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

package/lib/client/SQLOpenFactory.d.ts

@@ -1,4 +1,7 @@
 import { DBAdapter } from '../db/DBAdapter.js';
+/**
+ * @public
+ */
 export interface SQLOpenOptions {
     /**
      * Filename for the database.
@@ -22,6 +25,9 @@ export interface SQLOpenOptions {
      */
     debugMode?: boolean;
 }
+/**
+ * @public
+ */
 export interface SQLOpenFactory {
     /**
      * Opens a connection adapter to a SQLite DB
@@ -29,14 +35,42 @@ export interface SQLOpenFactory {
     openDB(): DBAdapter;
 }
 /**
- * Tests if the input is a {@link SQLOpenOptions}
+ * A source describing how to open databases.
+ *
+ * - A {@link DBAdapter} providing access to an opened SQLite connection pool.
+ * - A {@link SQLOpenFactory} which will be used to open a SQLite connection pool lazily.
+ * - A {@link SQLOpenOptions} for opening a SQLite connection with a default {@link SQLOpenFactory} for the current
+ *   platform.
+ *
+ * For most apps, using the `database` key with {@link SQLOpenOptions} is the easiest and recommended option.
+ *
+ * @public
  */
-export declare const isSQLOpenOptions: (test: any) => test is SQLOpenOptions;
-/**
- * Tests if input is a {@link SQLOpenFactory}
- */
-export declare const isSQLOpenFactory: (test: any) => test is SQLOpenFactory;
-/**
- * Tests if input is a {@link DBAdapter}
- */
-export declare const isDBAdapter: (test: any) => test is DBAdapter;
+export type DatabaseSource<OpenOptions extends SQLOpenOptions = SQLOpenOptions> = {
+    /**
+     * Wrap an opened {@link DBAdapter} as a PowerSync database instance.
+     *
+     * This is primarily useful for testing. On most platforms, PowerSync would open a pool of SQLite connections by
+     * default. This option allows using a single in-memory instance instead. It can also be used to customize the
+     * database used by default, e.g. to install additional logging on SQL statements by intercepting methods.
+     */
+    opened: DBAdapter;
+} | {
+    /**
+     * Construct a PowerSync database that will call {@link SQLOpenFactory.openDB} when opened.
+     *
+     * On most SDKs, passing {@link SQLOpenOptions} is a better option. An exception is React Native, where using an
+     * [OP-SQLite factory](https://docs.powersync.com/client-sdks/reference/react-native-and-expo#op-sqlite) is
+     * recommended.
+     */
+    factory: SQLOpenFactory;
+} | {
+    /**
+     * Construct a PowerSync database opening a connection pool from the {@link SQLOpenOptions}.
+     *
+     * At the very least, options include the {@link SQLOpenOptions.dbFilename} to open. Depending on the PowerSync
+     * SDK used, additional options are available. For example, the web SDK allows configuring the virtual file system
+     * implementation used to persist files on the web too.
+     */
+    database: OpenOptions;
+};

package/lib/client/SQLOpenFactory.js

@@ -1,20 +1,2 @@
-/**
- * Tests if the input is a {@link SQLOpenOptions}
- */
-export const isSQLOpenOptions = (test) => {
-    // typeof null is `object`, but you cannot use the `in` operator on `null.
-    return test && typeof test == 'object' && 'dbFilename' in test;
-};
-/**
- * Tests if input is a {@link SQLOpenFactory}
- */
-export const isSQLOpenFactory = (test) => {
-    return typeof test?.openDB == 'function';
-};
-/**
- * Tests if input is a {@link DBAdapter}
- */
-export const isDBAdapter = (test) => {
-    return typeof test?.writeTransaction == 'function';
-};
+export {};
 //# sourceMappingURL=SQLOpenFactory.js.map

package/lib/client/SQLOpenFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"SQLOpenFactory.js","sourceRoot":"","sources":["../../src/client/SQLOpenFactory.ts"],"names":[],"mappings":"AAkCA;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAS,EAA0B,EAAE;IACpE,0EAA0E;IAC1E,OAAO,IAAI,IAAI,OAAO,IAAI,IAAI,QAAQ,IAAI,YAAY,IAAI,IAAI,CAAC;AACjE,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,IAAS,EAA0B,EAAE;IACpE,OAAO,OAAO,IAAI,EAAE,MAAM,IAAI,UAAU,CAAC;AAC3C,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAS,EAAqB,EAAE;IAC1D,OAAO,OAAO,IAAI,EAAE,gBAAgB,IAAI,UAAU,CAAC;AACrD,CAAC,CAAC"}
+{"version":3,"file":"SQLOpenFactory.js","sourceRoot":"","sources":["../../src/client/SQLOpenFactory.ts"],"names":[],"mappings":""}

