arkenv 0.7.3 → 0.7.4

package/README.md

@@ -4,7 +4,7 @@
   </a>
   <br />
   <a href="https://github.com/yamcodes/arkenv/actions/workflows/tests.yml?query=branch%3Amain"><img alt="Tests Status" src="https://github.com/yamcodes/arkenv/actions/workflows/tests.yml/badge.svg?event=push&branch=main"></a>
-  <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/arkenv">
+  <a href="https://bundlephobia.com/package/arkenv"><img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/arkenv"></a>
   <a href="https://www.typescriptlang.org/"><img alt="TypeScript" src="https://img.shields.io/badge/TypeScript-3178C6?style=flat&logo=typescript&logoColor=white"></a>
   <a href="https://arktype.io/"><img alt="Powered By ArkType" src="https://custom-icon-badges.demolab.com/badge/ArkType-0d1526?logo=arktype2&logoColor=e9eef9"></a>
   <a href="https://nodejs.org/en"><img alt="Node.js" src="https://img.shields.io/badge/Node.js-339933?style=flat&logo=node.js&logoColor=white"></a>
@@ -110,7 +110,7 @@ bun add arkenv arktype
 ## Requirements
 
 - TypeScript >= 5.1 and [anything else required by ArkType](https://arktype.io/docs/intro/setup#installation)
--  Tested on [Node.js 22 LTS](https://github.com/yamcodes/arkenv/tree/main/examples/basic), [Bun 1.2](https://github.com/yamcodes/arkenv/tree/main/examples/with-bun), and [Vite from **2.9.18** to **7.x**](https://github.com/yamcodes/arkenv/tree/main/examples/with-vite-react-ts). Older versions may work but are not officially supported
+-  Tested on [Node.js **LTS** and **Current**](https://github.com/yamcodes/arkenv/tree/main/examples/basic), [Bun 1.2](https://github.com/yamcodes/arkenv/tree/main/examples/with-bun), and [Vite from **2.9.18** to **7.x**](https://github.com/yamcodes/arkenv/tree/main/examples/with-vite-react-ts). Older versions may work but are not officially supported
 
 ## Plugins
 

package/dist/index.cjs

@@ -1,137 +1,4 @@
-Object.defineProperty(exports, '__esModule', { value: true });
-//#region rolldown:runtime
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __copyProps = (to, from, except, desc) => {
-	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
-		key = keys[i];
-		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
-			get: ((k) => from[k]).bind(null, key),
-			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
-		});
-	}
-	return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
-	value: mod,
-	enumerable: true
-}) : target, mod));
-
-//#endregion
-let arktype = require("arktype");
-arktype = __toESM(arktype);
-let node_util = require("node:util");
-node_util = __toESM(node_util);
-
-//#region src/utils.ts
-/**
-* Indent a string by a given amount
-* @param str - The string to indent
-* @param amt - The amount to indent by, defaults to 2
-* @param options - {@link IndentOptions}
-* @returns The indented string
-*/
-const indent = (str, amt = 2, { dontDetectNewlines = false } = {}) => {
-	if (!dontDetectNewlines) return str.split("\n").map((line) => `${" ".repeat(amt)}${line}`).join("\n");
-	return `${" ".repeat(amt)}${str}`;
-};
-
-//#endregion
-//#region src/errors.ts
-/**
-* Format the errors returned by ArkType to be more readable
-* @param errors - The errors returned by ArkType
-* @returns A string of the formatted errors
-*/
-const formatErrors = (errors) => Object.entries(errors.byPath).map(([path, error]) => {
-	const messageWithoutPath = error.message.startsWith(path) ? error.message.slice(path.length) : error.message;
-	const valueMatch = messageWithoutPath.match(/\(was "([^"]+)"\)/);
-	const formattedMessage = valueMatch ? messageWithoutPath.replace(`(was "${valueMatch[1]}")`, `(was ${(0, node_util.styleText)("cyan", `"${valueMatch[1]}"`)})`) : messageWithoutPath;
-	return `${(0, node_util.styleText)("yellow", path)}${formattedMessage}`;
-}).join("\n");
-var ArkEnvError = class extends Error {
-	constructor(errors, message = "Errors found while validating environment variables") {
-		super(`${(0, node_util.styleText)("red", message)}\n${indent(formatErrors(errors))}\n`);
-		this.name = "ArkEnvError";
-	}
-};
-
-//#endregion
-//#region src/types.ts
-/**
-* A `string` that can be parsed into a number between 0 and 65535
-*/
-const port = (0, arktype.type)("string", "=>", (data, ctx) => {
-	const asNumber = Number.parseInt(data, 10);
-	if (!Number.isInteger(asNumber) || !(0 <= asNumber && asNumber <= 65535)) ctx.mustBe("an integer between 0 and 65535");
-	return asNumber;
-});
-/**
-* An IP address or `"localhost"`
-*/
-const host = (0, arktype.type)("string.ip | 'localhost'");
-/**
-* A boolean that accepts string values and converts them to boolean
-* Accepts "true" or "false" strings and converts them to actual boolean values
-*/
-const boolean = (0, arktype.type)("'true' | 'false' | true | false", "=>", (str) => str === "true" || str === true);
-
-//#endregion
-//#region src/scope.ts
-/**
-* The root scope for the ArkEnv library, containing extensions to the ArkType scopes with ArkEnv-specific types like `string.host` and `number.port`.
-*/
-const $ = (0, arktype.scope)({
-	string: arktype.type.module({
-		...arktype.type.keywords.string,
-		host
-	}),
-	number: arktype.type.module({
-		...arktype.type.keywords.number,
-		port
-	}),
-	boolean
-});
-
-//#endregion
-//#region src/create-env.ts
-/**
-* TODO: If possible, find a better type than "const T extends Record<string, unknown>",
-* and be as close as possible to the type accepted by ArkType's `type`.
-*/
-/**
-* Create an environment variables object from a schema and an environment
-* @param def - The environment variable schema
-* @param env - The environment variables to validate, defaults to `process.env`
-* @returns The validated environment variable schema
-* @throws An {@link ArkEnvError | error} if the environment variables are invalid.
-*/
-function createEnv(def, env = process.env) {
-	const validatedEnv = $.type.raw(def)(env);
-	if (validatedEnv instanceof arktype.type.errors) throw new ArkEnvError(validatedEnv);
-	return validatedEnv;
-}
-
-//#endregion
-//#region src/type.ts
-const type = $.type;
-
-//#endregion
-//#region src/index.ts
-/**
-* `arkenv`'s main export, an alias for {@link createEnv}
-*
-* {@link https://arkenv.js.org | ArkEnv} is a typesafe environment variables parser powered by {@link https://arktype.io | ArkType}, TypeScript's 1:1 validator.
-*/
-const arkenv = createEnv;
-var src_default = arkenv;
-
-//#endregion
-exports.ArkEnvError = ArkEnvError;
-exports.createEnv = createEnv;
-exports.default = src_default;
-exports.type = type;
+Object.defineProperty(exports,`__esModule`,{value:!0});var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));let c=require(`arktype`);c=s(c);const l={red:`\x1B[31m`,yellow:`\x1B[33m`,cyan:`\x1B[36m`,reset:`\x1B[0m`},u=()=>typeof process<`u`&&process.versions!=null&&process.versions.node!=null,d=()=>!!(!u()||process.env.NO_COLOR!==void 0||process.env.CI!==void 0||process.stdout&&!process.stdout.isTTY),f=(e,t)=>u()&&!d()?`${l[e]}${t}${l.reset}`:t,p=(e,t=2,{dontDetectNewlines:n=!1}={})=>n?`${` `.repeat(t)}${e}`:e.split(`
+`).map(e=>`${` `.repeat(t)}${e}`).join(`
+`),m=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 ${f(`cyan`,`"${r[1]}"`)})`):n;return`${f(`yellow`,e)}${i}`}).join(`
+`);var h=class extends Error{constructor(e,t=`Errors found while validating environment variables`){super(`${f(`red`,t)}\n${p(m(e))}\n`),this.name=`ArkEnvError`}};const g=(0,c.type)(`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}),_=(0,c.type)(`string.ip | 'localhost'`),v=(0,c.type)(`'true' | 'false' | true | false`,`=>`,e=>e===`true`||e===!0),y=(0,c.scope)({string:c.type.module({...c.type.keywords.string,host:_}),number:c.type.module({...c.type.keywords.number,port:g}),boolean:v});function b(e,t=process.env){let n=y.type.raw(e)(t);if(n instanceof c.type.errors)throw new h(n);return n}const x=y.type,S=b;var C=S;exports.ArkEnvError=h,exports.createEnv=b,exports.default=C,exports.type=x;

