postgresdk 0.18.20 → 0.18.21

package/README.md

@@ -960,6 +960,27 @@ const results = await sdk.books.list({
 });
 ```
 
+**Multi-field trigram search:**
+```typescript
+// Greatest strategy (default): score = GREATEST(sim(name), sim(url))
+const results = await sdk.websites.list({
+  trigram: { fields: ["name", "url"], query: "google", strategy: "greatest" }
+});
+
+// Concat strategy: concatenate fields before scoring ("name url")
+const results = await sdk.websites.list({
+  trigram: { fields: ["name", "url"], query: "google", strategy: "concat" }
+});
+
+// Weighted strategy: weighted average of per-field scores
+const results = await sdk.websites.list({
+  trigram: {
+    fields: [{ field: "name", weight: 2 }, { field: "url", weight: 1 }],
+    query: "google"
+  }
+});
+```
+
 **Note:** `trigram` and `vector` are mutually exclusive on a single `list()` call.
 
 See the generated SDK documentation for all available operators: `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`, `$in`, `$nin`, `$like`, `$ilike`, `$similarity`, `$wordSimilarity`, `$strictWordSimilarity`, `$is`, `$isNot`, `$or`, `$and`, `$jsonbContains`, `$jsonbContainedBy`, `$jsonbHasKey`, `$jsonbHasAnyKeys`, `$jsonbHasAllKeys`, `$jsonbPath`.

package/dist/cli.js

@@ -3228,6 +3228,7 @@ function emitHonoRoutes(table, _graph, opts) {
   const fileTableName = table.name;
   const Type = pascal(table.name);
   const hasVectorColumns = table.columns.some((c) => isVectorType(c.pgType));
+  const trigramMetricZod = `z.enum(["similarity", "wordSimilarity", "strictWordSimilarity"]).optional()`;
   const vectorColumns = table.columns.filter((c) => isVectorType(c.pgType)).map((c) => c.name);
   const jsonbColumns = table.columns.filter((c) => isJsonbType(c.pgType)).map((c) => c.name);
   const rawPk = table.pk;
@@ -3294,12 +3295,27 @@ const listSchema = z.object({
     metric: z.enum(["cosine", "l2", "inner"]).optional(),
     maxDistance: z.number().optional()
   }).optional(),` : ""}
