@patterkit/core 0.6.2 → 0.7.1

package/dist/index.cjs

@@ -96,6 +96,7 @@ ${indent}}`;
 var import_model = require("@patterkit/model");
 var import_model2 = require("@patterkit/model");
 var import_model3 = require("@patterkit/model");
+var import_expr = require("@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);
@@ -388,6 +389,20 @@ function validateProject(input) {
       });
     }
   }
+  const labelled = (project.cast ?? []).filter((c) => c.qualifierLabels && typeof c.qualifierLabels === "object");
+  const usedPairs = labelled.length === 0 ? /* @__PURE__ */ new Set() : new Set((0, import_model.usedSpeakerPairs)(scenes.filter((sc) => Array.isArray(sc?.blocks) && sc.blocks.every((b) => Array.isArray(b?.children)))).map((p) => `${p.character}\0${p.qualifier}`));
+  for (const c of labelled) {
+    const labels = c.qualifierLabels;
+    if (!labels || typeof labels !== "object") continue;
+    for (const q of Object.keys(labels)) {
+      if (usedPairs.has(`${c.name}\0${q}`)) continue;
+      issues.push({
+        code: "unused-speaker-label",
+        severity: "warning",
+        message: `'${c.name}' has its own label with the qualifier '${q}', but no line has that speaker with that qualifier`
+      });
+    }
+  }
   return issues;
 }
 function isQualifierEntry(q) {
@@ -468,6 +483,21 @@ function validateProjectFile(project, issues) {
     }
     if (typeof q.gameId === "string") seenQualifiers.add(q.gameId);
   }
+  const pattern = project.speakerPattern;
+  if (pattern !== void 0 && typeof pattern !== "string") {
+    issues.push({ code: "invalid-speaker-label", message: "the speaker pattern must be text" });
+  }
+  for (const c of project.cast ?? []) {
+    const labels = c.qualifierLabels;
+    if (labels === void 0) continue;
+    if (!labels || typeof labels !== "object" || Array.isArray(labels)) {
+      issues.push({ code: "invalid-speaker-label", message: `'${c.name}' qualifier labels must map a qualifier to its label` });
+      continue;
+    }
+    for (const [q, label] of Object.entries(labels)) {
+      if (typeof label !== "string") issues.push({ code: "invalid-speaker-label", message: `'${c.name}' label with the qualifier '${q}' must be text` });
+    }
+  }
   for (const [kind, fields] of Object.entries(project.gameDataFields ?? {})) {
     const seen = /* @__PURE__ */ new Set();
     for (const f of fields ?? []) {
@@ -572,18 +602,21 @@ function checkDecls(decls, where, issues) {
       });
     }
     if (decl.type === "quality") {
-      const stages = decl.stages ?? [];
-      if (stages.length < 2) {
-        issues.push({
-          code: "invalid-declaration",
-          message: `${where}: '${decl.name}' is a quality but declares ${stages.length === 0 ? "no stages" : "only one stage"} (a ladder needs at least two)`
-        });
-      }
-      const seenStages = /* @__PURE__ */ new Set();
-      for (const s of stages) {
-        if (!s.trim()) issues.push({ code: "invalid-declaration", message: `${where}: '${decl.name}' has an empty stage name` });
-        else if (seenStages.has(s)) issues.push({ code: "invalid-declaration", message: `${where}: '${decl.name}' declares stage '${s}' more than once` });
-        else seenStages.add(s);
+      for (const problem2 of (0, import_expr.qualityDeclarationProblems)(decl.stages)) {
+        switch (problem2.kind) {
+          case "too-few-stages":
+            issues.push({
+              code: "invalid-declaration",
+              message: `${where}: '${decl.name}' is a quality but declares ${problem2.count === 0 ? "no stages" : "only one stage"} (a ladder needs at least two)`
+            });
+            break;
+          case "empty-stage":
+            issues.push({ code: "invalid-declaration", message: `${where}: '${decl.name}' has an empty stage name` });
+            break;
+          case "duplicate-stage":
+            issues.push({ code: "invalid-declaration", message: `${where}: '${decl.name}' declares stage '${problem2.stage}' more than once` });
+            break;
+        }
       }
     }
     if (decl.default !== void 0 && !defaultMatchesType(decl.default, decl)) {
@@ -607,7 +640,7 @@ function defaultMatchesType(value, decl) {
     case "flags":
       return Array.isArray(value) && value.every((v) => typeof v === "string" && (decl.values?.includes(v) ?? true));
     case "quality":
-      return typeof value === "string" && (decl.stages?.includes(value) ?? true);
+      return typeof value === "string" && !(0, import_expr.qualityDeclarationProblems)(decl.stages, value).some((p) => p.kind === "default-not-a-stage");
   }
 }
 

package/dist/index.d.cts

@@ -26,7 +26,7 @@ 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-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" | "jump-cycle";
     message: string;
     /** Id of the offending node/beat, where applicable. */
     id?: string;

package/dist/index.d.ts

@@ -26,7 +26,7 @@ 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-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" | "jump-cycle";
     message: string;
     /** Id of the offending node/beat, where applicable. */
     id?: string;

package/dist/index.js

@@ -55,9 +55,10 @@ ${indent}}`;
 }
 
 // src/validate.ts
