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

package/lib/client/triggers/TriggerManager.d.ts

@@ -1,7 +1,8 @@
 import { LockContext } from '../../db/DBAdapter.js';
 /**
  * SQLite operations to track changes for with {@link TriggerManager}
- * @experimental
+ *
+ * @experimental @alpha
  */
 export declare enum DiffTriggerOperation {
     INSERT = "INSERT",
@@ -9,7 +10,7 @@ export declare enum DiffTriggerOperation {
     DELETE = "DELETE"
 }
 /**
- * @experimental
+ * @experimental @alpha
  * Diffs created by {@link TriggerManager#createDiffTrigger} are stored in a temporary table.
  * This is the base record structure for all diff records.
  *
@@ -38,7 +39,7 @@ export interface BaseTriggerDiffRecord<TOperationId extends string | number = nu
     timestamp: string;
 }
 /**
- * @experimental
+ * @experimental @alpha
  * Represents a diff record for a SQLite UPDATE operation.
  * This record contains the new value and optionally the previous value.
  * Values are stored as JSON strings.
@@ -55,7 +56,7 @@ export interface TriggerDiffUpdateRecord<TOperationId extends string | number =
     previous_value: string;
 }
 /**
- * @experimental
+ * @experimental @alpha
  * Represents a diff record for a SQLite INSERT operation.
  * This record contains the new value represented as a JSON string.
  */
@@ -67,7 +68,7 @@ export interface TriggerDiffInsertRecord<TOperationId extends string | number =
     value: string;
 }
 /**
- * @experimental
+ * @experimental @alpha
  * Represents a diff record for a SQLite DELETE operation.
  * This record contains the new value represented as a JSON string.
  */
