@patterkit/model 0.4.1 → 0.6.0

package/dist/index.cjs

@@ -30,6 +30,8 @@ __export(index_exports, {
   RERECORD_STATUS: () => RERECORD_STATUS,
   RERECORD_STATUS_DECL: () => RERECORD_STATUS_DECL,
   RESERVED_PROPERTY_NAMES: () => import_expr.RESERVED_PROPERTY_NAMES,
+  SAVE_SCHEMA: () => SAVE_SCHEMA,
+  SAVE_VERSION: () => SAVE_VERSION,
   castStringKey: () => castStringKey,
   deriveRecordingFolders: () => deriveRecordingFolders,
   effectiveGameId: () => effectiveGameId,
@@ -113,6 +115,8 @@ function castStringKey(name) {
 }
 var DEFAULT_CAPTION_DELIMITERS = { open: "[", close: "]" };
 var DEFAULT_CAPTION_CHARACTER = "SFX";
+var SAVE_SCHEMA = "patter/save@0";
+var SAVE_VERSION = 3;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   COMMON_GENDERS,
@@ -125,6 +129,8 @@ var DEFAULT_CAPTION_CHARACTER = "SFX";
   RERECORD_STATUS,
   RERECORD_STATUS_DECL,
   RESERVED_PROPERTY_NAMES,
+  SAVE_SCHEMA,
+  SAVE_VERSION,
   castStringKey,
   deriveRecordingFolders,
   effectiveGameId,

package/dist/index.d.cts

@@ -809,6 +809,10 @@ interface Bundle {
     /** Host / world scope declarations, baked from the project so the runtime can self-back a declared
      *  scope (`@world`, ...) when no host resolver claims its token. Absent = no host scopes. */
     scopeRegistry?: HostScopeRegistry;
+    /** Other engines' game-wide scopes the content names (`story`), sorted: the family's shared vocabulary,
+     *  opaque to the compiler and never self-backed. The engine reports when the game has not registered
+     *  one. Absent when none. */
+    externalScopes?: string[];
     gameDataFields?: GameDataFields;
     scenes: Record<string, CompiledScene>;
     /** locale -> (beatId -> text). In "embedded" localisation this carries every included locale; in "ids"
@@ -845,5 +849,112 @@ declare const DEFAULT_CAPTION_DELIMITERS: CaptionDelimiters;
 /** The default caption character: a cast member named `SFX` whose lines are pure captions (omitted when
  *  captions are off). Applies even to a project that pins no `closedCaptions`. */
 declare const DEFAULT_CAPTION_CHARACTER = "SFX";
+declare const SAVE_SCHEMA = "patter/save@0";
+/** The `save.version` inside the envelope. Bumped only when a reader would MISREAD an older save. */
+declare const SAVE_VERSION = 3;
+/** The tagged envelope a host stores: `serializeState` writes it, `deserializeState` refuses anything else. */
+interface SaveEnvelope {
+    schema: typeof SAVE_SCHEMA;
+    save: SaveGame;
+}
+/** A registry's values: registry key -> property name -> value (`{ patter: { gold: 7 } }`). */
+type EngineSave = Record<string, Record<string, ScalarValue>>;
+/** Serialised `sequence` selector visit state for one group (spec §4 / §7). Every key is OPTIONAL and
+ *  present only once the selector has used it: `seq` after the first sequential pick, `bag` once a
+ *  shuffle has drawn, `last` once there is a no-immediate-repeat memory. A port that stores "started"
+ *  flags derives them from key presence rather than writing them. */
+interface SelectorSnapshot {
+    seq?: number;
+    bag?: string[];
+    last?: string;
+}
+/** One entry on a flow's continuation stack: a position within a container's children. */
+interface StackFrame {
+    sceneId: string;
+    /** A block id or a run-group id (both are sequential containers). */
+    containerId: string;
+    index: number;
+    /** SNAPSHOT-ONLY (never on a live frame): the id of the child at `index` when the save was taken, so a
+     *  restore against an EDITED bundle re-finds the position by id. Absent when the frame sat at its
+     *  container's end (no next child), or in an older save. */
+    nextId?: string;
+}
+/** The prompt of a saved choice option: the choice text as a structured line/text beat. */
+interface SavedChoicePrompt {
+    kind: "line" | "text";
+    text: string;
+    character?: string;
+    characterName?: string;
+    direction?: string;
+}
+/** One option of a pending choice, saved VERBATIM: re-deriving on load would re-evaluate conditions. */
+interface SavedChoiceOption {
+    id: string;
+    prompt?: SavedChoicePrompt;
+    eligible: boolean;
+    gameData?: GameData;
+}
+/** A pending choice as saved: the option set the player was shown, replayed on load (schema 9.3). */
+interface SavedChoice {
+    groupId: string;
+    options: SavedChoiceOption[];
+}
+/** The flow's execution position: where it is, and what it is waiting on. */
+interface FlowCursor {
+    flowEnded: boolean;
+    currentSceneId: string | null;
+    /** The continuation stack (call frames + the active block run), root first. */
+    stack: StackFrame[];
+    activeSnippetId: string | null;
+    beatIndex: number;
+    /** Present (non-null) iff the flow is stopped at a choice. */
+    pendingChoice: SavedChoice | null;
+    /** The chosen option owning a prompt still to be replayed (a save taken between choose + advance).
+     *  Optional / null in older saves -> no pending prompt. */
+    pendingPromptOwnerId?: string | null;
+    /** This flow's (non-shared) selector cursors, keyed by group id. */
+    selectors: Record<string, SelectorSnapshot>;
+}
+/** The serialised cursor + PRNG + visits of a single flow. Its properties are the registry's. */
+interface FlowSnapshot {
+    /** This flow's built-in PRNG position (mulberry32 state, uint32; older saves may carry it signed). */
+    rngState: number;
+    /** This flow's per-node entry counts (node id -> times entered by this flow). */
+    visits: Record<string, number>;
+    cursor: FlowCursor;
+}
+/** A full resumable save-game (version 3): everything that is not a property, plus the registry's
+ *  values when the engine made its own registry. */
+interface SaveGame {
+    version: 3;
+    /** The engine's own registry's values, keyed by registry key: present only when the engine made the
+     *  registry itself (a standalone game). A game that passed a registry saves it once, beside this. */
+    registry?: EngineSave;
+    /** World-wide per-node entry counts (node id -> times entered by any flow). */
+    sharedVisits: Record<string, number>;
+    /** Shared selector cursors (node id -> snapshot) for `shared` memoried selectors. */
+    sharedSelectors: Record<string, SelectorSnapshot>;
+    /** Each live flow's snapshot, keyed by flow id. */
+    flows: Record<string, FlowSnapshot>;
+}
+/** A version 2 flow snapshot, which carried the flow's property values itself. Still read. */
+interface FlowSnapshotV2 extends FlowSnapshot {
+    /** The NOT-shared `@patter` globals, under token "patter". */
+    scopes: EngineSave;
+    /** Per-scene NOT-shared `@scene` bags (scene id -> name -> value). */
+    sceneBags: Record<string, Record<string, ScalarValue>>;
+}
+/** A version 2 save, from before the registry held the properties. Every runtime still reads it: its
+ *  property sections move into the registry (under the keys in the header above) as it loads. */
+interface SaveGameV2 {
+    version: 2;
+    /** Shared `@patter` globals (owned scope "patter"). */
+    shared: EngineSave;
+    sharedVisits: Record<string, number>;
+    sharedSelectors: Record<string, SelectorSnapshot>;
+    /** Shared, scene-namespaced `@scene` bags (scene id -> name -> value). */
+    stageBags: Record<string, Record<string, ScalarValue>>;
+    flows: Record<string, FlowSnapshotV2>;
+}
 
-export { type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, COMMON_GENDERS, type CaptionDelimiters, type CastMember, type Comment, type CommentMessage, type CommentRange, type CompiledBlock, type CompiledEffect, type CompiledGroup, type CompiledScene, type CompiledSnippet, type CoverageDriver, DEFAULT_CAPTION_CHARACTER, DEFAULT_CAPTION_DELIMITERS, DEFAULT_DOCUMENTATION_CLASSES, DEFAULT_RECORDING_STATUSES, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, type EditRecord, type Effect, type EstimatingConfig, type Expression, type FlowFile, type FlowNode, type GameData, type GameDataField, type GameDataFieldType, type GameDataFields, type GameDataNodeKind, type GameEventBeat, type GrammaticalGender, type Group, type HostScopeDecl, type HostScopeRegistry, type HostScopeSpec, type Jump, type JumpTarget, type LineBeat, type LocaleFile, PROJECT_LOCALE_SCENE, type ProjectDictionary, type ProjectFile, type PromptBeat, type PropertyDecl, type PropertyType, RERECORD_STATUS, RERECORD_STATUS_DECL, type RecordingFolder, type RecordingStatusDecl, type ScalarValue, type Scene, type Selector, type SelectorExhaust, type SelectorOrder, type SequenceOptions, type Snippet, type Suggestion, type TextBeat, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, gameIdify, isContentlessBeat, isValidGameId, walkNodes };
+export { type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, COMMON_GENDERS, type CaptionDelimiters, type CastMember, type Comment, type CommentMessage, type CommentRange, type CompiledBlock, type CompiledEffect, type CompiledGroup, type CompiledScene, type CompiledSnippet, type CoverageDriver, DEFAULT_CAPTION_CHARACTER, DEFAULT_CAPTION_DELIMITERS, DEFAULT_DOCUMENTATION_CLASSES, DEFAULT_RECORDING_STATUSES, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, type EditRecord, type Effect, type EngineSave, type EstimatingConfig, type Expression, type FlowCursor, type FlowFile, type FlowNode, type FlowSnapshot, type FlowSnapshotV2, type GameData, type GameDataField, type GameDataFieldType, type GameDataFields, type GameDataNodeKind, type GameEventBeat, type GrammaticalGender, type Group, type HostScopeDecl, type HostScopeRegistry, type HostScopeSpec, type Jump, type JumpTarget, type LineBeat, type LocaleFile, PROJECT_LOCALE_SCENE, type ProjectDictionary, type ProjectFile, type PromptBeat, type PropertyDecl, type PropertyType, RERECORD_STATUS, RERECORD_STATUS_DECL, type RecordingFolder, type RecordingStatusDecl, SAVE_SCHEMA, SAVE_VERSION, type SaveEnvelope, type SaveGame, type SaveGameV2, type SavedChoice, type SavedChoiceOption, type SavedChoicePrompt, type ScalarValue, type Scene, type Selector, type SelectorExhaust, type SelectorOrder, type SelectorSnapshot, type SequenceOptions, type Snippet, type StackFrame, type Suggestion, type TextBeat, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, gameIdify, isContentlessBeat, isValidGameId, walkNodes };

package/dist/index.d.ts

@@ -809,6 +809,10 @@ interface Bundle {
     /** Host / world scope declarations, baked from the project so the runtime can self-back a declared
      *  scope (`@world`, ...) when no host resolver claims its token. Absent = no host scopes. */
     scopeRegistry?: HostScopeRegistry;
+    /** Other engines' game-wide scopes the content names (`story`), sorted: the family's shared vocabulary,
+     *  opaque to the compiler and never self-backed. The engine reports when the game has not registered
+     *  one. Absent when none. */
+    externalScopes?: string[];
     gameDataFields?: GameDataFields;
     scenes: Record<string, CompiledScene>;
     /** locale -> (beatId -> text). In "embedded" localisation this carries every included locale; in "ids"
@@ -845,5 +849,112 @@ declare const DEFAULT_CAPTION_DELIMITERS: CaptionDelimiters;
 /** The default caption character: a cast member named `SFX` whose lines are pure captions (omitted when
  *  captions are off). Applies even to a project that pins no `closedCaptions`. */
 declare const DEFAULT_CAPTION_CHARACTER = "SFX";
+declare const SAVE_SCHEMA = "patter/save@0";
+/** The `save.version` inside the envelope. Bumped only when a reader would MISREAD an older save. */
+declare const SAVE_VERSION = 3;
+/** The tagged envelope a host stores: `serializeState` writes it, `deserializeState` refuses anything else. */
+interface SaveEnvelope {
+    schema: typeof SAVE_SCHEMA;
+    save: SaveGame;
+}
+/** A registry's values: registry key -> property name -> value (`{ patter: { gold: 7 } }`). */
+type EngineSave = Record<string, Record<string, ScalarValue>>;
+/** Serialised `sequence` selector visit state for one group (spec §4 / §7). Every key is OPTIONAL and
+ *  present only once the selector has used it: `seq` after the first sequential pick, `bag` once a
+ *  shuffle has drawn, `last` once there is a no-immediate-repeat memory. A port that stores "started"
+ *  flags derives them from key presence rather than writing them. */
+interface SelectorSnapshot {
+    seq?: number;
+    bag?: string[];
+    last?: string;
+}
+/** One entry on a flow's continuation stack: a position within a container's children. */
+interface StackFrame {
+    sceneId: string;
+    /** A block id or a run-group id (both are sequential containers). */
+    containerId: string;
+    index: number;
+    /** SNAPSHOT-ONLY (never on a live frame): the id of the child at `index` when the save was taken, so a
+     *  restore against an EDITED bundle re-finds the position by id. Absent when the frame sat at its
+     *  container's end (no next child), or in an older save. */
+    nextId?: string;
+}
+/** The prompt of a saved choice option: the choice text as a structured line/text beat. */
+interface SavedChoicePrompt {
+    kind: "line" | "text";
+    text: string;
+    character?: string;
+    characterName?: string;
+    direction?: string;
+}
+/** One option of a pending choice, saved VERBATIM: re-deriving on load would re-evaluate conditions. */
+interface SavedChoiceOption {
+    id: string;
+    prompt?: SavedChoicePrompt;
+    eligible: boolean;
+    gameData?: GameData;
+}
+/** A pending choice as saved: the option set the player was shown, replayed on load (schema 9.3). */
+interface SavedChoice {
+    groupId: string;
+    options: SavedChoiceOption[];
+}
+/** The flow's execution position: where it is, and what it is waiting on. */
+interface FlowCursor {
+    flowEnded: boolean;
+    currentSceneId: string | null;
+    /** The continuation stack (call frames + the active block run), root first. */
+    stack: StackFrame[];
+    activeSnippetId: string | null;
+    beatIndex: number;
+    /** Present (non-null) iff the flow is stopped at a choice. */
+    pendingChoice: SavedChoice | null;
+    /** The chosen option owning a prompt still to be replayed (a save taken between choose + advance).
+     *  Optional / null in older saves -> no pending prompt. */
+    pendingPromptOwnerId?: string | null;
+    /** This flow's (non-shared) selector cursors, keyed by group id. */
+    selectors: Record<string, SelectorSnapshot>;
+}
+/** The serialised cursor + PRNG + visits of a single flow. Its properties are the registry's. */
+interface FlowSnapshot {
+    /** This flow's built-in PRNG position (mulberry32 state, uint32; older saves may carry it signed). */
+    rngState: number;
+    /** This flow's per-node entry counts (node id -> times entered by this flow). */
+    visits: Record<string, number>;
+    cursor: FlowCursor;
+}
+/** A full resumable save-game (version 3): everything that is not a property, plus the registry's
+ *  values when the engine made its own registry. */
+interface SaveGame {
+    version: 3;
+    /** The engine's own registry's values, keyed by registry key: present only when the engine made the
+     *  registry itself (a standalone game). A game that passed a registry saves it once, beside this. */
+    registry?: EngineSave;
+    /** World-wide per-node entry counts (node id -> times entered by any flow). */
+    sharedVisits: Record<string, number>;
+    /** Shared selector cursors (node id -> snapshot) for `shared` memoried selectors. */
+    sharedSelectors: Record<string, SelectorSnapshot>;
+    /** Each live flow's snapshot, keyed by flow id. */
+    flows: Record<string, FlowSnapshot>;
+}
+/** A version 2 flow snapshot, which carried the flow's property values itself. Still read. */
+interface FlowSnapshotV2 extends FlowSnapshot {
+    /** The NOT-shared `@patter` globals, under token "patter". */
+    scopes: EngineSave;
+    /** Per-scene NOT-shared `@scene` bags (scene id -> name -> value). */
+    sceneBags: Record<string, Record<string, ScalarValue>>;
+}
+/** A version 2 save, from before the registry held the properties. Every runtime still reads it: its
+ *  property sections move into the registry (under the keys in the header above) as it loads. */
+interface SaveGameV2 {
+    version: 2;
+    /** Shared `@patter` globals (owned scope "patter"). */
+    shared: EngineSave;
+    sharedVisits: Record<string, number>;
+    sharedSelectors: Record<string, SelectorSnapshot>;
+    /** Shared, scene-namespaced `@scene` bags (scene id -> name -> value). */
+    stageBags: Record<string, Record<string, ScalarValue>>;
+    flows: Record<string, FlowSnapshotV2>;
+}
 
-export { type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, COMMON_GENDERS, type CaptionDelimiters, type CastMember, type Comment, type CommentMessage, type CommentRange, type CompiledBlock, type CompiledEffect, type CompiledGroup, type CompiledScene, type CompiledSnippet, type CoverageDriver, DEFAULT_CAPTION_CHARACTER, DEFAULT_CAPTION_DELIMITERS, DEFAULT_DOCUMENTATION_CLASSES, DEFAULT_RECORDING_STATUSES, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, type EditRecord, type Effect, type EstimatingConfig, type Expression, type FlowFile, type FlowNode, type GameData, type GameDataField, type GameDataFieldType, type GameDataFields, type GameDataNodeKind, type GameEventBeat, type GrammaticalGender, type Group, type HostScopeDecl, type HostScopeRegistry, type HostScopeSpec, type Jump, type JumpTarget, type LineBeat, type LocaleFile, PROJECT_LOCALE_SCENE, type ProjectDictionary, type ProjectFile, type PromptBeat, type PropertyDecl, type PropertyType, RERECORD_STATUS, RERECORD_STATUS_DECL, type RecordingFolder, type RecordingStatusDecl, type ScalarValue, type Scene, type Selector, type SelectorExhaust, type SelectorOrder, type SequenceOptions, type Snippet, type Suggestion, type TextBeat, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, gameIdify, isContentlessBeat, isValidGameId, walkNodes };
+export { type AuthoringFile, type Beat, type Block, type Bundle, type BundleCastMember, COMMON_GENDERS, type CaptionDelimiters, type CastMember, type Comment, type CommentMessage, type CommentRange, type CompiledBlock, type CompiledEffect, type CompiledGroup, type CompiledScene, type CompiledSnippet, type CoverageDriver, DEFAULT_CAPTION_CHARACTER, DEFAULT_CAPTION_DELIMITERS, DEFAULT_DOCUMENTATION_CLASSES, DEFAULT_RECORDING_STATUSES, DEFAULT_WRITING_STATUSES, type DocLine, type DocumentationClass, type EditRecord, type Effect, type EngineSave, type EstimatingConfig, type Expression, type FlowCursor, type FlowFile, type FlowNode, type FlowSnapshot, type FlowSnapshotV2, type GameData, type GameDataField, type GameDataFieldType, type GameDataFields, type GameDataNodeKind, type GameEventBeat, type GrammaticalGender, type Group, type HostScopeDecl, type HostScopeRegistry, type HostScopeSpec, type Jump, type JumpTarget, type LineBeat, type LocaleFile, PROJECT_LOCALE_SCENE, type ProjectDictionary, type ProjectFile, type PromptBeat, type PropertyDecl, type PropertyType, RERECORD_STATUS, RERECORD_STATUS_DECL, type RecordingFolder, type RecordingStatusDecl, SAVE_SCHEMA, SAVE_VERSION, type SaveEnvelope, type SaveGame, type SaveGameV2, type SavedChoice, type SavedChoiceOption, type SavedChoicePrompt, type ScalarValue, type Scene, type Selector, type SelectorExhaust, type SelectorOrder, type SelectorSnapshot, type SequenceOptions, type Snippet, type StackFrame, type Suggestion, type TextBeat, type VcsKind, type WritingStatusDecl, castStringKey, deriveRecordingFolders, effectiveGameId, gameIdify, isContentlessBeat, isValidGameId, walkNodes };

package/dist/index.js

@@ -75,6 +75,8 @@ function castStringKey(name) {
 }
 var DEFAULT_CAPTION_DELIMITERS = { open: "[", close: "]" };
 var DEFAULT_CAPTION_CHARACTER = "SFX";
+var SAVE_SCHEMA = "patter/save@0";
+var SAVE_VERSION = 3;
 export {
   COMMON_GENDERS,
   DEFAULT_CAPTION_CHARACTER,
@@ -86,6 +88,8 @@ export {
   RERECORD_STATUS,
   RERECORD_STATUS_DECL,
   RESERVED_PROPERTY_NAMES,
+  SAVE_SCHEMA,
+  SAVE_VERSION,
   castStringKey,
   deriveRecordingFolders,
   effectiveGameId,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patterkit/model",
-  "version": "0.4.1",
+  "version": "0.6.0",
   "description": "Patter data-model types: source (scene/block/group/snippet/beat/jump), project, locale, authoring. The shape source-of-truth.",
   "type": "module",
   "license": "MIT",