Class: StoryTestRunner — Kata docs
Kata docs

kata-framework


Class: StoryTestRunner

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:14

High-level test harness for narrative behavior. Wraps a KataEngine and exposes intent-based assertions (“advance until choice”, “choose by label”, “can reach scene”) instead of frame-index bookkeeping.

Constructors

Constructor

new StoryTestRunner(
   sources, 
   initialCtx?, 
   options?): StoryTestRunner;

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:25

Parameters

sources

string | string[] | KSONScene[]

initialCtx?

Record<string, any> = {}

options?

StoryTestRunnerOptions = {}

Returns

StoryTestRunner

Properties

engine

readonly engine: KataEngine;

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:15

Accessors

ctx

Get Signature

get ctx(): Record<string, any>;

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:145

Returns

Record<string, any>


currentChoices

Get Signature

get currentChoices(): string[];

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:127

Returns

string[]


currentFrame

Get Signature

get currentFrame(): KSONFrame | null;

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:123

Returns

KSONFrame | null


dialogueLog

Get Signature

get dialogueLog(): string[];

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:137

Returns

string[]


endedScene

Get Signature

get endedScene(): string | null;

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:154

Returns

string | null


frames

Get Signature

get frames(): KSONFrame[];

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:133

Returns

KSONFrame[]


isEnded

Get Signature

get isEnded(): boolean;

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:150

Returns

boolean


speakerLog

Get Signature

get speakerLog(): string[];

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:141

Returns

string[]

Methods

advanceUntilChoice()

advanceUntilChoice(): void;

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:68

Advance until the next choice frame appears, or the scene ends. Throws if neither happens within maxSteps.

Returns

void


advanceUntilText()

advanceUntilText(substring): void;

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:86

Advance until a text frame containing substring appears. Throws if not seen within maxSteps.

Parameters

substring

string

Returns

void


canReach()

canReach(sceneId, fromSceneId?): boolean;

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:159

Static graph reachability check across all registered scenes.

Parameters

sceneId

string

fromSceneId?

string

Returns

boolean


choose()

choose(label): void;

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:108

Select a choice by its label. Throws if no current choice or label not found.

Parameters

label

string

Returns

void


start()

start(sceneId): void;

Defined in: packages/kata-test-utils/src/StoryTestRunner.ts:58

Parameters

sceneId

string

Returns

void