@powersync/common 1.31.0 → 1.32.0

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

@@ -0,0 +1,60 @@
+/**
+ * Adapted from rsocket-websocket-client
+ * https://github.com/rsocket/rsocket-js/blob/e224cf379e747c4f1ddc4f2fa111854626cc8575/packages/rsocket-websocket-client/src/WebsocketClientTransport.ts#L17
+ * This adds additional error handling for React Native iOS.
+ * This particularly adds a close listener to handle cases where the WebSocket
+ * connection closes immediately after opening without emitting an error.
+ */
+import { Deserializer } from 'rsocket-core';
+import { WebsocketDuplexConnection } from 'rsocket-websocket-client/dist/WebsocketDuplexConnection.js';
+export class WebsocketClientTransport {
+    url;
+    factory;
+    constructor(options) {
+        this.url = options.url;
+        this.factory = options.wsCreator ?? ((url) => new WebSocket(url));
+    }
+    connect(multiplexerDemultiplexerFactory) {
+        return new Promise((resolve, reject) => {
+            const websocket = this.factory(this.url);
+            websocket.binaryType = 'arraybuffer';
+            let removeListeners;
+            const openListener = () => {
+                removeListeners();
+                resolve(new WebsocketDuplexConnection(websocket, new Deserializer(), multiplexerDemultiplexerFactory));
+            };
+            const errorListener = (ev) => {
+                removeListeners();
+                // We add a default error in that case.
+                if (ev.error != null) {
+                    // undici typically provides an error object
+                    reject(ev.error);
+                }
+                else if (ev.message != null) {
+                    // React Native typically does not provide an error object, but does provide a message
+                    reject(new Error(`Failed to create websocket connection: ${ev.message}`));
+                }
+                else {
+                    // Browsers often provide no details at all
+                    reject(new Error(`Failed to create websocket connection to ${this.url}`));
+                }
+            };
+            /**
+             * In some cases, such as React Native iOS, the WebSocket connection may close immediately after opening
+             * without and error. In such cases, we need to handle the close event to reject the promise.
+             */
+            const closeListener = () => {
+                removeListeners();
+                reject(new Error('WebSocket connection closed while opening'));
+            };
+            removeListeners = () => {
+                websocket.removeEventListener('open', openListener);
+                websocket.removeEventListener('error', errorListener);
+                websocket.removeEventListener('close', closeListener);
+            };
+            websocket.addEventListener('open', openListener);
+            websocket.addEventListener('error', errorListener);
+            websocket.addEventListener('close', closeListener);
+        });
+    }
+}

package/lib/db/crud/SyncStatus.js

