@vielzeug/vault 1.0.4 → 2.0.0

package/dist/versioned-codec.d.ts

@@ -1,44 +1,2 @@
-import type { VaultCodec } from './ttl';
-/**
- * A single version entry in a `createVersionedCodec` definition.
- * `version` must be a non-negative integer. `codec` is the codec responsible for
- * encoding/decoding records that carry this version number.
- */
-export type CodecVersion = {
-    codec: VaultCodec;
-    version: number;
-};
-/**
- * Creates a versioned codec that prepends a `__v` field to every encoded envelope.
- * When decoding, the `__v` field selects the matching codec from `versions`.
- * This allows safe codec upgrades: old records encoded with a previous codec continue
- * to decode correctly as long as the old codec remains in `versions`.
- *
- * ```ts
- * const v1Codec: VaultCodec = { ... };
- * const v2Codec: VaultCodec = { ... }; // newer, more compact format
- *
- * const codec = createVersionedCodec([
- *   { version: 1, codec: v1Codec },
- *   { version: 2, codec: v2Codec },
- * ], 2); // write new records with version 2
- *
- * const db = createMemory({ schema, codec });
- * // Old records (version 1) are decoded by v1Codec; new records use v2Codec.
- * ```
- *
- * **Rules:**
- * - `currentVersion` must be one of the versions listed in `versions`.
- * - Version numbers must be unique non-negative integers.
- * - The current version's codec is used for all new writes.
- * - Unrecognised `__v` values cause `decode` to return `undefined` (treated as corrupt).
- * - **Migration note:** records written by any other codec (including `defaultCodec`) lack
- *   the `__v` field and will decode as `undefined` — they will be treated as missing/expired.
- *   Perform a data migration or clear the store before switching to a versioned codec.
- * - **Secondary index caveat:** the `{ __d, __v }` envelope replaces the default
- *   `{ value, expiresAt? }` shape, so IndexedDB secondary indexes (created via `.index()`
- *   with keyPath `value.<field>`) silently stop matching. Don't combine a versioned codec
- *   with `.index()` on the same table.
- */
-export declare function createVersionedCodec(versions: CodecVersion[], currentVersion: number): VaultCodec;
+export {};
 //# sourceMappingURL=versioned-codec.d.ts.map

package/dist/versioned-codec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"versioned-codec.d.ts","sourceRoot":"","sources":["../src/versioned-codec.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAIxC;;;;GAIG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,UAAU,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,YAAY,EAAE,EAAE,cAAc,EAAE,MAAM,GAAG,UAAU,CAiDjG"}
+{"version":3,"file":"versioned-codec.d.ts","sourceRoot":"","sources":["../src/versioned-codec.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vielzeug/vault",
-  "version": "1.0.4",
-  "description": "Storage adapter for IndexedDB and localStorage with TTL, reactive signals, and schema validation",
+  "version": "2.0.0",
+  "description": "Typed browser storage with portable keys, TTL, observation, and IndexedDB transactions",
   "type": "module",
   "files": [
     "dist"
@@ -35,10 +35,10 @@
     "node": ">=22"
   },
   "devDependencies": {
-    "@types/node": "^26.1.0",
+    "@types/node": "^26.1.2",
     "fake-indexeddb": "^6.2.5",
     "typescript": "^6.0.3",
-    "vite": "^8.1.3",
+    "vite": "^8.2.0",
     "vitest": "^4.1.10"
   }
 }

package/dist/streaming.cjs

@@ -1,2 +0,0 @@
-function e(e){let t=e[Symbol.asyncIterator]();return new ReadableStream({async cancel(){await t.return?.()},async pull(e){try{let{done:n,value:r}=await t.next();n?e.close():e.enqueue(r)}catch(t){e.error(t)}}})}exports.toReadableStream=e;
-//# sourceMappingURL=streaming.cjs.map

package/dist/streaming.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"streaming.cjs","names":[],"sources":["../src/streaming.ts"],"sourcesContent":["/**\n * Converts an `AsyncIterable<T>` into a Web Standard `ReadableStream<T>`.\n *\n * Use this with `db.watch()` when you need a `ReadableStream` instead of an async iterator —\n * for example, to `pipeTo()` a `WritableStream` or `pipeThrough()` a `TransformStream`.\n *\n * ```ts\n * const stream = toReadableStream(db.watch('users'));\n * await stream.pipeTo(new WritableStream({ write: (users) => render(users) }));\n * ```\n *\n * The stream closes when the iterable is exhausted or when the stream is cancelled.\n * Pass an `AbortSignal` to `db.watch()` to cancel from outside:\n *\n * ```ts\n * const controller = new AbortController();\n * const stream = toReadableStream(db.watch('users', { signal: controller.signal }));\n * controller.abort(); // closes the stream\n * ```\n */\nexport function toReadableStream<T>(iterable: AsyncIterable<T>): ReadableStream<T> {\n  const iter = iterable[Symbol.asyncIterator]();\n\n  return new ReadableStream<T>({\n    async cancel() {\n      await iter.return?.();\n    },\n    async pull(controller) {\n      try {\n        const { done, value } = await iter.next();\n\n        if (done) {\n          controller.close();\n        } else {\n          controller.enqueue(value);\n        }\n      } catch (err) {\n        controller.error(err);\n      }\n    },\n  });\n}\n"],"mappings":"AAoBA,SAAgB,EAAoB,EAA+C,CACjF,IAAM,EAAO,EAAS,OAAO,cAAc,CAAC,EAE5C,OAAO,IAAI,eAAkB,CAC3B,MAAM,QAAS,CACb,MAAM,EAAK,SAAS,CACtB,EACA,MAAM,KAAK,EAAY,CACrB,GAAI,CACF,GAAM,CAAE,OAAM,SAAU,MAAM,EAAK,KAAK,EAEpC,EACF,EAAW,MAAM,EAEjB,EAAW,QAAQ,CAAK,CAE5B,OAAS,EAAK,CACZ,EAAW,MAAM,CAAG,CACtB,CACF,CACF,CAAC,CACH"}

