@livestore/wa-sqlite 0.4.0-dev.21 → 0.4.0-dev.23

package/README.md

@@ -5,7 +5,7 @@ This fork adds synchronous APIs and session extensions needed for LiveStore's re
 ### Why this fork?
 
 - **Synchronous API**: LiveStore requires synchronous database operations for performance-critical paths
-- **Session extensions**: Enables change tracking and replication for collaborative features  
+- **Session extensions**: Enables change tracking and replication for collaborative features
 - **Node.js compatibility**: Additional build targets for server-side testing
 
 ## Future work
@@ -15,24 +15,27 @@ This fork adds synchronous APIs and session extensions needed for LiveStore's re
 ### Changes include:
 
 - `src/sqlite-api.js`:
-	- Change API to expose synchronous functions
-	- Keeps `open_v2` but additionally exposes `open_v2Sync` which is synchronous
-	- Add `serialize`, `deserialize` and `backup` functions
+  - Change API to expose synchronous functions
+  - Keeps `open_v2` but additionally exposes `open_v2Sync` which is synchronous
+  - Add `serialize`, `deserialize` and `backup` functions
   - Add `session_` extension functions
 - `src/types/index.d.ts`
   - Adjust types to match the new sync API
-	- No longer `declare` `SQLiteAPI` / `SQLiteVFS` globally but export it properly
-	- Exposed more types from `src/examples`
+  - No longer `declare` `SQLiteAPI` / `SQLiteVFS` globally but export it properly
+  - Exposed more types from `src/examples`
 - `dist`
   - Added Node.js build target (mostly used for testing)
 
 ### Building LiveStore fork
+
 Use Nix to build the LiveStore variant with session and FTS5 support:
+
 ```bash
 nix run .#build  # Builds and updates dist/
 ```
 
 ### Staying current
