@systemfsoftware/storybook-gherkin 3.0.3 → 3.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @systemfsoftware/storybook-gherkin
2
2
 
3
+ ## 3.0.5
4
+
5
+ ### Patch Changes
6
+
7
+ - Dependencies resolve to Effect 4.0.0-rc.116 and Vitest 5.
8
+
9
+ ## 3.0.4
10
+
11
+ ### Patch Changes
12
+
13
+ - Type declarations for `@systemfsoftware/npm-package` and `@systemfsoftware/storybook-gherkin` are now flattened: every exported type is declared inline, so no published type refers to a declaration file you would have to resolve yourself.
14
+
15
+ The declarations of `@systemfsoftware/effect-atom` and `@systemfsoftware/effect-atom-react` are unchanged.
16
+
3
17
  ## 3.0.3
4
18
 
5
19
  ### Patch Changes
package/dist/index.d.ts CHANGED
@@ -1,248 +1,312 @@
1
- import { Context, Effect, Schema } from "effect";
2
- import { UserEventObject, screen, within } from "storybook/test";
3
- import { Simplify, UnionToIntersection } from "type-fest";
4
- //#region src/Capture.d.ts
5
- declare const CaptureTag: {
6
- readonly _tag: 'Capture';
7
- };
8
- type CaptureTag = typeof CaptureTag;
9
- interface Capture<Name extends string = string, _A = unknown> extends CaptureTag {
10
- readonly name: Name;
11
- readonly schema: Schema.ConstraintDecoder<unknown> | undefined;
12
- readonly default: string | undefined;
13
- }
14
- declare function capture<Name extends string, A>(name: Name, options: {
15
- readonly schema: Schema.Codec<A, string>;
16
- readonly default?: string;
17
- }): Capture<Name, A>;
18
- declare function capture<Name extends string>(name: Name, options?: {
19
- readonly default?: string;
20
- }): Capture<Name, string>;
21
- //#endregion
22
- //#region src/Errors.schema.d.ts
23
- declare const EmptyScenario_base: Schema.Class<EmptyScenario, Schema.TaggedStruct<"EmptyScenario", {
24
- readonly scenario: Schema.String;
25
- }>, import("effect/Cause").YieldableError>;
26
- /**
27
- * Two channels:
28
- * - Declaration time: every violation except `CaptureDecodeFailed` is thrown
29
- * during module evaluation of the story file, so a malformed spec fails the
30
- * Storybook import before any story runs.
31
- * - Run time: `CaptureDecodeFailed` travels the typed error channel of
32
- * `Step.run` and surfaces when the play edge interprets the scenario.
33
- */
34
- declare class EmptyScenario extends EmptyScenario_base {}
35
- declare const MissingThen_base: Schema.Class<MissingThen, Schema.TaggedStruct<"MissingThen", {
36
- readonly scenario: Schema.String;
37
- }>, import("effect/Cause").YieldableError>;
38
- /** Without a Then-phase step nothing is asserted — the scenario is not a spec. */
39
- declare class MissingThen extends MissingThen_base {}
40
- declare const BackgroundNotGiven_base: Schema.Class<BackgroundNotGiven, Schema.TaggedStruct<"BackgroundNotGiven", {
41
- readonly step: Schema.String;
42
- readonly resolved: Schema.Literals<readonly ["Given", "When", "Then"]>;
43
- }>, import("effect/Cause").YieldableError>;
44
- declare class BackgroundNotGiven extends BackgroundNotGiven_base {}
45
- declare const DuplicateCapture_base: Schema.Class<DuplicateCapture, Schema.TaggedStruct<"DuplicateCapture", {
46
- readonly step: Schema.String;
47
- readonly name: Schema.String;
48
- }>, import("effect/Cause").YieldableError>;
49
- declare class DuplicateCapture extends DuplicateCapture_base {}
50
- declare const UnresolvedCapture_base: Schema.Class<UnresolvedCapture, Schema.TaggedStruct<"UnresolvedCapture", {
51
- readonly scenario: Schema.String;
52
- readonly step: Schema.String;
53
- readonly capture: Schema.String;
54
- }>, import("effect/Cause").YieldableError>;
55
- /** Capture values come from a literal hole, `with`, or an outline row — none matched. */
56
- declare class UnresolvedCapture extends UnresolvedCapture_base {}
57
- declare const OutlineEmpty_base: Schema.Class<OutlineEmpty, Schema.TaggedStruct<"OutlineEmpty", {
58
- readonly outline: Schema.String;
59
- }>, import("effect/Cause").YieldableError>;
60
- declare class OutlineEmpty extends OutlineEmpty_base {}
61
- declare const OutlineInconsistentKeys_base: Schema.Class<OutlineInconsistentKeys, Schema.TaggedStruct<"OutlineInconsistentKeys", {
62
- readonly outline: Schema.String;
63
- readonly row: Schema.String;
64
- readonly expected: Schema.$Array<Schema.String>;
65
- readonly actual: Schema.$Array<Schema.String>;
66
- }>, import("effect/Cause").YieldableError>;
67
- declare class OutlineInconsistentKeys extends OutlineInconsistentKeys_base {}
68
- declare const OutlineDuplicateRowName_base: Schema.Class<OutlineDuplicateRowName, Schema.TaggedStruct<"OutlineDuplicateRowName", {
69
- readonly outline: Schema.String;
70
- readonly name: Schema.String;
71
- }>, import("effect/Cause").YieldableError>;
72
- /** Row names become the exported story names, so duplicates would collide. */
73
- declare class OutlineDuplicateRowName extends OutlineDuplicateRowName_base {}
74
- declare const OutlineMissingCapture_base: Schema.Class<OutlineMissingCapture, Schema.TaggedStruct<"OutlineMissingCapture", {
75
- readonly outline: Schema.String;
76
- readonly row: Schema.String;
77
- readonly capture: Schema.String;
78
- }>, import("effect/Cause").YieldableError>;
79
- declare class OutlineMissingCapture extends OutlineMissingCapture_base {}
80
- declare const CaptureDecodeFailed_base: Schema.Class<CaptureDecodeFailed, Schema.TaggedStruct<"CaptureDecodeFailed", {
81
- readonly step: Schema.String;
82
- readonly capture: Schema.String;
83
- readonly value: Schema.String;
84
- readonly cause: Schema.Unknown;
85
- }>, import("effect/Cause").YieldableError>;
86
- declare class CaptureDecodeFailed extends CaptureDecodeFailed_base {}
87
- //#endregion
88
- //#region src/Steps.d.ts
89
- type Keyword = 'Given' | 'When' | 'Then' | 'And' | 'But' | 'Star';
90
- type ConcreteKeyword = 'Given' | 'When' | 'Then';
91
- interface CaptureModel {
92
- readonly name: string;
93
- /** Service-free decode view — the v4 counterpart of the removed no-context alias. */
94
- readonly schema: Schema.ConstraintDecoder<unknown> | undefined;
95
- readonly default: string | undefined;
96
- }
97
- interface StepModel {
98
- readonly keyword: Keyword;
99
- /** Static segments around the holes — length is always captures.length + 1. */
100
- readonly parts: readonly string[];
101
- readonly captures: readonly CaptureModel[];
102
- }
103
- type ExampleRow = {
104
- readonly name: string;
105
- } & Readonly<Record<string, string>>;
106
- type Canvas = ReturnType<typeof within>;
107
- type StepFn = (label: string, fn: () => Promise<void>) => Promise<void> | void;
108
- interface Report {
109
- readonly type: string;
110
- readonly version?: number;
111
- readonly result: unknown;
112
- readonly status: 'failed' | 'passed' | 'warning';
113
- }
114
- interface ReportingAPI {
115
- readonly reports: Report[];
116
- readonly addReport: (report: Report) => void;
117
- }
118
- interface PlayContext<TArgs = unknown> {
119
- readonly canvas: Canvas;
120
- readonly canvasElement: HTMLElement;
121
- readonly step: StepFn;
122
- readonly userEvent: UserEventObject;
123
- readonly args: TArgs;
124
- readonly globals: Record<string, unknown>;
125
- readonly parameters: Record<string, unknown>;
126
- readonly loaded: Record<string, unknown>;
127
- readonly abortSignal: AbortSignal;
128
- readonly reporting: ReportingAPI;
129
- }
130
- interface StepContext<TArgs = unknown> {
131
- readonly canvas: Canvas;
132
- readonly screen: typeof screen;
133
- readonly userEvent: UserEventObject;
134
- readonly step: StepFn;
135
- readonly args: TArgs;
136
- readonly globals: Record<string, unknown>;
137
- readonly parameters: Record<string, unknown>;
138
- readonly loaded: Record<string, unknown>;
139
- readonly canvasElement: HTMLElement;
140
- /**
141
- * Fires on story teardown (remount, navigation, HMR). Since the 2026-08-09
142
- * Effect-composition refactor, the play edge interrupts the in-flight step
143
- * on abort — steps no longer run to completion after teardown. The step
144
- * handler's own promise is abandoned, not cancelled: observe this signal
145
- * for cleanup or to race long-running work.
146
- */
147
- readonly abortSignal: AbortSignal;
148
- readonly reporting: ReportingAPI;
149
- readonly context: PlayContext<TArgs>;
150
- }
151
- type Hole = Capture | string | number;
152
- type CapsOf<THoles extends readonly Hole[]> = THoles extends readonly [] ? {} : Simplify<UnionToIntersection<{ [K in keyof THoles]: THoles[K] extends Capture<infer N, infer A> ? { [P in N]: A; } : {}; }[number]>>;
153
- type StepHandler<TCaps, TArgs = unknown> = (ctx: StepContext<TArgs>, caps: TCaps) => void | Promise<void>;
154
- declare const StepTag: {
155
- readonly _tag: "Step";
156
- };
157
- type StepTag = typeof StepTag;
158
- interface Step<TArgs = unknown> extends StepTag {
159
- readonly model: StepModel;
160
- readonly run: (values: Readonly<Record<string, string>>, ctx: StepContext<TArgs>) => Effect.Effect<void, CaptureDecodeFailed>;
161
- }
162
- interface StepBuilder<THoles extends readonly Hole[], TArgs = unknown> {
163
- (handler: StepHandler<CapsOf<THoles>, TArgs>): Step<TArgs>;
164
- }
165
- type StepCtor = {
166
- <const THoles extends readonly Hole[]>(statics: TemplateStringsArray, ...holes: THoles): StepBuilder<THoles>;
167
- <TArgs, const THoles extends readonly Hole[] = readonly Hole[]>(statics: TemplateStringsArray, ...holes: THoles): StepBuilder<THoles, TArgs>;
168
- };
169
- declare const Given: StepCtor;
170
- declare const When: StepCtor;
171
- declare const Then: StepCtor;
172
- declare const And: StepCtor;
173
- declare const But: StepCtor;
174
- declare const Star: StepCtor;
175
- //#endregion
176
- //#region src/Feature.d.ts
177
- interface StorySpec<TArgs = unknown> {
178
- readonly name: string;
179
- readonly play: (context: PlayContext<TArgs>) => Promise<void>;
180
- }
181
- interface ScenarioOptions {
182
- /** Capture values for a plain (non-outline) scenario, keyed by capture name. */
183
- readonly with?: Readonly<Record<string, string>>;
184
- }
185
- interface FeatureOptions {
186
- /**
187
- * Context that interprets a scenario's step program at the play edge,
188
- * defaulting to `Context.empty()`. Supply a context carrying services
189
- * or a custom scheduler to make them available to the run.
190
- */
191
- readonly context?: Context.Context<never>;
192
- }
193
- /**
194
- * Anything positional after the scenario name: a step, a step group from
195
- * `Steps(...)` / `From(...)`, or — in first position only — an options object.
196
- */
197
- type StepArg<TArgs> = Step<TArgs> | readonly Step<TArgs>[];
198
- /**
199
- * A scenario title names a concrete situation in natural-language prose. Two
200
- * shape checks keep DAMP `Should_[Behavior]_When_[Condition]` unit-test names —
201
- * and every concatenated-token title shaped like one — out of the call site:
202
- * 1. the literal must not start with `Should`;
203
- * 2. the literal must contain at least one ASCII space (a single-word title is
204
- * a test name, not prose).
205
- * Either check failing maps to `ScenarioTitleRejected`, so the call fails to
206
- * type-check with the rule in the diagnostic. Non-literal titles (widened
207
- * `string`) pass through untouched — a runtime guard would catch those, but
208
- * the brand is the contract this skill ships.
209
- */
210
- type ScenarioTitleRejected<T extends string> = `Scenario titles are natural-language prose of a concrete situation, not DAMP Should_[Behavior]_When_[Condition] unit-test names. Got: ${T}` | `Scenario title must be natural-language prose (at least one space separates words); got: ${T}`;
211
- type ScenarioTitle<T extends string> = T extends `Should${string}` ? ScenarioTitleRejected<T> : T extends `${string} ${string}` ? T : ScenarioTitleRejected<T>;
212
- interface ScenarioFn<TArgs> {
213
- <TName extends string>(name: ScenarioTitle<TName>, ...steps: readonly StepArg<TArgs>[]): StorySpec<TArgs>;
214
- <TName extends string>(name: ScenarioTitle<TName>, options: ScenarioOptions, ...steps: readonly StepArg<TArgs>[]): StorySpec<TArgs>;
215
- }
216
- interface OutlineBuilder<TArgs> {
217
- readonly examples: (rows: readonly ExampleRow[]) => Record<string, StorySpec<TArgs>>;
218
- }
219
- interface OutlineFn<TArgs> {
220
- <TName extends string>(name: ScenarioTitle<TName>, ...steps: readonly StepArg<TArgs>[]): OutlineBuilder<TArgs>;
221
- <TName extends string>(name: ScenarioTitle<TName>, options: ScenarioOptions, ...steps: readonly StepArg<TArgs>[]): OutlineBuilder<TArgs>;
222
- }
223
- interface RuleScope<TArgs> {
224
- readonly scenario: ScenarioFn<TArgs>;
225
- readonly scenarioOutline: OutlineFn<TArgs>;
226
- }
227
- interface Feature<M, TArgs = unknown> {
228
- readonly meta: M;
229
- readonly type: <TNext>() => Feature<M, TNext>;
230
- readonly background: (...steps: readonly Step<TArgs>[]) => void;
231
- readonly scenario: ScenarioFn<TArgs>;
232
- readonly scenarioOutline: OutlineFn<TArgs>;
233
- readonly rule: (name: string) => RuleScope<TArgs>;
234
- }
235
- /**
236
- * Declare a feature: a story set whose scenarios execute as CSF `play`
237
- * functions. `options.context` (default `Context.empty()`) is the Effect
238
- * context interpreting each scenario's composed step program exactly once,
239
- * at the play edge.
240
- */
241
- declare const feature: <M>(meta: M, options?: FeatureOptions) => Feature<M>;
242
- declare const Steps: <TArgs>(...steps: readonly Step<TArgs>[]) => Step<TArgs>[];
243
- interface StoryWithPlay<TArgs> {
244
- readonly play?: (context: PlayContext<TArgs>) => Promise<void> | void;
245
- }
246
- declare const From: <TArgs>(story: StoryWithPlay<TArgs>) => Step<TArgs>[];
247
- //#endregion
248
- export { And, BackgroundNotGiven, But, type Canvas, type CapsOf, type Capture, CaptureDecodeFailed, type CaptureModel, type ConcreteKeyword, DuplicateCapture, EmptyScenario, type ExampleRow, type Feature, type FeatureOptions, From, Given, type Hole, type Keyword, MissingThen, type OutlineBuilder, OutlineDuplicateRowName, OutlineEmpty, type OutlineFn, OutlineInconsistentKeys, OutlineMissingCapture, type PlayContext, type Report, type ReportingAPI, type RuleScope, type ScenarioFn, type ScenarioOptions, Star, type Step, type StepArg, type StepBuilder, type StepContext, type StepCtor, type StepFn, type StepHandler, type StepModel, Steps, type StorySpec, Then, UnresolvedCapture, When, capture, feature };
1
+ import { Context } from 'effect';
2
+ import { Effect } from 'effect';
3
+ import { Schema } from 'effect';
4
+ import { screen as screen_2 } from 'storybook/test';
5
+ import { Simplify } from 'type-fest';
6
+ import { UnionToIntersection } from 'type-fest';
7
+ import { UserEventObject } from 'storybook/test';
8
+ import { YieldableError } from 'effect/Cause';
9
+
10
+ export declare const And: StepCtor;
11
+
12
+ export declare class BackgroundNotGiven extends BackgroundNotGiven_base {}
13
+
14
+ declare const BackgroundNotGiven_base: Schema.Class<BackgroundNotGiven, Schema.TaggedStruct<"BackgroundNotGiven", {
15
+ readonly step: Schema.String;
16
+ readonly resolved: Schema.Literals<readonly ["Given", "When", "Then"]>;
17
+ }>, YieldableError>;
18
+
19
+ export declare const But: StepCtor;
20
+
21
+ export declare type Canvas = typeof screen_2;
22
+
23
+ export declare type CapsOf<THoles extends readonly Hole[]> = THoles extends readonly [] ? {} : Simplify<UnionToIntersection<{ [K in keyof THoles]: THoles[K] extends Capture<infer N, infer A> ? { [P in N]: A; } : {}; }[number]>>;
24
+
25
+ export declare interface Capture<Name extends string = string, _A = unknown> extends CaptureTag {
26
+ readonly name: Name;
27
+ readonly schema: Schema.ConstraintDecoder<unknown> | undefined;
28
+ readonly default: string | undefined;
29
+ }
30
+
31
+ export declare function capture<Name extends string, A>(name: Name, options: {
32
+ readonly schema: Schema.Codec<A, string>;
33
+ readonly default?: string;
34
+ }): Capture<Name, A>;
35
+
36
+ export declare function capture<Name extends string>(name: Name, options?: {
37
+ readonly default?: string;
38
+ }): Capture<Name, string>;
39
+
40
+ export declare class CaptureDecodeFailed extends CaptureDecodeFailed_base {}
41
+
42
+ declare const CaptureDecodeFailed_base: Schema.Class<CaptureDecodeFailed, Schema.TaggedStruct<"CaptureDecodeFailed", {
43
+ readonly step: Schema.String;
44
+ readonly capture: Schema.String;
45
+ readonly value: Schema.String;
46
+ readonly cause: Schema.Unknown;
47
+ }>, YieldableError>;
48
+
49
+ export declare interface CaptureModel {
50
+ readonly name: string;
51
+ /** Service-free decode view — the v4 counterpart of the removed no-context alias. */
52
+ readonly schema: Schema.ConstraintDecoder<unknown> | undefined;
53
+ readonly default: string | undefined;
54
+ }
55
+
56
+ declare const CaptureTag: {
57
+ readonly _tag: 'Capture';
58
+ };
59
+
60
+ declare type CaptureTag = typeof CaptureTag;
61
+
62
+ export declare type ConcreteKeyword = 'Given' | 'When' | 'Then';
63
+
64
+ export declare class DuplicateCapture extends DuplicateCapture_base {}
65
+
66
+ declare const DuplicateCapture_base: Schema.Class<DuplicateCapture, Schema.TaggedStruct<"DuplicateCapture", {
67
+ readonly step: Schema.String;
68
+ readonly name: Schema.String;
69
+ }>, YieldableError>;
70
+
71
+ /**
72
+ * Two channels:
73
+ * - Declaration time: every violation except `CaptureDecodeFailed` is thrown
74
+ * during module evaluation of the story file, so a malformed spec fails the
75
+ * Storybook import before any story runs.
76
+ * - Run time: `CaptureDecodeFailed` travels the typed error channel of
77
+ * `Step.run` and surfaces when the play edge interprets the scenario.
78
+ */
79
+ export declare class EmptyScenario extends EmptyScenario_base {}
80
+
81
+ declare const EmptyScenario_base: Schema.Class<EmptyScenario, Schema.TaggedStruct<"EmptyScenario", {
82
+ readonly scenario: Schema.String;
83
+ }>, YieldableError>;
84
+
85
+ export declare type ExampleRow = {
86
+ readonly name: string;
87
+ } & Readonly<Record<string, string>>;
88
+
89
+ export declare interface Feature<M, TArgs = unknown> {
90
+ readonly meta: M;
91
+ readonly type: <TNext>() => Feature<M, TNext>;
92
+ readonly background: (...steps: readonly Step<TArgs>[]) => void;
93
+ readonly scenario: ScenarioFn<TArgs>;
94
+ readonly scenarioOutline: OutlineFn<TArgs>;
95
+ readonly rule: (name: string) => RuleScope<TArgs>;
96
+ }
97
+
98
+ /**
99
+ * Declare a feature: a story set whose scenarios execute as CSF `play`
100
+ * functions. `options.context` (default `Context.empty()`) is the Effect
101
+ * context interpreting each scenario's composed step program exactly once,
102
+ * at the play edge.
103
+ */
104
+ export declare const feature: <M>(meta: M, options?: FeatureOptions) => Feature<M>;
105
+
106
+ export declare interface FeatureOptions {
107
+ /**
108
+ * Context that interprets a scenario's step program at the play edge,
109
+ * defaulting to `Context.empty()`. Supply a context carrying services
110
+ * or a custom scheduler to make them available to the run.
111
+ */
112
+ readonly context?: Context.Context<never>;
113
+ }
114
+
115
+ export declare const From: <TArgs>(story: StoryWithPlay<TArgs>) => Step<TArgs>[];
116
+
117
+ export declare const Given: StepCtor;
118
+
119
+ export declare type Hole = Capture | string | number;
120
+
121
+ export declare type Keyword = 'Given' | 'When' | 'Then' | 'And' | 'But' | 'Star';
122
+
123
+ /** Without a Then-phase step nothing is asserted — the scenario is not a spec. */
124
+ export declare class MissingThen extends MissingThen_base {}
125
+
126
+ declare const MissingThen_base: Schema.Class<MissingThen, Schema.TaggedStruct<"MissingThen", {
127
+ readonly scenario: Schema.String;
128
+ }>, YieldableError>;
129
+
130
+ export declare interface OutlineBuilder<TArgs> {
131
+ readonly examples: (rows: readonly ExampleRow[]) => Record<string, StorySpec<TArgs>>;
132
+ }
133
+
134
+ /** Row names become the exported story names, so duplicates would collide. */
135
+ export declare class OutlineDuplicateRowName extends OutlineDuplicateRowName_base {}
136
+
137
+ declare const OutlineDuplicateRowName_base: Schema.Class<OutlineDuplicateRowName, Schema.TaggedStruct<"OutlineDuplicateRowName", {
138
+ readonly outline: Schema.String;
139
+ readonly name: Schema.String;
140
+ }>, YieldableError>;
141
+
142
+ export declare class OutlineEmpty extends OutlineEmpty_base {}
143
+
144
+ declare const OutlineEmpty_base: Schema.Class<OutlineEmpty, Schema.TaggedStruct<"OutlineEmpty", {
145
+ readonly outline: Schema.String;
146
+ }>, YieldableError>;
147
+
148
+ export declare interface OutlineFn<TArgs> {
149
+ <TName extends string>(name: ScenarioTitle<TName>, ...steps: readonly StepArg<TArgs>[]): OutlineBuilder<TArgs>;
150
+ <TName extends string>(name: ScenarioTitle<TName>, options: ScenarioOptions, ...steps: readonly StepArg<TArgs>[]): OutlineBuilder<TArgs>;
151
+ }
152
+
153
+ export declare class OutlineInconsistentKeys extends OutlineInconsistentKeys_base {}
154
+
155
+ declare const OutlineInconsistentKeys_base: Schema.Class<OutlineInconsistentKeys, Schema.TaggedStruct<"OutlineInconsistentKeys", {
156
+ readonly outline: Schema.String;
157
+ readonly row: Schema.String;
158
+ readonly expected: Schema.$Array<Schema.String>;
159
+ readonly actual: Schema.$Array<Schema.String>;
160
+ }>, YieldableError>;
161
+
162
+ export declare class OutlineMissingCapture extends OutlineMissingCapture_base {}
163
+
164
+ declare const OutlineMissingCapture_base: Schema.Class<OutlineMissingCapture, Schema.TaggedStruct<"OutlineMissingCapture", {
165
+ readonly outline: Schema.String;
166
+ readonly row: Schema.String;
167
+ readonly capture: Schema.String;
168
+ }>, YieldableError>;
169
+
170
+ export declare interface PlayContext<TArgs = unknown> {
171
+ readonly canvas: Canvas;
172
+ readonly canvasElement: HTMLElement;
173
+ readonly step: StepFn;
174
+ readonly userEvent: UserEventObject;
175
+ readonly args: TArgs;
176
+ readonly globals: Record<string, unknown>;
177
+ readonly parameters: Record<string, unknown>;
178
+ readonly loaded: Record<string, unknown>;
179
+ readonly abortSignal: AbortSignal;
180
+ readonly reporting: ReportingAPI;
181
+ }
182
+
183
+ declare interface Report_2 {
184
+ readonly type: string;
185
+ readonly version?: number;
186
+ readonly result: unknown;
187
+ readonly status: 'failed' | 'passed' | 'warning';
188
+ }
189
+ export { Report_2 as Report }
190
+
191
+ export declare interface ReportingAPI {
192
+ readonly reports: Report_2[];
193
+ readonly addReport: (report: Report_2) => void;
194
+ }
195
+
196
+ export declare interface RuleScope<TArgs> {
197
+ readonly scenario: ScenarioFn<TArgs>;
198
+ readonly scenarioOutline: OutlineFn<TArgs>;
199
+ }
200
+
201
+ export declare interface ScenarioFn<TArgs> {
202
+ <TName extends string>(name: ScenarioTitle<TName>, ...steps: readonly StepArg<TArgs>[]): StorySpec<TArgs>;
203
+ <TName extends string>(name: ScenarioTitle<TName>, options: ScenarioOptions, ...steps: readonly StepArg<TArgs>[]): StorySpec<TArgs>;
204
+ }
205
+
206
+ export declare interface ScenarioOptions {
207
+ /** Capture values for a plain (non-outline) scenario, keyed by capture name. */
208
+ readonly with?: Readonly<Record<string, string>>;
209
+ }
210
+
211
+ declare type ScenarioTitle<T extends string> = T extends `Should${string}` ? ScenarioTitleRejected<T> : T extends `${string} ${string}` ? T : ScenarioTitleRejected<T>;
212
+
213
+ /**
214
+ * A scenario title names a concrete situation in natural-language prose. Two
215
+ * shape checks keep DAMP `Should_[Behavior]_When_[Condition]` unit-test names —
216
+ * and every concatenated-token title shaped like one — out of the call site:
217
+ * 1. the literal must not start with `Should`;
218
+ * 2. the literal must contain at least one ASCII space (a single-word title is
219
+ * a test name, not prose).
220
+ * Either check failing maps to `ScenarioTitleRejected`, so the call fails to
221
+ * type-check with the rule in the diagnostic. Non-literal titles (widened
222
+ * `string`) pass through untouched — a runtime guard would catch those, but
223
+ * the brand is the contract this skill ships.
224
+ */
225
+ declare type ScenarioTitleRejected<T extends string> = `Scenario titles are natural-language prose of a concrete situation, not DAMP Should_[Behavior]_When_[Condition] unit-test names. Got: ${T}` | `Scenario title must be natural-language prose (at least one space separates words); got: ${T}`;
226
+
227
+ export declare const Star: StepCtor;
228
+
229
+ export declare interface Step<TArgs = unknown> extends StepTag {
230
+ readonly model: StepModel;
231
+ readonly run: (values: Readonly<Record<string, string>>, ctx: StepContext<TArgs>) => Effect.Effect<void, CaptureDecodeFailed>;
232
+ }
233
+
234
+ /**
235
+ * Anything positional after the scenario name: a step, a step group from
236
+ * `Steps(...)` / `From(...)`, or — in first position only — an options object.
237
+ */
238
+ export declare type StepArg<TArgs> = Step<TArgs> | readonly Step<TArgs>[];
239
+
240
+ export declare interface StepBuilder<THoles extends readonly Hole[], TArgs = unknown> {
241
+ (handler: StepHandler<CapsOf<THoles>, TArgs>): Step<TArgs>;
242
+ }
243
+
244
+ export declare interface StepContext<TArgs = unknown> {
245
+ readonly canvas: Canvas;
246
+ readonly screen: typeof screen_2;
247
+ readonly userEvent: UserEventObject;
248
+ readonly step: StepFn;
249
+ readonly args: TArgs;
250
+ readonly globals: Record<string, unknown>;
251
+ readonly parameters: Record<string, unknown>;
252
+ readonly loaded: Record<string, unknown>;
253
+ readonly canvasElement: HTMLElement;
254
+ /**
255
+ * Fires on story teardown (remount, navigation, HMR). Since the 2026-08-09
256
+ * Effect-composition refactor, the play edge interrupts the in-flight step
257
+ * on abort — steps no longer run to completion after teardown. The step
258
+ * handler's own promise is abandoned, not cancelled: observe this signal
259
+ * for cleanup or to race long-running work.
260
+ */
261
+ readonly abortSignal: AbortSignal;
262
+ readonly reporting: ReportingAPI;
263
+ readonly context: PlayContext<TArgs>;
264
+ }
265
+
266
+ export declare type StepCtor = {
267
+ <const THoles extends readonly Hole[]>(statics: TemplateStringsArray, ...holes: THoles): StepBuilder<THoles>;
268
+ <TArgs, const THoles extends readonly Hole[] = readonly Hole[]>(statics: TemplateStringsArray, ...holes: THoles): StepBuilder<THoles, TArgs>;
269
+ };
270
+
271
+ export declare type StepFn = (label: string, fn: () => Promise<void>) => Promise<void> | void;
272
+
273
+ export declare type StepHandler<TCaps, TArgs = unknown> = (ctx: StepContext<TArgs>, caps: TCaps) => void | Promise<void>;
274
+
275
+ export declare interface StepModel {
276
+ readonly keyword: Keyword;
277
+ /** Static segments around the holes — length is always captures.length + 1. */
278
+ readonly parts: readonly string[];
279
+ readonly captures: readonly CaptureModel[];
280
+ }
281
+
282
+ export declare const Steps: <TArgs>(...steps: readonly Step<TArgs>[]) => Step<TArgs>[];
283
+
284
+ declare const StepTag: {
285
+ readonly _tag: "Step";
286
+ };
287
+
288
+ declare type StepTag = typeof StepTag;
289
+
290
+ export declare interface StorySpec<TArgs = unknown> {
291
+ readonly name: string;
292
+ readonly play: (context: PlayContext<TArgs>) => Promise<void>;
293
+ }
294
+
295
+ declare interface StoryWithPlay<TArgs> {
296
+ readonly play?: (context: PlayContext<TArgs>) => Promise<void> | void;
297
+ }
298
+
299
+ export declare const Then: StepCtor;
300
+
301
+ /** Capture values come from a literal hole, `with`, or an outline row — none matched. */
302
+ export declare class UnresolvedCapture extends UnresolvedCapture_base {}
303
+
304
+ declare const UnresolvedCapture_base: Schema.Class<UnresolvedCapture, Schema.TaggedStruct<"UnresolvedCapture", {
305
+ readonly scenario: Schema.String;
306
+ readonly step: Schema.String;
307
+ readonly capture: Schema.String;
308
+ }>, YieldableError>;
309
+
310
+ export declare const When: StepCtor;
311
+
312
+ export { }
package/dist/index.mjs CHANGED
@@ -3,11 +3,12 @@ import { screen } from "storybook/test";
3
3
  //#region src/Capture.ts
