@powersync/service-core 0.18.1 → 1.7.1

package/dist/storage/SyncRulesBucketStorage.d.ts

@@ -0,0 +1,207 @@
+import { ObserverClient } from '@powersync/lib-services-framework';
+import { SqlSyncRules, SqliteJsonRow, SqliteJsonValue } from '@powersync/service-sync-rules';
+import * as util from '../util/util-index.js';
+import { BucketStorageBatch, FlushedResult } from './BucketStorageBatch.js';
+import { BucketStorageFactory } from './BucketStorageFactory.js';
+import { ParseSyncRulesOptions } from './PersistedSyncRulesContent.js';
+import { SourceEntityDescriptor } from './SourceEntity.js';
+import { SourceTable } from './SourceTable.js';
+import { SyncStorageWriteCheckpointAPI } from './WriteCheckpointAPI.js';
+/**
+ * Storage for a specific copy of sync rules.
+ */
+export interface SyncRulesBucketStorage extends ObserverClient<SyncRulesBucketStorageListener>, SyncStorageWriteCheckpointAPI {
+    readonly group_id: number;
+    readonly slot_name: string;
+    readonly factory: BucketStorageFactory;
+    /**
+     * Resolve a table, keeping track of it internally.
+     */
+    resolveTable(options: ResolveTableOptions): Promise<ResolveTableResult>;
+    /**
+     * Use this to get access to update storage data.
+     */
+    startBatch(options: StartBatchOptions, callback: (batch: BucketStorageBatch) => Promise<void>): Promise<FlushedResult | null>;
+    getParsedSyncRules(options: ParseSyncRulesOptions): SqlSyncRules;
+    /**
+     * Terminate the sync rules.
+     *
+     * This clears the storage, and sets state to TERMINATED.
+     *
+     * Must only be called on stopped sync rules.
+     */
+    terminate(options?: TerminateOptions): Promise<void>;
+    getStatus(): Promise<SyncRuleStatus>;
+    /**
+     * Clear the storage, without changing state.
+     */
+    clear(): Promise<void>;
+    autoActivate(): Promise<void>;
+    /**
+     * Record a replication error.
+     *
+     * This could be a recoverable error (e.g. temporary network failure),
+     * or a permanent error (e.g. missing toast data).
+     *
+     * Errors are cleared on commit.
+     */
+    reportError(e: any): Promise<void>;
+    compact(options?: CompactOptions): Promise<void>;
+    getCheckpoint(): Promise<ReplicationCheckpoint>;
+    /**
+     * Used to resolve "dynamic" parameter queries.
+     */
+    getParameterSets(checkpoint: util.OpId, lookups: SqliteJsonValue[][]): Promise<SqliteJsonRow[]>;
+    getCheckpointChanges(options: GetCheckpointChangesOptions): Promise<CheckpointChanges>;
+    /**
+     * Yields the latest user write checkpoint whenever the sync checkpoint updates.
+     *
+     * The stream stops or errors if this is not the active sync rules (anymore).
+     */
+    watchWriteCheckpoint(options: WatchWriteCheckpointOptions): AsyncIterable<StorageCheckpointUpdate>;
+    /**
+     * Get a "batch" of data for a checkpoint.
+     *
+     * The results will be split into separate SyncBucketData chunks to:
+     * 1. Separate buckets.
+     * 2. Limit the size of each individual chunk according to options.batchSizeLimitBytes.
+     *
+     * @param checkpoint the checkpoint
+     * @param dataBuckets current bucket states
+     * @param options batch size options
+     */
+    getBucketDataBatch(checkpoint: util.OpId, dataBuckets: Map<string, string>, options?: BucketDataBatchOptions): AsyncIterable<SyncBucketDataBatch>;
+    /**
+     * Compute checksums for a given list of buckets.
+     *
+     * Returns zero checksums for any buckets not found.
+     */
+    getChecksums(checkpoint: util.OpId, buckets: string[]): Promise<util.ChecksumMap>;
+}
+export interface SyncRulesBucketStorageListener {
+    batchStarted: (batch: BucketStorageBatch) => void;
+}
+export interface SyncRuleStatus {
+    checkpoint_lsn: string | null;
+    active: boolean;
+    snapshot_done: boolean;
+}
+export interface ResolveTableOptions {
+    group_id: number;
+    connection_id: number;
+    connection_tag: string;
+    entity_descriptor: SourceEntityDescriptor;
+    sync_rules: SqlSyncRules;
+}
+export interface ResolveTableResult {
+    table: SourceTable;
+    dropTables: SourceTable[];
+}
+export interface StartBatchOptions extends ParseSyncRulesOptions {
+    zeroLSN: string;
+    /**
+     * Whether or not to store a copy of the current data.
+     *
+     * This is needed if we need to apply partial updates, for example
+     * when we get TOAST values from Postgres.
+     *
+     * This is not needed when we get the full document from the source
+     * database, for example from MongoDB.
+     */
+    storeCurrentData: boolean;
+    /**
+     * Set to true for initial replication.
+     *
+     * This will avoid creating new operations for rows previously replicated.
+     */
+    skipExistingRows?: boolean;
+}
+export interface CompactOptions {
+    /**
+     * Heap memory limit for the compact process.
+     *
+     * Add around 64MB to this to determine the "--max-old-space-size" argument.
+     * Add another 80MB to get RSS usage / memory limits.
+     */
+    memoryLimitMB?: number;
+    /**
+     * If specified, ignore any operations newer than this when compacting.
+     *
+     * This is primarily for tests, where we want to test compacting at a specific
+     * point.
+     *
+     * This can also be used to create a "safe buffer" of recent operations that should
+     * not be compacted, to avoid invalidating checkpoints in use.
+     */
+    maxOpId?: bigint;
+    /**
+     * If specified, compact only the specific buckets.
+     *
+     * If not specified, compacts all buckets.
+     *
+     * These can be individual bucket names, or bucket definition names.
+     */
+    compactBuckets?: string[];
+    /** Minimum of 2 */
+    clearBatchLimit?: number;
+    /** Minimum of 1 */
+    moveBatchLimit?: number;
+    /** Minimum of 1 */
+    moveBatchQueryLimit?: number;
+}
+export interface TerminateOptions {
+    /**
+     * If true, also clear the storage before terminating.
+     */
+    clearStorage: boolean;
+}
+export interface BucketDataBatchOptions {
+    /** Limit number of documents returned. Defaults to 1000. */
+    limit?: number;
+    /**
+     * Limit size of chunks returned. Defaults to 1MB.
+     *
+     * This is a lower bound, not an upper bound. As soon as the chunk size goes over this limit,
+     * it is returned.
+     *
+     * Note that an individual data row can be close to 16MB in size, so this does not help in
+     * extreme cases.
+     */
+    chunkLimitBytes?: number;
+}
+export interface SyncBucketDataBatch {
+    batch: util.SyncBucketData;
+    targetOp: bigint | null;
+}
+export interface ReplicationCheckpoint {
+    readonly checkpoint: util.OpId;
+    readonly lsn: string | null;
+}
+export interface WatchWriteCheckpointOptions {
+    /** user_id and client_id combined. */
+    user_id: string;
+    signal: AbortSignal;
+}
+export interface WatchFilterEvent {
+    changedDataBucket?: string;
+    changedParameterBucketDefinition?: string;
+    invalidate?: boolean;
+}
+export interface WriteCheckpoint {
+    base: ReplicationCheckpoint;
+    writeCheckpoint: bigint | null;
+}
+export interface StorageCheckpointUpdate extends WriteCheckpoint {
+    update: CheckpointChanges;
+}
+export interface GetCheckpointChangesOptions {
+    lastCheckpoint: util.OpId;
+    nextCheckpoint: util.OpId;
+}
+export interface CheckpointChanges {
+    updatedDataBuckets: string[];
+    invalidateDataBuckets: boolean;
+    updatedParameterBucketDefinitions: string[];
+    invalidateParameterBuckets: boolean;
+}
+export declare const CHECKPOINT_INVALIDATE_ALL: CheckpointChanges;

