@mdbase-dev/sdk 0.0.0-stage → 0.1.0-beta.149

package/dist/runtime/wasm.js

@@ -0,0 +1,274 @@
+/**
+ * The JS side of `runtime.wasm`'s ABI (`crates/wasm/src/lib.rs`): instantiate it,
+ * open a replica, and hand out in-process ports (`replica-client-api.md` §12.1).
+ *
+ * Packaging (embedding as base64, the table-driven decoder, the process-wide registry
+ * and the version-skew rule) lives in `packages/obsidian-runtime`. This module takes
+ * the decoded bytes, so web apps that host a replica and Obsidian share it.
+ */
+import { decode, encode, encodeSecret } from "../cbor.js";
+import { mdbaseError } from "../errors.js";
+import { uuidToBytes } from "../codec.js";
+/** A `runtime.wasm` instance hosting one collection. */
+export class WasmRuntime {
+    instance;
+    ports = new Map();
+    timer = null;
+    opened = false;
+    constructor(instance) {
+        this.instance = instance;
+    }
+    get x() {
+        if (!this.instance)
+            throw mdbaseError("unavailable", "runtime instance was discarded after an ABI failure");
+        return this.instance;
+    }
+    discard() {
+        // A trap may bypass Rust's input wipe. Ownership has crossed the ABI, so do
+        // not guess whether the pointer is still allocated. Fail-stop and release
+        // the instance instead of serving or reopening it with uncertain key state.
+        this.instance = null;
+        if (this.timer)
+            clearInterval(this.timer);
+        this.timer = null;
+        for (const port of [...this.ports.values()])
+            port.end();
+        this.ports.clear();
+    }
+    /** Instantiate from the module's bytes (decoded by the embedding loader). */
+    static async instantiate(bytes) {
+        return new WasmRuntime(await this.load(bytes));
+    }
+    /** @internal App subclass installs bounded same-Worker imports, never app RPCs. */
+    static async load(bytes, extra) {
+        let memory = null;
+        let exports = null;
+        const extraEnv = extra?.(() => {
+            if (!exports)
+                throw mdbaseError("unavailable", "runtime imports called before initialization");
+            return exports;
+        }) ?? {};
+        const utf8 = new TextDecoder();
+        const env = {
+            // The optional app host overrides this with same-Worker SQL. A legacy
+            // runtime cannot activate app storage or silently fall back to MemStore.
+            host_app_sql: (_ptr, _len) => 0n,
+            host_now_ms: () => Date.now(),
+            host_local_date: (ms, tzPtr, tzLen, out) => {
+                try {
+                    const tz = utf8.decode(new Uint8Array(memory.buffer, tzPtr, tzLen));
+                    // en-CA formats as YYYY-MM-DD.
+                    const d = new Intl.DateTimeFormat("en-CA", { timeZone: tz, year: "numeric", month: "2-digit", day: "2-digit" }).format(ms);
+                    if (!/^\d{4}-\d{2}-\d{2}$/.test(d))
+                        return 0;
+                    new Uint8Array(memory.buffer, out, 10).set(new TextEncoder().encode(d));
+                    return 10;
+                }
+                catch {
+                    return 0; // unknown zone
+                }
+            },
+            host_default_zone: (out, cap) => {
+                const b = new TextEncoder().encode(Intl.DateTimeFormat().resolvedOptions().timeZone || "UTC");
+                const n = Math.min(b.length, cap);
+                new Uint8Array(memory.buffer, out, n).set(b.subarray(0, n));
+                return n;
+            },
+            host_random: (ptr, len) => {
+                // Fill in chunks: getRandomValues takes at most 65536 bytes.
+                const view = new Uint8Array(memory.buffer, ptr, len);
+                for (let o = 0; o < len; o += 65536)
+                    globalThis.crypto.getRandomValues(view.subarray(o, o + 65536));
+            },
+        };
+        const { instance } = await WebAssembly.instantiate(bytes, { env: { ...env, ...extraEnv } });
+        const x = instance.exports;
+        exports = x;
+        memory = x.memory;
+        return x;
+    }
+    put(b) {
+        if (b.length === 0)
+            return [0, 0];
+        const p = this.x.alloc(b.length);
+        new Uint8Array(this.x.memory.buffer, p, b.length).set(b);
+        return [p, b.length];
+    }
+    takeOut(packed) {
+        const ptr = Number(packed >> 32n);
+        const len = Number(packed & 0xffffffffn);
+        if (len === 0)
+            return new Uint8Array(0);
+        const out = new Uint8Array(this.x.memory.buffer, ptr, len).slice();
+        this.x.dealloc(ptr, len);
+        return out;
+    }
+    info() {
+        const m = decode(this.takeOut(this.x.rt_info()));
+        const pair = (v) => {
+            const [major, minor] = v;
+            return { major: major, minor: minor };
+        };
+        return {
+            abiMajor: m.get(0),
+            runtimeVersion: m.get(1),
+            sem: pair(m.get(2)),
+            serves: m.get(3).map(pair),
+        };
+    }
+    /** Open the replica. */
+    open(c) {
+        const x = this.x;
+        if (this.opened)
+            throw mdbaseError("unavailable", "runtime is already open");
+        const profile = c.queryExecutionProfile;
+        let tag;
+        if (profile !== undefined) {
+            if (profile !== "memory_constrained" && profile !== "desktop") {
+                throw mdbaseError("invalid_request", "unknown query execution profile");
+            }
+            if (typeof x.rt_open_profile !== "function") {
+                throw mdbaseError("unavailable", "runtime does not support explicit query profile initialization");
+            }
+            tag = profile === "memory_constrained" ? 0 : 1;
+        }
+        const cfg = encodeSecret(new Map([
+            [0, uuidToBytes(c.collection)],
+            [1, uuidToBytes(c.replicaId)],
+            [2, uuidToBytes(c.deviceId)],
+            [3, c.mode === "local_only" ? 0 : 1],
+            [4, c.signSecretKey],
+            [5, c.kemSecretKey],
+            [6, c.e2e ?? false],
+        ]));
+        let err;
+        try {
+            // rt_open consumes and wipes the linear-memory input. This JS encoding is
+            // a separate secret-bearing copy: clear it on success, refusal or a trap.
+            const input = this.put(cfg);
+            err = this.takeOut(tag === undefined ? x.rt_open(...input) : x.rt_open_profile(...input, tag));
+        }
+        catch (error) {
+            this.discard();
+            throw error;
+        }
+        finally {
+            cfg.fill(0);
+        }
+        if (err.length)
+            throw mdbaseError("unavailable", `runtime failed to open: ${new TextDecoder().decode(err)}`);
+        this.markOpened();
+    }
+    /** @internal Start the shared frame/timer driver only after a successful open. */
+    markOpened() {
+        this.opened = true;
+        this.timer ??= setInterval(() => this.tick(), 1000);
+        this.timer.unref?.();
+    }
+    /** Run timers now. */
+    tick() {
+        this.x.rt_tick(Date.now());
+        this.flush();
+    }
+    /** An in-process port. The first frame sent must be `hello`. */
+    connect(o = {}) {
+        let session = null;
+        let closed = false;
+        const queue = [];
+        const port = {
+            onframe: null,
+            onclose: null,
+            send: (frame) => {
+                if (closed)
+                    throw mdbaseError("unavailable", "port closed");
+                const bytes = encode(frame);
+                if (session === null) {
+                    const grant = o.grant && o.clientKey ? new Uint8Array([...uuidToBytes(o.grant), ...o.clientKey]) : new Uint8Array(0);
+                    const out = decode(this.takeOut(this.x.rt_hello(...this.put(grant), ...this.put(bytes))));
+                    const s = BigInt(out[0]);
+                    const resp = decode(out[1]);
+                    queueMicrotask(() => {
+                        port.onframe?.(resp);
+                        if (s === 0n)
+                            port.end();
+                    });
+                    if (s !== 0n) {
+                        session = s;
+                        this.ports.set(s, port);
+                        this.flush();
+                    }
+                    return;
+                }
+                this.x.rt_frame(session, ...this.put(bytes));
+                this.flush();
+            },
+            close: () => {
+                if (closed)
+                    return;
+                closed = true;
+                if (session !== null) {
+                    this.ports.delete(session);
+                    this.x.rt_close(session);
+                }
+                port.onclose?.();
+            },
+            deliver: (f) => (port.onframe ? port.onframe(f) : queue.push(f)),
+            end: () => {
+                if (closed)
+                    return;
+                closed = true;
+                if (session !== null)
+                    this.ports.delete(session);
+                port.onclose?.();
+            },
+        };
+        return port;
+    }
+    /** @internal Privileged app subclass: current local session, never a caller
+     * guessed ID. Closed/foreign/uninitialized ports have no authority. */
+    sessionForPort(port) {
+        for (const [id, current] of this.ports)
+            if (current === port)
+                return id;
+        return null;
+    }
+    flush() {
+        const out = this.takeOut(this.x.rt_poll());
+        if (!out.length)
+            return;
+        const items = decode(out);
+        const ending = new Set(items.filter(item => item[1] === null)
+            .map(item => BigInt(item[0])));
+        for (const item of items) {
+            const [s, f] = item;
+            const port = this.ports.get(BigInt(s));
+            if (!port)
+                continue;
+            if (f === null)
+                port.end();
+            else {
+                const frame = decode(f);
+                if (ending.has(BigInt(s))) {
+                    // Native closes retain only their terminal problem. Deliver that
+                    // diagnostic BEFORE the facade ends; a queued microtask would lose
+                    // it behind the synchronous close and report only "fenced". Do not
+                    // let closing a session flush any other queued plaintext.
+                    if (frame instanceof Map) {
+                        const fields = frame;
+                        if (fields.get(0) === 2 && fields.get(1) === "closed")
+                            port.deliver(frame);
+                    }
+                }
+                else
+                    queueMicrotask(() => port.deliver(frame));
+            }
+        }
+    }
+    dispose() {
+        if (this.timer)
+            clearInterval(this.timer);
+        for (const p of [...this.ports.values()])
+            p.close();
+    }
+}
+//# sourceMappingURL=wasm.js.map