package/lib/client/compilableQueryWatch.d.ts

@@ -1,7 +1,13 @@
 import { CompilableQuery } from './../types/types.js';
-import { AbstractPowerSyncDatabase, SQLWatchOptions } from './AbstractPowerSyncDatabase.js';
+import { CommonPowerSyncDatabase, SQLWatchOptions } from './CommonPowerSyncDatabase.js';
+/**
+ * @public
+ */
 export interface CompilableQueryWatchHandler<T> {
     onResult: (results: T[]) => void;
     onError?: (error: Error) => void;
 }
-export declare function compilableQueryWatch<T>(db: AbstractPowerSyncDatabase, query: CompilableQuery<T>, handler: CompilableQueryWatchHandler<T>, options?: SQLWatchOptions): void;
+/**
+ * @public
+ */
+export declare function compilableQueryWatch<T>(db: CommonPowerSyncDatabase, query: CompilableQuery<T>, handler: CompilableQueryWatchHandler<T>, options?: SQLWatchOptions): void;

package/lib/client/compilableQueryWatch.js

@@ -1,4 +1,7 @@
 import { runOnSchemaChange } from './runOnSchemaChange.js';
+/**
+ * @public
+ */
 export function compilableQueryWatch(db, query, handler, options) {
     const { onResult, onError = (e) => { } } = handler ?? {};
     if (!onResult) {
@@ -20,8 +23,7 @@ export function compilableQueryWatch(db, query, handler, options) {
                     catch (error) {
                         onError(error);
                     }
-                },
-                onError
+                }
             }, {
                 ...(options ?? {}),
                 tables: resolvedTables,

package/lib/client/compilableQueryWatch.js.map

@@ -1 +1 @@
-{"version":3,"file":"compilableQueryWatch.js","sourceRoot":"","sources":["../../src/client/compilableQueryWatch.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAO3D,MAAM,UAAU,oBAAoB,CAClC,EAA6B,EAC7B,KAAyB,EACzB,OAAuC,EACvC,OAAyB;IAEzB,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,CAAC,CAAQ,EAAE,EAAE,GAAE,CAAC,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAC/D,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,UAAU,GAAG,KAAK,EAAE,WAAwB,EAAE,EAAE;QACpD,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,cAAc,GAAG,MAAM,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,UAAgB,EAAE,OAAO,CAAC,CAAC;YAE1F,qBAAqB;YACrB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;YACrC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAEjB,EAAE,CAAC,oBAAoB,CACrB;gBACE,QAAQ,EAAE,KAAK,IAAI,EAAE;oBACnB,IAAI,CAAC;wBACH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;wBACrC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBACnB,CAAC;oBAAC,OAAO,KAAU,EAAE,CAAC;wBACpB,OAAO,CAAC,KAAK,CAAC,CAAC;oBACjB,CAAC;gBACH,CAAC;gBACD,OAAO;aACR,EACD;gBACE,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;gBAClB,MAAM,EAAE,cAAc;gBACtB,kDAAkD;gBAClD,MAAM,EAAE,WAAW;aACpB,CACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEF,iBAAiB,CAAC,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;AAC7C,CAAC"}
+{"version":3,"file":"compilableQueryWatch.js","sourceRoot":"","sources":["../../src/client/compilableQueryWatch.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAU3D;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAClC,EAA2B,EAC3B,KAAyB,EACzB,OAAuC,EACvC,OAAyB;IAEzB,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,CAAC,CAAQ,EAAE,EAAE,GAAE,CAAC,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAC/D,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,UAAU,GAAG,KAAK,EAAE,WAAwB,EAAE,EAAE;QACpD,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,cAAc,GAAG,MAAM,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,UAAgB,EAAE,OAAO,CAAC,CAAC;YAE1F,qBAAqB;YACrB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;YACrC,QAAQ,CAAC,MAAM,CAAC,CAAC;YAEjB,EAAE,CAAC,oBAAoB,CACrB;gBACE,QAAQ,EAAE,KAAK,IAAI,EAAE;oBACnB,IAAI,CAAC;wBACH,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;wBACrC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBACnB,CAAC;oBAAC,OAAO,KAAU,EAAE,CAAC;wBACpB,OAAO,CAAC,KAAK,CAAC,CAAC;oBACjB,CAAC;gBACH,CAAC;aACF,EACD;gBACE,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC;gBAClB,MAAM,EAAE,cAAc;gBACtB,kDAAkD;gBAClD,MAAM,EAAE,WAAW;aACpB,CACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEF,iBAAiB,CAAC,UAAU,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;AAC7C,CAAC"}

package/lib/client/connection/PowerSyncBackendConnector.d.ts

@@ -1,5 +1,8 @@
 import { PowerSyncCredentials } from './PowerSyncCredentials.js';
-import type { AbstractPowerSyncDatabase } from '../AbstractPowerSyncDatabase.js';
+import { CommonPowerSyncDatabase } from '../CommonPowerSyncDatabase.js';
+/**
+ * @public
+ */
 export interface PowerSyncBackendConnector {
     /** Allows the PowerSync client to retrieve an authentication token from your backend
      * which is used to authenticate against the PowerSync service.
@@ -15,9 +18,9 @@ export interface PowerSyncBackendConnector {
     fetchCredentials: () => Promise<PowerSyncCredentials | null>;
     /** Upload local changes to the app backend.
      *
-     * Use {@link AbstractPowerSyncDatabase.getCrudBatch} to get a batch of changes to upload.
+     * Use {@link CommonPowerSyncDatabase.getCrudBatch} to get a batch of changes to upload.
      *
      * Any thrown errors will result in a retry after the configured wait period (default: 5 seconds).
      */
-    uploadData: (database: AbstractPowerSyncDatabase) => Promise<void>;
+    uploadData: (database: CommonPowerSyncDatabase) => Promise<void>;
 }

package/lib/client/connection/PowerSyncCredentials.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @public
+ */
 export interface PowerSyncCredentials {
     endpoint: string;
     token: string;

package/lib/client/runOnSchemaChange.d.ts

@@ -1,2 +1,5 @@
-import { AbstractPowerSyncDatabase, SQLWatchOptions } from './AbstractPowerSyncDatabase.js';
-export declare function runOnSchemaChange(callback: (signal: AbortSignal) => void, db: AbstractPowerSyncDatabase, options?: SQLWatchOptions): void;
+import { CommonPowerSyncDatabase, SQLWatchOptions } from './CommonPowerSyncDatabase.js';
+/**
+ * @internal
+ */
+export declare function runOnSchemaChange(callback: (signal: AbortSignal) => void, db: CommonPowerSyncDatabase, options?: SQLWatchOptions): void;

package/lib/client/runOnSchemaChange.js

@@ -1,3 +1,6 @@
+/**
+ * @internal
+ */
 export function runOnSchemaChange(callback, db, options) {
     const triggerWatchedQuery = () => {
         const abortController = new AbortController();

package/lib/client/runOnSchemaChange.js.map

@@ -1 +1 @@
-{"version":3,"file":"runOnSchemaChange.js","sourceRoot":"","sources":["../../src/client/runOnSchemaChange.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,iBAAiB,CAC/B,QAAuC,EACvC,EAA6B,EAC7B,OAAyB;IAEzB,MAAM,mBAAmB,GAAG,GAAG,EAAE;QAC/B,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;QAC9C,IAAI,qBAAqB,GAAwB,IAAI,CAAC;QACtD,MAAM,YAAY,GAAG,GAAG,EAAE;YACxB,eAAe,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACzC,qBAAqB,EAAE,EAAE,CAAC;YAC1B,qBAAqB,GAAG,IAAI,CAAC;YAC7B,kDAAkD;YAClD,OAAO,EAAE,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAC9D,CAAC,CAAC;QAEF,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACzD,qBAAqB,GAAG,EAAE,CAAC,gBAAgB,CAAC;YAC1C,aAAa,EAAE,KAAK,IAAI,EAAE;gBACxB,YAAY,EAAE,CAAC;gBACf,yIAAyI;gBACzI,UAAU,CAAC,GAAG,EAAE,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC,CAAC;YAC7C,CAAC;SACF,CAAC,CAAC;QACH,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,mBAAmB,EAAE,CAAC;AACxB,CAAC"}
+{"version":3,"file":"runOnSchemaChange.js","sourceRoot":"","sources":["../../src/client/runOnSchemaChange.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAC/B,QAAuC,EACvC,EAA2B,EAC3B,OAAyB;IAEzB,MAAM,mBAAmB,GAAG,GAAG,EAAE;QAC/B,MAAM,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;QAC9C,IAAI,qBAAqB,GAAwB,IAAI,CAAC;QACtD,MAAM,YAAY,GAAG,GAAG,EAAE;YACxB,eAAe,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;YACzC,qBAAqB,EAAE,EAAE,CAAC;YAC1B,qBAAqB,GAAG,IAAI,CAAC;YAC7B,kDAAkD;YAClD,OAAO,EAAE,MAAM,EAAE,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QAC9D,CAAC,CAAC;QAEF,OAAO,EAAE,MAAM,EAAE,gBAAgB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACzD,qBAAqB,GAAG,EAAE,CAAC,gBAAgB,CAAC;YAC1C,aAAa,EAAE,KAAK,IAAI,EAAE;gBACxB,YAAY,EAAE,CAAC;gBACf,yIAAyI;gBACzI,UAAU,CAAC,GAAG,EAAE,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC,CAAC;YAC7C,CAAC;SACF,CAAC,CAAC;QACH,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC,CAAC;IAEF,mBAAmB,EAAE,CAAC;AACxB,CAAC"}

package/lib/client/sync/bucket/CrudBatch.d.ts

@@ -1,6 +1,8 @@
 import { CrudEntry } from './CrudEntry.js';
 /**
  * A batch of client-side changes.
+ *
+ * @public
  */
 export declare class CrudBatch {
     /**

package/lib/client/sync/bucket/CrudBatch.js

@@ -1,5 +1,7 @@
 /**
  * A batch of client-side changes.
+ *
+ * @public
  */
 export class CrudBatch {
     crud;

package/lib/client/sync/bucket/CrudBatch.js.map

@@ -1 +1 @@
-{"version":3,"file":"CrudBatch.js","sourceRoot":"","sources":["../../../../src/client/sync/bucket/CrudBatch.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,SAAS;IAKX;IAIA;IAIA;IAZT;IACE;;OAEG;IACI,IAAiB;IACxB;;OAEG;IACI,QAAiB;IACxB;;OAEG;IACI,QAAqD;QARrD,SAAI,GAAJ,IAAI,CAAa;QAIjB,aAAQ,GAAR,QAAQ,CAAS;QAIjB,aAAQ,GAAR,QAAQ,CAA6C;IAC3D,CAAC;CACL"}
+{"version":3,"file":"CrudBatch.js","sourceRoot":"","sources":["../../../../src/client/sync/bucket/CrudBatch.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,MAAM,OAAO,SAAS;IAKX;IAIA;IAIA;IAZT;IACE;;OAEG;IACI,IAAiB;IACxB;;OAEG;IACI,QAAiB;IACxB;;OAEG;IACI,QAAqD;QARrD,SAAI,GAAJ,IAAI,CAAa;QAIjB,aAAQ,GAAR,QAAQ,CAAS;QAIjB,aAAQ,GAAR,QAAQ,CAA6C;IAC3D,CAAC;CACL"}

package/lib/client/sync/bucket/CrudEntry.d.ts

@@ -2,10 +2,14 @@
  * 64-bit unsigned integer stored as a string in base-10.
  *
  * Not sortable as a string.
+ *
+ * @public
  */
 export type OpId = string;
 /**
  * Type of local change.
+ *
+ * @public
  */
 export declare enum UpdateType {
     /** Insert or replace existing row. All non-null columns are included in the data. Generated by INSERT statements. */
@@ -15,28 +19,12 @@ export declare enum UpdateType {
     /** Delete existing row. Contains the id. Generated by DELETE statements. */
     DELETE = "DELETE"
 }
-export type CrudEntryJSON = {
-    id: string;
-    data: string;
-    tx_id?: number;
-};
-/**
- * The output JSON seems to be a third type of JSON, not the same as the input JSON.
- */
-type CrudEntryOutputJSON = {
-    op_id: number;
-    op: UpdateType;
-    type: string;
-    id: string;
-    tx_id?: number;
-    data?: Record<string, any>;
-    old?: Record<string, any>;
-    metadata?: string;
-};
 /**
  * A single client-side change.
+ *
+ * @public
  */
-export declare class CrudEntry {
+export interface CrudEntry {
     /**
      * Auto-incrementing client-side id.
      */
@@ -73,23 +61,13 @@ export declare class CrudEntry {
      * and the insert or update statement set the `_metadata` column.
      */
     metadata?: string;
-    static fromRow(dbRow: CrudEntryJSON): CrudEntry;
-    constructor(clientId: number, op: UpdateType, table: string, id: string, transactionId?: number, opData?: Record<string, any>, previousValues?: Record<string, any>, metadata?: string);
     /**
      * Converts the change to JSON format.
      */
-    toJSON(): CrudEntryOutputJSON;
+    toJSON(): unknown;
     equals(entry: CrudEntry): boolean;
-    /**
-     * The hash code for this object.
-     * @deprecated This should not be necessary in the JS SDK.
-     * Use the  @see CrudEntry#equals method instead.
-     * TODO remove in the next major release.
-     */
-    hashCode(): string;
     /**
      * Generates an array for use in deep comparison operations
      */
-    toComparisonArray(): (string | number | Record<string, any> | undefined)[];
+    toComparisonArray(): unknown[];
 }
-export {};

package/lib/client/sync/bucket/CrudEntry.js

@@ -1,5 +1,7 @@
 /**
  * Type of local change.
+ *
+ * @public
  */
 export var UpdateType;
 (function (UpdateType) {
@@ -10,101 +12,4 @@ export var UpdateType;
     /** Delete existing row. Contains the id. Generated by DELETE statements. */
     UpdateType["DELETE"] = "DELETE";
 })(UpdateType || (UpdateType = {}));
-/**
- * A single client-side change.
- */
-export class CrudEntry {
-    /**
-     * Auto-incrementing client-side id.
-     */
-    clientId;
-    /**
-     * ID of the changed row.
-     */
-    id;
-    /**
-     * Type of change.
-     */
-    op;
-    /**
-     * Data associated with the change.
-     */
-    opData;
-    /**
-     * For tables where the `trackPreviousValues` option has been enabled, this tracks previous values for
-     * `UPDATE` and `DELETE` statements.
-     */
-    previousValues;
-    /**
-     * Table that contained the change.
-     */
-    table;
-    /**
-     * Auto-incrementing transaction id. This is the same for all operations within the same transaction.
-     */
-    transactionId;
-    /**
-     * Client-side metadata attached with this write.
-     *
-     * This field is only available when the `trackMetadata` option was set to `true` when creating a table
-     * and the insert or update statement set the `_metadata` column.
-     */
-    metadata;
-    static fromRow(dbRow) {
-        const data = JSON.parse(dbRow.data);
-        return new CrudEntry(parseInt(dbRow.id), data.op, data.type, data.id, dbRow.tx_id, data.data, data.old, data.metadata);
-    }
-    constructor(clientId, op, table, id, transactionId, opData, previousValues, metadata) {
-        this.clientId = clientId;
-        this.id = id;
-        this.op = op;
-        this.opData = opData;
-        this.table = table;
-        this.transactionId = transactionId;
-        this.previousValues = previousValues;
-        this.metadata = metadata;
-    }
-    /**
-     * Converts the change to JSON format.
-     */
-    toJSON() {
-        return {
-            op_id: this.clientId,
-            op: this.op,
-            type: this.table,
-            id: this.id,
-            tx_id: this.transactionId,
-            data: this.opData,
-            old: this.previousValues,
-            metadata: this.metadata
-        };
-    }
-    equals(entry) {
-        return JSON.stringify(this.toComparisonArray()) == JSON.stringify(entry.toComparisonArray());
-    }
-    /**
-     * The hash code for this object.
-     * @deprecated This should not be necessary in the JS SDK.
-     * Use the  @see CrudEntry#equals method instead.
-     * TODO remove in the next major release.
-     */
-    hashCode() {
-        return JSON.stringify(this.toComparisonArray());
-    }
-    /**
-     * Generates an array for use in deep comparison operations
-     */
-    toComparisonArray() {
-        return [
-            this.transactionId,
-            this.clientId,
-            this.op,
-            this.table,
-            this.id,
-            this.opData,
-            this.previousValues,
-            this.metadata
-        ];
-    }
-}
 //# sourceMappingURL=CrudEntry.js.map

package/lib/client/sync/bucket/CrudEntry.js.map

@@ -1 +1 @@
-{"version":3,"file":"CrudEntry.js","sourceRoot":"","sources":["../../../../src/client/sync/bucket/CrudEntry.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,qHAAqH;IACrH,yBAAW,CAAA;IACX,8GAA8G;IAC9G,6BAAe,CAAA;IACf,4EAA4E;IAC5E,+BAAiB,CAAA;AACnB,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB;AA+BD;;GAEG;AACH,MAAM,OAAO,SAAS;IACpB;;OAEG;IACH,QAAQ,CAAS;IACjB;;OAEG;IACH,EAAE,CAAS;IACX;;OAEG;IACH,EAAE,CAAa;IACf;;OAEG;IACH,MAAM,CAAuB;IAE7B;;;OAGG;IACH,cAAc,CAAuB;IAErC;;OAEG;IACH,KAAK,CAAS;IACd;;OAEG;IACH,aAAa,CAAU;IAEvB;;;;;OAKG;IACH,QAAQ,CAAU;IAElB,MAAM,CAAC,OAAO,CAAC,KAAoB;QACjC,MAAM,IAAI,GAAsB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvD,OAAO,IAAI,SAAS,CAClB,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,EAClB,IAAI,CAAC,EAAE,EACP,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,EAAE,EACP,KAAK,CAAC,KAAK,EACX,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,QAAQ,CACd,CAAC;IACJ,CAAC;IAED,YACE,QAAgB,EAChB,EAAc,EACd,KAAa,EACb,EAAU,EACV,aAAsB,EACtB,MAA4B,EAC5B,cAAoC,EACpC,QAAiB;QAEjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC;QACb,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,QAAQ;YACpB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,KAAK,EAAE,IAAI,CAAC,aAAa;YACzB,IAAI,EAAE,IAAI,CAAC,MAAM;YACjB,GAAG,EAAE,IAAI,CAAC,cAAc;YACxB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,KAAgB;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;OAKG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO;YACL,IAAI,CAAC,aAAa;YAClB,IAAI,CAAC,QAAQ;YACb,IAAI,CAAC,EAAE;YACP,IAAI,CAAC,KAAK;YACV,IAAI,CAAC,EAAE;YACP,IAAI,CAAC,MAAM;YACX,IAAI,CAAC,cAAc;YACnB,IAAI,CAAC,QAAQ;SACd,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"CrudEntry.js","sourceRoot":"","sources":["../../../../src/client/sync/bucket/CrudEntry.ts"],"names":[],"mappings":"AASA;;;;GAIG;AACH,MAAM,CAAN,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,qHAAqH;IACrH,yBAAW,CAAA;IACX,8GAA8G;IAC9G,6BAAe,CAAA;IACf,4EAA4E;IAC5E,+BAAiB,CAAA;AACnB,CAAC,EAPW,UAAU,KAAV,UAAU,QAOrB"}

package/lib/client/sync/bucket/CrudTransaction.d.ts

@@ -1,5 +1,8 @@
 import { CrudBatch } from './CrudBatch.js';
 import { CrudEntry } from './CrudEntry.js';
+/**
+ * @public
+ */
 export declare class CrudTransaction extends CrudBatch {
     /**
      * List of client-side changes.

package/lib/client/sync/bucket/CrudTransaction.js

@@ -1,4 +1,7 @@
 import { CrudBatch } from './CrudBatch.js';
+/**
+ * @public
+ */
 export class CrudTransaction extends CrudBatch {
     crud;
     complete;

package/lib/client/sync/bucket/CrudTransaction.js.map

@@ -1 +1 @@
-{"version":3,"file":"CrudTransaction.js","sourceRoot":"","sources":["../../../../src/client/sync/bucket/CrudTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAKnC;IAIA;IAIA;IAZT;IACE;;OAEG;IACI,IAAiB;IACxB;;OAEG;IACI,QAAgD;IACvD;;OAEG;IACI,aAAsB;QAE7B,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QAVtB,SAAI,GAAJ,IAAI,CAAa;QAIjB,aAAQ,GAAR,QAAQ,CAAwC;QAIhD,kBAAa,GAAb,aAAa,CAAS;IAG/B,CAAC;CACF"}
+{"version":3,"file":"CrudTransaction.js","sourceRoot":"","sources":["../../../../src/client/sync/bucket/CrudTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,SAAS;IAKnC;IAIA;IAIA;IAZT;IACE;;OAEG;IACI,IAAiB;IACxB;;OAEG;IACI,QAAgD;IACvD;;OAEG;IACI,aAAsB;QAE7B,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QAVtB,SAAI,GAAJ,IAAI,CAAa;QAIjB,aAAQ,GAAR,QAAQ,CAAwC;QAIhD,kBAAa,GAAb,aAAa,CAAS;IAG/B,CAAC;CACF"}

package/lib/client/sync/options.d.ts

@@ -0,0 +1,65 @@
+import { StreamingSyncRequestParameterType } from './stream/JsonValue.js';
+/**
+ * Options that affect how the PowerSync SDK connects to the PowerSync Service.
+ *
+ * @public
+ */
+export interface SyncOptions {
+    /**
+     * A set of metadata to be included in service logs.
+     */
+    appMetadata?: Record<string, string>;
+    /**
+     * These parameters are passed to the sync rules, and will be available under the`user_parameters` object.
+     */
+    params?: Record<string, StreamingSyncRequestParameterType>;
+    /**
+     * The connection method to use when streaming updates from
+     * the PowerSync backend instance.
+     *
+     * The default value is SDK-specific. {@link SyncStreamConnectionMethod.HTTP} is the preferred implementation and used
+     * by default, except for React Native apps without Expo. Those don't support streaming HTTP responses, which is why
+     * {@link SyncStreamConnectionMethod.WEB_SOCKET} is used as a workaround.
+     */
+    connectionMethod?: SyncStreamConnectionMethod;
+    fetchStrategy?: FetchStrategy;
+    /**
+     * Whether to include streams that have `auto_subscribe: true` in their definition.
+     *
+     * This defaults to `true`.
+     */
+    includeDefaultStreams?: boolean;
+    /**
+     * Delay for retrying sync streaming operations
+     * from the PowerSync backend after an error occurs.
+     */
+    retryDelayMs?: number;
+    /**
+     * Backend Connector CRUD operations are throttled
+     * to occur at most every `crudUploadThrottleMs`
+     * milliseconds.
+     */
+    crudUploadThrottleMs?: number;
+}
+/**
+ * @public
+ */
+export declare enum SyncStreamConnectionMethod {
+    HTTP = "http",
+    WEB_SOCKET = "web-socket"
+}
+/**
+ * @public
+ */
+export declare enum FetchStrategy {
+    /**
+     * Queues multiple sync events before processing, reducing round-trips.
+     * This comes at the cost of more processing overhead, which may cause ACK timeouts on older/weaker devices for big enough datasets.
+     */
+    Buffered = "buffered",
+    /**
+     * Processes each sync event immediately before requesting the next.
+     * This reduces processing overhead and improves real-time responsiveness.
+     */
+    Sequential = "sequential"
+}

package/lib/client/sync/options.js

@@ -0,0 +1,25 @@
+/**
+ * @public
+ */
+export var SyncStreamConnectionMethod;
+(function (SyncStreamConnectionMethod) {
+    SyncStreamConnectionMethod["HTTP"] = "http";
+    SyncStreamConnectionMethod["WEB_SOCKET"] = "web-socket";
+})(SyncStreamConnectionMethod || (SyncStreamConnectionMethod = {}));
+/**
+ * @public
+ */
+export var FetchStrategy;
+(function (FetchStrategy) {
+    /**
+     * Queues multiple sync events before processing, reducing round-trips.
+     * This comes at the cost of more processing overhead, which may cause ACK timeouts on older/weaker devices for big enough datasets.
+     */
+    FetchStrategy["Buffered"] = "buffered";
+    /**
+     * Processes each sync event immediately before requesting the next.
+     * This reduces processing overhead and improves real-time responsiveness.
+     */
+    FetchStrategy["Sequential"] = "sequential";
+})(FetchStrategy || (FetchStrategy = {}));
+//# sourceMappingURL=options.js.map

package/lib/client/sync/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/client/sync/options.ts"],"names":[],"mappings":"AAqDA;;GAEG;AACH,MAAM,CAAN,IAAY,0BAGX;AAHD,WAAY,0BAA0B;IACpC,2CAAa,CAAA;IACb,uDAAyB,CAAA;AAC3B,CAAC,EAHW,0BAA0B,KAA1B,0BAA0B,QAGrC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB;;;OAGG;IACH,sCAAqB,CAAA;IAErB;;;OAGG;IACH,0CAAyB,CAAA;AAC3B,CAAC,EAZW,aAAa,KAAb,aAAa,QAYxB"}

package/lib/client/sync/stream/JsonValue.d.ts

@@ -3,5 +3,8 @@ interface JSONObject {
     [key: string]: JSONValue;
 }
 type JSONArray = JSONValue[];
+/**
+ * @public
+ */
 export type StreamingSyncRequestParameterType = JSONValue;
 export {};

package/lib/client/sync/sync-streams.d.ts

@@ -1,5 +1,8 @@
 /**
- * A description of a sync stream, consisting of its {@link name} and the {@link parameters} used when subscribing.
+ * A description of a sync stream, consisting of its {@link SyncStreamDescription.name} and the
+ * {@link SyncStreamDescription.parameters} used when subscribing.
+ *
+ * @public
  */
 export interface SyncStreamDescription {
     /**
@@ -17,6 +20,8 @@ export interface SyncStreamDescription {
  * Information about a subscribed sync stream.
  *
  * This includes the {@link SyncStreamDescription}, along with information about the current sync status.
+ *
+ * @public
  */
 export interface SyncSubscriptionDescription extends SyncStreamDescription {
     active: boolean;
@@ -24,15 +29,17 @@ export interface SyncSubscriptionDescription extends SyncStreamDescription {
      * Whether this stream subscription is included by default, regardless of whether the stream has explicitly been
      * subscribed to or not.
      *
-     * It's possible for both {@link isDefault} and {@link hasExplicitSubscription} to be true at the same time - this
-     * happens when a default stream was subscribed explicitly.
+     * It's possible for both {@link SyncSubscriptionDescription.isDefault} and
+     * {@link SyncSubscriptionDescription.hasExplicitSubscription} to be true at the same time - this happens when a
+     * default stream was subscribed explicitly.
      */
     isDefault: boolean;
     /**
      * Whether this stream has been subscribed to explicitly.
      *
-     * It's possible for both {@link isDefault} and {@link hasExplicitSubscription} to be true at the same time - this
-     * happens when a default stream was subscribed explicitly.
+     * It's possible for both {@link SyncSubscriptionDescription.isDefault} and
+     * {@link SyncSubscriptionDescription.hasExplicitSubscription} to be true at the same time - this happens when a
+     * default stream was subscribed explicitly.
      */
     hasExplicitSubscription: boolean;
     /**
@@ -45,10 +52,13 @@ export interface SyncSubscriptionDescription extends SyncStreamDescription {
      */
     hasSynced: boolean;
     /**
-     * If {@link hasSynced} is true, the last time data from this stream has been synced.
+     * If {@link SyncSubscriptionDescription.hasSynced} is true, the last time data from this stream has been synced.
      */
     lastSyncedAt: Date | null;
 }
+/**
+ * @public
+ */
 export interface SyncStreamSubscribeOptions {
     /**
      * A "time to live" for this stream subscription, in seconds.
@@ -67,7 +77,9 @@ export interface SyncStreamSubscribeOptions {
 /**
  * A handle to a {@link SyncStreamDescription} that allows subscribing to the stream.
  *
- * To obtain an instance of {@link SyncStream}, call {@link AbstractPowerSyncDatabase.syncStream}.
+ * To obtain an instance of {@link SyncStream}, call {@link CommonPowerSyncDatabase.syncStream}.
+ *
+ * @public
  */
 export interface SyncStream extends SyncStreamDescription {
     /**
@@ -76,7 +88,7 @@ export interface SyncStream extends SyncStreamDescription {
      * You should keep a reference to the returned {@link SyncStreamSubscription} object along as you need data for that
      * stream. As soon as {@link SyncStreamSubscription.unsubscribe} is called for all subscriptions on this stream
      * (including subscriptions created on other tabs), the {@link SyncStreamSubscribeOptions.ttl} starts ticking and will
-     * eventually evict the stream (unless {@link subscribe} is called again).
+     * eventually evict the stream (unless {@link SyncStream.subscribe} is called again).
      */
     subscribe(options?: SyncStreamSubscribeOptions): Promise<SyncStreamSubscription>;
     /**
@@ -86,6 +98,9 @@ export interface SyncStream extends SyncStreamDescription {
      */
     unsubscribeAll(): Promise<void>;
 }
+/**
+ * @public
+ */
 export interface SyncStreamSubscription extends SyncStreamDescription {
     /**
      * A promise that resolves once data from in this sync stream has been synced and applied.