@clayroach/effect 3.19.14-source-capture.6 → 3.19.14-source-capture.8

package/src/ConfigError.ts

@@ -1,270 +0,0 @@
-/**
- * @since 2.0.0
- */
-import type * as Cause from "./Cause.js"
-import * as internal from "./internal/configError.js"
-
-/**
- * @since 2.0.0
- * @category symbols
- */
-export const ConfigErrorTypeId: unique symbol = internal.ConfigErrorTypeId
-
-/**
- * @since 2.0.0
- * @category symbols
- */
-export type ConfigErrorTypeId = typeof ConfigErrorTypeId
-
-/**
- * The possible ways that loading configuration data may fail.
- *
- * @since 2.0.0
- * @category models
- */
-export type ConfigError =
-  | And
-  | Or
-  | InvalidData
-  | MissingData
-  | SourceUnavailable
-  | Unsupported
-
-/**
- * @since 2.0.0
- */
-export declare namespace ConfigError {
-  /**
-   * @since 2.0.0
-   * @category models
-   */
-  export interface Proto {
-    readonly _tag: "ConfigError"
-    readonly [ConfigErrorTypeId]: ConfigErrorTypeId
-  }
-
-  /**
-   * @since 2.0.0
-   * @category models
-   */
-  export type Reducer<C, Z> = ConfigErrorReducer<C, Z>
-}
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface ConfigErrorReducer<in C, in out Z> {
-  andCase(context: C, left: Z, right: Z): Z
-  orCase(context: C, left: Z, right: Z): Z
-  invalidDataCase(context: C, path: Array<string>, message: string): Z
-  missingDataCase(context: C, path: Array<string>, message: string): Z
-  sourceUnavailableCase(
-    context: C,
-    path: Array<string>,
-    message: string,
-    cause: Cause.Cause<unknown>
-  ): Z
-  unsupportedCase(context: C, path: Array<string>, message: string): Z
-}
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface And extends ConfigError.Proto {
-  readonly _op: "And"
-  readonly left: ConfigError
-  readonly right: ConfigError
-  readonly message: string
-}
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface Or extends ConfigError.Proto {
-  readonly _op: "Or"
-  readonly left: ConfigError
-  readonly right: ConfigError
-  readonly message: string
-}
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface InvalidData extends ConfigError.Proto {
-  readonly _op: "InvalidData"
-  readonly path: Array<string>
-  readonly message: string
-}
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface MissingData extends ConfigError.Proto {
-  readonly _op: "MissingData"
-  readonly path: Array<string>
-  readonly message: string
-}
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface SourceUnavailable extends ConfigError.Proto {
-  readonly _op: "SourceUnavailable"
-  readonly path: Array<string>
-  readonly message: string
-  readonly cause: Cause.Cause<unknown>
-}
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface Unsupported extends ConfigError.Proto {
-  readonly _op: "Unsupported"
-  readonly path: Array<string>
-  readonly message: string
-}
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface Options {
-  readonly pathDelim: string
-}
-
-/**
- * @since 2.0.0
- * @category constructors
- */
-export const And: (self: ConfigError, that: ConfigError) => ConfigError = internal.And
-
-/**
- * @since 2.0.0
- * @category constructors
- */
-export const Or: (self: ConfigError, that: ConfigError) => ConfigError = internal.Or
-
-/**
- * @since 2.0.0
- * @category constructors
- */
-export const MissingData: (path: Array<string>, message: string, options?: Options) => ConfigError =
-  internal.MissingData
-
-/**
- * @since 2.0.0
- * @category constructors
- */
-export const InvalidData: (path: Array<string>, message: string, options?: Options) => ConfigError =
-  internal.InvalidData
-
-/**
- * @since 2.0.0
- * @category constructors
- */
-export const SourceUnavailable: (
-  path: Array<string>,
-  message: string,
-  cause: Cause.Cause<unknown>,
-  options?: Options
-) => ConfigError = internal.SourceUnavailable
-
-/**
- * @since 2.0.0
- * @category constructors
- */
-export const Unsupported: (path: Array<string>, message: string, options?: Options) => ConfigError =
-  internal.Unsupported
-
-/**
- * Returns `true` if the specified value is a `ConfigError`, `false` otherwise.
- *
- * @since 2.0.0
- * @category refinements
- */
-export const isConfigError: (u: unknown) => u is ConfigError = internal.isConfigError
-
-/**
- * Returns `true` if the specified `ConfigError` is an `And`, `false` otherwise.
- *
- * @since 2.0.0
- * @category refinements
- */
-export const isAnd: (self: ConfigError) => self is And = internal.isAnd
-
-/**
- * Returns `true` if the specified `ConfigError` is an `Or`, `false` otherwise.
- *
- * @since 2.0.0
- * @category refinements
- */
-export const isOr: (self: ConfigError) => self is Or = internal.isOr
-
-/**
- * Returns `true` if the specified `ConfigError` is an `InvalidData`, `false`
- * otherwise.
- *
- * @since 2.0.0
- * @category refinements
- */
-export const isInvalidData: (self: ConfigError) => self is InvalidData = internal.isInvalidData
-
-/**
- * Returns `true` if the specified `ConfigError` is an `MissingData`, `false`
- * otherwise.
- *
- * @since 2.0.0
- * @category refinements
- */
-export const isMissingData: (self: ConfigError) => self is MissingData = internal.isMissingData
-
-/**
- * Returns `true` if the specified `ConfigError` contains only `MissingData` errors, `false` otherwise.
- *
- * @since 2.0.0
- * @categer getters
- */
-export const isMissingDataOnly: (self: ConfigError) => boolean = internal.isMissingDataOnly
-
-/**
- * Returns `true` if the specified `ConfigError` is a `SourceUnavailable`,
- * `false` otherwise.
- *
- * @since 2.0.0
- * @category refinements
- */
-export const isSourceUnavailable: (self: ConfigError) => self is SourceUnavailable = internal.isSourceUnavailable
-
-/**
- * Returns `true` if the specified `ConfigError` is an `Unsupported`, `false`
- * otherwise.
- *
- * @since 2.0.0
- * @category refinements
- */
-export const isUnsupported: (self: ConfigError) => self is Unsupported = internal.isUnsupported
-
-/**
- * @since 2.0.0
- * @category utils
- */
-export const prefixed: {
-  (prefix: Array<string>): (self: ConfigError) => ConfigError
-  (self: ConfigError, prefix: Array<string>): ConfigError
-} = internal.prefixed
-
-/**
- * @since 2.0.0
- * @category folding
- */
-export const reduceWithContext: {
-  <C, Z>(context: C, reducer: ConfigErrorReducer<C, Z>): (self: ConfigError) => Z
-  <C, Z>(self: ConfigError, context: C, reducer: ConfigErrorReducer<C, Z>): Z
-} = internal.reduceWithContext

