@graview/core 0.1.14 → 0.1.16

package/dist/document/edit.js

@@ -9,8 +9,12 @@ import { ActSpec, EDGE_NAME, EdgeSpec, FIELD_NAME, FIELD_TYPES, FieldSpec, KindS
 import { SHIPPED_LENSES, isShippedLens, SHIPPED_LENS_NAMES } from "../places.js";
 import { placeSlug } from "../views/types.js";
 import { computedOf, validateComputed } from "./computed.js";
-import { parseTemplate, templateBraces, TemplateError } from "./template.js";
+import { parseTemplate, templateBraces, TemplateError } from "./template-parse.js";
 import { validateViews, VIEW_SLOTS } from "./views.js";
+import { brandFindings } from "./brand-check.js";
+import { canonicalize } from "./canonical.js";
+import { quotedAtTheEnd } from "./quote.js";
+import { accentProblem } from "../theme/accent.js";
 /** The ops, for tool schemas and the guide. */
 export const EDIT_OPS = [
     "add-kind",
@@ -32,6 +36,8 @@ export const EDIT_OPS = [
     "add-rule",
     "remove-rule",
     "set-brand",
+    "set-name",
+    "set-description",
     "set-label",
     "set-describe",
     "set-view",
@@ -74,11 +80,20 @@ const SHAPES = {
         .object({
         op: z.literal("set-brand"),
         accent: z.union([z.string(), z.null()]).optional(),
-        name: z.string().min(1).max(60).optional(),
+        name: z.union([z.string().min(1).max(60), z.null()]).optional(),
         currency: z.union([z.string(), z.null()]).optional(),
         locale: z.union([z.string(), z.null()]).optional(),
+        // The rest of the brand (FR-124, FR-125): each as the document holds it, null to clear it.
+        logo: z.union([z.string().min(1), z.object({ src: z.string().min(1), alt: z.string().min(1).max(120).optional() }).strict(), z.null()]).optional(),
+        favicon: z.union([z.string().min(1), z.null()]).optional(),
+        typography: z.union([z.object({ display: z.union([z.string().min(1).max(200), z.null()]).optional(), body: z.union([z.string().min(1).max(200), z.null()]).optional(), mono: z.union([z.string().min(1).max(200), z.null()]).optional() }).strict(), z.null()]).optional(),
+        shape: z.union([z.object({ radius: z.union([z.number().min(0).max(32), z.null()]).optional(), density: z.union([z.number().min(0.75).max(1.5), z.null()]).optional() }).strict(), z.null()]).optional(),
+        accents: z.union([z.record(z.string(), z.union([z.number().min(0).max(360), z.null()])), z.null()]).optional(),
+        scheme: z.union([z.enum(["light", "dark", "auto"]), z.null()]).optional(),
     })
         .strict(),
+    "set-name": z.object({ op: z.literal("set-name"), name: z.string().min(1).max(80) }).strict(),
+    "set-description": z.object({ op: z.literal("set-description"), description: z.union([z.string().min(1).max(500), z.null()]) }).strict(),
     "set-label": z.object({ op: z.literal("set-label"), kind: kindName, field: fieldName.optional(), label: z.union([z.string().min(1).max(300), z.null()]) }).strict(),
     "set-describe": z.object({ op: z.literal("set-describe"), kind: kindName, describe: z.union([z.string().min(1).max(300), z.null()]) }).strict(),
     // A kind's slot; the front page (`slot: "home"`, no kind); or a blocks lens's blocks, by its title (FR-84).
@@ -104,6 +119,7 @@ const SHAPES = {
         order: z.union([z.array(kindName).max(40), z.null()]).optional(),
         hide: z.union([z.array(kindName).max(40), z.null()]).optional(),
         first: z.union([z.string().min(1).max(80), z.null()]).optional(),
+        overview: z.union([z.string().min(1).max(40), z.null()]).optional(),
     })
         .strict(),
     "set-computed": z
@@ -395,6 +411,7 @@ function setTargets(act, doc) {
 // ── the edits ────────────────────────────────────────────────────────────────
 class Editor {
     doc;
+    options;
     said = [];
     /** The agent tools this change renames or reshapes: a model that listed them before calls what is gone. */
     toolsMoved = new Set();
@@ -404,8 +421,9 @@ class Editor {
     kindOrigin = new Map();
     fieldOrigin = new Map();
     edgeOrigin = new Map();
-    constructor(doc, base) {
+    constructor(doc, base, options = {}) {
         this.doc = doc;
+        this.options = options;
         for (const [kind, spec] of Object.entries(base.kinds)) {
             this.kindOrigin.set(kind, kind);
             for (const f of Object.keys(spec.fields))
@@ -417,6 +435,128 @@ class Editor {
     fail(i, path, message, fix) {
         this.findings.push(error("edit", `edits.${i}${path ? `.${path}` : ""}`, message, fix));
     }
+    /**
+     * THE BRAND, KEY BY KEY (FR-100, FR-124, FR-125): what an edit names is
+     * set, null clears it, and what it does not name stays as it was. Each
+     * is judged as `graview check` judges it — a mark that could act or load,
+     * a face off the list — and an accent that does not read as given is
+     * refused with the pair, the ratio and a shade that would (FR-126).
+     */
+    setBrand(i, e) {
+        const brand = clone(this.doc.brand ?? {});
+        const at = `edits.${i}`;
+        // An edit that names nothing to change is refused, never applied with nothing said.
+        const named = Object.keys(e).filter((key) => key !== "op" && e[key] !== undefined);
+        if (named.length === 0)
+            return this.fail(i, "", "a set-brand edit names at least one key of the brand to set, or null to clear one", '{"op": "set-brand", "accent": "#0f6e5c"}');
+        const emptyPart = ["typography", "shape", "accents"].find((key) => isObject(e[key]) && Object.keys(e[key]).length === 0);
+        if (emptyPart)
+            return this.fail(i, emptyPart, `${emptyPart} names no part to set; name one, or give null to clear all of it`);
+        const judged = brandFindings({ ...(typeof e.logo === "string" || isObject(e.logo) ? { logo: e.logo } : {}), ...(typeof e.favicon === "string" ? { favicon: e.favicon } : {}), ...(isObject(e.typography) ? { typography: Object.fromEntries(Object.entries(e.typography).filter(([, v]) => typeof v === "string")) } : {}) }, { at, ...(this.options.fonts ? { fonts: this.options.fonts } : {}) });
+        if (judged.length > 0)
+            return void this.findings.push(...judged);
+        if (e.accent === null) {
+            delete brand["accent"];
+            this.said.push("The app goes back to Graview's colors.");
+        }
+        else if (e.accent !== undefined) {
+            if (!/^#[0-9a-fA-F]{6}$/.test(e.accent))
+                return this.fail(i, "accent", 'an accent is a color like "#c2577a"');
+            const refused = accentProblem(e.accent);
+            if (refused)
+                return this.fail(i, "accent", refused.sentence, refused.suggestion ? `{"op": "set-brand", "accent": "${refused.suggestion}"}` : "pick a color of another hue");
+            brand["accent"] = e.accent;
+            this.said.push(`The app's accent color becomes ${e.accent}.`);
+        }
+        if (e.currency === null) {
+            delete brand["currency"];
+            this.said.push("Money is said with no currency.");
+        }
+        else if (e.currency !== undefined) {
+            if (!/^[A-Z]{3}$/.test(e.currency))
+                return this.fail(i, "currency", 'a currency is its three-letter code, like "USD" or "EUR"');
+            brand["currency"] = e.currency;
+            this.said.push(`Money is said in ${e.currency}.`);
+        }
+        if (e.locale === null)
+            delete brand["locale"];
+        else if (e.locale !== undefined) {
+            if (!/^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$/.test(e.locale))
+                return this.fail(i, "locale", 'a locale is a language tag, like "en-US" or "de-DE"');
+            brand["locale"] = e.locale;
+            this.said.push(`Money is written for ${e.locale}.`);
+        }
+        if (e.name === null) {
+            delete brand["name"];
+            this.said.push("The wordmark says the app's name.");
+        }
+        else if (e.name !== undefined) {
+            brand["name"] = e.name;
+            this.said.push(`The app's wordmark says ${e.name}.`);
+        }
+        for (const [key, what] of [["logo", "logo"], ["favicon", "page icon"]]) {
+            if (e[key] === undefined)
+                continue;
+            const was = brand[key];
+            if (e[key] === null)
+                delete brand[key];
+            else
+                brand[key] = e[key];
+            const src = (mark) => (typeof mark === "string" ? mark : isObject(mark) ? mark["src"] : undefined);
+            const alt = (mark) => (isObject(mark) && typeof mark["alt"] === "string" ? mark["alt"] : undefined);
+            if (e[key] === null)
+                this.said.push(`The app has no ${what}.`);
+            else if (was === undefined)
+                this.said.push(`The app gets a ${what}.`);
+            else if (canonicalize(was) === canonicalize(e[key]))
+                this.said.push(`The ${what} stays as it was.`);
+            else if (src(was) === src(e[key]))
+                this.said.push(`The ${what} is said as ${quotedAtTheEnd(alt(e[key]) ?? brand["name"] ?? this.doc.name)}`);
+            else
+                this.said.push(`The ${what} changes.`);
+        }
+        const merge = (key, say, cleared) => {
+            if (e[key] === undefined)
+                return;
+            if (e[key] === null) {
+                delete brand[key];
+                this.said.push(cleared);
+                return;
+            }
+            const into = { ...(brand[key] ?? {}) };
+            for (const [part, value] of Object.entries(e[key])) {
+                if (value === null)
+                    delete into[part];
+                else
+                    into[part] = value;
+                this.said.push(say(part, value));
+            }
+            if (Object.keys(into).length === 0)
+                delete brand[key];
+            else
+                brand[key] = into;
+        };
+        const ROLE = { display: "Headings", body: "Body text", mono: "Code" };
+        merge("typography", (role, value) => (value === null ? `${ROLE[role]} go${role === "display" ? "" : "es"} back to Graview's face.` : `${ROLE[role]} ${role === "display" ? "are" : "is"} now set in ${value}.`), "Words go back to Graview's faces.");
+        merge("shape", (part, value) => (part === "radius" ? (value === null ? "Corners go back to Graview's own." : `Corners are now ${value}px.`) : value === null ? "Spacing goes back to Graview's own." : `Spacing is now ${value} times Graview's own.`), "Corners and spacing go back to Graview's own.");
+        if (isObject(e.accents)) {
+            const unknown = Object.keys(e.accents).find((kind) => !this.doc.kinds[kind]);
+            if (unknown)
+                return this.fail(i, "accents", `"${unknown}" is not a kind this app has; it has ${Object.keys(this.doc.kinds).join(", ")}`);
+        }
+        merge("accents", (kind, hue) => (hue === null ? `${cap(kind)} goes back to its own hue.` : `${cap(kind)} is drawn at hue ${hue}°.`), "Every kind goes back to its own hue.");
+        if (e.scheme !== undefined) {
+            if (e.scheme === null || e.scheme === "auto")
+                delete brand["scheme"];
+            else
+                brand["scheme"] = e.scheme;
+            this.said.push(e.scheme === "light" || e.scheme === "dark" ? `The app opens ${e.scheme} when the reader has not chosen.` : "The app follows the reader's system for light and dark.");
+        }
+        if (Object.keys(brand).length === 0)
+            delete this.doc.brand;
+        else
+            this.doc.brand = brand;
+    }
     kind(i, kind) {
         const spec = this.doc.kinds[kind];
         if (!spec)
@@ -532,46 +672,23 @@ class Editor {
                 this.said.push(`The rule "${title}" is removed.`);
                 return;
             }
-            case "set-brand": {
-                // The colours and the money (FR-100) are set apart: what an edit does not name stays as it was.
-                const brand = { ...(this.doc.brand ?? {}) };
-                if (e.accent === null) {
-                    delete brand["accent"];
-                    this.said.push("The app goes back to Graview's colours.");
-                }
-                else if (e.accent !== undefined) {
-                    if (!/^#[0-9a-fA-F]{6}$/.test(e.accent))
-                        return this.fail(i, "accent", 'an accent is a colour like "#c2577a"');
-                    brand["accent"] = e.accent;
-                    this.said.push(`The app's accent colour becomes ${e.accent}.`);
-                }
-                if (e.currency === null) {
-                    delete brand["currency"];
-                    this.said.push("Money is said with no currency.");
-                }
-                else if (e.currency !== undefined) {
-                    if (!/^[A-Z]{3}$/.test(e.currency))
-                        return this.fail(i, "currency", 'a currency is its three-letter code, like "USD" or "EUR"');
-                    brand["currency"] = e.currency;
-                    this.said.push(`Money is said in ${e.currency}.`);
-                }
-                if (e.locale === null)
-                    delete brand["locale"];
-                else if (e.locale !== undefined) {
-                    if (!/^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})*$/.test(e.locale))
-                        return this.fail(i, "locale", 'a locale is a language tag, like "en-US" or "de-DE"');
-                    brand["locale"] = e.locale;
-                    this.said.push(`Money is written for ${e.locale}.`);
-                }
-                if (e.name) {
-                    brand["name"] = e.name;
-                    this.said.push(`The app's wordmark says ${e.name}.`);
-                }
-                // A brand that holds only a name holds nothing to apply.
-                if (Object.keys(brand).every((key) => key === "name"))
-                    delete this.doc.brand;
+            case "set-brand":
+                return this.setBrand(i, e);
+            case "set-name": {
+                const already = this.doc.name === e.name;
+                this.doc.name = e.name;
+                this.said.push(already ? `The app is already called ${quotedAtTheEnd(e.name)}` : `The app is now called ${quotedAtTheEnd(e.name)}`);
+                return;
+            }
+            case "set-description": {
+                const already = (this.doc.description ?? null) === e.description;
+                if (e.description === null)
+                    delete this.doc.description;
                 else
-                    this.doc.brand = brand;
+                    this.doc.description = e.description;
+                this.said.push(e.description === null
+                    ? already ? "The app already has no line under its name." : "The app has no line under its name."
+                    : already ? `The line under the app's name already reads ${quotedAtTheEnd(e.description)}` : `The line under the app's name reads ${quotedAtTheEnd(e.description)}`);
                 return;
             }
             case "set-label": {
@@ -823,8 +940,8 @@ class Editor {
         this.said.push(`${cap(said.replace(/ \(the app opens at its home again\)$/, ""))} is removed${said.endsWith("again)") ? "; the app opens at its home again" : ""}.`);
     }
     arrangePages(i, e) {
-        if (e.order === undefined && e.hide === undefined && e.first === undefined)
-            return this.fail(i, "", 'arrange-pages says at least one of "order", "hide" or "first"');
+        if (e.order === undefined && e.hide === undefined && e.first === undefined && e.overview === undefined)
+            return this.fail(i, "", 'arrange-pages says at least one of "order", "hide", "first" or "overview"');
         const kinds = Object.keys(this.doc.kinds);
         for (const part of ["order", "hide"]) {
             for (const [n, kind] of (e[part] ?? []).entries()) {
@@ -873,6 +990,17 @@ class Editor {
                 said.push(`the app opens on "${e.first}"`);
             }
         }
+        if (e.overview !== undefined) {
+            // What the scene is called on the bar (FR-132); its address stays /places/overview.
+            if (e.overview === null || e.overview.trim() === "" || e.overview.trim() === "Overview") {
+                delete pages.overview;
+                said.push("the overview is called Overview");
+            }
+            else {
+                pages.overview = e.overview.trim();
+                said.push(`the overview is called "${pages.overview}"`);
+            }
+        }
         if (Object.keys(pages).length === 0)
             delete this.doc.pages;
         this.said.push(`${cap(listOf(said))}.`);
@@ -2277,7 +2405,7 @@ function pruneBlock(doc, b, ctx, r, kind) {
  * `edits.<i>.…`) and no document. The result is NOT compiled here: the caller
  * previews it like any other proposed document.
  */
-export function editDocument(document, edits) {
+export function editDocument(document, edits, options = {}) {
     if (!Array.isArray(edits))
         return { ok: false, findings: [error("edit", "edits", "edits are a list, like [{\"op\": \"add-field\", …}]")] };
     // No edits is no change: the document as it was, and nothing said.
@@ -2285,7 +2413,7 @@ export function editDocument(document, edits) {
         return { ok: true, document: clone(document), said: [], fills: [] };
     if (edits.length > MAX_EDITS)
         return { ok: false, findings: [error("edit", "edits", `at most ${MAX_EDITS} edits at once`)] };
-    const editor = new Editor(clone(document), document);
+    const editor = new Editor(clone(document), document, options);
     edits.forEach((raw, i) => {
         if (editor.findings.length > 0)
             return;