package/dist/storage/SyncRulesBucketStorage.js

@@ -0,0 +1,7 @@
+export const CHECKPOINT_INVALIDATE_ALL = {
+    updatedDataBuckets: [],
+    invalidateDataBuckets: true,
+    updatedParameterBucketDefinitions: [],
+    invalidateParameterBuckets: true
+};
+//# sourceMappingURL=SyncRulesBucketStorage.js.map

package/dist/storage/SyncRulesBucketStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SyncRulesBucketStorage.js","sourceRoot":"","sources":["../../src/storage/SyncRulesBucketStorage.ts"],"names":[],"mappings":"AAmQA,MAAM,CAAC,MAAM,yBAAyB,GAAsB;IAC1D,kBAAkB,EAAE,EAAE;IACtB,qBAAqB,EAAE,IAAI;IAC3B,iCAAiC,EAAE,EAAE;IACrC,0BAA0B,EAAE,IAAI;CACjC,CAAC"}

package/dist/storage/bson.d.ts

@@ -1,14 +1,22 @@
 import * as bson from 'bson';
 import { SqliteJsonValue } from '@powersync/service-sync-rules';
-import { ReplicaId } from './BucketStorage.js';
+import { ReplicaId } from './BucketStorageBatch.js';
 type NodeBuffer = Buffer<ArrayBuffer>;
