@graview/core 0.1.28 → 0.1.30

package/dist/linked.js

@@ -0,0 +1,181 @@
+/**
+ * `@graview/core/linked` — RECORDS IN ANOTHER APP, READ AS THE VIEWER (FR-171).
+ *
+ * A relation may go to a kind in another app (`"to": ["@nick/house/house"]`);
+ * the record that links keeps which one (`house:h1`) and the host reads the
+ * far record as whoever is looking (`LinkedRecords`, on `@graview/core`).
+ * This entry is what a host and a face need beyond that, fetched when a
+ * link is first drawn or a host first serves one:
+ *
+ * - `linkedRecordsOver` — the host over apps it holds in memory: each far
+ *   record read through the far store's `seenBy(viewer)`, so a viewer is
+ *   told only what they may see there, and refused an app they may not
+ *   open. The tests read two compiled documents through it; a host serving
+ *   many apps answers the same shape from its own store.
+ * - `readLinkedRecord` — one record of a store, as a viewer is told it.
+ * - `linkedChange`, `recordLinkedChange` — a far value's change, kept in the
+ *   READING app's history: an op authored by the far app (`system`,
+ *   `app:<address>`, via `app:<address>`) on each record that links it,
+ *   naming what changed and nothing of its value.
+ * - `linkedRelationWords` — a relation to another app, said: what
+ *   `describe_app` and the agent's tools tell a model.
+ */
+// A host serves seats: a sight that hides a field shows the rest, never nothing (`@graview/core/field-sight`).
+import "./field-sight.js";
+import { labelOf } from "./schema/define-node.js";
+import { humanizeField } from "./schema/define-node.js";
+import { readableFields } from "./schema/reading.js";
+import { computedValues } from "./document/computed-values.js";
+import { linkedRelations, linkedRefsOf, linkedValue } from "./schema/linked.js";
+const asPrincipal = (viewer) => ({ kind: viewer.kind, ...(viewer.id === undefined ? {} : { id: viewer.id }), ...(viewer.roles ? { roles: viewer.roles } : {}) });
+const NOT_A_FIELD = new Set(["id", "kind"]);
+/**
+ * ONE RECORD OF A STORE, AS A VIEWER IS TOLD IT: read through the store's
+ * `seenBy(viewer)`, so a record they may not see is null and a field kept
+ * from them is not there — its label, its describe line, its card (a
+ * glance, field by field, in words) and its values, computed ones too.
+ */
+export function readLinkedRecord(store, ref, viewer, options = {}) {
+    const seen = store.seenBy(asPrincipal(viewer));
+    const node = seen.graph.getNode(ref.id);
+    if (!node || node.kind !== ref.kind)
+        return null;
+    return recordOf(seen, node, ref.address, options);
+}
+function recordOf(seen, node, address, options) {
+    const definition = seen.schema.tryDefinition(node.kind);
+    const { values } = computedValues(seen.schema, seen.graph, node);
+    const fields = {};
+    for (const [key, value] of Object.entries(node))
+        if (!NOT_A_FIELD.has(key) && value !== undefined)
+            fields[key] = value;
+    for (const [key, value] of Object.entries(values))
+        fields[key] = typeof value === "object" && value !== null && !Array.isArray(value) ? value.label : value;
+    const label = labelOf(definition, node);
+    const describe = definition?.describe?.(node)?.trim();
+    const card = readableFields(node, definition, { glance: true, limit: 4, said: [label] })
+        .filter((field) => !field.files && !field.app)
+        .map((field) => ({ label: field.label, text: field.value }));
+    return {
+        address,
+        kind: node.kind,
+        id: node.id,
+        label,
+        ...(describe ? { describe } : {}),
+        ...(card.length > 0 ? { card } : {}),
+        fields,
+        ...(options.href ? { href: options.href } : {}),
+        ...(options.app ? { app: options.app } : {}),
+    };
+}
+/**
+ * THE HOST, OVER APPS IT HOLDS IN MEMORY (FR-171): every answer as the
+ * viewer. An address it does not hold, or a record not there for this
+ * viewer, is null; an app the viewer may not open is `{ denied: true }`,
+ * for a record and for a search alike — nothing of it is said.
+ */
+export function linkedRecordsOver(homes, options = {}) {
+    const homeOf = (address) => (Object.hasOwn(homes, address) ? homes[address] : undefined);
+    return {
+        async resolve(ref, viewer) {
+            const home = homeOf(ref.address);
+            if (!home)
+                return null;
+            if (home.opens && !home.opens(viewer))
+                return { denied: true };
+            return readLinkedRecord(home.store, ref, viewer, { ...(home.href ? { href: home.href(ref) } : {}), ...(home.name ? { app: home.name } : {}) });
+        },
+        async find(search, viewer) {
+            const home = homeOf(search.address);
+            if (!home)
+                return [];
+            if (home.opens && !home.opens(viewer))
+                return { denied: true };
+            const seen = home.store.seenBy(asPrincipal(viewer));
+            const words = search.query.trim().toLowerCase();
+            const found = [];
+            for (const kind of search.kinds) {
+                for (const node of seen.graph.nodesOfKind(kind)) {
+                    if (found.length >= search.limit)
+                        break;
+                    const label = labelOf(seen.schema.tryDefinition(kind), node);
+                    if (words && !label.toLowerCase().includes(words))
+                        continue;
+                    const ref = { address: search.address, kind, id: node.id };
+                    found.push(recordOf(seen, node, search.address, { ...(home.href ? { href: home.href(ref) } : {}), ...(home.name ? { app: home.name } : {}) }));
+                }
+            }
+            return found;
+        },
+        ...(options.open ? { open: options.open } : {}),
+    };
+}
+/** The fields whose values differ between two readings of one far record, in the order the later one holds them. */
+export function linkedChange(before, after) {
+    const keys = [...new Set([...Object.keys(after.fields), ...Object.keys(before.fields)])];
+    return keys.filter((key) => JSON.stringify(before.fields[key]) !== JSON.stringify(after.fields[key]));
+}
+/** The records of a store that link a far record, and the relation each links it by. */
+export function recordsLinking(store, ref) {
+    const kept = linkedValue(ref);
+    const found = [];
+    for (const kind of store.schema.kinds) {
+        for (const [relation, link] of linkedRelations(store.schema.tryDefinition(kind))) {
+            if (link.address !== ref.address || !link.kinds.includes(ref.kind))
+                continue;
+            for (const node of store.graph.nodesOfKind(kind, { archived: "all" })) {
+                if (linkedRefsOf(node[relation], link).some((one) => linkedValue(one) === kept))
+                    found.push({ id: node["id"], relation });
+            }
+        }
+    }
+    return found;
+}
+/**
+ * A FAR VALUE'S CHANGE, KEPT IN THE READING APP'S HISTORY (FR-171): one op
+ * on each record that links the far record, in one batch, authored by the
+ * far app — `{ kind: "system", id: "app:<address>", name }`, via
+ * `app:<address>` — saying which of its fields changed and nothing of
+ * their values, which are the far app's to show to whoever may see them.
+ * It reads the linking record and writes nothing: the reading app's own
+ * values are as they were, and its Activity and the record's history say
+ * "Buy it outright: the linked house changed in House — list price".
+ * Nothing is kept when no record links it or nothing changed.
+ */
+export function recordLinkedChange(store, change) {
+    if (change.fields.length === 0)
+        return [];
+    const linking = recordsLinking(store, change.ref);
+    if (linking.length === 0)
+        return [];
+    const app = change.app ?? change.ref.address;
+    const what = change.fields.map((field) => humanizeField(field).toLowerCase()).join(", ");
+    const author = { kind: "system", id: `app:${change.ref.address}`, name: app };
+    return store.append(linking.map(({ id }) => {
+        const node = store.graph.getNode(id);
+        const label = node ? labelOf(store.schema.tryDefinition(node.kind), node) : id;
+        return {
+            primitives: [],
+            author,
+            // The far kind's noun is its own app's: the record is said as the link it is.
+            intent: `${label}: the linked record changed in ${app} — ${what}`,
+            reads: [id],
+            writes: [],
+            via: `app:${change.ref.address}`,
+            ...(change.at ? { at: change.at } : {}),
+        };
+    }));
+}
+/**
+ * A RELATION TO ANOTHER APP, SAID — for `describe_app`, the agent's tools and
+ * a person reading the declaration: where it goes, how many, and how one is
+ * linked. "forHouse → one house in the app @nick/house (another app; link
+ * one by setting forHouse to "house:<id>", an id the host's search finds)".
+ */
+export function linkedRelationWords(name, relation, editAct) {
+    const kinds = relation.kinds.join(" or ");
+    const many = relation.cardinality === "many";
+    const how = `link ${many ? "them" : "one"} by setting ${name} to ${many ? "a list of " : ""}"${relation.kinds[0]}:<id>"${editAct ? ` with ${editAct}` : ""}, an id found in that app (find_linked)`;
+    return `${name} → ${many ? "records of" : "one"} ${kinds} in the app ${relation.address} (another app, read as the viewer; ${how})`;
+}
+//# sourceMappingURL=linked.js.map

