@wildwinter/toolkit 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @wildwinter/toolkit
 
+## 0.3.1
+
+### Added
+
+- **Requirements in a manifest** (`./extensions`): `requires` names the other extensions, by id, that a project must
+  take for this one to work. The manifest check holds it to ids, each once, never the extension's own.
+  `missingRequirements(manifest, taken)` lists those a project lacks, for a host's Add Extension, its validation,
+  and its views.
+- **A view as a field's editor** (`./extensions`): a target's own map of records can name one of the manifest's views
+  as its `editor`, which a host opens in place of its own record grid. The check holds it to a declared view that
+  opens in that host, and warns of one on any other kind of field, where it means nothing.
+
 ## 0.3.0
 
 ### Removed

package/conformance/extensions/manifest.json

@@ -1619,6 +1619,281 @@
           "severity": "warning"
         }
       ]
+    },
+    {
+      "name": "requires and a field's editor pass",
+      "manifest": {
+        "schema": "wildwinter/extension@0",
+        "id": "probe",
+        "name": "Probe",
+        "version": "1.0.0",
+        "targets": {
+          "patter": {
+            "line": {
+              "fields": [
+                {
+                  "name": "performance",
+                  "type": "map",
+                  "key": {
+                    "type": "text"
+                  },
+                  "of": {
+                    "type": "record",
+                    "fields": [
+                      {
+                        "name": "look",
+                        "type": "text"
+                      }
+                    ]
+                  },
+                  "editor": "sheet"
+                }
+              ]
+            }
+          }
+        },
+        "views": [
+          {
+            "id": "sheet",
+            "name": "Sheet",
+            "entry": "view/sheet.js",
+            "element": "probe-sheet",
+            "hosts": [
+              "patter"
+            ]
+          }
+        ],
+        "reads": [
+          "patterstage"
+        ],
+        "requires": [
+          "patterstage"
+        ]
+      },
+      "problems": []
+    },
+    {
+      "name": "requires names other extensions, once each",
+      "manifest": {
+        "schema": "wildwinter/extension@0",
+        "id": "probe",
+        "name": "Probe",
+        "version": "1.0.0",
+        "targets": {
+          "patter": {
+            "line": {
+              "fields": [
+                {
+                  "name": "mood",
+                  "type": "text"
+                }
+              ]
+            }
+          }
+        },
+        "requires": [
+          "patterstage",
+          "probe",
+          "patterstage",
+          "Bad"
+        ]
+      },
+      "problems": [
+        {
+          "path": "requires[1]",
+          "code": "requires-self"
+        },
+        {
+          "path": "requires[2]",
+          "code": "requires-duplicate"
+        },
+        {
+          "path": "requires[3]",
+          "code": "requires-id"
+        }
+      ]
+    },
+    {
+      "name": "requires must be a list",
+      "manifest": {
+        "schema": "wildwinter/extension@0",
+        "id": "probe",
+        "name": "Probe",
+        "version": "1.0.0",
+        "targets": {
+          "patter": {
+            "line": {
+              "fields": [
+                {
+                  "name": "mood",
+                  "type": "text"
+                }
+              ]
+            }
+          }
+        },
+        "requires": "patterstage"
+      },
+      "problems": [
+        {
+          "path": "requires",
+          "code": "not-a-list"
+        }
+      ]
+    },
+    {
+      "name": "a field's editor names a view that opens in its host, on a map of records",
+      "manifest": {
+        "schema": "wildwinter/extension@0",
+        "id": "probe",
+        "name": "Probe",
+        "version": "1.0.0",
+        "targets": {
+          "patter": {
+            "line": {
+              "fields": [
+                {
+                  "name": "perf",
+                  "type": "map",
+                  "key": {
+                    "type": "text"
+                  },
+                  "of": {
+                    "type": "record",
+                    "fields": [
+                      {
+                        "name": "look",
+                        "type": "text",
+                        "editor": "sheet"
+                      }
+                    ]
+                  },
+                  "editor": "nope"
+                },
+                {
+                  "name": "cues",
+                  "type": "map",
+                  "key": {
+                    "type": "text"
+                  },
+                  "of": {
+                    "type": "record",
+                    "fields": [
+                      {
+                        "name": "at",
+                        "type": "number"
+                      }
+                    ]
+                  },
+                  "editor": 3
+                },
+                {
+                  "name": "mood",
+                  "type": "text",
+                  "editor": "sheet"
+                }
+              ]
+            }
+          },
+          "storylets": {
+            "card": {
+              "fields": [
+                {
+                  "name": "perf",
+                  "type": "map",
+                  "key": {
+                    "type": "text"
+                  },
+                  "of": {
+                    "type": "record",
+                    "fields": [
+                      {
+                        "name": "look",
+                        "type": "text"
+                      }
+                    ]
+                  },
+                  "editor": "sheet"
+                }
+              ]
+            }
+          }
+        },
+        "views": [
+          {
+            "id": "sheet",
+            "name": "Sheet",
+            "entry": "view/sheet.js",
+            "element": "probe-sheet",
+            "hosts": [
+              "patter"
+            ]
+          }
+        ]
+      },
+      "problems": [
+        {
+          "path": "targets.patter.line.fields[0].of.fields[0].editor",
+          "code": "editor-nested"
+        },
+        {
+          "path": "targets.patter.line.fields[0].editor",
+          "code": "editor-view"
+        },
+        {
+          "path": "targets.patter.line.fields[1].editor",
+          "code": "editor-view"
+        },
+        {
+          "path": "targets.patter.line.fields[2].editor",
+          "code": "editor-ignored",
+          "severity": "warning"
+        },
+        {
+          "path": "targets.storylets.card.fields[0].editor",
+          "code": "editor-host"
+        }
+      ]
+    },
+    {
+      "name": "an editor names a view the manifest declares",
+      "manifest": {
+        "schema": "wildwinter/extension@0",
+        "id": "probe",
+        "name": "Probe",
+        "version": "1.0.0",
+        "targets": {
+          "patter": {
+            "line": {
+              "fields": [
+                {
+                  "name": "perf",
+                  "type": "map",
+                  "key": {
+                    "type": "text"
+                  },
+                  "of": {
+                    "type": "record",
+                    "fields": [
+                      {
+                        "name": "look",
+                        "type": "text"
+                      }
+                    ]
+                  },
+                  "editor": "sheet"
+                }
+              ]
+            }
+          }
+        }
+      },
+      "problems": [
+        {
+          "path": "targets.patter.line.fields[0].editor",
+          "code": "editor-view"
+        }
+      ]
     }
   ]
 }

