@powersync/common 1.6.1

package/lib/client/AbstractPowerSyncOpenFactory.d.ts

@@ -0,0 +1,29 @@
+import { DBAdapter } from '../db/DBAdapter';
+import { Schema } from '../db/schema/Schema';
+import { AbstractPowerSyncDatabase, PowerSyncDatabaseOptions } from './AbstractPowerSyncDatabase';
+export interface PowerSyncOpenFactoryOptions extends Partial<PowerSyncDatabaseOptions> {
+    /** Schema used for the local database. */
+    schema: Schema;
+    /**
+     * Filename for the database.
+     */
+    dbFilename: string;
+    /**
+     * Directory where the database file is located.
+     */
+    dbLocation?: string;
+}
+export declare abstract class AbstractPowerSyncDatabaseOpenFactory {
+    protected options: PowerSyncOpenFactoryOptions;
+    constructor(options: PowerSyncOpenFactoryOptions);
+    /**
+     * Schema used for the local database.
+     */
+    get schema(): Schema<{
+        [x: string]: import("..").TableV2<any>;
+    }>;
+    protected abstract openDB(): DBAdapter;
+    generateOptions(): PowerSyncDatabaseOptions;
+    abstract generateInstance(options: PowerSyncDatabaseOptions): AbstractPowerSyncDatabase;
+    getInstance(): AbstractPowerSyncDatabase;
+}

package/lib/client/AbstractPowerSyncOpenFactory.js

@@ -0,0 +1,25 @@
+import Logger from 'js-logger';
+export class AbstractPowerSyncDatabaseOpenFactory {
+    options;
+    constructor(options) {
+        this.options = options;
+        options.logger = options.logger ?? Logger.get(`PowerSync ${this.options.dbFilename}`);
+    }
+    /**
+     * Schema used for the local database.
+     */
+    get schema() {
+        return this.options.schema;
+    }
+    generateOptions() {
+        return {
+            database: this.openDB(),
+            ...this.options
+        };
+    }
+    getInstance() {
+        const options = this.generateOptions();
+        return this.generateInstance(options);
+    }
+}
+//# sourceMappingURL=AbstractPowerSyncOpenFactory.js.map

package/lib/client/AbstractPowerSyncOpenFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractPowerSyncOpenFactory.js","sourceRoot":"","sources":["../../src/client/AbstractPowerSyncOpenFactory.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,WAAW,CAAC;AAkB/B,MAAM,OAAgB,oCAAoC;IAClC;IAAtB,YAAsB,OAAoC;QAApC,YAAO,GAAP,OAAO,CAA6B;QACxD,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,MAAM,CAAC,GAAG,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC7B,CAAC;IAID,eAAe;QACb,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE;YACvB,GAAG,IAAI,CAAC,OAAO;SAChB,CAAC;IACJ,CAAC;IAID,WAAW;QACT,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACvC,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;CACF"}

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