@@ -123,7 +123,21 @@ export class SyncStatus {
      * @returns {boolean} True if the instances are considered equal, false otherwise
      */
     isEqual(status) {
-        return JSON.stringify(this.options) == JSON.stringify(status.options);
+        /**
+         * By default Error object are serialized to an empty object.
+         * This replaces Errors with more useful information before serialization.
+         */
+        const replacer = (_, value) => {
+            if (value instanceof Error) {
+                return {
+                    name: value.name,
+                    message: value.message,
+                    stack: value.stack
+                };
+            }
+            return value;
+        };
+        return JSON.stringify(this.options, replacer) == JSON.stringify(status.options, replacer);
     }
     /**
      * Creates a human-readable string representation of the current sync status.

package/lib/index.d.ts

@@ -1,35 +1,34 @@
 export * from './client/AbstractPowerSyncDatabase.js';
 export * from './client/AbstractPowerSyncOpenFactory.js';
-export * from './client/SQLOpenFactory.js';
+export { compilableQueryWatch, CompilableQueryWatchHandler } from './client/compilableQueryWatch.js';
 export * from './client/connection/PowerSyncBackendConnector.js';
 export * from './client/connection/PowerSyncCredentials.js';
-export * from './client/sync/bucket/BucketStorageAdapter.js';
+export { MAX_OP_ID } from './client/constants.js';
 export { runOnSchemaChange } from './client/runOnSchemaChange.js';
-export { CompilableQueryWatchHandler, compilableQueryWatch } from './client/compilableQueryWatch.js';
-export { UpdateType, CrudEntry, OpId } from './client/sync/bucket/CrudEntry.js';
-export * from './client/sync/bucket/SqliteBucketStorage.js';
+export * from './client/SQLOpenFactory.js';
+export * from './client/sync/bucket/BucketStorageAdapter.js';
 export * from './client/sync/bucket/CrudBatch.js';
+export { CrudEntry, OpId, UpdateType } from './client/sync/bucket/CrudEntry.js';
 export * from './client/sync/bucket/CrudTransaction.js';
+export * from './client/sync/bucket/OplogEntry.js';
+export * from './client/sync/bucket/OpType.js';
+export * from './client/sync/bucket/SqliteBucketStorage.js';
 export * from './client/sync/bucket/SyncDataBatch.js';
 export * from './client/sync/bucket/SyncDataBucket.js';
-export * from './client/sync/bucket/OpType.js';
-export * from './client/sync/bucket/OplogEntry.js';
 export * from './client/sync/stream/AbstractRemote.js';
 export * from './client/sync/stream/AbstractStreamingSyncImplementation.js';
 export * from './client/sync/stream/streaming-sync-types.js';
-export { MAX_OP_ID } from './client/constants.js';
+export * from './client/ConnectionManager.js';
 export { ProgressWithOperations, SyncProgress } from './db/crud/SyncProgress.js';
 export * from './db/crud/SyncStatus.js';
 export * from './db/crud/UploadQueueStatus.js';
-export * from './db/schema/Schema.js';
-export * from './db/schema/Table.js';
+export * from './db/DBAdapter.js';
+export * from './db/schema/Column.js';
 export * from './db/schema/Index.js';
 export * from './db/schema/IndexedColumn.js';
-export * from './db/schema/Column.js';
+export * from './db/schema/Schema.js';
+export * from './db/schema/Table.js';
 export * from './db/schema/TableV2.js';
-export * from './db/crud/SyncStatus.js';
-export * from './db/crud/UploadQueueStatus.js';
-export * from './db/DBAdapter.js';
 export * from './utils/AbortOperation.js';
 export * from './utils/BaseObserver.js';
 export * from './utils/DataStream.js';

package/lib/index.js

@@ -1,35 +1,34 @@
 export * from './client/AbstractPowerSyncDatabase.js';
 export * from './client/AbstractPowerSyncOpenFactory.js';
-export * from './client/SQLOpenFactory.js';
+export { compilableQueryWatch } from './client/compilableQueryWatch.js';
 export * from './client/connection/PowerSyncBackendConnector.js';
 export * from './client/connection/PowerSyncCredentials.js';
-export * from './client/sync/bucket/BucketStorageAdapter.js';
+export { MAX_OP_ID } from './client/constants.js';
 export { runOnSchemaChange } from './client/runOnSchemaChange.js';
-export { compilableQueryWatch } from './client/compilableQueryWatch.js';
-export { UpdateType, CrudEntry } from './client/sync/bucket/CrudEntry.js';
-export * from './client/sync/bucket/SqliteBucketStorage.js';
+export * from './client/SQLOpenFactory.js';
+export * from './client/sync/bucket/BucketStorageAdapter.js';
 export * from './client/sync/bucket/CrudBatch.js';
+export { CrudEntry, UpdateType } from './client/sync/bucket/CrudEntry.js';
 export * from './client/sync/bucket/CrudTransaction.js';
+export * from './client/sync/bucket/OplogEntry.js';
+export * from './client/sync/bucket/OpType.js';
+export * from './client/sync/bucket/SqliteBucketStorage.js';
 export * from './client/sync/bucket/SyncDataBatch.js';
 export * from './client/sync/bucket/SyncDataBucket.js';
-export * from './client/sync/bucket/OpType.js';
-export * from './client/sync/bucket/OplogEntry.js';
 export * from './client/sync/stream/AbstractRemote.js';
 export * from './client/sync/stream/AbstractStreamingSyncImplementation.js';
 export * from './client/sync/stream/streaming-sync-types.js';
-export { MAX_OP_ID } from './client/constants.js';
+export * from './client/ConnectionManager.js';
 export { SyncProgress } from './db/crud/SyncProgress.js';
 export * from './db/crud/SyncStatus.js';
 export * from './db/crud/UploadQueueStatus.js';
-export * from './db/schema/Schema.js';
-export * from './db/schema/Table.js';
+export * from './db/DBAdapter.js';
+export * from './db/schema/Column.js';
 export * from './db/schema/Index.js';
 export * from './db/schema/IndexedColumn.js';
-export * from './db/schema/Column.js';
+export * from './db/schema/Schema.js';
+export * from './db/schema/Table.js';
 export * from './db/schema/TableV2.js';
-export * from './db/crud/SyncStatus.js';
-export * from './db/crud/UploadQueueStatus.js';
-export * from './db/DBAdapter.js';
 export * from './utils/AbortOperation.js';
 export * from './utils/BaseObserver.js';
 export * from './utils/DataStream.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powersync/common",
-  "version": "1.31.0",
+  "version": "1.32.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"