@powersync/service-sync-rules 0.29.10 → 0.31.0

package/dist/sync_plan/evaluator/parameter_evaluator.js

@@ -0,0 +1,359 @@
+import { ScopedParameterLookup, UnscopedParameterLookup } from '../../BucketParameterQuerier.js';
+import { cartesianProduct } from '../../streams/utils.js';
+import { isValidParameterValue } from '../../utils.js';
+import { MapSourceVisitor, visitExpr } from '../expression_visitor.js';
+import { mapExternalDataToInstantiation } from '../engine/scalar_expression_engine.js';
+/**
+ * Finds bucket parameters for a given request or subscription.
+ *
+ * In sync streams, queriers are represented as a DAG structure describing how to get from connection data to bucket
+ * parameters.
+ *
+ * As an example, consider the following stream:
+ *
+ * ```
+ * SELECT projects.* FROM projects
+ *  INNER JOIN orgs ON orgs.id = projects.org_id
+ * WHERE orgs.name = auth.parameter('org')
+ * ```
+ *
+ * This would partition data into a bucket with a single parameter (grouping by `projects.org_id`). It would also
+ * prepare a lookup from `orgs.name` to `orgs.id`.
+ *
+ * The querier for this would have:
+ *
+ *  1. A single lookup stage with a single {@link plan.ParameterLookup}. That lookup would have an instantiation
+ *     reflecting `auth.parameter('org')` as a `request` {@link plan.ParameterValue}.
+ *  2. A single {@link plan.StreamQuerier.sourceInstantiation}, a `lookup` {@link plan.ParameterValue} referencing the
+ *     lookup from step 1.
+ *
+ * On this prepared evaluator, lookup stages and parameter values are tracked as {@link PreparedExpandingLookup}s and
+ * {@link PreparedParameterValue}s, respectively. These correspond to their definitions on sync plans, except that:
+ *
+ *   1. Instead of being a description of the parameter, they're a JavaScript function that can be invoked to compute
+ *      parameters.
+ *   2. After being called once, we can replace them with a cached value. This enables a partial instantiation, and
+ *      avoids recomputing everything whenever a parameter lookup changes. In the example stream, we would run and cache
+ *      the outputs of `auth.parameter('org')` for a given connection. This sub-expression would not get re-evaluated
+ *      when the `org-name` -> `org.id` lookup changes.
+ *
+ * For queriers that don't use parameter lookups, e.g. for streams like `SELECT * FROM users WHERE id = auth.user_id()`,
+ * the partial instantiation based on connection data happens to be a complete instantiation. We use this when building
+ * queriers by indicating that no lookups will be used.
+ */
+export class RequestParameterEvaluators {
+    lookupStages;
+    parameterValues;
+    constructor(
+    /**
+     * Pending lookup stages, or their cached outputs.
+     */
+    lookupStages, 
+    /**
+     * Pending parameter values, or their cached outputs.
+     */
+    parameterValues) {
+        this.lookupStages = lookupStages;
+        this.parameterValues = parameterValues;
+    }
+    /**
+     * Returns a copy of this instance.
+     *
+     * Since resolved values are replaced with their instantiation, we need to use closed evaluators before evaluating
+     * them on inputs that might change (like parameter lookups).
+     *
+     * Static data (like connection parameters) can be resolved sooner, and cloning that partially-instantiated evaluator
+     * graph essentially forks it. This allows us to cache connection parameters for the lifetime of the connection
+     * instead of re-evaluating them on every parameter lookup change.
+     */
+    clone() {
+        return new RequestParameterEvaluators(this.lookupStages.map((stage) => [...stage]), [...this.parameterValues]);
+    }
+    /**
+     * Evaluates those lookups and parameter values that be evaluated without looking up parameter indexes.
+     *
+     * This is also used to determine whether a querier is static - if the partial instantiation depending on request data
+     * fully resolves the stream, we don't need to lookup any parameters.
+     */
+    partiallyInstantiate(input) {
+        const helper = new PartialInstantiator(input, this);
+        this.lookupStages.forEach((stage, stageIndex) => {
+            stage.forEach((_, indexInStage) => helper.expandingLookupSync(stageIndex, indexInStage));
+        });
+        this.parameterValues.forEach((_, i) => helper.parameterSync(this.parameterValues, i));
+    }
+    /**
+     * Resolves and caches all lookup stages and parameter values.
+     *
+     * Because this needs to lookup parameter indexes, it is asynchronous.
+     */
+    async instantiate(input) {
+        const helper = new FullInstantiator(input, this);
+        for (let i = 0; i < this.lookupStages.length; i++) {
+            // Within a stage, we can resolve lookups concurrently.
+            await Promise.all(this.lookupStages[i].map((_, j) => helper.expandingLookup(i, j)));
+        }
+        // At this point, all lookups have been resolved and we can synchronously evaluate parameters which might depend on
+        // those lookups.
+        return helper.resolveInputs(this.parameterValues);
+    }
+    /**
+     * Whether these evaluators are known to not result in any buckets, for instance because parameters are instanted to
+     * `NULL` values that aren't equal to anything.
+     *
+     * This is fairly efficient to compute and can be used to short-circuit further evaluation.
+     */
+    isDefinitelyUninstantiable() {
+        for (const parameter of this.parameterValues) {
+            if (parameter.type != 'cached') {
+                return false; // Unknown
+            }
+            if (parameter.values.length === 0) {
+                // Missing parameter.
+                return true;
+            }
+        }
+        return false;
+    }
+    extractFullInstantiation() {
+        // All lookup stages need to be resolved, even if they're not used in a parameter. The reason is that queries like
+        // `WHERE 'static_value' IN (SELECT name FROM users WHERE id = auth.user_id())` are implemented as lookup stages,
+        // so we can't ignore them.
+        for (const stage of this.lookupStages) {
+            for (const element of stage) {
+                if (element.type !== 'cached') {
+                    return undefined;
+                }
+            }
+        }
+        // Outer array represents parameters, inner array represents values for a given parameter.
+        const parameters = [];
+        for (const parameter of this.parameterValues) {
+            if (parameter.type !== 'cached') {
+                return undefined;
+            }
+            parameters.push(parameter.values);
+        }
+        // Transform to array of complete instantiations.
+        return [...cartesianProduct(...parameters)];
+    }
+    /**
+     * Prepares evaluators for a description of parameter values obtained from a compiled querier in the sync plan.
+     *
+     * @param lookupStages The {@link plan.StreamQuerier.lookupStages} of the querier to compile.
+     * @param values The {@link plan.StreamQuerier.sourceInstantiation} of the querier to compile.
+     * @param input Access to bucket and parameter sources generated for buckets and parameter lookups referenced by the
+     * querier.
+     */
+    static prepare(lookupStages, values, input) {
+        const mappedStages = [];
+        const lookupToStage = new Map();
+        function mapParameterValue(value) {
+            if (value.type == 'request') {
+                // Prepare an expression evaluating the expression derived from request data.
+                const mapper = mapExternalDataToInstantiation();
+                const prepared = input.engine.prepareEvaluator({ filters: [], outputs: [mapper.transform(value.expr)] });
+                const instantiation = mapper.instantiation;
+                return {
+                    type: 'request',
+                    read(request) {
+                        return prepared.evaluate(parametersForRequest(request, instantiation))[0][0];
+                    }
+                };
+            }
+            else if (value.type == 'lookup') {
+                const stagePosition = lookupToStage.get(value.lookup);
+                return { type: 'lookup', lookup: stagePosition, resultIndex: value.resultIndex };
+            }
+            else {
+                return { type: 'intersection', values: mapParameterValues(value.values) };
+            }
+        }
+        function mapParameterValues(values) {
+            return values.map(mapParameterValue);
+        }
+        for (const stage of lookupStages) {
+            const stageIndex = mappedStages.length;
+            const mappedStage = [];
+            mappedStages.push(mappedStage);
+            for (const lookup of stage) {
+                const index = mappedStage.length;
+                lookupToStage.set(lookup, { stage: stageIndex, index });
+                if (lookup.type == 'parameter') {
+                    mappedStage.push({
+                        type: 'parameter',
+                        lookup: input.preparedLookups.get(lookup.lookup),
+                        instantiation: mapParameterValues(lookup.instantiation)
+                    });
+                }
+                else {
+                    // Create an expression like SELECT <output> FROM table_valued(<functionInputs>) WHERE <filters>
+                    const mapInputs = mapExternalDataToInstantiation();
+                    const fn = {
+                        name: lookup.functionName,
+                        inputs: lookup.functionInputs.map((e) => mapInputs.transform(e))
+                    };
+                    const mapOutputs = new MapSourceVisitor(({ column }) => ({
+                        function: fn,
+                        column
+                    }));
+                    const prepared = input.engine.prepareEvaluator({
+                        tableValuedFunctions: [fn],
+                        outputs: lookup.outputs.map((e) => visitExpr(mapOutputs, e, null)),
+                        filters: lookup.filters.map((e) => visitExpr(mapOutputs, e, null))
+                    });
+                    mappedStage.push({
+                        type: 'table_valued',
+                        read(request) {
+                            return [
+                                ...filterParameterRows(prepared.evaluate(parametersForRequest(request, mapInputs.instantiation)))
+                            ];
+                        }
+                    });
+                }
+            }
+        }
+        return new RequestParameterEvaluators(mappedStages, mapParameterValues(values));
+    }
+}
+class PartialInstantiator {
+    input;
+    evaluators;
+    constructor(input, evaluators) {
+        this.input = input;
+        this.evaluators = evaluators;
+    }
+    /**
+     * If possible, evaluates an element in an array of parameter values and replaces the parameter with a marker
+     * indicating it as cached.
+     */
+    parameterSync(parent, index) {
+        const current = parent[index];
+        if (current.type === 'cached') {
+            return current.values;
+        }
+        else if (current.type === 'intersection') {
+            let intersection = null;
+            for (let i = 0; i < current.values.length; i++) {
+                const evaluated = this.parameterSync(current.values, i);
+                if (evaluated == null) {
+                    return undefined; // Can't evaluate sub-parameter
+                }
+                if (intersection == null) {
+                    intersection = new Set(evaluated);
+                }
+                else {
+                    // TODO: Remove as any once we can use ES2025 in TypeScript
+                    intersection = intersection.intersection(new Set(evaluated));
+                }
+                if (intersection.size == 0) {
+                    // Empty intersection, we don't even need to evaluate the rest.
+                    break;
+                }
+            }
+            let values = [];
+            if (intersection) {
+                values.push(...intersection.keys());
+            }
+            parent[index] = { type: 'cached', values };
+            return values;
+        }
+        else if (current.type === 'lookup') {
+            const resolvedLookup = this.expandingLookupSync(current.lookup.stage, current.lookup.index);
+            if (resolvedLookup) {
+                const values = resolvedLookup.map((row) => row[current.resultIndex]);
+                parent[index] = { type: 'cached', values };
+                return values;
+            }
+        }
+        else if (current.type === 'request') {
+            const value = current.read(this.input.request);
+            const values = isValidParameterValue(value) ? [value] : [];
+            parent[index] = { type: 'cached', values };
+            return values;
+        }
+        return undefined;
+    }
+    expandingLookupSync(stage, index) {
+        const lookup = this.evaluators.lookupStages[stage][index];
+        if (lookup.type == 'table_valued') {
+            // We can evaluate this table-valued function already.
+            const values = lookup.read(this.input.request);
+            this.evaluators.lookupStages[stage][index] = { type: 'cached', values };
+            return values;
+        }
+        else if (lookup.type == 'cached') {
+            return lookup.values;
+        }
+        return undefined;
+    }
+}
+class FullInstantiator extends PartialInstantiator {
+    *resolveInputs(params) {
+        const parameterValues = params.map((_, index) => {
+            const cached = this.parameterSync(params, index);
+            if (cached == null) {
+                // This method is only called for inputs from an earlier stage, which should have been resolved at this point.
+                throw new Error('Should have been able to resolve parameter from earlier stage synchronously.');
+            }
+            return cached;
+        });
+        yield* cartesianProduct(...parameterValues);
+    }
+    async expandingLookup(stage, index) {
+        const lookup = this.evaluators.lookupStages[stage][index];
+        if (lookup.type == 'parameter') {
+            const scope = this.input.hydrationState.getParameterIndexLookupScope(lookup.lookup);
+            const outputs = await this.input.source.getParameterSets([...this.resolveInputs(lookup.instantiation)].map((instantiation) => ScopedParameterLookup.normalized(scope, UnscopedParameterLookup.normalized(instantiation))));
+            // Stream parameters generate an output row like {0: <expr>, 1: <expr>, ...}.
+            const values = outputs.map((row) => {
+                const length = Object.entries(row).length;
+                const asArray = [];
+                for (let i = 0; i < length; i++) {
+                    asArray.push(row[i.toString()]);
+                }
+                return asArray;
+            });
+            this.evaluators.lookupStages[stage][index] = { type: 'cached', values };
+            return values;
+        }
+        const other = this.expandingLookupSync(stage, index);
+        if (other == null) {
+            throw new Error('internal error: Unable to resolve non-parameter lookup synchronously?');
+        }
+        return other;
+    }
+}
+export function isValidParameterValueRow(row) {
+    for (const value of row) {
+        if (!isValidParameterValue(value)) {
+            return false;
+        }
+    }
+    return true;
+}
+export function parametersForRequest(parameters, values) {
+    return values.map((v) => {
+        if ('request' in v) {
+            switch (v.request) {
+                case 'auth':
+                    return parameters.rawTokenPayload;
+                case 'subscription':
+                    return parameters.rawStreamParameters;
+                case 'connection':
+                    return parameters.rawUserParameters;
+            }
+        }
+        else {
+            throw new Error('Illegal column reference in request filter');
+        }
+    });
+}
+function* filterParameterRows(rows) {
+    for (const row of rows) {
+        if (isValidParameterValueRow(row)) {
+            yield row;
+        }
+    }
+}
+//# sourceMappingURL=parameter_evaluator.js.map

