arkenv 1.0.0-alpha.2 → 1.0.0-alpha.3

package/dist/index.d.cts

@@ -1,235 +1 @@
-import { a as SafeArkEnvResult } from "./core-7-JO-N-w.cjs";
-import { a as Dict, n as SchemaShape, o as $, r as InferType, t as CompiledEnvSchema } from "./index-Do-2CL1V.cjs";
-import * as _$arktype_internal_keywords_string_ts0 from "arktype/internal/keywords/string.ts";
-import * as _$arktype_internal_attributes_ts0 from "arktype/internal/attributes.ts";
-import * as _$arktype from "arktype";
-import { distill, type as type$1 } from "arktype";
-import * as _$arktype_internal_type_ts0 from "arktype/internal/type.ts";
-
-//#region src/arkenv.d.ts
-/**
- * Declarative environment schema definition accepted by ArkEnv.
- *
- * Represents a declarative schema object mapping environment
- * variable names to schema definitions (e.g. ArkType DSL strings
- * or Standard Schema validators).
- *
- * This type is used to validate that a schema object is compatible with
- * ArkEnv’s validator scope before being compiled or parsed.
- *
- * Most users will provide schemas in this form.
- *
- * @template def - The schema shape object
- */
-type EnvSchema<def> = type$1.validate<def, $>;
-/**
- * Infer the validated and coerced environment object type from a schema.
- * Supports declarative schema shapes, compiled ArkType schemas, and Standard Schema validators.
- *
- * @template T - The schema type
- */
-type Infer<T> = T extends SchemaShape ? distill.Out<type$1.infer<T, $>> : InferType<T>;
-/**
- * The environment variables passed to `arkenv`.
- * Uses `Dict<string>` to enforce
- * compile-time safety: all input environment variables must be strings
- * (or undefined), matching `process.env` semantics.
- */
-type RuntimeEnvironment = Dict<string>;
-/**
- * Configuration options for `arkenv`
- */
-type ArkEnvConfig = {
-  /**
-   * The environment variables to parse. Defaults to `process.env`
-   */
-  env?: RuntimeEnvironment;
-  /**
-   * Whether to coerce environment variables to their defined types. Defaults to `true`
-   */
-  coerce?: boolean;
-  /**
-   * Control how ArkEnv handles environment variables that are not defined in your schema.
-   *
-   * Defaults to `'delete'` to ensure your output object only contains
-   * keys you've explicitly declared. This differs from ArkType's standard behavior, which
-   * mirrors TypeScript by defaulting to `'ignore'`.
-   *
-   * - `delete` (ArkEnv default): Undeclared keys are allowed on input but stripped from the output.
-   * - `ignore` (ArkType default): Undeclared keys are allowed and preserved in the output.
-   * - `reject`: Undeclared keys will cause validation to fail.
-   *
-   * @default "delete"
-   * @see https://arktype.io/docs/configuration#onundeclaredkey
-   */
-  onUndeclaredKey?: "ignore" | "delete" | "reject";
-  /**
-   * The format to use for array parsing when coercion is enabled.
-   *
-   * - `comma` (default): Strings are split by comma and trimmed.
-   * - `json`: Strings are parsed as JSON.
-   *
-   * @default "comma"
-   */
-  arrayFormat?: "comma" | "json";
-  /**
-   * Whether to bypass secret redaction and print raw sensitive values during debugging.
-   * Defaults to checking `process.env.ARKENV_DEBUG_SECRETS === "true"` or `"1"`.
-   */
-  debugSecrets?: boolean;
-  /**
-   * Whether to treat empty strings (`""`) as `undefined` before validation.
-   *
-   * When enabled, an environment variable set to an empty value (e.g. `PORT=`)
-   * will be treated as if it were missing, allowing defaults to apply and
-   * preventing validation errors for numeric or boolean types.
-   *
-   * @default false
-   */
-  emptyAsUndefined?: boolean;
-  /**
-   * Whether to return a safe result object instead of throwing an error on validation failure.
-   *
-   * When enabled, the function returns an object with `{ success: true, data }` or `{ success: false, issues }`.
-   *
-   * @default false
-   */
-  safe?: boolean;
-};
-/**
- * Helper type to represent the output of parsing either an EnvSchema or CompiledEnvSchema.
- */
-type ArkenvOutput<T extends SchemaShape, D> = distill.Out<type$1.infer<T, $>> | InferType<D>;
-/**
- * Utility to parse environment variables using ArkType or Standard Schema
- *
- * Naming convention: the main function is lowercase (`arkenv`) following the
- * JavaScript convention for functions (e.g. `zod`, `joi`). Classes and types
- * use PascalCase with the full product name (`ArkEnvError`, `SafeArkEnvResult`).
- *
- * @param def The schema definition
- * @param config The evaluation configuration
- * @returns The parsed environment variables, or a SafeArkEnvResult if `{ safe: true }` is configured
- * @throws An {@link ArkEnvError | error} if the environment variables are invalid and `safe` is not enabled
- */
-declare function arkenv<const T extends SchemaShape>(def: EnvSchema<T>, config?: ArkEnvConfig & {
-  safe?: false;
-}): distill.Out<type$1.infer<T, $>>;
-declare function arkenv<T extends CompiledEnvSchema>(def: T, config?: ArkEnvConfig & {
-  safe?: false;
-}): InferType<T>;
-declare function arkenv<const T extends SchemaShape, const D extends EnvSchema<T> | CompiledEnvSchema>(def: D, config?: ArkEnvConfig & {
-  safe?: false;
-}): ArkenvOutput<T, D>;
-declare function arkenv<const T extends SchemaShape>(def: EnvSchema<T>, config: ArkEnvConfig & {
-  safe: true;
-}): SafeArkEnvResult<distill.Out<type$1.infer<T, $>>>;
-declare function arkenv<T extends CompiledEnvSchema>(def: T, config: ArkEnvConfig & {
-  safe: true;
-}): SafeArkEnvResult<InferType<T>>;
-declare function arkenv<const T extends SchemaShape, const D extends EnvSchema<T> | CompiledEnvSchema>(def: D, config: ArkEnvConfig & {
-  safe: true;
-}): SafeArkEnvResult<ArkenvOutput<T, D>>;
-//#endregion
-//#region src/schema.d.ts
-/**
- * Extract the keys from a schema definition dynamically.
- * Supports plain objects, ArkType schemas, and Standard Schema validators.
- *
- * @param schema The schema definition to extract keys from
- * @returns An array of extracted key names
- * @internal
- */
-declare function getSchemaKeys(schema: any): string[];
-//#endregion
-//#region src/index.d.ts
-/**
- * Like ArkType's `type`, but with ArkEnv's extra keywords, such as:
- *
- * - `string.host` – a hostname (e.g. `"localhost"`, `"127.0.0.1"`)
- * - `number.port` – a port number (e.g. `8080`)
- *
- * See ArkType's docs for the full API:
- * https://arktype.io/docs/type-api
- */
-declare const type: _$arktype_internal_type_ts0.TypeParser<{
-  string: _$arktype.Submodule<{
-    trim: _$arktype.Submodule<_$arktype_internal_keywords_string_ts0.trim.$ & {
-      " arkInferred": (In: string) => _$arktype_internal_attributes_ts0.To<string>;
-    }>;
-    normalize: _$arktype.Submodule<_$arktype_internal_keywords_string_ts0.normalize.$ & {
-      " arkInferred": (In: string) => _$arktype_internal_attributes_ts0.To<string>;
-    }>;
-    root: string;
-    alpha: string;
-    alphanumeric: string;
-    hex: string;
-    base64: _$arktype.Submodule<{
-      root: string;
-      url: string;
-    } & {
-      " arkInferred": string;
-    }>;
-    capitalize: _$arktype.Submodule<_$arktype_internal_keywords_string_ts0.capitalize.$ & {
-      " arkInferred": (In: string) => _$arktype_internal_attributes_ts0.To<string>;
-    }>;
-    creditCard: string;
-    date: _$arktype.Submodule<_$arktype_internal_keywords_string_ts0.stringDate.$ & {
-      " arkInferred": string;
-    }>;
-    digits: string;
-    email: string;
-    integer: _$arktype.Submodule<_$arktype_internal_keywords_string_ts0.stringInteger.$ & {
-      " arkInferred": string;
-    }>;
-    ip: _$arktype.Submodule<_$arktype_internal_keywords_string_ts0.ip.$ & {
-      " arkInferred": string;
-    }>;
-    json: _$arktype.Submodule<_$arktype_internal_keywords_string_ts0.stringJson.$ & {
-      " arkInferred": string;
-    }>;
-    lower: _$arktype.Submodule<_$arktype_internal_keywords_string_ts0.lower.$ & {
-      " arkInferred": (In: string) => _$arktype_internal_attributes_ts0.To<string>;
-    }>;
-    numeric: _$arktype.Submodule<_$arktype_internal_keywords_string_ts0.stringNumeric.$ & {
-      " arkInferred": string;
-    }>;
-    regex: string;
-    semver: string;
-    upper: _$arktype.Submodule<{
-      root: (In: string) => _$arktype_internal_attributes_ts0.To<string>;
-      preformatted: string;
-    } & {
-      " arkInferred": (In: string) => _$arktype_internal_attributes_ts0.To<string>;
-    }>;
-    url: _$arktype.Submodule<_$arktype_internal_keywords_string_ts0.url.$ & {
-      " arkInferred": string;
-    }>;
-    uuid: _$arktype.Submodule<_$arktype_internal_keywords_string_ts0.uuid.$ & {
-      " arkInferred": string;
-    }>;
-    " arkInferred": string;
-    host: string;
-  }>;
-  number: _$arktype.Submodule<{
-    NaN: number;
-    Infinity: number;
-    root: number;
-    integer: number;
-    " arkInferred": number;
-    epoch: number;
-    safe: number;
-    NegativeInfinity: number;
-    port: number;
-  }>;
-}>;
-//#endregion
-export { type ArkEnvConfig, type EnvSchema, type Infer, type SafeArkEnvResult, arkenv, arkenv as default, getSchemaKeys, type };
-
-// CJS Interop Shim
-if (module.exports && module.exports.default) {
-    Object.assign(module.exports.default, module.exports);
-    module.exports = module.exports.default;
-}
-      
-//# sourceMappingURL=index.d.cts.map
+export { };