package/dist/streaming.js

@@ -1,21 +0,0 @@
-//#region src/streaming.ts
-function e(e) {
-	let t = e[Symbol.asyncIterator]();
-	return new ReadableStream({
-		async cancel() {
-			await t.return?.();
-		},
-		async pull(e) {
-			try {
-				let { done: n, value: r } = await t.next();
-				n ? e.close() : e.enqueue(r);
-			} catch (t) {
-				e.error(t);
-			}
-		}
-	});
-}
-//#endregion
-export { e as toReadableStream };
-
-//# sourceMappingURL=streaming.js.map

package/dist/streaming.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"streaming.js","names":[],"sources":["../src/streaming.ts"],"sourcesContent":["/**\n * Converts an `AsyncIterable<T>` into a Web Standard `ReadableStream<T>`.\n *\n * Use this with `db.watch()` when you need a `ReadableStream` instead of an async iterator —\n * for example, to `pipeTo()` a `WritableStream` or `pipeThrough()` a `TransformStream`.\n *\n * ```ts\n * const stream = toReadableStream(db.watch('users'));\n * await stream.pipeTo(new WritableStream({ write: (users) => render(users) }));\n * ```\n *\n * The stream closes when the iterable is exhausted or when the stream is cancelled.\n * Pass an `AbortSignal` to `db.watch()` to cancel from outside:\n *\n * ```ts\n * const controller = new AbortController();\n * const stream = toReadableStream(db.watch('users', { signal: controller.signal }));\n * controller.abort(); // closes the stream\n * ```\n */\nexport function toReadableStream<T>(iterable: AsyncIterable<T>): ReadableStream<T> {\n  const iter = iterable[Symbol.asyncIterator]();\n\n  return new ReadableStream<T>({\n    async cancel() {\n      await iter.return?.();\n    },\n    async pull(controller) {\n      try {\n        const { done, value } = await iter.next();\n\n        if (done) {\n          controller.close();\n        } else {\n          controller.enqueue(value);\n        }\n      } catch (err) {\n        controller.error(err);\n      }\n    },\n  });\n}\n"],"mappings":";AAoBA,SAAgB,EAAoB,GAA+C;CACjF,IAAM,IAAO,EAAS,OAAO,cAAc,CAAC;CAE5C,OAAO,IAAI,eAAkB;EAC3B,MAAM,SAAS;GACb,MAAM,EAAK,SAAS;EACtB;EACA,MAAM,KAAK,GAAY;GACrB,IAAI;IACF,IAAM,EAAE,SAAM,aAAU,MAAM,EAAK,KAAK;IAExC,AAAI,IACF,EAAW,MAAM,IAEjB,EAAW,QAAQ,CAAK;GAE5B,SAAS,GAAK;IACZ,EAAW,MAAM,CAAG;GACtB;EACF;CACF,CAAC;AACH"}

package/dist/versioned-codec.cjs