package/dist/extensions.cjs

@@ -365,9 +365,9 @@ var ID = /^[a-z][a-z0-9-]*$/;
 var VERSION = /^\d+\.\d+\.\d+$/;
 var NAME = /^[A-Za-z_][A-Za-z0-9_]*$/;
 var TYPE_KEYS = ["type", "values", "stages", "renamedStages", "to", "from", "fields", "key", "of", "id", "min", "max", "valueHelp", "default"];
-var FIELD_KEYS = /* @__PURE__ */ new Set([...TYPE_KEYS, "name", "label", "help", "required", "group", "editorOnly"]);
+var FIELD_KEYS = /* @__PURE__ */ new Set([...TYPE_KEYS, "name", "label", "help", "required", "group", "editorOnly", "editor"]);
 var BARE_KEYS = new Set(TYPE_KEYS);
-var MANIFEST_KEYS = /* @__PURE__ */ new Set(["schema", "id", "name", "version", "docs", "targets", "views", "reads"]);
+var MANIFEST_KEYS = /* @__PURE__ */ new Set(["schema", "id", "name", "version", "docs", "targets", "views", "reads", "requires"]);
 var REMOVED_MANIFEST_KEYS = {
   settings: "settings were removed with claims; declare the extension's own fields, or a project field for a project-wide value"
 };
@@ -398,6 +398,7 @@ function manifestProblems(manifest) {
   if (m["docs"] !== void 0 && typeof m["docs"] !== "string") out.push(err2("docs", "docs", "docs is a link, as text"));
   viewsProblems(m["views"], m["targets"], out);
   readsProblems(m["reads"], m["id"], out);
+  requiresProblems(m["requires"], m["id"], out);
   const targets = m["targets"];
   if (!isObject(targets) || Object.keys(targets).length === 0) {
     out.push(err2("no-targets", "targets", "the manifest targets no host"));
@@ -423,6 +424,7 @@ function manifestProblems(manifest) {
       targetProblems(host, target, kindPath, out);
     }
     pickListProblems(kinds, hostPath, out);
+    editorProblems(host, kinds, m["views"], Object.keys(targets), hostPath, out);
   }
   return out;
 }