package/package.json

@@ -1,47 +1,29 @@
 {
   "name": "arkenv",
   "type": "module",
-  "version": "1.0.0-alpha.2",
-  "description": "Typesafe environment variables parsing and validation with ArkType",
+  "version": "1.0.0-alpha.3",
+  "description": "Interactive CLI for scaffolding ArkEnv projects",
+  "bin": {
+    "arkenv": "./dist/index.cjs"
+  },
   "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.mts",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": {
-        "import": "./dist/index.d.mts",
-        "require": "./dist/index.d.cts"
-      },
-      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
-    "./standard": {
-      "types": {
-        "import": "./dist/standard.d.mts",
-        "require": "./dist/standard.d.cts"
-      },
-      "import": "./dist/standard.mjs",
-      "require": "./dist/standard.cjs"
-    },
-    "./core": {
-      "types": {
-        "import": "./dist/core.d.mts",
-        "require": "./dist/core.d.cts"
-      },
-      "import": "./dist/core.mjs",
-      "require": "./dist/core.cjs"
-    }
+    "./*": "./dist/*"
   },
   "files": [
     "dist"
   ],
   "keywords": [
-    "pnpm",
-    "arktype",
-    "environment",
-    "variables",
-    "typesafe",
-    "validation"
+    "arkenv",
+    "cli",
+    "scaffold",
+    "init"
   ],
   "license": "MIT",
   "homepage": "https://arkenv.js.org",
@@ -49,63 +31,27 @@
     "type": "git",
     "url": "git+https://github.com/yamcodes/arkenv.git"
   },
