@graphrefly/graphrefly 0.44.0 → 0.46.0

package/dist/extra/storage-tiers-browser.d.cts

@@ -1,120 +0,0 @@
-import { AppendLogStorageOptions, AppendLogStorageTier, StorageBackend, KvStorageOptions, KvStorageTier, SnapshotStorageOptions, SnapshotStorageTier } from './storage-tiers.cjs';
-
-/**
- * Browser-only Audit 4 storage backend + convenience factories.
- *
- * Uses DOM `IndexedDB`. Browser-safe consumers should import from this module;
- * Node consumers should not import here without the DOM lib in their tsconfig.
- *
- * @module
- */
-
-type IndexedDbBackendSpec = {
-    dbName: string;
-    storeName: string;
-    version?: number;
-};
-/**
- * Creates an IndexedDB backend for browser-based persistent storage.
- *
- * All operations (`read`, `write`, `delete`, `list`) are async and return
- * `Promise`. The backing object store is created automatically on first open
- * if it does not already exist.
- *
- * @param spec - Database name, object store name, and optional schema version.
- * @returns `StorageBackend` backed by an IndexedDB object store.
- *
- * @example
- * ```ts
- * import { indexedDbBackend, snapshotStorage } from "@graphrefly/graphrefly/extra/browser";
- *
- * const backend = indexedDbBackend({ dbName: "my-app", storeName: "snapshots" });
- * const tier = snapshotStorage(backend, { name: "graph1" });
- * await tier.save({ name: "graph1", state: {} });
- * ```
- *
- * @category extra
- */
-declare function indexedDbBackend(spec: IndexedDbBackendSpec): StorageBackend;
-/**
- * Creates an IndexedDB snapshot tier backed by an `indexedDbBackend`.
- *
- * Convenience wrapper for `snapshotStorage(indexedDbBackend(spec), opts)`.
- * All reads and writes are async via IndexedDB. Requires a browser or
- * browser-compatible environment.
- *
- * @param spec - Database name, object store name, and optional schema version.
- * @param opts - Optional snapshot storage options (name, codec, filter, keyOf, debounce, compactEvery).
- * @returns `SnapshotStorageTier<T>` backed by IndexedDB.
- *
- * @example
- * ```ts
- * import { indexedDbSnapshot } from "@graphrefly/graphrefly/extra/browser";
- *
- * const tier = indexedDbSnapshot<{ count: number }>(
- *   { dbName: "my-app", storeName: "snapshots" },
- *   { name: "counter" },
- * );
- * await tier.save({ count: 1 });
- * ```
- *
- * @category extra
- */
-declare function indexedDbSnapshot<T>(spec: IndexedDbBackendSpec, opts?: Omit<SnapshotStorageOptions<T>, "name"> & {
-    name?: string;
-}): SnapshotStorageTier<T>;
-/**
- * Creates an IndexedDB append-log tier backed by an `indexedDbBackend`.
- *
- * Convenience wrapper for `appendLogStorage(indexedDbBackend(spec), opts)`.
- * All reads and writes are async via IndexedDB. Requires a browser or
- * browser-compatible environment.
- *
- * @param spec - Database name, object store name, and optional schema version.
- * @param opts - Optional append-log storage options (name, codec, keyOf, debounce, compactEvery).
- * @returns `AppendLogStorageTier<T>` backed by IndexedDB.
- *
- * @example
- * ```ts
- * import { indexedDbAppendLog } from "@graphrefly/graphrefly/extra/browser";
- *
- * const tier = indexedDbAppendLog<{ type: string }>(
- *   { dbName: "my-app", storeName: "events" },
- * );
- * await tier.appendEntries([{ type: "init" }]);
- * ```
- *
- * @category extra
- */
-declare function indexedDbAppendLog<T>(spec: IndexedDbBackendSpec, opts?: Omit<AppendLogStorageOptions<T>, "name"> & {
-    name?: string;
-}): AppendLogStorageTier<T>;
-/**
- * Creates an IndexedDB key-value tier backed by an `indexedDbBackend`.
- *
- * Convenience wrapper for `kvStorage(indexedDbBackend(spec), opts)`.
- * All reads and writes are async via IndexedDB. Requires a browser or
- * browser-compatible environment.
- *
- * @param spec - Database name, object store name, and optional schema version.
- * @param opts - Optional kv storage options (name, codec, filter, debounce, compactEvery).
- * @returns `KvStorageTier<T>` backed by IndexedDB.
- *
- * @example
- * ```ts
- * import { indexedDbKv } from "@graphrefly/graphrefly/extra/browser";
- *
- * const kv = indexedDbKv<{ score: number }>(
- *   { dbName: "my-app", storeName: "scores" },
- * );
- * await kv.save("player1", { score: 100 });
- * const val = await kv.load("player1");
- * ```
- *
- * @category extra
- */
-declare function indexedDbKv<T>(spec: IndexedDbBackendSpec, opts?: Omit<KvStorageOptions<T>, "name"> & {
-    name?: string;
-}): KvStorageTier<T>;
-
-export { type IndexedDbBackendSpec, indexedDbAppendLog, indexedDbBackend, indexedDbKv, indexedDbSnapshot };