-  trigram: z.object({
-    field: z.string(),
-    query: z.string(),
-    metric: z.enum(["similarity", "wordSimilarity", "strictWordSimilarity"]).optional(),
-    threshold: z.number().min(0).max(1).optional()
-  }).optional()
+  trigram: z.union([
+    z.object({
+      field: z.string(),
+      query: z.string(),
+      metric: ${trigramMetricZod},
+      threshold: z.number().min(0).max(1).optional()
+    }),
+    z.object({
+      fields: z.array(z.string()).min(1),
+      strategy: z.enum(["greatest", "concat"]).optional(),
+      query: z.string(),
+      metric: ${trigramMetricZod},
+      threshold: z.number().min(0).max(1).optional()
+    }),
+    z.object({
+      fields: z.array(z.object({ field: z.string(), weight: z.number().positive() })).min(1),
+      query: z.string(),
+      metric: ${trigramMetricZod},
+      threshold: z.number().min(0).max(1).optional()
+    })
+  ]).optional()
 }).strict().refine(
   (data) => !(data.select && data.exclude),
   { message: "Cannot specify both 'select' and 'exclude' parameters" }
@@ -3567,6 +3583,7 @@ function analyzeIncludeSpec(includeSpec) {
 function emitClient(table, graph, opts, model) {
   const Type = pascal(table.name);
   const ext = opts.useJsExtensions ? ".js" : "";
+  const trigramParamType = `{ field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number } | { fields: string[]; strategy?: "greatest" | "concat"; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number } | { fields: Array<{ field: string; weight: number }>; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number }`;
   const hasVectorColumns = table.columns.some((c) => isVectorType2(c.pgType));
   const hasJsonbColumns = table.columns.some((c) => isJsonbType2(c.pgType));
   if (process.env.SDK_DEBUG) {
@@ -3970,7 +3987,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -3992,7 +4009,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -4025,7 +4042,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -4043,7 +4060,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -4066,7 +4083,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -4088,7 +4105,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -4115,7 +4132,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -4133,7 +4150,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -5928,7 +5945,7 @@ export async function createRecord(
 
     const preparedVals = vals.map((v, i) =>
       v !== null && v !== undefined && typeof v === 'object' &&
-      (ctx.jsonbColumns?.includes(cols[i]) || ctx.vectorColumns?.includes(cols[i]))
+      (ctx.jsonbColumns?.includes(cols[i]!) || ctx.vectorColumns?.includes(cols[i]!))
         ? JSON.stringify(v)
         : v
     );
@@ -6279,20 +6296,51 @@ function getVectorDistanceOperator(metric?: string): string {
   }
 }
 
+export type TrigramMetric = "similarity" | "wordSimilarity" | "strictWordSimilarity";
+
+export type TrigramParam =
+  | { field: string; query: string; metric?: TrigramMetric; threshold?: number }
+  | { fields: string[]; strategy?: "greatest" | "concat"; query: string; metric?: TrigramMetric; threshold?: number }
+  | { fields: Array<{ field: string; weight: number }>; query: string; metric?: TrigramMetric; threshold?: number };
+
 /**
- * Build the pg_trgm SQL function expression for a given field and metric.
+ * Build a pg_trgm function expression for a raw SQL field expression.
  * $1 is always the query string parameter.
  */
-function getTrigramFnExpr(field: string, metric?: string): string {
+function trigramFnRaw(fieldExpr: string, metric?: TrigramMetric): string {
   switch (metric) {
-    case "wordSimilarity":
-      return \`word_similarity($1, "\${field}")\`;
-    case "strictWordSimilarity":
-      return \`strict_word_similarity($1, "\${field}")\`;
-    case "similarity":
-    default:
-      return \`similarity("\${field}", $1)\`;
+    case "wordSimilarity":      return \`word_similarity($1, \${fieldExpr})\`;
+    case "strictWordSimilarity": return \`strict_word_similarity($1, \${fieldExpr})\`;
+    default:                    return \`similarity(\${fieldExpr}, $1)\`;
+  }
+}
+
+/** Build the full pg_trgm SQL expression for the given trigram param. */
+function getTrigramFnExpr(trigram: TrigramParam): string {
+  if ("field" in trigram) {
+    return trigramFnRaw(\`"\${trigram.field}"\`, trigram.metric);
+  }
+
+  const { fields, metric } = trigram;
+
+  // Weighted: fields is Array<{ field, weight }>
+  if (fields.length > 0 && typeof fields[0] === "object" && "weight" in fields[0]) {
+    const wfields = fields as Array<{ field: string; weight: number }>;
+    const totalWeight = wfields.reduce((sum, f) => sum + f.weight, 0);
+    const terms = wfields.map(f => \`\${trigramFnRaw(\`"\${f.field}"\`, metric)} * \${f.weight}\`).join(" + ");
+    return \`(\${terms}) / \${totalWeight}\`;
+  }
+
+  const sfields = fields as string[];
+  const strategy = (trigram as Extract<TrigramParam, { fields: string[] }>).strategy ?? "greatest";
+
+  if (strategy === "concat") {
+    const concatExpr = sfields.map(f => \`"\${f}"\`).join(\` || ' ' || \`);
+    return trigramFnRaw(concatExpr, metric);
   }
+
+  // greatest (default)
+  return \`GREATEST(\${sfields.map(f => trigramFnRaw(\`"\${f}"\`, metric)).join(", ")})\`;
 }
 
 /** Builds a SQL ORDER BY clause from parallel cols/dirs arrays. Returns "" when cols is empty. */
@@ -6320,12 +6368,7 @@ export async function listRecords(
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };
-    trigram?: {
-      field: string;
-      query: string;
-      metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity";
-      threshold?: number;
-    };
+    trigram?: TrigramParam;
   }
 ): Promise<{ data?: any; total?: number; limit?: number; offset?: number; hasMore?: boolean; error?: string; issues?: any; needsIncludes?: boolean; includeSpec?: any; status: number }> {
   try {
@@ -6351,7 +6394,7 @@ export async function listRecords(
     const distanceOp = vector ? getVectorDistanceOperator(vector.metric) : "";
 
     // Get trigram similarity SQL expression (pg_trgm). $1 is always the query string.
-    const trigramFnExpr = trigram ? getTrigramFnExpr(trigram.field, trigram.metric) : "";
+    const trigramFnExpr = trigram ? getTrigramFnExpr(trigram) : "";
 
     // Add vector or trigram query as $1 if present (mutually exclusive)
     const queryParams: any[] = vector

package/dist/index.js

@@ -2267,6 +2267,7 @@ function emitHonoRoutes(table, _graph, opts) {
   const fileTableName = table.name;
   const Type = pascal(table.name);
   const hasVectorColumns = table.columns.some((c) => isVectorType(c.pgType));
+  const trigramMetricZod = `z.enum(["similarity", "wordSimilarity", "strictWordSimilarity"]).optional()`;
   const vectorColumns = table.columns.filter((c) => isVectorType(c.pgType)).map((c) => c.name);
   const jsonbColumns = table.columns.filter((c) => isJsonbType(c.pgType)).map((c) => c.name);
   const rawPk = table.pk;
@@ -2333,12 +2334,27 @@ const listSchema = z.object({
     metric: z.enum(["cosine", "l2", "inner"]).optional(),
     maxDistance: z.number().optional()
   }).optional(),` : ""}
-  trigram: z.object({
-    field: z.string(),
-    query: z.string(),
-    metric: z.enum(["similarity", "wordSimilarity", "strictWordSimilarity"]).optional(),
-    threshold: z.number().min(0).max(1).optional()
-  }).optional()
+  trigram: z.union([
+    z.object({
+      field: z.string(),
+      query: z.string(),
+      metric: ${trigramMetricZod},
+      threshold: z.number().min(0).max(1).optional()
+    }),
+    z.object({
+      fields: z.array(z.string()).min(1),
+      strategy: z.enum(["greatest", "concat"]).optional(),
+      query: z.string(),
+      metric: ${trigramMetricZod},
+      threshold: z.number().min(0).max(1).optional()
+    }),
+    z.object({
+      fields: z.array(z.object({ field: z.string(), weight: z.number().positive() })).min(1),
+      query: z.string(),
+      metric: ${trigramMetricZod},
+      threshold: z.number().min(0).max(1).optional()
+    })
+  ]).optional()
 }).strict().refine(
   (data) => !(data.select && data.exclude),
   { message: "Cannot specify both 'select' and 'exclude' parameters" }
@@ -2606,6 +2622,7 @@ function analyzeIncludeSpec(includeSpec) {
 function emitClient(table, graph, opts, model) {
   const Type = pascal(table.name);
   const ext = opts.useJsExtensions ? ".js" : "";
+  const trigramParamType = `{ field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number } | { fields: string[]; strategy?: "greatest" | "concat"; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number } | { fields: Array<{ field: string; weight: number }>; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number }`;
   const hasVectorColumns = table.columns.some((c) => isVectorType2(c.pgType));
   const hasJsonbColumns = table.columns.some((c) => isJsonbType2(c.pgType));
   if (process.env.SDK_DEBUG) {
@@ -3009,7 +3026,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -3031,7 +3048,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -3064,7 +3081,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -3082,7 +3099,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -3105,7 +3122,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -3127,7 +3144,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -3154,7 +3171,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -3172,7 +3189,7 @@ ${hasJsonbColumns ? `  /**
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };` : ""}
-    trigram?: { field: string; query: string; metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity"; threshold?: number };
+    trigram?: ${trigramParamType};
     orderBy?: string | string[];
     order?: "asc" | "desc" | ("asc" | "desc")[];
     distinctOn?: string | string[];
@@ -4967,7 +4984,7 @@ export async function createRecord(
 
     const preparedVals = vals.map((v, i) =>
       v !== null && v !== undefined && typeof v === 'object' &&
-      (ctx.jsonbColumns?.includes(cols[i]) || ctx.vectorColumns?.includes(cols[i]))
+      (ctx.jsonbColumns?.includes(cols[i]!) || ctx.vectorColumns?.includes(cols[i]!))
         ? JSON.stringify(v)
         : v
     );
@@ -5318,20 +5335,51 @@ function getVectorDistanceOperator(metric?: string): string {
   }
 }
 
+export type TrigramMetric = "similarity" | "wordSimilarity" | "strictWordSimilarity";
+
+export type TrigramParam =
+  | { field: string; query: string; metric?: TrigramMetric; threshold?: number }
+  | { fields: string[]; strategy?: "greatest" | "concat"; query: string; metric?: TrigramMetric; threshold?: number }
+  | { fields: Array<{ field: string; weight: number }>; query: string; metric?: TrigramMetric; threshold?: number };
+
 /**
- * Build the pg_trgm SQL function expression for a given field and metric.
+ * Build a pg_trgm function expression for a raw SQL field expression.
  * $1 is always the query string parameter.
  */
-function getTrigramFnExpr(field: string, metric?: string): string {
+function trigramFnRaw(fieldExpr: string, metric?: TrigramMetric): string {
   switch (metric) {
-    case "wordSimilarity":
-      return \`word_similarity($1, "\${field}")\`;
-    case "strictWordSimilarity":
-      return \`strict_word_similarity($1, "\${field}")\`;
-    case "similarity":
-    default:
-      return \`similarity("\${field}", $1)\`;
+    case "wordSimilarity":      return \`word_similarity($1, \${fieldExpr})\`;
+    case "strictWordSimilarity": return \`strict_word_similarity($1, \${fieldExpr})\`;
+    default:                    return \`similarity(\${fieldExpr}, $1)\`;
+  }
+}
+
+/** Build the full pg_trgm SQL expression for the given trigram param. */
+function getTrigramFnExpr(trigram: TrigramParam): string {
+  if ("field" in trigram) {
+    return trigramFnRaw(\`"\${trigram.field}"\`, trigram.metric);
+  }
+
+  const { fields, metric } = trigram;
+
+  // Weighted: fields is Array<{ field, weight }>
+  if (fields.length > 0 && typeof fields[0] === "object" && "weight" in fields[0]) {
+    const wfields = fields as Array<{ field: string; weight: number }>;
+    const totalWeight = wfields.reduce((sum, f) => sum + f.weight, 0);
+    const terms = wfields.map(f => \`\${trigramFnRaw(\`"\${f.field}"\`, metric)} * \${f.weight}\`).join(" + ");
+    return \`(\${terms}) / \${totalWeight}\`;
+  }
+
+  const sfields = fields as string[];
+  const strategy = (trigram as Extract<TrigramParam, { fields: string[] }>).strategy ?? "greatest";
+
+  if (strategy === "concat") {
+    const concatExpr = sfields.map(f => \`"\${f}"\`).join(\` || ' ' || \`);
+    return trigramFnRaw(concatExpr, metric);
   }
+
+  // greatest (default)
+  return \`GREATEST(\${sfields.map(f => trigramFnRaw(\`"\${f}"\`, metric)).join(", ")})\`;
 }
 
 /** Builds a SQL ORDER BY clause from parallel cols/dirs arrays. Returns "" when cols is empty. */
@@ -5359,12 +5407,7 @@ export async function listRecords(
       metric?: "cosine" | "l2" | "inner";
       maxDistance?: number;
     };
-    trigram?: {
-      field: string;
-      query: string;
-      metric?: "similarity" | "wordSimilarity" | "strictWordSimilarity";
-      threshold?: number;
-    };
+    trigram?: TrigramParam;
   }
 ): Promise<{ data?: any; total?: number; limit?: number; offset?: number; hasMore?: boolean; error?: string; issues?: any; needsIncludes?: boolean; includeSpec?: any; status: number }> {
   try {
@@ -5390,7 +5433,7 @@ export async function listRecords(
     const distanceOp = vector ? getVectorDistanceOperator(vector.metric) : "";
 
     // Get trigram similarity SQL expression (pg_trgm). $1 is always the query string.
-    const trigramFnExpr = trigram ? getTrigramFnExpr(trigram.field, trigram.metric) : "";
+    const trigramFnExpr = trigram ? getTrigramFnExpr(trigram) : "";
 
     // Add vector or trigram query as $1 if present (mutually exclusive)
     const queryParams: any[] = vector

package/package.json

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