@weaveprotocol/core 0.1.0

package/dist/records/rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../src/records/rules.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAU1C,4FAA4F;AAC5F,MAAM,CAAC,MAAM,kBAAkB,GAAG,0BAA0B,CAAC;AAE7D,+DAA+D;AAC/D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,UAAkB,EAAE,UAAkB,EAAE,EAAE,CAAC,GAAG,UAAU,IAAI,UAAU,EAAE,CAAC;AAoBxG,MAAM,KAAK,GAAG,CAAC,CAAU,EAAY,EAAE,CAAC,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpK;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,KAAc,EAAE,EAAE,GAAG,OAAO,EAAE,cAAqC,EAAE;IAC9F,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QAAE,OAAO,GAAG,EAAE,oBAAoB,CAAC;IAC1G,MAAM,CAAC,GAAG,KAAgC,CAAC;IAC3C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,GAAG,EAAE,IAAI,GAAG,0DAA0D,CAAC;IACpJ,CAAC;IACD,KAAK,MAAM,MAAM,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;QAClD,MAAM,GAAG,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC;QACtB,IAAI,GAAG,KAAK,SAAS;YAAE,SAAS;QAChC,MAAM,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5C,OAAO,GAAG,EAAE,IAAI,MAAM,uEAAuE,CAAC;QAChG,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/F,IAAI,UAAU;YAAE,OAAO,GAAG,EAAE,IAAI,MAAM,UAAU,UAAU,0CAA0C,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,sBAAsB,CAAC;IAChJ,CAAC;IACD,IAAI,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACpG,OAAO,GAAG,EAAE,2EAA2E,CAAC;IAC1F,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QACtB,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QAClC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;YAC9G,OAAO,GAAG,EAAE,IAAI,IAAI,oCAAoC,CAAC;QAC3D,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAYD,sCAAsC;AACtC,MAAM,UAAU,MAAM,CAAC,GAAyC,EAAE,OAAoB;IACpF,MAAM,IAAI,GAAuB,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAU,CAAC,CAAC;IAC1G,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3H,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,WAAW,CAAC,GAAyC;IACnE,MAAM,IAAI,GAAuB,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAU,CAAC,CAAC;IAC1G,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACxI,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAChG,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAC7B,UAAkB,EAClB,MAA6B,EAC7B,MAAmE;IAEnE,MAAM,KAAK,GAAa,CAAC,UAAU,CAAC,CAAC;IACrC,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAC1B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,KAAK,CAAC,IAAI,CAAC,WAAW,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QACvC,CAAC;aAAM,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;YACpC,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC1B,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;YACrD,IAAI,CAAC,IAAI;gBAAE,OAAO,IAAI,CAAC;YACvB,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,MAAM,KAAK,GAAI,MAAM,CAAC,IAAuC,EAAE,CAAC,IAAI,CAAC,CAAC;YACtE,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO,IAAI,CAAC;YACrC,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACxE,OAAO,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;AACtG,CAAC;AAED,yFAAyF;AACzF,MAAM,UAAU,iBAAiB,CAAC,KAAwC,EAAE,KAAc,EAAE,IAAa;IACvG,KAAK,MAAM,KAAK,IAAI,KAAK,IAAI,EAAE,EAAE,CAAC;QAChC,MAAM,CAAC,GAAI,KAAwC,EAAE,CAAC,KAAK,CAAC,CAAC;QAC7D,MAAM,CAAC,GAAI,IAAuC,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5D,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;YAAE,OAAO,KAAK,CAAC;IAC5D,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/records/version.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @module records/version
+ * What makes one version of a record newer than another — without a clock.
+ *
+ * A record keeps one `key` for life. Every change is a new signed version
+ * carrying `seq` (one more than the version it replaces), `prev` (that
+ * version's hash) and `genesis` (the hash of the record's first version).
+ *
+ * **The ordering rule: higher `seq` wins; on a tie, the lower id wins.** Every
+ * node applies it to the same data and reaches the same answer, and `createdAt`
+ * — which is whatever the writer typed — decides nothing. So a replayed old
+ * version loses to the current one, a delete (a version with a higher `seq`)
+ * stays deleted, and two devices that edited the same record while apart agree
+ * on the same winner.
+ *
+ * The rule is load-bearing forever: nodes running two versions of it would
+ * disagree about which version is current. It is pinned by tests.
+ */
+import type { Expression } from '../types.js';
+/** How many access changes a version may say it saw — normally one or two */
+export declare const MAX_SEEN = 64;
+/** Keys a caller may choose: `profile`, `collection:app.todo.item`, `space:b7…` */
+export declare const RECORD_KEY_PATTERN: RegExp;
+/** A fresh key: 128 random bits. Random rather than time-based, so it says nothing about when. */
+export declare function newRecordKey(): string;
+/** The parts of a version the ordering rule looks at */
+export interface Versioned {
+    readonly id: string;
+    readonly seq: number;
+}
+/**
+ * Whether `a` supersedes `b`. Higher `seq` first, then the lower id.
+ * Never looks at a timestamp.
+ */
+export declare function supersedes(a: Versioned, b: Versioned): boolean;
+/** Sorts newest first by the ordering rule. */
+export declare function byVersion(a: Versioned, b: Versioned): number;
+/** The version fields for the next change to a record, given its current version. */
+export declare function nextVersion(current: Pick<Expression, 'id' | 'key' | 'seq' | 'genesis'>): {
+    key: string;
+    seq: number;
+    prev: string;
+    genesis: string;
+};
+/**
+ * Why a version is malformed on its own, or null when it is not.
+ *
+ * Only what can be seen in this one version. Whether `prev` exists, whether
+ * `seq` is exactly one past it, whether the collection matches earlier versions
+ * — each depends on what else a node happens to hold, and a check that depends
+ * on that makes nodes disagree forever. Those are applied when reading.
+ */
+export declare function checkVersionShape(expression: Partial<Expression>): string | null;
+//# sourceMappingURL=version.d.ts.map

