npm - @fireproof/core - Versions diffs - 0.19.121-dev → 0.20.0-dev-preview-05 - Mend

@fireproof/core 0.19.121-dev → 0.20.0-dev-preview-05

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.

Files changed (103) hide show

package/README.md +13 -12
package/deno/index.d.ts +7 -0
package/deno/index.js +66 -0
package/deno/index.js.map +1 -0
package/deno/metafile-esm.json +1 -0
package/deno.json +3 -4
package/index.cjs +1797 -1431
package/index.cjs.map +1 -1
package/index.d.cts +760 -381
package/index.d.ts +760 -381
package/index.js +1976 -913
package/index.js.map +1 -1
package/metafile-cjs.json +1 -1
package/metafile-esm.json +1 -1
package/node/{node-filesystem.cjs → index.cjs} +17 -6
package/node/index.cjs.map +1 -0
package/node/index.d.cts +7 -0
package/node/index.d.ts +7 -0
package/node/{node-filesystem.js → index.js} +25 -5
package/node/index.js.map +1 -0
package/node/metafile-cjs.json +1 -1
package/node/metafile-esm.json +1 -1
package/package.json +27 -17
package/react/index.cjs +22 -22
package/react/index.cjs.map +1 -1
package/react/index.d.cts +7 -7
package/react/index.d.ts +7 -7
package/react/index.js +22 -22
package/react/index.js.map +1 -1
package/react/metafile-cjs.json +1 -1
package/react/metafile-esm.json +1 -1
package/tests/blockstore/fp-envelope.test.ts-off +65 -0
package/tests/blockstore/interceptor-gateway.test.ts +122 -0
package/tests/blockstore/keyed-crypto-indexdb-file.test.ts +130 -0
package/tests/blockstore/keyed-crypto.test.ts +75 -118
package/tests/blockstore/loader.test.ts +18 -9
package/tests/blockstore/store.test.ts +40 -31
package/tests/blockstore/transaction.test.ts +14 -13
package/tests/fireproof/all-gateway.test.ts +286 -216
package/tests/fireproof/cars/bafkreidxwt2nhvbl4fnqfw3ctlt6zbrir4kqwmjo5im6rf4q5si27kgo2i.ts +324 -316
package/tests/fireproof/crdt.test.ts +78 -19
package/tests/fireproof/fireproof.test.ts +111 -92
package/tests/fireproof/hello.test.ts +21 -17
package/tests/fireproof/indexer.test.ts +74 -50
package/tests/fireproof/{database.test.ts → ledger.test.ts} +241 -45
package/tests/fireproof/multiple-ledger.test.ts +2 -2
package/tests/fireproof/utils.test.ts +47 -6
package/tests/gateway/file/loader-config.test.ts +307 -0
package/tests/gateway/fp-envelope-serialize.test.ts +256 -0
package/tests/gateway/indexdb/loader-config.test.ts +79 -0
package/tests/helpers.ts +44 -17
package/tests/react/useFireproof.test.tsx +2 -2
package/tests/www/gallery.html +2 -2
package/tests/www/todo-aws.html +1 -1
package/tests/www/todo-ipfs.html +1 -1
package/tests/www/todo-local.html +1 -1
package/tests/www/todo.html +25 -4
package/web/index.cjs +218 -0
package/web/index.cjs.map +1 -0
package/web/index.d.cts +30 -0
package/web/index.d.ts +30 -0
package/web/index.js +195 -0
package/web/index.js.map +1 -0
package/web/metafile-cjs.json +1 -1
package/web/metafile-esm.json +1 -1
package/chunk-7EWIAXTM.js +0 -7
package/chunk-7EWIAXTM.js.map +0 -1
package/chunk-F4FC6B2T.js +0 -63
package/chunk-F4FC6B2T.js.map +0 -1
package/chunk-PZ5AY32C.js +0 -10
package/chunk-PZ5AY32C.js.map +0 -1
package/chunk-RXC4JGJT.js +0 -301
package/chunk-RXC4JGJT.js.map +0 -1
package/gateway-C62S56GY.js +0 -66
package/gateway-C62S56GY.js.map +0 -1
package/gateway-VVS4QWDA.js +0 -145
package/gateway-VVS4QWDA.js.map +0 -1
package/key-bag-file-PWZ3QE7B.js +0 -55
package/key-bag-file-PWZ3QE7B.js.map +0 -1
package/key-bag-indexdb-SYG3YD4D.js +0 -51
package/key-bag-indexdb-SYG3YD4D.js.map +0 -1
package/node/chunk-4A4RAVNS.js +0 -17
package/node/chunk-4A4RAVNS.js.map +0 -1
package/node/mem-filesystem.cjs +0 -72
package/node/mem-filesystem.cjs.map +0 -1
package/node/mem-filesystem.d.cts +0 -25
package/node/mem-filesystem.d.ts +0 -25
package/node/mem-filesystem.js +0 -40
package/node/mem-filesystem.js.map +0 -1
package/node/node-filesystem.cjs.map +0 -1
package/node/node-filesystem.d.cts +0 -35
package/node/node-filesystem.d.ts +0 -35
package/node/node-filesystem.js.map +0 -1
package/tests/fireproof/config.test.ts +0 -172
package/utils-ZVVGAXFE.js +0 -13
package/utils-ZVVGAXFE.js.map +0 -1
package/web/gateway-impl.cjs +0 -183
package/web/gateway-impl.cjs.map +0 -1
package/web/gateway-impl.d.cts +0 -31
package/web/gateway-impl.d.ts +0 -31
package/web/gateway-impl.js +0 -162
package/web/gateway-impl.js.map +0 -1
/package/tests/blockstore/{fragment-gateway.test.ts → fragment-gateway.test.ts-off} +0 -0

package/tests/helpers.ts CHANGED Viewed