package/dist/runtime/wasm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wasm.js","sourceRoot":"","sources":["../../src/runtime/wasm.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAa,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AA0C1C,wDAAwD;AACxD,MAAM,OAAO,WAAW;IAKQ;IAJtB,KAAK,GAAG,IAAI,GAAG,EAAoE,CAAC;IACpF,KAAK,GAA0C,IAAI,CAAC;IACpD,MAAM,GAAG,KAAK,CAAC;IAEvB,YAA8B,QAAwB;QAAxB,aAAQ,GAAR,QAAQ,CAAgB;IAAG,CAAC;IAE1D,IAAc,CAAC;QACb,IAAI,CAAC,IAAI,CAAC,QAAQ;YAAE,MAAM,WAAW,CAAC,aAAa,EAAE,qDAAqD,CAAC,CAAC;QAC5G,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAES,OAAO;QACf,4EAA4E;QAC5E,0EAA0E;QAC1E,4EAA4E;QAC5E,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,IAAI,CAAC,KAAK;YAAE,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,KAAK,MAAM,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAAE,IAAI,CAAC,GAAG,EAAE,CAAC;QACxD,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;IACrB,CAAC;IAED,6EAA6E;IAC7E,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,KAAmB;QAC1C,OAAO,IAAI,WAAW,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IACjD,CAAC;IAED,mFAAmF;IACzE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAmB,EAAE,KAA6D;QAC5G,IAAI,MAAM,GAA8B,IAAI,CAAC;QAC7C,IAAI,OAAO,GAAmB,IAAI,CAAC;QACnC,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAC,GAAG,EAAE;YAC5B,IAAI,CAAC,OAAO;gBAAE,MAAM,WAAW,CAAC,aAAa,EAAE,8CAA8C,CAAC,CAAC;YAC/F,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,IAAI,EAAE,CAAC;QACT,MAAM,IAAI,GAAG,IAAI,WAAW,EAAE,CAAC;QAC/B,MAAM,GAAG,GAAG;YACV,sEAAsE;YACtE,yEAAyE;YACzE,YAAY,EAAE,CAAC,IAAY,EAAE,IAAY,EAAE,EAAE,CAAC,EAAE;YAChD,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;YAC7B,eAAe,EAAE,CAAC,EAAU,EAAE,KAAa,EAAE,KAAa,EAAE,GAAW,EAAE,EAAE;gBACzE,IAAI,CAAC;oBACH,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,MAAO,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;oBACrE,+BAA+B;oBAC/B,MAAM,CAAC,GAAG,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBAC3H,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC;wBAAE,OAAO,CAAC,CAAC;oBAC7C,IAAI,UAAU,CAAC,MAAO,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;oBACzE,OAAO,EAAE,CAAC;gBACZ,CAAC;gBAAC,MAAM,CAAC;oBACP,OAAO,CAAC,CAAC,CAAC,eAAe;gBAC3B,CAAC;YACH,CAAC;YACD,iBAAiB,EAAE,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE;gBAC9C,MAAM,CAAC,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,eAAe,EAAE,CAAC,QAAQ,IAAI,KAAK,CAAC,CAAC;gBAC9F,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;gBAClC,IAAI,UAAU,CAAC,MAAO,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;gBAC7D,OAAO,CAAC,CAAC;YACX,CAAC;YACD,WAAW,EAAE,CAAC,GAAW,EAAE,GAAW,EAAE,EAAE;gBACxC,6DAA6D;gBAC7D,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,MAAO,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;gBACtD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI,KAAK;oBAAE,UAAU,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;YACtG,CAAC;SACF,CAAC;QACF,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,WAAW,CAAC,WAAW,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,EAAE,GAAG,GAAG,EAAE,GAAG,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC5F,MAAM,CAAC,GAAG,QAAQ,CAAC,OAA6B,CAAC;QACjD,OAAO,GAAG,CAAC,CAAC;QACZ,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;QAClB,OAAO,CAAC,CAAC;IACX,CAAC;IAES,GAAG,CAAC,CAAa;QACzB,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAClC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;QACjC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACzD,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;IAES,OAAO,CAAC,MAAc;QAC9B,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC;QAClC,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,GAAG,WAAW,CAAC,CAAC;QACzC,IAAI,GAAG,KAAK,CAAC;YAAE,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC;QACnE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACzB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,IAAI;QACF,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAA2B,CAAC;QAC3E,MAAM,IAAI,GAAG,CAAC,CAAY,EAAE,EAAE;YAC5B,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAa,CAAC;YACrC,OAAO,EAAE,KAAK,EAAE,KAAM,EAAE,KAAK,EAAE,KAAM,EAAE,CAAC;QAC1C,CAAC,CAAC;QACF,OAAO;YACL,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAW;YAC5B,cAAc,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAW;YAClC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAE,CAAC;YACpB,MAAM,EAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAiB,CAAC,GAAG,CAAC,IAAI,CAAC;SAC5C,CAAC;IACJ,CAAC;IAED,wBAAwB;IACxB,IAAI,CAAC,CAAa;QAChB,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;QACjB,IAAI,IAAI,CAAC,MAAM;YAAE,MAAM,WAAW,CAAC,aAAa,EAAE,yBAAyB,CAAC,CAAC;QAC7E,MAAM,OAAO,GAAG,CAAC,CAAC,qBAAqB,CAAC;QACxC,IAAI,GAAuB,CAAC;QAC5B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,OAAO,KAAK,oBAAoB,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC9D,MAAM,WAAW,CAAC,iBAAiB,EAAE,iCAAiC,CAAC,CAAC;YAC1E,CAAC;YACD,IAAI,OAAO,CAAC,CAAC,eAAe,KAAK,UAAU,EAAE,CAAC;gBAC5C,MAAM,WAAW,CAAC,aAAa,EAAE,gEAAgE,CAAC,CAAC;YACrG,CAAC;YACD,GAAG,GAAG,OAAO,KAAK,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjD,CAAC;QACD,MAAM,GAAG,GAAG,YAAY,CACtB,IAAI,GAAG,CAAoB;YACzB,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;YAC9B,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;YAC7B,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;YAC5B,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACpC,CAAC,CAAC,EAAE,CAAC,CAAC,aAAa,CAAC;YACpB,CAAC,CAAC,EAAE,CAAC,CAAC,YAAY,CAAC;YACnB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,KAAK,CAAC;SACpB,CAAC,CACH,CAAC;QACF,IAAI,GAAe,CAAC;QACpB,IAAI,CAAC;YACH,0EAA0E;YAC1E,0EAA0E;YAC1E,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC5B,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,eAAgB,CAAC,GAAG,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;QAClG,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,MAAM,KAAK,CAAC;QACd,CAAC;gBAAS,CAAC;YACT,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACd,CAAC;QACD,IAAI,GAAG,CAAC,MAAM;YAAE,MAAM,WAAW,CAAC,aAAa,EAAE,2BAA2B,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC7G,IAAI,CAAC,UAAU,EAAE,CAAC;IACpB,CAAC;IAED,kFAAkF;IACxE,UAAU;QAClB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,IAAI,CAAC,KAAK,KAAK,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,CAAC;QACnD,IAAI,CAAC,KAAgC,CAAC,KAAK,EAAE,EAAE,CAAC;IACnD,CAAC;IAED,sBAAsB;IACtB,IAAI;QACF,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAC3B,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,gEAAgE;IAChE,OAAO,CAAC,IAA0D,EAAE;QAClE,IAAI,OAAO,GAAkB,IAAI,CAAC;QAClC,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,MAAM,KAAK,GAAgB,EAAE,CAAC;QAC9B,MAAM,IAAI,GAA6D;YACrE,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;gBACd,IAAI,MAAM;oBAAE,MAAM,WAAW,CAAC,aAAa,EAAE,aAAa,CAAC,CAAC;gBAC5D,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;gBAC5B,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;oBACrB,MAAM,KAAK,GACT,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;oBACzG,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAgB,CAAC;oBACzG,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAoB,CAAC,CAAC;oBAC5C,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAe,CAAC,CAAC;oBAC1C,cAAc,CAAC,GAAG,EAAE;wBAClB,IAAI,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC;wBACrB,IAAI,CAAC,KAAK,EAAE;4BAAE,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC3B,CAAC,CAAC,CAAC;oBACH,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;wBACb,OAAO,GAAG,CAAC,CAAC;wBACZ,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;wBACxB,IAAI,CAAC,KAAK,EAAE,CAAC;oBACf,CAAC;oBACD,OAAO;gBACT,CAAC;gBACD,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;gBAC7C,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,CAAC;YACD,KAAK,EAAE,GAAG,EAAE;gBACV,IAAI,MAAM;oBAAE,OAAO;gBACnB,MAAM,GAAG,IAAI,CAAC;gBACd,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;oBACrB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;oBAC3B,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBAC3B,CAAC;gBACD,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;YACnB,CAAC;YACD,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAChE,GAAG,EAAE,GAAG,EAAE;gBACR,IAAI,MAAM;oBAAE,OAAO;gBACnB,MAAM,GAAG,IAAI,CAAC;gBACd,IAAI,OAAO,KAAK,IAAI;oBAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBACjD,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;YACnB,CAAC;SACF,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;2EACuE;IAC7D,cAAc,CAAC,IAAe;QACtC,KAAK,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,OAAO,KAAK,IAAI;gBAAE,OAAO,EAAE,CAAC;QACxE,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,KAAK;QACX,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC3C,IAAI,CAAC,GAAG,CAAC,MAAM;YAAE,OAAO;QACxB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAgB,CAAC;QACzC,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAE,IAAoB,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;aAC3E,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAE,IAAgC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,IAA4C,CAAC;YAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YACvC,IAAI,CAAC,IAAI;gBAAE,SAAS;YACpB,IAAI,CAAC,KAAK,IAAI;gBAAE,IAAI,CAAC,GAAG,EAAE,CAAC;iBACtB,CAAC;gBACJ,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;gBACxB,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;oBAC1B,iEAAiE;oBACjE,mEAAmE;oBACnE,mEAAmE;oBACnE,0DAA0D;oBAC1D,IAAI,KAAK,YAAY,GAAG,EAAE,CAAC;wBACzB,MAAM,MAAM,GAAG,KAAkC,CAAC;wBAClD,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,QAAQ;4BAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;oBAC7E,CAAC;gBACH,CAAC;;oBAAM,cAAc,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;YACnD,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,KAAK;YAAE,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC1C,KAAK,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAAE,CAAC,CAAC,KAAK,EAAE,CAAC;IACtD,CAAC;CACF"}

