@powersync/service-sync-rules 0.29.10 → 0.31.0

package/dist/compiler/table.js

@@ -0,0 +1,67 @@
+import { equalsIgnoringResultSetList } from './compatibility.js';
+/**
+ * The syntactic sources of a {@link SourceResultSet} being added to a table.
+ */
+export class SyntacticResultSetSource {
+    origin;
+    explicitName;
+    constructor(origin, explicitName) {
+        this.origin = origin;
+        this.explicitName = explicitName;
+    }
+}
+export class BaseSourceResultSet {
+    source;
+    constructor(source) {
+        this.source = source;
+    }
+}
+/**
+ * A {@link SourceResultSet} selecting rows from a table in the source database.
+ *
+ * The primary result set of streams must be of this type. Also, indexed lookups can only operate on this type.
+ */
+export class PhysicalSourceResultSet extends BaseSourceResultSet {
+    tablePattern;
+    schemaTablesForWarnings;
+    constructor(tablePattern, source, 
+    /**
+     * Source tables that the {@link tablePattern} resolves to in the static schema context used when compiling sync
+     * streams.
+     *
+     * This information must only be used to generate analysis warnings, e.g. for column references that don't exist in
+     * resolved tables. It must not affect how sync streams are compiled, as that is always schema-independent.
+     */
+    schemaTablesForWarnings) {
+        super(source);
+        this.tablePattern = tablePattern;
+        this.schemaTablesForWarnings = schemaTablesForWarnings;
+    }
+    get description() {
+        return this.tablePattern.name;
+    }
+}
+/**
+ * A {@link SourceResultSet} applying a table-valued function with inputs that exclusively depend on request data.
+ */
+export class RequestTableValuedResultSet extends BaseSourceResultSet {
+    tableValuedFunctionName;
+    parameters;
+    constructor(tableValuedFunctionName, parameters, source) {
+        super(source);
+        this.tableValuedFunctionName = tableValuedFunctionName;
+        this.parameters = parameters;
+    }
+    get description() {
+        return this.tableValuedFunctionName;
+    }
+    buildBehaviorHashCode(hasher) {
+        hasher.addString(this.tableValuedFunctionName);
+        equalsIgnoringResultSetList.hash(hasher, this.parameters);
+    }
+    behavesIdenticalTo(other) {
+        return (other.tableValuedFunctionName == this.tableValuedFunctionName &&
+            equalsIgnoringResultSetList.equals(other.parameters, this.parameters));
+    }
+}
+//# sourceMappingURL=table.js.map

package/dist/compiler/table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.js","sourceRoot":"","sources":["../../src/compiler/table.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AAgBjE;;GAEG;AACH,MAAM,OAAO,wBAAwB;IAExB;IACA;IAFX,YACW,MAAc,EACd,YAA2B;QAD3B,WAAM,GAAN,MAAM,CAAQ;QACd,iBAAY,GAAZ,YAAY,CAAe;IACnC,CAAC;CACL;AAED,MAAM,OAAgB,mBAAmB;IAClB;IAArB,YAAqB,MAAgC;QAAhC,WAAM,GAAN,MAAM,CAA0B;IAAG,CAAC;CAG1D;AAED;;;;GAIG;AACH,MAAM,OAAO,uBAAwB,SAAQ,mBAAmB;IAEnD;IASA;IAVX,YACW,YAAwC,EACjD,MAAgC;IAChC;;;;;;OAMG;IACM,uBAA4C;QAErD,KAAK,CAAC,MAAM,CAAC,CAAC;QAXL,iBAAY,GAAZ,YAAY,CAA4B;QASxC,4BAAuB,GAAvB,uBAAuB,CAAqB;IAGvD,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC;IAChC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,OAAO,2BAA4B,SAAQ,mBAAmB;IAEvD;IACA;IAFX,YACW,uBAA+B,EAC/B,UAA+B,EACxC,MAAgC;QAEhC,KAAK,CAAC,MAAM,CAAC,CAAC;QAJL,4BAAuB,GAAvB,uBAAuB,CAAQ;QAC/B,eAAU,GAAV,UAAU,CAAqB;IAI1C,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,uBAAuB,CAAC;IACtC,CAAC;IAED,qBAAqB,CAAC,MAAoB;QACxC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAC/C,2BAA2B,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5D,CAAC;IAED,kBAAkB,CAAC,KAAkC;QACnD,OAAO,CACL,KAAK,CAAC,uBAAuB,IAAI,IAAI,CAAC,uBAAuB;YAC7D,2BAA2B,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CACtE,CAAC;IACJ,CAAC;CACF"}

package/dist/errors.d.ts

@@ -1,13 +1,15 @@
-import { Expr, NodeLocation } from 'pgsql-ast-parser';
+import { NodeLocation, PGNode } from 'pgsql-ast-parser';
 export interface ErrorLocation {
     start: number;
     end: number;
 }
