@sharpee/if-domain 5.3.2 → 5.4.0

package/endings.d.ts

@@ -7,7 +7,7 @@
  * emitters build the events with existing primitives.
  *
  * Public interface: `StoryEndingEvents`, `STORY_ENDING_FLAG`,
- * `StoryEndingKind`, `IStoryEndingData`.
+ * `StoryEndingKind`, `IStoryEndingData`, `IStoryEnding`.
  *
  * Owner context: `@sharpee/if-domain` — shared by the story-loader (emits on
  * `win`/`lose`), the engine/clients (react to endings), and transcript tests
@@ -25,9 +25,14 @@ export declare const StoryEndingEvents: {
 /** How a story ended. */
 export type StoryEndingKind = 'victory' | 'defeat';
 /**
- * World-state key holding the ending once one is reached (a
- * `StoryEndingKind`), or unset while play continues. The generic
- * `isComplete()` reads this key; stories never implement completion logic.
+ * World-state key that once held the ending.
+ *
+ * **Superseded by {@link IStoryEnding}** (ADR-347 D2a), which is a real
+ * `WorldModel` member rather than a key in an untyped state bag. Nothing
+ * reads or writes this key any more — the constant survives only because
+ * this file's values are frozen contract. Do not reach for it: an ending
+ * recorded here is invisible to the engine, the scheduler and every
+ * client.
  */
 export declare const STORY_ENDING_FLAG = "story.ending";
 /** Payload carried by a `StoryEndingEvents` event. */
@@ -36,4 +41,35 @@ export interface IStoryEndingData {
     /** Message ID of the ending phrase, when the author supplied one. */
     messageId?: string;
 }
+/**
+ * The ending a story reached, or absent while play continues (ADR-347 D1, D2d).
+ *
+ * A story that has not ended carries no Ending — which is a different
+ * statement from "carries an Ending that says nothing". Once written it is
+ * final: the first ending wins (`endStory`'s rejection rule), so a reader
+ * may treat `turn` as the turn the conclusion actually happened on.
+ */
+export interface IStoryEnding {
+    /** Victory or defeat. */
+    readonly kind: StoryEndingKind;
+    /**
+     * The turn the story ended on.
+     *
+     * Required, so a client can always say *when* and a save can always say
+     * whether the ending it carries is the one it was written at. The world
+     * holds no turn counter, so the declaring site supplies it — Chord's
+     * runtime has `turnNow`, the engine's stages have `context.turn`. A
+     * headless Chord run with no engine turn provider wired records `0`,
+     * which is `turnNow`'s existing fallback and the same answer timers get.
+     */
+    readonly turn: number;
+    /**
+     * Message ID of the ending phrase, when the author supplied one. It
+     * identifies the phrase; it does not render it (GH #274) — same rule as
+     * {@link IStoryEndingData.messageId}.
+     */
+    readonly messageId?: string;
+    /** Free-form cause, e.g. the `cause` a player death carried. */
+    readonly cause?: string;
+}
 //# sourceMappingURL=endings.d.ts.map

package/endings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"endings.d.ts","sourceRoot":"","sources":["../../../../../../work/sharpee/sharpee/packages/if-domain/src/endings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,sDAAsD;AACtD,eAAO,MAAM,iBAAiB;IAC5B,0EAA0E;;IAE1E,2EAA2E;;CAEnE,CAAC;AAEX,yBAAyB;AACzB,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEnD;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAEhD,sDAAsD;AACtD,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,eAAe,CAAC;IACxB,qEAAqE;IACrE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB"}
+{"version":3,"file":"endings.d.ts","sourceRoot":"","sources":["../../../../../../work/sharpee/sharpee/packages/if-domain/src/endings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,sDAAsD;AACtD,eAAO,MAAM,iBAAiB;IAC5B,0EAA0E;;IAE1E,2EAA2E;;CAEnE,CAAC;AAEX,yBAAyB;AACzB,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,QAAQ,CAAC;AAEnD;;;;;;;;;GASG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAEhD,sDAAsD;AACtD,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,eAAe,CAAC;IACxB,qEAAqE;IACrE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,YAAY;IAC3B,yBAAyB;IACzB,QAAQ,CAAC,IAAI,EAAE,eAAe,CAAC;IAE/B;;;;;;;;;OASG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAE5B,gEAAgE;IAChE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CACzB"}

package/endings.js

@@ -8,7 +8,7 @@
  * emitters build the events with existing primitives.
  *
  * Public interface: `StoryEndingEvents`, `STORY_ENDING_FLAG`,
- * `StoryEndingKind`, `IStoryEndingData`.
+ * `StoryEndingKind`, `IStoryEndingData`, `IStoryEnding`.
  *
  * Owner context: `@sharpee/if-domain` — shared by the story-loader (emits on
  * `win`/`lose`), the engine/clients (react to endings), and transcript tests
@@ -26,9 +26,14 @@ exports.StoryEndingEvents = {
     DEFEAT: 'story.defeat',
 };
 /**
- * World-state key holding the ending once one is reached (a
- * `StoryEndingKind`), or unset while play continues. The generic
- * `isComplete()` reads this key; stories never implement completion logic.
+ * World-state key that once held the ending.
+ *
+ * **Superseded by {@link IStoryEnding}** (ADR-347 D2a), which is a real
+ * `WorldModel` member rather than a key in an untyped state bag. Nothing
+ * reads or writes this key any more — the constant survives only because
+ * this file's values are frozen contract. Do not reach for it: an ending
+ * recorded here is invisible to the engine, the scheduler and every
+ * client.
  */
 exports.STORY_ENDING_FLAG = 'story.ending';
 //# sourceMappingURL=endings.js.map

package/endings.js.map

@@ -1 +1 @@
-{"version":3,"file":"endings.js","sourceRoot":"","sources":["../../../../../../work/sharpee/sharpee/packages/if-domain/src/endings.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;AAEH,sDAAsD;AACzC,QAAA,iBAAiB,GAAG;IAC/B,0EAA0E;IAC1E,OAAO,EAAE,eAAe;IACxB,2EAA2E;IAC3E,MAAM,EAAE,cAAc;CACd,CAAC;AAKX;;;;GAIG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC"}
+{"version":3,"file":"endings.js","sourceRoot":"","sources":["../../../../../../work/sharpee/sharpee/packages/if-domain/src/endings.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;GAgBG;;;AAEH,sDAAsD;AACzC,QAAA,iBAAiB,GAAG;IAC/B,0EAA0E;IAC1E,OAAO,EAAE,eAAe;IACxB,2EAA2E;IAC3E,MAAM,EAAE,cAAc;CACd,CAAC;AAKX;;;;;;;;;GASG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sharpee/if-domain",
-  "version": "5.3.2",
+  "version": "5.4.0",
   "description": "Core domain model and contracts for Sharpee Interactive Fiction Platform",
   "main": "./index.js",
   "types": "./index.d.ts",
@@ -12,8 +12,8 @@
     }
   },
   "dependencies": {
-    "@sharpee/core": "^5.3.2",
-    "@sharpee/text-blocks": "^5.3.2"
+    "@sharpee/core": "^5.4.0",
+    "@sharpee/text-blocks": "^5.4.0"
   },
   "keywords": [
     "interactive-fiction",

package/prompt.d.ts

@@ -4,7 +4,7 @@
  * The prompt is a channel primitive (FyreVM heritage). Each prompt is a named
  * constant with a messageId resolved through the language provider.
  *
- * @public GamePrompt, DefaultPrompt, PROMPT_STATE_KEY
+ * @public GamePrompt, DefaultPrompt, EndGamePrompt, PROMPT_STATE_KEY
  * @context if-domain (platform-level type)
  */
 /**
@@ -26,6 +26,15 @@ export interface GamePrompt {
  * Resolves to '> ' via lang-en-us registration of 'if.platform.prompt'.
  */
 export declare const DefaultPrompt: GamePrompt;
+/**
+ * The prompt shown once the story has ended (ADR-347 D3a).
+ *
+ * Derived from the world's Ending rather than stored, so it overrides
+ * whatever prompt the story last set: at an end-game prompt the story's
+ * own prompt is the wrong one. Resolves to the end-game prompt text via
+ * lang-en-us's registration of `if.platform.prompt.ended`.
+ */
+export declare const EndGamePrompt: GamePrompt;
 /**
  * World state key for storing the active prompt.
  */

package/prompt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prompt.d.ts","sourceRoot":"","sources":["../../../../../../work/sharpee/sharpee/packages/if-domain/src/prompt.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,mDAAmD;IACnD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,oDAAoD;IACpD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC3C;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,UAAgD,CAAC;AAE7E;;GAEG;AACH,eAAO,MAAM,gBAAgB,cAAc,CAAC"}
+{"version":3,"file":"prompt.d.ts","sourceRoot":"","sources":["../../../../../../work/sharpee/sharpee/packages/if-domain/src/prompt.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB,mDAAmD;IACnD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,oDAAoD;IACpD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC3C;AAED;;;GAGG;AACH,eAAO,MAAM,aAAa,EAAE,UAAgD,CAAC;AAE7E;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,EAAE,UAAsD,CAAC;AAEnF;;GAEG;AACH,eAAO,MAAM,gBAAgB,cAAc,CAAC"}

package/prompt.js

@@ -5,16 +5,25 @@
  * The prompt is a channel primitive (FyreVM heritage). Each prompt is a named
  * constant with a messageId resolved through the language provider.
  *
- * @public GamePrompt, DefaultPrompt, PROMPT_STATE_KEY
+ * @public GamePrompt, DefaultPrompt, EndGamePrompt, PROMPT_STATE_KEY
  * @context if-domain (platform-level type)
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PROMPT_STATE_KEY = exports.DefaultPrompt = void 0;
+exports.PROMPT_STATE_KEY = exports.EndGamePrompt = exports.DefaultPrompt = void 0;
 /**
  * Platform default prompt.
  * Resolves to '> ' via lang-en-us registration of 'if.platform.prompt'.
  */
 exports.DefaultPrompt = { messageId: 'if.platform.prompt' };
+/**
+ * The prompt shown once the story has ended (ADR-347 D3a).
+ *
+ * Derived from the world's Ending rather than stored, so it overrides
+ * whatever prompt the story last set: at an end-game prompt the story's
+ * own prompt is the wrong one. Resolves to the end-game prompt text via
+ * lang-en-us's registration of `if.platform.prompt.ended`.
+ */
+exports.EndGamePrompt = { messageId: 'if.platform.prompt.ended' };
 /**
  * World state key for storing the active prompt.
  */

package/prompt.js.map

@@ -1 +1 @@
-{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../../../../../work/sharpee/sharpee/packages/if-domain/src/prompt.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AAiBH;;;GAGG;AACU,QAAA,aAAa,GAAe,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAC;AAE7E;;GAEG;AACU,QAAA,gBAAgB,GAAG,WAAW,CAAC"}
+{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../../../../../work/sharpee/sharpee/packages/if-domain/src/prompt.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AAiBH;;;GAGG;AACU,QAAA,aAAa,GAAe,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAC;AAE7E;;;;;;;GAOG;AACU,QAAA,aAAa,GAAe,EAAE,SAAS,EAAE,0BAA0B,EAAE,CAAC;AAEnF;;GAEG;AACU,QAAA,gBAAgB,GAAG,WAAW,CAAC"}