@powersync/common 1.6.1

package/lib/client/sync/stream/AbstractStreamingSyncImplementation.js

@@ -0,0 +1,478 @@
+import throttle from 'lodash/throttle';
+import Logger from 'js-logger';
+import { isStreamingKeepalive, isStreamingSyncCheckpoint, isStreamingSyncCheckpointComplete, isStreamingSyncCheckpointDiff, isStreamingSyncData } from './streaming-sync-types';
+import ndjsonStream from 'can-ndjson-stream';
+import { SyncStatus } from '../../../db/crud/SyncStatus';
+import { SyncDataBucket } from '../bucket/SyncDataBucket';
+import { BaseObserver } from '../../../utils/BaseObserver';
+import { AbortOperation } from '../../../utils/AbortOperation';
+export var LockType;
+(function (LockType) {
+    LockType["CRUD"] = "crud";
+    LockType["SYNC"] = "sync";
+})(LockType || (LockType = {}));
+export const DEFAULT_CRUD_UPLOAD_THROTTLE_MS = 1000;
+export const DEFAULT_STREAMING_SYNC_OPTIONS = {
+    retryDelayMs: 5000,
+    logger: Logger.get('PowerSyncStream'),
+    crudUploadThrottleMs: DEFAULT_CRUD_UPLOAD_THROTTLE_MS
+};
+export class AbstractStreamingSyncImplementation extends BaseObserver {
+    _lastSyncedAt;
+    options;
+    abortController;
+    crudUpdateListener;
+    streamingSyncPromise;
+    syncStatus;
+    triggerCrudUpload;
+    constructor(options) {
+        super();
+        this.options = { ...DEFAULT_STREAMING_SYNC_OPTIONS, ...options };
+        this.syncStatus = new SyncStatus({
+            connected: false,
+            lastSyncedAt: undefined,
+            dataFlow: {
+                uploading: false,
+                downloading: false
+            }
+        });
+        this.abortController = null;
+        this.triggerCrudUpload = throttle(() => {
+            if (!this.syncStatus.connected || this.syncStatus.dataFlowStatus.uploading) {
+                return;
+            }
+            this._uploadAllCrud();
+        }, this.options.crudUploadThrottleMs, { trailing: true });
+    }
+    async waitForReady() { }
+    waitForStatus(status) {
+        return new Promise((resolve) => {
+            const l = this.registerListener({
+                statusChanged: (updatedStatus) => {
+                    /**
+                     * Match only the partial status options provided in the
+                     * matching status
+                     */
+                    const matchPartialObject = (compA, compB) => {
+                        return Object.entries(compA).every(([key, value]) => {
+                            const comparisonBValue = compB[key];
+                            if (typeof value == 'object' && typeof comparisonBValue == 'object') {
+                                return matchPartialObject(value, comparisonBValue);
+                            }
+                            return value == comparisonBValue;
+                        });
+                    };
+                    if (matchPartialObject(status, updatedStatus.toJSON())) {
+                        resolve();
+                        l?.();
+                    }
+                }
+            });
+        });
+    }
+    get lastSyncedAt() {
+        const lastSynced = this.syncStatus.lastSyncedAt;
+        return lastSynced && new Date(lastSynced);
+    }
+    get isConnected() {
+        return this.syncStatus.connected;
+    }
+    get logger() {
+        return this.options.logger;
+    }
+    async dispose() {
+        this.crudUpdateListener?.();
+        this.crudUpdateListener = undefined;
+    }
+    async hasCompletedSync() {
+        return this.options.adapter.hasCompletedSync();
+    }
+    async getWriteCheckpoint() {
+        const response = await this.options.remote.get('/write-checkpoint2.json');
+        return response['data']['write_checkpoint'];
+    }
+    async _uploadAllCrud() {
+        return this.obtainLock({
+            type: LockType.CRUD,
+            callback: async () => {
+                this.updateSyncStatus({
+                    dataFlow: {
+                        uploading: true
+                    }
+                });
+                while (true) {
+                    try {
+                        const done = await this.uploadCrudBatch();
+                        if (done) {
+                            break;
+                        }
+                    }
+                    catch (ex) {
+                        this.updateSyncStatus({
+                            connected: false,
+                            dataFlow: {
+                                uploading: false
+                            }
+                        });
+                        await this.delayRetry();
+                        break;
+                    }
+                    finally {
+                        this.updateSyncStatus({
+                            dataFlow: {
+                                uploading: false
+                            }
+                        });
+                    }
+                }
+            }
+        });
+    }
+    async uploadCrudBatch() {
+        const hasCrud = await this.options.adapter.hasCrud();
+        if (hasCrud) {
+            await this.options.uploadCrud();
+            return false;
+        }
+        else {
+            await this.options.adapter.updateLocalTarget(() => this.getWriteCheckpoint());
+            return true;
+        }
+    }
+    async connect() {
+        if (this.abortController) {
+            await this.disconnect();
+        }
+        this.abortController = new AbortController();
+        this.streamingSyncPromise = this.streamingSync(this.abortController.signal);
+        // Return a promise that resolves when the connection status is updated
+        return new Promise((resolve) => {
+            const l = this.registerListener({
+                statusUpdated: (update) => {
+                    // This is triggered as soon as a connection is read from
+                    if (typeof update.connected == 'undefined') {
+                        // only concern with connection updates
+                        return;
+                    }
+                    if (update.connected == false) {
+                        /**
+                         * This function does not reject if initial connect attempt failed
+                         */
+                        this.logger.warn('Initial connect attempt did not successfully connect to server');
+                    }
+                    resolve();
+                    l();
+                }
+            });
+        });
+    }
+    async disconnect() {
+        if (!this.abortController) {
+            return;
+        }
+        // This might be called multiple times
+        if (!this.abortController.signal.aborted) {
+            this.abortController.abort(new AbortOperation('Disconnect has been requested'));
+        }
+        // Await any pending operations before completing the disconnect operation
+        try {
+            await this.streamingSyncPromise;
+        }
+        catch (ex) {
+            // The operation might have failed, all we care about is if it has completed
+            this.logger.warn(ex);
+        }
+        this.streamingSyncPromise = undefined;
+        this.abortController = null;
+        this.updateSyncStatus({ connected: false });
+    }
+    /**
+     * @deprecated use [connect instead]
+     */
+    async streamingSync(signal) {
+        if (!signal) {
+            this.abortController = new AbortController();
+            signal = this.abortController.signal;
+        }
+        /**
+         * Listen for CRUD updates and trigger upstream uploads
+         */
+        this.crudUpdateListener = this.options.adapter.registerListener({
+            crudUpdate: () => this.triggerCrudUpload()
+        });
+        /**
+         * Create a new abort controller which aborts items downstream.
+         * This is needed to close any previous connections on exception.
+         */
+        let nestedAbortController = new AbortController();
+        signal.addEventListener('abort', () => {
+            /**
+             * A request for disconnect was received upstream. Relay the request
+             * to the nested abort controller.
+             */
+            nestedAbortController.abort(signal?.reason ?? new AbortOperation('Received command to disconnect from upstream'));
+            this.crudUpdateListener?.();
+            this.crudUpdateListener = undefined;
+            this.updateSyncStatus({
+                connected: false,
+                dataFlow: {
+                    downloading: false
+                }
+            });
+        });
+        /**
+         * This loops runs until [retry] is false or the abort signal is set to aborted.
+         * Aborting the nestedAbortController will:
+         *  - Abort any pending fetch requests
+         *  - Close any sync stream ReadableStreams (which will also close any established network requests)
+         */
+        while (true) {
+            try {
+                if (signal?.aborted) {
+                    break;
+                }
+                const { retry } = await this.streamingSyncIteration(nestedAbortController.signal);
+                if (!retry) {
+                    /**
+                     * A sync error ocurred that we cannot recover from here.
+                     * This loop must terminate.
+                     * The nestedAbortController will close any open network requests and streams below.
+                     */
+                    break;
+                }
+                // Continue immediately
+            }
+            catch (ex) {
+                /**
+                 * Either:
+                 *  - A network request failed with a failed connection or not OKAY response code.
+                 *  - There was a sync processing error.
+                 * This loop will retry.
+                 * The nested abort controller will cleanup any open network requests and streams.
+                 * The WebRemote should only abort pending fetch requests or close active Readable streams.
+                 */
+                if (ex instanceof AbortOperation) {
+                    this.logger.warn(ex);
+                }
+                else {
+                    this.logger.error(ex);
+                }
+                await this.delayRetry();
+            }
+            finally {
+                if (!signal.aborted) {
+                    nestedAbortController.abort(new AbortOperation('Closing sync stream network requests before retry.'));
+                    nestedAbortController = new AbortController();
+                }
+                this.updateSyncStatus({
+                    connected: false
+                });
+                // On error, wait a little before retrying
+            }
+        }
+        // Mark as disconnected if here
+        this.updateSyncStatus({ connected: false });
+    }
+    async streamingSyncIteration(signal, progress) {
+        return await this.obtainLock({
+            type: LockType.SYNC,
+            signal,
+            callback: async () => {
+                this.logger.debug('Streaming sync iteration started');
+                this.options.adapter.startSession();
+                const bucketEntries = await this.options.adapter.getBucketStates();
+                const initialBuckets = new Map();
+                bucketEntries.forEach((entry) => {
+                    initialBuckets.set(entry.bucket, entry.op_id);
+                });
+                const req = Array.from(initialBuckets.entries()).map(([bucket, after]) => ({
+                    name: bucket,
+                    after: after
+                }));
+                // These are compared by reference
+                let targetCheckpoint = null;
+                let validatedCheckpoint = null;
+                let appliedCheckpoint = null;
+                let bucketSet = new Set(initialBuckets.keys());
+                for await (const line of this.streamingSyncRequest({
+                    buckets: req,
+                    include_checksum: true,
+                    raw_data: true
+                }, signal)) {
+                    if (isStreamingSyncCheckpoint(line)) {
+                        targetCheckpoint = line.checkpoint;
+                        const bucketsToDelete = new Set(bucketSet);
+                        const newBuckets = new Set();
+                        for (const checksum of line.checkpoint.buckets) {
+                            newBuckets.add(checksum.bucket);
+                            bucketsToDelete.delete(checksum.bucket);
+                        }
+                        if (bucketsToDelete.size > 0) {
+                            this.logger.debug('Removing buckets', [...bucketsToDelete]);
+                        }
+                        bucketSet = newBuckets;
+                        await this.options.adapter.removeBuckets([...bucketsToDelete]);
+                        await this.options.adapter.setTargetCheckpoint(targetCheckpoint);
+                    }
+                    else if (isStreamingSyncCheckpointComplete(line)) {
+                        this.logger.debug('Checkpoint complete', targetCheckpoint);
+                        const result = await this.options.adapter.syncLocalDatabase(targetCheckpoint);
+                        if (!result.checkpointValid) {
+                            // This means checksums failed. Start again with a new checkpoint.
+                            // TODO: better back-off
+                            await new Promise((resolve) => setTimeout(resolve, 50));
+                            return { retry: true };
+                        }
+                        else if (!result.ready) {
+                            // Checksums valid, but need more data for a consistent checkpoint.
+                            // Continue waiting.
+                            // landing here the whole time
+                        }
+                        else {
+                            appliedCheckpoint = targetCheckpoint;
+                            this.logger.debug('validated checkpoint', appliedCheckpoint);
+                            this.updateSyncStatus({
+                                connected: true,
+                                lastSyncedAt: new Date(),
+                                dataFlow: {
+                                    downloading: false
+                                }
+                            });
+                        }
+                        validatedCheckpoint = targetCheckpoint;
+                    }
+                    else if (isStreamingSyncCheckpointDiff(line)) {
+                        // TODO: It may be faster to just keep track of the diff, instead of the entire checkpoint
+                        if (targetCheckpoint == null) {
+                            throw new Error('Checkpoint diff without previous checkpoint');
+                        }
+                        const diff = line.checkpoint_diff;
+                        const newBuckets = new Map();
+                        for (const checksum of targetCheckpoint.buckets) {
+                            newBuckets.set(checksum.bucket, checksum);
+                        }
+                        for (const checksum of diff.updated_buckets) {
+                            newBuckets.set(checksum.bucket, checksum);
+                        }
+                        for (const bucket of diff.removed_buckets) {
+                            newBuckets.delete(bucket);
+                        }
+                        const newCheckpoint = {
+                            last_op_id: diff.last_op_id,
+                            buckets: [...newBuckets.values()],
+                            write_checkpoint: diff.write_checkpoint
+                        };
+                        targetCheckpoint = newCheckpoint;
+                        bucketSet = new Set(newBuckets.keys());
+                        const bucketsToDelete = diff.removed_buckets;
+                        if (bucketsToDelete.length > 0) {
+                            this.logger.debug('Remove buckets', bucketsToDelete);
+                        }
+                        await this.options.adapter.removeBuckets(bucketsToDelete);
+                        await this.options.adapter.setTargetCheckpoint(targetCheckpoint);
+                    }
+                    else if (isStreamingSyncData(line)) {
+                        const { data } = line;
+                        this.updateSyncStatus({
+                            dataFlow: {
+                                downloading: true
+                            }
+                        });
+                        await this.options.adapter.saveSyncData({ buckets: [SyncDataBucket.fromRow(data)] });
+                    }
+                    else if (isStreamingKeepalive(line)) {
+                        const remaining_seconds = line.token_expires_in;
+                        if (remaining_seconds == 0) {
+                            // Connection would be closed automatically right after this
+                            this.logger.debug('Token expiring; reconnect');
+                            return { retry: true };
+                        }
+                        this.triggerCrudUpload();
+                    }
+                    else {
+                        this.logger.debug('Sync complete');
+                        if (targetCheckpoint === appliedCheckpoint) {
+                            this.updateSyncStatus({
+                                connected: true,
+                                lastSyncedAt: new Date()
+                            });
+                        }
+                        else if (validatedCheckpoint === targetCheckpoint) {
+                            const result = await this.options.adapter.syncLocalDatabase(targetCheckpoint);
+                            if (!result.checkpointValid) {
+                                // This means checksums failed. Start again with a new checkpoint.
+                                // TODO: better back-off
+                                await new Promise((resolve) => setTimeout(resolve, 50));
+                                return { retry: false };
+                            }
+                            else if (!result.ready) {
+                                // Checksums valid, but need more data for a consistent checkpoint.
+                                // Continue waiting.
+                            }
+                            else {
+                                appliedCheckpoint = targetCheckpoint;
+                                this.updateSyncStatus({
+                                    connected: true,
+                                    lastSyncedAt: new Date(),
+                                    dataFlow: {
+                                        downloading: false
+                                    }
+                                });
+                            }
+                        }
+                    }
+                    progress?.();
+                }
+                this.logger.debug('Stream input empty');
+                // Connection closed. Likely due to auth issue.
+                return { retry: true };
+            }
+        });
+    }
+    async *streamingSyncRequest(req, signal) {
+        const body = await this.options.remote.postStreaming('/sync/stream', req, {}, signal);
+        // A connection is active
+        // There is a connection now
+        Promise.resolve().then(() => this.triggerCrudUpload());
+        this.updateSyncStatus({
+            connected: true
+        });
+        const stream = ndjsonStream(body);
+        const reader = stream.getReader();
+        try {
+            while (true) {
+                // Read from the stream
+                const { done, value } = await reader.read();
+                // Exit if we're done
+                if (done)
+                    return;
+                // Else yield the chunk
+                yield value;
+            }
+        }
+        finally {
+            reader.releaseLock();
+        }
+    }
+    updateSyncStatus(options) {
+        const updatedStatus = new SyncStatus({
+            connected: options.connected ?? this.syncStatus.connected,
+            lastSyncedAt: options.lastSyncedAt ?? this.syncStatus.lastSyncedAt,
+            dataFlow: {
+                ...this.syncStatus.dataFlowStatus,
+                ...options.dataFlow
+            }
+        });
+        if (!this.syncStatus.isEqual(updatedStatus)) {
+            this.syncStatus = updatedStatus;
+            // Only trigger this is there was a change
+            this.iterateListeners((cb) => cb.statusChanged?.(updatedStatus));
+        }
+        // trigger this for all updates
+        this.iterateListeners((cb) => cb.statusUpdated?.(options));
+    }
+    async delayRetry() {
+        return new Promise((resolve) => setTimeout(resolve, this.options.retryDelayMs));
+    }
+}
+//# sourceMappingURL=AbstractStreamingSyncImplementation.js.map