-  "bugs": "https://github.com/yamcodes/arkenv/labels/arkenv",
+  "bugs": "https://github.com/yamcodes/arkenv/labels/arkenv-cli",
   "author": "Yam Borodetsky <yam@yam.codes>",
+  "dependencies": {
+    "@clack/prompts": "^1.3.0",
+    "dedent": "^1.7.2",
+    "jsonc-parser": "^3.3.1",
+    "magicast": "^0.5.2",
+    "picocolors": "^1.1.1",
+    "radashi": "^12.9.1"
+  },
   "devDependencies": {
-    "@ark/attest": "0.56.0",
-    "@size-limit/esbuild-why": "12.1.0",
-    "@size-limit/preset-small-lib": "12.1.0",
     "@types/node": "24.12.2",
-    "arktype": "2.2.0",
-    "rimraf": "6.1.3",
-    "size-limit": "12.1.0",
     "tsdown": "0.21.10",
-    "typescript": "6.0.3",
-    "vitest": "4.1.5",
-    "zod": "4.4.1",
-    "@repo/scope": "0.1.3",
-    "@repo/types": "0.1.0"
-  },
-  "peerDependencies": {
-    "arktype": "^2.1.22"
+    "typescript": "6.0.3"
   },
-  "peerDependenciesMeta": {
-    "arktype": {
-      "optional": true
-    }
-  },
-  "size-limit": [
-    {
-      "name": "arkenv",
-      "path": "dist/index.mjs",
-      "limit": "2.7 kB",
-      "import": "*",
-      "ignore": [
-        "arktype"
-      ]
-    },
-    {
-      "name": "arkenv/standard",
-      "path": "dist/standard.mjs",
-      "limit": "3.5 kB",
-      "import": "*"
-    },
-    {
-      "name": "arkenv/core",
-      "path": "dist/core.mjs",
-      "limit": "500 B",
-      "import": "*"
-    }
-  ],
   "scripts": {
     "build": "tsdown",
-    "size": "size-limit --json > .size-limit.json",
-    "test:once": "vitest run",
-    "test:dist": "vitest run test/dist.test.ts",
-    "typecheck": "tsc --noEmit",
-    "clean": "rimraf dist node_modules",
+    "start": "node ./dist/index.cjs init",
+    "dev": "tsdown --watch",
     "test": "vitest",
-    "test:types": "vitest run --typecheck.only",
-    "fix": "pnpm -w run fix"
+    "test:run": "vitest run",
+    "typecheck": "tsc --noEmit"
   }
 }

package/dist/core-7-JO-N-w.d.cts

@@ -1,82 +0,0 @@
-//#region src/core.d.ts
-/**
- * Machine-readable classification codes for environment validation issues.
- * Serves as the Source of Truth (SoT) for error categorization in ArkEnv.
- */
-type EnvIssueCode = /** The environment variable is required but was not provided, and has no default value. */"MISSING_VARIABLE" /** The variable value failed a type assertion (e.g., expected a number or boolean but received a string). */ | "INVALID_TYPE" /** The variable value falls below the minimum allowed numeric limit or string/array length constraint. */ | "VALUE_TOO_SMALL" /** The variable value exceeds the maximum allowed numeric limit or string/array length constraint. */ | "VALUE_TOO_LARGE" /** The variable value did not match the specified regular expression (regex) pattern constraint. */ | "PATTERN_MISMATCH" /** The variable value is not in a valid format (e.g., failed email or UUID format validation). */ | "INVALID_FORMAT" /** An undeclared key was found in the environment, and the schema config is set to reject undeclared keys. */ | "UNDECLARED_KEY" /** The provided validation schema definition itself is malformed or invalid. */ | "INVALID_SCHEMA" /** A validation error was triggered by a custom validator function or inline pipe logic. */ | "CUSTOM";
-/**
- * Metadata associated with an environment validation issue.
- */
-type EnvIssueMeta = {
-  /** The minimum expected boundary for numeric/string length constraints */min?: number; /** The maximum expected boundary for numeric/string length constraints */
-  max?: number; /** Additional validation pattern/specifier details */
-  validation?: string; /** Any custom constraint descriptions */
-  constraint?: string; /** Traversal error occurred during JSON-parsing of the environment variable */
-  traversalError?: string;
-};
-/**
- * Normalized validation issue representing a failure on a specific environment variable.
- */
-type EnvIssue = {
-  /** The dot-separated property path/name of the environment variable */path: string; /** The descriptive, user-friendly error message */
-  message: string; /** The normalized classification code for the issue */
-  code: EnvIssueCode; /** The expected type or value shape description */
-  expected?: string; /** The raw value received (redacted in string formatting if sensitive) */
-  received?: unknown; /** Additional validation metadata */
-  meta?: EnvIssueMeta;
-};
-/**
- * Format a list of normalized environment issues into a single styled string.
- *
- * @param issues - The array of normalized issues to format
- * @returns The formatted and styled error report string
- */
-declare function formatIssues(issues: EnvIssue[]): string;
-/**
- * Error thrown when environment variable validation fails.
- *
- * This error extends the native `Error` class and provides formatted error messages
- * that clearly indicate which environment variables are invalid and why.
- *
- * @example
- * ```ts
- * import arkenv from 'arkenv';
- * import { ArkEnvError } from 'arkenv/core';
- *
- * try {
- *   const env = arkenv({
- *     PORT: 'number.port',
- *     HOST: 'string.host',
- *   });
- * } catch (error) {
- *   if (error instanceof ArkEnvError) {
- *     console.error('Environment validation failed:', error.message);
- *   }
- * }
- * ```
- */
-declare class ArkEnvError extends Error {
-  /** The list of normalized issues that caused the validation failure */
-  readonly issues: EnvIssue[];
-  constructor(issues: EnvIssue[], message?: string);
-}
-/**
- * Result of a non-throwing arkenv parse operation.
- */
-type SafeArkEnvResult<T> = {
-  success: true;
-  data: T;
-} | {
-  success: false;
-  issues: readonly EnvIssue[];
-};
-//#endregion
-export { SafeArkEnvResult as a, EnvIssueMeta as i, EnvIssue as n, formatIssues as o, EnvIssueCode as r, ArkEnvError as t };
-
-// CJS Interop Shim
-if (module.exports && module.exports.default) {
-    Object.assign(module.exports.default, module.exports);
-    module.exports = module.exports.default;
-}
-      
-//# sourceMappingURL=core-7-JO-N-w.d.cts.map