-export declare const BSON_DESERIALIZE_OPTIONS: bson.DeserializeOptions;
+/**
+ * Use for internal (bucket storage) data, where we control each field.
+ */
+export declare const BSON_DESERIALIZE_INTERNAL_OPTIONS: bson.DeserializeOptions;
+/**
+ * Use for data from external sources, which could contain arbitrary fields.
+ */
+export declare const BSON_DESERIALIZE_DATA_OPTIONS: bson.DeserializeOptions;
 /**
  * Lookup serialization must be number-agnostic. I.e. normalize numbers, instead of preserving numbers.
  * @param lookup
  */
 export declare const serializeLookupBuffer: (lookup: SqliteJsonValue[]) => NodeBuffer;
 export declare const serializeLookup: (lookup: SqliteJsonValue[]) => bson.Binary;
+export declare const getLookupBucketDefinitionName: (lookup: bson.Binary) => string;
 /**
  * True if this is a bson.UUID.
  *
@@ -17,7 +25,10 @@ export declare const serializeLookup: (lookup: SqliteJsonValue[]) => bson.Binary
 export declare const isUUID: (value: any) => value is bson.UUID;
 export declare const serializeReplicaId: (id: ReplicaId) => NodeBuffer;
 export declare const deserializeReplicaId: (id: Buffer) => ReplicaId;
-export declare const deserializeBson: (buffer: Buffer) => bson.Document;
+/**
+ * Deserialize BSON - can be used for BSON containing arbitrary user data.
+ */
+export declare const deserializeBson: (buffer: Uint8Array) => bson.Document;
 export declare const serializeBson: (document: any) => NodeBuffer;
 /**
  * Returns true if two ReplicaId values are the same (serializes to the same BSON value).

package/dist/storage/bson.js

@@ -1,8 +1,17 @@
 import * as bson from 'bson';
-export const BSON_DESERIALIZE_OPTIONS = {
+/**
+ * Use for internal (bucket storage) data, where we control each field.
+ */
+export const BSON_DESERIALIZE_INTERNAL_OPTIONS = {
     // use bigint instead of Long
     useBigInt64: true
 };