package/dist/sync_plan/evaluator/parameter_evaluator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameter_evaluator.js","sourceRoot":"","sources":["../../../src/sync_plan/evaluator/parameter_evaluator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAyB,qBAAqB,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAGxH,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAE1D,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AAGvE,OAAO,EACL,8BAA8B,EAG/B,MAAM,uCAAuC,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,OAAO,0BAA0B;IAK1B;IAIA;IARX;IACE;;OAEG;IACM,YAAyC;IAClD;;OAEG;IACM,eAAyC;QAJzC,iBAAY,GAAZ,YAAY,CAA6B;QAIzC,oBAAe,GAAf,eAAe,CAA0B;IACjD,CAAC;IAEJ;;;;;;;;;OASG;IACH,KAAK;QACH,OAAO,IAAI,0BAA0B,CACnC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,EAC5C,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,oBAAoB,CAAC,KAAgC;QACnD,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAEpD,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;YAC9C,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC;IACxF,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,KAAyB;QACzC,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAEjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAClD,uDAAuD;YACvD,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACtF,CAAC;QAED,mHAAmH;QACnH,iBAAiB;QACjB,OAAO,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACH,0BAA0B;QACxB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAC7C,IAAI,SAAS,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC;gBAC/B,OAAO,KAAK,CAAC,CAAC,UAAU;YAC1B,CAAC;YAED,IAAI,SAAS,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClC,qBAAqB;gBACrB,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,wBAAwB;QACtB,kHAAkH;QAClH,iHAAiH;QACjH,2BAA2B;QAC3B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtC,KAAK,MAAM,OAAO,IAAI,KAAK,EAAE,CAAC;gBAC5B,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC9B,OAAO,SAAS,CAAC;gBACnB,CAAC;YACH,CAAC;QACH,CAAC;QAED,0FAA0F;QAC1F,MAAM,UAAU,GAA6B,EAAE,CAAC;QAChD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAC7C,IAAI,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAChC,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC;QAED,iDAAiD;QACjD,OAAO,CAAC,GAAG,gBAAgB,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,OAAO,CAAC,YAAsC,EAAE,MAA6B,EAAE,KAAkB;QACtG,MAAM,YAAY,GAAgC,EAAE,CAAC;QACrD,MAAM,aAAa,GAAG,IAAI,GAAG,EAA0D,CAAC;QAExF,SAAS,iBAAiB,CAAC,KAA0B;YACnD,IAAI,KAAK,CAAC,IAAI,IAAI,SAAS,EAAE,CAAC;gBAC5B,6EAA6E;gBAC7E,MAAM,MAAM,GAAG,8BAA8B,EAAiC,CAAC;gBAC/E,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;gBACzG,MAAM,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;gBAE3C,OAAO;oBACL,IAAI,EAAE,SAAS;oBACf,IAAI,CAAC,OAAO;wBACV,OAAO,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBAC/E,CAAC;iBACF,CAAC;YACJ,CAAC;iBAAM,IAAI,KAAK,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC;gBAClC,MAAM,aAAa,GAAG,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAE,CAAC;gBACvD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC;YACnF,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,MAAM,EAAE,kBAAkB,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAC5E,CAAC;QACH,CAAC;QAED,SAAS,kBAAkB,CAAC,MAA6B;YACvD,OAAO,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACvC,CAAC;QAED,KAAK,MAAM,KAAK,IAAI,YAAY,EAAE,CAAC;YACjC,MAAM,UAAU,GAAG,YAAY,CAAC,MAAM,CAAC;YACvC,MAAM,WAAW,GAA8B,EAAE,CAAC;YAClD,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAE/B,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;gBAC3B,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC;gBACjC,aAAa,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;gBAExD,IAAI,MAAM,CAAC,IAAI,IAAI,WAAW,EAAE,CAAC;oBAC/B,WAAW,CAAC,IAAI,CAAC;wBACf,IAAI,EAAE,WAAW;wBACjB,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAE;wBACjD,aAAa,EAAE,kBAAkB,CAAC,MAAM,CAAC,aAAa,CAAC;qBACxD,CAAC,CAAC;gBACL,CAAC;qBAAM,CAAC;oBACN,gGAAgG;oBAChG,MAAM,SAAS,GAAG,8BAA8B,EAAE,CAAC;oBACnD,MAAM,EAAE,GAAwB;wBAC9B,IAAI,EAAE,MAAM,CAAC,YAAY;wBACzB,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;qBACjE,CAAC;oBACF,MAAM,UAAU,GAAG,IAAI,gBAAgB,CACrC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;wBACf,QAAQ,EAAE,EAAE;wBACZ,MAAM;qBACP,CAAC,CACH,CAAC;oBAEF,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC,gBAAgB,CAAC;wBAC7C,oBAAoB,EAAE,CAAC,EAAE,CAAC;wBAC1B,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;wBAClE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;qBACnE,CAAC,CAAC;oBAEH,WAAW,CAAC,IAAI,CAAC;wBACf,IAAI,EAAE,cAAc;wBACpB,IAAI,CAAC,OAAO;4BACV,OAAO;gCACL,GAAG,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,oBAAoB,CAAC,OAAO,EAAE,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;6BAClG,CAAC;wBACJ,CAAC;qBACF,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAI,0BAA0B,CAAC,YAAY,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC;IAClF,CAAC;CACF;AAED,MAAM,mBAAmB;IAEF;IACA;IAFrB,YACqB,KAAQ,EACR,UAAsC;QADtC,UAAK,GAAL,KAAK,CAAG;QACR,eAAU,GAAV,UAAU,CAA4B;IACxD,CAAC;IAEJ;;;OAGG;IACH,aAAa,CAAC,MAAgC,EAAE,KAAa;QAC3D,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,OAAO,CAAC,MAAM,CAAC;QACxB,CAAC;aAAM,IAAI,OAAO,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;YAC3C,IAAI,YAAY,GAAqC,IAAI,CAAC;YAC1D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC/C,MAAM,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;gBACxD,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;oBACtB,OAAO,SAAS,CAAC,CAAC,+BAA+B;gBACnD,CAAC;gBAED,IAAI,YAAY,IAAI,IAAI,EAAE,CAAC;oBACzB,YAAY,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC;gBACpC,CAAC;qBAAM,CAAC;oBACN,2DAA2D;oBAC3D,YAAY,GAAI,YAAoB,CAAC,YAAY,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC,CAA8B,CAAC;gBACrG,CAAC;gBAED,IAAI,YAAY,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC;oBAC3B,+DAA+D;oBAC/D,MAAM;gBACR,CAAC;YACH,CAAC;YAED,IAAI,MAAM,GAA2B,EAAE,CAAC;YACxC,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;YACtC,CAAC;YAED,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;YAC3C,OAAO,MAAM,CAAC;QAChB,CAAC;aAAM,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACrC,MAAM,cAAc,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC5F,IAAI,cAAc,EAAE,CAAC;gBACnB,MAAM,MAAM,GAAG,cAAc,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;gBACrE,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;gBAC3C,OAAO,MAAM,CAAC;YAChB,CAAC;QACH,CAAC;aAAM,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;YACtC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAM,MAAM,GAA2B,qBAAqB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEnF,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;YAC3C,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,mBAAmB,CAAC,KAAa,EAAE,KAAa;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC;QAC1D,IAAI,MAAM,CAAC,IAAI,IAAI,cAAc,EAAE,CAAC;YAClC,sDAAsD;YACtD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC/C,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;YACxE,OAAO,MAAM,CAAC;QAChB,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC;YACnC,OAAO,MAAM,CAAC,MAAM,CAAC;QACvB,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAED,MAAM,gBAAiB,SAAQ,mBAAuC;IACpE,CAAC,aAAa,CAAC,MAAgC;QAC7C,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;YAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YACjD,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;gBACnB,8GAA8G;gBAC9G,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAC;YAClG,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC,CAAC;QAEH,KAAK,CAAC,CAAC,gBAAgB,CAAC,GAAG,eAAe,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,KAAa,EAAE,KAAa;QAChD,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC;QAC1D,IAAI,MAAM,CAAC,IAAI,IAAI,WAAW,EAAE,CAAC;YAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,4BAA4B,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;YACpF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,gBAAgB,CACtD,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,EAAE,CAClE,qBAAqB,CAAC,UAAU,CAAC,KAAK,EAAE,uBAAuB,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAC3F,CACF,CAAC;YAEF,6EAA6E;YAC7E,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBACjC,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;gBAC1C,MAAM,OAAO,GAA2B,EAAE,CAAC;gBAE3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBAChC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAyB,CAAC,CAAC;gBAC1D,CAAC;gBACD,OAAO,OAAO,CAAC;YACjB,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC;YACxE,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,mBAAmB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACrD,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;QAC3F,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA2BD,MAAM,UAAU,wBAAwB,CAAC,GAAkB;IACzD,KAAK,MAAM,KAAK,IAAI,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,UAA6B,EAAE,MAAgC;IAClG,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACtB,IAAI,SAAS,IAAI,CAAC,EAAE,CAAC;YACnB,QAAQ,CAAC,CAAC,OAAO,EAAE,CAAC;gBAClB,KAAK,MAAM;oBACT,OAAO,UAAU,CAAC,eAAe,CAAC;gBACpC,KAAK,cAAc;oBACjB,OAAO,UAAU,CAAC,mBAAoB,CAAC;gBACzC,KAAK,YAAY;oBACf,OAAO,UAAU,CAAC,iBAAiB,CAAC;YACxC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,QAAQ,CAAC,CAAC,mBAAmB,CAAC,IAAqB;IACjD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,wBAAwB,CAAC,GAAG,CAAC,EAAE,CAAC;YAClC,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/sync_plan/evaluator/parameter_index_lookup_creator.d.ts