package/dist/index.js

@@ -1,108 +1,4 @@
-import { scope, type as type$1 } from "arktype";
-import { styleText } from "node:util";
-
-//#region src/utils.ts
-/**
-* Indent a string by a given amount
-* @param str - The string to indent
-* @param amt - The amount to indent by, defaults to 2
-* @param options - {@link IndentOptions}
-* @returns The indented string
-*/
-const indent = (str, amt = 2, { dontDetectNewlines = false } = {}) => {
-	if (!dontDetectNewlines) return str.split("\n").map((line) => `${" ".repeat(amt)}${line}`).join("\n");
-	return `${" ".repeat(amt)}${str}`;
-};
-
-//#endregion
-//#region src/errors.ts
-/**
-* Format the errors returned by ArkType to be more readable
-* @param errors - The errors returned by ArkType
-* @returns A string of the formatted errors
-*/
-const formatErrors = (errors) => Object.entries(errors.byPath).map(([path, error]) => {
-	const messageWithoutPath = error.message.startsWith(path) ? error.message.slice(path.length) : error.message;
-	const valueMatch = messageWithoutPath.match(/\(was "([^"]+)"\)/);
-	const formattedMessage = valueMatch ? messageWithoutPath.replace(`(was "${valueMatch[1]}")`, `(was ${styleText("cyan", `"${valueMatch[1]}"`)})`) : messageWithoutPath;
-	return `${styleText("yellow", path)}${formattedMessage}`;
-}).join("\n");
-var ArkEnvError = class extends Error {
-	constructor(errors, message = "Errors found while validating environment variables") {
-		super(`${styleText("red", message)}\n${indent(formatErrors(errors))}\n`);
-		this.name = "ArkEnvError";
-	}
-};
-
-//#endregion
-//#region src/types.ts
-/**
-* A `string` that can be parsed into a number between 0 and 65535
-*/
-const port = type$1("string", "=>", (data, ctx) => {
-	const asNumber = Number.parseInt(data, 10);
-	if (!Number.isInteger(asNumber) || !(0 <= asNumber && asNumber <= 65535)) ctx.mustBe("an integer between 0 and 65535");
-	return asNumber;
-});
-/**
-* An IP address or `"localhost"`
-*/
-const host = type$1("string.ip | 'localhost'");
-/**
-* A boolean that accepts string values and converts them to boolean
-* Accepts "true" or "false" strings and converts them to actual boolean values
-*/
-const boolean = type$1("'true' | 'false' | true | false", "=>", (str) => str === "true" || str === true);
-
-//#endregion
-//#region src/scope.ts
-/**
-* The root scope for the ArkEnv library, containing extensions to the ArkType scopes with ArkEnv-specific types like `string.host` and `number.port`.
-*/
-const $ = scope({
-	string: type$1.module({
-		...type$1.keywords.string,
-		host
-	}),
-	number: type$1.module({
-		...type$1.keywords.number,
-		port
-	}),
-	boolean
-});
-
-//#endregion
-//#region src/create-env.ts
-/**
-* TODO: If possible, find a better type than "const T extends Record<string, unknown>",
-* and be as close as possible to the type accepted by ArkType's `type`.
-*/
-/**
-* Create an environment variables object from a schema and an environment
-* @param def - The environment variable schema
-* @param env - The environment variables to validate, defaults to `process.env`
-* @returns The validated environment variable schema
-* @throws An {@link ArkEnvError | error} if the environment variables are invalid.
-*/
-function createEnv(def, env = process.env) {
-	const validatedEnv = $.type.raw(def)(env);
-	if (validatedEnv instanceof type$1.errors) throw new ArkEnvError(validatedEnv);
-	return validatedEnv;
-}
-
-//#endregion
-//#region src/type.ts
-const type = $.type;
-
-//#endregion
-//#region src/index.ts
-/**
-* `arkenv`'s main export, an alias for {@link createEnv}
-*
-* {@link https://arkenv.js.org | ArkEnv} is a typesafe environment variables parser powered by {@link https://arktype.io | ArkType}, TypeScript's 1:1 validator.
-*/
-const arkenv = createEnv;
-var src_default = arkenv;
-
-//#endregion
-export { ArkEnvError, createEnv, src_default as default, type };
+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};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "arkenv",
   "type": "module",
