@patterkit/core 0.4.0 → 0.5.0

package/dist/index.cjs

@@ -167,6 +167,12 @@ function validateProject(input) {
   const sceneGameIds = /* @__PURE__ */ new Map();
   const jumps = [];
   const castNames = new Set((project.cast ?? []).map((c) => c.name));
+  const qualifierIds = new Set((0, import_model.projectQualifiers)(project).map((q) => q.gameId));
+  const checkQualifier = (beat, what) => {
+    if (beat.kind === "line" && beat.qualifier !== void 0 && !qualifierIds.has(beat.qualifier)) {
+      issues.push({ code: "unknown-qualifier", message: `${what} '${beat.id}' qualifier '${beat.qualifier}' is not in the project's qualifiers`, id: beat.id });
+    }
+  };
   const checkTags = (tags, where, id) => {
     for (const t of tags ?? []) {
       if (typeof t !== "string" || t.length === 0 || /[\s,]/.test(t)) {
@@ -174,6 +180,7 @@ function validateProject(input) {
       }
     }
   };
+  const addressOf = (node) => (0, import_model2.effectiveGameId)({ gameId: node.gameId, name: typeof node.name === "string" ? node.name : "" });
   const seeId = (id, kind, where) => {
     if (typeof id !== "string" || id.length === 0) {
       issues.push({ code: "missing-id", message: `${kind} in ${where} has no id` });
@@ -198,7 +205,7 @@ function validateProject(input) {
     if (scene.gameId && !(0, import_model2.isValidGameId)(scene.gameId)) {
       issues.push({ code: "invalid-gameid", message: `${where} address '${scene.gameId}' is invalid (lowercase letters, digits, hyphens; no leading/trailing hyphen)`, id: scene.id });
     }
-    const sgid = (0, import_model2.effectiveGameId)(scene);
+    const sgid = addressOf(scene);
     if (sgid) {
       const prev = sceneGameIds.get(sgid);
       if (prev && prev !== scene.id) issues.push({ code: "duplicate-gameid", message: `${where} address '${sgid}' is already used by scene '${prev}'`, id: scene.id });
@@ -233,7 +240,7 @@ function validateProject(input) {
       if (block.gameId && !(0, import_model2.isValidGameId)(block.gameId)) {
         issues.push({ code: "invalid-gameid", message: `block '${block.id}' address '${block.gameId}' is invalid (lowercase letters, digits, hyphens; no leading/trailing hyphen)`, id: block.id });
       }
-      const bgid = (0, import_model2.effectiveGameId)(block);
+      const bgid = addressOf(block);
       if (bgid) {
         const prev = blockGameIds.get(bgid);
         if (prev && prev !== block.id) issues.push({ code: "duplicate-gameid", message: `block '${block.id}' address '${bgid}' is already used by block '${prev}' in ${where}`, id: block.id });
@@ -289,6 +296,7 @@ function validateProject(input) {
                 if (p.kind === "line" && p.character && !castNames.has(p.character)) {
                   issues.push({ code: "unknown-character", message: `prompt '${p.id}' speaker '${p.character}' is not in the project cast`, id: p.id });
                 }
+                checkQualifier(p, "prompt");
               }
             }
             if (fallbacks > 1) {
@@ -318,6 +326,7 @@ function validateProject(input) {
               id: beat.id
             });
           }
+          checkQualifier(beat, "beat");
         }
         if (node.jump) jumps.push({ to: node.jump.to, from: node.id });
       });
@@ -390,6 +399,18 @@ function validateProjectFile(project, issues) {
   if (project.recordingStatuses) {
     checkLadderNames(project.recordingStatuses.map((s) => s.name), "recordingStatuses", issues);
   }
+  const seenQualifiers = /* @__PURE__ */ new Set();
+  for (const q of project.qualifiers ?? []) {
+    if (typeof q.name !== "string" || !q.name.trim()) {
+      issues.push({ code: "invalid-qualifier", message: `qualifier '${String(q.gameId)}' has no name` });
+    }
+    if (typeof q.gameId !== "string" || !(0, import_model2.isValidGameId)(q.gameId)) {
+      issues.push({ code: "invalid-qualifier", message: `qualifier '${String(q.name)}' address '${String(q.gameId)}' is invalid (lowercase letters, digits, hyphens; no leading/trailing hyphen)` });
+    } else if (seenQualifiers.has(q.gameId)) {
+      issues.push({ code: "invalid-qualifier", message: `qualifier address '${q.gameId}' is used more than once` });
+    }
+    if (typeof q.gameId === "string") seenQualifiers.add(q.gameId);
+  }
   for (const [kind, fields] of Object.entries(project.gameDataFields ?? {})) {
     const seen = /* @__PURE__ */ new Set();
     for (const f of fields ?? []) {

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" | "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-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" | "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-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,7 +55,7 @@ ${indent}}`;
 }
 
 // src/validate.ts
-import { walkNodes, DEFAULT_WRITING_STATUSES, DEFAULT_RECORDING_STATUSES, DEFAULT_DOCUMENTATION_CLASSES } from "@patterkit/model";
+import { walkNodes, DEFAULT_WRITING_STATUSES, DEFAULT_RECORDING_STATUSES, DEFAULT_DOCUMENTATION_CLASSES, projectQualifiers } from "@patterkit/model";
 import { isValidGameId, effectiveGameId } from "@patterkit/model";
 import { isValidPropertyName, propertyNameify, RESERVED_PROPERTY_NAMES } from "@patterkit/model";
 function choiceLoopsBack(choice, ...targets) {
@@ -129,6 +129,12 @@ function validateProject(input) {
   const sceneGameIds = /* @__PURE__ */ new Map();
   const jumps = [];
   const castNames = new Set((project.cast ?? []).map((c) => c.name));
+  const qualifierIds = new Set(projectQualifiers(project).map((q) => q.gameId));
+  const checkQualifier = (beat, what) => {
+    if (beat.kind === "line" && beat.qualifier !== void 0 && !qualifierIds.has(beat.qualifier)) {
+      issues.push({ code: "unknown-qualifier", message: `${what} '${beat.id}' qualifier '${beat.qualifier}' is not in the project's qualifiers`, id: beat.id });
+    }
+  };
   const checkTags = (tags, where, id) => {
     for (const t of tags ?? []) {
       if (typeof t !== "string" || t.length === 0 || /[\s,]/.test(t)) {
@@ -136,6 +142,7 @@ function validateProject(input) {
       }
     }
   };
+  const addressOf = (node) => effectiveGameId({ gameId: node.gameId, name: typeof node.name === "string" ? node.name : "" });
   const seeId = (id, kind, where) => {
     if (typeof id !== "string" || id.length === 0) {
       issues.push({ code: "missing-id", message: `${kind} in ${where} has no id` });
@@ -160,7 +167,7 @@ function validateProject(input) {
     if (scene.gameId && !isValidGameId(scene.gameId)) {
       issues.push({ code: "invalid-gameid", message: `${where} address '${scene.gameId}' is invalid (lowercase letters, digits, hyphens; no leading/trailing hyphen)`, id: scene.id });
     }
-    const sgid = effectiveGameId(scene);
+    const sgid = addressOf(scene);
     if (sgid) {
       const prev = sceneGameIds.get(sgid);
       if (prev && prev !== scene.id) issues.push({ code: "duplicate-gameid", message: `${where} address '${sgid}' is already used by scene '${prev}'`, id: scene.id });
@@ -195,7 +202,7 @@ function validateProject(input) {
       if (block.gameId && !isValidGameId(block.gameId)) {
         issues.push({ code: "invalid-gameid", message: `block '${block.id}' address '${block.gameId}' is invalid (lowercase letters, digits, hyphens; no leading/trailing hyphen)`, id: block.id });
       }
-      const bgid = effectiveGameId(block);
+      const bgid = addressOf(block);
       if (bgid) {
         const prev = blockGameIds.get(bgid);
         if (prev && prev !== block.id) issues.push({ code: "duplicate-gameid", message: `block '${block.id}' address '${bgid}' is already used by block '${prev}' in ${where}`, id: block.id });
@@ -251,6 +258,7 @@ function validateProject(input) {
                 if (p.kind === "line" && p.character && !castNames.has(p.character)) {
                   issues.push({ code: "unknown-character", message: `prompt '${p.id}' speaker '${p.character}' is not in the project cast`, id: p.id });
                 }
+                checkQualifier(p, "prompt");
               }
             }
             if (fallbacks > 1) {
@@ -280,6 +288,7 @@ function validateProject(input) {
               id: beat.id
             });
           }
+          checkQualifier(beat, "beat");
         }
         if (node.jump) jumps.push({ to: node.jump.to, from: node.id });
       });
@@ -352,6 +361,18 @@ function validateProjectFile(project, issues) {
   if (project.recordingStatuses) {
     checkLadderNames(project.recordingStatuses.map((s) => s.name), "recordingStatuses", issues);
   }
+  const seenQualifiers = /* @__PURE__ */ new Set();
+  for (const q of project.qualifiers ?? []) {
+    if (typeof q.name !== "string" || !q.name.trim()) {
+      issues.push({ code: "invalid-qualifier", message: `qualifier '${String(q.gameId)}' has no name` });
+    }
+    if (typeof q.gameId !== "string" || !isValidGameId(q.gameId)) {
+      issues.push({ code: "invalid-qualifier", message: `qualifier '${String(q.name)}' address '${String(q.gameId)}' is invalid (lowercase letters, digits, hyphens; no leading/trailing hyphen)` });
+    } else if (seenQualifiers.has(q.gameId)) {
+      issues.push({ code: "invalid-qualifier", message: `qualifier address '${q.gameId}' is used more than once` });
+    }
+    if (typeof q.gameId === "string") seenQualifiers.add(q.gameId);
+  }
   for (const [kind, fields] of Object.entries(project.gameDataFields ?? {})) {
     const seen = /* @__PURE__ */ new Set();
     for (const f of fields ?? []) {

package/package.json

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