package/dist/records/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/records/version.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAI9C,6EAA6E;AAC7E,eAAO,MAAM,QAAQ,KAAK,CAAC;AAE3B,mFAAmF;AACnF,eAAO,MAAM,kBAAkB,QAA0B,CAAC;AAE1D,kGAAkG;AAClG,wBAAgB,YAAY,IAAI,MAAM,CAErC;AAED,wDAAwD;AACxD,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,GAAG,OAAO,CAE9D;AAED,+CAA+C;AAC/C,wBAAgB,SAAS,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,SAAS,GAAG,MAAM,CAG5D;AAED,qFAAqF;AACrF,wBAAgB,WAAW,CAAC,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,KAAK,GAAG,KAAK,GAAG,SAAS,CAAC,GAAG;IACxF,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CACjB,CAOA;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,GAAG,MAAM,GAAG,IAAI,CAkBhF"}

package/dist/records/version.js

@@ -0,0 +1,70 @@
+import { base32Encode } from '../utils/hash.js';
+import { checkLinks } from './links.js';
+/** How many access changes a version may say it saw — normally one or two */
+export const MAX_SEEN = 64;
+/** Keys a caller may choose: `profile`, `collection:app.todo.item`, `space:b7…` */
+export const RECORD_KEY_PATTERN = /^[a-z0-9:._-]{1,128}$/;
+/** A fresh key: 128 random bits. Random rather than time-based, so it says nothing about when. */
+export function newRecordKey() {
+    return base32Encode(globalThis.crypto.getRandomValues(new Uint8Array(16)));
+}
+/**
+ * Whether `a` supersedes `b`. Higher `seq` first, then the lower id.
+ * Never looks at a timestamp.
+ */
+export function supersedes(a, b) {
+    return a.seq > b.seq || (a.seq === b.seq && a.id < b.id);
+}
+/** Sorts newest first by the ordering rule. */
+export function byVersion(a, b) {
+    if (a.id === b.id)
+        return 0;
+    return supersedes(a, b) ? -1 : 1;
+}
+/** The version fields for the next change to a record, given its current version. */
+export function nextVersion(current) {
+    return {
+        key: current.key,
+        seq: current.seq + 1,
+        prev: current.id,
+        genesis: current.seq === 0 ? current.id : (current.genesis ?? current.id),
+    };
+}
+/**
+ * Why a version is malformed on its own, or null when it is not.
+ *
+ * Only what can be seen in this one version. Whether `prev` exists, whether
+ * `seq` is exactly one past it, whether the collection matches earlier versions
+ * — each depends on what else a node happens to hold, and a check that depends
+ * on that makes nodes disagree forever. Those are applied when reading.
+ */
+export function checkVersionShape(expression) {
+    const { key, seq, prev, genesis, deleted, retain, body, seen } = expression;
+    if (typeof key !== 'string' || !RECORD_KEY_PATTERN.test(key))
+        return 'Record key is missing or malformed';
+    if (!Number.isSafeInteger(seq) || seq < 0)
+        return 'Version number must be a whole number from 0';
+    if (seq === 0) {
+        if (prev !== undefined || genesis !== undefined)
+            return 'A first version cannot name a previous one';
+    }
+    else {
+        if (typeof prev !== 'string' || typeof genesis !== 'string')
+            return 'A later version must name its previous and first versions';
+        if (prev === expression.id || genesis === expression.id)
+            return 'A version cannot name itself';
+    }
+    if (seen !== undefined && (!Array.isArray(seen) || seen.length > MAX_SEEN || !seen.every((id) => typeof id === 'string' && id.length > 0 && id.length <= 128))) {
+        return `seen must be a list of at most ${MAX_SEEN} version ids`;
+    }
+    if (deleted !== undefined && deleted !== true)
+        return 'deleted must be true when present';
+    if (retain !== undefined && retain !== true)
+        return 'retain must be true when present';
+    if (deleted && body !== null)
+        return 'A delete carries no body';
+    if (expression.links !== undefined)
+        return checkLinks(expression.links);
+    return null;
+}
+//# sourceMappingURL=version.js.map

