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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powersync/common",
-  "version": "0.0.0-dev-20260503073249",
+  "version": "0.0.0-dev-20260504100448",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -30,6 +30,9 @@
         "types": "./dist/index.d.cts",
         "require": "./dist/bundle.cjs"
       }
+    },
+    "./internal/sync_protocol": {
+      "types": "./legacy/sync_protocol.d.ts"
     }
   },
   "author": "PowerSync",
@@ -37,7 +40,8 @@
   "files": [
     "lib",
     "dist",
-    "src"
+    "src",
+    "legacy"
   ],
   "repository": {
     "type": "git",
@@ -57,7 +61,6 @@
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@types/node": "^24.0.0",
     "@types/uuid": "^9.0.6",
-    "bson": "^6.10.4",
     "buffer": "^6.0.3",
     "cross-fetch": "^4.1.0",
     "estree-walker": "^3.0.3",
@@ -73,6 +76,6 @@
     "build:prod": "tsc -b && rollup -c rollup.config.mjs",
     "clean": "rm -rf lib dist tsconfig.tsbuildinfo",
     "test": "vitest",
-    "test:exports": "attw --pack ."
+    "test:exports": "attw --pack . --exclude-entrypoints internal/sync_protocol"
   }
 }

package/src/client/sync/bucket/BucketStorageAdapter.ts

@@ -1,62 +1,6 @@
 import { BaseListener, BaseObserverInterface, Disposable } from '../../../utils/BaseObserver.js';
 import { CrudBatch } from './CrudBatch.js';
