@powersync/common 0.0.0-dev-20260504100448 → 0.0.0-dev-20260630144038

package/lib/client/watched/processors/DifferentialQueryProcessor.js

@@ -1,173 +1,2 @@
-import { AbstractQueryProcessor } from './AbstractQueryProcessor.js';
-/**
- * An empty differential result set.
- * This is used as the initial state for differential incrementally watched queries.
- */
-export const EMPTY_DIFFERENTIAL = {
-    added: [],
-    all: [],
-    removed: [],
-    updated: [],
-    unchanged: []
-};
-/**
- * Default implementation of the {@link DifferentialWatchedQueryComparator} for watched queries.
- * It keys items by their `id` property if available, alternatively it uses JSON stringification
- * of the entire item for the key and comparison.
- */
-export const DEFAULT_ROW_COMPARATOR = {
-    keyBy: (item) => {
-        if (item && typeof item == 'object' && typeof item['id'] == 'string') {
-            return item['id'];
-        }
-        return JSON.stringify(item);
-    },
-    compareBy: (item) => JSON.stringify(item)
-};
-/**
- * Uses the PowerSync onChange event to trigger watched queries.
- * Results are emitted on every change of the relevant tables.
- * @internal
- */
-export class DifferentialQueryProcessor extends AbstractQueryProcessor {
-    options;
-    comparator;
-    constructor(options) {
-        super(options);
-        this.options = options;
-        this.comparator = options.rowComparator ?? DEFAULT_ROW_COMPARATOR;
-    }
-    /*
-     * @returns If the sets are equal
-     */
-    differentiate(current, previousMap) {
-        const { keyBy, compareBy } = this.comparator;
-        let hasChanged = false;
-        const currentMap = new Map();
-        const removedTracker = new Set(previousMap.keys());
-        // Allow mutating to populate the data temporarily.
-        const diff = {
-            all: [],
-            added: [],
-            removed: [],
-            updated: [],
-            unchanged: []
-        };
-        /**
-         * Looping over the current result set array is important to preserve
-         * the ordering of the result set.
-         * We can replace items in the current array with previous object references if they are equal.
-         */
-        for (const item of current) {
-            const key = keyBy(item);
-            const hash = compareBy(item);
-            currentMap.set(key, { hash, item });
-            const previousItem = previousMap.get(key);
-            if (!previousItem) {
-                // New item
-                hasChanged = true;
-                diff.added.push(item);
-                diff.all.push(item);
-            }
-            else {
-                // Existing item
-                if (hash == previousItem.hash) {
-                    diff.unchanged.push(previousItem.item);
-                    // Use the previous object reference
-                    diff.all.push(previousItem.item);
-                    // update the map to preserve the reference
-                    currentMap.set(key, previousItem);
-                }
-                else {
-                    hasChanged = true;
-                    diff.updated.push({ current: item, previous: previousItem.item });
-                    // Use the new reference
-                    diff.all.push(item);
-                }
-            }
-            // The item is present, we don't consider it removed
-            removedTracker.delete(key);
-        }
-        diff.removed = Array.from(removedTracker).map((key) => previousMap.get(key).item);
-        hasChanged = hasChanged || diff.removed.length > 0;
-        return {
-            diff,
-            hasChanged,
-            map: currentMap
-        };
-    }
-    async linkQuery(options) {
-        const { db, watchOptions } = this.options;
-        const { abortSignal } = options;
-        const compiledQuery = watchOptions.query.compile();
-        const tables = await db.resolveTables(compiledQuery.sql, compiledQuery.parameters, {
-            tables: options.settings.triggerOnTables
-        });
-        let currentMap = new Map();
-        // populate the currentMap from the placeholder data
-        this.state.data.forEach((item) => {
-            currentMap.set(this.comparator.keyBy(item), {
-                hash: this.comparator.compareBy(item),
-                item
-            });
-        });
-        db.onChangeWithCallback({
-            onChange: async () => {
-                if (this.closed || abortSignal.aborted) {
-                    return;
-                }
-                // This fires for each change of the relevant tables
-                try {
-                    if (this.reportFetching && !this.state.isFetching) {
-                        await this.updateState({ isFetching: true });
-                    }
-                    const partialStateUpdate = {};
-                    // Always run the query if an underlying table has changed
-                    const result = await watchOptions.query.execute({
-                        sql: compiledQuery.sql,
-                        // Allows casting from ReadOnlyArray[unknown] to Array<unknown>
-                        // This allows simpler compatibility with PowerSync queries
-                        parameters: [...compiledQuery.parameters],
-                        db: this.options.db
-                    });
-                    if (abortSignal.aborted) {
-                        return;
-                    }
-                    if (this.reportFetching) {
-                        partialStateUpdate.isFetching = false;
-                    }
-                    if (this.state.isLoading) {
-                        partialStateUpdate.isLoading = false;
-                    }
-                    const { diff, hasChanged, map } = this.differentiate(result, currentMap);
-                    // Update for future comparisons
-                    currentMap = map;
-                    if (hasChanged) {
-                        await this.iterateAsyncListenersWithError((l) => l.onDiff?.(diff));
-                        Object.assign(partialStateUpdate, {
-                            data: diff.all
-                        });
-                    }
-                    if (this.state.error) {
-                        partialStateUpdate.error = null;
-                    }
-                    if (Object.keys(partialStateUpdate).length > 0) {
-                        await this.updateState(partialStateUpdate);
-                    }
-                }
-                catch (error) {
-                    await this.updateState({ error });
-                }
-            },
-            onError: async (error) => {
-                await this.updateState({ error });
-            }
-        }, {
-            signal: abortSignal,
-            tables,
-            throttleMs: watchOptions.throttleMs,
-            triggerImmediate: true // used to emit the initial state
-        });
-    }
-}
+export {};
 //# sourceMappingURL=DifferentialQueryProcessor.js.map

