@tursodatabase/database-wasm-common 0.2.0-pre.11

package/README.md

@@ -0,0 +1,8 @@
+## About
+
+This package is the Turso embedded database common JS library which is shared between final builds for Node and Browser.
+
+Do not use this package directly - instead you must use `@tursodatabase/database` or `@tursodatabase/database-wasm`.
+
+> **⚠️ Warning:** This software is ALPHA, only use for development, testing, and experimentation. We are working to make it production ready, but do not use it for critical data right now.
+

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+interface BrowserImports {
+    is_web_worker(): boolean;
+    lookup_file(ptr: number, len: number): number;
+    read(handle: number, ptr: number, len: number, offset: number): number;
+    read_async(handle: number, ptr: number, len: number, offset: number, c: number): any;
+    write(handle: number, ptr: number, len: number, offset: number): number;
+    write_async(handle: number, ptr: number, len: number, offset: number, c: number): any;
+    sync(handle: number): number;
+    sync_async(handle: number, c: number): any;
+    truncate(handle: number, len: number): number;
+    truncate_async(handle: number, len: number, c: number): any;
+    size(handle: number): number;
+}
+declare function mainImports(worker: Worker, completeOpfs: (c: any, r: any) => void): BrowserImports;
+declare function workerImports(opfs: OpfsDirectory, memory: WebAssembly.Memory): BrowserImports;
+declare class OpfsDirectory {
+    fileByPath: Map<String, {
+        handle: number;
+        sync: FileSystemSyncAccessHandle;
+    }>;
+    fileByHandle: Map<number, FileSystemSyncAccessHandle>;
+    fileHandleNo: number;
+    constructor();
+    registerFile(path: string): Promise<void>;
+    unregisterFile(path: string): Promise<void>;
+    lookupFileHandle(path: string): number | null;
+    read(handle: number, buffer: Uint8Array, offset: number): number;
+    write(handle: number, buffer: Uint8Array, offset: number): number;
+    sync(handle: number): number;
+    truncate(handle: number, size: number): number;
+    size(handle: number): number;
+}
+declare function waitForWorkerResponse(worker: Worker, id: number): Promise<any>;
+declare function registerFileAtWorker(worker: Worker, path: string): Promise<void>;
+declare function unregisterFileAtWorker(worker: Worker, path: string): Promise<void>;
+declare function isWebWorker(): boolean;
+declare function setupWebWorker(): void;
+declare function setupMainThread(wasmFile: ArrayBuffer, factory: () => Worker): Promise<any>;
+export { OpfsDirectory, workerImports, mainImports as MainDummyImports, waitForWorkerResponse, registerFileAtWorker, unregisterFileAtWorker, isWebWorker, setupWebWorker, setupMainThread };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAsBA,UAAU,cAAc;IACpB,aAAa,IAAI,OAAO,CAAC;IACzB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9C,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACvE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,OAAE;IAChF,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxE,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,OAAE;IACjF,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,OAAE;IACtC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9C,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,OAAE;IACvD,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;CAChC;AAUD,iBAAS,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,cAAc,CA4D3F;AAED,iBAAS,aAAa,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,MAAM,GAAG,cAAc,CA8DtF;AAED,cAAM,aAAa;IACf,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,0BAA0B,CAAA;KAAE,CAAC,CAAC;IAC9E,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACtD,YAAY,EAAE,MAAM,CAAC;;IAQf,YAAY,CAAC,IAAI,EAAE,MAAM;IAYzB,cAAc,CAAC,IAAI,EAAE,MAAM;IASjC,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAY7C,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAUhE,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM;IAUjE,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;IAU5B,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAUrC,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM;CAU/B;AAGD,iBAAS,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAoBvE;AAkCD,iBAAS,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAMzE;AAED,iBAAS,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAM3E;AAED,iBAAS,WAAW,IAAI,OAAO,CAE9B;AAED,iBAAS,cAAc,SAiEtB;AAED,iBAAe,eAAe,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAyCzF;AAED,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,IAAI,gBAAgB,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,WAAW,EAAE,cAAc,EAAE,eAAe,EAAE,CAAA"}

package/dist/index.js

