@patterkit/runtime 0.23.0 → 0.25.0

package/CHANGELOG.md

@@ -33,6 +33,31 @@ version number always means the same runtime behaviour. This package is versione
 
 ## [Unreleased]
 
+## [0.25.0] - 2026-10-14
+
+### Added
+
+- **Speaker labels**: a line step, a line choice prompt, and a beat's info carry `speakerLabel`, the name to
+  show for the speaker, localised. With a qualifier it is the character's own label for that pair when the
+  project gives one (`speaker:<NAME>:<qualifier>`), else the project's speaker pattern (`speaker:pattern`,
+  `{name} ({qualifier})` by default) filled with the shown name and the qualifier's shown name; with none, the
+  shown name (the token when the cast gives none). Each piece follows the active locale, then the default, then
+  the authored value. A translated pair label counts only for a pair the project overrides. Absent with no
+  speaker, on a silenced line, and in IDs-only mode. Saved choice prompts carry it, and an older save works it
+  out again on load.
+
+## [0.24.0] - 2026-10-11
+
+### Added
+
+- **Flow capture and restore**: `engine.captureFlow(id)` takes one flow out as a `FlowState`, plain data in the
+  save's own spelling (its snapshot, a `version`, and its own values as a version 2 save's per-flow `scopes`
+  and `sceneBags`, without its id), and `engine.restoreFlow(id, state)` opens it again under any id, as
+  `loadGame` restores each flow. Shared state isn't in it, so a restore rewinds nothing else, and anything a
+  load left waiting under the id is dropped first, as when a flow starts. Refused over an open id, while a
+  checkpoint is open, and for a state with no cursor, changing nothing; capturing is allowed in a checkpoint.
+  The conformance corpus holds every runtime to it.
+
 ## [0.23.0] - 2026-10-10
 
 ### Added

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ian Thomas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -110,6 +110,10 @@ value); `engine.loadGame(blob)` restores it. Saves from before property values m
 registry (version 2) still load. [@patterkit/play-helpers](../play-helpers) wraps these as
 `serializeState` / `deserializeState` with a tagged envelope.
 
+To set one flow aside instead, `engine.captureFlow(id)` returns its part of a save as plain data (its
+position, PRNG, visits, selectors, and its own property values, without its id); close it after capturing,
+and `engine.restoreFlow(newId, state)` opens it again later, under any id, without rewinding shared state.
+
 ## One registry per game
 
 A game has one `ScopeRegistry` holding every property from every engine, except values the game

package/dist/index.cjs