@@ -0,0 +1,20 @@
+import { ParameterIndexLookupCreator } from '../../BucketSource.js';
+import { ParameterLookupScope } from '../../HydrationState.js';
+import * as plan from '../plan.js';
+import { StreamEvaluationContext } from './index.js';
+import { TablePattern } from '../../TablePattern.js';
+import { SourceTableInterface } from '../../SourceTableInterface.js';
+import { SqliteRow, UnscopedEvaluatedParametersResult } from '../../types.js';
+export declare class PreparedParameterIndexLookupCreator implements ParameterIndexLookupCreator {
+    private readonly source;
+    readonly defaultLookupScope: ParameterLookupScope;
+    private readonly evaluator;
+    private readonly sourceTable;
+    private readonly evaluatorInputs;
+    private readonly numberOfOutputs;
+    private readonly numberOfParameters;
+    constructor(source: plan.StreamParameterIndexLookupCreator, { engine, defaultSchema }: StreamEvaluationContext);
+    getSourceTables(): Set<TablePattern>;
+    evaluateParameterRow(sourceTable: SourceTableInterface, row: SqliteRow): UnscopedEvaluatedParametersResult[];
+    tableSyncsParameters(table: SourceTableInterface): boolean;
+}

package/dist/sync_plan/evaluator/parameter_index_lookup_creator.js

