keyframe-store 3.2.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020-present Jimmy Chen
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,111 @@
+# keyframe-store
+
+[![Apache-2.0 licensed][badge-license]][url-license]
+[![NPM version][badge-npm-version]][url-npm]
+[![NPM downloads][badge-npm-downloads]][url-npm]
+[![NPM Unpacked Size (with version)][badge-npm-unpacked-size]][url-npm]
+
+Content-addressed version storage for documents handed over whole. Every version is stored as a zstd **keyframe** — compressed on its own — or as a **delta** compressed against exactly one keyframe, using that keyframe's plaintext as the dictionary. Reconstructing any version is at most two reads, a version whose content is already held costs nothing, and the backend is anything that can store bytes by key.
+
+## Table of Contents
+
+- 🚀 [Getting Started](#getting-started)
+- 📖 [Documentation](#documentation)
+- ⚖️ [License](#license)
+
+---
+
+## <a name="getting-started">🚀 Getting Started</a>
+
+```bash
+pnpm i keyframe-store
+```
+
+```ts
+import { createKeyframeStore } from "keyframe-store";
+
+const objects = new Map<string, Uint8Array>();
+const keyframeStore = createKeyframeStore({
+  delete: async (keys) => {
+    for (const key of keys) objects.delete(key);
+  },
+  read: async (key) => objects.get(key),
+  // Create-only: false tells the store another writer of the same content landed first
+  write: async (key, bytes) => {
+    if (objects.has(key)) return false;
+
+    objects.set(key, bytes);
+    return true;
+  },
+});
+
+// Every operation is a neverthrow ResultAsync. The first version of a lineage has no keyframe yet
+const first = await keyframeStore.write(Buffer.from(JSON.stringify(document)), { anchoredBytes: 0, hash: "" }).match(
+  (writtenVersion) => writtenVersion,
+  (error) => {
+    throw error;
+  },
+);
+// first.baseHash === "" — it became the keyframe, so the lineage's anchor is its hash
+const second = await keyframeStore
+  .write(Buffer.from(JSON.stringify(editedDocument)), { anchoredBytes: 0, hash: first.hash })
+  .match(
+    (writtenVersion) => writtenVersion,
+    (error) => {
+      throw error;
+    },
+  );
+// second.baseHash === first.hash and second.storedBytes is roughly the size of the edit
+const plaintext = await keyframeStore.read(second.hash).match(
+  (bytes) => bytes,
+  (error) => {
+    throw error;
+  },
+);
+```
+
+## <a name="documentation">📖 Documentation</a>
+
+We highly recommend you take a look at the [documentation](https://esposter.com/docs/api/modules/keyframe-store.html) to level up.
+
+### How it works
+
+- **Addressing.** An object's key is the hex SHA-256 of its plaintext, so two versions with identical content resolve to one object whichever keyframe either would have been encoded against. The store is write-once: a write of content it already holds records nothing and reports itself deduplicated.
+- **Encoding.** Each write compresses the plaintext standalone and, when the lineage has a keyframe, again with that keyframe's plaintext as the dictionary. The delta is kept only if it is at most the **promotion ratio** of the standalone size _and_ the bytes already anchored to the keyframe plus this delta fit the **segment budget**; otherwise the standalone form is written and this version becomes the lineage's next keyframe.
+- **Reading.** A keyframe is one read and one decompression; a delta fetches the keyframe its own header names, decompresses it, then decompresses the delta against it. Every result is hashed and compared with the key, so a truncated, altered or misfiled object is a refused read rather than a plausible document.
+- **Collection.** An object survives while any record names it, as its own hash or as its base. The caller answers that from its own records — `collect` takes the hashes an eviction released and the hashes still named, deletes the difference, and returns what it deleted.
+- **The anchor is the caller's.** The store holds no notion of a lineage: a caller derives one anchor per history — the newest keyframe's hash, and the bytes anchored to it — and resets both whenever a write reports an empty base.
+
+### Key exports
+
+| Export                 | Role                                                                                                |
+| ---------------------- | --------------------------------------------------------------------------------------------------- |
+| `createKeyframeStore`  | The factory, taking an `ObjectStore` and optional `KeyframeStoreOptions`                            |
+| `ObjectStore`          | The backend interface — `read`, `write`, `delete` by key                                            |
+| `KeyframeStore`        | `write(plaintext, anchor)`, `read(hash)`, `collect(released, retained)` — every one a `ResultAsync` |
+| `VersionAnchor`        | What a lineage passes to a write: its keyframe's hash and the bytes anchored to it                  |
+| `WrittenVersion`       | What a write reports: the hash, its base, both sizes and whether it was deduplicated                |
+| `KeyframeStoreOptions` | `compressionLevel`, `promotionRatio`, `segmentBudgetRatio`, each defaulted from `constants`         |
+
+### Commands
+
+Run from `packages/keyframe-store/`:
+
+```bash
+pnpm build        # compile to dist/
+pnpm test         # vitest watch mode (coverage is run from the repo root)
+pnpm bench        # the codec benchmark, writing the colocated *.bench.md
+pnpm lint:fix     # auto-fix lint
+pnpm typecheck    # type check
+```
+
+## <a name="license">⚖️ License</a>
+
+This project is licensed under the [Apache-2.0 license](https://github.com/Esposter/Esposter/blob/main/LICENSE).
+
+[badge-license]: https://img.shields.io/github/license/Esposter/Esposter.svg?color=blue
+[url-license]: https://github.com/Esposter/Esposter/blob/main/LICENSE
+[badge-npm-version]: https://img.shields.io/npm/v/keyframe-store/latest?color=brightgreen
+[url-npm]: https://www.npmjs.com/package/keyframe-store/v/latest
+[badge-npm-unpacked-size]: https://img.shields.io/npm/unpacked-size/keyframe-store/latest?label=npm
+[badge-npm-downloads]: https://img.shields.io/npm/dm/keyframe-store.svg

package/dist/index.d.ts

@@ -0,0 +1,88 @@
+import { InvalidOperationError } from "@esposter/shared";
+import { ResultAsync } from "neverthrow";
+//#region src/constants.d.ts
+export declare const OBJECT_MAGIC: Uint8Array;
+export declare const OBJECT_FORMAT_VERSION = 1;
+export declare const OBJECT_VERSION_OFFSET = 4;
+export declare const OBJECT_FLAGS_OFFSET = 5;
+export declare const OBJECT_WINDOW_LOG_OFFSET = 6;
+export declare const OBJECT_HEADER_BYTE_COUNT = 8;
+export declare const KEYFRAME_FLAG = 0;
+export declare const DELTA_FLAG = 1;
+export declare const HASH_BYTE_COUNT = 32;
+export declare const DELTA_HEADER_BYTE_COUNT: number;
+export declare const DEFAULT_COMPRESSION_LEVEL = 12;
+export declare const MIN_WINDOW_LOG = 10;
+export declare const MAX_WINDOW_LOG = 27;
+export declare const DEFAULT_PROMOTION_RATIO: number;
+export declare const DEFAULT_SEGMENT_BUDGET_RATIO = 1;
+//#endregion
+//#region src/models/VersionAnchor.d.ts
+export interface VersionAnchor {
+  anchoredBytes: number;
+  hash: string;
+}
+//#endregion
+//#region src/models/WrittenVersion.d.ts
+export interface WrittenVersion {
+  baseHash: string;
+  hash: string;
+  isDeduplicated: boolean;
+  plaintextBytes: number;
+  storedBytes: number;
+}
+//#endregion
+//#region src/models/KeyframeStore.d.ts
+export interface KeyframeStore {
+  collect: (releasedHashes: string[], retainedHashes: string[]) => ResultAsync<string[], Error>;
+  read: (hash: string) => ResultAsync<Uint8Array, Error>;
+  write: (plaintext: Uint8Array, anchor: VersionAnchor) => ResultAsync<WrittenVersion, Error>;
+}
+//#endregion
+//#region src/models/KeyframeStoreOptions.d.ts
+export interface KeyframeStoreOptions {
+  compressionLevel?: number;
+  promotionRatio?: number;
+  segmentBudgetRatio?: number;
+}
+//#endregion
+//#region src/models/ObjectStore.d.ts
+export interface ObjectStore {
+  delete: (keys: string[]) => Promise<void>;
+  read: (key: string) => Promise<Uint8Array | undefined>;
+  write: (key: string, bytes: Uint8Array) => Promise<boolean>;
+}
+//#endregion
+//#region src/createKeyframeStore.d.ts
+export declare const createKeyframeStore: (objectStore: ObjectStore, { compressionLevel, promotionRatio, segmentBudgetRatio }?: KeyframeStoreOptions) => KeyframeStore;
+//#endregion
+//#region src/models/ObjectNotStoredError.d.ts
+export declare class ObjectNotStoredError extends InvalidOperationError {
+  constructor(hash: string, message: string);
+}
+//#endregion
+//#region src/models/ParsedObject.d.ts
+export interface ParsedObject {
+  baseHash: string;
+  payload: Uint8Array;
+  windowLog: number;
+}
+//#endregion
+//#region src/services/decodeObject.d.ts
+export declare const decodeObject: (parsedObject: ParsedObject, basePlaintext?: Uint8Array) => Promise<Buffer>;
+//#endregion
+//#region src/services/encodeObject.d.ts
+export declare const encodeObject: (plaintext: Uint8Array, compressionLevel: number, base?: {
+  hash: string;
+  plaintext: Uint8Array;
+}) => Promise<Uint8Array>;
+//#endregion
+//#region src/services/getContentAddress.d.ts
+export declare const getContentAddress: (plaintext: Uint8Array) => string;
+//#endregion
+//#region src/services/getWindowLog.d.ts
+export declare const getWindowLog: (dictionaryByteCount: number, inputByteCount: number) => number;
+//#endregion
+//#region src/services/parseObject.d.ts
+export declare const parseObject: (hash: string, bytes: Uint8Array) => ParsedObject;
+//#endregion

package/dist/index.js

@@ -0,0 +1,180 @@
+import { InvalidOperationError, Operation, getResultAsync } from "@esposter/shared";
+import { promisify } from "node:util";
+import { constants, zstdCompress, zstdDecompress } from "node:zlib";
+import { createHash } from "node:crypto";
+//#region src/constants.ts
+const OBJECT_MAGIC = new Uint8Array([
+	75,
+	70,
+	83,
+	84
+]);
+const OBJECT_FORMAT_VERSION = 1;
+const OBJECT_VERSION_OFFSET = 4;
+const OBJECT_FLAGS_OFFSET = 5;
+const OBJECT_WINDOW_LOG_OFFSET = 6;
+const OBJECT_HEADER_BYTE_COUNT = 8;
+const KEYFRAME_FLAG = 0;
+const DELTA_FLAG = 1;
+const HASH_BYTE_COUNT = 32;
+const DELTA_HEADER_BYTE_COUNT = 40;
+const DEFAULT_COMPRESSION_LEVEL = 12;
+const MIN_WINDOW_LOG = 10;
+const MAX_WINDOW_LOG = 27;
+const DEFAULT_PROMOTION_RATIO = 1 / 3;
+const DEFAULT_SEGMENT_BUDGET_RATIO = 1;
+//#endregion
+//#region src/models/ObjectNotStoredError.ts
+var ObjectNotStoredError = class extends InvalidOperationError {
+	constructor(hash, message) {
+		super(Operation.Read, hash, message);
+		this.name = "ObjectNotStoredError";
+	}
+};
+//#endregion
+//#region src/services/decodeObject.ts
+const decompress = promisify(zstdDecompress);
+const decodeObject = (parsedObject, basePlaintext) => decompress(parsedObject.payload, {
+	...basePlaintext ? { dictionary: basePlaintext } : {},
+	params: { [constants.ZSTD_d_windowLogMax]: parsedObject.windowLog }
+});
+//#endregion
+//#region src/services/getWindowLog.ts
+const getWindowLog = (dictionaryByteCount, inputByteCount) => Math.min(27, Math.max(10, Math.ceil(Math.log2(dictionaryByteCount + inputByteCount + 1))));
+//#endregion
+//#region src/services/encodeObject.ts
+const compress = promisify(zstdCompress);
+const encodeObject = async (plaintext, compressionLevel, base) => {
+	const windowLog = getWindowLog(base?.plaintext.byteLength ?? 0, plaintext.byteLength);
+	const payload = await compress(plaintext, {
+		...base ? { dictionary: base.plaintext } : {},
+		params: {
+			[constants.ZSTD_c_compressionLevel]: compressionLevel,
+			[constants.ZSTD_c_windowLog]: windowLog
+		}
+	});
+	const headerByteCount = base ? 40 : 8;
+	const bytes = new Uint8Array(headerByteCount + payload.byteLength);
+	bytes.set(OBJECT_MAGIC);
+	bytes[4] = 1;
+	bytes[5] = base ? 1 : 0;
+	bytes[6] = windowLog;
+	if (base) bytes.set(Buffer.from(base.hash, "hex").subarray(0, 32), 8);
+	bytes.set(payload, headerByteCount);
+	return bytes;
+};
+//#endregion
+//#region src/services/getContentAddress.ts
+const getContentAddress = (plaintext) => createHash("sha256").update(plaintext).digest("hex");
+//#endregion
+//#region src/services/parseObject.ts
+const parseObject = (hash, bytes) => {
+	if (!(bytes.byteLength >= 8 && OBJECT_MAGIC.every((byte, index) => bytes[index] === byte))) throw new InvalidOperationError(Operation.Read, hash, "not a keyframe store object");
+	else if (bytes[4] !== 1) throw new InvalidOperationError(Operation.Read, hash, `unknown object format version ${bytes[4]}`);
+	const windowLog = bytes[6] ?? 0;
+	const flags = bytes[5];
+	if (flags === 0) return {
+		baseHash: "",
+		payload: bytes.subarray(8),
+		windowLog
+	};
+	else if (flags !== 1) throw new InvalidOperationError(Operation.Read, hash, `unknown object flags ${flags}`);
+	else if (bytes.byteLength < 40) throw new InvalidOperationError(Operation.Read, hash, "delta object is truncated before its base hash");
+	return {
+		baseHash: Buffer.from(bytes.subarray(8, 40)).toString("hex"),
+		payload: bytes.subarray(40),
+		windowLog
+	};
+};
+//#endregion
+//#region src/createKeyframeStore.ts
+const verifyContentAddress = (hash, plaintext) => {
+	if (getContentAddress(plaintext) !== hash) throw new InvalidOperationError(Operation.Read, hash, "object does not hash to its key");
+	return plaintext;
+};
+const createKeyframeStore = (objectStore, { compressionLevel = 12, promotionRatio = DEFAULT_PROMOTION_RATIO, segmentBudgetRatio = 1 } = {}) => {
+	const readKeyframe = async (hash) => {
+		const bytes = await objectStore.read(hash);
+		if (!bytes) return void 0;
+		const parsedObject = parseObject(hash, bytes);
+		if (parsedObject.baseHash) throw new InvalidOperationError(Operation.Read, hash, `is a delta against ${parsedObject.baseHash}, not a keyframe`);
+		return {
+			plaintext: verifyContentAddress(hash, await decodeObject(parsedObject)),
+			storedBytes: bytes.byteLength
+		};
+	};
+	const readStoredObject = async (hash) => {
+		const bytes = await objectStore.read(hash);
+		if (!bytes) return void 0;
+		const parsedObject = parseObject(hash, bytes);
+		if (!parsedObject.baseHash) return {
+			baseHash: "",
+			plaintext: verifyContentAddress(hash, await decodeObject(parsedObject))
+		};
+		const keyframe = await readKeyframe(parsedObject.baseHash);
+		if (!keyframe) throw new ObjectNotStoredError(hash, `keyframe ${parsedObject.baseHash} is not stored`);
+		return {
+			baseHash: parsedObject.baseHash,
+			plaintext: verifyContentAddress(hash, await decodeObject(parsedObject, keyframe.plaintext))
+		};
+	};
+	return {
+		collect: (releasedHashes, retainedHashes) => getResultAsync(async () => {
+			const retainedHashSet = new Set(retainedHashes);
+			const collectableHashes = [...new Set(releasedHashes)].filter((hash) => !retainedHashSet.has(hash));
+			if (collectableHashes.length > 0) await objectStore.delete(collectableHashes);
+			return collectableHashes;
+		}),
+		read: (hash) => getResultAsync(async () => {
+			const storedObject = await readStoredObject(hash);
+			if (!storedObject) throw new ObjectNotStoredError(hash, "object is not stored");
+			return storedObject.plaintext;
+		}),
+		write: (plaintext, anchor) => getResultAsync(async () => {
+			const hash = getContentAddress(plaintext);
+			const plaintextBytes = plaintext.byteLength;
+			const adoptStored = (baseHash) => ({
+				baseHash,
+				hash,
+				isDeduplicated: true,
+				plaintextBytes,
+				storedBytes: 0
+			});
+			const storedObject = await readStoredObject(hash);
+			if (storedObject) return adoptStored(storedObject.baseHash);
+			const writeObject = async (bytes, baseHash) => {
+				if (await objectStore.write(hash, bytes)) return {
+					baseHash,
+					hash,
+					isDeduplicated: false,
+					plaintextBytes,
+					storedBytes: bytes.byteLength
+				};
+				const twinObject = await readStoredObject(hash);
+				if (!twinObject) throw new InvalidOperationError(Operation.Create, hash, "refused as already stored, but nothing is stored");
+				return adoptStored(twinObject.baseHash);
+			};
+			const encodeDelta = async () => {
+				const keyframe = await readKeyframe(anchor.hash);
+				if (!keyframe) return void 0;
+				return {
+					bytes: await encodeObject(plaintext, compressionLevel, {
+						hash: anchor.hash,
+						plaintext: keyframe.plaintext
+					}),
+					keyframeStoredBytes: keyframe.storedBytes
+				};
+			};
+			const keyframeEncoding = encodeObject(plaintext, compressionLevel);
+			const deltaEncoding = anchor.hash ? encodeDelta() : void 0;
+			const [keyframeBytes, delta] = await Promise.all([keyframeEncoding, deltaEncoding]);
+			if (!delta) return writeObject(keyframeBytes, "");
+			const isWithinPromotionRatio = delta.bytes.byteLength <= keyframeBytes.byteLength * promotionRatio;
+			const isWithinSegmentBudget = anchor.anchoredBytes + delta.bytes.byteLength <= delta.keyframeStoredBytes * segmentBudgetRatio;
+			if (!isWithinPromotionRatio || !isWithinSegmentBudget) return writeObject(keyframeBytes, "");
+			return writeObject(delta.bytes, anchor.hash);
+		})
+	};
+};
+//#endregion
+export { DEFAULT_COMPRESSION_LEVEL, DEFAULT_PROMOTION_RATIO, DEFAULT_SEGMENT_BUDGET_RATIO, DELTA_FLAG, DELTA_HEADER_BYTE_COUNT, HASH_BYTE_COUNT, KEYFRAME_FLAG, MAX_WINDOW_LOG, MIN_WINDOW_LOG, OBJECT_FLAGS_OFFSET, OBJECT_FORMAT_VERSION, OBJECT_HEADER_BYTE_COUNT, OBJECT_MAGIC, OBJECT_VERSION_OFFSET, OBJECT_WINDOW_LOG_OFFSET, ObjectNotStoredError, createKeyframeStore, decodeObject, encodeObject, getContentAddress, getWindowLog, parseObject };

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "keyframe-store",
+  "version": "3.2.0",
+  "description": "Content-addressed version storage — every version is a zstd keyframe or a delta against one, over any backend that can store bytes by key.",
+  "keywords": [
+    "compression",
+    "content-addressed",
+    "deduplication",
+    "delta",
+    "history",
+    "keyframe",
+    "node",
+    "storage",
+    "typescript",
+    "version",
+    "zstd"
+  ],
+  "homepage": "https://github.com/Esposter/Esposter/blob/main/packages/keyframe-store#readme",
+  "bugs": {
+    "url": "https://github.com/Esposter/Esposter/issues"
+  },
+  "license": "Apache-2.0",
+  "author": "Jimmy Chen",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Esposter/Esposter.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "types": "dist/index.d.ts",
+  "imports": {
+    "#src/*": "./src/*.ts"
+  },
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "bench": "vitest bench --run",
+    "build": "tsdown",
+    "export:gen": "generate-exports",
+    "format": "oxfmt",
+    "format:check": "oxfmt --check",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "test": "vitest",
+    "typecheck": "tsc"
+  },
+  "dependencies": {
+    "@esposter/shared": "3.2.0",
+    "neverthrow": "^8.2.0"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/core": "^0.18.5",
+    "@esposter/configuration": "3.2.0",
+    "@esposter/shared-node": "3.2.0",
+    "@types/node": "^26.6.1",
+    "publint": "^0.3.24",
+    "tsdown": "^0.23.0",
+    "vitest": "^5.0.1"
+  },
+  "gitHead": "bc055ed2f154eff219a355016a6b586962dbfa9c"
+}