@@ -0,0 +1,424 @@
+import { getDefaultContext as __emnapiGetDefaultContext, instantiateNapiModule as __emnapiInstantiateNapiModule, WASI as __WASI, instantiateNapiModuleSync, MessageHandler } from '@napi-rs/wasm-runtime';
+function getUint8ArrayFromMemory(memory, ptr, len) {
+    ptr = ptr >>> 0;
+    return new Uint8Array(memory.buffer).subarray(ptr, ptr + len);
+}
+function getStringFromMemory(memory, ptr, len) {
+    const shared = getUint8ArrayFromMemory(memory, ptr, len);
+    const copy = new Uint8Array(shared.length);
+    copy.set(shared);
+    const decoder = new TextDecoder('utf-8');
+    return decoder.decode(copy);
+}
+function panicMain(name) {
+    throw new Error(`method ${name} must be invoked only from the worker thread`);
+}
+function panicWorker(name) {
+    throw new Error(`method ${name} must be invoked only from the main thread`);
+}
+function mainImports(worker, completeOpfs) {
+    return {
+        is_web_worker() {
+            return false;
+        },
+        write_async(handle, ptr, len, offset, c) {
+            writeFileAtWorker(worker, handle, ptr, len, offset)
+                .then(result => {
+                completeOpfs(c, result);
+            }, err => {
+                console.error('write_async', err);
+                completeOpfs(c, -1);
+            });
+        },
+        sync_async(handle, c) {
+            syncFileAtWorker(worker, handle)
+                .then(result => {
+                completeOpfs(c, result);
+            }, err => {
+                console.error('sync_async', err);
+                completeOpfs(c, -1);
+            });
+        },
+        read_async(handle, ptr, len, offset, c) {
+            readFileAtWorker(worker, handle, ptr, len, offset)
+                .then(result => {
+                completeOpfs(c, result);
+            }, err => {
+                console.error('read_async', err);
+                completeOpfs(c, -1);
+            });
+        },
+        truncate_async(handle, len, c) {
+            truncateFileAtWorker(worker, handle, len)
+                .then(result => {
+                completeOpfs(c, result);
+            }, err => {
+                console.error('truncate_async', err);
+                completeOpfs(c, -1);
+            });
+        },
+        lookup_file(ptr, len) {
+            panicMain("lookup_file");
+        },
+        read(handle, ptr, len, offset) {
+            panicMain("read");
+        },
+        write(handle, ptr, len, offset) {
+            panicMain("write");
+        },
+        sync(handle) {
+            panicMain("sync");
+        },
+        truncate(handle, len) {
+            panicMain("truncate");
+        },
+        size(handle) {
+            panicMain("size");
+        }
+    };
+}
+;
+function workerImports(opfs, memory) {
+    return {
+        is_web_worker() {
+            return true;
+        },
+        lookup_file(ptr, len) {
+            try {
+                const handle = opfs.lookupFileHandle(getStringFromMemory(memory, ptr, len));
+                return handle == null ? -404 : handle;
+            }
+            catch (e) {
+                return -1;
+            }
+        },
+        read(handle, ptr, len, offset) {
+            try {
+                return opfs.read(handle, getUint8ArrayFromMemory(memory, ptr, len), offset);
+            }
+            catch (e) {
+                return -1;
+            }
+        },
+        write(handle, ptr, len, offset) {
+            try {
+                return opfs.write(handle, getUint8ArrayFromMemory(memory, ptr, len), offset);
+            }
+            catch (e) {
+                return -1;
+            }
+        },
+        sync(handle) {
+            try {
+                return opfs.sync(handle);
+            }
+            catch (e) {
+                return -1;
+            }
+        },
+        truncate(handle, len) {
+            try {
+                opfs.truncate(handle, len);
+                return 0;
+            }
+            catch (e) {
+                return -1;
+            }
+        },
+        size(handle) {
+            try {
+                return opfs.size(handle);
+            }
+            catch (e) {
+                return -1;
+            }
+        },
+        read_async(handle, ptr, len, offset, completion) {
+            panicWorker("read_async");
+        },
+        write_async(handle, ptr, len, offset, completion) {
+            panicWorker("write_async");
+        },
+        sync_async(handle, completion) {
+            panicWorker("sync_async");
+        },
+        truncate_async(handle, len, c) {
+            panicWorker("truncate_async");
+        },
+    };
+}
+class OpfsDirectory {
+    fileByPath;
+    fileByHandle;
+    fileHandleNo;
+    constructor() {
+        this.fileByPath = new Map();
+        this.fileByHandle = new Map();
+        this.fileHandleNo = 0;
+    }
+    async registerFile(path) {
+        if (this.fileByPath.has(path)) {
+            return;
+        }
+        const opfsRoot = await navigator.storage.getDirectory();
+        const opfsHandle = await opfsRoot.getFileHandle(path, { create: true });
+        const opfsSync = await opfsHandle.createSyncAccessHandle();
+        this.fileHandleNo += 1;
+        this.fileByPath.set(path, { handle: this.fileHandleNo, sync: opfsSync });
+        this.fileByHandle.set(this.fileHandleNo, opfsSync);
+    }
+    async unregisterFile(path) {
+        const file = this.fileByPath.get(path);
+        if (file == null) {
+            return;
+        }
+        this.fileByPath.delete(path);
+        this.fileByHandle.delete(file.handle);
+        file.sync.close();
+    }
+    lookupFileHandle(path) {
+        try {
+            const file = this.fileByPath.get(path);
+            if (file == null) {
+                return null;
+            }
+            return file.handle;
+        }
+        catch (e) {
+            console.error('lookupFile', path, e);
+            throw e;
+        }
+    }
+    read(handle, buffer, offset) {
+        try {
+            const file = this.fileByHandle.get(handle);
+            const result = file.read(buffer, { at: Number(offset) });
+            return result;
+        }
+        catch (e) {
+            console.error('read', handle, buffer.length, offset, e);
+            throw e;
+        }
+    }
+    write(handle, buffer, offset) {
+        try {
+            const file = this.fileByHandle.get(handle);
+            const result = file.write(buffer, { at: Number(offset) });
+            return result;
+        }
+        catch (e) {
+            console.error('write', handle, buffer.length, offset, e);
+            throw e;
+        }
+    }
+    sync(handle) {
+        try {
+            const file = this.fileByHandle.get(handle);
+            file.flush();
+            return 0;
+        }
+        catch (e) {
+            console.error('sync', handle, e);
+            throw e;
+        }
+    }
+    truncate(handle, size) {
+        try {
+            const file = this.fileByHandle.get(handle);
+            file.truncate(size);
+            return 0;
+        }
+        catch (e) {
+            console.error('truncate', handle, size, e);
+            throw e;
+        }
+    }
+    size(handle) {
+        try {
+            const file = this.fileByHandle.get(handle);
+            const size = file.getSize();
+            return size;
+        }
+        catch (e) {
+            console.error('size', handle, e);
+            throw e;
+        }
+    }
+}
+let workerRequestId = 0;
+function waitForWorkerResponse(worker, id) {
+    let waitResolve, waitReject;
+    const callback = msg => {
+        if (msg.data.__turso__ && msg.data.id == id) {
+            if (msg.data.error != null) {
+                waitReject(msg.data.error);
+            }
+            else {
+                waitResolve(msg.data.result);
+            }
+            cleanup();
+        }
+    };
+    const cleanup = () => worker.removeEventListener("message", callback);
+    worker.addEventListener("message", callback);
+    const result = new Promise((resolve, reject) => {
+        waitResolve = resolve;
+        waitReject = reject;
+    });
+    return result;
+}
+function readFileAtWorker(worker, handle, ptr, len, offset) {
+    workerRequestId += 1;
+    const currentId = workerRequestId;
+    const promise = waitForWorkerResponse(worker, currentId);
+    worker.postMessage({ __turso__: "read_async", handle: handle, ptr: ptr, len: len, offset: offset, id: currentId });
+    return promise;
+}
+function writeFileAtWorker(worker, handle, ptr, len, offset) {
+    workerRequestId += 1;
+    const currentId = workerRequestId;
+    const promise = waitForWorkerResponse(worker, currentId);
+    worker.postMessage({ __turso__: "write_async", handle: handle, ptr: ptr, len: len, offset: offset, id: currentId });
+    return promise;
+}
+function syncFileAtWorker(worker, handle) {
+    workerRequestId += 1;
+    const currentId = workerRequestId;
+    const promise = waitForWorkerResponse(worker, currentId);
+    worker.postMessage({ __turso__: "sync_async", handle: handle, id: currentId });
+    return promise;
+}
+function truncateFileAtWorker(worker, handle, len) {
+    workerRequestId += 1;
+    const currentId = workerRequestId;
+    const promise = waitForWorkerResponse(worker, currentId);
+    worker.postMessage({ __turso__: "truncate_async", handle: handle, len: len, id: currentId });
+    return promise;
+}
+function registerFileAtWorker(worker, path) {
+    workerRequestId += 1;
+    const currentId = workerRequestId;
+    const promise = waitForWorkerResponse(worker, currentId);
+    worker.postMessage({ __turso__: "register", path: path, id: currentId });
+    return promise;
+}
+function unregisterFileAtWorker(worker, path) {
+    workerRequestId += 1;
+    const currentId = workerRequestId;
+    const promise = waitForWorkerResponse(worker, currentId);
+    worker.postMessage({ __turso__: "unregister", path: path, id: currentId });
+    return promise;
+}
+function isWebWorker() {
+    return typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope;
+}
+function setupWebWorker() {
+    let opfs = new OpfsDirectory();
+    let memory = null;
+    const handler = new MessageHandler({
+        onLoad({ wasmModule, wasmMemory }) {
+            memory = wasmMemory;
+            const wasi = new __WASI({
+                print: function () {
+                    // eslint-disable-next-line no-console
+                    console.log.apply(console, arguments);
+                },
+                printErr: function () {
+                    // eslint-disable-next-line no-console
+                    console.error.apply(console, arguments);
+                },
+            });
+            return instantiateNapiModuleSync(wasmModule, {
+                childThread: true,
+                wasi,
+                overwriteImports(importObject) {
+                    importObject.env = {
+                        ...importObject.env,
+                        ...importObject.napi,
+                        ...importObject.emnapi,
+                        ...workerImports(opfs, memory),
+                        memory: wasmMemory,
+                    };
+                },
+            });
+        },
+    });
+    globalThis.onmessage = async function (e) {
+        if (e.data.__turso__ == 'register') {
+            try {
+                await opfs.registerFile(e.data.path);
+                self.postMessage({ __turso__: true, id: e.data.id });
+            }
+            catch (error) {
+                self.postMessage({ __turso__: true, id: e.data.id, error: error });
+            }
+            return;
+        }
+        else if (e.data.__turso__ == 'unregister') {
+            try {
+                await opfs.unregisterFile(e.data.path);
+                self.postMessage({ __turso__: true, id: e.data.id });
+            }
+            catch (error) {
+                self.postMessage({ __turso__: true, id: e.data.id, error: error });
+            }
+            return;
+        }
+        else if (e.data.__turso__ == 'read_async') {
+            let result = opfs.read(e.data.handle, getUint8ArrayFromMemory(memory, e.data.ptr, e.data.len), e.data.offset);
+            self.postMessage({ __turso__: true, id: e.data.id, result: result });
+        }
+        else if (e.data.__turso__ == 'write_async') {
+            let result = opfs.write(e.data.handle, getUint8ArrayFromMemory(memory, e.data.ptr, e.data.len), e.data.offset);
+            self.postMessage({ __turso__: true, id: e.data.id, result: result });
+        }
+        else if (e.data.__turso__ == 'sync_async') {
+            let result = opfs.sync(e.data.handle);
+            self.postMessage({ __turso__: true, id: e.data.id, result: result });
+        }
+        else if (e.data.__turso__ == 'truncate_async') {
+            let result = opfs.truncate(e.data.handle, e.data.len);
+            self.postMessage({ __turso__: true, id: e.data.id, result: result });
+        }
+        handler.handle(e);
+    };
+}
+async function setupMainThread(wasmFile, factory) {
+    const worker = factory();
+    let completeOpfs = null;
+    const __emnapiContext = __emnapiGetDefaultContext();
+    const __wasi = new __WASI({
+        version: 'preview1',
+    });
+    const __sharedMemory = new WebAssembly.Memory({
+        initial: 4000,
+        maximum: 65536,
+        shared: true,
+    });
+    const { instance: __napiInstance, module: __wasiModule, napiModule: __napiModule, } = await __emnapiInstantiateNapiModule(wasmFile, {
+        context: __emnapiContext,
+        asyncWorkPoolSize: 1,
+        wasi: __wasi,
+        onCreateWorker() { return worker; },
+        overwriteImports(importObject) {
+            importObject.env = {
+                ...importObject.env,
+                ...importObject.napi,
+                ...importObject.emnapi,
+                ...mainImports(worker, (c, res) => completeOpfs(c, res)),
+                memory: __sharedMemory,
+            };
+            return importObject;
+        },
+        beforeInit({ instance }) {
+            for (const name of Object.keys(instance.exports)) {
+                if (name.startsWith('__napi_register__')) {
+                    instance.exports[name]();
+                }
+            }
+        },
+    });
+    completeOpfs = __napiModule.exports.completeOpfs;
+    return __napiModule;
+}
+export { OpfsDirectory, workerImports, mainImports as MainDummyImports, waitForWorkerResponse, registerFileAtWorker, unregisterFileAtWorker, isWebWorker, setupWebWorker, setupMainThread };

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@tursodatabase/database-wasm-common",
+  "version": "0.2.0-pre.11",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tursodatabase/turso"
+  },
+  "type": "module",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "packageManager": "yarn@4.9.2",
+  "files": [
+    "dist/**",
+    "README.md"
+  ],
+  "devDependencies": {
+    "typescript": "^5.9.2"
+  },
+  "scripts": {
+    "tsc-build": "npm exec tsc",
+    "build": "npm run tsc-build",
+    "test": "echo 'no tests'"
+  },
+  "dependencies": {
+    "@napi-rs/wasm-runtime": "^1.0.5"
+  }
+}