@@ -1,2 +0,0 @@
-const e=require("./errors.cjs");function t(t,n){if(t.length===0)throw new e.VaultError(`createVersionedCodec: at least one version entry is required`);let r=new Map;for(let n of t){if(!Number.isInteger(n.version)||n.version<0)throw new e.VaultError(`createVersionedCodec: version must be a non-negative integer, got ${String(n.version)}`);if(r.has(n.version))throw new e.VaultError(`createVersionedCodec: duplicate version ${String(n.version)}`);r.set(n.version,n.codec)}if(!r.has(n))throw new e.VaultError(`createVersionedCodec: currentVersion ${String(n)} is not listed in versions`);let i=r.get(n);return{decode(e){if(typeof e!=`object`||!e||!(`__v`in e))return;let t=e,n=t.__v;if(typeof n!=`number`)return;let i=r.get(n);if(i)return i.decode(t.__d)},encode(e,t){return{__d:i.encode(e,t),__v:n}}}}exports.createVersionedCodec=t;
-//# sourceMappingURL=versioned-codec.cjs.map

package/dist/versioned-codec.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"versioned-codec.cjs","names":[],"sources":["../src/versioned-codec.ts"],"sourcesContent":["import type { VaultCodec } from './ttl';\n\nimport { VaultError } from './errors';\n\n/**\n * A single version entry in a `createVersionedCodec` definition.\n * `version` must be a non-negative integer. `codec` is the codec responsible for\n * encoding/decoding records that carry this version number.\n */\nexport type CodecVersion = {\n  codec: VaultCodec;\n  version: number;\n};\n\n/**\n * Creates a versioned codec that prepends a `__v` field to every encoded envelope.\n * When decoding, the `__v` field selects the matching codec from `versions`.\n * This allows safe codec upgrades: old records encoded with a previous codec continue\n * to decode correctly as long as the old codec remains in `versions`.\n *\n * ```ts\n * const v1Codec: VaultCodec = { ... };\n * const v2Codec: VaultCodec = { ... }; // newer, more compact format\n *\n * const codec = createVersionedCodec([\n *   { version: 1, codec: v1Codec },\n *   { version: 2, codec: v2Codec },\n * ], 2); // write new records with version 2\n *\n * const db = createMemory({ schema, codec });\n * // Old records (version 1) are decoded by v1Codec; new records use v2Codec.\n * ```\n *\n * **Rules:**\n * - `currentVersion` must be one of the versions listed in `versions`.\n * - Version numbers must be unique non-negative integers.\n * - The current version's codec is used for all new writes.\n * - Unrecognised `__v` values cause `decode` to return `undefined` (treated as corrupt).\n * - **Migration note:** records written by any other codec (including `defaultCodec`) lack\n *   the `__v` field and will decode as `undefined` — they will be treated as missing/expired.\n *   Perform a data migration or clear the store before switching to a versioned codec.\n * - **Secondary index caveat:** the `{ __d, __v }` envelope replaces the default\n *   `{ value, expiresAt? }` shape, so IndexedDB secondary indexes (created via `.index()`\n *   with keyPath `value.<field>`) silently stop matching. Don't combine a versioned codec\n *   with `.index()` on the same table.\n */\nexport function createVersionedCodec(versions: CodecVersion[], currentVersion: number): VaultCodec {\n  if (versions.length === 0) {\n    throw new VaultError('createVersionedCodec: at least one version entry is required');\n  }\n\n  const byVersion = new Map<number, VaultCodec>();\n\n  for (const entry of versions) {\n    if (!Number.isInteger(entry.version) || entry.version < 0) {\n      throw new VaultError(\n        `createVersionedCodec: version must be a non-negative integer, got ${String(entry.version)}`,\n      );\n    }\n\n    if (byVersion.has(entry.version)) {\n      throw new VaultError(`createVersionedCodec: duplicate version ${String(entry.version)}`);\n    }\n\n    byVersion.set(entry.version, entry.codec);\n  }\n\n  if (!byVersion.has(currentVersion)) {\n    throw new VaultError(`createVersionedCodec: currentVersion ${String(currentVersion)} is not listed in versions`);\n  }\n\n  const writeCodec = byVersion.get(currentVersion)!;\n\n  return {\n    decode<T>(raw: unknown): { expiresAt?: number; value: T } | undefined {\n      if (typeof raw !== 'object' || raw === null || !('__v' in raw)) {\n        return undefined;\n      }\n\n      const wrapper = raw as { __d: unknown; __v: unknown };\n      const version = wrapper.__v;\n\n      if (typeof version !== 'number') return undefined;\n\n      const codec = byVersion.get(version);\n\n      if (!codec) return undefined;\n\n      return codec.decode<T>(wrapper.__d);\n    },\n\n    encode<T>(value: T, expiresAt?: number): unknown {\n      return { __d: writeCodec.encode(value, expiresAt), __v: currentVersion };\n    },\n  };\n}\n"],"mappings":"gCA8CA,SAAgB,EAAqB,EAA0B,EAAoC,CACjG,GAAI,EAAS,SAAW,EACtB,MAAM,IAAI,EAAA,WAAW,8DAA8D,EAGrF,IAAM,EAAY,IAAI,IAEtB,IAAK,IAAM,KAAS,EAAU,CAC5B,GAAI,CAAC,OAAO,UAAU,EAAM,OAAO,GAAK,EAAM,QAAU,EACtD,MAAM,IAAI,EAAA,WACR,qEAAqE,OAAO,EAAM,OAAO,GAC3F,EAGF,GAAI,EAAU,IAAI,EAAM,OAAO,EAC7B,MAAM,IAAI,EAAA,WAAW,2CAA2C,OAAO,EAAM,OAAO,GAAG,EAGzF,EAAU,IAAI,EAAM,QAAS,EAAM,KAAK,CAC1C,CAEA,GAAI,CAAC,EAAU,IAAI,CAAc,EAC/B,MAAM,IAAI,EAAA,WAAW,wCAAwC,OAAO,CAAc,EAAE,2BAA2B,EAGjH,IAAM,EAAa,EAAU,IAAI,CAAc,EAE/C,MAAO,CACL,OAAU,EAA4D,CACpE,GAAI,OAAO,GAAQ,WAAY,GAAgB,EAAE,QAAS,GACxD,OAGF,IAAM,EAAU,EACV,EAAU,EAAQ,IAExB,GAAI,OAAO,GAAY,SAAU,OAEjC,IAAM,EAAQ,EAAU,IAAI,CAAO,EAE9B,KAEL,OAAO,EAAM,OAAU,EAAQ,GAAG,CACpC,EAEA,OAAU,EAAU,EAA6B,CAC/C,MAAO,CAAE,IAAK,EAAW,OAAO,EAAO,CAAS,EAAG,IAAK,CAAe,CACzE,CACF,CACF"}

