{ "package": "@arki/env", "version": "0.1.0", "entries": [ { "subpath": ".", "name": "contracts", "kind": "variable", "signature": "export declare const contracts: { string: (defaultValue?: string) => import(\"zod\").ZodDefault | import(\"zod\").ZodString; number: (defaultValue?: number) => import(\"zod\").ZodCoercedNumber | import(\"zod\").ZodDefault>; port: (defaultValue?: number) => import(\"zod\").ZodDefault>; nodeEnv: () => import(\"zod\").ZodDefault>; boolean: (defaultValue?: boolean) => import(\"zod\").ZodPipe>, import(\"zod\").ZodTransform>; logLevel: (defaultValue?: 'debug' | 'info' | 'warn' | 'error') => import(\"zod\").ZodDefault>; json: (schema: T) => import(\"zod\").ZodPipe>, string>>; csvArray: (itemSchema: T) => import(\"zod\").ZodPreprocess, unknown>; csvSet: (itemSchema: T) => import(\"zod\").ZodPreprocess, unknown>; url: (defaultValue?: string) => import(\"zod\").ZodDefault | import(\"zod\").ZodURL; databaseUrl: () => import(\"zod\").ZodURL; redisUrl: () => import(\"zod\").ZodURL; };", "jsdocSummary": "" }, { "subpath": "./contracts", "name": "commonContracts", "kind": "variable", "signature": "export declare const commonContracts: { string: (defaultValue?: string) => z.ZodDefault | z.ZodString; number: (defaultValue?: number) => z.ZodCoercedNumber | z.ZodDefault>; port: (defaultValue?: number) => z.ZodDefault>; nodeEnv: () => z.ZodDefault>; boolean: (defaultValue?: boolean) => z.ZodPipe>, z.ZodTransform>; logLevel: (defaultValue?: 'debug' | 'info' | 'warn' | 'error') => z.ZodDefault>; };", "jsdocSummary": "" }, { "subpath": "./contracts", "name": "contracts", "kind": "variable", "signature": "export declare const contracts: { string: (defaultValue?: string) => import(\"zod\").ZodDefault | import(\"zod\").ZodString; number: (defaultValue?: number) => import(\"zod\").ZodCoercedNumber | import(\"zod\").ZodDefault>; port: (defaultValue?: number) => import(\"zod\").ZodDefault>; nodeEnv: () => import(\"zod\").ZodDefault>; boolean: (defaultValue?: boolean) => import(\"zod\").ZodPipe>, import(\"zod\").ZodTransform>; logLevel: (defaultValue?: 'debug' | 'info' | 'warn' | 'error') => import(\"zod\").ZodDefault>; json: (schema: T) => import(\"zod\").ZodPipe>, string>>; csvArray: (itemSchema: T) => import(\"zod\").ZodPreprocess, unknown>; csvSet: (itemSchema: T) => import(\"zod\").ZodPreprocess, unknown>; url: (defaultValue?: string) => import(\"zod\").ZodDefault | import(\"zod\").ZodURL; databaseUrl: () => import(\"zod\").ZodURL; redisUrl: () => import(\"zod\").ZodURL; };", "jsdocSummary": "" }, { "subpath": "./contracts", "name": "parseContracts", "kind": "variable", "signature": "export declare const parseContracts: { json: (schema: T) => z.ZodPipe>, string>>; csvArray: (itemSchema: T) => z.ZodPreprocess, unknown>; csvSet: (itemSchema: T) => z.ZodPreprocess, unknown>; };", "jsdocSummary": "" }, { "subpath": "./contracts", "name": "urlContracts", "kind": "variable", "signature": "export declare const urlContracts: { url: (defaultValue?: string) => z.ZodDefault | z.ZodURL; databaseUrl: () => z.ZodURL; redisUrl: () => z.ZodURL; };", "jsdocSummary": "" }, { "subpath": "./core", "name": "contracts", "kind": "variable", "signature": "export declare const contracts: { string: (defaultValue?: string) => import(\"zod\").ZodDefault | import(\"zod\").ZodString; number: (defaultValue?: number) => import(\"zod\").ZodCoercedNumber | import(\"zod\").ZodDefault>; port: (defaultValue?: number) => import(\"zod\").ZodDefault>; nodeEnv: () => import(\"zod\").ZodDefault>; boolean: (defaultValue?: boolean) => import(\"zod\").ZodPipe>, import(\"zod\").ZodTransform>; logLevel: (defaultValue?: 'debug' | 'info' | 'warn' | 'error') => import(\"zod\").ZodDefault>; json: (schema: T) => import(\"zod\").ZodPipe>, string>>; csvArray: (itemSchema: T) => import(\"zod\").ZodPreprocess, unknown>; csvSet: (itemSchema: T) => import(\"zod\").ZodPreprocess, unknown>; url: (defaultValue?: string) => import(\"zod\").ZodDefault | import(\"zod\").ZodURL; databaseUrl: () => import(\"zod\").ZodURL; redisUrl: () => import(\"zod\").ZodURL; };", "jsdocSummary": "" }, { "subpath": "./core", "name": "defineEnv", "kind": "function", "signature": "export declare function defineEnv, TClient extends Record = NonNullable, TShared extends Record = NonNullable, const TPrefix extends string = '', const TExtends extends Record[] = []>(config: { /** * Label shown in validation-error logs, e.g. `'@acme/backend'`. Without it a misconfigured * deploy logs a bare \"Invalid environment variables\" with no hint which env failed — exactly the * blind failure this wrapper exists to prevent. */ name?: string; server: TServer; /** Client-side schema. Every key must start with `clientPrefix` (enforced by `createEnv`). */ client?: TClient; /** Prefix client keys must carry, e.g. `'VITE_'`. Defaults to `''` (no client vars). */ clientPrefix?: TPrefix; /** Shared vars available to both client and server, unprefixed (e.g. `NODE_ENV`). */ shared?: TShared; /** * Already-built envs to compose in (e.g. `@arki/auth`, `@arki/db`). Their parsed variables merge * into the result with full types; each was validated by its own `createEnv` at import time. */ extends?: TExtends; /** * Explicit runtime source. Omit it and `defineEnv` auto-builds one by reading `process.env` for * every declared key — correct for any server-side env. Provide it only when the auto-build would * be wrong: Vite/`start` apps whose client vars come from `import.meta.env` in the browser, or * keys with a fallback/alias (e.g. `DB_URL: process.env.DB_URL ?? process.env.DATABASE_URL`). */ runtimeEnv?: Record; options?: { /** * `true` skips schema validation: values pass through raw. Default: validate on the first read, * in every environment, unless the process sets `SKIP_ENV_VALIDATION=1` (exactly `1`). That * variable is the only implicit opt-out, meant for Docker build stages that prerender without * secrets. `CI`, lint and `NODE_ENV` never skip. */ skipValidation?: boolean; /** * Treat empty-string env values as `undefined` so defaults apply (e.g. `PORT=` in `.env`, or a * Docker arg baked as `X=\"\"`). Defaults to `true` — set `false` only if an app intentionally * accepts `\"\"` as a valid required string. */ emptyStringAsUndefined?: boolean; onValidationError?: (issues: ValidationIssues) => never; }; }): CreateEnv, TExtends>;", "jsdocSummary": "Thin, type-preserving wrapper over `@t3-oss/env-core`'s `createEnv`. Generic over the server, client, shared and composed schemas so the parsed env keeps its exact inferred types — the wrapper adds the ARKI defaults (auto `runtimeEnv`, validation on in every environment, a legible labelled error handler) without widening any value to `unknown`." }, { "subpath": "./core", "name": "Redacted", "kind": "class", "signature": "export declare class Redacted { #private; constructor(value: Value); toString(): string; toJSON(): string; [inspect](): string; }", "jsdocSummary": "A value that prints as `[redacted]`. Read it with {@link reveal}." }, { "subpath": "./core", "name": "reveal", "kind": "function", "signature": "export declare function reveal(value: Redacted | Value): Value;", "jsdocSummary": "The plain value of a secret. Also takes the raw value, because when validation is skipped (`skipValidation`, or `CI` builds) schemas do not run and the variable is still a plain string." }, { "subpath": "./core", "name": "secret", "kind": "function", "signature": "export declare function secret(schema: Schema): SecretSchema;", "jsdocSummary": "Validate with `schema` (any Standard Schema), then wrap the value in a {@link Redacted}. For an optional secret, call `.optional()`: `secret(z.string()).optional()`. The inner result passes straight through: an async inner schema yields a promise, so `defineEnv`'s synchronous check fails with the same `UnexpectedFailure` it would give without `secret`, and a throwing validator still throws." }, { "subpath": "./dot", "name": "env", "kind": "function", "signature": "export declare function env>(options: EnvDotOptions): import(\"@arki/dot/plugin\").AuthoredPlugin, import(\"@arki/dot/plugin\").ProvidedValues<{ env: Readonly<(Partial, (import(\"@t3-oss/env-core\").StandardSchemaDictionary.InferOutput extends infer T_1 ? { [K in keyof T_1]: undefined extends T_1[K] ? K : never; } : never)[keyof TSchema]>> & Omit, (import(\"@t3-oss/env-core\").StandardSchemaDictionary.InferOutput extends infer T_1 ? { [K in keyof T_1]: undefined extends T_1[K] ? K : never; } : never)[keyof TSchema]> extends infer T_2 ? T_2 extends Partial, (import(\"@t3-oss/env-core\").StandardSchemaDictionary.InferOutput extends infer T_1 ? { [K in keyof T_1]: undefined extends T_1[K] ? K : never; } : never)[keyof TSchema]>> & Omit, (import(\"@t3-oss/env-core\").StandardSchemaDictionary.InferOutput extends infer T_1 ? { [K in keyof T_1]: undefined extends T_1[K] ? K : never; } : never)[keyof TSchema]> ? T_2 extends Readonly ? U : T_2 : never : never) & Omit extends infer T_1 ? { [K in keyof T_1]: undefined extends T_1[K] ? K : never; } : never)[keyof TSchema] | Exclude extends infer T_1 ? { [K in keyof T_1]: undefined extends T_1[K] ? K : never; } : never)[keyof TSchema]>> extends infer T ? { [P in keyof T]: T[P]; } : never>; }>, import(\"@arki/dot/plugin\").EmptyShape, \"env\", { env: Readonly<(Partial, (import(\"@t3-oss/env-core\").StandardSchemaDictionary.InferOutput extends infer T_1 ? { [K in keyof T_1]: undefined extends T_1[K] ? K : never; } : never)[keyof TSchema]>> & Omit, (import(\"@t3-oss/env-core\").StandardSchemaDictionary.InferOutput extends infer T_1 ? { [K in keyof T_1]: undefined extends T_1[K] ? K : never; } : never)[keyof TSchema]> extends infer T_2 ? T_2 extends Partial, (import(\"@t3-oss/env-core\").StandardSchemaDictionary.InferOutput extends infer T_1 ? { [K in keyof T_1]: undefined extends T_1[K] ? K : never; } : never)[keyof TSchema]>> & Omit, (import(\"@t3-oss/env-core\").StandardSchemaDictionary.InferOutput extends infer T_1 ? { [K in keyof T_1]: undefined extends T_1[K] ? K : never; } : never)[keyof TSchema]> ? T_2 extends Readonly ? U : T_2 : never : never) & Omit extends infer T_1 ? { [K in keyof T_1]: undefined extends T_1[K] ? K : never; } : never)[keyof TSchema] | Exclude extends infer T_1 ? { [K in keyof T_1]: undefined extends T_1[K] ? K : never; } : never)[keyof TSchema]>> extends infer T ? { [P in keyof T]: T[P]; } : never>; }, import(\"@arki/dot/plugin\").EmptyPhases, import(\"@arki/dot/plugin\").DotLoggingHandle, undefined>;", "jsdocSummary": "Build a DOT plugin that validates and publishes a typed `env` service." }, { "subpath": "./dot", "name": "ENV_PLUGIN_ERROR_CODES", "kind": "variable", "signature": "export declare const ENV_PLUGIN_ERROR_CODES: { /** * The env failed its schema at boot. The message lists every bad key. * * @fix Set the listed variables, or fix their values, before booting the app. * @verify dot doctor --json | jq '.data' */ readonly invalidEnv: 'ARKI_ENV_PLUGIN_E001'; };", "jsdocSummary": "" }, { "subpath": "./dot", "name": "EnvDotOptions", "kind": "type", "signature": "export type EnvDotOptions> = { /** One Standard Schema (Zod, Valibot, ArkType, ...) per env var the plugin validates. */ readonly schema: TSchema; /** * Forwarded to `defineEnv`. If `true`, the validator is skipped * entirely. By default the env is validated at boot, in every * environment, unless the process sets `SKIP_ENV_VALIDATION=1`. */ readonly skipValidation?: boolean; };", "jsdocSummary": "Options for the env DOT adapter." }, { "subpath": "./dot", "name": "EnvServices", "kind": "type", "signature": "export type EnvServices> = { readonly env: ReturnType>; };", "jsdocSummary": "The shape of services published by the env adapter." } ], "errorCodes": [ "ARKI_ENV_PLUGIN_E001" ] }