@effect/platform 0.72.1 → 0.73.0

package/dist/dts/Url.d.ts

@@ -0,0 +1,591 @@
+/**
+ * @since 1.0.0
+ */
+import * as Cause from "effect/Cause";
+import * as Either from "effect/Either";
+import * as UrlParams from "./UrlParams.js";
+/**
+ * Parses a URL string into a `URL` object, returning an `Either` type for safe
+ * error handling.
+ *
+ * **Details**
+ *
+ * This function converts a string into a `URL` object, enabling safe URL
+ * parsing with built-in error handling. If the string is invalid or fails to
+ * parse, this function does not throw an error; instead, it wraps the error in
+ * a `IllegalArgumentException` and returns it as the `Left` value of an
+ * `Either`. The `Right` value contains the successfully parsed `URL`.
+ *
+ * An optional `base` parameter can be provided to resolve relative URLs. If
+ * specified, the function interprets the input `url` as relative to this
+ * `base`. This is especially useful when dealing with URLs that might not be
+ * fully qualified.
+ *
+ * @example
+ * ```ts
+ * import { Url } from "@effect/platform"
+ * import { Either } from "effect"
+ *
+ * // Parse an absolute URL
+ * //
+ * //      ┌─── Either<URL, IllegalArgumentException>
+ * //      ▼
+ * const parsed = Url.fromString("https://example.com/path")
+ *
+ * if (Either.isRight(parsed)) {
+ *   console.log("Parsed URL:", parsed.right.toString())
+ * } else {
+ *   console.log("Error:", parsed.left.message)
+ * }
+ * // Output: Parsed URL: https://example.com/path
+ *
+ * // Parse a relative URL with a base
+ * const relativeParsed = Url.fromString("/relative-path", "https://example.com")
+ *
+ * if (Either.isRight(relativeParsed)) {
+ *   console.log("Parsed relative URL:", relativeParsed.right.toString())
+ * } else {
+ *   console.log("Error:", relativeParsed.left.message)
+ * }
+ * // Output: Parsed relative URL: https://example.com/relative-path
+ * ```
+ *
+ * @since 1.0.0
+ * @category Constructors
+ */
+export declare const fromString: {
+    /**
+     * Parses a URL string into a `URL` object, returning an `Either` type for safe
+     * error handling.
+     *
+     * **Details**
+     *
+     * This function converts a string into a `URL` object, enabling safe URL
+     * parsing with built-in error handling. If the string is invalid or fails to
+     * parse, this function does not throw an error; instead, it wraps the error in
+     * a `IllegalArgumentException` and returns it as the `Left` value of an
+     * `Either`. The `Right` value contains the successfully parsed `URL`.
+     *
+     * An optional `base` parameter can be provided to resolve relative URLs. If
+     * specified, the function interprets the input `url` as relative to this
+     * `base`. This is especially useful when dealing with URLs that might not be
+     * fully qualified.
+     *
+     * @example
+     * ```ts
+     * import { Url } from "@effect/platform"
+     * import { Either } from "effect"
+     *
+     * // Parse an absolute URL
+     * //
+     * //      ┌─── Either<URL, IllegalArgumentException>
+     * //      ▼
+     * const parsed = Url.fromString("https://example.com/path")
+     *
+     * if (Either.isRight(parsed)) {
+     *   console.log("Parsed URL:", parsed.right.toString())
+     * } else {
+     *   console.log("Error:", parsed.left.message)
+     * }
+     * // Output: Parsed URL: https://example.com/path
+     *
+     * // Parse a relative URL with a base
+     * const relativeParsed = Url.fromString("/relative-path", "https://example.com")
+     *
+     * if (Either.isRight(relativeParsed)) {
+     *   console.log("Parsed relative URL:", relativeParsed.right.toString())
+     * } else {
+     *   console.log("Error:", relativeParsed.left.message)
+     * }
+     * // Output: Parsed relative URL: https://example.com/relative-path
+     * ```
+     *
+     * @since 1.0.0
+     * @category Constructors
+     */
+    (url: string, base?: string | URL | undefined): Either.Either<URL, Cause.IllegalArgumentException>;
+};
+/**
+ * This function clones the original `URL` object and applies a callback to the
+ * clone, allowing multiple updates at once.
+ *
+ * @example
+ * ```ts
+ * import { Url } from "@effect/platform"
+ *
+ * const myUrl = new URL("https://example.com")
+ *
+ * const mutatedUrl = Url.mutate(myUrl, (url) => {
+ *   url.username = "user"
+ *   url.password = "pass"
+ * })
+ *
+ * console.log("Mutated:", mutatedUrl.toString())
+ * // Output: Mutated: https://user:pass@example.com/
+ * ```
+ *
+ * @since 1.0.0
+ * @category Modifiers
+ */
+export declare const mutate: {
+    /**
+     * This function clones the original `URL` object and applies a callback to the
+     * clone, allowing multiple updates at once.
+     *
+     * @example
+     * ```ts
+     * import { Url } from "@effect/platform"
+     *
+     * const myUrl = new URL("https://example.com")
+     *
+     * const mutatedUrl = Url.mutate(myUrl, (url) => {
+     *   url.username = "user"
+     *   url.password = "pass"
+     * })
+     *
+     * console.log("Mutated:", mutatedUrl.toString())
+     * // Output: Mutated: https://user:pass@example.com/
+     * ```
+     *
+     * @since 1.0.0
+     * @category Modifiers
+     */
+    (f: (url: URL) => void): (self: URL) => URL;
+    /**
+     * This function clones the original `URL` object and applies a callback to the
+     * clone, allowing multiple updates at once.
+     *
+     * @example
+     * ```ts
+     * import { Url } from "@effect/platform"
+     *
+     * const myUrl = new URL("https://example.com")
+     *
+     * const mutatedUrl = Url.mutate(myUrl, (url) => {
+     *   url.username = "user"
+     *   url.password = "pass"
+     * })
+     *
+     * console.log("Mutated:", mutatedUrl.toString())
+     * // Output: Mutated: https://user:pass@example.com/
+     * ```
+     *
+     * @since 1.0.0
+     * @category Modifiers
+     */
+    (self: URL, f: (url: URL) => void): URL;
+};
+/**
+ * Updates the hash fragment of the URL.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export declare const setHash: {
+    /**
+     * Updates the hash fragment of the URL.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (hash: string): (url: URL) => URL;
+    /**
+     * Updates the hash fragment of the URL.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (url: URL, hash: string): URL;
+};
+/**
+ * Updates the host (domain and port) of the URL.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export declare const setHost: {
+    /**
+     * Updates the host (domain and port) of the URL.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (host: string): (url: URL) => URL;
+    /**
+     * Updates the host (domain and port) of the URL.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (url: URL, host: string): URL;
+};
+/**
+ * Updates the domain of the URL without modifying the port.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export declare const setHostname: {
+    /**
+     * Updates the domain of the URL without modifying the port.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (hostname: string): (url: URL) => URL;
+    /**
+     * Updates the domain of the URL without modifying the port.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (url: URL, hostname: string): URL;
+};
+/**
+ * Replaces the entire URL string.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export declare const setHref: {
+    /**
+     * Replaces the entire URL string.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (href: string): (url: URL) => URL;
+    /**
+     * Replaces the entire URL string.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (url: URL, href: string): URL;
+};
+/**
+ * Updates the password used for authentication.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export declare const setPassword: {
+    /**
+     * Updates the password used for authentication.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (password: string): (url: URL) => URL;
+    /**
+     * Updates the password used for authentication.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (url: URL, password: string): URL;
+};
+/**
+ * Updates the path of the URL.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export declare const setPathname: {
+    /**
+     * Updates the path of the URL.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (pathname: string): (url: URL) => URL;
+    /**
+     * Updates the path of the URL.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (url: URL, pathname: string): URL;
+};
+/**
+ * Updates the port of the URL.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export declare const setPort: {
+    /**
+     * Updates the port of the URL.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (port: string): (url: URL) => URL;
+    /**
+     * Updates the port of the URL.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (url: URL, port: string): URL;
+};
+/**
+ * Updates the protocol (e.g., `http`, `https`).
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export declare const setProtocol: {
+    /**
+     * Updates the protocol (e.g., `http`, `https`).
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (protocol: string): (url: URL) => URL;
+    /**
+     * Updates the protocol (e.g., `http`, `https`).
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (url: URL, protocol: string): URL;
+};
+/**
+ * Updates the query string of the URL.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export declare const setSearch: {
+    /**
+     * Updates the query string of the URL.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (search: string): (url: URL) => URL;
+    /**
+     * Updates the query string of the URL.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (url: URL, search: string): URL;
+};
+/**
+ * Updates the username used for authentication.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export declare const setUsername: {
+    /**
+     * Updates the username used for authentication.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (username: string): (url: URL) => URL;
+    /**
+     * Updates the username used for authentication.
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (url: URL, username: string): URL;
+};
+/**
+ * Updates the query parameters of a URL.
+ *
+ * **Details**
+ *
+ * This function allows you to set or replace the query parameters of a `URL`
+ * object using the provided `UrlParams`. It creates a new `URL` object with the
+ * updated parameters, leaving the original object unchanged.
+ *
+ * @example
+ * ```ts
+ * import { Url, UrlParams } from "@effect/platform"
+ *
+ * const myUrl = new URL("https://example.com?foo=bar")
+ *
+ * // Write parameters
+ * const updatedUrl = Url.setUrlParams(
+ *   myUrl,
+ *   UrlParams.fromInput([["key", "value"]])
+ * )
+ *
+ * console.log(updatedUrl.toString())
+ * // Output: https://example.com/?key=value
+ * ```
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export declare const setUrlParams: {
+    /**
+     * Updates the query parameters of a URL.
+     *
+     * **Details**
+     *
+     * This function allows you to set or replace the query parameters of a `URL`
+     * object using the provided `UrlParams`. It creates a new `URL` object with the
+     * updated parameters, leaving the original object unchanged.
+     *
+     * @example
+     * ```ts
+     * import { Url, UrlParams } from "@effect/platform"
+     *
+     * const myUrl = new URL("https://example.com?foo=bar")
+     *
+     * // Write parameters
+     * const updatedUrl = Url.setUrlParams(
+     *   myUrl,
+     *   UrlParams.fromInput([["key", "value"]])
+     * )
+     *
+     * console.log(updatedUrl.toString())
+     * // Output: https://example.com/?key=value
+     * ```
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (urlParams: UrlParams.UrlParams): (url: URL) => URL;
+    /**
+     * Updates the query parameters of a URL.
+     *
+     * **Details**
+     *
+     * This function allows you to set or replace the query parameters of a `URL`
+     * object using the provided `UrlParams`. It creates a new `URL` object with the
+     * updated parameters, leaving the original object unchanged.
+     *
+     * @example
+     * ```ts
+     * import { Url, UrlParams } from "@effect/platform"
+     *
+     * const myUrl = new URL("https://example.com?foo=bar")
+     *
+     * // Write parameters
+     * const updatedUrl = Url.setUrlParams(
+     *   myUrl,
+     *   UrlParams.fromInput([["key", "value"]])
+     * )
+     *
+     * console.log(updatedUrl.toString())
+     * // Output: https://example.com/?key=value
+     * ```
+     *
+     * @since 1.0.0
+     * @category Setters
+     */
+    (url: URL, urlParams: UrlParams.UrlParams): URL;
+};
+/**
+ * Retrieves the query parameters from a URL.
+ *
+ * **Details**
+ *
+ * This function extracts the query parameters from a `URL` object and returns
+ * them as `UrlParams`. The resulting structure can be easily manipulated or
+ * inspected.
+ *
+ * @example
+ * ```ts
+ * import { Url } from "@effect/platform"
+ *
+ * const myUrl = new URL("https://example.com?foo=bar")
+ *
+ * // Read parameters
+ * const params = Url.urlParams(myUrl)
+ *
+ * console.log(params)
+ * // Output: [ [ 'foo', 'bar' ] ]
+ * ```
+ *
+ * @since 1.0.0
+ * @category Getters
+ */
+export declare const urlParams: (url: URL) => UrlParams.UrlParams;
+/**
+ * Reads, modifies, and updates the query parameters of a URL.
+ *
+ * **Details**
+ *
+ * This function provides a functional way to interact with query parameters by
+ * reading the current parameters, applying a transformation function, and then
+ * writing the updated parameters back to the URL. It returns a new `URL` object
+ * with the modified parameters, ensuring immutability.
+ *
+ * @example
+ * ```ts
+ * import { Url, UrlParams } from "@effect/platform"
+ *
+ * const myUrl = new URL("https://example.com?foo=bar")
+ *
+ * const changedUrl = Url.modifyUrlParams(myUrl, UrlParams.append("key", "value"))
+ *
+ * console.log(changedUrl.toString())
+ * // Output: https://example.com/?foo=bar&key=value
+ * ```
+ *
+ * @since 1.0.0
+ * @category Modifiers
+ */
+export declare const modifyUrlParams: {
+    /**
+     * Reads, modifies, and updates the query parameters of a URL.
+     *
+     * **Details**
+     *
+     * This function provides a functional way to interact with query parameters by
+     * reading the current parameters, applying a transformation function, and then
+     * writing the updated parameters back to the URL. It returns a new `URL` object
+     * with the modified parameters, ensuring immutability.
+     *
+     * @example
+     * ```ts
+     * import { Url, UrlParams } from "@effect/platform"
+     *
+     * const myUrl = new URL("https://example.com?foo=bar")
+     *
+     * const changedUrl = Url.modifyUrlParams(myUrl, UrlParams.append("key", "value"))
+     *
+     * console.log(changedUrl.toString())
+     * // Output: https://example.com/?foo=bar&key=value
+     * ```
+     *
+     * @since 1.0.0
+     * @category Modifiers
+     */
+    (f: (urlParams: UrlParams.UrlParams) => UrlParams.UrlParams): (url: URL) => URL;
+    /**
+     * Reads, modifies, and updates the query parameters of a URL.
+     *
+     * **Details**
+     *
+     * This function provides a functional way to interact with query parameters by
+     * reading the current parameters, applying a transformation function, and then
+     * writing the updated parameters back to the URL. It returns a new `URL` object
+     * with the modified parameters, ensuring immutability.
+     *
+     * @example
+     * ```ts
+     * import { Url, UrlParams } from "@effect/platform"
+     *
+     * const myUrl = new URL("https://example.com?foo=bar")
+     *
+     * const changedUrl = Url.modifyUrlParams(myUrl, UrlParams.append("key", "value"))
+     *
+     * console.log(changedUrl.toString())
+     * // Output: https://example.com/?foo=bar&key=value
+     * ```
+     *
+     * @since 1.0.0
+     * @category Modifiers
+     */
+    (url: URL, f: (urlParams: UrlParams.UrlParams) => UrlParams.UrlParams): URL;
+};
+//# sourceMappingURL=Url.d.ts.map

