fix: embed sqlite3.wasm in lib for production builds

packages/worker-relay/README.md

@@ -11,21 +11,21 @@ Worker relay is a Nostr relay built on `sqlite-wasm`
 ```typescript
 import { WorkerRelayInterface } from "@snort/worker-relay";
 
-// in debug mode you may need this, to map to the correct sqlite-wasm path
+// when using Vite import the worker script directly (for production)
-// this is needed because sqlite-wasm will otherwise look inside @snort/worker-relay directory for sqlite3.wasm
+import WorkerVite from "@snort/worker-relay/src/worker?worker"
-const basePath = new URL("@sqlite.org/sqlite-wasm", import.meta.url);
 
-// internally we resolve the script path like this:
+// in dev mode import esm module, i have no idea why it has to work like this
-const scriptPath = new URL("@snort/worker-relay/dist/esm/worker.mjs", import.meta.url);
+const workerScript = import.meta.env.DEV ?
+    new URL("@snort/worker-relay/dist/esm/worker.mjs", import.meta.url) :
+    new WorkerVite();
 
-// scriptPath & basePath are optional
+const workerRelay = new WorkerRelayInterface(workerScript);
-const relay = new WorkerRelayInterface(scriptPath.href, basePath.href);
 
 // load sqlite database and run migrations
-await relay.init("my-relay.db");
+await workerRelay.init("my-relay.db");
 
 // Query worker relay with regular nostr REQ command
-const results = await relay.query(["REQ", "1", { kinds: [1], limit: 10 }]);
+const results = await workerRelay.query(["REQ", "1", { kinds: [1], limit: 10 }]);
 
 // publish a new event to the relay
 const myEvent = {
@@ -34,7 +34,7 @@ const myEvent = {
     content: "test",
     tags: []
 };
-if (await relay.event(myEvent)) {
+if (await workerRelay.event(myEvent)) {
     console.log("Success");
 }
 ```

packages/worker-relay/example/basic.ts

@@ -1,20 +1,20 @@
 import { WorkerRelayInterface } from "@snort/worker-relay";
 
-// in debug mode you may need this, to map to the correct sqlite-wasm path
+// when using Vite import the worker script directly (for production)
-// this is needed because sqlite-wasm will otherwise look inside @snort/worker-relay directory for sqlite3.wasm
+import WorkerVite from "@snort/worker-relay/src/worker?worker"
-const basePath = new URL("@sqlite.org/sqlite-wasm", import.meta.url);
 
-// internally we resolve the script path like this:
+// in dev mode import esm module, i have no idea why it has to work like this
-const scriptPath = new URL("@snort/worker-relay/dist/esm/worker.mjs", import.meta.url);
+const workerScript = import.meta.env.DEV ?
+    new URL("@snort/worker-relay/dist/esm/worker.mjs", import.meta.url) :
+    new WorkerVite();
 
-// scriptPath & basePath are optional
+const workerRelay = new WorkerRelayInterface(workerScript);
-const relay = new WorkerRelayInterface(scriptPath, basePath.href);
 
 // load sqlite database and run migrations
-await relay.init("my-relay.db");
+await workerRelay.init("my-relay.db");
 
 // Query worker relay with regular nostr REQ command