package/dist/core-7-JO-N-w.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"core-7-JO-N-w.d.cts","names":[],"sources":["../src/core.ts"],"mappings":";;AAOA;;;KAAY,YAAA,0tBAuCZ;;;;KAhBY,YAAA;EA4BX,0EA1BA,GAAA,WA0BmB;EAxBnB,GAAA,WAiCe;EA/Bf,UAAA;EAEA,UAAA,WA6B8C;EA3B9C,cAAA;AAAA;;;;KAMW,QAAA;EAsD0B,uEApDrC,IAAA,UAoDgC;EAlDhC,OAAA,UAoDiB;EAlDjB,IAAA,EAAM,YAAA,EAqDG;EAnDT,QAAA,WAoDC;EAlDD,QAAA,YAkDgE;EAhDhE,IAAA,GAAO,YAAA;AAAA;;;;;;;iBASQ,YAAA,CAAa,MAAA,EAAQ,QAAA;;;;;;;;;;;;;;;;;;;;;;;;cAiCxB,WAAA,SAAoB,KAAA;;WAEvB,MAAA,EAAQ,QAAA;cAGhB,MAAA,EAAQ,QAAA,IACR,OAAA;AAAA;;;;KAcU,gBAAA;EACP,OAAA;EAAe,IAAA,EAAM,CAAA;AAAA;EACrB,OAAA;EAAgB,MAAA,WAAiB,QAAA;AAAA"}

package/dist/core-A65KioHX.mjs

@@ -1,6 +0,0 @@
-const e=(e,t=2,{dontDetectNewlines:n=!1}={})=>n?`${` `.repeat(t)}${e}`:e.split(`
-`).map(e=>`${` `.repeat(t)}${e}`).join(`
-`),t={red:`\x1B[31m`,yellow:`\x1B[33m`,cyan:`\x1B[36m`,reset:`\x1B[0m`},n=()=>typeof process<`u`&&process.versions!=null&&process.versions.node!=null,r=()=>!!(!n()||process.env.NO_COLOR!==void 0||process.env.CI!==void 0||process.stdout&&!process.stdout.isTTY),i=(e,i)=>n()&&!r()?`${t[e]}${i}${t.reset}`:i;function a(e){return e.map(e=>`${i(`yellow`,e.path)} ${e.message.trimStart()}`).join(`
-`)}var o=class extends Error{constructor(t,n=`Errors found while validating environment variables`){let r=a(t);super(`${i(`red`,n)}\n${e(r)}\n`),this.name=`ArkEnvError`,this.issues=t}};Object.defineProperty(o,`name`,{value:`ArkEnvError`});export{a as n,i as r,o as t};
-
-//# sourceMappingURL=core-A65KioHX.mjs.map