package/dist/linked.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"linked.js","sourceRoot":"","sources":["../src/linked.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,+GAA+G;AAC/G,OAAO,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,yBAAyB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,WAAW,EAAuL,MAAM,oBAAoB,CAAC;AAqBrQ,MAAM,WAAW,GAAG,CAAC,MAAoB,EAAa,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAc,CAAC;AAEvM,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AAE5C;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAuB,EAAE,GAAoB,EAAE,MAAoB,EAAE,UAA6D,EAAE;IACnK,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAyE,CAAC;IAChH,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI;QAAE,OAAO,IAAI,CAAC;IACjD,OAAO,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,QAAQ,CAAC,IAAsB,EAAE,IAA4D,EAAE,OAAe,EAAE,OAA0D;IACjL,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAkC,CAAC;IACzF,MAAM,EAAE,MAAM,EAAE,GAAG,cAAc,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,KAAc,EAAE,IAAa,CAAC,CAAC;IACnF,MAAM,MAAM,GAA4B,EAAE,CAAC;IAC3C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;QAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACvH,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,MAAM,CAAC,GAAG,CAAC,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAE,KAA2B,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IACnL,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IACxC,MAAM,QAAQ,GAAI,UAAgE,EAAE,QAAQ,EAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC;IAC7G,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC;SACrF,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;SAC7C,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC/D,OAAO;QACL,OAAO;QACP,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,KAAK;QACL,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjC,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACpC,MAAM;QACN,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/C,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC7C,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAA2C,EAAE,UAAqD,EAAE;IACpI,MAAM,MAAM,GAAG,CAAC,OAAe,EAA0B,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACzH,OAAO;QACL,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM;YACvB,MAAM,IAAI,GAAG,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACjC,IAAI,CAAC,IAAI;gBAAE,OAAO,IAAI,CAAC;YACvB,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;gBAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;YAC/D,OAAO,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QACjJ,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM;YACvB,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YACpC,IAAI,CAAC,IAAI;gBAAE,OAAO,EAAE,CAAC;YACrB,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;gBAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;YAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;YACpD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;YAChD,MAAM,KAAK,GAAmB,EAAE,CAAC;YACjC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBAChC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAa,CAA0E,EAAE,CAAC;oBAClI,IAAI,KAAK,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK;wBAAE,MAAM;oBACxC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAkC,EAAE,IAAI,CAAC,CAAC;oBAC9F,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC;wBAAE,SAAS;oBAC5D,MAAM,GAAG,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;oBAC3D,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;gBACjJ,CAAC;YACH,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAChD,CAAC;AACJ,CAAC;AAED,oHAAoH;AACpH,MAAM,UAAU,YAAY,CAAC,MAAoB,EAAE,KAAmB;IACpE,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACzF,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;AACxG,CAAC;AAaD,wFAAwF;AACxF,MAAM,UAAU,cAAc,CAAC,KAAuB,EAAE,GAAoB;IAC1E,MAAM,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;IAC9B,MAAM,KAAK,GAAuC,EAAE,CAAC;IACrD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,KAA0B,EAAE,CAAC;QAC3D,KAAK,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,eAAe,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACjF,IAAI,IAAI,CAAC,OAAO,KAAK,GAAG,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC;gBAAE,SAAS;YAC7E,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,IAAa,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAyC,EAAE,CAAC;gBACvH,IAAI,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;oBAAE,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,IAAI,CAAW,EAAE,QAAQ,EAAE,CAAC,CAAC;YACtI,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAuB,EAAE,MAAoB;IAC9E,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAC1C,MAAM,OAAO,GAAG,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC;IAClD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACpC,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC;IAC7C,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACzF,MAAM,MAAM,GAAG,EAAE,IAAI,EAAE,QAAiB,EAAE,EAAE,EAAE,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC;IACvF,OAAO,KAAK,CAAC,MAAM,CACjB,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;QACrB,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAyE,CAAC;QAC7G,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAkC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAChH,OAAO;YACL,UAAU,EAAE,EAAE;YACd,MAAM;YACN,8EAA8E;YAC9E,MAAM,EAAE,GAAG,KAAK,kCAAkC,GAAG,MAAM,IAAI,EAAE;YACjE,KAAK,EAAE,CAAC,EAAE,CAAC;YACX,MAAM,EAAE,EAAE;YACV,GAAG,EAAE,OAAO,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE;YAChC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACxC,CAAC;IACJ,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAY,EAAE,QAAwB,EAAE,OAAgB;IAC1F,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,IAAI,GAAG,QAAQ,CAAC,WAAW,KAAK,MAAM,CAAC;IAC7C,MAAM,GAAG,GAAG,QAAQ,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,eAAe,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,OAAO,CAAC,CAAC,CAAC,SAAS,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,yCAAyC,CAAC;IACpM,OAAO,GAAG,IAAI,MAAM,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,eAAe,QAAQ,CAAC,OAAO,sCAAsC,GAAG,GAAG,CAAC;AACtI,CAAC"}