package/dist/extra/storage-tiers-browser.d.ts

@@ -1,120 +0,0 @@
-import { AppendLogStorageOptions, AppendLogStorageTier, StorageBackend, KvStorageOptions, KvStorageTier, SnapshotStorageOptions, SnapshotStorageTier } from './storage-tiers.js';
-
-/**
- * Browser-only Audit 4 storage backend + convenience factories.
- *
- * Uses DOM `IndexedDB`. Browser-safe consumers should import from this module;
- * Node consumers should not import here without the DOM lib in their tsconfig.
- *
- * @module
- */
-
-type IndexedDbBackendSpec = {
-    dbName: string;
-    storeName: string;
-    version?: number;
-};
-/**
- * Creates an IndexedDB backend for browser-based persistent storage.
- *
- * All operations (`read`, `write`, `delete`, `list`) are async and return
- * `Promise`. The backing object store is created automatically on first open
- * if it does not already exist.
- *
- * @param spec - Database name, object store name, and optional schema version.
- * @returns `StorageBackend` backed by an IndexedDB object store.
- *
- * @example
- * ```ts
- * import { indexedDbBackend, snapshotStorage } from "@graphrefly/graphrefly/extra/browser";
- *
- * const backend = indexedDbBackend({ dbName: "my-app", storeName: "snapshots" });
- * const tier = snapshotStorage(backend, { name: "graph1" });
- * await tier.save({ name: "graph1", state: {} });
- * ```
- *
- * @category extra
- */
-declare function indexedDbBackend(spec: IndexedDbBackendSpec): StorageBackend;
-/**
- * Creates an IndexedDB snapshot tier backed by an `indexedDbBackend`.
- *
- * Convenience wrapper for `snapshotStorage(indexedDbBackend(spec), opts)`.
- * All reads and writes are async via IndexedDB. Requires a browser or
- * browser-compatible environment.
- *
- * @param spec - Database name, object store name, and optional schema version.
- * @param opts - Optional snapshot storage options (name, codec, filter, keyOf, debounce, compactEvery).
- * @returns `SnapshotStorageTier<T>` backed by IndexedDB.
- *
- * @example
- * ```ts
- * import { indexedDbSnapshot } from "@graphrefly/graphrefly/extra/browser";
- *
- * const tier = indexedDbSnapshot<{ count: number }>(
- *   { dbName: "my-app", storeName: "snapshots" },
- *   { name: "counter" },
- * );
- * await tier.save({ count: 1 });
- * ```
- *
- * @category extra
- */
-declare function indexedDbSnapshot<T>(spec: IndexedDbBackendSpec, opts?: Omit<SnapshotStorageOptions<T>, "name"> & {
-    name?: string;
-}): SnapshotStorageTier<T>;
-/**
- * Creates an IndexedDB append-log tier backed by an `indexedDbBackend`.
- *
- * Convenience wrapper for `appendLogStorage(indexedDbBackend(spec), opts)`.
- * All reads and writes are async via IndexedDB. Requires a browser or
- * browser-compatible environment.
- *
- * @param spec - Database name, object store name, and optional schema version.
- * @param opts - Optional append-log storage options (name, codec, keyOf, debounce, compactEvery).
- * @returns `AppendLogStorageTier<T>` backed by IndexedDB.
- *
- * @example
- * ```ts
- * import { indexedDbAppendLog } from "@graphrefly/graphrefly/extra/browser";
- *
- * const tier = indexedDbAppendLog<{ type: string }>(
- *   { dbName: "my-app", storeName: "events" },
- * );
- * await tier.appendEntries([{ type: "init" }]);
- * ```
- *
- * @category extra
- */
-declare function indexedDbAppendLog<T>(spec: IndexedDbBackendSpec, opts?: Omit<AppendLogStorageOptions<T>, "name"> & {
-    name?: string;
-}): AppendLogStorageTier<T>;
-/**
- * Creates an IndexedDB key-value tier backed by an `indexedDbBackend`.
- *
- * Convenience wrapper for `kvStorage(indexedDbBackend(spec), opts)`.
- * All reads and writes are async via IndexedDB. Requires a browser or
- * browser-compatible environment.
- *
- * @param spec - Database name, object store name, and optional schema version.
- * @param opts - Optional kv storage options (name, codec, filter, debounce, compactEvery).
- * @returns `KvStorageTier<T>` backed by IndexedDB.
- *
- * @example
- * ```ts
- * import { indexedDbKv } from "@graphrefly/graphrefly/extra/browser";
- *
- * const kv = indexedDbKv<{ score: number }>(
- *   { dbName: "my-app", storeName: "scores" },
- * );
- * await kv.save("player1", { score: 100 });
- * const val = await kv.load("player1");
- * ```
- *
- * @category extra
- */
-declare function indexedDbKv<T>(spec: IndexedDbBackendSpec, opts?: Omit<KvStorageOptions<T>, "name"> & {
-    name?: string;
-}): KvStorageTier<T>;
-
-export { type IndexedDbBackendSpec, indexedDbAppendLog, indexedDbBackend, indexedDbKv, indexedDbSnapshot };