package/src/ConfigProvider.ts

@@ -1,333 +0,0 @@
-/**
- * @since 2.0.0
- */
-import type * as Config from "./Config.js"
-import type * as ConfigError from "./ConfigError.js"
-import type * as PathPatch from "./ConfigProviderPathPatch.js"
-import type * as Context from "./Context.js"
-import type * as Effect from "./Effect.js"
-import type { LazyArg } from "./Function.js"
-import type * as HashSet from "./HashSet.js"
-import * as internal from "./internal/configProvider.js"
-import type { Pipeable } from "./Pipeable.js"
-
-/**
- * @since 2.0.0
- * @category symbols
- */
-export const ConfigProviderTypeId: unique symbol = internal.ConfigProviderTypeId
-
-/**
- * @since 2.0.0
- * @category symbols
- */
-export type ConfigProviderTypeId = typeof ConfigProviderTypeId
-
-/**
- * @since 2.0.0
- * @category symbols
- */
-export const FlatConfigProviderTypeId: unique symbol = internal.FlatConfigProviderTypeId
-
-/**
- * @since 2.0.0
- * @category symbols
- */
-export type FlatConfigProviderTypeId = typeof FlatConfigProviderTypeId
-
-/**
- * A ConfigProvider is a service that provides configuration given a description
- * of the structure of that configuration.
- *
- * @since 2.0.0
- * @category models
- */
-export interface ConfigProvider extends ConfigProvider.Proto, Pipeable {
-  /**
-   * Loads the specified configuration, or fails with a config error.
-   */
-  load<A>(config: Config.Config<A>): Effect.Effect<A, ConfigError.ConfigError>
-  /**
-   * Flattens this config provider into a simplified config provider that knows
-   * only how to deal with flat (key/value) properties.
-   */
-  readonly flattened: ConfigProvider.Flat
-}
-
-/**
- * @since 2.0.0
- */
-export declare namespace ConfigProvider {
-  /**
-   * @since 2.0.0
-   * @category models
-   */
-  export interface Proto {
-    readonly [ConfigProviderTypeId]: ConfigProviderTypeId
-  }
-
-  /**
-   * A simplified config provider that knows only how to deal with flat
-   * (key/value) properties. Because these providers are common, there is
-   * special support for implementing them.
-   *
-   * @since 2.0.0
-   * @category models
-   */
-  export interface Flat {
-    readonly [FlatConfigProviderTypeId]: FlatConfigProviderTypeId
-    readonly patch: PathPatch.PathPatch
-    load<A>(
-      path: ReadonlyArray<string>,
-      config: Config.Config.Primitive<A>,
-      split?: boolean
-    ): Effect.Effect<Array<A>, ConfigError.ConfigError>
-    enumerateChildren(
-      path: ReadonlyArray<string>
-    ): Effect.Effect<HashSet.HashSet<string>, ConfigError.ConfigError>
-  }
-
-  /**
-   * @since 2.0.0
-   * @category models
-   */
-  export interface FromMapConfig {
-    readonly pathDelim: string
-    readonly seqDelim: string
-  }
-
-  /**
-   * @since 2.0.0
-   * @category models
-   */
-  export interface FromEnvConfig {
-    readonly pathDelim: string
-    readonly seqDelim: string
-  }
-
-  /**
-   * @since 1.0.0
-   * @category models
-   */
-  export type KeyComponent = KeyName | KeyIndex
-
-  /**
-   * @since 1.0.0
-   * @category models
-   */
-  export interface KeyName {
-    readonly _tag: "KeyName"
-    readonly name: string
-  }
-
-  /**
-   * @since 1.0.0
-   * @category models
-   */
-  export interface KeyIndex {
-    readonly _tag: "KeyIndex"
-    readonly index: number
-  }
-}
-
-/**
- * The service tag for `ConfigProvider`.
- *
- * @since 2.0.0
- * @category context
- */
-export const ConfigProvider: Context.Tag<ConfigProvider, ConfigProvider> = internal.configProviderTag
-
-/**
- * Creates a new config provider.
- *
- * @since 2.0.0
- * @category constructors
- */
-export const make: (
-  options: {
-    readonly load: <A>(config: Config.Config<A>) => Effect.Effect<A, ConfigError.ConfigError>
-    readonly flattened: ConfigProvider.Flat
-  }
-) => ConfigProvider = internal.make
-
-/**
- * Creates a new flat config provider.
- *
- * @since 2.0.0
- * @category constructors
- */
-export const makeFlat: (options: {
-  readonly load: <A>(
-    path: ReadonlyArray<string>,
-    config: Config.Config.Primitive<A>,
-    split: boolean
-  ) => Effect.Effect<Array<A>, ConfigError.ConfigError>
-  readonly enumerateChildren: (
-    path: ReadonlyArray<string>
-  ) => Effect.Effect<HashSet.HashSet<string>, ConfigError.ConfigError>
-  readonly patch: PathPatch.PathPatch
-}) => ConfigProvider.Flat = internal.makeFlat
-
-/**
- * A config provider that loads configuration from context variables
- *
- * **Options**:
- *
- * - `pathDelim`: The delimiter for the path segments (default: `"_"`).
- * - `seqDelim`: The delimiter for the sequence of values (default: `","`).
- *
- * @since 2.0.0
- * @category constructors
- */
-export const fromEnv: (options?: Partial<ConfigProvider.FromEnvConfig>) => ConfigProvider = internal.fromEnv
-
-/**
- * Constructs a new `ConfigProvider` from a key/value (flat) provider, where
- * nesting is embedded into the string keys.
- *
- * @since 2.0.0
- * @category constructors
- */
-export const fromFlat: (flat: ConfigProvider.Flat) => ConfigProvider = internal.fromFlat
-
-/**
- * Constructs a new `ConfigProvider` from a JSON object.
- *
- * @since 2.0.0
- * @category constructors
- */
-export const fromJson: (json: unknown) => ConfigProvider = internal.fromJson
-
-// TODO(4.0): use `_` for nested configs instead of `.` in next major
-/**
- * Constructs a ConfigProvider using a map and the specified delimiter string,
- * which determines how to split the keys in the map into path segments.
- *
- * @since 2.0.0
- * @category constructors
- */
-export const fromMap: (map: Map<string, string>, config?: Partial<ConfigProvider.FromMapConfig>) => ConfigProvider =
-  internal.fromMap
-
-/**
- * Returns a new config provider that will automatically convert all property
- * names to constant case. This can be utilized to adapt the names of
- * configuration properties from the default naming convention of camel case
- * to the naming convention of a config provider.
- *
- * @since 2.0.0
- * @category combinators
- */
-export const constantCase: (self: ConfigProvider) => ConfigProvider = internal.constantCase
-
-/**
- * Returns a new config provider that will automatically tranform all path
- * configuration names with the specified function. This can be utilized to
- * adapt the names of configuration properties from one naming convention to
- * another.
- *
- * @since 2.0.0
- * @category utils
- */
-export const mapInputPath: {
-  (f: (path: string) => string): (self: ConfigProvider) => ConfigProvider
-  (self: ConfigProvider, f: (path: string) => string): ConfigProvider
-} = internal.mapInputPath
-
-/**
- * Returns a new config provider that will automatically convert all property
- * names to kebab case. This can be utilized to adapt the names of
- * configuration properties from the default naming convention of camel case
- * to the naming convention of a config provider.
- *
- * @since 2.0.0
- * @category combinators
- */
-export const kebabCase: (self: ConfigProvider) => ConfigProvider = internal.kebabCase
-
-/**
- * Returns a new config provider that will automatically convert all property
- * names to lower case. This can be utilized to adapt the names of
- * configuration properties from the default naming convention of camel case
- * to the naming convention of a config provider.
- *
- * @since 2.0.0
- * @category combinators
- */
-export const lowerCase: (self: ConfigProvider) => ConfigProvider = internal.lowerCase
-
-/**
- * Returns a new config provider that will automatically nest all
- * configuration under the specified property name. This can be utilized to
- * aggregate separate configuration sources that are all required to load a
- * single configuration value.
- *
- * @since 2.0.0
- * @category utils
- */
-export const nested: {
-  (name: string): (self: ConfigProvider) => ConfigProvider
-  (self: ConfigProvider, name: string): ConfigProvider
-} = internal.nested
-
-/**
- * Returns a new config provider that preferentially loads configuration data
- * from this one, but which will fall back to the specified alternate provider
- * if there are any issues loading the configuration from this provider.
- *
- * @since 2.0.0
- * @category utils
- */
-export const orElse: {
-  (that: LazyArg<ConfigProvider>): (self: ConfigProvider) => ConfigProvider
-  (self: ConfigProvider, that: LazyArg<ConfigProvider>): ConfigProvider
-} = internal.orElse
-
-/**
- * Returns a new config provider that will automatically un-nest all
- * configuration under the specified property name. This can be utilized to
- * de-aggregate separate configuration sources that are all required to load a
- * single configuration value.
- *
- * @since 2.0.0
- * @category utils
- */
-export const unnested: {
-  (name: string): (self: ConfigProvider) => ConfigProvider
-  (self: ConfigProvider, name: string): ConfigProvider
-} = internal.unnested
-
-/**
- * Returns a new config provider that will automatically convert all property
- * names to upper case. This can be utilized to adapt the names of
- * configuration properties from the default naming convention of camel case
- * to the naming convention of a config provider.
- *
- * @since 2.0.0
- * @category combinators
- */
-export const snakeCase: (self: ConfigProvider) => ConfigProvider = internal.snakeCase
-
-/**
- * Returns a new config provider that will automatically convert all property
- * names to upper case. This can be utilized to adapt the names of
- * configuration properties from the default naming convention of camel case
- * to the naming convention of a config provider.
- *
- * @since 2.0.0
- * @category combinators
- */
-export const upperCase: (self: ConfigProvider) => ConfigProvider = internal.upperCase
-
-/**
- * Returns a new config provider that transforms the config provider with the
- * specified function within the specified path.
- *
- * @since 2.0.0
- * @category combinators
- */
-export const within: {
-  (path: ReadonlyArray<string>, f: (self: ConfigProvider) => ConfigProvider): (self: ConfigProvider) => ConfigProvider
-  (self: ConfigProvider, path: ReadonlyArray<string>, f: (self: ConfigProvider) => ConfigProvider): ConfigProvider
-} = internal.within