package/dist/runtime-wire.d.ts

@@ -0,0 +1,71 @@
+import { type Codec } from "./codec.js";
+import { type BlobRef, type Hash, type Mutation, type Op, type Uuid } from "./wire.js";
+import { type AttachmentContentV1 } from "./attachment-wire.js";
+export { attachmentContentV1, attachmentRefV1 } from "./attachment-wire.js";
+export type { AttachmentContentV1, AttachmentRefV1 } from "./attachment-wire.js";
+export type FileAttach = {
+    kind: "file_attach";
+    id: Uuid;
+    path: string;
+    content: AttachmentContentV1;
+    ifRevision?: Hash;
+    base?: Hash;
+};
+export type FileContent = {
+    form: "blob";
+    blob: BlobRef;
+} | {
+    form: "attachment";
+    content: AttachmentContentV1;
+};
+/** Closed content union; unknown envelopes never become BlobRefs. */
+export declare const fileContent: Codec<FileContent>;
+export interface UnindexedMarkdownPayloadV1 {
+    content: FileContent;
+}
+/** Structural declaration only; neither UTF8 nor plaintext/authority proof. */
+export declare const unindexedMarkdownPayloadV1: Codec<UnindexedMarkdownPayloadV1>;
+export type RuntimeText = string | number;
+export type UnindexedMarkdownPut = {
+    kind: "unindexed_markdown_put";
+    id: Uuid;
+    path: string;
+    payload: UnindexedMarkdownPayloadV1;
+    expected?: UnindexedMarkdownPayloadV1;
+};
+export type RecordToUnindexedMarkdown = {
+    kind: "record_to_unindexed_markdown";
+    id: Uuid;
+    path: string;
+    payload: UnindexedMarkdownPayloadV1;
+    priorRevision: Hash;
+};
+export type UnindexedMarkdownToRecord = {
+    kind: "unindexed_markdown_to_record";
+    id: Uuid;
+    path: string;
+    doc: RuntimeText;
+    prior: UnindexedMarkdownPayloadV1;
+};
+export type OrdinaryFileToRecord = {
+    kind: "ordinary_file_to_record";
+    id: Uuid;
+    path: string;
+    doc: RuntimeText;
+    prior: FileContent;
+};
+export type OrdinaryAttachmentContinuation = {
+    kind: "ordinary_attachment_continuation";
+    id: Uuid;
+    path: string;
+    content: AttachmentContentV1;
+    prior: FileContent;
+};
+type ExtendedOp = OrdinaryAttachmentContinuation | FileAttach | UnindexedMarkdownPut | RecordToUnindexedMarkdown | UnindexedMarkdownToRecord | OrdinaryFileToRecord;
+export type RuntimeOp = Op | ExtendedOp;
+export declare const runtimeOp: Codec<RuntimeOp>;
+export type RuntimeMutation = Omit<Mutation, "ops"> & {
+    ops: RuntimeOp[];
+};
+/** Canonical parent keys unchanged; only the explicit operation family differs. */
+export declare const runtimeMutation: Codec<RuntimeMutation>;