package/lib/client/watched/processors/DifferentialQueryProcessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"DifferentialQueryProcessor.js","sourceRoot":"","sources":["../../../../src/client/watched/processors/DifferentialQueryProcessor.ts"],"names":[],"mappings":"AACA,OAAO,EACL,sBAAsB,EAIvB,MAAM,6BAA6B,CAAC;AAoGrC;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,KAAK,EAAE,EAAE;IACT,GAAG,EAAE,EAAE;IACP,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,EAAE;IACX,SAAS,EAAE,EAAE;CACd,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAA4C;IAC7E,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE;QACd,IAAI,IAAI,IAAI,OAAO,IAAI,IAAI,QAAQ,IAAI,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,QAAQ,EAAE,CAAC;YACrE,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC;QACpB,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IACD,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;CAC1C,CAAC;AAEF;;;;GAIG;AACH,MAAM,OAAO,0BACX,SAAQ,sBAAmG;IAKrF;IAFZ,UAAU,CAA8C;IAElE,YAAsB,OAAmD;QACvE,KAAK,CAAC,OAAO,CAAC,CAAC;QADK,YAAO,GAAP,OAAO,CAA4C;QAEvE,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC,aAAa,IAAI,sBAAsB,CAAC;IACpE,CAAC;IAED;;OAEG;IACO,aAAa,CACrB,OAAkB,EAClB,WAAiC;QAEjC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,UAAU,CAAC;QAE7C,IAAI,UAAU,GAAG,KAAK,CAAC;QACvB,MAAM,UAAU,GAAG,IAAI,GAAG,EAA2C,CAAC;QACtE,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;QAEnD,mDAAmD;QACnD,MAAM,IAAI,GAAG;YACX,GAAG,EAAE,EAAe;YACpB,KAAK,EAAE,EAAe;YACtB,OAAO,EAAE,EAAe;YACxB,OAAO,EAAE,EAA4C;YACrD,SAAS,EAAE,EAAe;SAC3B,CAAC;QAEF;;;;WAIG;QACH,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;YACxB,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;YAC7B,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAEpC,MAAM,YAAY,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC1C,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,WAAW;gBACX,UAAU,GAAG,IAAI,CAAC;gBAClB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACtB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,gBAAgB;gBAChB,IAAI,IAAI,IAAI,YAAY,CAAC,IAAI,EAAE,CAAC;oBAC9B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;oBACvC,oCAAoC;oBACpC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;oBACjC,2CAA2C;oBAC3C,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;gBACpC,CAAC;qBAAM,CAAC;oBACN,UAAU,GAAG,IAAI,CAAC;oBAClB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;oBAClE,wBAAwB;oBACxB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACtB,CAAC;YACH,CAAC;YACD,oDAAoD;YACpD,cAAc,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;QAED,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,CAAC;QACnF,UAAU,GAAG,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;QAEnD,OAAO;YACL,IAAI;YACJ,UAAU;YACV,GAAG,EAAE,UAAU;SAChB,CAAC;IACJ,CAAC;IAES,KAAK,CAAC,SAAS,CAAC,OAA4D;QACpF,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAC1C,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;QAEhC,MAAM,aAAa,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACnD,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,aAAa,CAAC,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,UAAmB,EAAE;YAC1F,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,eAAe;SACzC,CAAC,CAAC;QAEH,IAAI,UAAU,GAAyB,IAAI,GAAG,EAAE,CAAC;QAEjD,oDAAoD;QACpD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YAC/B,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE;gBAC1C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;gBACrC,IAAI;aACL,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oBAAoB,CACrB;YACE,QAAQ,EAAE,KAAK,IAAI,EAAE;gBACnB,IAAI,IAAI,CAAC,MAAM,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;oBACvC,OAAO;gBACT,CAAC;gBACD,oDAAoD;gBACpD,IAAI,CAAC;oBACH,IAAI,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;wBAClD,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC/C,CAAC;oBAED,MAAM,kBAAkB,GAAiD,EAAE,CAAC;oBAE5E,0DAA0D;oBAC1D,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC;wBAC9C,GAAG,EAAE,aAAa,CAAC,GAAG;wBACtB,+DAA+D;wBAC/D,2DAA2D;wBAC3D,UAAU,EAAE,CAAC,GAAG,aAAa,CAAC,UAAU,CAAC;wBACzC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE;qBACpB,CAAC,CAAC;oBAEH,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;wBACxB,OAAO;oBACT,CAAC;oBAED,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;wBACxB,kBAAkB,CAAC,UAAU,GAAG,KAAK,CAAC;oBACxC,CAAC;oBAED,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;wBACzB,kBAAkB,CAAC,SAAS,GAAG,KAAK,CAAC;oBACvC,CAAC;oBAED,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;oBACzE,gCAAgC;oBAChC,UAAU,GAAG,GAAG,CAAC;oBAEjB,IAAI,UAAU,EAAE,CAAC;wBACf,MAAM,IAAI,CAAC,8BAA8B,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;wBACnE,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE;4BAChC,IAAI,EAAE,IAAI,CAAC,GAAG;yBACf,CAAC,CAAC;oBACL,CAAC;oBAED,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;wBACrB,kBAAkB,CAAC,KAAK,GAAG,IAAI,CAAC;oBAClC,CAAC;oBAED,IAAI,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAC/C,MAAM,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;oBAC7C,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBACpC,CAAC;YACH,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;gBACvB,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;YACpC,CAAC;SACF,EACD;YACE,MAAM,EAAE,WAAW;YACnB,MAAM;YACN,UAAU,EAAE,YAAY,CAAC,UAAU;YACnC,gBAAgB,EAAE,IAAI,CAAC,iCAAiC;SACzD,CACF,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"DifferentialQueryProcessor.js","sourceRoot":"","sources":["../../../../src/client/watched/processors/DifferentialQueryProcessor.ts"],"names":[],"mappings":""}