@@ -0,0 +1,64 @@
+import { mapExternalDataToInstantiation } from '../engine/scalar_expression_engine.js';
+import { isValidParameterValueRow } from './parameter_evaluator.js';
+import { UnscopedParameterLookup } from '../../BucketParameterQuerier.js';
+export class PreparedParameterIndexLookupCreator {
+    source;
+    defaultLookupScope;
+    evaluator;
+    sourceTable;
+    evaluatorInputs;
+    numberOfOutputs;
+    numberOfParameters;
+    constructor(source, { engine, defaultSchema }) {
+        this.source = source;
+        this.defaultLookupScope = source.defaultLookupScope;
+        const mapExpressions = mapExternalDataToInstantiation();
+        const expressions = source.outputs.map((o) => mapExpressions.transform(o));
+        this.numberOfOutputs = expressions.length;
+        for (const parameter of source.parameters) {
+            expressions.push(mapExpressions.transform(parameter.expr));
+        }
+        this.numberOfParameters = source.parameters.length;
+        this.evaluator = engine.prepareEvaluator({
+            outputs: expressions,
+            filters: source.filters.map((f) => mapExpressions.transform(f))
+        });
+        this.sourceTable = source.sourceTable.toTablePattern(defaultSchema);
+        this.evaluatorInputs = mapExpressions.instantiation;
+    }
+    getSourceTables() {
+        const set = new Set();
+        set.add(this.sourceTable);
+        return set;
+    }
+    evaluateParameterRow(sourceTable, row) {
+        const results = [];
+        if (!this.sourceTable.matches(sourceTable)) {
+            return results;
+        }
+        try {
+            const inputInstantiation = this.evaluatorInputs.map((input) => row[input.column]);
+            for (const outputRow of this.evaluator.evaluate(inputInstantiation)) {
+                if (!isValidParameterValueRow(outputRow)) {
+                    continue;
+                }
+                const outputs = {};
+                for (let i = 0; i < this.numberOfOutputs; i++) {
+                    outputs[i.toString()] = outputRow[i];
+                }
+                // source is [...outputs, ...partitionValues]
+                const partitionValues = outputRow.splice(this.numberOfOutputs, this.numberOfParameters);
+                const lookup = UnscopedParameterLookup.normalized(partitionValues);
+                results.push({ lookup, bucketParameters: [outputs] });
+            }
+        }
+        catch (e) {
+            results.push({ error: e.message });
+        }
+        return results;
+    }
+    tableSyncsParameters(table) {
+        return this.sourceTable.matches(table);
+    }
+}
+//# sourceMappingURL=parameter_index_lookup_creator.js.map