-  "version": "0.7.3",
+  "version": "0.7.4",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -31,17 +31,29 @@
   "bugs": "https://github.com/yamcodes/arkenv/labels/arkenv",
   "author": "Yam Borodetsky <yam@yam.codes>",
   "devDependencies": {
-    "@ark/schema": "^0.49.0",
-    "@types/node": "24.6.2",
-    "tsdown": "^0.15.6",
-    "typescript": "^5.9.3",
-    "vitest": "^3.2.4"
+    "@ark/schema": "0.53.0",
+    "@size-limit/esbuild-why": "11.2.0",
+    "@size-limit/preset-small-lib": "11.2.0",
+    "@types/node": "24.10.0",
+    "arktype": "2.1.25",
+    "size-limit": "11.2.0",
+    "tsdown": "0.15.12",
+    "typescript": "5.9.3",
+    "vitest": "4.0.4"
   },
   "peerDependencies": {
     "arktype": "^2.1.22"
   },
+  "size-limit": [
+    {
+      "path": "dist/index.js",
+      "limit": "2 kB",
+      "import": "*"
+    }
+  ],
   "scripts": {
     "build": "tsdown",
+    "size": "size-limit",
     "test:once": "pnpm test",
     "typecheck": "tsc --noEmit",
     "clean": "rimraf dist node_modules",