effect 4.0.2 → 4.0.4

package/dist/Schema.d.ts

@@ -30,9 +30,12 @@ import * as HashSet_ from "./HashSet.ts";
 import * as Cookies_ from "./http/Cookies.ts";
 import * as Headers_ from "./http/Headers.ts";
 import * as UrlParams_ from "./http/UrlParams.ts";
+import { NodeInspectSymbol } from "./Inspectable.ts";
 import { SchemaErrorTypeId } from "./internal/schemaError.ts";
 import type * as JsonPatch from "./JsonPatch.ts";
 import type * as JsonSchema from "./JsonSchema.ts";
+import * as Dns_ from "./net/Dns.ts";
+import * as Host_ from "./net/Host.ts";
 import * as IpInterface_ from "./net/IpInterface.ts";
 import * as IpNetwork_ from "./net/IpNetwork.ts";
 import * as NetAddress_ from "./net/NetAddress.ts";
@@ -984,6 +987,14 @@ export declare class SchemaError extends SchemaError_base<{
     readonly [SchemaErrorTypeId]: typeof SchemaErrorTypeId;
     constructor(issue: SchemaIssue.Issue);
     get message(): string;
+    toJSON(): {
+        _tag: "SchemaError";
+        message: string;
+    };
+    [NodeInspectSymbol](): {
+        _tag: "SchemaError";
+        message: string;
+    };
     toString(): string;
 }
 /**
@@ -3346,6 +3357,7 @@ export declare namespace StructWithRest {
      */
     type Objects = Constraint & {
         readonly ast: SchemaAST.Objects;
+        readonly Encoded: object;
     };
     /**
      * Readonly list of record schemas that provide the additional index signatures
@@ -3482,6 +3494,13 @@ export interface StructWithRest<S extends StructWithRest.Objects, Records extend
  *
  * **Gotchas**
  *
+ * The base schema must have an object-shaped encoded type. Whole-object
+ * transformations are not supported, even with an empty rest array. Apply
+ * transformations such as `Schema.fromJsonString` to the completed
+ * `StructWithRest` schema instead. Object-shaped encoded types alone do not
+ * guarantee compatibility: unsupported encodings are still rejected at runtime.
+ * Transformations on individual fields remain supported.
+ *
  * TypeScript index signatures also apply to fixed keys. `StructWithRest` does
  * not reject incompatible fixed fields at the call site; use
  * `StructWithRest.ValidateRecords` when you want an explicit type-level
@@ -6092,7 +6111,8 @@ export declare function isMultipleOf(divisor: number, annotations?: Annotations.
  *
  * JSON Schema:
  *
- * This check corresponds to the `type: "integer"` constraint in JSON Schema.
+ * This check corresponds to `type: "integer"` with `minimum: Number.MIN_SAFE_INTEGER`
+ * and `maximum: Number.MAX_SAFE_INTEGER` in JSON Schema.
  *
  * Arbitrary:
  *
@@ -9510,6 +9530,184 @@ export interface SocketAddress extends declare<NetAddress_.SocketAddress> {
  * @since 4.0.0
  */
 export declare const SocketAddress: SocketAddress;