package/dist/core-A65KioHX.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"core-A65KioHX.mjs","names":[],"sources":["../src/utils/indent.ts","../src/utils/style-text.ts","../src/core.ts"],"sourcesContent":["/**\n * Options for the `indent` function\n */\ntype IndentOptions = {\n\t/**\n\t * Whether to detect newlines and indent each line individually, defaults to false (indenting the whole string)\n\t */\n\tdontDetectNewlines?: boolean;\n};\n\n/**\n * Indent a string by a given amount\n * @param str - The string to indent\n * @param amt - The amount to indent by, defaults to 2\n * @param options - {@link IndentOptions}\n * @returns The indented string\n */\nexport const indent = (\n\tstr: string,\n\tamt = 2,\n\t{ dontDetectNewlines = false }: IndentOptions = {},\n) => {\n\tconst detectNewlines = !dontDetectNewlines;\n\tif (detectNewlines) {\n\t\treturn str\n\t\t\t.split(\"\\n\")\n\t\t\t.map((line) => `${\" \".repeat(amt)}${line}`)\n\t\t\t.join(\"\\n\");\n\t}\n\n\treturn `${\" \".repeat(amt)}${str}`;\n};\n","/**\n * Cross-platform text styling utility\n * Uses ANSI colors in Node environments, plain text in browsers\n * Respects NO_COLOR, CI environment variables, and TTY detection\n */\n\n// ANSI color codes for Node environments\nconst colors = {\n\tred: \"\\x1b[31m\",\n\tyellow: \"\\x1b[33m\",\n\tcyan: \"\\x1b[36m\",\n\treset: \"\\x1b[0m\",\n} as const;\n\n/**\n * Check if we're in a Node environment (not browser)\n * Checked dynamically to allow for testing with mocked globals\n */\nconst isNode = (): boolean =>\n\ttypeof process !== \"undefined\" &&\n\tprocess.versions != null &&\n\tprocess.versions.node != null;\n\n/**\n * Check if colors should be disabled based on environment\n * Respects NO_COLOR, CI environment variables, and TTY detection\n */\nconst shouldDisableColors = (): boolean => {\n\tif (!isNode()) return true;\n\n\t// Respect NO_COLOR environment variable (https://no-color.org/)\n\tif (process.env.NO_COLOR !== undefined) return true;\n\n\t// Disable colors in CI environments by default\n\tif (process.env.CI !== undefined) return true;\n\n\t// Disable colors if not writing to a TTY\n\tif (process.stdout && !process.stdout.isTTY) return true;\n\n\treturn false;\n};\n\n/**\n * Style text with color. Uses ANSI codes in Node, plain text in browsers.\n * @param color - The color to apply\n * @param text - The text to style\n * @returns Styled text in Node (if colors enabled), plain text otherwise\n */\nexport const styleText = (\n\tcolor: \"red\" | \"yellow\" | \"cyan\",\n\ttext: string,\n): string => {\n\t// Use ANSI colors only in Node environments with colors enabled\n\tif (isNode() && !shouldDisableColors()) {\n\t\treturn `${colors[color]}${text}${colors.reset}`;\n\t}\n\t// Fall back to plain text in browsers or when colors are disabled\n\treturn text;\n};\n","import { indent } from \"@/utils/indent\";\nimport { styleText } from \"@/utils/style-text\";\n\n/**\n * Machine-readable classification codes for environment validation issues.\n * Serves as the Source of Truth (SoT) for error categorization in ArkEnv.\n */\nexport type EnvIssueCode =\n\t/** The environment variable is required but was not provided, and has no default value. */\n\t| \"MISSING_VARIABLE\"\n\t/** The variable value failed a type assertion (e.g., expected a number or boolean but received a string). */\n\t| \"INVALID_TYPE\"\n\t/** The variable value falls below the minimum allowed numeric limit or string/array length constraint. */\n\t| \"VALUE_TOO_SMALL\"\n\t/** The variable value exceeds the maximum allowed numeric limit or string/array length constraint. */\n\t| \"VALUE_TOO_LARGE\"\n\t/** The variable value did not match the specified regular expression (regex) pattern constraint. */\n\t| \"PATTERN_MISMATCH\"\n\t/** The variable value is not in a valid format (e.g., failed email or UUID format validation). */\n\t| \"INVALID_FORMAT\"\n\t/** An undeclared key was found in the environment, and the schema config is set to reject undeclared keys. */\n\t| \"UNDECLARED_KEY\"\n\t/** The provided validation schema definition itself is malformed or invalid. */\n\t| \"INVALID_SCHEMA\"\n\t/** A validation error was triggered by a custom validator function or inline pipe logic. */\n\t| \"CUSTOM\";\n\n/**\n * Metadata associated with an environment validation issue.\n */\nexport type EnvIssueMeta = {\n\t/** The minimum expected boundary for numeric/string length constraints */\n\tmin?: number;\n\t/** The maximum expected boundary for numeric/string length constraints */\n\tmax?: number;\n\t/** Additional validation pattern/specifier details */\n\tvalidation?: string;\n\t/** Any custom constraint descriptions */\n\tconstraint?: string;\n\t/** Traversal error occurred during JSON-parsing of the environment variable */\n\ttraversalError?: string;\n};\n\n/**\n * Normalized validation issue representing a failure on a specific environment variable.\n */\nexport type EnvIssue = {\n\t/** The dot-separated property path/name of the environment variable */\n\tpath: string;\n\t/** The descriptive, user-friendly error message */\n\tmessage: string;\n\t/** The normalized classification code for the issue */\n\tcode: EnvIssueCode;\n\t/** The expected type or value shape description */\n\texpected?: string;\n\t/** The raw value received (redacted in string formatting if sensitive) */\n\treceived?: unknown;\n\t/** Additional validation metadata */\n\tmeta?: EnvIssueMeta;\n};\n\n/**\n * Format a list of normalized environment issues into a single styled string.\n *\n * @param issues - The array of normalized issues to format\n * @returns The formatted and styled error report string\n */\nexport function formatIssues(issues: EnvIssue[]): string {\n\treturn issues\n\t\t.map((issue) => {\n\t\t\tconst pathStr = styleText(\"yellow\", issue.path);\n\t\t\tconst messageStr = issue.message.trimStart();\n\t\t\treturn `${pathStr} ${messageStr}`;\n\t\t})\n\t\t.join(\"\\n\");\n}\n\n/**\n * Error thrown when environment variable validation fails.\n *\n * This error extends the native `Error` class and provides formatted error messages\n * that clearly indicate which environment variables are invalid and why.\n *\n * @example\n * ```ts\n * import arkenv from 'arkenv';\n * import { ArkEnvError } from 'arkenv/core';\n *\n * try {\n *   const env = arkenv({\n *     PORT: 'number.port',\n *     HOST: 'string.host',\n *   });\n * } catch (error) {\n *   if (error instanceof ArkEnvError) {\n *     console.error('Environment validation failed:', error.message);\n *   }\n * }\n * ```\n */\nexport class ArkEnvError extends Error {\n\t/** The list of normalized issues that caused the validation failure */\n\treadonly issues: EnvIssue[];\n\n\tconstructor(\n\t\tissues: EnvIssue[],\n\t\tmessage = \"Errors found while validating environment variables\",\n\t) {\n\t\tconst formattedIssues = formatIssues(issues);\n\t\tsuper(`${styleText(\"red\", message)}\\n${indent(formattedIssues)}\\n`);\n\t\tthis.name = \"ArkEnvError\";\n\t\tthis.issues = issues;\n\t}\n}\n\nObject.defineProperty(ArkEnvError, \"name\", { value: \"ArkEnvError\" });\n\n/**\n * Result of a non-throwing arkenv parse operation.\n */\nexport type SafeArkEnvResult<T> =\n\t| { success: true; data: T }\n\t| { success: false; issues: readonly EnvIssue[] };\n"],"mappings":"AAiBA,MAAa,GACZ,EACA,EAAM,EACN,CAAE,qBAAqB,IAAyB,EAAE,GAE1B,EAQjB,GAAG,IAAI,OAAO,EAAI,GAAG,IANpB,EACL,MAAM;EAAK,CACX,IAAK,GAAS,GAAG,IAAI,OAAO,EAAI,GAAG,IAAO,CAC1C,KAAK;EAAK,CCpBR,EAAS,CACd,IAAK,WACL,OAAQ,WACR,KAAM,WACN,MAAO,UACP,CAMK,MACL,OAAO,QAAY,KACnB,QAAQ,UAAY,MACpB,QAAQ,SAAS,MAAQ,KAMpB,MAUL,GATI,CAAC,GAAQ,EAGT,QAAQ,IAAI,WAAa,IAAA,IAGzB,QAAQ,IAAI,KAAO,IAAA,IAGnB,QAAQ,QAAU,CAAC,QAAQ,OAAO,OAW1B,GACZ,EACA,IAGI,GAAQ,EAAI,CAAC,GAAqB,CAC9B,GAAG,EAAO,KAAS,IAAO,EAAO,QAGlC,ECUR,SAAgB,EAAa,EAA4B,CACxD,OAAO,EACL,IAAK,GAGE,GAFS,EAAU,SAAU,EAAM,KAEzB,CAAC,GADC,EAAM,QAAQ,WACF,GAC9B,CACD,KAAK;EAAK,CA0Bb,IAAa,EAAb,cAAiC,KAAM,CAItC,YACC,EACA,EAAU,sDACT,CACD,IAAM,EAAkB,EAAa,EAAO,CAC5C,MAAM,GAAG,EAAU,MAAO,EAAQ,CAAC,IAAI,EAAO,EAAgB,CAAC,IAAI,CACnE,KAAK,KAAO,cACZ,KAAK,OAAS,IAIhB,OAAO,eAAe,EAAa,OAAQ,CAAE,MAAO,cAAe,CAAC"}

