@powersync/common 1.51.0 → 1.53.0

package/lib/client/sync/stream/AbstractStreamingSyncImplementation.d.ts

@@ -3,7 +3,7 @@ import { SyncStatus, SyncStatusOptions } from '../../../db/crud/SyncStatus.js';
 import { BaseListener, BaseObserver, BaseObserverInterface, Disposable } from '../../../utils/BaseObserver.js';
 import { BucketStorageAdapter } from '../bucket/BucketStorageAdapter.js';
 import { AbstractRemote, FetchStrategy } from './AbstractRemote.js';
-import { StreamingSyncRequestParameterType } from './streaming-sync-types.js';
+import { StreamingSyncRequestParameterType } from './JsonValue.js';
 export declare enum LockType {
     CRUD = "crud",
     SYNC = "sync"
@@ -13,35 +13,21 @@ export declare enum SyncStreamConnectionMethod {
     WEB_SOCKET = "web-socket"
 }
 export declare enum SyncClientImplementation {
-    /**
-     * Decodes and handles sync lines received from the sync service in JavaScript.
-     *
-     * This is the default option.
-     *
-     * @deprecated We recommend the {@link RUST} client implementation for all apps. If you have issues with
-     * the Rust client, please file an issue or reach out to us. The JavaScript client will be removed in a future
-     * version of the PowerSync SDK.
-     */
-    JAVASCRIPT = "js",
     /**
      * This implementation offloads the sync line decoding and handling into the PowerSync
      * core extension.
      *
-     * This option is more performant than the {@link JAVASCRIPT} client, enabled by default and the
-     * recommended client implementation for all apps.
+     * This is the only option, as an older JavaScript client implementation has been removed from the SDK.
      *
      * ## Compatibility warning
      *
      * The Rust sync client stores sync data in a format that is slightly different than the one used
-     * by the old {@link JAVASCRIPT} implementation. When adopting the {@link RUST} client on existing
-     * databases, the PowerSync SDK will migrate the format automatically.
-     * Further, the {@link JAVASCRIPT} client in recent versions of the PowerSync JS SDK (starting from
-     * the version introducing {@link RUST} as an option) also supports the new format, so you can switch
-     * back to {@link JAVASCRIPT} later.
+     * by the old JavaScript client. When adopting the {@link RUST} client on existing databases, the PowerSync SDK will
+     * migrate the format automatically.
      *
-     * __However__: Upgrading the SDK version, then adopting {@link RUST} as a sync client and later
-     * downgrading the SDK to an older version (necessarily using the JavaScript-based implementation then)
-     * can lead to sync issues.
+     * SDK versions supporting both the JavaScript and the Rust client support both formats with the JavaScript client
+     * implementaiton. However, downgrading to an SDK version that only supports the JavaScript client would not be
+     * possible anymore. Problematic SDK versions have been released before 2025-06-09.
      */
     RUST = "rust"
 }
@@ -94,11 +80,7 @@ export interface BaseConnectionOptions {
      */
     appMetadata?: Record<string, string>;
     /**
-     * Whether to use a JavaScript implementation to handle received sync lines from the sync
-     * service, or whether this work should be offloaded to the PowerSync core extension.
-     *
-     * This defaults to the JavaScript implementation ({@link SyncClientImplementation.JAVASCRIPT})
-     * since the ({@link SyncClientImplementation.RUST}) implementation is experimental at the moment.
+     * @deprecated The Rust sync client is used unconditionally, so this option can't be configured.
      */
     clientImplementation?: SyncClientImplementation;
     /**
@@ -155,15 +137,14 @@ export interface StreamingSyncImplementation extends BaseObserverInterface<Strea
      */
     disconnect(): Promise<void>;
     getWriteCheckpoint: () => Promise<string>;
-    hasCompletedSync: () => Promise<boolean>;
     isConnected: boolean;
-    lastSyncedAt?: Date;
     syncStatus: SyncStatus;
     triggerCrudUpload: () => void;
     waitForReady(): Promise<void>;
     waitForStatus(status: SyncStatusOptions): Promise<void>;
     waitUntilStatusMatches(predicate: (status: SyncStatus) => boolean): Promise<void>;
     updateSubscriptions(subscriptions: SubscribedStream[]): void;
+    markConnectionMayHaveChanged(): void;
 }
 export declare const DEFAULT_CRUD_UPLOAD_THROTTLE_MS = 1000;
 export declare const DEFAULT_RETRY_DELAY_MS = 5000;
@@ -178,14 +159,14 @@ export type SubscribedStream = {
     params: Record<string, any> | null;
 };
 export declare abstract class AbstractStreamingSyncImplementation extends BaseObserver<StreamingSyncImplementationListener> implements StreamingSyncImplementation {
-    protected _lastSyncedAt: Date | null;
     protected options: AbstractStreamingSyncImplementationOptions;
     protected abortController: AbortController | null;
-    protected uploadAbortController: AbortController | null;
+    protected uploadAbortController: AbortController | undefined;
     protected crudUpdateListener?: () => void;
     protected streamingSyncPromise?: Promise<void>;
     protected logger: ILogger;
     private activeStreams;
+    private connectionMayHaveChanged;
     private isUploadingCrud;
     private notifyCompletedUploads?;
     private handleActiveStreamsChange?;
@@ -199,7 +180,6 @@ export declare abstract class AbstractStreamingSyncImplementation extends BaseOb
     get isConnected(): boolean;
     dispose(): Promise<void>;
     abstract obtainLock<T>(lockOptions: LockOptions<T>): Promise<T>;
-    hasCompletedSync(): Promise<boolean>;
     getWriteCheckpoint(): Promise<string>;
     protected _uploadAllCrud(): Promise<void>;
     connect(options?: PowerSyncConnectionOptions): Promise<void>;
@@ -208,7 +188,7 @@ export declare abstract class AbstractStreamingSyncImplementation extends BaseOb
      * @deprecated use [connect instead]
      */
     streamingSync(signal?: AbortSignal, options?: PowerSyncConnectionOptions): Promise<void>;
-    private collectLocalBucketState;
+    markConnectionMayHaveChanged(): void;
     /**
      * Older versions of the JS SDK used to encode subkeys as JSON in {@link OplogEntry.toJSON}.
      * Because subkeys are always strings, this leads to quotes being added around them in `ps_oplog`.
@@ -226,10 +206,8 @@ export declare abstract class AbstractStreamingSyncImplementation extends BaseOb
      */
     private requireKeyFormat;
     protected streamingSyncIteration(signal: AbortSignal, options?: PowerSyncConnectionOptions): Promise<RustIterationResult | null>;
-    private legacyStreamingSyncIteration;
+    private receiveSyncLines;
     private rustSyncIteration;
-    private updateSyncStatusForStartingCheckpoint;
-    private applyCheckpoint;
     protected updateSyncStatus(options: SyncStatusOptions): void;
     private delayRetry;
     updateSubscriptions(subscriptions: SubscribedStream[]): void;