package/dist/dts/Url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Url.d.ts","sourceRoot":"","sources":["../../src/Url.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AACrC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,eAAO,MAAM,UAAU,EAAE;IACvB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACH,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAA;CAMhG,CAAA;AAEJ;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,MAAM,EAAE;IACnB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,GAAG,CAAC,IAAI,EAAE,GAAG,KAAK,GAAG,CAAA;IAC3C;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,GAAG,GAAG,CAAA;CAKvC,CAAA;AAYF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;OAKG;IACH,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IACjC;;;;;OAKG;IACH,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;CACD,CAAA;AAE9B;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;OAKG;IACH,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IACjC;;;;;OAKG;IACH,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;CACD,CAAA;AAE9B;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE;IACxB;;;;;OAKG;IACH,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IACrC;;;;;OAKG;IACH,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;CACD,CAAA;AAElC;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;OAKG;IACH,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IACjC;;;;;OAKG;IACH,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;CACD,CAAA;AAE9B;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE;IACxB;;;;;OAKG;IACH,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IACrC;;;;;OAKG;IACH,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;CACD,CAAA;AAElC;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE;IACxB;;;;;OAKG;IACH,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IACrC;;;;;OAKG;IACH,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;CACD,CAAA;AAElC;;;;;GAKG;AACH,eAAO,MAAM,OAAO,EAAE;IACpB;;;;;OAKG;IACH,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IACjC;;;;;OAKG;IACH,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,GAAG,GAAG,CAAA;CACD,CAAA;AAE9B;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE;IACxB;;;;;OAKG;IACH,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IACrC;;;;;OAKG;IACH,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;CACD,CAAA;AAElC;;;;;GAKG;AACH,eAAO,MAAM,SAAS,EAAE;IACtB;;;;;OAKG;IACH,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IACnC;;;;;OAKG;IACH,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,GAAG,CAAA;CACD,CAAA;AAEhC;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE;IACxB;;;;;OAKG;IACH,CAAC,QAAQ,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IACrC;;;;;OAKG;IACH,CAAC,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAA;CACD,CAAA;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,YAAY,EAAE;IACzB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IACnD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,SAAS,CAAC,SAAS,GAAG,GAAG,CAAA;CAI5C,CAAA;AAEL;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,SAAS,QAAS,GAAG,KAAG,SAAS,CAAC,SAAkD,CAAA;AAEjG;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,eAAe,EAAE;IAC5B;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,KAAK,SAAS,CAAC,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAA;IAC/E;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,KAAK,SAAS,CAAC,SAAS,GAAG,GAAG,CAAA;CAKxE,CAAA"}

