@shivaedev/test-story 0.27.0 → 0.29.0

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.
Files changed (56) hide show
  1. package/CHANGELOG.md +18 -0
  2. package/README.md +44 -5
  3. package/dist/server/internal/compose.d.ts.map +1 -1
  4. package/dist/server/internal/compose.js +2 -2
  5. package/dist/server/internal/compose.js.map +1 -1
  6. package/dist/server/internal/engineSnapshot.d.ts.map +1 -1
  7. package/dist/server/internal/engineSnapshot.js +3 -0
  8. package/dist/server/internal/engineSnapshot.js.map +1 -1
  9. package/dist/server/internal/hookInference.d.ts +3 -2
  10. package/dist/server/internal/hookInference.d.ts.map +1 -1
  11. package/dist/server/internal/narration.d.ts +11 -1
  12. package/dist/server/internal/narration.d.ts.map +1 -1
  13. package/dist/server/internal/narration.js +8 -3
  14. package/dist/server/internal/narration.js.map +1 -1
  15. package/dist/server/internal/screenActivity.d.ts +5 -0
  16. package/dist/server/internal/screenActivity.d.ts.map +1 -0
  17. package/dist/server/internal/screenActivity.js +10 -0
  18. package/dist/server/internal/screenActivity.js.map +1 -0
  19. package/dist/server/internal/screenElements.d.ts +2 -1
  20. package/dist/server/internal/screenElements.d.ts.map +1 -1
  21. package/dist/server/internal/screenElements.js +2 -11
  22. package/dist/server/internal/screenElements.js.map +1 -1
  23. package/dist/server/internal/screenReadouts.d.ts +10 -0
  24. package/dist/server/internal/screenReadouts.d.ts.map +1 -0
  25. package/dist/server/internal/screenReadouts.js +27 -0
  26. package/dist/server/internal/screenReadouts.js.map +1 -0
  27. package/dist/server/internal/screenText.d.ts +2 -0
  28. package/dist/server/internal/screenText.d.ts.map +1 -0
  29. package/dist/server/internal/screenText.js +40 -0
  30. package/dist/server/internal/screenText.js.map +1 -0
  31. package/dist/server/internal/start.js +1 -1
  32. package/dist/server/internal/start.js.map +1 -1
  33. package/dist/server/screenDriver.d.ts +17 -5
  34. package/dist/server/screenDriver.d.ts.map +1 -1
  35. package/dist/server/screenDriver.js +28 -22
  36. package/dist/server/screenDriver.js.map +1 -1
  37. package/dist/server/storyKit.d.ts +2 -2
  38. package/dist/server/storyKit.d.ts.map +1 -1
  39. package/dist/server/storyKit.js.map +1 -1
  40. package/dist/server/until.d.ts +16 -0
  41. package/dist/server/until.d.ts.map +1 -0
  42. package/dist/server/until.js +36 -0
  43. package/dist/server/until.js.map +1 -0
  44. package/package.json +3 -3
  45. package/src/server/internal/compose.ts +6 -2
  46. package/src/server/internal/engineSnapshot.ts +4 -1
  47. package/src/server/internal/hookInference.ts +4 -2
  48. package/src/server/internal/narration.ts +15 -3
  49. package/src/server/internal/screenActivity.ts +15 -0
  50. package/src/server/internal/screenElements.ts +2 -11
  51. package/src/server/internal/screenReadouts.ts +28 -0
  52. package/src/server/internal/screenText.ts +41 -0
  53. package/src/server/internal/start.ts +1 -1
  54. package/src/server/screenDriver.ts +43 -25
  55. package/src/server/storyKit.ts +4 -2
  56. package/src/server/until.ts +60 -0
@@ -112,8 +112,9 @@ export function storyKit<
112
112
  TStep extends AnyEffect = never,
113
113
  TFailed extends AnyEffect = never,
114
114
  TDiagnose extends AnyEffect = never,
