distillate 0.6.0 → 0.8.0

package/dist/serialize-ChyWpB9F.d.ts

@@ -0,0 +1,73 @@
+//#region src/core/bytes.d.ts
+type BytesLike = string | Uint8Array | ArrayBuffer;
+//#endregion
+//#region src/core/serialize.d.ts
+/**
+ * Base class for every defect `fromBytes` and `fromJSON` reject. Thrown
+ * directly when a JSON envelope is malformed: not an object, missing the
+ * `"distillate"` tag, missing `data`, or `data` that is not valid base64.
+ * Catch this to handle any decode failure at once, or a subclass to tell the
+ * causes apart. The input is corrupt or foreign, so discard it; retrying the
+ * same bytes cannot succeed.
+ */
+declare class SerializationError extends Error {
+  /** Discriminates this error from other `Error`s. */
+  override readonly name: string;
+}
+/**
+ * Thrown when a frame is shorter than its header plus trailer, or when its
+ * body length does not match the length its declared params imply. The bytes
+ * were cut short in transit or storage; re-fetch the whole frame.
+ */
+declare class TruncatedError extends SerializationError {
+  /** Discriminates this error from other `Error`s. */
+  override readonly name = "TruncatedError";
+}
+/**
+ * Thrown when a frame does not start with the four-byte `AMQF` magic, so it
+ * was never produced by `toBytes`. Check that the bytes really are a
+ * distillate frame and not another payload, a text encoding of one, or a
+ * slice taken at the wrong offset.
+ */
+declare class BadMagicError extends SerializationError {
+  /** Discriminates this error from other `Error`s. */
+  override readonly name = "BadMagicError";
+}
+/**
+ * Thrown when a frame or JSON envelope declares a format version this release
+ * does not read. A reader must be at least as new as the producer, so upgrade
+ * `distillate` or re-serialize the data with the version you run.
+ */
+declare class UnknownVersionError extends SerializationError {
+  /** Discriminates this error from other `Error`s. */
+  override readonly name = "UnknownVersionError";
+}
+/**
+ * Thrown when a frame's flags nibble names a hash this release cannot
+ * reproduce, so its stored bits are unreadable. Rebuild the filter from the
+ * source keys with the version you run.
+ */
+declare class UnknownHashVariantError extends SerializationError {
+  /** Discriminates this error from other `Error`s. */
+  override readonly name = "UnknownHashVariantError";
+}
+/**
+ * Thrown when a frame's CRC32 trailer does not match its contents, so the
+ * bytes were corrupted after they were written. Discard them and re-fetch;
+ * the payload cannot be trusted even where it still parses.
+ */
+declare class ChecksumError extends SerializationError {
+  /** Discriminates this error from other `Error`s. */
+  override readonly name = "ChecksumError";
+}
+/** JSON-friendly envelope for a filter: the binary frame, base64-encoded. */
+interface FilterJSON {
+  /** Format tag; always `"distillate"`. */
+  $: string;
+  /** Binary format version. */
+  v: number;
+  /** Base64 of the `toBytes` frame. */
+  data: string;
+}
+//#endregion
+export { TruncatedError as a, BytesLike as c, SerializationError as i, ChecksumError as n, UnknownHashVariantError as o, FilterJSON as r, UnknownVersionError as s, BadMagicError as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "distillate",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Probabilistic data structures for JavaScript. Space-efficient, approximate-membership filters (Bloom, Blocked Bloom, Binary Fuse) with tunable error and a portable binary format; zero dependencies, universal.",
   "keywords": [
     "bloom-filter",
@@ -66,15 +66,14 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.18.5",
     "@microsoft/api-extractor": "^7.58.12",
-    "@types/node": "^26.1.2",
+    "@types/node": "^22.0.0",
     "@vitest/coverage-v8": "^4.1.10",
     "fast-check": "^4.9.0",
     "mitata": "^1.0.34",
-    "publint": "^0.3.22",
+    "publint": "^0.3.23",
     "tsdown": "^0.22.14",
-    "tsx": "^4.23.1",
+    "tsx": "^4.23.12",
     "typedoc": "^0.28.20",
-    "typedoc-plugin-markdown": "^4.12.0",
     "typescript": "^5.9.3",
     "vitest": "^4.1.10"
   },
@@ -90,7 +89,7 @@
     "coverage": "vitest run --coverage",
     "api:report": "node scripts/api-extractor.mjs --local",
     "api:check": "node scripts/api-extractor.mjs",
-    "docs:api": "typedoc",
+    "docs:check": "typedoc --emit none",
     "golden:gen": "tsx scripts/gen-golden.ts",
     "size:check": "node scripts/size-check.mjs",
     "bench": "tsx bench/core.bench.ts && tsx bench/bloom.bench.ts && tsx bench/blocked.bench.ts && tsx bench/fuse.bench.ts && tsx bench/accuracy.bench.ts",

package/dist/serialize-DRKh6QOr.d.cts

@@ -1,15 +0,0 @@
-//#region src/core/bytes.d.ts
-type BytesLike = string | Uint8Array | ArrayBuffer;
-//#endregion
-//#region src/core/serialize.d.ts
-/** JSON-friendly envelope for a filter: the binary frame, base64-encoded. */
-interface FilterJSON {
-  /** Format tag; always `"distillate"`. */
-  $: string;
-  /** Binary format version. */
-  v: number;
-  /** Base64 of the `toBytes` frame. */
-  data: string;
-}
-//#endregion
-export { BytesLike as n, FilterJSON as t };

package/dist/serialize-DRKh6QOr.d.ts

@@ -1,15 +0,0 @@
-//#region src/core/bytes.d.ts
-type BytesLike = string | Uint8Array | ArrayBuffer;
-//#endregion
-//#region src/core/serialize.d.ts
-/** JSON-friendly envelope for a filter: the binary frame, base64-encoded. */
-interface FilterJSON {
-  /** Format tag; always `"distillate"`. */
-  $: string;
-  /** Binary format version. */
-  v: number;
-  /** Base64 of the `toBytes` frame. */
-  data: string;
-}
-//#endregion
-export { BytesLike as n, FilterJSON as t };