package/lib/client/watched/processors/OnChangeQueryProcessor.d.ts

@@ -1,33 +1,15 @@
 import { WatchCompatibleQuery, WatchedQuery, WatchedQueryOptions } from '../WatchedQuery.js';
-import { AbstractQueryProcessor, AbstractQueryProcessorOptions, LinkQueryOptions } from './AbstractQueryProcessor.js';
-import { WatchedQueryComparator } from './comparators.js';
 /**
  * Settings for {@link WatchedQuery} instances created via {@link Query#watch}.
+ *
+ * @public
  */
 export interface WatchedQuerySettings<DataType> extends WatchedQueryOptions {
     query: WatchCompatibleQuery<DataType>;
 }
 /**
  * {@link WatchedQuery} returned from {@link Query#watch}.
+ *
+ * @public
  */
 export type StandardWatchedQuery<DataType> = WatchedQuery<DataType, WatchedQuerySettings<DataType>>;
-/**
- * @internal
- */
-export interface OnChangeQueryProcessorOptions<Data> extends AbstractQueryProcessorOptions<Data, WatchedQuerySettings<Data>> {
-    comparator?: WatchedQueryComparator<Data>;
-}
-/**
- * Uses the PowerSync onChange event to trigger watched queries.
- * Results are emitted on every change of the relevant tables.
- * @internal
- */
-export declare class OnChangeQueryProcessor<Data> extends AbstractQueryProcessor<Data, WatchedQuerySettings<Data>> {
-    protected options: OnChangeQueryProcessorOptions<Data>;
-    constructor(options: OnChangeQueryProcessorOptions<Data>);
-    /**
-     * @returns If the sets are equal
-     */
-    protected checkEquality(current: Data, previous: Data): boolean;
-    protected linkQuery(options: LinkQueryOptions<Data>): Promise<void>;
-}

package/lib/client/watched/processors/OnChangeQueryProcessor.js