package/dist/dts/index.d.ts

@@ -199,6 +199,10 @@ export * as Terminal from "./Terminal.js";
  * @since 1.0.0
  */
 export * as Transferable from "./Transferable.js";
+/**
+ * @since 1.0.0
+ */
+export * as Url from "./Url.js";
 /**
  * @since 1.0.0
  */

package/dist/dts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAA;AAE7D;;GAEG;AACH,OAAO,KAAK,mBAAmB,MAAM,0BAA0B,CAAA;AAE/D;;;GAGG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,qBAAqB,MAAM,4BAA4B,CAAA;AAEnE;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAA;AAE7D;;GAEG;AACH,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAA;AAEzD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC;;GAEG;AACH,OAAO,KAAK,sBAAsB,MAAM,6BAA6B,CAAA;AAErE;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AAEnC;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAA;AAE7D;;GAEG;AACH,OAAO,KAAK,mBAAmB,MAAM,0BAA0B,CAAA;AAE/D;;;GAGG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,UAAU,MAAM,iBAAiB,CAAA;AAE7C;;GAEG;AACH,OAAO,KAAK,eAAe,MAAM,sBAAsB,CAAA;AAEvD;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,qBAAqB,MAAM,4BAA4B,CAAA;AAEnE;;GAEG;AACH,OAAO,KAAK,kBAAkB,MAAM,yBAAyB,CAAA;AAE7D;;GAEG;AACH,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAA;AAEzD;;GAEG;AACH,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,iBAAiB,MAAM,wBAAwB,CAAA;AAE3D;;GAEG;AACH,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAEjC;;GAEG;AACH,OAAO,KAAK,sBAAsB,MAAM,6BAA6B,CAAA;AAErE;;GAEG;AACH,OAAO,KAAK,cAAc,MAAM,qBAAqB,CAAA;AAErD;;GAEG;AACH,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,QAAQ,MAAM,eAAe,CAAA;AAEzC;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAE/B;;GAEG;AACH,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAA;AAE3C;;GAEG;AACH,OAAO,KAAK,MAAM,MAAM,aAAa,CAAA;AAErC;;GAEG;AACH,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAA;AAE/C;;GAEG;AACH,OAAO,KAAK,YAAY,MAAM,mBAAmB,CAAA"}

