effect 4.0.0-beta.102 → 4.0.0-beta.103

package/dist/SchemaIssue.js

@@ -1,9 +1,7 @@
 import * as Arr from "./Array.js";
-import { format, formatPath } from "./Formatter.js";
+import { formatPath } from "./Formatter.js";
 import * as InternalAnnotations from "./internal/schema/annotations.js";
-import * as Option from "./Option.js";
 import { hasProperty } from "./Predicate.js";
-import * as Redacted from "./Redacted.js";
 const TypeId = "~effect/SchemaIssue/Issue";
 /**
  * Returns `true` if the given value is an {@link Issue}.
@@ -20,14 +18,12 @@ const TypeId = "~effect/SchemaIssue/Issue";
  *
  * **Example** (Type-guarding an unknown error)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { SchemaIssue } from "effect"
  *
  * const issue = new SchemaIssue.MissingKey(undefined)
- * console.log(SchemaIssue.isIssue(issue))
- * // true
- * console.log(SchemaIssue.isIssue("not an issue"))
- * // false
+ * SchemaIssue.isIssue(issue) // => true
+ * SchemaIssue.isIssue("not an issue") // => false
  * ```
  *
  * @see {@link Issue}
@@ -54,22 +50,26 @@ class Base {
  *
  * **Details**
  *
- * - `actual` is the raw input value that was tested (plain `unknown`, not
- *   wrapped in `Option`).
  * - `filter` is the AST filter node that produced this issue.
  * - `issue` is the inner issue describing the failure reason.
  *
  * **Example** (Matching a Filter issue)
  *
- * ```ts
- * import { SchemaIssue } from "effect"
+ * ```ts import.meta.vitest
+ * import { SchemaAST, SchemaIssue } from "effect"
  *
  * function describe(issue: SchemaIssue.Issue): string {
  *   if (issue._tag === "Filter") {
- *     return `Filter failed on: ${JSON.stringify(issue.actual)}`
+ *     return `Filter failed: ${String(issue.issue)}`
  *   }
  *   return String(issue)
  * }
+ *
+ * const issue = new SchemaIssue.Filter(
+ *   SchemaAST.isPattern(/^valid$/),
+ *   new SchemaIssue.InvalidValue()
+ * )
+ * describe(issue) // => `Filter failed: Expected a valid value`
  * ```
  *
  * @see {@link Leaf} — terminal issue types that commonly appear as the inner `issue`
@@ -80,10 +80,6 @@ class Base {
  */
 export class Filter extends Base {
   _tag = "Filter";
-  /**
-   * The input value that caused the issue.
-   */
-  actual;
   /**
    * The filter that failed.
    */
@@ -93,10 +89,6 @@ export class Filter extends Base {
    */
   issue;
   constructor(
-  /**
-   * The input value that caused the issue.
-   */
-  actual,
   /**
    * The filter that failed.
    */
@@ -106,7 +98,6 @@ export class Filter extends Base {
    */
   issue) {
     super();
-    this.actual = actual;
     this.filter = filter;
     this.issue = issue;
   }
@@ -122,8 +113,6 @@ export class Filter extends Base {
  * **Details**
  *
  * - `ast` is the AST node for the transformation that failed.
- * - `actual` is `Option.some(value)` when the input was present, or
- *   `Option.none()` when it was absent.
  * - `issue` is the inner issue describing the failure.
  *
  * @see {@link Filter} — failure from a refinement check (not a transformation)
@@ -138,10 +127,6 @@ export class Encoding extends Base {
    * The schema that caused the issue.
    */
   ast;
-  /**
-   * The input value that caused the issue.
-   */
-  actual;
   /**
    * The issue that occurred.
    */
@@ -151,17 +136,12 @@ export class Encoding extends Base {
    * The schema that caused the issue.
    */
   ast,
-  /**
-   * The input value that caused the issue.
-   */
-  actual,
   /**
    * The issue that occurred.
    */
   issue) {
     super();
     this.ast = ast;
-    this.actual = actual;
     this.issue = issue;
   }
 }
@@ -177,11 +157,9 @@ export class Encoding extends Base {
  * **Details**
  *
  * - `path` is an array of property keys (strings, numbers, or symbols).
- * - Has no `actual` value — {@link getActual} returns `Option.none()`.
  * - Formatters concatenate nested `Pointer` paths into a single path like
  *   `["a"]["b"][0]`.
  *
- * @see {@link getActual} — returns `Option.none()` for `Pointer`
  * @see {@link Composite} — groups multiple issues under one schema node
  *
  * @category models
@@ -220,7 +198,6 @@ export class Pointer extends Base {
  *
  * **Details**
  *
- * - Has no `actual` value — {@link getActual} returns `Option.none()`.
  * - `annotations` may contain a custom `messageMissingKey` for formatting.
  *
  * @see {@link Pointer} — wraps this issue with the missing key's path
@@ -255,9 +232,9 @@ export class MissingKey extends Base {
  *
  * **Details**
  *
- * - `actual` is the raw value at the unexpected key (plain `unknown`).
  * - `ast` is the schema that was being validated against.
  * - `annotations` on `ast` may contain a custom `messageUnexpectedKey`.
+ * - The default formatter renders this as `"Expected no excess property"`.
  *
  * @see {@link MissingKey} — the opposite case (required key absent)
  * @see {@link Pointer} — wraps this issue with the unexpected key's path
@@ -271,22 +248,13 @@ export class UnexpectedKey extends Base {
    * The schema that caused the issue.
    */
   ast;
-  /**
-   * The input value that caused the issue.
-   */
-  actual;
   constructor(
   /**
    * The schema that caused the issue.
    */
-  ast,
-  /**
-   * The input value that caused the issue.
-   */
-  actual) {
+  ast) {
     super();
     this.ast = ast;
-    this.actual = actual;
   }
 }
 /**
@@ -300,8 +268,6 @@ export class UnexpectedKey extends Base {
  * **Details**
  *
  * - `issues` is a non-empty readonly array (at least one child).
- * - `actual` is `Option.some(value)` when the input was present, or
- *   `Option.none()` when absent.
  * - Formatters flatten `Composite` by recursing into each child.
  *
  * @see {@link AnyOf} — used for union no-match errors (similar but different semantics)
@@ -316,10 +282,6 @@ export class Composite extends Base {
    * The schema that caused the issue.
    */
   ast;
-  /**
-   * The input value that caused the issue.
-   */
-  actual;
   /**
    * The issues that occurred.
    */
@@ -329,23 +291,18 @@ export class Composite extends Base {
    * The schema that caused the issue.
    */
   ast,
-  /**
-   * The input value that caused the issue.
-   */
-  actual,
   /**
    * The issues that occurred.
    */
   issues) {
     super();
     this.ast = ast;
-    this.actual = actual;
     this.issues = issues;
   }
 }
 /**
  * Represents a schema issue produced when the runtime type of the input does not match the type
- * expected by the schema (e.g. got `null` when `string` was expected).
+ * expected by the schema.
  *
  * **When to use**
  *
@@ -355,23 +312,15 @@ export class Composite extends Base {
  * **Details**
  *
  * - `ast` is the schema node that expected a different type.
- * - `actual` is `Option.some(value)` when the input was present, or
- *   `Option.none()` when no value was provided.
- * - The default formatter renders this as `"Expected <type>, got <actual>"`.
+ * - The default formatter renders this as `"Expected <type>"`.
  *
- * **Example** (Formatting output)
+ * **Example** (Formatting a type mismatch)
  *
- * ```ts
- * import { Schema } from "effect"
+ * ```ts import.meta.vitest
+ * import { Schema, SchemaIssue } from "effect"
  *
- * try {
- *   Schema.decodeUnknownSync(Schema.String)(42)
- * } catch (e) {
- *   if (Schema.isSchemaError(e)) {
- *     console.log(String(e.issue))
- *     // "Expected string, got 42"
- *   }
- * }
+ * const issue = new SchemaIssue.InvalidType(Schema.String.ast)
+ * String(issue) // => "Expected string"
  * ```
  *
  * @see {@link InvalidValue} — the input has the right type but fails a value constraint
@@ -385,22 +334,13 @@ export class InvalidType extends Base {
    * The schema that caused the issue.
    */
   ast;
-  /**
-   * The input value that caused the issue.
-   */
-  actual;
   constructor(
   /**
    * The schema that caused the issue.
    */
-  ast,
-  /**
-   * The input value that caused the issue.
-   */
-  actual) {
+  ast) {
     super();
     this.ast = ast;
-    this.actual = actual;
   }
 }
 /**
@@ -414,23 +354,17 @@ export class InvalidType extends Base {
  *
  * **Details**
  *
- * - `actual` is `Option.some(value)` when the failing value is known, or
- *   `Option.none()` when absent.
  * - `annotations` optionally carries a `message` string for formatting.
- * - The default formatter renders this as `"Invalid data <actual>"` unless a
+ * - The default formatter renders this as `"Expected a valid value"` unless a
  *   custom `message` annotation is provided.
  *
  * **Example** (Returning InvalidValue from a custom filter)
  *
- * ```ts
- * import { Option, SchemaIssue } from "effect"
+ * ```ts import.meta.vitest
+ * import { SchemaIssue } from "effect"
  *
- * const issue = new SchemaIssue.InvalidValue(
- *   Option.some(""),
- *   { message: "must not be empty" }
- * )
- * console.log(String(issue))
- * // "must not be empty"
+ * const issue = new SchemaIssue.InvalidValue({ message: "must not be empty" })
+ * String(issue) // => "must not be empty"
  * ```
  *
  * @see {@link InvalidType} — the input has the wrong type entirely
@@ -441,25 +375,12 @@ export class InvalidType extends Base {
  */
 export class InvalidValue extends Base {
   _tag = "InvalidValue";
-  /**
-   * The value that caused the issue.
-   */
-  actual;
   /**
    * The metadata for the issue.
    */
   annotations;
-  constructor(
-  /**
-   * The value that caused the issue.
-   */
-  actual,
-  /**
-   * The metadata for the issue.
-   */
-  annotations) {
+  constructor(annotations) {
     super();
-    this.actual = actual;
     this.annotations = annotations;
   }
 }
@@ -474,22 +395,18 @@ export class InvalidValue extends Base {
  *
  * **Details**
  *
- * - `actual` is `Option.some(value)` when the input is known, or
- *   `Option.none()` when absent.
  * - `annotations` optionally carries a `message` string.
  * - The default formatter renders this as `"Forbidden operation"`.
  *
  * **Example** (Creating a Forbidden issue)
  *
- * ```ts
- * import { Option, SchemaIssue } from "effect"
+ * ```ts import.meta.vitest
+ * import { SchemaIssue } from "effect"
  *
  * const issue = new SchemaIssue.Forbidden(
- *   Option.none(),
  *   { message: "async operation not allowed in sync context" }
  * )
- * console.log(String(issue))
- * // "async operation not allowed in sync context"
+ * String(issue) // => "async operation not allowed in sync context"
  * ```
  *
  * @see {@link InvalidValue} — for value-constraint failures (not operation failures)
@@ -499,25 +416,16 @@ export class InvalidValue extends Base {
  */
 export class Forbidden extends Base {
   _tag = "Forbidden";
-  /**
-   * The input value that caused the issue.
-   */
-  actual;
   /**
    * The metadata for the issue.
    */
   annotations;
   constructor(
-  /**
-   * The input value that caused the issue.
-   */
-  actual,
   /**
    * The metadata for the issue.
    */
   annotations) {
     super();
-    this.actual = actual;
     this.annotations = annotations;
   }
 }
@@ -532,9 +440,12 @@ export class Forbidden extends Base {
  * **Details**
  *
  * - `ast` is the `Union` AST node.
- * - `actual` is the raw input value (plain `unknown`).
- * - `issues` contains per-member failures. When empty, the formatter falls
- *   back to the union's `expected` annotation.
+ * - `issues` contains the per-member failures.
+ *
+ * **Gotchas**
+ *
+ * `issues` is empty when no union member was applicable. In that case, the
+ * default formatter reports the expected type for the union.
  *
  * @see {@link OneOf} — the opposite: *too many* members matched
  * @see {@link Composite} — groups multiple issues under a non-union schema
@@ -548,10 +459,6 @@ export class AnyOf extends Base {
    * The schema that caused the issue.
    */
   ast;
-  /**
-   * The input value that caused the issue.
-   */
-  actual;
   /**
    * The issues that occurred.
    */
@@ -561,17 +468,12 @@ export class AnyOf extends Base {
    * The schema that caused the issue.
    */
   ast,
-  /**
-   * The input value that caused the issue.
-   */
-  actual,
   /**
    * The issues that occurred.
    */
   issues) {
     super();
     this.ast = ast;
-    this.actual = actual;
     this.issues = issues;
   }
 }
@@ -587,10 +489,9 @@ export class AnyOf extends Base {
  * **Details**
  *
  * - `ast` is the `Union` AST node.
- * - `actual` is the raw input value (plain `unknown`).
  * - `successes` lists the AST nodes of each member that accepted the input.
  * - The default formatter renders this as
- *   `"Expected exactly one member to match the input <actual>"`.
+ *   `"Expected exactly one member to match"`.
  *
  * @see {@link AnyOf} — the opposite: *no* members matched
  *
@@ -603,10 +504,6 @@ export class OneOf extends Base {
    * The schema that caused the issue.
    */
   ast;
-  /**
-   * The input value that caused the issue.
-   */
-  actual;
   /**
    * The schemas that were successful.
    */
@@ -616,108 +513,48 @@ export class OneOf extends Base {
    * The schema that caused the issue.
    */
   ast,
-  /**
-   * The input value that caused the issue.
-   */
-  actual,
   /**
    * The schemas that were successful.
    */
   successes) {
     super();
     this.ast = ast;
-    this.actual = actual;
     this.successes = successes;
   }
 }
-/**
- * Extracts the actual input value from any {@link Issue} variant.
- *
- * **When to use**
- *
- * Use when you need to retrieve an `Issue`'s offending input value for logging
- * or custom error rendering.
- *
- * **Details**
- *
- * - Returns `Option.none()` for `Pointer` and `MissingKey` (they carry no
- *   value).
- * - Returns the existing `Option` for variants that already store `actual` as
- *   `Option<unknown>` (`InvalidType`, `InvalidValue`, `Forbidden`, `Encoding`,
- *   `Composite`).
- * - Wraps `actual` with `Option.some` for variants that store it as plain
- *   `unknown` (`AnyOf`, `UnexpectedKey`, `OneOf`, `Filter`).
- *
- * **Example** (Extracting the actual value)
- *
- * ```ts
- * import { Option, SchemaIssue } from "effect"
- *
- * const issue = new SchemaIssue.MissingKey(undefined)
- * console.log(SchemaIssue.getActual(issue))
- * // { _tag: "None" }
- * ```
- *
- * @see {@link Issue}
- * @see {@link isIssue}
- *
- * @category getters
- * @since 4.0.0
- */
-export function getActual(issue) {
-  switch (issue._tag) {
-    case "Pointer":
-    case "MissingKey":
-      return Option.none();
-    case "InvalidType":
-    case "InvalidValue":
-    case "Forbidden":
-    case "Encoding":
-    case "Composite":
-      return issue.actual;
-    case "AnyOf":
-    case "UnexpectedKey":
-    case "OneOf":
-    case "Filter":
-      return Option.some(issue.actual);
-  }
-}
-function makeFilterIssue(input, entry) {
+function makeFilterIssue(entry) {
   if (isIssue(entry)) {
     return entry;
   }
   if (typeof entry === "string") {
-    return new InvalidValue(Option.some(input), {
+    return new InvalidValue({
       message: entry
     });
   }
-  const inner = typeof entry.issue === "string" ? new InvalidValue(Option.some(input), {
+  const inner = typeof entry.issue === "string" ? new InvalidValue({
     message: entry.issue
   }) : entry.issue;
   return new Pointer(entry.path, inner);
 }
 /** @internal */
-export function makeSingle(input, out) {
+export function makeSingle(out) {
   if (out === undefined) {
     return undefined;
   }
   if (typeof out === "boolean") {
-    return out ? undefined : new InvalidValue(Option.some(input));
+    return out ? undefined : new InvalidValue();
   }
-  return makeFilterIssue(input, out);
+  return makeFilterIssue(out);
 }
 /** @internal */
-export function make(input, ast, out) {
+export function normalizeFilterOutput(ast, out) {
   if (Array.isArray(out)) {
-    if (Arr.isReadonlyArrayNonEmpty(out)) {
-      if (out.length === 1) {
-        return makeFilterIssue(input, out[0]);
-      }
-      return new Composite(ast, Option.some(input), Arr.map(out, entry => makeFilterIssue(input, entry)));
+    if (!Arr.isReadonlyArrayNonEmpty(out)) {
+      return undefined;
     }
-    return undefined;
+    return out.length === 1 ? makeFilterIssue(out[0]) : new Composite(ast, Arr.map(out, makeFilterIssue));
   }
-  return makeSingle(input, out);
+  return makeSingle(out);
 }
 /**
  * Returns the built-in {@link LeafHook} used by default formatters.
@@ -730,27 +567,28 @@ export function make(input, ast, out) {
  *
  * - Checks for a `message` annotation first; returns it if present.
  * - Otherwise generates a default message per `_tag`:
- *   - `InvalidType` → `"Expected <type>, got <actual>"`
- *   - `InvalidValue` → `"Invalid data <actual>"`
+ *   - `InvalidType` → `"Expected <type>"`
+ *   - `InvalidValue` → `"Expected a valid value"`
  *   - `MissingKey` → `"Missing key"`
- *   - `UnexpectedKey` → `"Unexpected key with value <actual>"`
+ *   - `UnexpectedKey` → `"Expected no excess property"`
  *   - `Forbidden` → `"Forbidden operation"`
- *   - `OneOf` → `"Expected exactly one member to match the input <actual>"`
+ *   - `OneOf` → `"Expected exactly one member to match"`
  *
  * **Example** (Formatting Standard Schema issues with defaultLeafHook)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { SchemaIssue } from "effect"
  *
  * const formatter = SchemaIssue.makeFormatterStandardSchemaV1({
  *   leafHook: SchemaIssue.defaultLeafHook
  * })
+ * formatter(new SchemaIssue.MissingKey(undefined)) // => { issues: [{ path: [], message: "Missing key" }] }
  * ```
  *
  * @see {@link LeafHook}
  * @see {@link makeFormatterStandardSchemaV1}
  *
- * @category Formatter
+ * @category formatting
  * @since 4.0.0
  */
 export const defaultLeafHook = issue => {
@@ -758,17 +596,17 @@ export const defaultLeafHook = issue => {
   if (message !== undefined) return message;
   switch (issue._tag) {
     case "InvalidType":
-      return getExpectedMessage(InternalAnnotations.getExpected(issue.ast), formatOption(issue.actual));
+      return getExpectedMessage(InternalAnnotations.getExpected(issue.ast));
     case "InvalidValue":
-      return `Invalid data ${formatOption(issue.actual)}`;
+      return "Expected a valid value";
     case "MissingKey":
       return "Missing key";
     case "UnexpectedKey":
-      return `Unexpected key with value ${format(issue.actual)}`;
+      return "Expected no excess property";
     case "Forbidden":
       return "Forbidden operation";
     case "OneOf":
-      return `Expected exactly one member to match the input ${format(issue.actual)}`;
+      return "Expected exactly one member to match";
   }
 };
 /**
@@ -783,12 +621,12 @@ export const defaultLeafHook = issue => {
  * - Looks for a `message` annotation on the inner issue first, then on the
  *   filter itself.
  * - Returns `undefined` when no annotation is found, causing the formatter to
- *   fall back to `"Expected <filter>, got <actual>"`.
+ *   fall back to `"Expected <filter>"`.
  *
  * @see {@link CheckHook}
  * @see {@link makeFormatterStandardSchemaV1}
  *
- * @category Formatter
+ * @category formatting
  * @since 4.0.0
  */
 export const defaultCheckHook = issue => {
@@ -813,17 +651,18 @@ export const defaultCheckHook = issue => {
  *
  * **Example** (Creating a Standard Schema V1 formatter)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { SchemaIssue } from "effect"
  *
  * const formatter = SchemaIssue.makeFormatterStandardSchemaV1()
+ * formatter(new SchemaIssue.MissingKey(undefined)).issues[0].message // => "Missing key"
  * ```
  *
  * @see {@link makeFormatterDefault} — produces a plain string instead
  * @see {@link LeafHook}
  * @see {@link CheckHook}
  *
- * @category Formatter
+ * @category formatting
  * @since 4.0.0
  */
 export function makeFormatterStandardSchemaV1(options) {
@@ -831,8 +670,8 @@ export function makeFormatterStandardSchemaV1(options) {
     issues: toDefaultIssues(issue, [], options?.leafHook ?? defaultLeafHook, options?.checkHook ?? defaultCheckHook)
   });
 }
-function getExpectedMessage(expected, actual) {
-  return `Expected ${expected}, got ${actual}`;
+function getExpectedMessage(expected) {
+  return `Expected ${expected}`;
 }
 function toDefaultIssues(issue, path, leafHook, checkHook) {
   switch (issue._tag) {
@@ -849,7 +688,7 @@ function toDefaultIssues(issue, path, leafHook, checkHook) {
           case "InvalidValue":
             return [{
               path,
-              message: getExpectedMessage(formatCheck(issue.filter), format(issue.actual))
+              message: getExpectedMessage(formatCheck(issue.filter))
             }];
           default:
             return toDefaultIssues(issue.issue, path, leafHook, checkHook);
@@ -863,16 +702,10 @@ function toDefaultIssues(issue, path, leafHook, checkHook) {
       return issue.issues.flatMap(issue => toDefaultIssues(issue, path, leafHook, checkHook));
     case "AnyOf":
       {
-        const message = findMessage(issue);
         if (issue.issues.length === 0) {
-          if (message !== undefined) return [{
-            path,
-            message
-          }];
-          const expected = getExpectedMessage(InternalAnnotations.getExpected(issue.ast), format(issue.actual));
           return [{
             path,
-            message: expected
+            message: findMessage(issue) ?? getExpectedMessage(InternalAnnotations.getExpected(issue.ast))
           }];
         }
         return issue.issues.flatMap(issue => toDefaultIssues(issue, path, leafHook, checkHook));
@@ -914,16 +747,17 @@ function formatCheck(check) {
  *
  * **Example** (Formatting an issue as a string)
  *
- * ```ts
+ * ```ts import.meta.vitest
  * import { SchemaIssue } from "effect"
  *
  * const formatter = SchemaIssue.makeFormatterDefault()
+ * formatter(new SchemaIssue.MissingKey(undefined)) // => "Missing key"
  * ```
  *
  * @see {@link makeFormatterStandardSchemaV1} — produces Standard Schema V1 format instead
  * @see {@link Formatter}
  *
- * @category Formatter
+ * @category formatting
  * @since 4.0.0
  */
 export function makeFormatterDefault() {
@@ -963,30 +797,4 @@ function getMessageAnnotation(annotations, type = "message") {
   const message = annotations?.[type];
   if (typeof message === "string") return message;
 }
-function formatOption(actual) {
-  if (Option.isNone(actual)) return "no value provided";
-  return format(actual.value);
-}
-/** @internal */
-export function redact(issue) {
-  switch (issue._tag) {
-    case "MissingKey":
-      return issue;
-    case "Forbidden":
-      return new Forbidden(Option.map(issue.actual, Redacted.make), issue.annotations);
-    case "Filter":
-      return new Filter(Redacted.make(issue.actual), issue.filter, redact(issue.issue));
-    case "Pointer":
-      return new Pointer(issue.path, redact(issue.issue));
-    case "Encoding":
-    case "InvalidType":
-    case "InvalidValue":
-    case "Composite":
-      return new InvalidValue(Option.map(issue.actual, Redacted.make));
-    case "AnyOf":
-    case "OneOf":
-    case "UnexpectedKey":
-      return new InvalidValue(Option.some(Redacted.make(issue.actual)));
-  }
-}
 //# sourceMappingURL=SchemaIssue.js.map