package/lib/client/sync/stream/AbstractStreamingSyncImplementation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AbstractStreamingSyncImplementation.js","sourceRoot":"","sources":["../../../../src/client/sync/stream/AbstractStreamingSyncImplementation.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,iBAAiB,CAAC;AAEvC,OAAO,MAAmB,MAAM,WAAW,CAAC;AAE5C,OAAO,EAIL,oBAAoB,EACpB,yBAAyB,EACzB,iCAAiC,EACjC,6BAA6B,EAC7B,mBAAmB,EACpB,MAAM,wBAAwB,CAAC;AAEhC,OAAO,YAAY,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,UAAU,EAAqB,MAAM,6BAA6B,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAA4B,MAAM,6BAA6B,CAAC;AACrF,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAE/D,MAAM,CAAN,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,yBAAa,CAAA;IACb,yBAAa,CAAA;AACf,CAAC,EAHW,QAAQ,KAAR,QAAQ,QAGnB;AAwDD,MAAM,CAAC,MAAM,+BAA+B,GAAG,IAAI,CAAC;AAEpD,MAAM,CAAC,MAAM,8BAA8B,GAAG;IAC5C,YAAY,EAAE,IAAI;IAClB,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC;IACrC,oBAAoB,EAAE,+BAA+B;CACtD,CAAC;AAEF,MAAM,OAAgB,mCACpB,SAAQ,YAAiD;IAG/C,aAAa,CAAc;IAC3B,OAAO,CAA6C;IACpD,eAAe,CAAyB;IACxC,kBAAkB,CAAc;IAChC,oBAAoB,CAAiB;IAE/C,UAAU,CAAa;IACvB,iBAAiB,CAAa;IAE9B,YAAY,OAAmD;QAC7D,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,8BAA8B,EAAE,GAAG,OAAO,EAAE,CAAC;QACjE,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC;YAC/B,SAAS,EAAE,KAAK;YAChB,YAAY,EAAE,SAAS;YACvB,QAAQ,EAAE;gBACR,SAAS,EAAE,KAAK;gBAChB,WAAW,EAAE,KAAK;aACnB;SACF,CAAC,CAAC;QACH,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAE5B,IAAI,CAAC,iBAAiB,GAAG,QAAQ,CAC/B,GAAG,EAAE;YACH,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC;gBAC3E,OAAO;YACT,CAAC;YACD,IAAI,CAAC,cAAc,EAAE,CAAC;QACxB,CAAC,EACD,IAAI,CAAC,OAAO,CAAC,oBAAoB,EACjC,EAAE,QAAQ,EAAE,IAAI,EAAE,CACnB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY,KAAI,CAAC;IAEvB,aAAa,CAAC,MAAyB;QACrC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC7B,MAAM,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;gBAC9B,aAAa,EAAE,CAAC,aAAa,EAAE,EAAE;oBAC/B;;;uBAGG;oBACH,MAAM,kBAAkB,GAAG,CAAC,KAAa,EAAE,KAAa,EAAE,EAAE;wBAC1D,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;4BAClD,MAAM,gBAAgB,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;4BACpC,IAAI,OAAO,KAAK,IAAI,QAAQ,IAAI,OAAO,gBAAgB,IAAI,QAAQ,EAAE,CAAC;gCACpE,OAAO,kBAAkB,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC;4BACrD,CAAC;4BACD,OAAO,KAAK,IAAI,gBAAgB,CAAC;wBACnC,CAAC,CAAC,CAAC;oBACL,CAAC,CAAC;oBAEF,IAAI,kBAAkB,CAAC,MAAM,EAAE,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC;wBACvD,OAAO,EAAE,CAAC;wBACV,CAAC,EAAE,EAAE,CAAC;oBACR,CAAC;gBACH,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,YAAY;QACd,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;QAChD,OAAO,UAAU,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;IACnC,CAAC;IAED,IAAc,MAAM;QAClB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAO,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,kBAAkB,EAAE,EAAE,CAAC;QAC5B,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;IACtC,CAAC;IAID,KAAK,CAAC,gBAAgB;QACpB,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IACjD,CAAC;IAED,KAAK,CAAC,kBAAkB;QACtB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QAC1E,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,kBAAkB,CAAW,CAAC;IACxD,CAAC;IAES,KAAK,CAAC,cAAc;QAC5B,OAAO,IAAI,CAAC,UAAU,CAAC;YACrB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,QAAQ,EAAE,KAAK,IAAI,EAAE;gBACnB,IAAI,CAAC,gBAAgB,CAAC;oBACpB,QAAQ,EAAE;wBACR,SAAS,EAAE,IAAI;qBAChB;iBACF,CAAC,CAAC;gBACH,OAAO,IAAI,EAAE,CAAC;oBACZ,IAAI,CAAC;wBACH,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;wBAC1C,IAAI,IAAI,EAAE,CAAC;4BACT,MAAM;wBACR,CAAC;oBACH,CAAC;oBAAC,OAAO,EAAE,EAAE,CAAC;wBACZ,IAAI,CAAC,gBAAgB,CAAC;4BACpB,SAAS,EAAE,KAAK;4BAChB,QAAQ,EAAE;gCACR,SAAS,EAAE,KAAK;6BACjB;yBACF,CAAC,CAAC;wBACH,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;wBACxB,MAAM;oBACR,CAAC;4BAAS,CAAC;wBACT,IAAI,CAAC,gBAAgB,CAAC;4BACpB,QAAQ,EAAE;gCACR,SAAS,EAAE,KAAK;6BACjB;yBACF,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAES,KAAK,CAAC,eAAe;QAC7B,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACrD,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC;QACf,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC,CAAC;YAC9E,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAO;QACX,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAC1B,CAAC;QAED,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;QAC7C,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAE5E,uEAAuE;QACvE,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YACnC,MAAM,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;gBAC9B,aAAa,EAAE,CAAC,MAAM,EAAE,EAAE;oBACxB,yDAAyD;oBACzD,IAAI,OAAO,MAAM,CAAC,SAAS,IAAI,WAAW,EAAE,CAAC;wBAC3C,uCAAuC;wBACvC,OAAO;oBACT,CAAC;oBAED,IAAI,MAAM,CAAC,SAAS,IAAI,KAAK,EAAE,CAAC;wBAC9B;;2BAEG;wBACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gEAAgE,CAAC,CAAC;oBACrF,CAAC;oBAED,OAAO,EAAE,CAAC;oBACV,CAAC,EAAE,CAAC;gBACN,CAAC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,UAAU;QACd,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QAED,sCAAsC;QACtC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACzC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,cAAc,CAAC,+BAA+B,CAAC,CAAC,CAAC;QAClF,CAAC;QAED,0EAA0E;QAC1E,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,oBAAoB,CAAC;QAClC,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACZ,4EAA4E;YAC5E,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACvB,CAAC;QACD,IAAI,CAAC,oBAAoB,GAAG,SAAS,CAAC;QAEtC,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC;QAC5B,IAAI,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,aAAa,CAAC,MAAoB;QACtC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;YAC7C,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC;QACvC,CAAC;QAED;;WAEG;QACH,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC;YAC9D,UAAU,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE;SAC3C,CAAC,CAAC;QAEH;;;WAGG;QACH,IAAI,qBAAqB,GAAG,IAAI,eAAe,EAAE,CAAC;QAElD,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE;YACpC;;;eAGG;YACH,qBAAqB,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,IAAI,IAAI,cAAc,CAAC,8CAA8C,CAAC,CAAC,CAAC;YAClH,IAAI,CAAC,kBAAkB,EAAE,EAAE,CAAC;YAC5B,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;YACpC,IAAI,CAAC,gBAAgB,CAAC;gBACpB,SAAS,EAAE,KAAK;gBAChB,QAAQ,EAAE;oBACR,WAAW,EAAE,KAAK;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH;;;;;WAKG;QACH,OAAO,IAAI,EAAE,CAAC;YACZ,IAAI,CAAC;gBACH,IAAI,MAAM,EAAE,OAAO,EAAE,CAAC;oBACpB,MAAM;gBACR,CAAC;gBACD,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;gBAClF,IAAI,CAAC,KAAK,EAAE,CAAC;oBACX;;;;uBAIG;oBACH,MAAM;gBACR,CAAC;gBACD,uBAAuB;YACzB,CAAC;YAAC,OAAO,EAAE,EAAE,CAAC;gBACZ;;;;;;;mBAOG;gBACH,IAAI,EAAE,YAAY,cAAc,EAAE,CAAC;oBACjC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACvB,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACxB,CAAC;gBACD,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YAC1B,CAAC;oBAAS,CAAC;gBACT,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBACpB,qBAAqB,CAAC,KAAK,CAAC,IAAI,cAAc,CAAC,oDAAoD,CAAC,CAAC,CAAC;oBACtG,qBAAqB,GAAG,IAAI,eAAe,EAAE,CAAC;gBAChD,CAAC;gBAED,IAAI,CAAC,gBAAgB,CAAC;oBACpB,SAAS,EAAE,KAAK;iBACjB,CAAC,CAAC;gBAEH,0CAA0C;YAC5C,CAAC;QACH,CAAC;QAED,+BAA+B;QAC/B,IAAI,CAAC,gBAAgB,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;IAES,KAAK,CAAC,sBAAsB,CAAC,MAAmB,EAAE,QAAqB;QAC/E,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC;YAC3B,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM;YACN,QAAQ,EAAE,KAAK,IAAI,EAAE;gBACnB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kCAAkC,CAAC,CAAC;gBACtD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC;gBACpC,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;gBACnE,MAAM,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAC;gBAEjD,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;oBAC9B,cAAc,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;gBAChD,CAAC,CAAC,CAAC;gBAEH,MAAM,GAAG,GAAoB,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC1F,IAAI,EAAE,MAAM;oBACZ,KAAK,EAAE,KAAK;iBACb,CAAC,CAAC,CAAC;gBAEJ,kCAAkC;gBAClC,IAAI,gBAAgB,GAAsB,IAAI,CAAC;gBAC/C,IAAI,mBAAmB,GAAsB,IAAI,CAAC;gBAClD,IAAI,iBAAiB,GAAsB,IAAI,CAAC;gBAEhD,IAAI,SAAS,GAAG,IAAI,GAAG,CAAS,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;gBAEvD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,CAAC,oBAAoB,CAChD;oBACE,OAAO,EAAE,GAAG;oBACZ,gBAAgB,EAAE,IAAI;oBACtB,QAAQ,EAAE,IAAI;iBACf,EACD,MAAM,CACP,EAAE,CAAC;oBACF,IAAI,yBAAyB,CAAC,IAAI,CAAC,EAAE,CAAC;wBACpC,gBAAgB,GAAG,IAAI,CAAC,UAAU,CAAC;wBACnC,MAAM,eAAe,GAAG,IAAI,GAAG,CAAS,SAAS,CAAC,CAAC;wBACnD,MAAM,UAAU,GAAG,IAAI,GAAG,EAAU,CAAC;wBACrC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;4BAC/C,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;4BAChC,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;wBAC1C,CAAC;wBACD,IAAI,eAAe,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;4BAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC;wBAC9D,CAAC;wBACD,SAAS,GAAG,UAAU,CAAC;wBACvB,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC;wBAC/D,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;oBACnE,CAAC;yBAAM,IAAI,iCAAiC,CAAC,IAAI,CAAC,EAAE,CAAC;wBACnD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,qBAAqB,EAAE,gBAAgB,CAAC,CAAC;wBAC3D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,gBAAiB,CAAC,CAAC;wBAC/E,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;4BAC5B,kEAAkE;4BAClE,wBAAwB;4BACxB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;4BACxD,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;wBACzB,CAAC;6BAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;4BACzB,mEAAmE;4BACnE,oBAAoB;4BACpB,8BAA8B;wBAChC,CAAC;6BAAM,CAAC;4BACN,iBAAiB,GAAG,gBAAgB,CAAC;4BACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,sBAAsB,EAAE,iBAAiB,CAAC,CAAC;4BAC7D,IAAI,CAAC,gBAAgB,CAAC;gCACpB,SAAS,EAAE,IAAI;gCACf,YAAY,EAAE,IAAI,IAAI,EAAE;gCACxB,QAAQ,EAAE;oCACR,WAAW,EAAE,KAAK;iCACnB;6BACF,CAAC,CAAC;wBACL,CAAC;wBAED,mBAAmB,GAAG,gBAAgB,CAAC;oBACzC,CAAC;yBAAM,IAAI,6BAA6B,CAAC,IAAI,CAAC,EAAE,CAAC;wBAC/C,0FAA0F;wBAC1F,IAAI,gBAAgB,IAAI,IAAI,EAAE,CAAC;4BAC7B,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;wBACjE,CAAC;wBACD,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC;wBAClC,MAAM,UAAU,GAAG,IAAI,GAAG,EAA0B,CAAC;wBACrD,KAAK,MAAM,QAAQ,IAAI,gBAAgB,CAAC,OAAO,EAAE,CAAC;4BAChD,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;wBAC5C,CAAC;wBACD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;4BAC5C,UAAU,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;wBAC5C,CAAC;wBACD,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;4BAC1C,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;wBAC5B,CAAC;wBAED,MAAM,aAAa,GAAe;4BAChC,UAAU,EAAE,IAAI,CAAC,UAAU;4BAC3B,OAAO,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;4BACjC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;yBACxC,CAAC;wBACF,gBAAgB,GAAG,aAAa,CAAC;wBAEjC,SAAS,GAAG,IAAI,GAAG,CAAS,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;wBAE/C,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC;wBAC7C,IAAI,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;4BAC/B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,eAAe,CAAC,CAAC;wBACvD,CAAC;wBACD,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;wBAC1D,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,gBAAgB,CAAC,CAAC;oBACnE,CAAC;yBAAM,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;wBACrC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;wBACtB,IAAI,CAAC,gBAAgB,CAAC;4BACpB,QAAQ,EAAE;gCACR,WAAW,EAAE,IAAI;6BAClB;yBACF,CAAC,CAAC;wBACH,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;oBACvF,CAAC;yBAAM,IAAI,oBAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;wBACtC,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC;wBAChD,IAAI,iBAAiB,IAAI,CAAC,EAAE,CAAC;4BAC3B,4DAA4D;4BAC5D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;4BAC/C,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;wBACzB,CAAC;wBACD,IAAI,CAAC,iBAAiB,EAAE,CAAC;oBAC3B,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;wBAEnC,IAAI,gBAAgB,KAAK,iBAAiB,EAAE,CAAC;4BAC3C,IAAI,CAAC,gBAAgB,CAAC;gCACpB,SAAS,EAAE,IAAI;gCACf,YAAY,EAAE,IAAI,IAAI,EAAE;6BACzB,CAAC,CAAC;wBACL,CAAC;6BAAM,IAAI,mBAAmB,KAAK,gBAAgB,EAAE,CAAC;4BACpD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,gBAAiB,CAAC,CAAC;4BAC/E,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;gCAC5B,kEAAkE;gCAClE,wBAAwB;gCACxB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;gCACxD,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;4BAC1B,CAAC;iCAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;gCACzB,mEAAmE;gCACnE,oBAAoB;4BACtB,CAAC;iCAAM,CAAC;gCACN,iBAAiB,GAAG,gBAAgB,CAAC;gCACrC,IAAI,CAAC,gBAAgB,CAAC;oCACpB,SAAS,EAAE,IAAI;oCACf,YAAY,EAAE,IAAI,IAAI,EAAE;oCACxB,QAAQ,EAAE;wCACR,WAAW,EAAE,KAAK;qCACnB;iCACF,CAAC,CAAC;4BACL,CAAC;wBACH,CAAC;oBACH,CAAC;oBACD,QAAQ,EAAE,EAAE,CAAC;gBACf,CAAC;gBACD,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;gBACxC,+CAA+C;gBAC/C,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YACzB,CAAC;SACF,CAAC,CAAC;IACL,CAAC;IAES,KAAK,CAAC,CAAC,oBAAoB,CACnC,GAAyB,EACzB,MAAoB;QAEpB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,aAAa,CAAC,cAAc,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;QAEtF,yBAAyB;QACzB,4BAA4B;QAC5B,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC;QACvD,IAAI,CAAC,gBAAgB,CAAC;YACpB,SAAS,EAAE,IAAI;SAChB,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;QAElC,IAAI,CAAC;YACH,OAAO,IAAI,EAAE,CAAC;gBACZ,uBAAuB;gBACvB,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBAC5C,qBAAqB;gBACrB,IAAI,IAAI;oBAAE,OAAO;gBACjB,uBAAuB;gBACvB,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;gBAAS,CAAC;YACT,MAAM,CAAC,WAAW,EAAE,CAAC;QACvB,CAAC;IACH,CAAC;IAES,gBAAgB,CAAC,OAA0B;QACnD,MAAM,aAAa,GAAG,IAAI,UAAU,CAAC;YACnC,SAAS,EAAE,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS;YACzD,YAAY,EAAE,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC,YAAY;YAClE,QAAQ,EAAE;gBACR,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc;gBACjC,GAAG,OAAO,CAAC,QAAQ;aACpB;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC;YAChC,0CAA0C;YAC1C,IAAI,CAAC,gBAAgB,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;QACnE,CAAC;QAED,+BAA+B;QAC/B,IAAI,CAAC,gBAAgB,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,aAAa,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC7D,CAAC;IAEO,KAAK,CAAC,UAAU;QACtB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;IAClF,CAAC;CACF"}

