@xyo-network/xl1-driver-lmdb 2.0.11

package/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -0,0 +1,97 @@
+[![logo][]](https://xyo.network)
+
+# @xyo-network/xl1-driver-lmdb
+
+[![npm-badge][]][npm-link]
+[![license-badge][]][license-link]
+
+> LMDB-backed map driver for XL1 protocol storage — a synchronous, embedded `SyncMap` implementation for Node.
+
+## About
+
+XL1 SDK components persist data through the `MapType` (`SyncMap | AsyncMap`) abstraction. This package provides `SynchronousLmdbMap`, a synchronous [LMDB](https://github.com/kriszyp/lmdb-js)-backed `SyncMap` for Node, plus helpers (`getLocalPersistentMap`, `deleteLocalPersistentMap`, `getStoreDirectory`) for convention-based on-disk stores. A single LMDB environment supports multiple named stores for multi-tenancy.
+
+Inject it wherever an SDK component accepts a `MapType` to back that store with durable, embedded, file-based storage — no external database process required.
+
+## Install
+
+Using npm:
+
+```sh
+npm i --save @xyo-network/xl1-driver-lmdb
+```
+
+Using yarn:
+
+```sh
+yarn add @xyo-network/xl1-driver-lmdb
+```
+
+Using pnpm:
+
+```sh
+pnpm add @xyo-network/xl1-driver-lmdb
+```
+
+Using bun:
+
+```sh
+bun add @xyo-network/xl1-driver-lmdb
+```
+
+> `lmdb` is an optional peer dependency — install it in the consuming application. This package is Node-only.
+
+## What's Inside
+
+- **`SynchronousLmdbMap`** — a synchronous LMDB-backed `SyncMap<K, V>`: `get`/`set`/`has`/`getMany`/`setMany`/`delete`/`clear`/`all`, with multi-store support inside one environment.
+- **`getLocalPersistentMap` / `deleteLocalPersistentMap`** — create/remove a convention-based local store.
+- **`getStoreDirectory`**, **`StoreKind`**, **`LmdbMapParams`** — store path and configuration helpers.
+
+## Building Locally
+
+```sh
+xy build @xyo-network/xl1-driver-lmdb
+xy test @xyo-network/xl1-driver-lmdb
+xy lint @xyo-network/xl1-driver-lmdb
+```
+
+## Maintainers
+
+<table>
+  <tr>
+    <td align="center" valign="top" width="120">
+      <a href="https://github.com/arietrouw">
+        <img src="https://github.com/arietrouw.png" width="80" height="80" alt="Arie Trouw" /><br />
+        <sub><b>Arie Trouw</b></sub>
+      </a>
+      <br />
+      <a href="https://arietrouw.com">arietrouw.com</a>
+    </td>
+    <td align="center" valign="top" width="120">
+      <a href="https://github.com/jonesmac">
+        <img src="https://github.com/jonesmac.png" width="80" height="80" alt="Matt Jones" /><br />
+        <sub><b>Matt Jones</b></sub>
+      </a>
+    </td>
+    <td align="center" valign="top" width="120">
+      <a href="https://github.com/JoelBCarter">
+        <img src="https://github.com/JoelBCarter.png" width="80" height="80" alt="Joel Carter" /><br />
+        <sub><b>Joel Carter</b></sub>
+      </a>
+    </td>
+  </tr>
+</table>
+
+## License
+
+See the [LICENSE](./LICENSE) file (LGPL-3.0-only).
+
+## Credits
+
+[Made with 🔥 and ❄️ by XYO Foundation](https://xyo.network)
+
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-driver-lmdb.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-driver-lmdb
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-driver-lmdb.svg
+[license-link]: ./LICENSE
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/dist/node/Params.d.ts

@@ -0,0 +1,7 @@
+import type { CreatableParams } from '@xylabs/sdk-js';
+export interface LmdbMapParams extends CreatableParams {
+    dbName: string;
+    location: string;
+    storeName: string;
+}
+//# sourceMappingURL=Params.d.ts.map

package/dist/node/Params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Params.d.ts","sourceRoot":"","sources":["../../src/Params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAErD,MAAM,WAAW,aAAc,SAAQ,eAAe;IACpD,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;CAClB"}

package/dist/node/StoreKind.d.ts

@@ -0,0 +1,2 @@
+export type StoreKind = 'lmdb';
+//# sourceMappingURL=StoreKind.d.ts.map

package/dist/node/StoreKind.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StoreKind.d.ts","sourceRoot":"","sources":["../../src/StoreKind.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,MAAM,CAAA"}

package/dist/node/SynchronousLmdbMap.d.ts

@@ -0,0 +1,34 @@
+import { AbstractCreatable } from '@xylabs/sdk-js';
+import type { SyncMap } from '@xyo-network/xl1-protocol-lib';
+import type { Database, Key, RootDatabase } from 'lmdb';
+import type { LmdbMapParams } from './Params.ts';
+/**
+ * A synchronous LMDB-backed Map implementation.
+ * This class provides a synchronous interface to an LMDB database, allowing for key-value storage.
+ * It allows for multi-tenancy within a single LMDB environment by using a root database (located
+ * at this.folderPath) and a specific DB within the environment (specified by this.params.storeName).
+ * @template K - The type of keys in the map.
+ * @template V - The type of values in the map.
+ */
+export declare class SynchronousLmdbMap<K extends Key, V> extends AbstractCreatable<LmdbMapParams> implements SyncMap<K, V> {
+    protected db: Database<V, K>;
+    protected rootDatabase: RootDatabase;
+    /**
+     * The path to the LMDB folder where the database is stored.
+     * This is constructed from the location and dbName parameters
+     * allowing for multiple DBs within the root (by specifying a
+     * different storeName).
+     * @returns The folder path for the LMDB database.
+     */
+    get folderPath(): string;
+    all(): V[];
+    clear(): void;
+    delete(id: K): boolean;
+    get(id: K): V | undefined;
+    getMany(ids: K[]): V[];
+    has(id: K): boolean;
+    set(id: K, data: V): void;
+    setMany(entries: [K, V][]): void;
+    startHandler(): Promise<void>;
+}
+//# sourceMappingURL=SynchronousLmdbMap.d.ts.map

package/dist/node/SynchronousLmdbMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SynchronousLmdbMap.d.ts","sourceRoot":"","sources":["../../src/SynchronousLmdbMap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAa,MAAM,gBAAgB,CAAA;AAC7D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAA;AAC5D,OAAO,KAAK,EACV,QAAQ,EAAE,GAAG,EAAE,YAAY,EAC5B,MAAM,MAAM,CAAA;AAGb,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAGhD;;;;;;;GAOG;AACH,qBACa,kBAAkB,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,CAAE,SAAQ,iBAAiB,CAAC,aAAa,CAAE,YAAW,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IACjH,SAAS,CAAC,EAAE,EAAG,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAC7B,SAAS,CAAC,YAAY,EAAG,YAAY,CAAA;IAErC;;;;;;OAMG;IACH,IAAI,UAAU,WAEb;IAED,GAAG,IAAI,CAAC,EAAE;IAIV,KAAK,IAAI,IAAI;IAIb,MAAM,CAAC,EAAE,EAAE,CAAC,GAAG,OAAO;IAItB,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS;IAIzB,OAAO,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE;IAWtB,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,OAAO;IAInB,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI;IAIzB,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI;IAMjB,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CAO7C"}

package/dist/node/getStoreDirectory.d.ts

@@ -0,0 +1,10 @@
+import type { StoreKind } from './StoreKind.ts';
+/**
+ * Creates a convention-based directory path for an archivist store
+ * @param name The name of the archivist
+ * @param storageRoot The root directory for storage
+ * @param kind The kind of the archivist (optional)
+ * @returns The directory path for the archivist store
+ */
+export declare const getStoreDirectory: (name: string, storageRoot: string, kind?: StoreKind) => string;
+//# sourceMappingURL=getStoreDirectory.d.ts.map

package/dist/node/getStoreDirectory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getStoreDirectory.d.ts","sourceRoot":"","sources":["../../src/getStoreDirectory.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,GAAI,MAAM,MAAM,EAAE,aAAa,MAAM,EAAE,OAAO,SAAS,KAAG,MAEvF,CAAA"}

package/dist/node/index.d.ts

@@ -0,0 +1,6 @@
+export * from './getStoreDirectory.ts';
+export * from './localPersistentMap.ts';
+export * from './Params.ts';
+export * from './StoreKind.ts';
+export * from './SynchronousLmdbMap.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/node/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,yBAAyB,CAAA;AACvC,cAAc,aAAa,CAAA;AAC3B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,yBAAyB,CAAA"}

package/dist/node/index.mjs

@@ -0,0 +1,116 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result) __defProp(target, key, result);
+  return result;
+};
+
+// src/getStoreDirectory.ts
+import Path from "node:path";
+var getStoreDirectory = (name, storageRoot, kind) => {
+  return kind === void 0 ? Path.join(storageRoot, name) : Path.join(storageRoot, kind, name);
+};
+
+// src/localPersistentMap.ts
+import { rm } from "node:fs/promises";
+import Path2 from "node:path";
+
+// src/SynchronousLmdbMap.ts
+import { AbstractCreatable, creatable } from "@xylabs/sdk-js";
+import { open } from "lmdb";
+var SynchronousLmdbMap = class extends AbstractCreatable {
+  db;
+  rootDatabase;
+  /**
+   * The path to the LMDB folder where the database is stored.
+   * This is constructed from the location and dbName parameters
+   * allowing for multiple DBs within the root (by specifying a
+   * different storeName).
+   * @returns The folder path for the LMDB database.
+   */
+  get folderPath() {
+    return `${this.params.location}/${this.params.storeName}`;
+  }
+  all() {
+    return [...this.db.getRange({})].map((entry) => entry.value);
+  }
+  clear() {
+    this.db.clearSync();
+  }
+  delete(id) {
+    return this.db.removeSync(id);
+  }
+  get(id) {
+    return this.db.get(id);
+  }
+  getMany(ids) {
+    const results = [];
+    for (const id of ids) {
+      const value = this.db.get(id);
+      if (value !== void 0) {
+        results.push(value);
+      }
+    }
+    return results;
+  }
+  has(id) {
+    return this.db.doesExist(id);
+  }
+  set(id, data) {
+    this.db.putSync(id, data);
+  }
+  setMany(entries) {
+    for (const [key, value] of entries) {
+      this.set(key, value);
+    }
+  }
+  async startHandler() {
+    await super.startHandler();
+    this.rootDatabase = open({ path: this.folderPath, name: this.params.dbName });
+    this.db = this.rootDatabase.openDB({ name: this.params.storeName, cache: true });
+  }
+};
+SynchronousLmdbMap = __decorateClass([
+  creatable()
+], SynchronousLmdbMap);
+
+// src/localPersistentMap.ts
+var DEFAULT_STORAGE_ROOT = Path2.join(process.cwd(), ".store");
+var getLocalPersistentMap = async (dbName, storeName, storageRoot, kind = "lmdb") => {
+  switch (kind) {
+    case "lmdb": {
+      const root = storageRoot ?? DEFAULT_STORAGE_ROOT;
+      const location = getStoreDirectory(dbName, root, "lmdb");
+      const store = await SynchronousLmdbMap.create({
+        location,
+        dbName,
+        storeName
+      });
+      await store.start();
+      return store;
+    }
+  }
+};
+var deleteLocalPersistentMap = async (dbName, storageRoot, kind = "lmdb") => {
+  await Promise.resolve();
+  let location = "";
+  switch (kind) {
+    case "lmdb": {
+      const root = storageRoot ?? DEFAULT_STORAGE_ROOT;
+      location = getStoreDirectory(dbName, root, "lmdb");
+      break;
+    }
+  }
+  await rm(location, { recursive: true, force: true });
+};
+export {
+  SynchronousLmdbMap,
+  deleteLocalPersistentMap,
+  getLocalPersistentMap,
+  getStoreDirectory
+};
+//# sourceMappingURL=index.mjs.map

package/dist/node/index.mjs.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/getStoreDirectory.ts", "../../src/localPersistentMap.ts", "../../src/SynchronousLmdbMap.ts"],
+  "sourcesContent": ["import Path from 'node:path'\n\nimport type { StoreKind } from './StoreKind.ts'\n\n/**\n * Creates a convention-based directory path for an archivist store\n * @param name The name of the archivist\n * @param storageRoot The root directory for storage\n * @param kind The kind of the archivist (optional)\n * @returns The directory path for the archivist store\n */\nexport const getStoreDirectory = (name: string, storageRoot: string, kind?: StoreKind): string => {\n  return (kind === undefined) ? Path.join(storageRoot, name) : Path.join(storageRoot, kind, name)\n}\n", "import { rm } from 'node:fs/promises'\nimport Path from 'node:path'\n\nimport type { MapType } from '@xyo-network/xl1-protocol-lib'\n\nimport { getStoreDirectory } from './getStoreDirectory.ts'\nimport type { StoreKind } from './StoreKind.ts'\nimport { SynchronousLmdbMap } from './SynchronousLmdbMap.ts'\n\nconst DEFAULT_STORAGE_ROOT = Path.join(process.cwd(), '.store')\n\n/**\n * Returns a local persistent map\n * @param dbName The name of the database\n * @param storeName The name of the store\n * @param storageRoot The root directory for storage (default is '.store' in the current working directory)\n * @param kind The kind of the map\n * @returns a map\n */\nexport const getLocalPersistentMap = async <TId, TData>(\n  dbName: string,\n  storeName: string,\n  storageRoot?: string,\n  kind: StoreKind = 'lmdb'): Promise<MapType<TId, TData>> => {\n  switch (kind) {\n    case 'lmdb': {\n      const root = storageRoot ?? DEFAULT_STORAGE_ROOT\n      const location = getStoreDirectory(dbName, root, 'lmdb')\n      const store = await SynchronousLmdbMap.create({\n        location, dbName, storeName,\n      })\n      await store.start()\n      return store as unknown as MapType<TId, TData>\n    }\n  }\n}\n\nexport const deleteLocalPersistentMap = async (\n  dbName: string,\n  storageRoot?: string,\n  kind: StoreKind = 'lmdb',\n): Promise<void> => {\n  await Promise.resolve()\n  let location = ''\n  switch (kind) {\n    case 'lmdb': {\n      const root = storageRoot ?? DEFAULT_STORAGE_ROOT\n      location = getStoreDirectory(dbName, root, 'lmdb')\n      break\n    }\n  }\n  await rm(location, { recursive: true, force: true })\n}\n", "import { AbstractCreatable, creatable } from '@xylabs/sdk-js'\nimport type { SyncMap } from '@xyo-network/xl1-protocol-lib'\nimport type {\n  Database, Key, RootDatabase,\n} from 'lmdb'\nimport { open } from 'lmdb'\n\nimport type { LmdbMapParams } from './Params.ts'\n\n// TODO: Abstract creatable instead of service?\n/**\n * A synchronous LMDB-backed Map implementation.\n * This class provides a synchronous interface to an LMDB database, allowing for key-value storage.\n * It allows for multi-tenancy within a single LMDB environment by using a root database (located\n * at this.folderPath) and a specific DB within the environment (specified by this.params.storeName).\n * @template K - The type of keys in the map.\n * @template V - The type of values in the map.\n */\n@creatable()\nexport class SynchronousLmdbMap<K extends Key, V> extends AbstractCreatable<LmdbMapParams> implements SyncMap<K, V> {\n  protected db!: Database<V, K>\n  protected rootDatabase!: RootDatabase\n\n  /**\n   * The path to the LMDB folder where the database is stored.\n   * This is constructed from the location and dbName parameters\n   * allowing for multiple DBs within the root (by specifying a\n   * different storeName).\n   * @returns The folder path for the LMDB database.\n   */\n  get folderPath() {\n    return `${this.params.location}/${this.params.storeName}`\n  }\n\n  all(): V[] {\n    return [...this.db.getRange({})].map(entry => entry.value)\n  }\n\n  clear(): void {\n    this.db.clearSync()\n  }\n\n  delete(id: K): boolean {\n    return this.db.removeSync(id)\n  }\n\n  get(id: K): V | undefined {\n    return this.db.get(id)\n  }\n\n  getMany(ids: K[]): V[] {\n    const results: V[] = []\n    for (const id of ids) {\n      const value = this.db.get(id)\n      if (value !== undefined) {\n        results.push(value)\n      }\n    }\n    return results\n  }\n\n  has(id: K): boolean {\n    return this.db.doesExist(id)\n  }\n\n  set(id: K, data: V): void {\n    this.db.putSync(id, data)\n  }\n\n  setMany(entries: [K, V][]): void {\n    for (const [key, value] of entries) {\n      this.set(key, value)\n    }\n  }\n\n  override async startHandler(): Promise<void> {\n    await super.startHandler()\n    // Initialize the DB Environment (opens the default LMDB database)\n    this.rootDatabase = open({ path: this.folderPath, name: this.params.dbName })\n    // Open the desired DB (using the store name)\n    this.db = this.rootDatabase.openDB<V, K>({ name: this.params.storeName, cache: true })\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;AAAA,OAAO,UAAU;AAWV,IAAM,oBAAoB,CAAC,MAAc,aAAqB,SAA6B;AAChG,SAAQ,SAAS,SAAa,KAAK,KAAK,aAAa,IAAI,IAAI,KAAK,KAAK,aAAa,MAAM,IAAI;AAChG;;;ACbA,SAAS,UAAU;AACnB,OAAOA,WAAU;;;ACDjB,SAAS,mBAAmB,iBAAiB;AAK7C,SAAS,YAAY;AAcd,IAAM,qBAAN,cAAmD,kBAA0D;AAAA,EACxG;AAAA,EACA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASV,IAAI,aAAa;AACf,WAAO,GAAG,KAAK,OAAO,QAAQ,IAAI,KAAK,OAAO,SAAS;AAAA,EACzD;AAAA,EAEA,MAAW;AACT,WAAO,CAAC,GAAG,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,IAAI,WAAS,MAAM,KAAK;AAAA,EAC3D;AAAA,EAEA,QAAc;AACZ,SAAK,GAAG,UAAU;AAAA,EACpB;AAAA,EAEA,OAAO,IAAgB;AACrB,WAAO,KAAK,GAAG,WAAW,EAAE;AAAA,EAC9B;AAAA,EAEA,IAAI,IAAsB;AACxB,WAAO,KAAK,GAAG,IAAI,EAAE;AAAA,EACvB;AAAA,EAEA,QAAQ,KAAe;AACrB,UAAM,UAAe,CAAC;AACtB,eAAW,MAAM,KAAK;AACpB,YAAM,QAAQ,KAAK,GAAG,IAAI,EAAE;AAC5B,UAAI,UAAU,QAAW;AACvB,gBAAQ,KAAK,KAAK;AAAA,MACpB;AAAA,IACF;AACA,WAAO;AAAA,EACT;AAAA,EAEA,IAAI,IAAgB;AAClB,WAAO,KAAK,GAAG,UAAU,EAAE;AAAA,EAC7B;AAAA,EAEA,IAAI,IAAO,MAAe;AACxB,SAAK,GAAG,QAAQ,IAAI,IAAI;AAAA,EAC1B;AAAA,EAEA,QAAQ,SAAyB;AAC/B,eAAW,CAAC,KAAK,KAAK,KAAK,SAAS;AAClC,WAAK,IAAI,KAAK,KAAK;AAAA,IACrB;AAAA,EACF;AAAA,EAEA,MAAe,eAA8B;AAC3C,UAAM,MAAM,aAAa;AAEzB,SAAK,eAAe,KAAK,EAAE,MAAM,KAAK,YAAY,MAAM,KAAK,OAAO,OAAO,CAAC;AAE5E,SAAK,KAAK,KAAK,aAAa,OAAa,EAAE,MAAM,KAAK,OAAO,WAAW,OAAO,KAAK,CAAC;AAAA,EACvF;AACF;AA/Da,qBAAN;AAAA,EADN,UAAU;AAAA,GACE;;;ADVb,IAAM,uBAAuBC,MAAK,KAAK,QAAQ,IAAI,GAAG,QAAQ;AAUvD,IAAM,wBAAwB,OACnC,QACA,WACA,aACA,OAAkB,WAAyC;AAC3D,UAAQ,MAAM;AAAA,IACZ,KAAK,QAAQ;AACX,YAAM,OAAO,eAAe;AAC5B,YAAM,WAAW,kBAAkB,QAAQ,MAAM,MAAM;AACvD,YAAM,QAAQ,MAAM,mBAAmB,OAAO;AAAA,QAC5C;AAAA,QAAU;AAAA,QAAQ;AAAA,MACpB,CAAC;AACD,YAAM,MAAM,MAAM;AAClB,aAAO;AAAA,IACT;AAAA,EACF;AACF;AAEO,IAAM,2BAA2B,OACtC,QACA,aACA,OAAkB,WACA;AAClB,QAAM,QAAQ,QAAQ;AACtB,MAAI,WAAW;AACf,UAAQ,MAAM;AAAA,IACZ,KAAK,QAAQ;AACX,YAAM,OAAO,eAAe;AAC5B,iBAAW,kBAAkB,QAAQ,MAAM,MAAM;AACjD;AAAA,IACF;AAAA,EACF;AACA,QAAM,GAAG,UAAU,EAAE,WAAW,MAAM,OAAO,KAAK,CAAC;AACrD;",
+  "names": ["Path", "Path"]
+}

package/dist/node/localPersistentMap.d.ts

@@ -0,0 +1,13 @@
+import type { MapType } from '@xyo-network/xl1-protocol-lib';
+import type { StoreKind } from './StoreKind.ts';
+/**
+ * Returns a local persistent map
+ * @param dbName The name of the database
+ * @param storeName The name of the store
+ * @param storageRoot The root directory for storage (default is '.store' in the current working directory)
+ * @param kind The kind of the map
+ * @returns a map
+ */
+export declare const getLocalPersistentMap: <TId, TData>(dbName: string, storeName: string, storageRoot?: string, kind?: StoreKind) => Promise<MapType<TId, TData>>;
+export declare const deleteLocalPersistentMap: (dbName: string, storageRoot?: string, kind?: StoreKind) => Promise<void>;
+//# sourceMappingURL=localPersistentMap.d.ts.map

package/dist/node/localPersistentMap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localPersistentMap.d.ts","sourceRoot":"","sources":["../../src/localPersistentMap.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAA;AAG5D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAK/C;;;;;;;GAOG;AACH,eAAO,MAAM,qBAAqB,GAAU,GAAG,EAAE,KAAK,EACpD,QAAQ,MAAM,EACd,WAAW,MAAM,EACjB,cAAc,MAAM,EACpB,OAAM,SAAkB,KAAG,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAYvD,CAAA;AAED,eAAO,MAAM,wBAAwB,GACnC,QAAQ,MAAM,EACd,cAAc,MAAM,EACpB,OAAM,SAAkB,KACvB,OAAO,CAAC,IAAI,CAWd,CAAA"}

package/package.json

@@ -0,0 +1,112 @@
+{
+  "$schema": "http://json.schemastore.org/package.json",
+  "name": "@xyo-network/xl1-driver-lmdb",
+  "version": "2.0.11",
+  "description": "XYO Layer One SDK Protocol LMDB Driver",
+  "homepage": "https://xylabs.com",
+  "bugs": {
+    "url": "https://github.com/XYOracleNetwork/xl1-protocol/issues",
+    "email": "support@xylabs.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/XYOracleNetwork/xl1-protocol.git"
+  },
+  "license": "LGPL-3.0-only",
+  "author": {
+    "name": "XY Labs Development Team",
+    "email": "support@xylabs.com",
+    "url": "https://xylabs.com"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/node/index.d.ts",
+      "default": "./dist/node/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "!**/*.bench.*",
+    "!**/*.spec.*",
+    "!**/*.test.*",
+    "README.md"
+  ],
+  "dependencies": {
+    "@xyo-network/xl1-protocol-lib": "~2.0.11"
+  },
+  "devDependencies": {
+    "@bitauth/libauth": "~3.0",
+    "@metamask/providers": "^22.1",
+    "@noble/post-quantum": "~0.6.1",
+    "@opentelemetry/api": "^1.9",
+    "@opentelemetry/sdk-trace-base": "^2.7",
+    "@scure/base": "~2.2",
+    "@scure/bip39": "~2.2",
+    "@xylabs/geo": "^6.0",
+    "@xylabs/sdk-js": "^6.0.10",
+    "@xylabs/threads": "~6.0",
+    "@xylabs/toolchain": "~8.1.18",
+    "@xylabs/tsconfig": "~8.1.18",
+    "@xyo-network/address": "^6.0",
+    "@xyo-network/sdk-js": "^6.0",
+    "@xyo-network/sdk-protocol-js": "~6.0",
+    "ajv": "^8.20",
+    "async-mutex": "^0.5",
+    "bn.js": "^5.2",
+    "buffer": "^6.0",
+    "debug": "~4.4",
+    "eslint": "^10.4.1",
+    "ethers": "^6.16",
+    "hash-wasm": "~4.12",
+    "idb": "^8.0",
+    "lmdb": "^3.5.5",
+    "lru-cache": "^11.3",
+    "observable-fns": "~0.6",
+    "typescript": "~6.0.3",
+    "webextension-polyfill": "^0.12",
+    "zod": "~4.4"
+  },
+  "peerDependencies": {
+    "@bitauth/libauth": "~3.0",
+    "@metamask/providers": "^22.1",
+    "@noble/post-quantum": "~0.6.1",
+    "@opentelemetry/api": "^1.9",
+    "@opentelemetry/sdk-trace-base": "^2.7",
+    "@scure/base": "~2.2",
+    "@scure/bip39": "~2.2",
+    "@xylabs/geo": "^6.0",
+    "@xylabs/sdk-js": "^6.0",
+    "@xylabs/threads": "~6.0",
+    "@xyo-network/address": "^6.0",
+    "@xyo-network/sdk-js": "^6.0",
+    "@xyo-network/sdk-protocol-js": "~6.0",
+    "ajv": "^8.20",
+    "async-mutex": "^0.5",
+    "bn.js": "^5.2",
+    "buffer": "^6.0",
+    "debug": "~4.4",
+    "ethers": "^6.16",
+    "hash-wasm": "~4.12",
+    "idb": "^8.0",
+    "lmdb": "^3.5",
+    "lru-cache": "^11.3",
+    "observable-fns": "~0.6",
+    "webextension-polyfill": "^0.12",
+    "zod": "~4.4"
+  },
+  "peerDependenciesMeta": {
+    "lmdb": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=22.3"
+  },
+  "engineStrict": true,
+  "publishConfig": {
+    "access": "public"
+  }
+}