package/dist/sync_plan/evaluator/parameter_index_lookup_creator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameter_index_lookup_creator.js","sourceRoot":"","sources":["../../../src/sync_plan/evaluator/parameter_index_lookup_creator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,8BAA8B,EAA6B,MAAM,uCAAuC,CAAC;AAMlH,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAE1E,MAAM,OAAO,mCAAmC;IAS3B;IARV,kBAAkB,CAAuB;IACjC,SAAS,CAA4B;IACrC,WAAW,CAAe;IAC1B,eAAe,CAAiC;IAChD,eAAe,CAAS;IACxB,kBAAkB,CAAS;IAE5C,YACmB,MAA8C,EAC/D,EAAE,MAAM,EAAE,aAAa,EAA2B;QADjC,WAAM,GAAN,MAAM,CAAwC;QAG/D,IAAI,CAAC,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;QACpD,MAAM,cAAc,GAAG,8BAA8B,EAAgC,CAAC;QACtF,MAAM,WAAW,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAE3E,IAAI,CAAC,eAAe,GAAG,WAAW,CAAC,MAAM,CAAC;QAC1C,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YAC1C,WAAW,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,CAAC,kBAAkB,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC;QAEnD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,gBAAgB,CAAC;YACvC,OAAO,EAAE,WAAW;YACpB,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;SAChE,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;QACpE,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC,aAAa,CAAC;IACtD,CAAC;IAED,eAAe;QACb,MAAM,GAAG,GAAG,IAAI,GAAG,EAAgB,CAAC;QACpC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC1B,OAAO,GAAG,CAAC;IACb,CAAC;IAED,oBAAoB,CAAC,WAAiC,EAAE,GAAc;QACpE,MAAM,OAAO,GAAwC,EAAE,CAAC;QACxD,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3C,OAAO,OAAO,CAAC;QACjB,CAAC;QAED,IAAI,CAAC;YACH,MAAM,kBAAkB,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;YAElF,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;gBACpE,IAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,EAAE,CAAC;oBACzC,SAAS;gBACX,CAAC;gBAED,MAAM,OAAO,GAAoC,EAAE,CAAC;gBACpD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC9C,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;gBACvC,CAAC;gBAED,6CAA6C;gBAC7C,MAAM,eAAe,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;gBACxF,MAAM,MAAM,GAAG,uBAAuB,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;gBACnE,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACxD,CAAC;QACH,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACrC,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,oBAAoB,CAAC,KAA2B;QAC9C,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;CACF"}

