postgresdk 0.11.0 → 0.12.0

package/README.md

@@ -160,7 +160,7 @@ const authors = await sdk.authors.list({
 ### Filtering & Pagination
 
 ```typescript
-// Simple equality filtering
+// Simple equality filtering with single-column sorting
 const users = await sdk.users.list({
   where: { status: "active" },
   orderBy: "created_at",
@@ -169,6 +169,12 @@ const users = await sdk.users.list({
   offset: 40
 });
 
+// Multi-column sorting
+const sorted = await sdk.users.list({
+  orderBy: ["status", "created_at"],
+  order: ["asc", "desc"]  // or use single direction: order: "asc"
+});
+
 // Advanced WHERE operators
 const filtered = await sdk.users.list({
   where: {

package/dist/cli.js

@@ -793,9 +793,9 @@ const items = await sdk.${tableName}.list();
 const filtered = await sdk.${tableName}.list({
   limit: 20,
   offset: 0,
-  ${table.columns[0]?.name || "field"}_like: 'search',
-  order_by: '${table.columns[0]?.name || "created_at"}',
-  order_dir: 'desc'
+  where: { ${table.columns[0]?.name || "field"}: { $like: '%search%' } },
+  orderBy: '${table.columns[0]?.name || "created_at"}',
+  order: 'desc'
 });`,
     correspondsTo: `GET ${basePath}`
   });
