@patterkit/runtime 0.23.0 → 0.24.0

package/dist/index.d.cts

@@ -1,8 +1,8 @@
 import { ScalarValue } from '@wildwinter/expr';
 import { ScopeRegistry, PropertyBag, ScopeDeclaration, LogMount, ScopeResolver, PropertyRow } from '@wildwinter/scoperegistry';
 export { PropertyRow } from '@wildwinter/scoperegistry';
-import { GameData, Bundle, CompiledGroup, CompiledSnippet, CompiledBlock, FlowSnapshot, EngineSave, SaveGame, SaveGameV2, PropertyType, ScalarValue as ScalarValue$1, GameDataNodeKind, GameDataField } from '@patterkit/model';
-export { Bundle, DEFAULT_PAD_AFTER, EngineSave, FlowCursor, FlowSnapshot, SaveEnvelope, SaveGame, SavedChoice, SavedChoiceOption, SavedChoicePrompt, SelectorSnapshot, StackFrame } from '@patterkit/model';
+import { GameData, Bundle, CompiledGroup, CompiledSnippet, CompiledBlock, FlowSnapshot, FlowState, EngineSave, SaveGame, SaveGameV2, PropertyType, ScalarValue as ScalarValue$1, GameDataNodeKind, GameDataField } from '@patterkit/model';
+export { Bundle, DEFAULT_PAD_AFTER, EngineSave, FlowCursor, FlowSnapshot, FlowState, FlowValues, SaveEnvelope, SaveGame, SavedChoice, SavedChoiceOption, SavedChoicePrompt, SelectorSnapshot, StackFrame } from '@patterkit/model';
 
 /** A beat's own `padAfter` (when it sets one) and its resolved one (always). */
 interface BeatPad {
@@ -686,6 +686,20 @@ declare class Engine {
     /** Let go of what a closed checkpoint recorded, so a handle the game keeps holds nothing. */
     private static forget;
     private refuseInCheckpoint;
+    /**
+     * 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: string): FlowState;
+    /**
+     * 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: string, state: FlowState): 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: string): void;

package/dist/index.d.ts

@@ -1,8 +1,8 @@
 import { ScalarValue } from '@wildwinter/expr';
 import { ScopeRegistry, PropertyBag, ScopeDeclaration, LogMount, ScopeResolver, PropertyRow } from '@wildwinter/scoperegistry';
 export { PropertyRow } from '@wildwinter/scoperegistry';
-import { GameData, Bundle, CompiledGroup, CompiledSnippet, CompiledBlock, FlowSnapshot, EngineSave, SaveGame, SaveGameV2, PropertyType, ScalarValue as ScalarValue$1, GameDataNodeKind, GameDataField } from '@patterkit/model';
-export { Bundle, DEFAULT_PAD_AFTER, EngineSave, FlowCursor, FlowSnapshot, SaveEnvelope, SaveGame, SavedChoice, SavedChoiceOption, SavedChoicePrompt, SelectorSnapshot, StackFrame } from '@patterkit/model';
+import { GameData, Bundle, CompiledGroup, CompiledSnippet, CompiledBlock, FlowSnapshot, FlowState, EngineSave, SaveGame, SaveGameV2, PropertyType, ScalarValue as ScalarValue$1, GameDataNodeKind, GameDataField } from '@patterkit/model';
+export { Bundle, DEFAULT_PAD_AFTER, EngineSave, FlowCursor, FlowSnapshot, FlowState, FlowValues, SaveEnvelope, SaveGame, SavedChoice, SavedChoiceOption, SavedChoicePrompt, SelectorSnapshot, StackFrame } from '@patterkit/model';
 
 /** A beat's own `padAfter` (when it sets one) and its resolved one (always). */
 interface BeatPad {
@@ -686,6 +686,20 @@ declare class Engine {
     /** Let go of what a closed checkpoint recorded, so a handle the game keeps holds nothing. */
     private static forget;
     private refuseInCheckpoint;
+    /**
+     * 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: string): FlowState;
+    /**
+     * 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: string, state: FlowState): 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: string): void;

package/dist/index.js

@@ -105,6 +105,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). */
@@ -733,6 +734,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: 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 !== 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) {
@@ -2136,9 +2176,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;
 }