115
+ TInspect extends (engine: HookValue<ReturnType<TCreate>>) => unknown = (engine: HookValue<ReturnType<TCreate>>) => unknown,
115
116
  >(
116
- definition: InferredDefinition<TCreate, TStage, TVerbs, TProvided, TAfter, TStep, TFailed, TDiagnose>,
117
+ definition: InferredDefinition<TCreate, TStage, TVerbs, TProvided, TAfter, TStep, TFailed, TDiagnose, TInspect>,
117
118
  ): StoryKit<HookValue<ReturnType<TCreate>>, TStage, TVerbs, TStep | TFailed | TDiagnose, TProvided>;
118
119
  export function storyKit<const TKits extends KitList>(definition: Composition<TKits>): ComposedKit<TKits>;
119
120
  // TypeScript reports the last overload's error, so it must check both definition shapes.
@@ -126,9 +127,10 @@ export function storyKit<
126
127
  TStep extends AnyEffect = never,
127
128
  TFailed extends AnyEffect = never,
128
129
  TDiagnose extends AnyEffect = never,
130
+ TInspect extends (engine: HookValue<ReturnType<TCreate>>) => unknown = (engine: HookValue<ReturnType<TCreate>>) => unknown,
129
131
  const TKits extends KitList = KitList,
130
132
  >(
131
- definition: InferredDefinition<TCreate, TStage, TVerbs, TProvided, TAfter, TStep, TFailed, TDiagnose> | Composition<TKits>,
133
+ definition: InferredDefinition<TCreate, TStage, TVerbs, TProvided, TAfter, TStep, TFailed, TDiagnose, TInspect> | Composition<TKits>,
132
134
  ): StoryKit<HookValue<ReturnType<TCreate>>, TStage, TVerbs, TStep | TFailed | TDiagnose, TProvided> | ComposedKit<TKits>;
133
135
  export function storyKit(input: LooseDefinition | Composition<KitList>): unknown {
134
136
  const definition = "extends" in input ? compose(input.name, input.extends) : input;
@@ -0,0 +1,60 @@
1
+ import { Data, type Duration, Effect, Option, Stream } from "effect";
2
+ import { withLive } from "@shivaedev/test/withLive.ts";
3
+ import { describeValue } from "#internal/render.ts";
4
+
5
+ export interface UntilOptions {
6
+ readonly name: string;
7
+ readonly timeout?: Duration.Input;
8
+ }
9
+
10
+ export class SignalNotReceived extends Data.TaggedError("SignalNotReceived")<{
11
+ readonly message: string;
12
+ }> {}
13
+
14
+ export function until<A, E, R>(stream: Stream.Stream<A, E, R>, matches: (value: A) => boolean, options: UntilOptions) {
15
+ return Effect.suspend(() => {
16
+ let last = "(no values received)";
17
+ let found: Option.Option<A> = Option.none();
18
+ function absent(reason: string) {
19
+ return new SignalNotReceived({
20
+ message: `Signal "${options.name}" never arrived: ${reason}.\nLast value seen: ${last}\nhelp: Check that the action emits this signal and that the predicate matches its expected value.`,
21
+ });
22
+ }
23
+ const read = stream.pipe(
24
+ Stream.runForEachWhile((value) =>
25
+ Effect.sync(() => {
26
+ last = describeValue(value);
27
+ if (!matches(value)) {
28
+ return true;
29
+ }
30
+ found = Option.some(value);
31
+ return false;
32
+ }),
33
+ ),
34
+ Effect.flatMap(() => (Option.isSome(found) ? Effect.succeed(found.value) : Effect.fail(absent("the stream ended")))),
35
+ );
36
+ const deadline = Effect.sleep(options.timeout ?? "5 seconds").pipe(
37
+ Effect.andThen(Effect.failSync(() => absent("the live-time deadline expired"))),
38
+ withLive,
39
+ );
40
+ return Effect.raceFirst(read, deadline);
41
+ });
42
+ }
43
+
44
+ export function collectUntil<A, E, R>(stream: Stream.Stream<A, E, R>, matches: (values: readonly A[]) => boolean, options: UntilOptions) {
45
+ return Effect.suspend(() => {
46
+ const values: A[] = [];
47
+ return until(
48
+ stream.pipe(
49
+ Stream.mapEffect((value) =>
50
+ Effect.sync((): readonly A[] => {
51
+ values.push(value);
52
+ return [...values];
53
+ }),
54
+ ),
55
+ ),
56
+ matches,
57
+ options,
58
+ );
59
+ });
60
+ }