effect 4.0.0 → 4.0.2

package/src/SchemaIssue.ts

@@ -7,6 +7,7 @@
  * keys, invalid types, invalid values, failed filters, failed transformations,
  * and alternatives that did not match. This module also formats issues.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import * as Arr from "./Array.ts"
@@ -45,6 +46,7 @@ const TypeId = "~effect/SchemaIssue/Issue"
  *
  * @see {@link Issue}
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -78,6 +80,7 @@ export function isIssue(u: unknown): u is Issue {
  *
  * @see {@link Issue} for the complete issue model
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -101,6 +104,7 @@ export function hasInput(issue: Issue): issue is Issue & { readonly input: unkno
  * @see {@link Issue} — the full union including composite nodes
  * @see {@link LeafHook} — formatter hook that operates on `Leaf` values
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -136,6 +140,7 @@ export type Leaf =
  * @see {@link Leaf} — the terminal subset
  * @see {@link isIssue} — type guard
  * @see {@link hasInput} — checks whether an issue reports an input
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -208,6 +213,7 @@ class IssueNodeImpl implements IssueNode {
  * @see {@link Leaf} — terminal issue types that commonly appear as the inner `issue`
  * @see {@link CheckHook} — formatter hook for `Filter` issues
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -226,6 +232,7 @@ export interface Filter extends IssueNode {
 /**
  * Constructs a schema issue for a failed refinement check.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -299,6 +306,7 @@ export const Filter: new(
  * @see {@link Filter} — failure from a refinement check (not a transformation)
  * @see {@link Composite} — multiple issues from a single schema node
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -317,6 +325,7 @@ export interface Encoding extends IssueNode {
 /**
  * Constructs a schema issue for a failed transformation.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -378,6 +387,7 @@ export const Encoding: new(
  *
  * @see {@link Composite} — groups multiple issues under one schema node
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -396,6 +406,7 @@ export interface Pointer extends IssueNode {
 /**
  * Constructs a schema issue that points to a nested location.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -440,6 +451,7 @@ export const Pointer: new(path: ReadonlyArray<PropertyKey>, issue: Issue) => Poi
  * @see {@link Pointer} — wraps this issue with the missing key's path
  * @see {@link UnexpectedKey} — the opposite case (extra key present)
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -454,6 +466,7 @@ export interface MissingKey extends IssueNode {
 /**
  * Constructs a schema issue for a missing key or tuple index.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -496,6 +509,7 @@ export const MissingKey: new(annotations: Schema.Annotations.Key<unknown> | unde
  * @see {@link MissingKey} — the opposite case (required key absent)
  * @see {@link Pointer} — wraps this issue with the unexpected key's path
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -510,6 +524,7 @@ export interface UnexpectedKey extends IssueNode {
 /**
  * Constructs a schema issue for an unexpected key or tuple index.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -559,6 +574,7 @@ export const UnexpectedKey: new(
  * @see {@link AnyOf} — used for union no-match errors (similar but different semantics)
  * @see {@link Pointer} — adds path context to individual issues
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -577,6 +593,7 @@ export interface Composite extends IssueNode {
 /**
  * Constructs a schema issue that groups multiple child issues.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -648,6 +665,7 @@ export const Composite: new(
  *
  * @see {@link InvalidValue} — the input has the right type but fails a value constraint
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -662,6 +680,7 @@ export interface InvalidType extends IssueNode {
 /**
  * Constructs a schema issue for an input with an invalid runtime type.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -727,6 +746,7 @@ export const InvalidType: new(
  * @see {@link InvalidType} — the input has the wrong type entirely
  * @see {@link Filter} — composite wrapper when a schema filter produces this issue
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -741,6 +761,7 @@ export interface InvalidValue extends IssueNode {
 /**
  * Constructs a schema issue for a value that violates a constraint.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -819,6 +840,7 @@ export function makeCompositeAtKey(
  *
  * @see {@link InvalidValue} — for value-constraint failures (not operation failures)
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -833,6 +855,7 @@ export interface Forbidden extends IssueNode {
 /**
  * Constructs a schema issue for a forbidden parsing operation.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -889,6 +912,7 @@ export const Forbidden: new(
  * @see {@link OneOf} — the opposite: *too many* members matched
  * @see {@link Composite} — groups multiple issues under a non-union schema
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -907,6 +931,7 @@ export interface AnyOf extends IssueNode {
 /**
  * Constructs a schema issue for a value that matches no union member.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -971,6 +996,7 @@ export const AnyOf: new(
  *
  * @see {@link AnyOf} — the opposite: *no* members matched
  *
+ * @stability stable
  * @category models
  * @since 4.0.0
  */
@@ -989,6 +1015,7 @@ export interface OneOf extends IssueNode {
 /**
  * Constructs a schema issue for a value that matches multiple union members.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -1091,6 +1118,7 @@ export function normalizeFilterOutput(
  * @see {@link makeFormatterDefault} — creates a `Formatter<string>`
  * @see {@link makeFormatterStandardSchemaV1} — creates a `Formatter<StandardSchemaV1.FailureResult>`
  *
+ * @stability stable
  * @category formatting
  * @since 4.0.0
  */
@@ -1107,6 +1135,7 @@ export interface Formatter<out Format> extends FormatterI<Issue, Format> {}
  * @see {@link defaultLeafHook} — the built-in implementation
  * @see {@link Leaf} — the union of terminal issue types
  *
+ * @stability stable
  * @category formatting
  * @since 4.0.0
  */
@@ -1149,6 +1178,7 @@ export type LeafHook = (issue: Leaf) => string
  * @see {@link LeafHook}
  * @see {@link makeFormatterStandardSchemaV1}
  *
+ * @stability stable
  * @category formatting
  * @since 4.0.0
  */
@@ -1197,6 +1227,7 @@ export const defaultLeafHook: LeafHook = (issue): string => {
  * @see {@link defaultCheckHook} — the built-in implementation
  * @see {@link Filter} — the issue type this hook formats
  *
+ * @stability stable
  * @category formatting
  * @since 4.0.0
  */
@@ -1220,6 +1251,7 @@ export type CheckHook = (issue: Filter) => string | undefined
  * @see {@link CheckHook}
  * @see {@link makeFormatterStandardSchemaV1}
  *
+ * @stability stable
  * @category formatting
  * @since 4.0.0
  */
@@ -1264,6 +1296,7 @@ export const defaultCheckHook: CheckHook = (issue): string | undefined => findMe
  * @see {@link LeafHook}
  * @see {@link CheckHook}
  *
+ * @stability stable
  * @category formatting
  * @since 4.0.0
  */
@@ -1387,6 +1420,7 @@ function formatCheck<T>(check: SchemaAST.Check<T>): string {
  * @see {@link makeFormatterStandardSchemaV1} — produces Standard Schema V1 format instead
  * @see {@link Formatter}
  *
+ * @stability stable
  * @category formatting
  * @since 4.0.0
  */

package/src/SchemaParser.ts

@@ -8,6 +8,7 @@
  * synchronous functions that throw. It also contains the lower-level runner that
  * walks a schema AST and reports schema failures as `SchemaIssue.Issue` values.
  *
+ * @stability stable
  * @since 4.0.0
  */
 import * as Cause from "./Cause.ts"
@@ -37,6 +38,7 @@ import * as SchemaIssue from "./SchemaIssue.ts"
  * runs type-side validation unless checks are disabled, and fails with a
  * `SchemaIssue.Issue` when construction fails.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -68,6 +70,7 @@ export function makeEffect<S extends Schema.Constraint>(schema: S) {
  * Causes that contain defects, interruptions, or asynchronous work at this
  * synchronous boundary throw an `Error` whose cause is the underlying `Cause`.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -105,6 +108,7 @@ export function makeOption<S extends Schema.Constraint>(schema: S) {
  * synchronous boundary throw an `Error` whose cause is the underlying `Cause`,
  * instead of being converted to a schema validation error.
  *
+ * @stability stable
  * @category constructors
  * @since 4.0.0
  */
@@ -132,6 +136,7 @@ export function make<S extends Schema.Constraint>(schema: S) {
  * that contain defects, interruptions, or asynchronous work at this synchronous
  * boundary throw an `Error` whose cause is the underlying `Cause`.
  *
+ * @stability stable
  * @category guards
  * @since 3.10.0
  */
@@ -223,6 +228,7 @@ export function _issue<T>(ast: SchemaAST.AST) {
  * synchronous boundary throw an `Error` whose cause is the underlying `Cause`,
  * instead of being converted to a schema validation error.
  *
+ * @stability stable
  * @category guards
  * @since 4.0.0
  */
@@ -257,6 +263,7 @@ export function asserts<S extends Schema.Constraint, I>(schema: S, input: I): as
  *
  * @see {@link decodeEffect} for input already typed as the schema's `Encoded` type
  *
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -292,6 +299,7 @@ export function decodeUnknownEffect<S extends Schema.Constraint>(
  * @see {@link decodeUnknownEffect} for untyped boundary input
  * @see {@link encodeEffect} for the opposite direction
  *
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -327,6 +335,7 @@ export const decodeEffect: <S extends Schema.Constraint>(
  * @see {@link decodePromise} for input already typed as the schema's `Encoded` type
  * @see {@link decodeUnknownEffect} for schemas that require decoding services or when failures should remain in `Effect`
  *
+ * @stability stable
  * @category decoding
  * @since 3.10.0
  */
@@ -362,6 +371,7 @@ export function decodeUnknownPromise<S extends Schema.ConstraintDecoder<unknown>
  * @see {@link decodeUnknownPromise} for untyped input returning a JavaScript `Promise`
  * @see {@link decodeEffect} for preserving decoding services and failures in `Effect`
  *
+ * @stability stable
  * @category decoding
  * @since 3.10.0
  */
@@ -398,6 +408,7 @@ export function decodePromise<S extends Schema.ConstraintDecoder<unknown>>(
  * @see {@link decodeUnknownResult} for returning schema issues as data
  * @see {@link decodeUnknownSync} for throwing on decoding failure
  *
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -431,6 +442,7 @@ export function decodeUnknownExit<S extends Schema.ConstraintDecoder<unknown>>(
  * @see {@link decodeUnknownExit} for untyped input with the same `Exit` result shape
  * @see {@link decodeEffect} for preserving decoding services and failures in `Effect`
  *
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -477,6 +489,7 @@ export const decodeOption: <S extends Schema.ConstraintDecoder<unknown>>(
  * @see {@link decodeResult} for input already typed as the schema's `Encoded` type
  * @see {@link decodeUnknownEffect} for effectful or service-requiring decoding
  *
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -510,6 +523,7 @@ export function decodeUnknownResult<S extends Schema.ConstraintDecoder<unknown>>
  * @see {@link decodeUnknownResult} for untyped input with the same `Result` shape
  * @see {@link decodeEffect} for effectful or service-requiring decoding
  *
+ * @stability stable
  * @category decoding
  * @since 4.0.0
  */
@@ -545,6 +559,7 @@ export const decodeResult: <S extends Schema.ConstraintDecoder<unknown>>(
  * @see {@link decodeUnknownEffect} for preserving decoding failures in `Effect`
  * @see {@link decodeUnknownResult} for returning schema issues as data
  *
+ * @stability stable
  * @category decoding
  * @since 3.10.0
  */
@@ -584,6 +599,7 @@ export function decodeUnknownSync<S extends Schema.ConstraintDecoder<unknown>>(
  * @see {@link decodeResult} for returning schema issues as data
  * @see {@link decodeEffect} for preserving decoding failures in `Effect`
  *
+ * @stability stable
  * @category decoding
  * @since 3.10.0
  */
@@ -610,6 +626,7 @@ export const decodeSync: <S extends Schema.ConstraintDecoder<unknown>>(
  *
  * @see {@link encodeEffect} for the typed-input variant when the value is already typed as the schema's decoded `Type`
  *
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -644,6 +661,7 @@ export function encodeUnknownEffect<S extends Schema.Constraint>(
  *
  * @see {@link encodeUnknownEffect} for encoding unknown input before the value is statically typed as the schema's `Type`
  *
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -679,6 +697,7 @@ export const encodeEffect: <S extends Schema.Constraint>(
  * @see {@link encodePromise} for input already typed as the schema's decoded `Type`
  * @see {@link encodeUnknownEffect} for schemas that require encoding services or when failures should remain in `Effect`
  *
+ * @stability stable
  * @category encoding
  * @since 3.10.0
  */
@@ -713,6 +732,7 @@ export const encodeUnknownPromise = <S extends Schema.ConstraintEncoder<unknown>
  * @see {@link encodeUnknownPromise} for encoding untyped input
  * @see {@link encodeEffect} for effectful encoding or schemas with encoding service requirements
  *
+ * @stability stable
  * @category encoding
  * @since 3.10.0
  */
@@ -744,6 +764,7 @@ export const encodePromise: <S extends Schema.ConstraintEncoder<unknown>>(
  * @see {@link encodeExit} for input already typed as the schema's decoded `Type`
  * @see {@link encodeUnknownEffect} for effectful encoding that preserves service requirements
  *
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -777,6 +798,7 @@ export function encodeUnknownExit<S extends Schema.ConstraintEncoder<unknown>>(
  * @see {@link encodeUnknownExit} for unknown input with the same `Exit` result shape
  * @see {@link encodeEffect} for effectful encoding that preserves service requirements
  *
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -825,6 +847,7 @@ export const encodeOption: <S extends Schema.ConstraintEncoder<unknown>>(
  * @see {@link encodeResult} for input already typed as the schema's decoded `Type`
  * @see {@link encodeUnknownEffect} for effectful encoding, including schemas with encoding service requirements
  *
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -858,6 +881,7 @@ export function encodeUnknownResult<S extends Schema.ConstraintEncoder<unknown>>
  *
  * @see {@link encodeUnknownResult} for the same `Result` shape when the input is not already typed
  *
+ * @stability stable
  * @category encoding
  * @since 4.0.0
  */
@@ -892,6 +916,7 @@ export const encodeResult: <S extends Schema.ConstraintEncoder<unknown>>(
  * @see {@link encodeSync} for input already typed as the schema's decoded `Type`
  * @see {@link encodeUnknownEffect} for effectful encoding that preserves service requirements
  *
+ * @stability stable
  * @category encoding
  * @since 3.10.0
  */
@@ -931,6 +956,7 @@ export function encodeUnknownSync<S extends Schema.ConstraintEncoder<unknown>>(
  * @see {@link encodeResult} for returning schema issues as data
  * @see {@link encodeEffect} for effectful encoding that preserves service requirements
  *
+ * @stability stable
  * @category encoding
  * @since 3.10.0
  */