effect-bdd 0.1.0

package/dist/Bdd.d.ts

@@ -0,0 +1,285 @@
+/**
+ * @since 4.0.0
+ */
+import type * as Effect from "effect/Effect";
+import { type Pipeable } from "effect/Pipeable";
+import type * as Schema from "effect/Schema";
+import { MatchError, ParseError, StepError } from "./Errors.ts";
+import * as expression from "./internal/expression.ts";
+import * as parser from "./internal/parser.ts";
+import * as runner from "./internal/runner.ts";
+/**
+ * Error type returned by `Bdd.run`.
+ *
+ * @category errors
+ * @since 4.0.0
+ */
+export type RunError = ParseError | MatchError | StepError;
+/**
+ * Service used to compile Gherkin source into executable scenarios.
+ *
+ * **Details**
+ *
+ * The built-in `Cucumber` layer uses Cucumber's parser and Pickle compiler.
+ * Custom implementations must preserve the compiled step, argument, tag, and
+ * source-location semantics expected by the runner.
+ *
+ * @category services
+ * @since 4.0.0
+ */
+export declare const GherkinCompiler: typeof parser.GherkinCompiler & {
+    Cucumber: import("effect/Layer").Layer<parser.GherkinCompiler, never, never>;
+};
+/**
+ * Service used to compile Gherkin source into executable scenarios.
+ *
+ * **Details**
+ *
+ * The built-in `Cucumber` layer uses Cucumber's parser and Pickle compiler.
+ * Custom implementations must preserve the compiled step, argument, tag, and
+ * source-location semantics expected by the runner.
+ *
+ * @category services
+ * @since 4.0.0
+ */
+export type GherkinCompiler = parser.GherkinCompiler;
+/**
+ * Advanced keyword metadata attached to a transition.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type StepKind = "Step" | "Given" | "When" | "Then";
+/**
+ * A named capture decoded from step text with a Schema.
+ *
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Capture<Name extends string, A> = expression.Capture<Name, A>;
+/**
+ * Advanced type helper that maps capture definitions to decoded values.
+ *
+ * @category utility types
+ * @since 4.0.0
+ */
+export type CapturesOf<Captures extends ReadonlyArray<Capture<string, unknown>>> = {
+    readonly [Capture in Captures[number] as Capture["name"]]: Capture extends expression.Capture<string, infer A> ? A : never;
+};
+/**
+ * Advanced matcher type for a compiled step expression.
+ *
+ * @category utility types
+ * @since 4.0.0
+ */
+export type Expression<A> = expression.Matcher<A>;
+/**
+ * A decoded DataTable argument.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface TableArg<A> {
+    readonly _tag: "TableArg";
+    readonly decode: (table: runner.DataTableInput) => Effect.Effect<A, unknown>;
+}
+/**
+ * A decoded DocString argument.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface DocStringArg<A> {
+    readonly _tag: "DocStringArg";
+    readonly decode: (docString: runner.DocStringInput) => Effect.Effect<A, unknown>;
+}
+/**
+ * Advanced union of decoded step argument descriptors.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type StepArg<A> = TableArg<A> | DocStringArg<A>;
+/**
+ * Advanced model for a transition registered on a feature definition.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface Transition<State, E, R, Captures = unknown, Argument = unknown> {
+    readonly kind: StepKind;
+    readonly expression: Expression<Captures>;
+    readonly argument?: StepArg<Argument>;
+    readonly run: (captures: Captures, argument: Argument, state: State) => Effect.Effect<State, E, R>;
+}
+/**
+ * Existential transition type stored by feature definitions.
+ *
+ * **Details**
+ *
+ * A feature can contain many transitions with different capture and step
+ * argument shapes. The public constructors keep those shapes typed at the
+ * handler boundary, while the runtime matcher stores transitions through this
+ * existential type.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export type AnyTransition<State, E, R> = Transition<State, E, R, any, any>;
+/**
+ * A local immutable feature definition used to interpret scenarios from Gherkin source.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface Feature<State, E = never, R = never> extends Pipeable {
+    readonly _tag: "Feature";
+    readonly name: string;
+    readonly initial: State;
+    readonly transitions: ReadonlyArray<AnyTransition<State, E, R>>;
+}
+/**
+ * Result returned after all scenarios pass.
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export interface Report {
+    readonly feature: string;
+    readonly scenarios: ReadonlyArray<{
+        readonly name: string;
+        readonly steps: number;
+        readonly tags: ReadonlyArray<string>;
+    }>;
+}
+type FeatureType<State, E, R> = Feature<State, E, R>;
+type ReportType = Report;
+type RunErrorType = RunError;
+type GherkinCompilerType = GherkinCompiler;
+type CaptureType<Name extends string, A> = Capture<Name, A>;
+type TableArgType<A> = TableArg<A>;
+type DocStringArgType<A> = DocStringArg<A>;
+/**
+ * Namespace-style API for building and running BDD feature definitions.
+ *
+ * **Details**
+ *
+ * The namespace contains constructors for captures, step arguments, feature
+ * definitions, step transitions, and the Gherkin runner.
+ *
+ * **Example** (Defining and running a feature)
+ *
+ * ```ts
+ * import { Bdd } from "effect-bdd"
+ * import { Effect, Schema } from "effect"
+ *
+ * const qty = Bdd.capture("qty", Schema.FiniteFromString)
+ *
+ * const feature = Bdd.feature("Counter", { initial: 0 }).pipe(
+ *   Bdd.given`zero`(() => Effect.succeed(0)),
+ *   Bdd.when`increment by ${qty}`(({ qty }, state) => Effect.succeed(state + qty))
+ * )
+ *
+ * const program = Bdd.run(feature, `
+ * Feature: Counter
+ *
+ *   Scenario: Increment
+ *     Given zero
+ *     When increment by 2
+ * `).pipe(Effect.provide(Bdd.GherkinCompiler.Cucumber))
+ * ```
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export declare const Bdd: {
+    ParseError: typeof ParseError;
+    MatchError: typeof MatchError;
+    StepError: typeof StepError;
+    GherkinCompiler: typeof parser.GherkinCompiler & {
+        Cucumber: import("effect/Layer").Layer<parser.GherkinCompiler, never, never>;
+    };
+    capture: <const Name extends string, A>(name: Name, schema: Schema.Codec<A, string>) => Capture<Name, A>;
+    table: <S extends Schema.Decoder<unknown, never>>(row: S) => TableArg<ReadonlyArray<S["Type"]>>;
+    docString: <S extends Schema.Decoder<unknown, never>>(schema: S) => DocStringArg<S["Type"]>;
+    feature: <State>(name: string, options: {
+        readonly initial: State;
+    }) => Feature<State>;
+    step: StepTag<"Step">;
+    given: StepTag<"Given">;
+    when: StepTag<"When">;
+    then: StepTag<"Then">;
+    run: <State, E, R>(self: Feature<State, E, R>, source: string) => Effect.Effect<Report, RunError, R | GherkinCompiler>;
+};
+/**
+ * Type helpers for the {@link Bdd} value namespace.
+ *
+ * @since 4.0.0
+ */
+export declare namespace Bdd {
+    /**
+     * A local immutable feature definition used to interpret scenarios from Gherkin source.
+     *
+     * @since 4.0.0
+     */
+    type Feature<State, E = never, R = never> = FeatureType<State, E, R>;
+    /**
+     * Result returned after all scenarios pass.
+     *
+     * @since 4.0.0
+     */
+    type Report = ReportType;
+    /**
+     * Error type returned by `Bdd.run`.
+     *
+     * @since 4.0.0
+     */
+    type RunError = RunErrorType;
+    /**
+     * Service used to compile Gherkin source into executable scenarios.
+     *
+     * @since 4.0.0
+     */
+    type GherkinCompiler = GherkinCompilerType;
+    /**
+     * A named capture decoded from step text with a Schema.
+     *
+     * @since 4.0.0
+     */
+    type Capture<Name extends string, A> = CaptureType<Name, A>;
+    /**
+     * A decoded DataTable argument.
+     *
+     * @since 4.0.0
+     */
+    type TableArg<A> = TableArgType<A>;
+    /**
+     * A decoded DocString argument.
+     *
+     * @since 4.0.0
+     */
+    type DocStringArg<A> = DocStringArgType<A>;
+}
+/**
+ * Advanced tagged-template function type used to register transitions.
+ *
+ * @category utility types
+ * @since 4.0.0
+ */
+export interface StepTag<Kind extends StepKind> {
+    <const Captures extends ReadonlyArray<Capture<string, unknown>>>(strings: TemplateStringsArray, ...captures: Captures): StepBuilder<CapturesOf<Captures>, Kind>;
+}
+/**
+ * Advanced builder returned by a tagged-template transition.
+ *
+ * @category utility types
+ * @since 4.0.0
+ */
+export interface StepBuilder<Captures, Kind extends StepKind> {
+    <State, E, R>(impl: (captures: Captures, state: State) => Effect.Effect<State, E, R>): <E0, R0>(self: Feature<State, E0, R0>) => Feature<State, E | E0, R | R0>;
+    <State, Arg, E, R>(arg: StepArg<Arg>, impl: (captures: Captures, arg: Arg, state: State) => Effect.Effect<State, E, R>): <E0, R0>(self: Feature<State, E0, R0>) => Feature<State, E | E0, R | R0>;
+    readonly kind: Kind;
+    readonly expression: Expression<Captures>;
+}
+export {};
+//# sourceMappingURL=Bdd.d.ts.map