package/dist/extra/storage-tiers-browser.js

@@ -1 +0,0 @@
-import{a,b,c,d}from"../chunk-F672GV32.js";import"../chunk-D5RFJOZ2.js";import"../chunk-CE72X3WO.js";import"../chunk-QYADASLV.js";export{c as indexedDbAppendLog,a as indexedDbBackend,d as indexedDbKv,b as indexedDbSnapshot};

package/dist/extra/storage-tiers-node.cjs

@@ -1 +0,0 @@
-"use strict";var A=Object.defineProperty;var U=Object.getOwnPropertyDescriptor;var N=Object.getOwnPropertyNames;var F=Object.prototype.hasOwnProperty;var j=(n,e)=>{for(var t in e)A(n,t,{get:e[t],enumerable:!0})},_=(n,e,t,s)=>{if(e&&typeof e=="object"||typeof e=="function")for(let l of N(e))!F.call(n,l)&&l!==t&&A(n,l,{get:()=>e[l],enumerable:!(s=U(e,l))||s.enumerable});return n};var W=n=>_(A({},"__esModule",{value:!0}),n);var V={};j(V,{fileAppendLog:()=>J,fileBackend:()=>k,fileKv:()=>H,fileSnapshot:()=>I,sqliteAppendLog:()=>z,sqliteBackend:()=>w,sqliteKv:()=>Y,sqliteSnapshot:()=>q});module.exports=W(V);var C=require("node:crypto"),m=require("node:fs"),S=require("node:path"),R=require("node:sqlite");function E(n){if(n===null||typeof n!="object")return n;if(Array.isArray(n))return n.map(E);let e=n,t=Object.keys(e).sort(),s={};for(let l of t)s[l]=E(e[l]);return s}function M(n){return JSON.stringify(E(n),void 0,0)}var $=new TextEncoder,D=new TextDecoder("utf-8",{fatal:!0}),b={name:"json",version:1,encode(n){return $.encode(M(n))},decode(n){return JSON.parse(D.decode(n))}};function P(n,e={}){let t=e.codec??b,s=e.name??n.name??"snapshot",l=e.keyOf??(d=>d.name??e.name??n.name??"snapshot"),o,r=0,c=e.compactEvery,f,a={name:s,debounceMs:e.debounceMs,compactEvery:c,filter:e.filter,keyOf:l,save(d){if(!(e.filter&&!e.filter(d))&&(o={snapshot:d},r+=1,c!==void 0&&r%c===0||!e.debounceMs))return i()},load(){let d=f??s,u=n.read(d);if(u!==void 0)return u instanceof Uint8Array?u.length===0?void 0:t.decode(u):Promise.resolve(u).then(p=>p===void 0||p.length===0?void 0:t.decode(p))},async flush(){await i()},async rollback(){o=void 0}};function i(){let d=o;if(!d)return;o=void 0;let u=l(d.snapshot),p=t.encode(d.snapshot),g=n.write(u,p);if(g instanceof Promise)return g.then(()=>{f=u});f=u}return a}function x(n,e={}){let t=e.codec??b,s=e.name??n.name??"append-log",l=e.keyOf??(u=>s),o=e.compactEvery,r=new Map,c=0,f,a={name:s,debounceMs:e.debounceMs,compactEvery:o,keyOf:l,appendEntries(u){if(u.length!==0){for(let p of u){let g=l(p),y=r.get(g);y||(y=[],r.set(g,y)),y.push(p)}if(c+=u.length,o!==void 0&&c%o===0||!e.debounceMs)return i()}},async loadEntries(u){let p=u?.keyFilter,g=n.list===void 0?p!==void 0?[p]:[s]:await Promise.resolve(n.list(p)),y=[];for(let v of g){let h=await Promise.resolve(n.read(v));if(h===void 0||h.length===0)continue;let T=t.decode(h);Array.isArray(T)&&y.push(...T)}return{entries:y,cursor:void 0}},async flush(){await i()},async rollback(){r=new Map}};function i(){if(r.size===0)return;let u=r;r=new Map;let p=(f??Promise.resolve()).then(()=>{let g=d(u);return g instanceof Promise?g:Promise.resolve()},()=>{let g=d(u);return g instanceof Promise?g:Promise.resolve()});return f=p.finally(()=>{f===p&&(f=void 0)}),f}function d(u){let p=[];for(let[g,y]of u){let v=n.read(g),h=T=>{let B=[...T===void 0||T.length===0?[]:t.decode(T)??[],...y],K=t.encode(B);return n.write(g,K)};if(v instanceof Promise)p.push(v.then(async T=>{let O=h(T);O instanceof Promise&&await O}));else{let T=h(v);T instanceof Promise&&p.push(T)}}if(p.length>0)return Promise.all(p).then(()=>{})}return a}function L(n,e={}){let t=e.codec??b,s=e.name??n.name??"kv",l=e.compactEvery,o=new Map,r=0,c={name:s,debounceMs:e.debounceMs,compactEvery:l,filter:e.filter,save(a,i){if(!(e.filter&&!e.filter(a,i))&&(o.set(a,i),r+=1,l!==void 0&&r%l===0||!e.debounceMs))return f()},load(a){let i=n.read(a);if(i!==void 0)return i instanceof Uint8Array?i.length===0?void 0:t.decode(i):Promise.resolve(i).then(d=>d===void 0||d.length===0?void 0:t.decode(d))},delete(a){if(o.delete(a),!!n.delete)return n.delete(a)},list(a){return n.list?n.list(a):[]},async flush(){await f()},async rollback(){o=new Map}};function f(){if(o.size===0)return;let a=o;o=new Map;let i=[];for(let[d,u]of a){let p=t.encode(u),g=n.write(d,p);g instanceof Promise&&i.push(g)}if(i.length>0)return Promise.all(i).then(()=>{})}return c}function k(n){let e=new TextEncoder,t=new TextDecoder("utf-8",{fatal:!0}),s=o=>{let r="";for(let c of o){if(c.length===1&&/[a-zA-Z0-9_-]/.test(c)){r+=c;continue}for(let f of e.encode(c))r+=`%${f.toString(16).padStart(2,"0")}`}return(0,S.join)(n,`${r}.bin`)},l=o=>{if(!o.endsWith(".bin"))return null;let r=o.slice(0,-4),c=[],f=i=>{for(let d=0;d<i.length;d++)c.push(i.charCodeAt(d))},a=0;for(;a<r.length;){let i=r[a];if(i==="%"&&a+2<r.length){let d=r.slice(a+1,a+3);if(/^[0-9a-f]{2}$/i.test(d)){c.push(Number.parseInt(d,16)),a+=3;continue}}f(i),a+=1}try{return t.decode(new Uint8Array(c))}catch{return null}};return{name:`file:${n}`,read(o){try{let r=(0,m.readFileSync)(s(o));return new Uint8Array(r.buffer,r.byteOffset,r.byteLength)}catch{return}},write(o,r){(0,m.mkdirSync)(n,{recursive:!0});let c=s(o),f=(0,S.basename)(c),a=(0,S.dirname)(c),i=(0,S.join)(a,`.${f}.${(0,C.randomBytes)(8).toString("hex")}.tmp`);try{(0,m.writeFileSync)(i,r),(0,m.renameSync)(i,c)}catch(d){try{(0,m.unlinkSync)(i)}catch{}throw d}},delete(o){try{(0,m.unlinkSync)(s(o))}catch(r){if(r.code!=="ENOENT")throw r}},list(o){try{let r=(0,m.readdirSync)(n),c=[];for(let f of r){if(f.startsWith("."))continue;let a=l(f);a!==null&&(o!==void 0&&!a.startsWith(o)||c.push(a))}return c.sort()}catch(r){if(r.code==="ENOENT")return[];throw r}}}}function w(n){let e=new R.DatabaseSync(n);return e.exec("CREATE TABLE IF NOT EXISTS graphrefly_storage (k TEXT PRIMARY KEY, v BLOB NOT NULL)"),{name:`sqlite:${n}`,read(t){return e.prepare("SELECT v FROM graphrefly_storage WHERE k = ?").get(t)?.v},write(t,s){e.prepare("INSERT OR REPLACE INTO graphrefly_storage (k, v) VALUES (?, ?)").run(t,s)},delete(t){e.prepare("DELETE FROM graphrefly_storage WHERE k = ?").run(t)},list(t){if(t===void 0)return e.prepare("SELECT k FROM graphrefly_storage ORDER BY k").all().map(r=>r.k);let s=t.replace(/[\\%_]/g,"\\$&");return e.prepare("SELECT k FROM graphrefly_storage WHERE k LIKE ? ESCAPE '\\' ORDER BY k").all(`${s}%`).map(o=>o.k)},close(){try{e.close()}catch{}}}}function I(n,e){return P(k(n),e)}function J(n,e){return x(k(n),e)}function q(n,e){let t=w(n),s=P(t,e);return Object.assign(s,{close:()=>t.close()})}function z(n,e){let t=w(n),s=x(t,e);return Object.assign(s,{close:()=>t.close()})}function H(n,e){return L(k(n),e)}function Y(n,e){let t=w(n),s=L(t,e);return Object.assign(s,{close:()=>t.close()})}0&&(module.exports={fileAppendLog,fileBackend,fileKv,fileSnapshot,sqliteAppendLog,sqliteBackend,sqliteKv,sqliteSnapshot});

