postgresdk 0.12.1 → 0.13.1

package/README.md

@@ -121,7 +121,8 @@ const user = await sdk.users.create({ name: "Bob", email: "bob@example.com" });
 
 // Read
 const user = await sdk.users.getByPk(123);
-const users = await sdk.users.list();
+const result = await sdk.users.list();
+const users = result.data;  // Array of users
 
 // Update  
 const updated = await sdk.users.update(123, { name: "Robert" });
@@ -136,17 +137,19 @@ Automatically handles relationships with the `include` parameter:
 
 ```typescript
 // 1:N relationship - Get authors with their books
-const authors = await sdk.authors.list({
+const authorsResult = await sdk.authors.list({
   include: { books: true }
 });
+const authors = authorsResult.data;
 
 // M:N relationship - Get books with their tags
-const books = await sdk.books.list({
+const booksResult = await sdk.books.list({
   include: { tags: true }
 });
+const books = booksResult.data;
 
 // Nested includes - Get authors with books and their tags
-const authors = await sdk.authors.list({
+const nestedResult = await sdk.authors.list({
   include: {
     books: {
       include: {
@@ -155,13 +158,15 @@ const authors = await sdk.authors.list({
     }
   }
 });
+const authorsWithBooksAndTags = nestedResult.data;
 ```
 
 ### Filtering & Pagination
 
+All `list()` methods return pagination metadata:
+
 ```typescript
-// Simple equality filtering with single-column sorting
-const users = await sdk.users.list({
+const result = await sdk.users.list({
   where: { status: "active" },
   orderBy: "created_at",
   order: "desc",
@@ -169,6 +174,17 @@ const users = await sdk.users.list({
   offset: 40
 });
 
+// Access results
+result.data;       // User[] - array of records
+result.total;      // number - total matching records
+result.limit;      // number - page size used
+result.offset;     // number - offset used
+result.hasMore;    // boolean - more pages available
+
+// Calculate pagination info
+const totalPages = Math.ceil(result.total / result.limit);
+const currentPage = Math.floor(result.offset / result.limit) + 1;
+
 // Multi-column sorting
 const sorted = await sdk.users.list({
   orderBy: ["status", "created_at"],
@@ -184,6 +200,7 @@ const filtered = await sdk.users.list({
     deleted_at: { $is: null }              // NULL checks
   }
 });
+// filtered.total respects WHERE clause for accurate counts
 
 // OR logic - match any condition
 const results = await sdk.users.list({
@@ -221,6 +238,17 @@ const nested = await sdk.users.list({
     ]
   }
 });
+
+// Pagination with filtered results
+let allResults = [];
+let offset = 0;
+const limit = 50;
+do {
+  const page = await sdk.users.list({ where: { status: 'active' }, limit, offset });
+  allResults = allResults.concat(page.data);
+  offset += limit;
+  if (!page.hasMore) break;
+} while (true);
 ```
 
 See the generated SDK documentation for all available operators: `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`, `$in`, `$nin`, `$like`, `$ilike`, `$is`, `$isNot`, `$or`, `$and`.

package/dist/cli.js

