effect 4.0.0-beta.0 → 4.0.0-beta.10

package/dist/Schema.d.ts

@@ -1,7 +1,9 @@
 /**
  * @since 4.0.0
  */
+/** @effect-diagnostics schemaStructWithTag:skip-file */
 import type { StandardJSONSchemaV1, StandardSchemaV1 } from "@standard-schema/spec";
+import * as BigDecimal_ from "./BigDecimal.ts";
 import type * as Brand from "./Brand.ts";
 import * as Cause_ from "./Cause.ts";
 import type * as Combiner from "./Combiner.ts";
@@ -12,6 +14,8 @@ import * as Effect from "./Effect.ts";
 import * as Equivalence from "./Equivalence.ts";
 import * as Exit_ from "./Exit.ts";
 import type { Formatter } from "./Formatter.ts";
+import * as HashMap_ from "./HashMap.ts";
+import * as HashSet_ from "./HashSet.ts";
 import * as JsonPatch from "./JsonPatch.ts";
 import * as JsonSchema from "./JsonSchema.ts";
 import * as Optic_ from "./Optic.ts";
@@ -181,7 +185,7 @@ export declare namespace Schema {
     /**
      * @since 4.0.0
      */
-    type Type<S extends Top> = S["Type"];
+    type Type<S> = S extends Top ? S["Type"] : never;
 }
 /**
  * A typed view of a schema that tracks the decoded (output) type `T`.
@@ -207,15 +211,15 @@ export declare namespace Codec {
     /**
      * @since 4.0.0
      */
-    type Encoded<S extends Top> = S["Encoded"];
+    type Encoded<S> = S extends Top ? S["Encoded"] : never;
     /**
      * @since 4.0.0
      */
-    type DecodingServices<S extends Top> = S["DecodingServices"];
+    type DecodingServices<S> = S extends Top ? S["DecodingServices"] : never;
     /**
      * @since 4.0.0
      */
-    type EncodingServices<S extends Top> = S["EncodingServices"];
+    type EncodingServices<S> = S extends Top ? S["EncodingServices"] : never;
     /**
      * @since 4.0.0
      */
@@ -568,21 +572,7 @@ export declare const encodeUnknownSync: typeof Parser.encodeUnknownSync;
  */
 export declare const encodeSync: <S extends Top & {
     readonly EncodingServices: never;
-}>(schema: S) => (input: S["Type"], options
-/**
- * The top (most general) type for all schema-like values in this module.
- *
- * When to use:
- * - You are writing generic helpers and only need "some schema", without caring about its `Type` / `Encoded`.
- * - You need a common constraint for type-level utilities (for example in `Schema.Type` or `Codec.Encoded`).
- *
- * Behavior:
- * - This is a *type-level* supertype; it does not represent a specific concrete schema.
- * - In user code, you usually want {@link Schema}, {@link Codec}, {@link Decoder}, or {@link Encoder} instead.
- *
- * @since 4.0.0
- */
-?: AST.ParseOptions) => S["Encoded"];
+}>(schema: S) => (input: S["Type"], options?: AST.ParseOptions) => S["Encoded"];
 /**
  * Creates a schema from an AST (Abstract Syntax Tree) node.
  *
@@ -1183,10 +1173,6 @@ export declare namespace Record {
         readonly "~type.make": PropertyKey;
         readonly "Iso": PropertyKey;
     }
-    /**
-     * @since 4.0.0
-     */
-    type Record = Record$<Record.Key, Top>;
     /**
      * @since 4.0.0
      */