package/dist/runtime-wire.js

@@ -0,0 +1,71 @@
+import { SchemaError, b16, b32, either, enumOf, hash, list, struct, tstr, uint, union, uuid } from "./codec.js";
+import { blobRef, conflictMode, op, opClock } from "./wire.js";
+import { attachmentContentV1 } from "./attachment-wire.js";
+export { attachmentContentV1, attachmentRefV1 } from "./attachment-wire.js";
+/** Closed content union; unknown envelopes never become BlobRefs. */
+export const fileContent = {
+    name: "file-content",
+    enc: v => v.form === "blob" ? blobRef.enc(v.blob) : attachmentContentV1.enc(v.content),
+    dec: c => Array.isArray(c) ? { form: "attachment", content: attachmentContentV1.dec(c) }
+        : { form: "blob", blob: blobRef.dec(c) },
+};
+function payloadSize(v) {
+    return v.content.form === "blob" ? v.content.blob.size : v.content.content.totalPlainBytes;
+}
+/** Structural declaration only; neither UTF8 nor plaintext/authority proof. */
+export const unindexedMarkdownPayloadV1 = {
+    name: "unindexed-markdown-payload-v1",
+    enc: v => {
+        if (payloadSize(v) <= 1_048_576)
+            throw new SchemaError("unindexed-markdown-payload-v1", "declared size must exceed record cap");
+        return [2, 1, 1, fileContent.enc(v.content)];
+    },
+    dec: c => {
+        const name = "unindexed-markdown-payload-v1";
+        if (!Array.isArray(c) || c.length !== 4)
+            throw new SchemaError(name, "must have exactly four elements");
+        if (uint.dec(c[0]) !== 2 || uint.dec(c[1]) !== 1 || uint.dec(c[2]) !== 1)
+            throw new SchemaError(name, "unknown discriminator/profile/kind", true);
+        const v = { content: fileContent.dec(c[3]) };
+        if (payloadSize(v) <= 1_048_576)
+            throw new SchemaError(name, "declared size must exceed record cap");
+        return v;
+    },
+};
+const runtimeText = either("text", tstr, (v) => typeof v === "string", c => typeof c === "string", uint);
+const extendedOp = union("extended-runtime-op", [
+    [13, "file_attach", [[1, "id", uuid], [2, "path", tstr], [3, "content", attachmentContentV1], [4, "ifRevision", hash, "opt"], [5, "base", hash, "opt"]]],
+    [14, "unindexed_markdown_put", [[1, "id", uuid], [2, "path", tstr], [3, "payload", unindexedMarkdownPayloadV1], [4, "expected", unindexedMarkdownPayloadV1, "opt"]]],
+    [15, "record_to_unindexed_markdown", [[1, "id", uuid], [2, "path", tstr], [3, "payload", unindexedMarkdownPayloadV1], [4, "priorRevision", hash]]],
+    [16, "unindexed_markdown_to_record", [[1, "id", uuid], [2, "path", tstr], [3, "doc", runtimeText], [4, "prior", unindexedMarkdownPayloadV1]]],
+    [18, "ordinary_attachment_continuation", [[1, "id", uuid], [2, "path", tstr], [3, "content", attachmentContentV1], [4, "prior", fileContent]]],
+    [17, "ordinary_file_to_record", [[1, "id", uuid], [2, "path", tstr], [3, "doc", runtimeText], [4, "prior", fileContent]]],
+]);
+function extended(v) {
+    return v.kind === "ordinary_attachment_continuation" || v.kind === "file_attach" || v.kind === "unindexed_markdown_put" || v.kind === "record_to_unindexed_markdown"
+        || v.kind === "unindexed_markdown_to_record" || v.kind === "ordinary_file_to_record";
+}
+export const runtimeOp = {
+    name: "runtime-v1-op",
+    enc: v => extended(v) ? extendedOp.enc(v) : op.enc(v),
+    dec: c => {
+        const tag = c instanceof Map ? uint.dec(c.get(0)) : undefined;
+        return tag !== undefined && tag >= 13 && tag <= 18 ? extendedOp.dec(c) : op.dec(c);
+    },
+};
+// The legacy wire exports the pending-evidence codec, which delegates to this
+// family. Delay its value references so either module may be imported first.
+function deferred(name, codec) {
+    return { name, enc: v => codec().enc(v), dec: c => codec().dec(c) };
+}
+/** Canonical parent keys unchanged; only the explicit operation family differs. */
+export const runtimeMutation = struct("runtime-v1-mutation", [
+    [0, "id", uuid], [1, "origin", uuid], [2, "baseSeq", uint],
+    [3, "clock", deferred("op-clock", () => opClock)],
+    [4, "seed", b32], [5, "source", enumOf("source", ["api", "external"])],
+    [6, "ops", list(runtimeOp, { nonEmpty: true }), "req1"],
+    [7, "onBehalf", uuid, "opt"], [8, "conflictMode", deferred("conflict-mode", () => conflictMode), "opt"],
+    [9, "validatedAt", enumOf("level", ["off", "warn", "error"]), "opt"],
+    [10, "room", struct("room-checkpoint", [[0, "stream", b16], [1, "state", hash]]), "opt"],
+]);
+//# sourceMappingURL=runtime-wire.js.map

