env-validated 1.0.0

package/dist/effect-DIhhk_ck.d.cts

@@ -0,0 +1,222 @@
+interface BuiltInBase {
+    required?: boolean;
+    default?: unknown;
+}
+interface StringField extends BuiltInBase {
+    type: 'string';
+    default?: string;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: RegExp;
+}
+interface NumberField extends BuiltInBase {
+    type: 'number';
+    default?: number;
+    min?: number;
+    max?: number;
+}
+interface BooleanField extends BuiltInBase {
+    type: 'boolean';
+    default?: boolean;
+}
+interface UrlField extends BuiltInBase {
+    type: 'url';
+    default?: string;
+}
+interface PortField extends BuiltInBase {
+    type: 'port';
+    default?: number;
+}
+interface EnumField<T extends readonly string[] = readonly string[]> extends BuiltInBase {
+    type: 'enum';
+    values: T;
+    default?: T[number];
+}
+interface JsonField extends BuiltInBase {
+    type: 'json';
+    default?: unknown;
+}
+type BuiltInFieldDef = StringField | NumberField | BooleanField | UrlField | PortField | EnumField<readonly string[]> | JsonField;
+
+type ValidationResult<T = unknown> = {
+    success: true;
+    value: T;
+} | {
+    success: false;
+    error: string;
+};
+interface EnvSafeValidator {
+    validate(value: string | undefined): ValidationResult;
+}
+interface CustomValidateField<T = unknown> {
+    validate: (value: string | undefined) => ValidationResult<T>;
+}
+interface CreateEnvOptions {
+    source?: Record<string, string | undefined>;
+    onError?: 'throw' | 'warn' | ((error: EnvSafeError) => void);
+    dotenv?: boolean | string;
+    prefix?: string;
+}
+declare class EnvSafeError extends Error {
+    readonly errors: ReadonlyArray<{
+        key: string;
+        message: string;
+    }>;
+    constructor(errors: Array<{
+        key: string;
+        message: string;
+    }>);
+}
+/**
+ * Maps a built-in field definition to its output TypeScript type.
+ */
+type BuiltInOutputType<F> = F extends EnumField<infer V> ? V[number] : F extends {
+    type: 'number' | 'port';
+} ? number : F extends {
+    type: 'boolean';
+} ? boolean : F extends {
+    type: 'string' | 'url';
+} ? string : F extends {
+    type: 'json';
+} ? unknown : string;
+/**
+ * Infers the output type of a single schema field.
+ *
+ * Uses structural conditional types to match phantom properties
+ * on each validator library's schema objects. This means no imports
+ * of external libraries are needed at the type level.
+ */
+type InferFieldOutput<F> = F extends BuiltInFieldDef ? BuiltInOutputType<F> : F extends {
+    validate: (value: string | undefined) => {
+        success: true;
+        value: infer T;
+    } | {
+        success: false;
+        error: string;
+    };
+} ? T : F extends {
+    _zod: {
+        output: infer O;
+    };
+} ? O : F extends {
+    _output: infer O;
+} ? O : F extends {
+    __outputType: infer O;
+} ? O : F extends {
+    '~standard': {
+        types: {
+            output: infer O;
+        };
+    };
+} ? O : F extends {
+    inferOut: infer O;
+} ? O : F extends {
+    static: infer O;
+} ? O : F extends {
+    TYPE: infer O;
+} ? O : F extends {
+    guard(x: unknown): x is infer O;
+} ? O : F extends {
+    Type: infer O;
+} ? O : F extends {
+    _flags: Record<string, unknown>;
+    alphanum(): unknown;
+    email(): unknown;
+} ? string : F extends {
+    _flags: Record<string, unknown>;
+    greater(limit: number): unknown;
+    integer(): unknown;
+} ? number : F extends {
+    _flags: Record<string, unknown>;
+    truthy(...values: unknown[]): unknown;
+    falsy(...values: unknown[]): unknown;
+} ? boolean : F extends {
+    _flags: Record<string, unknown>;
+    iso(): unknown;
+    timestamp(): unknown;
+} ? Date : unknown;
+/**
+ * Maps an entire field-by-field schema object to its output type.
+ */
+type InferEnvOutput<S extends Record<string, unknown>> = {
+    readonly [K in keyof S]: InferFieldOutput<S[K]>;
+};
+/**
+ * Maps a Joi schema type to its output TypeScript type using structural matching.
+ * Reuses the same logic as the Joi branch in InferFieldOutput.
+ */
+type InferJoiFieldOutput<F> = F extends {
+    alphanum(): unknown;
+    email(): unknown;
+} ? string : F extends {
+    greater(limit: number): unknown;
+    integer(): unknown;
+} ? number : F extends {
+    truthy(...values: unknown[]): unknown;
+    falsy(...values: unknown[]): unknown;
+} ? boolean : F extends {
+    iso(): unknown;
+    timestamp(): unknown;
+} ? Date : unknown;
+/**
+ * Maps a Joi schema shape (from joiObject) to its output type.
+ */
+type InferJoiObjectOutput<T> = {
+    [K in keyof T]: InferJoiFieldOutput<T[K]>;
+};
+/**
+ * Extracts the output type from an object-level validator schema.
+ *
+ * Uses structural conditional types matching phantom properties
+ * on each validator library's object/struct schema types.
+ */
+type InferObjectSchemaOutput<S> = S extends {
+    __joiShape: infer Shape extends Record<string, unknown>;
+} ? InferJoiObjectOutput<Shape> : S extends {
+    _zod: {
+        output: infer O;
+    };
+} ? O : S extends {
+    _output: infer O;
+} ? O : S extends {
+    __outputType: infer O;
+} ? O : S extends {
+    inferOut: infer O;
+} ? O : S extends {
+    static: infer O;
+} ? O : S extends {
+    TYPE: infer O;
+} ? O : S extends {
+    guard(x: unknown): x is infer O;
+} ? O : S extends {
+    Type: infer O;
+} ? O : S extends {
+    '~standard': {
+        types?: infer T;
+    };
+} ? NonNullable<T> extends {
+    output: infer O;
+} ? O : unknown : unknown;
+/**
+ * Detects whether S is an object-level validator schema (e.g. z.object(), yup.object())
+ * or a field-by-field record of individual validators.
+ *
+ * When an object-level schema is passed, the output type is extracted directly
+ * from the validator's phantom types. Otherwise, falls back to per-field inference.
+ */
+/**
+ * Helper: true when T is `any`.
+ * Uses the fact that `0 extends (1 & T)` is true only for `any`.
+ */
+type IsAny<T> = 0 extends 1 & T ? true : false;
+type InferSchemaOutput<S> = InferObjectSchemaOutput<S> extends infer O ? IsAny<O> extends true ? Readonly<Record<string, unknown>> : [O] extends [Record<string, unknown>] ? Readonly<O> : S extends Record<string, unknown> ? InferEnvOutput<S> : Readonly<Record<string, unknown>> : never;
+type SchemaInput = Record<string, unknown>;
+
+interface RuntimeAdapter {
+    name: string;
+    detect(field: unknown): boolean;
+    validate(field: unknown, raw: string | undefined, key: string): ValidationResult;
+}
+declare function registerAdapter(adapter: RuntimeAdapter): void;
+
+export { type BooleanField as B, type CreateEnvOptions as C, type EnumField as E, type InferSchemaOutput as I, type JsonField as J, type NumberField as N, type PortField as P, type SchemaInput as S, type UrlField as U, type ValidationResult as V, type BuiltInFieldDef as a, type CustomValidateField as b, EnvSafeError as c, type EnvSafeValidator as d, type InferEnvOutput as e, type InferFieldOutput as f, type StringField as g, registerAdapter as r };