+export declare function expandNodeLocations(nodes: Iterable<PGNode | NodeLocation | undefined>): NodeLocation | undefined;
+export declare function getLocation(location?: NodeLocation | PGNode): NodeLocation | undefined;
 export declare class SqlRuleError extends Error {
     sql: string;
     location?: ErrorLocation;
     type: 'warning' | 'fatal';
-    constructor(message: string, sql: string, location?: NodeLocation | Expr);
+    constructor(message: string, sql: string, location?: NodeLocation | PGNode);
 }
 export declare class YamlError extends Error {
     source: Error;

package/dist/errors.js

@@ -1,5 +1,20 @@
 import * as yaml from 'yaml';
-function getLocation(location) {
+export function expandNodeLocations(nodes) {
+    let location = undefined;
+    for (const node of nodes) {
+        const nodeLocation = getLocation(node);
+        if (nodeLocation == null)
+            continue;
+        if (location == null) {
+            location = nodeLocation;
+        }
+        else {
+            location = { start: Math.min(location.start, nodeLocation.start), end: Math.max(location.end, nodeLocation.end) };
+        }
+    }
+    return location;
+}
+export function getLocation(location) {
     if (location != null && !isLocation(location)) {
         return location._location;
     }

package/dist/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAO7B,SAAS,WAAW,CAAC,QAA8B;IACjD,IAAI,QAAQ,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9C,OAAO,QAAQ,CAAC,SAAS,CAAC;IAC5B,CAAC;SAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChC,OAAO,QAAQ,CAAC;IAClB,CAAC;SAAM,CAAC;QACN,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,QAA8B;IAChD,OAAO,CACL,QAAQ,IAAI,IAAI;QAChB,OAAQ,QAAyB,CAAC,KAAK,IAAI,QAAQ;QACnD,OAAQ,QAAyB,CAAC,GAAG,IAAI,QAAQ,CAClD,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,YAAa,SAAQ,KAAK;IAM5B;IALT,QAAQ,CAAiB;IACzB,IAAI,GAAwB,OAAO,CAAC;IAEpC,YACE,OAAe,EACR,GAAW,EAClB,QAA8B;QAE9B,KAAK,CAAC,OAAO,CAAC,CAAC;QAHR,QAAG,GAAH,GAAG,CAAQ;QAKlB,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC;IACzE,CAAC;CACF;AAED,MAAM,OAAO,SAAU,SAAQ,KAAK;IAKzB;IAJT,QAAQ,CAAgB;IACxB,IAAI,GAAwB,OAAO,CAAC;IAEpC,YACS,MAAa,EACpB,QAAwB;QAExB,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAHf,WAAM,GAAN,MAAM,CAAO;QAKpB,IAAI,QAAQ,IAAI,IAAI,IAAI,MAAM,YAAY,IAAI,CAAC,SAAS,EAAE,CAAC;YACzD,QAAQ,GAAG;gBACT,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;gBACpB,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;aACnB,CAAC;QACJ,CAAC;aAAM,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YAC5B,QAAQ,GAAG;gBACT,KAAK,EAAE,CAAC;gBACR,GAAG,EAAE,EAAE;aACR,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,YAAY,SAAS,IAAI,MAAM,YAAY,YAAY,EAAE,CAAC;YAClE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAIrB;IAHnB,MAAM,CAAC,gBAAgB,CAAC,MAAmB;QACzC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IACD,YAAmB,MAAmB;QACpC,KAAK,CAAC,eAAe,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;QAD/B,WAAM,GAAN,MAAM,CAAa;IAEtC,CAAC;CACF;AAGD,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IACzC,IAAI,CAAqB;IAEhC,YAAY,IAAwB,EAAE,OAAe;QACnD,KAAK,CAAC,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAO7B,MAAM,UAAU,mBAAmB,CAAC,KAAkD;IACpF,IAAI,QAAQ,GAA6B,SAAS,CAAC;IACnD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,YAAY,IAAI,IAAI;YAAE,SAAS;QAEnC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YACrB,QAAQ,GAAG,YAAY,CAAC;QAC1B,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,YAAY,CAAC,GAAG,CAAC,EAAE,CAAC;QACpH,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,QAAgC;IAC1D,IAAI,QAAQ,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC9C,OAAO,QAAQ,CAAC,SAAS,CAAC;IAC5B,CAAC;SAAM,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChC,OAAO,QAAQ,CAAC;IAClB,CAAC;SAAM,CAAC;QACN,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,UAAU,CAAC,QAAgC;IAClD,OAAO,CACL,QAAQ,IAAI,IAAI;QAChB,OAAQ,QAAyB,CAAC,KAAK,IAAI,QAAQ;QACnD,OAAQ,QAAyB,CAAC,GAAG,IAAI,QAAQ,CAClD,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,YAAa,SAAQ,KAAK;IAM5B;IALT,QAAQ,CAAiB;IACzB,IAAI,GAAwB,OAAO,CAAC;IAEpC,YACE,OAAe,EACR,GAAW,EAClB,QAAgC;QAEhC,KAAK,CAAC,OAAO,CAAC,CAAC;QAHR,QAAG,GAAH,GAAG,CAAQ;QAKlB,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC;IACzE,CAAC;CACF;AAED,MAAM,OAAO,SAAU,SAAQ,KAAK;IAKzB;IAJT,QAAQ,CAAgB;IACxB,IAAI,GAAwB,OAAO,CAAC;IAEpC,YACS,MAAa,EACpB,QAAwB;QAExB,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAHf,WAAM,GAAN,MAAM,CAAO;QAKpB,IAAI,QAAQ,IAAI,IAAI,IAAI,MAAM,YAAY,IAAI,CAAC,SAAS,EAAE,CAAC;YACzD,QAAQ,GAAG;gBACT,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;gBACpB,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;aACnB,CAAC;QACJ,CAAC;aAAM,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;YAC5B,QAAQ,GAAG;gBACT,KAAK,EAAE,CAAC;gBACR,GAAG,EAAE,EAAE;aACR,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,YAAY,SAAS,IAAI,MAAM,YAAY,YAAY,EAAE,CAAC;YAClE,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QAC1B,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,OAAO,eAAgB,SAAQ,KAAK;IAIrB;IAHnB,MAAM,CAAC,gBAAgB,CAAC,MAAmB;QACzC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IACD,YAAmB,MAAmB;QACpC,KAAK,CAAC,eAAe,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;QAD/B,WAAM,GAAN,MAAM,CAAa;IAEtC,CAAC;CACF;AAGD,MAAM,OAAO,uBAAwB,SAAQ,KAAK;IACzC,IAAI,CAAqB;IAEhC,YAAY,IAAwB,EAAE,OAAe;QACnD,KAAK,CAAC,IAAI,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF"}

package/dist/events/SqlEventDescriptor.js

@@ -12,7 +12,7 @@ export class SqlEventDescriptor {
         this.name = name;
     }
     addSourceQuery(sql, options) {
-        const source = SqlEventSourceQuery.fromSql(this.name, sql, options, this.compatibility);
+        const source = SqlEventSourceQuery.fromSql(sql, options, this.compatibility);
         // Each source query should be for a unique table
         const existingSourceQuery = this.sourceQueries.find((q) => q.table == source.table);
         if (existingSourceQuery) {

package/dist/events/SqlEventDescriptor.js.map

@@ -1 +1 @@
-{"version":3,"file":"SqlEventDescriptor.js","sourceRoot":"","sources":["../../src/events/SqlEventDescriptor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAO5C,OAAO,EAA+B,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE5F;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAMV;IALnB,IAAI,CAAS;IACb,aAAa,GAA0B,EAAE,CAAC;IAE1C,YACE,IAAY,EACK,aAAmC;QAAnC,kBAAa,GAAb,aAAa,CAAsB;QAEpD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,cAAc,CAAC,GAAW,EAAE,OAAyB;QACnD,MAAM,MAAM,GAAG,mBAAmB,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAExF,iDAAiD;QACjD,MAAM,mBAAmB,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;QACpF,IAAI,mBAAmB,EAAE,CAAC;YACxB,OAAO;gBACL,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,CAAC,IAAI,YAAY,CAAC,gDAAgD,EAAE,GAAG,CAAC,CAAC;aAClF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEhC,OAAO;YACL,MAAM,EAAE,IAAI;YACZ,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC;IACJ,CAAC;IAED,qBAAqB,CAAC,OAA2B;QAC/C,yDAAyD;QACzD,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO;gBACL,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,4CAA4C,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC;aAC5F,CAAC;QACJ,CAAC;QAED,OAAO,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAClF,CAAC;IAED,eAAe;QACb,IAAI,MAAM,GAAG,IAAI,GAAG,EAAgB,CAAC;QACrC,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACrC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,WAAY,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,kBAAkB,CAAC,KAA2B;QAC5C,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAClE,CAAC;CACF"}
+{"version":3,"file":"SqlEventDescriptor.js","sourceRoot":"","sources":["../../src/events/SqlEventDescriptor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAO5C,OAAO,EAA+B,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAE5F;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAMV;IALnB,IAAI,CAAS;IACb,aAAa,GAA0B,EAAE,CAAC;IAE1C,YACE,IAAY,EACK,aAAmC;QAAnC,kBAAa,GAAb,aAAa,CAAsB;QAEpD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,cAAc,CAAC,GAAW,EAAE,OAAyB;QACnD,MAAM,MAAM,GAAG,mBAAmB,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;QAE7E,iDAAiD;QACjD,MAAM,mBAAmB,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC;QACpF,IAAI,mBAAmB,EAAE,CAAC;YACxB,OAAO;gBACL,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,CAAC,IAAI,YAAY,CAAC,gDAAgD,EAAE,GAAG,CAAC,CAAC;aAClF,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAEhC,OAAO;YACL,MAAM,EAAE,IAAI;YACZ,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC;IACJ,CAAC;IAED,qBAAqB,CAAC,OAA2B;QAC/C,yDAAyD;QACzD,MAAM,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;QACrF,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO;gBACL,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,4CAA4C,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC;aAC5F,CAAC;QACJ,CAAC;QAED,OAAO,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IAClF,CAAC;IAED,eAAe;QACb,IAAI,MAAM,GAAG,IAAI,GAAG,EAAgB,CAAC;QACrC,KAAK,IAAI,KAAK,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACrC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,WAAY,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,kBAAkB,CAAC,KAA2B;QAC5C,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAClE,CAAC;CACF"}

package/dist/events/SqlEventSourceQuery.d.ts

@@ -14,7 +14,7 @@ export type EvaluatedEventRowWithErrors = {
  * Defines how a Replicated Row is mapped to source parameters for events.
  */
 export declare class SqlEventSourceQuery extends BaseSqlDataQuery {
-    static fromSql(descriptor_name: string, sql: string, options: SyncRulesOptions, compatibility: CompatibilityContext): SqlEventSourceQuery;
+    static fromSql(sql: string, options: SyncRulesOptions, compatibility: CompatibilityContext): SqlEventSourceQuery;
     constructor(options: BaseSqlDataQueryOptions);
     evaluateRowWithErrors(table: SourceTableInterface, row: SqliteRow): EvaluatedEventRowWithErrors;
 }

package/dist/events/SqlEventSourceQuery.js

@@ -11,7 +11,7 @@ import { isSelectStatement } from '../utils.js';
  * Defines how a Replicated Row is mapped to source parameters for events.
  */
 export class SqlEventSourceQuery extends BaseSqlDataQuery {
-    static fromSql(descriptor_name, sql, options, compatibility) {
+    static fromSql(sql, options, compatibility) {
         const parsed = parse(sql, { locationTracking: true });
         const schema = options.schema;
         if (parsed.length > 1) {
@@ -95,7 +95,6 @@ export class SqlEventSourceQuery extends BaseSqlDataQuery {
             sourceTable,
             table: alias,
             sql,
-            descriptorName: descriptor_name,
             columns: q.columns ?? [],
             extractors: extractors,
             tools,

package/dist/events/SqlEventSourceQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"SqlEventSourceQuery.js","sourceRoot":"","sources":["../../src/events/SqlEventSourceQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAA8C,MAAM,wBAAwB,CAAC;AACtG,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAE5E,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAYhD;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,gBAAgB;IACvD,MAAM,CAAC,OAAO,CAAC,eAAuB,EAAE,GAAW,EAAE,OAAyB,EAAE,aAAmC;QACjH,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAE9B,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,YAAY,CAAC,6CAA6C,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QACnG,CAAC;QACD,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,YAAY,CAAC,sCAAsC,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;QACnF,CAAC;QAED,IAAI,MAAM,GAAmB,EAAE,CAAC;QAEhC,MAAM,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QAEjD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC;YACtE,MAAM,IAAI,YAAY,CAAC,iCAAiC,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACxF,CAAC;QAED,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAClC,IAAI,QAAQ,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;YAC3B,MAAM,IAAI,YAAY,CAAC,iCAAiC,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACxF,CAAC;QACD,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE/C,MAAM,WAAW,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,IAAI,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9F,IAAI,WAAW,GAA4B,SAAS,CAAC;QACrD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAC7C,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,CAAC,GAAG,IAAI,YAAY,CACxB,SAAS,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,YAAY,YAAY,EACnE,GAAG,EACH,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,CACvB,CAAC;gBACF,CAAC,CAAC,IAAI,GAAG,SAAS,CAAC;gBAEnB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,WAAW,GAAG,IAAI,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC;YACzB,KAAK,EAAE,KAAK;YACZ,eAAe,EAAE,EAAE;YACnB,WAAW,EAAE,CAAC,KAAK,CAAC;YACpB,GAAG;YACH,MAAM,EAAE,WAAW;YACnB,oBAAoB,EAAE,aAAa;SACpC,CAAC,CAAC;QAEH,IAAI,UAAU,GAAwB,EAAE,CAAC;QACzC,KAAK,IAAI,MAAM,IAAI,CAAC,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC;gBAChB,MAAM,MAAM,GAAG,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC3D,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC1B,uBAAuB;oBACvB,SAAS;gBACX,CAAC;gBACD,UAAU,CAAC,IAAI,CAAC;oBACd,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;wBAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBACzC,CAAC;oBACD,QAAQ,CAAC,MAAM,EAAE,IAAI;wBACnB,MAAM,GAAG,GAAG,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;wBAC/C,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,IAAI,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC;oBACjG,CAAC;iBACF,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,IAAI,CAAC;oBACd,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;wBAC1B,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;wBACvC,KAAK,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;4BACpB,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gCACxB,SAAS;4BACX,CAAC;4BACD,MAAM,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;wBAC3B,CAAC;oBACH,CAAC;oBACD,QAAQ,CAAC,MAAM,EAAE,IAAI;wBACnB,KAAK,IAAI,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;4BACzD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC;wBAC/B,CAAC;oBACH,CAAC;iBACF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B,OAAO,IAAI,mBAAmB,CAAC;YAC7B,WAAW;YACX,KAAK,EAAE,KAAK;YACZ,GAAG;YACH,cAAc,EAAE,eAAe;YAC/B,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,EAAE;YACxB,UAAU,EAAE,UAAU;YACtB,KAAK;YACL,gBAAgB,EAAE,EAAE;YACpB,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;IAED,YAAY,OAAgC;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,qBAAqB,CAAC,KAA2B,EAAE,GAAc;QAC/D,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,KAAM,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;YAErF,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACvC,OAAO;gBACL,MAAM,EAAE;oBACN,IAAI;iBACL;gBACD,MAAM,EAAE,EAAE;aACX,CAAC;QACJ,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,8BAA8B,CAAC,EAAE,CAAC;QACnE,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"SqlEventSourceQuery.js","sourceRoot":"","sources":["../../src/events/SqlEventSourceQuery.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAA8C,MAAM,wBAAwB,CAAC;AACtG,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtD,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAE5E,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAYhD;;GAEG;AACH,MAAM,OAAO,mBAAoB,SAAQ,gBAAgB;IACvD,MAAM,CAAC,OAAO,CAAC,GAAW,EAAE,OAAyB,EAAE,aAAmC;QACxF,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,gBAAgB,EAAE,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAE9B,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,IAAI,YAAY,CAAC,6CAA6C,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;QACnG,CAAC;QACD,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1B,MAAM,IAAI,YAAY,CAAC,sCAAsC,EAAE,GAAG,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;QACnF,CAAC;QAED,IAAI,MAAM,GAAmB,EAAE,CAAC;QAEhC,MAAM,CAAC,IAAI,CAAC,GAAG,wBAAwB,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QAEjD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC;YACtE,MAAM,IAAI,YAAY,CAAC,iCAAiC,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACxF,CAAC;QAED,MAAM,QAAQ,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAClC,IAAI,QAAQ,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;YAC3B,MAAM,IAAI,YAAY,CAAC,iCAAiC,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACxF,CAAC;QACD,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE/C,MAAM,WAAW,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,MAAM,IAAI,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9F,IAAI,WAAW,GAA4B,SAAS,CAAC;QACrD,IAAI,MAAM,EAAE,CAAC;YACX,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;YAC7C,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;gBACvB,MAAM,CAAC,GAAG,IAAI,YAAY,CACxB,SAAS,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,YAAY,YAAY,EACnE,GAAG,EACH,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,SAAS,CACvB,CAAC;gBACF,CAAC,CAAC,IAAI,GAAG,SAAS,CAAC;gBAEnB,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjB,CAAC;iBAAM,CAAC;gBACN,WAAW,GAAG,IAAI,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YACpD,CAAC;QACH,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,QAAQ,CAAC;YACzB,KAAK,EAAE,KAAK;YACZ,eAAe,EAAE,EAAE;YACnB,WAAW,EAAE,CAAC,KAAK,CAAC;YACpB,GAAG;YACH,MAAM,EAAE,WAAW;YACnB,oBAAoB,EAAE,aAAa;SACpC,CAAC,CAAC;QAEH,IAAI,UAAU,GAAwB,EAAE,CAAC;QACzC,KAAK,IAAI,MAAM,IAAI,CAAC,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;YACzC,IAAI,IAAI,IAAI,GAAG,EAAE,CAAC;gBAChB,MAAM,MAAM,GAAG,KAAK,CAAC,wBAAwB,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC3D,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC1B,uBAAuB;oBACvB,SAAS;gBACX,CAAC;gBACD,UAAU,CAAC,IAAI,CAAC;oBACd,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;wBAC1B,MAAM,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBACzC,CAAC;oBACD,QAAQ,CAAC,MAAM,EAAE,IAAI;wBACnB,MAAM,GAAG,GAAG,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;wBAC/C,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,IAAI,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,EAAE,YAAY,EAAE,CAAC;oBACjG,CAAC;iBACF,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,UAAU,CAAC,IAAI,CAAC;oBACd,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;wBAC1B,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;wBACvC,KAAK,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;4BACpB,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gCACxB,SAAS;4BACX,CAAC;4BACD,MAAM,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC;wBAC3B,CAAC;oBACH,CAAC;oBACD,QAAQ,CAAC,MAAM,EAAE,IAAI;wBACnB,KAAK,IAAI,MAAM,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC;4BACzD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC;wBAC/B,CAAC;oBACH,CAAC;iBACF,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QAE7B,OAAO,IAAI,mBAAmB,CAAC;YAC7B,WAAW;YACX,KAAK,EAAE,KAAK;YACZ,GAAG;YACH,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,EAAE;YACxB,UAAU,EAAE,UAAU;YACtB,KAAK;YACL,gBAAgB,EAAE,EAAE;YACpB,MAAM,EAAE,MAAM;SACf,CAAC,CAAC;IACL,CAAC;IAED,YAAY,OAAgC;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,qBAAqB,CAAC,KAA2B,EAAE,GAAc;QAC/D,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,EAAE,CAAC,IAAI,CAAC,KAAM,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;YAErF,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC;YACvC,OAAO;gBACL,MAAM,EAAE;oBACN,IAAI;iBACL;gBACD,MAAM,EAAE,EAAE;aACX,CAAC;QACJ,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,OAAO,IAAI,8BAA8B,CAAC,EAAE,CAAC;QACnE,CAAC;IACH,CAAC;CACF"}

package/dist/from_yaml.d.ts

@@ -0,0 +1,28 @@
+import { SourceSchema } from './types.js';
+import { SyncConfigWithErrors } from './SyncConfig.js';
+/**
+ * Reads `sync_rules.yaml` files containing a sync configuration.
+ *
+ * @internal Only exposed through `SqlSyncRules.fromYaml`.
+ */
+export declare class SyncConfigFromYaml {
+    #private;
+    private readonly options;
+    private readonly yaml;
+    constructor(options: SyncConfigFromYamlOptions, yaml: string);
+    read(): SyncConfigWithErrors;
+}
+export interface SyncConfigFromYamlOptions {
+    readonly throwOnError: boolean;
+    readonly schema?: SourceSchema;
+    /**
+     * The default schema to use when only a table name is specified.
+     *
+     * 'public' for Postgres, default database for MongoDB/MySQL.
+     */
+    readonly defaultSchema: string;
+    /**
+     * Whether to allow the option of using the new sync compiler.
+     */
+    readonly allowNewSyncCompiler: boolean;
+}

package/dist/from_yaml.js

@@ -0,0 +1,411 @@
+import { isScalar, LineCounter, parseDocument, Scalar, YAMLMap, YAMLSeq } from 'yaml';
+import { SqlRuleError, SyncRulesErrors, YamlError } from './errors.js';
+import { DEFAULT_BUCKET_PRIORITY, isValidPriority } from './BucketDescription.js';
+import { CompatibilityContext, CompatibilityEdition, CompatibilityOption, TimeValuePrecision } from './compatibility.js';
+import { SqlSyncRules } from './SqlSyncRules.js';
+import { validateSyncRulesSchema } from './json_schema.js';
+import { SqlEventDescriptor } from './events/SqlEventDescriptor.js';
+import { SqlBucketDescriptor } from './SqlBucketDescriptor.js';
+import { SyncStreamsCompiler } from './compiler/compiler.js';
+import { syncStreamFromSql } from './streams/from_sql.js';
+import { PrecompiledSyncConfig } from './sync_plan/evaluator/index.js';
+import { javaScriptExpressionEngine } from './sync_plan/engine/javascript.js';
+const ACCEPT_POTENTIALLY_DANGEROUS_QUERIES = Symbol('ACCEPT_POTENTIALLY_DANGEROUS_QUERIES');
+/**
+ * Reads `sync_rules.yaml` files containing a sync configuration.
+ *
+ * @internal Only exposed through `SqlSyncRules.fromYaml`.
+ */
+export class SyncConfigFromYaml {
+    options;
+    yaml;
+    #errors = [];
+    #lineCounter = new LineCounter();
+    // Names of bucket definitions and sync streams, to prevent duplicates.
+    #definitionNames = new Set();
+    constructor(options, yaml) {
+        this.options = options;
+        this.yaml = yaml;
+    }
+    read() {
+        return { config: this.#read(), errors: this.#errors };
+    }
+    #read() {
+        const parsed = parseDocument(this.yaml, {
+            schema: 'core',
+            keepSourceTokens: true,
+            lineCounter: this.#lineCounter,
+            customTags: [
+                {
+                    tag: '!accept_potentially_dangerous_queries',
+                    resolve(_text, _onError) {
+                        return ACCEPT_POTENTIALLY_DANGEROUS_QUERIES;
+                    }
+                }
+            ]
+        });
+        if (parsed.errors.length > 0) {
+            this.#errors.push(...parsed.errors.map((e) => new YamlError(e)));
+            this.#throwOnErrorIfRequested();
+            // Return an empty sync rules instance if we couldn't parse YAML, it doesn't make sense to try parsing the broken
+            // structure further.
+            return new SqlSyncRules(this.yaml);
+        }
+        let compatibility;
+        let useNewCompiler;
+        if (parsed.has('config')) {
+            const declaredOptions = parsed.get('config');
+            const compatibilityOptions = this.#parseCompatibilityOptions(declaredOptions);
+            compatibility = compatibilityOptions.compatibility;
+            useNewCompiler = compatibilityOptions.useNewCompiler;
+        }
+        else {
+            compatibility = CompatibilityContext.FULL_BACKWARDS_COMPATIBILITY;
+            useNewCompiler = false;
+        }
+        // Bucket definitions using explicit parameter and data queries.
+        const bucketMap = parsed.get('bucket_definitions');
+        const streamMap = parsed.get('streams');
+        let result;
+        if (useNewCompiler && this.options.allowNewSyncCompiler) {
+            result = this.#compileSyncPlan(bucketMap, streamMap, compatibility);
+        }
+        else {
+            result = this.#legacyParseBucketDefinitionsAndStreams(bucketMap, streamMap, compatibility);
+        }
+        const eventDefinitions = this.#parseEventDefinitions(parsed, compatibility);
+        result.eventDescriptors.push(...eventDefinitions);
+        // Validate that there are no additional properties.
+        // Since these errors don't contain line numbers, do this last.
+        const valid = validateSyncRulesSchema(parsed.toJSON());
+        if (!valid) {
+            this.#errors.push(...validateSyncRulesSchema.errors.map((e) => {
+                return new YamlError(e);
+            }));
+        }
+        this.#throwOnErrorIfRequested();
+        return result;
+    }
+    #throwOnErrorIfRequested() {
+        if (this.options.throwOnError && this.#errors.find((e) => e.type != 'warning') != null) {
+            throw new SyncRulesErrors(this.#errors);
+        }
+    }
+    /**
+     * Parses the `config` block of a sync configuration.
+     *
+     * @see https://docs.powersync.com/sync/advanced/compatibility
+     */
+    #parseCompatibilityOptions(declaredOptions) {
+        const edition = (declaredOptions.get('edition') ?? CompatibilityEdition.LEGACY);
+        const options = new Map();
+        let maxTimeValuePrecision = undefined;
+        let useNewCompiler = false;
+        for (const entry of declaredOptions.items) {
+            const { key: { value: key }, value: { value } } = entry;
+            if (key == 'timestamp_max_precision') {
+                maxTimeValuePrecision = TimeValuePrecision.byName[value];
+            }
+            if (key == 'sync_config_compiler') {
+                useNewCompiler = Boolean(value);
+                continue;
+            }
+            const option = CompatibilityOption.byName[key];
+            if (option) {
+                options.set(option, Boolean(value));
+            }
+        }
+        const compatibility = new CompatibilityContext({ edition, overrides: options, maxTimeValuePrecision });
+        if (maxTimeValuePrecision && !compatibility.isEnabled(CompatibilityOption.timestampsIso8601)) {
+            this.#errors.push(new YamlError(new Error(`'timestamp_max_precision' requires 'timestamps_iso8601' to be enabled.`)));
+        }
+        return { compatibility, useNewCompiler };
+    }
+    #compileSyncPlan(bucketMap, streamMap, compatibility) {
+        if (bucketMap != null) {
+            this.#errors.push(this.#yamlError(bucketMap, `'bucket_definitions' are not supported by the new compiler. Consider using https://powersync-community.github.io/bucket-definitions-to-sync-streams/ to translate them to streams.`));
+        }
+        if (streamMap == null) {
+            this.#errors.push(new YamlError(new Error(`'streams' are required.`)));
+        }
+        const compiler = new SyncStreamsCompiler(this.options);
+        for (const entry of streamMap?.items ?? []) {
+            const { key: keyScalar, value } = entry;
+            if (!(value instanceof YAMLMap)) {
+                // The json schema validator will flag this later.
+                continue;
+            }
+            const key = keyScalar.toString();
+            if (!this.#checkUniqueName(key, keyScalar)) {
+                continue;
+            }
+            const $with = value.get('with');
+            const streamCompiler = compiler.stream({
+                name: key,
+                isSubscribedByDefault: value.get('auto_subscribe', true)?.value == true,
+                priority: this.#parsePriority(value) ?? DEFAULT_BUCKET_PRIORITY
+            });
+            if ($with != null) {
+                for (const entry of $with.items ?? []) {
+                    const { key: cteName, value: cteQuery } = entry;
+                    const [sql, errorListener] = this.#scalarErrorListener(cteQuery);
+                    const parsed = compiler.commonTableExpression(sql, errorListener);
+                    if (parsed) {
+                        streamCompiler.registerCommonTableExpression(cteName.value, parsed);
+                    }
+                }
+            }
+            const addQuery = (query) => {
+                const [sql, errorListener] = this.#scalarErrorListener(query);
+                streamCompiler.addQuery(sql, errorListener);
+            };
+            const queries = value.get('queries');
+            const query = value.get('query', true);
+            if ((queries == null) == (query == null)) {
+                this.#errors.push(this.#yamlError(value, 'One of `queries` or `query` must be given.'));
+            }
+            if (query) {
+                addQuery(query);
+            }
+            if (queries) {
+                for (const queryEntry of queries.items) {
+                    if (queryEntry instanceof Scalar) {
+                        addQuery(queryEntry);
+                    }
+                }
+            }
+            streamCompiler.finish();
+        }
+        return new PrecompiledSyncConfig(compiler.output.toSyncPlan(), {
+            defaultSchema: this.options.defaultSchema,
+            engine: javaScriptExpressionEngine(compatibility),
+            sourceText: this.yaml
+        });
+    }
+    #legacyParseBucketDefinitionsAndStreams(bucketMap, streamMap, compatibility) {
+        const rules = new SqlSyncRules(this.yaml);
+        rules.compatibility = compatibility;
+        if (bucketMap == null && streamMap == null) {
+            this.#errors.push(new YamlError(new Error(`'bucket_definitions' or 'streams' is required`)));
+            this.#throwOnErrorIfRequested();
+        }
+        for (let entry of bucketMap?.items ?? []) {
+            const { key: keyScalar, value } = entry;
+            const key = keyScalar.toString();
+            if (!this.#checkUniqueName(key, keyScalar)) {
+                continue;
+            }
+            if (value == null || !(value instanceof YAMLMap)) {
+                this.#errors.push(this.#tokenError(keyScalar, `'${key}' bucket definition must be an object`));
+                continue;
+            }
+            const accept_potentially_dangerous_queries = value.get('accept_potentially_dangerous_queries', true)?.value == true;
+            const parseOptionPriority = this.#parsePriority(value);
+            const queryOptions = {
+                ...this.options,
+                accept_potentially_dangerous_queries,
+                priority: parseOptionPriority,
+                compatibility
+            };
+            const parameters = value.get('parameters', true);
+            const dataQueries = value.get('data', true);
+            const descriptor = new SqlBucketDescriptor(key);
+            if (parameters instanceof Scalar) {
+                this.#withScalar(parameters, (q) => {
+                    return descriptor.addParameterQuery(q, queryOptions);
+                });
+            }
+            else if (parameters instanceof YAMLSeq) {
+                for (let item of parameters.items) {
+                    this.#withScalar(item, (q) => {
+                        return descriptor.addParameterQuery(q, queryOptions);
+                    });
+                }
+            }
+            else {
+                descriptor.addParameterQuery('SELECT', queryOptions);
+            }
+            if (!(dataQueries instanceof YAMLSeq)) {
+                this.#errors.push(this.#tokenError((dataQueries ?? value), `'data' must be an array`));
+                continue;
+            }
+            for (let query of dataQueries.items) {
+                this.#withScalar(query, (q) => {
+                    return descriptor.addDataQuery(q, queryOptions, compatibility);
+                });
+            }
+            rules.bucketSources.push(descriptor);
+            rules.bucketDataSources.push(...descriptor.dataSources);
+            rules.bucketParameterLookupSources.push(...descriptor.parameterIndexLookupCreators);
+        }
+        for (const entry of streamMap?.items ?? []) {
+            const { key: keyScalar, value } = entry;
+            const key = keyScalar.toString();
+            if (!this.#checkUniqueName(key, keyScalar)) {
+                continue;
+            }
+            // We don't support with or multiple queries in streams, those are only supported by the new compiler.
+            const $with = value.get('with');
+            if ($with != null) {
+                this.#errors.push(this.#yamlError($with, 'Common table expressions are not supported without the `sync_config_compiler` option.'));
+            }
+            const queries = value.get('queries');
+            if (queries != null) {
+                this.#errors.push(this.#yamlError(queries, 'Multiple queries not supported without the `sync_config_compiler` option.'));
+            }
+            const accept_potentially_dangerous_queries = value.get('accept_potentially_dangerous_queries', true)?.value == true;
+            const queryOptions = {
+                ...this.options,
+                accept_potentially_dangerous_queries,
+                priority: this.#parsePriority(value),
+                auto_subscribe: value.get('auto_subscribe', true)?.value == true,
+                compatibility
+            };
+            const data = value.get('query', true);
+            if (data instanceof Scalar) {
+                this.#withScalar(data, (q) => {
+                    const [parsed, errors] = syncStreamFromSql(key, q, queryOptions);
+                    rules.bucketSources.push(parsed);
+                    rules.bucketDataSources.push(...parsed.dataSources);
+                    rules.bucketParameterLookupSources.push(...parsed.parameterIndexLookupCreators);
+                    return {
+                        parsed: true,
+                        errors
+                    };
+                });
+            }
+            else {
+                this.#errors.push(this.#tokenError(data, 'Must be a string.'));
+                continue;
+            }
+        }
+        return rules;
+    }
+    #parseEventDefinitions(parsed, compatibility) {
+        const eventMap = parsed.get('event_definitions');
+        const eventDescriptors = [];
+        for (const event of eventMap?.items ?? []) {
+            const { key, value } = event;
+            if (false == value instanceof YAMLMap) {
+                this.#errors.push(new YamlError(new Error(`Event definitions must be objects.`)));
+                continue;
+            }
+            const payloads = value.get('payloads');
+            if (false == payloads instanceof YAMLSeq) {
+                this.#errors.push(new YamlError(new Error(`Event definition payloads must be an array.`)));
+                continue;
+            }
+            const eventDescriptor = new SqlEventDescriptor(key.toString(), compatibility);
+            for (let item of payloads.items) {
+                if (!isScalar(item)) {
+                    this.#errors.push(new YamlError(new Error(`Payload queries for events must be scalar.`)));
+                    continue;
+                }
+                this.#withScalar(item, (q) => {
+                    return eventDescriptor.addSourceQuery(q, this.options);
+                });
+            }
+            eventDescriptors.push(eventDescriptor);
+        }
+        return eventDescriptors;
+    }
+    #checkUniqueName(name, literal) {
+        if (this.#definitionNames.has(name)) {
+            this.#errors.push(this.#tokenError(literal, 'Duplicate stream or bucket definition.'));
+            return false;
+        }
+        this.#definitionNames.add(name);
+        return true;
+    }
+    #parsePriority(value) {
+        if (value.has('priority')) {
+            const priorityValue = value.get('priority', true);
+            if (typeof priorityValue.value != 'number' || !isValidPriority(priorityValue.value)) {
+                this.#errors.push(this.#tokenError(priorityValue, 'Invalid priority, expected a number between 0 and 3 (inclusive).'));
+            }
+            else {
+                return priorityValue.value;
+            }
+        }
+    }
+    #yamlError(node, message) {
+        if (node.range != null) {
+            const [start, _, end] = node.range;
+            return new YamlError(new Error(message), { start, end });
+        }
+        else {
+            return new YamlError(new Error(message));
+        }
+    }
+    #tokenError(token, message) {
+        const start = token?.srcToken?.offset ?? 0;
+        const end = start + 1;
+        return new YamlError(new Error(message), { start, end });
+    }
+    #withScalar(scalar, cb) {
+        const value = scalar.toString();
+        const wrapped = (value) => {
+            try {
+                return cb(value);
+            }
+            catch (e) {
+                return {
+                    parsed: false,
+                    errors: [e]
+                };
+            }
+        };
+        const result = wrapped(value);
+        for (let err of result.errors) {
+            this.#addErrorFromScalar(scalar, value, err);
+        }
+        return result;
+    }
+    /**
+     * Reads string contents from a YAML scalar and returns an error listener for the sync stream compiler.
+     */
+    #scalarErrorListener(scalar) {
+        const value = scalar.toString();
+        const listener = {
+            report: (message, location, options) => {
+                const error = new SqlRuleError(message, value, location);
+                if (options?.isWarning) {
+                    error.type = 'warning';
+                }
+                this.#addErrorFromScalar(scalar, value, error);
+            }
+        };
+        return [value, listener];
+    }
+    /**
+     * Adds an error originally added while parsing a YAML scalar string.
+     *
+     * @param scalar The scalar being parsed.
+     * @param value String contents of the scalar.
+     * @param error An error in the scalar content. Offsets will be translated to point at the full YAML source.
+     */
+    #addErrorFromScalar(scalar, value, err) {
+        let sourceOffset = scalar.srcToken.offset;
+        if (scalar.type == Scalar.QUOTE_DOUBLE || scalar.type == Scalar.QUOTE_SINGLE) {
+            // TODO: Is there a better way to do this?
+            sourceOffset += 1;
+        }
+        let offset;
+        let end;
+        if (err instanceof SqlRuleError && err.location) {
+            offset = err.location.start + sourceOffset;
+            end = err.location.end + sourceOffset;
+        }
+        else if (typeof err.token?._location?.start == 'number') {
+            offset = sourceOffset + err.token?._location?.start;
+            end = sourceOffset + err.token?._location?.end;
+        }
+        else {
+            offset = sourceOffset;
+            end = sourceOffset + Math.max(value.length, 1);
+        }
+        const pos = { start: offset, end };
+        this.#errors.push(new YamlError(err, pos));
+    }
+}
+//# sourceMappingURL=from_yaml.js.map