package/dist/core-BaGd9k2K.d.mts

@@ -1,76 +0,0 @@
-//#region src/core.d.ts
-/**
- * Machine-readable classification codes for environment validation issues.
- * Serves as the Source of Truth (SoT) for error categorization in ArkEnv.
- */
-type EnvIssueCode = /** The environment variable is required but was not provided, and has no default value. */"MISSING_VARIABLE" /** The variable value failed a type assertion (e.g., expected a number or boolean but received a string). */ | "INVALID_TYPE" /** The variable value falls below the minimum allowed numeric limit or string/array length constraint. */ | "VALUE_TOO_SMALL" /** The variable value exceeds the maximum allowed numeric limit or string/array length constraint. */ | "VALUE_TOO_LARGE" /** The variable value did not match the specified regular expression (regex) pattern constraint. */ | "PATTERN_MISMATCH" /** The variable value is not in a valid format (e.g., failed email or UUID format validation). */ | "INVALID_FORMAT" /** An undeclared key was found in the environment, and the schema config is set to reject undeclared keys. */ | "UNDECLARED_KEY" /** The provided validation schema definition itself is malformed or invalid. */ | "INVALID_SCHEMA" /** A validation error was triggered by a custom validator function or inline pipe logic. */ | "CUSTOM";
-/**
- * Metadata associated with an environment validation issue.
- */
-type EnvIssueMeta = {
-  /** The minimum expected boundary for numeric/string length constraints */min?: number; /** The maximum expected boundary for numeric/string length constraints */
-  max?: number; /** Additional validation pattern/specifier details */
-  validation?: string; /** Any custom constraint descriptions */
-  constraint?: string; /** Traversal error occurred during JSON-parsing of the environment variable */
-  traversalError?: string;
-};
-/**
- * Normalized validation issue representing a failure on a specific environment variable.
- */
-type EnvIssue = {
-  /** The dot-separated property path/name of the environment variable */path: string; /** The descriptive, user-friendly error message */
-  message: string; /** The normalized classification code for the issue */
-  code: EnvIssueCode; /** The expected type or value shape description */
-  expected?: string; /** The raw value received (redacted in string formatting if sensitive) */
-  received?: unknown; /** Additional validation metadata */
-  meta?: EnvIssueMeta;
-};
-/**
- * Format a list of normalized environment issues into a single styled string.
- *
- * @param issues - The array of normalized issues to format
- * @returns The formatted and styled error report string
- */
-declare function formatIssues(issues: EnvIssue[]): string;
-/**
- * Error thrown when environment variable validation fails.
- *
- * This error extends the native `Error` class and provides formatted error messages
- * that clearly indicate which environment variables are invalid and why.
- *
- * @example
- * ```ts
- * import arkenv from 'arkenv';
- * import { ArkEnvError } from 'arkenv/core';
- *
- * try {
- *   const env = arkenv({
- *     PORT: 'number.port',
- *     HOST: 'string.host',
- *   });
- * } catch (error) {
- *   if (error instanceof ArkEnvError) {
- *     console.error('Environment validation failed:', error.message);
- *   }
- * }
- * ```
- */
-declare class ArkEnvError extends Error {
-  /** The list of normalized issues that caused the validation failure */
-  readonly issues: EnvIssue[];
-  constructor(issues: EnvIssue[], message?: string);
-}
-/**
- * Result of a non-throwing arkenv parse operation.
- */
-type SafeArkEnvResult<T> = {
-  success: true;
-  data: T;
-} | {
-  success: false;
-  issues: readonly EnvIssue[];
-};
-//#endregion
-export { SafeArkEnvResult as a, EnvIssueMeta as i, EnvIssue as n, formatIssues as o, EnvIssueCode as r, ArkEnvError as t };
-
-//# sourceMappingURL=core-BaGd9k2K.d.mts.map

package/dist/core-BaGd9k2K.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"core-BaGd9k2K.d.mts","names":[],"sources":["../src/core.ts"],"mappings":";;AAOA;;;KAAY,YAAA,0tBAuCZ;;;;KAhBY,YAAA;EA4BX,0EA1BA,GAAA,WA0BmB;EAxBnB,GAAA,WAiCe;EA/Bf,UAAA;EAEA,UAAA,WA6B8C;EA3B9C,cAAA;AAAA;;;;KAMW,QAAA;EAsD0B,uEApDrC,IAAA,UAoDgC;EAlDhC,OAAA,UAoDiB;EAlDjB,IAAA,EAAM,YAAA,EAqDG;EAnDT,QAAA,WAoDC;EAlDD,QAAA,YAkDgE;EAhDhE,IAAA,GAAO,YAAA;AAAA;;;;;;;iBASQ,YAAA,CAAa,MAAA,EAAQ,QAAA;;;;;;;;;;;;;;;;;;;;;;;;cAiCxB,WAAA,SAAoB,KAAA;;WAEvB,MAAA,EAAQ,QAAA;cAGhB,MAAA,EAAQ,QAAA,IACR,OAAA;AAAA;;;;KAcU,gBAAA;EACP,OAAA;EAAe,IAAA,EAAM,CAAA;AAAA;EACrB,OAAA;EAAgB,MAAA,WAAiB,QAAA;AAAA"}