@@ -578,7 +578,7 @@ function generateIncludeMethods(table, graph, opts, allTables) {
         path: newPath,
         isMany: newIsMany,
         targets: newTargets,
-        returnType: `(${buildReturnType(baseTableName, newPath, newIsMany, newTargets, graph)})[]`,
+        returnType: `PaginatedResponse<${buildReturnType(baseTableName, newPath, newIsMany, newTargets, graph)}>`,
         includeSpec: buildIncludeSpec(newPath)
       });
       methods.push({
@@ -618,7 +618,7 @@ function generateIncludeMethods(table, graph, opts, allTables) {
               path: combinedPath,
               isMany: [edge1.kind === "many", edge2.kind === "many"],
               targets: [edge1.target, edge2.target],
-              returnType: `(Select${pascal(baseTableName)} & { ${type1}; ${type2} })[]`,
+              returnType: `PaginatedResponse<Select${pascal(baseTableName)} & { ${type1}; ${type2} }>`,
               includeSpec: { [key1]: true, [key2]: true }
             });
             methods.push({
@@ -785,10 +785,13 @@ function generateResourceWithSDK(table, model, graph, config) {
   const endpoints = [];
   sdkMethods.push({
     name: "list",
-    signature: `list(params?: ListParams): Promise<${Type}[]>`,
-    description: `List ${tableName} with filtering, sorting, and pagination`,
+    signature: `list(params?: ListParams): Promise<PaginatedResponse<${Type}>>`,
+    description: `List ${tableName} with filtering, sorting, and pagination. Returns paginated results with metadata.`,
     example: `// Get all ${tableName}
-const items = await sdk.${tableName}.list();
+const result = await sdk.${tableName}.list();
+console.log(result.data);        // array of records
+console.log(result.total);       // total matching records
+console.log(result.hasMore);     // true if more pages available
 
 // With filters and pagination
 const filtered = await sdk.${tableName}.list({
@@ -797,15 +800,19 @@ const filtered = await sdk.${tableName}.list({
   where: { ${table.columns[0]?.name || "field"}: { $like: '%search%' } },
   orderBy: '${table.columns[0]?.name || "created_at"}',
   order: 'desc'
-});`,
+});
+
+// Calculate total pages
+const totalPages = Math.ceil(filtered.total / filtered.limit);
+const currentPage = Math.floor(filtered.offset / filtered.limit) + 1;`,
     correspondsTo: `GET ${basePath}`
   });
   endpoints.push({
     method: "GET",
     path: basePath,
-    description: `List all ${tableName} records`,
+    description: `List all ${tableName} records with pagination metadata`,
     queryParameters: generateQueryParams(table, enums),
-    responseBody: `${Type}[]`
+    responseBody: `PaginatedResponse<${Type}>`
   });
   if (hasSinglePK) {
     sdkMethods.push({
@@ -895,7 +902,10 @@ console.log('Deleted:', deleted);`,
     }, allTables);
     for (const method of includeMethods) {
       const isGetByPk = method.name.startsWith("getByPk");
-      const exampleCall = isGetByPk ? `const result = await sdk.${tableName}.${method.name}('123e4567-e89b-12d3-a456-426614174000');` : `const results = await sdk.${tableName}.${method.name}();
+      const exampleCall = isGetByPk ? `const result = await sdk.${tableName}.${method.name}('123e4567-e89b-12d3-a456-426614174000');` : `const result = await sdk.${tableName}.${method.name}();
+console.log(result.data);    // array of records with includes
+console.log(result.total);   // total count
+console.log(result.hasMore); // more pages available
 
 // With filters and pagination
 const filtered = await sdk.${tableName}.${method.name}({
@@ -2725,6 +2735,31 @@ export type PaginationParams = z.infer<typeof PaginationParamsSchema>;
 `;
 }
 
+// src/emit-shared-types.ts
+function emitSharedTypes() {
+  return `/**
+ * Shared types used across all SDK operations
+ */
+
+/**
+ * Paginated response structure returned by list operations
+ * @template T - The type of records in the data array
+ */
+export interface PaginatedResponse<T> {
+  /** Array of records for the current page */
+  data: T[];
+  /** Total number of records matching the query (across all pages) */
+  total: number;
+  /** Maximum number of records per page */
+  limit: number;
+  /** Number of records skipped (for pagination) */
+  offset: number;
+  /** Whether there are more records available after this page */
+  hasMore: boolean;
+}
+`;
+}
+
 // src/emit-routes-hono.ts
 init_utils();
 function emitHonoRoutes(table, _graph, opts) {
@@ -2768,6 +2803,13 @@ const listSchema = z.object({
   order: z.union([z.enum(["asc", "desc"]), z.array(z.enum(["asc", "desc"]))]).optional()
 });
 
+/**
+ * Register all CRUD routes for the ${fileTableName} table
+ * @param app - Hono application instance
+ * @param deps - Dependencies including database client and optional request hook
+ * @param deps.pg - PostgreSQL client with query method
+ * @param deps.onRequest - Optional hook that runs before each request (for audit logging, RLS, etc.)
+ */
 export function register${Type}Routes(app: Hono, deps: { pg: { query: (text: string, params?: any[]) => Promise<{ rows: any[] }> }, onRequest?: (c: Context, pg: { query: (text: string, params?: any[]) => Promise<{ rows: any[] }> }) => Promise<void> }) {
   const base = "/v1/${fileTableName}";
   
@@ -2847,34 +2889,50 @@ ${hasAuth ? `
     if (result.needsIncludes && result.includeSpec) {
       try {
         const stitched = await loadIncludes(
-          "${fileTableName}", 
-          result.data, 
-          result.includeSpec, 
-          deps.pg, 
+          "${fileTableName}",
+          result.data,
+          result.includeSpec,
+          deps.pg,
           ${opts.includeMethodsDepth}
         );
-        return c.json(stitched);
+        return c.json({
+          data: stitched,
+          total: result.total,
+          limit: result.limit,
+          offset: result.offset,
+          hasMore: result.hasMore
+        });
       } catch (e: any) {
         const strict = process.env.SDK_STRICT_INCLUDE === "1";
         if (strict) {
-          return c.json({ 
-            error: "include-stitch-failed", 
+          return c.json({
+            error: "include-stitch-failed",
             message: e?.message,
             ...(process.env.SDK_DEBUG === "1" ? { stack: e?.stack } : {})
           }, 500);
         }
         // Non-strict: return base rows with error metadata
-        return c.json({ 
-          data: result.data, 
-          includeError: { 
+        return c.json({
+          data: result.data,
+          total: result.total,
+          limit: result.limit,
+          offset: result.offset,
+          hasMore: result.hasMore,
+          includeError: {
             message: e?.message,
             ...(process.env.SDK_DEBUG === "1" ? { stack: e?.stack } : {})
           }
         }, 200);
       }
     }
-    
-    return c.json(result.data, result.status as any);
+
+    return c.json({
+      data: result.data,
+      total: result.total,
+      limit: result.limit,
+      offset: result.offset,
+      hasMore: result.hasMore
+    }, result.status as any);
   });
 
   // UPDATE
@@ -2955,21 +3013,36 @@ function emitClient(table, graph, opts, model) {
   for (const method of includeMethods) {
     const isGetByPk = method.name.startsWith("getByPk");
     const baseParams = isGetByPk ? "" : `params?: Omit<{ limit?: number; offset?: number; where?: Where<Select${Type}>; orderBy?: string | string[]; order?: "asc" | "desc" | ("asc" | "desc")[]; }, "include">`;
+    const relationshipDesc = method.path.map((p, i) => {
+      const isLast = i === method.path.length - 1;
+      const relation = method.isMany[i] ? "many" : "one";
+      return isLast ? p : `${p} -> `;
+    }).join("");
     if (isGetByPk) {
       const pkWhere = hasCompositePk ? `{ ${safePk.map((col) => `${col}: pk.${col}`).join(", ")} }` : `{ ${safePk[0] || "id"}: pk }`;
       const baseReturnType = method.returnType.replace(" | null", "");
       includeMethodsCode += `
+  /**
+   * Get a ${table.name} record by primary key with included related ${relationshipDesc}
+   * @param pk - The primary key value${hasCompositePk ? "s" : ""}
+   * @returns The record with nested ${method.path.join(" and ")} if found, null otherwise
+   */
   async ${method.name}(pk: ${pkType}): Promise<${method.returnType}> {
-    const results = await this.post<${baseReturnType}[]>(\`\${this.resource}/list\`, { 
+    const results = await this.post<PaginatedResponse<${baseReturnType}>>(\`\${this.resource}/list\`, {
       where: ${pkWhere},
       include: ${JSON.stringify(method.includeSpec)},
-      limit: 1 
+      limit: 1
     });
-    return (results[0] as ${baseReturnType}) ?? null;
+    return (results.data[0] as ${baseReturnType}) ?? null;
   }
 `;
     } else {
       includeMethodsCode += `
+  /**
+   * List ${table.name} records with included related ${relationshipDesc}
+   * @param params - Query parameters (where, orderBy, order, limit, offset)
+   * @returns Paginated results with nested ${method.path.join(" and ")} included
+   */
   async ${method.name}(${baseParams}): Promise<${method.returnType}> {
     return this.post<${method.returnType}>(\`\${this.resource}/list\`, { ...params, include: ${JSON.stringify(method.includeSpec)} });
   }
@@ -2986,6 +3059,7 @@ function emitClient(table, graph, opts, model) {
  */
 import { BaseClient } from "./base-client${ext}";
 import type { Where } from "./where-types${ext}";
+import type { PaginatedResponse } from "./types/shared${ext}";
 ${typeImports}
 ${otherTableImports.join(`
 `)}
@@ -2996,15 +3070,36 @@ ${otherTableImports.join(`
 export class ${Type}Client extends BaseClient {
   private readonly resource = "/v1/${table.name}";
 
+  /**
+   * Create a new ${table.name} record
+   * @param data - The data to insert
+   * @returns The created record
+   */
   async create(data: Insert${Type}): Promise<Select${Type}> {
     return this.post<Select${Type}>(this.resource, data);
   }
 
+  /**
+   * Get a ${table.name} record by primary key
+   * @param pk - The primary key value${hasCompositePk ? "s" : ""}
+   * @returns The record if found, null otherwise
+   */
   async getByPk(pk: ${pkType}): Promise<Select${Type} | null> {
     const path = ${pkPathExpr};
     return this.get<Select${Type} | null>(\`\${this.resource}/\${path}\`);
   }
 
+  /**
+   * List ${table.name} records with pagination and filtering
+   * @param params - Query parameters
+   * @param params.where - Filter conditions using operators like $eq, $gt, $in, $like, etc.
+   * @param params.orderBy - Column(s) to sort by
+   * @param params.order - Sort direction(s): "asc" or "desc"
+   * @param params.limit - Maximum number of records to return (default: 50, max: 100)
+   * @param params.offset - Number of records to skip for pagination
+   * @param params.include - Related records to include (see listWith* methods for typed includes)
+   * @returns Paginated results with data, total count, and hasMore flag
+   */
   async list(params?: {
     include?: any;
     limit?: number;
@@ -3012,15 +3107,26 @@ export class ${Type}Client extends BaseClient {
     where?: Where<Select${Type}>;
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
-  }): Promise<Select${Type}[]> {
-    return this.post<Select${Type}[]>(\`\${this.resource}/list\`, params ?? {});
+  }): Promise<PaginatedResponse<Select${Type}>> {
+    return this.post<PaginatedResponse<Select${Type}>>(\`\${this.resource}/list\`, params ?? {});
   }
 
+  /**
+   * Update a ${table.name} record by primary key
+   * @param pk - The primary key value${hasCompositePk ? "s" : ""}
+   * @param patch - Partial data to update
+   * @returns The updated record if found, null otherwise
+   */
   async update(pk: ${pkType}, patch: Update${Type}): Promise<Select${Type} | null> {
     const path = ${pkPathExpr};
     return this.patch<Select${Type} | null>(\`\${this.resource}/\${path}\`, patch);
   }
 
+  /**
+   * Delete a ${table.name} record by primary key
+   * @param pk - The primary key value${hasCompositePk ? "s" : ""}
+   * @returns The deleted record if found, null otherwise
+   */
   async delete(pk: ${pkType}): Promise<Select${Type} | null> {
     const path = ${pkPathExpr};
     return this.del<Select${Type} | null>(\`\${this.resource}/\${path}\`);
@@ -3113,6 +3219,11 @@ export type { AuthConfig, HeaderMap, AuthHeadersProvider } from "./base-client${
     out += `export type { Insert${Type}, Update${Type}, Select${Type} } from "./types/${t.name}${ext}";
 `;
   }
+  out += `
+// Shared types
+`;
+  out += `export type { PaginatedResponse } from "./types/shared${ext}";
+`;
   return out;
 }
 
@@ -3611,12 +3722,25 @@ function emitTypes(table, opts, enums) {
  *
  * To make changes, modify your schema or configuration and regenerate.
  */
+
+/**
+ * Type for inserting a new ${table.name} record.
+ * Fields with defaults or nullable columns are optional.
+ */
 export type Insert${Type} = {
 ${insertFields}
 };
 
+/**
+ * Type for updating an existing ${table.name} record.
+ * All fields are optional, allowing partial updates.
+ */
 export type Update${Type} = Partial<Insert${Type}>;
 
+/**
+ * Type representing a ${table.name} record from the database.
+ * All fields are included as returned by SELECT queries.
+ */
 export type Select${Type} = {
 ${selectFields}
 };
@@ -4349,7 +4473,7 @@ function buildWhereClause(
 export async function listRecords(
   ctx: OperationContext,
   params: { where?: any; limit?: number; offset?: number; include?: any; orderBy?: string | string[]; order?: "asc" | "desc" | ("asc" | "desc")[] }
-): Promise<{ data?: any; error?: string; issues?: any; needsIncludes?: boolean; includeSpec?: any; status: number }> {
+): Promise<{ data?: any; total?: number; limit?: number; offset?: number; hasMore?: boolean; error?: string; issues?: any; needsIncludes?: boolean; includeSpec?: any; status: number }> {
   try {
     const { where: whereClause, limit = 50, offset = 0, include, orderBy, order } = params;
 
@@ -4394,20 +4518,34 @@ export async function listRecords(
     const offsetParam = \`$\${paramIndex + 1}\`;
     const allParams = [...whereParams, limit, offset];
 
+    // Get total count for pagination
+    const countText = \`SELECT COUNT(*) FROM "\${ctx.table}" \${whereSQL}\`;
+    log.debug(\`LIST \${ctx.table} COUNT SQL:\`, countText, "params:", whereParams);
+    const countResult = await ctx.pg.query(countText, whereParams);
+    const total = parseInt(countResult.rows[0].count, 10);
+
+    // Get paginated data
     const text = \`SELECT * FROM "\${ctx.table}" \${whereSQL} \${orderBySQL} LIMIT \${limitParam} OFFSET \${offsetParam}\`;
     log.debug(\`LIST \${ctx.table} SQL:\`, text, "params:", allParams);
 
     const { rows } = await ctx.pg.query(text, allParams);
 
-    if (!include) {
-      log.debug(\`LIST \${ctx.table} rows:\`, rows.length);
-      return { data: rows, status: 200 };
-    }
+    // Calculate hasMore
+    const hasMore = offset + limit < total;
+
+    const metadata = {
+      data: rows,
+      total,
+      limit,
+      offset,
+      hasMore,
+      needsIncludes: !!include,
+      includeSpec: include,
+      status: 200
+    };
 
-    // Include logic will be handled by the include-loader
-    // For now, just return the rows with a note that includes need to be applied
-    log.debug(\`LIST \${ctx.table} include spec:\`, include);
-    return { data: rows, needsIncludes: true, includeSpec: include, status: 200 };
+    log.debug(\`LIST \${ctx.table} result: \${rows.length} rows, \${total} total, hasMore=\${hasMore}\`);
+    return metadata;
   } catch (e: any) {
     log.error(\`LIST \${ctx.table} error:\`, e?.stack ?? e);
     return {
@@ -4549,8 +4687,11 @@ describe('${Type} SDK Operations', () => {
   });
   
   it('should list ${tableName} relationships', async () => {
-    const list = await sdk.${tableName}.list({ limit: 10 });
-    expect(Array.isArray(list)).toBe(true);
+    const result = await sdk.${tableName}.list({ limit: 10 });
+    expect(result).toBeDefined();
+    expect(Array.isArray(result.data)).toBe(true);
+    expect(typeof result.total).toBe('number');
+    expect(typeof result.hasMore).toBe('boolean');
   });
 });
 `;
@@ -5186,8 +5327,11 @@ function generateTestCases(table, sampleData, updateData, hasForeignKeys = false
   });
   
   it('should list ${table.name}', async () => {
-    const list = await sdk.${table.name}.list({ limit: 10 });
-    expect(Array.isArray(list)).toBe(true);
+    const result = await sdk.${table.name}.list({ limit: 10 });
+    expect(result).toBeDefined();
+    expect(Array.isArray(result.data)).toBe(true);
+    expect(typeof result.total).toBe('number');
+    expect(typeof result.hasMore).toBe('boolean');
   });
   
   ${hasData && hasSinglePK ? `it('should get ${table.name} by id', async () => {
@@ -5314,6 +5458,7 @@ async function generate(configPath) {
   files.push({ path: join(serverDir, "include-spec.ts"), content: includeSpec });
   files.push({ path: join(clientDir, "include-spec.ts"), content: includeSpec });
   files.push({ path: join(clientDir, "params", "shared.ts"), content: emitSharedParamsZod() });
+  files.push({ path: join(clientDir, "types", "shared.ts"), content: emitSharedTypes() });
   files.push({ path: join(clientDir, "base-client.ts"), content: emitBaseClient() });
   files.push({ path: join(clientDir, "where-types.ts"), content: emitWhereTypes() });
   files.push({

package/dist/emit-shared-types.d.ts

@@ -0,0 +1 @@
+export declare function emitSharedTypes(): string;

package/dist/index.js

@@ -577,7 +577,7 @@ function generateIncludeMethods(table, graph, opts, allTables) {
         path: newPath,
         isMany: newIsMany,
         targets: newTargets,
-        returnType: `(${buildReturnType(baseTableName, newPath, newIsMany, newTargets, graph)})[]`,
+        returnType: `PaginatedResponse<${buildReturnType(baseTableName, newPath, newIsMany, newTargets, graph)}>`,
         includeSpec: buildIncludeSpec(newPath)
       });
       methods.push({
@@ -617,7 +617,7 @@ function generateIncludeMethods(table, graph, opts, allTables) {
               path: combinedPath,
               isMany: [edge1.kind === "many", edge2.kind === "many"],
               targets: [edge1.target, edge2.target],
-              returnType: `(Select${pascal(baseTableName)} & { ${type1}; ${type2} })[]`,
+              returnType: `PaginatedResponse<Select${pascal(baseTableName)} & { ${type1}; ${type2} }>`,
               includeSpec: { [key1]: true, [key2]: true }
             });
             methods.push({
@@ -784,10 +784,13 @@ function generateResourceWithSDK(table, model, graph, config) {
   const endpoints = [];
   sdkMethods.push({
     name: "list",
-    signature: `list(params?: ListParams): Promise<${Type}[]>`,
-    description: `List ${tableName} with filtering, sorting, and pagination`,
+    signature: `list(params?: ListParams): Promise<PaginatedResponse<${Type}>>`,
+    description: `List ${tableName} with filtering, sorting, and pagination. Returns paginated results with metadata.`,
     example: `// Get all ${tableName}
-const items = await sdk.${tableName}.list();
+const result = await sdk.${tableName}.list();
+console.log(result.data);        // array of records
+console.log(result.total);       // total matching records
+console.log(result.hasMore);     // true if more pages available
 
 // With filters and pagination
 const filtered = await sdk.${tableName}.list({
@@ -796,15 +799,19 @@ const filtered = await sdk.${tableName}.list({
   where: { ${table.columns[0]?.name || "field"}: { $like: '%search%' } },
   orderBy: '${table.columns[0]?.name || "created_at"}',
   order: 'desc'
-});`,
+});
+
+// Calculate total pages
+const totalPages = Math.ceil(filtered.total / filtered.limit);
+const currentPage = Math.floor(filtered.offset / filtered.limit) + 1;`,
     correspondsTo: `GET ${basePath}`
   });
   endpoints.push({
     method: "GET",
     path: basePath,
-    description: `List all ${tableName} records`,
+    description: `List all ${tableName} records with pagination metadata`,
     queryParameters: generateQueryParams(table, enums),
-    responseBody: `${Type}[]`
+    responseBody: `PaginatedResponse<${Type}>`
   });
   if (hasSinglePK) {
     sdkMethods.push({
@@ -894,7 +901,10 @@ console.log('Deleted:', deleted);`,
     }, allTables);
     for (const method of includeMethods) {
       const isGetByPk = method.name.startsWith("getByPk");
-      const exampleCall = isGetByPk ? `const result = await sdk.${tableName}.${method.name}('123e4567-e89b-12d3-a456-426614174000');` : `const results = await sdk.${tableName}.${method.name}();
+      const exampleCall = isGetByPk ? `const result = await sdk.${tableName}.${method.name}('123e4567-e89b-12d3-a456-426614174000');` : `const result = await sdk.${tableName}.${method.name}();
+console.log(result.data);    // array of records with includes
+console.log(result.total);   // total count
+console.log(result.hasMore); // more pages available
 
 // With filters and pagination
 const filtered = await sdk.${tableName}.${method.name}({
@@ -1965,6 +1975,31 @@ export type PaginationParams = z.infer<typeof PaginationParamsSchema>;
 `;
 }
 
+// src/emit-shared-types.ts
+function emitSharedTypes() {
+  return `/**
+ * Shared types used across all SDK operations
+ */
+
+/**
+ * Paginated response structure returned by list operations
+ * @template T - The type of records in the data array
+ */
+export interface PaginatedResponse<T> {
+  /** Array of records for the current page */
+  data: T[];
+  /** Total number of records matching the query (across all pages) */
+  total: number;
+  /** Maximum number of records per page */
+  limit: number;
+  /** Number of records skipped (for pagination) */
+  offset: number;
+  /** Whether there are more records available after this page */
+  hasMore: boolean;
+}
+`;
+}
+
 // src/emit-routes-hono.ts
 init_utils();
 function emitHonoRoutes(table, _graph, opts) {
@@ -2008,6 +2043,13 @@ const listSchema = z.object({
   order: z.union([z.enum(["asc", "desc"]), z.array(z.enum(["asc", "desc"]))]).optional()
 });
 
+/**
+ * Register all CRUD routes for the ${fileTableName} table
+ * @param app - Hono application instance
+ * @param deps - Dependencies including database client and optional request hook
+ * @param deps.pg - PostgreSQL client with query method
+ * @param deps.onRequest - Optional hook that runs before each request (for audit logging, RLS, etc.)
+ */
 export function register${Type}Routes(app: Hono, deps: { pg: { query: (text: string, params?: any[]) => Promise<{ rows: any[] }> }, onRequest?: (c: Context, pg: { query: (text: string, params?: any[]) => Promise<{ rows: any[] }> }) => Promise<void> }) {
   const base = "/v1/${fileTableName}";
   
@@ -2087,34 +2129,50 @@ ${hasAuth ? `
     if (result.needsIncludes && result.includeSpec) {
       try {
         const stitched = await loadIncludes(
-          "${fileTableName}", 
-          result.data, 
-          result.includeSpec, 
-          deps.pg, 
+          "${fileTableName}",
+          result.data,
+          result.includeSpec,
+          deps.pg,
           ${opts.includeMethodsDepth}
         );
-        return c.json(stitched);
+        return c.json({
+          data: stitched,
+          total: result.total,
+          limit: result.limit,
+          offset: result.offset,
+          hasMore: result.hasMore
+        });
       } catch (e: any) {
         const strict = process.env.SDK_STRICT_INCLUDE === "1";
         if (strict) {
-          return c.json({ 
-            error: "include-stitch-failed", 
+          return c.json({
+            error: "include-stitch-failed",
             message: e?.message,
             ...(process.env.SDK_DEBUG === "1" ? { stack: e?.stack } : {})
           }, 500);
         }
         // Non-strict: return base rows with error metadata
-        return c.json({ 
-          data: result.data, 
-          includeError: { 
+        return c.json({
+          data: result.data,
+          total: result.total,
+          limit: result.limit,
+          offset: result.offset,
+          hasMore: result.hasMore,
+          includeError: {
             message: e?.message,
             ...(process.env.SDK_DEBUG === "1" ? { stack: e?.stack } : {})
           }
         }, 200);
       }
     }
-    
-    return c.json(result.data, result.status as any);
+
+    return c.json({
+      data: result.data,
+      total: result.total,
+      limit: result.limit,
+      offset: result.offset,
+      hasMore: result.hasMore
+    }, result.status as any);
   });
 
   // UPDATE
@@ -2195,21 +2253,36 @@ function emitClient(table, graph, opts, model) {
   for (const method of includeMethods) {
     const isGetByPk = method.name.startsWith("getByPk");
     const baseParams = isGetByPk ? "" : `params?: Omit<{ limit?: number; offset?: number; where?: Where<Select${Type}>; orderBy?: string | string[]; order?: "asc" | "desc" | ("asc" | "desc")[]; }, "include">`;
+    const relationshipDesc = method.path.map((p, i) => {
+      const isLast = i === method.path.length - 1;
+      const relation = method.isMany[i] ? "many" : "one";
+      return isLast ? p : `${p} -> `;
+    }).join("");
     if (isGetByPk) {
       const pkWhere = hasCompositePk ? `{ ${safePk.map((col) => `${col}: pk.${col}`).join(", ")} }` : `{ ${safePk[0] || "id"}: pk }`;
       const baseReturnType = method.returnType.replace(" | null", "");
       includeMethodsCode += `
+  /**
+   * Get a ${table.name} record by primary key with included related ${relationshipDesc}
+   * @param pk - The primary key value${hasCompositePk ? "s" : ""}
+   * @returns The record with nested ${method.path.join(" and ")} if found, null otherwise
+   */
   async ${method.name}(pk: ${pkType}): Promise<${method.returnType}> {
-    const results = await this.post<${baseReturnType}[]>(\`\${this.resource}/list\`, { 
+    const results = await this.post<PaginatedResponse<${baseReturnType}>>(\`\${this.resource}/list\`, {
       where: ${pkWhere},
       include: ${JSON.stringify(method.includeSpec)},
-      limit: 1 
+      limit: 1
     });
-    return (results[0] as ${baseReturnType}) ?? null;
+    return (results.data[0] as ${baseReturnType}) ?? null;
   }
 `;
     } else {
       includeMethodsCode += `
+  /**
+   * List ${table.name} records with included related ${relationshipDesc}
+   * @param params - Query parameters (where, orderBy, order, limit, offset)
+   * @returns Paginated results with nested ${method.path.join(" and ")} included
+   */
   async ${method.name}(${baseParams}): Promise<${method.returnType}> {
     return this.post<${method.returnType}>(\`\${this.resource}/list\`, { ...params, include: ${JSON.stringify(method.includeSpec)} });
   }
@@ -2226,6 +2299,7 @@ function emitClient(table, graph, opts, model) {
  */
 import { BaseClient } from "./base-client${ext}";
 import type { Where } from "./where-types${ext}";
+import type { PaginatedResponse } from "./types/shared${ext}";
 ${typeImports}
 ${otherTableImports.join(`
 `)}
@@ -2236,15 +2310,36 @@ ${otherTableImports.join(`
 export class ${Type}Client extends BaseClient {
   private readonly resource = "/v1/${table.name}";
 
+  /**
+   * Create a new ${table.name} record
+   * @param data - The data to insert
+   * @returns The created record
+   */
   async create(data: Insert${Type}): Promise<Select${Type}> {
     return this.post<Select${Type}>(this.resource, data);
   }
 
+  /**
+   * Get a ${table.name} record by primary key
+   * @param pk - The primary key value${hasCompositePk ? "s" : ""}
+   * @returns The record if found, null otherwise
+   */
   async getByPk(pk: ${pkType}): Promise<Select${Type} | null> {
     const path = ${pkPathExpr};
     return this.get<Select${Type} | null>(\`\${this.resource}/\${path}\`);
   }
 
+  /**
+   * List ${table.name} records with pagination and filtering
+   * @param params - Query parameters
+   * @param params.where - Filter conditions using operators like $eq, $gt, $in, $like, etc.
+   * @param params.orderBy - Column(s) to sort by
+   * @param params.order - Sort direction(s): "asc" or "desc"
+   * @param params.limit - Maximum number of records to return (default: 50, max: 100)
+   * @param params.offset - Number of records to skip for pagination
+   * @param params.include - Related records to include (see listWith* methods for typed includes)
+   * @returns Paginated results with data, total count, and hasMore flag
+   */
   async list(params?: {
     include?: any;
     limit?: number;
@@ -2252,15 +2347,26 @@ export class ${Type}Client extends BaseClient {
     where?: Where<Select${Type}>;
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
-  }): Promise<Select${Type}[]> {
-    return this.post<Select${Type}[]>(\`\${this.resource}/list\`, params ?? {});
+  }): Promise<PaginatedResponse<Select${Type}>> {
+    return this.post<PaginatedResponse<Select${Type}>>(\`\${this.resource}/list\`, params ?? {});
   }
 
+  /**
+   * Update a ${table.name} record by primary key
+   * @param pk - The primary key value${hasCompositePk ? "s" : ""}
+   * @param patch - Partial data to update
+   * @returns The updated record if found, null otherwise
+   */
   async update(pk: ${pkType}, patch: Update${Type}): Promise<Select${Type} | null> {
     const path = ${pkPathExpr};
     return this.patch<Select${Type} | null>(\`\${this.resource}/\${path}\`, patch);
   }
 
+  /**
+   * Delete a ${table.name} record by primary key
+   * @param pk - The primary key value${hasCompositePk ? "s" : ""}
+   * @returns The deleted record if found, null otherwise
+   */
   async delete(pk: ${pkType}): Promise<Select${Type} | null> {
     const path = ${pkPathExpr};
     return this.del<Select${Type} | null>(\`\${this.resource}/\${path}\`);
@@ -2353,6 +2459,11 @@ export type { AuthConfig, HeaderMap, AuthHeadersProvider } from "./base-client${
     out += `export type { Insert${Type}, Update${Type}, Select${Type} } from "./types/${t.name}${ext}";
 `;
   }
+  out += `
+// Shared types
+`;
+  out += `export type { PaginatedResponse } from "./types/shared${ext}";
+`;
   return out;
 }
 
@@ -2851,12 +2962,25 @@ function emitTypes(table, opts, enums) {
  *
  * To make changes, modify your schema or configuration and regenerate.
  */
+
+/**
+ * Type for inserting a new ${table.name} record.
+ * Fields with defaults or nullable columns are optional.
+ */
 export type Insert${Type} = {
 ${insertFields}
 };
 
+/**
+ * Type for updating an existing ${table.name} record.
+ * All fields are optional, allowing partial updates.
+ */
 export type Update${Type} = Partial<Insert${Type}>;
 
+/**
+ * Type representing a ${table.name} record from the database.
+ * All fields are included as returned by SELECT queries.
+ */
 export type Select${Type} = {
 ${selectFields}
 };
@@ -3589,7 +3713,7 @@ function buildWhereClause(
 export async function listRecords(
   ctx: OperationContext,
   params: { where?: any; limit?: number; offset?: number; include?: any; orderBy?: string | string[]; order?: "asc" | "desc" | ("asc" | "desc")[] }
-): Promise<{ data?: any; error?: string; issues?: any; needsIncludes?: boolean; includeSpec?: any; status: number }> {
+): Promise<{ data?: any; total?: number; limit?: number; offset?: number; hasMore?: boolean; error?: string; issues?: any; needsIncludes?: boolean; includeSpec?: any; status: number }> {
   try {
     const { where: whereClause, limit = 50, offset = 0, include, orderBy, order } = params;
 
@@ -3634,20 +3758,34 @@ export async function listRecords(
     const offsetParam = \`$\${paramIndex + 1}\`;
     const allParams = [...whereParams, limit, offset];
 
+    // Get total count for pagination
+    const countText = \`SELECT COUNT(*) FROM "\${ctx.table}" \${whereSQL}\`;
+    log.debug(\`LIST \${ctx.table} COUNT SQL:\`, countText, "params:", whereParams);
+    const countResult = await ctx.pg.query(countText, whereParams);
+    const total = parseInt(countResult.rows[0].count, 10);
+
+    // Get paginated data
     const text = \`SELECT * FROM "\${ctx.table}" \${whereSQL} \${orderBySQL} LIMIT \${limitParam} OFFSET \${offsetParam}\`;
     log.debug(\`LIST \${ctx.table} SQL:\`, text, "params:", allParams);
 
     const { rows } = await ctx.pg.query(text, allParams);
 
-    if (!include) {
-      log.debug(\`LIST \${ctx.table} rows:\`, rows.length);
-      return { data: rows, status: 200 };
-    }
+    // Calculate hasMore
+    const hasMore = offset + limit < total;
+
+    const metadata = {
+      data: rows,
+      total,
+      limit,
+      offset,
+      hasMore,
+      needsIncludes: !!include,
+      includeSpec: include,
+      status: 200
+    };
 
-    // Include logic will be handled by the include-loader
-    // For now, just return the rows with a note that includes need to be applied
-    log.debug(\`LIST \${ctx.table} include spec:\`, include);
-    return { data: rows, needsIncludes: true, includeSpec: include, status: 200 };
+    log.debug(\`LIST \${ctx.table} result: \${rows.length} rows, \${total} total, hasMore=\${hasMore}\`);
+    return metadata;
   } catch (e: any) {
     log.error(\`LIST \${ctx.table} error:\`, e?.stack ?? e);
     return {
@@ -3789,8 +3927,11 @@ describe('${Type} SDK Operations', () => {
   });
   
   it('should list ${tableName} relationships', async () => {
-    const list = await sdk.${tableName}.list({ limit: 10 });
-    expect(Array.isArray(list)).toBe(true);
+    const result = await sdk.${tableName}.list({ limit: 10 });
+    expect(result).toBeDefined();
+    expect(Array.isArray(result.data)).toBe(true);
+    expect(typeof result.total).toBe('number');
+    expect(typeof result.hasMore).toBe('boolean');
   });
 });
 `;
@@ -4426,8 +4567,11 @@ function generateTestCases(table, sampleData, updateData, hasForeignKeys = false
   });
   
   it('should list ${table.name}', async () => {
-    const list = await sdk.${table.name}.list({ limit: 10 });
-    expect(Array.isArray(list)).toBe(true);
+    const result = await sdk.${table.name}.list({ limit: 10 });
+    expect(result).toBeDefined();
+    expect(Array.isArray(result.data)).toBe(true);
+    expect(typeof result.total).toBe('number');
+    expect(typeof result.hasMore).toBe('boolean');
   });
   
   ${hasData && hasSinglePK ? `it('should get ${table.name} by id', async () => {
@@ -4554,6 +4698,7 @@ async function generate(configPath) {
   files.push({ path: join(serverDir, "include-spec.ts"), content: includeSpec });
   files.push({ path: join(clientDir, "include-spec.ts"), content: includeSpec });
   files.push({ path: join(clientDir, "params", "shared.ts"), content: emitSharedParamsZod() });
+  files.push({ path: join(clientDir, "types", "shared.ts"), content: emitSharedTypes() });
   files.push({ path: join(clientDir, "base-client.ts"), content: emitBaseClient() });
   files.push({ path: join(clientDir, "where-types.ts"), content: emitWhereTypes() });
   files.push({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "postgresdk",
-  "version": "0.12.1",
+  "version": "0.13.1",
   "description": "Generate a typed server/client SDK from a Postgres schema (includes, Zod, Hono).",
   "type": "module",
   "bin": {