-import { walkNodes, DEFAULT_WRITING_STATUSES, DEFAULT_RECORDING_STATUSES, DEFAULT_DOCUMENTATION_CLASSES, projectQualifiers, PAD_AFTER_MIN, PAD_AFTER_MAX } from "@patterkit/model";
+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";
 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);
@@ -350,6 +351,20 @@ function validateProject(input) {
       });
     }
   }
+  const labelled = (project.cast ?? []).filter((c) => c.qualifierLabels && typeof c.qualifierLabels === "object");
+  const usedPairs = labelled.length === 0 ? /* @__PURE__ */ new Set() : new Set(usedSpeakerPairs(scenes.filter((sc) => Array.isArray(sc?.blocks) && sc.blocks.every((b) => Array.isArray(b?.children)))).map((p) => `${p.character}\0${p.qualifier}`));
+  for (const c of labelled) {
+    const labels = c.qualifierLabels;
+    if (!labels || typeof labels !== "object") continue;
+    for (const q of Object.keys(labels)) {
+      if (usedPairs.has(`${c.name}\0${q}`)) continue;
+      issues.push({
+        code: "unused-speaker-label",
+        severity: "warning",
+        message: `'${c.name}' has its own label with the qualifier '${q}', but no line has that speaker with that qualifier`
+      });
+    }
+  }
   return issues;
 }
 function isQualifierEntry(q) {
@@ -430,6 +445,21 @@ function validateProjectFile(project, issues) {
     }
     if (typeof q.gameId === "string") seenQualifiers.add(q.gameId);
   }
+  const pattern = project.speakerPattern;
+  if (pattern !== void 0 && typeof pattern !== "string") {
+    issues.push({ code: "invalid-speaker-label", message: "the speaker pattern must be text" });
+  }
+  for (const c of project.cast ?? []) {
+    const labels = c.qualifierLabels;
+    if (labels === void 0) continue;
+    if (!labels || typeof labels !== "object" || Array.isArray(labels)) {
+      issues.push({ code: "invalid-speaker-label", message: `'${c.name}' qualifier labels must map a qualifier to its label` });
+      continue;
+    }
+    for (const [q, label] of Object.entries(labels)) {
+      if (typeof label !== "string") issues.push({ code: "invalid-speaker-label", message: `'${c.name}' label with the qualifier '${q}' must be text` });
+    }
+  }
   for (const [kind, fields] of Object.entries(project.gameDataFields ?? {})) {
     const seen = /* @__PURE__ */ new Set();
     for (const f of fields ?? []) {
@@ -534,18 +564,21 @@ function checkDecls(decls, where, issues) {
       });
     }
     if (decl.type === "quality") {
-      const stages = decl.stages ?? [];
-      if (stages.length < 2) {
-        issues.push({
-          code: "invalid-declaration",
-          message: `${where}: '${decl.name}' is a quality but declares ${stages.length === 0 ? "no stages" : "only one stage"} (a ladder needs at least two)`
-        });
-      }
-      const seenStages = /* @__PURE__ */ new Set();
-      for (const s of stages) {
-        if (!s.trim()) issues.push({ code: "invalid-declaration", message: `${where}: '${decl.name}' has an empty stage name` });
-        else if (seenStages.has(s)) issues.push({ code: "invalid-declaration", message: `${where}: '${decl.name}' declares stage '${s}' more than once` });
-        else seenStages.add(s);
+      for (const problem2 of qualityDeclarationProblems(decl.stages)) {
+        switch (problem2.kind) {
+          case "too-few-stages":
+            issues.push({
+              code: "invalid-declaration",
+              message: `${where}: '${decl.name}' is a quality but declares ${problem2.count === 0 ? "no stages" : "only one stage"} (a ladder needs at least two)`
+            });
+            break;
+          case "empty-stage":
+            issues.push({ code: "invalid-declaration", message: `${where}: '${decl.name}' has an empty stage name` });
+            break;
+          case "duplicate-stage":
+            issues.push({ code: "invalid-declaration", message: `${where}: '${decl.name}' declares stage '${problem2.stage}' more than once` });
+            break;
+        }
       }
     }
     if (decl.default !== void 0 && !defaultMatchesType(decl.default, decl)) {
@@ -569,7 +602,7 @@ function defaultMatchesType(value, decl) {
     case "flags":
       return Array.isArray(value) && value.every((v) => typeof v === "string" && (decl.values?.includes(v) ?? true));
     case "quality":
-      return typeof value === "string" && (decl.stages?.includes(value) ?? true);
+      return typeof value === "string" && !qualityDeclarationProblems(decl.stages, value).some((p) => p.kind === "default-not-a-stage");
   }
 }
 

package/package.json

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