@@ -0,0 +1,23 @@
+import { PowerSyncCredentials } from './PowerSyncCredentials';
+import type { AbstractPowerSyncDatabase } from '../AbstractPowerSyncDatabase';
+export interface PowerSyncBackendConnector {
+    /** Allows the PowerSync client to retrieve an authentication token from your backend
+     * which is used to authenticate against the PowerSync service.
+     *
+     * This should always fetch a fresh set of credentials - don't use cached
+     * values.
+     *
+     * Return null if the user is not signed in. Throw an error if credentials
+     * cannot be fetched due to a network error or other temporary error.
+     *
+     * This token is kept for the duration of a sync connection.
+     */
+    fetchCredentials: () => Promise<PowerSyncCredentials | null>;
+    /** Upload local changes to the app backend.
+     *
+     * Use {@link AbstractPowerSyncDatabase.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>;
+}

package/lib/client/connection/PowerSyncBackendConnector.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=PowerSyncBackendConnector.js.map

package/lib/client/connection/PowerSyncBackendConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PowerSyncBackendConnector.js","sourceRoot":"","sources":["../../../src/client/connection/PowerSyncBackendConnector.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,5 @@
+export interface PowerSyncCredentials {
+    endpoint: string;
+    token: string;
+    expiresAt?: Date;
+}

package/lib/client/connection/PowerSyncCredentials.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=PowerSyncCredentials.js.map

package/lib/client/connection/PowerSyncCredentials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PowerSyncCredentials.js","sourceRoot":"","sources":["../../../src/client/connection/PowerSyncCredentials.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,71 @@
+import { OpId } from './CrudEntry';
+import { CrudBatch } from './CrudBatch';
+import { SyncDataBatch } from './SyncDataBatch';
+import { BaseListener, BaseObserver, Disposable } from '../../../utils/BaseObserver';
+export interface Checkpoint {
+    last_op_id: OpId;
+    buckets: BucketChecksum[];
+    write_checkpoint?: string;
+}
+export interface BucketState {
+    bucket: string;
+    op_id: string;
+}
+export interface ChecksumCache {
+    checksums: Map<string, {
+        checksum: BucketChecksum;
+        last_op_id: OpId;
+    }>;
+    lastOpId: OpId;
+}
+export interface SyncLocalDatabaseResult {
+    ready: boolean;
+    checkpointValid: boolean;
+    checkpointFailures?: string[];
+}
+export interface BucketChecksum {
+    bucket: string;
+    /**
+     * 32-bit unsigned hash.
+     */
+    checksum: number;
+    /**
+     * Count of operations - informational only.
+     */
+    count?: number;
+}
+export declare enum PSInternalTable {
+    DATA = "ps_data",
+    CRUD = "ps_crud",
+    BUCKETS = "ps_buckets",
+    OPLOG = "ps_oplog"
+}
+export interface BucketStorageListener extends BaseListener {
+    crudUpdate: () => void;
+}
+export interface BucketStorageAdapter extends BaseObserver<BucketStorageListener>, Disposable {
+    init(): Promise<void>;
+    saveSyncData(batch: SyncDataBatch): Promise<void>;
+    removeBuckets(buckets: string[]): Promise<void>;
+    setTargetCheckpoint(checkpoint: Checkpoint): Promise<void>;
+    startSession(): void;
+    getBucketStates(): Promise<BucketState[]>;
+    syncLocalDatabase(checkpoint: Checkpoint): Promise<{
+        checkpointValid: boolean;
+        ready: boolean;
+        failures?: any[];
+    }>;
+    hasCrud(): Promise<boolean>;
+    getCrudBatch(limit?: number): Promise<CrudBatch | null>;
+    hasCompletedSync(): Promise<boolean>;
+    updateLocalTarget(cb: () => Promise<string>): Promise<boolean>;
+    /**
+     * Exposed for tests only.
+     */
+    autoCompact(): Promise<void>;
+    /**
+     * Exposed for tests only.
+     */
+    forceCompact(): Promise<void>;
+    getMaxOpId(): string;
+}

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

@@ -0,0 +1,8 @@
+export var PSInternalTable;
+(function (PSInternalTable) {
+    PSInternalTable["DATA"] = "ps_data";
+    PSInternalTable["CRUD"] = "ps_crud";
+    PSInternalTable["BUCKETS"] = "ps_buckets";
+    PSInternalTable["OPLOG"] = "ps_oplog";
+})(PSInternalTable || (PSInternalTable = {}));
+//# sourceMappingURL=BucketStorageAdapter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"BucketStorageAdapter.js","sourceRoot":"","sources":["../../../../src/client/sync/bucket/BucketStorageAdapter.ts"],"names":[],"mappings":"AAwCA,MAAM,CAAN,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,mCAAgB,CAAA;IAChB,mCAAgB,CAAA;IAChB,yCAAsB,CAAA;IACtB,qCAAkB,CAAA;AACpB,CAAC,EALW,eAAe,KAAf,eAAe,QAK1B"}

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