package/dist/markdown.d.ts

@@ -0,0 +1,102 @@
+/**
+ * `@graview/core/markdown` — PROSE WRITTEN IN MARKDOWN, READ SAFELY (FR-180).
+ *
+ * A text field may say it is written in Markdown (`markdownField()`,
+ * `{"type": "text", "format": "markdown"}`). This reads one into blocks and
+ * runs of words a face draws as elements — the routed face through React
+ * (`@graview/primitives`, fetched with the first Markdown a record draws),
+ * a static page as HTML (`markdownHtml`). Its own entry: nothing a page
+ * draws first reads Markdown.
+ *
+ * What it reads, and nothing else:
+ *
+ *   # … ######            a heading, demoted under the page's own
+ *   a blank line          a new paragraph; a single line break is kept
+ *   - * + / 1. 1)         a list, nested by indenting; [ ] and [x] said as ☐ ☑
+ *   > …                   a quotation
+ *   ``` or ~~~            a block of code, as written
+ *   --- *** ___           a rule
+ *   | a | b | + |---|     a table
+ *   **strong** *em* _em_ ~~struck~~ `code`
+ *   [words](https://…)    a link — http, https and mailto only; any other
+ *                         address (javascript:, data:, a relative path) is
+ *                         its words, not a link
+ *   <https://…>, https://…  an address, as a link
+ *   ![words](…)           NOT a picture: its words, a link where the address
+ *                         is http(s). A record's pictures are an image
+ *                         field's, which the host stored (FR-162)
+ *   \*  &amp; &#169;      an escape, an entity: the character
+ *
+ * NO HTML PASSES THROUGH. A tag is its letters; every word is text a face
+ * writes as text (React's text nodes, `escapeHtml` here), so a value can
+ * never become markup, a script or a handler, whatever it holds.
+ *
+ * Linear in what it reads: each line is read once, an inline mark looks for
+ * its closing mark once (a mark with none is remembered as having none), and
+ * nesting stops at a depth where it is words again.
+ */
+/** A run of words, as a face draws it. */
+export type MarkdownInline = {
+    readonly t: "text";
+    readonly text: string;
+} | {
+    readonly t: "br";
+} | {
+    readonly t: "code";
+    readonly text: string;
+} | {
+    readonly t: "strong" | "em" | "del";
+    readonly children: readonly MarkdownInline[];
+} | {
+    readonly t: "link";
+    readonly href: string;
+    readonly children: readonly MarkdownInline[];
+};
+/** A block of a Markdown text. */
+export type MarkdownBlock = {
+    readonly t: "heading";
+    readonly level: number;
+    readonly children: readonly MarkdownInline[];
+} | {
+    readonly t: "p";
+    readonly children: readonly MarkdownInline[];
+} | {
+    readonly t: "list";
+    readonly ordered: boolean;
+    readonly start: number;
+    readonly items: readonly (readonly MarkdownBlock[])[];
+} | {
+    readonly t: "quote";
+    readonly blocks: readonly MarkdownBlock[];
+} | {
+    readonly t: "code";
+    readonly text: string;
+    readonly lang?: string;
+} | {
+    readonly t: "rule";
+} | {
+    readonly t: "table";
+    readonly align: readonly ("left" | "center" | "right" | undefined)[];
+    readonly head: readonly (readonly MarkdownInline[])[];
+    readonly rows: readonly (readonly (readonly MarkdownInline[])[])[];
+};
+/** The blocks a Markdown text is written in. */
+export declare function markdownBlocks(text: string): readonly MarkdownBlock[];
+/** The addresses a link may go to: the web and mail. Anything else is its words. */
+export declare function safeHref(address: string): string | undefined;
+/** A paragraph's words: emphasis, code, links, breaks and escapes, every other character text. */
+export declare function inlineOf(source: string, depth: number): MarkdownInline[];
+/** A text as HTML writes it: every character that could start markup, escaped. */
+export declare function escapeHtml(text: string): string;
+/** Options for drawing Markdown as HTML or elements. */
+export interface MarkdownDrawing {
+    /** The level a Markdown "#" is drawn at: a record's page's own heading and section are above it. 3 when unsaid. */
+    readonly headingsFrom?: number;
+    /** Where a link opens: `_blank` (a new tab, the default) or `_self`. */
+    readonly target?: "_blank" | "_self";
+}
+/** The heading level a Markdown heading of `level` is drawn at, under the page's own. */
+export declare const headingLevel: (level: number, from?: number) => number;
+/** A Markdown text as HTML: escaped words in the elements it reads, and nothing else (a static page's). */
+export declare function markdownHtml(text: string, drawing?: MarkdownDrawing): string;
+//# sourceMappingURL=markdown.d.ts.map