@@ -1058,8 +1058,8 @@ function generateQueryParams(table) {
   const params = {
     limit: "number - Max records to return (default: 50)",
     offset: "number - Records to skip",
-    order_by: "string - Field to sort by",
-    order_dir: "'asc' | 'desc' - Sort direction"
+    orderBy: "string | string[] - Field(s) to sort by",
+    order: "'asc' | 'desc' | ('asc' | 'desc')[] - Sort direction(s)"
   };
   let filterCount = 0;
   for (const col of table.columns) {
@@ -1351,6 +1351,64 @@ function generateUnifiedContractMarkdown(contract) {
   lines.push("");
   lines.push("**Note:** The WHERE clause types are fully type-safe. TypeScript will only allow operators that are valid for each field type.");
   lines.push("");
+  lines.push("## Sorting");
+  lines.push("");
+  lines.push("Sort query results using the `orderBy` and `order` parameters. Supports both single and multi-column sorting.");
+  lines.push("");
+  lines.push("### Single Column Sorting");
+  lines.push("");
+  lines.push("```typescript");
+  lines.push("// Sort by one column ascending");
+  lines.push("const users = await sdk.users.list({");
+  lines.push("  orderBy: 'created_at',");
+  lines.push("  order: 'asc'");
+  lines.push("});");
+  lines.push("");
+  lines.push("// Sort descending");
+  lines.push("const latest = await sdk.users.list({");
+  lines.push("  orderBy: 'created_at',");
+  lines.push("  order: 'desc'");
+  lines.push("});");
+  lines.push("");
+  lines.push("// Order defaults to 'asc' if not specified");
+  lines.push("const sorted = await sdk.users.list({");
+  lines.push("  orderBy: 'name'");
+  lines.push("});");
+  lines.push("```");
+  lines.push("");
+  lines.push("### Multi-Column Sorting");
+  lines.push("");
+  lines.push("```typescript");
+  lines.push("// Sort by multiple columns (all same direction)");
+  lines.push("const users = await sdk.users.list({");
+  lines.push("  orderBy: ['status', 'created_at'],");
+  lines.push("  order: 'desc'");
+  lines.push("});");
+  lines.push("");
+  lines.push("// Different direction per column");
+  lines.push("const sorted = await sdk.users.list({");
+  lines.push("  orderBy: ['status', 'created_at'],");
+  lines.push("  order: ['asc', 'desc']  // status ASC, created_at DESC");
+  lines.push("});");
+  lines.push("```");
+  lines.push("");
+  lines.push("### Combining Sorting with Filters");
+  lines.push("");
+  lines.push("```typescript");
+  lines.push("const results = await sdk.users.list({");
+  lines.push("  where: {");
+  lines.push("    status: 'active',");
+  lines.push("    age: { $gte: 18 }");
+  lines.push("  },");
+  lines.push("  orderBy: 'created_at',");
+  lines.push("  order: 'desc',");
+  lines.push("  limit: 50,");
+  lines.push("  offset: 0");
+  lines.push("});");
+  lines.push("```");
+  lines.push("");
+  lines.push("**Note:** Column names are validated by Zod schemas. Only valid table columns are accepted, preventing SQL injection.");
+  lines.push("");
   lines.push("## Resources");
   lines.push("");
   for (const resource of contract.resources) {
@@ -2625,6 +2683,7 @@ function emitHonoRoutes(table, _graph, opts) {
   const hasAuth = opts.authStrategy && opts.authStrategy !== "none";
   const ext = opts.useJsExtensions ? ".js" : "";
   const authImport = hasAuth ? `import { authMiddleware } from "../auth${ext}";` : "";
+  const columnNames = table.columns.map((c) => `"${c.name}"`).join(", ");
   return `/**
  * AUTO-GENERATED FILE - DO NOT EDIT
  *
@@ -2641,12 +2700,15 @@ import { loadIncludes } from "../include-loader${ext}";
 import * as coreOps from "../core/operations${ext}";
 ${authImport}
 
+const columnEnum = z.enum([${columnNames}]);
+
 const listSchema = z.object({
   where: z.any().optional(),
   include: z.any().optional(),
   limit: z.number().int().positive().max(100).optional(),
   offset: z.number().int().min(0).optional(),
-  orderBy: z.any().optional()
+  orderBy: z.union([columnEnum, z.array(columnEnum)]).optional(),
+  order: z.union([z.enum(["asc", "desc"]), z.array(z.enum(["asc", "desc"]))]).optional()
 });
 
 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> }) {
@@ -2835,7 +2897,7 @@ function emitClient(table, graph, opts, model) {
   let includeMethodsCode = "";
   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; order?: "asc" | "desc"; }, "include">`;
+    const baseParams = isGetByPk ? "" : `params?: Omit<{ limit?: number; offset?: number; where?: Where<Select${Type}>; orderBy?: string | string[]; order?: "asc" | "desc" | ("asc" | "desc")[]; }, "include">`;
     if (isGetByPk) {
       const pkWhere = hasCompositePk ? `{ ${safePk.map((col) => `${col}: pk.${col}`).join(", ")} }` : `{ ${safePk[0] || "id"}: pk }`;
       const baseReturnType = method.returnType.replace(" | null", "");
@@ -2891,8 +2953,8 @@ export class ${Type}Client extends BaseClient {
     limit?: number;
     offset?: number;
     where?: Where<Select${Type}>;
-    orderBy?: string;
-    order?: "asc" | "desc";
+    orderBy?: string | string[];
+    order?: "asc" | "desc" | ("asc" | "desc")[];
   }): Promise<Select${Type}[]> {
     return this.post<Select${Type}[]>(\`\${this.resource}/list\`, params ?? {});
   }
@@ -4226,10 +4288,10 @@ function buildWhereClause(
  */
 export async function listRecords(
   ctx: OperationContext,
-  params: { where?: any; limit?: number; offset?: number; include?: any }
+  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 }> {
   try {
-    const { where: whereClause, limit = 50, offset = 0, include } = params;
+    const { where: whereClause, limit = 50, offset = 0, include, orderBy, order } = params;
 
     // Build WHERE clause
     let paramIndex = 1;
@@ -4253,12 +4315,26 @@ export async function listRecords(
 
     const whereSQL = whereParts.length > 0 ? \`WHERE \${whereParts.join(" AND ")}\` : "";
 
+    // Build ORDER BY clause
+    let orderBySQL = "";
+    if (orderBy) {
+      const columns = Array.isArray(orderBy) ? orderBy : [orderBy];
+      const directions = Array.isArray(order) ? order : (order ? Array(columns.length).fill(order) : Array(columns.length).fill("asc"));
+
+      const orderParts = columns.map((col, i) => {
+        const dir = (directions[i] || "asc").toUpperCase();
+        return \`"\${col}" \${dir}\`;
+      });
+
+      orderBySQL = \`ORDER BY \${orderParts.join(", ")}\`;
+    }
+
     // Add limit and offset params
     const limitParam = \`$\${paramIndex}\`;
     const offsetParam = \`$\${paramIndex + 1}\`;
     const allParams = [...whereParams, limit, offset];
 
-    const text = \`SELECT * FROM "\${ctx.table}" \${whereSQL} LIMIT \${limitParam} OFFSET \${offsetParam}\`;
+    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);

package/dist/core/operations.d.ts

@@ -39,6 +39,8 @@ export declare function listRecords(ctx: OperationContext, params: {
     limit?: number;
     offset?: number;
     include?: any;
+    orderBy?: string | string[];
+    order?: "asc" | "desc" | ("asc" | "desc")[];
 }): Promise<{
     data?: any;
     error?: string;

package/dist/index.js

@@ -792,9 +792,9 @@ const items = await sdk.${tableName}.list();
 const filtered = await sdk.${tableName}.list({
   limit: 20,
   offset: 0,
-  ${table.columns[0]?.name || "field"}_like: 'search',
-  order_by: '${table.columns[0]?.name || "created_at"}',
-  order_dir: 'desc'
+  where: { ${table.columns[0]?.name || "field"}: { $like: '%search%' } },
+  orderBy: '${table.columns[0]?.name || "created_at"}',
+  order: 'desc'
 });`,
     correspondsTo: `GET ${basePath}`
   });
@@ -1057,8 +1057,8 @@ function generateQueryParams(table) {
   const params = {
     limit: "number - Max records to return (default: 50)",
     offset: "number - Records to skip",
-    order_by: "string - Field to sort by",
-    order_dir: "'asc' | 'desc' - Sort direction"
+    orderBy: "string | string[] - Field(s) to sort by",
+    order: "'asc' | 'desc' | ('asc' | 'desc')[] - Sort direction(s)"
   };
   let filterCount = 0;
   for (const col of table.columns) {
@@ -1350,6 +1350,64 @@ function generateUnifiedContractMarkdown(contract) {
   lines.push("");
   lines.push("**Note:** The WHERE clause types are fully type-safe. TypeScript will only allow operators that are valid for each field type.");
   lines.push("");
+  lines.push("## Sorting");
+  lines.push("");
+  lines.push("Sort query results using the `orderBy` and `order` parameters. Supports both single and multi-column sorting.");
+  lines.push("");
+  lines.push("### Single Column Sorting");
+  lines.push("");
+  lines.push("```typescript");
+  lines.push("// Sort by one column ascending");
+  lines.push("const users = await sdk.users.list({");
+  lines.push("  orderBy: 'created_at',");
+  lines.push("  order: 'asc'");
+  lines.push("});");
+  lines.push("");
+  lines.push("// Sort descending");
+  lines.push("const latest = await sdk.users.list({");
+  lines.push("  orderBy: 'created_at',");
+  lines.push("  order: 'desc'");
+  lines.push("});");
+  lines.push("");
+  lines.push("// Order defaults to 'asc' if not specified");
+  lines.push("const sorted = await sdk.users.list({");
+  lines.push("  orderBy: 'name'");
+  lines.push("});");
+  lines.push("```");
+  lines.push("");
+  lines.push("### Multi-Column Sorting");
+  lines.push("");
+  lines.push("```typescript");
+  lines.push("// Sort by multiple columns (all same direction)");
+  lines.push("const users = await sdk.users.list({");
+  lines.push("  orderBy: ['status', 'created_at'],");
+  lines.push("  order: 'desc'");
+  lines.push("});");
+  lines.push("");
+  lines.push("// Different direction per column");
+  lines.push("const sorted = await sdk.users.list({");
+  lines.push("  orderBy: ['status', 'created_at'],");
+  lines.push("  order: ['asc', 'desc']  // status ASC, created_at DESC");
+  lines.push("});");
+  lines.push("```");
+  lines.push("");
+  lines.push("### Combining Sorting with Filters");
+  lines.push("");
+  lines.push("```typescript");
+  lines.push("const results = await sdk.users.list({");
+  lines.push("  where: {");
+  lines.push("    status: 'active',");
+  lines.push("    age: { $gte: 18 }");
+  lines.push("  },");
+  lines.push("  orderBy: 'created_at',");
+  lines.push("  order: 'desc',");
+  lines.push("  limit: 50,");
+  lines.push("  offset: 0");
+  lines.push("});");
+  lines.push("```");
+  lines.push("");
+  lines.push("**Note:** Column names are validated by Zod schemas. Only valid table columns are accepted, preventing SQL injection.");
+  lines.push("");
   lines.push("## Resources");
   lines.push("");
   for (const resource of contract.resources) {
@@ -1865,6 +1923,7 @@ function emitHonoRoutes(table, _graph, opts) {
   const hasAuth = opts.authStrategy && opts.authStrategy !== "none";
   const ext = opts.useJsExtensions ? ".js" : "";
   const authImport = hasAuth ? `import { authMiddleware } from "../auth${ext}";` : "";
+  const columnNames = table.columns.map((c) => `"${c.name}"`).join(", ");
   return `/**
  * AUTO-GENERATED FILE - DO NOT EDIT
  *
@@ -1881,12 +1940,15 @@ import { loadIncludes } from "../include-loader${ext}";
 import * as coreOps from "../core/operations${ext}";
 ${authImport}
 
+const columnEnum = z.enum([${columnNames}]);
+
 const listSchema = z.object({
   where: z.any().optional(),
   include: z.any().optional(),
   limit: z.number().int().positive().max(100).optional(),
   offset: z.number().int().min(0).optional(),
-  orderBy: z.any().optional()
+  orderBy: z.union([columnEnum, z.array(columnEnum)]).optional(),
+  order: z.union([z.enum(["asc", "desc"]), z.array(z.enum(["asc", "desc"]))]).optional()
 });
 
 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> }) {
@@ -2075,7 +2137,7 @@ function emitClient(table, graph, opts, model) {
   let includeMethodsCode = "";
   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; order?: "asc" | "desc"; }, "include">`;
+    const baseParams = isGetByPk ? "" : `params?: Omit<{ limit?: number; offset?: number; where?: Where<Select${Type}>; orderBy?: string | string[]; order?: "asc" | "desc" | ("asc" | "desc")[]; }, "include">`;
     if (isGetByPk) {
       const pkWhere = hasCompositePk ? `{ ${safePk.map((col) => `${col}: pk.${col}`).join(", ")} }` : `{ ${safePk[0] || "id"}: pk }`;
       const baseReturnType = method.returnType.replace(" | null", "");
@@ -2131,8 +2193,8 @@ export class ${Type}Client extends BaseClient {
     limit?: number;
     offset?: number;
     where?: Where<Select${Type}>;
-    orderBy?: string;
-    order?: "asc" | "desc";
+    orderBy?: string | string[];
+    order?: "asc" | "desc" | ("asc" | "desc")[];
   }): Promise<Select${Type}[]> {
     return this.post<Select${Type}[]>(\`\${this.resource}/list\`, params ?? {});
   }
@@ -3466,10 +3528,10 @@ function buildWhereClause(
  */
 export async function listRecords(
   ctx: OperationContext,
-  params: { where?: any; limit?: number; offset?: number; include?: any }
+  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 }> {
   try {
-    const { where: whereClause, limit = 50, offset = 0, include } = params;
+    const { where: whereClause, limit = 50, offset = 0, include, orderBy, order } = params;
 
     // Build WHERE clause
     let paramIndex = 1;
@@ -3493,12 +3555,26 @@ export async function listRecords(
 
     const whereSQL = whereParts.length > 0 ? \`WHERE \${whereParts.join(" AND ")}\` : "";
 
+    // Build ORDER BY clause
+    let orderBySQL = "";
+    if (orderBy) {
+      const columns = Array.isArray(orderBy) ? orderBy : [orderBy];
+      const directions = Array.isArray(order) ? order : (order ? Array(columns.length).fill(order) : Array(columns.length).fill("asc"));
+
+      const orderParts = columns.map((col, i) => {
+        const dir = (directions[i] || "asc").toUpperCase();
+        return \`"\${col}" \${dir}\`;
+      });
+
+      orderBySQL = \`ORDER BY \${orderParts.join(", ")}\`;
+    }
+
     // Add limit and offset params
     const limitParam = \`$\${paramIndex}\`;
     const offsetParam = \`$\${paramIndex + 1}\`;
     const allParams = [...whereParams, limit, offset];
 
-    const text = \`SELECT * FROM "\${ctx.table}" \${whereSQL} LIMIT \${limitParam} OFFSET \${offsetParam}\`;
+    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);

package/package.json

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