@wildwinter/toolkit 0.3.0 → 0.3.1

package/dist/extensions.d.cts

@@ -80,6 +80,9 @@ interface FieldDecl extends TypeDecl {
     readonly group?: string;
     /** Stripped at compile: editor data, never in a bundle. A target's own fields only. */
     readonly editorOnly?: boolean;
+    /** One of the manifest's views, by id, that edits this field in the hosts it opens in: a target's own map of
+     *  records only. */
+    readonly editor?: string;
 }
 /** What an extension declares for one node kind of one host. */
 interface TargetDecl {
@@ -96,6 +99,8 @@ interface Manifest {
     readonly views?: readonly ViewDecl[];
     /** Other extensions whose data this one's views read, by id. */
     readonly reads?: readonly string[];
+    /** Other extensions a project must take for this one to work, by id. */
+    readonly requires?: readonly string[];
 }
 /** A view: a web component in the extension's installed package, opened by a host in a floating window. */
 interface ViewDecl {
@@ -145,6 +150,9 @@ declare function parseManifest(text: string): Manifest;
 declare function manifestProblems(manifest: unknown): Problem[];
 /** A package path a view's entry may name: relative, forward slashes, no `.` or `..` segment, a `.js` file. */
 declare function isViewEntry(entry: unknown): entry is string;
+/** The extensions a manifest requires that a project doesn't take, by id, in the manifest's order. An entry that
+ *  fails its checks is left out. */
+declare function missingRequirements(manifest: Manifest, taken: Iterable<string>): string[];
 /** The views a host offers from a manifest: those naming the host, or every view when it names none and the
  *  manifest targets the host. A view that fails its checks is left out. */
 declare function viewsFor(manifest: Manifest, host: HostName): ViewDecl[];
@@ -372,4 +380,4 @@ declare const atKey: (base: string, key: string) => string;
 /** `base` and then list position `i`. */
 declare const atIndex: (base: string, i: number) => string;
 
-export { ATOMIC, COMMENTS, type Conflict, type ConflictKind, type DataMergeResult, type ExtensionData, type FieldDecl, HOSTS, type HostName, type HostSpec, type JsonValue, MANIFEST_FILE_SUFFIX, MANIFEST_SCHEMA, type Manifest, type MergeWarning, type PickChoice, type PickSource, type PickSources, type Problem, SCALAR_TYPES, SET, type ScalarType, type StageRename, type Strategy, type TargetDecl, type TreeMergeOptions, type TreeMergeResult, type TypeDecl, UNRESOLVED_KEY, type UnresolvedEntry, VALUE_TYPES, type ValueContext, type ValueType, type ViewDecl, atIndex, atKey, compileEntry, compiledTarget, defaultOf, entryProblems, extensionDataStrategy, isTextList, isViewEntry, keyedBy, manifestProblems, mapOf, markUnresolved, mergeComments, mergeExtensionData, mergeTree, objectOf, orphanedEntries, parseManifest, pickChoices, pickClashes, pickLists, renameStages, stableStringify, strategyForTarget, strategyForType, targetOf, unresolvedOf, unresolvedProblems, valueProblems, viewsFor, withoutMark };
+export { ATOMIC, COMMENTS, type Conflict, type ConflictKind, type DataMergeResult, type ExtensionData, type FieldDecl, HOSTS, type HostName, type HostSpec, type JsonValue, MANIFEST_FILE_SUFFIX, MANIFEST_SCHEMA, type Manifest, type MergeWarning, type PickChoice, type PickSource, type PickSources, type Problem, SCALAR_TYPES, SET, type ScalarType, type StageRename, type Strategy, type TargetDecl, type TreeMergeOptions, type TreeMergeResult, type TypeDecl, UNRESOLVED_KEY, type UnresolvedEntry, VALUE_TYPES, type ValueContext, type ValueType, type ViewDecl, atIndex, atKey, compileEntry, compiledTarget, defaultOf, entryProblems, extensionDataStrategy, isTextList, isViewEntry, keyedBy, manifestProblems, mapOf, markUnresolved, mergeComments, mergeExtensionData, mergeTree, missingRequirements, objectOf, orphanedEntries, parseManifest, pickChoices, pickClashes, pickLists, renameStages, stableStringify, strategyForTarget, strategyForType, targetOf, unresolvedOf, unresolvedProblems, valueProblems, viewsFor, withoutMark };

package/dist/extensions.d.ts

@@ -80,6 +80,9 @@ interface FieldDecl extends TypeDecl {
     readonly group?: string;
     /** Stripped at compile: editor data, never in a bundle. A target's own fields only. */
     readonly editorOnly?: boolean;
+    /** One of the manifest's views, by id, that edits this field in the hosts it opens in: a target's own map of
+     *  records only. */
+    readonly editor?: string;
 }
 /** What an extension declares for one node kind of one host. */
 interface TargetDecl {
@@ -96,6 +99,8 @@ interface Manifest {
     readonly views?: readonly ViewDecl[];
     /** Other extensions whose data this one's views read, by id. */
     readonly reads?: readonly string[];
+    /** Other extensions a project must take for this one to work, by id. */
+    readonly requires?: readonly string[];
 }
 /** A view: a web component in the extension's installed package, opened by a host in a floating window. */
 interface ViewDecl {
@@ -145,6 +150,9 @@ declare function parseManifest(text: string): Manifest;
 declare function manifestProblems(manifest: unknown): Problem[];
 /** A package path a view's entry may name: relative, forward slashes, no `.` or `..` segment, a `.js` file. */
 declare function isViewEntry(entry: unknown): entry is string;
+/** The extensions a manifest requires that a project doesn't take, by id, in the manifest's order. An entry that
+ *  fails its checks is left out. */
+declare function missingRequirements(manifest: Manifest, taken: Iterable<string>): string[];
 /** The views a host offers from a manifest: those naming the host, or every view when it names none and the
  *  manifest targets the host. A view that fails its checks is left out. */
 declare function viewsFor(manifest: Manifest, host: HostName): ViewDecl[];
@@ -372,4 +380,4 @@ declare const atKey: (base: string, key: string) => string;
 /** `base` and then list position `i`. */
 declare const atIndex: (base: string, i: number) => string;
 
-export { ATOMIC, COMMENTS, type Conflict, type ConflictKind, type DataMergeResult, type ExtensionData, type FieldDecl, HOSTS, type HostName, type HostSpec, type JsonValue, MANIFEST_FILE_SUFFIX, MANIFEST_SCHEMA, type Manifest, type MergeWarning, type PickChoice, type PickSource, type PickSources, type Problem, SCALAR_TYPES, SET, type ScalarType, type StageRename, type Strategy, type TargetDecl, type TreeMergeOptions, type TreeMergeResult, type TypeDecl, UNRESOLVED_KEY, type UnresolvedEntry, VALUE_TYPES, type ValueContext, type ValueType, type ViewDecl, atIndex, atKey, compileEntry, compiledTarget, defaultOf, entryProblems, extensionDataStrategy, isTextList, isViewEntry, keyedBy, manifestProblems, mapOf, markUnresolved, mergeComments, mergeExtensionData, mergeTree, objectOf, orphanedEntries, parseManifest, pickChoices, pickClashes, pickLists, renameStages, stableStringify, strategyForTarget, strategyForType, targetOf, unresolvedOf, unresolvedProblems, valueProblems, viewsFor, withoutMark };
+export { ATOMIC, COMMENTS, type Conflict, type ConflictKind, type DataMergeResult, type ExtensionData, type FieldDecl, HOSTS, type HostName, type HostSpec, type JsonValue, MANIFEST_FILE_SUFFIX, MANIFEST_SCHEMA, type Manifest, type MergeWarning, type PickChoice, type PickSource, type PickSources, type Problem, SCALAR_TYPES, SET, type ScalarType, type StageRename, type Strategy, type TargetDecl, type TreeMergeOptions, type TreeMergeResult, type TypeDecl, UNRESOLVED_KEY, type UnresolvedEntry, VALUE_TYPES, type ValueContext, type ValueType, type ViewDecl, atIndex, atKey, compileEntry, compiledTarget, defaultOf, entryProblems, extensionDataStrategy, isTextList, isViewEntry, keyedBy, manifestProblems, mapOf, markUnresolved, mergeComments, mergeExtensionData, mergeTree, missingRequirements, objectOf, orphanedEntries, parseManifest, pickChoices, pickClashes, pickLists, renameStages, stableStringify, strategyForTarget, strategyForType, targetOf, unresolvedOf, unresolvedProblems, valueProblems, viewsFor, withoutMark };

package/dist/extensions.js

@@ -355,9 +355,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"
 };
@@ -388,6 +388,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"));
@@ -413,6 +414,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;
 }
@@ -552,6 +554,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)));
@@ -599,6 +649,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`));
@@ -1085,6 +1138,6 @@ function orphanedEntries(data, exists) {
   return out;
 }
 
-export { ATOMIC, COMMENTS, HOSTS, MANIFEST_FILE_SUFFIX, MANIFEST_SCHEMA, SCALAR_TYPES, SET, UNRESOLVED_KEY, VALUE_TYPES, atIndex, atKey, compileEntry, compiledTarget, defaultOf, entryProblems, extensionDataStrategy, isTextList, isViewEntry, keyedBy, manifestProblems, mapOf, markUnresolved, mergeComments, mergeExtensionData, mergeTree, objectOf, orphanedEntries, parseManifest, pickChoices, pickClashes, pickLists, renameStages, stableStringify, strategyForTarget, strategyForType, targetOf, unresolvedOf, unresolvedProblems, valueProblems, viewsFor, withoutMark };
+export { ATOMIC, COMMENTS, HOSTS, MANIFEST_FILE_SUFFIX, MANIFEST_SCHEMA, SCALAR_TYPES, SET, UNRESOLVED_KEY, VALUE_TYPES, atIndex, atKey, compileEntry, compiledTarget, defaultOf, entryProblems, extensionDataStrategy, isTextList, isViewEntry, keyedBy, manifestProblems, mapOf, markUnresolved, mergeComments, mergeExtensionData, mergeTree, missingRequirements, objectOf, orphanedEntries, parseManifest, pickChoices, pickClashes, pickLists, renameStages, stableStringify, strategyForTarget, strategyForType, targetOf, unresolvedOf, unresolvedProblems, valueProblems, viewsFor, withoutMark };
 //# sourceMappingURL=extensions.js.map
 //# sourceMappingURL=extensions.js.map