@graview/core 0.1.10 → 0.1.12

package/dist/document/edit.js

@@ -66,7 +66,15 @@ const SHAPES = {
     "remove-act": z.object({ op: z.literal("remove-act"), act: actName }).strict(),
     "add-rule": z.object({ op: z.literal("add-rule"), rule: actName, replace: z.boolean().optional() }).passthrough(),
     "remove-rule": z.object({ op: z.literal("remove-rule"), rule: actName }).strict(),
-    "set-brand": z.object({ op: z.literal("set-brand"), accent: z.union([z.string(), z.null()]), name: z.string().min(1).max(60).optional() }).strict(),
+    "set-brand": z
+        .object({
+        op: z.literal("set-brand"),
+        accent: z.union([z.string(), z.null()]).optional(),
+        name: z.string().min(1).max(60).optional(),
+        currency: z.union([z.string(), z.null()]).optional(),
+        locale: z.union([z.string(), z.null()]).optional(),
+    })
+        .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).
@@ -148,6 +156,12 @@ function kindsOf(doc, e, ctx) {
             return kindsOf(doc, e.set, ctx);
         case "call": {
             const lit = e.args[0]?.t === "lit" && typeof e.args[0].value === "string" ? e.args[0].value : undefined;
+            // A walk from every member of a set (FR-101): its relation is its second word.
+            const walked = e.args.length === 2 && e.args[1]?.t === "lit" && typeof e.args[1].value === "string" ? e.args[1].value : undefined;
+            if (e.fn === "out" && walked)
+                return targets(doc, kindsOf(doc, e.args[0], ctx), walked);
+            if (e.fn === "in" && walked)
+                return sources(doc, walked);
             if (e.fn === "out" && lit)
                 return targets(doc, "*", lit);
             if (e.fn === "in" && lit)
@@ -212,6 +226,12 @@ function mapNames(doc, e, ctx, rename) {
                     const name = rename({ role: x.fn === "all" ? "kind" : "edge", kinds: NONE, name: literal });
                     args = name === literal ? [...x.args] : [{ ...first, value: name }];
                 }
+                else if ((x.fn === "out" || x.fn === "in") && x.args.length === 2 && x.args[1].t === "lit" && typeof x.args[1].value === "string") {
+                    // out(S, 'edge'): the set is read where the walk stands, and its relation renamed like any walk's (FR-101).
+                    const relation = x.args[1];
+                    const name = rename({ role: "edge", kinds: NONE, name: relation.value });
+                    args = [go(first, at), name === relation.value ? relation : { ...relation, value: name }];
+                }
                 else if (((x.fn === "every" || x.fn === "some") && x.args.length === 2) || (x.fn === "sort" && x.args.length >= 2)) {
                     // Read once per member, with the member as its subject: its names are the members'.
                     args = [go(x.args[0], at), go(x.args[1], kindsOf(doc, x.args[0], at)), ...x.args.slice(2).map((a) => go(a, at))];
@@ -499,16 +519,45 @@ class Editor {
                 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 this.doc.brand;
+                    delete brand["accent"];
                     this.said.push("The app goes back to Graview's colours.");
                 }
-                else {
+                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"');
-                    this.doc.brand = { accent: e.accent, ...(e.name ? { name: e.name } : this.doc.brand?.name ? { name: this.doc.brand.name } : {}) };
+                    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;
+                else
+                    this.doc.brand = brand;
                 return;
             }
             case "set-label": {
@@ -699,6 +748,8 @@ class Editor {
             if (!Array.isArray(e.options?.blocks) || e.options.blocks.length === 0)
                 return this.fail(i, "options.blocks", 'a lens drawn from blocks has blocks: "options": {"blocks": [{"headline": "…"}, {"list": "all(\'<kind>\')", "as": "card"}]}');
         }
+        if (name === "columns" && !this.columnsHold(i, e.bindings))
+            return;
         if (was)
             lenses[at] = lens;
         else
@@ -721,6 +772,35 @@ class Editor {
         }
         this.said.push(retitled ? `The lens "${String(was["title"])}" is now "${e.title}"${where}${follows}.` : `The lens "${e.title}" changes${where}.`);
     }
+    /**
+     * A STATUS BOARD'S BINDINGS (FR-97), held before it is added: each kind it
+     * binds is a kind, and its `column` is a field of that kind whose values
+     * are choices — the columns. Refused at the binding's path otherwise, so a
+     * chat is told which word to change rather than shown an empty board.
+     */
+    columnsHold(i, bindings) {
+        const example = '"bindings": {"<kind>": {"column": "<a choice field, like status>"}}';
+        if (!isObject(bindings) || Object.keys(bindings).length === 0)
+            return (this.fail(i, "bindings", "a board binds a kind's choice field to its columns", example), false);
+        for (const [kind, roles] of Object.entries(bindings)) {
+            if (!isObject(this.doc.kinds[kind]))
+                return (this.fail(i, `bindings.${kind}`, `"${kind}" is not a kind this app has; it has ${Object.keys(this.doc.kinds).join(", ")}`), false);
+            const field = isObject(roles) ? roles["column"] : undefined;
+            const fields = this.doc.kinds[kind].fields;
+            if (typeof field !== "string")
+                return (this.fail(i, `bindings.${kind}.column`, `the board does not say which field of ${kind} its columns are`, example), false);
+            if (!(field in fields))
+                return (this.fail(i, `bindings.${kind}.column`, `${kind} has no field "${field}"; it has ${Object.keys(fields).join(", ")}`), false);
+            if (fields[field]["type"] !== "enum") {
+                const choices = Object.keys(fields).filter((one) => fields[one]["type"] === "enum");
+                return (this.fail(i, `bindings.${kind}.column`, `${kind}'s ${field} is not a choice, so it has no columns`, choices.length > 0 ? `bind one of ${choices.join(", ")}` : `give ${kind} a choice field first: add-field with "type": "enum" and its "options", in the order the columns go`), false);
+            }
+            const others = Object.keys(roles).filter((role) => role !== "column");
+            if (others.length > 0)
+                return (this.fail(i, `bindings.${kind}.${others[0]}`, `a board binds only "column"`), false);
+        }
+        return true;
+    }
     removeLens(i, e) {
         const index = this.lensIndex(i, e.title, e.on);
         if (index < 0)
@@ -2064,6 +2144,9 @@ function rewriteBlock(doc, b, ctx, r, kind) {
             next[key] = rewriteTemplate(doc, next[key], ctx, r);
     if (typeof next["figure"] === "string")
         next["figure"] = rewriteExpr(doc, next["figure"], ctx, r);
+    // A figure's and a meter's label is a template (FR-99); a field's is words.
+    if ((typeof next["figure"] === "string" || "progress" in next) && typeof next["label"] === "string")
+        next["label"] = rewriteTemplate(doc, next["label"], ctx, r);
     if (typeof next["list"] === "string") {
         const members = listMembers(doc, next["list"], ctx);
         next["list"] = rewriteExpr(doc, next["list"], ctx, r);
@@ -2111,6 +2194,11 @@ function pruneBlock(doc, b, ctx, r, kind) {
         for (const k of ["value", "max"])
             if (exprMentions(doc, b["progress"][k], ctx, r))
                 return null;
+    // A label that says what is gone goes; the figure or meter stays (FR-99).
+    if ((typeof b["figure"] === "string" || "progress" in b) && typeof b["label"] === "string" && templateMentions(doc, b["label"], ctx, r)) {
+        const { label: _gone, ...kept } = b;
+        return kept;
+    }
     if (typeof b["list"] === "string") {
         if (exprMentions(doc, b["list"], ctx, r))
             return null;