-import { CrudEntry, OpId } from './CrudEntry.js';
-import { SyncDataBatch } from './SyncDataBatch.js';
-
-export interface BucketDescription {
-  name: string;
-  priority: number;
-}
-
-export interface Checkpoint {
-  last_op_id: OpId;
-  buckets: BucketChecksum[];
-  write_checkpoint?: string;
-  streams?: any[];
-}
-
-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 type SavedProgress = {
-  atLast: number;
-  sinceLast: number;
-};
-
-export type BucketOperationProgress = Record<string, SavedProgress>;
-
-export interface BucketChecksum {
-  bucket: string;
-  priority?: number;
-  /**
-   * 32-bit unsigned hash.
-   */
-  checksum: number;
-
-  /**
-   * Count of operations - informational only.
-   */
-  count?: number;
-  /**
-   * The JavaScript client does not use this field, which is why it's defined to be `any`. We rely on the structure of
-   * this interface to pass custom `BucketChecksum`s to the Rust client in unit tests, which so all fields need to be
-   * present.
-   */
-  subscriptions?: any;
-}
+import { CrudEntry } from './CrudEntry.js';
 
 export enum PSInternalTable {
   DATA = 'ps_data',
@@ -82,27 +26,14 @@ export interface BucketStorageListener extends BaseListener {
 
 export interface BucketStorageAdapter extends BaseObserverInterface<BucketStorageListener>, Disposable {
   init(): Promise<void>;
-  saveSyncData(batch: SyncDataBatch, fixedKeyFormat?: boolean): Promise<void>;
-  removeBuckets(buckets: string[]): Promise<void>;
-  setTargetCheckpoint(checkpoint: Checkpoint): Promise<void>;
 
-  startSession(): void;
-
-  getBucketStates(): Promise<BucketState[]>;
-  getBucketOperationProgress(): Promise<BucketOperationProgress>;
   hasMigratedSubkeys(): Promise<boolean>;
   migrateToFixedSubkeys(): Promise<void>;
 
-  syncLocalDatabase(
-    checkpoint: Checkpoint,
-    priority?: number
-  ): Promise<{ checkpointValid: boolean; ready: boolean; failures?: any[] }>;
-
   nextCrudItem(): Promise<CrudEntry | undefined>;
   hasCrud(): Promise<boolean>;
   getCrudBatch(limit?: number): Promise<CrudBatch | null>;
 
-  hasCompletedSync(): Promise<boolean>;
   updateLocalTarget(cb: () => Promise<string>): Promise<boolean>;
   getMaxOpId(): string;
 

package/src/client/sync/bucket/SqliteBucketStorage.ts

@@ -3,23 +3,16 @@ import { DBAdapter, extractTableUpdates, Transaction } from '../../../db/DBAdapt
 import { BaseObserver } from '../../../utils/BaseObserver.js';
 import { MAX_OP_ID } from '../../constants.js';
 import {
-  BucketChecksum,
-  BucketOperationProgress,
-  BucketState,
   BucketStorageAdapter,
   BucketStorageListener,
-  Checkpoint,
   PowerSyncControlCommand,
-  PSInternalTable,
-  SyncLocalDatabaseResult
+  PSInternalTable
 } from './BucketStorageAdapter.js';
 import { CrudBatch } from './CrudBatch.js';
 import { CrudEntry, CrudEntryJSON } from './CrudEntry.js';
-import { SyncDataBatch } from './SyncDataBatch.js';
 
 export class SqliteBucketStorage extends BaseObserver<BucketStorageListener> implements BucketStorageAdapter {
   public tableNames: Set<string>;
-  private _hasCompletedSync: boolean;
   private updateListener: () => void;
   private _clientId?: Promise<string>;
 
@@ -28,7 +21,6 @@ export class SqliteBucketStorage extends BaseObserver<BucketStorageListener> imp
     private logger: ILogger = Logger.get('SqliteBucketStorage')
   ) {
     super();
-    this._hasCompletedSync = false;
     this.tableNames = new Set();
     this.updateListener = db.registerListener({
       tablesUpdated: (update) => {
@@ -41,7 +33,6 @@ export class SqliteBucketStorage extends BaseObserver<BucketStorageListener> imp
   }
 
   async init() {
-    this._hasCompletedSync = false;
     const existingTableRows = await this.db.getAll<{ name: string }>(
       `SELECT name FROM sqlite_master WHERE type='table' AND name GLOB 'ps_data_*'`
     );
@@ -70,182 +61,6 @@ export class SqliteBucketStorage extends BaseObserver<BucketStorageListener> imp
     return MAX_OP_ID;
   }
 
-  /**
-   * Reset any caches.
-   */
-  startSession(): void {}
-
-  async getBucketStates(): Promise<BucketState[]> {
-    const result = await this.db.getAll<BucketState>(
-      "SELECT name as bucket, cast(last_op as TEXT) as op_id FROM ps_buckets WHERE pending_delete = 0 AND name != '$local'"
-    );
-    return result;
-  }
-
-  async getBucketOperationProgress(): Promise<BucketOperationProgress> {
-    const rows = await this.db.getAll<{ name: string; count_at_last: number; count_since_last: number }>(
-      'SELECT name, count_at_last, count_since_last FROM ps_buckets'
-    );
-    return Object.fromEntries(rows.map((r) => [r.name, { atLast: r.count_at_last, sinceLast: r.count_since_last }]));
-  }
-
-  async saveSyncData(batch: SyncDataBatch, fixedKeyFormat: boolean = false) {
-    await this.writeTransaction(async (tx) => {
-      for (const b of batch.buckets) {
-        await tx.execute('INSERT INTO powersync_operations(op, data) VALUES(?, ?)', [
-          'save',
-          JSON.stringify({ buckets: [b.toJSON(fixedKeyFormat)] })
-        ]);
-        this.logger.debug(`Saved batch of data for  bucket: ${b.bucket}, operations: ${b.data.length}`);
-      }
-    });
-  }
-
-  async removeBuckets(buckets: string[]): Promise<void> {
-    for (const bucket of buckets) {
-      await this.deleteBucket(bucket);
-    }
-  }
-
-  /**
-   * Mark a bucket for deletion.
-   */
-  private async deleteBucket(bucket: string) {
-    await this.writeTransaction(async (tx) => {
-      await tx.execute('INSERT INTO powersync_operations(op, data) VALUES(?, ?)', ['delete_bucket', bucket]);
-    });
-
-    this.logger.debug(`Done deleting bucket ${bucket}`);
-  }
-
-  async hasCompletedSync() {
-    if (this._hasCompletedSync) {
-      return true;
-    }
-    const r = await this.db.get<{ synced_at: string | null }>(`SELECT powersync_last_synced_at() as synced_at`);
-    const completed = r.synced_at != null;
-    if (completed) {
-      this._hasCompletedSync = true;
-    }
-    return completed;
-  }
-
-  async syncLocalDatabase(checkpoint: Checkpoint, priority?: number): Promise<SyncLocalDatabaseResult> {
-    const r = await this.validateChecksums(checkpoint, priority);
-    if (!r.checkpointValid) {
-      this.logger.error('Checksums failed for', r.checkpointFailures);
-      for (const b of r.checkpointFailures ?? []) {
-        await this.deleteBucket(b);
-      }
-      return { ready: false, checkpointValid: false, checkpointFailures: r.checkpointFailures };
-    }
-    if (priority == null) {
-      this.logger.debug(`Validated checksums checkpoint ${checkpoint.last_op_id}`);
-    } else {
-      this.logger.debug(`Validated checksums for partial checkpoint ${checkpoint.last_op_id}, priority ${priority}`);
-    }
-
-    let buckets = checkpoint.buckets;
-    if (priority !== undefined) {
-      buckets = buckets.filter((b) => hasMatchingPriority(priority, b));
-    }
-    const bucketNames = buckets.map((b) => b.bucket);
-    await this.writeTransaction(async (tx) => {
-      await tx.execute(`UPDATE ps_buckets SET last_op = ? WHERE name IN (SELECT json_each.value FROM json_each(?))`, [
-        checkpoint.last_op_id,
-        JSON.stringify(bucketNames)
-      ]);
-
-      if (priority == null && checkpoint.write_checkpoint) {
-        await tx.execute("UPDATE ps_buckets SET last_op = ? WHERE name = '$local'", [checkpoint.write_checkpoint]);
-      }
-    });
-
-    const valid = await this.updateObjectsFromBuckets(checkpoint, priority);
-    if (!valid) {
-      return { ready: false, checkpointValid: true };
-    }
-
-    return {
-      ready: true,
-      checkpointValid: true
-    };
-  }
-
-  /**
-   * 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 async updateObjectsFromBuckets(checkpoint: Checkpoint, priority: number | undefined) {
-    let arg = '';
-    if (priority !== undefined) {
-      const affectedBuckets: string[] = [];
-      for (const desc of checkpoint.buckets) {
-        if (hasMatchingPriority(priority, desc)) {
-          affectedBuckets.push(desc.bucket);
-        }
-      }
-
-      arg = JSON.stringify({ priority, buckets: affectedBuckets });
-    }
-
-    return this.writeTransaction(async (tx) => {
-      const { insertId: result } = await tx.execute('INSERT INTO powersync_operations(op, data) VALUES(?, ?)', [
-        'sync_local',
-        arg
-      ]);
-      if (result == 1) {
-        if (priority == null) {
-          const bucketToCount = Object.fromEntries(checkpoint.buckets.map((b) => [b.bucket, b.count]));
-          // The two parameters could be replaced with one, but: https://github.com/powersync-ja/better-sqlite3/pull/6
-          const jsonBucketCount = JSON.stringify(bucketToCount);
-          await tx.execute(
-            "UPDATE ps_buckets SET count_since_last = 0, count_at_last = ?->name WHERE name != '$local' AND ?->name IS NOT NULL",
-            [jsonBucketCount, jsonBucketCount]
-          );
-        }
-
-        return true;
-      } else {
-        return false;
-      }
-    });
-  }
-
-  async validateChecksums(checkpoint: Checkpoint, priority: number | undefined): Promise<SyncLocalDatabaseResult> {
-    if (priority !== undefined) {
-      // Only validate the buckets within the priority we care about
-      const newBuckets = checkpoint.buckets.filter((cs) => hasMatchingPriority(priority, cs));
-      checkpoint = { ...checkpoint, buckets: newBuckets };
-    }
-
-    const rs = await this.db.execute('SELECT powersync_validate_checkpoint(?) as result', [
-      JSON.stringify({ ...checkpoint })
-    ]);
-
-    const resultItem = rs.rows?.item(0);
-    if (!resultItem) {
-      return {
-        checkpointValid: false,
-        ready: false,
-        checkpointFailures: []
-      };
-    }
-
-    const result = JSON.parse(resultItem['result']);
-
-    if (result['valid']) {
-      return { ready: true, checkpointValid: true };
-    } else {
-      return {
-        checkpointValid: false,
-        ready: false,
-        checkpointFailures: result['failed_buckets']
-      };
-    }
-  }
-
   async updateLocalTarget(cb: () => Promise<string>): Promise<boolean> {
     const rs1 = await this.db.getAll(
       "SELECT target_op FROM ps_buckets WHERE name = '$local' AND target_op = CAST(? as INTEGER)",
@@ -356,13 +171,6 @@ export class SqliteBucketStorage extends BaseObserver<BucketStorageListener> imp
     return this.db.writeTransaction(callback, options);
   }
 
-  /**
-   * Set a target checkpoint.
-   */
-  async setTargetCheckpoint(checkpoint: Checkpoint) {
-    // No-op for now
-  }
-
   async control(op: PowerSyncControlCommand, payload: string | Uint8Array | ArrayBuffer | null): Promise<string> {
     return await this.writeTransaction(async (tx) => {
       const [[raw]] = await tx.executeRaw('SELECT powersync_control(?, ?)', [op, payload]);
@@ -389,7 +197,3 @@ export class SqliteBucketStorage extends BaseObserver<BucketStorageListener> imp
 
   static _subkeyMigrationKey = 'powersync_js_migrated_subkeys';
 }
-
-function hasMatchingPriority(priority: number, bucket: BucketChecksum) {
-  return bucket.priority != null && bucket.priority <= priority;
-}

package/src/client/sync/stream/AbstractRemote.ts

@@ -1,4 +1,3 @@
-import type { BSON } from 'bson';
 import { type fetch } from 'cross-fetch';
 import Logger, { ILogger } from 'js-logger';
 import { Requestable, RSocket, RSocketConnector } from 'rsocket-core';
@@ -6,7 +5,6 @@ import PACKAGE from '../../../../package.json' with { type: 'json' };
 import { AbortOperation } from '../../../utils/AbortOperation.js';
 import { PowerSyncCredentials } from '../../connection/PowerSyncCredentials.js';
 import { WebsocketClientTransport } from './WebsocketClientTransport.js';
-import { StreamingSyncRequest } from './streaming-sync-types.js';
 import {
   doneResult,
   extractBsonObjects,
@@ -16,8 +14,6 @@ import {
 import { EventIterator } from 'event-iterator';
 import type { Queue } from 'event-iterator/lib/event-iterator.js';
 
-export type BSONImplementation = typeof BSON;
-
 export type RemoteConnector = {
   fetchCredentials: () => Promise<PowerSyncCredentials | null>;
   invalidateCredentials?: () => void;
@@ -44,7 +40,7 @@ export const DEFAULT_REMOTE_LOGGER = Logger.get('PowerSyncRemote');
 
 export type SyncStreamOptions = {
   path: string;
-  data: StreamingSyncRequest;
+  data: unknown;
   headers?: Record<string, string>;
   abortSignal: AbortSignal;
   fetchOptions?: Request;
@@ -265,11 +261,6 @@ export abstract class AbstractRemote {
     return res.json();
   }
 
-  /**
-   * Provides a BSON implementation. The import nature of this varies depending on the platform
-   */
-  abstract getBSON(): Promise<BSONImplementation>;
-
   /**
    * @returns A text decoder decoding UTF-8. This is a method to allow patching it for Hermes which doesn't support the
    * builtin, without forcing us to bundle a polyfill with `@powersync/common`.
@@ -286,26 +277,13 @@ export abstract class AbstractRemote {
    * Returns a data stream of sync line data, fetched via RSocket-over-WebSocket.
    *
    * The only mechanism to abort the returned stream is to use the abort signal in {@link SocketSyncStreamOptions}.
-   *
-   * @param bson A BSON encoder and decoder. When set, the data stream will be requested with a BSON payload
-   * (required for compatibility with older sync services).
    */
-  async socketStreamRaw(
-    options: SocketSyncStreamOptions,
-    bson?: typeof BSON
-  ): Promise<SimpleAsyncIterator<Uint8Array>> {
+  async socketStreamRaw(options: SocketSyncStreamOptions): Promise<SimpleAsyncIterator<Uint8Array>> {
     const { path, fetchStrategy = FetchStrategy.Buffered } = options;
-    const mimeType = bson == null ? 'application/json' : 'application/bson';
+    const mimeType = 'application/json';
 
     function toBuffer(js: any): Buffer {
-      let contents: any;
-      if (bson != null) {
-        contents = bson.serialize(js);
-      } else {
-        contents = JSON.stringify(js);
-      }
-
-      return Buffer.from(contents);
+      return Buffer.from(JSON.stringify(js));
     }
 
     const syncQueueRequestSize = fetchStrategy == FetchStrategy.Buffered ? 10 : 1;
@@ -575,7 +553,7 @@ export abstract class AbstractRemote {
 
       const contentType = res.headers.get('content-type');
       responseIsBson = contentType == bson;
-    } catch (ex) {
+    } catch (ex: any) {
       if (ex.name == 'AbortError') {
         throw new AbortOperation(`Pending fetch request to ${request.url} has been aborted.`);
       }