package/dist/records/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/records/version.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAExC,6EAA6E;AAC7E,MAAM,CAAC,MAAM,QAAQ,GAAG,EAAE,CAAC;AAE3B,mFAAmF;AACnF,MAAM,CAAC,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;AAE1D,kGAAkG;AAClG,MAAM,UAAU,YAAY;IAC1B,OAAO,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC7E,CAAC;AAQD;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,CAAY,EAAE,CAAY;IACnD,OAAO,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;AAC3D,CAAC;AAED,+CAA+C;AAC/C,MAAM,UAAU,SAAS,CAAC,CAAY,EAAE,CAAY;IAClD,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE;QAAE,OAAO,CAAC,CAAC;IAC5B,OAAO,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACnC,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,WAAW,CAAC,OAA2D;IAMrF,OAAO;QACL,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,GAAG,EAAE,OAAO,CAAC,GAAG,GAAG,CAAC;QACpB,IAAI,EAAE,OAAO,CAAC,EAAE;QAChB,OAAO,EAAE,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,EAAE,CAAC;KAC1E,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAA+B;IAC/D,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC5E,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC;QAAE,OAAO,oCAAoC,CAAC;IAC1G,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,IAAK,GAAc,GAAG,CAAC;QAAE,OAAO,8CAA8C,CAAC;IAC7G,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC;QACd,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO,4CAA4C,CAAC;IACvG,CAAC;SAAM,CAAC;QACN,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,OAAO,KAAK,QAAQ;YAAE,OAAO,2DAA2D,CAAC;QAChI,IAAI,IAAI,KAAK,UAAU,CAAC,EAAE,IAAI,OAAO,KAAK,UAAU,CAAC,EAAE;YAAE,OAAO,8BAA8B,CAAC;IACjG,CAAC;IACD,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,QAAQ,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,KAAK,QAAQ,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,EAAE,CAAC;QAC/J,OAAO,kCAAkC,QAAQ,cAAc,CAAC;IAClE,CAAC;IACD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI;QAAE,OAAO,mCAAmC,CAAC;IAC1F,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI;QAAE,OAAO,kCAAkC,CAAC;IACvF,IAAI,OAAO,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,0BAA0B,CAAC;IAChE,IAAI,UAAU,CAAC,KAAK,KAAK,SAAS;QAAE,OAAO,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IACxE,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/schema/collection-def.d.ts

@@ -0,0 +1,96 @@
+import type { StandardJSONSchemaV1, StandardSchemaV1 } from '../types.js';
+import type { LinkDeclaration } from '../records/links.js';
+import type { DefineCollection } from '../node/types.js';
+import { type CollectionRules } from '../records/rules.js';
+export type JsonSchema = {
+    readonly [keyword: string]: unknown;
+};
+/**
+ * A collection definition, kept exactly as written: its validator's type
+ * comes along, so querying or writing with it is typed, and its rules stay
+ * the literals `define` expects.
+ *
+ * ```ts
+ * const polls = collection({ name: 'app.poll', schema: Poll, rules: { edit: 'creator' } });
+ * await node.collections.define(space.id, polls);
+ * const { records } = await node.records.query(space.id, { collection: polls }); // bodies are z.infer<typeof Poll>
+ * ```
+ */
+export declare function collection<const C extends DefineCollection>(definition: C): C;
+/**
+ * The JSON Schema to store for a definition's schema: plain JSON Schema as
+ * it is, or what a Standard JSON Schema validator (a Zod object, say) says it
+ * accepts. The result is checked like any other — a validator feature that
+ * has no stored equivalent, like a regex, is refused with the reason.
+ */
+export declare function toJsonSchema(schema: JsonSchema | StandardJSONSchemaV1): JsonSchema;
+/** A collection, as a space describes it to whoever opens it. */
+export interface StoredCollection {
+    /** Reverse-DNS, like `app.todo.item`. `sys.*` is the protocol's own. */
+    readonly name: string;
+    readonly title?: string;
+    readonly description?: string;
+    /** JSON Schema for a record's body */
+    readonly schema: JsonSchema;
+    /** Bumped when the shape changes; records keep the version they were written under */
+    readonly version: number;
+    /**
+     * Whether edits to its records keep old versions. `latest` (the default)
+     * keeps current state only; `all` keeps every version, hash-linked, as a
+     * verifiable history. Read by writers, who mark each version accordingly.
+     */
+    readonly history?: 'latest' | 'all';
+    /**
+     * The link roles its records may carry, and what each may point at. An agent
+     * reading the catalogue learns from these how the space's things connect.
+     */
+    readonly links?: Readonly<Record<string, LinkDeclaration>>;
+    /**
+     * The permissions its rules may name, in its own words: `moderate`. A role
+     * holds one as `<collection>/<permission>` — `app.poll/moderate` — so two
+     * apps in one space never clash.
+     */
+    readonly permissions?: ReadonlyArray<string>;
+    /**
+     * Who may create, edit and delete its records, what must be unique, which
+     * fields are fixed. A version is judged by the definition in force as of
+     * the access changes it saw, on every peer.
+     */
+    readonly rules?: CollectionRules;
+    /**
+     * A screen for its records: one HTML document, scripts and styles inline,
+     * that an app may run in a sealed frame instead of drawing the records
+     * itself. It reaches the records only through what the app hands it, as
+     * whoever is looking, under these rules. Kept on the definition, so only
+     * someone allowed to define collections — never an agent — puts one in a
+     * space, and what they approved is exactly what runs.
+     */
+    readonly screen?: string;
+}
+/** The largest screen a definition may carry, in bytes of UTF-8 — it travels with every copy of the definition */
+export declare const MAX_SCREEN_BYTES: number;
+/** The reserved collection that collection definitions live in. */
+export declare const CATALOG_COLLECTION = "sys.collection";
+/**
+ * Why a schema may not be published, or null when it may.
+ * @param schema The candidate schema
+ * @param path Where in the schema, for the message
+ */
+export declare function checkPublishableSchema(schema: unknown, path?: string): string | null;
+/**
+ * Why a definition may not be published, or null when it may.
+ */
+export declare function checkStoredCollection(definition: unknown): string | null;
+export interface SchemaIssue {
+    /** Where in the value, as a JSON pointer: `/items/0/text` */
+    readonly path: string;
+    readonly message: string;
+}
+/**
+ * Validates a value against a stored schema.
+ * @returns The issues; empty when it conforms
+ */
+export declare function validateJsonSchema(schema: JsonSchema, value: unknown): ReadonlyArray<SchemaIssue>;
+/** Wraps a stored schema as a Standard Schema, so gates and engines take it unchanged. */
+export declare function asStandardSchema(schema: JsonSchema): StandardSchemaV1;
+//# sourceMappingURL=collection-def.d.ts.map

