@powersync/node 0.0.0-dev-20250318143512

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,47 @@
+<p align="center">
+  <a href="https://www.powersync.com" target="_blank"><img src="https://github.com/powersync-ja/.github/assets/7372448/d2538c43-c1a0-4c47-9a76-41462dba484f"/></a>
+</p>
+
+# PowerSync SDK for Node.js
+
+_[PowerSync](https://www.powersync.com) is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres, MongoDB or MySQL on the server-side._
+
+This package (`packages/node`) is the PowerSync SDK for Node.js clients. It is an extension of `packages/common`.
+Using this package is not necessary for PowerSync on servers, see [our documentation](https://docs.powersync.com/installation/app-backend-setup) for more details on that.
+
+See a summary of features [here](https://docs.powersync.com/client-sdk-references/node).
+
+## Alpha Release
+
+The `@powersync/node` package is currently in an Alpha release.
+
+# Installation
+
+## Install Package
+
+```bash
+npm install @powersync/node
+```
+
+Both `@powersync/node` and the `better-sqlite3` packages have install scripts that need to run to compile
+or download sqlite3 and PowerSync binaries.
+
+# Getting Started
+
+The [Node.js SDK reference](https://docs.powersync.com/client-sdk-references/node)
+contains everything you need to know to get started implementing PowerSync in your project.
+
+# Examples
+
+A simple example using `@powersync/node` is available in the [`demos/example-node/`](../demos/example-node) directory.
+
+# Found a bug or need help?
+
+- Join our [Discord server](https://discord.gg/powersync) where you can browse topics from our community, ask questions, share feedback, or just say hello :)
+- Please open a [GitHub issue](https://github.com/powersync-ja/powersync-js/issues) when you come across a bug.
+- Have feedback or an idea? [Submit an idea](https://roadmap.powersync.com/tabs/5-roadmap/submit-idea) via our public roadmap or [schedule a chat](https://calendly.com/powersync-product/powersync-chat) with someone from our product team.
+
+# Thanks
+
+The PowerSync Node.js SDK relies on the work contributors and maintainers have put into the upstream better-sqlite3 package.
+In particular, we'd like to thank [@spinda](https://github.com/spinda) for contributing support for update, commit and rollback hooks!

package/download_core.js

@@ -0,0 +1,46 @@
+// TODO: Make this a pre-publish hook and just bundle everything
+import * as OS from 'node:os';
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import { Readable } from 'node:stream';
+import { finished } from 'node:stream/promises';
+import { exit } from 'node:process';
+
+const version = '0.3.11';
+
+const platform = OS.platform();
+let destination;
+let asset;
+
+if (platform === 'win32') {
+  asset = 'powersync_x64.dll';
+  destination = 'powersync.dll';
+} else if (platform === 'linux') {
+  asset = OS.arch() === 'x64' ? 'libpowersync_x64.so' : 'libpowersync_aarch64.so';
+  destination = 'libpowersync.so';
+} else if (platform === 'darwin') {
+  asset = OS.arch() === 'x64' ? 'libpowersync_x64.dylib' : 'libpowersync_aarch64.dylib';
+  destination = 'libpowersync.dylib';
+}
+
+const destinationPath = path.resolve('lib', destination);
+try {
+  await fs.access(destinationPath);
+  exit(0);
+} catch {}
+
+const url = `https://github.com/powersync-ja/powersync-sqlite-core/releases/download/v${version}/${asset}`;
+const response = await fetch(url);
+if (response.status != 200) {
+  throw `Could not download ${url}`;
+}
+
+try {
+  await fs.access('lib');
+} catch {
+  await fs.mkdir('lib');
+}
+
+const file = await fs.open(destinationPath, 'w');
+await finished(Readable.fromWeb(response.body).pipe(file.createWriteStream()));
+await file.close();

package/lib/db/AsyncDatabase.d.ts

@@ -0,0 +1,16 @@
+import { QueryResult } from '@powersync/common';
+export type ProxiedQueryResult = Omit<QueryResult, 'rows'> & {
+    rows?: {
+        _array: any[];
+        length: number;
+    };
+};
+export interface AsyncDatabaseOpener {
+    open(path: string, isWriter: boolean): Promise<AsyncDatabase>;
+}
+export interface AsyncDatabase {
+    execute: (query: string, params: any[]) => Promise<ProxiedQueryResult>;
+    executeBatch: (query: string, params: any[][]) => Promise<ProxiedQueryResult>;
+    close: () => Promise<void>;
+    collectCommittedUpdates: () => Promise<string[]>;
+}

package/lib/db/AsyncDatabase.js

@@ -0,0 +1 @@
+export {};

package/lib/db/BetterSQLite3DBAdapter.d.ts

@@ -0,0 +1,30 @@
+import { BaseObserver, DBAdapter, DBAdapterListener, LockContext, Transaction, DBLockOptions, QueryResult, SQLOpenOptions } from '@powersync/common';
+export type BetterSQLite3LockContext = LockContext & {
+    executeBatch(query: string, params?: any[][]): Promise<QueryResult>;
+};
+export type BetterSQLite3Transaction = Transaction & BetterSQLite3LockContext;
+/**
+ * Adapter for better-sqlite3
+ */
+export declare class BetterSQLite3DBAdapter extends BaseObserver<DBAdapterListener> implements DBAdapter {
+    private readonly options;
+    readonly name: string;
+    private readConnections;
+    private writeConnection;
+    private readonly readQueue;
+    private readonly writeQueue;
+    constructor(options: SQLOpenOptions);
+    initialize(): Promise<void>;
+    close(): Promise<void>;
+    readLock<T>(fn: (tx: BetterSQLite3LockContext) => Promise<T>, _options?: DBLockOptions | undefined): Promise<T>;
+    writeLock<T>(fn: (tx: BetterSQLite3LockContext) => Promise<T>, _options?: DBLockOptions | undefined): Promise<T>;
+    readTransaction<T>(fn: (tx: BetterSQLite3Transaction) => Promise<T>, _options?: DBLockOptions | undefined): Promise<T>;
+    writeTransaction<T>(fn: (tx: BetterSQLite3Transaction) => Promise<T>, _options?: DBLockOptions | undefined): Promise<T>;
+    private internalTransaction;
+    getAll<T>(sql: string, parameters?: any[]): Promise<T[]>;
+    getOptional<T>(sql: string, parameters?: any[]): Promise<T | null>;
+    get<T>(sql: string, parameters?: any[]): Promise<T>;
+    execute(query: string, params?: any[] | undefined): Promise<QueryResult>;
+    executeBatch(query: string, params?: any[][]): Promise<QueryResult>;
+    refreshSchema(): Promise<void>;
+}

package/lib/db/BetterSQLite3DBAdapter.js

@@ -0,0 +1,211 @@
+import * as path from 'node:path';
+import { Worker } from 'node:worker_threads';
+import * as Comlink from 'comlink';
+import { BaseObserver } from '@powersync/common';
+import { AsyncResource } from 'node:async_hooks';
+import { RemoteConnection } from './RemoteConnection.js';
+const READ_CONNECTIONS = 5;
+/**
+ * Adapter for better-sqlite3
+ */
+export class BetterSQLite3DBAdapter extends BaseObserver {
+    options;
+    name;
+    readConnections;
+    writeConnection;
+    readQueue = [];
+    writeQueue = [];
+    constructor(options) {
+        super();
+        this.options = options;
+        this.name = options.dbFilename;
+    }
+    async initialize() {
+        let dbFilePath = this.options.dbFilename;
+        if (this.options.dbLocation !== undefined) {
+            dbFilePath = path.join(this.options.dbLocation, dbFilePath);
+        }
+        const openWorker = async (isWriter) => {
+            const worker = new Worker(new URL('./SqliteWorker.js', import.meta.url), { name: isWriter ? `write ${dbFilePath}` : `read ${dbFilePath}` });
+            const listeners = new WeakMap();
+            const comlink = Comlink.wrap({
+                postMessage: worker.postMessage.bind(worker),
+                addEventListener: (type, listener) => {
+                    let resolved = 'handleEvent' in listener ? listener.handleEvent.bind(listener) : listener;
+                    // Comlink wants message events, but the message event on workers in Node returns the data only.
+                    if (type === 'message') {
+                        const original = resolved;
+                        resolved = (data) => {
+                            original({ data });
+                        };
+                    }
+                    listeners.set(listener, resolved);
+                    worker.addListener(type, resolved);
+                },
+                removeEventListener: (type, listener) => {
+                    const resolved = listeners.get(listener);
+                    if (!resolved) {
+                        return;
+                    }
+                    worker.removeListener(type, resolved);
+                }
+            });
+            worker.once('error', (e) => {
+                console.error('Unexpected PowerSync database worker error', e);
+            });
+            const database = (await comlink.open(dbFilePath, isWriter));
+            return new RemoteConnection(worker, comlink, database);
+        };
+        // Open the writer first to avoid multiple threads enabling WAL concurrently (causing "database is locked" errors).
+        this.writeConnection = await openWorker(true);
+        const createWorkers = [];
+        for (let i = 0; i < READ_CONNECTIONS; i++) {
+            createWorkers.push(openWorker(false));
+        }
+        this.readConnections = await Promise.all(createWorkers);
+    }
+    async close() {
+        await this.writeConnection.close();
+        for (const connection of this.readConnections) {
+            await connection.close();
+        }
+    }
+    readLock(fn, _options) {
+        let resolveConnectionPromise;
+        const connectionPromise = new Promise((resolve, _reject) => {
+            resolveConnectionPromise = AsyncResource.bind(resolve);
+        });
+        const connection = this.readConnections.find((connection) => !connection.isBusy);
+        if (connection) {
+            connection.isBusy = true;
+            resolveConnectionPromise(connection);
+        }
+        else {
+            this.readQueue.push(resolveConnectionPromise);
+        }
+        return (async () => {
+            const connection = await connectionPromise;
+            try {
+                return await fn(connection);
+            }
+            finally {
+                const next = this.readQueue.shift();
+                if (next) {
+                    next(connection);
+                }
+                else {
+                    connection.isBusy = false;
+                }
+            }
+        })();
+    }
+    writeLock(fn, _options) {
+        let resolveLockPromise;
+        const lockPromise = new Promise((resolve, _reject) => {
+            resolveLockPromise = AsyncResource.bind(resolve);
+        });
+        if (!this.writeConnection.isBusy) {
+            this.writeConnection.isBusy = true;
+            resolveLockPromise();
+        }
+        else {
+            this.writeQueue.push(resolveLockPromise);
+        }
+        return (async () => {
+            await lockPromise;
+            try {
+                try {
+                    return await fn(this.writeConnection);
+                }
+                finally {
+                    const updates = await this.writeConnection.database.collectCommittedUpdates();
+                    if (updates.length > 0) {
+                        const event = {
+                            tables: updates,
+                            groupedUpdates: {},
+                            rawUpdates: []
+                        };
+                        this.iterateListeners((cb) => cb.tablesUpdated?.(event));
+                    }
+                }
+            }
+            finally {
+                const next = this.writeQueue.shift();
+                if (next) {
+                    next();
+                }
+                else {
+                    this.writeConnection.isBusy = false;
+                }
+            }
+        })();
+    }
+    readTransaction(fn, _options) {
+        return this.readLock((ctx) => this.internalTransaction(ctx, fn));
+    }
+    writeTransaction(fn, _options) {
+        return this.writeLock((ctx) => this.internalTransaction(ctx, fn));
+    }
+    async internalTransaction(connection, fn) {
+        let finalized = false;
+        const commit = async () => {
+            if (!finalized) {
+                finalized = true;
+                await connection.execute('COMMIT');
+            }
+            return { rowsAffected: 0 };
+        };
+        const rollback = async () => {
+            if (!finalized) {
+                finalized = true;
+                await connection.execute('ROLLBACK');
+            }
+            return { rowsAffected: 0 };
+        };
+        try {
+            await connection.execute('BEGIN');
+            const result = await fn({
+                execute: (query, params) => connection.execute(query, params),
+                executeBatch: (query, params) => connection.executeBatch(query, params),
+                get: (query, params) => connection.get(query, params),
+                getAll: (query, params) => connection.getAll(query, params),
+                getOptional: (query, params) => connection.getOptional(query, params),
+                commit,
+                rollback
+            });
+            await commit();
+            return result;
+        }
+        catch (ex) {
+            try {
+                await rollback();
+            }
+            catch (ex2) {
+                // In rare cases, a rollback may fail.
+                // Safe to ignore.
+            }
+            throw ex;
+        }
+    }
+    getAll(sql, parameters) {
+        return this.readLock((ctx) => ctx.getAll(sql, parameters));
+    }
+    getOptional(sql, parameters) {
+        return this.readLock((ctx) => ctx.getOptional(sql, parameters));
+    }
+    get(sql, parameters) {
+        return this.readLock((ctx) => ctx.get(sql, parameters));
+    }
+    execute(query, params) {
+        return this.writeLock((ctx) => ctx.execute(query, params));
+    }
+    executeBatch(query, params) {
+        return this.writeTransaction((ctx) => ctx.executeBatch(query, params));
+    }
+    async refreshSchema() {
+        await this.writeConnection.refreshSchema();
+        for (const readConnection of this.readConnections) {
+            await readConnection.refreshSchema();
+        }
+    }
+}

package/lib/db/PowerSyncDatabase.d.ts

@@ -0,0 +1,24 @@
+import { AbstractPowerSyncDatabase, AbstractStreamingSyncImplementation, BucketStorageAdapter, DBAdapter, PowerSyncBackendConnector, PowerSyncDatabaseOptionsWithSettings } from '@powersync/common';
+/**
+ * A PowerSync database which provides SQLite functionality
+ * which is automatically synced.
+ *
+ * @example
+ * ```typescript
+ * export const db = new PowerSyncDatabase({
+ *  schema: AppSchema,
+ *  database: {
+ *    dbFilename: 'example.db'
+ *  }
+ * });
+ * ```
+ */
+export declare class PowerSyncDatabase extends AbstractPowerSyncDatabase {
+    _initialize(): Promise<void>;
+    /**
+     * Opens a DBAdapter using better-sqlite3 as the default SQLite open factory.
+     */
+    protected openDBAdapter(options: PowerSyncDatabaseOptionsWithSettings): DBAdapter;
+    protected generateBucketStorageAdapter(): BucketStorageAdapter;
+    protected generateSyncStreamImplementation(connector: PowerSyncBackendConnector): AbstractStreamingSyncImplementation;
+}

package/lib/db/PowerSyncDatabase.js

@@ -0,0 +1,46 @@
+import { AbstractPowerSyncDatabase, SqliteBucketStorage } from '@powersync/common';
+import { NodeRemote } from '../sync/stream/NodeRemote.js';
+import { NodeStreamingSyncImplementation } from '../sync/stream/NodeStreamingSyncImplementation.js';
+import { BetterSQLite3DBAdapter } from './BetterSQLite3DBAdapter.js';
+/**
+ * A PowerSync database which provides SQLite functionality
+ * which is automatically synced.
+ *
+ * @example
+ * ```typescript
+ * export const db = new PowerSyncDatabase({
+ *  schema: AppSchema,
+ *  database: {
+ *    dbFilename: 'example.db'
+ *  }
+ * });
+ * ```
+ */
+export class PowerSyncDatabase extends AbstractPowerSyncDatabase {
+    async _initialize() {
+        await this.database.initialize();
+    }
+    /**
+     * Opens a DBAdapter using better-sqlite3 as the default SQLite open factory.
+     */
+    openDBAdapter(options) {
+        return new BetterSQLite3DBAdapter(options.database);
+    }
+    generateBucketStorageAdapter() {
+        return new SqliteBucketStorage(this.database, AbstractPowerSyncDatabase.transactionMutex);
+    }
+    generateSyncStreamImplementation(connector) {
+        const remote = new NodeRemote(connector);
+        return new NodeStreamingSyncImplementation({
+            adapter: this.bucketStorageAdapter,
+            remote,
+            uploadCrud: async () => {
+                await this.waitForReady();
+                await connector.uploadData(this);
+            },
+            retryDelayMs: this.options.retryDelayMs,
+            crudUploadThrottleMs: this.options.crudUploadThrottleMs,
+            identifier: this.database.name
+        });
+    }
+}

package/lib/db/RemoteConnection.d.ts

@@ -0,0 +1,22 @@
+import { Worker } from 'node:worker_threads';
+import { LockContext, QueryResult } from '@powersync/common';
+import { Remote } from 'comlink';
+import { AsyncDatabase, AsyncDatabaseOpener, ProxiedQueryResult } from './AsyncDatabase.js';
+/**
+ * A PowerSync database connection implemented with RPC calls to a background worker.
+ */
+export declare class RemoteConnection implements LockContext {
+    isBusy: boolean;
+    private readonly worker;
+    private readonly comlink;
+    readonly database: Remote<AsyncDatabase>;
+    constructor(worker: Worker, comlink: Remote<AsyncDatabaseOpener>, database: Remote<AsyncDatabase>);
+    executeBatch(query: string, params?: any[][]): Promise<QueryResult>;
+    execute(query: string, params?: any[] | undefined): Promise<QueryResult>;
+    getAll<T>(sql: string, parameters?: any[]): Promise<T[]>;
+    getOptional<T>(sql: string, parameters?: any[]): Promise<T | null>;
+    get<T>(sql: string, parameters?: any[]): Promise<T>;
+    refreshSchema(): Promise<void>;
+    close(): Promise<void>;
+    static wrapQueryResult(result: ProxiedQueryResult): QueryResult;
+}

package/lib/db/RemoteConnection.js

@@ -0,0 +1,61 @@
+import { releaseProxy } from 'comlink';
+/**
+ * A PowerSync database connection implemented with RPC calls to a background worker.
+ */
+export class RemoteConnection {
+    isBusy = false;
+    worker;
+    comlink;
+    database;
+    constructor(worker, comlink, database) {
+        this.worker = worker;
+        this.comlink = comlink;
+        this.database = database;
+    }
+    async executeBatch(query, params = []) {
+        const result = await this.database.executeBatch(query, params ?? []);
+        return RemoteConnection.wrapQueryResult(result);
+    }
+    async execute(query, params) {
+        const result = await this.database.execute(query, params ?? []);
+        return RemoteConnection.wrapQueryResult(result);
+    }
+    async getAll(sql, parameters) {
+        const res = await this.execute(sql, parameters);
+        return res.rows?._array ?? [];
+    }
+    async getOptional(sql, parameters) {
+        const res = await this.execute(sql, parameters);
+        return res.rows?.item(0) ?? null;
+    }
+    async get(sql, parameters) {
+        const res = await this.execute(sql, parameters);
+        const first = res.rows?.item(0);
+        if (!first) {
+            throw new Error('Result set is empty');
+        }
+        return first;
+    }
+    async refreshSchema() {
+        await this.execute("pragma table_info('sqlite_master')");
+    }
+    async close() {
+        await this.database.close();
+        this.database[releaseProxy]();
+        this.comlink[releaseProxy]();
+        await this.worker.terminate();
+    }
+    static wrapQueryResult(result) {
+        let rows = undefined;
+        if (result.rows) {
+            rows = {
+                ...result.rows,
+                item: (idx) => result.rows?._array[idx]
+            };
+        }
+        return {
+            ...result,
+            rows
+        };
+    }
+}

package/lib/db/SqliteWorker.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/db/SqliteWorker.js

@@ -0,0 +1,99 @@
+import BetterSQLite3Database from '@powersync/better-sqlite3';
+import * as Comlink from 'comlink';
+import { parentPort, threadId } from 'node:worker_threads';
+import OS from 'node:os';
+import url from 'node:url';
+class BlockingAsyncDatabase {
+    db;
+    uncommittedUpdatedTables = new Set();
+    committedUpdatedTables = new Set();
+    constructor(db) {
+        this.db = db;
+        db.function('node_thread_id', () => threadId);
+    }
+    collectCommittedUpdates() {
+        const resolved = Promise.resolve([...this.committedUpdatedTables]);
+        this.committedUpdatedTables.clear();
+        return resolved;
+    }
+    installUpdateHooks() {
+        this.db.updateHook((_op, _dbName, tableName, _rowid) => {
+            this.uncommittedUpdatedTables.add(tableName);
+        });
+        this.db.commitHook(() => {
+            for (const tableName of this.uncommittedUpdatedTables) {
+                this.committedUpdatedTables.add(tableName);
+            }
+            this.uncommittedUpdatedTables.clear();
+            return true;
+        });
+        this.db.rollbackHook(() => {
+            this.uncommittedUpdatedTables.clear();
+        });
+    }
+    async close() {
+        this.db.close();
+    }
+    async execute(query, params) {
+        const stmt = this.db.prepare(query);
+        if (stmt.reader) {
+            const rows = stmt.all(params);
+            return {
+                rowsAffected: 0,
+                rows: {
+                    _array: rows,
+                    length: rows.length
+                }
+            };
+        }
+        else {
+            const info = stmt.run(params);
+            return {
+                rowsAffected: info.changes,
+                insertId: Number(info.lastInsertRowid)
+            };
+        }
+    }
+    async executeBatch(query, params) {
+        params = params ?? [];
+        let rowsAffected = 0;
+        const stmt = this.db.prepare(query);
+        for (const paramSet of params) {
+            const info = stmt.run(paramSet);
+            rowsAffected += info.changes;
+        }
+        return { rowsAffected };
+    }
+}
+class BetterSqliteWorker {
+    async open(path, isWriter) {
+        const baseDB = new BetterSQLite3Database(path);
+        baseDB.pragma('journal_mode = WAL');
+        loadExtension(baseDB);
+        if (!isWriter) {
+            baseDB.pragma('query_only = true');
+        }
+        const asyncDb = new BlockingAsyncDatabase(baseDB);
+        asyncDb.installUpdateHooks();
+        return Comlink.proxy(asyncDb);
+    }
+}
+const loadExtension = (db) => {
+    const platform = OS.platform();
+    let extensionPath;
+    if (platform === 'win32') {
+        extensionPath = 'powersync.dll';
+    }
+    else if (platform === 'linux') {
+        extensionPath = 'libpowersync.so';
+    }
+    else if (platform === 'darwin') {
+        extensionPath = 'libpowersync.dylib';
+    }
+    else {
+        throw 'Unknown platform, PowerSync for Node.js currently supports Windows, Linux and macOS.';
+    }
+    const resolved = url.fileURLToPath(new URL(`../${extensionPath}`, import.meta.url));
+    db.loadExtension(resolved, 'sqlite3_powersync_init');
+};
+Comlink.expose(new BetterSqliteWorker(), parentPort);

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from '@powersync/common';
+export * from './db/PowerSyncDatabase.js';

package/lib/index.js

@@ -0,0 +1,3 @@
+// Re export to only require one import in client side code
+export * from '@powersync/common';
+export * from './db/PowerSyncDatabase.js';

package/lib/sync/stream/NodeRemote.d.ts

@@ -0,0 +1,10 @@
+import { ILogger } from 'js-logger';
+import { AbstractRemote, AbstractRemoteOptions, BSONImplementation, RemoteConnector } from '@powersync/common';
+export declare const STREAMING_POST_TIMEOUT_MS = 30000;
+export declare class NodeRemote extends AbstractRemote {
+    protected connector: RemoteConnector;
+    protected logger: ILogger;
+    constructor(connector: RemoteConnector, logger?: ILogger, options?: Partial<AbstractRemoteOptions>);
+    getUserAgent(): string;
+    getBSON(): Promise<BSONImplementation>;
+}

package/lib/sync/stream/NodeRemote.js

@@ -0,0 +1,32 @@
+import * as os from 'node:os';
+import { AbstractRemote, DEFAULT_REMOTE_LOGGER, FetchImplementationProvider } from '@powersync/common';
+import { BSON } from 'bson';
+export const STREAMING_POST_TIMEOUT_MS = 30_000;
+class NodeFetchProvider extends FetchImplementationProvider {
+    getFetch() {
+        return fetch.bind(globalThis);
+    }
+}
+export class NodeRemote extends AbstractRemote {
+    connector;
+    logger;
+    constructor(connector, logger = DEFAULT_REMOTE_LOGGER, options) {
+        super(connector, logger, {
+            ...(options ?? {}),
+            fetchImplementation: options?.fetchImplementation ?? new NodeFetchProvider()
+        });
+        this.connector = connector;
+        this.logger = logger;
+    }
+    getUserAgent() {
+        return [
+            super.getUserAgent(),
+            `powersync-node`,
+            `node/${process.versions.node}`,
+            `${os.platform()}/${os.release()}`
+        ].join(' ');
+    }
+    async getBSON() {
+        return BSON;
+    }
+}

package/lib/sync/stream/NodeStreamingSyncImplementation.d.ts

@@ -0,0 +1,11 @@
+import { AbstractStreamingSyncImplementation, AbstractStreamingSyncImplementationOptions, LockOptions } from '@powersync/common';
+import Lock from 'async-lock';
+export declare class NodeStreamingSyncImplementation extends AbstractStreamingSyncImplementation {
+    locks: Lock;
+    constructor(options: AbstractStreamingSyncImplementationOptions);
+    /**
+     *  Configures global locks on sync process
+     */
+    initLocks(): void;
+    obtainLock<T>(lockOptions: LockOptions<T>): Promise<T>;
+}

package/lib/sync/stream/NodeStreamingSyncImplementation.js

@@ -0,0 +1,40 @@
+import { AbstractStreamingSyncImplementation, LockType } from '@powersync/common';
+import Lock from 'async-lock';
+/**
+ * Global locks which prevent multiple instances from syncing
+ * concurrently.
+ */
+const LOCKS = new Map();
+const lockTypes = new Set(Object.values(LockType));
+export class NodeStreamingSyncImplementation extends AbstractStreamingSyncImplementation {
+    locks;
+    constructor(options) {
+        super(options);
+        this.initLocks();
+    }
+    /**
+     *  Configures global locks on sync process
+     */
+    initLocks() {
+        const { identifier } = this.options;
+        if (identifier && LOCKS.has(identifier)) {
+            this.locks = LOCKS.get(identifier);
+            return;
+        }
+        this.locks = new Lock();
+        if (identifier) {
+            LOCKS.set(identifier, this.locks);
+        }
+    }
+    obtainLock(lockOptions) {
+        if (!lockTypes.has(lockOptions.type)) {
+            throw new Error(`Lock type ${lockOptions.type} not found`);
+        }
+        return this.locks.acquire(lockOptions.type, async () => {
+            if (lockOptions.signal?.aborted) {
+                throw new Error('Aborted');
+            }
+            return lockOptions.callback();
+        });
+    }
+}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@powersync/node",
+  "version": "0.0.0-dev-20250318143512",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "description": "PowerSync Node.js SDK. Sync Postgres, MongoDB or MySQL with SQLite in your Node.js app",
+  "main": "./lib/index.js",
+  "module": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "lib",
+    "dist",
+    "download_core.js"
+  ],
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/powersync-ja/powersync-js.git"
+  },
+  "author": "JOURNEYAPPS",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/powersync-ja/powersync-js/issues"
+  },
+  "homepage": "https://docs.powersync.com/",
+  "peerDependencies": {
+    "@powersync/common": "^1.22.0",
+    "@powersync/better-sqlite3": "^0.1.0"
+  },
+  "dependencies": {
+    "async-lock": "^1.4.0",
+    "bson": "^6.6.0",
+    "comlink": "^4.4.2",
+    "@powersync/common": "1.25.0"
+  },
+  "devDependencies": {
+    "@types/async-lock": "^1.4.0",
+    "typescript": "^5.5.3",
+    "vitest": "^3.0.5"
+  },
+  "keywords": [
+    "data sync",
+    "offline-first",
+    "sqlite",
+    "real-time data stream",
+    "live data"
+  ],
+  "scripts": {
+    "install": "node download_core.js",
+    "build": "tsc -b",
+    "build:prod": "tsc -b --sourceMap false",
+    "clean": "rm -rf lib dist tsconfig.tsbuildinfo dist",
+    "watch": "tsc -b -w",
+    "test": "vitest"
+  }
+}