@statewalker/db-sqlite-browser 0.1.3 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -68,10 +68,11 @@ const nearest = await db.query<{ id: number }>(
68
68
 
69
69
  ## Internals
70
70
 
71
- - **The engine loads once per page.** The first call starts the WASM module;
72
- later calls reuse it, and their `wasmUrl` is ignored. A failed start is
73
- cached too: if `sqlite3.wasm` was not found, every later call in that page
74
- fails the same way until the page reloads.
71
+ - **The engine loads once per `wasmUrl`.** The first call with a given
72
+ `wasmUrl` starts the WASM module; later calls with the same URL reuse it, and
73
+ a call with a different URL starts a separate engine. A failed start is
74
+ cached too: if `sqlite3.wasm` was not found at a URL, every later call with
75
+ that URL fails the same way until the page reloads.
75
76
  - **No OPFS.** `options.path` goes to `new sqlite3.oo1.DB(path, "c")`. The
76
77
  driver does not install or select an OPFS VFS.
77
78
  - **Synchronous engine, async interface.** `query` runs
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.mts","names":["DbOptions","Db"],"sources":["../src/browser-sqlite-db.ts"],"mappings":";;KAIY,mBAAmBA;;EAE7B;;;;;;;;;;;wBAuBoB,mBAAmB,UAAU,mBAAmB,QAAQC"}
1
+ {"version":3,"file":"index.d.mts","names":["DbOptions","Db"],"sources":["../src/browser-sqlite-db.ts"],"mappings":";;KAIY,mBAAmBA;;EAE7B;;;;;;;;;;;wBA0BoB,mBAAmB,UAAU,mBAAmB,QAAQC"}
package/dist/index.mjs CHANGED
@@ -1,8 +1,13 @@
1
1
  import sqlite3InitModule from "@libsql/libsql-wasm-experimental";
2
2
  //#region src/browser-sqlite-db.ts
3
- let sqlite3Promise;
3
+ /** One engine instance per `wasmUrl`, started on first use. */
4
+ const sqlite3Promises = /* @__PURE__ */ new Map();
4
5
  function getSqlite3(wasmUrl) {
5
- if (!sqlite3Promise) sqlite3Promise = sqlite3InitModule({ locateFile: (file) => file.endsWith(".wasm") ? wasmUrl : file });
6
+ let sqlite3Promise = sqlite3Promises.get(wasmUrl);
7
+ if (!sqlite3Promise) {
8
+ sqlite3Promise = sqlite3InitModule({ locateFile: (file) => file.endsWith(".wasm") ? wasmUrl : file });
9
+ sqlite3Promises.set(wasmUrl, sqlite3Promise);
10
+ }
6
11
  return sqlite3Promise;
7
12
  }
8
13
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","names":[],"sources":["../src/browser-sqlite-db.ts"],"sourcesContent":["import type { Database, Sqlite3Static } from \"@libsql/libsql-wasm-experimental\";\nimport sqlite3InitModule from \"@libsql/libsql-wasm-experimental\";\nimport type { Db, DbEntry, DbOptions } from \"@statewalker/db-api\";\n\nexport type BrowserDbOptions = DbOptions & {\n /** URL to the sqlite3.wasm file. Defaults to \"/sqlite3.wasm\". */\n wasmUrl?: string;\n};\n\nlet sqlite3Promise: Promise<Sqlite3Static> | undefined;\n\nfunction getSqlite3(wasmUrl: string): Promise<Sqlite3Static> {\n if (!sqlite3Promise) {\n sqlite3Promise = sqlite3InitModule({\n locateFile: (file: string) => (file.endsWith(\".wasm\") ? wasmUrl : file),\n });\n }\n return sqlite3Promise;\n}\n\n/**\n * Create a libSQL WASM-backed {@link Db} in the browser.\n *\n * Uses `@libsql/libsql-wasm-experimental` which provides the full libSQL\n * engine (FTS5, vector search) compiled to WebAssembly.\n *\n * @param options.path File path for persistent storage. Omit for in-memory.\n * @param options.wasmUrl URL to the sqlite3.wasm file. Defaults to \"/sqlite3.wasm\".\n */\nexport async function newBrowserSqliteDb(options?: BrowserDbOptions): Promise<Db> {\n const wasmUrl = options?.wasmUrl ?? \"/sqlite3.wasm\";\n const sqlite3 = await getSqlite3(wasmUrl);\n const dbPath = options?.path ?? \":memory:\";\n const db: Database = new sqlite3.oo1.DB(dbPath, \"c\");\n\n return {\n async query<T = DbEntry>(sql: string, params?: unknown[]): Promise<T[]> {\n const rows = db.exec(sql, {\n returnValue: \"resultRows\",\n rowMode: \"object\",\n bind: params as never[],\n });\n return rows as unknown as T[];\n },\n\n async exec(sql: string): Promise<void> {\n db.exec(sql);\n },\n\n async close(): Promise<void> {\n db.close();\n },\n };\n}\n"],"mappings":";;AASA,IAAI;AAEJ,SAAS,WAAW,SAAyC;CAC3D,IAAI,CAAC,gBACH,iBAAiB,kBAAkB,EACjC,aAAa,SAAkB,KAAK,SAAS,OAAO,IAAI,UAAU,KACpE,CAAC;CAEH,OAAO;AACT;;;;;;;;;;AAWA,eAAsB,mBAAmB,SAAyC;CAEhF,MAAM,UAAU,MAAM,WADN,SAAS,WAAW,eACI;CACxC,MAAM,SAAS,SAAS,QAAQ;CAChC,MAAM,KAAe,IAAI,QAAQ,IAAI,GAAG,QAAQ,GAAG;CAEnD,OAAO;EACL,MAAM,MAAmB,KAAa,QAAkC;GAMtE,OALa,GAAG,KAAK,KAAK;IACxB,aAAa;IACb,SAAS;IACT,MAAM;GACR,CACU;EACZ;EAEA,MAAM,KAAK,KAA4B;GACrC,GAAG,KAAK,GAAG;EACb;EAEA,MAAM,QAAuB;GAC3B,GAAG,MAAM;EACX;CACF;AACF"}
1
+ {"version":3,"file":"index.mjs","names":[],"sources":["../src/browser-sqlite-db.ts"],"sourcesContent":["import type { Database, Sqlite3Static } from \"@libsql/libsql-wasm-experimental\";\nimport sqlite3InitModule from \"@libsql/libsql-wasm-experimental\";\nimport type { Db, DbEntry, DbOptions } from \"@statewalker/db-api\";\n\nexport type BrowserDbOptions = DbOptions & {\n /** URL to the sqlite3.wasm file. Defaults to \"/sqlite3.wasm\". */\n wasmUrl?: string;\n};\n\n/** One engine instance per `wasmUrl`, started on first use. */\nconst sqlite3Promises = new Map<string, Promise<Sqlite3Static>>();\n\nfunction getSqlite3(wasmUrl: string): Promise<Sqlite3Static> {\n let sqlite3Promise = sqlite3Promises.get(wasmUrl);\n if (!sqlite3Promise) {\n sqlite3Promise = sqlite3InitModule({\n locateFile: (file: string) => (file.endsWith(\".wasm\") ? wasmUrl : file),\n });\n sqlite3Promises.set(wasmUrl, sqlite3Promise);\n }\n return sqlite3Promise;\n}\n\n/**\n * Create a libSQL WASM-backed {@link Db} in the browser.\n *\n * Uses `@libsql/libsql-wasm-experimental` which provides the full libSQL\n * engine (FTS5, vector search) compiled to WebAssembly.\n *\n * @param options.path File path for persistent storage. Omit for in-memory.\n * @param options.wasmUrl URL to the sqlite3.wasm file. Defaults to \"/sqlite3.wasm\".\n */\nexport async function newBrowserSqliteDb(options?: BrowserDbOptions): Promise<Db> {\n const wasmUrl = options?.wasmUrl ?? \"/sqlite3.wasm\";\n const sqlite3 = await getSqlite3(wasmUrl);\n const dbPath = options?.path ?? \":memory:\";\n const db: Database = new sqlite3.oo1.DB(dbPath, \"c\");\n\n return {\n async query<T = DbEntry>(sql: string, params?: unknown[]): Promise<T[]> {\n const rows = db.exec(sql, {\n returnValue: \"resultRows\",\n rowMode: \"object\",\n bind: params as never[],\n });\n return rows as unknown as T[];\n },\n\n async exec(sql: string): Promise<void> {\n db.exec(sql);\n },\n\n async close(): Promise<void> {\n db.close();\n },\n };\n}\n"],"mappings":";;;AAUA,MAAM,kCAAkB,IAAI,IAAoC;AAEhE,SAAS,WAAW,SAAyC;CAC3D,IAAI,iBAAiB,gBAAgB,IAAI,OAAO;CAChD,IAAI,CAAC,gBAAgB;EACnB,iBAAiB,kBAAkB,EACjC,aAAa,SAAkB,KAAK,SAAS,OAAO,IAAI,UAAU,KACpE,CAAC;EACD,gBAAgB,IAAI,SAAS,cAAc;CAC7C;CACA,OAAO;AACT;;;;;;;;;;AAWA,eAAsB,mBAAmB,SAAyC;CAEhF,MAAM,UAAU,MAAM,WADN,SAAS,WAAW,eACI;CACxC,MAAM,SAAS,SAAS,QAAQ;CAChC,MAAM,KAAe,IAAI,QAAQ,IAAI,GAAG,QAAQ,GAAG;CAEnD,OAAO;EACL,MAAM,MAAmB,KAAa,QAAkC;GAMtE,OALa,GAAG,KAAK,KAAK;IACxB,aAAa;IACb,SAAS;IACT,MAAM;GACR,CACU;EACZ;EAEA,MAAM,KAAK,KAA4B;GACrC,GAAG,KAAK,GAAG;EACb;EAEA,MAAM,QAAuB;GAC3B,GAAG,MAAM;EACX;CACF;AACF"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@statewalker/db-sqlite-browser",
3
- "version": "0.1.3",
3
+ "version": "0.1.4",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "description": "libSQL/SQLite WASM driver for @statewalker/db-api, targeting browser environments.",
@@ -1,14 +1,34 @@
1
1
  import { describe, expect, it } from "vitest";
2
+ import { newBrowserSqliteDb } from "./browser-sqlite-db.js";
2
3
 
3
4
  /**
4
- * Node-safe smoke test. The real browser coverage (shared conformance suite +
5
+ * Node-side tests. The real browser coverage (shared conformance suite +
5
6
  * FTS5/vector) lives in `browser-sqlite-db.browser.test.ts`, run via Vitest
6
- * browser mode (`pnpm test:browser`); this file only checks the module loads
7
- * and exports its factory, since libSQL-WASM cannot instantiate under Node.
7
+ * browser mode (`pnpm test:browser`). Under Node the engine's loader reads
8
+ * `wasmUrl` as a file path, which is enough to check how the engine is loaded.
8
9
  */
10
+ const wasmPath = decodeURIComponent(
11
+ new URL(
12
+ "../node_modules/@libsql/libsql-wasm-experimental/sqlite-wasm/jswasm/sqlite3.wasm",
13
+ import.meta.url,
14
+ ).pathname,
15
+ );
16
+
9
17
  describe("browser-sqlite-db module", () => {
10
18
  it("exports newBrowserSqliteDb function", async () => {
11
19
  const mod = await import("./browser-sqlite-db.js");
12
20
  expect(typeof mod.newBrowserSqliteDb).toBe("function");
13
21
  });
22
+
23
+ it("honors a different wasmUrl after an earlier call", async () => {
24
+ await expect(newBrowserSqliteDb({ wasmUrl: "/nonexistent/sqlite3.wasm" })).rejects.toThrow(
25
+ /ENOENT/,
26
+ );
27
+ const db = await newBrowserSqliteDb({ wasmUrl: wasmPath });
28
+ try {
29
+ expect(await db.query("SELECT 1 AS x")).toEqual([{ x: 1 }]);
30
+ } finally {
31
+ await db.close();
32
+ }
33
+ });
14
34
  });
@@ -7,13 +7,16 @@ export type BrowserDbOptions = DbOptions & {
7
7
  wasmUrl?: string;
8
8
  };
9
9
 
10
- let sqlite3Promise: Promise<Sqlite3Static> | undefined;
10
+ /** One engine instance per `wasmUrl`, started on first use. */
11
+ const sqlite3Promises = new Map<string, Promise<Sqlite3Static>>();
11
12
 
12
13
  function getSqlite3(wasmUrl: string): Promise<Sqlite3Static> {
14
+ let sqlite3Promise = sqlite3Promises.get(wasmUrl);
13
15
  if (!sqlite3Promise) {
14
16
  sqlite3Promise = sqlite3InitModule({
15
17
  locateFile: (file: string) => (file.endsWith(".wasm") ? wasmUrl : file),
16
18
  });
19
+ sqlite3Promises.set(wasmUrl, sqlite3Promise);
17
20
  }
18
21
  return sqlite3Promise;
19
22
  }