Load core extension in node demo

Author: simolus3

demos/example-node/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "example-node",
+  "version": "1.0.0",
+  "description": "",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -b",
+    "run": "node --loader ts-node/esm src/main.ts"
+  },
+  "dependencies": {
+    "@powersync/node": "workspace:*",
+    "better-sqlite3": "any"
+  },
+  "devDependencies": {
+    "ts-node": "^10.9.2",
+    "typescript": "^5.8.2"
+  }
+}

demos/example-node/src/main.ts

@@ -0,0 +1,45 @@
+import { column, PowerSyncDatabase, Schema, Table } from "@powersync/node";
+
+const main = async () => {
+    const db = new PowerSyncDatabase({
+        schema: AppSchema,
+        database: {
+            dbFilename: 'test.db',
+        },
+    });
+    console.log(await db.get('SELECT powersync_rs_version();'));
+};
+
+export const LIST_TABLE = 'lists';
+export const TODO_TABLE = 'todos';
+
+const todos = new Table(
+  {
+    list_id: column.text,
+    created_at: column.text,
+    completed_at: column.text,
+    description: column.text,
+    created_by: column.text,
+    completed_by: column.text,
+    completed: column.integer,
+    photo_id: column.text
+  },
+  { indexes: { list: ['list_id'] } }
+);
+
+const lists = new Table({
+  created_at: column.text,
+  name: column.text,
+  owner_id: column.text
+});
+
+export const AppSchema = new Schema({
+  lists,
+  todos
+});
+
+export type Database = (typeof AppSchema)['types'];
+export type TodoRecord = Database['todos'];
+export type ListRecord = Database['lists'];
+
+await main();

demos/example-node/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.base",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "rootDir": "src",
+    "outDir": "lib",
+    "strictNullChecks": true
+  },
+  "references": [
+    {
+      "path": "../../packages/node"
+    }
+  ]
+}

packages/node/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();

packages/node/package.json

@@ -14,11 +14,13 @@
     "dist"
   ],
   "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"
   },
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/powersync-ja/powersync-js.git"

packages/node/src/db/BetterSQLite3DBAdapter.ts

@@ -1,4 +1,6 @@
-import path from 'node:path';
+import * as path from 'node:path';
+import * as OS from 'node:os';
+import * as url from 'node:url';
 
 import BetterSQLite3Database from 'better-sqlite3';
 
@@ -49,7 +51,24 @@ export class BetterSQLite3DBAdapter extends BaseObserver<DBAdapterListener> impl
       dbFilePath = path.join(options.dbLocation, dbFilePath);
     }
 
+    const platform = OS.platform();
+    let extensionPath: string;
+    if (platform === "win32") {
+      extensionPath = 'powersync.dll';
+    } else if (platform === "linux") {
+      extensionPath = 'libpowersync.so';
+    } else if (platform === "darwin") {
+      extensionPath = 'libpowersync.dylib';
+    }
+
     const baseDB = new BetterSQLite3Database(dbFilePath);
+
+    const loadExtension = (db: BetterSQLite3Database) => {
+      const resolved = url.fileURLToPath(new URL(`../${extensionPath}`, import.meta.url));
+      db.loadExtension(resolved, 'sqlite3_powersync_init');
+    }
+
+    loadExtension(baseDB);
     baseDB.pragma('journal_mode = WAL');
 
     baseDB.updateHook((_op, _dbName, tableName, _rowid) => {
@@ -71,6 +90,7 @@ export class BetterSQLite3DBAdapter extends BaseObserver<DBAdapterListener> impl
     this.readConnections = [];
     for (let i = 0; i < READ_CONNECTIONS; i++) {
       const baseDB = new BetterSQLite3Database(dbFilePath);
+      loadExtension(baseDB);
       baseDB.pragma('query_only = true');
       this.readConnections.push(new Connection(baseDB));
     }
@@ -253,7 +273,7 @@ class Connection implements BetterSQLite3LockContext {
   async execute(query: string, params?: any[]): Promise<QueryResult> {
     const stmt = this.baseDB.prepare(query);
     if (stmt.reader) {
-      const rows = stmt.all(params);
+      const rows = stmt.all(params ?? []);
       return {
         rowsAffected: 0,
         rows: {
@@ -263,7 +283,7 @@ class Connection implements BetterSQLite3LockContext {
         },
       };
     } else {
-      const info = stmt.run(params);
+      const info = stmt.run(params ?? []);
       return {
         rowsAffected: info.changes,
         insertId: Number(info.lastInsertRowid),

packages/node/src/db/PowerSyncDatabase.ts

@@ -8,10 +8,10 @@ import {
   SqliteBucketStorage
 } from '@powersync/common';
 
-import { NodeRemote } from '../sync/stream/NodeRemote';
-import { NodeStreamingSyncImplementation } from '../sync/stream/NodeStreamingSyncImplementation';
+import { NodeRemote } from '../sync/stream/NodeRemote.js';
+import { NodeStreamingSyncImplementation } from '../sync/stream/NodeStreamingSyncImplementation.js';
 
-import { BetterSQLite3DBAdapter } from './BetterSQLite3DBAdapter';
+import { BetterSQLite3DBAdapter } from './BetterSQLite3DBAdapter.js';
 
 /**
  * A PowerSync database which provides SQLite functionality

packages/node/src/index.ts

@@ -1,8 +1,8 @@
 // Re export to only require one import in client side code
 export * from '@powersync/common';
 
-export * from './db/BetterSQLite3DBAdapter';
-export * from './db/PowerSyncDatabase';
+export * from './db/BetterSQLite3DBAdapter.js';
+export * from './db/PowerSyncDatabase.js';
 
-export * from './sync/stream/NodeRemote';
-export * from './sync/stream/NodeStreamingSyncImplementation';
+export * from './sync/stream/NodeRemote.js';
+export * from './sync/stream/NodeStreamingSyncImplementation.js';

packages/node/src/sync/stream/NodeRemote.ts

@@ -1,4 +1,4 @@
-import os from 'node:os';
+import * as os from 'node:os';
 
 import { ILogger } from 'js-logger';
 

packages/node/tsconfig.json

@@ -2,10 +2,20 @@
   "extends": "../../tsconfig.base",
   "compilerOptions": {
     "baseUrl": "./",
+    "jsx": "react",
+    "types": ["node"],
     "rootDir": "src",
     "outDir": "./lib",
+    "lib": ["esnext"],
+    "declaration": true,
+    "module": "NodeNext",
+    "moduleResolution": "nodenext",
+    "preserveConstEnums": true,
+    "esModuleInterop": false,
+    "skipLibCheck": false,
     "strictNullChecks": true
   },
+  "include": ["src/**/*"],
   "references": [
     {
       "path": "../common"