fix(nextjs): resolve bundle size limit violation and implicitly share NODE_ENV in flat layout

Author: yamcodes

.changeset/flat-layout-mode.md

@@ -14,12 +14,10 @@ export const env = arkenv({
 	DATABASE_URL: "string",
 	NEXT_PUBLIC_API_URL: "string",
 	NODE_ENV: "'development' | 'production' | 'test' = 'development'",
-}, {
-	shared: ["NODE_ENV"]
 });
 ```
 
-- Filter client-safe keys starting with `NEXT_PUBLIC_` and shared keys specified in `options.shared`.
+- Filter client-safe keys starting with `NEXT_PUBLIC_` and shared keys specified in `options.shared`. `NODE_ENV` is implicitly shared.
 - Exclude server-only keys from autocomplete on the client using TypeScript `Pick`.
-- Wrap the client-side returned variables in a Proxy that throws an error at runtime when a server-only variable is accessed on the client.
+- Wrap the returned variables in a Proxy that throws an error at runtime when a server-only variable is accessed on the client.
 - Update CLI scaffolding to generate the Flat layout by default.

packages/cli/src/features/scaffold/env-template.test.ts

@@ -50,7 +50,7 @@ describe("env-template", () => {
 			expect(template).toContain("DATABASE_URL:");
 			expect(template).toContain("NEXT_PUBLIC_API_URL:");
 			expect(template).toContain("NODE_ENV:");
-			expect(template).toContain('shared: ["NODE_ENV"]');
+			expect(template).not.toContain("shared:");
 			expect(template).not.toContain("runtimeEnv:");
 		});
 

packages/cli/src/features/scaffold/templates/nextjs-template.ts

@@ -97,11 +97,9 @@ export function buildNextjsTemplate(
 		if (envKeys && envKeys.length > 0) {
 			for (const key of envKeys) {
 				if (key === "NODE_ENV") {
-					sharedKeyNames.push(key);
+					// NODE_ENV is implicitly shared, no need to list it in options.shared
 				}
 			}
-		} else {
-			sharedKeyNames.push("NODE_ENV");
 		}
 
 		const optionParts: string[] = [];

packages/nextjs/src/config.test.ts

@@ -211,12 +211,11 @@ describe("codegen process", () => {
 
 		// Check warning header
 		expect(generatedContent).not.toContain("// @ts-nocheck");
-		expect(generatedContent).toContain("This file is auto-generated by ArkEnv");
+		expect(generatedContent).toContain("Generated by ArkEnv. DO NOT EDIT DIRECTLY.");
 
 		// Check exports and wrapper types
 		expect(generatedContent).toContain("export function createEnv<");
-		expect(generatedContent).toContain("const arkenv = createEnv;");
-		expect(generatedContent).toContain("export default arkenv;");
+		expect(generatedContent).toContain("export default createEnv;");
 
 		// Check that relative path import was resolved correctly (relative from __temp_tests__/env.gen.ts to __temp_tests__/env.ts is ./env)
 		// Wait, path.relative(__temp_tests__, __temp_tests__/env.ts) is "env.ts", which normalizes to "./env"
@@ -382,8 +381,7 @@ describe("withArkEnv wrapper", () => {
 
 		const generatedContent = fs.readFileSync(genPath, "utf-8");
 		expect(generatedContent).toContain("export function createEnv<");
-		expect(generatedContent).toContain("const arkenv = createEnv;");
-		expect(generatedContent).toContain("export default arkenv;");
+		expect(generatedContent).toContain("export default createEnv;");
 		expect(generatedContent).toContain(
 			'NEXT_PUBLIC_API_URL: typeof window !== "undefined" ? (globalThis as any).__arkenv_env__?.NEXT_PUBLIC_API_URL ?? process.env.NEXT_PUBLIC_API_URL : process.env.NEXT_PUBLIC_API_URL,',
 		);

packages/nextjs/src/config.ts

@@ -375,21 +375,15 @@ export function extractKeys(content: string): {
 		if (args.optionsArg) {
 			const sharedMatch = args.optionsArg.match(/shared\s*:\s*\[([\s\S]*?)\]/);
 			if (sharedMatch) {
-				const arrayContent = sharedMatch[1];
-				const stringRegex =
-					/(?:"([^"\\]*(?:\\.[^"\\]*)*)"|'([^'\\]*(?:\\.[^'\\]*)*)'|`([^`\\]*(?:\\.[^`\\]*)*)`)/g;
-				const matches = arrayContent.matchAll(stringRegex);
+				const matches = sharedMatch[1].matchAll(/['"`](.*?)['"`]/g);
 				for (const match of matches) {
-					const val = match[1] || match[2] || match[3];
-					if (val) {
-						optionSharedKeys.push(val);
-					}
+					optionSharedKeys.push(match[1]);
 				}
 			}
 		}
 
 		for (const key of topKeys) {
-			if (optionSharedKeys.includes(key)) {
+			if (optionSharedKeys.includes(key) || key === "NODE_ENV") {
 				sharedKeys.push(key);
 			} else if (key.startsWith("NEXT_PUBLIC_")) {
 				clientKeys.push(key);
@@ -401,35 +395,45 @@ export function extractKeys(content: string): {
 }
 
 /**
- * Generate the TypeScript factory code for the tailored createEnv helper.
- *
- * @param clientKeys The client environment variable keys
- * @param sharedKeys The shared environment variable keys
- * @returns The generated TypeScript source code string
+ * Generate the triple-tab indented runtime environment variables mapping.
  */
-function generateFactoryCode(
+function generateRuntimeEnvLines(
 	clientKeys: string[],
 	sharedKeys: string[],
 ): string {
 	const allKeys = Array.from(new Set([...clientKeys, ...sharedKeys]));
-	const runtimeEnvLines = allKeys
+	return allKeys
 		.map(
 			(key) =>
 				`\t\t\t${key}: typeof window !== "undefined" ? (globalThis as any).__arkenv_env__?.${key} ?? process.env.${key} : process.env.${key},`,
 		)
 		.join("\n");
+}
 
-	return `/* eslint-disable */
-// prettier-ignore
+const GENERATED_HEADER = `/* eslint-disable */
 // biome-ignore format: auto-generated
+// Generated by ArkEnv. DO NOT EDIT DIRECTLY.
+`;
+
+const GENERATED_FOOTER = `
+export default createEnv;
+`;
+
 /**
- * @file env.gen.ts
- * @note This file is auto-generated by ArkEnv. DO NOT EDIT DIRECTLY.
- * @see https://arkenv.js.org
+ * Generate the TypeScript factory code for the tailored createEnv helper.
+ *
+ * @param clientKeys The client environment variable keys
+ * @param sharedKeys The shared environment variable keys
+ * @returns The generated TypeScript source code string
  */
+function generateFactoryCode(
+	clientKeys: string[],
+	sharedKeys: string[],
+): string {
+	const runtimeEnvLines = generateRuntimeEnvLines(clientKeys, sharedKeys);
 
+	return `${GENERATED_HEADER}
 import { createEnv as coreCreateEnv } from "@arkenv/nextjs";
-import type { Infer } from "@arkenv/nextjs";
 
 export { type } from "@arkenv/nextjs";
 
@@ -443,18 +447,15 @@ export function createEnv<
 		[K in keyof TClient]: K extends \`NEXT_PUBLIC_\${string}\` ? unknown : never;
 	};
 	shared?: TShared;
-}): Readonly<Infer<TServer & TClient & TShared>> {
+}) {
 	return coreCreateEnv({
 		...options,
 		runtimeEnv: {
 ${runtimeEnvLines}
 		},
 	} as any) as any;
 }
-
-const arkenv = createEnv;
-export default arkenv;
-`;
+${GENERATED_FOOTER}`;
 }
 
 /**
@@ -464,25 +465,10 @@ function generateFlatFactoryCode(
 	clientKeys: string[],
 	sharedKeys: string[],
 ): string {
-	const allKeys = Array.from(new Set([...clientKeys, ...sharedKeys]));
-	const runtimeEnvLines = allKeys
-		.map(
-			(key) =>
-				`\t\t\t${key}: typeof window !== "undefined" ? (globalThis as any).__arkenv_env__?.${key} ?? process.env.${key} : process.env.${key},`,
-		)
-		.join("\n");
-
-	return `/* eslint-disable */
-// prettier-ignore
-// biome-ignore format: auto-generated
-/**
- * @file env.gen.ts
- * @note This file is auto-generated by ArkEnv. DO NOT EDIT DIRECTLY.
- * @see https://arkenv.js.org
- */
+	const runtimeEnvLines = generateRuntimeEnvLines(clientKeys, sharedKeys);
 
+	return `${GENERATED_HEADER}
 import { createEnv as coreCreateEnv } from "@arkenv/nextjs";
-import type { Infer } from "@arkenv/nextjs";
 
 export { type } from "@arkenv/nextjs";
 
@@ -495,36 +481,15 @@ export function createEnv<
 		shared?: readonly (keyof TSchema)[];
 		extends?: [...TExtends];
 	},
-): Readonly<Infer<TSchema>> {
-	const parsedEnv = coreCreateEnv(schema as any, {
+) {
+	return coreCreateEnv(schema as any, {
 		...options,
 		runtimeEnv: {
 ${runtimeEnvLines}
 		},
 	} as any) as any;
-
-	return new Proxy(parsedEnv, {
-		get(target, prop, receiver) {
-			if (typeof prop === "string") {
-				const isSchemaKey = prop in schema;
-				const isServer = typeof window === "undefined";
-				const isClientVar = prop.startsWith("NEXT_PUBLIC_");
-				const isSharedVar = options?.shared?.includes(prop);
-
-				if (isSchemaKey && !isServer && !isClientVar && !isSharedVar) {
-					throw new Error(
-						\`Accessing server-side environment variable '\${prop}' on the client is not allowed.\`
-					);
-				}
-			}
-			return Reflect.get(target, prop, receiver);
-		}
-	}) as any;
 }
-
-const arkenv = createEnv;
-export default arkenv;
-`;
+${GENERATED_FOOTER}`;
 }
 
 /**
@@ -541,23 +506,9 @@ function generateClientFactoryCode(
 	clientKeys: string[],
 	sharedKeys: string[],
 ): string {
-	const allKeys = Array.from(new Set([...clientKeys, ...sharedKeys]));
-	const runtimeEnvLines = allKeys
-		.map(
-			(key) =>
-				`\t\t\t${key}: typeof window !== "undefined" ? (globalThis as any).__arkenv_env__?.${key} ?? process.env.${key} : process.env.${key},`,
-		)
-		.join("\n");
-
-	return `/* eslint-disable */
-// prettier-ignore
-// biome-ignore format: auto-generated
-/**
- * @file env.gen.ts
- * @note This file is auto-generated by ArkEnv. DO NOT EDIT DIRECTLY.
- * @see https://arkenv.js.org
- */
+	const runtimeEnvLines = generateRuntimeEnvLines(clientKeys, sharedKeys);
 
+	return `${GENERATED_HEADER}
 import { createEnv as coreCreateEnv } from "@arkenv/nextjs/client";
 
 export { type } from "@arkenv/nextjs/client";
@@ -580,8 +531,5 @@ ${runtimeEnvLines}
 		},
 	} as any);
 }
-
-const arkenv = createEnv;
-export default arkenv;
-`;
+${GENERATED_FOOTER}`;
 }

packages/nextjs/src/create-env.ts

@@ -98,7 +98,7 @@ export function createEnvInternal(
 		} else {
 			const sharedKeys = options.shared || [];
 			for (const key of Object.keys(flatSchema)) {
-				if (sharedKeys.includes(key)) {
+				if (sharedKeys.includes(key) || key === "NODE_ENV") {
 					shared[key] = flatSchema[key];
 				} else if (key.startsWith("NEXT_PUBLIC_")) {
 					client[key] = flatSchema[key];

packages/nextjs/src/index.ts

@@ -24,7 +24,7 @@ export function createEnv<
 		distill.Out<at.infer<TSchema, $>>,
 		Extract<
 			keyof distill.Out<at.infer<TSchema, $>>,
-			(keyof TSchema & `NEXT_PUBLIC_${string}`) | TShared
+			(keyof TSchema & `NEXT_PUBLIC_${string}`) | TShared | (keyof TSchema & "NODE_ENV")
 		>
 	> &
 		MergeExtends<TExtends>