@effect/platform 0.72.1 → 0.73.0

package/src/OpenApiJsonSchema.ts

@@ -4,6 +4,7 @@
 import * as JSONSchema from "effect/JSONSchema"
 import * as Record from "effect/Record"
 import type * as Schema from "effect/Schema"
+import type * as AST from "effect/SchemaAST"
 
 /**
  * @category model
@@ -270,8 +271,15 @@ export const makeWithDefs = <A, I, R>(schema: Schema.Schema<A, I, R>, options: {
   readonly defs: Record<string, any>
   readonly defsPath?: string
   readonly topLevelReferenceStrategy?: "skip" | "keep"
+}): JsonSchema => fromAST(schema.ast, options)
+
+/** @internal */
+export const fromAST = (ast: AST.AST, options: {
+  readonly defs: Record<string, any>
+  readonly defsPath?: string
+  readonly topLevelReferenceStrategy?: "skip" | "keep"
 }): JsonSchema => {
-  const jsonSchema = JSONSchema.fromAST(schema.ast, {
+  const jsonSchema = JSONSchema.fromAST(ast, {
     definitions: options.defs,
     definitionPath: options.defsPath ?? "#/components/schemas/",
     target: "openApi3.1",

package/src/Runtime.ts

@@ -36,6 +36,30 @@ export const defaultTeardown: Teardown = <E, A>(
  * @since 1.0.0
  */
 export interface RunMain {
+  /**
+   * Helps you run a main effect with built-in error handling, logging, and signal management.
+   *
+   * **Details**
+   *
+   * This function launches an Effect as the main entry point, setting exit codes
+   * based on success or failure, handling interrupts (e.g., Ctrl+C), and optionally
+   * logging errors. By default, it logs errors and uses a "pretty" format, but both
+   * behaviors can be turned off. You can also provide custom teardown logic to
+   * finalize resources or produce different exit codes.
+   *
+   * **Options**
+   *
+   * An optional object that can include:
+   * - `disableErrorReporting`: Turn off automatic error logging.
+   * - `disablePrettyLogger`: Avoid adding the pretty logger.
+   * - `teardown`: Provide custom finalization logic.
+   *
+   * **When to Use**
+   *
+   * Use this function to run an Effect as your application’s main program, especially
+   * when you need structured error handling, log management, interrupt support,
+   * or advanced teardown capabilities.
+   */
   (
     options?: {
       readonly disableErrorReporting?: boolean | undefined
@@ -43,6 +67,30 @@ export interface RunMain {
       readonly teardown?: Teardown | undefined
     }
   ): <E, A>(effect: Effect.Effect<A, E>) => void
+  /**
+   * Helps you run a main effect with built-in error handling, logging, and signal management.
+   *
+   * **Details**
+   *
+   * This function launches an Effect as the main entry point, setting exit codes
+   * based on success or failure, handling interrupts (e.g., Ctrl+C), and optionally
+   * logging errors. By default, it logs errors and uses a "pretty" format, but both
+   * behaviors can be turned off. You can also provide custom teardown logic to
+   * finalize resources or produce different exit codes.
+   *
+   * **Options**
+   *
+   * An optional object that can include:
+   * - `disableErrorReporting`: Turn off automatic error logging.
+   * - `disablePrettyLogger`: Avoid adding the pretty logger.
+   * - `teardown`: Provide custom finalization logic.
+   *
+   * **When to Use**
+   *
+   * Use this function to run an Effect as your application’s main program, especially
+   * when you need structured error handling, log management, interrupt support,
+   * or advanced teardown capabilities.
+   */
   <E, A>(
     effect: Effect.Effect<A, E>,
     options?: {

package/src/Url.ts

@@ -0,0 +1,632 @@
+/**
+ * @since 1.0.0
+ */
+import * as Cause from "effect/Cause"
+import * as Either from "effect/Either"
+import { dual } from "effect/Function"
+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 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>
+} = (url, base) =>
+  Either.try({
+    try: () => new URL(url, base),
+    catch: (cause) =>
+      new Cause.IllegalArgumentException(cause instanceof globalThis.Error ? cause.message : "Invalid input")
+  })
+
+/**
+ * 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 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
+} = dual(2, (self: URL, f: (url: URL) => void) => {
+  const copy = new URL(self)
+  f(copy)
+  return copy
+})
+
+/** @internal */
+const immutableURLSetter = <P extends keyof URL>(property: P): {
+  (value: URL[P]): (url: URL) => URL
+  (url: URL, value: URL[P]): URL
+} =>
+  dual(2, (url: URL, value: URL[P]) =>
+    mutate(url, (url) => {
+      url[property] = value
+    }))
+
+/**
+ * Updates the hash fragment of the URL.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export 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
+} = immutableURLSetter("hash")
+
+/**
+ * Updates the host (domain and port) of the URL.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export 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
+} = immutableURLSetter("host")
+
+/**
+ * Updates the domain of the URL without modifying the port.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export 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
+} = immutableURLSetter("hostname")
+
+/**
+ * Replaces the entire URL string.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export 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
+} = immutableURLSetter("href")
+
+/**
+ * Updates the password used for authentication.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export 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
+} = immutableURLSetter("password")
+
+/**
+ * Updates the path of the URL.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export 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
+} = immutableURLSetter("pathname")
+
+/**
+ * Updates the port of the URL.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export 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
+} = immutableURLSetter("port")
+
+/**
+ * Updates the protocol (e.g., `http`, `https`).
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export 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
+} = immutableURLSetter("protocol")
+
+/**
+ * Updates the query string of the URL.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export 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
+} = immutableURLSetter("search")
+
+/**
+ * Updates the username used for authentication.
+ *
+ * @since 1.0.0
+ * @category Setters
+ */
+export 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
+} = immutableURLSetter("username")
+
+/**
+ * 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 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
+} = dual(2, (url: URL, searchParams: UrlParams.UrlParams) =>
+  mutate(url, (url) => {
+    url.search = UrlParams.toString(searchParams)
+  }))
+
+/**
+ * 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 const urlParams = (url: URL): UrlParams.UrlParams => UrlParams.fromInput(url.searchParams)
+
+/**
+ * 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 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
+} = dual(2, (url: URL, f: (urlParams: UrlParams.UrlParams) => UrlParams.UrlParams) =>
+  mutate(url, (url) => {
+    const params = f(UrlParams.fromInput(url.searchParams))
+    url.search = UrlParams.toString(params)
+  }))