@@ -0,0 +1,31 @@
+import { CrudEntry } from './CrudEntry';
+/**
+ * A batch of client-side changes.
+ */
+export declare class CrudBatch {
+    /**
+     * List of client-side changes.
+     */
+    crud: CrudEntry[];
+    /**
+     * true if there are more changes in the local queue.
+     */
+    haveMore: boolean;
+    /**
+     * Call to remove the changes from the local queue, once successfully uploaded.
+     */
+    complete: (writeCheckpoint?: string) => Promise<void>;
+    constructor(
+    /**
+     * List of client-side changes.
+     */
+    crud: CrudEntry[], 
+    /**
+     * true if there are more changes in the local queue.
+     */
+    haveMore: boolean, 
+    /**
+     * Call to remove the changes from the local queue, once successfully uploaded.
+     */
+    complete: (writeCheckpoint?: string) => Promise<void>);
+}

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

@@ -0,0 +1,26 @@
+/**
+ * A batch of client-side changes.
+ */
+export class CrudBatch {
+    crud;
+    haveMore;
+    complete;
+    constructor(
+    /**
+     * List of client-side changes.
+     */
+    crud, 
+    /**
+     * true if there are more changes in the local queue.
+     */
+    haveMore, 
+    /**
+     * Call to remove the changes from the local queue, once successfully uploaded.
+     */
+    complete) {
+        this.crud = crud;
+        this.haveMore = haveMore;
+        this.complete = complete;
+    }
+}
+//# sourceMappingURL=CrudBatch.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,86 @@
+/**
+ * 64-bit unsigned integer stored as a string in base-10.
+ *
+ * Not sortable as a string.
+ */
+export type OpId = string;
+/**
+ * Type of local change.
+ */
+export declare enum UpdateType {
+    /** Insert or replace existing row. All non-null columns are included in the data. Generated by INSERT statements. */
+    PUT = "PUT",
+    /** Update existing row. Contains the id, and value of each changed column. Generated by UPDATE statements. */
+    PATCH = "PATCH",
+    /** Delete existing row. Contains the id. Generated by DELETE statements. */
+    DELETE = "DELETE"
+}
+export type CrudEntryJSON = {
+    id: string;
+    data: string;
+    tx_id?: number;
+};
+export type CrudEntryDataJSON = {
+    data: Record<string, any>;
+    op: UpdateType;
+    type: string;
+    id: string;
+};
+/**
+ * The output JSON seems to be a third type of JSON, not the same as the input JSON.
+ */
+export type CrudEntryOutputJSON = {
+    op_id: number;
+    op: UpdateType;
+    type: string;
+    id: string;
+    tx_id?: number;
+    data?: Record<string, any>;
+};
+/**
+ * A single client-side change.
+ */
+export declare class CrudEntry {
+    /**
+     * Auto-incrementing client-side id.
+     */
+    clientId: number;
+    /**
+     * ID of the changed row.
+     */
+    id: string;
+    /**
+     * Type of change.
+     */
+    op: UpdateType;
+    /**
+     * Data associated with the change.
+     */
+    opData?: Record<string, any>;
+    /**
+     * Table that contained the change.
+     */
+    table: string;
+    /**
+     * Auto-incrementing transaction id. This is the same for all operations within the same transaction.
+     */
+    transactionId?: number;
+    static fromRow(dbRow: CrudEntryJSON): CrudEntry;
+    constructor(clientId: number, op: UpdateType, table: string, id: string, transactionId?: number, opData?: Record<string, any>);
+    /**
+     * Converts the change to JSON format.
+     */
+    toJSON(): CrudEntryOutputJSON;
+    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)[];
+}

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