4
4
  const CaptureTag = { _tag: "Capture" };
5
5
  function capture(name, options) {
6
+ const resolved = options ?? {};
6
7
  return {
7
8
  ...CaptureTag,
8
9
  name,
9
- schema: options?.schema,
10
- default: options?.default
10
+ schema: resolved.schema,
11
+ default: resolved.default
11
12
  };
12
13
  }
13
14
  //#endregion
@@ -67,9 +68,22 @@ var CaptureDecodeFailed = class extends Schema.TaggedError()("CaptureDecodeFaile
67
68
  }) {};
68
69
  //#endregion
69
70
  //#region src/Steps.ts
70
- const joinStep = (step, renderHole) => [step.parts[0] ?? "", ...step.captures.flatMap((cap, i) => [renderHole(cap), step.parts[i + 1] ?? ""])].join("");
71
+ const emptyIfMissing = (part) => {
72
+ if (part === void 0) return "";
73
+ return part;
74
+ };
75
+ const joinStep = (step, renderHole) => [emptyIfMissing(step.parts[0]), ...step.captures.flatMap((cap, i) => [renderHole(cap), emptyIfMissing(step.parts[i + 1])])].join("");
71
76
  const displayPattern = (step) => joinStep(step, (cap) => `{${cap.name}}`);