package/dist/runtime-wire.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime-wire.js","sourceRoot":"","sources":["../src/runtime-wire.ts"],"names":[],"mappings":"AAKA,OAAO,EAAc,WAAW,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAC5H,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,OAAO,EAA8D,MAAM,WAAW,CAAC;AAE3H,OAAO,EAAE,mBAAmB,EAA4B,MAAM,sBAAsB,CAAC;AACrF,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAI5E,qEAAqE;AACrE,MAAM,CAAC,MAAM,WAAW,GAAuB;IAC7C,IAAI,EAAE,cAAc;IACpB,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC;IACtF,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;QACtF,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;CAC3C,CAAC;AAEF,SAAS,WAAW,CAAC,CAA6B;IAChD,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC;AAC7F,CAAC;AACD,+EAA+E;AAC/E,MAAM,CAAC,MAAM,0BAA0B,GAAsC;IAC3E,IAAI,EAAE,+BAA+B;IACrC,GAAG,EAAE,CAAC,CAAC,EAAE;QACP,IAAI,WAAW,CAAC,CAAC,CAAC,IAAI,SAAS;YAAE,MAAM,IAAI,WAAW,CAAC,+BAA+B,EAAE,sCAAsC,CAAC,CAAC;QAChI,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC/C,CAAC;IACD,GAAG,EAAE,CAAC,CAAC,EAAE;QACP,MAAM,IAAI,GAAG,+BAA+B,CAAC;QAC7C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC;YAAE,MAAM,IAAI,WAAW,CAAC,IAAI,EAAE,iCAAiC,CAAC,CAAC;QACxG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,KAAK,CAAC;YAAE,MAAM,IAAI,WAAW,CAAC,IAAI,EAAE,oCAAoC,EAAE,IAAI,CAAC,CAAC;QACrJ,MAAM,CAAC,GAAG,EAAE,OAAO,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,EAAE,CAAC;QAC9C,IAAI,WAAW,CAAC,CAAC,CAAC,IAAI,SAAS;YAAE,MAAM,IAAI,WAAW,CAAC,IAAI,EAAE,sCAAsC,CAAC,CAAC;QACrG,OAAO,CAAC,CAAC;IACX,CAAC;CACF,CAAC;AAEF,MAAM,WAAW,GAAG,MAAM,CAAiB,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,EAAE,IAAI,CAAC,CAAC;AAQtI,MAAM,UAAU,GAAG,KAAK,CAAa,qBAAqB,EAAE;IAC1D,CAAC,EAAE,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,mBAAmB,CAAC,EAAE,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IACxJ,CAAC,EAAE,EAAE,wBAAwB,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,0BAA0B,CAAC,EAAE,CAAC,CAAC,EAAE,UAAU,EAAE,0BAA0B,EAAE,KAAK,CAAC,CAAC,CAAC;IACpK,CAAC,EAAE,EAAE,8BAA8B,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,0BAA0B,CAAC,EAAE,CAAC,CAAC,EAAE,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC;IAClJ,CAAC,EAAE,EAAE,8BAA8B,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,0BAA0B,CAAC,CAAC,CAAC;IAC7I,CAAC,EAAE,EAAE,kCAAkC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,mBAAmB,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;IAC9I,CAAC,EAAE,EAAE,yBAAyB,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;CAC1H,CAAC,CAAC;AACH,SAAS,QAAQ,CAAC,CAAY;IAC5B,OAAO,CAAC,CAAC,IAAI,KAAK,kCAAkC,IAAI,CAAC,CAAC,IAAI,KAAK,aAAa,IAAI,CAAC,CAAC,IAAI,KAAK,wBAAwB,IAAI,CAAC,CAAC,IAAI,KAAK,8BAA8B;WAC/J,CAAC,CAAC,IAAI,KAAK,8BAA8B,IAAI,CAAC,CAAC,IAAI,KAAK,yBAAyB,CAAC;AACzF,CAAC;AACD,MAAM,CAAC,MAAM,SAAS,GAAqB;IACzC,IAAI,EAAE,eAAe;IACrB,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrD,GAAG,EAAE,CAAC,CAAC,EAAE;QACP,MAAM,GAAG,GAAG,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAE,CAA4B,CAAC,GAAG,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3F,OAAO,GAAG,KAAK,SAAS,IAAI,GAAG,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IACrF,CAAC;CACF,CAAC;AAEF,8EAA8E;AAC9E,6EAA6E;AAC7E,SAAS,QAAQ,CAAI,IAAY,EAAE,KAAqB;IACtD,OAAO,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;AACtE,CAAC;AACD,mFAAmF;AACnF,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAkB,qBAAqB,EAAE;IAC5E,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC;IAC1D,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,CAAC;IACjD,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,UAAU,CAAU,CAAC,CAAC;IAC/E,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC;IACvD,CAAC,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,cAAc,EAAE,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC;IACvG,CAAC,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAU,CAAC,EAAE,KAAK,CAAC;IAC7E,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAsC,iBAAiB,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;CAC9H,CAAC,CAAC"}