package/dist/core-CA13n2Iu.cjs

@@ -1,11 +0,0 @@
-const e=(e,t=2,{dontDetectNewlines:n=!1}={})=>n?`${` `.repeat(t)}${e}`:e.split(`
-`).map(e=>`${` `.repeat(t)}${e}`).join(`
-`),t={red:`\x1B[31m`,yellow:`\x1B[33m`,cyan:`\x1B[36m`,reset:`\x1B[0m`},n=()=>typeof process<`u`&&process.versions!=null&&process.versions.node!=null,r=()=>!!(!n()||process.env.NO_COLOR!==void 0||process.env.CI!==void 0||process.stdout&&!process.stdout.isTTY),i=(e,i)=>n()&&!r()?`${t[e]}${i}${t.reset}`:i;function a(e){return e.map(e=>`${i(`yellow`,e.path)} ${e.message.trimStart()}`).join(`
-`)}var o=class extends Error{constructor(t,n=`Errors found while validating environment variables`){let r=a(t);super(`${i(`red`,n)}\n${e(r)}\n`),this.name=`ArkEnvError`,this.issues=t}};Object.defineProperty(o,`name`,{value:`ArkEnvError`}),Object.defineProperty(exports,`n`,{enumerable:!0,get:function(){return a}}),Object.defineProperty(exports,`r`,{enumerable:!0,get:function(){return i}}),Object.defineProperty(exports,`t`,{enumerable:!0,get:function(){return o}});
-
-// CJS Interop Shim
-if (module.exports && module.exports.default) {
-    Object.assign(module.exports.default, module.exports);
-    module.exports = module.exports.default;
-}
-      

package/dist/core.cjs

@@ -1,8 +0,0 @@
-Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});const e=require(`./core-CA13n2Iu.cjs`);exports.ArkEnvError=e.t,exports.formatIssues=e.n;
-
-// CJS Interop Shim
-if (module.exports && module.exports.default) {
-    Object.assign(module.exports.default, module.exports);
-    module.exports = module.exports.default;
-}
-      

package/dist/core.d.cts

@@ -1,9 +0,0 @@
-import { a as SafeArkEnvResult, i as EnvIssueMeta, n as EnvIssue, o as formatIssues, r as EnvIssueCode, t as ArkEnvError } from "./core-7-JO-N-w.cjs";
-export { ArkEnvError, EnvIssue, EnvIssueCode, EnvIssueMeta, SafeArkEnvResult, formatIssues };
-
-// CJS Interop Shim
-if (module.exports && module.exports.default) {
-    Object.assign(module.exports.default, module.exports);
-    module.exports = module.exports.default;
-}
-      

package/dist/core.d.mts

@@ -1,2 +0,0 @@
-import { a as SafeArkEnvResult, i as EnvIssueMeta, n as EnvIssue, o as formatIssues, r as EnvIssueCode, t as ArkEnvError } from "./core-BaGd9k2K.mjs";
-export { ArkEnvError, EnvIssue, EnvIssueCode, EnvIssueMeta, SafeArkEnvResult, formatIssues };

package/dist/core.mjs

@@ -1 +0,0 @@
-import{n as e,t}from"./core-A65KioHX.mjs";export{t as ArkEnvError,e as formatIssues};

package/dist/errors-C_uh86xh.mjs

