effect 4.0.1 → 4.0.3

package/dist/net/Host.d.ts

@@ -0,0 +1,320 @@
+/**
+ * Host names and unresolved host and port endpoints.
+ *
+ * A `Host` is either a numeric IP address, an IPv6 literal with a zone such as
+ * `fe80::1%eth0`, or a DNS domain name. Numeric addresses are parsed directly
+ * into `NetAddress` values. The `AddressResolver` service turns a `HostPort`
+ * into internet addresses, looking up domain names with the `Dns` service.
+ *
+ * @stability experimental
+ * @since 4.0.0
+ */
+import type * as Brand from "../Brand.ts";
+import * as Equal from "../Equal.ts";
+import * as Hash from "../Hash.ts";
+import * as Inspectable from "../Inspectable.ts";
+import * as Result from "../Result.ts";
+import * as NetAddress from "./NetAddress.ts";
+declare const TypeId: "~effect/net/Host";
+/**
+ * A syntactically valid DNS domain name in lowercase ASCII form.
+ *
+ * **Details**
+ *
+ * Names follow the rules used by Go's resolver: at most 253 characters, labels
+ * of 1 to 63 letters, digits, hyphens, or underscores, and no label starting or
+ * ending with a hyphen. Underscores are allowed so that service names such as
+ * `_http._tcp.example.com` are valid. The last label must not be numeric, which
+ * keeps IPv4-like strings out. A trailing dot marks a fully qualified name and
+ * is preserved. The root name `.` is valid.
+ *
+ * Internationalized names are stored in their ASCII (`xn--`) form.
+ *
+ * @see {@link domainNameFromString} for parsing and normalizing domain names
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export type DomainName = Brand.Branded<string, "~effect/net/Host/DomainName">;
+/**
+ * A domain name or a string to parse and normalize.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export type DomainNameInput = DomainName | string;
+/**
+ * A host as written in configuration or a URL authority: a numeric IP address,
+ * a scoped IPv6 literal, or a domain name.
+ *
+ * @see {@link hostFromString} for parsing hosts
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export type Host = NetAddress.IpAddress | NetAddress.ScopedIpv6Literal | DomainName;
+/**
+ * A host, or a string or any `IpAddressInput` to convert to one.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export type HostInput = Host | NetAddress.IpAddressInput;
+/**
+ * An unresolved host and port.
+ *
+ * @see {@link hostPortFromString} for parsing `host:port` strings
+ * @see {@link formatHostPort} for formatting `host:port` strings
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface HostPort extends Equal.Equal, Hash.Hash, Inspectable.Inspectable {
+    readonly _tag: "HostPort";
+    readonly host: Host;
+    readonly port: number;
+    readonly [TypeId]: typeof TypeId;
+}
+/**
+ * The host and port of an endpoint.
+ *
+ * @see {@link hostPort} for the checked constructor
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export interface HostPortParts {
+    readonly host: HostInput;
+    readonly port: number;
+}
+/**
+ * An endpoint, or a `host:port` string or parts to convert to one.
+ *
+ * @stability experimental
+ * @category models
+ * @since 4.0.0
+ */
+export type HostPortInput = HostPort | string | HostPortParts;
+/**
+ * Returns `true` when a value is a valid, normalized domain name.
+ *
+ * @stability experimental
+ * @category guards
+ * @since 4.0.0
+ */
+export declare const isDomainName: (u: unknown) => u is DomainName;
+/**
+ * Returns `true` when a value is a host.
+ *
+ * @stability experimental
+ * @category guards
+ * @since 4.0.0
+ */
+export declare const isHost: (u: unknown) => u is Host;
+/**
+ * Returns `true` when a value is an unresolved host and port.
+ *
+ * @stability experimental
+ * @category guards
+ * @since 4.0.0
+ */
+export declare const isHostPort: (u: unknown) => u is HostPort;
+/**
+ * Parses and normalizes a domain name.
+ *
+ * **Details**
+ *
+ * ASCII names are lowercased. Names containing non-ASCII characters are
+ * converted to their ASCII (`xn--`) form using the WHATWG URL host parser, then
+ * validated with the same rules as ASCII names. A trailing dot is preserved.
+ *
+ * **Example** (Normalizing domain names)
+ *
+ * ```ts import.meta.vitest
+ * import { Result } from "effect"
+ * import { Host } from "effect/net"
+ *
+ * Result.getOrThrow(Host.domainNameFromString("Example.COM")) // => "example.com"
+ * Result.getOrThrow(Host.domainNameFromString("bücher.example")) // => "xn--bcher-kva.example"
+ * Result.isFailure(Host.domainNameFromString("1.2.3.4")) // => true
+ * ```
+ *
+ * @stability experimental
+ * @category decoding
+ * @since 4.0.0
+ */
+export declare const domainNameFromString: (input: string) => Result.Result<DomainName, NetAddress.NetAddressError>;
+/**
+ * Parses a trusted domain name, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export declare const domainNameFromStringUnsafe: (input: string) => DomainName;
+/**
+ * Converts a `DomainNameInput` to a domain name, parsing and normalizing it like
+ * `domainNameFromString`.
+ *
+ * **Details**
+ *
+ * Domain names are strings, so every input is parsed.
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const domainNameFromInput: (input: DomainNameInput) => Result.Result<DomainName, NetAddress.NetAddressError>;
+/**
+ * Converts a trusted `DomainNameInput` to a domain name, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export declare const domainNameFromInputUnsafe: (input: DomainNameInput) => DomainName;
+/**
+ * Parses a host as a numeric IP address, a scoped IPv6 literal, or a domain
+ * name, in that order.
+ *
+ * **Example** (Parsing hosts)
+ *
+ * ```ts import.meta.vitest
+ * import { Result } from "effect"
+ * import { Host, NetAddress } from "effect/net"
+ *
+ * NetAddress.isIpAddress(Result.getOrThrow(Host.hostFromString("10.0.0.5"))) // => true
+ * Result.getOrThrow(Host.hostFromString("fe80::1%eth0")) // => "fe80::1%eth0"
+ * Result.getOrThrow(Host.hostFromString("DB.internal")) // => "db.internal"
+ * ```
+ *
+ * @stability experimental
+ * @category decoding
+ * @since 4.0.0
+ */
+export declare const hostFromString: (input: string) => Result.Result<Host, NetAddress.NetAddressError>;
+/**
+ * Parses a trusted host, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export declare const hostFromStringUnsafe: (input: string) => Host;
+/**
+ * Converts a `HostInput` to a host, parsing strings like `hostFromString` and
+ * converting other inputs like `NetAddress.ipFromInput`.
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const hostFromInput: (input: HostInput) => Result.Result<Host, NetAddress.NetAddressError>;
+/**
+ * Converts a trusted `HostInput` to a host, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export declare const hostFromInputUnsafe: (input: HostInput) => Host;
+/**
+ * Formats a host without brackets.
+ *
+ * @stability experimental
+ * @category encoding
+ * @since 4.0.0
+ */
+export declare const formatHost: (self: Host) => string;
+/**
+ * Returns `true` when a domain name ends with a dot, which excludes it from
+ * resolver search domains.
+ *
+ * @stability experimental
+ * @category predicates
+ * @since 4.0.0
+ */
+export declare const isFullyQualified: (self: DomainName) => boolean;
+/**
+ * Creates a checked host and port.
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const hostPort: (host: Host, port: number) => Result.Result<HostPort, NetAddress.NetAddressError>;
+/**
+ * Creates a trusted host and port, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export declare const hostPortUnsafe: (host: Host, port: number) => HostPort;
+/**
+ * Parses `host:port`, `[IPv6]:port`, or `[IPv6%zone]:port`.
+ *
+ * **Details**
+ *
+ * IPv6 hosts must be bracketed and other hosts must not be. The port is
+ * required and must be an unpadded decimal integer from 0 through 65535. A
+ * zone follows the `%` directly; the percent-encoded `%25` separator of RFC
+ * 6874 URLs is not decoded, because `[fe80::1%253]:80` would be ambiguous.
+ *
+ * **Example** (Parsing host and port strings)
+ *
+ * ```ts import.meta.vitest
+ * import { Result } from "effect"
+ * import { Host } from "effect/net"
+ *
+ * const endpoint = Result.getOrThrow(Host.hostPortFromString("DB.internal:5432"))
+ * endpoint.host // => "db.internal"
+ * endpoint.port // => 5432
+ * Host.formatHostPort(Result.getOrThrow(Host.hostPortFromString("[::1]:80"))) // => "[::1]:80"
+ * ```
+ *
+ * @see {@link formatHostPort} for the inverse operation
+ * @stability experimental
+ * @category decoding
+ * @since 4.0.0
+ */
+export declare const hostPortFromString: (input: string) => Result.Result<HostPort, NetAddress.NetAddressError>;
+/**
+ * Parses a trusted `host:port` string, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export declare const hostPortFromStringUnsafe: (input: string) => HostPort;
+/**
+ * Converts a `HostPortInput` to an endpoint, parsing strings like
+ * `hostPortFromString`, converting parts like `hostPort`, and returning
+ * endpoints unchanged.
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export declare const hostPortFromInput: (input: HostPortInput) => Result.Result<HostPort, NetAddress.NetAddressError>;
+/**
+ * Converts a trusted `HostPortInput` to an endpoint, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export declare const hostPortFromInputUnsafe: (input: HostPortInput) => HostPort;
+/**
+ * Formats a host and port, bracketing IPv6 hosts.
+ *
+ * @see {@link hostPortFromString} for the inverse operation
+ * @stability experimental
+ * @category encoding
+ * @since 4.0.0
+ */
+export declare const formatHostPort: (self: HostPort) => string;
+export {};
+//# sourceMappingURL=Host.d.ts.map

