postgresdk 0.13.0 → 0.13.1

package/dist/cli.js

@@ -578,7 +578,7 @@ function generateIncludeMethods(table, graph, opts, allTables) {
         path: newPath,
         isMany: newIsMany,
         targets: newTargets,
-        returnType: `{ data: (${buildReturnType(baseTableName, newPath, newIsMany, newTargets, graph)})[]; total: number; limit: number; offset: number; hasMore: boolean; }`,
+        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: `{ data: (Select${pascal(baseTableName)} & { ${type1}; ${type2} })[]; total: number; limit: number; offset: number; hasMore: boolean; }`,
+              returnType: `PaginatedResponse<Select${pascal(baseTableName)} & { ${type1}; ${type2} }>`,
               includeSpec: { [key1]: true, [key2]: true }
             });
             methods.push({
@@ -785,7 +785,7 @@ function generateResourceWithSDK(table, model, graph, config) {
   const endpoints = [];
   sdkMethods.push({
     name: "list",
-    signature: `list(params?: ListParams): Promise<{ data: ${Type}[]; total: number; limit: number; offset: number; hasMore: boolean; }>`,
+    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 result = await sdk.${tableName}.list();
@@ -812,7 +812,7 @@ const currentPage = Math.floor(filtered.offset / filtered.limit) + 1;`,
     path: basePath,
     description: `List all ${tableName} records with pagination metadata`,
     queryParameters: generateQueryParams(table, enums),
-    responseBody: `{ data: ${Type}[]; total: number; limit: number; offset: number; hasMore: boolean; }`
+    responseBody: `PaginatedResponse<${Type}>`
   });
   if (hasSinglePK) {
     sdkMethods.push({
@@ -2735,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) {
@@ -3003,7 +3028,7 @@ function emitClient(table, graph, opts, model) {
    * @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<{ data: ${baseReturnType}[]; total: number; limit: number; offset: number; hasMore: boolean; }>(\`\${this.resource}/list\`, {
+    const results = await this.post<PaginatedResponse<${baseReturnType}>>(\`\${this.resource}/list\`, {
       where: ${pkWhere},
       include: ${JSON.stringify(method.includeSpec)},
       limit: 1
@@ -3034,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(`
 `)}
@@ -3081,20 +3107,8 @@ export class ${Type}Client extends BaseClient {
     where?: Where<Select${Type}>;
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
-  }): Promise<{
-    data: Select${Type}[];
-    total: number;
-    limit: number;
-    offset: number;
-    hasMore: boolean;
-  }> {
-    return this.post<{
-      data: Select${Type}[];
-      total: number;
-      limit: number;
-      offset: number;
-      hasMore: boolean;
-    }>(\`\${this.resource}/list\`, params ?? {});
+  }): Promise<PaginatedResponse<Select${Type}>> {
+    return this.post<PaginatedResponse<Select${Type}>>(\`\${this.resource}/list\`, params ?? {});
   }
 
   /**
@@ -3205,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;
 }
 
@@ -5439,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: `{ data: (${buildReturnType(baseTableName, newPath, newIsMany, newTargets, graph)})[]; total: number; limit: number; offset: number; hasMore: boolean; }`,
+        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: `{ data: (Select${pascal(baseTableName)} & { ${type1}; ${type2} })[]; total: number; limit: number; offset: number; hasMore: boolean; }`,
+              returnType: `PaginatedResponse<Select${pascal(baseTableName)} & { ${type1}; ${type2} }>`,
               includeSpec: { [key1]: true, [key2]: true }
             });
             methods.push({
@@ -784,7 +784,7 @@ function generateResourceWithSDK(table, model, graph, config) {
   const endpoints = [];
   sdkMethods.push({
     name: "list",
-    signature: `list(params?: ListParams): Promise<{ data: ${Type}[]; total: number; limit: number; offset: number; hasMore: boolean; }>`,
+    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 result = await sdk.${tableName}.list();
@@ -811,7 +811,7 @@ const currentPage = Math.floor(filtered.offset / filtered.limit) + 1;`,
     path: basePath,
     description: `List all ${tableName} records with pagination metadata`,
     queryParameters: generateQueryParams(table, enums),
-    responseBody: `{ data: ${Type}[]; total: number; limit: number; offset: number; hasMore: boolean; }`
+    responseBody: `PaginatedResponse<${Type}>`
   });
   if (hasSinglePK) {
     sdkMethods.push({
@@ -1975,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) {
@@ -2243,7 +2268,7 @@ function emitClient(table, graph, opts, model) {
    * @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<{ data: ${baseReturnType}[]; total: number; limit: number; offset: number; hasMore: boolean; }>(\`\${this.resource}/list\`, {
+    const results = await this.post<PaginatedResponse<${baseReturnType}>>(\`\${this.resource}/list\`, {
       where: ${pkWhere},
       include: ${JSON.stringify(method.includeSpec)},
       limit: 1
@@ -2274,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(`
 `)}
@@ -2321,20 +2347,8 @@ export class ${Type}Client extends BaseClient {
     where?: Where<Select${Type}>;
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
-  }): Promise<{
-    data: Select${Type}[];
-    total: number;
-    limit: number;
-    offset: number;
-    hasMore: boolean;
-  }> {
-    return this.post<{
-      data: Select${Type}[];
-      total: number;
-      limit: number;
-      offset: number;
-      hasMore: boolean;
-    }>(\`\${this.resource}/list\`, params ?? {});
+  }): Promise<PaginatedResponse<Select${Type}>> {
+    return this.post<PaginatedResponse<Select${Type}>>(\`\${this.resource}/list\`, params ?? {});
   }
 
   /**
@@ -2445,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;
 }
 
@@ -4679,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.13.0",
+  "version": "0.13.1",
   "description": "Generate a typed server/client SDK from a Postgres schema (includes, Zod, Hono).",
   "type": "module",
   "bin": {