@@ -1,83 +1,2 @@
-import { AbstractQueryProcessor } from './AbstractQueryProcessor.js';
-/**
- * Uses the PowerSync onChange event to trigger watched queries.
- * Results are emitted on every change of the relevant tables.
- * @internal
- */
-export class OnChangeQueryProcessor extends AbstractQueryProcessor {
-    options;
-    constructor(options) {
-        super(options);
-        this.options = options;
-    }
-    /**
-     * @returns If the sets are equal
-     */
-    checkEquality(current, previous) {
-        // Use the provided comparator if available. Assume values are unique if not available.
-        return this.options.comparator?.checkEquality?.(current, previous) ?? false;
-    }
-    async linkQuery(options) {
-        const { db, watchOptions } = this.options;
-        const { abortSignal } = options;
-        const compiledQuery = watchOptions.query.compile();
-        const tables = await db.resolveTables(compiledQuery.sql, compiledQuery.parameters, {
-            tables: options.settings.triggerOnTables
-        });
-        db.onChangeWithCallback({
-            onChange: async () => {
-                if (this.closed || abortSignal.aborted) {
-                    return;
-                }
-                // This fires for each change of the relevant tables
-                try {
-                    if (this.reportFetching && !this.state.isFetching) {
-                        await this.updateState({ isFetching: true });
-                    }
-                    const partialStateUpdate = {};
-                    // Always run the query if an underlying table has changed
-                    const result = await watchOptions.query.execute({
-                        sql: compiledQuery.sql,
-                        // Allows casting from ReadOnlyArray[unknown] to Array<unknown>
-                        // This allows simpler compatibility with PowerSync queries
-                        parameters: [...compiledQuery.parameters],
-                        db: this.options.db
-                    });
-                    if (abortSignal.aborted) {
-                        return;
-                    }
-                    if (this.reportFetching) {
-                        partialStateUpdate.isFetching = false;
-                    }
-                    if (this.state.isLoading) {
-                        partialStateUpdate.isLoading = false;
-                    }
-                    // Check if the result has changed
-                    if (!this.checkEquality(result, this.state.data)) {
-                        Object.assign(partialStateUpdate, {
-                            data: result
-                        });
-                    }
-                    if (this.state.error) {
-                        partialStateUpdate.error = null;
-                    }
-                    if (Object.keys(partialStateUpdate).length > 0) {
-                        await this.updateState(partialStateUpdate);
-                    }
-                }
-                catch (error) {
-                    await this.updateState({ error });
-                }
-            },
-            onError: async (error) => {
-                await this.updateState({ error });
-            }
-        }, {
-            signal: abortSignal,
-            tables,
-            throttleMs: watchOptions.throttleMs,
-            triggerImmediate: true // used to emit the initial state
-        });
-    }
-}
+export {};
 //# sourceMappingURL=OnChangeQueryProcessor.js.map

