@birchill/nice-sqlite-wasm 0.1.0 → 0.1.2

package/README.md

@@ -15,6 +15,9 @@ It's "nice" because:
 In general, it should be nicer for apps using bundlers that only need the
 "opfs-sahpool" VFS.
 
+As an extra bonus, the whole build (including building the WASM module) is done
+in CI and published to npm with provenance data so you get full traceability.
+
 > [!NOTE]
 > The JS/WASM part of SQLite is under heavy development and is expected to
 > change a lot in future (e.g. using WASI instead of Emscripten). As a result
@@ -25,7 +28,116 @@ For the official SQLite WASM package see
 
 ## Usage
 
-TODO
+Install:
+
+```
+npm install @birchill/nice-sqlite-wasm
+```
+
+You _could_ probably just do an `import sqlite3InitModule from
+'@birchill/nice-sqlite-wasm'` and be done with it but the whole point of this
+module is to allow you to set it up for better caching and pre-loading.
+How you do that will depend on your bundler.
+
+Following is an example for [rspack](https://rspack.rs).
+
+### rspack
+
+First, we set up a way to generated the name of the WASM module so we can pass
+it to `sqlite3InitModule`.
+
+In your `rspack.config.js`:
+
+```js
+export default defineConfig((env) => {
+  // ...
+  module: {
+    rules: [
+      { resourceQuery: /url$/, type: 'asset/resource' },
+    ],
+  },
+});
+```
+
+Second, we set up rspack to produce the desired output filename for the asset,
+otherwise you'll get something like `[hash].wasm` which isn't very helpful.
+
+Furthermore, we want to drop the query string we enabled above.
+
+```js
+export default defineConfig((env) => {
+  // ...
+  output: {
+    assetModuleFilename: (fileInfo) => {
+      // Generate a cacheable but readable filename for WASM files
+      if (
+        fileInfo.filename.endsWith('.wasm') ||
+        fileInfo.filename.endsWith('.wasm?url')
+      ) {
+        return '[name].[hash].wasm';
+      }
+      return '[hash][ext][query]';
+    },
+  },
+});
+```
+
+Then in your worker code:
+
+```js
+import wasmUrl from '@birchill/nice-sqlite-wasm/sqlite3.wasm?url';
+import sqlite3InitModule from '@birchill/nice-sqlite-wasm';
+```
+
+Then when you initialize SQLite:
+
+```js
+const sqlite = await sqlite3InitModule({
+  // Override SQLite's locateFile implementation which wants to resolve
+  // the SQLite WASM binary relative to the source directory instead of
+  // the asset name assigned by rspack.
+  locateFile: (file) => {
+    if (file === 'sqlite3.wasm') {
+      // Since we strip the query string in our `assetModuleFilename`
+      // option in rspack.config.js we don't need to worry about dropping
+      // it here.
+      //
+      // If we were to stop doing that, however, we'd need to do
+      // something like:
+      //
+      //   return new URL(wasmUrl, self.location.href).pathname;
+      //
+      // instead.
+      return fetch(wasmUrl, {
+        credentials: 'same-origin',
+        // If you want to make the fetch abortable...
+        signal: abortController.signal,
+      });
+    } else {
+      throw new Error(`Unknown file: ${file}`);
+    }
+  },
+});
+```
+
+You can also just return `wasmUrl` from `locateFile` if don't need to control
+the fetch yourself.
+
+### vite
+
+I'm not sure how to configure vite, but if you're only using it for testing
+(i.e. using [vitest](https://vitest.dev/)) then you can just disable
+optimization there as [explained in the official WASM
+module docs](https://github.com/sqlite/sqlite-wasm/#usage-with-vite):
+
+```js
+// vitest.config.js
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  optimizeDeps: { exclude: ['@birchill/nice-sqlite-wasm'] },
+});
+```
 
 ## Developing
 

package/dist/sqlite-rev.txt

@@ -0,0 +1 @@
+a5333afb9ad1aa473f8963b92caeaa955f47dc74

package/dist/sqlite3.js

@@ -26,11 +26,11 @@
 /*
  ** This code was built from sqlite3 version...
  **
- ** SQLITE_VERSION "3.51.1"
- ** SQLITE_VERSION_NUMBER 3051001
- ** SQLITE_SOURCE_ID "2025-11-28 17:28:25 281fc0e9afc38674b9b0991943b9e9d1e64c6cbdb133d35f6f5c87ff6af3alt1"
+ ** SQLITE_VERSION "3.51.3"
+ ** SQLITE_VERSION_NUMBER 3051003
+ ** SQLITE_SOURCE_ID "2026-03-13 10:38:09 737ae4a34738ffa0c3ff7f9bb18df914dd1cad163f28fd6b6e114a344fe6alt1"
  **
- ** Emscripten SDK: 4.0.23
+ ** Emscripten SDK: 5.0.3
  **
  */
 
@@ -845,9 +845,10 @@ async function sqlite3InitModule(moduleArg = {}) {
       } else if (FS.isFile(node.mode)) {
         node.node_ops = MEMFS.ops_table.file.node;
         node.stream_ops = MEMFS.ops_table.file.stream;
+
         node.usedBytes = 0;
 
-        node.contents = null;
+        node.contents = MEMFS.emptyFileContents ??= new Uint8Array(0);
       } else if (FS.isLink(node.mode)) {
         node.node_ops = MEMFS.ops_table.link.node;
         node.stream_ops = MEMFS.ops_table.link.stream;
@@ -864,13 +865,10 @@ async function sqlite3InitModule(moduleArg = {}) {
       return node;
     },
     getFileDataAsTypedArray(node) {
-      if (!node.contents) return new Uint8Array(0);
-      if (node.contents.subarray)
-        return node.contents.subarray(0, node.usedBytes);
-      return new Uint8Array(node.contents);
+      return node.contents.subarray(0, node.usedBytes);
     },
     expandFileStorage(node, newCapacity) {
-      var prevCapacity = node.contents ? node.contents.length : 0;
+      var prevCapacity = node.contents.length;
       if (prevCapacity >= newCapacity) return;
 
       var CAPACITY_DOUBLING_MAX = 1024 * 1024;
@@ -880,27 +878,19 @@ async function sqlite3InitModule(moduleArg = {}) {
           (prevCapacity < CAPACITY_DOUBLING_MAX ? 2.0 : 1.125)) >>>
           0
       );
-      if (prevCapacity != 0) newCapacity = Math.max(newCapacity, 256);
-      var oldContents = node.contents;
+      if (prevCapacity) newCapacity = Math.max(newCapacity, 256);
+      var oldContents = MEMFS.getFileDataAsTypedArray(node);
       node.contents = new Uint8Array(newCapacity);
-      if (node.usedBytes > 0)
-        node.contents.set(oldContents.subarray(0, node.usedBytes), 0);
+      node.contents.set(oldContents);
     },
     resizeFileStorage(node, newSize) {
       if (node.usedBytes == newSize) return;
-      if (newSize == 0) {
-        node.contents = null;
-        node.usedBytes = 0;
-      } else {
-        var oldContents = node.contents;
-        node.contents = new Uint8Array(newSize);
-        if (oldContents) {
-          node.contents.set(
-            oldContents.subarray(0, Math.min(newSize, node.usedBytes))
-          );
-        }
-        node.usedBytes = newSize;
-      }
+      var oldContents = node.contents;
+      node.contents = new Uint8Array(newSize);
+      node.contents.set(
+        oldContents.subarray(0, Math.min(newSize, node.usedBytes))
+      );
+      node.usedBytes = newSize;
     },
     node_ops: {
       getattr(node) {
@@ -1006,12 +996,7 @@ async function sqlite3InitModule(moduleArg = {}) {
         var contents = stream.node.contents;
         if (position >= stream.node.usedBytes) return 0;
         var size = Math.min(stream.node.usedBytes - position, length);
-        if (size > 8 && contents.subarray) {
-          buffer.set(contents.subarray(position, position + size), offset);
-        } else {
-          for (var i = 0; i < size; i++)
-            buffer[offset + i] = contents[position + i];
-        }
+        buffer.set(contents.subarray(position, position + size), offset);
         return size;
       },
       write(stream, buffer, offset, length, position, canOwn) {
@@ -1023,33 +1008,18 @@ async function sqlite3InitModule(moduleArg = {}) {
         var node = stream.node;
         node.mtime = node.ctime = Date.now();
 
-        if (buffer.subarray && (!node.contents || node.contents.subarray)) {
-          if (canOwn) {
-            node.contents = buffer.subarray(offset, offset + length);
-            node.usedBytes = length;
-            return length;
-          } else if (node.usedBytes === 0 && position === 0) {
-            node.contents = buffer.slice(offset, offset + length);
-            node.usedBytes = length;
-            return length;
-          } else if (position + length <= node.usedBytes) {
-            node.contents.set(
-              buffer.subarray(offset, offset + length),
-              position
-            );
-            return length;
-          }
-        }
+        if (canOwn) {
+          node.contents = buffer.subarray(offset, offset + length);
+          node.usedBytes = length;
+        } else if (node.usedBytes === 0 && position === 0) {
+          node.contents = buffer.slice(offset, offset + length);
+          node.usedBytes = length;
+        } else {
+          MEMFS.expandFileStorage(node, position + length);
 
-        MEMFS.expandFileStorage(node, position + length);
-        if (node.contents.subarray && buffer.subarray) {
           node.contents.set(buffer.subarray(offset, offset + length), position);
-        } else {
-          for (var i = 0; i < length; i++) {
-            node.contents[position + i] = buffer[offset + i];
-          }
+          node.usedBytes = Math.max(node.usedBytes, position + length);
         }
-        node.usedBytes = Math.max(node.usedBytes, position + length);
         return length;
       },
       llseek(stream, offset, whence) {
@@ -1074,7 +1044,7 @@ async function sqlite3InitModule(moduleArg = {}) {
         var allocated;
         var contents = stream.node.contents;
 
-        if (!(flags & 2) && contents && contents.buffer === HEAP8.buffer) {
+        if (!(flags & 2) && contents.buffer === HEAP8.buffer) {
           allocated = false;
           ptr = contents.byteOffset;
         } else {
@@ -1109,6 +1079,7 @@ async function sqlite3InitModule(moduleArg = {}) {
   };
 
   var FS_modeStringToFlags = (str) => {
+    if (typeof str != 'string') return str;
     var flagModes = {
       r: 0,
       'r+': 2,
@@ -1124,6 +1095,16 @@ async function sqlite3InitModule(moduleArg = {}) {
     return flags;
   };
 
+  var FS_fileDataToTypedArray = (data) => {
+    if (typeof data == 'string') {
+      data = intArrayFromString(data, true);
+    }
+    if (!data.subarray) {
+      data = new Uint8Array(data);
+    }
+    return data;
+  };
+
   var FS_getMode = (canRead, canWrite) => {
     var mode = 0;
     if (canRead) mode |= 292 | 73;
@@ -1242,7 +1223,6 @@ async function sqlite3InitModule(moduleArg = {}) {
     ignorePermissions: true,
     filesystems: null,
     syncFSRequests: 0,
-    readFiles: {},
     ErrnoError: class {
       name = 'ErrnoError';
 
@@ -1494,9 +1474,11 @@ async function sqlite3InitModule(moduleArg = {}) {
 
       if (perms.includes('r') && !(node.mode & 292)) {
         return 2;
-      } else if (perms.includes('w') && !(node.mode & 146)) {
+      }
+      if (perms.includes('w') && !(node.mode & 146)) {
         return 2;
-      } else if (perms.includes('x') && !(node.mode & 73)) {
+      }
+      if (perms.includes('x') && !(node.mode & 73)) {
         return 2;
       }
       return 0;
@@ -1536,10 +1518,8 @@ async function sqlite3InitModule(moduleArg = {}) {
         if (FS.isRoot(node) || FS.getPath(node) === FS.cwd()) {
           return 10;
         }
-      } else {
-        if (FS.isDir(node.mode)) {
-          return 31;
-        }
+      } else if (FS.isDir(node.mode)) {
+        return 31;
       }
       return 0;
     },
@@ -1549,12 +1529,14 @@ async function sqlite3InitModule(moduleArg = {}) {
       }
       if (FS.isLink(node.mode)) {
         return 32;
-      } else if (FS.isDir(node.mode)) {
-        if (FS.flagsToPermissionString(flags) !== 'r' || flags & (512 | 64)) {
+      }
+      var mode = FS.flagsToPermissionString(flags);
+      if (FS.isDir(node.mode)) {
+        if (mode !== 'r' || flags & (512 | 64)) {
           return 31;
         }
       }
-      return FS.nodePermissions(node, FS.flagsToPermissionString(flags));
+      return FS.nodePermissions(node, mode);
     },
     checkOpExists(op, err) {
       if (!op) {
@@ -2087,7 +2069,7 @@ async function sqlite3InitModule(moduleArg = {}) {
       if (path === '') {
         throw new FS.ErrnoError(44);
       }
-      flags = typeof flags == 'string' ? FS_modeStringToFlags(flags) : flags;
+      flags = FS_modeStringToFlags(flags);
       if (flags & 64) {
         mode = (mode & 4095) | 32768;
       } else {
@@ -2164,11 +2146,6 @@ async function sqlite3InitModule(moduleArg = {}) {
       if (created) {
         FS.chmod(node, mode & 0o777);
       }
-      if (Module['logReadFiles'] && !(flags & 1)) {
-        if (!(path in FS.readFiles)) {
-          FS.readFiles[path] = 1;
-        }
-      }
       return stream;
     },
     close(stream) {
@@ -2323,14 +2300,8 @@ async function sqlite3InitModule(moduleArg = {}) {
     writeFile(path, data, opts = {}) {
       opts.flags = opts.flags || 577;
       var stream = FS.open(path, opts.flags, opts.mode);
-      if (typeof data == 'string') {
-        data = new Uint8Array(intArrayFromString(data, true));
-      }
-      if (ArrayBuffer.isView(data)) {
-        FS.write(stream, data, 0, data.byteLength, undefined, opts.canOwn);
-      } else {
-        abort('Unsupported data type');
-      }
+      data = FS_fileDataToTypedArray(data);
+      FS.write(stream, data, 0, data.byteLength, undefined, opts.canOwn);
       FS.close(stream);
     },
     cwd: () => FS.currentPath,
@@ -2541,12 +2512,7 @@ async function sqlite3InitModule(moduleArg = {}) {
       var mode = FS_getMode(canRead, canWrite);
       var node = FS.create(path, mode);
       if (data) {
-        if (typeof data == 'string') {
-          var arr = new Array(data.length);
-          for (var i = 0, len = data.length; i < len; ++i)
-            arr[i] = data.charCodeAt(i);
-          data = arr;
-        }
+        data = FS_fileDataToTypedArray(data);
 
         FS.chmod(node, mode | 146);
         var stream = FS.open(node, 577);
@@ -9719,17 +9685,17 @@ async function sqlite3InitModule(moduleArg = {}) {
     });
     globalThis.sqlite3ApiBootstrap.initializers.push(function (sqlite3) {
       sqlite3.version = {
-        libVersion: '3.51.1',
-        libVersionNumber: 3051001,
+        libVersion: '3.51.3',
+        libVersionNumber: 3051003,
         sourceId:
-          '2025-11-28 17:28:25 281fc0e9afc38674b9b0991943b9e9d1e64c6cbdb133d35f6f5c87ff6af3alt1',
-        downloadVersion: 3510100,
+          '2026-03-13 10:38:09 737ae4a34738ffa0c3ff7f9bb18df914dd1cad163f28fd6b6e114a344fe6alt1',
+        downloadVersion: 3510300,
         scm: {
           'sha3-256':
-            '281fc0e9afc38674b9b0991943b9e9d1e64c6cbdb133d35f6f5c87ff6af3alt1',
+            '737ae4a34738ffa0c3ff7f9bb18df914dd1cad163f28fd6b6e114a344fe6alt1',
           branch: 'branch-3.51',
-          tags: 'release version-3.51.1',
-          datetime: '2025-11-28T17:28:25.933Z',
+          tags: 'release version-3.51.3',
+          datetime: '2026-03-13T10:38:09.694Z',
         },
       };
     });
@@ -10264,11 +10230,11 @@ async function sqlite3InitModule(moduleArg = {}) {
               stmt = null;
             }
           } finally {
-            wasm.scopedAllocPop(stack);
             if (stmt) {
               __execLock.delete(stmt);
               stmt.finalize();
             }
+            wasm.scopedAllocPop(stack);
           }
           return arg.returnVal();
         },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@birchill/nice-sqlite-wasm",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "private": false,
   "repository": {
     "type": "git",
@@ -23,5 +23,5 @@
   "publishConfig": {
     "provenance": true
   },
-  "publishedAt": "2026-01-14T05:14:37.216Z"
+  "publishedAt": "2026-03-20T02:25:21.222Z"
 }