@graview/core 0.1.28 → 0.1.30

package/dist/schema/linked.js

@@ -0,0 +1,151 @@
+import { isAppAddress } from "./app-address.js";
+/*
+ * Nothing of zod here: the rule language reads a link through this module,
+ * and a page that judges a rule carries no zod for it. A schema's
+ * definition is read where zod keeps it; the schema a link is kept in is
+ * `linked-schema.ts`'s.
+ */
+const defOf = (schema) => typeof schema === "object" && schema !== null ? schema._zod?.def : undefined;
+/*
+ * A RELATION TO A KIND IN ANOTHER APP (FR-171, the full relation).
+ *
+ * 0.1.29's `app-link` field named another app. This names a RECORD there:
+ * a relation whose `to` is `@<app address>/<kind>` —
+ *
+ *   "edges": { "forHouse": { "to": ["@nick/house/house"], "cardinality": "one" } }
+ *
+ * — and linking one picks a record in that app; the far document is never
+ * touched. The record that links keeps which one, as a value of its own
+ * (`house:h1`, the far kind and its id), so the edit that sets it, its undo,
+ * its history and who may see it are the reading app's like any field's.
+ * What the far record IS — its card, its describe line, the fields this
+ * viewer may see there — is the host's to say, as the viewer
+ * (`LinkedRecords`); a viewer who may not open the far app sees "linked
+ * record (no access)" and nothing of it.
+ *
+ * This module is what a page builds a document's fields with, and what the
+ * rule language reads a link through, so it holds that and no more. What
+ * draws one is `@graview/primitives`'s, fetched with the first one drawn;
+ * the in-memory host, the history of a far change and the words for a
+ * relation are `@graview/core/linked`'s.
+ */
+/** A kind in another app, as a relation's `to` names it: `@` + the app's address + `/` + the kind. */
+export const LINKED_TARGET = /^@(?:https?:\/\/[^\s<>"'`\\#?]+|[A-Za-z0-9][\w.~-]*(?:\/[\w.~-]+)*)\/[a-z][a-z0-9]*(?:-[a-z0-9]+)*$/;
+/**
+ * THE APP AND THE KIND A RELATION'S TARGET NAMES — or undefined when it names
+ * a kind of this document. The address is what an app-link field would
+ * hold for that app: `@nick/house/house` is the kind `house` of `@nick/house`;
+ * `@app_kf5eydr9z58jzf/house` of the app with that id; `@https://x.dev/a/house`
+ * of the app at `https://x.dev/a`.
+ */
+export function parseLinkedTarget(target) {
+    if (typeof target !== "string" || !target.startsWith("@") || !LINKED_TARGET.test(target))
+        return undefined;
+    const cut = target.lastIndexOf("/");
+    const body = target.slice(0, cut);
+    const kind = target.slice(cut + 1);
+    // `@owner/app` keeps its @, as an app-link holds it; an id or an http(s) address does not have one.
+    const address = /^@https?:\/\//.test(body) || !body.includes("/") ? body.slice(1) : body;
+    return isAppAddress(address) ? { address, kind } : undefined;
+}
+/** Whether a relation's target is a kind in another app. */
+export const isLinkedTarget = (target) => typeof target === "string" && parseLinkedTarget(target) !== undefined;
+/*
+ * WHAT A LINK KEEPS: `<kind>:<id>` — the far kind and the id its app knows
+ * it by. A kind is a word with no colon, so the first colon divides them.
+ */
+const KEPT = /^[a-z][a-z0-9]*(?:-[a-z0-9]+)*:\S[^\n]{0,199}$/;
+/** What a link keeps for a far record: `house:h1`. */
+export const linkedValue = (ref) => `${ref.kind}:${ref.id}`;
+/** The far record a kept value names, read against its relation; undefined when it names none. */
+export function linkedRefOf(value, relation) {
+    if (typeof value !== "string" || !KEPT.test(value))
+        return undefined;
+    const at = value.indexOf(":");
+    const kind = value.slice(0, at);
+    return relation.kinds.includes(kind) ? { address: relation.address, kind, id: value.slice(at + 1) } : undefined;
+}
+/** Every far record a link's value names — one, or each of many — in order. */
+export function linkedRefsOf(value, relation) {
+    const values = Array.isArray(value) ? value : value === undefined || value === null ? [] : [value];
+    return values.flatMap((one) => {
+        const ref = linkedRefOf(one, relation);
+        return ref ? [ref] : [];
+    });
+}
+/*
+ * WHICH FIELDS HOLD A LINK TO ANOTHER APP: a mark on the schema's def, as an
+ * app-link is marked, carrying the relation — so a clone shares it, a
+ * wrapper holds it inside, and every face, tool and checker reads the
+ * relation from the field the record keeps it in.
+ */
+const LINKED = Symbol.for("@graview/core:linked");
+/** Marks a schema as holding links to records of another app. */
+export const markLinked = (schema, relation) => (Object.defineProperty(defOf(schema), LINKED, { value: relation, enumerable: true }), schema);
+/** The relation to another app a field holds — under optional, default and nullable — or undefined. */
+export function linkedRelationOf(schema) {
+    const def = defOf(schema);
+    return def ? (def[LINKED] ?? linkedRelationOf(def.innerType)) : undefined;
+}
+/** A definition's relations to other apps, by the field each is kept in. */
+export function linkedRelations(definition) {
+    const shape = definition?.fields?.shape ?? {};
+    const found = new Map();
+    for (const [field, schema] of Object.entries(shape)) {
+        const relation = linkedRelationOf(schema);
+        if (relation)
+            found.set(field, relation);
+    }
+    return found;
+}
+/**
+ * The relation to another app a document's relation declares, or undefined
+ * for one within the document. Only a relation whose every target is a kind
+ * of ONE other app is one (`graview check` says `linked-mixed` and
+ * `linked-apps` of the rest).
+ */
+export function linkedRelationOfSpec(edge) {
+    if (edge.to === "*" || edge.to.length === 0)
+        return undefined;
+    const targets = edge.to.map(parseLinkedTarget);
+    if (targets.some((target) => !target))
+        return undefined;
+    const address = targets[0].address;
+    if (targets.some((target) => target.address !== address))
+        return undefined;
+    return { address, kinds: [...new Set(targets.map((target) => target.kind))], cardinality: edge.cardinality ?? "many", ...(edge.description ? { description: edge.description } : {}) };
+}
+/** Whether a document's relation reaches out of the document at all: any of its targets names another app. */
+export const reachesAnotherApp = (edge) => edge.to !== "*" && edge.to.some((target) => typeof target === "string" && target.startsWith("@"));
+/** A document kind's relations within the document, its relations to other apps aside. */
+export function localEdges(edges) {
+    return Object.fromEntries(Object.entries(edges ?? {}).filter(([, edge]) => !reachesAnotherApp(edge)));
+}
+/** A document kind's relations to other apps, by name. */
+export function linkedEdges(edges) {
+    const found = new Map();
+    for (const [name, edge] of Object.entries(edges ?? {})) {
+        const relation = linkedRelationOfSpec(edge);
+        if (relation)
+            found.set(name, relation);
+    }
+    return found;
+}
+/*
+ * WHERE A GRAPH'S FAR RECORDS ARE READ FROM, for whoever is looking at it:
+ * a page registers its store's graph once, with the reader of its viewer,
+ * and every computed field, rule and template judged over that graph walks
+ * a link through it. A seat's own graph (`store.seenBy`) is registered by
+ * whoever serves the seat. A graph with none reads every far record unread.
+ */
+const READERS = new WeakMap();
+/** Read far records through `reader` for every expression judged over `graph`; undefined stops. */
+export function readLinkedThrough(graph, reader) {
+    if (reader)
+        READERS.set(graph, reader);
+    else
+        READERS.delete(graph);
+}
+/** The reader a graph's far records are read through, if any. */
+export const linkedReaderOf = (graph) => READERS.get(graph);
+//# sourceMappingURL=linked.js.map

package/dist/schema/linked.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"linked.js","sourceRoot":"","sources":["../../src/schema/linked.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,KAAK,GAAG,CAAC,MAAe,EAA4C,EAAE,CAC1E,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,CAAC,CAAC,CAAE,MAA4D,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;AAEtI;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,sGAAsG;AACtG,MAAM,CAAC,MAAM,aAAa,GAAG,qGAAqG,CAAC;AAEnI;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,SAAS,CAAC;IAC3G,MAAM,GAAG,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAClC,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IACnC,oGAAoG;IACpG,MAAM,OAAO,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzF,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED,4DAA4D;AAC5D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAe,EAAoB,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,iBAAiB,CAAC,MAAM,CAAC,KAAK,SAAS,CAAC;AAoB3I;;;GAGG;AACH,MAAM,IAAI,GAAG,gDAAgD,CAAC;AAE9D,sDAAsD;AACtD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,GAAyC,EAAU,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE,EAAE,CAAC;AAE1G,kGAAkG;AAClG,MAAM,UAAU,WAAW,CAAC,KAAc,EAAE,QAAmD;IAC7F,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IACrE,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAC9B,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAChC,OAAO,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;AAClH,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,YAAY,CAAC,KAAc,EAAE,QAAmD;IAC9F,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACnG,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QAC5B,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QACvC,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1B,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;AAElD,iEAAiE;AACjE,MAAM,CAAC,MAAM,UAAU,GAAG,CAAmB,MAAS,EAAE,QAAwB,EAAK,EAAE,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,MAAM,CAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC;AAEvL,uGAAuG;AACvG,MAAM,UAAU,gBAAgB,CAAC,MAAe;IAC9C,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAmE,CAAC;IAC5F,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,gBAAgB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC5E,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,eAAe,CAAC,UAAqD;IACnF,MAAM,KAAK,GAAI,UAAU,EAAE,MAA0D,EAAE,KAAK,IAAI,EAAE,CAAC;IACnG,MAAM,KAAK,GAAG,IAAI,GAAG,EAA0B,CAAC;IAChD,KAAK,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACpD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,QAAQ;YAAE,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AASD;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAsB;IACzD,IAAI,IAAI,CAAC,EAAE,KAAK,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;IAC/C,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC;QAAE,OAAO,SAAS,CAAC;IACxD,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC;IACpC,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAO,CAAC,OAAO,KAAK,OAAO,CAAC;QAAE,OAAO,SAAS,CAAC;IAC5E,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,MAAM,EAAE,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC;AAC1L,CAAC;AAED,8GAA8G;AAC9G,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,IAAsB,EAAW,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,GAAG,IAAI,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;AAExK,0FAA0F;AAC1F,MAAM,UAAU,UAAU,CAA6B,KAA8C;IACnG,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACxG,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,WAAW,CAAC,KAA6D;IACvF,MAAM,KAAK,GAAG,IAAI,GAAG,EAA0B,CAAC;IAChD,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC;QACvD,MAAM,QAAQ,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,QAAQ;YAAE,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAqED;;;;;;GAMG;AACH,MAAM,OAAO,GAAG,IAAI,OAAO,EAAwB,CAAC;AAEpD,mGAAmG;AACnG,MAAM,UAAU,iBAAiB,CAAC,KAAa,EAAE,MAAgC;IAC/E,IAAI,MAAM;QAAE,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;;QAClC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC7B,CAAC;AAED,iEAAiE;AACjE,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,KAAa,EAA4B,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC"}

package/dist/schema/markdown-field.d.ts

@@ -0,0 +1,4 @@
+import { z } from "zod";
+/** A text field whose value is Markdown: at most 20,000 characters. */
+export declare function markdownField(): z.ZodString;
+//# sourceMappingURL=markdown-field.d.ts.map

package/dist/schema/markdown-field.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-field.d.ts","sourceRoot":"","sources":["../../src/schema/markdown-field.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAiBxB,uEAAuE;AACvE,wBAAgB,aAAa,IAAI,CAAC,CAAC,SAAS,CAE3C"}

package/dist/schema/markdown-field.js

@@ -0,0 +1,20 @@
+import { z } from "zod";
+import { markMarkdown } from "./markdown.js";
+/*
+ * PROSE WRITTEN IN MARKDOWN (FR-180), in the classic zod a product writes
+ * its kinds in, so it chains like any other field:
+ *
+ *   fields: z.object({
+ *     title: z.string(),
+ *     body: markdownField().optional(),
+ *   })
+ *
+ * A document says the same as `{"type": "text", "format": "markdown"}`: up
+ * to 20,000 characters, asked for in a text area, drawn as prose on the
+ * record's page and said as an excerpt everywhere else.
+ */
+/** A text field whose value is Markdown: at most 20,000 characters. */
+export function markdownField() {
+    return markMarkdown(z.string().max(20_000));
+}
+//# sourceMappingURL=markdown-field.js.map

package/dist/schema/markdown-field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-field.js","sourceRoot":"","sources":["../../src/schema/markdown-field.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C;;;;;;;;;;;;GAYG;AAEH,uEAAuE;AACvE,MAAM,UAAU,aAAa;IAC3B,OAAO,YAAY,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;AAC9C,CAAC"}

package/dist/schema/markdown.d.ts

@@ -0,0 +1,6 @@
+export declare const MARKDOWN: unique symbol;
+/** Marks a schema as holding Markdown. */
+export declare const markMarkdown: <T extends object>(schema: T) => T;
+/** Whether a field holds Markdown — under optional, default and nullable. */
+export declare function isMarkdownField(schema: unknown): boolean;
+//# sourceMappingURL=markdown.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../src/schema/markdown.ts"],"names":[],"mappings":"AAmBA,eAAO,MAAM,QAAQ,eAAuC,CAAC;AAE7D,0CAA0C;AAC1C,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,MAAM,EAAE,QAAQ,CAAC,KAAG,CAAyE,CAAC;AAErI,6EAA6E;AAC7E,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAGxD"}

package/dist/schema/markdown.js

@@ -0,0 +1,27 @@
+import { defOf } from "./zod.js";
+/*
+ * A TEXT FIELD WRITTEN IN MARKDOWN (FR-180).
+ *
+ * A document says `{"type": "text", "format": "markdown"}`; TypeScript says
+ * `markdownField()`. The value is kept as written — the Markdown, not a
+ * rendering of it — and the mark is on the schema's def, as a file field's
+ * is (`files.ts`), so a clone shares it, a refinement spreads it and a
+ * wrapper holds it inside. The record's page draws it as prose; a list, a
+ * card, a describe line and a search hit say its start with the syntax
+ * taken out (`excerptOf`).
+ *
+ * A hosted page builds a document's fields up front, and a module both its
+ * first chunk and a fetched one reach is a chunk of its own: so a
+ * document's field is marked where it is built (`fieldSchema`, by the same
+ * `Symbol.for`), and this is reached only by what declares, draws or
+ * describes a record.
+ */
+export const MARKDOWN = Symbol.for("@graview/core:markdown");
+/** Marks a schema as holding Markdown. */
+export const markMarkdown = (schema) => ((defOf(schema)[MARKDOWN] = 1), schema);
+/** Whether a field holds Markdown — under optional, default and nullable. */
+export function isMarkdownField(schema) {
+    const def = defOf(schema);
+    return !!def && (def[MARKDOWN] === 1 || isMarkdownField(def.innerType));
+}
+//# sourceMappingURL=markdown.js.map

package/dist/schema/markdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown.js","sourceRoot":"","sources":["../../src/schema/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;AAE7D,0CAA0C;AAC1C,MAAM,CAAC,MAAM,YAAY,GAAG,CAAmB,MAAS,EAAK,EAAE,CAAC,CAAC,CAAE,KAAK,CAAC,MAAM,CAA6B,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;AAErI,6EAA6E;AAC7E,MAAM,UAAU,eAAe,CAAC,MAAe;IAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAwD,CAAC;IACjF,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;AAC1E,CAAC"}

package/dist/schema/reading.d.ts

@@ -0,0 +1,86 @@
+import { type ReadableField } from "./define-node.js";
+import type { AnyNodeDefinition } from "./types.js";
+/**
+ * WHAT TELLS TWO SAME-NAMED THINGS APART, among the nodes a person is
+ * choosing from. A single and its album are both "Blue Hour", and every
+ * picker, every ask and the Find strip listed "Blue Hour, Blue Hour": a
+ * choice nobody could make. For each node whose name another in the list
+ * shares, the first fact that differs between them — "single" and "album",
+ * or the dates — else its kind, else its id. Nodes with a name of their
+ * own get nothing.
+ */
+export declare function tellApart(nodes: readonly ({
+    id: string;
+    kind: string;
+} & Record<string, unknown>)[], definitionOf: (kind: string) => AnyNodeDefinition | undefined): Map<string, string>;
+/** Resolves a node's prose description, used for a11y and tool text. */
+export declare function describeNode(definition: AnyNodeDefinition | undefined, node: {
+    id: string;
+    kind: string;
+} & Record<string, unknown>): string;
+/**
+ * WHICH of a node's fields a person sees, and HOW each one reads.
+ *
+ * One implementation, because there were two: the record on a page and the
+ * summary on a card each decided this for themselves, and every rule — hide an
+ * ordering key, format minutes as a time, render a boolean as a word, drop a
+ * value the heading already said — had to be written into both and kept in
+ * step by hand. They diverged the day the second one was written, which is how
+ * a summary card ended up showing a list's ordering key as a chip reading "0"
+ * while the page beside it did not.
+ *
+ * `said` is what the surrounding view has already put on screen. A value the
+ * heading already carries is not information twice, it is the same sentence
+ * twice — and where the heading is a SHORTENED form of a field, an exact
+ * comparison never catches it, so the summary's stem is compared too.
+ */
+export declare function readableFields(node: Record<string, unknown>, definition: AnyNodeDefinition | undefined, options?: {
+    /** How many a GLANCE shows. Unset, every field: a record is read whole (W-156). */
+    readonly limit?: number;
+    readonly said?: readonly (string | undefined)[];
+    /**
+     * A GLANCE drops a value the heading already says as a WORD, not only as
+     * the whole heading: a vehicle's summary is headed "2027 Subaru Forester
+     * Sport", and "Year 2027 · Subaru" under it spent two of its three facts
+     * saying the heading again while the price never appeared. A record's
+     * full facts keep every field — that is where each is changed.
+     */
+    readonly glance?: boolean;
+    /**
+     * PROSE SAID BY ITS START (FR-180): a long text or Markdown read as its
+     * first paragraph, line or about 160 characters, the syntax taken out.
+     * A glance always is; a line about a record (a seat's answer, a table's
+     * cell) asks for it without a glance's choice of fields.
+     */
+    readonly excerpt?: boolean;
+    /** The app's locale its days are said in (FR-178): a reader's a host passed wins, and the page's when unsaid. */
+    readonly locale?: string | undefined;
+}): readonly ReadableField[];
+/**
+ * WHETHER A FIELD'S VALUE IS PROSE (FR-147): a string field declared to hold
+ * more than 500 characters — a document's `text`, or `z.string().max(5000)`
+ * in TypeScript — whatever it holds now, so an empty draft is still edited
+ * in a text area; or a value with a line break in it, or longer than 160
+ * characters.
+ */
+export declare function isLongText(definition: AnyNodeDefinition | undefined, key: string, value: unknown): boolean;
+/** One run of a record's facts: under a group's title, or (the first) under none. */
+export interface FieldSection<F extends {
+    readonly key: string;
+} = ReadableField> {
+    readonly title?: string;
+    readonly fields: readonly F[];
+}
+/**
+ * A RECORD'S FACTS, IN THE SECTIONS ITS PAGE DECLARES (FR-148).
+ *
+ * `fields` are read as `readableFields` ordered them. Unsaid, one untitled
+ * section of all of them. With `display.page`, its `fields` first, untitled;
+ * each of its `groups` under its title; and what neither names under
+ * "Details" when there are groups, else after the first fields. A section
+ * with nothing to show is left out.
+ */
+export declare function pageSections<F extends {
+    readonly key: string;
+}>(definition: AnyNodeDefinition | undefined, fields: readonly F[]): readonly FieldSection<F>[];
+//# sourceMappingURL=reading.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"reading.d.ts","sourceRoot":"","sources":["../../src/schema/reading.ts"],"names":[],"mappings":"AACA,OAAO,EAA+B,KAAK,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAYnF,OAAO,KAAK,EAAE,iBAAiB,EAAc,MAAM,YAAY,CAAC;AAWhE;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,SAAS,CAAC;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,EAC1E,YAAY,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,iBAAiB,GAAG,SAAS,GAC5D,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CA8BrB;AAGD,wEAAwE;AACxE,wBAAgB,YAAY,CAC1B,UAAU,EAAE,iBAAiB,GAAG,SAAS,EACzC,IAAI,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC3D,MAAM,CAKR;AAcD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC7B,UAAU,EAAE,iBAAiB,GAAG,SAAS,EACzC,OAAO,GAAE;IACP,mFAAmF;IACnF,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC;IAChD;;;;;;OAMG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAC3B,iHAAiH;IACjH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACjC,GACL,SAAS,aAAa,EAAE,CAkI1B;AA4DD;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,UAAU,EAAE,iBAAiB,GAAG,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAI1G;AAED,qFAAqF;AACrF,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS;IAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG,aAAa;IAC9E,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC;CAC/B;AAED;;;;;;;;GAQG;AACH,wBAAgB,YAAY,CAAC,CAAC,SAAS;IAAE,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CAAE,EAAE,UAAU,EAAE,iBAAiB,GAAG,SAAS,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,GAAG,SAAS,YAAY,CAAC,CAAC,CAAC,EAAE,CAa5J"}