convex-env 2.0.0 → 2.1.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>;

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) => {

package/package.json

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