package/dist/net/Host.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Host.d.ts","sourceRoot":"","sources":["../../src/net/Host.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,OAAO,KAAK,KAAK,KAAK,MAAM,aAAa,CAAA;AACzC,OAAO,KAAK,KAAK,MAAM,aAAa,CAAA;AACpC,OAAO,KAAK,IAAI,MAAM,YAAY,CAAA;AAClC,OAAO,KAAK,WAAW,MAAM,mBAAmB,CAAA;AAEhD,OAAO,KAAK,MAAM,MAAM,cAAc,CAAA;AACtC,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C,QAAA,MAAM,MAAM,EAAG,kBAA2B,CAAA;AAE1C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,6BAA6B,CAAC,CAAA;AAE7E;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,MAAM,CAAA;AAEjD;;;;;;;;GAQG;AACH,MAAM,MAAM,IAAI,GAAG,UAAU,CAAC,SAAS,GAAG,UAAU,CAAC,iBAAiB,GAAG,UAAU,CAAA;AAEnF;;;;;;GAMG;AACH,MAAM,MAAM,SAAS,GAAG,IAAI,GAAG,UAAU,CAAC,cAAc,CAAA;AAExD;;;;;;;;GAQG;AACH,MAAM,WAAW,QAAS,SAAQ,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,WAAW;IAC/E,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAA;IACzB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAA;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,CAAA;CACjC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CACtB;AAED;;;;;;GAMG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,GAAG,MAAM,GAAG,aAAa,CAAA;AA6C7D;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,MAAO,OAAO,KAAG,CAAC,IAAI,UAC2C,CAAA;AAE1F;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,MAAO,OAAO,KAAG,CAAC,IAAI,IAC0C,CAAA;AAEnF;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,MAAO,OAAO,KAAG,CAAC,IAAI,QAAkC,CAAA;AAE/E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,oBAAoB,UAAW,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,eAAe,CAKxG,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,UAAW,MAAM,KAAG,UAA4D,CAAA;AAEvH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,mBAAmB,UAAW,eAAe,KAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,UAAU,CAAC,eAAe,CACpF,CAAA;AAE7B;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,UAAW,eAAe,KAAG,UACpB,CAAA;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,cAAc,UAAW,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,eAAe,CAQ5F,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,UAAW,MAAM,KAAG,IAAgD,CAAA;AAErG;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa,UAAW,SAAS,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC,eAAe,CACZ,CAAA;AAEnF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,UAAW,SAAS,KAAG,IAA+C,CAAA;AAEtG;;;;;;GAMG;AACH,eAAO,MAAM,UAAU,SAAU,IAAI,KAAG,MAAqE,CAAA;AAE7G;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,SAAU,UAAU,KAAG,OAA6B,CAAA;AA6BjF;;;;;;GAMG;AACH,eAAO,MAAM,QAAQ,SAAU,IAAI,QAAQ,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,eAAe,CAIrG,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,SAAU,IAAI,QAAQ,MAAM,KAAG,QAAmD,CAAA;AAE7G;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,kBAAkB,UAAW,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,eAAe,CAsBpG,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,wBAAwB,UAAW,MAAM,KAAG,QAAwD,CAAA;AAEjH;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,UAAW,aAAa,KAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,UAAU,CAAC,eAAe,CAQ1G,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,UAAW,aAAa,KAAG,QAAuD,CAAA;AAEtH;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,SAAU,QAAQ,KAAG,MAG/C,CAAA"}