package/lib/client/sync/stream/streaming-sync-types.d.ts

@@ -0,0 +1,116 @@
+import { BucketChecksum, Checkpoint } from '../bucket/BucketStorageAdapter';
+import { CrudEntry, OpId } from '../bucket/CrudEntry';
+import { SyncDataBucketJSON } from '../bucket/SyncDataBucket';
+/**
+ * For sync2.json
+ */
+export interface ContinueCheckpointRequest {
+    /**
+     * Existing bucket states. Only these buckets are synchronized.
+     */
+    buckets: BucketRequest[];
+    checkpoint_token: string;
+    limit?: number;
+}
+export interface SyncNewCheckpointRequest {
+    /**
+     * Existing bucket states. Used if include_data is specified.
+     */
+    buckets?: BucketRequest[];
+    request_checkpoint: {
+        /**
+         * Whether or not to include an initial data request.
+         */
+        include_data: boolean;
+        /**
+         * Whether or not to compute a checksum.
+         */
+        include_checksum: boolean;
+    };
+    limit?: number;
+}
+export type SyncRequest = ContinueCheckpointRequest | SyncNewCheckpointRequest;
+export interface SyncResponse {
+    /**
+     * Data for the buckets returned. May not have an an entry for each bucket in the request.
+     */
+    data?: SyncDataBucketJSON[];
+    /**
+     * True if the response limit has been reached, and another request must be made.
+     */
+    has_more: boolean;
+    checkpoint_token?: string;
+    checkpoint?: Checkpoint;
+}
+export interface StreamingSyncRequest {
+    /**
+     * Existing bucket states.
+     */
+    buckets?: BucketRequest[];
+    /**
+     * If specified, limit the response to only include these buckets.
+     */
+    only?: string[];
+    /**
+     * Whether or not to compute a checksum for each checkpoint
+     */
+    include_checksum: boolean;
+    /**
+     * Changes the response to stringified data in each OplogEntry
+     */
+    raw_data: boolean;
+}
+export interface StreamingSyncCheckpoint {
+    checkpoint: Checkpoint;
+}
+export interface StreamingSyncCheckpointDiff {
+    checkpoint_diff: {
+        last_op_id: OpId;
+        updated_buckets: BucketChecksum[];
+        removed_buckets: string[];
+        write_checkpoint: string;
+    };
+}
+export interface StreamingSyncDataJSON {
+    data: SyncDataBucketJSON;
+}
+export interface StreamingSyncCheckpointComplete {
+    checkpoint_complete: {
+        last_op_id: OpId;
+    };
+}
+export interface StreamingSyncKeepalive {
+    /** If specified, token expires in this many seconds. */
+    token_expires_in: number;
+}
+export type StreamingSyncLine = StreamingSyncDataJSON | StreamingSyncCheckpoint | StreamingSyncCheckpointDiff | StreamingSyncCheckpointComplete | StreamingSyncKeepalive;
+export interface BucketRequest {
+    name: string;
+    /**
+     * Base-10 number. Sync all data from this bucket with op_id > after.
+     */
+    after: OpId;
+}
+export declare function isStreamingSyncData(line: StreamingSyncLine): line is StreamingSyncDataJSON;
+export declare function isStreamingKeepalive(line: StreamingSyncLine): line is StreamingSyncKeepalive;
+export declare function isStreamingSyncCheckpoint(line: StreamingSyncLine): line is StreamingSyncCheckpoint;
+export declare function isStreamingSyncCheckpointComplete(line: StreamingSyncLine): line is StreamingSyncCheckpointComplete;
+export declare function isStreamingSyncCheckpointDiff(line: StreamingSyncLine): line is StreamingSyncCheckpointDiff;
+export declare function isContinueCheckpointRequest(request: SyncRequest): request is ContinueCheckpointRequest;
+export declare function isSyncNewCheckpointRequest(request: SyncRequest): request is SyncNewCheckpointRequest;
+/**
+ * For crud.json
+ */
+export interface CrudRequest {
+    data: CrudEntry[];
+}
+export interface CrudResponse {
+    /**
+     * A sync response with a checkpoint >= this checkpoint would contain all the changes in this request.
+     *
+     * Any earlier checkpoint may or may not contain these changes.
+     *
+     * May be empty when the request contains no ops.
+     */
+    checkpoint?: OpId;
+}