@@ -1271,7 +1257,7 @@ export declare namespace Record {
 /**
  * @since 4.0.0
  */
-export interface Record$<Key extends Record.Key, Value extends Top> extends Bottom<Record.Type<Key, Value>, Record.Encoded<Key, Value>, Record.DecodingServices<Key, Value>, Record.EncodingServices<Key, Value>, AST.Objects, Record$<Key, Value>, Simplify<Record.MakeIn<Key, Value>>, Record.Iso<Key, Value>> {
+export interface $Record<Key extends Record.Key, Value extends Top> extends Bottom<Record.Type<Key, Value>, Record.Encoded<Key, Value>, Record.DecodingServices<Key, Value>, Record.EncodingServices<Key, Value>, AST.Objects, $Record<Key, Value>, Simplify<Record.MakeIn<Key, Value>>, Record.Iso<Key, Value>> {
     readonly "~rebuild.out": this;
     readonly key: Key;
     readonly value: Value;
@@ -1284,7 +1270,7 @@ export declare function Record<Key extends Record.Key, Value extends Top>(key: K
         readonly decode?: Combiner.Combiner<readonly [Key["Type"], Value["Type"]]> | undefined;
         readonly encode?: Combiner.Combiner<readonly [Key["Encoded"], Value["Encoded"]]> | undefined;
     };
-}): Record$<Key, Value>;
+}): $Record<Key, Value>;
 /**
  * @since 4.0.0
  */