package/dist/net/Host.js

@@ -0,0 +1,342 @@
+import * as Equal from "../Equal.js";
+import * as Hash from "../Hash.js";
+import * as Inspectable from "../Inspectable.js";
+import { hasProperty } from "../Predicate.js";
+import * as Result from "../Result.js";
+import * as NetAddress from "./NetAddress.js";
+const TypeId = "~effect/net/Host";
+const hostError = (input, message) => Result.fail(new NetAddress.NetAddressError({
+  input,
+  message
+}));
+const asciiNameCharacter = /^[a-z0-9_.-]$/i;
+const labelPattern = /^[a-z0-9_](?:[a-z0-9_-]{0,61}[a-z0-9_])?$/;
+const numericLabel = /^(?:\d+|0x[0-9a-f]*)$/;
+const validateDomainName = name => {
+  if (name === ".") return undefined;
+  const relative = name.endsWith(".") ? name.slice(0, -1) : name;
+  if (relative.length === 0) return "domain name must not be empty";
+  if (relative.length > 253) return "domain name must be at most 253 characters";
+  const labels = relative.split(".");
+  for (const label of labels) {
+    if (label.length === 0) return "domain name labels must not be empty";
+    if (label.length > 63) return "domain name labels must be at most 63 characters";
+    if (!labelPattern.test(label)) {
+      return "domain name labels must contain only letters, digits, hyphens, or underscores and must not start or end with a hyphen";
+    }
+  }
+  if (numericLabel.test(labels[labels.length - 1])) {
+    return "the last domain name label must not be numeric";
+  }
+  return undefined;
+};
+const toAsciiDomainName = input => {
+  let ascii = true;
+  for (const character of input) {
+    if (character.charCodeAt(0) < 0x80) {
+      if (!asciiNameCharacter.test(character)) return undefined;
+    } else {
+      ascii = false;
+    }
+  }
+  if (ascii) return input.toLowerCase();
+  try {
+    return new URL(`http://${input}`).hostname;
+  } catch {
+    return undefined;
+  }
+};
+/**
+ * Returns `true` when a value is a valid, normalized domain name.
+ *
+ * @stability experimental
+ * @category guards
+ * @since 4.0.0
+ */
+export const isDomainName = u => typeof u === "string" && /^[a-z0-9_.-]+$/.test(u) && validateDomainName(u) === undefined;
+/**
+ * Returns `true` when a value is a host.
+ *
+ * @stability experimental
+ * @category guards
+ * @since 4.0.0
+ */
+export const isHost = u => NetAddress.isIpAddress(u) || NetAddress.isScopedIpv6Literal(u) || isDomainName(u);
+/**
+ * Returns `true` when a value is an unresolved host and port.
+ *
+ * @stability experimental
+ * @category guards
+ * @since 4.0.0
+ */
+export const isHostPort = u => hasProperty(u, TypeId);
+/**
+ * Parses and normalizes a domain name.
+ *
+ * **Details**
+ *
+ * ASCII names are lowercased. Names containing non-ASCII characters are
+ * converted to their ASCII (`xn--`) form using the WHATWG URL host parser, then
+ * validated with the same rules as ASCII names. A trailing dot is preserved.
+ *
+ * **Example** (Normalizing domain names)
+ *
+ * ```ts import.meta.vitest
+ * import { Result } from "effect"
+ * import { Host } from "effect/net"
+ *
+ * Result.getOrThrow(Host.domainNameFromString("Example.COM")) // => "example.com"
+ * Result.getOrThrow(Host.domainNameFromString("bücher.example")) // => "xn--bcher-kva.example"
+ * Result.isFailure(Host.domainNameFromString("1.2.3.4")) // => true
+ * ```
+ *
+ * @stability experimental
+ * @category decoding
+ * @since 4.0.0
+ */
+export const domainNameFromString = input => {
+  const name = toAsciiDomainName(input);
+  if (name === undefined) return hostError(input, "invalid domain name");
+  const error = validateDomainName(name);
+  return error === undefined ? Result.succeed(name) : hostError(input, error);
+};
+/**
+ * Parses a trusted domain name, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export const domainNameFromStringUnsafe = input => Result.getOrThrow(domainNameFromString(input));
+/**
+ * Converts a `DomainNameInput` to a domain name, parsing and normalizing it like
+ * `domainNameFromString`.
+ *
+ * **Details**
+ *
+ * Domain names are strings, so every input is parsed.
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export const domainNameFromInput = input => domainNameFromString(input);
+/**
+ * Converts a trusted `DomainNameInput` to a domain name, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export const domainNameFromInputUnsafe = input => Result.getOrThrow(domainNameFromInput(input));
+/**
+ * Parses a host as a numeric IP address, a scoped IPv6 literal, or a domain
+ * name, in that order.
+ *
+ * **Example** (Parsing hosts)
+ *
+ * ```ts import.meta.vitest
+ * import { Result } from "effect"
+ * import { Host, NetAddress } from "effect/net"
+ *
+ * NetAddress.isIpAddress(Result.getOrThrow(Host.hostFromString("10.0.0.5"))) // => true
+ * Result.getOrThrow(Host.hostFromString("fe80::1%eth0")) // => "fe80::1%eth0"
+ * Result.getOrThrow(Host.hostFromString("DB.internal")) // => "db.internal"
+ * ```
+ *
+ * @stability experimental
+ * @category decoding
+ * @since 4.0.0
+ */
+export const hostFromString = input => {
+  if (input.includes("%")) return NetAddress.scopedIpv6LiteralFromString(input);
+  if (input.includes(":")) return NetAddress.ipFromString(input);
+  if (/^[\d.]+$/.test(input)) {
+    const address = NetAddress.ipFromString(input);
+    if (Result.isSuccess(address)) return address;
+  }
+  return domainNameFromString(input);
+};
+/**
+ * Parses a trusted host, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export const hostFromStringUnsafe = input => Result.getOrThrow(hostFromString(input));
+/**
+ * Converts a `HostInput` to a host, parsing strings like `hostFromString` and
+ * converting other inputs like `NetAddress.ipFromInput`.
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export const hostFromInput = input => typeof input === "string" ? hostFromString(input) : NetAddress.ipFromInput(input);
+/**
+ * Converts a trusted `HostInput` to a host, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export const hostFromInputUnsafe = input => Result.getOrThrow(hostFromInput(input));
+/**
+ * Formats a host without brackets.
+ *
+ * @stability experimental
+ * @category encoding
+ * @since 4.0.0
+ */
+export const formatHost = self => typeof self === "string" ? self : NetAddress.formatIp(self);
+/**
+ * Returns `true` when a domain name ends with a dot, which excludes it from
+ * resolver search domains.
+ *
+ * @stability experimental
+ * @category predicates
+ * @since 4.0.0
+ */
+export const isFullyQualified = self => self.endsWith(".");
+const HostPortProto = {
+  ...Inspectable.BaseProto,
+  _tag: "HostPort",
+  [TypeId]: TypeId,
+  [Equal.symbol](that) {
+    return isHostPort(that) && this.port === that.port && Equal.equals(this.host, that.host);
+  },
+  [Hash.symbol]() {
+    return Hash.combine(Hash.hash(this.host), Hash.number(this.port));
+  },
+  toString() {
+    return formatHostPort(this);
+  },
+  toJSON() {
+    return this.toString();
+  }
+};
+const isPort = port => Number.isInteger(port) && port >= 0 && port <= 0xffff;
+const makeHostPort = (host, port) => {
+  const self = Object.create(HostPortProto);
+  self.host = host;
+  self.port = port;
+  return Object.freeze(self);
+};
+/**
+ * Creates a checked host and port.
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export const hostPort = (host, port) => {
+  if (!isHost(host)) return hostError(host, "expected a host");
+  if (!isPort(port)) return hostError(port, "port must be an integer from 0 through 65535");
+  return Result.succeed(makeHostPort(host, port));
+};
+/**
+ * Creates a trusted host and port, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export const hostPortUnsafe = (host, port) => Result.getOrThrow(hostPort(host, port));
+/**
+ * Parses `host:port`, `[IPv6]:port`, or `[IPv6%zone]:port`.
+ *
+ * **Details**
+ *
+ * IPv6 hosts must be bracketed and other hosts must not be. The port is
+ * required and must be an unpadded decimal integer from 0 through 65535. A
+ * zone follows the `%` directly; the percent-encoded `%25` separator of RFC
+ * 6874 URLs is not decoded, because `[fe80::1%253]:80` would be ambiguous.
+ *
+ * **Example** (Parsing host and port strings)
+ *
+ * ```ts import.meta.vitest
+ * import { Result } from "effect"
+ * import { Host } from "effect/net"
+ *
+ * const endpoint = Result.getOrThrow(Host.hostPortFromString("DB.internal:5432"))
+ * endpoint.host // => "db.internal"
+ * endpoint.port // => 5432
+ * Host.formatHostPort(Result.getOrThrow(Host.hostPortFromString("[::1]:80"))) // => "[::1]:80"
+ * ```
+ *
+ * @see {@link formatHostPort} for the inverse operation
+ * @stability experimental
+ * @category decoding
+ * @since 4.0.0
+ */
+export const hostPortFromString = input => {
+  let hostText;
+  let portText;
+  if (input.startsWith("[")) {
+    const end = input.indexOf("]");
+    if (end === -1 || input[end + 1] !== ":") return hostError(input, "expected [IPv6]:port");
+    hostText = input.slice(1, end);
+    portText = input.slice(end + 2);
+    if (!hostText.includes(":")) return hostError(input, "only IPv6 addresses use brackets");
+  } else {
+    const separator = input.lastIndexOf(":");
+    if (separator === -1) return hostError(input, "expected host:port");
+    if (input.indexOf(":") !== separator) return hostError(input, "IPv6 addresses must be bracketed");
+    hostText = input.slice(0, separator);
+    portText = input.slice(separator + 1);
+  }
+  if (!/^(0|[1-9]\d*)$/.test(portText)) {
+    return hostError(input, "port must be an unpadded decimal integer");
+  }
+  const port = Number(portText);
+  if (!isPort(port)) return hostError(input, "port must be an integer from 0 through 65535");
+  return Result.map(hostFromString(hostText), host => makeHostPort(host, port));
+};
+/**
+ * Parses a trusted `host:port` string, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export const hostPortFromStringUnsafe = input => Result.getOrThrow(hostPortFromString(input));
+/**
+ * Converts a `HostPortInput` to an endpoint, parsing strings like
+ * `hostPortFromString`, converting parts like `hostPort`, and returning
+ * endpoints unchanged.
+ *
+ * @stability experimental
+ * @category constructors
+ * @since 4.0.0
+ */
+export const hostPortFromInput = input => {
+  if (isHostPort(input)) return Result.succeed(input);
+  if (typeof input === "string") return hostPortFromString(input);
+  if (!hasProperty(input, "host") || !hasProperty(input, "port")) {
+    return hostError(input, "expected a host and port");
+  }
+  const port = input.port;
+  return Result.flatMap(hostFromInput(input.host), host => hostPort(host, port));
+};
+/**
+ * Converts a trusted `HostPortInput` to an endpoint, throwing on failure.
+ *
+ * @stability experimental
+ * @category unsafe
+ * @since 4.0.0
+ */
+export const hostPortFromInputUnsafe = input => Result.getOrThrow(hostPortFromInput(input));
+/**
+ * Formats a host and port, bracketing IPv6 hosts.
+ *
+ * @see {@link hostPortFromString} for the inverse operation
+ * @stability experimental
+ * @category encoding
+ * @since 4.0.0
+ */
+export const formatHostPort = self => {
+  const host = formatHost(self.host);
+  return host.includes(":") ? `[${host}]:${self.port}` : `${host}:${self.port}`;
+};
+//# sourceMappingURL=Host.js.map

