@wildwinter/toolkit 0.2.6 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @wildwinter/toolkit
 
+## 0.3.0
+
+### Removed
+
+- **Claims and settings** (`./extensions`): a manifest's `settings` and a target's `claims`, and with them
+  `ClaimDecl`, `SettingDecl`, `HostSpec.claimable`, `settingValues`, `resolvedClaims`, `claimClashes`, and
+  `effectiveClaim`. An extension's data is always its own; a project-wide value is a field on the `project` target.
+  A manifest that still has `settings` or `claims` is warned of by name (`removed-key`), and the key is ignored.
+
+## 0.2.7
+
+### Added
+
+- **Value help on a pick** (`./extensions`): a pick's `valueHelp` describes its fixed `words`, a sentence each; the
+  manifest check holds each key to one of them, since the project's lists and nodes are the project's to describe.
+
 ## 0.2.6
 
 ### Added

package/conformance/extensions/defaults.json

@@ -28,7 +28,7 @@
         { "name": "tone", "type": "enum", "values": ["calm", "tense"], "valueHelp": { "calm": "x" } },
         { "name": "act", "type": "quality", "stages": ["setup", "turn"], "renamedStages": { "opening": "setup" } },
         { "name": "cue", "type": "record", "fields": [{ "name": "gain", "type": "number", "min": 0, "help": "Loudness." }] }
-      ], "claims": [{ "setting": "moodField", "type": "text" }] },
+      ] },
       "compiled": [
         { "name": "note", "type": "text", "default": "", "required": true },
         { "name": "tone", "type": "enum", "values": ["calm", "tense"], "default": "calm" },

package/conformance/extensions/manifest.json

@@ -24,20 +24,13 @@
       "problems": []
     },
     {
-      "name": "every type, a claim and a setting pass together",
+      "name": "every type passes together",
       "manifest": {
         "schema": "wildwinter/extension@0",
         "id": "probe",
         "name": "Probe",
         "version": "2.1.0",
         "docs": "https://example.com/probe",
-        "settings": [
-          {
-            "name": "moodField",
-            "label": "Mood field",
-            "default": "mood"
-          }
-        ],
         "targets": {
           "storylets": {
             "card": {
@@ -170,17 +163,6 @@
                     "type": "text"
                   }
                 }
-              ],
-              "claims": [
-                {
-                  "setting": "moodField",
-                  "type": "enum",
-                  "values": [
-                    "calm",
-                    "tense"
-                  ],
-                  "help": "The card's mood."
-                }
               ]
             },
             "project": {
@@ -571,6 +553,81 @@
         }
       ]
     },
+    {
+      "name": "a pick's value help describes its fixed words, never its lists or nodes",
+      "manifest": {
+        "schema": "wildwinter/extension@0",
+        "id": "probe",
+        "name": "Probe",
+        "version": "1.0.0",
+        "targets": {
+          "patter": {
+            "project": {
+              "fields": [
+                {
+                  "name": "types",
+                  "type": "list",
+                  "of": {
+                    "type": "text"
+                  }
+                }
+              ]
+            },
+            "scene": {
+              "fields": [
+                {
+                  "name": "type",
+                  "type": "pick",
+                  "from": [
+                    {
+                      "words": [
+                        "ambient",
+                        "cinematic"
+                      ]
+                    },
+                    {
+                      "list": "types"
+                    },
+                    {
+                      "words": [
+                        "bark"
+                      ]
+                    }
+                  ],
+                  "valueHelp": {
+                    "ambient": "Voices from sources.",
+                    "bark": "A one-off line.",
+                    "duel": "One of the project's types: not the manifest's to describe."
+                  }
+                },
+                {
+                  "name": "to",
+                  "type": "pick",
+                  "from": [
+                    {
+                      "to": "cast"
+                    }
+                  ],
+                  "valueHelp": {
+                    "WREN": "A cast member."
+                  }
+                }
+              ]
+            }
+          }
+        }
+      },
+      "problems": [
+        {
+          "path": "targets.patter.scene.fields[0].valueHelp.duel",
+          "code": "value-help"
+        },
+        {
+          "path": "targets.patter.scene.fields[1].valueHelp.WREN",
+          "code": "value-help"
+        }
+      ]
+    },
     {
       "name": "a reference names a kind its host can point at",
       "manifest": {
@@ -938,159 +995,6 @@
         }
       ]
     },