package/dist/Bdd.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bdd.d.ts","sourceRoot":"","sources":["../src/Bdd.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,iBAAiB,CAAA;AAC9D,OAAO,KAAK,KAAK,MAAM,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAE/D,OAAO,KAAK,UAAU,MAAM,0BAA0B,CAAA;AACtD,OAAO,KAAK,MAAM,MAAM,sBAAsB,CAAA;AAC9C,OAAO,KAAK,MAAM,MAAM,sBAAsB,CAAA;AAE9C;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,UAAU,GAAG,UAAU,GAAG,SAAS,CAAA;AAE1D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe;;CAE1B,CAAA;AAEF;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,eAAe,CAAA;AAEpD;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,CAAA;AAEzD;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,IAAI,SAAS,MAAM,EAAE,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;AAEzE;;;;;GAKG;AACH,MAAM,MAAM,UAAU,CAAC,QAAQ,SAAS,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,IAAI;IACjF,QAAQ,EAAE,OAAO,IAAI,QAAQ,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC,GAAG,OAAO,SAAS,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,GAC9G,KAAK;CACV,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,UAAU,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;AAEjD;;;;;GAKG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC;IACzB,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;IACzB,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,cAAc,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;CAC7E;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAA;IAC7B,QAAQ,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC,cAAc,KAAK,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAA;CACjF;AAED;;;;;GAKG;AACH,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAA;AAEtD;;;;;GAKG;AACH,MAAM,WAAW,UAAU,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,EAAE,QAAQ,GAAG,OAAO;IAC7E,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAA;IACzC,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;IACrC,QAAQ,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;CACnG;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;AAE1E;;;;;GAKG;AACH,MAAM,WAAW,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,CAAE,SAAQ,QAAQ;IACpE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAA;IACvB,QAAQ,CAAC,WAAW,EAAE,aAAa,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;CAChE;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,SAAS,EAAE,aAAa,CAAC;QAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;QACrB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;QACtB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;KACrC,CAAC,CAAA;CACH;AAED,KAAK,WAAW,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;AACpD,KAAK,UAAU,GAAG,MAAM,CAAA;AACxB,KAAK,YAAY,GAAG,QAAQ,CAAA;AAC5B,KAAK,mBAAmB,GAAG,eAAe,CAAA;AAC1C,KAAK,WAAW,CAAC,IAAI,SAAS,MAAM,EAAE,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;AAC3D,KAAK,YAAY,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAA;AAClC,KAAK,gBAAgB,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,CAAA;AAwN1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,GAAG;;;;;;;oBAjOO,IAAI,SAAS,MAAM,EAAE,CAAC,QACrC,IAAI,UACF,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,CAAC,KAC5B,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;YA4BL,CAAC,SAAS,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,KAAG,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;gBA8BjF,CAAC,SAAS,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,KAAG,YAAY,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;cA4B/E,KAAK,QAAQ,MAAM,WAAW;QAC9C,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAA;KACxB,KAAG,OAAO,CAAC,KAAK,CAAC;;;;;UAgGJ,KAAK,EAAE,CAAC,EAAE,CAAC,QACjB,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,UAClB,MAAM,KACb,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,eAAe,CAAC;CAkDtD,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,GAAG,CAAC;IAC3B;;;;OAIG;IACH,KAAY,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAE3E;;;;OAIG;IACH,KAAY,MAAM,GAAG,UAAU,CAAA;IAE/B;;;;OAIG;IACH,KAAY,QAAQ,GAAG,YAAY,CAAA;IAEnC;;;;OAIG;IACH,KAAY,eAAe,GAAG,mBAAmB,CAAA;IAEjD;;;;OAIG;IACH,KAAY,OAAO,CAAC,IAAI,SAAS,MAAM,EAAE,CAAC,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;IAElE;;;;OAIG;IACH,KAAY,QAAQ,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,CAAA;IAEzC;;;;OAIG;IACH,KAAY,YAAY,CAAC,CAAC,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAA;CAClD;AAED;;;;;GAKG;AACH,MAAM,WAAW,OAAO,CAAC,IAAI,SAAS,QAAQ;IAC5C,CAAC,KAAK,CAAC,QAAQ,SAAS,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAC7D,OAAO,EAAE,oBAAoB,EAC7B,GAAG,QAAQ,EAAE,QAAQ,GACpB,WAAW,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAA;CAC3C;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW,CAAC,QAAQ,EAAE,IAAI,SAAS,QAAQ;IAC1D,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,EACV,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,GACrE,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAA;IAC3E,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EACf,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,EACjB,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,KAAK,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,GAC/E,CAAC,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,KAAK,OAAO,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,CAAA;IAC3E,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;IACnB,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,QAAQ,CAAC,CAAA;CAC1C"}