@@ -1298,7 +1284,7 @@ export declare namespace StructWithRest {
     /**
      * @since 4.0.0
      */
-    type Records = ReadonlyArray<Record.Record>;
+    type Records = ReadonlyArray<$Record<Record.Key, Top>>;
     type MergeTuple<T extends ReadonlyArray<unknown>> = T extends readonly [infer Head, ...infer Tail] ? Head & MergeTuple<Tail> : {};
     /**
      * @since 4.0.0
@@ -1508,13 +1494,13 @@ export declare function TupleWithRest<S extends Tuple<Tuple.Elements>, const Res
 /**
  * @since 4.0.0
  */
-export interface Array$<S extends Top> extends Bottom<ReadonlyArray<S["Type"]>, ReadonlyArray<S["Encoded"]>, S["DecodingServices"], S["EncodingServices"], AST.Arrays, Array$<S>, ReadonlyArray<S["~type.make"]>, ReadonlyArray<S["Iso"]>> {
+export interface $Array<S extends Top> extends Bottom<ReadonlyArray<S["Type"]>, ReadonlyArray<S["Encoded"]>, S["DecodingServices"], S["EncodingServices"], AST.Arrays, $Array<S>, ReadonlyArray<S["~type.make"]>, ReadonlyArray<S["Iso"]>> {
     readonly "~rebuild.out": this;
     readonly schema: S;
 }
 interface ArrayLambda extends Lambda {
-    <S extends Top>(self: S): Array$<S>;
-    readonly "~lambda.out": this["~lambda.in"] extends Top ? Array$<this["~lambda.in"]> : never;
+    <S extends Top>(self: S): $Array<S>;
+    readonly "~lambda.out": this["~lambda.in"] extends Top ? $Array<this["~lambda.in"]> : never;
 }
 /**
  * @category Constructors
@@ -1540,7 +1526,7 @@ export declare const NonEmptyArray: NonEmptyArrayLambda;
 /**
  * @since 4.0.0
  */
-export interface UniqueArray<S extends Top> extends Array$<S> {
+export interface UniqueArray<S extends Top> extends $Array<S> {
 }
 /**
  * Returns a new array schema that ensures all elements are unique.
@@ -2101,12 +2087,12 @@ export interface TaggedUnion<Cases extends Record<string, Top>> extends Bottom<{
         [K in keyof Cases]: (u: unknown) => u is Cases[K]["Type"];
     };
     readonly match: {
-        <Output>(value: Cases[keyof Cases]["Type"], cases: {
-            [K in keyof Cases]: (value: Cases[K]["Type"]) => Output;
-        }): Output;
         <Output>(cases: {
             [K in keyof Cases]: (value: Cases[K]["Type"]) => Output;
         }): (value: Cases[keyof Cases]["Type"]) => Output;
+        <Output>(value: Cases[keyof Cases]["Type"], cases: {
+            [K in keyof Cases]: (value: Cases[K]["Type"]) => Output;
+        }): Output;
     };
 }
 /**
@@ -2856,6 +2842,48 @@ export declare const isBetweenBigInt: (options: {
     readonly exclusiveMinimum?: boolean | undefined;
     readonly exclusiveMaximum?: boolean | undefined;
 }, annotations?: Annotations.Filter) => AST.Filter<bigint>;
+/**
+ * Validates that a BigDecimal is greater than the specified value (exclusive).
+ *
+ * @category BigDecimal checks
+ * @since 4.0.0
+ */
+export declare const isGreaterThanBigDecimal: (exclusiveMinimum: BigDecimal_.BigDecimal, annotations?: Annotations.Filter) => AST.Filter<BigDecimal_.BigDecimal>;
+/**
+ * Validates that a BigDecimal is greater than or equal to the specified value
+ * (inclusive).
+ *
+ * @category BigDecimal checks
+ * @since 4.0.0
+ */
+export declare const isGreaterThanOrEqualToBigDecimal: (minimum: BigDecimal_.BigDecimal, annotations?: Annotations.Filter) => AST.Filter<BigDecimal_.BigDecimal>;
+/**
+ * Validates that a BigDecimal is less than the specified value (exclusive).
+ *
+ * @category BigDecimal checks
+ * @since 4.0.0
+ */
+export declare const isLessThanBigDecimal: (exclusiveMaximum: BigDecimal_.BigDecimal, annotations?: Annotations.Filter) => AST.Filter<BigDecimal_.BigDecimal>;
+/**
+ * Validates that a BigDecimal is less than or equal to the specified value
+ * (inclusive).
+ *
+ * @category BigDecimal checks
+ * @since 4.0.0
+ */
+export declare const isLessThanOrEqualToBigDecimal: (maximum: BigDecimal_.BigDecimal, annotations?: Annotations.Filter) => AST.Filter<BigDecimal_.BigDecimal>;
+/**
+ * Validates that a BigDecimal is within a specified range.
+ *
+ * @category BigDecimal checks
+ * @since 4.0.0
+ */
+export declare const isBetweenBigDecimal: (options: {
+    readonly minimum: BigDecimal_.BigDecimal;
+    readonly maximum: BigDecimal_.BigDecimal;
+    readonly exclusiveMinimum?: boolean | undefined;
+    readonly exclusiveMaximum?: boolean | undefined;
+}, annotations?: Annotations.Filter) => AST.Filter<BigDecimal_.BigDecimal>;
 /**
  * Validates that a value has at least the specified length. Works with strings
  * and arrays.
@@ -3262,18 +3290,18 @@ export declare function RedactedFromValue<S extends Top>(value: S, options?: {
     readonly label?: string | undefined;
 }): RedactedFromValue<S>;
 /**
- * @category CauseFailure
+ * @category CauseReason
  * @since 4.0.0
  */
-export interface CauseFailure<E extends Top, D extends Top> extends declareConstructor<Cause_.Reason<E["Type"]>, Cause_.Reason<E["Encoded"]>, readonly [E, D], CauseFailureIso<E, D>> {
+export interface CauseReason<E extends Top, D extends Top> extends declareConstructor<Cause_.Reason<E["Type"]>, Cause_.Reason<E["Encoded"]>, readonly [E, D], CauseReasonIso<E, D>> {
     readonly error: E;
     readonly defect: D;
 }
 /**
- * @category CauseFailure
+ * @category CauseReason
  * @since 4.0.0
  */
-export type CauseFailureIso<E extends Top, D extends Top> = {
+export type CauseReasonIso<E extends Top, D extends Top> = {
     readonly _tag: "Fail";
     readonly error: E["Iso"];
 } | {
@@ -3284,10 +3312,10 @@ export type CauseFailureIso<E extends Top, D extends Top> = {
     readonly fiberId: number | undefined;
 };
 /**
- * @category CauseFailure
+ * @category CauseReason
  * @since 4.0.0
  */
-export declare function CauseFailure<E extends Top, D extends Top>(error: E, defect: D): CauseFailure<E, D>;
+export declare function CauseReason<E extends Top, D extends Top>(error: E, defect: D): CauseReason<E, D>;
 /**
  * @category Cause
  * @since 4.0.0
@@ -3300,7 +3328,7 @@ export interface Cause<E extends Top, D extends Top> extends declareConstructor<
  * @category Cause
  * @since 4.0.0
  */
-export type CauseIso<E extends Top, D extends Top> = ReadonlyArray<CauseFailureIso<E, D>>;
+export type CauseIso<E extends Top, D extends Top> = ReadonlyArray<CauseReasonIso<E, D>>;
 /**
  * @category Cause
  * @since 4.0.0
@@ -3387,7 +3415,7 @@ export declare function Exit<A extends Top, E extends Top, D extends Top>(value:
  * @category ReadonlyMap
  * @since 4.0.0
  */
-export interface ReadonlyMap$<Key extends Top, Value extends Top> extends declareConstructor<globalThis.ReadonlyMap<Key["Type"], Value["Type"]>, globalThis.ReadonlyMap<Key["Encoded"], Value["Encoded"]>, readonly [Key, Value], ReadonlyMapIso<Key, Value>> {
+export interface $ReadonlyMap<Key extends Top, Value extends Top> extends declareConstructor<globalThis.ReadonlyMap<Key["Type"], Value["Type"]>, globalThis.ReadonlyMap<Key["Encoded"], Value["Encoded"]>, readonly [Key, Value], ReadonlyMapIso<Key, Value>> {
     readonly key: Key;
     readonly value: Value;
 }
@@ -3403,12 +3431,33 @@ export type ReadonlyMapIso<Key extends Top, Value extends Top> = ReadonlyArray<r
  * @category ReadonlyMap
  * @since 4.0.0
  */
-export declare function ReadonlyMap<Key extends Top, Value extends Top>(key: Key, value: Value): ReadonlyMap$<Key, Value>;
+export declare function ReadonlyMap<Key extends Top, Value extends Top>(key: Key, value: Value): $ReadonlyMap<Key, Value>;
+/**
+ * @category HashMap
+ * @since 4.0.0
+ */
+export interface HashMap<Key extends Top, Value extends Top> extends declareConstructor<HashMap_.HashMap<Key["Type"], Value["Type"]>, HashMap_.HashMap<Key["Encoded"], Value["Encoded"]>, readonly [Key, Value], HashMapIso<Key, Value>> {
+    readonly key: Key;
+    readonly value: Value;
+}
+/**
+ * @category HashMap
+ * @since 4.0.0
+ */
+export type HashMapIso<Key extends Top, Value extends Top> = ReadonlyArray<readonly [Key["Iso"], Value["Iso"]]>;
+/**
+ * Creates a schema that validates a `HashMap` where keys and values must
+ * conform to the provided schemas.
+ *
+ * @category HashMap
+ * @since 4.0.0
+ */
+export declare function HashMap<Key extends Top, Value extends Top>(key: Key, value: Value): HashMap<Key, Value>;
 /**
  * @category ReadonlySet
  * @since 4.0.0
  */
-export interface ReadonlySet$<Value extends Top> extends declareConstructor<globalThis.ReadonlySet<Value["Type"]>, globalThis.ReadonlySet<Value["Encoded"]>, readonly [Value], ReadonlySetIso<Value>> {
+export interface $ReadonlySet<Value extends Top> extends declareConstructor<globalThis.ReadonlySet<Value["Type"]>, globalThis.ReadonlySet<Value["Encoded"]>, readonly [Value], ReadonlySetIso<Value>> {
     readonly value: Value;
 }
 /**
@@ -3420,7 +3469,27 @@ export type ReadonlySetIso<Value extends Top> = ReadonlyArray<Value["Iso"]>;
  * @category ReadonlySet
  * @since 4.0.0
  */
-export declare function ReadonlySet<Value extends Top>(value: Value): ReadonlySet$<Value>;
+export declare function ReadonlySet<Value extends Top>(value: Value): $ReadonlySet<Value>;
+/**
+ * @category HashSet
+ * @since 4.0.0
+ */
+export interface HashSet<Value extends Top> extends declareConstructor<HashSet_.HashSet<Value["Type"]>, HashSet_.HashSet<Value["Encoded"]>, readonly [Value], HashSetIso<Value>> {
+    readonly value: Value;
+}
+/**
+ * @category HashSet
+ * @since 4.0.0
+ */
+export type HashSetIso<Value extends Top> = ReadonlyArray<Value["Iso"]>;
+/**
+ * Creates a schema that validates a `HashSet` where values must conform to the
+ * provided schema.
+ *
+ * @category HashSet
+ * @since 4.0.0
+ */
+export declare function HashSet<Value extends Top>(value: Value): HashSet<Value>;
 /**
  * @since 4.0.0
  */
@@ -3548,6 +3617,21 @@ export interface DurationFromMillis extends decodeTo<Duration, Number> {
  * @since 4.0.0
  */
 export declare const DurationFromMillis: DurationFromMillis;
+/**
+ * @since 4.0.0
+ */
+export interface BigDecimal extends declare<BigDecimal_.BigDecimal> {
+}
+/**
+ * A schema for `BigDecimal` values.
+ *
+ * **Default JSON serializer**
+ *
+ * - encodes `BigDecimal` as a `string`
+ *
+ * @since 4.0.0
+ */
+export declare const BigDecimal: BigDecimal;
 /**
  * @since 4.0.0
  */
@@ -3934,9 +4018,9 @@ export declare const PropertyKey: Union<readonly [Finite, Symbol, String]>;
  * @since 4.0.0
  */
 export declare const StandardSchemaV1FailureResult: Struct<{
-    readonly issues: Array$<Struct<{
+    readonly issues: $Array<Struct<{
         readonly message: String;
-        readonly path: optional<Array$<Union<readonly [Union<readonly [Finite, Symbol, String]>, Struct<{
+        readonly path: optional<$Array<Union<readonly [Union<readonly [Finite, Symbol, String]>, Struct<{
             readonly key: Union<readonly [Finite, Symbol, String]>;
         }>]>>>;
     }>>;
@@ -4098,13 +4182,79 @@ export interface DateTimeUtcFromMillis extends decodeTo<instanceOf<DateTime.Utc>
  * @since 4.0.0
  */
 export declare const DateTimeUtcFromMillis: DateTimeUtcFromMillis;
+/**
+ * @since 4.0.0
+ */
+export interface TimeZoneOffset extends declare<DateTime.TimeZone.Offset> {
+}
+/**
+ * A schema for `DateTime.TimeZone.Offset` values.
+ *
+ * **Default JSON serializer**
+ *
+ * - encodes `DateTime.TimeZone.Offset` as a number (offset in milliseconds)
+ *
+ * @category DateTime
+ * @since 4.0.0
+ */
+export declare const TimeZoneOffset: TimeZoneOffset;
+/**
+ * @since 4.0.0
+ */
+export interface TimeZoneNamed extends declare<DateTime.TimeZone.Named> {
+}
+/**
+ * A schema for `DateTime.TimeZone.Named` values.
+ *
+ * **Default JSON serializer**
+ *
+ * - encodes `DateTime.TimeZone.Named` as a string (IANA time zone identifier)
+ *
+ * @category DateTime
+ * @since 4.0.0
+ */
+export declare const TimeZoneNamed: TimeZoneNamed;
+/**
+ * @since 4.0.0
+ */
+export interface TimeZone extends declare<DateTime.TimeZone> {
+}
+/**
+ * A schema for `DateTime.TimeZone` values.
+ *
+ * **Default JSON serializer**
+ *
+ * - encodes `DateTime.TimeZone` as a string (IANA identifier or offset like
+ *   `+03:00`)
+ *
+ * @category DateTime
+ * @since 4.0.0
+ */
+export declare const TimeZone: TimeZone;
+/**
+ * @since 4.0.0
+ */
+export interface DateTimeZoned extends declare<DateTime.Zoned> {
+}
+/**
+ * A schema for `DateTime.Zoned` values.
+ *
+ * **Default JSON serializer**
+ *
+ * - encodes `DateTime.Zoned` as a string in the format
+ *   `YYYY-MM-DDTHH:mm:ss.sss+HH:MM[Time/Zone]`
+ *
+ * @category DateTime
+ * @since 4.0.0
+ */
+export declare const DateTimeZoned: DateTimeZoned;
 /**
  * @since 4.0.0
  */
 export interface Class<Self, S extends Top & {
     readonly fields: Struct.Fields;
 }, Inherited> extends Bottom<Self, S["Encoded"], S["DecodingServices"], S["EncodingServices"], AST.Declaration, decodeTo<declareConstructor<Self, S["Encoded"], readonly [S], S["Iso"]>, S>, S["~type.make.in"], S["Iso"], readonly [S], Self, S["~type.mutability"], S["~type.optionality"], S["~type.constructor.default"], S["~encoded.mutability"], S["~encoded.optionality"]> {
-    new (props: S["~type.make.in"], options?: MakeOptions): S["Type"] & Inherited;
+    new (...args: {} extends S["~type.make.in"] ? [props?: S["~type.make.in"], options?: MakeOptions] : [props: S["~type.make.in"], options?: MakeOptions]): S["Type"] & Inherited;
     readonly identifier: string;
     readonly fields: S["fields"];
     /**
@@ -4429,7 +4579,7 @@ export interface TreeObject<A> {
  * @category Tree
  * @since 4.0.0
  */
-export declare function Tree<S extends Top>(node: S): Union<readonly [S, Array$<suspend<Codec<Tree<S["Type"]>, Tree<S["Encoded"]>, S["DecodingServices"], S["EncodingServices"]>>>, Record$<String, suspend<Codec<Tree<S["Type"]>, Tree<S["Encoded"]>, S["DecodingServices"], S["EncodingServices"]>>>]>;
+export declare function Tree<S extends Top>(node: S): Union<readonly [S, $Array<suspend<Codec<Tree<S["Type"]>, Tree<S["Encoded"]>, S["DecodingServices"], S["EncodingServices"]>>>, $Record<String, suspend<Codec<Tree<S["Type"]>, Tree<S["Encoded"]>, S["DecodingServices"], S["EncodingServices"]>>>]>;
 /**
  * @category Tree
  * @since 4.0.0
@@ -4446,7 +4596,7 @@ export interface MutableTreeRecord<A> {
  * @category Tree
  * @since 4.0.0
  */
-export declare function MutableTree<S extends Top>(node: S): Union<readonly [S, mutable<Array$<suspend<Codec<MutableTree<S["Type"]>, MutableTree<S["Encoded"]>, S["DecodingServices"], S["EncodingServices"]>>>>, Record$<String, mutableKey<suspend<Codec<MutableTree<S["Type"]>, MutableTree<S["Encoded"]>, S["DecodingServices"], S["EncodingServices"]>>>>]>;
+export declare function MutableTree<S extends Top>(node: S): Union<readonly [S, mutable<$Array<suspend<Codec<MutableTree<S["Type"]>, MutableTree<S["Encoded"]>, S["DecodingServices"], S["EncodingServices"]>>>>, $Record<String, mutableKey<suspend<Codec<MutableTree<S["Type"]>, MutableTree<S["Encoded"]>, S["DecodingServices"], S["EncodingServices"]>>>>]>;
 /**
  * @category JSON
  * @since 4.0.0