72
- const renderStepText = (step, values) => joinStep(step, (cap) => values[cap.name] ?? cap.default ?? `{${cap.name}}`);
77
+ const firstString = (left, right) => {
78
+ if (left !== void 0) return left;
79
+ return right;
80
+ };
81
+ const holeText = (cap, values) => {
82
+ const fromValues = values[cap.name];
83
+ if (fromValues !== void 0) return fromValues;
84
+ return firstString(cap.default, `{${cap.name}}`);
85
+ };
86
+ const renderStepText = (step, values) => joinStep(step, (cap) => holeText(cap, values));
73
87
  const resolveKeyword = (keyword, previous) => Match.value(keyword).pipe(Match.when("Given", () => "Given"), Match.when("When", () => "When"), Match.when("Then", () => "Then"), Match.when("And", () => previous), Match.when("But", () => previous), Match.when("Star", () => previous), Match.exhaustive);
74
88
  const resolveKeywords = (steps) => {
75
89
  return Array$1.mapAccum(steps, "Given", (previous, s) => {
@@ -82,44 +96,63 @@ const resolveKeywords = (steps) => {
82
96
  };
83
97
  const STEP_TAG = "Step";
84
98
  const StepTag = { _tag: STEP_TAG };
99
+ const partAt = (statics, index) => emptyIfMissing(statics[index]);
100
+ const appendLiteral = (current, literal, trailing) => current + literal + trailing;
101
+ const consumeNonStringHole = (current, hole, trailing, parts, captures) => {
102
+ if (typeof hole === "number") return appendLiteral(current, String(hole), trailing);
103
+ parts.push(current);
104
+ captures.push({
105
+ name: hole.name,
106
+ schema: hole.schema,
107
+ default: hole.default
108
+ });
109
+ return trailing;
110
+ };
111
+ const consumeHole = (current, hole, trailing, parts, captures) => {
112
+ if (typeof hole === "string") return appendLiteral(current, hole, trailing);
113
+ return consumeNonStringHole(current, hole, trailing, parts, captures);
114
+ };
115
+ const rememberCapture = (model, seen, cap) => {
116
+ if (seen.has(cap.name)) throw DuplicateCapture.make({
117
+ step: displayPattern(model),
118
+ name: cap.name
119
+ });
120
+ seen.add(cap.name);
121
+ };
122
+ const assertUniqueCaptures = (model, captures) => {
123
+ const seen = /* @__PURE__ */ new Set();
124
+ for (const cap of captures) rememberCapture(model, seen, cap);
125
+ };
85
126
  const buildModel = (keyword, statics, holes) => {
86
127
  const parts = [];
87
128
  const captures = [];
88
- let current = statics[0] ?? "";
89
- for (const [i, hole] of holes.entries()) if (typeof hole === "string") current += hole + (statics[i + 1] ?? "");
90
- else if (typeof hole === "number") current += String(hole) + (statics[i + 1] ?? "");
91
- else {
92
- parts.push(current);
93
- current = statics[i + 1] ?? "";
94
- captures.push({
95
- name: hole.name,
96
- schema: hole.schema,
97
- default: hole.default
98
- });
99
- }
129
+ let current = partAt(statics, 0);
130
+ for (const [i, hole] of holes.entries()) current = consumeHole(current, hole, partAt(statics, i + 1), parts, captures);
100
131
  parts.push(current);
101
132
  const model = {
102
133
  keyword,
103
134
  parts,
104
135
  captures
105
136
  };
106
- const seen = /* @__PURE__ */ new Set();
107
- for (const cap of captures) {
108
- if (seen.has(cap.name)) throw DuplicateCapture.make({
109
- step: displayPattern(model),
110
- name: cap.name
111
- });
112
- seen.add(cap.name);
113
- }
137
+ assertUniqueCaptures(model, captures);
114
138
  return model;
115
139
  };
140
+ const captureRaw = (cap, values) => {
141
+ const fromValues = values[cap.name];
142
+ if (fromValues !== void 0) return fromValues;
143
+ return cap.default;
144
+ };
145
+ const rawOrEmpty = (raw) => {
146
+ if (raw === void 0) return "";
147
+ return raw;
148
+ };
116
149
  const decodeCapture = (cap, values, model) => {
117
- const raw = values[cap.name] ?? cap.default;
150
+ const raw = captureRaw(cap, values);
118
151
  if (cap.schema === void 0) return Effect.succeed(raw);
119
152
  return Schema.decodeEffect(cap.schema)(raw).pipe(Effect.mapError((error) => CaptureDecodeFailed.make({
120
153
  step: displayPattern(model),
121
154
  capture: cap.name,
122
- value: raw ?? "",
155
+ value: rawOrEmpty(raw),
123
156
  cause: error
124
157
  })));
125
158
  };
@@ -146,13 +179,28 @@ const Then = makeStepCtor("Then");
146
179
  const And = makeStepCtor("And");
147
180
  const But = makeStepCtor("But");
148
181
  const Star = makeStepCtor("Star");
182
+ const isNonNullObject = (value) => {
183
+ if (typeof value !== "object") return false;
184
+ return value !== null;
185
+ };
186
+ const hasModelAndRun = (value) => {
187
+ if (!("model" in value)) return false;
188
+ return "run" in value;
189
+ };
190
+ const hasStepFields = (value) => {
191
+ if (Reflect.get(value, "_tag") !== STEP_TAG) return false;
192
+ return hasModelAndRun(value);
193
+ };
149
194
  const isStep = (value) => {
150
- if (typeof value !== "object" || value === null) return false;
151
- return Reflect.get(value, "_tag") === STEP_TAG && "model" in value && "run" in value;
195
+ if (!isNonNullObject(value)) return false;
196
+ return hasStepFields(value);
152
197
  };
153
198
  //#endregion
154
199
  //#region src/Feature.ts
155
- const displayKeyword = (model) => model.keyword === "Star" ? "*" : model.keyword;
200
+ const displayKeyword = (model) => {
201
+ if (model.keyword === "Star") return "*";
202
+ return model.keyword;
203
+ };
156
204
  const buildStepContext = (ctx) => ({
157
205
  canvas: ctx.canvas,
158
206
  screen,
@@ -167,12 +215,6 @@ const buildStepContext = (ctx) => ({
167
215
  reporting: ctx.reporting,
168
216
  context: ctx
169
217
  });
170
- /**
171
- * Total classification of an interpreted program's `Exit`, shared by the play
172
- * edge and the step bridge: interruption resolves silently, success returns
173
- * the value, and any other cause is rethrown as the original error instance
174
- * (`Cause.squash`) so Storybook's panel keeps the matcher diff.
175
- */
176
218
  const squashExit = (exit) => Exit.match(exit, {
177
219
  onSuccess: (value) => value,
178
220
  onFailure: (cause) => {
@@ -180,17 +222,6 @@ const squashExit = (exit) => Exit.match(exit, {
180
222
  throw Cause.squash(cause);
181
223
  }
182
224
  });
183
- /**
184
- * One scenario step, composed as an Effect. Storybook's instrumented `step`
185
- * expects a promise whose settlement tracks the step's work, so the body runs
186
- * in a child fiber that settles a deferred; the bridge promise given to
187
- * `stepCtx.step` awaits that deferred and rejects with the step's original error.
188
- * The bridge interprets only this pure signalling effect; user code runs in
189
- * the single play-edge interpretation. The `ensuring` finalizer interrupts
190
- * the child on every parent exit — success (no-op on a joined fiber),
191
- * failure, and interruption — so an independently failed `stepCtx.step` never
192
- * orphans a running step body.
193
- */
194
225
  const runStep = (step, values, stepCtx) => {
195
226
  const label = `${displayKeyword(step.model)} ${renderStepText(step.model, values)}`;
196
227
  return Deferred.make().pipe(Effect.flatMap((done) => {
@@ -202,7 +233,6 @@ const executeSteps = (ordered, values, ctx) => {
202
233
  const stepCtx = buildStepContext(ctx);
203
234
  return Effect.forEach(ordered, (s) => runStep(s, values, stepCtx), { discard: true });
204
235
  };
205
- /** The single interpretation edge of the package. */
206
236
  const interpretPlay = (context, program, ctx) => Effect.runPromiseExitWith(context)(program, { signal: ctx.abortSignal }).then(squashExit);
207
237
  const rowValuesFor = (row) => Object.fromEntries(Object.entries(row).filter(([k]) => k !== "name"));
208
238
  const sortKeys = (keys) => {
@@ -210,41 +240,95 @@ const sortKeys = (keys) => {
210
240
  sorted.sort();
211
241
  return sorted;
212
242
  };
213
- const validateScenarioSteps = (fullName, models, withRecord) => {
243
+ const assertNonEmptyScenario = (fullName, models) => {
214
244
  if (models.length === 0) throw EmptyScenario.make({ scenario: fullName });
215
- if (!resolveKeywords(models).some((r) => r.resolved === "Then")) throw MissingThen.make({ scenario: fullName });
216
- for (const stepModel of models) for (const cap of stepModel.captures) {
217
- const hasDefault = cap.default !== void 0;
218
- const hasWith = Object.prototype.hasOwnProperty.call(withRecord, cap.name);
219
- if (!hasDefault && !hasWith) throw UnresolvedCapture.make({
220
- scenario: fullName,
221
- step: displayPattern(stepModel),
222
- capture: cap.name
223
- });
224
- }
245
+ };
246
+ const isThen = (r) => r.resolved === "Then";
247
+ const assertHasThen = (fullName, models) => {
248
+ if (!resolveKeywords(models).some(isThen)) throw MissingThen.make({ scenario: fullName });
249
+ };
250
+ const captureIsBound = (cap, withRecord) => {
251
+ if (cap.default !== void 0) return true;
252
+ return Object.prototype.hasOwnProperty.call(withRecord, cap.name);
253
+ };
254
+ const assertCaptureBound = (fullName, stepModel, cap, withRecord) => {
255
+ if (captureIsBound(cap, withRecord)) return;
256
+ throw UnresolvedCapture.make({
257
+ scenario: fullName,
258
+ step: displayPattern(stepModel),
259
+ capture: cap.name
260
+ });
261
+ };
262
+ const assertCapturesBound = (fullName, stepModel, withRecord) => {
263
+ for (const cap of stepModel.captures) assertCaptureBound(fullName, stepModel, cap, withRecord);
264
+ };
265
+ const validateScenarioSteps = (fullName, models, withRecord) => {
266
+ assertNonEmptyScenario(fullName, models);
267
+ assertHasThen(fullName, models);
268
+ for (const stepModel of models) assertCapturesBound(fullName, stepModel, withRecord);
225
269
  };
226
270
  const isScenarioOptions = (value) => !isStep(value) && !Array.isArray(value);
227
- const parseScenarioArgs = (rest) => {
271
+ const optionsIfPresent = (firstArg) => {
272
+ if (!isScenarioOptions(firstArg)) return void 0;
273
+ return firstArg;
274
+ };
275
+ const readOptions = (rest) => {
228
276
  const firstArg = rest[0];
229
- const options = firstArg !== void 0 && isScenarioOptions(firstArg) ? firstArg : void 0;
230
- const body = options === void 0 ? rest : rest.slice(1);
231
- const steps = [];
232
- for (const item of body) if (isStep(item)) steps.push(item);
233
- else if (Array.isArray(item)) for (const inner of item) {
234
- if (!isStep(inner)) throw new TypeError(`Steps group contains a non-step value of type ${typeof inner}`);
235
- steps.push(inner);
277
+ if (firstArg === void 0) return void 0;
278
+ return optionsIfPresent(firstArg);
279
+ };
280
+ const bodyAfterOptions = (rest, options) => {
281
+ if (options === void 0) return rest;
282
+ return rest.slice(1);
283
+ };
284
+ const pushInnerStep = (steps, inner) => {
285
+ if (!isStep(inner)) throw new TypeError(`Steps group contains a non-step value of type ${typeof inner}`);
286
+ steps.push(inner);
287
+ };
288
+ const pushStepGroup = (steps, item) => {
289
+ for (const inner of item) pushInnerStep(steps, inner);
290
+ };
291
+ const pushIfGroup = (steps, item) => {
292
+ if (Array.isArray(item)) {
293
+ pushStepGroup(steps, item);
294
+ return;
295
+ }
296
+ throw new TypeError(`Scenario arguments must be steps or step groups; got type ${typeof item}`);
297
+ };
298
+ const pushScenarioItem = (steps, item) => {
299
+ if (isStep(item)) {
300
+ steps.push(item);
301
+ return;
236
302
  }
237
- else throw new TypeError(`Scenario arguments must be steps or step groups; got type ${typeof item}`);
303
+ pushIfGroup(steps, item);
304
+ };
305
+ const parseScenarioArgs = (rest) => {
306
+ const options = readOptions(rest);
307
+ const body = bodyAfterOptions(rest, options);
308
+ const steps = [];
309
+ for (const item of body) pushScenarioItem(steps, item);
238
310
  return {
239
311
  options,
240
312
  steps
241
313
  };
242
314
  };
315
+ const qualifyName = (prefix, name) => {
316
+ if (prefix === "") return name;
317
+ return `${prefix}: ${name}`;
318
+ };
319
+ const recordOrEmpty = (value) => {
320
+ if (value === void 0) return {};
321
+ return value;
322
+ };
323
+ const withRecordOf = (options) => {
324
+ if (options === void 0) return {};
325
+ return recordOrEmpty(options.with);
326
+ };
243
327
  const makeScenario = (background, prefix, context) => {
244
328
  function scenario(name, ...rest) {
245
329
  const { options, steps } = parseScenarioArgs(rest);
246
- const fullName = prefix === "" ? name : `${prefix}: ${name}`;
247
- const withRecord = options?.with ?? {};
330
+ const fullName = qualifyName(prefix, name);
331
+ const withRecord = withRecordOf(options);
248
332
  validateScenarioSteps(fullName, steps.map((s) => s.model), withRecord);
249
333
  return {
250
334
  name: fullName,
@@ -253,40 +337,77 @@ const makeScenario = (background, prefix, context) => {
253
337
  }
254
338
  return scenario;
255
339
  };
256
- const validateOutlineRows = (rows, captureNames, fullName) => {
340
+ const assertOutlineNonEmpty = (rows, fullName) => {
257
341
  if (rows.length === 0) throw OutlineEmpty.make({ outline: fullName });
342
+ };
343
+ const isNotName = (k) => k !== "name";
344
+ const keysExceptName = (row) => sortKeys(Object.keys(row).filter(isNotName));
345
+ const firstRowKeys = (rows) => {
346
+ const first = rows[0];
347
+ if (first === void 0) return [];
348
+ return keysExceptName(first);
349
+ };
350
+ const rememberRowName = (seen, row, fullName) => {
351
+ if (seen.has(row.name)) throw OutlineDuplicateRowName.make({
352
+ outline: fullName,
353
+ name: row.name
354
+ });
355
+ seen.add(row.name);
356
+ };
357
+ const keyAtMatches = (actual, expected, i) => actual[i] === expected[i];
358
+ const keysMatch = (actual, expected) => {
359
+ if (actual.length !== expected.length) return false;
360
+ return actual.every((_, i) => keyAtMatches(actual, expected, i));
361
+ };
362
+ const assertKeysConsistent = (row, firstKeys, fullName) => {
363
+ const actual = keysExceptName(row);
364
+ if (keysMatch(actual, firstKeys)) return;
365
+ throw OutlineInconsistentKeys.make({
366
+ outline: fullName,
367
+ row: row.name,
368
+ expected: [...firstKeys],
369
+ actual: [...actual]
370
+ });
371
+ };
372
+ const assertRowHasCapture = (row, cap, fullName) => {
373
+ if (Object.prototype.hasOwnProperty.call(row, cap)) return;
374
+ throw OutlineMissingCapture.make({
375
+ outline: fullName,
376
+ row: row.name,
377
+ capture: cap
378
+ });
379
+ };
380
+ const assertRowCaptures = (row, captureNames, fullName) => {
381
+ for (const cap of captureNames) assertRowHasCapture(row, cap, fullName);
382
+ };
383
+ const validateOneRow = (seenRowNames, row, firstKeys, captureNames, fullName) => {
384
+ rememberRowName(seenRowNames, row, fullName);
385
+ assertKeysConsistent(row, firstKeys, fullName);
386
+ assertRowCaptures(row, captureNames, fullName);
387
+ };
388
+ const validateOutlineRows = (rows, captureNames, fullName) => {
389
+ assertOutlineNonEmpty(rows, fullName);
258
390
  const seenRowNames = /* @__PURE__ */ new Set();
259
- const firstKeys = sortKeys(Object.keys(rows[0] ?? {}).filter((k) => k !== "name"));
260
- for (const row of rows) {
261
- if (seenRowNames.has(row.name)) throw OutlineDuplicateRowName.make({
262
- outline: fullName,
263
- name: row.name
264
- });
265
- seenRowNames.add(row.name);
266
- const actual = sortKeys(Object.keys(row).filter((k) => k !== "name"));
267
- if (actual.length !== firstKeys.length || actual.some((k, i) => k !== firstKeys[i])) throw OutlineInconsistentKeys.make({
268
- outline: fullName,
269
- row: row.name,
270
- expected: [...firstKeys],
271
- actual: [...actual]
272
- });
273
- for (const cap of captureNames) if (!Object.prototype.hasOwnProperty.call(row, cap)) throw OutlineMissingCapture.make({
274
- outline: fullName,
275
- row: row.name,
276
- capture: cap
277
- });
278
- }
391
+ const firstKeys = firstRowKeys(rows);
392
+ for (const row of rows) validateOneRow(seenRowNames, row, firstKeys, captureNames, fullName);
393
+ };
394
+ const addModelCaptures = (captureNames, m) => {
395
+ for (const c of m.captures) captureNames.add(c.name);
396
+ };
397
+ const collectCaptureNames = (models) => {
398
+ const captureNames = /* @__PURE__ */ new Set();
399
+ for (const m of models) addModelCaptures(captureNames, m);
400
+ return captureNames;
279
401
  };
280
402
  const makeOutline = (background, prefix, context) => {
281
403
  function outline(name, ...rest) {
282
404
  const { options, steps } = parseScenarioArgs(rest);
283
- const fullName = prefix === "" ? name : `${prefix}: ${name}`;
284
- const withRecord = options?.with ?? {};
405
+ const fullName = qualifyName(prefix, name);
406
+ const withRecord = withRecordOf(options);
285
407
  const models = steps.map((s) => s.model);
286
- if (models.length === 0) throw EmptyScenario.make({ scenario: fullName });
287
- if (!resolveKeywords(models).some((r) => r.resolved === "Then")) throw MissingThen.make({ scenario: fullName });
288
- const captureNames = /* @__PURE__ */ new Set();
289
- for (const m of models) for (const c of m.captures) captureNames.add(c.name);
408
+ assertNonEmptyScenario(fullName, models);
409
+ assertHasThen(fullName, models);
410
+ const captureNames = collectCaptureNames(models);
290
411
  const buildRowSpec = (row) => {
291
412
  const values = {
292
413
  ...withRecord,
@@ -307,17 +428,24 @@ const makeOutline = (background, prefix, context) => {
307
428
  }
308
429
  return outline;
309
430
  };
431
+ const assertResolvedGiven = (step, resolved) => {
432
+ if (resolved === "Given") return;
433
+ throw BackgroundNotGiven.make({
434
+ step: displayPattern(step.model),
435
+ resolved
436
+ });
437
+ };
438
+ const assertBackgroundResolved = (step, resolvedEntry) => {
439
+ if (resolvedEntry === void 0) return;
440
+ assertResolvedGiven(step, resolvedEntry.resolved);
441
+ };
442
+ const assertBackgroundStep = (step, resolvedEntry) => {
443
+ if (step === void 0) return;
444
+ assertBackgroundResolved(step, resolvedEntry);
445
+ };
310
446
  const makeBackground = (background) => (...steps) => {
311
447
  const resolvedKeywords = resolveKeywords(steps.map((s) => s.model));
312
- for (let i = 0; i < steps.length; i++) {
313
- const step = steps[i];
314
- const resolvedEntry = resolvedKeywords[i];
315
- if (step === void 0 || resolvedEntry === void 0) continue;
316
- if (resolvedEntry.resolved !== "Given") throw BackgroundNotGiven.make({
317
- step: displayPattern(step.model),
318
- resolved: resolvedEntry.resolved
319
- });
320
- }
448
+ for (let i = 0; i < steps.length; i++) assertBackgroundStep(steps[i], resolvedKeywords[i]);
321
449
  background.push(...steps);
322
450
  };
323
451
  const makeFeature = (meta, context) => {
@@ -334,13 +462,17 @@ const makeFeature = (meta, context) => {
334
462
  })
335
463
  };
336
464
  };
465
+ const contextOf = (options) => {
466
+ if (options.context === void 0) return Context.empty();
467
+ return options.context;
468
+ };
337
469
  /**
338
470
  * Declare a feature: a story set whose scenarios execute as CSF `play`
339
471
  * functions. `options.context` (default `Context.empty()`) is the Effect
340
472
  * context interpreting each scenario's composed step program exactly once,
341
473
  * at the play edge.
342
474
  */
343
- const feature = (meta, options = {}) => makeFeature(meta, options.context ?? Context.empty());
475
+ const feature = (meta, options = {}) => makeFeature(meta, contextOf(options));
344
476
  const Steps = (...steps) => [...steps];
345
477
  const From = (story) => {
346
478
  const play = story.play;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@systemfsoftware/storybook-gherkin",
3
3
  "license": "Apache-2.0",
4
- "version": "3.0.3",
4
+ "version": "3.0.5",
5
5
  "author": "Ryan Lee <drdgvhbh@gmail.com>",
6
6
  "repository": {
7
7
  "type": "git",
@@ -36,47 +36,51 @@
36
36
  "dist"
37
37
  ],
38
38
  "dependencies": {
39
- "type-fest": "^5.8.0"
39
+ "type-fest": "^5.10.0"
40
40
  },
41
41
  "peerDependencies": {
42
- "effect": "4.0.0-rc.112",
42
+ "effect": "4.0.0-rc.116",
43
43
  "storybook": ">=10.0.0"
44
44
  },
45
45
  "devDependencies": {
46
- "@storybook/addon-vitest": "^10.5.0",
47
- "@storybook/react-vite": "^10.5.0",
48
- "@systemfsoftware/arethetypeswrong-cli": "^4.1.0",
49
- "@types/node": "^24",
50
- "@types/react": "^19.2.18",
51
- "@types/react-dom": "^19.2.4",
52
- "@vitest/browser": "^4",
53
- "@vitest/browser-playwright": "^4",
54
- "effect": "4.0.0-rc.112",
55
- "oxlint": "^1.77.0",
46
+ "@microsoft/api-extractor": "^7.59.1",
47
+ "@storybook/addon-vitest": "^10.6.0",
48
+ "@storybook/react-vite": "^10.6.0",
49
+ "@systemfsoftware/arethetypeswrong-cli": "^4.2.0",
50
+ "@types/node": "^26",
51
+ "@types/react": "^19.3.0",
52
+ "@types/react-dom": "^19.3.0",
53
+ "@vitest/browser": "^5",
54
+ "@vitest/browser-playwright": "^5",
55
+ "effect": "4.0.0-rc.116",
56
+ "oxlint": "~1.82.0",
56
57
  "playwright": "^1",
57
- "react": "^19.2.8",
58
- "react-dom": "^19.2.8",
58
+ "react": "^19.3.0",
59
+ "react-dom": "^19.3.0",
59
60
  "rimraf": "^6.1.3",
60
- "storybook": "^10.5.0",
61
- "tsdown": "^0.22.14",
61
+ "storybook": "^10.6.0",
62
+ "tsdown": "^0.23.0",
62
63
  "typescript": "^7",
63
64
  "vite": "^8",
64
- "vitest": "^4",
65
- "@systemfsoftware/oxlint-config": "^0.1.0",
66
- "@systemfsoftware/tsconfig": "^1.3.4"
65
+ "vitest": "^5",
66
+ "@systemfsoftware/all": "^2.1.1",
67
+ "@systemfsoftware/tsconfig": "^1.3.5",
68
+ "@systemfsoftware/oxlint-config": "^0.1.0"
67
69
  },
68
70
  "publishConfig": {
69
71
  "provenance": true
70
72
  },
71
73
  "scripts": {
72
74
  "clean": "rimraf dist",
73
- "build": "tsdown && pnpm dts:check",
75
+ "build": "tsdown && pnpm dts:check && pnpm api:check",
74
76
  "typecheck": "tsc --noEmit --incremental",
75
77
  "lint": "f=${OXLINT_FORMAT:-${AGENT:+agent}}; oxlint . --config oxlint.config.ts --format=${f:-default}",
76
78
  "lint:tsgo": "effect-tsgo diagnostics --project tsconfig.json --format ${TSGO_FORMAT:-text}",
77
79
  "attw": "attw --pack .",
78
80
  "dts:check": "node scripts/check-dts.mjs",
79
81
  "storybook": "storybook dev -p 6006 --no-open",
80
- "test:browser": "pnpm build && vitest run"
82
+ "test:browser": "pnpm build && vitest run",
83
+ "api:check": "tsdown && api-extractor run",
84
+ "api:update": "api-extractor run --local"
81
85
  }
82
86
  }