@stroc/core 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2026 Got Choices Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,20 @@
-# Temporary Holding Version
+# @stroc/core
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Types, validation, canonical encoding and CIDs for Stroc documents. No Node or DOM APIs: runs in
+browsers, Node and React Native.
+
+```js
+import { validateDocument, documentCid, verifyDocument } from '@stroc/core'
+
+const { valid, problems } = validateDocument(doc)
+const { cid, bytes } = await documentCid(doc)          // DAG-JSON, SHA-256, CIDv1
+const check = await verifyDocument(receivedBytes, cid)  // hashes the bytes as received
+```
+
+SHA-256 is pure JavaScript by default; an app may install a native one with `setSha256` (checked
+against known digests first).
+
+Part of [Stroc](https://github.com/gotchoices/stroc), a format for structured legal documents
+identified by content (IPLD CIDs). The format is specified in
+[docs/Specification.md](https://github.com/gotchoices/stroc/blob/main/docs/Specification.md).
+MIT license.

package/dist/src/dagjson.d.ts

@@ -0,0 +1,27 @@
+import { CID } from 'multiformats/cid';
+import type { Problem, StrocDocument } from './types.js';
+import { type ValidationResult } from './validate.js';
+export declare const DAG_JSON_CODE: 297;
+export declare function encodeDagJson(value: unknown): Uint8Array;
+export declare function computeCid(bytes: Uint8Array): Promise<CID>;
+export declare function cidOfValue(value: unknown): Promise<CID>;
+export interface DocumentCidResult {
+    cid?: CID;
+    bytes?: Uint8Array;
+    validation: ValidationResult;
+}
+export declare function documentCid(doc: unknown): Promise<DocumentCidResult>;
+export interface VerifyResult {
+    ok: boolean;
+    document?: StrocDocument;
+    problems: Problem[];
+    validation?: ValidationResult;
+}
+export declare function verifyDocument(bytes: Uint8Array, claimed: CID | string): Promise<VerifyResult>;
+export declare function decodeDagJson(bytes: Uint8Array): unknown;
+export declare function fromPlain(value: unknown): {
+    value: unknown;
+    problems: Problem[];
+};
+export declare function toPlain(value: unknown): unknown;
+//# sourceMappingURL=dagjson.d.ts.map

package/dist/src/dagjson.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dagjson.d.ts","sourceRoot":"","sources":["../../src/dagjson.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AAGtC,OAAO,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AACxD,OAAO,EAAuC,KAAK,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAE1F,eAAO,MAAM,aAAa,KAAe,CAAA;AAGzC,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,UAAU,CAExD;AAGD,wBAAsB,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAEhE;AAGD,wBAAsB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAE7D;AAED,MAAM,WAAW,iBAAiB;IAChC,GAAG,CAAC,EAAE,GAAG,CAAA;IACT,KAAK,CAAC,EAAE,UAAU,CAAA;IAClB,UAAU,EAAE,gBAAgB,CAAA;CAC7B;AAID,wBAAsB,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAK1E;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,OAAO,CAAA;IACX,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,QAAQ,EAAE,OAAO,EAAE,CAAA;IACnB,UAAU,CAAC,EAAE,gBAAgB,CAAA;CAC9B;AAID,wBAAsB,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,GAAG,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC,CA4BpG;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAExD;AAUD,wBAAgB,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,OAAO,EAAE,CAAA;CAAE,CA0BjF;AAGD,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAU/C"}

package/dist/src/dagjson.js

@@ -0,0 +1,123 @@
+// Canonical encoding, CIDs and verification (Specification: Content ID Generation, Verification)
+import { CID } from 'multiformats/cid';
+import { sha256 } from './hash.js';
+import * as dagJson from '@ipld/dag-json';
+import { validateDocument, checkDocumentLink } from './validate.js';
+export const DAG_JSON_CODE = dagJson.code;
+// Canonical DAG-JSON bytes of any value in the data model. Does not validate.
+export function encodeDagJson(value) {
+    return dagJson.encode(value);
+}
+// The CID of some bytes, as a DAG-JSON block.
+export async function computeCid(bytes) {
+    return CID.create(1, dagJson.code, await sha256.digest(bytes));
+}
+// The CID of any value (for example an app's data object), encoded as DAG-JSON. Does not validate.
+export async function cidOfValue(value) {
+    return computeCid(encodeDagJson(value));
+}
+// Validate a document and, if valid, encode it and compute its CID. Nothing is altered first:
+// a document that is not already canonical is reported, not fixed.
+export async function documentCid(doc) {
+    const validation = validateDocument(doc);
+    if (!validation.valid)
+        return { validation };
+    const bytes = encodeDagJson(doc);
+    return { cid: await computeCid(bytes), bytes, validation };
+}
+// Verify received bytes against a claimed CID: hash exactly what was received, require canonical
+// DAG-JSON, then validate. Never normalizes.
+export async function verifyDocument(bytes, claimed) {
+    const fail = (code, message) => ({ ok: false, problems: [{ path: [], code, message }] });
+    let cid;
+    try {
+        cid = typeof claimed === 'string' ? CID.parse(claimed) : claimed;
+    }
+    catch {
+        return fail('bad-cid', `"${String(claimed)}" is not a CID`);
+    }
+    const linkError = checkDocumentLink(cid);
+    if (linkError)
+        return fail('bad-cid', `the claimed CID ${linkError}`);
+    const actual = await computeCid(bytes);
+    if (!actual.equals(cid))
+        return fail('cid-mismatch', `content hashes to ${actual}, not ${cid}`);
+    let value;
+    try {
+        value = dagJson.decode(bytes);
+    }
+    catch (err) {
+        return fail('bad-encoding', `not valid DAG-JSON: ${err.message}`);
+    }
+    const reencoded = dagJson.encode(value);
+    if (!sameBytes(reencoded, bytes))
+        return fail('not-canonical', 'not canonical DAG-JSON (key order, spacing or number form differs)');
+    const validation = validateDocument(value);
+    return {
+        ok: validation.valid,
+        document: validation.valid ? value : undefined,
+        problems: validation.problems,
+        validation,
+    };
+}
+export function decodeDagJson(bytes) {
+    return dagJson.decode(bytes);
+}
+function sameBytes(a, b) {
+    if (a.length !== b.length)
+        return false;
+    for (let i = 0; i < a.length; i++)
+        if (a[i] !== b[i])
+            return false;
+    return true;
+}
+// Convert a plain value parsed from JSON or YAML into the data model: every {"/": "<cid>"} becomes
+// a link. Malformed link objects are reported and left as they are (validation will reject them).
+export function fromPlain(value) {
+    const problems = [];
+    const walk = (v, at) => {
+        if (Array.isArray(v))
+            return v.map((x, i) => walk(x, [...at, i]));
+        if (typeof v === 'object' && v !== null && !CID.asCID(v)) {
+            const obj = v;
+            if ('/' in obj) {
+                if (Object.keys(obj).length === 1 && typeof obj['/'] === 'string') {
+                    try {
+                        return CID.parse(obj['/']);
+                    }
+                    catch {
+                        const linkText = obj['/'];
+                        problems.push({ path: at, code: 'bad-link', message: /\.(ya?ml|json)$/i.test(linkText)
+                                ? `"${linkText}" is a file, not a CID: run \`stroc link\` to replace it with that file's CID`
+                                : `"${linkText}" is not a CID` });
+                        return v;
+                    }
+                }
+                problems.push({ path: at, code: 'bad-link', message: 'a link must be written {"/": "<cid>"} with no other keys' });
+                return v;
+            }
+            const out = {};
+            for (const [k, x] of Object.entries(obj))
+                out[k] = walk(x, [...at, k]);
+            return out;
+        }
+        return v;
+    };
+    return { value: walk(value, []), problems };
+}
+// Convert from the data model to plain JSON/YAML values: every link becomes {"/": "<cid>"}.
+export function toPlain(value) {
+    const cid = CID.asCID(value);
+    if (cid)
+        return { '/': cid.toString() };
+    if (Array.isArray(value))
+        return value.map(toPlain);
+    if (typeof value === 'object' && value !== null) {
+        const out = {};
+        for (const [k, x] of Object.entries(value))
+            out[k] = toPlain(x);
+        return out;
+    }
+    return value;
+}
+//# sourceMappingURL=dagjson.js.map

package/dist/src/dagjson.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dagjson.js","sourceRoot":"","sources":["../../src/dagjson.ts"],"names":[],"mappings":"AAAA,iGAAiG;AAEjG,OAAO,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AAEzC,OAAO,EAAE,gBAAgB,EAAE,iBAAiB,EAAyB,MAAM,eAAe,CAAA;AAE1F,MAAM,CAAC,MAAM,aAAa,GAAG,OAAO,CAAC,IAAI,CAAA;AAEzC,8EAA8E;AAC9E,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC9B,CAAC;AAED,8CAA8C;AAC9C,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,KAAiB;IAChD,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;AAChE,CAAC;AAED,mGAAmG;AACnG,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,KAAc;IAC7C,OAAO,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAA;AACzC,CAAC;AAQD,8FAA8F;AAC9F,mEAAmE;AACnE,MAAM,CAAC,KAAK,UAAU,WAAW,CAAC,GAAY;IAC5C,MAAM,UAAU,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,CAAC,UAAU,CAAC,KAAK;QAAE,OAAO,EAAE,UAAU,EAAE,CAAA;IAC5C,MAAM,KAAK,GAAG,aAAa,CAAC,GAAG,CAAC,CAAA;IAChC,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAA;AAC5D,CAAC;AASD,iGAAiG;AACjG,6CAA6C;AAC7C,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,KAAiB,EAAE,OAAqB;IAC3E,MAAM,IAAI,GAAG,CAAC,IAAY,EAAE,OAAe,EAAgB,EAAE,CAC3D,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC,CAAA;IAC1D,IAAI,GAAQ,CAAA;IACZ,IAAI,CAAC;QACH,GAAG,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;IAClE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC,SAAS,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAC7D,CAAC;IACD,MAAM,SAAS,GAAG,iBAAiB,CAAC,GAAG,CAAC,CAAA;IACxC,IAAI,SAAS;QAAE,OAAO,IAAI,CAAC,SAAS,EAAE,mBAAmB,SAAS,EAAE,CAAC,CAAA;IACrE,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,CAAA;IACtC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC,cAAc,EAAE,qBAAqB,MAAM,SAAS,GAAG,EAAE,CAAC,CAAA;IAC/F,IAAI,KAAc,CAAA;IAClB,IAAI,CAAC;QACH,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC/B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,IAAI,CAAC,cAAc,EAAE,uBAAwB,GAAa,CAAC,OAAO,EAAE,CAAC,CAAA;IAC9E,CAAC;IACD,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IACvC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC,eAAe,EAAE,oEAAoE,CAAC,CAAA;IACpI,MAAM,UAAU,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAA;IAC1C,OAAO;QACL,EAAE,EAAE,UAAU,CAAC,KAAK;QACpB,QAAQ,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,KAAsB,CAAC,CAAC,CAAC,SAAS;QAC/D,QAAQ,EAAE,UAAU,CAAC,QAAQ;QAC7B,UAAU;KACX,CAAA;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAiB;IAC7C,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC9B,CAAC;AAED,SAAS,SAAS,CAAC,CAAa,EAAE,CAAa;IAC7C,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM;QAAE,OAAO,KAAK,CAAA;IACvC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE;QAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAA;IAClE,OAAO,IAAI,CAAA;AACb,CAAC;AAED,mGAAmG;AACnG,kGAAkG;AAClG,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,MAAM,QAAQ,GAAc,EAAE,CAAA;IAC9B,MAAM,IAAI,GAAG,CAAC,CAAU,EAAE,EAAuB,EAAW,EAAE;QAC5D,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAA;QACjE,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;YACzD,MAAM,GAAG,GAAG,CAA4B,CAAA;YACxC,IAAI,GAAG,IAAI,GAAG,EAAE,CAAC;gBACf,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,QAAQ,EAAE,CAAC;oBAClE,IAAI,CAAC;wBAAC,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAA;oBAAC,CAAC;oBAAC,MAAM,CAAC;wBACxC,MAAM,QAAQ,GAAG,GAAG,CAAC,GAAG,CAAC,CAAA;wBACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC;gCACpF,CAAC,CAAC,IAAI,QAAQ,+EAA+E;gCAC7F,CAAC,CAAC,IAAI,QAAQ,gBAAgB,EAAE,CAAC,CAAA;wBACnC,OAAO,CAAC,CAAA;oBACV,CAAC;gBACH,CAAC;gBACD,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,0DAA0D,EAAE,CAAC,CAAA;gBAClH,OAAO,CAAC,CAAA;YACV,CAAC;YACD,MAAM,GAAG,GAA4B,EAAE,CAAA;YACvC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;gBAAE,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;YACtE,OAAO,GAAG,CAAA;QACZ,CAAC;QACD,OAAO,CAAC,CAAA;IACV,CAAC,CAAA;IACD,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAA;AAC7C,CAAC;AAED,4FAA4F;AAC5F,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,MAAM,GAAG,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IAC5B,IAAI,GAAG;QAAE,OAAO,EAAE,GAAG,EAAE,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAA;IACvC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACnD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,MAAM,GAAG,GAA4B,EAAE,CAAA;QACvC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;YAAE,GAAG,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;QAC/D,OAAO,GAAG,CAAA;IACZ,CAAC;IACD,OAAO,KAAK,CAAA;AACd,CAAC"}

package/dist/src/hash.d.ts

@@ -0,0 +1,5 @@
+export type Sha256 = (bytes: Uint8Array) => Uint8Array | Promise<Uint8Array>;
+export declare const sha256: import("multiformats/hashes/hasher").Hasher<"sha2-256", 18>;
+export declare function setSha256(fn: Sha256): Promise<void>;
+export declare function resetSha256(): void;
+//# sourceMappingURL=hash.d.ts.map

package/dist/src/hash.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.d.ts","sourceRoot":"","sources":["../../src/hash.ts"],"names":[],"mappings":"AAOA,MAAM,MAAM,MAAM,GAAG,CAAC,KAAK,EAAE,UAAU,KAAK,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;AAI5E,eAAO,MAAM,MAAM,6DAAwF,CAAA;AAe3G,wBAAsB,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASzD;AAGD,wBAAgB,WAAW,IAAI,IAAI,CAElC"}

package/dist/src/hash.js

@@ -0,0 +1,40 @@
+// SHA-256 for CIDs. The default is pure JavaScript (@noble/hashes), so hashing works the same in
+// browsers, Node and React Native (Hermes has no WebCrypto). An app may supply its own
+// implementation (for example a native module on a phone) with setSha256; it is checked against
+// known digests first, because a wrong implementation would silently produce wrong CIDs.
+import { from } from 'multiformats/hashes/hasher';
+import { sha256 as nobleSha256 } from '@noble/hashes/sha2.js';
+let current = nobleSha256;
+export const sha256 = from({ name: 'sha2-256', code: 0x12, encode: (input) => current(input) });
+const ascii = (s) => Uint8Array.from(s, c => c.charCodeAt(0));
+const hex = (b) => Array.from(b, x => x.toString(16).padStart(2, '0')).join('');
+// FIPS 180-2 test vectors, and a large input checked against the built-in implementation (which
+// exercises block handling the short vectors do not).
+const VECTORS = [
+    [ascii(''), 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855'],
+    [ascii('abc'), 'ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad'],
+    [ascii('abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq'), '248d6a61d20638b8e5c026930c3e6039a33ce45964ff2167f6ecedd419db06c1'],
+];
+// Use a different SHA-256 implementation from now on. Rejects (and keeps the current one) if it
+// does not produce correct digests.
+export async function setSha256(fn) {
+    const big = Uint8Array.from({ length: 1000003 }, (_, i) => (i * 31 + 7) & 255);
+    const cases = [...VECTORS, [big, hex(nobleSha256(big))]];
+    for (const [input, expected] of cases) {
+        let got;
+        try {
+            got = hex(await fn(input));
+        }
+        catch (err) {
+            throw new Error(`SHA-256 implementation failed its self-test: ${err.message}`);
+        }
+        if (got !== expected)
+            throw new Error(`SHA-256 implementation failed its self-test (input of ${input.length} bytes)`);
+    }
+    current = fn;
+}
+// Go back to the built-in pure-JavaScript implementation.
+export function resetSha256() {
+    current = nobleSha256;
+}
+//# sourceMappingURL=hash.js.map

package/dist/src/hash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hash.js","sourceRoot":"","sources":["../../src/hash.ts"],"names":[],"mappings":"AAAA,iGAAiG;AACjG,uFAAuF;AACvF,gGAAgG;AAChG,yFAAyF;AACzF,OAAO,EAAE,IAAI,EAAE,MAAM,4BAA4B,CAAA;AACjD,OAAO,EAAE,MAAM,IAAI,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAI7D,IAAI,OAAO,GAAW,WAAW,CAAA;AAEjC,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,KAAiB,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;AAE3G,MAAM,KAAK,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;AACrE,MAAM,GAAG,GAAG,CAAC,CAAa,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AAE3F,gGAAgG;AAChG,sDAAsD;AACtD,MAAM,OAAO,GAA2B;IACtC,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,kEAAkE,CAAC;IAC/E,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,kEAAkE,CAAC;IAClF,CAAC,KAAK,CAAC,0DAA0D,CAAC,EAAE,kEAAkE,CAAC;CACxI,CAAA;AAED,gGAAgG;AAChG,oCAAoC;AACpC,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,EAAU;IACxC,MAAM,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAS,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,CAAA;IAChF,MAAM,KAAK,GAA2B,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAChF,KAAK,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,KAAK,EAAE,CAAC;QACtC,IAAI,GAAW,CAAA;QACf,IAAI,CAAC;YAAC,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,CAAC,CAAA;QAAC,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YAAC,MAAM,IAAI,KAAK,CAAC,gDAAiD,GAAa,CAAC,OAAO,EAAE,CAAC,CAAA;QAAC,CAAC;QAC5I,IAAI,GAAG,KAAK,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,yDAAyD,KAAK,CAAC,MAAM,SAAS,CAAC,CAAA;IACvH,CAAC;IACD,OAAO,GAAG,EAAE,CAAA;AACd,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,WAAW;IACzB,OAAO,GAAG,WAAW,CAAA;AACvB,CAAC"}

package/dist/src/ids.d.ts

@@ -0,0 +1,6 @@
+export declare const MAX_ID_LENGTH = 64;
+export declare function isValidId(value: string): boolean;
+export declare function suggestId(title: string): string;
+export declare function isDomain(value: string): boolean;
+export declare function looksLikeDomain(value: string): boolean;
+//# sourceMappingURL=ids.d.ts.map

package/dist/src/ids.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.d.ts","sourceRoot":"","sources":["../../src/ids.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,aAAa,KAAK,CAAA;AAE/B,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAEhD;AAGD,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAW/C;AAMD,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAE/C;AAGD,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAEtD"}

package/dist/src/ids.js

@@ -0,0 +1,30 @@
+// Section ids and parameter keys (Specification: Section Ids)
+const ID_PATTERN = /^[a-z][a-z0-9]*(-[a-z0-9]+)*$/;
+export const MAX_ID_LENGTH = 64;
+export function isValidId(value) {
+    return value.length <= MAX_ID_LENGTH && ID_PATTERN.test(value);
+}
+// Propose an id from a title: "Cure of Default" -> "cure-of-default".
+export function suggestId(title) {
+    const base = title
+        .normalize('NFKD')
+        .replace(/[̀-ͯ]/g, '')
+        .toLowerCase()
+        .replace(/[^a-z0-9]+/g, '-')
+        .replace(/^-+|-+$/g, '')
+        .replace(/^[0-9-]+/, '')
+        .slice(0, MAX_ID_LENGTH)
+        .replace(/-+$/, '');
+    return base || 'section';
+}
+// A domain `author` (Specification: Author): lowercase ASCII labels separated by dots, at least
+// one dot, the last label alphabetic or an IDNA (xn--) label.
+const DOMAIN_PATTERN = /^(?=.{4,253}$)([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\.)+([a-z]{2,63}|xn--[a-z0-9-]{1,59})$/;
+export function isDomain(value) {
+    return DOMAIN_PATTERN.test(value);
+}
+// True when the value would be a domain if written in lowercase (for lint advice).
+export function looksLikeDomain(value) {
+    return !isDomain(value) && isDomain(value.toLowerCase());
+}
+//# sourceMappingURL=ids.js.map

package/dist/src/ids.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ids.js","sourceRoot":"","sources":["../../src/ids.ts"],"names":[],"mappings":"AAAA,8DAA8D;AAE9D,MAAM,UAAU,GAAG,+BAA+B,CAAA;AAClD,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,CAAA;AAE/B,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,OAAO,KAAK,CAAC,MAAM,IAAI,aAAa,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAChE,CAAC;AAED,sEAAsE;AACtE,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,MAAM,IAAI,GAAG,KAAK;SACf,SAAS,CAAC,MAAM,CAAC;SACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;SACrB,WAAW,EAAE;SACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC;SACvB,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC;SACvB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;IACrB,OAAO,IAAI,IAAI,SAAS,CAAA;AAC1B,CAAC;AAED,gGAAgG;AAChG,8DAA8D;AAC9D,MAAM,cAAc,GAAG,yFAAyF,CAAA;AAEhH,MAAM,UAAU,QAAQ,CAAC,KAAa;IACpC,OAAO,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AACnC,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,eAAe,CAAC,KAAa;IAC3C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;AAC1D,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,9 @@
+export * from './types.js';
+export * from './text.js';
+export * from './ids.js';
+export * from './language.js';
+export * from './markup.js';
+export * from './validate.js';
+export * from './dagjson.js';
+export { setSha256, resetSha256, type Sha256 } from './hash.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,KAAK,MAAM,EAAE,MAAM,WAAW,CAAA"}

package/dist/src/index.js

@@ -0,0 +1,9 @@
+export * from './types.js';
+export * from './text.js';
+export * from './ids.js';
+export * from './language.js';
+export * from './markup.js';
+export * from './validate.js';
+export * from './dagjson.js';
+export { setSha256, resetSha256 } from './hash.js';
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,cAAc,CAAA;AAC5B,OAAO,EAAE,SAAS,EAAE,WAAW,EAAe,MAAM,WAAW,CAAA"}

package/dist/src/language.d.ts

@@ -0,0 +1,3 @@
+export declare function isCanonicalLanguageTag(tag: string): boolean;
+export declare function canonicalLanguageTag(tag: string): string | undefined;
+//# sourceMappingURL=language.d.ts.map

package/dist/src/language.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"language.d.ts","sourceRoot":"","sources":["../../src/language.ts"],"names":[],"mappings":"AASA,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE3D;AAGD,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAYpE"}

package/dist/src/language.js

@@ -0,0 +1,32 @@
+// BCP 47 language tags in canonical case (Specification: Field Definitions)
+//
+// Checks well-formedness of the common subset: language, extended language, script, region,
+// variants, extensions and private use. The primary language must be 2-3 letters; longer ones
+// are grammatical but unregistered, and usually a mistake such as "english". Canonical case:
+// language lowercase, script title case, region uppercase, everything else lowercase.
+const SUBTAG_RULES = /^([a-z]{2,3}(-[a-z]{3}){0,3})(-[A-Z][a-z]{3})?(-([A-Z]{2}|[0-9]{3}))?(-([a-z0-9]{5,8}|[0-9][a-z0-9]{3}))*(-[a-wy-z0-9](-[a-z0-9]{2,8})+)*(-x(-[a-z0-9]{1,8})+)?$/;
+export function isCanonicalLanguageTag(tag) {
+    return SUBTAG_RULES.test(tag);
+}
+// The canonical-case spelling of a tag, or undefined if it is not well formed in any case.
+export function canonicalLanguageTag(tag) {
+    const parts = tag.split(/[-_]/);
+    let seenSingleton = false;
+    const fixed = parts.map((p, i) => {
+        if (i === 0)
+            return p.toLowerCase();
+        if (seenSingleton)
+            return p.toLowerCase();
+        if (p.length === 1) {
+            seenSingleton = true;
+            return p.toLowerCase();
+        }
+        if (p.length === 4 && /^[a-zA-Z]{4}$/.test(p))
+            return p[0].toUpperCase() + p.slice(1).toLowerCase();
+        if (p.length === 2 && /^[a-zA-Z]{2}$/.test(p))
+            return p.toUpperCase();
+        return p.toLowerCase();
+    }).join('-');
+    return isCanonicalLanguageTag(fixed) ? fixed : undefined;
+}
+//# sourceMappingURL=language.js.map

package/dist/src/language.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"language.js","sourceRoot":"","sources":["../../src/language.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,EAAE;AACF,4FAA4F;AAC5F,8FAA8F;AAC9F,6FAA6F;AAC7F,sFAAsF;AAEtF,MAAM,YAAY,GAAG,kKAAkK,CAAA;AAEvL,MAAM,UAAU,sBAAsB,CAAC,GAAW;IAChD,OAAO,YAAY,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAC/B,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,oBAAoB,CAAC,GAAW;IAC9C,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IAC/B,IAAI,aAAa,GAAG,KAAK,CAAA;IACzB,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAC/B,IAAI,CAAC,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC,WAAW,EAAE,CAAA;QACnC,IAAI,aAAa;YAAE,OAAO,CAAC,CAAC,WAAW,EAAE,CAAA;QACzC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAAC,aAAa,GAAG,IAAI,CAAC;YAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAA;QAAC,CAAC;QACpE,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAA;QACnG,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;YAAE,OAAO,CAAC,CAAC,WAAW,EAAE,CAAA;QACrE,OAAO,CAAC,CAAC,WAAW,EAAE,CAAA;IACxB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACZ,OAAO,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAA;AAC1D,CAAC"}

package/dist/src/markup.d.ts

@@ -0,0 +1,40 @@
+export type EmphasisTag = 'b' | 'i' | 'u';
+export type MarkupNode = {
+    type: 'text';
+    value: string;
+} | {
+    type: 'emphasis';
+    tag: EmphasisTag;
+    children: MarkupNode[];
+    offset: number;
+} | {
+    type: 'ref';
+    path: string[];
+    offset: number;
+} | {
+    type: 'param';
+    key: string;
+    offset: number;
+};
+export interface MarkupIssue {
+    code: string;
+    message: string;
+    offset: number;
+}
+export interface ParsedMarkup {
+    nodes: MarkupNode[];
+    issues: MarkupIssue[];
+}
+export declare function parseMarkup(text: string): ParsedMarkup;
+export declare function canonicalMarkup(input: string | MarkupNode[]): string;
+export declare function findReferences(nodes: MarkupNode[]): {
+    path: string[];
+    offset: number;
+}[];
+export declare function findParams(nodes: MarkupNode[]): {
+    key: string;
+    offset: number;
+}[];
+export declare function markupToPlainText(nodes: MarkupNode[]): string;
+export declare function escapeMarkupText(value: string): string;
+//# sourceMappingURL=markup.d.ts.map

package/dist/src/markup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markup.d.ts","sourceRoot":"","sources":["../../src/markup.ts"],"names":[],"mappings":"AAWA,MAAM,MAAM,WAAW,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAA;AAKzC,MAAM,MAAM,UAAU,GAClB;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC/B;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,GAAG,EAAE,WAAW,CAAC;IAAC,QAAQ,EAAE,UAAU,EAAE,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC9E;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,GAC/C;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAElD,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,UAAU,EAAE,CAAA;IACnB,MAAM,EAAE,WAAW,EAAE,CAAA;CACtB;AAqFD,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAoCtD;AAiDD,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,EAAE,GAAG,MAAM,CAiDpE;AAGD,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG;IAAE,IAAI,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAAE,CAQxF;AAGD,wBAAgB,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,EAAE,CAQjF;AAGD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM,CAM7D;AAGD,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEtD"}