@@ -0,0 +1,85 @@
+/**
+ * Type of local change.
+ */
+export var UpdateType;
+(function (UpdateType) {
+    /** Insert or replace existing row. All non-null columns are included in the data. Generated by INSERT statements. */
+    UpdateType["PUT"] = "PUT";
+    /** Update existing row. Contains the id, and value of each changed column. Generated by UPDATE statements. */
+    UpdateType["PATCH"] = "PATCH";
+    /** 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;
+    /**
+     * Table that contained the change.
+     */
+    table;
+    /**
+     * Auto-incrementing transaction id. This is the same for all operations within the same transaction.
+     */
+    transactionId;
+    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);
+    }
+    constructor(clientId, op, table, id, transactionId, opData) {
+        this.clientId = clientId;
+        this.id = id;
+        this.op = op;
+        this.opData = opData;
+        this.table = table;
+        this.transactionId = transactionId;
+    }
+    /**
+     * 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
+        };
+    }
+    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];
+    }
+}
+//# sourceMappingURL=CrudEntry.js.map

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

@@ -0,0 +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;AA2BD;;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;IAC7B;;OAEG;IACH,KAAK,CAAS;IACd;;OAEG;IACH,aAAa,CAAU;IAEvB,MAAM,CAAC,OAAO,CAAC,KAAoB;QACjC,MAAM,IAAI,GAAsB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvD,OAAO,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IAChG,CAAC;IAED,YACE,QAAgB,EAChB,EAAc,EACd,KAAa,EACb,EAAU,EACV,aAAsB,EACtB,MAA4B;QAE5B,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;IACrC,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;SAClB,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,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACxF,CAAC;CACF"}

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

@@ -0,0 +1,29 @@
+import { CrudBatch } from './CrudBatch';
+import { CrudEntry } from './CrudEntry';
+export declare class CrudTransaction extends CrudBatch {
+    /**
+     * List of client-side changes.
+     */
+    crud: CrudEntry[];
+    /**
+     * Call to remove the changes from the local queue, once successfully uploaded.
+     */
+    complete: (checkpoint?: string) => Promise<void>;
+    /**
+     * If null, this contains a list of changes recorded without an explicit transaction associated.
+     */
+    transactionId?: number | undefined;
+    constructor(
+    /**
+     * List of client-side changes.
+     */
+    crud: CrudEntry[], 
+    /**
+     * Call to remove the changes from the local queue, once successfully uploaded.
+     */
+    complete: (checkpoint?: string) => Promise<void>, 
+    /**
+     * If null, this contains a list of changes recorded without an explicit transaction associated.
+     */
+    transactionId?: number | undefined);
+}

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

@@ -0,0 +1,25 @@
+import { CrudBatch } from './CrudBatch';
+export class CrudTransaction extends CrudBatch {
+    crud;
+    complete;
+    transactionId;
+    constructor(
+    /**
+     * List of client-side changes.
+     */
+    crud, 
+    /**
+     * Call to remove the changes from the local queue, once successfully uploaded.
+     */
+    complete, 
+    /**
+     * If null, this contains a list of changes recorded without an explicit transaction associated.
+     */
+    transactionId) {
+        super(crud, false, complete);
+        this.crud = crud;
+        this.complete = complete;
+        this.transactionId = transactionId;
+    }
+}
+//# sourceMappingURL=CrudTransaction.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"CrudTransaction.js","sourceRoot":"","sources":["../../../../src/client/sync/bucket/CrudTransaction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAGxC,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/bucket/OpType.d.ts

@@ -0,0 +1,16 @@
+export declare enum OpTypeEnum {
+    CLEAR = 1,
+    MOVE = 2,
+    PUT = 3,
+    REMOVE = 4
+}
+export type OpTypeJSON = string;
+/**
+ * Used internally for sync buckets.
+ */
+export declare class OpType {
+    value: OpTypeEnum;
+    static fromJSON(jsonValue: OpTypeJSON): OpType;
+    constructor(value: OpTypeEnum);
+    toJSON(): string;
+}

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