@@ -1,7 +1,8 @@
-import { runtimeFn, toCryptoRuntime, URI } from "@adviser/cement";
-import { dataDir, rt, SuperThis } from "@fireproof/core";
-export { dataDir };
+import { BuildURI, MockLogger, runtimeFn, toCryptoRuntime, URI, utils, LogCollector } from "@adviser/cement";
+import { ensureSuperThis, rt, SuperThis, SuperThisOpts, bs, PARAM } from "@fireproof/core";
+import { CID } from "multiformats";
+import { sha256 } from "multiformats/hashes/sha2";
+import * as json from "multiformats/codecs/json";
 export function sleep(ms: number) {
   return new Promise((resolve) => setTimeout(resolve, ms));
@@ -37,16 +38,42 @@ export function storageURL(sthis: SuperThis): URI {
   return merged;
 }
-// export type MockSuperThis = SuperThis & { logCollector: LogCollector };
-// // eslint-disable-next-line @typescript-eslint/no-unused-vars
-// export function mockSuperThis(sthis?: Partial<SuperThisOpts>): MockSuperThis {
-//   const mockLog = MockLogger();
-//   const ethis = ensureSuperThis({
-//     logger: mockLog.logger,
-//     ctx: {
-//       logCollector: mockLog.logCollector,
-//     },
-//   }) as MockSuperThis;
-//   ethis.logCollector = mockLog.logCollector;
-//   return ethis;
-// }
+export type MockSuperThis = SuperThis & { ctx: { readonly logCollector: LogCollector } };
+export function mockSuperThis(sthis?: Partial<SuperThisOpts>): MockSuperThis {
+  const mockLog = MockLogger({
+    pass: new utils.ConsoleWriterStreamDefaultWriter(new utils.ConsoleWriterStream()),
+  });
+  return ensureSuperThis({
+    ...sthis,
+    logger: mockLog.logger,
+    ctx: {
+      logCollector: mockLog.logCollector,
+    },
+  }) as MockSuperThis;
+}
+export function noopUrl(name?: string): URI {
+  const burl = BuildURI.from("memory://noop");
+  burl.setParam(PARAM.NAME, name || "test");
+  return burl.URI();
+}
+export function simpleBlockOpts(sthis: SuperThis, name?: string) {
+  const url = noopUrl(name);
+  return {
+    keyBag: rt.kb.defaultKeyBagOpts(sthis),
+    storeRuntime: bs.toStoreRuntime(sthis),
+    storeUrls: {
+      file: url,
+      wal: url,
+      meta: url,
+      data: url,
+    },
+  };
+}
+export async function simpleCID(sthis: SuperThis) {
+  const bytes = json.encode({ hello: sthis.nextId().str });
+  const hash = await sha256.digest(bytes);
+  return CID.create(1, json.code, hash);
+}

package/tests/react/useFireproof.test.tsx CHANGED Viewed

@@ -10,10 +10,10 @@ describe("HOOK: useFireproof", () => {
   it("renders the hook correctly and checks types", () => {
     renderHook(() => {
-      const { database, useLiveQuery, useDocument } = useFireproof("dbname");
+      const { ledger, useLiveQuery, useDocument } = useFireproof("dbname");
       expect(typeof useLiveQuery).toBe("function");
       expect(typeof useDocument).toBe("function");
-      expect(database?.constructor.name).toBe("Database");
+      expect(ledger?.constructor.name).toMatch(/^Ledger/);
     });
   });
 });

package/tests/www/gallery.html CHANGED Viewed

@@ -122,8 +122,8 @@
     <h3>Files</h3>
     <p>
       Data is stored locally and encrypted before upload to S3. This is a demo so the encryption key is not managed securely. Read
-      more about <a href="https://use-fireproof.com/docs/database-api/replication">Fireproof replication options.</a> You can also
-      see a demo without images but <a href="https://fireproof.storage/s3up-test.html">with compaction and refresh buttons.</a>
+      more about <a href="https://use-fireproof.com/docs/ledger-api/replication">Fireproof replication options.</a> You can also see
+      a demo without images but <a href="https://fireproof.storage/s3up-test.html">with compaction and refresh buttons.</a>
     </p>
     <label for="files-up"><strong>Drop files:</strong></label>
     <input accept="image/*" title="save to Fireproof" type="file" id="files-up" multiple />

package/tests/www/todo-aws.html CHANGED Viewed

@@ -211,7 +211,7 @@
   <body>
     <h1><a href="https://use-fireproof.com/">Fireproof</a> Test App</h1>
-    Database:
+    Ledger:
     <input title="Change list" type="text" name="list" id="list" />
     <button onclick="changeList(event)">Switch</button>

package/tests/www/todo-ipfs.html CHANGED Viewed

@@ -156,7 +156,7 @@
           e.preventDefault();
           e.target.disabled = true;
           const input = document.querySelector("#join");
-          const { database: newDb, connection: newConn } = await cx.joinShared(input.value);
+          const { ledger: newDb, connection: newConn } = await cx.joinShared(input.value);
           setupDb(null, newDb, newConn);
         };

package/tests/www/todo-local.html CHANGED Viewed

@@ -196,7 +196,7 @@
   <body>
     <h1><a href="https://use-fireproof.com/">Fireproof</a> Test App</h1>
-    Database:
+    Ledger:
     <input title="Change list" type="text" name="list" id="list" />
     <button onclick="changeList(event)">Switch</button>

package/tests/www/todo.html CHANGED Viewed

