@patterkit/core 0.7.1 → 0.9.0

package/dist/index.cjs

@@ -229,6 +229,7 @@ function validateProject(input) {
     return true;
   };
   validateProjectFile(project, issues);
+  validateGameDataValues(project, scenes, issues);
   for (const scene of scenes) {
     seeId(scene.id, "scene", "project");
     checkPad(scene.padAfterDefault, `scene '${scene.id}' default`, scene.id);
@@ -505,12 +506,80 @@ function validateProjectFile(project, issues) {
       if (!f.name.trim()) issues.push({ code: "invalid-gamedata-field", message: `${kind} gameData field has no name` });
       else if (seen.has(key)) issues.push({ code: "invalid-gamedata-field", message: `${kind} gameData field '${f.name}' is declared more than once` });
       else seen.add(key);
+      const subject = `${kind} gameData field '${f.name}'`;
       if (f.type === "enum" && !(f.values && f.values.length)) {
-        issues.push({ code: "invalid-gamedata-field", message: `${kind} gameData field '${f.name}' is an enum but lists no values` });
+        issues.push({ code: "invalid-gamedata-field", message: `${subject} is an enum but lists no values` });
+      } else if (f.type === "flags" && !(f.values && f.values.length)) {
+        issues.push({ code: "invalid-gamedata-field", message: `${subject} is flags but lists no values` });
+      }
+      if (f.type === "quality") {
+        for (const problem of (0, import_expr.qualityDeclarationProblems)(f.stages, f.default)) {
+          issues.push({ code: "invalid-gamedata-field", message: `${subject} ${qualityProblemWords(problem)}` });
+        }
+      } else if (f.default !== void 0 && !(0, import_expr.valueFits)(f, f.default, { noneChosen: true })) {
+        issues.push({
+          code: "invalid-gamedata-field",
+          message: `${subject} default ${JSON.stringify(f.default)} does not match type '${f.type}'`
+        });
       }
     }
   }
 }
+function qualityProblemWords(problem) {
+  switch (problem.kind) {
+    case "too-few-stages":
+      return `is a quality but declares ${problem.count === 0 ? "no stages" : "only one stage"} (a ladder needs at least two)`;
+    case "empty-stage":
+      return "has an empty stage name";
+    case "duplicate-stage":
+      return `declares stage '${problem.stage}' more than once`;
+    case "default-not-a-stage":
+      return `default ${JSON.stringify(problem.value)} is not one of its stages`;
+  }
+}
+function validateGameDataValues(project, scenes, issues) {
+  const declared = project.gameDataFields ?? {};
+  const check = (kind, id, values) => {
+    if (!values) return;
+    const fields = declared[kind] ?? [];
+    if (fields.length === 0) return;
+    for (const [name, value] of Object.entries(values)) {
+      const f = fields.find((d) => d.name === name);
+      if (!f || (0, import_expr.valueFits)(f, value, { noneChosen: true })) continue;
+      const where = `${kind} '${id ?? "?"}'`;
+      if (f.type === "quality" && typeof value === "string") {
+        issues.push({
+          code: "invalid-gamedata-value",
+          id,
+          message: `${where} gameData '${name}' is '${value}', which is not one of its stages`,
+          offLadder: { field: name, bad: value, options: (0, import_expr.stagesEitherSide)(f, value) }
+        });
+      } else {
+        issues.push({
+          code: "invalid-gamedata-value",
+          id,
+          message: `${where} gameData '${name}' ${JSON.stringify(value)} does not match type '${f.type}'`
+        });
+      }
+    }
+  };
+  for (const scene of scenes) {
+    check("scene", scene.id, scene.gameData);
+    for (const block of scene.blocks ?? []) {
+      check("block", block.id, block.gameData);
+      (0, import_model.walkNodes)(block.children ?? [], (node) => {
+        if (node.type !== "snippet") {
+          if (node.selector === "choice") {
+            for (const option of node.children ?? []) if (option.type === "group") check("option", option.id, option.gameData);
+          }
+          return;
+        }
+        check("snippet", node.id, node.gameData);
+        for (const beat of node.beats ?? []) check(beat.kind, beat.id, beat.gameData);
+      });
+    }
+  }
+}
 function validateAuthoring(files, project, allIds, issues) {
   const writingLadder = new Set((project.writingStatuses ?? import_model.DEFAULT_WRITING_STATUSES).map((s) => s.name));
   const recordingLadder = new Set((project.recordingStatuses ?? import_model.DEFAULT_RECORDING_STATUSES).map((s) => s.name));
@@ -619,7 +688,7 @@ function checkDecls(decls, where, issues) {
         }
       }
     }