package/dist/saved-views.d.ts

@@ -0,0 +1,29 @@
+import type { MdbaseClient, RecordRef } from "./client.js";
+import type { Include, Issue, QueryResult, ViewSource, ViewSourceDocument } from "./wire.js";
+export declare const SAVED_VIEW_CONTRACT: Readonly<{
+    id: "mdbase.view";
+    version: "1.0.0";
+}>;
+export interface ListViewsResult {
+    sources: ViewSource[];
+    diagnostics: Issue[];
+    complete: boolean;
+}
+export interface ExecuteViewOptions {
+    context?: RecordRef;
+    limit?: number;
+    offset?: number;
+    timezone?: string;
+    include?: Include;
+    signal?: AbortSignal;
+}
+type Client = Pick<MdbaseClient, "queryContract" | "getContract" | "get" | "query">;
+/** Every `mdbase.view` source, ascending by path, then source-defined view order.
+ * A collection without the contract has no saved views. Invalid sources become
+ * warnings, never a partial descriptor. */
+export declare function listSavedViews(client: Client, folder?: string, signal?: AbortSignal): Promise<ListViewsResult>;
+/** Spec 11 named-view resolution, then one ordinary native query page. */
+export declare function executeSavedView(client: Client, source: RecordRef, viewId: string, o?: ExecuteViewOptions): Promise<QueryResult>;
+/** The complete current source document of one `mdbase.view` record. */
+export declare function readSavedViewSource(client: Client, source: RecordRef, signal?: AbortSignal): Promise<ViewSourceDocument>;
+export {};

