@patterkit/runtime 0.24.0 → 0.26.0

package/dist/index.d.cts

@@ -22,6 +22,7 @@ type StepResult = {
     direction?: string;
     qualifier?: string;
     qualifierName?: string;
+    speakerLabel?: string;
     padAfter: number;
     gameData?: GameData;
     tags?: string[];
@@ -58,6 +59,8 @@ interface BeatInfo {
     qualifier?: string;
     /** The qualifier's shown name (source locale), e.g. `V.O.`. */
     qualifierName?: string;
+    /** The speaker's label (source locale): `You (V.O.)`, a pair's own label, or with no qualifier the name. */
+    speakerLabel?: string;
     /** The pause after this beat, in seconds, resolved from its own value and the defaults above it (line and
      *  text only; see line padding). What a delivered step carries. */
     padAfter?: number;
@@ -133,6 +136,8 @@ interface ChoicePrompt {
     /** The speaker qualifier's `gameId` (`vo`), and its resolved shown name (locale-aware). */
     qualifier?: string;
     qualifierName?: string;
+    /** The name to show for the speaker (locale-aware): see {@link speakerLabelOf}. */
+    speakerLabel?: string;
     /** The prompt's resolved pause, in seconds: when it is spoken (by `replayPromptOnChoose`, or by a game that
      *  voices it), the wait before the reply, negative to cut in on the question (line padding). */
     padAfter: number;
@@ -379,6 +384,11 @@ interface FlowHost {
     castDisplay: Map<string, string>;
     /** Speaker qualifier gameId -> authored name (the unlocalised fallback when no loc string exists). */
     qualifierDisplay: Map<string, string>;
+    /** `<name>\0<gameId>` -> a character's own label with that qualifier, for the overridden pairs only (the
+     *  unlocalised fallback). A pair not here follows the pattern, whatever a loc file holds for it. */
+    speakerLabels: Map<string, string>;
+    /** The project's speaker pattern (the unlocalised fallback for the `speaker:pattern` string). */
+    speakerPattern: string;
     nodeIndex: Map<string, SelectableNode>;
     blockIndex: Map<string, {
         sceneId: string;
@@ -899,6 +909,15 @@ declare class Flow {
     private emit;
     /** How many times this flow has entered each node, by node id. */
     getVisitCounts(): Record<string, number>;
+    /**
+     * The step this flow would deliver for beat `beatId` right now, as `advance` would give it: its text in the
+     * active locale, interpolated against this flow's values (unless the project is voiced), closed captions
+     * applied, and the speaker's names and label, its pause, Game Data, and tags. Built by the same function that
+     * builds a delivered step, so the two can't differ. It doesn't move the flow, count a visit, or run an effect.
+     * Undefined for an id that is neither a beat nor an option's prompt. For a game that keeps lines by id and
+     * shows them again (after a load, or a language switch).
+     */
+    stepFor(beatId: string): StepResult | undefined;
     /** The options of a pending choice (empty when not at a choice point). */
     getChoices(): ChoiceOption[];
     /** Pick an eligible option by id; the next `advance()` runs it. */

package/dist/index.d.ts

@@ -22,6 +22,7 @@ type StepResult = {
     direction?: string;
     qualifier?: string;
     qualifierName?: string;
+    speakerLabel?: string;
     padAfter: number;
     gameData?: GameData;
     tags?: string[];
@@ -58,6 +59,8 @@ interface BeatInfo {
     qualifier?: string;
     /** The qualifier's shown name (source locale), e.g. `V.O.`. */
     qualifierName?: string;
+    /** The speaker's label (source locale): `You (V.O.)`, a pair's own label, or with no qualifier the name. */
+    speakerLabel?: string;
     /** The pause after this beat, in seconds, resolved from its own value and the defaults above it (line and
      *  text only; see line padding). What a delivered step carries. */
     padAfter?: number;
@@ -133,6 +136,8 @@ interface ChoicePrompt {
     /** The speaker qualifier's `gameId` (`vo`), and its resolved shown name (locale-aware). */
     qualifier?: string;
     qualifierName?: string;
+    /** The name to show for the speaker (locale-aware): see {@link speakerLabelOf}. */
+    speakerLabel?: string;
     /** The prompt's resolved pause, in seconds: when it is spoken (by `replayPromptOnChoose`, or by a game that
      *  voices it), the wait before the reply, negative to cut in on the question (line padding). */
     padAfter: number;
@@ -379,6 +384,11 @@ interface FlowHost {
     castDisplay: Map<string, string>;
     /** Speaker qualifier gameId -> authored name (the unlocalised fallback when no loc string exists). */
     qualifierDisplay: Map<string, string>;
+    /** `<name>\0<gameId>` -> a character's own label with that qualifier, for the overridden pairs only (the
+     *  unlocalised fallback). A pair not here follows the pattern, whatever a loc file holds for it. */
+    speakerLabels: Map<string, string>;
+    /** The project's speaker pattern (the unlocalised fallback for the `speaker:pattern` string). */
+    speakerPattern: string;
     nodeIndex: Map<string, SelectableNode>;
     blockIndex: Map<string, {
         sceneId: string;
@@ -899,6 +909,15 @@ declare class Flow {
     private emit;
     /** How many times this flow has entered each node, by node id. */
     getVisitCounts(): Record<string, number>;
+    /**
+     * The step this flow would deliver for beat `beatId` right now, as `advance` would give it: its text in the
+     * active locale, interpolated against this flow's values (unless the project is voiced), closed captions
+     * applied, and the speaker's names and label, its pause, Game Data, and tags. Built by the same function that
+     * builds a delivered step, so the two can't differ. It doesn't move the flow, count a visit, or run an effect.
+     * Undefined for an id that is neither a beat nor an option's prompt. For a game that keeps lines by id and
+     * shows them again (after a load, or a language switch).
+     */
+    stepFor(beatId: string): StepResult | undefined;
     /** The options of a pending choice (empty when not at a choice point). */
     getChoices(): ChoiceOption[];
     /** Pick an eligible option by id; the next `advance()` runs it. */

package/dist/index.js

@@ -4,7 +4,7 @@ import { matchedSpecificity as scoreSpecificity } from "@wildwinter/expr-specifi
 import { ScopeRegistry } from "@wildwinter/scoperegistry";
 import { defaultFor, PropertyBag } from "@wildwinter/scoperegistry";
 import { patterDialect, interpolate, splitRef, stripCaptions } from "@patterkit/dialect";
-import { walkNodes, effectiveGameId, castStringKey, qualifierStringKey, DEFAULT_PAD_AFTER as DEFAULT_PAD_AFTER2, DEFAULT_CAPTION_DELIMITERS, DEFAULT_CAPTION_CHARACTER } from "@patterkit/model";
+import { walkNodes, effectiveGameId, castStringKey, qualifierStringKey, speakerLabelKey, formatSpeakerLabel, SPEAKER_PATTERN_KEY, DEFAULT_SPEAKER_PATTERN, DEFAULT_PAD_AFTER as DEFAULT_PAD_AFTER2, DEFAULT_CAPTION_DELIMITERS, DEFAULT_CAPTION_CHARACTER } from "@patterkit/model";
 
 // src/tags.ts
 function dedupe(tags) {
@@ -100,6 +100,25 @@ function padIndexFor(bundle) {
   }
   return index;
 }
+var beatIndexCache = /* @__PURE__ */ new WeakMap();
+function beatIndexFor(bundle) {
+  let index = beatIndexCache.get(bundle);
+  if (index) return index;
+  index = /* @__PURE__ */ new Map();
+  for (const scene of Object.values(bundle.scenes)) {
+    for (const block of scene.blocks) {
+      walkNodes(block.children, (n) => {
+        if (n.type === "group") {
+          if (n.prompt) index.set(n.prompt.id, n.prompt);
+          return;
+        }
+        for (const beat of n.beats ?? []) index.set(beat.id, beat);
+      });
+    }
+  }
+  beatIndexCache.set(bundle, index);
+  return index;
+}
 function tagsOf(host, id) {
   return host.tagIndex.get(id)?.slice();
 }
@@ -168,6 +187,9 @@ var Engine = class _Engine {
     for (const c of bundle.cast ?? []) if (c.displayName) castDisplay.set(c.name, c.displayName);
     const qualifierDisplay = /* @__PURE__ */ new Map();
     for (const q of bundle.qualifiers ?? []) if (q?.gameId) qualifierDisplay.set(q.gameId, q.name);
+    const speakerLabels = /* @__PURE__ */ new Map();
+    for (const c of bundle.cast ?? []) for (const [q, label] of Object.entries(c.qualifierLabels ?? {})) if (typeof label === "string") speakerLabels.set(`${c.name}\0${q}`, label);
+    const speakerPattern = bundle.speakerPattern ?? DEFAULT_SPEAKER_PATTERN;
     this.defaultSeed = (options.seed ?? 2654435769) >>> 0;
     const nodeIndex = /* @__PURE__ */ new Map();
     const blockIndex = /* @__PURE__ */ new Map();
@@ -229,6 +251,8 @@ var Engine = class _Engine {
       defaultStrings,
       castDisplay,
       qualifierDisplay,
+      speakerLabels,
+      speakerPattern,
       nodeIndex,
       blockIndex,
       blockById,
@@ -639,6 +663,8 @@ var Engine = class _Engine {
         const name = this.host.defaultStrings[qualifierStringKey(beat.qualifier)] ?? this.host.qualifierDisplay.get(beat.qualifier);
         if (name !== void 0) info.qualifierName = name;
       }
+      const label = speakerLabelOf(this.host, beat.character, beat.qualifier, true);
+      if (label !== void 0) info.speakerLabel = label;
     }
     if (beat.kind === "line" || beat.kind === "text") {
       const pad = this.host.padIndex.get(beat.id);
@@ -1345,6 +1371,18 @@ var Flow = class {
   getVisitCounts() {
     return Object.fromEntries(this.visitCounts);
   }
+  /**
+   * The step this flow would deliver for beat `beatId` right now, as `advance` would give it: its text in the
+   * active locale, interpolated against this flow's values (unless the project is voiced), closed captions
+   * applied, and the speaker's names and label, its pause, Game Data, and tags. Built by the same function that
+   * builds a delivered step, so the two can't differ. It doesn't move the flow, count a visit, or run an effect.
+   * Undefined for an id that is neither a beat nor an option's prompt. For a game that keeps lines by id and
+   * shows them again (after a load, or a language switch).
+   */
+  stepFor(beatId) {
+    const beat = beatIndexFor(this.host.bundle).get(beatId);
+    return beat ? this.beatResult(beat) : void 0;
+  }
   /** The options of a pending choice (empty when not at a choice point). */
   getChoices() {
     return this.pendingChoice?.options ?? [];
@@ -1477,7 +1515,8 @@ var Flow = class {
         if (!node) continue;
         byId.set(o.id, node);
         const { prompt: saved, ...rest } = o;
-        options.push({ ...rest, ...saved ? { prompt: { ...saved, padAfter: saved.padAfter ?? this.promptPadOf(node) } } : {} });
+        const label = saved?.kind === "line" && saved.speakerLabel === void 0 ? speakerLabelOf(this.host, saved.character, saved.qualifier) : void 0;
+        options.push({ ...rest, ...saved ? { prompt: { ...saved, padAfter: saved.padAfter ?? this.promptPadOf(node), ...label !== void 0 ? { speakerLabel: label } : {} } } : {} });
       }
       if (options.length > 0) this.pendingChoice = { groupId: c.pendingChoice.groupId, options, byId };
     }
@@ -1486,7 +1525,9 @@ var Flow = class {
     if (this.pendingPromptOwnerId) {
       const owner = this.host.nodeIndex.get(this.pendingPromptOwnerId);
       const beat = owner ? this.authoredPromptOf(owner) : void 0;
-      if (beat) this.pendingPrompt = { beat, ...c.pendingPrompt ? { shown: { ...c.pendingPrompt, padAfter: c.pendingPrompt.padAfter ?? this.padOf(beat.id) } } : {} };
+      const saved = c.pendingPrompt;
+      const label = saved?.kind === "line" && saved.speakerLabel === void 0 ? speakerLabelOf(this.host, saved.character, saved.qualifier) : void 0;
+      if (beat) this.pendingPrompt = { beat, ...saved ? { shown: { ...saved, padAfter: saved.padAfter ?? this.padOf(beat.id), ...label !== void 0 ? { speakerLabel: label } : {} } } : {} };
       else this.pendingPromptOwnerId = null;
     }
   }
@@ -1872,6 +1913,7 @@ var Flow = class {
           direction: silent ? void 0 : beat.direction,
           qualifier: silent ? void 0 : beat.qualifier,
           qualifierName: silent ? void 0 : this.resolveQualifierName(beat.qualifier),
+          speakerLabel: silent ? void 0 : speakerLabelOf(this.host, beat.character, beat.qualifier),
           padAfter: this.padOf(beat.id),
           // a silent line still fires, so it still carries its pause
           gameData: beat.gameData,
@@ -1921,6 +1963,7 @@ var Flow = class {
       direction: beat.direction,
       qualifier: beat.qualifier,
       qualifierName: this.resolveQualifierName(beat.qualifier),
+      speakerLabel: speakerLabelOf(this.host, beat.character, beat.qualifier),
       padAfter
     } : { kind: "text", text, padAfter };
   }
@@ -1943,6 +1986,7 @@ var Flow = class {
       direction: shown.direction,
       qualifier: shown.qualifier,
       qualifierName: shown.qualifierName,
+      speakerLabel: shown.speakerLabel,
       padAfter: this.padOf(beat.id),
       gameData: beat.gameData,
       ...withTags
@@ -2088,6 +2132,16 @@ function collectCast(nodes, out) {
     for (const beat of n.beats ?? []) if (beat.kind === "line" && beat.character) out.add(beat.character);
   });
 }
+function speakerLabelOf(host, character, qualifier, source = false) {
+  if (!character || host.emitIds) return void 0;
+  const lookup = (key) => (source ? void 0 : host.strings[key]) ?? host.defaultStrings[key];
+  const name = lookup(castStringKey(character)) ?? host.castDisplay.get(character) ?? character;
+  if (qualifier === void 0) return name;
+  const own = host.speakerLabels.get(`${character}\0${qualifier}`);
+  if (own !== void 0) return lookup(speakerLabelKey(character, qualifier)) ?? own;
+  const shown = lookup(qualifierStringKey(qualifier)) ?? host.qualifierDisplay.get(qualifier) ?? qualifier;
+  return formatSpeakerLabel(lookup(SPEAKER_PATTERN_KEY) ?? host.speakerPattern, name, shown);
+}
 function gameDataField(gameData) {
   return gameData && Object.keys(gameData).length ? { gameData } : {};
 }
@@ -2098,6 +2152,7 @@ function savedPrompt(p) {
   if (p.direction !== void 0) out.direction = p.direction;
   if (p.qualifier !== void 0) out.qualifier = p.qualifier;
   if (p.qualifierName !== void 0) out.qualifierName = p.qualifierName;
+  if (p.speakerLabel !== void 0) out.speakerLabel = p.speakerLabel;
   if (typeof p.padAfter === "number") out.padAfter = p.padAfter;
   return out;
 }