package/dist/markdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../src/markdown.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AAEH,0CAA0C;AAC1C,MAAM,MAAM,cAAc,GACtB;IAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC7C;IAAE,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAA;CAAE,GACpB;IAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC7C;IAAE,QAAQ,CAAC,CAAC,EAAE,QAAQ,GAAG,IAAI,GAAG,KAAK,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,cAAc,EAAE,CAAA;CAAE,GACrF;IAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,cAAc,EAAE,CAAA;CAAE,CAAC;AAEhG,kCAAkC;AAClC,MAAM,MAAM,aAAa,GACrB;IAAE,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,cAAc,EAAE,CAAA;CAAE,GAC/F;IAAE,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC;IAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,cAAc,EAAE,CAAA;CAAE,GACjE;IAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,SAAS,aAAa,EAAE,CAAC,EAAE,CAAA;CAAE,GAChI;IAAE,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,aAAa,EAAE,CAAA;CAAE,GAClE;IAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACrE;IAAE,QAAQ,CAAC,CAAC,EAAE,MAAM,CAAA;CAAE,GACtB;IAAE,QAAQ,CAAC,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,CAAC,EAAE,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,cAAc,EAAE,CAAC,EAAE,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,SAAS,CAAC,SAAS,cAAc,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;CAAE,CAAC;AA2D7N,gDAAgD;AAChD,wBAAgB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,aAAa,EAAE,CAErE;AAiGD,oFAAoF;AACpF,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAK5D;AAkBD,kGAAkG;AAClG,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,cAAc,EAAE,CAgJxE;AAoBD,kFAAkF;AAClF,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE/C;AAED,wDAAwD;AACxD,MAAM,WAAW,eAAe;IAC9B,mHAAmH;IACnH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,wEAAwE;IACxE,QAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;CACtC;AAED,yFAAyF;AACzF,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,EAAE,aAAQ,KAAG,MAAuC,CAAC;AAuD/F,2GAA2G;AAC3G,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,eAAoB,GAAG,MAAM,CAEhF"}