effect 4.0.0-beta.6 → 4.0.0-beta.62

package/dist/testing/TestSchema.js

@@ -1,5 +1,68 @@
 /**
- * Testing utilities for Schema validation and assertions.
+ * Testing utilities for asserting Schema decoding, encoding, make, and
+ * arbitrary-generation behavior. Used in unit tests to verify that schemas
+ * accept, reject, and round-trip values correctly.
+ *
+ * ## Mental model
+ *
+ * - **Asserts** – entry point: wraps a schema and exposes helpers grouped by
+ *   operation (decoding, encoding, make, arbitrary, round-trip).
+ * - **Decoding** – returned by `asserts.decoding()`; has `succeed` / `fail`
+ *   helpers that run the schema's decoder and compare the result.
+ * - **Encoding** – returned by `asserts.encoding()`; mirrors {@link Decoding}
+ *   but exercises the encoder direction.
+ * - Every assertion is async (`Promise<void>`) because parsing may involve
+ *   effectful schemas.
+ * - `succeed` with one argument asserts identity (output equals input);
+ *   with two arguments asserts a specific expected output.
+ * - `fail` always takes the input and the expected error message string.
+ *
+ * ## Common tasks
+ *
+ * - Assert decoding succeeds / fails → `new Asserts(schema).decoding().succeed(…)` / `.fail(…)`
+ * - Assert encoding succeeds / fails → `new Asserts(schema).encoding().succeed(…)` / `.fail(…)`
+ * - Assert make succeeds / fails → `new Asserts(schema).make().succeed(…)` / `.fail(…)`
+ * - Verify round-trip (encode then decode) → `new Asserts(schema).verifyLosslessTransformation()`
+ * - Verify arbitrary generation → `new Asserts(schema).arbitrary().verifyGeneration()`
+ * - Compare AST of struct fields → `Asserts.ast.fields.equals(a, b)`
+ * - Provide a service dependency for decoding → `asserts.decoding().provide(key, impl)`
+ *
+ * ## Gotchas
+ *
+ * - `succeed` uses `assert.deepStrictEqual`, so reference equality is not
+ *   required but structural equality is.
+ * - `fail` compares against the stringified `Issue`, not the `Issue` object
+ *   itself. Pass the exact multiline string the issue produces.
+ * - `verifyLosslessTransformation` and `arbitrary().verifyGeneration` run
+ *   property-based tests via FastCheck; default run count is 20 for
+ *   `verifyGeneration`.
+ *
+ * ## Quickstart
+ *
+ * **Example** (Basic decoding and encoding assertions)
+ *
+ * ```ts
+ * import { Schema } from "effect"
+ * import { TestSchema } from "effect/testing"
+ *
+ * const schema = Schema.NumberFromString
+ * const asserts = new TestSchema.Asserts(schema)
+ *
+ * // decoding
+ * const decoding = asserts.decoding()
+ * await decoding.succeed("1", 1)
+ * await decoding.fail(null, "Expected string, got null")
+ *
+ * // encoding
+ * const encoding = asserts.encoding()
+ * await encoding.succeed(1, "1")
+ * ```
+ *
+ * ## See also
+ *
+ * - {@link Asserts}
+ * - {@link Decoding}
+ * - {@link Encoding}
  *
  * @since 4.0.0
  */