package/lib/client/watched/processors/OnChangeQueryProcessor.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnChangeQueryProcessor.js","sourceRoot":"","sources":["../../../../src/client/watched/processors/OnChangeQueryProcessor.ts"],"names":[],"mappings":"AACA,OAAO,EACL,sBAAsB,EAIvB,MAAM,6BAA6B,CAAC;AAuBrC;;;;GAIG;AACH,MAAM,OAAO,sBAA6B,SAAQ,sBAAwD;IAClF;IAAtB,YAAsB,OAA4C;QAChE,KAAK,CAAC,OAAO,CAAC,CAAC;QADK,YAAO,GAAP,OAAO,CAAqC;IAElE,CAAC;IAED;;OAEG;IACO,aAAa,CAAC,OAAa,EAAE,QAAc;QACnD,uFAAuF;QACvF,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,aAAa,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,KAAK,CAAC;IAC9E,CAAC;IAES,KAAK,CAAC,SAAS,CAAC,OAA+B;QACvD,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAC1C,MAAM,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;QAEhC,MAAM,aAAa,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACnD,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,aAAa,CAAC,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,UAAmB,EAAE;YAC1F,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,eAAe;SACzC,CAAC,CAAC;QAEH,EAAE,CAAC,oBAAoB,CACrB;YACE,QAAQ,EAAE,KAAK,IAAI,EAAE;gBACnB,IAAI,IAAI,CAAC,MAAM,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;oBACvC,OAAO;gBACT,CAAC;gBACD,oDAAoD;gBACpD,IAAI,CAAC;oBACH,IAAI,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;wBAClD,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;oBAC/C,CAAC;oBAED,MAAM,kBAAkB,GAA8D,EAAE,CAAC;oBAEzF,0DAA0D;oBAC1D,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC;wBAC9C,GAAG,EAAE,aAAa,CAAC,GAAG;wBACtB,+DAA+D;wBAC/D,2DAA2D;wBAC3D,UAAU,EAAE,CAAC,GAAG,aAAa,CAAC,UAAU,CAAC;wBACzC,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE;qBACpB,CAAC,CAAC;oBAEH,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;wBACxB,OAAO;oBACT,CAAC;oBAED,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;wBACxB,kBAAkB,CAAC,UAAU,GAAG,KAAK,CAAC;oBACxC,CAAC;oBAED,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,CAAC;wBACzB,kBAAkB,CAAC,SAAS,GAAG,KAAK,CAAC;oBACvC,CAAC;oBAED,kCAAkC;oBAClC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;wBACjD,MAAM,CAAC,MAAM,CAAC,kBAAkB,EAAE;4BAChC,IAAI,EAAE,MAAM;yBACb,CAAC,CAAC;oBACL,CAAC;oBAED,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;wBACrB,kBAAkB,CAAC,KAAK,GAAG,IAAI,CAAC;oBAClC,CAAC;oBAED,IAAI,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;wBAC/C,MAAM,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC;oBAC7C,CAAC;gBACH,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;gBACpC,CAAC;YACH,CAAC;YACD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;gBACvB,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;YACpC,CAAC;SACF,EACD;YACE,MAAM,EAAE,WAAW;YACnB,MAAM;YACN,UAAU,EAAE,YAAY,CAAC,UAAU;YACnC,gBAAgB,EAAE,IAAI,CAAC,iCAAiC;SACzD,CACF,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"OnChangeQueryProcessor.js","sourceRoot":"","sources":["../../../../src/client/watched/processors/OnChangeQueryProcessor.ts"],"names":[],"mappings":""}

package/lib/client/watched/processors/comparators.d.ts

@@ -2,12 +2,16 @@
  * A basic comparator for incrementally watched queries. This performs a single comparison which
  * determines if the result set has changed. The {@link WatchedQuery} will only emit the new result
  * if a change has been detected.