package/dist/schema/collection-def.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection-def.d.ts","sourceRoot":"","sources":["../../src/schema/collection-def.ts"],"names":[],"mappings":"AAiCA,OAAO,KAAK,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAkC,KAAK,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3F,MAAM,MAAM,UAAU,GAAG;IAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAEjE;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CAAC,KAAK,CAAC,CAAC,SAAS,gBAAgB,EAAE,UAAU,EAAE,CAAC,GAAG,CAAC,CAE7E;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,oBAAoB,GAAG,UAAU,CAYlF;AAED,iEAAiE;AACjE,MAAM,WAAW,gBAAgB;IAC/B,wEAAwE;IACxE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,sFAAsF;IACtF,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;IACpC;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;IAC3D;;;;OAIG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IAC7C;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,eAAe,CAAC;IACjC;;;;;;;OAOG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,kHAAkH;AAClH,eAAO,MAAM,gBAAgB,QAAY,CAAC;AAE1C,mEAAmE;AACnE,eAAO,MAAM,kBAAkB,mBAAmB,CAAC;AAyBnD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,SAAW,GAAG,MAAM,GAAG,IAAI,CAwEtF;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAwCxE;AAED,MAAM,WAAW,WAAW;IAC1B,6DAA6D;IAC7D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,OAAO,GAAG,aAAa,CAAC,WAAW,CAAC,CAUjG;AAED,0FAA0F;AAC1F,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,UAAU,GAAG,gBAAgB,CAarE"}

package/dist/schema/collection-def.js