@@ -1,3 +0,0 @@
-import{r as e,t}from"./core-A65KioHX.mjs";const n=e=>{if(typeof e==`number`||typeof e!=`string`||!e.trim())return e;if(e.trim()===`NaN`)return NaN;let t=Number(e);return Number.isNaN(t)?e:t},r=e=>e===`true`?!0:e===`false`?!1:e,i=e=>{if(typeof e!=`string`)return e;let t=e.trim();if(t[0]!==`{`&&t[0]!==`[`)return e;try{return JSON.parse(t)}catch{return e}},a=e=>{if(e instanceof Date||typeof e!=`string`||!e.trim())return e;let t=new Date(e);return Number.isNaN(t.getTime())?e:t},o=e=>{let t={};for(let n in e){let r=e[n];r!==``&&(t[n]=r)}return t},s=(e,t=[])=>{let n=[];if(!e||typeof e!=`object`||Array.isArray(e))return n;let r=e;if(`const`in r){let e=typeof r.const;(e===`number`||e===`boolean`)&&n.push({path:[...t],type:`primitive`})}`enum`in r&&Array.isArray(r.enum)&&r.enum.some(e=>typeof e==`number`||typeof e==`boolean`)&&n.push({path:[...t],type:`primitive`});let i=r.type;if(i===`number`||i===`integer`||i===`boolean`)n.push({path:[...t],type:`primitive`});else if(i===`string`&&`format`in r&&(r.format===`date-time`||r.format===`date`))n.push({path:[...t],type:`date`});else if(i===`object`){if(r.properties&&Object.keys(r.properties).length>0){n.push({path:[...t],type:`object`});for(let e in r.properties)n.push(...s(r.properties[e],[...t,e]))}}else i===`array`&&(n.push({path:[...t],type:`array`}),r.items&&(Array.isArray(r.items)?r.items.forEach((e,r)=>{n.push(...s(e,[...t,String(r)]))}):n.push(...s(r.items,[...t,`*`]))));for(let e of[`anyOf`,`allOf`,`oneOf`])if(r[e]&&Array.isArray(r[e]))for(let i of r[e])n.push(...s(i,t));let a=new Set;return n.filter(e=>{let t=e.path.join(`/`)+`:`+e.type;return a.has(t)?!1:a.add(t)})},c=(e,t,o={})=>{let{arrayFormat:s=`comma`}=o,c=e=>{if(s===`json`)try{return JSON.parse(e)}catch{return e}return e.trim()?e.split(`,`).map(e=>e.trim()):[]},l=(e,t)=>{if(t===`array`&&typeof e==`string`)return c(e);if(t===`object`&&typeof e==`string`)return i(e);if(t===`date`&&typeof e==`string`)return a(e);if(t===`primitive`){if(Array.isArray(e))return e.map(e=>{if(typeof e!=`string`)return e;let t=n(e);return typeof t==`number`?t:r(e)});if(typeof e!=`string`)return e;let t=n(e);return typeof t==`number`?t:r(e)}return e};if(typeof e!=`object`||!e){let n=t.find(e=>e.path.length===0);return n?l(e,n.type):e}let u=[...t].sort((e,t)=>e.path.length-t.path.length),d=(e,t,n)=>{if(t.length===0)return n(e);let[r,...i]=t;if(r===`*`){if(Array.isArray(e)){let t=!1,r=e.map(e=>{let r=d(e,i,n);return r!==e&&(t=!0),r});return t?r:e}return e}if(!e||typeof e!=`object`)return e;if(Array.isArray(e)){let t=Number(r);if(!Number.isNaN(t)&&t>=0&&t<e.length){let r=d(e[t],i,n);if(r!==e[t]){let n=[...e];return n[t]=r,n}}return e}if(Object.hasOwn(e,r)){let t=d(e[r],i,n);if(t!==e[r])return{...e,[r]:t}}return e},f=e;for(let e of u)e.path.length>0&&(f=d(f,e.path,t=>l(t,e.type)));return f};function l(e,t,n,r){let i=t?o(e):e,a={...i},l=[];if(r){let e=r();l.push(...e.missingKeys||[]),e.hasSchema&&(a=c(a,s(e.schema),{arrayFormat:n}))}return{processedEnv:i,coercedEnv:a,missingKeys:l}}const u=/secret|(_|^)key(_|$)|token|(_|^)password(_|$)|(_|^)pass(_|$)|(_|^)auth(_|$)|jwt|cert|credential|database_url|db_url/i;function d(e){if(e!==void 0)return e;if(typeof process>`u`)return!1;let t=process.env.ARKENV_DEBUG_SECRETS;return t===`true`||t===`1`}function f(e){return u.test(e)&&!/public/i.test(e)}function p(e,t,n){let r=d(n?.debugSecrets);if(e===void 0)return`missing`;if(e===null)return`null`;if(!r&&f(t))return`[REDACTED]`;if(typeof e==`string`)return JSON.stringify(e);if(typeof e==`number`||typeof e==`boolean`||typeof e==`bigint`)return String(e);if(typeof e==`symbol`)return e.toString();if(typeof e==`function`)return`[Function]`;if(e&&typeof e==`object`)try{if(Array.isArray(e)){let r=e.slice(0,3).map(e=>p(e,t,n));return e.length>3&&r.push(`...(+${e.length-3} more)`),`[${r.join(`, `)}]`}let r=Object.keys(e),i=r.slice(0,3).map(r=>`${r}: ${p(e[r],t,n)}`);return r.length>3&&i.push(`...(+${r.length-3} more)`),`{ ${i.join(`, `)} }`}catch{return Object.prototype.toString.call(e)}return String(e)}const m={required:`MISSING_VARIABLE`,pattern:`PATTERN_MISMATCH`,min:`VALUE_TOO_SMALL`,minLength:`VALUE_TOO_SMALL`,max:`VALUE_TOO_LARGE`,maxLength:`VALUE_TOO_LARGE`,divisor:`INVALID_TYPE`,intersection:`INVALID_TYPE`,union:`INVALID_TYPE`,unit:`INVALID_TYPE`,proto:`INVALID_TYPE`,domain:`INVALID_TYPE`,exactLength:`INVALID_FORMAT`,before:`INVALID_FORMAT`,after:`INVALID_FORMAT`,predicate:`CUSTOM`};function h(e){return e in m?m[e]:`INVALID_FORMAT`}function g(e){let t=e.min??e.rule,n=e.max;return{...typeof t==`number`?{min:t}:{},...typeof n==`number`?{max:n}:{}}}const _={too_small:`VALUE_TOO_SMALL`,too_big:`VALUE_TOO_LARGE`,invalid_string:`INVALID_FORMAT`,invalid_date:`INVALID_FORMAT`,custom:`INVALID_FORMAT`};function v(e,t,n){let r=t.toLowerCase();return e===`invalid_type`&&(n===void 0||n===`undefined`)||r===`required`?`MISSING_VARIABLE`:e in _?_[e]:/regex|pattern|match/.test(r)?`PATTERN_MISMATCH`:`INVALID_TYPE`}function y(e){let t=e.minimum??e.min,n=e.maximum??e.max;return{...typeof t==`number`?{min:t}:{},...typeof n==`number`?{max:n}:{}}}function b(e){try{return{success:!0,data:e()}}catch(e){if(e instanceof t)return{success:!1,issues:e.issues};throw e}}function x(e,t,n,r,i,a){let o={path:e,message:t,code:n,meta:r??{}};return i&&(o.expected=i),a!==void 0&&(o.received=a),o}function S(t,n,r,i,a,o){if(n===`MISSING_VARIABLE`)return r?`must be ${r} (was missing)`:`is required`;if(t.includes(`(was `))return t;let s=`(was ${e(`cyan`,!d(o?.debugSecrets)&&f(a)?`[REDACTED]`:p(i,a,o))})`;return r&&!t.includes(`Expected`)?`must be ${r} ${s}`:`${t} ${s}`}function C(t,n,r){let i=t.match(/\(was (.*)\)/);if(!i?.[1])return t;let a=i[1],o=!d(r)&&f(n)?`[REDACTED]`:a;return o.includes(`\x1B[`)?t:t.replace(`(was ${a})`,`(was ${e(`cyan`,o)})`)}export{h as a,b as c,y as i,l,S as n,v as o,g as r,C as s,x as t};
-
-//# sourceMappingURL=errors-C_uh86xh.mjs.map