-    {
-      "name": "claims: a claimable kind, a declared setting, a scalar, once per setting",
-      "manifest": {
-        "schema": "wildwinter/extension@0",
-        "id": "probe",
-        "name": "Probe",
-        "version": "1.0.0",
-        "settings": [
-          {
-            "name": "moodField",
-            "default": "mood"
-          }
-        ],
-        "targets": {
-          "storylets": {
-            "deck": {
-              "claims": [
-                {
-                  "setting": "moodField",
-                  "type": "text"
-                }
-              ]
-            },
-            "card": {
-              "claims": [
-                {
-                  "setting": "moodField",
-                  "type": "text"
-                },
-                {
-                  "setting": "moodField",
-                  "type": "text"
-                },
-                {
-                  "setting": "nope",
-                  "type": "text"
-                },
-                {
-                  "setting": "moodField",
-                  "type": "record",
-                  "fields": [
-                    {
-                      "name": "a",
-                      "type": "text"
-                    }
-                  ]
-                }
-              ]
-            }
-          }
-        }
-      },
-      "problems": [
-        {
-          "path": "targets.storylets.deck.claims[0]",
-          "code": "claim-kind"
-        },
-        {
-          "path": "targets.storylets.card.claims[1].setting",
-          "code": "claim-duplicate"
-        },
-        {
-          "path": "targets.storylets.card.claims[2].setting",
-          "code": "claim-setting"
-        },
-        {
-          "path": "targets.storylets.card.claims[3].type",
-          "code": "claim-type"
-        },
-        {
-          "path": "targets.storylets.card.claims[3].setting",
-          "code": "claim-duplicate"
-        }
-      ]
-    },
-    {
-      "name": "settings: named once each, defaulting to a field name",
-      "manifest": {
-        "schema": "wildwinter/extension@0",
-        "id": "probe",
-        "name": "Probe",
-        "version": "1.0.0",
-        "settings": [
-          {
-            "name": "a",
-            "default": "x"
-          },
-          {
-            "name": "a",
-            "default": "y"
-          },
-          {
-            "name": "b"
-          },
-          {
-            "name": "c",
-            "default": "not a name"
-          }
-        ],
-        "targets": {
-          "storylets": {
-            "card": {}
-          }
-        }
-      },
-      "problems": [
-        {
-          "path": "settings[1].name",
-          "code": "setting-duplicate"
-        },
-        {
-          "path": "settings[2].default",
-          "code": "setting-default"
-        },
-        {
-          "path": "settings[3].default",
-          "code": "setting-default"
-        }
-      ]
-    },
-    {
-      "name": "an enum claim may leave out its values, and its value help may describe values the host does not declare",
-      "manifest": {
-        "schema": "wildwinter/extension@0",
-        "id": "probe",
-        "name": "Probe",
-        "version": "1.0.0",
-        "settings": [
-          {
-            "name": "moodField",
-            "default": "mood"
-          }
-        ],
-        "targets": {
-          "storylets": {
-            "card": {
-              "claims": [
-                {
-                  "setting": "moodField",
-                  "type": "enum",
-                  "label": "Mood",
-                  "valueHelp": {
-                    "calm": "Unhurried.",
-                    "wild": "Not one the host has."
-                  }
-                }
-              ]
-            }
-          }
-        }
-      },
-      "problems": []
-    },
     {
       "name": "an enum field of the extension's own still lists its values",
       "manifest": {
@@ -1670,6 +1574,51 @@
           "code": "not-a-list"
         }
       ]
+    },
+    {
+      "name": "settings and claims were removed: each warned of by name, and ignored",
+      "manifest": {
+        "schema": "wildwinter/extension@0",
+        "id": "probe",
+        "name": "Probe",
+        "version": "1.0.0",
+        "settings": [
+          {
+            "name": "moodField",
+            "default": "mood"
+          }
+        ],
+        "targets": {
+          "storylets": {
+            "card": {
+              "fields": [
+                {
+                  "name": "tone",
+                  "type": "text"
+                }
+              ],
+              "claims": [
+                {
+                  "setting": "moodField",
+                  "type": "enum"
+                }
+              ]
+            }
+          }
+        }
+      },
+      "problems": [
+        {
+          "path": "settings",
+          "code": "removed-key",
+          "severity": "warning"
+        },
+        {
+          "path": "targets.storylets.card.claims",
+          "code": "removed-key",
+          "severity": "warning"
+        }
+      ]
     }
   ]
 }

package/conformance/extensions/values.json

@@ -937,92 +937,6 @@
       ]
     }
   ],
-  "claims": [
-    {
-      "name": "a claim without values takes the host's, and keeps its own label, help and value help",
-      "claim": {
-        "setting": "moodField",
-        "type": "enum",
-        "label": "Mood",
-        "help": "How it feels.",
-        "valueHelp": {
-          "calm": "Unhurried.",
-          "wild": "Unused."
-        }
-      },
-      "host": {
-        "type": "enum",
-        "values": [
-          "calm",
-          "tense"
-        ],
-        "default": "calm"
-      },
-      "effective": {
-        "setting": "moodField",
-        "type": "enum",
-        "label": "Mood",
-        "help": "How it feels.",
-        "valueHelp": {
-          "calm": "Unhurried.",
-          "wild": "Unused."
-        },
-        "values": [
-          "calm",
-          "tense"
-        ],
-        "default": "calm"
-      }
-    },
-    {
-      "name": "a claim's own values stand",
-      "claim": {
-        "setting": "moodField",
-        "type": "enum",
-        "values": [
-          "calm"
-        ]
-      },
-      "host": {
-        "type": "enum",
-        "values": [
-          "calm",
-          "tense"
-        ]
-      },
-      "effective": {
-        "setting": "moodField",
-        "type": "enum",
-        "values": [
-          "calm"
-        ]
-      }
-    },
-    {
-      "name": "a quality claim takes the host's ladder, as a claimed field keeps the host's",
-      "claim": {
-        "setting": "actField",
-        "type": "quality",
-        "label": "Act"
-      },
-      "host": {
-        "type": "quality",
-        "stages": [
-          "setup",
-          "turn"
-        ]
-      },
-      "effective": {
-        "setting": "actField",
-        "type": "quality",
-        "label": "Act",
-        "stages": [
-          "setup",
-          "turn"
-        ]
-      }
-    }
-  ],
   "picks": [
     {
       "name": "choices in source order, each source's in its own",