-    if (decl.default !== void 0 && !defaultMatchesType(decl.default, decl)) {
+    if (decl.default !== void 0 && !(0, import_expr.valueFits)(decl, decl.default)) {
       issues.push({
         code: "invalid-declaration",
         message: `${where}: '${decl.name}' default ${JSON.stringify(decl.default)} does not match type '${decl.type}'`
@@ -627,22 +696,6 @@ function checkDecls(decls, where, issues) {
     }
   }
 }
-function defaultMatchesType(value, decl) {
-  switch (decl.type) {
-    case "boolean":
-      return typeof value === "boolean";
-    case "number":
-      return typeof value === "number";
-    case "string":
-      return typeof value === "string";
-    case "enum":
-      return typeof value === "string" && (decl.values?.includes(value) ?? true);
-    case "flags":
-      return Array.isArray(value) && value.every((v) => typeof v === "string" && (decl.values?.includes(v) ?? true));
-    case "quality":
-      return typeof value === "string" && !(0, import_expr.qualityDeclarationProblems)(decl.stages, value).some((p) => p.kind === "default-not-a-stage");
-  }
-}
 
 // src/scene-scaffold.ts
 var import_model4 = require("@patterkit/model");

package/dist/index.d.cts

@@ -26,13 +26,20 @@ interface StringifyOptions {
 declare function canonicalStringify(value: unknown, opts?: StringifyOptions): string;
 
 interface ValidationIssue {
-    code: "duplicate-id" | "missing-id" | "malformed-node" | "missing-name" | "empty-scene" | "empty-snippet" | "empty-container" | "dangling-jump" | "jump-into-non-addressable" | "invalid-gameid" | "duplicate-gameid" | "unknown-character" | "unknown-qualifier" | "invalid-qualifier" | "invalid-pad" | "pad-overlaps-seam" | "prompt-pad-without-beat" | "qualifier-without-speaker" | "invalid-speaker-label" | "unused-speaker-label" | "invalid-temporary" | "invalid-declaration" | "invalid-status-ladder" | "invalid-locales" | "invalid-captions" | "missing-prompt" | "invalid-prompt" | "multiple-fallbacks" | "choice-can-empty" | "invalid-status-value" | "unknown-doc-class" | "invalid-tag" | "invalid-gamedata-field" | "jump-cycle";
+    code: "duplicate-id" | "missing-id" | "malformed-node" | "missing-name" | "empty-scene" | "empty-snippet" | "empty-container" | "dangling-jump" | "jump-into-non-addressable" | "invalid-gameid" | "duplicate-gameid" | "unknown-character" | "unknown-qualifier" | "invalid-qualifier" | "invalid-pad" | "pad-overlaps-seam" | "prompt-pad-without-beat" | "qualifier-without-speaker" | "invalid-speaker-label" | "unused-speaker-label" | "invalid-temporary" | "invalid-declaration" | "invalid-status-ladder" | "invalid-locales" | "invalid-captions" | "missing-prompt" | "invalid-prompt" | "multiple-fallbacks" | "choice-can-empty" | "invalid-status-value" | "unknown-doc-class" | "invalid-tag" | "invalid-gamedata-field" | "invalid-gamedata-value" | "jump-cycle";
     message: string;
     /** Id of the offending node/beat, where applicable. */
     id?: string;
     /** Absent means an error: the project should not be built. A warning still compiles and plays (a choice
      *  that can run dry gathers or falls through at runtime), and every front end shows it as one. */
     severity?: "warning";
+    /** A quality gameData value off its field's ladder (a deleted or renamed stage, most often): the field, the
+     *  value, and the stages to offer in its place, in ladder order. An editor's quick fix reads it. */
+    offLadder?: {
+        field: string;
+        bad: string;
+        options: string[];
+    };
 }
 interface ProjectInput {
     project: ProjectFile;

package/dist/index.d.ts

@@ -26,13 +26,20 @@ interface StringifyOptions {
 declare function canonicalStringify(value: unknown, opts?: StringifyOptions): string;
 
 interface ValidationIssue {
-    code: "duplicate-id" | "missing-id" | "malformed-node" | "missing-name" | "empty-scene" | "empty-snippet" | "empty-container" | "dangling-jump" | "jump-into-non-addressable" | "invalid-gameid" | "duplicate-gameid" | "unknown-character" | "unknown-qualifier" | "invalid-qualifier" | "invalid-pad" | "pad-overlaps-seam" | "prompt-pad-without-beat" | "qualifier-without-speaker" | "invalid-speaker-label" | "unused-speaker-label" | "invalid-temporary" | "invalid-declaration" | "invalid-status-ladder" | "invalid-locales" | "invalid-captions" | "missing-prompt" | "invalid-prompt" | "multiple-fallbacks" | "choice-can-empty" | "invalid-status-value" | "unknown-doc-class" | "invalid-tag" | "invalid-gamedata-field" | "jump-cycle";
+    code: "duplicate-id" | "missing-id" | "malformed-node" | "missing-name" | "empty-scene" | "empty-snippet" | "empty-container" | "dangling-jump" | "jump-into-non-addressable" | "invalid-gameid" | "duplicate-gameid" | "unknown-character" | "unknown-qualifier" | "invalid-qualifier" | "invalid-pad" | "pad-overlaps-seam" | "prompt-pad-without-beat" | "qualifier-without-speaker" | "invalid-speaker-label" | "unused-speaker-label" | "invalid-temporary" | "invalid-declaration" | "invalid-status-ladder" | "invalid-locales" | "invalid-captions" | "missing-prompt" | "invalid-prompt" | "multiple-fallbacks" | "choice-can-empty" | "invalid-status-value" | "unknown-doc-class" | "invalid-tag" | "invalid-gamedata-field" | "invalid-gamedata-value" | "jump-cycle";
     message: string;
     /** Id of the offending node/beat, where applicable. */
     id?: string;
     /** Absent means an error: the project should not be built. A warning still compiles and plays (a choice
      *  that can run dry gathers or falls through at runtime), and every front end shows it as one. */
     severity?: "warning";
+    /** A quality gameData value off its field's ladder (a deleted or renamed stage, most often): the field, the
+     *  value, and the stages to offer in its place, in ladder order. An editor's quick fix reads it. */
+    offLadder?: {
+        field: string;
+        bad: string;
+        options: string[];
+    };
 }
 interface ProjectInput {
     project: ProjectFile;

package/dist/index.js

@@ -58,7 +58,7 @@ ${indent}}`;
 import { walkNodes, DEFAULT_WRITING_STATUSES, DEFAULT_RECORDING_STATUSES, DEFAULT_DOCUMENTATION_CLASSES, projectQualifiers, usedSpeakerPairs, PAD_AFTER_MIN, PAD_AFTER_MAX } from "@patterkit/model";
 import { isValidGameId, effectiveGameId } from "@patterkit/model";
 import { isValidPropertyName, propertyNameify, RESERVED_PROPERTY_NAMES } from "@patterkit/model";
-import { qualityDeclarationProblems } from "@wildwinter/expr";
+import { qualityDeclarationProblems, stagesEitherSide, valueFits } from "@wildwinter/expr";
 function choiceLoopsBack(choice, ...targets) {
   const back = new Set(targets.filter((s) => typeof s === "string" && s.length > 0));
   const hits = (n) => n.type === "snippet" ? !!n.jump && back.has(n.jump.to) : (n.children ?? []).some(hits);
@@ -191,6 +191,7 @@ function validateProject(input) {
     return true;
   };
   validateProjectFile(project, issues);
+  validateGameDataValues(project, scenes, issues);
   for (const scene of scenes) {
     seeId(scene.id, "scene", "project");
     checkPad(scene.padAfterDefault, `scene '${scene.id}' default`, scene.id);
@@ -467,12 +468,80 @@ function validateProjectFile(project, issues) {
       if (!f.name.trim()) issues.push({ code: "invalid-gamedata-field", message: `${kind} gameData field has no name` });
       else if (seen.has(key)) issues.push({ code: "invalid-gamedata-field", message: `${kind} gameData field '${f.name}' is declared more than once` });
       else seen.add(key);
+      const subject = `${kind} gameData field '${f.name}'`;
       if (f.type === "enum" && !(f.values && f.values.length)) {
-        issues.push({ code: "invalid-gamedata-field", message: `${kind} gameData field '${f.name}' is an enum but lists no values` });
+        issues.push({ code: "invalid-gamedata-field", message: `${subject} is an enum but lists no values` });
+      } else if (f.type === "flags" && !(f.values && f.values.length)) {
+        issues.push({ code: "invalid-gamedata-field", message: `${subject} is flags but lists no values` });
+      }
+      if (f.type === "quality") {
+        for (const problem of qualityDeclarationProblems(f.stages, f.default)) {
+          issues.push({ code: "invalid-gamedata-field", message: `${subject} ${qualityProblemWords(problem)}` });
+        }
+      } else if (f.default !== void 0 && !valueFits(f, f.default, { noneChosen: true })) {
+        issues.push({
+          code: "invalid-gamedata-field",
+          message: `${subject} default ${JSON.stringify(f.default)} does not match type '${f.type}'`
+        });
       }
     }
   }
 }
+function qualityProblemWords(problem) {
+  switch (problem.kind) {
+    case "too-few-stages":
+      return `is a quality but declares ${problem.count === 0 ? "no stages" : "only one stage"} (a ladder needs at least two)`;
+    case "empty-stage":
+      return "has an empty stage name";
+    case "duplicate-stage":
+      return `declares stage '${problem.stage}' more than once`;
+    case "default-not-a-stage":
+      return `default ${JSON.stringify(problem.value)} is not one of its stages`;
+  }
+}
+function validateGameDataValues(project, scenes, issues) {
+  const declared = project.gameDataFields ?? {};
+  const check = (kind, id, values) => {
+    if (!values) return;
+    const fields = declared[kind] ?? [];
+    if (fields.length === 0) return;
+    for (const [name, value] of Object.entries(values)) {
+      const f = fields.find((d) => d.name === name);
+      if (!f || valueFits(f, value, { noneChosen: true })) continue;
+      const where = `${kind} '${id ?? "?"}'`;
+      if (f.type === "quality" && typeof value === "string") {
+        issues.push({
+          code: "invalid-gamedata-value",
+          id,
+          message: `${where} gameData '${name}' is '${value}', which is not one of its stages`,
+          offLadder: { field: name, bad: value, options: stagesEitherSide(f, value) }
+        });
+      } else {
+        issues.push({
+          code: "invalid-gamedata-value",
+          id,
+          message: `${where} gameData '${name}' ${JSON.stringify(value)} does not match type '${f.type}'`
+        });
+      }
+    }
+  };
+  for (const scene of scenes) {
+    check("scene", scene.id, scene.gameData);
+    for (const block of scene.blocks ?? []) {
+      check("block", block.id, block.gameData);
+      walkNodes(block.children ?? [], (node) => {
+        if (node.type !== "snippet") {
+          if (node.selector === "choice") {
+            for (const option of node.children ?? []) if (option.type === "group") check("option", option.id, option.gameData);
+          }
+          return;
+        }
+        check("snippet", node.id, node.gameData);
+        for (const beat of node.beats ?? []) check(beat.kind, beat.id, beat.gameData);
+      });
+    }
+  }
+}
 function validateAuthoring(files, project, allIds, issues) {
   const writingLadder = new Set((project.writingStatuses ?? DEFAULT_WRITING_STATUSES).map((s) => s.name));
   const recordingLadder = new Set((project.recordingStatuses ?? DEFAULT_RECORDING_STATUSES).map((s) => s.name));
@@ -581,7 +650,7 @@ function checkDecls(decls, where, issues) {
         }
       }
     }
-    if (decl.default !== void 0 && !defaultMatchesType(decl.default, decl)) {
+    if (decl.default !== void 0 && !valueFits(decl, decl.default)) {
       issues.push({
         code: "invalid-declaration",
         message: `${where}: '${decl.name}' default ${JSON.stringify(decl.default)} does not match type '${decl.type}'`
@@ -589,22 +658,6 @@ function checkDecls(decls, where, issues) {
     }
   }
 }
-function defaultMatchesType(value, decl) {
-  switch (decl.type) {
-    case "boolean":
-      return typeof value === "boolean";
-    case "number":
-      return typeof value === "number";
-    case "string":
-      return typeof value === "string";
-    case "enum":
-      return typeof value === "string" && (decl.values?.includes(value) ?? true);
-    case "flags":
-      return Array.isArray(value) && value.every((v) => typeof v === "string" && (decl.values?.includes(v) ?? true));
-    case "quality":
-      return typeof value === "string" && !qualityDeclarationProblems(decl.stages, value).some((p) => p.kind === "default-not-a-stage");
-  }
-}
 
 // src/scene-scaffold.ts
 import { projectLayout, FLOW_SCHEMA, PROJECT_SCHEMA, STRINGS_SCHEMA } from "@patterkit/model";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patterkit/core",
-  "version": "0.7.1",
+  "version": "0.9.0",
   "description": "Patter core: stable id generation, readable-handle computation, canonical (de)serialisation, and the structural validator.",
   "type": "module",
   "license": "MIT",
@@ -34,9 +34,9 @@
     "build": "tsup src/index.ts --format esm,cjs --dts --clean"
   },
   "dependencies": {
-    "@patterkit/model": "0.14.0",
-    "@wildwinter/expr": "^0.5.2",
-    "@wildwinter/toolkit": "^0.1.0",
+    "@patterkit/model": "0.16.0",
+    "@wildwinter/expr": "^0.6.0",
+    "@wildwinter/toolkit": "^0.2.0",
     "json5": "^2.2.3"
   }
 }