package/dist/versioned-codec.js

@@ -1,32 +0,0 @@
-import { VaultError as e } from "./errors.js";
-//#region src/versioned-codec.ts
-function t(t, n) {
-	if (t.length === 0) throw new e("createVersionedCodec: at least one version entry is required");
-	let r = /* @__PURE__ */ new Map();
-	for (let n of t) {
-		if (!Number.isInteger(n.version) || n.version < 0) throw new e(`createVersionedCodec: version must be a non-negative integer, got ${String(n.version)}`);
-		if (r.has(n.version)) throw new e(`createVersionedCodec: duplicate version ${String(n.version)}`);
-		r.set(n.version, n.codec);
-	}
-	if (!r.has(n)) throw new e(`createVersionedCodec: currentVersion ${String(n)} is not listed in versions`);
-	let i = r.get(n);
-	return {
-		decode(e) {
-			if (typeof e != "object" || !e || !("__v" in e)) return;
-			let t = e, n = t.__v;
-			if (typeof n != "number") return;
-			let i = r.get(n);
-			if (i) return i.decode(t.__d);
-		},
-		encode(e, t) {
-			return {
-				__d: i.encode(e, t),
-				__v: n
-			};
-		}
-	};
-}
-//#endregion
-export { t as createVersionedCodec };
-
-//# sourceMappingURL=versioned-codec.js.map