package/dist/extra/storage-tiers-node.d.cts

@@ -1,210 +0,0 @@
-import { AppendLogStorageOptions, AppendLogStorageTier, StorageBackend, KvStorageOptions, KvStorageTier, SnapshotStorageOptions, SnapshotStorageTier } from './storage-tiers.cjs';
-
-/**
- * Node-only Audit 4 storage backends + convenience factories.
- *
- * Imports `node:fs`, `node:path`, `node:crypto`, `node:sqlite`. Browser-safe
- * consumers should not import this module.
- *
- * @module
- */
-
-/**
- * Creates a filesystem backend that maps each key to a file under `dir`.
- *
- * Writes are atomic via temp + rename. Keys are percent-encoded to safe
- * filenames; `list(prefix)` enumerates `.bin` files in the directory.
- *
- * @param dir - Directory path where key files are stored (created on first write).
- * @returns `StorageBackend` backed by the filesystem under `dir`.
- *
- * @example
- * ```ts
- * import { fileBackend, snapshotStorage } from "@graphrefly/graphrefly/extra/node";
- *
- * const backend = fileBackend("./checkpoints");
- * const tier = snapshotStorage(backend, { name: "my-graph" });
- * await tier.save({ name: "my-graph", state: { count: 1 } });
- * ```
- *
- * @category extra
- */
-declare function fileBackend(dir: string): StorageBackend;
-/**
- * Creates a SQLite backend using Node 22.5+ `node:sqlite`.
- *
- * Stores byte values under string keys in a single `graphrefly_storage` table.
- * The caller owns the connection lifetime — call `.close()` for explicit teardown.
- * Requires Node 22.5 or later for `node:sqlite`.
- *
- * @param path - Filesystem path to the SQLite database file (created if absent).
- * @returns `StorageBackend` with an extra `close()` method for explicit teardown.
- *
- * @example
- * ```ts
- * import { sqliteBackend, snapshotStorage } from "@graphrefly/graphrefly/extra/node";
- *
- * const backend = sqliteBackend("./state.db");
- * const tier = snapshotStorage(backend, { name: "my-graph" });
- * await tier.save({ name: "my-graph", state: { count: 1 } });
- * backend.close();
- * ```
- *
- * @category extra
- */
-declare function sqliteBackend(path: string): StorageBackend & {
-    close(): void;
-};
-/**
- * Creates a filesystem snapshot tier backed by a `fileBackend` under `dir`.
- *
- * Convenience wrapper for `snapshotStorage(fileBackend(dir), opts)`.
- * Writes are atomic (temp + rename). Requires Node.js with filesystem access.
- *
- * @param dir - Directory path where snapshot files are stored.
- * @param opts - Optional snapshot storage options (name, codec, filter, keyOf, debounce, compactEvery).
- * @returns `SnapshotStorageTier<T>` backed by the filesystem.
- *
- * @example
- * ```ts
- * import { fileSnapshot } from "@graphrefly/graphrefly/extra/node";
- *
- * const tier = fileSnapshot<{ count: number }>("./checkpoints", { name: "counter" });
- * await tier.save({ count: 1 });
- * ```
- *
- * @category extra
- */
-declare function fileSnapshot<T>(dir: string, opts?: Omit<SnapshotStorageOptions<T>, "name"> & {
-    name?: string;
-}): SnapshotStorageTier<T>;
-/**
- * Creates a filesystem append-log tier backed by a `fileBackend` under `dir`.
- *
- * Convenience wrapper for `appendLogStorage(fileBackend(dir), opts)`.
- * Writes are atomic (temp + rename). Requires Node.js with filesystem access.
- *
- * @param dir - Directory path where append-log files are stored.
- * @param opts - Optional append-log storage options (name, codec, keyOf, debounce, compactEvery).
- * @returns `AppendLogStorageTier<T>` backed by the filesystem.
- *
- * @example
- * ```ts
- * import { fileAppendLog } from "@graphrefly/graphrefly/extra/node";
- *
- * const tier = fileAppendLog<{ type: string; id: number }>("./events");
- * await tier.appendEntries([{ type: "created", id: 1 }]);
- * ```
- *
- * @category extra
- */
-declare function fileAppendLog<T>(dir: string, opts?: Omit<AppendLogStorageOptions<T>, "name"> & {
-    name?: string;
-}): AppendLogStorageTier<T>;
-/**
- * Creates a SQLite snapshot tier; caller owns the connection lifetime.
- *
- * Convenience wrapper for `snapshotStorage(sqliteBackend(path), opts)`.
- * The returned tier exposes an extra `close()` method — call it for explicit
- * teardown of the underlying SQLite connection.
- *
- * @param path - Filesystem path to the SQLite database file.
- * @param opts - Optional snapshot storage options (name, codec, filter, keyOf, debounce, compactEvery).
- * @returns `SnapshotStorageTier<T>` with a `close()` method for connection teardown.
- *
- * @example
- * ```ts
- * import { sqliteSnapshot } from "@graphrefly/graphrefly/extra/node";
- *
- * const tier = sqliteSnapshot<{ count: number }>("./state.db", { name: "counter" });
- * await tier.save({ count: 42 });
- * tier.close();
- * ```
- *
- * @category extra
- */
-declare function sqliteSnapshot<T>(path: string, opts?: Omit<SnapshotStorageOptions<T>, "name"> & {
-    name?: string;
-}): SnapshotStorageTier<T> & {
-    close(): void;
-};
-/**
- * Creates a SQLite append-log tier; caller owns the connection lifetime.
- *
- * Convenience wrapper for `appendLogStorage(sqliteBackend(path), opts)`.
- * The returned tier exposes an extra `close()` method — call it for explicit
- * teardown of the underlying SQLite connection.
- *
- * @param path - Filesystem path to the SQLite database file.
- * @param opts - Optional append-log storage options (name, codec, keyOf, debounce, compactEvery).
- * @returns `AppendLogStorageTier<T>` with a `close()` method for connection teardown.
- *
- * @example
- * ```ts
- * import { sqliteAppendLog } from "@graphrefly/graphrefly/extra/node";
- *
- * const tier = sqliteAppendLog<{ type: string }>("./events.db", { name: "events" });
- * await tier.appendEntries([{ type: "created" }]);
- * tier.close();
- * ```
- *
- * @category extra
- */
-declare function sqliteAppendLog<T>(path: string, opts?: Omit<AppendLogStorageOptions<T>, "name"> & {
-    name?: string;
-}): AppendLogStorageTier<T> & {
-    close(): void;
-};
-/**
- * Creates a filesystem key-value tier backed by a `fileBackend` under `dir`.
- *
- * Convenience wrapper for `kvStorage(fileBackend(dir), opts)`.
- * Each key is stored as a separate file; writes are atomic (temp + rename).
- *
- * @param dir - Directory path where key files are stored.
- * @param opts - Optional kv storage options (name, codec, filter, debounce, compactEvery).
- * @returns `KvStorageTier<T>` backed by the filesystem.
- *
- * @example
- * ```ts
- * import { fileKv } from "@graphrefly/graphrefly/extra/node";
- *
- * const kv = fileKv<{ score: number }>("./scores");
- * await kv.save("player1", { score: 100 });
- * const val = await kv.load("player1");
- * ```
- *
- * @category extra
- */
-declare function fileKv<T>(dir: string, opts?: Omit<KvStorageOptions<T>, "name"> & {
-    name?: string;
-}): KvStorageTier<T>;
-/**
- * Creates a SQLite key-value tier; caller owns the connection lifetime.
- *
- * Convenience wrapper for `kvStorage(sqliteBackend(path), opts)`.
- * The returned tier exposes an extra `close()` method — call it for explicit
- * teardown of the underlying SQLite connection.
- *
- * @param path - Filesystem path to the SQLite database file.
- * @param opts - Optional kv storage options (name, codec, filter, debounce, compactEvery).
- * @returns `KvStorageTier<T>` with a `close()` method for connection teardown.
- *
- * @example
- * ```ts
- * import { sqliteKv } from "@graphrefly/graphrefly/extra/node";
- *
- * const kv = sqliteKv<{ score: number }>("./scores.db");
- * await kv.save("player1", { score: 100 });
- * kv.close();
- * ```
- *
- * @category extra
- */
-declare function sqliteKv<T>(path: string, opts?: Omit<KvStorageOptions<T>, "name"> & {
-    name?: string;
-}): KvStorageTier<T> & {
-    close(): void;
-};
-
-export { fileAppendLog, fileBackend, fileKv, fileSnapshot, sqliteAppendLog, sqliteBackend, sqliteKv, sqliteSnapshot };