package/dist/effect-DIhhk_ck.d.ts

@@ -0,0 +1,222 @@
+interface BuiltInBase {
+    required?: boolean;
+    default?: unknown;
+}
+interface StringField extends BuiltInBase {
+    type: 'string';
+    default?: string;
+    minLength?: number;
+    maxLength?: number;
+    pattern?: RegExp;
+}
+interface NumberField extends BuiltInBase {
+    type: 'number';
+    default?: number;
+    min?: number;
+    max?: number;
+}
+interface BooleanField extends BuiltInBase {
+    type: 'boolean';
+    default?: boolean;
+}
+interface UrlField extends BuiltInBase {
+    type: 'url';
+    default?: string;
+}
+interface PortField extends BuiltInBase {
+    type: 'port';
+    default?: number;
+}
+interface EnumField<T extends readonly string[] = readonly string[]> extends BuiltInBase {
+    type: 'enum';
+    values: T;
+    default?: T[number];
+}
+interface JsonField extends BuiltInBase {
+    type: 'json';
+    default?: unknown;
+}
+type BuiltInFieldDef = StringField | NumberField | BooleanField | UrlField | PortField | EnumField<readonly string[]> | JsonField;
+
+type ValidationResult<T = unknown> = {
+    success: true;
+    value: T;
+} | {
+    success: false;
+    error: string;
+};
+interface EnvSafeValidator {
+    validate(value: string | undefined): ValidationResult;
+}
+interface CustomValidateField<T = unknown> {
+    validate: (value: string | undefined) => ValidationResult<T>;
+}
+interface CreateEnvOptions {
+    source?: Record<string, string | undefined>;
+    onError?: 'throw' | 'warn' | ((error: EnvSafeError) => void);
+    dotenv?: boolean | string;
+    prefix?: string;
+}
+declare class EnvSafeError extends Error {
+    readonly errors: ReadonlyArray<{
+        key: string;
+        message: string;
+    }>;
+    constructor(errors: Array<{
+        key: string;
+        message: string;
+    }>);
+}
+/**
+ * Maps a built-in field definition to its output TypeScript type.
+ */
+type BuiltInOutputType<F> = F extends EnumField<infer V> ? V[number] : F extends {
+    type: 'number' | 'port';
+} ? number : F extends {
+    type: 'boolean';
+} ? boolean : F extends {
+    type: 'string' | 'url';
+} ? string : F extends {
+    type: 'json';
+} ? unknown : string;
+/**
+ * Infers the output type of a single schema field.
+ *
+ * Uses structural conditional types to match phantom properties
+ * on each validator library's schema objects. This means no imports
+ * of external libraries are needed at the type level.
+ */
+type InferFieldOutput<F> = F extends BuiltInFieldDef ? BuiltInOutputType<F> : F extends {
+    validate: (value: string | undefined) => {
+        success: true;
+        value: infer T;
+    } | {
+        success: false;
+        error: string;
+    };
+} ? T : F extends {
+    _zod: {
+        output: infer O;
+    };
+} ? O : F extends {
+    _output: infer O;
+} ? O : F extends {
+    __outputType: infer O;
+} ? O : F extends {
+    '~standard': {
+        types: {
+            output: infer O;
+        };
+    };
+} ? O : F extends {
+    inferOut: infer O;
+} ? O : F extends {
+    static: infer O;
+} ? O : F extends {
+    TYPE: infer O;
+} ? O : F extends {
+    guard(x: unknown): x is infer O;
+} ? O : F extends {
+    Type: infer O;
+} ? O : F extends {
+    _flags: Record<string, unknown>;
+    alphanum(): unknown;
+    email(): unknown;
+} ? string : F extends {
+    _flags: Record<string, unknown>;
+    greater(limit: number): unknown;
+    integer(): unknown;
+} ? number : F extends {
+    _flags: Record<string, unknown>;
+    truthy(...values: unknown[]): unknown;
+    falsy(...values: unknown[]): unknown;
+} ? boolean : F extends {
+    _flags: Record<string, unknown>;
+    iso(): unknown;
+    timestamp(): unknown;
+} ? Date : unknown;
+/**
+ * Maps an entire field-by-field schema object to its output type.
+ */
+type InferEnvOutput<S extends Record<string, unknown>> = {
+    readonly [K in keyof S]: InferFieldOutput<S[K]>;
+};
+/**
+ * Maps a Joi schema type to its output TypeScript type using structural matching.
+ * Reuses the same logic as the Joi branch in InferFieldOutput.
+ */
+type InferJoiFieldOutput<F> = F extends {
+    alphanum(): unknown;
+    email(): unknown;
+} ? string : F extends {
+    greater(limit: number): unknown;
+    integer(): unknown;
+} ? number : F extends {
+    truthy(...values: unknown[]): unknown;
+    falsy(...values: unknown[]): unknown;
+} ? boolean : F extends {
+    iso(): unknown;
+    timestamp(): unknown;
+} ? Date : unknown;
+/**
+ * Maps a Joi schema shape (from joiObject) to its output type.
+ */
+type InferJoiObjectOutput<T> = {
+    [K in keyof T]: InferJoiFieldOutput<T[K]>;
+};
+/**
+ * Extracts the output type from an object-level validator schema.
+ *
+ * Uses structural conditional types matching phantom properties
+ * on each validator library's object/struct schema types.
+ */
+type InferObjectSchemaOutput<S> = S extends {
+    __joiShape: infer Shape extends Record<string, unknown>;
+} ? InferJoiObjectOutput<Shape> : S extends {
+    _zod: {
+        output: infer O;
+    };
+} ? O : S extends {
+    _output: infer O;
+} ? O : S extends {
+    __outputType: infer O;
+} ? O : S extends {
+    inferOut: infer O;
+} ? O : S extends {
+    static: infer O;
+} ? O : S extends {
+    TYPE: infer O;
+} ? O : S extends {
+    guard(x: unknown): x is infer O;
+} ? O : S extends {
+    Type: infer O;
+} ? O : S extends {
+    '~standard': {
+        types?: infer T;
+    };
+} ? NonNullable<T> extends {
+    output: infer O;
+} ? O : unknown : unknown;
+/**
+ * Detects whether S is an object-level validator schema (e.g. z.object(), yup.object())
+ * or a field-by-field record of individual validators.
+ *
+ * When an object-level schema is passed, the output type is extracted directly
+ * from the validator's phantom types. Otherwise, falls back to per-field inference.
+ */
+/**
+ * Helper: true when T is `any`.
+ * Uses the fact that `0 extends (1 & T)` is true only for `any`.
+ */
+type IsAny<T> = 0 extends 1 & T ? true : false;
+type InferSchemaOutput<S> = InferObjectSchemaOutput<S> extends infer O ? IsAny<O> extends true ? Readonly<Record<string, unknown>> : [O] extends [Record<string, unknown>] ? Readonly<O> : S extends Record<string, unknown> ? InferEnvOutput<S> : Readonly<Record<string, unknown>> : never;
+type SchemaInput = Record<string, unknown>;
+
+interface RuntimeAdapter {
+    name: string;
+    detect(field: unknown): boolean;
+    validate(field: unknown, raw: string | undefined, key: string): ValidationResult;
+}
+declare function registerAdapter(adapter: RuntimeAdapter): void;
+
+export { type BooleanField as B, type CreateEnvOptions as C, type EnumField as E, type InferSchemaOutput as I, type JsonField as J, type NumberField as N, type PortField as P, type SchemaInput as S, type UrlField as U, type ValidationResult as V, type BuiltInFieldDef as a, type CustomValidateField as b, EnvSafeError as c, type EnvSafeValidator as d, type InferEnvOutput as e, type InferFieldOutput as f, type StringField as g, registerAdapter as r };