@powersync/common 0.0.0-dev-20240723112746 → 0.0.0-dev-20240726145924

package/lib/client/AbstractPowerSyncDatabase.d.ts

@@ -5,12 +5,12 @@ import { SyncStatus } from '../db/crud/SyncStatus';
 import { UploadQueueStats } from '../db/crud/UploadQueueStatus';
 import { Schema } from '../db/schema/Schema';
 import { BaseObserver } from '../utils/BaseObserver';
+import { SQLOpenFactory, SQLOpenOptions } from './SQLOpenFactory';
 import { PowerSyncBackendConnector } from './connection/PowerSyncBackendConnector';
 import { BucketStorageAdapter } from './sync/bucket/BucketStorageAdapter';
 import { CrudBatch } from './sync/bucket/CrudBatch';
 import { CrudTransaction } from './sync/bucket/CrudTransaction';
-import { AbstractStreamingSyncImplementation, StreamingSyncImplementationListener, StreamingSyncImplementation, PowerSyncConnectionOptions } from './sync/stream/AbstractStreamingSyncImplementation';
-import { SQLOpenFactory, SQLOpenOptions } from './SQLOpenFactory';
+import { AbstractStreamingSyncImplementation, PowerSyncConnectionOptions, StreamingSyncImplementation, StreamingSyncImplementationListener } from './sync/stream/AbstractStreamingSyncImplementation';
 export interface DisconnectAndClearOptions {
     /** When set to false, data in local-only tables is preserved. */
     clearLocal?: boolean;
@@ -96,6 +96,11 @@ export declare const DEFAULT_POWERSYNC_DB_OPTIONS: {
  * be obtained.
  */
 export declare const DEFAULT_LOCK_TIMEOUT_MS = 120000;
+/**
+ * Tests if the input is a {@link PowerSyncDatabaseOptionsWithSettings}
+ * @internal
+ */
+export declare const isPowerSyncDatabaseOptionsWithSettings: (test: any) => test is PowerSyncDatabaseOptionsWithSettings;
 export declare abstract class AbstractPowerSyncDatabase extends BaseObserver<PowerSyncDBListener> {
     protected options: PowerSyncDatabaseOptions;
     /**
@@ -143,7 +148,7 @@ export declare abstract class AbstractPowerSyncDatabase extends BaseObserver<Pow
     /**
      * Opens the DBAdapter given open options using a default open factory
      */
-    protected abstract openDBAdapter(options: SQLOpenOptions): DBAdapter;
+    protected abstract openDBAdapter(options: PowerSyncDatabaseOptionsWithSettings): DBAdapter;
     protected abstract generateSyncStreamImplementation(connector: PowerSyncBackendConnector): AbstractStreamingSyncImplementation;
     protected abstract generateBucketStorageAdapter(): BucketStorageAdapter;
     /**

package/lib/client/AbstractPowerSyncDatabase.js

@@ -6,15 +6,15 @@ import { isBatchedUpdateNotification } from '../db/DBAdapter';
 import { SyncStatus } from '../db/crud/SyncStatus';
 import { UploadQueueStats } from '../db/crud/UploadQueueStatus';
 import { BaseObserver } from '../utils/BaseObserver';
+import { ControlledExecutor } from '../utils/ControlledExecutor';
 import { mutexRunExclusive } from '../utils/mutex';
 import { quoteIdentifier } from '../utils/strings';
+import { isDBAdapter, isSQLOpenFactory, isSQLOpenOptions } from './SQLOpenFactory';
 import { PSInternalTable } from './sync/bucket/BucketStorageAdapter';
 import { CrudBatch } from './sync/bucket/CrudBatch';
 import { CrudEntry } from './sync/bucket/CrudEntry';
 import { CrudTransaction } from './sync/bucket/CrudTransaction';
 import { DEFAULT_CRUD_UPLOAD_THROTTLE_MS } from './sync/stream/AbstractStreamingSyncImplementation';
-import { ControlledExecutor } from '../utils/ControlledExecutor';
-import { isDBAdapter, isSQLOpenFactory, isSQLOpenOptions } from './SQLOpenFactory';
 const POWERSYNC_TABLE_MATCH = /(^ps_data__|^ps_data_local__)/;
 const DEFAULT_DISCONNECT_CLEAR_OPTIONS = {
     clearLocal: true
@@ -34,6 +34,13 @@ export const DEFAULT_POWERSYNC_DB_OPTIONS = {
  * be obtained.
  */
 export const DEFAULT_LOCK_TIMEOUT_MS = 120_000; // 2 mins
+/**
+ * Tests if the input is a {@link PowerSyncDatabaseOptionsWithSettings}
+ * @internal
+ */
+export const isPowerSyncDatabaseOptionsWithSettings = (test) => {
+    return typeof test == 'object' && isSQLOpenOptions(test.database);
+};
 export class AbstractPowerSyncDatabase extends BaseObserver {
     options;
     /**
@@ -68,8 +75,8 @@ export class AbstractPowerSyncDatabase extends BaseObserver {
         else if (isSQLOpenFactory(database)) {
             this._database = database.openDB();
         }
-        else if (isSQLOpenOptions(database)) {
-            this._database = this.openDBAdapter(database);
+        else if (isPowerSyncDatabaseOptionsWithSettings(options)) {
+            this._database = this.openDBAdapter(options);
         }
         this.bucketStorageAdapter = this.generateBucketStorageAdapter();
         this.closed = false;
@@ -663,4 +670,3 @@ export class AbstractPowerSyncDatabase extends BaseObserver {
         return this.database.readLock((tx) => tx.execute(sql, params));
     }
 }
-//# sourceMappingURL=AbstractPowerSyncDatabase.js.map

package/lib/client/AbstractPowerSyncOpenFactory.js

@@ -22,4 +22,3 @@ export class AbstractPowerSyncDatabaseOpenFactory {
         return this.generateInstance(options);
     }
 }
-//# sourceMappingURL=AbstractPowerSyncOpenFactory.js.map

package/lib/client/SQLOpenFactory.d.ts

@@ -8,6 +8,16 @@ export interface SQLOpenOptions {
      * Directory where the database file is located.
      */
     dbLocation?: string;
+    /**
+     * Enable debugMode to log queries to the performance timeline.
+     *
+     * Defaults to false.
+     *
+     * To enable in development builds, use:
+     *
+     *    debugMode: process.env.NODE_ENV !== 'production'
+     */
+    debugMode?: boolean;
 }
 export interface SQLOpenFactory {
     /**

package/lib/client/SQLOpenFactory.js

@@ -16,4 +16,3 @@ export const isSQLOpenFactory = (test) => {
 export const isDBAdapter = (test) => {
     return typeof test?.writeTransaction == 'function';
 };
-//# sourceMappingURL=SQLOpenFactory.js.map

package/lib/client/connection/PowerSyncBackendConnector.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=PowerSyncBackendConnector.js.map

package/lib/client/connection/PowerSyncCredentials.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=PowerSyncCredentials.js.map

package/lib/client/sync/bucket/BucketStorageAdapter.js

@@ -6,4 +6,3 @@ export var PSInternalTable;
     PSInternalTable["OPLOG"] = "ps_oplog";
     PSInternalTable["UNTYPED"] = "ps_untyped";
 })(PSInternalTable || (PSInternalTable = {}));
-//# sourceMappingURL=BucketStorageAdapter.js.map

package/lib/client/sync/bucket/CrudBatch.js

@@ -23,4 +23,3 @@ export class CrudBatch {
         this.complete = complete;
     }
 }
-//# sourceMappingURL=CrudBatch.js.map

package/lib/client/sync/bucket/CrudEntry.js

@@ -82,4 +82,3 @@ export class CrudEntry {
         return [this.transactionId, this.clientId, this.op, this.table, this.id, this.opData];
     }
 }
-//# sourceMappingURL=CrudEntry.js.map

package/lib/client/sync/bucket/CrudTransaction.js

@@ -22,4 +22,3 @@ export class CrudTransaction extends CrudBatch {
         this.transactionId = transactionId;
     }
 }
-//# sourceMappingURL=CrudTransaction.js.map

package/lib/client/sync/bucket/OpType.js

@@ -20,4 +20,3 @@ export class OpType {
         return Object.entries(OpTypeEnum).find(([, value]) => value === this.value)[0];
     }
 }
-//# sourceMappingURL=OpType.js.map

package/lib/client/sync/bucket/OplogEntry.js

@@ -31,4 +31,3 @@ export class OplogEntry {
         };
     }
 }
-//# sourceMappingURL=OplogEntry.js.map

package/lib/client/sync/bucket/SqliteBucketStorage.js

@@ -295,4 +295,3 @@ export class SqliteBucketStorage extends BaseObserver {
         // No-op for now
     }
 }
-//# sourceMappingURL=SqliteBucketStorage.js.map

package/lib/client/sync/bucket/SyncDataBatch.js

@@ -9,4 +9,3 @@ export class SyncDataBatch {
         this.buckets = buckets;
     }
 }
-//# sourceMappingURL=SyncDataBatch.js.map

package/lib/client/sync/bucket/SyncDataBucket.js

@@ -38,4 +38,3 @@ export class SyncDataBucket {
         };
     }
 }
-//# sourceMappingURL=SyncDataBucket.js.map

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

@@ -1,5 +1,5 @@
 import { ILogger } from 'js-logger';
-import { type fetch } from 'cross-fetch';
+import { fetch } from 'cross-fetch';
 import { PowerSyncCredentials } from '../../connection/PowerSyncCredentials';
 import { StreamingSyncLine, StreamingSyncRequest } from './streaming-sync-types';
 import { DataStream } from '../../../utils/DataStream';

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

@@ -1,4 +1,5 @@
 import Logger from 'js-logger';
+import { fetch } from 'cross-fetch';
 import { DataStream } from '../../../utils/DataStream';
 import ndjsonStream from 'can-ndjson-stream';
 import { RSocketConnector } from 'rsocket-core';
@@ -22,7 +23,7 @@ export const DEFAULT_REMOTE_LOGGER = Logger.get('PowerSyncRemote');
  */
 export class FetchImplementationProvider {
     getFetch() {
-        throw new Error('Unspecified fetch implementation');
+        return fetch.bind(globalThis);
     }
 }
 export const DEFAULT_REMOTE_OPTIONS = {
@@ -82,7 +83,7 @@ export class AbstractRemote {
     }
     async post(path, data, headers = {}) {
         const request = await this.buildRequest(path);
-        const res = await this.fetch(request.url, {
+        const res = await fetch(request.url, {
             method: 'POST',
             headers: {
                 ...headers,
@@ -179,8 +180,16 @@ export class AbstractRemote {
             socketIsClosed = true;
             rsocket.close();
         };
+        // Helps to prevent double close scenarios
+        rsocket.onClose(() => (socketIsClosed = true));
         // We initially request this amount and expect these to arrive eventually
         let pendingEventsCount = SYNC_QUEUE_REQUEST_N;
+        const disposeClosedListener = stream.registerListener({
+            closed: () => {
+                closeSocket();
+                disposeClosedListener();
+            }
+        });
         const socket = await new Promise((resolve, reject) => {
             let connectionEstablished = false;
             const res = rsocket.requestStream({
@@ -195,9 +204,8 @@ export class AbstractRemote {
                     if (e.message !== 'Closed. ') {
                         this.logger.error(e);
                     }
-                    // RSocket will close this automatically
-                    // Attempting to close multiple times causes a console warning
-                    socketIsClosed = true;
+                    // RSocket will close the RSocket stream automatically
+                    // Close the downstream stream as well - this will close the RSocket connection and WebSocket
                     stream.close();
                     // Handles cases where the connection failed e.g. auth error or connection error
                     if (!connectionEstablished) {
@@ -235,8 +243,7 @@ export class AbstractRemote {
                 }
             },
             closed: () => {
-                closeSocket();
-                l?.();
+                l();
             }
         });
         /**
@@ -347,7 +354,7 @@ export class AbstractRemote {
                 processStream();
             }
         });
-        const jsonS = ndjsonStream(outputStream);
+        const jsonS = ndjsonStream(new Response(outputStream).body);
         const stream = new DataStream({
             logger: this.logger
         });
@@ -377,4 +384,3 @@ export class AbstractRemote {
         return stream;
     }
 }
-//# sourceMappingURL=AbstractRemote.js.map

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

@@ -493,4 +493,3 @@ export class AbstractStreamingSyncImplementation extends BaseObserver {
         return new Promise((resolve) => setTimeout(resolve, this.options.retryDelayMs));
     }
 }
-//# sourceMappingURL=AbstractStreamingSyncImplementation.js.map

package/lib/client/sync/stream/streaming-sync-types.js

@@ -20,4 +20,3 @@ export function isContinueCheckpointRequest(request) {
 export function isSyncNewCheckpointRequest(request) {
     return typeof request.request_checkpoint == 'object';
 }
-//# sourceMappingURL=streaming-sync-types.js.map

package/lib/db/Column.js

@@ -23,4 +23,3 @@ export class Column {
         };
     }
 }
-//# sourceMappingURL=Column.js.map

package/lib/db/DBAdapter.js

@@ -17,4 +17,3 @@ export function isBatchedUpdateNotification(update) {
 export function extractTableUpdates(update) {
     return isBatchedUpdateNotification(update) ? update.tables : [update.table];
 }
-//# sourceMappingURL=DBAdapter.js.map

package/lib/db/crud/SyncStatus.js

@@ -55,4 +55,3 @@ export class SyncStatus {
         };
     }
 }
-//# sourceMappingURL=SyncStatus.js.map

package/lib/db/crud/UploadQueueStatus.js

@@ -22,4 +22,3 @@ export class UploadQueueStats {
         }
     }
 }
-//# sourceMappingURL=UploadQueueStatus.js.map

package/lib/db/schema/Index.js

@@ -27,4 +27,3 @@ export class Index {
         };
     }
 }
-//# sourceMappingURL=Index.js.map

package/lib/db/schema/IndexedColumn.js

@@ -27,4 +27,3 @@ export class IndexedColumn {
         };
     }
 }
-//# sourceMappingURL=IndexedColumn.js.map

package/lib/db/schema/Schema.js

@@ -34,4 +34,3 @@ export class Schema {
         });
     }
 }
-//# sourceMappingURL=Schema.js.map

package/lib/db/schema/Table.js

@@ -111,4 +111,3 @@ export class Table {
         };
     }
 }
-//# sourceMappingURL=Table.js.map

package/lib/db/schema/TableV2.js

@@ -41,4 +41,3 @@ export class TableV2 {
         }
     }
 }
-//# sourceMappingURL=TableV2.js.map

package/lib/index.js

@@ -32,4 +32,3 @@ export * from './utils/strings';
 export * from './utils/DataStream';
 export * from './utils/parseQuery';
 export * from './types/types';
-//# sourceMappingURL=index.js.map

package/lib/types/types.js

@@ -1,2 +1 @@
 export {};
-//# sourceMappingURL=types.js.map

package/lib/utils/AbortOperation.js

@@ -16,4 +16,3 @@ export class AbortOperation extends Error {
         }
     }
 }
-//# sourceMappingURL=AbortOperation.js.map

package/lib/utils/BaseObserver.js

@@ -21,4 +21,3 @@ export class BaseObserver {
         }
     }
 }
-//# sourceMappingURL=BaseObserver.js.map

package/lib/utils/ControlledExecutor.js

@@ -48,4 +48,3 @@ export class ControlledExecutor {
         }
     }
 }
-//# sourceMappingURL=ControlledExecutor.js.map

package/lib/utils/DataStream.js

@@ -160,4 +160,3 @@ export class DataStream extends BaseObserver {
         }
     }
 }
-//# sourceMappingURL=DataStream.js.map

package/lib/utils/mutex.js

@@ -26,4 +26,3 @@ export async function mutexRunExclusive(mutex, callback, options) {
         });
     });
 }
-//# sourceMappingURL=mutex.js.map

package/lib/utils/parseQuery.js

@@ -14,4 +14,3 @@ export const parseQuery = (query, parameters) => {
     }
     return { sqlStatement, parameters: parameters };
 };
-//# sourceMappingURL=parseQuery.js.map

package/lib/utils/strings.js

@@ -7,4 +7,3 @@ export function quoteJsonPath(path) {
 export function quoteIdentifier(s) {
     return `"${s.replaceAll('"', '""')}"`;
 }
-//# sourceMappingURL=strings.js.map

package/package.json

@@ -1,18 +1,17 @@
 {
   "name": "@powersync/common",
-  "version": "0.0.0-dev-20240723112746",
+  "version": "0.0.0-dev-20240726145924",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "description": "API definitions for JourneyApps PowerSync",
-  "main": "dist/index.js",
+  "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "author": "JOURNEYAPPS",
   "license": "Apache-2.0",
   "files": [
-    "lib",
-    "dist"
+    "lib"
   ],
   "repository": {
     "type": "git",
@@ -23,35 +22,27 @@
   },
   "homepage": "https://docs.powersync.com",
   "dependencies": {
-    "js-logger": "^1.6.1"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^25.0.7",
-    "@rollup/plugin-inject": "^5.0.5",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "15.2.3",
-    "@rollup/plugin-terser": "^0.4.4",
-    "@types/lodash": "^4.14.197",
-    "@types/node": "^20.5.9",
-    "@types/uuid": "^9.0.1",
     "async-mutex": "^0.4.0",
-    "bson": "^6.6.0",
     "buffer": "^6.0.3",
     "can-ndjson-stream": "^1.0.2",
     "cross-fetch": "^4.0.0",
     "event-iterator": "^2.0.0",
+    "js-logger": "^1.6.1",
     "lodash": "^4.17.21",
-    "rollup": "4.14.3",
     "rsocket-core": "1.0.0-alpha.3",
-    "rsocket-websocket-client": "1.0.0-alpha.3",
-    "text-encoding": "^0.7.0",
+    "rsocket-websocket-client": "1.0.0-alpha.3"
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.14.197",
+    "@types/node": "^20.5.9",
+    "@types/uuid": "^9.0.1",
     "typescript": "^5.5.3",
     "vitest": "^1.5.2",
-    "web-streams-polyfill": "3.2.1"
+    "bson": "^6.6.0"
   },
   "scripts": {
-    "build": "tsc -b && rollup -c rollup.config.mjs",
-    "clean": "rm -rf lib tsconfig.tsbuildinfo dist",
+    "build": "tsc -b",
+    "clean": "rm -rf lib tsconfig.tsbuildinfo",
     "test": "vitest"
   }
 }