@syncular/typegen 0.15.0 → 0.15.1

package/README.md

@@ -470,8 +470,10 @@ For FTS-backed named queries the synthesized type-check database creates the
 same declared columns plus `_syncular_source_id UNINDEXED`. `MATCH :query`
 infers a string parameter, and the FTS table reference is folded into its
 owning synced table for dependency and scope-coverage metadata. `bm25`,
-`highlight`, and `snippet` remain SQLite expressions and therefore use the
-normal computed-expression fidelity rules.
+`highlight`, and `snippet` are accepted deterministic FTS5 auxiliary
+functions only when the query references a schema-declared FTS projection;
+they use the normal computed-expression fidelity rules. Arbitrary extension
+functions remain outside the portable profile.
 
 **Typing fidelity** (what `bun:sqlite` actually exposes, and its honest
 boundary):

package/dist/syql-validator.js

@@ -121,6 +121,16 @@ const SQLITE_346_PORTABLE_FUNCTIONS = new Set([
     'jsonb_replace',
     'jsonb_set',
 ]);
+/**
+ * Deterministic FTS5 auxiliary functions available only when the query reads
+ * a schema-declared FTS projection. FTS5 is an explicit Syncular client
+ * requirement in that case, not an arbitrary host extension.
+ */
+const SQLITE_FTS5_AUXILIARY_FUNCTIONS = new Set([
+    'bm25',
+    'highlight',
+    'snippet',
+]);
 const SQL_PAREN_KEYWORDS = new Set([
     'and',
     'as',
@@ -248,8 +258,8 @@ class Validator {
         const activeStructure = this.#inspect(activeSql, location);
         this.#validateStatementShape(activeSql, activeStructure, logical.declaration, location);
         this.#validateDeterminism(activeSql, logical.declaration.statement.span);
-        this.#validatePortableProfile(activeSql, logical.declaration.statement.span);
         const refs = scanTableRefs(activeSql, this.#ir);
+        this.#validatePortableProfile(activeSql, logical.declaration.statement.span, refs);
         const bindSymbols = this.#bindSymbols(logical.declaration);
         const bindTypes = this.#resolveBindTypes(logical, activeSql, refs, bindSymbols);
         const sort = this.#validateSort(logical.declaration, activeStructure, location);
@@ -512,8 +522,11 @@ class Validator {
             }
         }
     }
-    #validatePortableProfile(sql, span) {
+    #validatePortableProfile(sql, span, refs) {
         const tokens = significant(lexSyqlSqlSource(span.file, sql));
+        const declaredFtsTables = new Set(this.#ir.tables.flatMap((table) => table.ftsIndexes.map((index) => index.name)));
+        const queryRefs = refs ?? scanTableRefs(sql, this.#ir);
+        const readsDeclaredFts = queryRefs.some((ref) => declaredFtsTables.has(ref.table));
         for (let index = 0; index < tokens.length; index += 1) {
             const token = tokens[index];
             const lower = tokenLower(token);
@@ -537,8 +550,10 @@ class Validator {
                 tokens[closeIndex + 2]?.text === '(') {
                 continue;
             }
-            if (!SQLITE_346_PORTABLE_FUNCTIONS.has(lower ?? '')) {
-                this.#fail('SYQL6002_INVALID_SQL', token.span, `${token.text}() is not a core built-in in the portable SQLite 3.46.0 profile`);
+            const allowedFtsAuxiliary = readsDeclaredFts && SQLITE_FTS5_AUXILIARY_FUNCTIONS.has(lower ?? '');
+            if (!SQLITE_346_PORTABLE_FUNCTIONS.has(lower ?? '') &&
+                !allowedFtsAuxiliary) {
+                this.#fail('SYQL6002_INVALID_SQL', token.span, `${token.text}() is not a core built-in in the portable SQLite 3.46.0 profile or an auxiliary function of a referenced schema-declared FTS5 projection`);
             }
             const argumentCount = functionArgumentCount(tokens, index + 1);
             if (lower === 'iif' && argumentCount !== 3) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncular/typegen",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "description": "Syncular schema-to-TypeScript type generator and the `syncular` CLI",
   "license": "Apache-2.0",
   "author": "Benjamin Kniffler",
@@ -48,7 +48,7 @@
     "!dist/**/*.test.d.ts"
   ],
   "devDependencies": {
-    "@syncular/core": "0.15.0",
-    "@syncular/server": "0.15.0"
+    "@syncular/core": "0.15.1",
+    "@syncular/server": "0.15.1"
   }
 }

package/src/syql-validator.ts

@@ -221,6 +221,16 @@ const SQLITE_346_PORTABLE_FUNCTIONS = new Set([
   'jsonb_replace',
   'jsonb_set',
 ]);
+/**
+ * Deterministic FTS5 auxiliary functions available only when the query reads
+ * a schema-declared FTS projection. FTS5 is an explicit Syncular client
+ * requirement in that case, not an arbitrary host extension.
+ */
+const SQLITE_FTS5_AUXILIARY_FUNCTIONS = new Set([
+  'bm25',
+  'highlight',
+  'snippet',
+]);
 const SQL_PAREN_KEYWORDS = new Set([
   'and',
   'as',
@@ -376,12 +386,13 @@ class Validator {
       location,
     );
     this.#validateDeterminism(activeSql, logical.declaration.statement.span);
+    const refs = scanTableRefs(activeSql, this.#ir);
     this.#validatePortableProfile(
       activeSql,
       logical.declaration.statement.span,
+      refs,
     );
 
-    const refs = scanTableRefs(activeSql, this.#ir);
     const bindSymbols = this.#bindSymbols(logical.declaration);
     const bindTypes = this.#resolveBindTypes(
       logical,
@@ -792,8 +803,21 @@ class Validator {
     }
   }
 
-  #validatePortableProfile(sql: string, span: SyqlSourceSpan): void {
+  #validatePortableProfile(
+    sql: string,
+    span: SyqlSourceSpan,
+    refs?: readonly TableRef[],
+  ): void {
     const tokens = significant(lexSyqlSqlSource(span.file, sql));
+    const declaredFtsTables = new Set(
+      this.#ir.tables.flatMap((table) =>
+        table.ftsIndexes.map((index) => index.name),
+      ),
+    );
+    const queryRefs = refs ?? scanTableRefs(sql, this.#ir);
+    const readsDeclaredFts = queryRefs.some((ref) =>
+      declaredFtsTables.has(ref.table),
+    );
     for (let index = 0; index < tokens.length; index += 1) {
       const token = tokens[index] as SyqlToken;
       const lower = tokenLower(token);
@@ -828,11 +852,16 @@ class Validator {
       ) {
         continue;
       }
-      if (!SQLITE_346_PORTABLE_FUNCTIONS.has(lower ?? '')) {
+      const allowedFtsAuxiliary =
+        readsDeclaredFts && SQLITE_FTS5_AUXILIARY_FUNCTIONS.has(lower ?? '');
+      if (
+        !SQLITE_346_PORTABLE_FUNCTIONS.has(lower ?? '') &&
+        !allowedFtsAuxiliary
+      ) {
         this.#fail(
           'SYQL6002_INVALID_SQL',
           token.span,
-          `${token.text}() is not a core built-in in the portable SQLite 3.46.0 profile`,
+          `${token.text}() is not a core built-in in the portable SQLite 3.46.0 profile or an auxiliary function of a referenced schema-declared FTS5 projection`,
         );
       }