@@ -562,6 +564,54 @@ function readsProblems(reads, self, out) {
     else seen.add(r);
   });
 }
+function requiresProblems(requires, self, out) {
+  if (requires === void 0) return;
+  if (!Array.isArray(requires)) {
+    out.push(err2("not-a-list", "requires", "requires is a list of extension ids"));
+    return;
+  }
+  const seen = /* @__PURE__ */ new Set();
+  requires.forEach((r, i) => {
+    const at = atIndex("requires", i);
+    if (typeof r !== "string" || !ID.test(r)) out.push(err2("requires-id", at, "a required extension is named by its id: lower case letters, digits and hyphens"));
+    else if (r === self) out.push(err2("requires-self", at, "an extension can't require itself"));
+    else if (seen.has(r)) out.push(err2("requires-duplicate", at, `"${r}" is listed twice`));
+    else seen.add(r);
+  });
+}
+function missingRequirements(manifest, taken) {
+  const have = new Set(taken);
+  const out = [];
+  for (const r of Array.isArray(manifest.requires) ? manifest.requires : []) {
+    if (typeof r === "string" && ID.test(r) && r !== manifest.id && !have.has(r) && !out.includes(r)) out.push(r);
+  }
+  return out;
+}
+function editorProblems(host, kinds, views, targeted, hostPath, out) {
+  const declared = Array.isArray(views) ? views.filter((v) => isObject(v) && typeof v["id"] === "string") : [];
+  for (const [kind, target] of Object.entries(kinds)) {
+    if (!isObject(target) || !Array.isArray(target["fields"])) continue;
+    target["fields"].forEach((f, i) => {
+      if (!isObject(f) || f["editor"] === void 0) return;
+      const at = atKey(atIndex(atKey(atKey(hostPath, kind), "fields"), i), "editor");
+      const editor = f["editor"];
+      const view = typeof editor === "string" ? declared.find((v) => v["id"] === editor) : void 0;
+      if (view === void 0) {
+        out.push(err2("editor-view", at, typeof editor === "string" ? `the manifest declares no view called "${editor}"; an editor names one of its views by id` : "an editor names one of the manifest's views by its id"));
+        return;
+      }
+      const opensIn = Array.isArray(view["hosts"]) ? view["hosts"] : targeted;
+      if (!opensIn.includes(host)) {
+        out.push(err2("editor-host", at, `the view "${editor}" doesn't open in ${host}`));
+        return;
+      }
+      const d = f;
+      if (!(d.type === "map" && isObject(d.of) && d.of.type === "record")) {
+        out.push({ severity: "warning", code: "editor-ignored", path: at, message: "only a map of records opens in an editor; this field is edited in place, so the editor is ignored" });
+      }
+    });
+  }
+}
 function viewsFor(manifest, host) {
   const targeted = Object.keys(manifest.targets ?? {});
   return (Array.isArray(manifest.views) ? manifest.views : []).filter((v) => isObject(v) && typeof v.id === "string" && ID.test(v.id) && typeof v.name === "string" && isViewEntry(v.entry) && typeof v.element === "string" && ELEMENT.test(v.element) && (v.hosts === void 0 ? targeted.includes(host) : Array.isArray(v.hosts) && v.hosts.includes(host)));
@@ -609,6 +659,9 @@ function fieldListProblems(host, fields, path, topLevel, out) {
     if (field.editorOnly !== void 0 && !topLevel) {
       out.push(err2("editor-only-nested", atKey(at, "editorOnly"), "only a target's own fields can be editor-only, not a record's"));
     }
+    if (field.editor !== void 0 && !topLevel) {
+      out.push(err2("editor-nested", atKey(at, "editor"), "only a target's own fields open in a view, not a record's"));
+    }
     for (const flag of ["required", "editorOnly"]) {
       if (field[flag] !== void 0 && typeof field[flag] !== "boolean") {
         out.push(err2("not-a-boolean", atKey(at, flag), `${flag} is true or false`));
@@ -1120,6 +1173,7 @@ exports.markUnresolved = markUnresolved;
 exports.mergeComments = mergeComments;
 exports.mergeExtensionData = mergeExtensionData;
 exports.mergeTree = mergeTree;
+exports.missingRequirements = missingRequirements;
 exports.objectOf = objectOf;
 exports.orphanedEntries = orphanedEntries;
 exports.parseManifest = parseManifest;