+
 This fork is regularly rebased against [upstream wa-sqlite](https://github.com/rhashimoto/wa-sqlite) to incorporate latest improvements and security fixes.
 
 ---
@@ -40,6 +43,7 @@ This fork is regularly rebased against [upstream wa-sqlite](https://github.com/r
 [![wa-sqlite CI](https://github.com/rhashimoto/wa-sqlite/actions/workflows/ci.yml/badge.svg)](https://github.com/rhashimoto/wa-sqlite/actions/workflows/ci.yml)
 
 # wa-sqlite
+
 This is a WebAssembly build of SQLite with support for writing SQLite virtual filesystems completely in Javascript. This allows alternative browser storage options such as IndexedDB and Origin Private File System. Applications can opt to use either a synchronous or asynchronous (using Asyncify or JSPI) SQLite library build (an asynchronous build is required for asynchronous extensions).
 
 IndexedDB and several Origin Private File System virtual file systems are among the examples provided as proof of concept. A table comparing the different VFS classes is [here](https://github.com/rhashimoto/wa-sqlite/tree/master/src/examples#vfs-comparison).
@@ -47,6 +51,7 @@ IndexedDB and several Origin Private File System virtual file systems are among
 [Try the demo](https://rhashimoto.github.io/wa-sqlite/demo/?build=asyncify&config=IDBBatchAtomicVFS&reset) or run [benchmarks](https://rhashimoto.github.io/wa-sqlite/demo/benchmarks/?config=asyncify,IDBBatchAtomicVFS;asyncify,IDBMirrorVFS;default,AccessHandlePoolVFS;default,OPFSCoopSyncVFS;asyncify,OPFSAdaptiveVFS;asyncify,OPFSPermutedVFS) with a modern desktop web browser. More information is available in the [FAQ](https://github.com/rhashimoto/wa-sqlite/issues?q=is%3Aissue+label%3Afaq+), [discussion forums](https://github.com/rhashimoto/wa-sqlite/discussions), and [API reference](https://rhashimoto.github.io/wa-sqlite/docs/).
 
 ## Build
+
 The primary motivation for this project is to enable additions to SQLite with only Javascript. Most developers should be able to use the pre-built artifacts in
 [./dist](https://github.com/rhashimoto/wa-sqlite/tree/master/dist).
 Note that earlier versions of the project only provided pre-built artifacts in the
@@ -56,38 +61,40 @@ Minor build customization (e.g. changing build defines or flags) can be done wit
 
 If you do want to build yourself, here are the prerequisites:
 
-* Building on Debian Linux is known to work, compatibility with other platforms is unknown.
-* `yarn` - If you use a different package manager (e.g. `npm`) then file paths in the demo will need adjustment.
-* [Emscripten SDK](https://emscripten.org/docs/getting_started/downloads.html) 3.1.61+.
-* `curl`, `make`, `openssl`, `sed`, `tclsh`, `unzip`
+- Building on Debian Linux is known to work, compatibility with other platforms is unknown.
+- `yarn` - If you use a different package manager (e.g. `npm`) then file paths in the demo will need adjustment.
+- [Emscripten SDK](https://emscripten.org/docs/getting_started/downloads.html) 3.1.61+.
+- `curl`, `make`, `openssl`, `sed`, `tclsh`, `unzip`
 
 Here are the build steps:
-* Make sure `emcc` works.
-* `git clone git@github.com:rhashimoto/wa-sqlite.git`
-* `cd wa-sqlite`
-* `yarn install`
-* `make`
+
+- Make sure `emcc` works.
+- `git clone git@github.com:rhashimoto/wa-sqlite.git`
+- `cd wa-sqlite`
+- `yarn install`
+- `make`
 
 The default build produces ES6 modules + WASM, [synchronous and asynchronous](https://github.com/rhashimoto/wa-sqlite/issues/7) (using Asyncify and JSPI) in `dist/`.
 
 ## API
+
 Javascript wrappers for core SQLITE C API functions (and some others) are provided. Some convenience functions are also provided to reduce boilerplate. Here is sample code to load the library and call the API:
 
 ```javascript
-  import SQLiteESMFactory from 'wa-sqlite/dist/wa-sqlite.mjs';
-  import * as SQLite from 'wa-sqlite';
-
-  async function hello() {
-    const module = await SQLiteESMFactory();
-    const sqlite3 = SQLite.Factory(module);
-    const db = await sqlite3.open_v2('myDB');
-    await sqlite3.exec(db, `SELECT 'Hello, world!'`, (row, columns) => {
-      console.log(row);
-    });
-    await sqlite3.close(db);
-  }
-
-  hello();
+import SQLiteESMFactory from 'wa-sqlite/dist/wa-sqlite.mjs'
+import * as SQLite from 'wa-sqlite'
+
+async function hello() {
+  const module = await SQLiteESMFactory()
+  const sqlite3 = SQLite.Factory(module)
+  const db = await sqlite3.open_v2('myDB')
+  await sqlite3.exec(db, `SELECT 'Hello, world!'`, (row, columns) => {
+    console.log(row)
+  })
+  await sqlite3.close(db)
+}
+
+hello()
 ```
 
 There is a slightly more complicated example [here](https://github.com/rhashimoto/wa-sqlite/tree/master/demo/hello) that also shows how to use a virtual filesystem (VFS) for persistent storage.
@@ -97,21 +104,24 @@ The [implementation of `sqlite3.exec`](https://github.com/rhashimoto/wa-sqlite/b
 [API reference](https://rhashimoto.github.io/wa-sqlite/docs/)
 
 ## Demo
+
 To serve the demo directly from the source tree:
-* `yarn start`
-* Open a browser on http://localhost:8000/demo/?build=asyncify&config=IDBBatchAtomicVFS&reset
+
+- `yarn start`
+- Open a browser on http://localhost:8000/demo/?build=asyncify&config=IDBBatchAtomicVFS&reset
 
 The demo page provides access to databases on multiple VFS implementations. Query parameters on the demo page URL can be used to specify the configuration and initial state:
 
-| Parameter | Purpose | Values | Default |
-|----|----|----|----|
-| build | Emscripten build type | default, asyncify, jspi | default |
-| config | select VFS | MemoryVFS, MemoryAsyncVFS, IDBBatchAtomicVFS, IDBMirrorVFS, AccessHandlePoolVFS, OPFSAdaptiveVFS, OPFSAnyContextVFS, OPFSCoopSyncVFS, OPFSPermutedVFS | uses SQLite internal memory |
-| reset | clear persistent storage | | |
+| Parameter | Purpose                  | Values                                                                                                                                                | Default                     |
+| --------- | ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
+| build     | Emscripten build type    | default, asyncify, jspi                                                                                                                               | default                     |
+| config    | select VFS               | MemoryVFS, MemoryAsyncVFS, IDBBatchAtomicVFS, IDBMirrorVFS, AccessHandlePoolVFS, OPFSAdaptiveVFS, OPFSAnyContextVFS, OPFSCoopSyncVFS, OPFSPermutedVFS | uses SQLite internal memory |
+| reset     | clear persistent storage |                                                                                                                                                       |                             |
 
 For convenience, if any text region is selected in the editor, only that region will be executed. In addition, the editor contents are restored across page reloads using browser localStorage.
 
 ## License
+
 MIT License as of February 10, 2023, changed by generous sponsors
 [Fleet Device Management](https://fleetdm.com/) and [Reflect](https://reflect.app/).
 Existing licensees may continue under the GPLv3 or switch to the new license.

package/dist/README.md

@@ -3,8 +3,8 @@
 This dist directory was built with the following configuration:
 
 ## Build Environment
-- **Built on:** 2025-08-28 07:48:15 UTC
-- **Emscripten:** emcc (Emscripten gcc/clang-like replacement + linker emulating GNU ld) 4.0.12-git
+- **Built on:** 2026-02-10 16:25:57 UTC
+- **Emscripten:** emcc (Emscripten gcc/clang-like replacement + linker emulating GNU ld) 4.0.23-git
 - **SQLite Version:** 3.50.4
 - **SQLite Commit:** 8ed5e7365e6f12f427910188bbf6b254daad2ef6
 
@@ -45,19 +45,19 @@ Generated via: `nix build .#wa-sqlite-livestore`
 
 ### Standard Build Sizes
 - **wa-sqlite-async.mjs**: 113K (gzip: 27.4K, brotli: 23.9K)
-- **wa-sqlite-jspi.mjs**: 115K (gzip: 27.0K, brotli: 23.5K)
-- **wa-sqlite.mjs**: 107K (gzip: 25.9K, brotli: 22.6K)
-- **wa-sqlite.node.mjs**: 108K (gzip: 26.0K, brotli: 22.7K)
-- **wa-sqlite-async.wasm**: 1.3M (gzip: 453.3K, brotli: 358.4K)
-- **wa-sqlite-jspi.wasm**: 611K (gzip: 298.0K, brotli: 256.4K)
-- **wa-sqlite.node.wasm**: 605K (gzip: 296.5K, brotli: 254.8K)
-- **wa-sqlite.wasm**: 605K (gzip: 296.5K, brotli: 254.8K)
+- **wa-sqlite-jspi.mjs**: 115K (gzip: 26.9K, brotli: 23.3K)
+- **wa-sqlite.mjs**: 107K (gzip: 25.8K, brotli: 22.6K)
+- **wa-sqlite.node.mjs**: 108K (gzip: 25.9K, brotli: 22.7K)
+- **wa-sqlite-async.wasm**: 1.3M (gzip: 453.1K, brotli: 357.9K)
+- **wa-sqlite-jspi.wasm**: 611K (gzip: 298.0K, brotli: 256.3K)
+- **wa-sqlite.node.wasm**: 605K (gzip: 296.4K, brotli: 254.8K)
+- **wa-sqlite.wasm**: 605K (gzip: 296.4K, brotli: 254.8K)
 
 ### FTS5 Variant Sizes
-- **fts5/wa-sqlite.mjs**: 107K (gzip: 25.9K, brotli: 22.6K)
-- **fts5/wa-sqlite.node.mjs**: 108K (gzip: 26.0K, brotli: 22.8K)
-- **fts5/wa-sqlite.node.wasm**: 719K (gzip: 353.0K, brotli: 303.6K)
-- **fts5/wa-sqlite.wasm**: 719K (gzip: 353.0K, brotli: 303.6K)
+- **fts5/wa-sqlite.mjs**: 107K (gzip: 25.8K, brotli: 22.5K)
+- **fts5/wa-sqlite.node.mjs**: 108K (gzip: 26.0K, brotli: 22.7K)
+- **fts5/wa-sqlite.node.wasm**: 719K (gzip: 352.2K, brotli: 303.4K)
+- **fts5/wa-sqlite.wasm**: 719K (gzip: 352.2K, brotli: 303.4K)
 
 ## Notes
 - All builds include session extension for data synchronization