@powersync/service-sync-rules 0.0.0-dev-20251209070120 → 0.0.0-dev-20260114145741

package/dist/BaseSqlDataQuery.d.ts

@@ -4,7 +4,7 @@ import { ColumnDefinition } from './ExpressionType.js';
 import { SourceTableInterface } from './SourceTableInterface.js';
 import { AvailableTable, SqlTools } from './sql_filters.js';
 import { TablePattern } from './TablePattern.js';
-import { BucketIdTransformer, EvaluationResult, QueryParameters, QuerySchema, SourceSchema, SourceSchemaTable, SqliteJsonRow, SqliteRow } from './types.js';
+import { QueryParameters, QuerySchema, UnscopedEvaluationResult, SourceSchema, SourceSchemaTable, SqliteJsonRow, SqliteRow } from './types.js';
 export interface RowValueExtractor {
     extract(tables: QueryParameters, into: SqliteRow): void;
     getTypes(schema: QuerySchema, into: Record<string, ColumnDefinition>): void;
@@ -12,8 +12,7 @@ export interface RowValueExtractor {
 export interface EvaluateRowOptions {
     table: SourceTableInterface;
     row: SqliteRow;
-    bucketIds: (params: QueryParameters) => string[];
-    bucketIdTransformer: BucketIdTransformer | null;
+    serializedBucketParameters: (params: QueryParameters) => string[];
 }
 export interface BaseSqlDataQueryOptions {
     sourceTable: TablePattern;
@@ -21,7 +20,6 @@ export interface BaseSqlDataQueryOptions {
     sql: string;
     columns: SelectedColumn[];
     extractors: RowValueExtractor[];
-    descriptorName: string;
     bucketParameters: string[];
     tools: SqlTools;
     errors?: SqlRuleError[];
@@ -51,10 +49,6 @@ export declare class BaseSqlDataQuery {
      * This may include plain column names, wildcards, and basic expressions.
      */
     readonly extractors: RowValueExtractor[];
-    /**
-     * Bucket definition name.
-     */
-    readonly descriptorName: string;
     /**
      * Bucket parameter names, without the `bucket.` prefix.
      *
@@ -78,7 +72,7 @@ export declare class BaseSqlDataQuery {
         columns: ColumnDefinition[];
     }[];
     resolveResultSets(schema: SourceSchema, tables: Record<string, Record<string, ColumnDefinition>>): void;
-    evaluateRowWithOptions(options: Omit<EvaluateRowOptions, 'bucketIdTransformer'>): EvaluationResult[];
+    evaluateRowWithOptions(options: EvaluateRowOptions): UnscopedEvaluationResult[];
     protected transformRow(tables: QueryParameters): SqliteJsonRow;
     protected getColumnOutputsFor(schemaTable: SourceSchemaTable, output: Record<string, ColumnDefinition>): void;
 }

package/dist/BaseSqlDataQuery.js

@@ -1,5 +1,5 @@
-import { filterJsonRow } from './utils.js';
 import { castAsText } from './sql_functions.js';
+import { filterJsonRow } from './utils.js';
 export class BaseSqlDataQuery {
     /**
      * Source table or table pattern.
@@ -25,10 +25,6 @@ export class BaseSqlDataQuery {
      * This may include plain column names, wildcards, and basic expressions.
      */
     extractors;
-    /**
-     * Bucket definition name.
-     */
-    descriptorName;
     /**
      * Bucket parameter names, without the `bucket.` prefix.
      *
@@ -47,7 +43,6 @@ export class BaseSqlDataQuery {
         this.sql = options.sql;
         this.columns = options.columns;
         this.extractors = options.extractors;
-        this.descriptorName = options.descriptorName;
         this.bucketParameters = options.bucketParameters;
         this.tools = options.tools;
         this.errors = options.errors ?? [];
@@ -122,9 +117,14 @@ export class BaseSqlDataQuery {
     }
     evaluateRowWithOptions(options) {
         try {
-            const { table, row, bucketIds } = options;
+            const { table, row, serializedBucketParameters } = options;
             const tables = { [this.table.nameInSchema]: this.addSpecialParameters(table, row) };
-            const resolvedBucketIds = bucketIds(tables);
+            // Array of _serialized_ parameters, one per output result.
+            const resolvedBucketParameters = serializedBucketParameters(tables);
+            if (resolvedBucketParameters.length == 0) {
+                // Short-circuit: No need to transform the row if there are no matching buckets.
+                return [];
+            }
             const data = this.transformRow(tables);
             let id = data.id;
             if (typeof id != 'string') {
@@ -137,9 +137,9 @@ export class BaseSqlDataQuery {
                 id = castAsText(id) ?? '';
             }
             const outputTable = this.getOutputName(table.name);
-            return resolvedBucketIds.map((bucketId) => {
+            return resolvedBucketParameters.map((serializedBucketParameters) => {
                 return {
-                    bucket: bucketId,
+                    serializedBucketParameters,
                     table: outputTable,
                     id: id,
                     data

package/dist/BaseSqlDataQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"BaseSqlDataQuery.js","sourceRoot":"","sources":["../src/BaseSqlDataQuery.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AA0BhD,MAAM,OAAO,gBAAgB;IAC3B;;OAEG;IACM,WAAW,CAAe;IAEnC;;;;OAIG;IACM,KAAK,CAAiB;IAE/B;;OAEG;IACM,GAAG,CAAS;IAErB;;OAEG;IACM,OAAO,CAAmB;IAEnC;;;;OAIG;IACM,UAAU,CAAsB;IAEzC;;OAEG;IACM,cAAc,CAAS;IAChC;;;;;OAKG;IACM,gBAAgB,CAAW;IACpC;;OAEG;IACc,KAAK,CAAW;IAExB,MAAM,CAAiB;IAEhC,YAAY,OAAgC;QAC1C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;IACrC,CAAC;IAED,OAAO,CAAC,KAA2B;QACjC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,oBAAoB,CAAC,KAA2B,EAAE,GAAc;QAC9D,IAAI,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;YAChC,OAAO;gBACL,GAAG,GAAG;gBACN,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;aACnD,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IAED,aAAa,CAAC,WAAmB;QAC/B,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC;YAC/B,sCAAsC;YACtC,OAAO,WAAW,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,mBAAmB;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;IAC9D,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC5B,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gBAAgB,CAAC,MAAoB;QACnC,IAAI,MAAM,GAAoD,EAAE,CAAC;QAEjE,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC;YAC/B,mBAAmB;YACnB,KAAK,IAAI,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC3D,IAAI,MAAM,GAAqC,EAAE,CAAC;gBAElD,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBAE9C,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC;oBAC1C,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;iBAC/B,CAAC,CAAC;YACL,CAAC;QACH,CAAC;aAAM,CAAC;YACN,iBAAiB;YACjB,IAAI,MAAM,GAAqC,EAAE,CAAC;YAClD,KAAK,IAAI,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC3D,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YAChD,CAAC;YACD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;gBACxB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;aAC/B,CAAC,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,iBAAiB,CAAC,MAAoB,EAAE,MAAwD;QAC9F,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAChD,KAAK,IAAI,KAAK,IAAI,SAAS,EAAE,CAAC;YAC5B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAC1B,KAAK,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBACjC,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oBACxB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC;gBAC7C,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,sBAAsB,CAAC,OAAwD;QAC7E,IAAI,CAAC;YACH,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;YAE1C,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;YACpF,MAAM,iBAAiB,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;YAE5C,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACvC,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;YACjB,IAAI,OAAO,EAAE,IAAI,QAAQ,EAAE,CAAC;gBAC1B,0EAA0E;gBAC1E,+EAA+E;gBAC/E,6BAA6B;gBAC7B,oFAAoF;gBACpF,kFAAkF;gBAClF,YAAY;gBACZ,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;YAC5B,CAAC;YACD,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAEnD,OAAO,iBAAiB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;gBACxC,OAAO;oBACL,MAAM,EAAE,QAAQ;oBAChB,KAAK,EAAE,WAAW;oBAClB,EAAE,EAAE,EAAE;oBACN,IAAI;iBACe,CAAC;YACxB,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,IAAI,8BAA8B,EAAE,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IAES,YAAY,CAAC,MAAuB;QAC5C,IAAI,MAAM,GAAc,EAAE,CAAC;QAC3B,KAAK,IAAI,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACtC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAES,mBAAmB,CAAC,WAA8B,EAAE,MAAwC;QACpG,MAAM,WAAW,GAAgB;YAC/B,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;gBAC3B,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;oBACrC,OAAO,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACvC,CAAC;qBAAM,CAAC;oBACN,2BAA2B;oBAC3B,OAAO,SAAS,CAAC;gBACnB,CAAC;YACH,CAAC;YACD,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;gBACpB,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;oBACrC,OAAO,WAAW,CAAC,UAAU,EAAE,CAAC;gBAClC,CAAC;qBAAM,CAAC;oBACN,OAAO,EAAE,CAAC;gBACZ,CAAC;YACH,CAAC;SACF,CAAC;QACF,KAAK,IAAI,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACtC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"BaseSqlDataQuery.js","sourceRoot":"","sources":["../src/BaseSqlDataQuery.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAYhD,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAwB3C,MAAM,OAAO,gBAAgB;IAC3B;;OAEG;IACM,WAAW,CAAe;IAEnC;;;;OAIG;IACM,KAAK,CAAiB;IAE/B;;OAEG;IACM,GAAG,CAAS;IAErB;;OAEG;IACM,OAAO,CAAmB;IAEnC;;;;OAIG;IACM,UAAU,CAAsB;IAEzC;;;;;OAKG;IACM,gBAAgB,CAAW;IACpC;;OAEG;IACc,KAAK,CAAW;IAExB,MAAM,CAAiB;IAEhC,YAAY,OAAgC;QAC1C,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC;IACrC,CAAC;IAED,OAAO,CAAC,KAA2B;QACjC,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,oBAAoB,CAAC,KAA2B,EAAE,GAAc;QAC9D,IAAI,IAAI,CAAC,WAAW,CAAC,UAAU,EAAE,CAAC;YAChC,OAAO;gBACL,GAAG,GAAG;gBACN,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;aACnD,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IAED,aAAa,CAAC,WAAmB;QAC/B,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC;YAC/B,sCAAsC;YACtC,OAAO,WAAW,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;QAC5B,CAAC;IACH,CAAC;IAED,mBAAmB;QACjB,OAAO,IAAI,CAAC,WAAW,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC;IAC9D,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YAC5B,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,gBAAgB,CAAC,MAAoB;QACnC,IAAI,MAAM,GAAoD,EAAE,CAAC;QAEjE,IAAI,IAAI,CAAC,mBAAmB,EAAE,EAAE,CAAC;YAC/B,mBAAmB;YACnB,KAAK,IAAI,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC3D,IAAI,MAAM,GAAqC,EAAE,CAAC;gBAElD,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gBAE9C,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC;oBAC1C,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;iBAC/B,CAAC,CAAC;YACL,CAAC;QACH,CAAC;aAAM,CAAC;YACN,iBAAiB;YACjB,IAAI,MAAM,GAAqC,EAAE,CAAC;YAClD,KAAK,IAAI,WAAW,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC3D,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;YAChD,CAAC;YACD,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;gBACxB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;aAC/B,CAAC,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,iBAAiB,CAAC,MAAoB,EAAE,MAAwD;QAC9F,MAAM,SAAS,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAChD,KAAK,IAAI,KAAK,IAAI,SAAS,EAAE,CAAC;YAC5B,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAC1B,KAAK,IAAI,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;gBACjC,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;oBACxB,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC;gBAC7C,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,sBAAsB,CAAC,OAA2B;QAChD,IAAI,CAAC;YACH,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,0BAA0B,EAAE,GAAG,OAAO,CAAC;YAE3D,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;YACpF,2DAA2D;YAC3D,MAAM,wBAAwB,GAAG,0BAA0B,CAAC,MAAM,CAAC,CAAC;YACpE,IAAI,wBAAwB,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;gBACzC,gFAAgF;gBAChF,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACvC,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;YACjB,IAAI,OAAO,EAAE,IAAI,QAAQ,EAAE,CAAC;gBAC1B,0EAA0E;gBAC1E,+EAA+E;gBAC/E,6BAA6B;gBAC7B,oFAAoF;gBACpF,kFAAkF;gBAClF,YAAY;gBACZ,EAAE,GAAG,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC;YAC5B,CAAC;YACD,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YAEnD,OAAO,wBAAwB,CAAC,GAAG,CAAC,CAAC,0BAA0B,EAAE,EAAE;gBACjE,OAAO;oBACL,0BAA0B;oBAC1B,KAAK,EAAE,WAAW;oBAClB,EAAE,EAAE,EAAE;oBACN,IAAI;iBAC0B,CAAC;YACnC,CAAC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,IAAI,8BAA8B,EAAE,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;IAES,YAAY,CAAC,MAAuB;QAC5C,IAAI,MAAM,GAAc,EAAE,CAAC;QAC3B,KAAK,IAAI,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACtC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,aAAa,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAES,mBAAmB,CAAC,WAA8B,EAAE,MAAwC;QACpG,MAAM,WAAW,GAAgB;YAC/B,SAAS,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;gBAC3B,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;oBACrC,OAAO,WAAW,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACvC,CAAC;qBAAM,CAAC;oBACN,2BAA2B;oBAC3B,OAAO,SAAS,CAAC;gBACnB,CAAC;YACH,CAAC;YACD,UAAU,EAAE,CAAC,KAAK,EAAE,EAAE;gBACpB,IAAI,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,EAAE,CAAC;oBACrC,OAAO,WAAW,CAAC,UAAU,EAAE,CAAC;gBAClC,CAAC;qBAAM,CAAC;oBACN,OAAO,EAAE,CAAC;gBACZ,CAAC;YACH,CAAC;SACF,CAAC;QACF,KAAK,IAAI,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACtC,SAAS,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;CACF"}

package/dist/BucketParameterQuerier.d.ts

@@ -1,4 +1,5 @@
 import { ResolvedBucket } from './BucketDescription.js';
+import { ParameterLookupScope } from './HydrationState.js';
 import { RequestedStream } from './SqlSyncRules.js';
 import { RequestParameters, SqliteJsonRow, SqliteJsonValue } from './types.js';
 /**
@@ -21,7 +22,7 @@ export interface BucketParameterQuerier {
      * and parameterQueryLookups.length == 0.
      */
     readonly hasDynamicBuckets: boolean;
-    readonly parameterQueryLookups: ParameterLookup[];
+    readonly parameterQueryLookups: ScopedParameterLookup[];
     /**
      * These buckets depend on parameter storage, and needs to be retrieved dynamically for each checkpoint.
      *
@@ -50,7 +51,7 @@ export interface PendingQueriers {
     errors: QuerierError[];
 }
 export interface ParameterLookupSource {
-    getParameterSets: (lookups: ParameterLookup[]) => Promise<SqliteJsonRow[]>;
+    getParameterSets: (lookups: ScopedParameterLookup[]) => Promise<SqliteJsonRow[]>;
 }
 export interface QueryBucketDescriptorOptions extends ParameterLookupSource {
     parameters: RequestParameters;
@@ -61,12 +62,21 @@ export declare function mergeBucketParameterQueriers(queriers: BucketParameterQu
  *
  * Other query types are not supported yet.
  */
-export declare class ParameterLookup {
+export declare class ScopedParameterLookup {
     readonly values: SqliteJsonValue[];
-    static normalized(bucketDefinitionName: string, queryIndex: string, values: SqliteJsonValue[]): ParameterLookup;
+    static normalized(scope: ParameterLookupScope, lookup: UnscopedParameterLookup): ScopedParameterLookup;
+    /**
+     * Primarily for test fixtures.
+     */
+    static direct(scope: ParameterLookupScope, values: SqliteJsonValue[]): ScopedParameterLookup;
     /**
      *
      * @param values must be pre-normalized (any integer converted into bigint)
      */
-    constructor(values: SqliteJsonValue[]);
+    private constructor();
+}
+export declare class UnscopedParameterLookup {
+    readonly lookupValues: SqliteJsonValue[];
+    static normalized(values: SqliteJsonValue[]): UnscopedParameterLookup;
+    constructor(lookupValues: SqliteJsonValue[]);
 }

package/dist/BucketParameterQuerier.js

@@ -21,11 +21,17 @@ export function mergeBucketParameterQueriers(queriers) {
  *
  * Other query types are not supported yet.
  */
-export class ParameterLookup {
+export class ScopedParameterLookup {
     // bucket definition name, parameter query index, ...lookup values
     values;
-    static normalized(bucketDefinitionName, queryIndex, values) {
-        return new ParameterLookup([bucketDefinitionName, queryIndex, ...values.map(normalizeParameterValue)]);
+    static normalized(scope, lookup) {
+        return new ScopedParameterLookup([scope.lookupName, scope.queryId, ...lookup.lookupValues]);
+    }
+    /**
+     * Primarily for test fixtures.
+     */
+    static direct(scope, values) {
+        return new ScopedParameterLookup([scope.lookupName, scope.queryId, ...values.map(normalizeParameterValue)]);
     }
     /**
      *
@@ -35,4 +41,13 @@ export class ParameterLookup {
         this.values = values;
     }
 }
+export class UnscopedParameterLookup {
+    lookupValues;
+    static normalized(values) {
+        return new UnscopedParameterLookup(values.map(normalizeParameterValue));
+    }
+    constructor(lookupValues) {
+        this.lookupValues = lookupValues;
+    }
+}
 //# sourceMappingURL=BucketParameterQuerier.js.map

package/dist/BucketParameterQuerier.js.map

@@ -1 +1 @@
-{"version":3,"file":"BucketParameterQuerier.js","sourceRoot":"","sources":["../src/BucketParameterQuerier.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAgErD,MAAM,UAAU,4BAA4B,CAAC,QAAkC;IAC7E,MAAM,qBAAqB,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC;IAC/E,OAAO;QACL,aAAa,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC;QACvD,iBAAiB,EAAE,qBAAqB,CAAC,MAAM,GAAG,CAAC;QACnD,qBAAqB,EAAE,qBAAqB;QAC5C,KAAK,CAAC,8BAA8B,CAAC,MAA6B;YAChE,IAAI,OAAO,GAAqB,EAAE,CAAC;YACnC,KAAK,IAAI,CAAC,IAAI,QAAQ,EAAE,CAAC;gBACvB,IAAI,CAAC,CAAC,iBAAiB,EAAE,CAAC;oBACxB,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACpE,CAAC;YACH,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,eAAe;IAC1B,kEAAkE;IACzD,MAAM,CAAoB;IAEnC,MAAM,CAAC,UAAU,CAAC,oBAA4B,EAAE,UAAkB,EAAE,MAAyB;QAC3F,OAAO,IAAI,eAAe,CAAC,CAAC,oBAAoB,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IACzG,CAAC;IAED;;;OAGG;IACH,YAAY,MAAyB;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF"}
+{"version":3,"file":"BucketParameterQuerier.js","sourceRoot":"","sources":["../src/BucketParameterQuerier.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAgErD,MAAM,UAAU,4BAA4B,CAAC,QAAkC;IAC7E,MAAM,qBAAqB,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC;IAC/E,OAAO;QACL,aAAa,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC;QACvD,iBAAiB,EAAE,qBAAqB,CAAC,MAAM,GAAG,CAAC;QACnD,qBAAqB,EAAE,qBAAqB;QAC5C,KAAK,CAAC,8BAA8B,CAAC,MAA6B;YAChE,IAAI,OAAO,GAAqB,EAAE,CAAC;YACnC,KAAK,IAAI,CAAC,IAAI,QAAQ,EAAE,CAAC;gBACvB,IAAI,CAAC,CAAC,iBAAiB,EAAE,CAAC;oBACxB,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBACpE,CAAC;YACH,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,OAAO,qBAAqB;IAChC,kEAAkE;IACzD,MAAM,CAAoB;IAEnC,MAAM,CAAC,UAAU,CAAC,KAA2B,EAAE,MAA+B;QAC5E,OAAO,IAAI,qBAAqB,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAC9F,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,MAAM,CAAC,KAA2B,EAAE,MAAyB;QAClE,OAAO,IAAI,qBAAqB,CAAC,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,OAAO,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;IAC9G,CAAC;IAED;;;OAGG;IACH,YAAoB,MAAyB;QAC3C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF;AAED,MAAM,OAAO,uBAAuB;IACzB,YAAY,CAAoB;IAEzC,MAAM,CAAC,UAAU,CAAC,MAAyB;QACzC,OAAO,IAAI,uBAAuB,CAAC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED,YAAY,YAA+B;QACzC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;CACF"}

package/dist/BucketSource.d.ts

@@ -1,36 +1,47 @@
 import { PendingQueriers } from './BucketParameterQuerier.js';
 import { ColumnDefinition } from './ExpressionType.js';
+import { HydrationState, ParameterLookupScope } from './HydrationState.js';
 import { SourceTableInterface } from './SourceTableInterface.js';
 import { GetQuerierOptions } from './SqlSyncRules.js';
 import { TablePattern } from './TablePattern.js';
-import { EvaluatedParametersResult, EvaluateRowOptions, EvaluationResult, SourceSchema, SqliteRow } from './types.js';
+import { EvaluatedParametersResult, EvaluateRowOptions, EvaluationResult, UnscopedEvaluationResult, SourceSchema, SqliteRow, UnscopedEvaluatedParametersResult } from './types.js';
+export interface CreateSourceParams {
+    hydrationState: HydrationState;
+}
 /**
- * An interface declaring
- *
- *  - which buckets the sync service should create when processing change streams from the database.
- *  - how data in source tables maps to data in buckets (e.g. when we're not selecting all columns).
- *  - which buckets a given connection has access to.
- *
- * There are two ways to define bucket sources: Via sync rules made up of parameter and data queries, and via stream
- * definitions that only consist of a single query.
+ * A BucketSource is a _logical_ bucket or sync stream definition. It is primarily used to group together
+ * related BucketDataSource, BucketParameterLookupSource and BucketParameterQuerierSource definitions,
+ * for the purpose of subscribing to specific streams. It does not directly define the implementation
+ * or replication process.
  */
 export interface BucketSource {
     readonly name: string;
     readonly type: BucketSourceType;
     readonly subscribedToByDefault: boolean;
     /**
-     * Given a row in a source table that affects sync parameters, returns a structure to index which buckets rows should
-     * be associated with.
+     * BucketDataSource describing the data in this bucket/stream definition.
      *
-     * The returned {@link ParameterLookup} can be referenced by {@link pushBucketParameterQueriers} to allow the storage
-     * system to find buckets.
+     * The same data source could in theory be present in multiple stream definitions.
+     *
+     * Sources must _only_ be split into multiple ones if they will result in different buckets being created.
+     * Specifically, bucket definitions would always have a single data source, while stream definitions may have
+     * one per variant.
      */
-    evaluateParameterRow(sourceTable: SourceTableInterface, row: SqliteRow): EvaluatedParametersResult[];
+    readonly dataSources: BucketDataSource[];
     /**
-     * Given a row as it appears in a table that affects sync data, return buckets, logical table names and transformed
-     * data for rows to add to buckets.
+     * BucketParameterLookupSource describing the parameter tables used in this bucket/stream definition.
+     *
+     * The same source could in theory be present in multiple stream definitions.
      */
-    evaluateRow(options: EvaluateRowOptions): EvaluationResult[];
+    readonly parameterIndexLookupCreators: ParameterIndexLookupCreator[];
+    debugRepresentation(): any;
+    hydrate(params: CreateSourceParams): HydratedBucketSource;
+}
+/**
+ * Internal interface for individual queriers. This is not used on its in the public API directly, apart
+ * from in HydratedBucketSource. Everywhere else it is just to standardize the internal functions that we re-use.
+ */
+export interface BucketParameterQuerierSource {
     /**
      * Reports {@link BucketParameterQuerier}s resolving buckets that a specific stream request should have access to.
      *
@@ -38,18 +49,36 @@ export interface BucketSource {
      * @param options Options, including parameters that may affect the buckets loaded by this source.
      */
     pushBucketParameterQueriers(result: PendingQueriers, options: GetQuerierOptions): void;
+}
+export interface HydratedBucketSource extends BucketParameterQuerierSource {
+    readonly definition: BucketSource;
+}
+export type ScopedEvaluateRow = (options: EvaluateRowOptions) => EvaluationResult[];
+export type ScopedEvaluateParameterRow = (sourceTable: SourceTableInterface, row: SqliteRow) => EvaluatedParametersResult[];
+/**
+ * Encodes a static definition of a bucket source, as parsed from sync rules or stream definitions.
+ *
+ * This does not require any "hydration" itself: All results are independent of bucket names.
+ * The higher-level HydratedSyncRules will use a HydrationState to generate bucket names.
+ */
+export interface BucketDataSource {
     /**
-     * Whether {@link pushBucketParameterQueriers} may include a querier where
-     * {@link BucketParameterQuerier.hasDynamicBuckets} is true.
+     * Unique name of the data source within a sync rules version.
      *
-     * This is mostly used for testing.
+     * This may be used as the basis for bucketPrefix (or it could be ignored).
      */
-    hasDynamicBucketQueries(): boolean;
+    readonly uniqueName: string;
+    /**
+     * For debug use only.
+     */
+    readonly bucketParameters: string[];
     getSourceTables(): Set<TablePattern>;
-    /** Whether the table possibly affects the buckets resolved by this source. */
-    tableSyncsParameters(table: SourceTableInterface): boolean;
-    /** Whether the table possibly affects the contents of buckets resolved by this source. */
     tableSyncsData(table: SourceTableInterface): boolean;
+    /**
+     * Given a row as it appears in a table that affects sync data, return buckets, logical table names and transformed
+     * data for rows to add to buckets.
+     */
+    evaluateRow(options: EvaluateRowOptions): UnscopedEvaluationResult[];
     /**
      * Given a static schema, infer all logical tables and associated columns that appear in buckets defined by this
      * source.
@@ -60,7 +89,34 @@ export interface BucketSource {
     debugWriteOutputTables(result: Record<string, {
         query: string;
     }[]>): void;
-    debugRepresentation(): any;
+}
+/**
+ * This defines how to extract parameter index lookup values from parameter queries or stream subqueries.
+ *
+ * This is only relevant for parameter queries and subqueries that query tables.
+ */
+export interface ParameterIndexLookupCreator {
+    /**
+     * lookupName + queryId is used to uniquely identify parameter queries for parameter storage.
+     *
+     * This defines the default values if no transformations are applied.
+     */
+    readonly defaultLookupScope: ParameterLookupScope;
+    getSourceTables(): Set<TablePattern>;
+    /**
+     * Given a row in a source table that affects sync parameters, returns a structure to index which buckets rows should
+     * be associated with.
+     *
+     * The returned {@link UnscopedParameterLookup} can be referenced by {@link pushBucketParameterQueriers} to allow the storage
+     * system to find buckets.
+     */
+    evaluateParameterRow(sourceTable: SourceTableInterface, row: SqliteRow): UnscopedEvaluatedParametersResult[];
+    /** Whether the table possibly affects the buckets resolved by this source. */
+    tableSyncsParameters(table: SourceTableInterface): boolean;
+}
+export interface DebugMergedSource extends HydratedBucketSource {
+    evaluateRow: ScopedEvaluateRow;
+    evaluateParameterRow: ScopedEvaluateParameterRow;
 }
 export declare enum BucketSourceType {
     SYNC_RULE = 0,
@@ -70,3 +126,16 @@ export type ResultSetDescription = {
     name: string;
     columns: ColumnDefinition[];
 };
+export declare function hydrateEvaluateRow(hydrationState: HydrationState, source: BucketDataSource): ScopedEvaluateRow;
+export declare function hydrateEvaluateParameterRow(hydrationState: HydrationState, source: ParameterIndexLookupCreator): ScopedEvaluateParameterRow;
+export declare function mergeDataSources(hydrationState: HydrationState, sources: BucketDataSource[]): {
+    evaluateRow: ScopedEvaluateRow;
+};
+export declare function mergeParameterIndexLookupCreators(hydrationState: HydrationState, sources: ParameterIndexLookupCreator[]): {
+    evaluateParameterRow: ScopedEvaluateParameterRow;
+};
+/**
+ * For production purposes, we typically need to operate on the different sources separately. However, for debugging,
+ * it is useful to have a single merged source that can evaluate everything.
+ */
+export declare function debugHydratedMergedSource(bucketSource: BucketSource, params?: CreateSourceParams): DebugMergedSource;

package/dist/BucketSource.js

@@ -1,6 +1,73 @@
+import { ScopedParameterLookup } from './BucketParameterQuerier.js';
+import { DEFAULT_HYDRATION_STATE } from './HydrationState.js';
+import { isEvaluationError } from './types.js';
+import { buildBucketName } from './utils.js';
 export var BucketSourceType;
 (function (BucketSourceType) {
     BucketSourceType[BucketSourceType["SYNC_RULE"] = 0] = "SYNC_RULE";
     BucketSourceType[BucketSourceType["SYNC_STREAM"] = 1] = "SYNC_STREAM";
 })(BucketSourceType || (BucketSourceType = {}));
+export function hydrateEvaluateRow(hydrationState, source) {
+    const scope = hydrationState.getBucketSourceScope(source);
+    return (options) => {
+        return source.evaluateRow(options).map((result) => {
+            if (isEvaluationError(result)) {
+                return result;
+            }
+            return {
+                bucket: buildBucketName(scope, result.serializedBucketParameters),
+                id: result.id,
+                table: result.table,
+                data: result.data
+            };
+        });
+    };
+}
+export function hydrateEvaluateParameterRow(hydrationState, source) {
+    const scope = hydrationState.getParameterIndexLookupScope(source);
+    return (sourceTable, row) => {
+        return source.evaluateParameterRow(sourceTable, row).map((result) => {
+            if (isEvaluationError(result)) {
+                return result;
+            }
+            return {
+                bucketParameters: result.bucketParameters,
+                lookup: ScopedParameterLookup.normalized(scope, result.lookup)
+            };
+        });
+    };
+}
+export function mergeDataSources(hydrationState, sources) {
+    const withScope = sources.map((source) => hydrateEvaluateRow(hydrationState, source));
+    return {
+        evaluateRow(options) {
+            return withScope.flatMap((source) => source(options));
+        }
+    };
+}
+export function mergeParameterIndexLookupCreators(hydrationState, sources) {
+    const withScope = sources.map((source) => hydrateEvaluateParameterRow(hydrationState, source));
+    return {
+        evaluateParameterRow(sourceTable, row) {
+            return withScope.flatMap((source) => source(sourceTable, row));
+        }
+    };
+}
+/**
+ * For production purposes, we typically need to operate on the different sources separately. However, for debugging,
+ * it is useful to have a single merged source that can evaluate everything.
+ */
+export function debugHydratedMergedSource(bucketSource, params) {
+    const hydrationState = params?.hydrationState ?? DEFAULT_HYDRATION_STATE;
+    const resolvedParams = { hydrationState };
+    const dataSource = mergeDataSources(hydrationState, bucketSource.dataSources);
+    const parameterLookupSource = mergeParameterIndexLookupCreators(hydrationState, bucketSource.parameterIndexLookupCreators);
+    const hydratedBucketSource = bucketSource.hydrate(resolvedParams);
+    return {
+        definition: bucketSource,
+        evaluateParameterRow: parameterLookupSource.evaluateParameterRow.bind(parameterLookupSource),
+        evaluateRow: dataSource.evaluateRow.bind(dataSource),
+        pushBucketParameterQueriers: hydratedBucketSource.pushBucketParameterQueriers.bind(hydratedBucketSource)
+    };
+}
 //# sourceMappingURL=BucketSource.js.map

package/dist/BucketSource.js.map

@@ -1 +1 @@
-{"version":3,"file":"BucketSource.js","sourceRoot":"","sources":["../src/BucketSource.ts"],"names":[],"mappings":"AA2EA,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iEAAS,CAAA;IACT,qEAAW,CAAA;AACb,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B"}
+{"version":3,"file":"BucketSource.js","sourceRoot":"","sources":["../src/BucketSource.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,qBAAqB,EACtB,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,uBAAuB,EAAwC,MAAM,qBAAqB,CAAC;AAIpG,OAAO,EAKL,iBAAiB,EAMlB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAwI7C,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iEAAS,CAAA;IACT,qEAAW,CAAA;AACb,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B;AAID,MAAM,UAAU,kBAAkB,CAAC,cAA8B,EAAE,MAAwB;IACzF,MAAM,KAAK,GAAG,cAAc,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IAC1D,OAAO,CAAC,OAA2B,EAAsB,EAAE;QACzD,OAAO,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YAChD,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9B,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,OAAO;gBACL,MAAM,EAAE,eAAe,CAAC,KAAK,EAAE,MAAM,CAAC,0BAA0B,CAAC;gBACjE,EAAE,EAAE,MAAM,CAAC,EAAE;gBACb,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,IAAI,EAAE,MAAM,CAAC,IAAI;aACK,CAAC;QAC3B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,cAA8B,EAC9B,MAAmC;IAEnC,MAAM,KAAK,GAAG,cAAc,CAAC,4BAA4B,CAAC,MAAM,CAAC,CAAC;IAClE,OAAO,CAAC,WAAiC,EAAE,GAAc,EAA+B,EAAE;QACxF,OAAO,MAAM,CAAC,oBAAoB,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YAClE,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9B,OAAO,MAAM,CAAC;YAChB,CAAC;YACD,OAAO;gBACL,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;gBACzC,MAAM,EAAE,qBAAqB,CAAC,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;aACjC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,cAA8B,EAC9B,OAA2B;IAE3B,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,kBAAkB,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;IACtF,OAAO;QACL,WAAW,CAAC,OAA2B;YACrC,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QACxD,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iCAAiC,CAC/C,cAA8B,EAC9B,OAAsC;IAEtC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,2BAA2B,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;IAC/F,OAAO;QACL,oBAAoB,CAAC,WAAiC,EAAE,GAAc;YACpE,OAAO,SAAS,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;QACjE,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yBAAyB,CAAC,YAA0B,EAAE,MAA2B;IAC/F,MAAM,cAAc,GAAG,MAAM,EAAE,cAAc,IAAI,uBAAuB,CAAC;IACzE,MAAM,cAAc,GAAG,EAAE,cAAc,EAAE,CAAC;IAC1C,MAAM,UAAU,GAAG,gBAAgB,CAAC,cAAc,EAAE,YAAY,CAAC,WAAW,CAAC,CAAC;IAC9E,MAAM,qBAAqB,GAAG,iCAAiC,CAC7D,cAAc,EACd,YAAY,CAAC,4BAA4B,CAC1C,CAAC;IACF,MAAM,oBAAoB,GAAG,YAAY,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAClE,OAAO;QACL,UAAU,EAAE,YAAY;QACxB,oBAAoB,EAAE,qBAAqB,CAAC,oBAAoB,CAAC,IAAI,CAAC,qBAAqB,CAAC;QAC5F,WAAW,EAAE,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC;QACpD,2BAA2B,EAAE,oBAAoB,CAAC,2BAA2B,CAAC,IAAI,CAAC,oBAAoB,CAAC;KACzG,CAAC;AACJ,CAAC"}

package/dist/HydratedSyncRules.d.ts

@@ -0,0 +1,46 @@
+import { BucketDataSource, CreateSourceParams, HydratedBucketSource } from './BucketSource.js';
+import { ParameterIndexLookupCreator, CompatibilityContext, EvaluatedParameters, EvaluatedRow, EvaluationError, GetBucketParameterQuerierResult, GetQuerierOptions, SqlEventDescriptor, SqliteInputValue, SqliteValue, SqlSyncRules } from './index.js';
+import { SourceTableInterface } from './SourceTableInterface.js';
+import { EvaluateRowOptions, SqliteRow } from './types.js';
+/**
+ * Hydrated sync rules is sync rule definitions along with persisted state. Currently, the persisted state
+ * specifically affects bucket names.
+ */
+export declare class HydratedSyncRules {
+    bucketSources: HydratedBucketSource[];
+    eventDescriptors: SqlEventDescriptor[];
+    compatibility: CompatibilityContext;
+    readonly definition: SqlSyncRules;
+    private readonly innerEvaluateRow;
+    private readonly innerEvaluateParameterRow;
+    constructor(params: {
+        definition: SqlSyncRules;
+        createParams: CreateSourceParams;
+        bucketDataSources: BucketDataSource[];
+        bucketParameterIndexLookupCreators: ParameterIndexLookupCreator[];
+        eventDescriptors?: SqlEventDescriptor[];
+        compatibility?: CompatibilityContext;
+    });
+    getSourceTables(): import("./TablePattern.js").TablePattern[];
+    tableTriggersEvent(table: SourceTableInterface): boolean;
+    tableSyncsData(table: SourceTableInterface): boolean;
+    tableSyncsParameters(table: SourceTableInterface): boolean;
+    applyRowContext<MaybeToast extends undefined = never>(source: SqliteRow<SqliteInputValue | MaybeToast>): SqliteRow<SqliteValue | MaybeToast>;
+    /**
+     * Throws errors.
+     */
+    evaluateRow(options: EvaluateRowOptions): EvaluatedRow[];
+    evaluateRowWithErrors(options: EvaluateRowOptions): {
+        results: EvaluatedRow[];
+        errors: EvaluationError[];
+    };
+    /**
+     * Throws errors.
+     */
+    evaluateParameterRow(table: SourceTableInterface, row: SqliteRow): EvaluatedParameters[];
+    evaluateParameterRowWithErrors(table: SourceTableInterface, row: SqliteRow): {
+        results: EvaluatedParameters[];
+        errors: EvaluationError[];
+    };
+    getBucketParameterQuerier(options: GetQuerierOptions): GetBucketParameterQuerierResult;
+}

package/dist/HydratedSyncRules.js

@@ -0,0 +1,88 @@
+import { CompatibilityContext, isEvaluatedParameters, isEvaluatedRow, isEvaluationError, mergeBucketParameterQueriers, mergeDataSources, mergeParameterIndexLookupCreators } from './index.js';
+/**
+ * Hydrated sync rules is sync rule definitions along with persisted state. Currently, the persisted state
+ * specifically affects bucket names.
+ */
+export class HydratedSyncRules {
+    bucketSources = [];
+    eventDescriptors = [];
+    compatibility = CompatibilityContext.FULL_BACKWARDS_COMPATIBILITY;
+    definition;
+    innerEvaluateRow;
+    innerEvaluateParameterRow;
+    constructor(params) {
+        const hydrationState = params.createParams.hydrationState;
+        this.definition = params.definition;
+        this.innerEvaluateRow = mergeDataSources(hydrationState, params.bucketDataSources).evaluateRow;
+        this.innerEvaluateParameterRow = mergeParameterIndexLookupCreators(hydrationState, params.bucketParameterIndexLookupCreators).evaluateParameterRow;
+        if (params.eventDescriptors) {
+            this.eventDescriptors = params.eventDescriptors;
+        }
+        if (params.compatibility) {
+            this.compatibility = params.compatibility;
+        }
+        this.bucketSources = this.definition.bucketSources.map((source) => source.hydrate(params.createParams));
+    }
+    // These methods do not depend on hydration, so we can just forward them to the definition.
+    getSourceTables() {
+        return this.definition.getSourceTables();
+    }
+    tableTriggersEvent(table) {
+        return this.definition.tableTriggersEvent(table);
+    }
+    tableSyncsData(table) {
+        return this.definition.tableSyncsData(table);
+    }
+    tableSyncsParameters(table) {
+        return this.definition.tableSyncsParameters(table);
+    }
+    applyRowContext(source) {
+        return this.definition.applyRowContext(source);
+    }
+    /**
+     * Throws errors.
+     */
+    evaluateRow(options) {
+        const { results, errors } = this.evaluateRowWithErrors(options);
+        if (errors.length > 0) {
+            throw new Error(errors[0].error);
+        }
+        return results;
+    }
+    evaluateRowWithErrors(options) {
+        const rawResults = this.innerEvaluateRow(options);
+        const results = rawResults.filter(isEvaluatedRow);
+        const errors = rawResults.filter(isEvaluationError);
+        return { results, errors };
+    }
+    /**
+     * Throws errors.
+     */
+    evaluateParameterRow(table, row) {
+        const { results, errors } = this.evaluateParameterRowWithErrors(table, row);
+        if (errors.length > 0) {
+            throw new Error(errors[0].error);
+        }
+        return results;
+    }
+    evaluateParameterRowWithErrors(table, row) {
+        const rawResults = this.innerEvaluateParameterRow(table, row);
+        const results = rawResults.filter(isEvaluatedParameters);
+        const errors = rawResults.filter(isEvaluationError);
+        return { results, errors };
+    }
+    getBucketParameterQuerier(options) {
+        const queriers = [];
+        const errors = [];
+        const pending = { queriers, errors };
+        for (const source of this.bucketSources) {
+            if ((source.definition.subscribedToByDefault && options.hasDefaultStreams) ||
+                source.definition.name in options.streams) {
+                source.pushBucketParameterQueriers(pending, options);
+            }
+        }
+        const querier = mergeBucketParameterQueriers(queriers);
+        return { querier, errors };
+    }
+}
+//# sourceMappingURL=HydratedSyncRules.js.map

package/dist/HydratedSyncRules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"HydratedSyncRules.js","sourceRoot":"","sources":["../src/HydratedSyncRules.ts"],"names":[],"mappings":"AAGA,OAAO,EAIL,oBAAoB,EAMpB,qBAAqB,EACrB,cAAc,EACd,iBAAiB,EACjB,4BAA4B,EAC5B,gBAAgB,EAChB,iCAAiC,EAQlC,MAAM,YAAY,CAAC;AAIpB;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAC5B,aAAa,GAA2B,EAAE,CAAC;IAC3C,gBAAgB,GAAyB,EAAE,CAAC;IAC5C,aAAa,GAAyB,oBAAoB,CAAC,4BAA4B,CAAC;IAE/E,UAAU,CAAe;IAEjB,gBAAgB,CAAoB;IACpC,yBAAyB,CAA6B;IAEvE,YAAY,MAOX;QACC,MAAM,cAAc,GAAG,MAAM,CAAC,YAAY,CAAC,cAAc,CAAC;QAE1D,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,EAAE,MAAM,CAAC,iBAAiB,CAAC,CAAC,WAAW,CAAC;QAC/F,IAAI,CAAC,yBAAyB,GAAG,iCAAiC,CAChE,cAAc,EACd,MAAM,CAAC,kCAAkC,CAC1C,CAAC,oBAAoB,CAAC;QAEvB,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAC5B,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;QAClD,CAAC;QACD,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YACzB,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC5C,CAAC;QAED,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;IAC1G,CAAC;IAED,2FAA2F;IAE3F,eAAe;QACb,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;IAC3C,CAAC;IAED,kBAAkB,CAAC,KAA2B;QAC5C,OAAO,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACnD,CAAC;IAED,cAAc,CAAC,KAA2B;QACxC,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC;IAED,oBAAoB,CAAC,KAA2B;QAC9C,OAAO,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,eAAe,CACb,MAAgD;QAEhD,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,OAA2B;QACrC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;QAChE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,qBAAqB,CAAC,OAA2B;QAC/C,MAAM,UAAU,GAAuB,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACtE,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,cAAc,CAAmB,CAAC;QACpE,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,iBAAiB,CAAsB,CAAC;QAEzE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,oBAAoB,CAAC,KAA2B,EAAE,GAAc;QAC9D,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,8BAA8B,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC5E,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,8BAA8B,CAC5B,KAA2B,EAC3B,GAAc;QAEd,MAAM,UAAU,GAAgC,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAC3F,MAAM,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,qBAAqB,CAA0B,CAAC;QAClF,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,iBAAiB,CAAsB,CAAC;QACzE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAC7B,CAAC;IAED,yBAAyB,CAAC,OAA0B;QAClD,MAAM,QAAQ,GAA6B,EAAE,CAAC;QAC9C,MAAM,MAAM,GAAmB,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;QAErC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACxC,IACE,CAAC,MAAM,CAAC,UAAU,CAAC,qBAAqB,IAAI,OAAO,CAAC,iBAAiB,CAAC;gBACtE,MAAM,CAAC,UAAU,CAAC,IAAI,IAAI,OAAO,CAAC,OAAO,EACzC,CAAC;gBACD,MAAM,CAAC,2BAA2B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAG,4BAA4B,CAAC,QAAQ,CAAC,CAAC;QACvD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAC7B,CAAC;CACF"}

package/dist/HydrationState.d.ts

@@ -0,0 +1,45 @@
+import { BucketDataSource, ParameterIndexLookupCreator } from './BucketSource.js';
+export interface BucketDataScope {
+    /** The prefix is the bucket name before the parameters. */
+    bucketPrefix: string;
+}
+export interface ParameterLookupScope {
+    /** The lookup name + queryid is used to reference the parameter lookup record. */
+    lookupName: string;
+    queryId: string;
+}
+/**
+ * Hydration state information for a source.
+ *
+ * This is what keeps track of bucket name and parameter lookup mappings for hydration. This can be used
+ * both to re-use mappings across hydrations of different sync rule versions, or to generate new mappings.
+ */
+export interface HydrationState {
+    /**
+     * Given a bucket data source definition, get the bucket prefix to use for it.
+     */
+    getBucketSourceScope(source: BucketDataSource): BucketDataScope;
+    /**
+     * Given a bucket parameter lookup definition, get the persistence name to use.
+     */
+    getParameterIndexLookupScope(source: ParameterIndexLookupCreator): ParameterLookupScope;
+}
+/**
+ * This represents hydration state that performs no transformations.
+ *
+ * This is the legacy default behavior with no bucket versioning.
+ */
+export declare const DEFAULT_HYDRATION_STATE: HydrationState;
+/**
+ * Transforms bucket ids generated when evaluating the row by e.g. encoding version information.
+ *
+ * Because buckets are recreated on a sync rule redeploy, it makes sense to use different bucket ids (otherwise, clients
+ * may run into checksum errors causing a sync to take longer than necessary or breaking progress).
+ *
+ * So, this transformer receives the original bucket id as generated by defined sync rules, and can prepend a version
+ * identifier.
+ *
+ * Note that this transformation has not been present in older versions of the sync service. To preserve backwards
+ * compatibility, sync rules will not use this without an opt-in.
+ */
+export declare function versionedHydrationState(version: number): HydrationState;