@@ -79,7 +80,7 @@ export interface TriggerDiffDeleteRecord<TOperationId extends string | number =
     value: string;
 }
 /**
- * @experimental
+ * @experimental @alpha
  * Diffs created by {@link TriggerManager#createDiffTrigger} are stored in a temporary table.
  * This is the record structure for all diff records.
  *
@@ -104,7 +105,7 @@ export interface TriggerDiffDeleteRecord<TOperationId extends string | number =
  */
 export type TriggerDiffRecord<TOperationId extends string | number = number> = TriggerDiffUpdateRecord<TOperationId> | TriggerDiffInsertRecord<TOperationId> | TriggerDiffDeleteRecord<TOperationId>;
 /**
- * @experimental
+ * @experimental @alpha
  * Querying the DIFF table directly with {@link TriggerDiffHandlerContext#withExtractedDiff} will return records
  * with the tracked columns extracted from the JSON value.
  * This type represents the structure of such records.
@@ -132,7 +133,7 @@ export type ExtractedTriggerDiffRecord<T, TOperationId extends string | number =
     __previous_value?: string;
 };
 /**
- * @experimental
+ * @experimental @alpha
  * Hooks used in the creation of a table diff trigger.
  */
 export interface TriggerCreationHooks {
@@ -143,8 +144,10 @@ export interface TriggerCreationHooks {
 }
 /**
  * Common interface for options used in creating a diff trigger.
+ *
+ * @alpha @experimental
  */
-interface BaseCreateDiffTriggerOptions {
+export interface BaseCreateDiffTriggerOptions {
     /**
      * PowerSync source table/view to trigger and track changes from.
      * This should be present in the PowerSync database's schema.
@@ -165,16 +168,18 @@ interface BaseCreateDiffTriggerOptions {
      * The row id is available in the `id` column.
      *
      * NB! The WHEN clauses here are added directly to the SQLite trigger creation SQL.
-     * Any user input strings here should be sanitized externally. The {@link when} string template function performs
-     * some basic sanitization, extra external sanitization is recommended.
+     * Any user input strings here should be sanitized externally. The {@link BaseCreateDiffTriggerOptions.when} string
+     * template function performs some basic sanitization, extra external sanitization is recommended.
      *
      * @example
+     * ```JavaScript
      * {
      *  'INSERT': sanitizeSQL`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(list.id)}`,
      *  'INSERT': `TRUE`,
      *  'UPDATE': sanitizeSQL`NEW.id = 'abcd' AND json_extract(NEW.data, '$.status') = 'active'`,
      *  'DELETE': sanitizeSQL`json_extract(OLD.data, '$.list_id') = 'abcd'`
      * }
+     * ```
      */
     when: Partial<Record<DiffTriggerOperation, string>>;
     /**
@@ -188,7 +193,7 @@ interface BaseCreateDiffTriggerOptions {
     useStorage?: boolean;
 }
 /**
- * @experimental
+ * @experimental @alpha
  * Options for {@link TriggerManager#createDiffTrigger}.
  */
 export interface CreateDiffTriggerOptions extends BaseCreateDiffTriggerOptions {
@@ -205,19 +210,19 @@ export interface CreateDiffTriggerOptions extends BaseCreateDiffTriggerOptions {
     setupContext?: LockContext;
 }
 /**
- * @experimental
+ * @experimental @alpha
  * Options for {@link TriggerRemoveCallback}.
  */
 export interface TriggerRemoveCallbackOptions {
     context?: LockContext;
 }
 /**
- * @experimental
+ * @experimental @alpha
  * Callback to drop a trigger after it has been created.
  */
 export type TriggerRemoveCallback = (options?: TriggerRemoveCallbackOptions) => Promise<void>;
 /**
- * @experimental
+ * @experimental @alpha
  * Options for {@link TriggerDiffHandlerContext#withDiff}.
  */
 export interface WithDiffOptions {
@@ -231,10 +236,11 @@ export interface WithDiffOptions {
     castOperationIdAsText?: boolean;
 }
 /**
- * @experimental
+ * @experimental @alpha
  * Context for the `onChange` handler provided to {@link TriggerManager#trackTableDiff}.
  */
-export interface TriggerDiffHandlerContext extends LockContext {
+export interface TriggerDiffHandlerContext {
+    context: LockContext;
     /**
      * The name of the temporary destination table created by the trigger.
      */
@@ -286,7 +292,7 @@ export interface TriggerDiffHandlerContext extends LockContext {
      * Allows querying the database with access to the table containing diff records.
      * The diff table is accessible via the `DIFF` accessor.
      *
-     * This is similar to {@link withDiff} but extracts the row columns from the tracked JSON value. The diff operation
+     * This is similar to {@link TriggerDiffHandlerContext#withDiff} but extracts the row columns from the tracked JSON value. The diff operation
      * data is aliased as `__` columns to avoid column conflicts.
      *
      * For {@link DiffTriggerOperation#DELETE} operations the previous_value columns are extracted for convenience.
@@ -317,7 +323,7 @@ export interface TriggerDiffHandlerContext extends LockContext {
     withExtractedDiff: <T = any>(query: string, params?: ReadonlyArray<Readonly<any>>) => Promise<T[]>;
 }
 /**
- * @experimental
+ * @experimental @alpha
  * Options for tracking changes to a table with {@link TriggerManager#trackTableDiff}.
  */
 export interface TrackDiffOptions extends BaseCreateDiffTriggerOptions {
@@ -328,13 +334,12 @@ export interface TrackDiffOptions extends BaseCreateDiffTriggerOptions {
      */
     onChange: (context: TriggerDiffHandlerContext) => Promise<void>;
     /**
-     * The minimum interval, in milliseconds, between {@link onChange} invocations.
-     *  @default {@link DEFAULT_WATCH_THROTTLE_MS}
+     * The minimum interval, in milliseconds, between {@link TrackDiffOptions.onChange} invocations.
      */
     throttleMs?: number;
 }
 /**
- * @experimental
+ * @experimental @alpha
  */
 export interface TriggerManager {
     /**
@@ -382,7 +387,7 @@ export interface TriggerManager {
     /**
      * @experimental
      * Tracks changes for a table. Triggering a provided handler on changes.
-     * Uses {@link createDiffTrigger} internally to create a temporary destination table.
+     * Uses {@link TriggerManager.createDiffTrigger} internally to create a temporary destination table.
      *
      * @returns A callback to cleanup the trigger and stop tracking changes.
      *
@@ -436,36 +441,3 @@ export interface TriggerManager {
      */
     trackTableDiff(options: TrackDiffOptions): Promise<TriggerRemoveCallback>;
 }
-/**
- * @experimental
- * @internal
- * Manages claims on persisted SQLite triggers and destination tables to enable proper cleanup
- * when they are no longer actively in use.
- *
- * When using persisted triggers (especially for OPFS multi-tab scenarios), we need a reliable way to determine which resources are still actively in use across different connections/tabs so stale resources can be safely cleaned up without interfering with active triggers.
- *
- * A cleanup process runs
- * on database creation (and every 2 minutes) that:
- * 1. Queries for existing managed persisted resources
- * 2. Checks with the claim manager if any consumer is actively using those resources
- * 3. Deletes unused resources
- */
-export interface TriggerClaimManager {
-    /**
-     * Obtains or marks a claim on a certain identifier.
-     * @returns a callback to release the claim.
-     */
-    obtainClaim: (identifier: string) => Promise<() => Promise<void>>;
-    /**
-     * Checks if a claim is present for an identifier.
-     */
-    checkClaim: (identifier: string) => Promise<boolean>;
-}
-/**
- * @experimental
- * @internal
- */
-export interface TriggerManagerConfig {
-    claimManager: TriggerClaimManager;
-}
-export {};

package/lib/client/triggers/TriggerManager.js

@@ -1,6 +1,7 @@
 /**
  * SQLite operations to track changes for with {@link TriggerManager}
- * @experimental
+ *
+ * @experimental @alpha
  */
 export var DiffTriggerOperation;
 (function (DiffTriggerOperation) {

package/lib/client/triggers/TriggerManager.js.map

@@ -1 +1 @@
-{"version":3,"file":"TriggerManager.js","sourceRoot":"","sources":["../../../src/client/triggers/TriggerManager.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;AACnB,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B"}
+{"version":3,"file":"TriggerManager.js","sourceRoot":"","sources":["../../../src/client/triggers/TriggerManager.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,CAAN,IAAY,oBAIX;AAJD,WAAY,oBAAoB;IAC9B,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;IACjB,yCAAiB,CAAA;AACnB,CAAC,EAJW,oBAAoB,KAApB,oBAAoB,QAI/B"}

package/lib/client/triggers/sanitizeSQL.d.ts

@@ -1,6 +1,8 @@
 /**
  * Helper function for sanitizing UUID input strings.
  * Typically used with {@link sanitizeSQL}.
+ *
+ * @alpha
  */
 export declare function sanitizeUUID(uuid: string): string;
 /**
@@ -30,5 +32,7 @@ export declare function sanitizeUUID(uuid: string): string;
  * // Incorrect:
  * sanitizeSQL`New.id = '${myID}'` // Produces double quotes: New.id = ''O''Reilly''
  * ```
+ *
+ * @alpha
  */
 export declare function sanitizeSQL(strings: TemplateStringsArray, ...values: any[]): string;

package/lib/client/triggers/sanitizeSQL.js

@@ -4,6 +4,8 @@ function sanitizeString(input) {
 /**
  * Helper function for sanitizing UUID input strings.
  * Typically used with {@link sanitizeSQL}.
+ *
+ * @alpha
  */
 export function sanitizeUUID(uuid) {
     const uuidRegex = /^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;
@@ -40,6 +42,8 @@ export function sanitizeUUID(uuid) {
  * // Incorrect:
  * sanitizeSQL`New.id = '${myID}'` // Produces double quotes: New.id = ''O''Reilly''
  * ```
+ *
+ * @alpha
  */
 export function sanitizeSQL(strings, ...values) {
     let result = '';

package/lib/client/triggers/sanitizeSQL.js.map

@@ -1 +1 @@
-{"version":3,"file":"sanitizeSQL.js","sourceRoot":"","sources":["../../../src/client/triggers/sanitizeSQL.ts"],"names":[],"mappings":"AAAA,SAAS,cAAc,CAAC,KAAa;IACnC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;AAC1C,CAAC;AACD;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,MAAM,SAAS,GAAG,4EAA4E,CAAC;IAC/F,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,sBAAsB,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,WAAW,CAAC,OAA6B,EAAE,GAAG,MAAa;IACzE,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;QACzB,MAAM,IAAI,GAAG,CAAC;QACd,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;YACtB,iDAAiD;YACjD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,OAAO,KAAK,IAAI,QAAQ,EAAE,CAAC;gBAC7B,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC;YAClC,CAAC;iBAAM,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;gBACzB,MAAM,IAAI,MAAM,CAAC;YACnB,CAAC;iBAAM,IAAI,OAAO,KAAK,IAAI,QAAQ,EAAE,CAAC;gBACpC,8DAA8D;gBAC9D,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBAC1C,MAAM,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;YACxC,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC"}
+{"version":3,"file":"sanitizeSQL.js","sourceRoot":"","sources":["../../../src/client/triggers/sanitizeSQL.ts"],"names":[],"mappings":"AAAA,SAAS,cAAc,CAAC,KAAa;IACnC,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC;AAC1C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,MAAM,SAAS,GAAG,4EAA4E,CAAC;IAC/F,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,sBAAsB,CAAC,CAAC;IACjD,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,UAAU,WAAW,CAAC,OAA6B,EAAE,GAAG,MAAa;IACzE,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE;QACzB,MAAM,IAAI,GAAG,CAAC;QACd,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;YACtB,iDAAiD;YACjD,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;YACxB,IAAI,OAAO,KAAK,IAAI,QAAQ,EAAE,CAAC;gBAC7B,MAAM,IAAI,cAAc,CAAC,KAAK,CAAC,CAAC;YAClC,CAAC;iBAAM,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;gBACzB,MAAM,IAAI,MAAM,CAAC;YACnB,CAAC;iBAAM,IAAI,OAAO,KAAK,IAAI,QAAQ,EAAE,CAAC;gBACpC,8DAA8D;gBAC9D,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;gBAC1C,MAAM,IAAI,cAAc,CAAC,WAAW,CAAC,CAAC;YACxC,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC;YAClB,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/lib/client/watched/GetAllQuery.d.ts

@@ -1,8 +1,10 @@
 import { CompiledQuery } from '../../types/types.js';
-import { AbstractPowerSyncDatabase } from '../AbstractPowerSyncDatabase.js';
+import { CommonPowerSyncDatabase } from '../CommonPowerSyncDatabase.js';
 import { WatchCompatibleQuery } from './WatchedQuery.js';
 /**
  * Options for {@link GetAllQuery}.
+ *
+ * @public
  */
 export type GetAllQueryOptions<RowType = unknown> = {
     sql: string;
@@ -20,13 +22,15 @@ export type GetAllQueryOptions<RowType = unknown> = {
     mapper?: (rawRow: Record<string, unknown>) => RowType;
 };
 /**
- * Performs a {@link AbstractPowerSyncDatabase.getAll} operation for a watched query.
+ * Performs a {@link DBGetUtils.getAll} operation for a watched query.
+ *
+ * @public
  */
 export declare class GetAllQuery<RowType = unknown> implements WatchCompatibleQuery<RowType[]> {
     protected options: GetAllQueryOptions<RowType>;
     constructor(options: GetAllQueryOptions<RowType>);
     compile(): CompiledQuery;
     execute(options: {
-        db: AbstractPowerSyncDatabase;
+        db: CommonPowerSyncDatabase;
     }): Promise<RowType[]>;
 }

package/lib/client/watched/GetAllQuery.js

@@ -1,5 +1,7 @@
 /**
- * Performs a {@link AbstractPowerSyncDatabase.getAll} operation for a watched query.
+ * Performs a {@link DBGetUtils.getAll} operation for a watched query.
+ *
+ * @public
  */
 export class GetAllQuery {
     options;

package/lib/client/watched/GetAllQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"GetAllQuery.js","sourceRoot":"","sources":["../../../src/client/watched/GetAllQuery.ts"],"names":[],"mappings":"AAuBA;;GAEG;AACH,MAAM,OAAO,WAAW;IACA;IAAtB,YAAsB,OAAoC;QAApC,YAAO,GAAP,OAAO,CAA6B;IAAG,CAAC;IAE9D,OAAO;QACL,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;YACrB,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE;SAC1C,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAA0C;QACtD,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC;QACvB,MAAM,EAAE,GAAG,EAAE,UAAU,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAChD,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,MAAM,CAAU,GAAG,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;QACjE,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,SAAsB,CAAC;IAChC,CAAC;CACF"}
+{"version":3,"file":"GetAllQuery.js","sourceRoot":"","sources":["../../../src/client/watched/GetAllQuery.ts"],"names":[],"mappings":"AAyBA;;;;GAIG;AACH,MAAM,OAAO,WAAW;IACA;IAAtB,YAAsB,OAAoC;QAApC,YAAO,GAAP,OAAO,CAA6B;IAAG,CAAC;IAE9D,OAAO;QACL,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG;YACrB,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,EAAE;SAC1C,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAwC;QACpD,MAAM,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC;QACvB,MAAM,EAAE,GAAG,EAAE,UAAU,GAAG,EAAE,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAChD,MAAM,SAAS,GAAG,MAAM,EAAE,CAAC,MAAM,CAA0B,GAAG,EAAE,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;QACjF,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACxB,OAAO,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC5C,CAAC;QACD,OAAO,SAAsB,CAAC;IAChC,CAAC;CACF"}

package/lib/client/watched/WatchedQuery.d.ts

@@ -1,9 +1,11 @@
 import { CompiledQuery } from '../../types/types.js';
 import { BaseListener } from '../../utils/BaseObserver.js';
 import { MetaBaseObserverInterface } from '../../utils/MetaBaseObserver.js';
-import { AbstractPowerSyncDatabase } from '../AbstractPowerSyncDatabase.js';
+import { CommonPowerSyncDatabase } from '../CommonPowerSyncDatabase.js';
 /**
  * State for {@link WatchedQuery} instances.
+ *
+ * @public
  */
 export interface WatchedQueryState<Data> {
     /**
@@ -31,20 +33,25 @@ export interface WatchedQueryState<Data> {
 }
 /**
  * Options provided to the `execute` method of a {@link WatchCompatibleQuery}.
+ *
+ * @public
  */
 export interface WatchExecuteOptions {
     sql: string;
     parameters: any[];
-    db: AbstractPowerSyncDatabase;
+    db: CommonPowerSyncDatabase;
 }
 /**
- * Similar to {@link CompatibleQuery}, except the `execute` method
- * does not enforce an Array result type.
+ *
+ * @public
  */
 export interface WatchCompatibleQuery<ResultType> {
     execute(options: WatchExecuteOptions): Promise<ResultType>;
     compile(): CompiledQuery;
 }
+/**
+ * @public
+ */
 export interface WatchedQueryOptions {
     /** The minimum interval between queries. */
     throttleMs?: number;
@@ -61,6 +68,9 @@ export interface WatchedQueryOptions {
      */
     triggerOnTables?: string[];
 }
+/**
+ * @public
+ */
 export declare enum WatchedQueryListenerEvent {
     ON_DATA = "onData",
     ON_ERROR = "onError",
@@ -68,6 +78,9 @@ export declare enum WatchedQueryListenerEvent {
     SETTINGS_WILL_UPDATE = "settingsWillUpdate",
     CLOSED = "closed"
 }
+/**
+ * @public
+ */
 export interface WatchedQueryListener<Data> extends BaseListener {
     [WatchedQueryListenerEvent.ON_DATA]?: (data: Data) => void | Promise<void>;
     [WatchedQueryListenerEvent.ON_ERROR]?: (error: Error) => void | Promise<void>;
@@ -75,8 +88,9 @@ export interface WatchedQueryListener<Data> extends BaseListener {
     [WatchedQueryListenerEvent.SETTINGS_WILL_UPDATE]?: () => void;
     [WatchedQueryListenerEvent.CLOSED]?: () => void | Promise<void>;
 }
-export declare const DEFAULT_WATCH_THROTTLE_MS = 30;
-export declare const DEFAULT_WATCH_QUERY_OPTIONS: WatchedQueryOptions;
+/**
+ * @public
+ */
 export interface WatchedQuery<Data = unknown, Settings extends WatchedQueryOptions = WatchedQueryOptions, Listener extends WatchedQueryListener<Data> = WatchedQueryListener<Data>> extends MetaBaseObserverInterface<Listener> {
     /**
      * Current state of the watched query.

package/lib/client/watched/WatchedQuery.js

@@ -1,3 +1,6 @@
+/**
+ * @public
+ */
 export var WatchedQueryListenerEvent;
 (function (WatchedQueryListenerEvent) {
     WatchedQueryListenerEvent["ON_DATA"] = "onData";
@@ -6,9 +9,4 @@ export var WatchedQueryListenerEvent;
     WatchedQueryListenerEvent["SETTINGS_WILL_UPDATE"] = "settingsWillUpdate";
     WatchedQueryListenerEvent["CLOSED"] = "closed";
 })(WatchedQueryListenerEvent || (WatchedQueryListenerEvent = {}));
-export const DEFAULT_WATCH_THROTTLE_MS = 30;
-export const DEFAULT_WATCH_QUERY_OPTIONS = {
-    throttleMs: DEFAULT_WATCH_THROTTLE_MS,
-    reportFetching: true
-};
 //# sourceMappingURL=WatchedQuery.js.map

package/lib/client/watched/WatchedQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"WatchedQuery.js","sourceRoot":"","sources":["../../../src/client/watched/WatchedQuery.ts"],"names":[],"mappings":"AAqEA,MAAM,CAAN,IAAY,yBAMX;AAND,WAAY,yBAAyB;IACnC,+CAAkB,CAAA;IAClB,iDAAoB,CAAA;IACpB,8DAAiC,CAAA;IACjC,wEAA2C,CAAA;IAC3C,8CAAiB,CAAA;AACnB,CAAC,EANW,yBAAyB,KAAzB,yBAAyB,QAMpC;AAUD,MAAM,CAAC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AAE5C,MAAM,CAAC,MAAM,2BAA2B,GAAwB;IAC9D,UAAU,EAAE,yBAAyB;IACrC,cAAc,EAAE,IAAI;CACrB,CAAC"}
+{"version":3,"file":"WatchedQuery.js","sourceRoot":"","sources":["../../../src/client/watched/WatchedQuery.ts"],"names":[],"mappings":"AA4EA;;GAEG;AACH,MAAM,CAAN,IAAY,yBAMX;AAND,WAAY,yBAAyB;IACnC,+CAAkB,CAAA;IAClB,iDAAoB,CAAA;IACpB,8DAAiC,CAAA;IACjC,wEAA2C,CAAA;IAC3C,8CAAiB,CAAA;AACnB,CAAC,EANW,yBAAyB,KAAzB,yBAAyB,QAMpC"}

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

@@ -1,8 +1,9 @@
 import { WatchCompatibleQuery, WatchedQuery, WatchedQueryListener, WatchedQueryOptions } from '../WatchedQuery.js';
-import { AbstractQueryProcessor, AbstractQueryProcessorOptions, LinkQueryOptions } from './AbstractQueryProcessor.js';
 /**
  * Represents an updated row in a differential watched query.
  * It contains both the current and previous state of the row.
+ *
+ * @public
  */
 export interface WatchedQueryRowDifferential<RowType> {
     readonly current: RowType;
@@ -11,6 +12,8 @@ export interface WatchedQueryRowDifferential<RowType> {
 /**
  * Represents the result of a watched query that has been diffed.
  * {@link DifferentialWatchedQueryState#diff} is of the {@link WatchedQueryDifferential} form.
+ *
+ * @public
  */
 export interface WatchedQueryDifferential<RowType> {
     readonly added: ReadonlyArray<Readonly<RowType>>;
@@ -35,6 +38,8 @@ export interface WatchedQueryDifferential<RowType> {
 }
 /**
  * Row comparator for differentially watched queries which keys and compares items in the result set.
+ *
+ * @public
  */
 export interface DifferentialWatchedQueryComparator<RowType> {
     /**
@@ -48,6 +53,8 @@ export interface DifferentialWatchedQueryComparator<RowType> {
 }
 /**
  * Options for building a differential watched query with the {@link Query} builder.
+ *
+ * @public
  */
 export interface DifferentialWatchedQueryOptions<RowType> extends WatchedQueryOptions {
     /**
@@ -58,12 +65,13 @@ export interface DifferentialWatchedQueryOptions<RowType> extends WatchedQueryOp
      * Row comparator used to identify and compare rows in the result set.
      * If not provided, the default comparator will be used which keys items by their `id` property if available,
      * otherwise it uses JSON stringification of the entire item for keying and comparison.
-     * @defaultValue {@link DEFAULT_ROW_COMPARATOR}
      */
     rowComparator?: DifferentialWatchedQueryComparator<RowType>;
 }
 /**
  * Settings for differential incremental watched queries using.
+ *
+ * @public
  */
 export interface DifferentialWatchedQuerySettings<RowType> extends DifferentialWatchedQueryOptions<RowType> {
     /**
@@ -71,51 +79,13 @@ export interface DifferentialWatchedQuerySettings<RowType> extends DifferentialW
      */
     query: WatchCompatibleQuery<RowType[]>;
 }
-export interface DifferentialWatchedQueryListener<RowType> extends WatchedQueryListener<ReadonlyArray<Readonly<RowType>>> {
-    onDiff?: (diff: WatchedQueryDifferential<RowType>) => void | Promise<void>;
-}
-export type DifferentialWatchedQuery<RowType> = WatchedQuery<ReadonlyArray<Readonly<RowType>>, DifferentialWatchedQuerySettings<RowType>, DifferentialWatchedQueryListener<RowType>>;
 /**
- * @internal
+ * @public
  */
-export interface DifferentialQueryProcessorOptions<RowType> extends AbstractQueryProcessorOptions<RowType[], DifferentialWatchedQuerySettings<RowType>> {
-    rowComparator?: DifferentialWatchedQueryComparator<RowType>;
+export interface DifferentialWatchedQueryListener<RowType> extends WatchedQueryListener<ReadonlyArray<Readonly<RowType>>> {
+    onDiff?: (diff: WatchedQueryDifferential<RowType>) => void | Promise<void>;
 }
-type DataHashMap<RowType> = Map<string, {
-    hash: string;
-    item: RowType;
-}>;
 /**
- * An empty differential result set.
- * This is used as the initial state for differential incrementally watched queries.
+ * @public
  */
-export declare const EMPTY_DIFFERENTIAL: {
-    added: never[];
-    all: never[];
-    removed: never[];
-    updated: never[];
-    unchanged: never[];
-};
-/**
- * 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 declare const DEFAULT_ROW_COMPARATOR: DifferentialWatchedQueryComparator<any>;
-/**
- * Uses the PowerSync onChange event to trigger watched queries.
- * Results are emitted on every change of the relevant tables.
- * @internal
- */
-export declare class DifferentialQueryProcessor<RowType> extends AbstractQueryProcessor<ReadonlyArray<Readonly<RowType>>, DifferentialWatchedQuerySettings<RowType>> implements DifferentialWatchedQuery<RowType> {
-    protected options: DifferentialQueryProcessorOptions<RowType>;
-    protected comparator: DifferentialWatchedQueryComparator<RowType>;
-    constructor(options: DifferentialQueryProcessorOptions<RowType>);
-    protected differentiate(current: RowType[], previousMap: DataHashMap<RowType>): {
-        diff: WatchedQueryDifferential<RowType>;
-        map: DataHashMap<RowType>;
-        hasChanged: boolean;
-    };
-    protected linkQuery(options: LinkQueryOptions<WatchedQueryDifferential<RowType>>): Promise<void>;
-}
-export {};
+export type DifferentialWatchedQuery<RowType> = WatchedQuery<ReadonlyArray<Readonly<RowType>>, DifferentialWatchedQuerySettings<RowType>, DifferentialWatchedQueryListener<RowType>>;