package/dist/esm/HttpApi.js

@@ -169,31 +169,32 @@ export const reflect = (self, options) => {
 };
 // -------------------------------------------------------------------------------------
 const emptyMap = /*#__PURE__*/new Map();
-const extractMembers = (topAst, inherited, getStatus) => {
+const extractMembers = (ast, inherited, getStatus) => {
   const members = new Map(inherited);
-  function process(ast) {
-    if (ast._tag === "NeverKeyword") {
+  function process(type) {
+    if (AST.isNeverKeyword(type)) {
       return;
     }
-    ast = AST.annotations(ast, {
-      ...HttpApiSchema.extractAnnotations(topAst.annotations),
-      ...ast.annotations
-    });
-    const status = getStatus(ast);
-    const emptyDecodeable = HttpApiSchema.getEmptyDecodeable(ast);
+    const annotations = HttpApiSchema.extractAnnotations(ast.annotations);
+    // Avoid changing the reference unless necessary
+    // Otherwise, deduplication of the ASTs below will not be possible
+    if (!Record.isEmptyRecord(annotations)) {
+      type = AST.annotations(type, {
+        ...annotations,
+        ...type.annotations
+      });
+    }
+    const status = getStatus(type);
+    const emptyDecodeable = HttpApiSchema.getEmptyDecodeable(type);
     const current = members.get(status);
     members.set(status, {
-      description: (current ? current.description : Option.none()).pipe(Option.orElse(() => getDescriptionOrIdentifier(ast))),
-      ast: (current ? current.ast : Option.none()).pipe(Option.map(current => AST.Union.make(current._tag === "Union" ? [...current.types, ast] : [current, ast])), Option.orElse(() => !emptyDecodeable && AST.encodedAST(ast)._tag === "VoidKeyword" ? Option.none() : Option.some(ast)))
+      description: (current ? current.description : Option.none()).pipe(Option.orElse(() => getDescriptionOrIdentifier(type))),
+      ast: (current ? current.ast : Option.none()).pipe(
+      // Deduplicate the ASTs
+      Option.map(current => HttpApiSchema.UnionUnifyAST(current, type)), Option.orElse(() => !emptyDecodeable && AST.isVoidKeyword(AST.encodedAST(type)) ? Option.none() : Option.some(type)))
     });
   }
-  if (topAst._tag === "Union") {
-    for (const type of topAst.types) {
-      process(type);
-    }
-  } else {
-    process(topAst);
-  }
+  HttpApiSchema.extractUnionTypes(ast).forEach(process);
   return members;
 };
 const extractPayloads = topAst => {
@@ -235,6 +236,9 @@ const getDescriptionOrIdentifier = ast => {
   return Option.fromNullable(annotations[AST.DescriptionAnnotationId] ?? annotations[AST.IdentifierAnnotationId]);
 };
 /**
+ * Adds additional schemas to components/schemas.
+ * The provided schemas must have a `identifier` annotation.
+ *
  * @since 1.0.0
  * @category tags
  */