+ *
+ * @public
  */
 export interface WatchedQueryComparator<Data> {
     checkEquality: (current: Data, previous: Data) => boolean;
 }
 /**
  * Options for {@link ArrayComparator}
+ *
+ * @public
  */
 export type ArrayComparatorOptions<ItemType> = {
     /**
@@ -18,6 +22,8 @@ export type ArrayComparatorOptions<ItemType> = {
 /**
  * An efficient comparator for {@link WatchedQuery} created with {@link Query#watch}. This has the ability to determine if a query
  * result has changes without necessarily processing all items in the result.
+ *
+ * @public
  */
 export declare class ArrayComparator<ItemType> implements WatchedQueryComparator<ItemType[]> {
     protected options: ArrayComparatorOptions<ItemType>;
@@ -26,5 +32,7 @@ export declare class ArrayComparator<ItemType> implements WatchedQueryComparator
 }
 /**
  * Watched query comparator that always reports changed result sets.
+ *
+ * @public
  */
 export declare const FalsyComparator: WatchedQueryComparator<unknown>;

package/lib/client/watched/processors/comparators.js

@@ -1,6 +1,8 @@
 /**
  * An efficient comparator for {@link WatchedQuery} created with {@link Query#watch}. This has the ability to determine if a query
  * result has changes without necessarily processing all items in the result.
+ *
+ * @public
  */
 export class ArrayComparator {
     options;
@@ -28,6 +30,8 @@ export class ArrayComparator {
 }
 /**
  * Watched query comparator that always reports changed result sets.
+ *
+ * @public
  */
 export const FalsyComparator = {
     checkEquality: () => false // Default comparator that always returns false

package/lib/client/watched/processors/comparators.js.map

@@ -1 +1 @@
-{"version":3,"file":"comparators.js","sourceRoot":"","sources":["../../../../src/client/watched/processors/comparators.ts"],"names":[],"mappings":"AAmBA;;;GAGG;AACH,MAAM,OAAO,eAAe;IACJ;IAAtB,YAAsB,OAAyC;QAAzC,YAAO,GAAP,OAAO,CAAkC;IAAG,CAAC;IAEnE,aAAa,CAAC,OAAmB,EAAE,QAAoB;QACrD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;YACvC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAEnC,sCAAsC;QACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1C,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YAE5C,IAAI,WAAW,KAAK,YAAY,EAAE,CAAC;gBACjC,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAoC;IAC9D,aAAa,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,+CAA+C;CAC3E,CAAC"}
+{"version":3,"file":"comparators.js","sourceRoot":"","sources":["../../../../src/client/watched/processors/comparators.ts"],"names":[],"mappings":"AAuBA;;;;;GAKG;AACH,MAAM,OAAO,eAAe;IACJ;IAAtB,YAAsB,OAAyC;QAAzC,YAAO,GAAP,OAAO,CAAkC;IAAG,CAAC;IAEnE,aAAa,CAAC,OAAmB,EAAE,QAAoB;QACrD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;YACvC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QAEnC,sCAAsC;QACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,MAAM,WAAW,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1C,MAAM,YAAY,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;YAE5C,IAAI,WAAW,KAAK,YAAY,EAAE,CAAC;gBACjC,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,eAAe,GAAoC;IAC9D,aAAa,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,+CAA+C;CAC3E,CAAC"}

package/lib/db/DBAdapter.d.ts

@@ -2,110 +2,104 @@
  * Set of generic interfaces to allow PowerSync compatibility with
  * different SQLite DB implementations.
  */
-import { BaseListener, BaseObserverInterface } from '../utils/BaseObserver.js';
+import { BaseListener, BaseObserver } from '../utils/BaseObserver.js';
+import { QueryResult, RawQueryResult, SqliteRecord } from './QueryResult.js';
 /**
- * TODO most of these types could be exported to a common `types` package
- * which is used by the DB adapter libraries as well.
+ * @public
  */
-/**
- * Object returned by SQL Query executions.
- */
-export type QueryResult = {
-    /** Represents the auto-generated row id if applicable. */
-    insertId?: number;
+export interface DBGetUtils {
     /**
-     * Number of affected rows reported by SQLite for a write query.
+     *  Execute a read-only query and return results.
      *
-     * When using the default client-side [JSON-based view system](https://docs.powersync.com/architecture/client-architecture#client-side-schema-and-sqlite-database-structure),
-     * `rowsAffected` may be `0` for successful `UPDATE` and `DELETE` statements.
-     * Use a `RETURNING` clause and inspect `rows` when you need to confirm which rows changed.
+     * @param sql - The SQL query to execute
+     * @param parameters - Optional array of parameters to bind to the query
+     * @returns An array of results
      */
-    rowsAffected: number;
-    /** if status is undefined or 0 this object will contain the query results */
-    rows?: {
-        /** Raw array with all dataset */
-        _array: any[];
-        /** The length of the dataset */
-        length: number;
-        /** A convenience function to acess the index based the row object
-         * @param idx the row index
-         * @returns the row structure identified by column names
-         */
-        item: (idx: number) => any;
-    };
-};
-export interface DBGetUtils {
-    /** Execute a read-only query and return results. */
     getAll<T>(sql: string, parameters?: any[]): Promise<T[]>;
-    /** Execute a read-only query and return the first result, or null if the ResultSet is empty. */
+    /**
+     * Execute a read-only query and return the first result, or null if the ResultSet is empty.
+     *
+     * @param sql - The SQL query to execute
+     * @param parameters - Optional array of parameters to bind to the query
+     * @returns The first result if found, or null if no results are returned
+     */
     getOptional<T>(sql: string, parameters?: any[]): Promise<T | null>;
-    /** Execute a read-only query and return the first result, error if the ResultSet is empty. */
+    /**
+     * Execute a read-only query and return the first result, error if the ResultSet is empty.
+     *
+     * @param sql - The SQL query to execute
+     * @param parameters - Optional array of parameters to bind to the query
+     * @returns The first result matching the query
+     * @throws Error if no rows are returned
+     */
     get<T>(sql: string, parameters?: any[]): Promise<T>;
 }
+/**
+ * @public
+ */
 export interface SqlExecutor {
-    /** Execute a single write statement. */
-    execute: (query: string, params?: any[] | undefined) => Promise<QueryResult>;
     /**
-     * Execute a single write statement and return raw results.
-     * Unlike `execute`, which returns an object with structured key-value pairs,
-     * `executeRaw` returns a nested array of raw values, where each row is
-     * represented as an array of column values without field names.
+     * Execute a SQL write (INSERT/UPDATE/DELETE) query
+     * and optionally return results.
      *
-     * Example result:
+     * When using the default client-side [JSON-based view system](https://docs.powersync.com/architecture/client-architecture#client-side-schema-and-sqlite-database-structure),
+     * the returned result's `rowsAffected` may be `0` for successful `UPDATE` and `DELETE` statements.
+     * Use a `RETURNING` clause and inspect `result.rows` when you need to confirm which rows changed.
      *
-     * ```[ [ '1', 'list 1', '33', 'Post content', '1' ] ]```
+     * @param sql - The SQL query to execute
+     * @param parameters - Optional array of parameters to bind to the query
+     * @returns The query result as an object with structured key-value pairs
+     */
+    execute: <T = SqliteRecord>(query: string, params?: any[] | undefined) => Promise<QueryResult<T>>;
+    /**
+     * Execute a SQL write (INSERT/UPDATE/DELETE) query directly on the database without any PowerSync processing.
+     * This bypasses certain PowerSync abstractions and is useful for accessing the raw database results.
      *
-     * Where as `execute`'s `rows._array` would have been:
+     * @param sql - The SQL query to execute
+     * @param parameters - Optional array of parameters to bind to the query
+     * @returns The {@link RawQueryResult} representing each row as an array.
+     */
+    executeRaw: (query: string, params?: any[] | undefined) => Promise<RawQueryResult>;
+    /**
+     * Execute a write query (INSERT/UPDATE/DELETE) multiple times with each parameter set
+     * and optionally return results.
+     * This is faster than executing separately with each parameter set.
      *
-     * ```[ { id: '33', name: 'list 1', content: 'Post content', list_id: '1' } ]```
+     * @param sql - The SQL query to execute
+     * @param parameters - Optional 2D array of parameter sets, where each inner array is a set of parameters for one execution
+     * @returns The query result
      */
-    executeRaw: (query: string, params?: any[] | undefined) => Promise<any[][]>;
-    executeBatch: (query: string, params?: any[][]) => Promise<QueryResult>;
+    executeBatch: (query: string, params?: any[][]) => Promise<QueryResult<never>>;
 }
-export interface LockContext extends SqlExecutor, DBGetUtils {
+/**
+ * @public
+ */
+export declare abstract class LockContext implements SqlExecutor, DBGetUtils {
+    abstract executeRaw<T>(query: string, params?: any[] | undefined): Promise<RawQueryResult>;
+    getAll<T>(sql: string, parameters?: any[]): Promise<T[]>;
+    getOptional<T>(sql: string, parameters?: any[]): Promise<T | null>;
+    get<T>(sql: string, parameters?: any[]): Promise<T>;
+    execute<T = SqliteRecord>(query: string, params?: any[] | undefined): Promise<QueryResult<T>>;
+    executeBatch(query: string, params?: any[][]): Promise<QueryResult<never>>;
 }
 /**
- * Implements {@link DBGetUtils} on a {@link SqlRunner}.
+ * @public
  */
-export declare function DBGetUtilsDefaultMixin<TBase extends new (...args: any[]) => Omit<SqlExecutor, 'executeBatch'>>(Base: TBase): {
-    new (...args: any[]): {
-        getAll<T>(sql: string, parameters?: any[]): Promise<T[]>;
-        getOptional<T>(sql: string, parameters?: any[]): Promise<T | null>;
-        get<T>(sql: string, parameters?: any[]): Promise<T>;
-        executeBatch(query: string, params?: any[][]): Promise<QueryResult>;
-        execute: (query: string, params?: any[] | undefined) => Promise<QueryResult>;
-        executeRaw: (query: string, params?: any[] | undefined) => Promise<any[][]>;
-    };
-} & TBase;
 export interface Transaction extends LockContext {
     /** Commit multiple changes to the local DB using the Transaction context. */
-    commit: () => Promise<QueryResult>;
+    commit: () => Promise<void>;
     /** Roll back multiple attempted changes using the Transaction context. */
-    rollback: () => Promise<QueryResult>;
-}
-/**
- * Update table operation numbers from SQLite
- */
-export declare enum RowUpdateType {
-    SQLITE_INSERT = 18,
-    SQLITE_DELETE = 9,
-    SQLITE_UPDATE = 23
-}
-export interface TableUpdateOperation {
-    opType: RowUpdateType;
-    rowId: number;
+    rollback: () => Promise<void>;
 }
 /**
- * Notification of an update to one or more tables, for the purpose of realtime change notifications.
+ * @public
  */
-export interface UpdateNotification extends TableUpdateOperation {
-    table: string;
-}
 export interface BatchedUpdateNotification {
-    rawUpdates: UpdateNotification[];
     tables: string[];
-    groupedUpdates: Record<string, TableUpdateOperation[]>;
 }
+/**
+ * @public
+ */
 export interface DBAdapterListener extends BaseListener {
     /**
      * Listener for table updates.
@@ -113,49 +107,32 @@ export interface DBAdapterListener extends BaseListener {
      * without the need for a major version bump
      * The DB adapter can also batch update notifications if supported.
      */
-    tablesUpdated: (updateNotification: BatchedUpdateNotification | UpdateNotification) => void;
+    tablesUpdated: (updateNotification: BatchedUpdateNotification) => void;
 }
+/**
+ * @public
+ */
 export interface DBLockOptions {
     timeoutMs?: number;
 }
-export interface ConnectionPool extends BaseObserverInterface<DBAdapterListener> {
-    name: string;
-    close: () => void | Promise<void>;
-    readLock: <T>(fn: (tx: LockContext) => Promise<T>, options?: DBLockOptions) => Promise<T>;
-    writeLock: <T>(fn: (tx: LockContext) => Promise<T>, options?: DBLockOptions) => Promise<T>;
+/**
+ * @public
+ */
+export declare abstract class DBAdapter extends BaseObserver<DBAdapterListener> implements SqlExecutor, DBGetUtils {
+    abstract get name(): string;
+    abstract close(): void | Promise<void>;
+    abstract readLock<T>(fn: (tx: LockContext) => Promise<T>, options?: DBLockOptions): Promise<T>;
+    abstract writeLock<T>(fn: (tx: LockContext) => Promise<T>, options?: DBLockOptions): Promise<T>;
     /**
      * This method refreshes the schema information across all connections. This is for advanced use cases, and should generally not be needed.
      */
-    refreshSchema: () => Promise<void>;
-}
-export interface DBAdapter extends ConnectionPool, SqlExecutor, DBGetUtils {
-    readTransaction: <T>(fn: (tx: Transaction) => Promise<T>, options?: DBLockOptions) => Promise<T>;
-    writeTransaction: <T>(fn: (tx: Transaction) => Promise<T>, options?: DBLockOptions) => Promise<T>;
+    abstract refreshSchema(): Promise<void>;
+    readTransaction<T>(fn: (tx: Transaction) => Promise<T>, options?: DBLockOptions): Promise<T>;
+    writeTransaction<T>(fn: (tx: Transaction) => Promise<T>, options?: DBLockOptions): Promise<T>;
+    getAll<T>(sql: string, parameters?: any[]): Promise<T[]>;
+    getOptional<T>(sql: string, parameters?: any[]): Promise<T | null>;
+    get<T>(sql: string, parameters?: any[]): Promise<T>;
+    execute<T>(query: string, params?: any[]): Promise<QueryResult<T>>;
+    executeRaw(query: string, params?: any[]): Promise<RawQueryResult>;
+    executeBatch(query: string, params?: any[][]): Promise<QueryResult<never>>;
 }
-/**
- * A mixin to implement {@link DBAdapter} by delegating to {@link ConnectionPool.readLock} and
- * {@link ConnectionPool.writeLock}.
- */
-export declare function DBAdapterDefaultMixin<TBase extends new (...args: any[]) => ConnectionPool>(Base: TBase): {
-    new (...args: any[]): {
-        readTransaction<T>(fn: (tx: Transaction) => Promise<T>, options?: DBLockOptions): Promise<T>;
-        writeTransaction<T>(fn: (tx: Transaction) => Promise<T>, options?: DBLockOptions): Promise<T>;
-        getAll<T>(sql: string, parameters?: any[]): Promise<T[]>;
-        getOptional<T>(sql: string, parameters?: any[]): Promise<T | null>;
-        get<T>(sql: string, parameters?: any[]): Promise<T>;
-        execute(query: string, params?: any[]): Promise<QueryResult>;
-        executeRaw(query: string, params?: any[]): Promise<any[][]>;
-        executeBatch(query: string, params?: any[][]): Promise<QueryResult>;
-        name: string;
-        close: () => void | Promise<void>;
-        readLock: <T>(fn: (tx: LockContext) => Promise<T>, options?: DBLockOptions) => Promise<T>;
-        writeLock: <T>(fn: (tx: LockContext) => Promise<T>, options?: DBLockOptions) => Promise<T>;
-        /**
-         * This method refreshes the schema information across all connections. This is for advanced use cases, and should generally not be needed.
-         */
-        refreshSchema: () => Promise<void>;
-        registerListener(listener: Partial<DBAdapterListener>): () => void;
-    };
-} & TBase;
-export declare function isBatchedUpdateNotification(update: BatchedUpdateNotification | UpdateNotification): update is BatchedUpdateNotification;
-export declare function extractTableUpdates(update: BatchedUpdateNotification | UpdateNotification): string[];