package/dist/Bdd.js

@@ -0,0 +1,304 @@
+import { pipeArguments } from "effect/Pipeable";
+import { MatchError, ParseError, StepError } from "./Errors.js";
+import * as cucumberCompiler from "./internal/cucumberCompiler.js";
+import * as expression from "./internal/expression.js";
+import * as parser from "./internal/parser.js";
+import * as runner from "./internal/runner.js";
+/**
+ * Service used to compile Gherkin source into executable scenarios.
+ *
+ * **Details**
+ *
+ * The built-in `Cucumber` layer uses Cucumber's parser and Pickle compiler.
+ * Custom implementations must preserve the compiled step, argument, tag, and
+ * source-location semantics expected by the runner.
+ *
+ * @category services
+ * @since 4.0.0
+ */
+export const GherkinCompiler = /*#__PURE__*/Object.assign(parser.GherkinCompiler, {
+  Cucumber: cucumberCompiler.Cucumber
+});
+/**
+ * Creates a named capture decoded from step text.
+ *
+ * **When to use**
+ *
+ * Use a capture when a Gherkin step contains a value that should be decoded
+ * before it reaches the step implementation.
+ *
+ * **Example** (Capturing a number)
+ *
+ * ```ts
+ * import { Bdd } from "effect-bdd"
+ * import { Schema } from "effect"
+ *
+ * const qty = Bdd.capture("qty", Schema.FiniteFromString)
+ *
+ * const step = Bdd.when`${qty} items are added`
+ * ```
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+const capture_ = expression.makeCapture;
+/**
+ * Creates a DataTable decoder from a row Schema.
+ *
+ * **Details**
+ *
+ * The first row of the Gherkin table is interpreted as the header row. Each
+ * following row is converted into an object and decoded with the supplied
+ * Schema.
+ *
+ * **Example** (Decoding table rows)
+ *
+ * ```ts
+ * import { Bdd } from "effect-bdd"
+ * import { Schema } from "effect"
+ *
+ * const Item = Schema.Struct({
+ *   sku: Schema.String,
+ *   qty: Schema.FiniteFromString
+ * })
+ *
+ * const items = Bdd.table(Item)
+ * ```
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+const table_ = row => ({
+  _tag: "TableArg",
+  decode: runner.decodeTable(row)
+});
+/**
+ * Creates a DocString decoder from a Schema.
+ *
+ * **When to use**
+ *
+ * Use `docString` for larger step arguments, such as JSON payloads or plain
+ * text blocks, that should be decoded before the step implementation runs.
+ *
+ * **Example** (Decoding JSON)
+ *
+ * ```ts
+ * import { Bdd } from "effect-bdd"
+ * import { Schema } from "effect"
+ *
+ * const Payload = Schema.Struct({
+ *   sku: Schema.String,
+ *   qty: Schema.Number
+ * })
+ *
+ * const payload = Bdd.docString(Schema.fromJsonString(Payload))
+ * ```
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+const docString_ = schema => ({
+  _tag: "DocStringArg",
+  decode: runner.decodeDocString(schema)
+});
+/**
+ * Creates a feature definition with an explicit initial state.
+ *
+ * **Details**
+ *
+ * A feature definition is an immutable state machine. Each registered step
+ * receives the current state and returns the next state in an `Effect`.
+ *
+ * **Example** (Building a feature)
+ *
+ * ```ts
+ * import { Bdd } from "effect-bdd"
+ * import { Effect } from "effect"
+ *
+ * const feature = Bdd.feature("Counter", { initial: 0 }).pipe(
+ *   Bdd.given`zero`(() => Effect.succeed(0)),
+ *   Bdd.when`increment`((_captures, state) => Effect.succeed(state + 1))
+ * )
+ * ```
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+const feature_ = (name, options) => makeFeature(name, options.initial, []);
+/**
+ * Tagged-template transition factory that does not attach Gherkin keyword metadata.
+ *
+ * **When to use**
+ *
+ * Use `step` for a transition that is semantically valid as any concrete
+ * Gherkin step kind. Prefer `given`, `when`, or `then` when the transition
+ * represents setup, action, or assertion specifically.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+const step_ = /*#__PURE__*/makeStepTag("Step");
+/**
+ * Tagged-template transition factory for `Given` steps.
+ *
+ * **Details**
+ *
+ * A source `Given` step only matches `given` or keyword-agnostic `step`
+ * transitions.
+ *
+ * `And` and `But` steps inherit the previous concrete Gherkin keyword before
+ * matching, so they can match a `given` transition when they follow a `Given`.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+const given_ = /*#__PURE__*/makeStepTag("Given");
+/**
+ * Tagged-template transition factory for `When` steps.
+ *
+ * **Details**
+ *
+ * A source `When` step only matches `when` or keyword-agnostic `step`
+ * transitions.
+ *
+ * `And` and `But` steps inherit the previous concrete Gherkin keyword before
+ * matching, so they can match a `when` transition when they follow a `When`.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+const when_ = /*#__PURE__*/makeStepTag("When");
+/**
+ * Tagged-template transition factory for `Then` steps.
+ *
+ * **Details**
+ *
+ * A source `Then` step only matches `then` or keyword-agnostic `step`
+ * transitions.
+ *
+ * `And` and `But` steps inherit the previous concrete Gherkin keyword before
+ * matching, so they can match a `then` transition when they follow a `Then`.
+ *
+ * @category constructors
+ * @since 4.0.0
+ */
+const then_ = /*#__PURE__*/makeStepTag("Then");
+/**
+ * Runs Gherkin source against a feature definition.
+ *
+ * **Details**
+ *
+ * The feature definition name must match the Gherkin `Feature:` name. Every
+ * scenario starts from the feature's initial state. Background steps run before
+ * each scenario, then scenario steps run in source order.
+ *
+ * **Example** (Running Gherkin)
+ *
+ * ```ts
+ * import { Bdd } from "effect-bdd"
+ * import { Effect } from "effect"
+ *
+ * const feature = Bdd.feature("Counter", { initial: 0 }).pipe(
+ *   Bdd.given`zero`(() => Effect.succeed(0)),
+ *   Bdd.when`increment`((_captures, state) => Effect.succeed(state + 1))
+ * )
+ *
+ * const program = Bdd.run(feature, `
+ * Feature: Counter
+ *
+ *   Scenario: Increment
+ *     Given zero
+ *     When increment
+ * `).pipe(Effect.provide(Bdd.GherkinCompiler.Cucumber))
+ * ```
+ *
+ * @category running
+ * @since 4.0.0
+ */
+const run_ = (self, source) => runner.run(self, source);
+/**
+ * Namespace-style API for building and running BDD feature definitions.
+ *
+ * **Details**
+ *
+ * The namespace contains constructors for captures, step arguments, feature
+ * definitions, step transitions, and the Gherkin runner.
+ *
+ * **Example** (Defining and running a feature)
+ *
+ * ```ts
+ * import { Bdd } from "effect-bdd"
+ * import { Effect, Schema } from "effect"
+ *
+ * const qty = Bdd.capture("qty", Schema.FiniteFromString)
+ *
+ * const feature = Bdd.feature("Counter", { initial: 0 }).pipe(
+ *   Bdd.given`zero`(() => Effect.succeed(0)),
+ *   Bdd.when`increment by ${qty}`(({ qty }, state) => Effect.succeed(state + qty))
+ * )
+ *
+ * const program = Bdd.run(feature, `
+ * Feature: Counter
+ *
+ *   Scenario: Increment
+ *     Given zero
+ *     When increment by 2
+ * `).pipe(Effect.provide(Bdd.GherkinCompiler.Cucumber))
+ * ```
+ *
+ * @category models
+ * @since 4.0.0
+ */
+export const Bdd = {
+  ParseError,
+  MatchError,
+  StepError,
+  GherkinCompiler,
+  capture: capture_,
+  table: table_,
+  docString: docString_,
+  feature: feature_,
+  step: step_,
+  given: given_,
+  when: when_,
+  // oxlint-disable-next-line unicorn/no-thenable
+  then: then_,
+  run: run_
+};
+const makeFeature = (name, initial, transitions) => ({
+  _tag: "Feature",
+  name,
+  initial,
+  transitions,
+  pipe() {
+    return pipeArguments(this, arguments);
+  }
+});
+function makeStepTag(kind) {
+  return (strings, ...captures) => {
+    const matcher = expression.makeMatcher(strings, captures);
+    const builder = (first, second) => self => {
+      const transition = second === undefined ? {
+        kind,
+        expression: matcher,
+        run: (captures, _argument, state) => first(captures, state)
+      } : {
+        kind,
+        expression: matcher,
+        argument: first,
+        run: (captures, argument, state) => second(captures, argument, state)
+      };
+      return makeFeature(self.name, self.initial, [...self.transitions, transition]);
+    };
+    Object.defineProperties(builder, {
+      kind: {
+        value: kind
+      },
+      expression: {
+        value: matcher
+      }
+    });
+    return builder;
+  };
+}
+//# sourceMappingURL=Bdd.js.map

