@powersync/service-core 0.16.0 → 0.17.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @powersync/service-core
 
+## 0.17.0
+
+### Minor Changes
+
+- 23fb49f: Added the ability to skip creating empty sync checkpoints if no changes were present in a batch.
+
+## 0.16.1
+
+### Patch Changes
+
+- Updated dependencies [5043a82]
+  - @powersync/service-sync-rules@0.23.3
+
 ## 0.16.0
 
 ### Minor Changes

package/dist/storage/BucketStorage.d.ts

@@ -44,6 +44,19 @@ export interface BucketStorageFactoryListener extends DisposableListener {
     syncStorageCreated: (storage: SyncRulesBucketStorage) => void;
     replicationEvent: (event: ReplicationEventPayload) => void;
 }
+export interface BucketStorageSystemIdentifier {
+    /**
+     * A unique identifier for the system used for storage.
+     * For Postgres this can be the cluster `system_identifier` and database name.
+     * For MongoDB this can be the replica set name.
+     */
+    id: string;
+    /**
+     * A unique type for the storage implementation.
+     * e.g. `mongodb`, `postgresql`.
+     */
+    type: string;
+}
 export interface BucketStorageFactory extends AsyncDisposableObserverClient<BucketStorageFactoryListener> {
     /**
      * Update sync rules from configuration, if changed.
@@ -117,6 +130,10 @@ export interface BucketStorageFactory extends AsyncDisposableObserverClient<Buck
      * Get the unique identifier for this instance of Powersync
      */
     getPowerSyncInstanceId(): Promise<string>;
+    /**
+     * Get a unique identifier for the system used for storage.
+     */
+    getSystemIdentifier(): Promise<BucketStorageSystemIdentifier>;
 }
 export interface ReplicationCheckpoint {
     readonly checkpoint: util.OpId;
@@ -288,6 +305,15 @@ export interface FlushedResult {
 export interface BucketBatchStorageListener extends DisposableListener {
     replicationEvent: (payload: ReplicationEventPayload) => void;
 }
+export interface BucketBatchCommitOptions {
+    /**
+     * Creates a new checkpoint even if there were no persisted operations.
+     * Defaults to true.
+     */
+    createEmptyCheckpoints?: boolean;
+}
+export type ResolvedBucketBatchCommitOptions = Required<BucketBatchCommitOptions>;
+export declare const DEFAULT_BUCKET_BATCH_COMMIT_OPTIONS: ResolvedBucketBatchCommitOptions;
 export interface BucketStorageBatch extends DisposableObserverClient<BucketBatchStorageListener> {
     /**
      * Save an op, and potentially flush.
@@ -315,11 +341,11 @@ export interface BucketStorageBatch extends DisposableObserverClient<BucketBatch
      */
     flush(): Promise<FlushedResult | null>;
     /**
-     * Flush and commit any saved ops. This creates a new checkpoint.
+     * Flush and commit any saved ops. This creates a new checkpoint by default.
      *
      * Only call this after a transaction.
      */
-    commit(lsn: string): Promise<boolean>;
+    commit(lsn: string, options?: BucketBatchCommitOptions): Promise<boolean>;
     /**
      * Advance the checkpoint LSN position, without any associated op.
      *

package/dist/storage/BucketStorage.js

@@ -26,6 +26,9 @@ export var SyncRuleState;
 })(SyncRuleState || (SyncRuleState = {}));
 export const DEFAULT_DOCUMENT_BATCH_LIMIT = 1000;
 export const DEFAULT_DOCUMENT_CHUNK_LIMIT_BYTES = 1 * 1024 * 1024;
+export const DEFAULT_BUCKET_BATCH_COMMIT_OPTIONS = {
+    createEmptyCheckpoints: true
+};
 export var SaveOperationTag;
 (function (SaveOperationTag) {
     SaveOperationTag["INSERT"] = "insert";

package/dist/storage/BucketStorage.js.map

@@ -1 +1 @@
-{"version":3,"file":"BucketStorage.js","sourceRoot":"","sources":["../../src/storage/BucketStorage.ts"],"names":[],"mappings":"AA+BA,MAAM,CAAN,IAAY,aAyBX;AAzBD,WAAY,aAAa;IACvB;;;;;OAKG;IACH,0CAAyB,CAAA;IAEzB;;;;OAIG;IACH,kCAAiB,CAAA;IACjB;;;OAGG;IACH,8BAAa,CAAA;IACb;;;OAGG;IACH,0CAAyB,CAAA;AAC3B,CAAC,EAzBW,aAAa,KAAb,aAAa,QAyBxB;AAsKD,MAAM,CAAC,MAAM,4BAA4B,GAAG,IAAI,CAAC;AACjD,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AAgOlE,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;AACnB,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AA4CD,MAAM,UAAU,UAAU,CAAC,MAA0B,EAAE,SAA6B;IAClF,MAAM,SAAS,GAAuB,EAAE,CAAC;IACzC,KAAK,IAAI,GAAG,IAAI,MAAM,EAAE,CAAC;QACvB,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,WAAW,EAAE,CAAC;YACtC,SAAS,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}
+{"version":3,"file":"BucketStorage.js","sourceRoot":"","sources":["../../src/storage/BucketStorage.ts"],"names":[],"mappings":"AA+BA,MAAM,CAAN,IAAY,aAyBX;AAzBD,WAAY,aAAa;IACvB;;;;;OAKG;IACH,0CAAyB,CAAA;IAEzB;;;;OAIG;IACH,kCAAiB,CAAA;IACjB;;;OAGG;IACH,8BAAa,CAAA;IACb;;;OAGG;IACH,0CAAyB,CAAA;AAC3B,CAAC,EAzBW,aAAa,KAAb,aAAa,QAyBxB;AAyLD,MAAM,CAAC,MAAM,4BAA4B,GAAG,IAAI,CAAC;AACjD,MAAM,CAAC,MAAM,kCAAkC,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AA4JlE,MAAM,CAAC,MAAM,mCAAmC,GAAqC;IACnF,sBAAsB,EAAE,IAAI;CAC7B,CAAC;AAgFF,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;AACnB,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AA4CD,MAAM,UAAU,UAAU,CAAC,MAA0B,EAAE,SAA6B;IAClF,MAAM,SAAS,GAAuB,EAAE,CAAC;IACzC,KAAK,IAAI,GAAG,IAAI,MAAM,EAAE,CAAC;QACvB,IAAI,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,WAAW,EAAE,CAAC;YACtC,SAAS,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/package.json

@@ -5,7 +5,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.16.0",
+  "version": "0.17.0",
   "main": "dist/index.js",
   "license": "FSL-1.1-Apache-2.0",
   "type": "module",
@@ -35,7 +35,7 @@
     "@powersync/lib-services-framework": "0.5.0",
     "@powersync/service-jsonbig": "0.17.10",
     "@powersync/service-rsocket-router": "0.0.17",
-    "@powersync/service-sync-rules": "0.23.2",
+    "@powersync/service-sync-rules": "0.23.3",
     "@powersync/service-types": "0.7.1"
   },
   "devDependencies": {

package/src/storage/BucketStorage.ts

@@ -60,6 +60,20 @@ export interface BucketStorageFactoryListener extends DisposableListener {
   replicationEvent: (event: ReplicationEventPayload) => void;
 }
 
+export interface BucketStorageSystemIdentifier {
+  /**
+   * A unique identifier for the system used for storage.
+   * For Postgres this can be the cluster `system_identifier` and database name.
+   * For MongoDB this can be the replica set name.
+   */
+  id: string;
+  /**
+   * A unique type for the storage implementation.
+   * e.g. `mongodb`, `postgresql`.
+   */
+  type: string;
+}
+
 export interface BucketStorageFactory extends AsyncDisposableObserverClient<BucketStorageFactoryListener> {
   /**
    * Update sync rules from configuration, if changed.
@@ -143,6 +157,11 @@ export interface BucketStorageFactory extends AsyncDisposableObserverClient<Buck
    * Get the unique identifier for this instance of Powersync
    */
   getPowerSyncInstanceId(): Promise<string>;
+
+  /**
+   * Get a unique identifier for the system used for storage.
+   */
+  getSystemIdentifier(): Promise<BucketStorageSystemIdentifier>;
 }
 
 export interface ReplicationCheckpoint {
@@ -367,6 +386,20 @@ export interface BucketBatchStorageListener extends DisposableListener {
   replicationEvent: (payload: ReplicationEventPayload) => void;
 }
 
+export interface BucketBatchCommitOptions {
+  /**
+   * Creates a new checkpoint even if there were no persisted operations.
+   * Defaults to true.
+   */
+  createEmptyCheckpoints?: boolean;
+}
+
+export type ResolvedBucketBatchCommitOptions = Required<BucketBatchCommitOptions>;
+
+export const DEFAULT_BUCKET_BATCH_COMMIT_OPTIONS: ResolvedBucketBatchCommitOptions = {
+  createEmptyCheckpoints: true
+};
+
 export interface BucketStorageBatch extends DisposableObserverClient<BucketBatchStorageListener> {
   /**
    * Save an op, and potentially flush.
@@ -398,11 +431,11 @@ export interface BucketStorageBatch extends DisposableObserverClient<BucketBatch
   flush(): Promise<FlushedResult | null>;
 
   /**
-   * Flush and commit any saved ops. This creates a new checkpoint.
+   * Flush and commit any saved ops. This creates a new checkpoint by default.
    *
    * Only call this after a transaction.
    */
-  commit(lsn: string): Promise<boolean>;
+  commit(lsn: string, options?: BucketBatchCommitOptions): Promise<boolean>;
 
   /**
    * Advance the checkpoint LSN position, without any associated op.