effect 4.0.0-beta.67 → 4.0.0-beta.68

package/src/Config.ts

@@ -104,8 +104,8 @@ const TypeId = "~effect/Config"
  * console.log(Config.isConfig("not a config"))        // false
  * ```
  *
- * @category Guards
- * @since 4.0.0
+ * @category guards
+ * @since 2.0.0
  */
 export const isConfig = (u: unknown): u is Config<unknown> => Predicate.hasProperty(u, TypeId)
 
@@ -125,7 +125,7 @@ export const isConfig = (u: unknown): u is Config<unknown> => Predicate.hasPrope
  * @see {@link orElse} – recover from a ConfigError
  * @see {@link withDefault} – provide a fallback for missing-data errors
  *
- * @category Models
+ * @category errors
  * @since 4.0.0
  */
 export class ConfigError {
@@ -156,7 +156,8 @@ export class ConfigError {
  * @see {@link schema} – the main way to create a Config
  * @see {@link make} – low-level constructor
  *
- * @since 4.0.0
+ * @category models
+ * @since 2.0.0
  */
 export interface Config<out T> extends Effect.Effect<T, ConfigError> {
   readonly [TypeId]: typeof TypeId
@@ -208,7 +209,7 @@ const Proto = {
  *
  * @see {@link schema} – higher-level constructor using Schema codecs
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function make<T>(
@@ -243,8 +244,8 @@ export function make<T>(
  *
  * @see {@link mapOrFail} – when the transformation can fail
  *
- * @category Mapping
- * @since 4.0.0
+ * @category mapping
+ * @since 2.0.0
  */
 export const map: {
   /**
@@ -271,8 +272,8 @@ export const map: {
    *
    * @see {@link mapOrFail} – when the transformation can fail
    *
-   * @category Mapping
-   * @since 4.0.0
+   * @category mapping
+   * @since 2.0.0
    */
   <A, B>(f: (a: A) => B): (self: Config<A>) => Config<B>
   /**
@@ -299,8 +300,8 @@ export const map: {
    *
    * @see {@link mapOrFail} – when the transformation can fail
    *
-   * @category Mapping
-   * @since 4.0.0
+   * @category mapping
+   * @since 2.0.0
    */
   <A, B>(self: Config<A>, f: (a: A) => B): Config<B>
 } = dual(2, <A, B>(self: Config<A>, f: (a: A) => B): Config<B> => {
@@ -328,8 +329,8 @@ export const map: {
  *
  * @see {@link map} – when the transformation cannot fail
  *
- * @category Mapping
- * @since 4.0.0
+ * @category mapping
+ * @since 2.0.0
  */
 export const mapOrFail: {
   /**
@@ -353,8 +354,8 @@ export const mapOrFail: {
    *
    * @see {@link map} – when the transformation cannot fail
    *
-   * @category Mapping
-   * @since 4.0.0
+   * @category mapping
+   * @since 2.0.0
    */
   <A, B>(f: (a: A) => Effect.Effect<B, ConfigError>): (self: Config<A>) => Config<B>
   /**
@@ -378,8 +379,8 @@ export const mapOrFail: {
    *
    * @see {@link map} – when the transformation cannot fail
    *
-   * @category Mapping
-   * @since 4.0.0
+   * @category mapping
+   * @since 2.0.0
    */
   <A, B>(self: Config<A>, f: (a: A) => Effect.Effect<B, ConfigError>): Config<B>
 } = dual(2, <A, B>(self: Config<A>, f: (a: A) => Effect.Effect<B, ConfigError>): Config<B> => {
@@ -411,7 +412,8 @@ export const mapOrFail: {
  *
  * @see {@link withDefault} – fallback only on missing data
  *
- * @since 4.0.0
+ * @category combinators
+ * @since 2.0.0
  */
 export const orElse: {
   /**
@@ -439,7 +441,8 @@ export const orElse: {
    *
    * @see {@link withDefault} – fallback only on missing data
    *
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   <A2>(that: (error: ConfigError) => Config<A2>): <A>(self: Config<A>) => Config<A2 | A>
   /**
@@ -467,7 +470,8 @@ export const orElse: {
    *
    * @see {@link withDefault} – fallback only on missing data
    *
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   <A, A2>(self: Config<A>, that: (error: ConfigError) => Config<A2>): Config<A | A2>
 } = dual(2, <A, A2>(self: Config<A>, that: (error: ConfigError) => Config<A2>): Config<A | A2> => {
@@ -498,7 +502,8 @@ export const orElse: {
  * // { host: "localhost", port: 5432 }
  * ```
  *