@@ -75,8 +75,9 @@
         let compactor = "🚗";
         function drawInfo() {
-          document.querySelector("#carLog").innerText =
-            ` ⏰ ${db._crdt.clock.head.length} ${compactor} ${cx.loader.carLog.length}  📩 ${1}`;
+          document.querySelector("#carLog").innerText = ` ⏰ ${db._crdt.clock.head.length} ${compactor} ${
+            cx.loader.carLog.length
+          }  📩 ${1}`;
         }
         const doRedraw = async () => {
           drawInfo();
@@ -164,7 +165,7 @@
           const timeout =
             10 +
             Math.pow(db._crdt.clock.head.length + cx.loader.taskManager.queue.length, 2) *
-              (Math.floor(Math.random() * 2000) + 2000);
+              (Math.floor(Math.random() * 1000) + 1000);
           // console.log('go worker', timeout/ 1000)
           worker = setTimeout(async () => {
             await Promise.all(
@@ -195,6 +196,25 @@
         };
         window.toggleWorker = toggleWorker;
+        async function writeStorm(e) {
+          e.preventDefault();
+          compactor = "🐦‍🔥";
+          drawInfo();
+          const dcs = await db.allDocs();
+          const lastRow = dcs.rows[dcs.rows.length - 1];
+          const theDoc = lastRow.value;
+          for (let i = 0; i < 50; i++) {
+            theDoc.clicks = (theDoc.clicks || 0) + 1;
+            theDoc.completed = !theDoc.completed;
+            await db.put(theDoc);
+          }
+          drawInfo();
+          compactor = "🚗";
+        }
+        window.writeStorm = writeStorm;
         async function doCompact(e) {
           e.preventDefault();
           compactor = "🚕";
@@ -215,12 +235,13 @@
   <body>
     <h1><a href="https://use-fireproof.com/">Fireproof</a> Test App</h1>
-    Database:
+    Ledger:
     <input title="Change list" type="text" name="list" id="list" />
     <button onclick="changeList(event)">Switch</button>
     <p>This version of the Fireprof test app uses PartyKit as the storage backend. Refresh is automatic and live.</p>
+    <button id="rocket" onclick="writeStorm(event)">🚀</button>
     <button id="robot" onclick="toggleWorker(event)">🤖</button>
     <span id="carLog" onclick="doCompact(event)"></span>
     <span id="cxInfo"></span>

package/web/index.cjs ADDED Viewed

@@ -0,0 +1,218 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+// src/runtime/gateways/indexdb/web/index.ts
+var index_exports = {};
+__export(index_exports, {
+  GatewayImpl: () => IndexDBGateway,
+  KeyBagProviderImpl: () => KeyBagProviderIndexDB,
+  KeyBagProviderIndexDB: () => KeyBagProviderIndexDB
+});
+module.exports = __toCommonJS(index_exports);
+// src/runtime/gateways/indexdb/web/key-bag-indexdb.ts
+var import_idb = require("idb");
+var import_cement = require("@adviser/cement");
+var import_core = require("@fireproof/core");
+var KeyBagProviderIndexDB = class {
+  constructor(url, sthis) {
+    this._db = new import_cement.ResolveOnce();
+    this.sthis = sthis;
+    this.logger = sthis.logger;
+    this.url = url;
+    this.dbName = import_core.rt.getPath(this.url, this.sthis);
+  }
+  async _prepare() {
+    return this._db.once(async () => {
+      return await (0, import_idb.openDB)(this.dbName, 1, {
+        upgrade(db) {
+          ["bag"].map((store) => {
+            db.createObjectStore(store, {
+              autoIncrement: false
+            });
+          });
+        }
+      });
+    });
+  }
+  async get(id) {
+    const db = await this._prepare();
+    const tx = db.transaction(["bag"], "readonly");
+    const keyItem = await tx.objectStore("bag").get(id);
+    await tx.done;
+    if (!keyItem) {
+      return void 0;
+    }
+    return keyItem;
+  }
+  async set(id, item) {
+    const db = await this._prepare();
+    const tx = db.transaction(["bag"], "readwrite");
+    await tx.objectStore("bag").put(item, id);
+    await tx.done;
+  }
+};
+// src/runtime/gateways/indexdb/web/gateway-impl.ts
+var import_idb2 = require("idb");
+var import_cement2 = require("@adviser/cement");
+// src/runtime/gateways/indexdb/version.ts
+var INDEXDB_VERSION = "v0.19-indexdb";
+// src/runtime/gateways/indexdb/web/gateway-impl.ts
+var import_core2 = require("@fireproof/core");
+function ensureVersion(url) {
+  return url.build().defParam(import_core2.PARAM.VERSION, INDEXDB_VERSION).URI();
+}
+var onceIndexDB = new import_cement2.KeyedResolvOnce();
+function sanitzeKey(key) {
+  if (key.length === 1) {
+    key = key[0];
+  }
+  return key;
+}
+async function connectIdb(url, sthis) {
+  const dbName = getIndexDBName(url, sthis);
+  const once = await onceIndexDB.get(dbName.fullDb).once(async () => {
+    const db = await (0, import_idb2.openDB)(dbName.fullDb, 1, {
+      upgrade(db2) {
+        ["version", "data", "wal", "meta", "idx.data", "idx.wal", "idx.meta"].map((store) => {
+          db2.createObjectStore(store, {
+            autoIncrement: false
+          });
+        });
+      }
+    });
+    const found = await db.get("version", "version");
+    const version = ensureVersion(url).getParam(import_core2.PARAM.VERSION);
+    if (!found) {
+      await db.put("version", { version }, "version");
+    } else if (found.version !== version) {
+      sthis.logger.Warn().Url(url).Str("version", version).Str("found", found.version).Msg("version mismatch");
+    }
+    return { db, dbName, version, url };
+  });
+  return {
+    ...once,
+    url: url.build().setParam(import_core2.PARAM.VERSION, once.version).URI()
+  };
+}
+function joinDBName(...names) {
+  return names.map((i) => i.replace(/^[^a-zA-Z0-9]+/g, "").replace(/[^a-zA-Z0-9-]+/g, "_")).filter((i) => i.length).join(".");
+}
+function getIndexDBName(iurl, sthis) {
+  const url = ensureVersion(iurl);
+  const fullDb = url.pathname.replace(/^\/+/, "").replace(/\?.*$/, "");
+  const dbName = url.getParam(import_core2.PARAM.NAME);
+  if (!dbName) throw sthis.logger.Error().Str("url", url.toString()).Msg(`name not found`).AsError();
+  const result = joinDBName(fullDb, dbName);
+  const objStore = (0, import_core2.getStore)(url, sthis, joinDBName).name;
+  const connectionKey = [result, objStore].join(":");
+  return {
+    fullDb: result,
+    objStore,
+    connectionKey,
+    dbName
+  };
+}
+var IndexDBGateway = class {
+  constructor() {
+    this._db = {};
+  }
+  async start(baseURL, sthis) {
+    return (0, import_cement2.exception2Result)(async () => {
+      await sthis.start();
+      sthis.logger.Debug().Url(baseURL).Msg("starting");
+      const ic = await connectIdb(baseURL, sthis);
+      this._db = ic.db;
+      sthis.logger.Debug().Url(ic.url).Msg("started");
+      return ic.url;
+    });
+  }
+  async close() {
+    return import_cement2.Result.Ok(void 0);
+  }
+  async destroy(baseUrl, sthis) {
+    return (0, import_cement2.exception2Result)(async () => {
+      const type = (0, import_core2.getStore)(baseUrl, sthis, joinDBName).name;
+      const idb = this._db;
+      const trans = idb.transaction(type, "readwrite");
+      const object_store = trans.objectStore(type);
+      const toDelete = [];
+      for (let cursor = await object_store.openCursor(); cursor; cursor = await cursor.continue()) {
+        toDelete.push(cursor.primaryKey);
+      }
+      for (const key of toDelete) {
+        await trans.db.delete(type, key);
+      }
+      await trans.done;
+    });
+  }
+  buildUrl(baseUrl, key) {
+    return Promise.resolve(import_cement2.Result.Ok(baseUrl.build().setParam(import_core2.PARAM.KEY, key).URI()));
+  }
+  async get(url, sthis) {
+    return (0, import_core2.exceptionWrapper)(async () => {
+      const key = (0, import_core2.getKey)(url, sthis.logger);
+      const store = (0, import_core2.getStore)(url, sthis, joinDBName).name;
+      sthis.logger.Debug().Url(url).Str("key", key).Str("store", store).Msg("getting");
+      const tx = this._db.transaction([store], "readonly");
+      const bytes = await tx.objectStore(store).get(sanitzeKey(key));
+      await tx.done;
+      if (!bytes) {
+        return import_cement2.Result.Err(new import_core2.NotFoundError(`missing ${key}`));
+      }
+      return Promise.resolve(import_cement2.Result.Ok(bytes));
+    });
+  }
+  async put(url, bytes, sthis) {
+    return (0, import_cement2.exception2Result)(async () => {
+      const key = (0, import_core2.getKey)(url, sthis.logger);
+      const store = (0, import_core2.getStore)(url, sthis, joinDBName).name;
+      sthis.logger.Debug().Url(url).Str("key", key).Str("store", store).Msg("putting");
+      const tx = this._db.transaction([store], "readwrite");
+      await tx.objectStore(store).put(bytes, sanitzeKey(key));
+      await tx.done;
+    });
+  }
+  async delete(url, sthis) {
+    return (0, import_cement2.exception2Result)(async () => {
+      const key = (0, import_core2.getKey)(url, sthis.logger);
+      const store = (0, import_core2.getStore)(url, sthis, joinDBName).name;
+      sthis.logger.Debug().Url(url).Str("key", key).Str("store", store).Msg("deleting");
+      const tx = this._db.transaction([store], "readwrite");
+      await tx.objectStore(store).delete(sanitzeKey(key));
+      await tx.done;
+      return import_cement2.Result.Ok(void 0);
+    });
+  }
+  async getPlain(url, key, sthis) {
+    const ic = await connectIdb(url, sthis);
+    const store = (0, import_core2.getStore)(ic.url, sthis, joinDBName).name;
+    sthis.logger.Debug().Str("key", key).Str("store", store).Msg("getting");
+    let bytes = await ic.db.get(store, sanitzeKey(key));
+    sthis.logger.Debug().Str("key", key).Str("store", store).Int("len", bytes.length).Msg("got");
+    if (typeof bytes === "string") {
+      bytes = sthis.txt.encode(bytes);
+    }
+    return import_cement2.Result.Ok(bytes);
+  }
+};
+//# sourceMappingURL=index.cjs.map

package/web/index.cjs.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"sources":["../../../src/runtime/gateways/indexdb/web/index.ts","../../../src/runtime/gateways/indexdb/web/key-bag-indexdb.ts","../../../src/runtime/gateways/indexdb/web/gateway-impl.ts","../../../src/runtime/gateways/indexdb/version.ts"],"sourcesContent":["// export * from \"./gateway-impl.js\";\n\nexport * from \"./key-bag-indexdb.js\";\nimport { KeyBagProviderIndexDB as KeyBagProviderImpl } from \"./key-bag-indexdb.js\";\n\nexport { KeyBagProviderImpl };\n\nimport { IndexDBGateway as GatewayImpl } from \"./gateway-impl.js\";\nexport { GatewayImpl };\n","import { IDBPDatabase, openDB } from \"idb\";\nimport { Logger, ResolveOnce, URI } from \"@adviser/cement\";\nimport { SuperThis, rt } from \"@fireproof/core\";\n\nexport class KeyBagProviderIndexDB implements rt.kb.KeyBagProvider {\n readonly _db: ResolveOnce<IDBPDatabase<unknown>> = new ResolveOnce<IDBPDatabase<unknown>>();\n\n readonly dbName: string;\n readonly url: URI;\n readonly logger: Logger;\n readonly sthis: SuperThis;\n constructor(url: URI, sthis: SuperThis) {\n this.sthis = sthis;\n this.logger = sthis.logger;\n this.url = url;\n this.dbName = rt.getPath(this.url, this.sthis);\n }\n\n async _prepare(): Promise<IDBPDatabase<unknown>> {\n return this._db.once(async () => {\n return await openDB(this.dbName, 1, {\n upgrade(db) {\n // console.log('upgrade:', dbName);\n [\"bag\"].map((store) => {\n db.createObjectStore(store, {\n autoIncrement: false,\n });\n });\n },\n });\n });\n }\n\n async get(id: string): Promise<rt.kb.KeyItem | undefined> {\n const db = await this._prepare();\n const tx = db.transaction([\"bag\"], \"readonly\");\n const keyItem = await tx.objectStore(\"bag\").get(id);\n await tx.done;\n if (!keyItem) {\n return undefined;\n }\n return keyItem;\n }\n\n async set(id: string, item: rt.kb.KeyItem): Promise<void> {\n const db = await this._prepare();\n const tx = db.transaction([\"bag\"], \"readwrite\");\n await tx.objectStore(\"bag\").put(item, id);\n await tx.done;\n }\n}\n","import { openDB, IDBPDatabase } from \"idb\";\nimport { exception2Result, KeyedResolvOnce, Result, URI } from \"@adviser/cement\";\n\nimport { INDEXDB_VERSION } from \"../version.js\";\nimport { NotFoundError, PARAM, exceptionWrapper, getKey, getStore, type SuperThis, bs } from \"@fireproof/core\";\n\nfunction ensureVersion(url: URI): URI {\n return url.build().defParam(PARAM.VERSION, INDEXDB_VERSION).URI();\n}\n\ninterface IDBConn {\n readonly db: IDBPDatabase<unknown>;\n readonly dbName: DbName;\n readonly version: string;\n readonly url: URI;\n}\nconst onceIndexDB = new KeyedResolvOnce<IDBConn>();\n\nfunction sanitzeKey(key: string | string[]): string | string[] {\n if (key.length === 1) {\n key = key[0];\n }\n return key;\n}\n\nasync function connectIdb(url: URI, sthis: SuperThis): Promise<IDBConn> {\n const dbName = getIndexDBName(url, sthis);\n const once = await onceIndexDB.get(dbName.fullDb).once(async () => {\n const db = await openDB(dbName.fullDb, 1, {\n upgrade(db) {\n [\"version\", \"data\", \"wal\", \"meta\", \"idx.data\", \"idx.wal\", \"idx.meta\"].map((store) => {\n db.createObjectStore(store, {\n autoIncrement: false,\n });\n });\n },\n });\n const found = await db.get(\"version\", \"version\");\n const version = ensureVersion(url).getParam(PARAM.VERSION) as string;\n if (!found) {\n await db.put(\"version\", { version }, \"version\");\n } else if (found.version !== version) {\n sthis.logger.Warn().Url(url).Str(\"version\", version).Str(\"found\", found.version).Msg(\"version mismatch\");\n }\n return { db, dbName, version, url };\n });\n return {\n ...once,\n url: url.build().setParam(PARAM.VERSION, once.version).URI(),\n };\n}\n\nexport interface DbName {\n readonly fullDb: string;\n readonly objStore: string;\n readonly connectionKey: string;\n readonly dbName: string;\n}\n\nfunction joinDBName(...names: string[]): string {\n return names\n .map((i) => i.replace(/^[^a-zA-Z0-9]+/g, \"\").replace(/[^a-zA-Z0-9-]+/g, \"_\"))\n .filter((i) => i.length)\n .join(\".\");\n}\n\nexport function getIndexDBName(iurl: URI, sthis: SuperThis): DbName {\n const url = ensureVersion(iurl);\n const fullDb = url.pathname.replace(/^\\/+/, \"\").replace(/\\?.*$/, \"\"); // cut leading slashes\n const dbName = url.getParam(PARAM.NAME);\n if (!dbName) throw sthis.logger.Error().Str(\"url\", url.toString()).Msg(`name not found`).AsError();\n const result = joinDBName(fullDb, dbName);\n const objStore = getStore(url, sthis, joinDBName).name;\n const connectionKey = [result, objStore].join(\":\");\n return {\n fullDb: result,\n objStore,\n connectionKey,\n dbName,\n };\n}\n\nexport class IndexDBGateway implements bs.Gateway {\n _db: IDBPDatabase<unknown> = {} as IDBPDatabase<unknown>;\n\n async start(baseURL: URI, sthis: SuperThis): Promise<Result<URI>> {\n return exception2Result(async () => {\n await sthis.start();\n sthis.logger.Debug().Url(baseURL).Msg(\"starting\");\n const ic = await connectIdb(baseURL, sthis);\n this._db = ic.db;\n sthis.logger.Debug().Url(ic.url).Msg(\"started\");\n return ic.url;\n });\n }\n async close(): Promise<Result<void>> {\n return Result.Ok(undefined);\n }\n async destroy(baseUrl: URI, sthis: SuperThis): Promise<Result<void>> {\n return exception2Result(async () => {\n // return deleteDB(getIndexDBName(this.url).fullDb);\n const type = getStore(baseUrl, sthis, joinDBName).name;\n // console.log(\"IndexDBDataStore:destroy\", type);\n const idb = this._db;\n const trans = idb.transaction(type, \"readwrite\");\n const object_store = trans.objectStore(type);\n const toDelete = [];\n for (let cursor = await object_store.openCursor(); cursor; cursor = await cursor.continue()) {\n toDelete.push(cursor.primaryKey);\n }\n for (const key of toDelete) {\n await trans.db.delete(type, key);\n }\n await trans.done;\n });\n }\n\n buildUrl(baseUrl: URI, key: string): Promise<Result<URI>> {\n return Promise.resolve(Result.Ok(baseUrl.build().setParam(PARAM.KEY, key).URI()));\n }\n\n async get(url: URI, sthis: SuperThis): Promise<bs.GetResult> {\n return exceptionWrapper(async () => {\n const key = getKey(url, sthis.logger);\n const store = getStore(url, sthis, joinDBName).name;\n sthis.logger.Debug().Url(url).Str(\"key\", key).Str(\"store\", store).Msg(\"getting\");\n const tx = this._db.transaction([store], \"readonly\");\n const bytes = await tx.objectStore(store).get(sanitzeKey(key));\n await tx.done;\n if (!bytes) {\n return Result.Err(new NotFoundError(`missing ${key}`));\n }\n return Promise.resolve(Result.Ok(bytes));\n });\n }\n async put(url: URI, bytes: Uint8Array, sthis: SuperThis): Promise<Result<void>> {\n return exception2Result(async () => {\n const key = getKey(url, sthis.logger);\n const store = getStore(url, sthis, joinDBName).name;\n sthis.logger.Debug().Url(url).Str(\"key\", key).Str(\"store\", store).Msg(\"putting\");\n const tx = this._db.transaction([store], \"readwrite\");\n await tx.objectStore(store).put(bytes, sanitzeKey(key));\n await tx.done;\n });\n }\n async delete(url: URI, sthis: SuperThis) {\n return exception2Result(async () => {\n const key = getKey(url, sthis.logger);\n const store = getStore(url, sthis, joinDBName).name;\n sthis.logger.Debug().Url(url).Str(\"key\", key).Str(\"store\", store).Msg(\"deleting\");\n const tx = this._db.transaction([store], \"readwrite\");\n await tx.objectStore(store).delete(sanitzeKey(key));\n await tx.done;\n return Result.Ok(undefined);\n });\n }\n\n async getPlain(url: URI, key: string, sthis: SuperThis): Promise<Result<Uint8Array>> {\n const ic = await connectIdb(url, sthis);\n const store = getStore(ic.url, sthis, joinDBName).name;\n sthis.logger.Debug().Str(\"key\", key).Str(\"store\", store).Msg(\"getting\");\n let bytes = await ic.db.get(store, sanitzeKey(key));\n sthis.logger.Debug().Str(\"key\", key).Str(\"store\", store).Int(\"len\", bytes.length).Msg(\"got\");\n if (typeof bytes === \"string\") {\n bytes = sthis.txt.encode(bytes);\n }\n return Result.Ok(bytes as Uint8Array);\n }\n}\n","export const INDEXDB_VERSION = \"v0.19-indexdb\";\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,iBAAqC;AACrC,oBAAyC;AACzC,kBAA8B;AAEvB,IAAM,wBAAN,MAA4D;AAAA,EAOjE,YAAY,KAAU,OAAkB;AANxC,SAAS,MAA0C,IAAI,0BAAmC;AAOxF,SAAK,QAAQ;AACb,SAAK,SAAS,MAAM;AACpB,SAAK,MAAM;AACX,SAAK,SAAS,eAAG,QAAQ,KAAK,KAAK,KAAK,KAAK;AAAA,EAC/C;AAAA,EAEA,MAAM,WAA2C;AAC/C,WAAO,KAAK,IAAI,KAAK,YAAY;AAC/B,aAAO,UAAM,mBAAO,KAAK,QAAQ,GAAG;AAAA,QAClC,QAAQ,IAAI;AAEV,WAAC,KAAK,EAAE,IAAI,CAAC,UAAU;AACrB,eAAG,kBAAkB,OAAO;AAAA,cAC1B,eAAe;AAAA,YACjB,CAAC;AAAA,UACH,CAAC;AAAA,QACH;AAAA,MACF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,IAAI,IAAgD;AACxD,UAAM,KAAK,MAAM,KAAK,SAAS;AAC/B,UAAM,KAAK,GAAG,YAAY,CAAC,KAAK,GAAG,UAAU;AAC7C,UAAM,UAAU,MAAM,GAAG,YAAY,KAAK,EAAE,IAAI,EAAE;AAClD,UAAM,GAAG;AACT,QAAI,CAAC,SAAS;AACZ,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AAAA,EAEA,MAAM,IAAI,IAAY,MAAoC;AACxD,UAAM,KAAK,MAAM,KAAK,SAAS;AAC/B,UAAM,KAAK,GAAG,YAAY,CAAC,KAAK,GAAG,WAAW;AAC9C,UAAM,GAAG,YAAY,KAAK,EAAE,IAAI,MAAM,EAAE;AACxC,UAAM,GAAG;AAAA,EACX;AACF;;;AClDA,IAAAA,cAAqC;AACrC,IAAAC,iBAA+D;;;ACDxD,IAAM,kBAAkB;;;ADI/B,IAAAC,eAA6F;AAE7F,SAAS,cAAc,KAAe;AACpC,SAAO,IAAI,MAAM,EAAE,SAAS,mBAAM,SAAS,eAAe,EAAE,IAAI;AAClE;AAQA,IAAM,cAAc,IAAI,+BAAyB;AAEjD,SAAS,WAAW,KAA2C;AAC7D,MAAI,IAAI,WAAW,GAAG;AACpB,UAAM,IAAI,CAAC;AAAA,EACb;AACA,SAAO;AACT;AAEA,eAAe,WAAW,KAAU,OAAoC;AACtE,QAAM,SAAS,eAAe,KAAK,KAAK;AACxC,QAAM,OAAO,MAAM,YAAY,IAAI,OAAO,MAAM,EAAE,KAAK,YAAY;AACjE,UAAM,KAAK,UAAM,oBAAO,OAAO,QAAQ,GAAG;AAAA,MACxC,QAAQC,KAAI;AACV,SAAC,WAAW,QAAQ,OAAO,QAAQ,YAAY,WAAW,UAAU,EAAE,IAAI,CAAC,UAAU;AACnF,UAAAA,IAAG,kBAAkB,OAAO;AAAA,YAC1B,eAAe;AAAA,UACjB,CAAC;AAAA,QACH,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AACD,UAAM,QAAQ,MAAM,GAAG,IAAI,WAAW,SAAS;AAC/C,UAAM,UAAU,cAAc,GAAG,EAAE,SAAS,mBAAM,OAAO;AACzD,QAAI,CAAC,OAAO;AACV,YAAM,GAAG,IAAI,WAAW,EAAE,QAAQ,GAAG,SAAS;AAAA,IAChD,WAAW,MAAM,YAAY,SAAS;AACpC,YAAM,OAAO,KAAK,EAAE,IAAI,GAAG,EAAE,IAAI,WAAW,OAAO,EAAE,IAAI,SAAS,MAAM,OAAO,EAAE,IAAI,kBAAkB;AAAA,IACzG;AACA,WAAO,EAAE,IAAI,QAAQ,SAAS,IAAI;AAAA,EACpC,CAAC;AACD,SAAO;AAAA,IACL,GAAG;AAAA,IACH,KAAK,IAAI,MAAM,EAAE,SAAS,mBAAM,SAAS,KAAK,OAAO,EAAE,IAAI;AAAA,EAC7D;AACF;AASA,SAAS,cAAc,OAAyB;AAC9C,SAAO,MACJ,IAAI,CAAC,MAAM,EAAE,QAAQ,mBAAmB,EAAE,EAAE,QAAQ,mBAAmB,GAAG,CAAC,EAC3E,OAAO,CAAC,MAAM,EAAE,MAAM,EACtB,KAAK,GAAG;AACb;AAEO,SAAS,eAAe,MAAW,OAA0B;AAClE,QAAM,MAAM,cAAc,IAAI;AAC9B,QAAM,SAAS,IAAI,SAAS,QAAQ,QAAQ,EAAE,EAAE,QAAQ,SAAS,EAAE;AACnE,QAAM,SAAS,IAAI,SAAS,mBAAM,IAAI;AACtC,MAAI,CAAC,OAAQ,OAAM,MAAM,OAAO,MAAM,EAAE,IAAI,OAAO,IAAI,SAAS,CAAC,EAAE,IAAI,gBAAgB,EAAE,QAAQ;AACjG,QAAM,SAAS,WAAW,QAAQ,MAAM;AACxC,QAAM,eAAW,uBAAS,KAAK,OAAO,UAAU,EAAE;AAClD,QAAM,gBAAgB,CAAC,QAAQ,QAAQ,EAAE,KAAK,GAAG;AACjD,SAAO;AAAA,IACL,QAAQ;AAAA,IACR;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAEO,IAAM,iBAAN,MAA2C;AAAA,EAA3C;AACL,eAA6B,CAAC;AAAA;AAAA,EAE9B,MAAM,MAAM,SAAc,OAAwC;AAChE,eAAO,iCAAiB,YAAY;AAClC,YAAM,MAAM,MAAM;AAClB,YAAM,OAAO,MAAM,EAAE,IAAI,OAAO,EAAE,IAAI,UAAU;AAChD,YAAM,KAAK,MAAM,WAAW,SAAS,KAAK;AAC1C,WAAK,MAAM,GAAG;AACd,YAAM,OAAO,MAAM,EAAE,IAAI,GAAG,GAAG,EAAE,IAAI,SAAS;AAC9C,aAAO,GAAG;AAAA,IACZ,CAAC;AAAA,EACH;AAAA,EACA,MAAM,QAA+B;AACnC,WAAO,sBAAO,GAAG,MAAS;AAAA,EAC5B;AAAA,EACA,MAAM,QAAQ,SAAc,OAAyC;AACnE,eAAO,iCAAiB,YAAY;AAElC,YAAM,WAAO,uBAAS,SAAS,OAAO,UAAU,EAAE;AAElD,YAAM,MAAM,KAAK;AACjB,YAAM,QAAQ,IAAI,YAAY,MAAM,WAAW;AAC/C,YAAM,eAAe,MAAM,YAAY,IAAI;AAC3C,YAAM,WAAW,CAAC;AAClB,eAAS,SAAS,MAAM,aAAa,WAAW,GAAG,QAAQ,SAAS,MAAM,OAAO,SAAS,GAAG;AAC3F,iBAAS,KAAK,OAAO,UAAU;AAAA,MACjC;AACA,iBAAW,OAAO,UAAU;AAC1B,cAAM,MAAM,GAAG,OAAO,MAAM,GAAG;AAAA,MACjC;AACA,YAAM,MAAM;AAAA,IACd,CAAC;AAAA,EACH;AAAA,EAEA,SAAS,SAAc,KAAmC;AACxD,WAAO,QAAQ,QAAQ,sBAAO,GAAG,QAAQ,MAAM,EAAE,SAAS,mBAAM,KAAK,GAAG,EAAE,IAAI,CAAC,CAAC;AAAA,EAClF;AAAA,EAEA,MAAM,IAAI,KAAU,OAAyC;AAC3D,eAAO,+BAAiB,YAAY;AAClC,YAAM,UAAM,qBAAO,KAAK,MAAM,MAAM;AACpC,YAAM,YAAQ,uBAAS,KAAK,OAAO,UAAU,EAAE;AAC/C,YAAM,OAAO,MAAM,EAAE,IAAI,GAAG,EAAE,IAAI,OAAO,GAAG,EAAE,IAAI,SAAS,KAAK,EAAE,IAAI,SAAS;AAC/E,YAAM,KAAK,KAAK,IAAI,YAAY,CAAC,KAAK,GAAG,UAAU;AACnD,YAAM,QAAQ,MAAM,GAAG,YAAY,KAAK,EAAE,IAAI,WAAW,GAAG,CAAC;AAC7D,YAAM,GAAG;AACT,UAAI,CAAC,OAAO;AACV,eAAO,sBAAO,IAAI,IAAI,2BAAc,WAAW,GAAG,EAAE,CAAC;AAAA,MACvD;AACA,aAAO,QAAQ,QAAQ,sBAAO,GAAG,KAAK,CAAC;AAAA,IACzC,CAAC;AAAA,EACH;AAAA,EACA,MAAM,IAAI,KAAU,OAAmB,OAAyC;AAC9E,eAAO,iCAAiB,YAAY;AAClC,YAAM,UAAM,qBAAO,KAAK,MAAM,MAAM;AACpC,YAAM,YAAQ,uBAAS,KAAK,OAAO,UAAU,EAAE;AAC/C,YAAM,OAAO,MAAM,EAAE,IAAI,GAAG,EAAE,IAAI,OAAO,GAAG,EAAE,IAAI,SAAS,KAAK,EAAE,IAAI,SAAS;AAC/E,YAAM,KAAK,KAAK,IAAI,YAAY,CAAC,KAAK,GAAG,WAAW;AACpD,YAAM,GAAG,YAAY,KAAK,EAAE,IAAI,OAAO,WAAW,GAAG,CAAC;AACtD,YAAM,GAAG;AAAA,IACX,CAAC;AAAA,EACH;AAAA,EACA,MAAM,OAAO,KAAU,OAAkB;AACvC,eAAO,iCAAiB,YAAY;AAClC,YAAM,UAAM,qBAAO,KAAK,MAAM,MAAM;AACpC,YAAM,YAAQ,uBAAS,KAAK,OAAO,UAAU,EAAE;AAC/C,YAAM,OAAO,MAAM,EAAE,IAAI,GAAG,EAAE,IAAI,OAAO,GAAG,EAAE,IAAI,SAAS,KAAK,EAAE,IAAI,UAAU;AAChF,YAAM,KAAK,KAAK,IAAI,YAAY,CAAC,KAAK,GAAG,WAAW;AACpD,YAAM,GAAG,YAAY,KAAK,EAAE,OAAO,WAAW,GAAG,CAAC;AAClD,YAAM,GAAG;AACT,aAAO,sBAAO,GAAG,MAAS;AAAA,IAC5B,CAAC;AAAA,EACH;AAAA,EAEA,MAAM,SAAS,KAAU,KAAa,OAA+C;AACnF,UAAM,KAAK,MAAM,WAAW,KAAK,KAAK;AACtC,UAAM,YAAQ,uBAAS,GAAG,KAAK,OAAO,UAAU,EAAE;AAClD,UAAM,OAAO,MAAM,EAAE,IAAI,OAAO,GAAG,EAAE,IAAI,SAAS,KAAK,EAAE,IAAI,SAAS;AACtE,QAAI,QAAQ,MAAM,GAAG,GAAG,IAAI,OAAO,WAAW,GAAG,CAAC;AAClD,UAAM,OAAO,MAAM,EAAE,IAAI,OAAO,GAAG,EAAE,IAAI,SAAS,KAAK,EAAE,IAAI,OAAO,MAAM,MAAM,EAAE,IAAI,KAAK;AAC3F,QAAI,OAAO,UAAU,UAAU;AAC7B,cAAQ,MAAM,IAAI,OAAO,KAAK;AAAA,IAChC;AACA,WAAO,sBAAO,GAAG,KAAmB;AAAA,EACtC;AACF;","names":["import_idb","import_cement","import_core","db"]}

package/web/index.d.cts ADDED Viewed

@@ -0,0 +1,30 @@
+import { IDBPDatabase } from 'idb';
+import { ResolveOnce, URI, Logger, Result } from '@adviser/cement';
+import { rt, SuperThis, bs } from '@fireproof/core';
+declare class KeyBagProviderIndexDB implements rt.kb.KeyBagProvider {
+    readonly _db: ResolveOnce<IDBPDatabase<unknown>>;
+    readonly dbName: string;
+    readonly url: URI;
+    readonly logger: Logger;
+    readonly sthis: SuperThis;
+    constructor(url: URI, sthis: SuperThis);
+    _prepare(): Promise<IDBPDatabase<unknown>>;
+    get(id: string): Promise<rt.kb.KeyItem | undefined>;
+    set(id: string, item: rt.kb.KeyItem): Promise<void>;
+}
+declare class IndexDBGateway implements bs.Gateway {
+    _db: IDBPDatabase<unknown>;
+    start(baseURL: URI, sthis: SuperThis): Promise<Result<URI>>;
+    close(): Promise<Result<void>>;
+    destroy(baseUrl: URI, sthis: SuperThis): Promise<Result<void>>;
+    buildUrl(baseUrl: URI, key: string): Promise<Result<URI>>;
+    get(url: URI, sthis: SuperThis): Promise<bs.GetResult>;
+    put(url: URI, bytes: Uint8Array, sthis: SuperThis): Promise<Result<void>>;
+    delete(url: URI, sthis: SuperThis): Promise<Result<Result<undefined, Error>, Error>>;
+    getPlain(url: URI, key: string, sthis: SuperThis): Promise<Result<Uint8Array>>;
+}
+export { IndexDBGateway as GatewayImpl, KeyBagProviderIndexDB as KeyBagProviderImpl, KeyBagProviderIndexDB };
+declare module '@fireproof/core/web'

package/web/index.d.ts ADDED Viewed

@@ -0,0 +1,30 @@
+import { IDBPDatabase } from 'idb';
+import { ResolveOnce, URI, Logger, Result } from '@adviser/cement';
+import { rt, SuperThis, bs } from '@fireproof/core';
+declare class KeyBagProviderIndexDB implements rt.kb.KeyBagProvider {
+    readonly _db: ResolveOnce<IDBPDatabase<unknown>>;
+    readonly dbName: string;
+    readonly url: URI;
+    readonly logger: Logger;
+    readonly sthis: SuperThis;
+    constructor(url: URI, sthis: SuperThis);
+    _prepare(): Promise<IDBPDatabase<unknown>>;
+    get(id: string): Promise<rt.kb.KeyItem | undefined>;
+    set(id: string, item: rt.kb.KeyItem): Promise<void>;
+}
+declare class IndexDBGateway implements bs.Gateway {
+    _db: IDBPDatabase<unknown>;
+    start(baseURL: URI, sthis: SuperThis): Promise<Result<URI>>;
+    close(): Promise<Result<void>>;
+    destroy(baseUrl: URI, sthis: SuperThis): Promise<Result<void>>;
+    buildUrl(baseUrl: URI, key: string): Promise<Result<URI>>;
+    get(url: URI, sthis: SuperThis): Promise<bs.GetResult>;
+    put(url: URI, bytes: Uint8Array, sthis: SuperThis): Promise<Result<void>>;
+    delete(url: URI, sthis: SuperThis): Promise<Result<Result<undefined, Error>, Error>>;
+    getPlain(url: URI, key: string, sthis: SuperThis): Promise<Result<Uint8Array>>;
+}
+export { IndexDBGateway as GatewayImpl, KeyBagProviderIndexDB as KeyBagProviderImpl, KeyBagProviderIndexDB };
+declare module '@fireproof/core/web'