package/dist/sync_plan/expression.d.ts

@@ -0,0 +1,109 @@
+/**
+ * An enumeration of all scalar SQL expressions supported by the sync service.
+ *
+ * Note that these expressions can be serialized, and the evaluation of serialized expressions must be stable.
+ *
+ * The `Data` type parameter encodes what external data references an {@link ExternalData} node may reference: Bucket
+ * data sources can only reference row data (e.g. to evaluate filters), while queriers can only reference connection
+ * data. Adding the parameter to expressions ensures the entire subtree can only reference expected sources.
+ */
+export type SqlExpression<Data> = ExternalData<Data> | UnaryExpression<Data> | BinaryExpression<Data> | BetweenExpression<Data> | ScalarInExpression<Data> | CaseWhenExpression<Data> | CastExpression<Data> | ScalarFunctionCallExpression<Data> | LiteralExpression;
+/**
+ * External data injected into the expression during evaluation.
+ *
+ * What kinds of external data is allowed depends on the expression. For instance, expressions for bucket data sources
+ * may only reference columns in the current row.
+ */
+export type ExternalData<Data> = {
+    type: 'data';
+    source: Data;
+};
+export type UnaryOperator = 'not' | '+';
+export type UnaryExpression<Data> = {
+    type: 'unary';
+    operand: SqlExpression<Data>;
+    operator: UnaryOperator;
+};
+export type BinaryOperator = 'or' | 'and' | '=' | 'is' | '<' | '<=' | '>' | '>=' | '&' | '|' | '<<' | '>>' | '+' | '-' | '*' | '/' | '%' | '||';
+/**
+ * A binary expression in SQLite, `$left $op $right`.
+ *
+ * Note that the `LIKE`, `GLOB`, `REGEXP` and `MATCH`, `->` and `->>` operators are not represented as binary
+ * expressions but rather as the functions SQLite [would call for them](https://www.sqlite.org/lang_expr.html#the_like_glob_regexp_match_and_extract_operators).
+ * Also, note that negated operators (e.g. `!=` or `NOT IN`) are represented by wrapping the expression in a unary
+ * `NOT`. This makes transformations to DNF easier.
+ */
+export type BinaryExpression<Data> = {
+    type: 'binary';
+    left: SqlExpression<Data>;
+    operator: BinaryOperator;
+    right: SqlExpression<Data>;
+};
+export type BetweenExpression<Data> = {
+    type: 'between';
+    value: SqlExpression<Data>;
+    low: SqlExpression<Data>;
+    high: SqlExpression<Data>;
+};
+/**
+ * An `expr IN ($in0, $in1, ..., $inN)` expression.
+ */
+export type ScalarInExpression<Data> = {
+    type: 'scalar_in';
+    target: SqlExpression<Data>;
+    in: SqlExpression<Data>[];
+};
+/**
+ * A `CASE WHEN` expression as supported by SQLite.
+ */
+export type CaseWhenExpression<Data> = {
+    type: 'case_when';
+    operand?: SqlExpression<Data>;
+    whens: {
+        when: SqlExpression<Data>;
+        then: SqlExpression<Data>;
+    }[];
+    else?: SqlExpression<Data>;
+};
+/**
+ * A `CAST` expression.
+ */
+export type CastExpression<Data> = {
+    type: 'cast';
+    operand: SqlExpression<Data>;
+    cast_as: 'text' | 'numeric' | 'real' | 'integer' | 'blob';
+};
+/**
+ * A constant literal in SQL.
+ */
+export type LiteralExpression = {
+    type: 'lit_null';
+} | {
+    type: 'lit_double';
+    value: number;
+} | {
+    type: 'lit_int';
+    /**
+     * The integer value as a base 10 string. We don't use the correct `bigint` type to be able to serialize and
+     * deserialize with the default JSON implementation.
+     */
+    base10: string;
+} | {
+    type: 'lit_string';
+    value: string;
+};
+/**
+ * A scalar (non-aggregate, non-window, non-table-valued) function call in SQL.
+ */
+export type ScalarFunctionCallExpression<Data> = {
+    type: 'function';
+    function: string;
+    parameters: SqlExpression<Data>[];
+};
+export type ArgumentCount = number | {
+    min: number;
+    max?: number;
+    mustBeEven?: boolean;
+    mustBeOdd?: boolean;
+};
+export declare const supportedFunctions: Record<string, ArgumentCount>;