@@ -0,0 +1,272 @@
+/**
+ * @module collection-def
+ * Collections a space describes itself, as data.
+ *
+ * `StandardSchemaV1` is a runtime object carrying a function — it cannot be
+ * written into a space and read by another app. So a space stores **JSON
+ * Schema**, and Standard Schema becomes the adapter that runs it locally.
+ * A validator that can describe itself as JSON Schema (Standard JSON Schema:
+ * Zod 4.2+, ArkType, Valibot) can be handed to a definition directly —
+ * {@link toJsonSchema} turns it into what gets stored.
+ *
+ * Only a small, fixed subset may be *published*, so every app in any language
+ * agrees on what a stored schema means:
+ *
+ *   type · properties · required · items · enum · minimum · maximum ·
+ *   minLength · maxLength · minItems · maxItems · additionalProperties
+ *   (boolean) · title · description
+ *
+ * plus two ways to say what a value *means*, so any app can show it well:
+ *
+ * - `oneOf: [{ const, title }]` — fixed choices with labels, the standard
+ *   JSON Schema way (`enum` has no labels).
+ * - `x-choicesFrom: { rel, field }` — the value picks from a list in another
+ *   record: the one this record links to as `rel`, in its field `field`. A
+ *   vote's `choice` picks from the `options` of the poll it is `about`. A
+ *   number is a position in that list; anything else is the option itself.
+ *   Not checked when validating — the other record may not be here yet.
+ *
+ * Anything else is refused at publish time — loudly, where the author can fix
+ * it. At validation time unknown keywords are ignored instead, so a space
+ * written by a newer app that allows more stays readable by an older one.
+ */
+import { Validator } from '@cfworker/json-schema';
+import { checkRules, PERMISSION_PATTERN } from '../records/rules.js';
+/**
+ * A collection definition, kept exactly as written: its validator's type
+ * comes along, so querying or writing with it is typed, and its rules stay
+ * the literals `define` expects.
+ *
+ * ```ts
+ * const polls = collection({ name: 'app.poll', schema: Poll, rules: { edit: 'creator' } });
+ * await node.collections.define(space.id, polls);
+ * const { records } = await node.records.query(space.id, { collection: polls }); // bodies are z.infer<typeof Poll>
+ * ```
+ */
+export function collection(definition) {
+    return definition;
+}
+/**
+ * The JSON Schema to store for a definition's schema: plain JSON Schema as
+ * it is, or what a Standard JSON Schema validator (a Zod object, say) says it
+ * accepts. The result is checked like any other — a validator feature that
+ * has no stored equivalent, like a regex, is refused with the reason.
+ */
+export function toJsonSchema(schema) {
+    const standard = schema['~standard'];
+    if (!standard)
+        return schema;
+    if (typeof standard.jsonSchema?.input !== 'function') {
+        throw new Error(`This ${standard.vendor ?? ''} schema can't describe itself as JSON Schema, which is what a space stores. ` +
+            'Use Zod 4.2+, ArkType 2.1.28+, Valibot with toStandardJsonSchema, or plain JSON Schema.');
+    }
+    // What was accepted is what gets stored; the dialect marker adds nothing.
+    const { $schema: _dialect, ...json } = standard.jsonSchema.input({ target: 'draft-2020-12' });
+    return json;
+}
+/** The largest screen a definition may carry, in bytes of UTF-8 — it travels with every copy of the definition */
+export const MAX_SCREEN_BYTES = 48 * 1024;
+/** The reserved collection that collection definitions live in. */
+export const CATALOG_COLLECTION = 'sys.collection';
+const KEYWORDS = new Set([
+    'type',
+    'properties',
+    'required',
+    'items',
+    'enum',
+    'minimum',
+    'maximum',
+    'minLength',
+    'maxLength',
+    'minItems',
+    'maxItems',
+    'additionalProperties',
+    'title',
+    'description',
+    'oneOf',
+    'const',
+    'x-choicesFrom',
+]);
+const LINK_REL = /^[a-z][a-zA-Z0-9]{0,63}$/;
+const TYPES = new Set(['object', 'array', 'string', 'number', 'integer', 'boolean', 'null']);
+const NAME = /^[a-z][a-z0-9-]*(\.[a-z][a-z0-9-]*)+$/;
+/**
+ * Why a schema may not be published, or null when it may.
+ * @param schema The candidate schema
+ * @param path Where in the schema, for the message
+ */
+export function checkPublishableSchema(schema, path = 'schema') {
+    if (typeof schema !== 'object' || schema === null || Array.isArray(schema))
+        return `${path} must be an object`;
+    for (const [keyword, value] of Object.entries(schema)) {
+        const at = `${path}.${keyword}`;
+        if (!KEYWORDS.has(keyword)) {
+            return `${at} is not supported. Stored schemas may use: ${[...KEYWORDS].join(', ')}`;
+        }
+        switch (keyword) {
+            case 'type': {
+                const types = Array.isArray(value) ? value : [value];
+                if (types.length === 0 || !types.every((t) => typeof t === 'string' && TYPES.has(t))) {
+                    return `${at} must be one of ${[...TYPES].join(', ')}`;
+                }
+                break;
+            }
+            case 'properties': {
+                if (typeof value !== 'object' || value === null || Array.isArray(value))
+                    return `${at} must be an object`;
+                for (const [property, sub] of Object.entries(value)) {
+                    const problem = checkPublishableSchema(sub, `${at}.${property}`);
+                    if (problem)
+                        return problem;
+                }
+                break;
+            }
+            case 'items': {
+                const problem = checkPublishableSchema(value, at);
+                if (problem)
+                    return problem;
+                break;
+            }
+            case 'required':
+                if (!Array.isArray(value) || !value.every((v) => typeof v === 'string'))
+                    return `${at} must be a list of property names`;
+                break;
+            case 'enum':
+                if (!Array.isArray(value) || value.length === 0)
+                    return `${at} must be a non-empty list`;
+                break;
+            case 'minimum':
+            case 'maximum':
+            case 'minLength':
+            case 'maxLength':
+            case 'minItems':
+            case 'maxItems':
+                if (typeof value !== 'number' || !Number.isFinite(value))
+                    return `${at} must be a number`;
+                break;
+            case 'additionalProperties':
+                if (typeof value !== 'boolean')
+                    return `${at} must be true or false`;
+                break;
+            case 'title':
+            case 'description':
+                if (typeof value !== 'string')
+                    return `${at} must be text`;
+                break;
+            case 'oneOf': {
+                // Only labelled choices: [{ const, title? }]. Not general composition.
+                if (!Array.isArray(value) || value.length === 0)
+                    return `${at} must be a non-empty list of { const, title }`;
+                for (const [i, choice] of value.entries()) {
+                    if (typeof choice !== 'object' || choice === null || !('const' in choice))
+                        return `${at}[${i}] must be { const, title }`;
+                    const extra = Object.keys(choice).find((k) => k !== 'const' && k !== 'title' && k !== 'description');
+                    if (extra)
+                        return `${at}[${i}].${extra}: oneOf is only for labelled choices — { const, title, description }`;
+                    if ('title' in choice && typeof choice.title !== 'string')
+                        return `${at}[${i}].title must be text`;
+                }
+                break;
+            }
+            case 'const':
+                break;
+            case 'x-choicesFrom': {
+                const from = value;
+                if (typeof from !== 'object' || from === null || typeof from.rel !== 'string' || !LINK_REL.test(from.rel) || typeof from.field !== 'string' || !from.field) {
+                    return `${at} must be { "rel": "<link role>", "field": "<list field in the linked record>" }`;
+                }
+                break;
+            }
+        }
+    }
+    return null;
+}
+/**
+ * Why a definition may not be published, or null when it may.
+ */
+export function checkStoredCollection(definition) {
+    const d = definition;
+    if (typeof d !== 'object' || d === null)
+        return 'A collection definition must be an object';
+    if (typeof d.name !== 'string' || !NAME.test(d.name)) {
+        return 'name must be reverse-DNS, lower case, with at least one dot — e.g. "app.todo.item"';
+    }
+    if (d.name.startsWith('sys.'))
+        return '"sys.*" collections belong to the protocol';
+    if (!Number.isInteger(d.version) || d.version < 1)
+        return 'version must be a whole number from 1';
+    if (d.title !== undefined && typeof d.title !== 'string')
+        return 'title must be text';
+    if (d.description !== undefined && typeof d.description !== 'string')
+        return 'description must be text';
+    if (d.history !== undefined && d.history !== 'latest' && d.history !== 'all')
+        return 'history must be "latest" or "all"';
+    if (d.links !== undefined) {
+        if (typeof d.links !== 'object' || d.links === null || Array.isArray(d.links))
+            return 'links must be an object of roles';
+        for (const [rel, declaration] of Object.entries(d.links)) {
+            if (!/^[a-z][a-zA-Z0-9]{0,63}$/.test(rel))
+                return `Link role "${rel}" must be lower camel case, like "about"`;
+            const decl = declaration;
+            if (typeof decl !== 'object' || decl === null)
+                return `links.${rel} must be an object`;
+            const to = decl.to;
+            if (to !== '*' && !(Array.isArray(to) && to.length > 0 && to.every((c) => typeof c === 'string'))) {
+                return `links.${rel}.to must be "*" or a list of collection names`;
+            }
+            if (decl.cardinality !== undefined && decl.cardinality !== 'one' && decl.cardinality !== 'many') {
+                return `links.${rel}.cardinality must be "one" or "many"`;
+            }
+            if (decl.description !== undefined && typeof decl.description !== 'string')
+                return `links.${rel}.description must be text`;
+        }
+    }
+    if (d.permissions !== undefined) {
+        if (!Array.isArray(d.permissions) || !d.permissions.every((p) => typeof p === 'string' && PERMISSION_PATTERN.test(p))) {
+            return 'permissions must be a list of names in lower camel case, like "moderate"';
+        }
+    }
+    const rules = checkRules(d.rules, 'rules', d.permissions ?? []);
+    if (rules)
+        return rules;
+    if (d.screen !== undefined) {
+        if (typeof d.screen !== 'string' || !d.screen.trim())
+            return 'screen must be an HTML document, as text';
+        const bytes = new TextEncoder().encode(d.screen).length;
+        if (bytes > MAX_SCREEN_BYTES)
+            return `screen is ${Math.ceil(bytes / 1024)} KB; at most ${MAX_SCREEN_BYTES / 1024} KB`;
+    }
+    return checkPublishableSchema(d.schema);
+}
+/**
+ * Validates a value against a stored schema.
+ * @returns The issues; empty when it conforms
+ */
+export function validateJsonSchema(schema, value) {
+    const result = new Validator(schema, '2020-12', false).validate(value);
+    if (result.valid)
+        return [];
+    // The validator reports the wrapping keywords too ("properties" failed
+    // because "text" did); the leaves are the useful part.
+    const leaves = result.errors.filter((error) => error.keyword !== 'properties' && error.keyword !== 'items');
+    return (leaves.length ? leaves : result.errors).map((error) => ({
+        path: error.instanceLocation.replace(/^#/, '') || '/',
+        message: error.error,
+    }));
+}
+/** Wraps a stored schema as a Standard Schema, so gates and engines take it unchanged. */
+export function asStandardSchema(schema) {
+    return {
+        '~standard': {
+            version: 1,
+            vendor: 'weave/json-schema',
+            validate(value) {
+                const issues = validateJsonSchema(schema, value);
+                return issues.length
+                    ? { issues: issues.map((issue) => ({ message: issue.path === '/' ? issue.message : `${issue.path}: ${issue.message}` })) }
+                    : { value };
+            },
+        },
+    };
+}
+//# sourceMappingURL=collection-def.js.map

package/dist/schema/collection-def.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collection-def.js","sourceRoot":"","sources":["../../src/schema/collection-def.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAIlD,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAwB,MAAM,qBAAqB,CAAC;AAI3F;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CAAmC,UAAa;IACxE,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,MAAyC;IACpE,MAAM,QAAQ,GAAI,MAAwC,CAAC,WAAW,CAAC,CAAC;IACxE,IAAI,CAAC,QAAQ;QAAE,OAAO,MAAoB,CAAC;IAC3C,IAAI,OAAO,QAAQ,CAAC,UAAU,EAAE,KAAK,KAAK,UAAU,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CACb,QAAQ,QAAQ,CAAC,MAAM,IAAI,EAAE,8EAA8E;YACzG,yFAAyF,CAC5F,CAAC;IACJ,CAAC;IACD,0EAA0E;IAC1E,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,eAAe,EAAE,CAAC,CAAC;IAC9F,OAAO,IAAI,CAAC;AACd,CAAC;AA8CD,kHAAkH;AAClH,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,GAAG,IAAI,CAAC;AAE1C,mEAAmE;AACnE,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AAEnD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC;IACvB,MAAM;IACN,YAAY;IACZ,UAAU;IACV,OAAO;IACP,MAAM;IACN,SAAS;IACT,SAAS;IACT,WAAW;IACX,WAAW;IACX,UAAU;IACV,UAAU;IACV,sBAAsB;IACtB,OAAO;IACP,aAAa;IACb,OAAO;IACP,OAAO;IACP,eAAe;CAChB,CAAC,CAAC;AACH,MAAM,QAAQ,GAAG,0BAA0B,CAAC;AAC5C,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;AAC7F,MAAM,IAAI,GAAG,uCAAuC,CAAC;AAErD;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,MAAe,EAAE,IAAI,GAAG,QAAQ;IACrE,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,OAAO,GAAG,IAAI,oBAAoB,CAAC;IAC/G,KAAK,MAAM,CAAC,OAAO,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACtD,MAAM,EAAE,GAAG,GAAG,IAAI,IAAI,OAAO,EAAE,CAAC;QAChC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3B,OAAO,GAAG,EAAE,8CAA8C,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACvF,CAAC;QACD,QAAQ,OAAO,EAAE,CAAC;YAChB,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;gBACrD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBACrF,OAAO,GAAG,EAAE,mBAAmB,CAAC,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzD,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,YAAY,CAAC,CAAC,CAAC;gBAClB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;oBAAE,OAAO,GAAG,EAAE,oBAAoB,CAAC;gBAC1G,KAAK,MAAM,CAAC,QAAQ,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACpD,MAAM,OAAO,GAAG,sBAAsB,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,QAAQ,EAAE,CAAC,CAAC;oBACjE,IAAI,OAAO;wBAAE,OAAO,OAAO,CAAC;gBAC9B,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,MAAM,OAAO,GAAG,sBAAsB,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;gBAClD,IAAI,OAAO;oBAAE,OAAO,OAAO,CAAC;gBAC5B,MAAM;YACR,CAAC;YACD,KAAK,UAAU;gBACb,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC;oBAAE,OAAO,GAAG,EAAE,mCAAmC,CAAC;gBACzH,MAAM;YACR,KAAK,MAAM;gBACT,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;oBAAE,OAAO,GAAG,EAAE,2BAA2B,CAAC;gBACzF,MAAM;YACR,KAAK,SAAS,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,WAAW,CAAC;YACjB,KAAK,WAAW,CAAC;YACjB,KAAK,UAAU,CAAC;YAChB,KAAK,UAAU;gBACb,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;oBAAE,OAAO,GAAG,EAAE,mBAAmB,CAAC;gBAC1F,MAAM;YACR,KAAK,sBAAsB;gBACzB,IAAI,OAAO,KAAK,KAAK,SAAS;oBAAE,OAAO,GAAG,EAAE,wBAAwB,CAAC;gBACrE,MAAM;YACR,KAAK,OAAO,CAAC;YACb,KAAK,aAAa;gBAChB,IAAI,OAAO,KAAK,KAAK,QAAQ;oBAAE,OAAO,GAAG,EAAE,eAAe,CAAC;gBAC3D,MAAM;YACR,KAAK,OAAO,CAAC,CAAC,CAAC;gBACb,uEAAuE;gBACvE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;oBAAE,OAAO,GAAG,EAAE,+CAA+C,CAAC;gBAC7G,KAAK,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;oBAC1C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,CAAC,OAAO,IAAI,MAAM,CAAC;wBAAE,OAAO,GAAG,EAAE,IAAI,CAAC,4BAA4B,CAAC;oBACzH,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,OAAO,IAAI,CAAC,KAAK,OAAO,IAAI,CAAC,KAAK,aAAa,CAAC,CAAC;oBACrG,IAAI,KAAK;wBAAE,OAAO,GAAG,EAAE,IAAI,CAAC,KAAK,KAAK,sEAAsE,CAAC;oBAC7G,IAAI,OAAO,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ;wBAAE,OAAO,GAAG,EAAE,IAAI,CAAC,sBAAsB,CAAC;gBACrG,CAAC;gBACD,MAAM;YACR,CAAC;YACD,KAAK,OAAO;gBACV,MAAM;YACR,KAAK,eAAe,CAAC,CAAC,CAAC;gBACrB,MAAM,IAAI,GAAG,KAAkD,CAAC;gBAChE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;oBAC3J,OAAO,GAAG,EAAE,iFAAiF,CAAC;gBAChG,CAAC;gBACD,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,UAAmB;IACvD,MAAM,CAAC,GAAG,UAA8C,CAAC;IACzD,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,IAAI;QAAE,OAAO,2CAA2C,CAAC;IAC5F,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;QACrD,OAAO,oFAAoF,CAAC;IAC9F,CAAC;IACD,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAAE,OAAO,4CAA4C,CAAC;IACnF,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAK,CAAC,CAAC,OAAkB,GAAG,CAAC;QAAE,OAAO,uCAAuC,CAAC;IAC9G,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ;QAAE,OAAO,oBAAoB,CAAC;IACtF,IAAI,CAAC,CAAC,WAAW,KAAK,SAAS,IAAI,OAAO,CAAC,CAAC,WAAW,KAAK,QAAQ;QAAE,OAAO,0BAA0B,CAAC;IACxG,IAAI,CAAC,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,CAAC,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,OAAO,KAAK,KAAK;QAAE,OAAO,mCAAmC,CAAC;IACzH,IAAI,CAAC,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1B,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;YAAE,OAAO,kCAAkC,CAAC;QACzH,KAAK,MAAM,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YACzD,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,GAAG,CAAC;gBAAE,OAAO,cAAc,GAAG,0CAA0C,CAAC;YAC9G,MAAM,IAAI,GAAG,WAA8C,CAAC;YAC5D,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI;gBAAE,OAAO,SAAS,GAAG,oBAAoB,CAAC;YACvF,MAAM,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC;YACnB,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,EAAE,CAAC;gBAClG,OAAO,SAAS,GAAG,+CAA+C,CAAC;YACrE,CAAC;YACD,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,IAAI,IAAI,CAAC,WAAW,KAAK,MAAM,EAAE,CAAC;gBAChG,OAAO,SAAS,GAAG,sCAAsC,CAAC;YAC5D,CAAC;YACD,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,OAAO,IAAI,CAAC,WAAW,KAAK,QAAQ;gBAAE,OAAO,SAAS,GAAG,2BAA2B,CAAC;QAC7H,CAAC;IACH,CAAC;IACD,IAAI,CAAC,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACtH,OAAO,0EAA0E,CAAC;QACpF,CAAC;IACH,CAAC;IACD,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IAChE,IAAI,KAAK;QAAE,OAAO,KAAK,CAAC;IACxB,IAAI,CAAC,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC3B,IAAI,OAAO,CAAC,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE;YAAE,OAAO,0CAA0C,CAAC;QACxG,MAAM,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;QACxD,IAAI,KAAK,GAAG,gBAAgB;YAAE,OAAO,aAAa,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,gBAAgB,gBAAgB,GAAG,IAAI,KAAK,CAAC;IACxH,CAAC;IACD,OAAO,sBAAsB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;AAC1C,CAAC;AAQD;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,MAAkB,EAAE,KAAc;IACnE,MAAM,MAAM,GAAG,IAAI,SAAS,CAAC,MAAe,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAChF,IAAI,MAAM,CAAC,KAAK;QAAE,OAAO,EAAE,CAAC;IAC5B,uEAAuE;IACvE,uDAAuD;IACvD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,KAAK,YAAY,IAAI,KAAK,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC;IAC5G,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC9D,IAAI,EAAE,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG;QACrD,OAAO,EAAE,KAAK,CAAC,KAAK;KACrB,CAAC,CAAC,CAAC;AACN,CAAC;AAED,0FAA0F;AAC1F,MAAM,UAAU,gBAAgB,CAAC,MAAkB;IACjD,OAAO;QACL,WAAW,EAAE;YACX,OAAO,EAAE,CAAC;YACV,MAAM,EAAE,mBAAmB;YAC3B,QAAQ,CAAC,KAAc;gBACrB,MAAM,MAAM,GAAG,kBAAkB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;gBACjD,OAAO,MAAM,CAAC,MAAM;oBAClB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE;oBAC1H,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC;YAChB,CAAC;SACF;KACF,CAAC;AACJ,CAAC"}

package/dist/schema/expression.d.ts

@@ -0,0 +1,69 @@
+import type { Expression, Link, UnsignedExpression } from '../types.js';
+/**
+ * Parameters for creating a new expression.
+ */
+export interface CreateExpressionParams<T> {
+    readonly author: string;
+    readonly collection: string;
+    readonly body: T;
+    readonly createdAt?: string;
+    /** Space this expression belongs to */
+    readonly space?: string;
+    /** Encoded UCAN authorizing this author, when signing with a delegated key */
+    readonly proof?: string;
+    /** The record this is a version of. Default: a new record, with a fresh key, at seq 0. */
+    readonly version?: {
+        readonly key: string;
+        readonly seq: number;
+        readonly prev?: string;
+        readonly genesis?: string;
+    };
+    readonly retain?: boolean;
+    readonly deleted?: boolean;
+    /** The latest access changes the writer knew of */
+    readonly seen?: ReadonlyArray<string>;
+    /** Links in the clear — public spaces only; a private space seals them in the body */
+    readonly links?: ReadonlyArray<Link>;
+}
+/**
+ * Deterministically serializes an object into a JSON string with sorted keys.
+ * Recursively processes nested objects.
+ *
+ * @param obj The object to canonicalize
+ * @returns Deterministic JSON string representation
+ */
+export declare function canonicalize(obj: unknown): string;
+/**
+ * Creates an unsigned expression with a generated timestamp (if not provided).
+ * @param params Parameters to create the expression
+ * @returns Unsigned expression object
+ */
+export declare function createExpression<T>(params: CreateExpressionParams<T>): UnsignedExpression<T>;
+/**
+ * What the author signed and the id hashes: everything but the id and the
+ * signature. Both checks — id and signature — must drop exactly these, or a
+ * field added later is hashed on one side and not the other.
+ * @param expression A signed expression
+ * @returns Its unsigned payload
+ */
+export declare function signedPart<T>(expression: Expression<T>): UnsignedExpression<T>;
+/**
+ * Computes the CID for an unsigned expression by hashing its canonical serialization.
+ * @param expr The unsigned expression
+ * @returns Promise resolving to the CID string
+ */
+export declare function getExpressionId(expr: UnsignedExpression): Promise<string>;
+/**
+ * Serializes an Expression to canonical JSON bytes.
+ * @param expr The expression to serialize
+ * @returns Uint8Array containing canonical JSON bytes
+ */
+export declare function serializeExpression(expr: Expression): Uint8Array;
+/**
+ * Parses an Expression from canonical JSON bytes.
+ * Note: Does not verify signature or ID.
+ * @param bytes The bytes to deserialize
+ * @returns Parsed Expression
+ */
+export declare function deserializeExpression(bytes: Uint8Array): Expression;
+//# sourceMappingURL=expression.d.ts.map

package/dist/schema/expression.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"expression.d.ts","sourceRoot":"","sources":["../../src/schema/expression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAKxE;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC;IACvC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IACjB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,uCAAuC;IACvC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,8EAA8E;IAC9E,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,0FAA0F;IAC1F,QAAQ,CAAC,OAAO,CAAC,EAAE;QACjB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;KAC3B,CAAC;IACF,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,mDAAmD;IACnD,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACtC,sFAAsF;IACtF,QAAQ,CAAC,KAAK,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;CACtC;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,CAkBjD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,sBAAsB,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAiB5F;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAG9E;AAED;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAI/E;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAGhE;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,UAAU,GAAG,UAAU,CAInE"}