@patterkit/model 0.8.0 → 0.9.0

package/README.md

@@ -0,0 +1,35 @@
+# @patterkit/model
+
+The TypeScript types that describe Patter's data: the shape every other `@patterkit` package agrees on.
+Types only, with no behaviour.
+
+Most people won't need to install this directly. To play Patter dialogue in a game or web page, use
+[`@patterkit/runtime`](https://www.npmjs.com/package/@patterkit/runtime); to work with Patter projects from
+a terminal or a build script, use [`@patterkit/cli`](https://www.npmjs.com/package/@patterkit/cli).
+
+## What's in it
+
+- **The source format**: scenes and their flow tree (blocks, groups, snippets, beats, and jumps), the
+  project file, locale files, and the authoring file that holds comments, suggestions, and writing status.
+- **The compiled bundle**: the `.patterc` a game loads, as written by the compiler and read by every runtime.
+- **Shared helpers for addressing**: the game-facing ids (`gameIdify`, `isValidGameId`, `effectiveGameId`).
+
+Conditions and effects are kept as source strings here; the expression language itself is
+[`@wildwinter/expr`](https://www.npmjs.com/package/@wildwinter/expr). The format is described in
+[the specification](https://patterkit.dev/specification/).
+
+```sh
+npm install @patterkit/model
+```
+
+## Part of Patter
+
+[Patter](https://patterkit.dev/) is a branching dialogue format with its own editor (Patterpad), command line
+tool (`patter`), and runtimes for JavaScript, Unity, Unreal, and Godot. This package is one layer of the
+JavaScript tooling, and the other `@patterkit` packages build on it. [How it fits
+together](https://patterkit.dev/architecture/) shows where each piece sits, and the source is in the
+[patter repository](https://github.com/patterkit/patter).
+
+## Licence
+
+MIT

package/dist/index.d.cts

@@ -1017,6 +1017,12 @@ interface FlowCursor {
     /** 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;
+    /** The prompt still to be replayed, exactly as the choice SHOWED it (text and speaker fields, the same
+     *  shape as a saved option's `prompt`), so the replay after a load says what the player saw. Written only
+     *  alongside a `pendingPromptOwnerId` (the choose -> advance window, with `replayPromptOnChoose`), and
+     *  absent otherwise. A save without it (written before Patterplay 0.18.0) resolves the owner's prompt beat
+     *  when it is delivered, as before. */
+    pendingPrompt?: SavedChoicePrompt;
     /** This flow's (non-shared) selector cursors, keyed by group id. */
     selectors: Record<string, SelectorSnapshot>;
 }

package/dist/index.d.ts

@@ -1017,6 +1017,12 @@ interface FlowCursor {
     /** 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;
+    /** The prompt still to be replayed, exactly as the choice SHOWED it (text and speaker fields, the same
+     *  shape as a saved option's `prompt`), so the replay after a load says what the player saw. Written only
+     *  alongside a `pendingPromptOwnerId` (the choose -> advance window, with `replayPromptOnChoose`), and
+     *  absent otherwise. A save without it (written before Patterplay 0.18.0) resolves the owner's prompt beat
+     *  when it is delivered, as before. */
+    pendingPrompt?: SavedChoicePrompt;
     /** This flow's (non-shared) selector cursors, keyed by group id. */
     selectors: Record<string, SelectorSnapshot>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patterkit/model",
-  "version": "0.8.0",
+  "version": "0.9.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",