package/src/ConfigProviderPathPatch.ts

@@ -1,100 +0,0 @@
-/**
- * @since 2.0.0
- */
-import * as internal from "./internal/configProvider/pathPatch.js"
-
-/**
- * Represents a description of how to modify the path to a configuration
- * value.
- *
- * @since 2.0.0
- * @category models
- */
-export type PathPatch = Empty | AndThen | MapName | Nested | Unnested
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface Empty {
-  readonly _tag: "Empty"
-}
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface AndThen {
-  readonly _tag: "AndThen"
-  readonly first: PathPatch
-  readonly second: PathPatch
-}
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface MapName {
-  readonly _tag: "MapName"
-  f(string: string): string
-}
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface Nested {
-  readonly _tag: "Nested"
-  readonly name: string
-}
-
-/**
- * @since 2.0.0
- * @category models
- */
-export interface Unnested {
-  readonly _tag: "Unnested"
-  readonly name: string
-}
-
-/**
- * @since 2.0.0
- * @category constructors
- */
-export const empty: PathPatch = internal.empty
-
-/**
- * @since 2.0.0
- * @category constructors
- */
-export const andThen: {
-  (that: PathPatch): (self: PathPatch) => PathPatch
-  (self: PathPatch, that: PathPatch): PathPatch
-} = internal.andThen
-
-/**
- * @since 2.0.0
- * @category constructors
- */
-export const mapName: {
-  (f: (string: string) => string): (self: PathPatch) => PathPatch
-  (self: PathPatch, f: (string: string) => string): PathPatch
-} = internal.mapName
-
-/**
- * @since 2.0.0
- * @category constructors
- */
-export const nested: {
-  (name: string): (self: PathPatch) => PathPatch
-  (self: PathPatch, name: string): PathPatch
-} = internal.nested
-
-/**
- * @since 2.0.0
- * @category constructors
- */
-export const unnested: {
-  (name: string): (self: PathPatch) => PathPatch
-  (self: PathPatch, name: string): PathPatch
-} = internal.unnested