-const results = await relay.query(["REQ", "1", { kinds: [1], limit: 10 }]);
+const results = await workerRelay.query(["REQ", "1", { kinds: [1], limit: 10 }]);
 
 // publish a new event to the relay
 const myEvent = {
@@ -23,6 +23,6 @@ const myEvent = {
     content: "test",
     tags: []
 };
-if (await relay.event(myEvent)) {
+if (await workerRelay.event(myEvent)) {
     console.log("Success");
 }

packages/worker-relay/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snort/worker-relay",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "A nostr relay in a service worker",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,19 +10,18 @@
   "author": "Kieran",
   "license": "MIT",
   "scripts": {
-    "build": "rm -rf dist && tsc && esbuild src/worker.ts --bundle --minify --sourcemap --outdir=dist/esm --format=esm --out-extension:.js=.mjs"
+    "build": "rm -rf dist && tsc && yarn build:esm",
+    "build:esm": "esbuild src/worker.ts --bundle --minify --sourcemap --outdir=dist/esm --format=esm --out-extension:.js=.mjs --loader:.wasm=copy"
   },
   "files": [
     "src",
     "dist"
   ],
   "dependencies": {
+    "@sqlite.org/sqlite-wasm": "^3.45.1-build1",
     "eventemitter3": "^5.0.1",
     "uuid": "^9.0.1"
   },
-  "peerDependencies": {
-    "@sqlite.org/sqlite-wasm": "^3.45.1-build1"
-  },
   "devDependencies": {
     "@types/debug": "^4.1.12",
     "@types/uuid": "^9.0.7",

packages/worker-relay/src/custom.d.ts

@@ -0,0 +1,4 @@
+declare module "*.wasm" {
+    const value: string;
+    export default value;
+  }

packages/worker-relay/src/interface.ts

@@ -3,7 +3,6 @@ import { v4 as uuid } from "uuid";
 
 export class WorkerRelayInterface {
   #worker: Worker;
-  #sqliteDir?: string;
   #commandQueue: Map<string, (v: unknown, ports: ReadonlyArray<MessagePort>) => void> = new Map();
 
   // Command timeout
@@ -12,10 +11,8 @@ export class WorkerRelayInterface {
   /**
    * Interface wrapper for worker relay
    * @param scriptPath Path to worker script or Worker script object
-   * @param sqlite3Dir Directory to search for sqlite3 depends
    */
-  constructor(scriptPath?: string | URL | Worker, sqlite3Dir?: string) {
+  constructor(scriptPath?: string | URL | Worker) {
-    this.#sqliteDir = sqlite3Dir;
     if (scriptPath instanceof Worker) {
       this.#worker = scriptPath;
     } else {
@@ -39,7 +36,7 @@ export class WorkerRelayInterface {
   }
 
   async init(databasePath: string) {
-    return await this.#workerRpc<Array<string>, boolean>("init", [databasePath, this.#sqliteDir ?? ""]);
+    return await this.#workerRpc<Array<string | undefined>, boolean>("init", [databasePath]);
   }
 
   async event(ev: NostrEvent) {

packages/worker-relay/src/sqlite-relay.ts

@@ -4,6 +4,9 @@ import { EventMetadata, NostrEvent, RelayHandler, RelayHandlerEvents, ReqFilter,
 import migrate from "./migrations";
 import { debugLog } from "./debug";
 
+// import wasm file directly, this needs to be copied from https://sqlite.org/download.html
+import SqlitePath from "./sqlite3.wasm";
+
 export class SqliteRelay extends EventEmitter<RelayHandlerEvents> implements RelayHandler {
   #sqlite?: Sqlite3Static;
   #log = (msg: string, ...args: Array<any>) => debugLog("SqliteRelay", msg, ...args);
@@ -13,11 +16,14 @@ export class SqliteRelay extends EventEmitter<RelayHandlerEvents> implements Rel
   /**
    * Initialize the SQLite driver
    */
-  async init(path: string, sqliteWasmPath?: string) {
+  async init(path: string) {
     if (this.#sqlite) return;
     this.#sqlite = await sqlite3InitModule({
-      locateFile(path, prefix) {
+      locateFile: (path, prefix) => {
-        return new URL(`sqlite-wasm/jswasm/${path}`, sqliteWasmPath).href;
+        if (path === "sqlite3.wasm") {
+          return SqlitePath;
+        }
+        return prefix + path;
       },
       print: msg => this.#log(msg),
       printErr: msg => this.#log(msg)

packages/worker-relay/src/worker.ts

@@ -80,9 +80,9 @@ globalThis.onmessage = async ev => {
           } else {
             relay = new InMemoryRelay();
           }
-          const [dbPath, wasmPath] = msg.args as Array<string>;
+          const [dbPath] = msg.args as Array<string>;
-          debugLog("StartInit", dbPath, wasmPath);
+          debugLog("StartInit", dbPath);
-          await relay.init(dbPath, wasmPath);
+          await relay.init(dbPath);
           reply(msg.id, true);
         });
         break;