package/dist/versioned-codec.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"versioned-codec.js","names":[],"sources":["../src/versioned-codec.ts"],"sourcesContent":["import type { VaultCodec } from './ttl';\n\nimport { VaultError } from './errors';\n\n/**\n * A single version entry in a `createVersionedCodec` definition.\n * `version` must be a non-negative integer. `codec` is the codec responsible for\n * encoding/decoding records that carry this version number.\n */\nexport type CodecVersion = {\n  codec: VaultCodec;\n  version: number;\n};\n\n/**\n * Creates a versioned codec that prepends a `__v` field to every encoded envelope.\n * When decoding, the `__v` field selects the matching codec from `versions`.\n * This allows safe codec upgrades: old records encoded with a previous codec continue\n * to decode correctly as long as the old codec remains in `versions`.\n *\n * ```ts\n * const v1Codec: VaultCodec = { ... };\n * const v2Codec: VaultCodec = { ... }; // newer, more compact format\n *\n * const codec = createVersionedCodec([\n *   { version: 1, codec: v1Codec },\n *   { version: 2, codec: v2Codec },\n * ], 2); // write new records with version 2\n *\n * const db = createMemory({ schema, codec });\n * // Old records (version 1) are decoded by v1Codec; new records use v2Codec.\n * ```\n *\n * **Rules:**\n * - `currentVersion` must be one of the versions listed in `versions`.\n * - Version numbers must be unique non-negative integers.\n * - The current version's codec is used for all new writes.\n * - Unrecognised `__v` values cause `decode` to return `undefined` (treated as corrupt).\n * - **Migration note:** records written by any other codec (including `defaultCodec`) lack\n *   the `__v` field and will decode as `undefined` — they will be treated as missing/expired.\n *   Perform a data migration or clear the store before switching to a versioned codec.\n * - **Secondary index caveat:** the `{ __d, __v }` envelope replaces the default\n *   `{ value, expiresAt? }` shape, so IndexedDB secondary indexes (created via `.index()`\n *   with keyPath `value.<field>`) silently stop matching. Don't combine a versioned codec\n *   with `.index()` on the same table.\n */\nexport function createVersionedCodec(versions: CodecVersion[], currentVersion: number): VaultCodec {\n  if (versions.length === 0) {\n    throw new VaultError('createVersionedCodec: at least one version entry is required');\n  }\n\n  const byVersion = new Map<number, VaultCodec>();\n\n  for (const entry of versions) {\n    if (!Number.isInteger(entry.version) || entry.version < 0) {\n      throw new VaultError(\n        `createVersionedCodec: version must be a non-negative integer, got ${String(entry.version)}`,\n      );\n    }\n\n    if (byVersion.has(entry.version)) {\n      throw new VaultError(`createVersionedCodec: duplicate version ${String(entry.version)}`);\n    }\n\n    byVersion.set(entry.version, entry.codec);\n  }\n\n  if (!byVersion.has(currentVersion)) {\n    throw new VaultError(`createVersionedCodec: currentVersion ${String(currentVersion)} is not listed in versions`);\n  }\n\n  const writeCodec = byVersion.get(currentVersion)!;\n\n  return {\n    decode<T>(raw: unknown): { expiresAt?: number; value: T } | undefined {\n      if (typeof raw !== 'object' || raw === null || !('__v' in raw)) {\n        return undefined;\n      }\n\n      const wrapper = raw as { __d: unknown; __v: unknown };\n      const version = wrapper.__v;\n\n      if (typeof version !== 'number') return undefined;\n\n      const codec = byVersion.get(version);\n\n      if (!codec) return undefined;\n\n      return codec.decode<T>(wrapper.__d);\n    },\n\n    encode<T>(value: T, expiresAt?: number): unknown {\n      return { __d: writeCodec.encode(value, expiresAt), __v: currentVersion };\n    },\n  };\n}\n"],"mappings":";;AA8CA,SAAgB,EAAqB,GAA0B,GAAoC;CACjG,IAAI,EAAS,WAAW,GACtB,MAAM,IAAI,EAAW,8DAA8D;CAGrF,IAAM,oBAAY,IAAI,IAAwB;CAE9C,KAAK,IAAM,KAAS,GAAU;EAC5B,IAAI,CAAC,OAAO,UAAU,EAAM,OAAO,KAAK,EAAM,UAAU,GACtD,MAAM,IAAI,EACR,qEAAqE,OAAO,EAAM,OAAO,GAC3F;EAGF,IAAI,EAAU,IAAI,EAAM,OAAO,GAC7B,MAAM,IAAI,EAAW,2CAA2C,OAAO,EAAM,OAAO,GAAG;EAGzF,EAAU,IAAI,EAAM,SAAS,EAAM,KAAK;CAC1C;CAEA,IAAI,CAAC,EAAU,IAAI,CAAc,GAC/B,MAAM,IAAI,EAAW,wCAAwC,OAAO,CAAc,EAAE,2BAA2B;CAGjH,IAAM,IAAa,EAAU,IAAI,CAAc;CAE/C,OAAO;EACL,OAAU,GAA4D;GACpE,IAAI,OAAO,KAAQ,aAAY,KAAgB,EAAE,SAAS,IACxD;GAGF,IAAM,IAAU,GACV,IAAU,EAAQ;GAExB,IAAI,OAAO,KAAY,UAAU;GAEjC,IAAM,IAAQ,EAAU,IAAI,CAAO;GAE9B,OAEL,OAAO,EAAM,OAAU,EAAQ,GAAG;EACpC;EAEA,OAAU,GAAU,GAA6B;GAC/C,OAAO;IAAE,KAAK,EAAW,OAAO,GAAO,CAAS;IAAG,KAAK;GAAe;EACzE;CACF;AACF"}