@powersync/service-sync-rules 0.28.0 → 0.29.0

package/dist/streams/stream.js

@@ -0,0 +1,139 @@
+import { DEFAULT_BUCKET_PRIORITY } from '../BucketDescription.js';
+import { BucketSourceType } from '../BucketSource.js';
+export class SyncStream {
+    name;
+    subscribedToByDefault;
+    priority;
+    variants;
+    data;
+    constructor(name, data) {
+        this.name = name;
+        this.subscribedToByDefault = false;
+        this.priority = DEFAULT_BUCKET_PRIORITY;
+        this.variants = [];
+        this.data = data;
+    }
+    get type() {
+        return BucketSourceType.SYNC_STREAM;
+    }
+    pushBucketParameterQueriers(result, options) {
+        const subscriptions = options.streams[this.name] ?? [];
+        if (!this.subscribedToByDefault && !subscriptions.length) {
+            // The client is not subscribing to this stream, so don't query buckets related to it.
+            return;
+        }
+        let hasExplicitDefaultSubscription = false;
+        for (const subscription of subscriptions) {
+            let subscriptionParams = options.globalParameters;
+            if (subscription.parameters != null) {
+                subscriptionParams = subscriptionParams.withAddedStreamParameters(subscription.parameters);
+            }
+            else {
+                hasExplicitDefaultSubscription = true;
+            }
+            this.queriersForSubscription(result, subscription, subscriptionParams, options.bucketIdTransformer);
+        }
+        // If the stream is subscribed to by default and there is no explicit subscription that would match the default
+        // subscription, also include the default querier.
+        if (this.subscribedToByDefault && !hasExplicitDefaultSubscription) {
+            this.queriersForSubscription(result, null, options.globalParameters, options.bucketIdTransformer);
+        }
+    }
+    queriersForSubscription(result, subscription, params, bucketIdTransformer) {
+        const reason = subscription != null ? { subscription: subscription.opaque_id } : 'default';
+        const queriers = [];
+        try {
+            for (const variant of this.variants) {
+                const querier = variant.querier(this, reason, params, bucketIdTransformer);
+                if (querier) {
+                    queriers.push(querier);
+                }
+            }
+            result.queriers.push(...queriers);
+        }
+        catch (e) {
+            result.errors.push({
+                descriptor: this.name,
+                message: `Error evaluating bucket ids: ${e.message}`,
+                subscription: subscription ?? undefined
+            });
+        }
+    }
+    hasDynamicBucketQueries() {
+        return this.variants.some((v) => v.hasDynamicBucketQueries);
+    }
+    tableSyncsData(table) {
+        return this.data.applies(table);
+    }
+    tableSyncsParameters(table) {
+        for (const variant of this.variants) {
+            for (const subquery of variant.subqueries) {
+                if (subquery.parameterTable.matches(table)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+    getSourceTables() {
+        let result = new Set();
+        result.add(this.data.sourceTable);
+        for (let variant of this.variants) {
+            for (const subquery of variant.subqueries) {
+                result.add(subquery.parameterTable);
+            }
+        }
+        // Note: No physical tables for global_parameter_queries
+        return result;
+    }
+    resolveResultSets(schema, tables) {
+        this.data.resolveResultSets(schema, tables);
+    }
+    debugRepresentation() {
+        return {
+            name: this.name,
+            type: BucketSourceType[this.type],
+            variants: this.variants.map((v) => v.debugRepresentation()),
+            data: {
+                table: this.data.sourceTable,
+                columns: this.data.columnOutputNames()
+            }
+        };
+    }
+    debugWriteOutputTables(result) {
+        result[this.data.table] ??= [];
+        const r = {
+            query: this.data.sql
+        };
+        result[this.data.table].push(r);
+    }
+    evaluateParameterRow(sourceTable, row) {
+        const result = [];
+        for (const variant of this.variants) {
+            variant.pushParameterRowEvaluation(result, sourceTable, row);
+        }
+        return result;
+    }
+    evaluateRow(options) {
+        if (!this.data.applies(options.sourceTable)) {
+            return [];
+        }
+        const stream = this;
+        const row = {
+            sourceTable: options.sourceTable,
+            record: options.record
+        };
+        return this.data.evaluateRowWithOptions({
+            table: options.sourceTable,
+            row: options.record,
+            bucketIds() {
+                const bucketIds = [];
+                for (const variant of stream.variants) {
+                    bucketIds.push(...variant.bucketIdsForRow(stream.name, row, options.bucketIdTransformer));
+                }
+                return bucketIds;
+            }
+        });
+    }
+}
+//# sourceMappingURL=stream.js.map

package/dist/streams/stream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.js","sourceRoot":"","sources":["../../src/streams/stream.ts"],"names":[],"mappings":"AACA,OAAO,EAAyC,uBAAuB,EAAE,MAAM,yBAAyB,CAAC;AAEzG,OAAO,EAAgB,gBAAgB,EAAwB,MAAM,oBAAoB,CAAC;AAmB1F,MAAM,OAAO,UAAU;IACrB,IAAI,CAAS;IACb,qBAAqB,CAAU;IAC/B,QAAQ,CAAiB;IACzB,QAAQ,CAAkB;IAC1B,IAAI,CAAmB;IAEvB,YAAY,IAAY,EAAE,IAAsB;QAC9C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC;QACnC,IAAI,CAAC,QAAQ,GAAG,uBAAuB,CAAC;QACxC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,IAAW,IAAI;QACb,OAAO,gBAAgB,CAAC,WAAW,CAAC;IACtC,CAAC;IAED,2BAA2B,CAAC,MAAuB,EAAE,OAA0B;QAC7E,MAAM,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QAEvD,IAAI,CAAC,IAAI,CAAC,qBAAqB,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;YACzD,sFAAsF;YACtF,OAAO;QACT,CAAC;QAED,IAAI,8BAA8B,GAAG,KAAK,CAAC;QAC3C,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,IAAI,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC;YAClD,IAAI,YAAY,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;gBACpC,kBAAkB,GAAG,kBAAkB,CAAC,yBAAyB,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAC7F,CAAC;iBAAM,CAAC;gBACN,8BAA8B,GAAG,IAAI,CAAC;YACxC,CAAC;YAED,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,YAAY,EAAE,kBAAkB,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;QACtG,CAAC;QAED,+GAA+G;QAC/G,kDAAkD;QAClD,IAAI,IAAI,CAAC,qBAAqB,IAAI,CAAC,8BAA8B,EAAE,CAAC;YAClE,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,gBAAgB,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;QACpG,CAAC;IACH,CAAC;IAEO,uBAAuB,CAC7B,MAAuB,EACvB,YAAoC,EACpC,MAAyB,EACzB,mBAAwC;QAExC,MAAM,MAAM,GAA0B,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAClH,MAAM,QAAQ,GAA6B,EAAE,CAAC;QAE9C,IAAI,CAAC;YACH,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACpC,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC;gBAC3E,IAAI,OAAO,EAAE,CAAC;oBACZ,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACzB,CAAC;YACH,CAAC;YAED,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;gBACjB,UAAU,EAAE,IAAI,CAAC,IAAI;gBACrB,OAAO,EAAE,gCAAgC,CAAC,CAAC,OAAO,EAAE;gBACpD,YAAY,EAAE,YAAY,IAAI,SAAS;aACxC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,uBAAuB;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC;IAC9D,CAAC;IAED,cAAc,CAAC,KAA2B;QACxC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,oBAAoB,CAAC,KAA2B;QAC9C,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACpC,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBAC1C,IAAI,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC3C,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED,eAAe;QACb,IAAI,MAAM,GAAG,IAAI,GAAG,EAAgB,CAAC;QACrC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,KAAK,IAAI,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAClC,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBAC1C,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QAED,wDAAwD;QAExD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,iBAAiB,CAAC,MAAoB,EAAE,MAAwD;QAC9F,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED,mBAAmB;QACjB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;YACjC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,mBAAmB,EAAE,CAAC;YAC3D,IAAI,EAAE;gBACJ,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW;gBAC5B,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;aACvC;SACF,CAAC;IACJ,CAAC;IAED,sBAAsB,CAAC,MAA2C;QAChE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAM,CAAC,KAAK,EAAE,CAAC;QAChC,MAAM,CAAC,GAAG;YACR,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG;SACrB,CAAC;QAEF,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnC,CAAC;IAED,oBAAoB,CAAC,WAAiC,EAAE,GAAc;QACpE,MAAM,MAAM,GAAgC,EAAE,CAAC;QAE/C,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACpC,OAAO,CAAC,0BAA0B,CAAC,MAAM,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;QAC/D,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,WAAW,CAAC,OAA2B;QACrC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5C,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,MAAM,GAAG,IAAI,CAAC;QACpB,MAAM,GAAG,GAAa;YACpB,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC;YACtC,KAAK,EAAE,OAAO,CAAC,WAAW;YAC1B,GAAG,EAAE,OAAO,CAAC,MAAM;YACnB,SAAS;gBACP,MAAM,SAAS,GAAa,EAAE,CAAC;gBAC/B,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;oBACtC,SAAS,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC;gBAC5F,CAAC;gBAED,OAAO,SAAS,CAAC;YACnB,CAAC;SACF,CAAC,CAAC;IACL,CAAC;CACF"}

package/dist/streams/utils.d.ts

@@ -0,0 +1 @@
+export declare function cartesianProduct<T>(...sets: T[][]): Generator<T[]>;

package/dist/streams/utils.js

@@ -0,0 +1,13 @@
+export function* cartesianProduct(...sets) {
+    if (sets.length == 0) {
+        yield [];
+        return;
+    }
+    const [head, ...tail] = sets;
+    for (let h of head) {
+        const remainder = cartesianProduct(...tail);
+        for (let r of remainder)
+            yield [h, ...r];
+    }
+}
+//# sourceMappingURL=utils.js.map

package/dist/streams/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/streams/utils.ts"],"names":[],"mappings":"AAAA,MAAM,SAAS,CAAC,CAAC,gBAAgB,CAAI,GAAG,IAAW;IACjD,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;QACrB,MAAM,EAAE,CAAC;QACT,OAAO;IACT,CAAC;IAED,MAAM,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IAC7B,KAAK,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QACnB,MAAM,SAAS,GAAG,gBAAgB,CAAC,GAAG,IAAI,CAAC,CAAC;QAC5C,KAAK,IAAI,CAAC,IAAI,SAAS;YAAE,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;IAC3C,CAAC;AACH,CAAC"}

package/dist/streams/variant.d.ts

@@ -0,0 +1,122 @@
+import { BucketInclusionReason } from '../BucketDescription.js';
+import { BucketParameterQuerier } from '../BucketParameterQuerier.js';
+import { SourceTableInterface } from '../SourceTableInterface.js';
+import { BucketIdTransformer, EvaluatedParametersResult, RequestParameters, SqliteJsonValue, SqliteRow, TableRow } from '../types.js';
+import { BucketParameter, SubqueryEvaluator } from './parameter.js';
+import { SyncStream } from './stream.js';
+/**
+ * A variant of a stream.
+ *
+ * Variants are introduced on {@link Or} filters, since different sub-filters (with potentially different) bucket
+ * parameters can both cause a row to be matched.
+ *
+ * Consider the query `SELECT * FROM comments WHERE issue_id IN (SELECT id FROM issue WHERE owner_id = request.user()) OR request.is_admin()`.
+ * Here, the filter is an or clause matching rows where:
+ *
+ *   - An {@link InOperator} associatates comments in issues owned by the requesting user. This gets implemented with a
+ *     parameter lookup index mapping `issue.owner_id => issue.id`. `comments.issue_id` is a bucket parameter resolved
+ *     dynamically.
+ *   - Or, the user is an admin, in which case all comments are matched. There are no bucket parameters for this
+ *     variant.
+ *
+ * The introduction of stream variants allows the `evaluateParameterRow` and `queriersForSubscription` implementations
+ * to operate independently.
+ *
+ * Multiple variants may cause the same row to get synced via different buckets. Depending on the request, users may
+ * also receive multiple buckets with the same data. This is not an issue! Clients deduplicate rows received across
+ * buckets, so we don't have to filter for this case in the sync service.
+ */
+export declare class StreamVariant {
+    id: number;
+    parameters: BucketParameter[];
+    subqueries: SubqueryEvaluator[];
+    /**
+     * Additional filters that don't introduce bucket parameters, but can exclude rows.
+     *
+     * This is introduced for streams like `SELECT * FROM assets WHERE LENGTH(assets.name < 10)`.
+     */
+    additionalRowFilters: ((row: TableRow) => boolean)[];
+    /**
+     * Additional filters that are evaluated against the request of the stream subscription.
+     *
+     * These filters can either only depend on values in the request alone (e.g. `WHERE token_parameters.is_admin`), or
+     * on results from a subquery (e.g. `WHERE request.user_id() IN (SELECT id FROM user WHERE is_admin)`).
+     */
+    requestFilters: RequestFilter[];
+    constructor(id: number);
+    /**
+     * Given a row in the table this stream selects from, returns all ids of buckets to which that row belongs to.
+     */
+    bucketIdsForRow(streamName: string, options: TableRow, transformer: BucketIdTransformer): string[];
+    /**
+     * Given a row to evaluate, returns all instantiations of parameters that satisfy conditions.
+     *
+     * The inner arrays will have a length equal to the amount of parameters in this variant.
+     */
+    instantiationsForRow(options: TableRow): SqliteJsonValue[][];
+    /**
+     * Turns an array of values for each parameter into an array of all instantiations by effectively building the
+     * cartesian product of the parameter sets.
+     *
+     * @param instantiations An array containing values for each parameter.
+     * @returns Each instantiation, with each sub-array having a value for a parameter.
+     */
+    private cartesianProductOfParameterInstantiations;
+    get hasDynamicBucketQueries(): boolean;
+    querier(stream: SyncStream, reason: BucketInclusionReason, params: RequestParameters, bucketIdTransformer: BucketIdTransformer): BucketParameterQuerier | null;
+    findStaticInstantiations(params: RequestParameters): SqliteJsonValue[][];
+    /**
+     * Creates lookup indices for dynamically-resolved parameters.
+     *
+     * Resolving dynamic parameters is a two-step process: First, for tables referenced in subqueries, we create an index
+     * to resolve which request parameters would match rows in subqueries. Then, when resolving bucket ids for a request,
+     * we compute subquery results by looking up results in that index.
+     *
+     * This implements the first step of that process.
+     *
+     * @param result The array into which evaluation results should be written to.
+     * @param sourceTable A table we depend on in a subquery.
+     * @param row Row data to index.
+     */
+    pushParameterRowEvaluation(result: EvaluatedParametersResult[], sourceTable: SourceTableInterface, row: SqliteRow): void;
+    debugRepresentation(): any;
+    /**
+     * Replaces {@link StreamVariant.parameters} with static values looked up in request parameters.
+     *
+     * Dynamic parameters that depend on subquery results are not replaced.
+     * This returns null if there's a {@link StaticRequestFilter} that doesn't match the request.
+     */
+    private partiallyEvaluateParameters;
+    /**
+     * Builds a bucket id for an instantiation, like `stream|0[1,2,"foo"]`.
+     *
+     * @param streamName The name of the stream, included in the bucket id
+     * @param instantiation An instantiation for all parameters in this variant.
+     * @param transformer A transformer adding version information to the inner id.
+     * @returns The generated bucket id
+     */
+    private buildBucketId;
+    private resolveBucket;
+}
+/**
+ * A stateless filter condition that only depends on the request itself, e.g. `WHERE token_parameters.is_admin`.
+ */
+export interface StaticRequestFilter {
+    type: 'static';
+    matches(params: RequestParameters): boolean;
+}
+/**
+ * A filter condition that depends on parameters and an evaluated subquery, e.g.
+ * `WHERE request.user_id() IN (SELECT id FROM users WHERE ...)`.
+ */
+export interface SubqueryRequestFilter {
+    type: 'dynamic';
+    subquery: SubqueryEvaluator;
+    /**
+     * Checks whether the parameter matches values from the subquery.
+     *
+     * @param results The values that the subquery evaluates to.
+     */
+    matches(params: RequestParameters, results: SqliteJsonValue[]): boolean;
+}
+export type RequestFilter = StaticRequestFilter | SubqueryRequestFilter;

package/dist/streams/variant.js

@@ -0,0 +1,266 @@
+import { isJsonValue, JSONBucketNameSerialize } from '../utils.js';
+import { cartesianProduct } from './utils.js';
+/**
+ * A variant of a stream.
+ *
+ * Variants are introduced on {@link Or} filters, since different sub-filters (with potentially different) bucket
+ * parameters can both cause a row to be matched.
+ *
+ * Consider the query `SELECT * FROM comments WHERE issue_id IN (SELECT id FROM issue WHERE owner_id = request.user()) OR request.is_admin()`.
+ * Here, the filter is an or clause matching rows where:
+ *
+ *   - An {@link InOperator} associatates comments in issues owned by the requesting user. This gets implemented with a
+ *     parameter lookup index mapping `issue.owner_id => issue.id`. `comments.issue_id` is a bucket parameter resolved
+ *     dynamically.
+ *   - Or, the user is an admin, in which case all comments are matched. There are no bucket parameters for this
+ *     variant.
+ *
+ * The introduction of stream variants allows the `evaluateParameterRow` and `queriersForSubscription` implementations
+ * to operate independently.
+ *
+ * Multiple variants may cause the same row to get synced via different buckets. Depending on the request, users may
+ * also receive multiple buckets with the same data. This is not an issue! Clients deduplicate rows received across
+ * buckets, so we don't have to filter for this case in the sync service.
+ */
+export class StreamVariant {
+    id;
+    parameters;
+    subqueries;
+    /**
+     * Additional filters that don't introduce bucket parameters, but can exclude rows.
+     *
+     * This is introduced for streams like `SELECT * FROM assets WHERE LENGTH(assets.name < 10)`.
+     */
+    additionalRowFilters;
+    /**
+     * Additional filters that are evaluated against the request of the stream subscription.
+     *
+     * These filters can either only depend on values in the request alone (e.g. `WHERE token_parameters.is_admin`), or
+     * on results from a subquery (e.g. `WHERE request.user_id() IN (SELECT id FROM user WHERE is_admin)`).
+     */
+    requestFilters;
+    constructor(id) {
+        this.id = id;
+        this.parameters = [];
+        this.subqueries = [];
+        this.additionalRowFilters = [];
+        this.requestFilters = [];
+    }
+    /**
+     * Given a row in the table this stream selects from, returns all ids of buckets to which that row belongs to.
+     */
+    bucketIdsForRow(streamName, options, transformer) {
+        return this.instantiationsForRow(options).map((values) => this.buildBucketId(streamName, values, transformer));
+    }
+    /**
+     * Given a row to evaluate, returns all instantiations of parameters that satisfy conditions.
+     *
+     * The inner arrays will have a length equal to the amount of parameters in this variant.
+     */
+    instantiationsForRow(options) {
+        for (const additional of this.additionalRowFilters) {
+            if (!additional(options)) {
+                return [];
+            }
+        }
+        // Contains an array of all values satisfying each parameter. So this array has the same length as the amount of
+        // parameters, and each nested array has a dynamic length.
+        const parameterInstantiations = [];
+        for (const parameter of this.parameters) {
+            const matching = parameter.filterRow(options);
+            if (matching.length == 0) {
+                // The final list of bucket ids is the cartesian product of all matching parameters. So if there's no parameter
+                // satisfying this value, we know the final list will be empty.
+                return [];
+            }
+            parameterInstantiations.push(matching);
+        }
+        // Combine the map of values like {param_1: [foo, bar], param_2: [baz]} into parameter arrays:
+        // [foo, baz], [bar, baz].
+        return this.cartesianProductOfParameterInstantiations(parameterInstantiations);
+    }
+    /**
+     * Turns an array of values for each parameter into an array of all instantiations by effectively building the
+     * cartesian product of the parameter sets.
+     *
+     * @param instantiations An array containing values for each parameter.
+     * @returns Each instantiation, with each sub-array having a value for a parameter.
+     */
+    cartesianProductOfParameterInstantiations(instantiations) {
+        return [...cartesianProduct(...instantiations)];
+    }
+    get hasDynamicBucketQueries() {
+        return this.requestFilters.some((f) => f.type == 'dynamic');
+    }
+    querier(stream, reason, params, bucketIdTransformer) {
+        const instantiation = this.partiallyEvaluateParameters(params);
+        if (instantiation == null) {
+            return null;
+        }
+        const dynamicRequestFilters = this.requestFilters.filter((f) => f.type == 'dynamic');
+        const dynamicParameters = [];
+        const subqueryToLookups = new Map();
+        for (let i = 0; i < this.parameters.length; i++) {
+            const parameter = this.parameters[i];
+            const lookup = parameter.lookup;
+            if (lookup.type == 'in' || lookup.type == 'overlap') {
+                dynamicParameters.push({
+                    index: i,
+                    subquery: lookup.subquery
+                });
+            }
+        }
+        for (const subquery of this.subqueries) {
+            subqueryToLookups.set(subquery, subquery.lookupsForRequest(params));
+        }
+        const staticBuckets = [];
+        if (dynamicParameters.length == 0 && dynamicRequestFilters.length == 0) {
+            // When we have no dynamic parameters, the partial evaluation is a full instantiation.
+            const instantiations = this.cartesianProductOfParameterInstantiations(instantiation);
+            for (const instantiation of instantiations) {
+                staticBuckets.push(this.resolveBucket(stream, instantiation, reason, bucketIdTransformer));
+            }
+        }
+        const variant = this;
+        return {
+            staticBuckets: staticBuckets,
+            hasDynamicBuckets: this.subqueries.length != 0,
+            parameterQueryLookups: [...subqueryToLookups.values()].flatMap((f) => f),
+            async queryDynamicBucketDescriptions(source) {
+                // Evaluate subqueries
+                const subqueryResults = new Map();
+                for (const [subquery, lookups] of subqueryToLookups.entries()) {
+                    const rows = await source.getParameterSets(lookups);
+                    // The result column used in parameter sets is always named result, see pushParameterRowEvaluation
+                    const values = rows.map((r) => r.result);
+                    subqueryResults.set(subquery, values);
+                }
+                // Check if we have a subquery-based request filter rejecting the row.
+                for (const filter of dynamicRequestFilters) {
+                    if (!filter.matches(params, subqueryResults.get(filter.subquery))) {
+                        return [];
+                    }
+                }
+                const perParameterInstantiation = [];
+                for (const parameter of instantiation) {
+                    if (Array.isArray(parameter)) {
+                        // Statically-resolved values
+                        perParameterInstantiation.push(parameter);
+                    }
+                    else {
+                        // to be instantiated with dynamic lookup
+                        perParameterInstantiation.push([parameter]);
+                    }
+                }
+                for (const lookup of dynamicParameters) {
+                    perParameterInstantiation[lookup.index] = subqueryResults.get(lookup.subquery);
+                }
+                const product = variant.cartesianProductOfParameterInstantiations(perParameterInstantiation);
+                return Promise.resolve(product.map((e) => variant.resolveBucket(stream, e, reason, bucketIdTransformer)));
+            }
+        };
+    }
+    findStaticInstantiations(params) {
+        if (this.subqueries.length) {
+            return [];
+        }
+        // This will be an array of values (i.e. a total evaluation) because there are no dynamic parameters.
+        return this.partiallyEvaluateParameters(params);
+    }
+    /**
+     * Creates lookup indices for dynamically-resolved parameters.
+     *
+     * Resolving dynamic parameters is a two-step process: First, for tables referenced in subqueries, we create an index
+     * to resolve which request parameters would match rows in subqueries. Then, when resolving bucket ids for a request,
+     * we compute subquery results by looking up results in that index.
+     *
+     * This implements the first step of that process.
+     *
+     * @param result The array into which evaluation results should be written to.
+     * @param sourceTable A table we depend on in a subquery.
+     * @param row Row data to index.
+     */
+    pushParameterRowEvaluation(result, sourceTable, row) {
+        for (const subquery of this.subqueries) {
+            if (subquery.parameterTable.matches(sourceTable)) {
+                const lookups = subquery.lookupsForParameterRow(sourceTable, row);
+                if (lookups == null) {
+                    continue;
+                }
+                // The row of the subquery. Since we only support subqueries with a single column, we unconditionally name the
+                // column `result` for simplicity.
+                const resultRow = { result: lookups.value };
+                result.push(...lookups.lookups.map((l) => ({
+                    lookup: l,
+                    bucketParameters: [resultRow]
+                })));
+            }
+        }
+    }
+    debugRepresentation() {
+        return {
+            id: this.id,
+            parameters: this.parameters.map((p) => ({
+                type: p.lookup.type
+            })),
+            subqueries: this.subqueries.map((s) => ({
+                table: s.parameterTable
+            })),
+            additional_row_filters: this.additionalRowFilters.length,
+            request_filters: this.requestFilters.map((f) => f.type)
+        };
+    }
+    /**
+     * Replaces {@link StreamVariant.parameters} with static values looked up in request parameters.
+     *
+     * Dynamic parameters that depend on subquery results are not replaced.
+     * This returns null if there's a {@link StaticRequestFilter} that doesn't match the request.
+     */
+    partiallyEvaluateParameters(params) {
+        for (const filter of this.requestFilters) {
+            if (filter.type == 'static' && !filter.matches(params)) {
+                return null;
+            }
+        }
+        const instantiation = [];
+        for (const parameter of this.parameters) {
+            const lookup = parameter.lookup;
+            if (lookup.type == 'static') {
+                const values = lookup.fromRequest(params)?.filter(isJsonValue);
+                if (values.length == 0) {
+                    // Parameter not instantiable for this request. Since parameters in a single variant form a conjunction, that
+                    // means the whole request won't find anything here.
+                    return null;
+                }
+                instantiation.push(values);
+            }
+            else {
+                instantiation.push(parameter);
+            }
+        }
+        return instantiation;
+    }
+    /**
+     * Builds a bucket id for an instantiation, like `stream|0[1,2,"foo"]`.
+     *
+     * @param streamName The name of the stream, included in the bucket id
+     * @param instantiation An instantiation for all parameters in this variant.
+     * @param transformer A transformer adding version information to the inner id.
+     * @returns The generated bucket id
+     */
+    buildBucketId(streamName, instantiation, transformer) {
+        if (instantiation.length != this.parameters.length) {
+            throw Error('Internal error, instantiation length mismatch');
+        }
+        return transformer(`${streamName}|${this.id}${JSONBucketNameSerialize.stringify(instantiation)}`);
+    }
+    resolveBucket(stream, instantiation, reason, bucketIdTransformer) {
+        return {
+            definition: stream.name,
+            inclusion_reasons: [reason],
+            bucket: this.buildBucketId(stream.name, instantiation, bucketIdTransformer),
+            priority: stream.priority
+        };
+    }
+}
+//# sourceMappingURL=variant.js.map

package/dist/streams/variant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variant.js","sourceRoot":"","sources":["../../src/streams/variant.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,WAAW,EAAE,uBAAuB,EAA2B,MAAM,aAAa,CAAC;AAG5F,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAE9C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,aAAa;IACxB,EAAE,CAAS;IACX,UAAU,CAAoB;IAC9B,UAAU,CAAsB;IAEhC;;;;OAIG;IACH,oBAAoB,CAAiC;IAErD;;;;;OAKG;IACH,cAAc,CAAkB;IAEhC,YAAY,EAAU;QACpB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,oBAAoB,GAAG,EAAE,CAAC;QAC/B,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,eAAe,CAAC,UAAkB,EAAE,OAAiB,EAAE,WAAgC;QACrF,OAAO,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC;IACjH,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAAC,OAAiB;QACpC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACnD,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;gBACzB,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC;QAED,gHAAgH;QAChH,0DAA0D;QAC1D,MAAM,uBAAuB,GAAwB,EAAE,CAAC;QACxD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,MAAM,QAAQ,GAAG,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAC9C,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;gBACzB,+GAA+G;gBAC/G,+DAA+D;gBAC/D,OAAO,EAAE,CAAC;YACZ,CAAC;YAED,uBAAuB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzC,CAAC;QAED,8FAA8F;QAC9F,0BAA0B;QAC1B,OAAO,IAAI,CAAC,yCAAyC,CAAC,uBAAuB,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACK,yCAAyC,CAAC,cAAmC;QACnF,OAAO,CAAC,GAAG,gBAAgB,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,uBAAuB;QACzB,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,SAAS,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,CACL,MAAkB,EAClB,MAA6B,EAC7B,MAAyB,EACzB,mBAAwC;QAExC,MAAM,aAAa,GAAG,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAC,CAAC;QAC/D,IAAI,aAAa,IAAI,IAAI,EAAE,CAAC;YAC1B,OAAO,IAAI,CAAC;QACd,CAAC;QAOD,MAAM,qBAAqB,GAA4B,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,SAAS,CAAC,CAAC;QAC9G,MAAM,iBAAiB,GAA+B,EAAE,CAAC;QACzD,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAwC,CAAC;QAE1E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAChD,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACrC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;YAEhC,IAAI,MAAM,CAAC,IAAI,IAAI,IAAI,IAAI,MAAM,CAAC,IAAI,IAAI,SAAS,EAAE,CAAC;gBACpD,iBAAiB,CAAC,IAAI,CAAC;oBACrB,KAAK,EAAE,CAAC;oBACR,QAAQ,EAAE,MAAM,CAAC,QAAQ;iBAC1B,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACvC,iBAAiB,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC,CAAC;QACtE,CAAC;QAED,MAAM,aAAa,GAAqB,EAAE,CAAC;QAC3C,IAAI,iBAAiB,CAAC,MAAM,IAAI,CAAC,IAAI,qBAAqB,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACvE,sFAAsF;YACtF,MAAM,cAAc,GAAG,IAAI,CAAC,yCAAyC,CAAC,aAAoC,CAAC,CAAC;YAC5G,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;gBAC3C,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC;YAC7F,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC;QACrB,OAAO;YACL,aAAa,EAAE,aAAa;YAC5B,iBAAiB,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC;YAC9C,qBAAqB,EAAE,CAAC,GAAG,iBAAiB,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;YACxE,KAAK,CAAC,8BAA8B,CAAC,MAAM;gBACzC,sBAAsB;gBACtB,MAAM,eAAe,GAAG,IAAI,GAAG,EAAwC,CAAC;gBACxE,KAAK,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,IAAI,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC;oBAC9D,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;oBACpD,kGAAkG;oBAClG,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;oBACzC,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;gBACxC,CAAC;gBAED,sEAAsE;gBACtE,KAAK,MAAM,MAAM,IAAI,qBAAqB,EAAE,CAAC;oBAC3C,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAE,CAAC,EAAE,CAAC;wBACnE,OAAO,EAAE,CAAC;oBACZ,CAAC;gBACH,CAAC;gBAED,MAAM,yBAAyB,GAA4C,EAAE,CAAC;gBAC9E,KAAK,MAAM,SAAS,IAAI,aAAa,EAAE,CAAC;oBACtC,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;wBAC7B,6BAA6B;wBAC7B,yBAAyB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBAC5C,CAAC;yBAAM,CAAC;wBACN,yCAAyC;wBACzC,yBAAyB,CAAC,IAAI,CAAC,CAAC,SAA4B,CAAC,CAAC,CAAC;oBACjE,CAAC;gBACH,CAAC;gBAED,KAAK,MAAM,MAAM,IAAI,iBAAiB,EAAE,CAAC;oBACvC,yBAAyB,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAE,CAAC;gBAClF,CAAC;gBAED,MAAM,OAAO,GAAG,OAAO,CAAC,yCAAyC,CAC/D,yBAAgD,CACjD,CAAC;gBAEF,OAAO,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;YAC5G,CAAC;SACF,CAAC;IACJ,CAAC;IAED,wBAAwB,CAAC,MAAyB;QAChD,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YAC3B,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,qGAAqG;QACrG,OAAO,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAwB,CAAC;IACzE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,0BAA0B,CAAC,MAAmC,EAAE,WAAiC,EAAE,GAAc;QAC/G,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACvC,IAAI,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,sBAAsB,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;gBAClE,IAAI,OAAO,IAAI,IAAI,EAAE,CAAC;oBACpB,SAAS;gBACX,CAAC;gBAED,8GAA8G;gBAC9G,kCAAkC;gBAClC,MAAM,SAAS,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;gBAE5C,MAAM,CAAC,IAAI,CACT,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC7B,MAAM,EAAE,CAAC;oBACT,gBAAgB,EAAE,CAAC,SAAS,CAAC;iBAC9B,CAAC,CAAC,CACJ,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,mBAAmB;QACjB,OAAO;YACL,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACtC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,IAAI;aACpB,CAAC,CAAC;YACH,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACtC,KAAK,EAAE,CAAC,CAAC,cAAc;aACxB,CAAC,CAAC;YACH,sBAAsB,EAAE,IAAI,CAAC,oBAAoB,CAAC,MAAM;YACxD,eAAe,EAAE,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SACxD,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACK,2BAA2B,CAAC,MAAyB;QAC3D,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACzC,IAAI,MAAM,CAAC,IAAI,IAAI,QAAQ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBACvD,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QAED,MAAM,aAAa,GAA4C,EAAE,CAAC;QAClE,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;YAChC,IAAI,MAAM,CAAC,IAAI,IAAI,QAAQ,EAAE,CAAC;gBAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,WAAW,CAAC,CAAC;gBAC/D,IAAI,MAAM,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;oBACvB,6GAA6G;oBAC7G,oDAAoD;oBACpD,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAChC,CAAC;QACH,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACK,aAAa,CAAC,UAAkB,EAAE,aAAgC,EAAE,WAAgC;QAC1G,IAAI,aAAa,CAAC,MAAM,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACnD,MAAM,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAC/D,CAAC;QAED,OAAO,WAAW,CAAC,GAAG,UAAU,IAAI,IAAI,CAAC,EAAE,GAAG,uBAAuB,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;IACpG,CAAC;IAEO,aAAa,CACnB,MAAkB,EAClB,aAAgC,EAChC,MAA6B,EAC7B,mBAAwC;QAExC,OAAO;YACL,UAAU,EAAE,MAAM,CAAC,IAAI;YACvB,iBAAiB,EAAE,CAAC,MAAM,CAAC;YAC3B,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,EAAE,aAAa,EAAE,mBAAmB,CAAC;YAC3E,QAAQ,EAAE,MAAM,CAAC,QAAQ;SAC1B,CAAC;IACJ,CAAC;CACF"}

package/dist/types/custom_sqlite_value.d.ts

@@ -0,0 +1,38 @@
+import { CompatibilityContext } from '../compatibility.js';
+import { SqliteValue } from '../types.js';
+import { SqliteValueType } from '../ExpressionType.js';
+/**
+ * A value that decays into a {@link SqliteValue} in a context-specific way.
+ *
+ * This is used to conditionally render some values in different formats depending on compatibility options. For
+ * instance, old versions of the sync service used to [encode timestamp values incorrectly](https://github.com/powersync-ja/powersync-service/issues/286).
+ * To fix this without breaking backwards-compatibility, we now represent timestamp values as a {@link CustomSqliteValue}
+ * subtype where `toSqliteValue` returns the old or the new format depending on options.
+ *
+ * Instances of {@link CustomSqliteValue} are always temporary structures that aren't persisted. They are created by the
+ * replicator implementations, the sync rule implementation will invoke {@link toSqliteValue} to ensure that an
+ * {@link EvaluatedRow} only consists of proper SQLite values.
+ */
+export declare abstract class CustomSqliteValue {
+    /**
+     * Renders this custom value into a {@link SqliteValue}.
+     *
+     * @param context The current compatibility options.
+     */
+    abstract toSqliteValue(context: CompatibilityContext): SqliteValue;
+    abstract get sqliteType(): SqliteValueType;
+}
+export declare class CustomArray extends CustomSqliteValue {
+    private readonly elements;
+    private readonly map;
+    constructor(elements: any[], map: (element: any, context: CompatibilityContext) => void);
+    get sqliteType(): SqliteValueType;
+    toSqliteValue(context: CompatibilityContext): SqliteValue;
+}
+export declare class CustomObject extends CustomSqliteValue {
+    private readonly source;
+    private readonly map;
+    constructor(source: Record<string, any>, map: (element: any, context: CompatibilityContext) => void);
+    get sqliteType(): SqliteValueType;
+    toSqliteValue(context: CompatibilityContext): SqliteValue;
+}

package/dist/types/custom_sqlite_value.js

@@ -0,0 +1,50 @@
+import { JSONBig } from '@powersync/service-jsonbig';
+/**
+ * A value that decays into a {@link SqliteValue} in a context-specific way.
+ *
+ * This is used to conditionally render some values in different formats depending on compatibility options. For
+ * instance, old versions of the sync service used to [encode timestamp values incorrectly](https://github.com/powersync-ja/powersync-service/issues/286).
+ * To fix this without breaking backwards-compatibility, we now represent timestamp values as a {@link CustomSqliteValue}
+ * subtype where `toSqliteValue` returns the old or the new format depending on options.
+ *
+ * Instances of {@link CustomSqliteValue} are always temporary structures that aren't persisted. They are created by the
+ * replicator implementations, the sync rule implementation will invoke {@link toSqliteValue} to ensure that an
+ * {@link EvaluatedRow} only consists of proper SQLite values.
+ */
+export class CustomSqliteValue {
+}
+export class CustomArray extends CustomSqliteValue {
+    elements;
+    map;
+    constructor(elements, map) {
+        super();
+        this.elements = elements;
+        this.map = map;
+    }
+    get sqliteType() {
+        return 'text';
+    }
+    toSqliteValue(context) {
+        return JSONBig.stringify(this.elements.map((element) => this.map(element, context)));
+    }
+}
+export class CustomObject extends CustomSqliteValue {
+    source;
+    map;
+    constructor(source, map) {
+        super();
+        this.source = source;
+        this.map = map;
+    }
+    get sqliteType() {
+        return 'text';
+    }
+    toSqliteValue(context) {
+        let record = {};
+        for (let key of Object.keys(this.source)) {
+            record[key] = this.map(this.source[key], context);
+        }
+        return JSONBig.stringify(record);
+    }
+}
+//# sourceMappingURL=custom_sqlite_value.js.map

package/dist/types/custom_sqlite_value.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom_sqlite_value.js","sourceRoot":"","sources":["../../src/types/custom_sqlite_value.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAC;AAKrD;;;;;;;;;;;GAWG;AACH,MAAM,OAAgB,iBAAiB;CAStC;AAED,MAAM,OAAO,WAAY,SAAQ,iBAAiB;IAE7B;IACA;IAFnB,YACmB,QAAe,EACf,GAA0D;QAE3E,KAAK,EAAE,CAAC;QAHS,aAAQ,GAAR,QAAQ,CAAO;QACf,QAAG,GAAH,GAAG,CAAuD;IAG7E,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,aAAa,CAAC,OAA6B;QACzC,OAAO,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACvF,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,iBAAiB;IAE9B;IACA;IAFnB,YACmB,MAA2B,EAC3B,GAA0D;QAE3E,KAAK,EAAE,CAAC;QAHS,WAAM,GAAN,MAAM,CAAqB;QAC3B,QAAG,GAAH,GAAG,CAAuD;IAG7E,CAAC;IAED,IAAI,UAAU;QACZ,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,aAAa,CAAC,OAA6B;QACzC,IAAI,MAAM,GAAwB,EAAE,CAAC;QACrC,KAAK,IAAI,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YACzC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;QACpD,CAAC;QACD,OAAO,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;CACF"}