Admin List Pattern

Admin List Integration Pattern

This skill outlines the standard pattern for implementing searchable, paginated lists in the erify_studios (frontend) and erify_api (backend) applications.

Canonical Examples

Study these real implementations:

• Backend: admin-client.controller.ts
• Repository: client.repository.ts

Integration Overview

The pattern relies on synchronized parameter names and behaviors across the stack:

1. Frontend: Uses useTableUrlState to sync URL params (e.g., ?name=...) with the table's columnFilters.
2. API Boundary: A specialized List<Resource>QueryDto extends the base pagination schema.
3. Repository: Builds a Prisma where clause to handle partial matches and other filters. The Service is a thin pass-through.

Backend Pattern (erify_api)

1. Define the Query DTO (schemas.ts)

Nest the filters inside a Zod schema and extend the base pagination. Following the pattern in models/client/schemas/client.schema.ts:

export const listResourceFilterSchema = z.object({
  name: z.string().optional(),
  include_deleted: z.coerce.boolean().default(false),
});

export const listResourceQuerySchema = z
  .object({
    page: z.coerce.number().int().min(1).optional().default(1),
    limit: z.coerce.number().int().min(1).optional().default(10),
  })
  .and(listResourceFilterSchema)
  .transform((data) => ({
    ...data,
    take: data.limit,
    skip: (data.page - 1) * data.limit,
  }));

export class ListResourceQueryDto extends createZodDto(listResourceQuerySchema) {}

2. Repository Logic (repository.ts)

Build the where clause in the repository. Ensure case-insensitive partial matching for strings.

async findPaginated(params: {
  skip?: number;
  take?: number;
  name?: string;
  includeDeleted?: boolean;
}): Promise<{ data: Resource[]; total: number }> {
  const where: Prisma.ResourceWhereInput = {};

  if (!params.includeDeleted) {
    where.deletedAt = null;
  }

  if (params.name) {
    where.name = {
      contains: params.name,
      mode: 'insensitive',
    };
  }

  const [data, total] = await Promise.all([
    this.model.findMany({ skip: params.skip, take: params.take, where }),
    this.model.count({ where }),
  ]);

  return { data, total };
}

3. Service Logic (service.ts)

Service passes parameters to repository without building Prisma where clauses.

async getResources(
  ...args: Parameters<ResourceRepository['findPaginated']>
): Promise<{ data: Resource[]; total: number }> {
  return this.repository.findPaginated(...args);
}

4. Controller Integration (controller.ts)

Pass the query DTO to the service and use @AdminPaginatedResponse.

@Get()
@AdminPaginatedResponse(ResourceDto, 'List resources')
async getResources(@Query() query: ListResourceQueryDto) {
  const { data, total } = await this.service.getResources(query);
  return this.createPaginatedResponse(data, total, query);
}

Frontend Pattern (erify_studios)

1. Route Search Schema

Ensure the Route search schema includes the filter field.

const searchSchema = z.object({
  page: z.number().int().min(1).catch(1),
  pageSize: z.number().int().min(10).max(100).catch(10),
  name: z.string().optional().catch(undefined),
});

2. AdminTable Configuration

Pass searchColumn and onColumnFiltersChange to the AdminTable.

const { 
  pagination, 
  onPaginationChange, 
  columnFilters, 
  onColumnFiltersChange 
} = useTableUrlState({ from: '/system/resources/' });

const nameFilter = columnFilters.find(f => f.id === 'name')?.value as string;

const { data, isLoading } = useAdminList<Resource>('resources', {
  page: pagination.pageIndex + 1,
  limit: pagination.pageSize,
  name: nameFilter,
});

// ... inside render
<AdminTable
  // ...
  searchColumn="name"
  columnFilters={columnFilters}
 
/>

3. Toolbar UX (Debouncing)

The AdminTableToolbar (generic component) should handle internal debouncing of the input to avoid immediate server queries on every keystroke.

• Timeout: Use a 500ms debounce.
• Visibility: Only show the search input when searchColumn is provided.

Checklist

• Backend: QueryDto extends pagination and includes filters.
• Backend: Repository builds where clause with contains and insensitive (NOT the service).
• Backend: Service delegates directly to repository.findPaginated() using Parameters<> spread.
• Frontend: useTableUrlState used for URL synchronization.
• Frontend: searchColumn passed to AdminTable.
• Frontend: Verification of debounced input behavior.