package/dist/Bdd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bdd.js","names":["pipeArguments","MatchError","ParseError","StepError","cucumberCompiler","expression","parser","runner","GherkinCompiler","Object","assign","Cucumber","capture_","makeCapture","table_","row","_tag","decode","decodeTable","docString_","schema","decodeDocString","feature_","name","options","makeFeature","initial","step_","makeStepTag","given_","when_","then_","run_","self","source","run","Bdd","capture","table","docString","feature","step","given","when","then","transitions","pipe","arguments","kind","strings","captures","matcher","makeMatcher","builder","first","second","transition","undefined","_argument","state","argument","defineProperties","value"],"sources":["../src/Bdd.ts"],"sourcesContent":[null],"mappings":"AAIA,SAAwBA,aAAa,QAAQ,iBAAiB;AAE9D,SAASC,UAAU,EAAEC,UAAU,EAAEC,SAAS,QAAQ,aAAa;AAC/D,OAAO,KAAKC,gBAAgB,MAAM,gCAAgC;AAClE,OAAO,KAAKC,UAAU,MAAM,0BAA0B;AACtD,OAAO,KAAKC,MAAM,MAAM,sBAAsB;AAC9C,OAAO,KAAKC,MAAM,MAAM,sBAAsB;AAU9C;;;;;;;;;;;;AAYA,OAAO,MAAMC,eAAe,gBAAGC,MAAM,CAACC,MAAM,CAACJ,MAAM,CAACE,eAAe,EAAE;EACnEG,QAAQ,EAAEP,gBAAgB,CAACO;CAC5B,CAAC;AAiJF;;;;;;;;;;;;;;;;;;;;;;AAsBA,MAAMC,QAAQ,GAGUP,UAAU,CAACQ,WAAW;AAE9C;;;;;;;;;;;;;;;;;;;;;;;;;;AA0BA,MAAMC,MAAM,GAA8CC,GAAM,KAA0C;EACxGC,IAAI,EAAE,UAAU;EAChBC,MAAM,EAAEV,MAAM,CAACW,WAAW,CAACH,GAAG;CAC/B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,MAAMI,UAAU,GAA8CC,MAAS,KAA+B;EACpGJ,IAAI,EAAE,cAAc;EACpBC,MAAM,EAAEV,MAAM,CAACc,eAAe,CAACD,MAAM;CACtC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;AAuBA,MAAME,QAAQ,GAAGA,CAAQC,IAAY,EAAEC,OAEtC,KAAqBC,WAAW,CAACF,IAAI,EAAEC,OAAO,CAACE,OAAO,EAAE,EAAE,CAAC;AAE5D;;;;;;;;;;;;AAYA,MAAMC,KAAK,gBAAoBC,WAAW,CAAC,MAAM,CAAC;AAElD;;;;;;;;;;;;;;AAcA,MAAMC,MAAM,gBAAqBD,WAAW,CAAC,OAAO,CAAC;AAErD;;;;;;;;;;;;;;AAcA,MAAME,KAAK,gBAAoBF,WAAW,CAAC,MAAM,CAAC;AAElD;;;;;;;;;;;;;;AAcA,MAAMG,KAAK,gBAAoBH,WAAW,CAAC,MAAM,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgCA,MAAMI,IAAI,GAAGA,CACXC,IAA0B,EAC1BC,MAAc,KAC2C3B,MAAM,CAAC4B,GAAG,CAACF,IAAI,EAAEC,MAAM,CAAC;AAEnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCA,OAAO,MAAME,GAAG,GAAG;EACjBlC,UAAU;EACVD,UAAU;EACVE,SAAS;EACTK,eAAe;EACf6B,OAAO,EAAEzB,QAAQ;EACjB0B,KAAK,EAAExB,MAAM;EACbyB,SAAS,EAAEpB,UAAU;EACrBqB,OAAO,EAAElB,QAAQ;EACjBmB,IAAI,EAAEd,KAAK;EACXe,KAAK,EAAEb,MAAM;EACbc,IAAI,EAAEb,KAAK;EACX;EACAc,IAAI,EAAEb,KAAK;EACXI,GAAG,EAAEH;CACN;AAyFD,MAAMP,WAAW,GAAGA,CAClBF,IAAY,EACZG,OAAc,EACdmB,WAAsD,MAC5B;EAC1B7B,IAAI,EAAE,SAAS;EACfO,IAAI;EACJG,OAAO;EACPmB,WAAW;EACXC,IAAIA,CAAA;IACF,OAAO9C,aAAa,CAAC,IAAI,EAAE+C,SAAS,CAAC;EACvC;CACD,CAAC;AAEF,SAASnB,WAAWA,CAAwBoB,IAAU;EACpD,OAAQ,CAACC,OAA6B,EAAE,GAAGC,QAAiD,KAAI;IAC9F,MAAMC,OAAO,GAAG9C,UAAU,CAAC+C,WAAW,CAACH,OAAO,EAAEC,QAAQ,CAAC;IACzD,MAAMG,OAAO,GAAIA,CAACC,KAAc,EAAEC,MAAgB,KAAMtB,IAAwC,IAAI;MAClG,MAAMuB,UAAU,GAA6CD,MAAM,KAAKE,SAAS,GAC/E;QACET,IAAI;QACJ3C,UAAU,EAAE8C,OAAO;QACnBhB,GAAG,EAAEA,CAACe,QAAQ,EAAEQ,SAAS,EAAEC,KAAK,KAC7BL,KAAyF,CAACJ,QAAQ,EAAES,KAAK;OAC7G,GACD;QACEX,IAAI;QACJ3C,UAAU,EAAE8C,OAAO;QACnBS,QAAQ,EAAEN,KAAyB;QACnCnB,GAAG,EAAEA,CAACe,QAAQ,EAAEU,QAAQ,EAAED,KAAK,KAC5BJ,MAI6C,CAACL,QAAQ,EAAEU,QAAQ,EAAED,KAAK;OAC3E;MACH,OAAOlC,WAAW,CAACQ,IAAI,CAACV,IAAI,EAAEU,IAAI,CAACP,OAAO,EAAE,CAAC,GAAGO,IAAI,CAACY,WAAW,EAAEW,UAAU,CAAC,CAAC;IAChF,CAAgC;IAChC/C,MAAM,CAACoD,gBAAgB,CAACR,OAAO,EAAE;MAC/BL,IAAI,EAAE;QAAEc,KAAK,EAAEd;MAAI,CAAE;MACrB3C,UAAU,EAAE;QAAEyD,KAAK,EAAEX;MAAO;KAC7B,CAAC;IACF,OAAOE,OAAO;EAChB,CAAC;AACH","ignoreList":[]}