@@ -0,0 +1,23 @@
+export var OpTypeEnum;
+(function (OpTypeEnum) {
+    OpTypeEnum[OpTypeEnum["CLEAR"] = 1] = "CLEAR";
+    OpTypeEnum[OpTypeEnum["MOVE"] = 2] = "MOVE";
+    OpTypeEnum[OpTypeEnum["PUT"] = 3] = "PUT";
+    OpTypeEnum[OpTypeEnum["REMOVE"] = 4] = "REMOVE";
+})(OpTypeEnum || (OpTypeEnum = {}));
+/**
+ * Used internally for sync buckets.
+ */
+export class OpType {
+    value;
+    static fromJSON(jsonValue) {
+        return new OpType(OpTypeEnum[jsonValue]);
+    }
+    constructor(value) {
+        this.value = value;
+    }
+    toJSON() {
+        return Object.entries(OpTypeEnum).find(([, value]) => value === this.value)[0];
+    }
+}
+//# sourceMappingURL=OpType.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OpType.js","sourceRoot":"","sources":["../../../../src/client/sync/bucket/OpType.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,6CAAS,CAAA;IACT,2CAAQ,CAAA;IACR,yCAAO,CAAA;IACP,+CAAU,CAAA;AACZ,CAAC,EALW,UAAU,KAAV,UAAU,QAKrB;AAID;;GAEG;AACH,MAAM,OAAO,MAAM;IAKE;IAJnB,MAAM,CAAC,QAAQ,CAAC,SAAqB;QACnC,OAAO,IAAI,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3C,CAAC;IAED,YAAmB,KAAiB;QAAjB,UAAK,GAAL,KAAK,CAAY;IAAG,CAAC;IAExC,MAAM;QACJ,OAAO,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,CAAE,CAAC,CAAC,CAAC,CAAC;IAClF,CAAC;CACF"}

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

@@ -0,0 +1,23 @@
+import { OpId } from './CrudEntry';
+import { OpType, OpTypeJSON } from './OpType';
+export interface OplogEntryJSON {
+    checksum: number;
+    data?: string;
+    object_id?: string;
+    object_type?: string;
+    op_id: string;
+    op: OpTypeJSON;
+    subkey?: string | object;
+}
+export declare class OplogEntry {
+    op_id: OpId;
+    op: OpType;
+    checksum: number;
+    subkey: string;
+    object_type?: string | undefined;
+    object_id?: string | undefined;
+    data?: string | undefined;
+    static fromRow(row: OplogEntryJSON): OplogEntry;
+    constructor(op_id: OpId, op: OpType, checksum: number, subkey: string, object_type?: string | undefined, object_id?: string | undefined, data?: string | undefined);
+    toJSON(): OplogEntryJSON;
+}

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

@@ -0,0 +1,34 @@
+import { OpType } from './OpType';
+export class OplogEntry {
+    op_id;
+    op;
+    checksum;
+    subkey;
+    object_type;
+    object_id;
+    data;
+    static fromRow(row) {
+        return new OplogEntry(row.op_id, OpType.fromJSON(row.op), row.checksum, typeof row.subkey == 'string' ? row.subkey : JSON.stringify(row.subkey), row.object_type, row.object_id, row.data);
+    }
+    constructor(op_id, op, checksum, subkey, object_type, object_id, data) {
+        this.op_id = op_id;
+        this.op = op;
+        this.checksum = checksum;
+        this.subkey = subkey;
+        this.object_type = object_type;
+        this.object_id = object_id;
+        this.data = data;
+    }
+    toJSON() {
+        return {
+            op_id: this.op_id,
+            op: this.op.toJSON(),
+            object_type: this.object_type,
+            object_id: this.object_id,
+            checksum: this.checksum,
+            data: this.data,
+            subkey: JSON.stringify(this.subkey)
+        };
+    }
+}
+//# sourceMappingURL=OplogEntry.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"OplogEntry.js","sourceRoot":"","sources":["../../../../src/client/sync/bucket/OplogEntry.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAc,MAAM,UAAU,CAAC;AAY9C,MAAM,OAAO,UAAU;IAcZ;IACA;IACA;IACA;IACA;IACA;IACA;IAnBT,MAAM,CAAC,OAAO,CAAC,GAAmB;QAChC,OAAO,IAAI,UAAU,CACnB,GAAG,CAAC,KAAK,EACT,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,EACvB,GAAG,CAAC,QAAQ,EACZ,OAAO,GAAG,CAAC,MAAM,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EACvE,GAAG,CAAC,WAAW,EACf,GAAG,CAAC,SAAS,EACb,GAAG,CAAC,IAAI,CACT,CAAC;IACJ,CAAC;IAED,YACS,KAAW,EACX,EAAU,EACV,QAAgB,EAChB,MAAc,EACd,WAAoB,EACpB,SAAkB,EAClB,IAAa;QANb,UAAK,GAAL,KAAK,CAAM;QACX,OAAE,GAAF,EAAE,CAAQ;QACV,aAAQ,GAAR,QAAQ,CAAQ;QAChB,WAAM,GAAN,MAAM,CAAQ;QACd,gBAAW,GAAX,WAAW,CAAS;QACpB,cAAS,GAAT,SAAS,CAAS;QAClB,SAAI,GAAJ,IAAI,CAAS;IACnB,CAAC;IAEJ,MAAM;QACJ,OAAO;YACL,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,EAAE,EAAE,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE;YACpB,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,CAAC;SACpC,CAAC;IACJ,CAAC;CACF"}

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

