convex-env 2.0.0 → 2.2.0

package/README.md

@@ -14,8 +14,9 @@ Validators currently supported:
 - v.string()
 - v.number()
 - v.boolean()
+- v.union() + v.literal() (strings only)
 
-You can use `v.optional()` on _any_ supported validator, see [example](#usage) below
+You can use `v.optional()` on _any_ supported validator, see [examples](#usage) below
 
 <span style="color: red;"><strong>IMPORTANT</strong></span>: The <code>env</code> object from <code>createEnv</code> should only be used in the Convex runtime, the values on it will not be accessible client-side.
 
@@ -50,6 +51,7 @@ import { createEnv } from "convex-env";
 import { v } from "convex/values";
 
 export const env = createEnv({
+  ENVIRONMENT: v.union(v.literal("development"), v.literal("production")),
   CONVEX_SITE_URL: v.string(),
   BETTER_AUTH_SECRET: v.string(),
   GOOGLE_CLIENT_ID: v.string(),
@@ -93,6 +95,7 @@ export const env = createEnv({
     MAX_REQUESTS_PER_USER: v.number(),
     DEBUG_MODE: v.optional(v.boolean()),
   },
+  // optional, defaults to process.env
   values: {
     CONVEX_SITE_URL: process.env.CONVEX_SITE_URL,
     MAX_REQUESTS_PER_USER: process.env.MAX_REQUESTS_PER_USER,
@@ -117,12 +120,6 @@ export const schema = {
 
 export const env = createEnv({
   schema,
-  // optional, defaults to process.env
-  values: {
-    CONVEX_SITE_URL: process.env.CONVEX_SITE_URL,
-    MAX_REQUESTS_PER_USER: process.env.MAX_REQUESTS_PER_USER,
-    DEBUG_MODE: process.env.DEBUG_MODE,
-  },
   options: {
     skipValidation: true,
   },

package/dist/index.d.mts

@@ -1,7 +1,10 @@
-import { Infer, VBoolean, VFloat64, VOptional, VString } from "convex/values";
+import { Infer, VBoolean, VFloat64, VLiteral, VOptional, VString, VUnion } from "convex/values";
 
 //#region src/types.d.ts
-type AllowedPrimitiveValidators = VString | VFloat64 | VBoolean;
+type AllowedBaseValidators = VString | VFloat64 | VBoolean;
+type AllowedLiteralValidators = VLiteral<string>;
+type AllowedUnionValidators = VUnion<any, [AllowedLiteralValidators, AllowedLiteralValidators, ...AllowedLiteralValidators[]]>;
+type AllowedPrimitiveValidators = AllowedBaseValidators | AllowedLiteralValidators | AllowedUnionValidators;
 type AllowedOptionalValidators = VOptional<AllowedPrimitiveValidators>;
 type AllowedValidators = AllowedPrimitiveValidators | AllowedOptionalValidators;
 type InferredOuput<V extends AllowedValidators> = Infer<V>;
@@ -25,6 +28,7 @@ type CreateEnvOptions = {
  *   FOO: v.string(),
  *   BAR: v.number(),
  *   BAZ: v.boolean(),
+ *   FIZZ: v.union(v.literal("development"), v.literal("production")),
  * });
  *
  * @example
@@ -33,11 +37,13 @@ type CreateEnvOptions = {
  *     FOO: v.string(),
  *     BAR: v.number(),
  *     BAZ: v.optional(v.boolean()),
+ *     FIZZ: v.union(v.literal("development"), v.literal("production")),
  *   },
  *   values: {
  *     FOO: process.env.FOO,
  *     BAR: "42",
  *     BAZ: "true",
+ *     FIZZ: "development",
  *   },
  *   options: {
  *     skipValidation: true,
@@ -49,7 +55,10 @@ declare const createEnv: <Schema extends Record<string, AllowedValidators>>(args
   schema: Schema;
   values?: Values<Schema>;
   options?: CreateEnvOptions;
-}) => { [K in keyof Schema]: InferredOuput<Schema[K]> };
+}) => { [K in keyof Schema]: InferredOuput<Schema[K]> } & {
+  CONVEX_SITE_URL: string;
+  CONVEX_CLOUD_URL: string;
+};
 /**
  *
  * @description You may want to verify the existence and type of the environment variables separately from the creation of the env object. If so, use this function in convex.config.ts, and use the skipValidation option when calling createEnv.

package/dist/index.mjs

@@ -1,13 +1,14 @@
 import { validate } from "convex-helpers/validators";
-import { v } from "convex/values";
 
 //#region src/transform.ts
 const transformed = (value, validator) => {
 	if (value === void 0) return void 0;
 	if (value.trim() === "") throw new Error("Value is empty");
-	if (validator.kind === v.string().kind) return value;
-	if (validator.kind === v.number().kind) return validateAndTransformNumber(value);
-	if (validator.kind === v.boolean().kind) return validateAndTransformBoolean(value);
+	if (validator.kind === "union") return value;
+	if (validator.kind === "literal") return value;
+	if (validator.kind === "string") return value;
+	if (validator.kind === "float64") return validateAndTransformNumber(value);
+	if (validator.kind === "boolean") return validateAndTransformBoolean(value);
 	throw new Error("Validator is not supported");
 };
 const validateAndTransformNumber = (value) => {
@@ -37,6 +38,7 @@ const validateAndTransformBoolean = (value) => {
 *   FOO: v.string(),
 *   BAR: v.number(),
 *   BAZ: v.boolean(),
+*   FIZZ: v.union(v.literal("development"), v.literal("production")),
 * });
 *
 * @example
@@ -45,11 +47,13 @@ const validateAndTransformBoolean = (value) => {
 *     FOO: v.string(),
 *     BAR: v.number(),
 *     BAZ: v.optional(v.boolean()),
+*     FIZZ: v.union(v.literal("development"), v.literal("production")),
 *   },
 *   values: {
 *     FOO: process.env.FOO,
 *     BAR: "42",
 *     BAZ: "true",
+*     FIZZ: "development",
 *   },
 *   options: {
 *     skipValidation: true,
@@ -72,6 +76,7 @@ const createEnv = (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");
@@ -85,7 +90,10 @@ const createEnv = (args) => {
 	}).reduce((acc, [key, value]) => {
 		acc[key] = value;
 		return acc;
-	}, {});
+	}, {
+		CONVEX_SITE_URL: process.env.CONVEX_SITE_URL,
+		CONVEX_CLOUD_URL: process.env.CONVEX_CLOUD_URL
+	});
 };
 /**
 *

package/package.json

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