@@ -139,6 +139,7 @@ function tagsOf(host, id) {
 }
 var OWNER = "Patter";
 var esc = (id) => id.replace(/%/g, "%25").replace(/\//g, "%2F");
+var unesc = (key) => key.replace(/%2F/g, "/").replace(/%25/g, "%");
 var OWNS_REGISTRY = /* @__PURE__ */ Symbol("ownsRegistry");
 var keys = {
   /** A scene's SHARED `@scene` props (one bag per scene, every flow's). */
@@ -201,6 +202,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 ?? import_model2.DEFAULT_SPEAKER_PATTERN;
     this.defaultSeed = (options.seed ?? 2654435769) >>> 0;
     const nodeIndex = /* @__PURE__ */ new Map();
     const blockIndex = /* @__PURE__ */ new Map();
@@ -262,6 +266,8 @@ var Engine = class _Engine {
       defaultStrings,
       castDisplay,
       qualifierDisplay,
+      speakerLabels,
+      speakerPattern,
       nodeIndex,
       blockIndex,
       blockById,
@@ -672,6 +678,8 @@ var Engine = class _Engine {
         const name = this.host.defaultStrings[(0, import_model2.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);
@@ -767,6 +775,45 @@ var Engine = class _Engine {
   refuseInCheckpoint(what) {
     if (this.host.journal) throw new Error(`${what} can't be undone, so it isn't allowed while a checkpoint is open`);
   }
+  /**
+   * Take flow `id` out of the engine as plain data, to be put back later with {@link restoreFlow}: its snapshot as
+   * `saveGame` writes it, and its own property values without its id (so it can come back under another). Shared
+   * state is never in it. Doesn't close the flow; close it with {@link closeFlow} AFTER capturing, since closing
+   * drops its values. Only reads, so it is allowed while a checkpoint is open.
+   */
+  captureFlow(id) {
+    const flow = this.flowsById.get(id);
+    if (!flow) throw new Error(`no open flow '${id}' to capture`);
+    return { version: import_model3.SAVE_VERSION, ...flow.snapshot(), ...flowValuesFrom(id, this.host.registry.save()) };
+  }
+  /**
+   * Open flow `id` from a {@link captureFlow} state, the per-flow half of `loadGame`: its values go into the
+   * registry as a load's do, and the flow is restored as a load restores each flow. `id` needn't be the id it was
+   * captured from. Against an edited bundle it re-finds its place by id, as a load does. Refused if a flow of
+   * that id is open, or while a checkpoint is.
+   */
+  restoreFlow(id, state) {
+    this.refuseInCheckpoint("restoreFlow");
+    const version = state.version;
+    if (version !== 2 && version !== import_model3.SAVE_VERSION) throw new Error(`unsupported flow state version: ${String(version)}`);
+    const cursor = state.cursor;
+    if (typeof cursor !== "object" || cursor === null) throw new Error("malformed flow state: no cursor");
+    if (this.flowsById.has(id)) throw new Error(`a flow '${id}' is already open; close it before restoring another under that id`);
+    this.assertExternalScopes();
+    const parked = keys.flow(id);
+    this.host.registry.discardParked(parked);
+    this.host.registry.load(flowSections(id, state), { keepParked: true });
+    const flow = new Flow(id, this.host, this.defaultSeed);
+    try {
+      flow.restore(state);
+    } catch (e) {
+      flow.close();
+      this.host.registry.discardParked(parked);
+      throw e;
+    }
+    this.flowsById.set(id, flow);
+    return flow;
+  }
   /** Close (remove) a flow. The flow object is FINISHED, not merely unregistered, so a host still
    *  holding it cannot keep advancing it into the shared world (see {@link Flow.close}). */
   closeFlow(id) {
@@ -1471,7 +1518,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 };
     }
@@ -1480,7 +1528,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;
     }
   }
@@ -1866,6 +1916,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,
@@ -1915,6 +1966,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 };
   }
@@ -1937,6 +1989,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
@@ -2082,6 +2135,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((0, import_model2.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((0, import_model2.speakerLabelKey)(character, qualifier)) ?? own;
+  const shown = lookup((0, import_model2.qualifierStringKey)(qualifier)) ?? host.qualifierDisplay.get(qualifier) ?? qualifier;
+  return (0, import_model2.formatSpeakerLabel)(lookup(import_model2.SPEAKER_PATTERN_KEY) ?? host.speakerPattern, name, shown);
+}
 function gameDataField(gameData) {
   return gameData && Object.keys(gameData).length ? { gameData } : {};
 }
@@ -2092,6 +2155,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;
 }
@@ -2170,9 +2234,23 @@ function sectionsFromV2(save) {
   const out = {};
   if (save.shared?.patter) out["patter"] = save.shared.patter;
   for (const [s, v] of Object.entries(save.stageBags ?? {})) out[keys.stage(s)] = v;
-  for (const [id, f] of Object.entries(save.flows ?? {})) {
-    if (f.scopes?.patter) out[keys.flowGlobals(id)] = f.scopes.patter;
-    for (const [s, v] of Object.entries(f.sceneBags ?? {})) out[keys.flowScene(id, s)] = v;
+  for (const [id, f] of Object.entries(save.flows ?? {})) Object.assign(out, flowSections(id, f));
+  return out;
+}
+function flowSections(id, f) {
+  const out = {};
+  if (f.scopes?.patter) out[keys.flowGlobals(id)] = f.scopes.patter;
+  for (const [s, v] of Object.entries(f.sceneBags ?? {})) out[keys.flowScene(id, s)] = v;
+  return out;
+}
+function flowValuesFrom(id, saved) {
+  const out = { scopes: {}, sceneBags: {} };
+  const prefix = keys.flow(id);
+  for (const [key, values] of Object.entries(saved)) {
+    if (!key.startsWith(prefix)) continue;
+    const rest = key.slice(prefix.length);
+    if (rest === "patter") out.scopes.patter = values;
+    else if (rest.startsWith("scene/")) out.sceneBags[unesc(rest.slice("scene/".length))] = values;
   }
   return out;
 }