package/dist/Errors.d.ts

@@ -0,0 +1,65 @@
+/**
+ * @since 4.0.0
+ */
+import * as Schema from "effect/Schema";
+declare const ParseError_base: Schema.Class<ParseError, Schema.TaggedStruct<"ParseError", {
+    readonly message: Schema.String;
+    readonly line: Schema.Number;
+    readonly column: Schema.Number;
+}>, import("effect/Cause").YieldableError>;
+/**
+ * A syntax or structure error found while parsing Gherkin source.
+ *
+ * **Details**
+ *
+ * The error includes the source line and column where parsing failed.
+ *
+ * @category errors
+ * @since 4.0.0
+ */
+export declare class ParseError extends ParseError_base {
+}
+declare const MatchError_base: Schema.Class<MatchError, Schema.TaggedStruct<"MatchError", {
+    readonly message: Schema.String;
+    readonly scenario: Schema.String;
+    readonly step: Schema.String;
+    readonly line: Schema.Number;
+    readonly candidates: Schema.$Array<Schema.String>;
+    readonly cause: Schema.optional<Schema.Unknown>;
+}>, import("effect/Cause").YieldableError>;
+/**
+ * An error raised when a parsed Gherkin step cannot be matched or decoded.
+ *
+ * **Details**
+ *
+ * The `candidates` field contains the registered step expressions considered
+ * for the failing source step. When a DataTable or DocString decode fails,
+ * `cause` contains the underlying Schema error.
+ *
+ * @category errors
+ * @since 4.0.0
+ */
+export declare class MatchError extends MatchError_base {
+}
+declare const StepError_base: Schema.Class<StepError, Schema.TaggedStruct<"StepError", {
+    readonly message: Schema.String;
+    readonly scenario: Schema.String;
+    readonly step: Schema.String;
+    readonly line: Schema.Number;
+    readonly cause: Schema.Unknown;
+}>, import("effect/Cause").YieldableError>;
+/**
+ * An error raised when a matched step implementation fails.
+ *
+ * **Details**
+ *
+ * The `cause` field preserves the original failure from the Effect returned by
+ * the step implementation.
+ *
+ * @category errors
+ * @since 4.0.0
+ */
+export declare class StepError extends StepError_base {
+}
+export {};
+//# sourceMappingURL=Errors.d.ts.map

package/dist/Errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Errors.d.ts","sourceRoot":"","sources":["../src/Errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;;;;;;AAEvC;;;;;;;;;GASG;AACH,qBAAa,UAAW,SAAQ,eAI9B;CAAG;;;;;;;;;AAEL;;;;;;;;;;;GAWG;AACH,qBAAa,UAAW,SAAQ,eAO9B;CAAG;;;;;;;;AAEL;;;;;;;;;;GAUG;AACH,qBAAa,SAAU,SAAQ,cAM7B;CAAG"}