@openlfcp/shared-objects 0.1.4 → 0.2.0-beta.1

package/dist/automerge-bytes.js

@@ -1,111 +0,0 @@
-import * as A from "@automerge/automerge";
-import { toHex } from "@openlfcp/core";
-import { checkCanonicalChange } from "./canonical.js";
-import { checkChangeExpansion } from "./chunk-limits.js";
-import { ProfileInvalidError } from "./profile-invalid.js";
-import { frameProfilePayload, unframeProfilePayload } from "./values.js";
-/**
- * Automerge byte checks of the SHARED-OBJECTS-PROFILE-01 payloads (LFCP-031):
- * a Data Unit plaintext carries exactly one Automerge change (§11, §12), a
- * Snapshot plaintext one Automerge full save (§13). The framing itself is
- * frameProfilePayload / unframeProfilePayload (LFCP-030); this adds the
- * check that the framed bytes are what they claim to be.
- *
- * Automerge storage chunks start with the magic bytes 85 6f 4a 83, a 4-byte
- * checksum (the first 4 bytes of the chunk hash) and a chunk type: 0 for a
- * document (a full save), 1 for a change, 2 for a compressed change.
- */
-const MAGIC = [0x85, 0x6f, 0x4a, 0x83];
-const CHUNK_DOCUMENT = 0;
-const CHUNK_CHANGE = 1;
-const CHUNK_COMPRESSED_CHANGE = 2;
-const HEADER = 9; // magic, checksum, chunk type
-/** §11, §13, §74.1: PROFILE_INVALID / INVALID_AUTOMERGE_BYTES. */
-const reject = (why) => {
-    throw new ProfileInvalidError("INVALID_AUTOMERGE_BYTES", why);
-};
-function chunkType(bytes, what) {
-    if (bytes.length < HEADER || MAGIC.some((b, i) => bytes[i] !== b))
-        return reject(`${what} is not an Automerge chunk`);
-    return bytes[8];
-}
-/**
- * Checks that `bytes` is exactly one valid Automerge change (§11, §12) and
- * returns it decoded. Rejects with PROFILE_INVALID / INVALID_AUTOMERGE_BYTES: a chunk that is not a
- * change (a document chunk is a full save, §13), bytes Automerge cannot
- * parse, trailing bytes such as a second concatenated change, and a
- * checksum that does not match the change hash. Automerge JS 3.5.0 parses
- * a change without verifying its checksum, so the check is done here.
- */
-export function checkChange(bytes) {
-    const type = chunkType(bytes, "the change");
-    if (type === CHUNK_COMPRESSED_CHANGE)
-        reject("a compressed Automerge change (chunk type 2): a change is uncompressed (§11)");
-    if (type !== CHUNK_CHANGE)
-        reject(`chunk type ${type} is not an Automerge change (§11)`);
-    // §11.1: what the change expands to and its structure, before Automerge decodes it.
-    const expansion = checkChangeExpansion(bytes);
-    // §11.3: the canonical encoding, by the format's properties, still before the engine.
-    const parsed = checkCanonicalChange(bytes);
-    let decoded;
-    try {
-        decoded = A.decodeChange(bytes);
-    }
-    catch (e) {
-        return reject(`invalid Automerge change bytes (§11): ${e.message}`);
-    }
-    if (toHex(bytes.subarray(4, 8)) !== decoded.hash.slice(0, 8))
-        reject("the Automerge change checksum does not match its hash (§11)");
-    const checked = Object.freeze({
-        bytes: Uint8Array.from(bytes),
-        hash: decoded.hash,
-        actor: decoded.actor,
-        seq: decoded.seq,
-        deps: Object.freeze([...decoded.deps]),
-        otherActors: expansion.otherActors,
-    });
-    PARSED.set(checked, parsed);
-    return checked;
-}
-/** The operations checkChange read from the bytes (§11.3), for the references of §11.4. */
-const PARSED = new WeakMap();
-/** The change as its canonical bytes give it (§11.3), reusing the walk of checkChange. */
-export function parsedOf(change) {
-    let p = PARSED.get(change);
-    if (p === undefined) {
-        p = checkCanonicalChange(change.bytes);
-        PARSED.set(change, p);
-    }
-    return p;
-}
-/**
- * Checks that `bytes` starts as an Automerge full save (a document chunk,
- * §13). Whether the whole image loads, checksums included, is decided by
- * Automerge's load.
- */
-export function checkSaveHeader(bytes) {
-    const type = chunkType(bytes, "the Snapshot image");
-    if (type !== CHUNK_DOCUMENT)
-        reject(`chunk type ${type} is not an Automerge document (full save, §13)`);
-}
-/** §11: the Data Unit plaintext [1, change] of one checked Automerge change. */
-export function frameChange(change) {
-    checkChange(change);
-    return frameProfilePayload(change);
-}
-/** §11: the one Automerge change a Data Unit plaintext carries, checked. Throws PROFILE_INVALID / INVALID_AUTOMERGE_BYTES. */
-export function unframeChange(plaintext) {
-    return checkChange(unframeProfilePayload(plaintext));
-}
-/** §13: the Snapshot plaintext [1, save] of an Automerge full save. */
-export function frameSnapshot(save) {
-    checkSaveHeader(save);
-    return frameProfilePayload(save);
-}
-/** §13: the Automerge full save a Snapshot plaintext carries (header checked). Throws PROFILE_INVALID / INVALID_AUTOMERGE_BYTES. */
-export function unframeSnapshot(plaintext) {
-    const save = unframeProfilePayload(plaintext);
-    checkSaveHeader(save);
-    return save;
-}
-//# sourceMappingURL=automerge-bytes.js.map