+/**
+ * Type-level representation of {@link DomainName}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DomainName extends brand<String, "~effect/net/Host/DomainName"> {
+    readonly "Rebuild": DomainName;
+}
+/**
+ * Schema for normalized DNS domain names.
+ *
+ * **Details**
+ *
+ * Only names already in normalized form (lowercase ASCII, with
+ * internationalized labels in `xn--` form) are accepted. Use
+ * {@link DomainNameFromString} to normalize arbitrary input.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DomainName: DomainName;
+/**
+ * Type-level representation of {@link DomainNameFromString}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DomainNameFromString extends decodeTo<DomainName, String> {
+    readonly "Rebuild": DomainNameFromString;
+}
+/**
+ * Schema for DNS domain names decoded from strings, normalizing case and
+ * converting internationalized names to their ASCII form.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DomainNameFromString: DomainNameFromString;
+/**
+ * Type-level representation of {@link ScopedIpv6Literal}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface ScopedIpv6Literal extends brand<String, "~effect/net/NetAddress/ScopedIpv6Literal"> {
+    readonly "Rebuild": ScopedIpv6Literal;
+}
+/**
+ * Schema for canonical scoped IPv6 literals such as `fe80::1%eth0`.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const ScopedIpv6Literal: ScopedIpv6Literal;
+/**
+ * Type-level representation of {@link ScopedIpv6LiteralFromString}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface ScopedIpv6LiteralFromString extends decodeTo<ScopedIpv6Literal, String> {
+    readonly "Rebuild": ScopedIpv6LiteralFromString;
+}
+/**
+ * Schema for scoped IPv6 literals decoded from strings, normalizing the address
+ * and numeric zones.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const ScopedIpv6LiteralFromString: ScopedIpv6LiteralFromString;
+/**
+ * Type-level representation of {@link Host}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface Host extends Union<readonly [IpAddress, ScopedIpv6Literal, DomainName]> {
+    readonly "Rebuild": Host;
+}
+/**
+ * Schema for hosts: numeric IP addresses, scoped IPv6 literals, or domain names.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const Host: Host;
+/**
+ * Type-level representation of {@link HostFromString}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface HostFromString extends Union<readonly [IpAddressFromString, ScopedIpv6LiteralFromString, DomainNameFromString]> {
+    readonly "Rebuild": HostFromString;
+}
+/**
+ * Schema for hosts decoded from strings. Numeric IP strings decode to IP
+ * addresses; other strings decode to scoped IPv6 literals or domain names.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const HostFromString: HostFromString;
+/**
+ * Type-level representation of {@link HostPort}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface HostPort extends declare<Host_.HostPort> {
+    readonly "Rebuild": HostPort;
+}
+/**
+ * Schema for already-constructed unresolved host and port values.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const HostPort: HostPort;
+/**
+ * Type-level representation of {@link HostPortFromString}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface HostPortFromString extends decodeTo<HostPort, String> {
+    readonly "Rebuild": HostPortFromString;
+}
+/**
+ * Schema for unresolved endpoints encoded as `host:port` or `[IPv6]:port`
+ * strings.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const HostPortFromString: HostPortFromString;
+/**
+ * Type-level representation of {@link Port}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface Port extends Int {
+    readonly "Rebuild": Port;
+}
+/**
+ * Schema for TCP and UDP port numbers from 0 through 65535.
+ *
+ * **Details**
+ *
+ * Port 0 is accepted because it asks the operating system to choose a port
+ * when binding, and it matches the port range of `InetAddress` and `HostPort`.
+ * `Config.Port` accepts only 1 through 65535.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const Port: Port;
 /**
  * Type-level representation of {@link Duration}.
  *
@@ -9629,6 +9827,284 @@ export interface DurationFromMillis extends decodeTo<Duration, Number> {
  * @since 3.10.0
  */
 export declare const DurationFromMillis: DurationFromMillis;
