convex-env 2.4.0 → 2.5.0

package/README.md

@@ -141,13 +141,13 @@ I wrote out some presets for commonly used pairs of variables. Below is a comple
   - everything supported by [better-auth](https://www.better-auth.com)
 - environment
   - "development", "preview", or "production"
+- [aws](https://aws.amazon.com/sdk-for-javascript/)
 - [clerk](https://docs.convex.dev/auth/clerk)
 - [workOS](https://docs.convex.dev/auth/authkit/),
 - [betterAuth](https://labs.convex.dev/better-auth)
 - [auth0](https://docs.convex.dev/auth/auth0)
 - [resend](https://www.convex.dev/components/resend)
 - [r2](https://www.convex.dev/components/cloudflare-r2)
-- [aws](https://aws.amazon.com/sdk-for-javascript/)
 - [stripe](https://www.convex.dev/components/stripe)
 - [autumn](https://www.convex.dev/components/autumn)
 - [dodo](https://www.convex.dev/components/dodopayments)

package/dist/index.d.mts

@@ -44,11 +44,11 @@ type Prettify<T> = { [K in keyof T]: T[K] } & {};
  * import { betterAuth, oAuth, r2 } from "convex-env/presets";
  *
  * const env = createEnv({
- *   ...betterAuth,
- *   ...oAuth.google,
- *   ...oAuth.apple,
- *   ...r2,
  *   schema: {
+ *     ...oAuth.apple,
+ *     ...oAuth.google,
+ *     ...betterAuth,
+ *     ...r2,
  *     OPENAI_API_KEY: v.string(),
  *     FREE_REQUESTS_PER_USER: v.number(),
  *     DEBUG_MODE: v.optional(v.boolean()),

package/dist/index.mjs

@@ -22,6 +22,16 @@ const validateAndTransformBoolean = (value) => {
 	throw new Error("Value is not a valid boolean");
 };
 
+//#endregion
+//#region src/utils.ts
+function formatEnvErrors(issues) {
+	return [
+		"❌ Invalid environment variables:",
+		"",
+		...issues.map(({ variable, reason }) => `  ${variable}: ${reason}`)
+	].join("\n");
+}
+
 //#endregion
 //#region src/env.ts
 /**
@@ -53,11 +63,11 @@ const validateAndTransformBoolean = (value) => {
 * import { betterAuth, oAuth, r2 } from "convex-env/presets";
 *
 * const env = createEnv({
-*   ...betterAuth,
-*   ...oAuth.google,
-*   ...oAuth.apple,
-*   ...r2,
 *   schema: {
+*     ...oAuth.apple,
+*     ...oAuth.google,
+*     ...betterAuth,
+*     ...r2,
 *     OPENAI_API_KEY: v.string(),
 *     FREE_REQUESTS_PER_USER: v.number(),
 *     DEBUG_MODE: v.optional(v.boolean()),
@@ -96,26 +106,47 @@ const createEnv = (args) => {
 		options = args.options;
 	} else schema = args;
 	const values = inputValues ?? process.env;
-	return Object.keys(schema).map((key) => {
-		try {
-			if (key === "CONVEX_SITE_URL" || key === "CONVEX_CLOUD_URL") throw new Error("Cannot override CONVEX_SITE_URL or CONVEX_CLOUD_URL");
-			const validator = schema[key];
-			const envValue = values[key];
-			if (validator.isOptional === "required" && envValue === void 0 && options?.skipValidation !== true) throw new Error("Variable is required but not found in env");
-			const transformedValue = transformed(envValue, validator);
-			if (validate(validator, transformedValue) === false && options?.skipValidation !== true) throw new Error(`Variable failed to validated as type: ${validator.kind}`);
-			return [key, transformedValue];
-		} catch (error) {
-			const errorMessage = error instanceof Error ? error.message : String(error);
-			throw new Error(`Error creating environment variable ${key}: ${errorMessage}`);
+	const issues = [];
+	const entries = [];
+	for (const key of Object.keys(schema)) try {
+		if (key === "CONVEX_SITE_URL" || key === "CONVEX_CLOUD_URL") {
+			issues.push({
+				variable: key,
+				reason: "Cannot override CONVEX_SITE_URL or CONVEX_CLOUD_URL"
+			});
+			continue;
+		}
+		const validator = schema[key];
+		const envValue = values[key];
+		if (validator.isOptional === "required" && envValue === void 0 && options?.skipValidation !== true) {
+			issues.push({
+				variable: key,
+				reason: "Variable is required but not found in env"
+			});
+			continue;
+		}
+		const transformedValue = transformed(envValue, validator);
+		if (validate(validator, transformedValue) === false && options?.skipValidation !== true) {
+			issues.push({
+				variable: key,
+				reason: `Variable failed to validate as type: ${validator.kind}`
+			});
+			continue;
 		}
-	}).reduce((acc, [key, value]) => {
-		acc[key] = value;
-		return acc;
-	}, {
+		entries.push([key, transformedValue]);
+	} catch (error) {
+		const errorMessage = error instanceof Error ? error.message : String(error);
+		issues.push({
+			variable: key,
+			reason: errorMessage
+		});
+	}
+	if (issues.length > 0) throw new Error(formatEnvErrors(issues));
+	return {
 		CONVEX_SITE_URL: process.env.CONVEX_SITE_URL,
-		CONVEX_CLOUD_URL: process.env.CONVEX_CLOUD_URL
-	});
+		CONVEX_CLOUD_URL: process.env.CONVEX_CLOUD_URL,
+		...Object.fromEntries(entries)
+	};
 };
 /**
 *
@@ -153,17 +184,32 @@ const verifyEnv = (args) => {
 		inputValues = args.values;
 	} else schema = args;
 	const values = inputValues ?? process.env;
-	Object.keys(schema).map((key) => {
-		try {
-			const validator = schema[key];
-			const envValue = values[key];
-			if (validator.isOptional === "required" && envValue === void 0) throw new Error("Variable is required but not found in env");
-			if (validate(validator, transformed(envValue, validator)) === false) throw new Error(`Variable failed validation`);
-		} catch (error) {
-			const errorMessage = error instanceof Error ? error.message : String(error);
-			throw new Error(`Error verifying environment variable ${key}: ${errorMessage}`);
+	const issues = [];
+	for (const key of Object.keys(schema)) try {
+		const validator = schema[key];
+		const envValue = values[key];
+		if (validator.isOptional === "required" && envValue === void 0) {
+			issues.push({
+				variable: key,
+				reason: "Variable is required but not found in env"
+			});
+			continue;
+		}
+		if (validate(validator, transformed(envValue, validator)) === false) {
+			issues.push({
+				variable: key,
+				reason: `Variable failed to validate as type: ${validator.kind}`
+			});
+			continue;
 		}
-	});
+	} catch (error) {
+		const errorMessage = error instanceof Error ? error.message : String(error);
+		issues.push({
+			variable: key,
+			reason: errorMessage
+		});
+	}
+	if (issues.length > 0) throw new Error(formatEnvErrors(issues));
 };
 
 //#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "convex-env",
   "type": "module",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "license": "MIT",
   "description": "Type-safe access to environment variables in Convex",
   "exports": {