package/dist/net/Host.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Host.js","names":[],"sources":["../../src/net/Host.ts"],"sourcesContent":[null],"mappings":"AAYA,OAAO,KAAK,KAAK,MAAM,aAAa;AACpC,OAAO,KAAK,IAAI,MAAM,YAAY;AAClC,OAAO,KAAK,WAAW,MAAM,mBAAmB;AAChD,SAAS,WAAW,QAAQ,iBAAiB;AAC7C,OAAO,KAAK,MAAM,MAAM,cAAc;AACtC,OAAO,KAAK,UAAU,MAAM,iBAAiB;AAE7C,MAAM,MAAM,GAAG,kBAA2B;AA0F1C,MAAM,SAAS,GAAG,CAAC,KAAc,EAAE,OAAe,KAChD,MAAM,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,eAAe,CAAC;EAAE,KAAK;EAAE;AAAO,CAAE,CAAC,CAAC;AAEjE,MAAM,kBAAkB,GAAG,gBAAgB;AAC3C,MAAM,YAAY,GAAG,2CAA2C;AAChE,MAAM,YAAY,GAAG,uBAAuB;AAE5C,MAAM,kBAAkB,GAAI,IAAY,IAAwB;EAC9D,IAAI,IAAI,KAAK,GAAG,EAAE,OAAO,SAAS;EAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI;EAC9D,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,OAAO,+BAA+B;EACjE,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,OAAO,4CAA4C;EAC9E,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC;EAClC,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;IAC1B,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,OAAO,sCAAsC;IACrE,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE,EAAE,OAAO,kDAAkD;IAChF,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;MAC7B,OAAO,uHAAuH;IAChI;EACF;EACA,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE;IAChD,OAAO,gDAAgD;EACzD;EACA,OAAO,SAAS;AAClB,CAAC;AAED,MAAM,iBAAiB,GAAI,KAAa,IAAwB;EAC9D,IAAI,KAAK,GAAG,IAAI;EAChB,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE;IAC7B,IAAI,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE;MAClC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,SAAS;IAC3D,CAAC,MAAM;MACL,KAAK,GAAG,KAAK;IACf;EACF;EACA,IAAI,KAAK,EAAE,OAAO,KAAK,CAAC,WAAW,EAAE;EACrC,IAAI;IACF,OAAO,IAAI,GAAG,CAAC,UAAU,KAAK,EAAE,CAAC,CAAC,QAAQ;EAC5C,CAAC,CAAC,MAAM;IACN,OAAO,SAAS;EAClB;AACF,CAAC;AAED;;;;;;;AAOA,OAAO,MAAM,YAAY,GAAI,CAAU,IACrC,OAAO,CAAC,KAAK,QAAQ,IAAI,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,CAAC,KAAK,SAAS;AAE1F;;;;;;;AAOA,OAAO,MAAM,MAAM,GAAI,CAAU,IAC/B,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC;AAEnF;;;;;;;AAOA,OAAO,MAAM,UAAU,GAAI,CAAU,IAAoB,WAAW,CAAC,CAAC,EAAE,MAAM,CAAC;AAE/E;;;;;;;;;;;;;;;;;;;;;;;;AAwBA,OAAO,MAAM,oBAAoB,GAAI,KAAa,IAA2D;EAC3G,MAAM,IAAI,GAAG,iBAAiB,CAAC,KAAK,CAAC;EACrC,IAAI,IAAI,KAAK,SAAS,EAAE,OAAO,SAAS,CAAC,KAAK,EAAE,qBAAqB,CAAC;EACtE,MAAM,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC;EACtC,OAAO,KAAK,KAAK,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,IAAkB,CAAC,GAAG,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC;AAC3F,CAAC;AAED;;;;;;;AAOA,OAAO,MAAM,0BAA0B,GAAI,KAAa,IAAiB,MAAM,CAAC,UAAU,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;AAEvH;;;;;;;;;;;;AAYA,OAAO,MAAM,mBAAmB,GAAI,KAAsB,IACxD,oBAAoB,CAAC,KAAK,CAAC;AAE7B;;;;;;;AAOA,OAAO,MAAM,yBAAyB,GAAI,KAAsB,IAC9D,MAAM,CAAC,UAAU,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAE/C;;;;;;;;;;;;;;;;;;;AAmBA,OAAO,MAAM,cAAc,GAAI,KAAa,IAAqD;EAC/F,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,UAAU,CAAC,2BAA2B,CAAC,KAAK,CAAC;EAC7E,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC;EAC9D,IAAI,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;IAC1B,MAAM,OAAO,GAAG,UAAU,CAAC,YAAY,CAAC,KAAK,CAAC;IAC9C,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,OAAO;EAC/C;EACA,OAAO,oBAAoB,CAAC,KAAK,CAAC;AACpC,CAAC;AAED;;;;;;;AAOA,OAAO,MAAM,oBAAoB,GAAI,KAAa,IAAW,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAErG;;;;;;;;AAQA,OAAO,MAAM,aAAa,GAAI,KAAgB,IAC5C,OAAO,KAAK,KAAK,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,WAAW,CAAC,KAAK,CAAC;AAEnF;;;;;;;AAOA,OAAO,MAAM,mBAAmB,GAAI,KAAgB,IAAW,MAAM,CAAC,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;AAEtG;;;;;;;AAOA,OAAO,MAAM,UAAU,GAAI,IAAU,IAAa,OAAO,IAAI,KAAK,QAAQ,GAAG,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC;AAE7G;;;;;;;;AAQA,OAAO,MAAM,gBAAgB,GAAI,IAAgB,IAAc,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;AAEjF,MAAM,aAAa,GAAG;EACpB,GAAG,WAAW,CAAC,SAAS;EACxB,IAAI,EAAE,UAAU;EAChB,CAAC,MAAM,GAAG,MAAM;EAChB,CAAC,KAAK,CAAC,MAAM,EAAkB,IAAiB;IAC9C,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC;EAC1F,CAAC;EACD,CAAC,IAAI,CAAC,MAAM,IAAC;IACX,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;EACnE,CAAC;EACD,QAAQ;IACN,OAAO,cAAc,CAAC,IAAI,CAAC;EAC7B,CAAC;EACD,MAAM;IACJ,OAAO,IAAI,CAAC,QAAQ,EAAE;EACxB;CACD;AAED,MAAM,MAAM,GAAI,IAAY,IAAc,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,MAAM;AAE/F,MAAM,YAAY,GAAG,CAAC,IAAU,EAAE,IAAY,KAAc;EAC1D,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC;EACzC,IAAI,CAAC,IAAI,GAAG,IAAI;EAChB,IAAI,CAAC,IAAI,GAAG,IAAI;EAChB,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;AAC5B,CAAC;AAED;;;;;;;AAOA,OAAO,MAAM,QAAQ,GAAG,CAAC,IAAU,EAAE,IAAY,KAAyD;EACxG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,SAAS,CAAC,IAAI,EAAE,iBAAiB,CAAC;EAC5D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,SAAS,CAAC,IAAI,EAAE,8CAA8C,CAAC;EACzF,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;AAOA,OAAO,MAAM,cAAc,GAAG,CAAC,IAAU,EAAE,IAAY,KAAe,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAE7G;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,MAAM,kBAAkB,GAAI,KAAa,IAAyD;EACvG,IAAI,QAAgB;EACpB,IAAI,QAAgB;EACpB,IAAI,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;IACzB,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;IAC9B,IAAI,GAAG,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE,OAAO,SAAS,CAAC,KAAK,EAAE,sBAAsB,CAAC;IACzF,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC;IAC9B,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC;IAC/B,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,SAAS,CAAC,KAAK,EAAE,kCAAkC,CAAC;EAC1F,CAAC,MAAM;IACL,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC;IACxC,IAAI,SAAS,KAAK,CAAC,CAAC,EAAE,OAAO,SAAS,CAAC,KAAK,EAAE,oBAAoB,CAAC;IACnE,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,OAAO,SAAS,CAAC,KAAK,EAAE,kCAAkC,CAAC;IACjG,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC;IACpC,QAAQ,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC;EACvC;EACA,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;IACpC,OAAO,SAAS,CAAC,KAAK,EAAE,0CAA0C,CAAC;EACrE;EACA,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC;EAC7B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,SAAS,CAAC,KAAK,EAAE,8CAA8C,CAAC;EAC1F,OAAO,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAG,IAAI,IAAK,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACjF,CAAC;AAED;;;;;;;AAOA,OAAO,MAAM,wBAAwB,GAAI,KAAa,IAAe,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;AAEjH;;;;;;;;;AASA,OAAO,MAAM,iBAAiB,GAAI,KAAoB,IAAyD;EAC7G,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,OAAO,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;EACnD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,OAAO,kBAAkB,CAAC,KAAK,CAAC;EAC/D,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE;IAC9D,OAAO,SAAS,CAAC,KAAK,EAAE,0BAA0B,CAAC;EACrD;EACA,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI;EACvB,OAAO,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,EAAG,IAAI,IAAK,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAClF,CAAC;AAED;;;;;;;AAOA,OAAO,MAAM,uBAAuB,GAAI,KAAoB,IAAe,MAAM,CAAC,UAAU,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;AAEtH;;;;;;;;AAQA,OAAO,MAAM,cAAc,GAAI,IAAc,IAAY;EACvD,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;EAClC,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,KAAK,IAAI,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE;AAC/E,CAAC","ignoreList":[]}