arkenv 0.7.4 → 0.7.5

package/dist/index.d.cts

@@ -184,4 +184,5 @@ declare class ArkEnvError extends Error {
  */
 declare const arkenv: typeof createEnv;
 //#endregion
-export { ArkEnvError, type EnvSchema, createEnv, arkenv as default, type };
+export { ArkEnvError, type EnvSchema, createEnv, arkenv as default, type };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/scope.ts","../src/create-env.ts","../src/type.ts","../src/errors.ts","../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;cAQa,aAAC;;;;IAUZ,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAVY,qBAAA,yDAAA;MAAA,cAAA,EAAA,MAAA;;;;ICJT,KAAA,qBAAqB,CAAM;MAEpB,IAAS,EAAA,CAAA,EAAA,EAAA,MAAA,EAAA,qCAAA,CAAA,MAAA,CAAA;MAAsB,YAAA,EAAA,MAAA;IAAa,CAAA,GAAA;MAAtB,cAAA,EAAA,CAAA,EAAA,EAAA,MAAA,EAAA,qCAAA,CAAA,MAAA,CAAA;IAAQ,CAAA,CAAA;IAc1B,GAAA,qBAAS,+CAAA;MAAiB,cAAA,EAAA,MAAA;IAC1B,CAAA,CAAA;IAAV,IAAA,qBAAA,gDAAA;MACA,cAAA,EAAA,MAAA;IACoB,CAAA,CAAA;IAAW,cAAA,EAAA,MAAA;IAAjB,IAAA,EAAA,MAAA;EAAjB,CAAA,CAAA;EAAW,MAAA,qBAAA,CAAA;;;;ICrBD,OAAa,EAAA,MAAA;;;;;;;;;;;KDErB,kBAAA,GAAqB;KAEd,iBAAiB,MAAA,CAAK,SAAS,aAAa;;;;ADExD;;;;;;;;iBCYgB,0BAA0B,8BACpC,UAAU,UACV,qBACH,OAAA,CAAQ,IAAI,MAAA,CAAK,MAAM,WAAW;;;cCrBxB,gCAAI;;;;;;;IFgBf,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAVY,EAAA,MAAA;IAAA,MAAA,EAAA,MAAA;;;;ICJT,CAAA,GAAA;MAEO,cAAS,EAAA,CAAA,EAAA,EAAA,MAAA,EAAA,qCAAA,CAAA,MAAA,CAAA;IAAsB,CAAA,CAAA;IAAa,GAAA,qBAAA,+CAAA;MAAtB,cAAA,EAAA,MAAA;IAAQ,CAAA,CAAA;IAc1B,IAAA,qBAAS,gDAAA;MAAiB,cAAA,EAAA,MAAA;IAC1B,CAAA,CAAA;IAAV,cAAA,EAAA,MAAA;IACA,IAAA,EAAA,MAAA;EACoB,CAAA,CAAA;EAAW,MAAA,qBAAA,CAAA;IAAjB,GAAA,EAAA,MAAA;IAAjB,QAAQ,EAAA,MAAA;IAAG,IAAA,EAAA,MAAA;;;;ICrBD,IAAa,EAAA,MAAA;;;;;;;;AFMb,cGqBA,WAAA,SAAoB,KAAA,CHX/B;sBGaQ;;;;;;;;;AHvBV,cICM,MJSJ,EAAA,OITU,SJSV"}

package/dist/index.d.ts

@@ -184,4 +184,5 @@ declare class ArkEnvError extends Error {
  */
 declare const arkenv: typeof createEnv;
 //#endregion
-export { ArkEnvError, type EnvSchema, createEnv, arkenv as default, type };
+export { ArkEnvError, type EnvSchema, createEnv, arkenv as default, type };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/scope.ts","../src/create-env.ts","../src/type.ts","../src/errors.ts","../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;;;cAQa,aAAC;;;;IAUZ,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAVY,qBAAA,yDAAA;MAAA,cAAA,EAAA,MAAA;;;;ICJT,KAAA,qBAAqB,CAAM;MAEpB,IAAS,EAAA,CAAA,EAAA,EAAA,MAAA,EAAA,qCAAA,CAAA,MAAA,CAAA;MAAsB,YAAA,EAAA,MAAA;IAAa,CAAA,GAAA;MAAtB,cAAA,EAAA,CAAA,EAAA,EAAA,MAAA,EAAA,qCAAA,CAAA,MAAA,CAAA;IAAQ,CAAA,CAAA;IAc1B,GAAA,qBAAS,+CAAA;MAAiB,cAAA,EAAA,MAAA;IAC1B,CAAA,CAAA;IAAV,IAAA,qBAAA,gDAAA;MACA,cAAA,EAAA,MAAA;IACoB,CAAA,CAAA;IAAW,cAAA,EAAA,MAAA;IAAjB,IAAA,EAAA,MAAA;EAAjB,CAAA,CAAA;EAAW,MAAA,qBAAA,CAAA;;;;ICrBD,OAAa,EAAA,MAAA;;;;;;;;;;;KDErB,kBAAA,GAAqB;KAEd,iBAAiB,MAAA,CAAK,SAAS,aAAa;;;;ADExD;;;;;;;;iBCYgB,0BAA0B,8BACpC,UAAU,UACV,qBACH,OAAA,CAAQ,IAAI,MAAA,CAAK,MAAM,WAAW;;;cCrBxB,gCAAI;;;;;;;IFgBf,CAAA,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAVY,EAAA,MAAA;IAAA,MAAA,EAAA,MAAA;;;;ICJT,CAAA,GAAA;MAEO,cAAS,EAAA,CAAA,EAAA,EAAA,MAAA,EAAA,qCAAA,CAAA,MAAA,CAAA;IAAsB,CAAA,CAAA;IAAa,GAAA,qBAAA,+CAAA;MAAtB,cAAA,EAAA,MAAA;IAAQ,CAAA,CAAA;IAc1B,IAAA,qBAAS,gDAAA;MAAiB,cAAA,EAAA,MAAA;IAC1B,CAAA,CAAA;IAAV,cAAA,EAAA,MAAA;IACA,IAAA,EAAA,MAAA;EACoB,CAAA,CAAA;EAAW,MAAA,qBAAA,CAAA;IAAjB,GAAA,EAAA,MAAA;IAAjB,QAAQ,EAAA,MAAA;IAAG,IAAA,EAAA,MAAA;;;;ICrBD,IAAa,EAAA,MAAA;;;;;;;;AFMb,cGqBA,WAAA,SAAoB,KAAA,CHX/B;sBGaQ;;;;;;;;;AHvBV,cICM,MJSJ,EAAA,OITU,SJSV"}

package/dist/index.js

@@ -1,4 +1,5 @@
 import{scope as e,type as t}from"arktype";const n={red:`\x1B[31m`,yellow:`\x1B[33m`,cyan:`\x1B[36m`,reset:`\x1B[0m`},r=()=>typeof process<`u`&&process.versions!=null&&process.versions.node!=null,i=()=>!!(!r()||process.env.NO_COLOR!==void 0||process.env.CI!==void 0||process.stdout&&!process.stdout.isTTY),a=(e,t)=>r()&&!i()?`${n[e]}${t}${n.reset}`:t,o=(e,t=2,{dontDetectNewlines:n=!1}={})=>n?`${` `.repeat(t)}${e}`:e.split(`
 `).map(e=>`${` `.repeat(t)}${e}`).join(`
 `),s=e=>Object.entries(e.byPath).map(([e,t])=>{let n=t.message.startsWith(e)?t.message.slice(e.length):t.message,r=n.match(/\(was "([^"]+)"\)/),i=r?n.replace(`(was "${r[1]}")`,`(was ${a(`cyan`,`"${r[1]}"`)})`):n;return`${a(`yellow`,e)}${i}`}).join(`
-`);var c=class extends Error{constructor(e,t=`Errors found while validating environment variables`){super(`${a(`red`,t)}\n${o(s(e))}\n`),this.name=`ArkEnvError`}};const l=t(`string`,`=>`,(e,t)=>{let n=Number.parseInt(e,10);return(!Number.isInteger(n)||!(0<=n&&n<=65535))&&t.mustBe(`an integer between 0 and 65535`),n}),u=t(`string.ip | 'localhost'`),d=t(`'true' | 'false' | true | false`,`=>`,e=>e===`true`||e===!0),f=e({string:t.module({...t.keywords.string,host:u}),number:t.module({...t.keywords.number,port:l}),boolean:d});function p(e,n=process.env){let r=f.type.raw(e)(n);if(r instanceof t.errors)throw new c(r);return r}const m=f.type;var h=p;export{c as ArkEnvError,p as createEnv,h as default,m as type};
+`);var c=class extends Error{constructor(e,t=`Errors found while validating environment variables`){super(`${a(`red`,t)}\n${o(s(e))}\n`),this.name=`ArkEnvError`}};const l=t(`string`,`=>`,(e,t)=>{let n=Number.parseInt(e,10);return(!Number.isInteger(n)||!(0<=n&&n<=65535))&&t.mustBe(`an integer between 0 and 65535`),n}),u=t(`string.ip | 'localhost'`),d=t(`'true' | 'false' | true | false`,`=>`,e=>e===`true`||e===!0),f=e({string:t.module({...t.keywords.string,host:u}),number:t.module({...t.keywords.number,port:l}),boolean:d});function p(e,n=process.env){let r=f.type.raw(e)(n);if(r instanceof t.errors)throw new c(r);return r}const m=f.type;var h=p;export{c as ArkEnvError,p as createEnv,h as default,m as type};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["type","type","type"],"sources":["../src/lib/style-text.ts","../src/utils.ts","../src/errors.ts","../src/types.ts","../src/scope.ts","../src/create-env.ts","../src/type.ts","../src/index.ts"],"sourcesContent":["/**\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","/**\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","import type { ArkErrors } from \"arktype\";\nimport { styleText } from \"./lib/style-text\";\nimport { indent } from \"./utils\";\n\n/**\n * Format the errors returned by ArkType to be more readable\n * @param errors - The errors returned by ArkType\n * @returns A string of the formatted errors\n */\nexport const formatErrors = (errors: ArkErrors): string =>\n\tObject.entries(errors.byPath)\n\t\t.map(([path, error]) => {\n\t\t\tconst messageWithoutPath = error.message.startsWith(path)\n\t\t\t\t? error.message.slice(path.length)\n\t\t\t\t: error.message;\n\n\t\t\t// Extract the value in parentheses if it exists\n\t\t\tconst valueMatch = messageWithoutPath.match(/\\(was \"([^\"]+)\"\\)/);\n\t\t\tconst formattedMessage = valueMatch\n\t\t\t\t? messageWithoutPath.replace(\n\t\t\t\t\t\t`(was \"${valueMatch[1]}\")`,\n\t\t\t\t\t\t`(was ${styleText(\"cyan\", `\"${valueMatch[1]}\"`)})`,\n\t\t\t\t\t)\n\t\t\t\t: messageWithoutPath;\n\n\t\t\treturn `${styleText(\"yellow\", path)}${formattedMessage}`;\n\t\t})\n\t\t.join(\"\\n\");\n\nexport class ArkEnvError extends Error {\n\tconstructor(\n\t\terrors: ArkErrors,\n\t\tmessage = \"Errors found while validating environment variables\",\n\t) {\n\t\tsuper(`${styleText(\"red\", message)}\\n${indent(formatErrors(errors))}\\n`);\n\t\tthis.name = \"ArkEnvError\";\n\t}\n}\n","import { type } from \"arktype\";\n\n/**\n * A `string` that can be parsed into a number between 0 and 65535\n */\nexport const port = type(\"string\", \"=>\", (data, ctx) => {\n\tconst asNumber = Number.parseInt(data, 10);\n\tconst isInteger = Number.isInteger(asNumber);\n\tconst isBetween = 0 <= asNumber && asNumber <= 65535;\n\tif (!isInteger || !isBetween) {\n\t\tctx.mustBe(\"an integer between 0 and 65535\");\n\t}\n\treturn asNumber;\n});\n\n/**\n * An IP address or `\"localhost\"`\n */\nexport const host = type(\"string.ip | 'localhost'\");\n\n/**\n * A boolean that accepts string values and converts them to boolean\n * Accepts \"true\" or \"false\" strings and converts them to actual boolean values\n */\nexport const boolean = type(\n\t\"'true' | 'false' | true | false\",\n\t\"=>\",\n\t(str) => str === \"true\" || str === true,\n);\n","import { scope, type } from \"arktype\";\nimport { boolean, host, port } from \"./types\";\n\n// For an explanation of the `$` variable naming convention, see: https://discord.com/channels/957797212103016458/1414659167008063588/1414670282756587581\n\n/**\n * The root scope for the ArkEnv library, containing extensions to the ArkType scopes with ArkEnv-specific types like `string.host` and `number.port`.\n */\nexport const $ = scope({\n\tstring: type.module({\n\t\t...type.keywords.string,\n\t\thost,\n\t}),\n\tnumber: type.module({\n\t\t...type.keywords.number,\n\t\tport,\n\t}),\n\tboolean,\n});\n","import { type distill, type } from \"arktype\";\nimport { ArkEnvError } from \"./errors\";\nimport { $ } from \"./scope\";\n\ntype RuntimeEnvironment = Record<string, string | undefined>;\n\nexport type EnvSchema<def> = type.validate<def, (typeof $)[\"t\"]>;\n\n/**\n * TODO: If possible, find a better type than \"const T extends Record<string, unknown>\",\n * and be as close as possible to the type accepted by ArkType's `type`.\n */\n\n/**\n * Create an environment variables object from a schema and an environment\n * @param def - The environment variable schema\n * @param env - The environment variables to validate, defaults to `process.env`\n * @returns The validated environment variable schema\n * @throws An {@link ArkEnvError | error} if the environment variables are invalid.\n */\nexport function createEnv<const T extends Record<string, unknown>>(\n\tdef: EnvSchema<T>,\n\tenv: RuntimeEnvironment = process.env,\n): distill.Out<type.infer<T, (typeof $)[\"t\"]>> {\n\tconst schema = $.type.raw(def);\n\n\tconst validatedEnv = schema(env);\n\n\tif (validatedEnv instanceof type.errors) {\n\t\tthrow new ArkEnvError(validatedEnv);\n\t}\n\n\treturn validatedEnv;\n}\n","import { $ } from \"./scope\";\n\nexport const type = $.type;\n","export type { EnvSchema } from \"./create-env\";\n\nimport { createEnv } from \"./create-env\";\n\n/**\n * `arkenv`'s main export, an alias for {@link createEnv}\n *\n * {@link https://arkenv.js.org | ArkEnv} is a typesafe environment variables parser powered by {@link https://arktype.io | ArkType}, TypeScript's 1:1 validator.\n */\nconst arkenv = createEnv;\nexport default arkenv;\nexport { type } from \"./type\";\nexport { createEnv };\nexport { ArkEnvError } from \"./errors\";\n"],"mappings":"0CAOA,MAAM,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,ECxCK,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,CClBD,EAAgB,GAC5B,OAAO,QAAQ,EAAO,OAAO,CAC3B,KAAK,CAAC,EAAM,KAAW,CACvB,IAAM,EAAqB,EAAM,QAAQ,WAAW,EAAK,CACtD,EAAM,QAAQ,MAAM,EAAK,OAAO,CAChC,EAAM,QAGH,EAAa,EAAmB,MAAM,oBAAoB,CAC1D,EAAmB,EACtB,EAAmB,QACnB,SAAS,EAAW,GAAG,IACvB,QAAQ,EAAU,OAAQ,IAAI,EAAW,GAAG,GAAG,CAAC,GAChD,CACA,EAEH,MAAO,GAAG,EAAU,SAAU,EAAK,GAAG,KACrC,CACD,KAAK;EAAK,CAEb,IAAa,EAAb,cAAiC,KAAM,CACtC,YACC,EACA,EAAU,sDACT,CACD,MAAM,GAAG,EAAU,MAAO,EAAQ,CAAC,IAAI,EAAO,EAAa,EAAO,CAAC,CAAC,IAAI,CACxE,KAAK,KAAO,gBC9Bd,MAAa,EAAOA,EAAK,SAAU,MAAO,EAAM,IAAQ,CACvD,IAAM,EAAW,OAAO,SAAS,EAAM,GAAG,CAM1C,OAHI,CAFc,OAAO,UAAU,EAAS,EAE1B,EADA,GAAK,GAAY,GAAY,SAE9C,EAAI,OAAO,iCAAiC,CAEtC,GACN,CAKW,EAAOA,EAAK,0BAA0B,CAMtC,EAAUA,EACtB,kCACA,KACC,GAAQ,IAAQ,QAAU,IAAQ,GACnC,CCpBY,EAAI,EAAM,CACtB,OAAQC,EAAK,OAAO,CACnB,GAAGA,EAAK,SAAS,OACjB,OACA,CAAC,CACF,OAAQA,EAAK,OAAO,CACnB,GAAGA,EAAK,SAAS,OACjB,OACA,CAAC,CACF,UACA,CAAC,CCEF,SAAgB,EACf,EACA,EAA0B,QAAQ,IACY,CAG9C,IAAM,EAFS,EAAE,KAAK,IAAI,EAAI,CAEF,EAAI,CAEhC,GAAI,aAAwBC,EAAK,OAChC,MAAM,IAAI,EAAY,EAAa,CAGpC,OAAO,EC9BR,MAAa,EAAO,EAAE,KCQtB,IAAA,EADe"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "arkenv",
   "type": "module",
-  "version": "0.7.4",
+  "version": "0.7.5",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -39,7 +39,7 @@
     "size-limit": "11.2.0",
     "tsdown": "0.15.12",
     "typescript": "5.9.3",
-    "vitest": "4.0.4"
+    "vitest": "4.0.8"
   },
   "peerDependencies": {
     "arktype": "^2.1.22"