+/**
+ * Type-level representation of {@link DnsRecordType}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsRecordType extends Literals<ReadonlyArray<Dns_.RecordType>> {
+}
+/**
+ * Schema for supported DNS record types such as `"A"` or `"SRV"`.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsRecordType: DnsRecordType;
+/**
+ * Type-level representation of {@link DnsARecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsARecord extends declare<Dns_.A> {
+    readonly "Rebuild": DnsARecord;
+}
+/**
+ * Schema for already-constructed IPv4 address (`A`) DNS records.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsARecord: DnsARecord;
+/**
+ * Type-level representation of {@link DnsAaaaRecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsAaaaRecord extends declare<Dns_.Aaaa> {
+    readonly "Rebuild": DnsAaaaRecord;
+}
+/**
+ * Schema for already-constructed IPv6 address (`AAAA`) DNS records.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsAaaaRecord: DnsAaaaRecord;
+/**
+ * Type-level representation of {@link DnsCaaRecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsCaaRecord extends declare<Dns_.Caa> {
+    readonly "Rebuild": DnsCaaRecord;
+}
+/**
+ * Schema for already-constructed certification authority authorization (`CAA`) DNS records.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsCaaRecord: DnsCaaRecord;
+/**
+ * Type-level representation of {@link DnsCnameRecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsCnameRecord extends declare<Dns_.Cname> {
+    readonly "Rebuild": DnsCnameRecord;
+}
+/**
+ * Schema for already-constructed canonical name (`CNAME`) DNS records.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsCnameRecord: DnsCnameRecord;
+/**
+ * Type-level representation of {@link DnsMxRecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsMxRecord extends declare<Dns_.Mx> {
+    readonly "Rebuild": DnsMxRecord;
+}
+/**
+ * Schema for already-constructed mail exchange (`MX`) DNS records.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsMxRecord: DnsMxRecord;
+/**
+ * Type-level representation of {@link DnsNaptrRecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsNaptrRecord extends declare<Dns_.Naptr> {
+    readonly "Rebuild": DnsNaptrRecord;
+}
+/**
+ * Schema for already-constructed naming authority pointer (`NAPTR`) DNS records.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsNaptrRecord: DnsNaptrRecord;
+/**
+ * Type-level representation of {@link DnsNsRecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsNsRecord extends declare<Dns_.Ns> {
+    readonly "Rebuild": DnsNsRecord;
+}
+/**
+ * Schema for already-constructed name server (`NS`) DNS records.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsNsRecord: DnsNsRecord;
+/**
+ * Type-level representation of {@link DnsPtrRecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsPtrRecord extends declare<Dns_.Ptr> {
+    readonly "Rebuild": DnsPtrRecord;
+}
+/**
+ * Schema for already-constructed pointer (`PTR`) DNS records.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsPtrRecord: DnsPtrRecord;
+/**
+ * Type-level representation of {@link DnsSoaRecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsSoaRecord extends declare<Dns_.Soa> {
+    readonly "Rebuild": DnsSoaRecord;
+}
+/**
+ * Schema for already-constructed start of authority (`SOA`) DNS records.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsSoaRecord: DnsSoaRecord;
+/**
+ * Type-level representation of {@link DnsSrvRecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsSrvRecord extends declare<Dns_.Srv> {
+    readonly "Rebuild": DnsSrvRecord;
+}
+/**
+ * Schema for already-constructed service locator (`SRV`) DNS records.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsSrvRecord: DnsSrvRecord;
+/**
+ * Type-level representation of {@link DnsTlsaRecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsTlsaRecord extends declare<Dns_.Tlsa> {
+    readonly "Rebuild": DnsTlsaRecord;
+}
+/**
+ * Schema for already-constructed TLS authentication (`TLSA`) DNS records.
+ *
+ * **Details**
+ *
+ * The default JSON serializer encodes the certificate association `data` as a
+ * hex string.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsTlsaRecord: DnsTlsaRecord;
+/**
+ * Type-level representation of {@link DnsTxtRecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsTxtRecord extends declare<Dns_.Txt> {
+    readonly "Rebuild": DnsTxtRecord;
+}
+/**
+ * Schema for already-constructed text (`TXT`) DNS records.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsTxtRecord: DnsTxtRecord;
+/**
+ * Type-level representation of {@link DnsRecord}.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface DnsRecord extends Union<readonly [
+    DnsARecord,
+    DnsAaaaRecord,
+    DnsCaaRecord,
+    DnsCnameRecord,
+    DnsMxRecord,
+    DnsNaptrRecord,
+    DnsNsRecord,
+    DnsPtrRecord,
+    DnsSoaRecord,
+    DnsSrvRecord,
+    DnsTlsaRecord,
+    DnsTxtRecord
+]> {
+    readonly "Rebuild": DnsRecord;
+}
+/**
+ * Schema for already-constructed DNS records of any supported record type.
+ *
+ * **Details**
+ *
+ * The default JSON serializer encodes records as objects tagged by record type,
+ * with addresses and names as canonical strings, SOA timers as whole seconds,
+ * and TLSA data as hex, such as
+ * `{ "_tag": "SRV", "target": "db.internal", "port": 5432, "priority": 10, "weight": 5 }`.
+ * Decoding accepts only canonical addresses and normalized domain names, and
+ * reports invalid fields with their path.
+ *
+ * @stability experimental
+ * @category schemas
+ * @since 4.0.0
+ */
+export declare const DnsRecord: DnsRecord;
 /**
  * Type-level representation returned by {@link Exit}.
  *
@@ -10334,6 +10810,10 @@ export interface Class<Self, S extends Constraint & {
      *
      * **Gotchas**
      *
+     * Fields with the same name replace inherited fields. Use this to refine
+     * validation or change encoding. Effect does not check compatibility; the
+     * caller must ensure the replacement preserves the base class contract.
+     *
      * Checks from a `Struct` argument are evaluated against the full subclass
      * value after inherited and extension fields are merged. Object-wide checks
      * such as `isMaxProperties` count inherited fields too.