- * @since 4.0.0
+ * @category combinators
+ * @since 2.0.0
  */
 export function all<const Arg extends Iterable<Config<any>> | Record<string, Config<any>>>(
   arg: Arg
@@ -576,7 +581,8 @@ function isMissingDataOnly(issue: Issue.Issue): boolean {
  * @see {@link option} – returns `Option` instead of a default value
  * @see {@link orElse} – catches all errors, not just missing data
  *
- * @since 4.0.0
+ * @category combinators
+ * @since 2.0.0
  */
 export const withDefault: {
   /**
@@ -605,7 +611,8 @@ export const withDefault: {
    * @see {@link option} – returns `Option` instead of a default value
    * @see {@link orElse} – catches all errors, not just missing data
    *
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   <const A2>(defaultValue: A2): <A>(self: Config<A>) => Config<A2 | A>
   /**
@@ -634,7 +641,8 @@ export const withDefault: {
    * @see {@link option} – returns `Option` instead of a default value
    * @see {@link orElse} – catches all errors, not just missing data
    *
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   <A, const A2>(self: Config<A>, defaultValue: A2): Config<A | A2>
 } = dual(2, <A, const A2>(self: Config<A>, defaultValue: A2): Config<A | A2> => {
@@ -673,7 +681,8 @@ export const withDefault: {
  *
  * @see {@link withDefault} – provide a concrete fallback value instead
  *
- * @since 4.0.0
+ * @category combinators
+ * @since 2.0.0
  */
 export const option = <A>(self: Config<A>): Config<Option.Option<A>> =>
   self.pipe(map(Option.some), withDefault(Option.none()))
@@ -681,7 +690,8 @@ export const option = <A>(self: Config<A>): Config<Option.Option<A>> =>
 /**
  * Extracts the successfully parsed value type from a `Config`.
  *
- * @since 3.0.0
+ * @category utility types
+ * @since 2.5.0
  */
 export type Success<T> = [T] extends [Config<infer A>] ? A : never
 
@@ -698,7 +708,7 @@ export type Success<T> = [T] extends [Config<infer A>] ? A : never
  * @see {@link unwrap} – construct a `Config` from a `Wrap<T>`
  *
  * @category Wrap
- * @since 4.0.0
+ * @since 2.0.0
  */
 export type Wrap<A> = [NonNullable<A>] extends [infer T] ? [IsPlainObject<T>] extends [true] ?
       | { readonly [K in keyof A]: Wrap<A[K]> }
@@ -736,7 +746,7 @@ type IsPlainObject<A> = [A] extends [Record<string, any>]
  * @see {@link Wrap} – the utility type accepted by this function
  *
  * @category Wrap
- * @since 4.0.0
+ * @since 2.0.0
  */
 export const unwrap = <T>(wrapped: Wrap<T>): Config<T> => {
   if (isConfig(wrapped)) return wrapped
@@ -883,7 +893,7 @@ const recur: (
  * @see {@link string} / {@link number} / {@link boolean} – shortcuts for
  *   single-value configs
  *
- * @category Schema
+ * @category schemas
  * @since 4.0.0
  */
 export function schema<T, E>(codec: Schema.Codec<T, E>, path?: string | ConfigProvider.Path): Config<T> {
@@ -924,7 +934,7 @@ export const FalseValues = Schema.Literals(["false", "no", "off", "0", "n"])
  *
  * @see {@link boolean} – convenience constructor
  *
- * @category Schema
+ * @category schemas
  * @since 4.0.0
  */
 export const Boolean = Schema.Literals([...TrueValues.literals, ...FalseValues.literals]).pipe(
@@ -946,7 +956,7 @@ export const Boolean = Schema.Literals([...TrueValues.literals, ...FalseValues.l
  *
  * @see {@link port} – convenience constructor
  *
- * @category Schema
+ * @category schemas
  * @since 4.0.0
  */
 export const Port = Schema.Int.check(Schema.isBetween({ minimum: 1, maximum: 65535 }))
@@ -963,7 +973,7 @@ export const Port = Schema.Int.check(Schema.isBetween({ minimum: 1, maximum: 655
  *
  * @see {@link logLevel} – convenience constructor
  *
- * @category Schema
+ * @category schemas
  * @since 4.0.0
  */
 export const LogLevel = Schema.Literals(LogLevel_.values)
@@ -1003,7 +1013,7 @@ export const LogLevel = Schema.Literals(LogLevel_.values)
  * // }
  * ```
  *
- * @category Schemas
+ * @category schemas
  * @since 4.0.0
  */
 export const Record = <K extends Schema.Record.Key, V extends Schema.Top>(key: K, value: V, options?: {
@@ -1033,8 +1043,8 @@ export const Record = <K extends Schema.Record.Key, V extends Schema.Top>(key: K
  * - Inside {@link orElse} to re-raise a specific error.
  * - Testing error handling paths.
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export function fail(err: SourceError | Schema.SchemaError) {
   return make(() => Effect.fail(new ConfigError(err)))
@@ -1058,8 +1068,8 @@ export function fail(err: SourceError | Schema.SchemaError) {
  * )
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export function succeed<T>(value: T) {
   return make(() => Effect.succeed(value))
@@ -1087,8 +1097,8 @@ export function succeed<T>(value: T) {
  * @see {@link nonEmptyString} – rejects empty strings
  * @see {@link schema} – for more complex types
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export function string(name?: string) {
   return schema(Schema.String, name)
@@ -1102,8 +1112,8 @@ export function string(name?: string) {
  *
  * @see {@link string} – allows empty strings
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 3.7.0
  */
 export function nonEmptyString(name?: string) {
   return schema(Schema.NonEmptyString, name)
@@ -1117,8 +1127,8 @@ export function nonEmptyString(name?: string) {
  * @see {@link finite} – rejects `NaN` and `Infinity`
  * @see {@link int} – only integers
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export function number(name?: string) {
   return schema(Schema.Number, name)
@@ -1132,7 +1142,7 @@ export function number(name?: string) {
  * @see {@link number} – allows `NaN` and `Infinity`
  * @see {@link int} – only integers
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function finite(name?: string) {
@@ -1147,7 +1157,7 @@ export function finite(name?: string) {
  * @see {@link number} – allows any number
  * @see {@link port} – integers in 1–65535
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function int(name?: string) {
@@ -1167,8 +1177,8 @@ export function int(name?: string) {
  * const env = Config.literal("production", "ENV")
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export function literal<L extends AST.LiteralValue>(literal: L, name?: string) {
   return schema(Schema.Literal(literal), name)
@@ -1187,7 +1197,7 @@ export function literal<L extends AST.LiteralValue>(literal: L, name?: string) {
  * const env = Config.literals(["development", "production"], "ENV")
  * ```
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function literals<const L extends ReadonlyArray<AST.LiteralValue>>(literals: L, name?: string) {
@@ -1225,8 +1235,8 @@ export function literals<const L extends ReadonlyArray<AST.LiteralValue>>(litera
  * // Output: true
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export function boolean(name?: string) {
   return schema(Boolean, name)
@@ -1263,8 +1273,8 @@ export function boolean(name?: string) {
  * // Output: Duration { _tag: "millis", value: 10000 }
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.5.0
  */
 export function duration(name?: string) {
   return schema(Schema.DurationFromString, name)
@@ -1297,8 +1307,8 @@ export function duration(name?: string) {
  * // Output: 8080
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 3.16.0
  */
 export function port(name?: string) {
   return schema(Port, name)
@@ -1334,8 +1344,8 @@ export function port(name?: string) {
  * // Output: "Info"
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export function logLevel(name?: string) {
   return schema(LogLevel, name)
@@ -1369,8 +1379,8 @@ export function logLevel(name?: string) {
  * // Output: <redacted>
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export function redacted(name?: string) {
   return schema(Schema.Redacted(Schema.String), name)
@@ -1417,8 +1427,8 @@ export function redacted(name?: string) {
  * // }
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 3.11.0
  */
 export function url(name?: string) {
   return schema(Schema.URL, name)
@@ -1443,8 +1453,8 @@ export function url(name?: string) {
  * // Date("2024-01-15T00:00:00.000Z")
  * ```
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export function date(name?: string) {
   return schema(Schema.DateValid, name)
@@ -1498,8 +1508,8 @@ export function date(name?: string) {
  * @see {@link all} – combine multiple configs into a struct
  * @see {@link schema} – read structured config from a schema
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 2.0.0
  */
 export const nested: {
   /**
@@ -1550,8 +1560,8 @@ export const nested: {
    * @see {@link all} – combine multiple configs into a struct
    * @see {@link schema} – read structured config from a schema
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   (name: string): <A>(self: Config<A>) => Config<A>
   /**
@@ -1602,8 +1612,8 @@ export const nested: {
    * @see {@link all} – combine multiple configs into a struct
    * @see {@link schema} – read structured config from a schema
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   <A>(self: Config<A>, name: string): Config<A>
 } = dual(

package/src/ConfigProvider.ts

@@ -112,7 +112,7 @@ import * as Str from "./String.ts"
  * @see {@link makeRecord} – construct a `Record` node
  * @see {@link makeArray} – construct an `Array` node
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Node =
@@ -154,7 +154,7 @@ export type Node =
  * @see {@link makeRecord} – for object-like containers
  * @see {@link makeArray} – for array-like containers
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function makeValue(value: string): Node {
@@ -183,7 +183,7 @@ export function makeValue(value: string): Node {
  * @see {@link makeValue} – for terminal leaves
  * @see {@link makeArray} – for array-like containers
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function makeRecord(keys: ReadonlySet<string>, value?: string): Node {
@@ -213,7 +213,7 @@ export function makeRecord(keys: ReadonlySet<string>, value?: string): Node {
  * @see {@link makeValue} – for terminal leaves
  * @see {@link makeRecord} – for object-like containers
  *
- * @category Constructors
+ * @category constructors
  * @since 4.0.0
  */
 export function makeArray(length: number, value?: string): Node {
@@ -246,7 +246,7 @@ export function makeArray(length: number, value?: string): Node {
  * @see {@link ConfigProvider} – the interface whose `load`/`get` may fail
  *   with this error
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export class SourceError extends Data.TaggedError("SourceError")<{
@@ -268,7 +268,7 @@ export class SourceError extends Data.TaggedError("SourceError")<{
  * const path: ConfigProvider.Path = ["database", "replicas", 0, "host"]
  * ```
  *
- * @category Models
+ * @category models
  * @since 4.0.0
  */
 export type Path = ReadonlyArray<string | number>
@@ -295,8 +295,8 @@ export type Path = ReadonlyArray<string | number>
  * @see {@link make} – construct a provider from a lookup function
  * @see {@link orElse} – compose providers with fallback
  *
- * @category Models
- * @since 4.0.0
+ * @category models
+ * @since 2.0.0
  */
 export interface ConfigProvider extends Pipeable {
   /**
@@ -352,8 +352,8 @@ export interface ConfigProvider extends Pipeable {
  * @see {@link layer} – install a provider as a Layer
  * @see {@link layerAdd} – add a fallback provider as a Layer
  *
- * @category Services
- * @since 4.0.0
+ * @category services
+ * @since 2.0.0
  */
 export const ConfigProvider: Context.Reference<ConfigProvider> = Context.Reference<ConfigProvider>(
   "effect/ConfigProvider",
@@ -406,8 +406,8 @@ const Proto = {
  * @see {@link fromEnv} – pre-built provider for environment variables
  * @see {@link fromUnknown} – pre-built provider for JSON objects
  *
- * @category Constructors
- * @since 4.0.0
+ * @category constructors
+ * @since 2.0.0
  */
 export function make(
   get: (path: Path) => Effect.Effect<Node | undefined, SourceError>,
@@ -454,8 +454,8 @@ export function make(
  *
  * @see {@link layerAdd} – install a fallback provider via a Layer
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 2.0.0
  */
 export const orElse: {
   /**
@@ -486,8 +486,8 @@ export const orElse: {
    *
    * @see {@link layerAdd} – install a fallback provider via a Layer
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   (that: ConfigProvider): (self: ConfigProvider) => ConfigProvider
   /**
@@ -518,8 +518,8 @@ export const orElse: {
    *
    * @see {@link layerAdd} – install a fallback provider via a Layer
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   (self: ConfigProvider, that: ConfigProvider): ConfigProvider
 } = dual(
@@ -561,7 +561,7 @@ export const orElse: {
  * @see {@link constantCase} – a preset that converts to `CONSTANT_CASE`
  * @see {@link nested} – for prepending a prefix instead of transforming
  *
- * @category Combinators
+ * @category combinators
  * @since 4.0.0
  */
 export const mapInput: {
@@ -598,7 +598,7 @@ export const mapInput: {
    * @see {@link constantCase} – a preset that converts to `CONSTANT_CASE`
    * @see {@link nested} – for prepending a prefix instead of transforming
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   (f: (path: Path) => Path): (self: ConfigProvider) => ConfigProvider
@@ -635,7 +635,7 @@ export const mapInput: {
    * @see {@link constantCase} – a preset that converts to `CONSTANT_CASE`
    * @see {@link nested} – for prepending a prefix instead of transforming
    *
-   * @category Combinators
+   * @category combinators
    * @since 4.0.0
    */
   (self: ConfigProvider, f: (path: Path) => Path): ConfigProvider
@@ -670,8 +670,8 @@ export const mapInput: {
  *
  * @see {@link mapInput} – for arbitrary path transformations
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 2.0.0
  */
 export const constantCase: (self: ConfigProvider) => ConfigProvider = mapInput((path) =>
   path.map((seg) => typeof seg === "number" ? seg : Str.constantCase(seg))
@@ -706,8 +706,8 @@ export const constantCase: (self: ConfigProvider) => ConfigProvider = mapInput((
  *
  * @see {@link mapInput} – for arbitrary path transformations
  *
- * @category Combinators
- * @since 4.0.0
+ * @category combinators
+ * @since 2.0.0
  */
 export const nested: {
   /**
@@ -739,8 +739,8 @@ export const nested: {
    *
    * @see {@link mapInput} – for arbitrary path transformations
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   (prefix: string | Path): (self: ConfigProvider) => ConfigProvider
   /**
@@ -772,8 +772,8 @@ export const nested: {
    *
    * @see {@link mapInput} – for arbitrary path transformations
    *
-   * @category Combinators
-   * @since 4.0.0
+   * @category combinators
+   * @since 2.0.0
    */
   (self: ConfigProvider, prefix: string | Path): ConfigProvider
 } = dual(
@@ -813,7 +813,7 @@ export const nested: {
  *
  * @see {@link layerAdd} – add a provider without replacing the existing one
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layer = <E = never, R = never>(
@@ -852,7 +852,7 @@ export const layer = <E = never, R = never>(
  * @see {@link layer} – replace the provider entirely
  * @see {@link orElse} – compose providers without layers
  *
- * @category Layers
+ * @category layers
  * @since 4.0.0
  */
 export const layerAdd = <E = never, R = never>(
@@ -997,7 +997,7 @@ function describeUnknown(u: unknown): Node | undefined {
  * @see {@link constantCase} – bridge camelCase keys to SCREAMING_SNAKE_CASE
  *
  * @category ConfigProviders
- * @since 4.0.0
+ * @since 2.0.0
  */
 export function fromEnv(options?: { readonly env?: Record<string, string> | undefined }): ConfigProvider {
   const env = options?.env ?? {
@@ -1239,6 +1239,7 @@ function searchLast(str: string, rgx: RegExp): number {
  * @see {@link fromDotEnvContents} – parse a `.env` string directly
  * @see {@link fromEnv} – read from the runtime environment
  *
+ * @category constructors
  * @since 4.0.0
  */
 export const fromDotEnv: (options?: {