package/dist/saved-views.js

@@ -0,0 +1,171 @@
+import { isMdbaseError, mdbaseError } from "./errors.js";
+export const SAVED_VIEW_CONTRACT = Object.freeze({ id: "mdbase.view", version: "1.0.0" });
+const map = (v) => v instanceof Map ? v : undefined;
+const text = (v) => typeof v === "string" ? v : undefined;
+const warning = (code, message, path) => ({ code, severity: "warning", message, details: new Map([["path", path]]) });
+const notFound = (e, path) => {
+    if (isMdbaseError(e, "not_found"))
+        throw mdbaseError("not_found", `saved view source '${path}' was not found`, "view_not_found");
+    throw e;
+};
+const refPath = (ref) => typeof ref === "string" ? ref : ref.path;
+function properties(record, view) {
+    const metadata = map(record.get("properties"));
+    const out = [];
+    const select = Array.isArray(view.get("select")) ? view.get("select") : [];
+    for (const selection of select) {
+        const object = map(selection);
+        const selector = text(selection);
+        const key = object ? text(object.get("name")) : selector?.slice(selector.lastIndexOf(".") + 1);
+        if (!key)
+            continue;
+        const meta = map(metadata?.get(object || !selector ? key : selector)) ?? map(metadata?.get(key));
+        const property = { key };
+        const label = text(object?.get("label")) ?? text(meta?.get("label"));
+        const description = text(object?.get("description")) ?? text(meta?.get("description"));
+        const format = text(meta?.get("format")), hidden = meta?.get("hidden");
+        if (label !== undefined)
+            property.label = label;
+        if (description !== undefined)
+            property.description = description;
+        if (format !== undefined)
+            property.format = format;
+        if (typeof hidden === "boolean")
+            property.hidden = hidden;
+        out.push(property);
+    }
+    return out;
+}
+/** Every `mdbase.view` source, ascending by path, then source-defined view order.
+ * A collection without the contract has no saved views. Invalid sources become
+ * warnings, never a partial descriptor. */
+export async function listSavedViews(client, folder, signal) {
+    const sources = [], diagnostics = [];
+    const prefix = folder ? folder.replace(/\/?$/, "/") : "";
+    let cursor, complete = true;
+    do {
+        let page;
+        try {
+            page = await client.queryContract(SAVED_VIEW_CONTRACT, { ...(cursor ? { cursor } : {}), ...(signal ? { signal } : {}) });
+        }
+        catch (e) {
+            if (isMdbaseError(e, "not_found") && e.reason === "data_contract_not_found")
+                return { sources, diagnostics, complete: true };
+            throw e;
+        }
+        complete &&= page.page.complete;
+        page.records.forEach((contract, i) => {
+            const record = page.page.records[i];
+            if (!record.path.startsWith(prefix))
+                return;
+            const projection = contract.implementations[0];
+            const invalid = projection?.issues.find(issue => issue.severity === "error");
+            if (!projection || invalid) {
+                diagnostics.push(warning("invalid_view", invalid?.message ?? "View record does not implement mdbase.view.", record.path));
+                return;
+            }
+            const fields = projection.fields, views = [], ids = new Set();
+            for (const item of Array.isArray(fields.get("views")) ? fields.get("views") : []) {
+                const view = map(item), id = text(view?.get("id")), name = text(view?.get("name"));
+                if (!view || !id || !name)
+                    continue;
+                if (ids.has(id)) {
+                    diagnostics.push(warning("invalid_view", "View record contains duplicate named-view IDs.", record.path));
+                    return;
+                }
+                ids.add(id);
+                const descriptor = { id, name, properties: properties(fields, view) };
+                if (view.has("presentation"))
+                    descriptor.presentation = view.get("presentation");
+                views.push(descriptor);
+            }
+            sources.push({
+                record: record.id,
+                id: text(fields.get("id")) ?? record.path,
+                name: text(fields.get("name")) ?? record.path,
+                source: { path: record.path, format: SAVED_VIEW_CONTRACT.id, revision: record.revision, writable: true },
+                views,
+            });
+        });
+        cursor = page.page.cursor;
+    } while (cursor);
+    sources.sort((a, b) => a.source.path < b.source.path ? -1 : a.source.path > b.source.path ? 1 : 0);
+    return { sources, diagnostics, complete };
+}
+/** Spec 11 named-view resolution, then one ordinary native query page. */
+export async function executeSavedView(client, source, viewId, o = {}) {
+    const signal = o.signal;
+    const record = await client.getContract(source, SAVED_VIEW_CONTRACT, signal).catch(e => notFound(e, refPath(source)));
+    const fields = record.fields, path = record.path;
+    const views = Array.isArray(fields.get("views")) ? fields.get("views").map(map) : [];
+    const ids = views.map(view => text(view?.get("id")));
+    if (new Set(ids).size !== ids.length)
+        throw mdbaseError("invalid_request", "View record contains duplicate named-view IDs.", "invalid_view");
+    const view = views[ids.indexOf(viewId)];
+    if (!view)
+        throw mdbaseError("not_found", `named view '${viewId}' was not found`, "view_not_found");
+    const shared = map(fields.get("query")) ?? new Map();
+    const query = new Map();
+    const types = view.get("types") ?? shared.get("types");
+    if (types !== undefined)
+        query.set("types", types);
+    const wheres = [text(shared.get("where")), text(view.get("where"))].filter((w) => !!w);
+    if (wheres.length)
+        query.set("where", wheres.length === 2 ? `(${wheres[0]}) && (${wheres[1]})` : wheres[0]);
+    const projections = new Map(map(shared.get("projections")));
+    for (const [name, definition] of map(view.get("projections")) ?? []) {
+        const existing = projections.get(name);
+        if (existing !== undefined && canonical(existing) !== canonical(definition))
+            throw mdbaseError("invalid_request", `Projection '${name}' has conflicting definitions.`, "invalid_view");
+        projections.set(name, definition);
+    }
+    if (projections.size)
+        query.set("projections", projections);
+    for (const key of ["select", "order_by", "group_by", "summaries", "limit", "offset", "include_body", "frontmatter_mode"])
+        if (view.has(key))
+            query.set(key, view.get(key));
+    if (fields.has("summary_functions"))
+        query.set("summary_functions", fields.get("summary_functions"));
+    if (o.limit !== undefined)
+        query.set("limit", o.limit);
+    if (o.offset !== undefined)
+        query.set("offset", o.offset);
+    if (o.timezone !== undefined)
+        query.set("timezone", o.timezone);
+    const declaration = map(map(view.get("context") ?? shared.get("context"))?.get("this"));
+    const onMissing = text(declaration?.get("on_missing")) ?? "view";
+    let context = o.context;
+    if (context === undefined && onMissing === "error")
+        throw mdbaseError("invalid_request", "This named view requires an invocation context.", "context_required");
+    if (context === undefined && onMissing === "view")
+        context = { path };
+    if (context !== undefined) {
+        const required = Array.isArray(declaration?.get("types")) ? declaration.get("types").filter((t) => typeof t === "string") : [];
+        let contextPath = typeof context === "string" ? undefined : context.path;
+        if (required.length || contextPath === undefined) {
+            const bound = await client.get(context, undefined, signal);
+            contextPath = bound.path;
+            if (required.length && !bound.types.some(t => required.some(r => r.toLowerCase() === t.toLowerCase())))
+                throw mdbaseError("invalid_request", "The invocation context does not match an allowed context type.", "context_type_mismatch");
+        }
+        query.set("context", new Map([["this", new Map([["path", contextPath]])]]));
+    }
+    const result = await client.query(query, o.include, signal);
+    return { ...result, view: { path, view: viewId } };
+}
+/** The complete current source document of one `mdbase.view` record. */
+export async function readSavedViewSource(client, source, signal) {
+    const contract = await client.getContract(source, SAVED_VIEW_CONTRACT, signal).catch(e => notFound(e, refPath(source)));
+    const record = await client.get(contract.id, { document: true }, signal);
+    if (record.revision !== contract.revision || typeof record.document !== "string")
+        throw mdbaseError("unavailable", "saved view source changed while it was read", "view_source_changed");
+    return { path: record.path, format: SAVED_VIEW_CONTRACT.id, revision: record.revision, document: record.document, record: record.id };
+}
+function canonical(v) {
+    if (v instanceof Map)
+        return `{${[...v].map(([k, x]) => [JSON.stringify(String(k)), canonical(x)]).sort((a, b) => a[0] < b[0] ? -1 : 1).map(([k, x]) => `${k}:${x}`).join(",")}}`;
+    if (Array.isArray(v))
+        return `[${v.map(canonical).join(",")}]`;
+    return typeof v === "bigint" ? `${v}n` : JSON.stringify(v instanceof Uint8Array ? [...v] : v);
+}
+//# sourceMappingURL=saved-views.js.map