@powersync/node 0.8.0 → 0.9.0

package/README.md

@@ -11,9 +11,9 @@ Using this package is not necessary for PowerSync on servers, see [our documenta
 
 See a summary of features [here](https://docs.powersync.com/client-sdk-references/node).
 
-## Alpha Release
+## Beta Release
 
-The `@powersync/node` package is currently in an Alpha release.
+The `@powersync/node` package is currently in a Beta release.
 
 # Installation
 

package/dist/bundle.d.cts

@@ -0,0 +1,75 @@
+import { SQLOpenOptions, PowerSyncDatabaseOptions, DBAdapter, SQLOpenFactory, AbstractRemoteOptions, AdditionalConnectionOptions, PowerSyncConnectionOptions, AbstractPowerSyncDatabase, PowerSyncDatabaseOptionsWithSettings, BucketStorageAdapter, PowerSyncBackendConnector, AbstractStreamingSyncImplementation } from '@powersync/common';
+export * from '@powersync/common';
+import { Dispatcher } from 'undici';
+import { Worker } from 'node:worker_threads';
+
+type NodeCustomConnectionOptions = {
+    /**
+     * Optional custom dispatcher for HTTP or WEB_SOCKET connections.
+     *
+     * This can be used to customize proxy usage (using undici ProxyAgent),
+     * or other connection options.
+     */
+    dispatcher?: Dispatcher;
+};
+
+type WorkerOpener = (...args: ConstructorParameters<typeof Worker>) => InstanceType<typeof Worker>;
+/**
+ * The {@link SQLOpenOptions} available across all PowerSync SDKs for JavaScript extended with
+ * Node.JS-specific options.
+ */
+interface NodeSQLOpenOptions extends SQLOpenOptions {
+    /**
+     * The Node.JS SDK will use one worker to run writing queries and additional workers to run reads.
+     * This option controls how many workers to use for reads.
+     */
+    readWorkerCount?: number;
+    /**
+     * A callback to allow customizing how the Node.JS SDK loads workers. This can be customized to
+     * use workers at different paths.
+     *
+     * @param args The arguments that would otherwise be passed to the {@link Worker} constructor.
+     * @returns the resolved worker.
+     */
+    openWorker?: WorkerOpener;
+}
+
+type NodePowerSyncDatabaseOptions = PowerSyncDatabaseOptions & {
+    database: DBAdapter | SQLOpenFactory | NodeSQLOpenOptions;
+    /**
+     * Options to override how the SDK will connect to the sync service.
+     *
+     * This option is intended to be used for internal tests.
+     */
+    remoteOptions?: Partial<AbstractRemoteOptions>;
+};
+type NodeAdditionalConnectionOptions = AdditionalConnectionOptions & NodeCustomConnectionOptions;
+type NodePowerSyncConnectionOptions = PowerSyncConnectionOptions & NodeAdditionalConnectionOptions;
+/**
+ * A PowerSync database which provides SQLite functionality
+ * which is automatically synced.
+ *
+ * @example
+ * ```typescript
+ * export const db = new PowerSyncDatabase({
+ *  schema: AppSchema,
+ *  database: {
+ *    dbFilename: 'example.db'
+ *  }
+ * });
+ * ```
+ */
+declare class PowerSyncDatabase extends AbstractPowerSyncDatabase {
+    constructor(options: NodePowerSyncDatabaseOptions);
+    _initialize(): Promise<void>;
+    /**
+     * Opens a DBAdapter using better-sqlite3 as the default SQLite open factory.
+     */
+    protected openDBAdapter(options: PowerSyncDatabaseOptionsWithSettings): DBAdapter;
+    protected generateBucketStorageAdapter(): BucketStorageAdapter;
+    connect(connector: PowerSyncBackendConnector, options?: PowerSyncConnectionOptions & NodeCustomConnectionOptions): Promise<void>;
+    protected generateSyncStreamImplementation(connector: PowerSyncBackendConnector, options: NodeAdditionalConnectionOptions): AbstractStreamingSyncImplementation;
+}
+
+export { PowerSyncDatabase };
+export type { NodeAdditionalConnectionOptions, NodePowerSyncConnectionOptions, NodePowerSyncDatabaseOptions };

package/dist/worker.d.cts

@@ -0,0 +1,12 @@
+interface PowerSyncWorkerOptions {
+    /**
+     * A function responsible for finding the powersync DLL/so/dylib file.
+     *
+     * @returns The absolute path of the PowerSync SQLite core extensions library.
+     */
+    extensionPath: () => string;
+}
+declare function startPowerSyncWorker(options?: Partial<PowerSyncWorkerOptions>): void;
+
+export { startPowerSyncWorker };
+export type { PowerSyncWorkerOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powersync/node",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -15,14 +15,24 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": "./lib/index.js",
-      "require": "./dist/bundle.cjs",
-      "types": "./lib/index.d.ts"
+      "import": {
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
+      },
+      "require": {
+        "types": "./dist/bundle.d.cts",
+        "default": "./dist/bundle.cjs"
+      }
     },
     "./worker.js": {
-      "import": "./lib/worker.js",
-      "require": "./dist/worker.cjs",
-      "types": "./lib/worker.d.ts"
+      "import": {
+        "types": "./lib/worker.d.ts",
+        "default": "./lib/worker.js"
+      },
+      "require": {
+        "types": "./dist/worker.d.cts",
+        "default": "./dist/worker.cjs"
+      }
     },
     "./package.json": "./package.json"
   },
@@ -37,7 +47,7 @@
   },
   "homepage": "https://docs.powersync.com/",
   "peerDependencies": {
-    "@powersync/common": "^1.34.0"
+    "@powersync/common": "^1.36.0"
   },
   "dependencies": {
     "@powersync/better-sqlite3": "^0.2.0",
@@ -45,15 +55,15 @@
     "bson": "^6.6.0",
     "comlink": "^4.4.2",
     "undici": "^7.11.0",
-    "@powersync/common": "1.34.0"
+    "@powersync/common": "1.36.0"
   },
   "devDependencies": {
     "@types/async-lock": "^1.4.0",
     "drizzle-orm": "^0.35.2",
     "rollup": "4.14.3",
     "typescript": "^5.5.3",
-    "vitest": "^3.0.5",
-    "@powersync/drizzle-driver": "0.4.0"
+    "vitest": "^3.2.4",
+    "@powersync/drizzle-driver": "0.5.0"
   },
   "keywords": [
     "data sync",
@@ -66,8 +76,9 @@
     "install": "node download_core.js",
     "build": "tsc -b && rollup --config",
     "build:prod": "tsc -b --sourceMap false && rollup --config",
-    "clean": "rm -rf lib dist tsconfig.tsbuildinfo dist",
+    "clean": "rm -rf lib dist tsconfig.tsbuildinfo",
     "watch": "tsc -b -w",
-    "test": "vitest"
+    "test": "vitest",
+    "test:exports": "attw --pack . --ignore-rules no-resolution"
   }
 }