package/dist/sync_plan/expression.js

@@ -0,0 +1,85 @@
+export const supportedFunctions = {
+    // https://sqlite.org/lang_corefunc.html#list_of_core_functions
+    abs: 1,
+    char: { min: 0 },
+    coalesce: { min: 2 },
+    concat: { min: 1 },
+    concat_ws: { min: 2 },
+    format: { min: 1 },
+    glob: 2,
+    hex: 1,
+    ifnull: { min: 2 },
+    if: { min: 2 },
+    iif: { min: 2 },
+    instr: 2,
+    length: 1,
+    // TODO: Establish defaults for case sensitivity, changing escape characters, ICU support.
+    // We might just want to remove LIKE support since we don't seem to have it in sql_functions.ts
+    like: { min: 2, max: 3 },
+    //  likelihood: 2,
+    //  likely: 1,
+    lower: 1,
+    ltrim: { min: 1, max: 2 },
+    max: { min: 2 },
+    min: { min: 2 },
+    nullif: 2,
+    octet_length: 1,
+    printf: { min: 1 },
+    quote: 1,
+    replace: 3,
+    round: { min: 1, max: 2 },
+    rtrim: { min: 1, max: 2 },
+    sign: 1,
+    substr: { min: 2, max: 3 },
+    substring: { min: 2, max: 3 },
+    trim: { min: 1, max: 2 },
+    typeof: 1,
+    unhex: { min: 1, max: 2 },
+    unicode: 1,
+    unistr: 1,
+    unistr_quote: 1,
+    //  unlikely: 1,
+    upper: 1,
+    zeroblob: 1,
+    // Scalar functions from https://sqlite.org/json1.html#overview
+    // We disallow jsonb functions because they're not implemented in sql_functions.ts and we want to preserve
+    // compatibility with that.
+    json: 1,
+    //  jsonb: 1,
+    json_array: { min: 0 },
+    //  jsonb_array: { min: 0 },
+    json_array_length: { min: 1, max: 2 },
+    json_error_position: 1,
+    json_extract: { min: 2 },
+    //  jsonb_extract: { min: 2 },
+    json_insert: { min: 3, mustBeOdd: true },
+    //  jsonb_insert: { min: 3, mustBeOdd: true },
+    json_object: { min: 0, mustBeEven: true },
+    //  jsonb_object: { min: 0, mustBeEven: true },
+    json_patch: 2,
+    //  jsonb_patch: 2,
+    json_pretty: 1,
+    json_remove: { min: 2 },
+    //  jsonb_remove: { min: 2 },
+    json_replace: { min: 3, mustBeOdd: true },
+    //  jsonb_replace: { min: 3, mustBeOdd: true },
+    json_set: { min: 3, mustBeOdd: true },
+    //  jsonb_set: { min: 3, mustBeOdd: true },
+    json_type: { min: 1, max: 2 },
+    json_valid: { min: 1, max: 2 },
+    json_quote: { min: 1 },
+    // https://www.sqlite.org/lang_datefunc.html, but we only support datetime and unixepoch
+    // TODO: Ensure our support matches the current unixepoch behavior in sql_functions.ts, register as user-defined
+    // function to patch default if in doubt.
+    unixepoch: { min: 1 },
+    datetime: { min: 1 },
+    // PowerSync-specific, mentioned in https://docs.powersync.com/sync/rules/supported-sql#functions
+    base64: 1,
+    json_keys: 1,
+    uuid_blob: 1,
+    st_asgeojson: 1,
+    st_astext: 1,
+    st_x: 1,
+    st_y: 1
+};
+//# sourceMappingURL=expression.js.map