package/dist/extra/storage-tiers-node.d.ts

@@ -1,210 +0,0 @@
-import { AppendLogStorageOptions, AppendLogStorageTier, StorageBackend, KvStorageOptions, KvStorageTier, SnapshotStorageOptions, SnapshotStorageTier } from './storage-tiers.js';
-
-/**
- * Node-only Audit 4 storage backends + convenience factories.
- *
- * Imports `node:fs`, `node:path`, `node:crypto`, `node:sqlite`. Browser-safe
- * consumers should not import this module.
- *
- * @module
- */
-
-/**
- * Creates a filesystem backend that maps each key to a file under `dir`.
- *
- * Writes are atomic via temp + rename. Keys are percent-encoded to safe
- * filenames; `list(prefix)` enumerates `.bin` files in the directory.
- *
- * @param dir - Directory path where key files are stored (created on first write).
- * @returns `StorageBackend` backed by the filesystem under `dir`.
- *
- * @example
- * ```ts
- * import { fileBackend, snapshotStorage } from "@graphrefly/graphrefly/extra/node";
- *
- * const backend = fileBackend("./checkpoints");
- * const tier = snapshotStorage(backend, { name: "my-graph" });
- * await tier.save({ name: "my-graph", state: { count: 1 } });
- * ```
- *
- * @category extra
- */
-declare function fileBackend(dir: string): StorageBackend;
-/**
- * Creates a SQLite backend using Node 22.5+ `node:sqlite`.
- *
- * Stores byte values under string keys in a single `graphrefly_storage` table.
- * The caller owns the connection lifetime — call `.close()` for explicit teardown.
- * Requires Node 22.5 or later for `node:sqlite`.
- *
- * @param path - Filesystem path to the SQLite database file (created if absent).
- * @returns `StorageBackend` with an extra `close()` method for explicit teardown.
- *
- * @example
- * ```ts
- * import { sqliteBackend, snapshotStorage } from "@graphrefly/graphrefly/extra/node";
- *
- * const backend = sqliteBackend("./state.db");
- * const tier = snapshotStorage(backend, { name: "my-graph" });
- * await tier.save({ name: "my-graph", state: { count: 1 } });
- * backend.close();
- * ```
- *
- * @category extra
- */
-declare function sqliteBackend(path: string): StorageBackend & {
-    close(): void;
-};
-/**
- * Creates a filesystem snapshot tier backed by a `fileBackend` under `dir`.
- *
- * Convenience wrapper for `snapshotStorage(fileBackend(dir), opts)`.
- * Writes are atomic (temp + rename). Requires Node.js with filesystem access.
- *
- * @param dir - Directory path where snapshot files are stored.
- * @param opts - Optional snapshot storage options (name, codec, filter, keyOf, debounce, compactEvery).
- * @returns `SnapshotStorageTier<T>` backed by the filesystem.
- *
- * @example
- * ```ts
- * import { fileSnapshot } from "@graphrefly/graphrefly/extra/node";
- *
- * const tier = fileSnapshot<{ count: number }>("./checkpoints", { name: "counter" });
- * await tier.save({ count: 1 });
- * ```
- *
- * @category extra
- */
-declare function fileSnapshot<T>(dir: string, opts?: Omit<SnapshotStorageOptions<T>, "name"> & {
-    name?: string;
-}): SnapshotStorageTier<T>;
-/**
- * Creates a filesystem append-log tier backed by a `fileBackend` under `dir`.
- *
- * Convenience wrapper for `appendLogStorage(fileBackend(dir), opts)`.
- * Writes are atomic (temp + rename). Requires Node.js with filesystem access.
- *
- * @param dir - Directory path where append-log files are stored.
- * @param opts - Optional append-log storage options (name, codec, keyOf, debounce, compactEvery).
- * @returns `AppendLogStorageTier<T>` backed by the filesystem.
- *
- * @example
- * ```ts
- * import { fileAppendLog } from "@graphrefly/graphrefly/extra/node";
- *
- * const tier = fileAppendLog<{ type: string; id: number }>("./events");
- * await tier.appendEntries([{ type: "created", id: 1 }]);
- * ```
- *
- * @category extra
- */
-declare function fileAppendLog<T>(dir: string, opts?: Omit<AppendLogStorageOptions<T>, "name"> & {
-    name?: string;
-}): AppendLogStorageTier<T>;
-/**
- * Creates a SQLite snapshot tier; caller owns the connection lifetime.
- *
- * Convenience wrapper for `snapshotStorage(sqliteBackend(path), opts)`.
- * The returned tier exposes an extra `close()` method — call it for explicit
- * teardown of the underlying SQLite connection.
- *
- * @param path - Filesystem path to the SQLite database file.
- * @param opts - Optional snapshot storage options (name, codec, filter, keyOf, debounce, compactEvery).
- * @returns `SnapshotStorageTier<T>` with a `close()` method for connection teardown.
- *
- * @example
- * ```ts
- * import { sqliteSnapshot } from "@graphrefly/graphrefly/extra/node";
- *
- * const tier = sqliteSnapshot<{ count: number }>("./state.db", { name: "counter" });
- * await tier.save({ count: 42 });
- * tier.close();
- * ```
- *
- * @category extra
- */
-declare function sqliteSnapshot<T>(path: string, opts?: Omit<SnapshotStorageOptions<T>, "name"> & {
-    name?: string;
-}): SnapshotStorageTier<T> & {
-    close(): void;
-};
-/**
- * Creates a SQLite append-log tier; caller owns the connection lifetime.
- *
- * Convenience wrapper for `appendLogStorage(sqliteBackend(path), opts)`.
- * The returned tier exposes an extra `close()` method — call it for explicit
- * teardown of the underlying SQLite connection.
- *
- * @param path - Filesystem path to the SQLite database file.
- * @param opts - Optional append-log storage options (name, codec, keyOf, debounce, compactEvery).
- * @returns `AppendLogStorageTier<T>` with a `close()` method for connection teardown.
- *
- * @example
- * ```ts
- * import { sqliteAppendLog } from "@graphrefly/graphrefly/extra/node";
- *
- * const tier = sqliteAppendLog<{ type: string }>("./events.db", { name: "events" });
- * await tier.appendEntries([{ type: "created" }]);
- * tier.close();
- * ```
- *
- * @category extra
- */
-declare function sqliteAppendLog<T>(path: string, opts?: Omit<AppendLogStorageOptions<T>, "name"> & {
-    name?: string;
-}): AppendLogStorageTier<T> & {
-    close(): void;
-};
-/**
- * Creates a filesystem key-value tier backed by a `fileBackend` under `dir`.
- *
- * Convenience wrapper for `kvStorage(fileBackend(dir), opts)`.
- * Each key is stored as a separate file; writes are atomic (temp + rename).
- *
- * @param dir - Directory path where key files are stored.
- * @param opts - Optional kv storage options (name, codec, filter, debounce, compactEvery).
- * @returns `KvStorageTier<T>` backed by the filesystem.
- *
- * @example
- * ```ts
- * import { fileKv } from "@graphrefly/graphrefly/extra/node";
- *
- * const kv = fileKv<{ score: number }>("./scores");
- * await kv.save("player1", { score: 100 });
- * const val = await kv.load("player1");
- * ```
- *
- * @category extra
- */
-declare function fileKv<T>(dir: string, opts?: Omit<KvStorageOptions<T>, "name"> & {
-    name?: string;
-}): KvStorageTier<T>;
-/**
- * Creates a SQLite key-value tier; caller owns the connection lifetime.
- *
- * Convenience wrapper for `kvStorage(sqliteBackend(path), opts)`.
- * The returned tier exposes an extra `close()` method — call it for explicit
- * teardown of the underlying SQLite connection.
- *
- * @param path - Filesystem path to the SQLite database file.
- * @param opts - Optional kv storage options (name, codec, filter, debounce, compactEvery).
- * @returns `KvStorageTier<T>` with a `close()` method for connection teardown.
- *
- * @example
- * ```ts
- * import { sqliteKv } from "@graphrefly/graphrefly/extra/node";
- *
- * const kv = sqliteKv<{ score: number }>("./scores.db");
- * await kv.save("player1", { score: 100 });
- * kv.close();
- * ```
- *
- * @category extra
- */
-declare function sqliteKv<T>(path: string, opts?: Omit<KvStorageOptions<T>, "name"> & {
-    name?: string;
-}): KvStorageTier<T> & {
-    close(): void;
-};
-
-export { fileAppendLog, fileBackend, fileKv, fileSnapshot, sqliteAppendLog, sqliteBackend, sqliteKv, sqliteSnapshot };

package/dist/extra/storage-tiers-node.js

@@ -1 +0,0 @@
-import{a,b,c,d,e,f,g,h}from"../chunk-VN6RDSK2.js";import"../chunk-D5RFJOZ2.js";import"../chunk-CE72X3WO.js";import"../chunk-QYADASLV.js";export{d as fileAppendLog,a as fileBackend,g as fileKv,c as fileSnapshot,f as sqliteAppendLog,b as sqliteBackend,h as sqliteKv,e as sqliteSnapshot};