@vibeorm/extensions 2.3.2 → 4.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 VibeORM contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -73,6 +73,8 @@ const hits = await db.post.search({
 
 `highlights` is `readonly string[] | null`; it is `null` when no highlight was requested and on engines without highlighting.
 
+`row` holds the model's columns, read exactly as `findMany` reads them, for `search` and for vector `nearest`. Generated artifact columns (the tsvector column) and `Unsupported(...)` columns such as the vector itself are not model fields and are not returned.
+
 ### Engines per dialect
 
 `engine: "auto"` (the default) picks the dialect's native engine. `resolveSearchEngine({ dialect, provider, requested })` is the exported resolution rule.

package/dist/index.js

@@ -84,7 +84,7 @@ async function pgExtensionCheck(params) {
 }
 
 // packages/extensions/src/search/index.ts
-import { ParamCollector, getSqlDialect, renderExpr } from "@vibeorm/sql";
+import { ParamCollector, getSqlDialect, renderExpr, renderSqliteFtsUpdateTrigger } from "@vibeorm/sql";
 var VERSION = "2.0.0-alpha.2";
 var SCORE_ALIAS = "_vibe_score";
 var HIGHLIGHT_ALIAS = "_vibe_highlight";
@@ -327,6 +327,17 @@ function readDeclaration(params) {
     filterFields: declStringArray(params.declaration, "filterFields")
   };
 }
+function resolveLanguage(params) {
+  const language = params.decl.language ?? params.options["language"] ?? "english";
+  if (!isSafeSqlName({ name: language })) {
+    throw new VibeError2({
+      code: "VIBE_SCHEMA_INVALID",
+      message: `search language "${language}" is not a plain text-search config name`,
+      meta: { model: params.model.name, language }
+    });
+  }
+  return language;
+}
 function weightLetters(params) {
   const { decl } = params;
   if (decl.weights === undefined || decl.weights.length !== decl.fields.length)
@@ -438,12 +449,12 @@ function searchArtifacts(ctx) {
     const decl = readDeclaration({ model, declaration });
     if (decl === null)
       continue;
+    const language = resolveLanguage({ model, decl, options: ctx.options });
     const table = tableNameOf({ model });
     const columns = decl.fields.map((field) => columnNameOf({ model, field }));
     resolveRank({ decl, options: ctx.options, engine, dialect: ctx.dialect });
     assertBm25Declarations({ decl, engine, dialect: ctx.dialect });
     if (engine === "tsvector") {
-      const language = decl.language ?? ctx.options["language"] ?? "english";
       const { tsvColumn, indexName } = resolveArtifactNames({ decl, engine, dialect: ctx.dialect });
       const expression = tsvectorExpression({ dialect, model, decl, language });
       artifacts.push({
@@ -501,6 +512,7 @@ function searchArtifacts(ctx) {
       const columnList = columns.map((column) => quote(column)).join(", ");
       const newList = columns.map((column) => `new.${quote(column)}`).join(", ");
       const oldList = columns.map((column) => `old.${quote(column)}`).join(", ");
+      const updateTrigger = renderSqliteFtsUpdateTrigger({ table, ftsTable: fts, columns });
       artifacts.push({
         id: `search:${modelName}:fts5-table`,
         owns: {
@@ -522,10 +534,7 @@ END;`,
           `CREATE TRIGGER IF NOT EXISTS ${quote(`${fts}_ad`)} AFTER DELETE ON ${quote(table)} BEGIN
   INSERT INTO ${quote(fts)}(${quote(fts)}, rowid, ${columnList}) VALUES ('delete', old.rowid, ${oldList});
 END;`,
-          `CREATE TRIGGER IF NOT EXISTS ${quote(`${fts}_au`)} AFTER UPDATE ON ${quote(table)} BEGIN
-  INSERT INTO ${quote(fts)}(${quote(fts)}, rowid, ${columnList}) VALUES ('delete', old.rowid, ${oldList});
-  INSERT INTO ${quote(fts)}(rowid, ${columnList}) VALUES (new.rowid, ${newList});
-END;`,
+          updateTrigger.create,
           `INSERT INTO ${quote(fts)}(${quote(fts)}) VALUES ('rebuild');`
         ],
         drop: [
@@ -533,6 +542,17 @@ END;`,
           `DROP TRIGGER IF EXISTS ${quote(`${fts}_ad`)};`,
           `DROP TRIGGER IF EXISTS ${quote(`${fts}_au`)};`
         ]
+      }, {
+        id: `search:${modelName}:fts5-update-trigger`,
+        owns: { kind: "trigger", table, name: `${fts}_au` },
+        expected: {
+          identity: { kind: "trigger", table: { namespace: "main", name: table }, name: `${fts}_au` },
+          facts: { definition: updateTrigger.definition, type: "trigger" },
+          dependencies: [],
+          format: "catalog-v2"
+        },
+        create: [],
+        drop: []
       });
       continue;
     }
@@ -563,15 +583,13 @@ function highlightColumn(params) {
   return field.column;
 }
 function shapeHits(params) {
-  const { rows, strip, highlightsRequested, engineHasHighlights } = params;
+  const { rows, highlightsRequested, engineHasHighlights } = params;
   return rows.map((raw) => {
     const row = { ...raw };
     const score = Number(row[SCORE_ALIAS]);
     const highlight = row[HIGHLIGHT_ALIAS];
     delete row[SCORE_ALIAS];
     delete row[HIGHLIGHT_ALIAS];
-    for (const name of strip)
-      delete row[name];
     const highlights = engineHasHighlights && highlightsRequested && highlight !== null && highlight !== undefined ? [String(highlight)] : null;
     return { row, score, highlights };
   });
@@ -581,6 +599,7 @@ function createSearchDelegate(config) {
     const dialect = ctx.dialect;
     const quote = (name) => dialect.quoteIdent({ name });
     const t = quote("t");
+    const pkColumns = ctx.model === null ? config.pkColumn === undefined || config.pkColumn === "" ? [] : [config.pkColumn] : ctx.model.primaryKey.map((field) => field.columnName);
     return async (args) => {
       if (typeof args.query !== "string" || args.query.trim().length === 0) {
         throw new VibeError2({
@@ -632,7 +651,14 @@ function createSearchDelegate(config) {
           meta: { table: config.table }
         });
       }
-      const projection = idOnly ? `${t}.${quote(config.pkColumn ?? "")}` : `${t}.*`;
+      if (pkColumns.length === 0) {
+        throw new VibeError2({
+          code: "VIBE_CONFIG",
+          message: `search needs primary-key metadata for deterministic ordering: ${config.table} has no model key, or the legacy mount has no explicit pkColumn`,
+          meta: { table: config.table }
+        });
+      }
+      const projection = idOnly ? `${t}.${quote(config.pkColumn ?? "")}` : ctx.projection({ qualify: "t" });
       const collector = new ParamCollector(dialect);
       const userWhere = (qualify) => {
         if (args.where === undefined)
@@ -641,13 +667,13 @@ function createSearchDelegate(config) {
         return expr === undefined ? null : renderExpr({ dialect, expr, collector });
       };
       let text;
-      let strip = [];
       let engineHasHighlights = true;
       if (config.engine === "tsvector") {
         const language = config.language ?? "english";
         const ranker = config.rank ?? "ts_rank_cd";
         const tsv = `${t}.${quote(config.tsvColumn ?? "")}`;
-        const tsquery = () => prefix ? `to_tsquery('${language}', ${collector.add(matchText)})` : `websearch_to_tsquery('${language}', ${collector.add(matchText)})`;
+        const queryParameter = dialect.name === "postgres" ? collector.add(matchText) : undefined;
+        const tsquery = () => prefix ? `to_tsquery('${language}', ${queryParameter ?? collector.add(matchText)})` : `websearch_to_tsquery('${language}', ${queryParameter ?? collector.add(matchText)})`;
         text = `SELECT ${projection}, ${ranker}(${tsv}, ${tsquery()}) AS ${quote(SCORE_ALIAS)}`;
         if (hlColumn !== null) {
           text += `, ts_headline('${language}', ${t}.${quote(hlColumn)}, ${tsquery()}) AS ${quote(HIGHLIGHT_ALIAS)}`;
@@ -659,8 +685,6 @@ function createSearchDelegate(config) {
         if (args.minScore !== undefined) {
           text += ` AND ${ranker}(${tsv}, ${tsquery()}) >= ${collector.add(args.minScore)}`;
         }
-        text += ` ORDER BY ${quote(SCORE_ALIAS)} DESC`;
-        strip = idOnly ? [] : [config.tsvColumn ?? ""];
       } else if (config.engine === "fts5") {
         const fts = quote(config.ftsTable ?? "");
         text = `SELECT ${projection}, -bm25(${fts}) AS ${quote(SCORE_ALIAS)}`;
@@ -676,7 +700,6 @@ function createSearchDelegate(config) {
         if (args.minScore !== undefined) {
           text += ` AND -bm25(${fts}) >= ${collector.add(args.minScore)}`;
         }
-        text += ` ORDER BY ${quote(SCORE_ALIAS)} DESC`;
       } else if (config.engine === "fulltext") {
         engineHasHighlights = false;
         const mode = prefix ? "IN BOOLEAN MODE" : "IN NATURAL LANGUAGE MODE";
@@ -689,7 +712,6 @@ function createSearchDelegate(config) {
         if (args.minScore !== undefined) {
           text += ` AND ${match()} >= ${collector.add(args.minScore)}`;
         }
-        text += ` ORDER BY ${quote(SCORE_ALIAS)} DESC`;
       } else {
         const pk = `${t}.${quote(config.pkColumn ?? "")}`;
         const operator = prefix || fuzzy !== undefined ? "&&&" : "@@@";
@@ -709,15 +731,14 @@ function createSearchDelegate(config) {
         if (args.minScore !== undefined) {
           text += ` AND paradedb.score(${pk}) >= ${collector.add(args.minScore)}`;
         }
-        text += ` ORDER BY ${quote(SCORE_ALIAS)} DESC`;
       }
+      text += ` ORDER BY ${quote(SCORE_ALIAS)} DESC, ${pkColumns.map((column) => `${t}.${quote(column)} ASC`).join(", ")}`;
       text += ` LIMIT ${take}`;
       if (skip !== null)
         text += ` OFFSET ${skip}`;
       const rows = await ctx.executeRows({ text, values: collector.values, method: "search" });
       return shapeHits({
         rows,
-        strip,
         highlightsRequested: args.highlight !== undefined,
         engineHasHighlights
       });
@@ -794,14 +815,7 @@ function search(options = {}) {
           return null;
         const requested = extOptions["engine"] ?? "auto";
         const engine = resolveSearchEngine({ dialect, provider, requested });
-        const language = decl.language ?? extOptions["language"] ?? "english";
-        if (!isSafeSqlName({ name: language })) {
-          throw new VibeError2({
-            code: "VIBE_SCHEMA_INVALID",
-            message: `search language "${language}" is not a plain text-search config name`,
-            meta: { model: model.name, language }
-          });
-        }
+        const language = resolveLanguage({ model, decl, options: extOptions });
         const pkField = primaryKeyFieldOf({ model });
         const rank = resolveRank({ decl, options: extOptions, engine, dialect });
         assertBm25Declarations({ decl, engine, dialect });
@@ -1055,7 +1069,8 @@ function createVectorNamespace(config) {
         const op = METRIC_OPERATOR[metric];
         const col = `${t}.${quote(column)}`;
         const collector = new ParamCollector2(dialect);
-        let text = `SELECT ${t}.*, (${col} ${op} ${collector.add(literal)}) AS ${quote(DISTANCE_ALIAS)}`;
+        const vector = dialect.name === "postgres" ? collector.add(literal) : undefined;
+        let text = `SELECT ${ctx.projection({ qualify: "t" })}, (${col} ${op} ${vector ?? collector.add(literal)}) AS ${quote(DISTANCE_ALIAS)}`;
         text += ` FROM ${quote(config.table)} AS ${t}`;
         text += ` WHERE ${col} IS NOT NULL`;
         if (args.where !== undefined) {
@@ -1064,9 +1079,9 @@ function createVectorNamespace(config) {
             text += ` AND (${renderExpr2({ dialect, expr, collector })})`;
         }
         if (args.maxDistance !== undefined) {
-          text += ` AND (${col} ${op} ${collector.add(literal)}) < ${collector.add(args.maxDistance)}`;
+          text += ` AND (${col} ${op} ${vector ?? collector.add(literal)}) < ${collector.add(args.maxDistance)}`;
         }
-        text += ` ORDER BY ${col} ${op} ${collector.add(literal)} LIMIT ${take}`;
+        text += ` ORDER BY ${col} ${op} ${vector ?? collector.add(literal)} LIMIT ${take}`;
         const rows = await ctx.executeRows({
           text,
           values: collector.values,
@@ -1400,4 +1415,4 @@ export {
   vector
 };
 
-//# debugId=8FC9F7443F3A892664756E2164756E21
+//# debugId=890DEA10C4EC860C64756E2164756E21