+/**
+ * Use for data from external sources, which could contain arbitrary fields.
+ */
+export const BSON_DESERIALIZE_DATA_OPTIONS = {
+    useBigInt64: true
+};
 /**
  * Lookup serialization must be number-agnostic. I.e. normalize numbers, instead of preserving numbers.
  * @param lookup
@@ -21,6 +30,10 @@ export const serializeLookupBuffer = (lookup) => {
 export const serializeLookup = (lookup) => {
     return new bson.Binary(serializeLookupBuffer(lookup));
 };
+export const getLookupBucketDefinitionName = (lookup) => {
+    const parsed = bson.deserialize(lookup.buffer, BSON_DESERIALIZE_INTERNAL_OPTIONS).l;
+    return parsed[0];
+};
 /**
  * True if this is a bson.UUID.
  *
@@ -40,8 +53,11 @@ export const deserializeReplicaId = (id) => {
     const deserialized = deserializeBson(id);
     return deserialized.id;
 };
+/**
+ * Deserialize BSON - can be used for BSON containing arbitrary user data.
+ */
 export const deserializeBson = (buffer) => {
-    return bson.deserialize(buffer, BSON_DESERIALIZE_OPTIONS);
+    return bson.deserialize(buffer, BSON_DESERIALIZE_DATA_OPTIONS);
 };
 export const serializeBson = (document) => {
     return bson.serialize(document);

package/dist/storage/bson.js.map

@@ -1 +1 @@
-{"version":3,"file":"bson.js","sourceRoot":"","sources":["../../src/storage/bson.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAO7B,MAAM,CAAC,MAAM,wBAAwB,GAA4B;IAC/D,6BAA6B;IAC7B,WAAW,EAAE,IAAI;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAyB,EAAc,EAAE;IAC7E,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACtC,IAAI,OAAO,KAAK,IAAI,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,UAAU,EAAE,CAAe,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAyB,EAAE,EAAE;IAC3D,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAU,EAAsB,EAAE;IACvD,IAAI,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,IAAI,GAAG,KAAkB,CAAC;IAChC,OAAO,IAAI,CAAC,SAAS,IAAI,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;AACjF,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,EAAa,EAAc,EAAE;IAC9D,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAe,CAAC;AAC9C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,EAAU,EAAa,EAAE;IAC5D,MAAM,YAAY,GAAG,eAAe,CAAC,EAAE,CAAC,CAAC;IACzC,OAAO,YAAY,CAAC,EAAE,CAAC;AACzB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAc,EAAE,EAAE;IAChD,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,QAAa,EAAc,EAAE;IACzD,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAe,CAAC;AAChD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAY,EAAE,CAAY,EAAE,EAAE;IAC5D,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,IAAI,OAAO,CAAC,IAAI,QAAQ,IAAI,OAAO,CAAC,IAAI,QAAQ,EAAE,CAAC;QACxD,OAAO,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;SAAM,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QAClC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;SAAM,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;SAAM,CAAC;QACN,iEAAiE;QACjE,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC,CAAC"}
+{"version":3,"file":"bson.js","sourceRoot":"","sources":["../../src/storage/bson.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAO7B;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAA4B;IACxE,6BAA6B;IAC7B,WAAW,EAAE,IAAI;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAA4B;IACpE,WAAW,EAAE,IAAI;CAClB,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAyB,EAAc,EAAE;IAC7E,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACtC,IAAI,OAAO,KAAK,IAAI,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE,UAAU,EAAE,CAAe,CAAC;AACzD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAyB,EAAE,EAAE;IAC3D,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC;AACxD,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,MAAmB,EAAE,EAAE;IACnE,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,iCAAiC,CAAC,CAAC,CAAsB,CAAC;IACzG,OAAO,MAAM,CAAC,CAAC,CAAW,CAAC;AAC7B,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,KAAU,EAAsB,EAAE;IACvD,IAAI,KAAK,IAAI,IAAI,IAAI,OAAO,KAAK,IAAI,QAAQ,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,IAAI,GAAG,KAAkB,CAAC;IAChC,OAAO,IAAI,CAAC,SAAS,IAAI,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;AACjF,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,EAAa,EAAc,EAAE;IAC9D,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,CAAe,CAAC;AAC9C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,EAAU,EAAa,EAAE;IAC5D,MAAM,YAAY,GAAG,eAAe,CAAC,EAAE,CAAC,CAAC;IACzC,OAAO,YAAY,CAAC,EAAE,CAAC;AACzB,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,MAAkB,EAAiB,EAAE;IACnE,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,QAAa,EAAc,EAAE;IACzD,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAe,CAAC;AAChD,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAY,EAAE,CAAY,EAAE,EAAE;IAC5D,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,IAAI,OAAO,CAAC,IAAI,QAAQ,IAAI,OAAO,CAAC,IAAI,QAAQ,EAAE,CAAC;QACxD,OAAO,CAAC,IAAI,CAAC,CAAC;IAChB,CAAC;SAAM,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QAClC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACrB,CAAC;SAAM,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;SAAM,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE,CAAC;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;SAAM,CAAC;QACN,iEAAiE;QACjE,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC,CAAC"}

package/dist/storage/storage-index.d.ts

@@ -7,3 +7,8 @@ export * from './SourceTable.js';
 export * from './StorageEngine.js';
 export * from './StorageProvider.js';
 export * from './WriteCheckpointAPI.js';
+export * from './BucketStorageFactory.js';
+export * from './BucketStorageBatch.js';
+export * from './SyncRulesBucketStorage.js';
+export * from './PersistedSyncRulesContent.js';
+export * from './ReplicationLock.js';

package/dist/storage/storage-index.js

@@ -7,4 +7,9 @@ export * from './SourceTable.js';
 export * from './StorageEngine.js';
 export * from './StorageProvider.js';
 export * from './WriteCheckpointAPI.js';
+export * from './BucketStorageFactory.js';
+export * from './BucketStorageBatch.js';
+export * from './SyncRulesBucketStorage.js';
+export * from './PersistedSyncRulesContent.js';
+export * from './ReplicationLock.js';
 //# sourceMappingURL=storage-index.js.map

package/dist/storage/storage-index.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage-index.js","sourceRoot":"","sources":["../../src/storage/storage-index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"storage-index.js","sourceRoot":"","sources":["../../src/storage/storage-index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,sBAAsB,CAAC"}

package/dist/sync/BucketChecksumState.d.ts

@@ -0,0 +1,91 @@
+import { BucketDescription, RequestParameters, SqlSyncRules } from '@powersync/service-sync-rules';
+import * as storage from '../storage/storage-index.js';
+import * as util from '../util/util-index.js';
+import { BucketSyncState } from './sync.js';
+export interface BucketChecksumStateOptions {
+    bucketStorage: BucketChecksumStateStorage;
+    syncRules: SqlSyncRules;
+    syncParams: RequestParameters;
+    initialBucketPositions?: {
+        name: string;
+        after: string;
+    }[];
+}
+/**
+ * Represents the state of the checksums and data for a specific connection.
+ *
+ * Handles incrementally re-computing checkpoints.
+ */
+export declare class BucketChecksumState {
+    private readonly bucketStorage;
+    /**
+     * Bucket state of bucket id -> op_id.
+     * This starts with the state from the client. May contain buckets that the user do not have access to (anymore).
+     */
+    bucketDataPositions: Map<string, BucketSyncState>;
+    /**
+     * Last checksums sent to the client. We keep this to calculate checkpoint diffs.
+     */
+    private lastChecksums;
+    private lastWriteCheckpoint;
+    private readonly parameterState;
+    /**
+     * Keep track of buckets that need to be downloaded. This is specifically relevant when
+     * partial checkpoints are sent.
+     */
+    private pendingBucketDownloads;
+    constructor(options: BucketChecksumStateOptions);
+    buildNextCheckpointLine(next: storage.StorageCheckpointUpdate): Promise<CheckpointLine | null>;
+    /**
+     * Get bucket positions to sync, given the list of buckets.
+     *
+     * @param bucketsToFetch List of buckets to fetch, typically from buildNextCheckpointLine, or a subset of that
+     * @returns
+     */
+    getFilteredBucketPositions(bucketsToFetch: BucketDescription[]): Map<string, string>;
+    /**
+     * Update the position of bucket data the client has.
+     *
+     * @param bucket the bucket name
+     * @param nextAfter sync operations >= this value in the next batch
+     */
+    updateBucketPosition(options: {
+        bucket: string;
+        nextAfter: string;
+        hasMore: boolean;
+    }): void;
+}
+export interface CheckpointUpdate {
+    /**
+     * All buckets forming part of the checkpoint.
+     */
+    buckets: BucketDescription[];
+    /**
+     * If present, a set of buckets that have been updated since the last checkpoint.
+     *
+     * If null, assume that any bucket in `buckets` may have been updated.
+     */
+    updatedBuckets: Set<string> | null;
+}
+export declare class BucketParameterState {
+    readonly bucketStorage: BucketChecksumStateStorage;
+    readonly syncRules: SqlSyncRules;
+    readonly syncParams: RequestParameters;
+    private readonly querier;
+    private readonly staticBuckets;
+    constructor(bucketStorage: BucketChecksumStateStorage, syncRules: SqlSyncRules, syncParams: RequestParameters);
+    getCheckpointUpdate(checkpoint: storage.StorageCheckpointUpdate): Promise<CheckpointUpdate | null>;
+    /**
+     * For static buckets, we can keep track of which buckets have been updated.
+     */
+    private getCheckpointUpdateStatic;
+    /**
+     * For dynamic buckets, we need to re-query the list of buckets every time.
+     */
+    private getCheckpointUpdateDynamic;
+}
+export interface CheckpointLine {
+    checkpointLine: util.StreamingSyncCheckpointDiff | util.StreamingSyncCheckpoint;
+    bucketsToFetch: BucketDescription[];
+}
+export type BucketChecksumStateStorage = Pick<storage.SyncRulesBucketStorage, 'getChecksums' | 'getParameterSets'>;