package/lib/client/sync/stream/streaming-sync-types.js

@@ -0,0 +1,23 @@
+export function isStreamingSyncData(line) {
+    return line.data != null;
+}
+export function isStreamingKeepalive(line) {
+    return line.token_expires_in != null;
+}
+export function isStreamingSyncCheckpoint(line) {
+    return line.checkpoint != null;
+}
+export function isStreamingSyncCheckpointComplete(line) {
+    return line.checkpoint_complete != null;
+}
+export function isStreamingSyncCheckpointDiff(line) {
+    return line.checkpoint_diff != null;
+}
+export function isContinueCheckpointRequest(request) {
+    return (Array.isArray(request.buckets) &&
+        typeof request.checkpoint_token == 'string');
+}
+export function isSyncNewCheckpointRequest(request) {
+    return typeof request.request_checkpoint == 'object';
+}
+//# sourceMappingURL=streaming-sync-types.js.map

package/lib/client/sync/stream/streaming-sync-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streaming-sync-types.js","sourceRoot":"","sources":["../../../../src/client/sync/stream/streaming-sync-types.ts"],"names":[],"mappings":"AA2HA,MAAM,UAAU,mBAAmB,CAAC,IAAuB;IACzD,OAAQ,IAA8B,CAAC,IAAI,IAAI,IAAI,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAuB;IAC1D,OAAQ,IAA+B,CAAC,gBAAgB,IAAI,IAAI,CAAC;AACnE,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,IAAuB;IAC/D,OAAQ,IAAgC,CAAC,UAAU,IAAI,IAAI,CAAC;AAC9D,CAAC;AAED,MAAM,UAAU,iCAAiC,CAAC,IAAuB;IACvE,OAAQ,IAAwC,CAAC,mBAAmB,IAAI,IAAI,CAAC;AAC/E,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,IAAuB;IACnE,OAAQ,IAAoC,CAAC,eAAe,IAAI,IAAI,CAAC;AACvE,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,OAAoB;IAC9D,OAAO,CACL,KAAK,CAAC,OAAO,CAAE,OAAqC,CAAC,OAAO,CAAC;QAC7D,OAAQ,OAAqC,CAAC,gBAAgB,IAAI,QAAQ,CAC3E,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,OAAoB;IAC7D,OAAO,OAAQ,OAAoC,CAAC,kBAAkB,IAAI,QAAQ,CAAC;AACrF,CAAC"}

package/lib/db/Column.d.ts

@@ -0,0 +1,19 @@
+export declare enum ColumnType {
+    TEXT = "TEXT",
+    INTEGER = "INTEGER",
+    REAL = "REAL"
+}
+export interface ColumnOptions {
+    name: string;
+    type?: ColumnType;
+}
+export declare class Column {
+    protected options: ColumnOptions;
+    constructor(options: ColumnOptions);
+    get name(): string;
+    get type(): ColumnType | undefined;
+    toJSON(): {
+        name: string;
+        type: ColumnType | undefined;
+    };
+}