@@ -12,20 +75,63 @@ import * as AST from "../SchemaAST.js";
 import * as Parser from "../SchemaParser.js";
 import * as FastCheck from "../testing/FastCheck.js";
 /**
- * The `Asserts` class provides a comprehensive testing framework for schema validation,
- * encoding/decoding operations, and property-based testing.
+ * Entry point for schema test assertions. Wraps a schema and exposes
+ * operation-specific helpers: {@link Decoding}, {@link Encoding}, make,
+ * arbitrary generation, and round-trip verification.
+ *
+ * When to use:
+ * - You are writing unit tests for a schema's decoding, encoding, or
+ *   construction behavior.
+ * - You want property-based round-trip or generation checks.
+ *
+ * **Example** (Decoding and encoding a struct)
+ *
+ * ```ts
+ * import { Schema } from "effect"
+ * import { TestSchema } from "effect/testing"
+ *
+ * const schema = Schema.Struct({ name: Schema.String })
+ * const asserts = new TestSchema.Asserts(schema)
+ *
+ * // decoding
+ * await asserts.decoding().succeed({ name: "Alice" })
+ *
+ * // encoding
+ * await asserts.encoding().succeed({ name: "Alice" })
+ * ```
+ *
+ * @see {@link Decoding}
+ * @see {@link Encoding}
  *
  * @since 4.0.0
  */
 export class Asserts {
+  /**
+   * Static helpers for comparing schema AST structures. Useful when you need
+   * to assert that two field or element definitions produce the same AST.
+   *
+   * - `ast.fields.equals(a, b)` – compares struct field ASTs via
+   *   `assert.deepStrictEqual`.
+   * - `ast.elements.equals(a, b)` – compares tuple element ASTs via
+   *   `assert.deepStrictEqual`.
+   *
+   * **Example** (Comparing struct fields)
+   *
+   * ```ts
+   * import { Schema } from "effect"
+   * import { TestSchema } from "effect/testing"
+   *
+   * const fieldsA = { name: Schema.String }
+   * const fieldsB = { name: Schema.String }
+   * TestSchema.Asserts.ast.fields.equals(fieldsA, fieldsB) // no error
+   * ```
+   */
   static ast = {
-    /** Asserts that two struct field definitions are equal by comparing their AST representations. */
     fields: {
       equals: (a, b) => {
         assert.deepStrictEqual(Record.map(a, AST.getAST), Record.map(b, AST.getAST));
       }
     },
-    /** Asserts that two tuple element definitions are equal by comparing their AST representations. */
     elements: {
       equals: (a, b) => {
         assert.deepStrictEqual(a.map(AST.getAST), b.map(AST.getAST));
@@ -37,7 +143,23 @@ export class Asserts {
     this.schema = schema;
   }
   /**
-   * Provides make operation testing utilities.
+   * Returns an object with `succeed` and `fail` helpers for testing the
+   * schema's `make` operation.
+   *
+   * - `succeed(input)` – asserts make returns the input unchanged.
+   * - `succeed(input, expected)` – asserts make returns `expected`.
+   * - `fail(input, message)` – asserts make fails with `message`.
+   *
+   * **Example** (Testing make)
+   *
+   * ```ts
+   * import { Schema } from "effect"
+   * import { TestSchema } from "effect/testing"
+   *
+   * const schema = Schema.String
+   * const asserts = new TestSchema.Asserts(schema)
+   * await asserts.make().succeed("hello")
+   * ```
    */
   make(options) {
     const makeEffect = Parser.makeEffect(this.schema);
@@ -48,9 +170,6 @@ export class Asserts {
     }
     return {
       succeed,
-      /**
-       * Asserts that make operation fails with the expected error message.
-       */
       async fail(input, message) {
         const r = await Effect.runPromise(makeEffect(input, options).pipe(Effect.mapError(issue => issue.toString()), Effect.result));
         assert.deepStrictEqual(r, Result.fail(message));
@@ -58,7 +177,23 @@ export class Asserts {
     };
   }
   /**
-   * Verifies that encoding values produces the same type after decoding (round-trip).
+   * Runs a property-based test that encodes arbitrary values and then decodes
+   * them, asserting the decoded value equals the original. Useful for verifying
+   * that a codec is lossless (encode followed by decode is identity).
+   *
+   * - Uses FastCheck to generate arbitrary values matching the schema's Type.
+   * - Fails the test if any generated value does not round-trip.
+   * - Pass `options.params` to control FastCheck parameters (e.g. `numRuns`).
+   *
+   * **Example** (Round-trip verification)
+   *
+   * ```ts
+   * import { Schema } from "effect"
+   * import { TestSchema } from "effect/testing"
+   *
+   * const asserts = new TestSchema.Asserts(Schema.NumberFromString)
+   * await asserts.verifyLosslessTransformation()
+   * ```
    */
   verifyLosslessTransformation(options) {
     const decodeUnknownEffect = Parser.decodeUnknownEffect(this.schema);
@@ -70,27 +205,71 @@ export class Asserts {
     }), options?.params);
   }
   /**
-   * Provides decoding testing utilities.
+   * Returns a {@link Decoding} instance for this schema, providing `succeed`
+   * and `fail` helpers to test decoding behavior.
+   *
+   * - Pass `parseOptions` to control error reporting (e.g. `{ errors: "all" }`).
+   *
+   * **Example** (Decoding assertions)
+   *
+   * ```ts
+   * import { Schema } from "effect"
+   * import { TestSchema } from "effect/testing"
+   *
+   * const asserts = new TestSchema.Asserts(Schema.NumberFromString)
+   * const decoding = asserts.decoding()
+   * await decoding.succeed("42", 42)
+   * await decoding.fail(null, "Expected string, got null")
+   * ```
+   *
+   * @see {@link Decoding}
    */
   decoding(options) {
     return new Decoding(this.schema, options);
   }
   /**
-   * Provides encoding testing utilities.
+   * Returns an {@link Encoding} instance for this schema, providing `succeed`
+   * and `fail` helpers to test encoding behavior.
+   *
+   * - Pass `parseOptions` to control error reporting (e.g. `{ errors: "all" }`).
+   *
+   * **Example** (Encoding assertions)
+   *
+   * ```ts
+   * import { Schema } from "effect"
+   * import { TestSchema } from "effect/testing"
+   *
+   * const asserts = new TestSchema.Asserts(Schema.NumberFromString)
+   * const encoding = asserts.encoding()
+   * await encoding.succeed(42, "42")
+   * ```
+   *
+   * @see {@link Encoding}
    */
   encoding(options) {
     return new Encoding(this.schema, options);
   }
   /**
-   * Provides property-based testing utilities for schema validation.
+   * Returns an object with property-based testing helpers for the schema's
+   * arbitrary generator.
+   *
+   * - `verifyGeneration()` – generates arbitrary values and asserts each
+   *   satisfies the schema's `is` predicate. Defaults to 20 runs.
+   * - Pass `options.params` to override FastCheck parameters.
+   *
+   * **Example** (Verifying arbitrary generation)
+   *
+   * ```ts
+   * import { Schema } from "effect"
+   * import { TestSchema } from "effect/testing"
+   *
+   * const asserts = new TestSchema.Asserts(Schema.String)
+   * asserts.arbitrary().verifyGeneration()
+   * ```
    */
   arbitrary() {
     const schema = this.schema;
     return {
-      /**
-       * Verifies that the schema generates valid arbitrary values that satisfy
-       * the schema constraints.
-       */
       verifyGeneration(options) {
         const params = options?.params;
         const is = Schema.is(schema);
@@ -104,6 +283,37 @@ export class Asserts {
   }
 }
 /**
+ * Decoding test helper. Wraps a schema and exposes `succeed` and `fail`
+ * methods that run the schema's decoder and compare the result.
+ *
+ * When to use:
+ * - You want to assert that specific inputs decode to expected values.
+ * - You want to assert that invalid inputs produce specific error messages.
+ * - You need to provide services required by the schema's decoding pipeline.
+ *
+ * Behavior:
+ * - All assertions are async and use `assert.deepStrictEqual` internally.
+ * - `succeed(input)` asserts the decoded output equals `input` (identity).
+ * - `succeed(input, expected)` asserts the decoded output equals `expected`.
+ * - `fail(input, message)` asserts decoding fails and the stringified issue
+ *   equals `message`.
+ * - `provide(key, impl)` returns a new `Decoding` with the service injected
+ *   into the decoding context.
+ *
+ * **Example** (Decoding with service provision)
+ *
+ * ```ts
+ * import { Schema } from "effect"
+ * import { TestSchema } from "effect/testing"
+ *
+ * const asserts = new TestSchema.Asserts(Schema.String)
+ * const decoding = asserts.decoding()
+ * await decoding.succeed("hello")
+ * ```
+ *
+ * @see {@link Asserts}
+ * @see {@link Encoding}
+ *
  * @since 4.0.0
  */
 export class Decoding {
@@ -121,21 +331,68 @@ export class Decoding {
     assert.deepStrictEqual(r, Result.succeed(expected));
   }
   /**
-   * Asserts that decoding fails with the expected error message.
+   * Asserts that decoding `input` fails and the stringified issue equals
+   * `message`.
+   *
+   * **Example** (Asserting a decoding failure)
+   *
+   * ```ts
+   * import { Schema } from "effect"
+   * import { TestSchema } from "effect/testing"
+   *
+   * const decoding = new TestSchema.Asserts(Schema.String).decoding()
+   * await decoding.fail(42, "Expected string, got 42")
+   * ```
    */
   async fail(input, message) {
     const r = await Effect.runPromise(this.decodeUnknownEffect(input, this.options?.parseOptions).pipe(Effect.mapError(issue => issue.toString()), Effect.result));
     assert.deepStrictEqual(r, Result.fail(message));
   }
   /**
-   * Creates a new Decoding instance with the provided service available in the
-   * decoding context.
+   * Returns a new {@link Decoding} instance with the given service injected
+   * into the decoding effect context. Use this when the schema's decoder
+   * requires a service dependency.
+   *
+   * - Does not mutate the current instance; returns a new one.
+   *
+   * @see {@link Encoding.provide}
    */
   provide(service, implementation) {
     return new Decoding(this.schema.pipe(Schema.middlewareDecoding(Effect.provideService(service, implementation))), this.options);
   }
 }
 /**
+ * Encoding test helper. Mirrors {@link Decoding} but exercises the schema's
+ * encoder direction.
+ *
+ * When to use:
+ * - You want to assert that specific values encode to expected outputs.
+ * - You want to assert that invalid inputs produce specific error messages
+ *   during encoding.
+ * - You need to provide services required by the schema's encoding pipeline.
+ *
+ * Behavior:
+ * - All assertions are async and use `assert.deepStrictEqual` internally.
+ * - `succeed(input)` asserts the encoded output equals `input` (identity).
+ * - `succeed(input, expected)` asserts the encoded output equals `expected`.
+ * - `fail(input, message)` asserts encoding fails and the stringified issue
+ *   equals `message`.
+ * - `provide(key, impl)` returns a new `Encoding` with the service injected
+ *   into the encoding context.
+ *
+ * **Example** (Encoding assertions)
+ *
+ * ```ts
+ * import { Schema } from "effect"
+ * import { TestSchema } from "effect/testing"
+ *
+ * const encoding = new TestSchema.Asserts(Schema.NumberFromString).encoding()
+ * await encoding.succeed(42, "42")
+ * ```
+ *
+ * @see {@link Asserts}
+ * @see {@link Decoding}
+ *
  * @since 4.0.0
  */
 class Encoding {
@@ -153,15 +410,31 @@ class Encoding {
     assert.deepStrictEqual(r, Result.succeed(expected));
   }
   /**
-   * Asserts that encoding fails with the expected error message.
+   * Asserts that encoding `input` fails and the stringified issue equals
+   * `message`.
+   *
+   * **Example** (Asserting an encoding failure)
+   *
+   * ```ts
+   * import { Schema } from "effect"
+   * import { TestSchema } from "effect/testing"
+   *
+   * const encoding = new TestSchema.Asserts(Schema.NumberFromString).encoding()
+   * await encoding.fail("not-a-number", "Expected number, got \"not-a-number\"")
+   * ```
    */
   async fail(input, message) {
     const r = await Effect.runPromise(this.encodeUnknownEffect(input, this.options?.parseOptions).pipe(Effect.mapError(issue => issue.toString()), Effect.result));
     assert.deepStrictEqual(r, Result.fail(message));
   }
   /**
-   * Creates a new Encoding instance with the provided service available in the
-   * encoding context.
+   * Returns a new {@link Encoding} instance with the given service injected
+   * into the encoding effect context. Use this when the schema's encoder
+   * requires a service dependency.
+   *
+   * - Does not mutate the current instance; returns a new one.
+   *
+   * @see {@link Decoding.provide}
    */
   provide(service, implementation) {
     return new Encoding(this.schema.pipe(Schema.middlewareEncoding(Effect.provideService(service, implementation))), this.options);

package/dist/testing/TestSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"TestSchema.js","names":["assert","Effect","Record","Result","Schema","AST","Parser","FastCheck","Asserts","ast","fields","equals","a","b","deepStrictEqual","map","getAST","elements","schema","constructor","make","options","makeEffect","succeed","input","expected","r","runPromise","pipe","mapError","issue","toString","result","arguments","length","fail","message","verifyLosslessTransformation","decodeUnknownEffect","encodeEffect","arbitrary","toArbitrary","asyncProperty","t","flatMap","e","params","decoding","Decoding","encoding","Encoding","verifyGeneration","is","arb","property","numRuns","parseOptions","provide","service","implementation","middlewareDecoding","provideService","encodeUnknownEffect","middlewareEncoding"],"sources":["../../src/testing/TestSchema.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;AAKA,OAAO,KAAKA,MAAM,MAAM,aAAa;AACrC,OAAO,KAAKC,MAAM,MAAM,cAAc;AACtC,OAAO,KAAKC,MAAM,MAAM,cAAc;AACtC,OAAO,KAAKC,MAAM,MAAM,cAAc;AACtC,OAAO,KAAKC,MAAM,MAAM,cAAc;AACtC,OAAO,KAAKC,GAAG,MAAM,iBAAiB;AAEtC,OAAO,KAAKC,MAAM,MAAM,oBAAoB;AAE5C,OAAO,KAAKC,SAAS,MAAM,yBAAyB;AAEpD;;;;;;AAMA,OAAM,MAAOC,OAAO;EAClB,OAAOC,GAAG,GAAG;IACX;IACAC,MAAM,EAAE;MACNC,MAAM,EAAEA,CAACC,CAAuB,EAAEC,CAAuB,KAAI;QAC3Db,MAAM,CAACc,eAAe,CAACZ,MAAM,CAACa,GAAG,CAACH,CAAC,EAAEP,GAAG,CAACW,MAAM,CAAC,EAAEd,MAAM,CAACa,GAAG,CAACF,CAAC,EAAER,GAAG,CAACW,MAAM,CAAC,CAAC;MAC9E;KACD;IACD;IACAC,QAAQ,EAAE;MACRN,MAAM,EAAEA,CAACC,CAAwB,EAAEC,CAAwB,KAAI;QAC7Db,MAAM,CAACc,eAAe,CAACF,CAAC,CAACG,GAAG,CAACV,GAAG,CAACW,MAAM,CAAC,EAAEH,CAAC,CAACE,GAAG,CAACV,GAAG,CAACW,MAAM,CAAC,CAAC;MAC9D;;GAEM;EAEDE,MAAM;EACfC,YAAYD,MAAS;IACnB,IAAI,CAACA,MAAM,GAAGA,MAAM;EACtB;EACA;;;EAGAE,IAAIA,CAACC,OAA4B;IAC/B,MAAMC,UAAU,GAAGhB,MAAM,CAACgB,UAAU,CAAC,IAAI,CAACJ,MAAM,CAAC;IAGjD,eAAeK,OAAOA,CAACC,KAAyB,EAAEC,QAAoB;MACpE,MAAMC,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/BL,UAAU,CAACE,KAAK,EAAEH,OAAO,CAAC,CAACO,IAAI,CAC7B3B,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;MACDP,QAAQ,GAAGQ,SAAS,CAACC,MAAM,KAAK,CAAC,GAAGV,KAAK,GAAGC,QAAQ;MACpDzB,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACoB,OAAO,CAACE,QAAQ,CAAC,CAAC;IACrD;IACA,OAAO;MACLF,OAAO;MACP;;;MAGA,MAAMY,IAAIA,CAACX,KAAc,EAAEY,OAAe;QACxC,MAAMV,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/BL,UAAU,CAACE,KAAK,EAAEH,OAAO,CAAC,CAACO,IAAI,CAC7B3B,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;QACDhC,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACgC,IAAI,CAACC,OAAO,CAAC,CAAC;MACjD;KACD;EACH;EACA;;;EAGAC,4BAA4BA,CAA6DhB,OAExF;IACC,MAAMiB,mBAAmB,GAAGhC,MAAM,CAACgC,mBAAmB,CAAC,IAAI,CAACpB,MAAM,CAAC;IACnE,MAAMqB,YAAY,GAAGjC,MAAM,CAACiC,YAAY,CAAC,IAAI,CAACrB,MAAM,CAAC;IACrD,MAAMsB,SAAS,GAAGpC,MAAM,CAACqC,WAAW,CAAC,IAAI,CAACvB,MAAM,CAAC;IACjD,OAAOX,SAAS,CAACP,MAAM,CACrBO,SAAS,CAACmC,aAAa,CAACF,SAAS,EAAE,MAAOG,CAAC,IAAI;MAC7C,MAAMjB,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/BY,YAAY,CAACI,CAAC,CAAC,CAACf,IAAI,CAClB3B,MAAM,CAAC2C,OAAO,CAAEC,CAAC,IAAKP,mBAAmB,CAACO,CAAC,CAAC,CAAC,EAC7C5C,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;MACDhC,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACoB,OAAO,CAACoB,CAAC,CAAC,CAAC;IAC9C,CAAC,CAAC,EACFtB,OAAO,EAAEyB,MAAM,CAChB;EACH;EACA;;;EAGAC,QAAQA,CAAC1B,OAER;IACC,OAAO,IAAI2B,QAAQ,CAAC,IAAI,CAAC9B,MAAM,EAAEG,OAAO,CAAC;EAC3C;EACA;;;EAGA4B,QAAQA,CAAC5B,OAER;IACC,OAAO,IAAI6B,QAAQ,CAAC,IAAI,CAAChC,MAAM,EAAEG,OAAO,CAAC;EAC3C;EACA;;;EAGAmB,SAASA,CAAA;IACP,MAAMtB,MAAM,GAAG,IAAI,CAACA,MAAM;IAC1B,OAAO;MACL;;;;MAIAiC,gBAAgBA,CAAC9B,OAEhB;QACC,MAAMyB,MAAM,GAAGzB,OAAO,EAAEyB,MAAM;QAC9B,MAAMM,EAAE,GAAGhD,MAAM,CAACgD,EAAE,CAAClC,MAAM,CAAC;QAC5B,MAAMmC,GAAG,GAAGjD,MAAM,CAACqC,WAAW,CAACvB,MAAM,CAAC;QACtCX,SAAS,CAACP,MAAM,CAACO,SAAS,CAAC+C,QAAQ,CAACD,GAAG,EAAGzC,CAAC,IAAKwC,EAAE,CAACxC,CAAC,CAAC,CAAC,EAAE;UAAE2C,OAAO,EAAE,EAAE;UAAE,GAAGT;QAAM,CAAE,CAAC;MACrF;KACD;EACH;;AAGF;;;AAGA,OAAM,MAAOE,QAAQ;EACV9B,MAAM;EACNoB,mBAAmB;EAInBjB,OAAO;EAGhBF,YAAYD,MAAS,EAAEG,OAEtB;IACC,IAAI,CAACH,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACoB,mBAAmB,GAAGhC,MAAM,CAACgC,mBAAmB,CAACpB,MAAM,CAAC;IAC7D,IAAI,CAACG,OAAO,GAAGA,OAAO;EACxB;EAaA,MAAME,OAAOA,CAEXC,KAAc,EACdC,QAAoB;IAEpB,MAAMC,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/B,IAAI,CAACW,mBAAmB,CAACd,KAAK,EAAE,IAAI,CAACH,OAAO,EAAEmC,YAAY,CAAC,CAAC5B,IAAI,CAC9D3B,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;IACDP,QAAQ,GAAGQ,SAAS,CAACC,MAAM,KAAK,CAAC,GAAGV,KAAK,GAAGC,QAAQ;IACpDzB,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACoB,OAAO,CAACE,QAAQ,CAAC,CAAC;EACrD;EACA;;;EAGA,MAAMU,IAAIA,CAERX,KAAc,EACdY,OAAe;IAEf,MAAMV,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/B,IAAI,CAACW,mBAAmB,CAACd,KAAK,EAAE,IAAI,CAACH,OAAO,EAAEmC,YAAY,CAAC,CAAC5B,IAAI,CAC9D3B,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;IACDhC,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACgC,IAAI,CAACC,OAAO,CAAC,CAAC;EACjD;EACA;;;;EAIAqB,OAAOA,CACLC,OAAwC,EACxCC,cAAuB;IAEvB,OAAO,IAAIX,QAAQ,CACjB,IAAI,CAAC9B,MAAM,CAACU,IAAI,CAACxB,MAAM,CAACwD,kBAAkB,CAAC3D,MAAM,CAAC4D,cAAc,CAACH,OAAO,EAAEC,cAAc,CAAC,CAAC,CAAC,EAC3F,IAAI,CAACtC,OAAO,CACb;EACH;;AAGF;;;AAGA,MAAM6B,QAAQ;EACHhC,MAAM;EACN4C,mBAAmB;EAInBzC,OAAO;EAGhBF,YAAYD,MAAS,EAAEG,OAEtB;IACC,IAAI,CAACH,MAAM,GAAGA,MAAM;IACpB,IAAI,CAAC4C,mBAAmB,GAAGxD,MAAM,CAACwD,mBAAmB,CAAC5C,MAAM,CAAC;IAC7D,IAAI,CAACG,OAAO,GAAGA,OAAO;EACxB;EAaA,MAAME,OAAOA,CAEXC,KAAc,EACdC,QAAuB;IAEvB,MAAMC,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/B,IAAI,CAACmC,mBAAmB,CAACtC,KAAK,EAAE,IAAI,CAACH,OAAO,EAAEmC,YAAY,CAAC,CAAC5B,IAAI,CAC9D3B,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;IACDP,QAAQ,GAAGQ,SAAS,CAACC,MAAM,KAAK,CAAC,GAAGV,KAAK,GAAGC,QAAQ;IACpDzB,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACoB,OAAO,CAACE,QAAQ,CAAC,CAAC;EACrD;EACA;;;EAGA,MAAMU,IAAIA,CAERX,KAAc,EACdY,OAAe;IAEf,MAAMV,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/B,IAAI,CAACmC,mBAAmB,CAACtC,KAAK,EAAE,IAAI,CAACH,OAAO,EAAEmC,YAAY,CAAC,CAAC5B,IAAI,CAC9D3B,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;IACDhC,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACgC,IAAI,CAACC,OAAO,CAAC,CAAC;EACjD;EACA;;;;EAIAqB,OAAOA,CACLC,OAAwC,EACxCC,cAAuB;IAEvB,OAAO,IAAIT,QAAQ,CACjB,IAAI,CAAChC,MAAM,CAACU,IAAI,CAACxB,MAAM,CAAC2D,kBAAkB,CAAC9D,MAAM,CAAC4D,cAAc,CAACH,OAAO,EAAEC,cAAc,CAAC,CAAC,CAAC,EAC3F,IAAI,CAACtC,OAAO,CACb;EACH","ignoreList":[]}
+{"version":3,"file":"TestSchema.js","names":["assert","Effect","Record","Result","Schema","AST","Parser","FastCheck","Asserts","ast","fields","equals","a","b","deepStrictEqual","map","getAST","elements","schema","constructor","make","options","makeEffect","succeed","input","expected","r","runPromise","pipe","mapError","issue","toString","result","arguments","length","fail","message","verifyLosslessTransformation","decodeUnknownEffect","encodeEffect","arbitrary","toArbitrary","asyncProperty","t","flatMap","e","params","decoding","Decoding","encoding","Encoding","verifyGeneration","is","arb","property","numRuns","parseOptions","provide","service","implementation","middlewareDecoding","provideService","encodeUnknownEffect","middlewareEncoding"],"sources":["../../src/testing/TestSchema.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoEA,OAAO,KAAKA,MAAM,MAAM,aAAa;AAErC,OAAO,KAAKC,MAAM,MAAM,cAAc;AACtC,OAAO,KAAKC,MAAM,MAAM,cAAc;AACtC,OAAO,KAAKC,MAAM,MAAM,cAAc;AACtC,OAAO,KAAKC,MAAM,MAAM,cAAc;AACtC,OAAO,KAAKC,GAAG,MAAM,iBAAiB;AAEtC,OAAO,KAAKC,MAAM,MAAM,oBAAoB;AAC5C,OAAO,KAAKC,SAAS,MAAM,yBAAyB;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,OAAM,MAAOC,OAAO;EAClB;;;;;;;;;;;;;;;;;;;;EAoBA,OAAOC,GAAG,GAAG;IACXC,MAAM,EAAE;MACNC,MAAM,EAAEA,CAACC,CAAuB,EAAEC,CAAuB,KAAI;QAC3Db,MAAM,CAACc,eAAe,CAACZ,MAAM,CAACa,GAAG,CAACH,CAAC,EAAEP,GAAG,CAACW,MAAM,CAAC,EAAEd,MAAM,CAACa,GAAG,CAACF,CAAC,EAAER,GAAG,CAACW,MAAM,CAAC,CAAC;MAC9E;KACD;IACDC,QAAQ,EAAE;MACRN,MAAM,EAAEA,CAACC,CAAwB,EAAEC,CAAwB,KAAI;QAC7Db,MAAM,CAACc,eAAe,CAACF,CAAC,CAACG,GAAG,CAACV,GAAG,CAACW,MAAM,CAAC,EAAEH,CAAC,CAACE,GAAG,CAACV,GAAG,CAACW,MAAM,CAAC,CAAC;MAC9D;;GAEM;EAEDE,MAAM;EACfC,YAAYD,MAAS;IACnB,IAAI,CAACA,MAAM,GAAGA,MAAM;EACtB;EACA;;;;;;;;;;;;;;;;;;;EAmBAE,IAAIA,CAACC,OAA4B;IAC/B,MAAMC,UAAU,GAAGhB,MAAM,CAACgB,UAAU,CAAC,IAAI,CAACJ,MAAM,CAAC;IAGjD,eAAeK,OAAOA,CAACC,KAAyB,EAAEC,QAAoB;MACpE,MAAMC,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/BL,UAAU,CAACE,KAAK,EAAEH,OAAO,CAAC,CAACO,IAAI,CAC7B3B,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;MACDP,QAAQ,GAAGQ,SAAS,CAACC,MAAM,KAAK,CAAC,GAAGV,KAAK,GAAGC,QAAQ;MACpDzB,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACoB,OAAO,CAACE,QAAQ,CAAC,CAAC;IACrD;IACA,OAAO;MACLF,OAAO;MACP,MAAMY,IAAIA,CAACX,KAAc,EAAEY,OAAe;QACxC,MAAMV,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/BL,UAAU,CAACE,KAAK,EAAEH,OAAO,CAAC,CAACO,IAAI,CAC7B3B,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;QACDhC,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACgC,IAAI,CAACC,OAAO,CAAC,CAAC;MACjD;KACD;EACH;EACA;;;;;;;;;;;;;;;;;;;EAmBAC,4BAA4BA,CAA6DhB,OAExF;IACC,MAAMiB,mBAAmB,GAAGhC,MAAM,CAACgC,mBAAmB,CAAC,IAAI,CAACpB,MAAM,CAAC;IACnE,MAAMqB,YAAY,GAAGjC,MAAM,CAACiC,YAAY,CAAC,IAAI,CAACrB,MAAM,CAAC;IACrD,MAAMsB,SAAS,GAAGpC,MAAM,CAACqC,WAAW,CAAC,IAAI,CAACvB,MAAM,CAAC;IACjD,OAAOX,SAAS,CAACP,MAAM,CACrBO,SAAS,CAACmC,aAAa,CAACF,SAAS,EAAE,MAAOG,CAAC,IAAI;MAC7C,MAAMjB,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/BY,YAAY,CAACI,CAAC,CAAC,CAACf,IAAI,CAClB3B,MAAM,CAAC2C,OAAO,CAAEC,CAAC,IAAKP,mBAAmB,CAACO,CAAC,CAAC,CAAC,EAC7C5C,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;MACDhC,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACoB,OAAO,CAACoB,CAAC,CAAC,CAAC;IAC9C,CAAC,CAAC,EACFtB,OAAO,EAAEyB,MAAM,CAChB;EACH;EACA;;;;;;;;;;;;;;;;;;;;EAoBAC,QAAQA,CAAC1B,OAER;IACC,OAAO,IAAI2B,QAAQ,CAAC,IAAI,CAAC9B,MAAM,EAAEG,OAAO,CAAC;EAC3C;EACA;;;;;;;;;;;;;;;;;;;EAmBA4B,QAAQA,CAAC5B,OAER;IACC,OAAO,IAAI6B,QAAQ,CAAC,IAAI,CAAChC,MAAM,EAAEG,OAAO,CAAC;EAC3C;EACA;;;;;;;;;;;;;;;;;;EAkBAmB,SAASA,CAAA;IACP,MAAMtB,MAAM,GAAG,IAAI,CAACA,MAAM;IAC1B,OAAO;MACLiC,gBAAgBA,CAAC9B,OAEhB;QACC,MAAMyB,MAAM,GAAGzB,OAAO,EAAEyB,MAAM;QAC9B,MAAMM,EAAE,GAAGhD,MAAM,CAACgD,EAAE,CAAClC,MAAM,CAAC;QAC5B,MAAMmC,GAAG,GAAGjD,MAAM,CAACqC,WAAW,CAACvB,MAAM,CAAC;QACtCX,SAAS,CAACP,MAAM,CAACO,SAAS,CAAC+C,QAAQ,CAACD,GAAG,EAAGzC,CAAC,IAAKwC,EAAE,CAACxC,CAAC,CAAC,CAAC,EAAE;UAAE2C,OAAO,EAAE,EAAE;UAAE,GAAGT;QAAM,CAAE,CAAC;MACrF;KACD;EACH;;AAGF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,OAAM,MAAOE,QAAQ;EACV9B,MAAM;EACNoB,mBAAmB;EAInBjB,OAAO;EAGhBF,YAAYD,MAAS,EAAEG,OAEtB;IACC,IAAI,CAACH,MAAM,GAAGA,MAAM;IACpB,IAAI,CAACoB,mBAAmB,GAAGhC,MAAM,CAACgC,mBAAmB,CAACpB,MAAM,CAAC;IAC7D,IAAI,CAACG,OAAO,GAAGA,OAAO;EACxB;EAyBA,MAAME,OAAOA,CAEXC,KAAc,EACdC,QAAoB;IAEpB,MAAMC,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/B,IAAI,CAACW,mBAAmB,CAACd,KAAK,EAAE,IAAI,CAACH,OAAO,EAAEmC,YAAY,CAAC,CAAC5B,IAAI,CAC9D3B,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;IACDP,QAAQ,GAAGQ,SAAS,CAACC,MAAM,KAAK,CAAC,GAAGV,KAAK,GAAGC,QAAQ;IACpDzB,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACoB,OAAO,CAACE,QAAQ,CAAC,CAAC;EACrD;EACA;;;;;;;;;;;;;;EAcA,MAAMU,IAAIA,CAERX,KAAc,EACdY,OAAe;IAEf,MAAMV,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/B,IAAI,CAACW,mBAAmB,CAACd,KAAK,EAAE,IAAI,CAACH,OAAO,EAAEmC,YAAY,CAAC,CAAC5B,IAAI,CAC9D3B,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;IACDhC,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACgC,IAAI,CAACC,OAAO,CAAC,CAAC;EACjD;EACA;;;;;;;;;EASAqB,OAAOA,CACLC,OAAiC,EACjCC,cAAuB;IAEvB,OAAO,IAAIX,QAAQ,CACjB,IAAI,CAAC9B,MAAM,CAACU,IAAI,CAACxB,MAAM,CAACwD,kBAAkB,CAAC3D,MAAM,CAAC4D,cAAc,CAACH,OAAO,EAAEC,cAAc,CAAC,CAAC,CAAC,EAC3F,IAAI,CAACtC,OAAO,CACb;EACH;;AAGF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,MAAM6B,QAAQ;EACHhC,MAAM;EACN4C,mBAAmB;EAInBzC,OAAO;EAGhBF,YAAYD,MAAS,EAAEG,OAEtB;IACC,IAAI,CAACH,MAAM,GAAGA,MAAM;IACpB,IAAI,CAAC4C,mBAAmB,GAAGxD,MAAM,CAACwD,mBAAmB,CAAC5C,MAAM,CAAC;IAC7D,IAAI,CAACG,OAAO,GAAGA,OAAO;EACxB;EAyBA,MAAME,OAAOA,CAEXC,KAAc,EACdC,QAAuB;IAEvB,MAAMC,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/B,IAAI,CAACmC,mBAAmB,CAACtC,KAAK,EAAE,IAAI,CAACH,OAAO,EAAEmC,YAAY,CAAC,CAAC5B,IAAI,CAC9D3B,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;IACDP,QAAQ,GAAGQ,SAAS,CAACC,MAAM,KAAK,CAAC,GAAGV,KAAK,GAAGC,QAAQ;IACpDzB,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACoB,OAAO,CAACE,QAAQ,CAAC,CAAC;EACrD;EACA;;;;;;;;;;;;;;EAcA,MAAMU,IAAIA,CAERX,KAAc,EACdY,OAAe;IAEf,MAAMV,CAAC,GAAG,MAAMzB,MAAM,CAAC0B,UAAU,CAC/B,IAAI,CAACmC,mBAAmB,CAACtC,KAAK,EAAE,IAAI,CAACH,OAAO,EAAEmC,YAAY,CAAC,CAAC5B,IAAI,CAC9D3B,MAAM,CAAC4B,QAAQ,CAAEC,KAAK,IAAKA,KAAK,CAACC,QAAQ,EAAE,CAAC,EAC5C9B,MAAM,CAAC+B,MAAM,CACd,CACF;IACDhC,MAAM,CAACc,eAAe,CAACY,CAAC,EAAEvB,MAAM,CAACgC,IAAI,CAACC,OAAO,CAAC,CAAC;EACjD;EACA;;;;;;;;;EASAqB,OAAOA,CACLC,OAAiC,EACjCC,cAAuB;IAEvB,OAAO,IAAIT,QAAQ,CACjB,IAAI,CAAChC,MAAM,CAACU,IAAI,CAACxB,MAAM,CAAC2D,kBAAkB,CAAC9D,MAAM,CAAC4D,cAAc,CAACH,OAAO,EAAEC,cAAc,CAAC,CAAC,CAAC,EAC3F,IAAI,CAACtC,OAAO,CACb;EACH","ignoreList":[]}

package/dist/testing/index.d.ts

@@ -22,7 +22,70 @@ export * as TestClock from "./TestClock.ts";
  */
 export * as TestConsole from "./TestConsole.ts";
 /**
- * Testing utilities for Schema validation and assertions.
+ * Testing utilities for asserting Schema decoding, encoding, make, and
+ * arbitrary-generation behavior. Used in unit tests to verify that schemas
+ * accept, reject, and round-trip values correctly.
+ *
+ * ## Mental model
+ *
+ * - **Asserts** – entry point: wraps a schema and exposes helpers grouped by
+ *   operation (decoding, encoding, make, arbitrary, round-trip).
+ * - **Decoding** – returned by `asserts.decoding()`; has `succeed` / `fail`
+ *   helpers that run the schema's decoder and compare the result.
+ * - **Encoding** – returned by `asserts.encoding()`; mirrors {@link Decoding}
+ *   but exercises the encoder direction.
+ * - Every assertion is async (`Promise<void>`) because parsing may involve
+ *   effectful schemas.
+ * - `succeed` with one argument asserts identity (output equals input);
+ *   with two arguments asserts a specific expected output.
+ * - `fail` always takes the input and the expected error message string.
+ *
+ * ## Common tasks
+ *
+ * - Assert decoding succeeds / fails → `new Asserts(schema).decoding().succeed(…)` / `.fail(…)`
+ * - Assert encoding succeeds / fails → `new Asserts(schema).encoding().succeed(…)` / `.fail(…)`
+ * - Assert make succeeds / fails → `new Asserts(schema).make().succeed(…)` / `.fail(…)`
+ * - Verify round-trip (encode then decode) → `new Asserts(schema).verifyLosslessTransformation()`
+ * - Verify arbitrary generation → `new Asserts(schema).arbitrary().verifyGeneration()`
+ * - Compare AST of struct fields → `Asserts.ast.fields.equals(a, b)`
+ * - Provide a service dependency for decoding → `asserts.decoding().provide(key, impl)`
+ *
+ * ## Gotchas
+ *
+ * - `succeed` uses `assert.deepStrictEqual`, so reference equality is not
+ *   required but structural equality is.
+ * - `fail` compares against the stringified `Issue`, not the `Issue` object
+ *   itself. Pass the exact multiline string the issue produces.
+ * - `verifyLosslessTransformation` and `arbitrary().verifyGeneration` run
+ *   property-based tests via FastCheck; default run count is 20 for
+ *   `verifyGeneration`.
+ *
+ * ## Quickstart
+ *
+ * **Example** (Basic decoding and encoding assertions)
+ *
+ * ```ts
+ * import { Schema } from "effect"
+ * import { TestSchema } from "effect/testing"
+ *
+ * const schema = Schema.NumberFromString
+ * const asserts = new TestSchema.Asserts(schema)
+ *
+ * // decoding
+ * const decoding = asserts.decoding()
+ * await decoding.succeed("1", 1)
+ * await decoding.fail(null, "Expected string, got null")
+ *
+ * // encoding
+ * const encoding = asserts.encoding()
+ * await encoding.succeed(1, "1")
+ * ```
+ *
+ * ## See also
+ *
+ * - {@link Asserts}
+ * - {@link Decoding}
+ * - {@link Encoding}
  *
  * @since 4.0.0
  */

package/dist/testing/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;GAUG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;;;GAIG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/testing/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;GAUG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA"}

package/dist/testing/index.js

@@ -23,7 +23,70 @@ export * as TestClock from "./TestClock.js";
  */
 export * as TestConsole from "./TestConsole.js";
 /**
- * Testing utilities for Schema validation and assertions.
+ * Testing utilities for asserting Schema decoding, encoding, make, and
+ * arbitrary-generation behavior. Used in unit tests to verify that schemas
+ * accept, reject, and round-trip values correctly.
+ *
+ * ## Mental model
+ *
+ * - **Asserts** – entry point: wraps a schema and exposes helpers grouped by
+ *   operation (decoding, encoding, make, arbitrary, round-trip).
+ * - **Decoding** – returned by `asserts.decoding()`; has `succeed` / `fail`
+ *   helpers that run the schema's decoder and compare the result.
+ * - **Encoding** – returned by `asserts.encoding()`; mirrors {@link Decoding}
+ *   but exercises the encoder direction.
+ * - Every assertion is async (`Promise<void>`) because parsing may involve
+ *   effectful schemas.
+ * - `succeed` with one argument asserts identity (output equals input);
+ *   with two arguments asserts a specific expected output.
+ * - `fail` always takes the input and the expected error message string.
+ *
+ * ## Common tasks
+ *
+ * - Assert decoding succeeds / fails → `new Asserts(schema).decoding().succeed(…)` / `.fail(…)`
+ * - Assert encoding succeeds / fails → `new Asserts(schema).encoding().succeed(…)` / `.fail(…)`
+ * - Assert make succeeds / fails → `new Asserts(schema).make().succeed(…)` / `.fail(…)`
+ * - Verify round-trip (encode then decode) → `new Asserts(schema).verifyLosslessTransformation()`
+ * - Verify arbitrary generation → `new Asserts(schema).arbitrary().verifyGeneration()`
+ * - Compare AST of struct fields → `Asserts.ast.fields.equals(a, b)`
+ * - Provide a service dependency for decoding → `asserts.decoding().provide(key, impl)`
+ *
+ * ## Gotchas
+ *
+ * - `succeed` uses `assert.deepStrictEqual`, so reference equality is not
+ *   required but structural equality is.
+ * - `fail` compares against the stringified `Issue`, not the `Issue` object
+ *   itself. Pass the exact multiline string the issue produces.
+ * - `verifyLosslessTransformation` and `arbitrary().verifyGeneration` run
+ *   property-based tests via FastCheck; default run count is 20 for
+ *   `verifyGeneration`.
+ *
+ * ## Quickstart
+ *
+ * **Example** (Basic decoding and encoding assertions)
+ *
+ * ```ts
+ * import { Schema } from "effect"
+ * import { TestSchema } from "effect/testing"
+ *
+ * const schema = Schema.NumberFromString
+ * const asserts = new TestSchema.Asserts(schema)
+ *
+ * // decoding
+ * const decoding = asserts.decoding()
+ * await decoding.succeed("1", 1)
+ * await decoding.fail(null, "Expected string, got null")
+ *
+ * // encoding
+ * const encoding = asserts.encoding()
+ * await encoding.succeed(1, "1")
+ * ```
+ *
+ * ## See also
+ *
+ * - {@link Asserts}
+ * - {@link Decoding}
+ * - {@link Encoding}
  *
  * @since 4.0.0
  */

package/dist/testing/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":["FastCheck","TestClock","TestConsole","TestSchema"],"sources":["../../src/testing/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;;;;;;;;;AAWA,OAAO,KAAKA,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;;;AAKA,OAAO,KAAKC,UAAU,MAAM,iBAAiB","ignoreList":[]}
+{"version":3,"file":"index.js","names":["FastCheck","TestClock","TestConsole","TestSchema"],"sources":["../../src/testing/index.ts"],"sourcesContent":[null],"mappings":"AAAA;;;AAIA;AAEA;;;;;;;;;;;AAWA,OAAO,KAAKA,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,SAAS,MAAM,gBAAgB;AAE3C;;;AAGA,OAAO,KAAKC,WAAW,MAAM,kBAAkB;AAE/C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoEA,OAAO,KAAKC,UAAU,MAAM,iBAAiB","ignoreList":[]}