@@ -0,0 +1,66 @@
+import { Mutex } from 'async-mutex';
+import { DBAdapter, Transaction } from '../../../db/DBAdapter';
+import { BucketState, BucketStorageAdapter, BucketStorageListener, Checkpoint, SyncLocalDatabaseResult } from './BucketStorageAdapter';
+import { CrudBatch } from './CrudBatch';
+import { SyncDataBatch } from './SyncDataBatch';
+import { ILogger } from 'js-logger';
+import { BaseObserver } from '../../../utils/BaseObserver';
+export declare class SqliteBucketStorage extends BaseObserver<BucketStorageListener> implements BucketStorageAdapter {
+    private db;
+    private mutex;
+    private logger;
+    static MAX_OP_ID: string;
+    tableNames: Set<string>;
+    private pendingBucketDeletes;
+    private _hasCompletedSync;
+    private updateListener;
+    /**
+     * Count up, and do a compact on startup.
+     */
+    private compactCounter;
+    constructor(db: DBAdapter, mutex: Mutex, logger?: ILogger);
+    init(): Promise<void>;
+    dispose(): Promise<void>;
+    getMaxOpId(): string;
+    /**
+     * Reset any caches.
+     */
+    startSession(): void;
+    getBucketStates(): Promise<BucketState[]>;
+    saveSyncData(batch: SyncDataBatch): Promise<void>;
+    removeBuckets(buckets: string[]): Promise<void>;
+    /**
+     * Mark a bucket for deletion.
+     */
+    private deleteBucket;
+    hasCompletedSync(): Promise<boolean>;
+    syncLocalDatabase(checkpoint: Checkpoint): Promise<SyncLocalDatabaseResult>;
+    /**
+     * Atomically update the local state to the current checkpoint.
+     *
+     * This includes creating new tables, dropping old tables, and copying data over from the oplog.
+     */
+    private updateObjectsFromBuckets;
+    validateChecksums(checkpoint: Checkpoint): Promise<SyncLocalDatabaseResult>;
+    /**
+     * Force a compact, for tests.
+     */
+    forceCompact(): Promise<void>;
+    autoCompact(): Promise<void>;
+    private deletePendingBuckets;
+    private clearRemoveOps;
+    updateLocalTarget(cb: () => Promise<string>): Promise<boolean>;
+    hasCrud(): Promise<boolean>;
+    /**
+     * Get a batch of objects to send to the server.
+     * When the objects are successfully sent to the server, call .complete()
+     */
+    getCrudBatch(limit?: number): Promise<CrudBatch | null>;
+    writeTransaction<T>(callback: (tx: Transaction) => Promise<T>, options?: {
+        timeoutMs: number;
+    }): Promise<T>;
+    /**
+     * Set a target checkpoint.
+     */
+    setTargetCheckpoint(checkpoint: Checkpoint): Promise<void>;
+}