@aamini/lib 0.0.8 → 0.0.11

package/dist/env.d.mts

@@ -1,7 +1,8 @@
-import { z } from "zod";
-
 //#region src/env.d.ts
-declare function createEnv<T extends z.ZodTypeAny>(schema: T): z.infer<T>;
+type EnvSchema<T extends object> = {
+  parse(input: unknown): T;
+};
+declare function createEnv<T extends object>(schema: EnvSchema<T>): T;
 //#endregion
 export { createEnv };
 //# sourceMappingURL=env.d.mts.map

package/dist/env.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"env.d.mts","names":[],"sources":["../src/env.ts"],"mappings":";;;iBAGgB,SAAA,WAAoB,CAAA,CAAE,UAAA,CAAA,CAAY,MAAA,EAAQ,CAAA,GAAI,CAAA,CAAE,KAAA,CAAM,CAAA"}
+{"version":3,"file":"env.d.mts","names":[],"sources":["../src/env.ts"],"mappings":";KAEK,SAAA;EACJ,KAAA,CAAM,KAAA,YAAiB,CAAA;AAAA;AAAA,iBAGR,SAAA,kBAAA,CAA4B,MAAA,EAAQ,SAAA,CAAU,CAAA,IAAK,CAAA"}

package/dist/env.mjs

@@ -15,8 +15,28 @@ function createEnv(schema) {
 		override: true,
 		processEnv: fileEnvironment
 	});
-	for (const [key, value] of Object.entries(fileEnvironment)) process.env[key] ??= value;
-	return schema.parse(process.env);
+	let parsed;
+	function parseEnv() {
+		if (parsed !== void 0) return parsed;
+		const env = { ...fileEnvironment };
+		for (const [key, value] of Object.entries(process.env)) if (value !== void 0) env[key] = value;
+		parsed = schema.parse(env);
+		return parsed;
+	}
+	return new Proxy({}, {
+		get(_target, property, receiver) {
+			return Reflect.get(parseEnv(), property, receiver);
+		},
+		has(_target, property) {
+			return property in parseEnv();
+		},
+		ownKeys() {
+			return Reflect.ownKeys(parseEnv());
+		},
+		getOwnPropertyDescriptor(_target, property) {
+			return Object.getOwnPropertyDescriptor(parseEnv(), property);
+		}
+	});
 }
 //#endregion
 export { createEnv };

package/dist/env.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"env.mjs","names":[],"sources":["../src/env.ts"],"sourcesContent":["import { config } from 'dotenv'\nimport { z } from 'zod'\n\nexport function createEnv<T extends z.ZodTypeAny>(schema: T): z.infer<T> {\n\tconst raw =\n\t\tprocess.env.RAILWAY_ENVIRONMENT_NAME ??\n\t\t(process.env.NODE_ENV === 'production' ? 'production' : 'development')\n\tconst environmentName = /(?:^|-)pr-\\d+$/.test(raw) ? 'staging' : raw\n\tconst fileEnvironment: NodeJS.ProcessEnv = {}\n\n\tconfig({\n\t\tpath: [\n\t\t\t'.env',\n\t\t\t'.env.local',\n\t\t\t`.env.${environmentName}`,\n\t\t\t`.env.${environmentName}.local`,\n\t\t],\n\t\tquiet: true,\n\t\toverride: true,\n\t\tprocessEnv: fileEnvironment,\n\t})\n\n\tfor (const [key, value] of Object.entries(fileEnvironment)) {\n\t\tprocess.env[key] ??= value\n\t}\n\n\treturn schema.parse(process.env)\n}\n"],"mappings":";;AAGA,SAAgB,UAAkC,QAAuB;CACxE,MAAM,MACL,QAAQ,IAAI,6BACX,QAAQ,IAAI,aAAa,eAAe,eAAe;CACzD,MAAM,kBAAkB,iBAAiB,KAAK,IAAI,GAAG,YAAY;CACjE,MAAM,kBAAqC,EAAE;CAE7C,OAAO;EACN,MAAM;GACL;GACA;GACA,QAAQ;GACR,QAAQ,gBAAgB;GACxB;EACD,OAAO;EACP,UAAU;EACV,YAAY;EACZ,CAAC;CAEF,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,gBAAgB,EACzD,QAAQ,IAAI,SAAS;CAGtB,OAAO,OAAO,MAAM,QAAQ,IAAI"}
+{"version":3,"file":"env.mjs","names":[],"sources":["../src/env.ts"],"sourcesContent":["import { config } from 'dotenv'\n\ntype EnvSchema<T extends object> = {\n\tparse(input: unknown): T\n}\n\nexport function createEnv<T extends object>(schema: EnvSchema<T>): T {\n\tconst raw =\n\t\tprocess.env.RAILWAY_ENVIRONMENT_NAME ??\n\t\t(process.env.NODE_ENV === 'production' ? 'production' : 'development')\n\tconst environmentName = /(?:^|-)pr-\\d+$/.test(raw) ? 'staging' : raw\n\tconst fileEnvironment: NodeJS.ProcessEnv = {}\n\n\tconfig({\n\t\tpath: [\n\t\t\t'.env',\n\t\t\t'.env.local',\n\t\t\t`.env.${environmentName}`,\n\t\t\t`.env.${environmentName}.local`,\n\t\t],\n\t\tquiet: true,\n\t\toverride: true,\n\t\tprocessEnv: fileEnvironment,\n\t})\n\n\tlet parsed: T | undefined\n\n\tfunction parseEnv() {\n\t\tif (parsed !== undefined) return parsed\n\n\t\tconst env: NodeJS.ProcessEnv = { ...fileEnvironment }\n\n\t\tfor (const [key, value] of Object.entries(process.env)) {\n\t\t\tif (value !== undefined) env[key] = value\n\t\t}\n\n\t\tparsed = schema.parse(env)\n\t\treturn parsed\n\t}\n\n\treturn new Proxy({} as Record<PropertyKey, unknown>, {\n\t\tget(_target, property, receiver) {\n\t\t\treturn Reflect.get(parseEnv() as object, property, receiver)\n\t\t},\n\t\thas(_target, property) {\n\t\t\treturn property in (parseEnv() as object)\n\t\t},\n\t\townKeys() {\n\t\t\treturn Reflect.ownKeys(parseEnv() as object)\n\t\t},\n\t\tgetOwnPropertyDescriptor(_target, property) {\n\t\t\treturn Object.getOwnPropertyDescriptor(parseEnv() as object, property)\n\t\t},\n\t}) as T\n}\n"],"mappings":";;AAMA,SAAgB,UAA4B,QAAyB;CACpE,MAAM,MACL,QAAQ,IAAI,6BACX,QAAQ,IAAI,aAAa,eAAe,eAAe;CACzD,MAAM,kBAAkB,iBAAiB,KAAK,IAAI,GAAG,YAAY;CACjE,MAAM,kBAAqC,EAAE;CAE7C,OAAO;EACN,MAAM;GACL;GACA;GACA,QAAQ;GACR,QAAQ,gBAAgB;GACxB;EACD,OAAO;EACP,UAAU;EACV,YAAY;EACZ,CAAC;CAEF,IAAI;CAEJ,SAAS,WAAW;EACnB,IAAI,WAAW,KAAA,GAAW,OAAO;EAEjC,MAAM,MAAyB,EAAE,GAAG,iBAAiB;EAErD,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,QAAQ,IAAI,EACrD,IAAI,UAAU,KAAA,GAAW,IAAI,OAAO;EAGrC,SAAS,OAAO,MAAM,IAAI;EAC1B,OAAO;;CAGR,OAAO,IAAI,MAAM,EAAE,EAAkC;EACpD,IAAI,SAAS,UAAU,UAAU;GAChC,OAAO,QAAQ,IAAI,UAAU,EAAY,UAAU,SAAS;;EAE7D,IAAI,SAAS,UAAU;GACtB,OAAO,YAAa,UAAU;;EAE/B,UAAU;GACT,OAAO,QAAQ,QAAQ,UAAU,CAAW;;EAE7C,yBAAyB,SAAS,UAAU;GAC3C,OAAO,OAAO,yBAAyB,UAAU,EAAY,SAAS;;EAEvE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aamini/lib",
-	"version": "0.0.8",
+	"version": "0.0.11",
 	"private": false,
 	"type": "module",
 	"repository": {
@@ -30,6 +30,7 @@
 	},
 	"scripts": {
 		"build": "vp pack",
+		"bump": "npm version patch --no-git-tag-version",
 		"pack": "vp pack",
 		"prepare": "vp pack",
 		"prepublishOnly": "vp pack",
@@ -41,6 +42,7 @@
 	},
 	"devDependencies": {
 		"@aamini/config": "workspace:*",
+		"vitest": "catalog:",
 		"typescript": "6.0.2"
 	}
 }

package/src/env.test.ts

@@ -0,0 +1,82 @@
+import { mkdtempSync, readFileSync, rmSync, writeFileSync } from 'node:fs'
+import { tmpdir } from 'node:os'
+import { join } from 'node:path'
+import { afterEach, beforeEach, describe, expect, it } from 'vitest'
+import { z } from 'zod'
+import { createEnv } from './env.js'
+
+describe.sequential('createEnv', () => {
+	const cwd = process.cwd()
+	const originalDatabaseUrl = process.env.DATABASE_URL
+	const originalRailwayEnvironmentName = process.env.RAILWAY_ENVIRONMENT_NAME
+	let tempDir = ''
+
+	beforeEach(() => {
+		tempDir = mkdtempSync(join(tmpdir(), 'aamini-lib-env-'))
+		process.chdir(tempDir)
+		process.env.RAILWAY_ENVIRONMENT_NAME = 'production'
+	})
+
+	afterEach(() => {
+		process.chdir(cwd)
+		if (originalDatabaseUrl === undefined) delete process.env.DATABASE_URL
+		else process.env.DATABASE_URL = originalDatabaseUrl
+		if (originalRailwayEnvironmentName === undefined)
+			delete process.env.RAILWAY_ENVIRONMENT_NAME
+		else process.env.RAILWAY_ENVIRONMENT_NAME = originalRailwayEnvironmentName
+		if (tempDir) rmSync(tempDir, { recursive: true, force: true })
+	})
+
+	it('keeps injected env values ahead of dotenv files', () => {
+		writeFileSync(join(tempDir, '.env'), 'DATABASE_URL=postgres://from-file\n')
+		process.env.DATABASE_URL = 'postgres://from-railway'
+
+		const env = createEnv(
+			z.object({
+				DATABASE_URL: z.string(),
+			}),
+		)
+
+		expect(env.DATABASE_URL).toBe('postgres://from-railway')
+		expect(process.env.DATABASE_URL).toBe('postgres://from-railway')
+		expect(readFileSync(join(tempDir, '.env'), 'utf8')).toContain('from-file')
+	})
+
+	it('loads dotenv files from lowest to highest precedence', () => {
+		delete process.env.DATABASE_URL
+		writeFileSync(join(tempDir, '.env'), 'DATABASE_URL=postgres://from-env\n')
+		writeFileSync(
+			join(tempDir, '.env.local'),
+			'DATABASE_URL=postgres://from-local\n',
+		)
+		writeFileSync(
+			join(tempDir, '.env.production'),
+			'DATABASE_URL=postgres://from-production\n',
+		)
+		writeFileSync(
+			join(tempDir, '.env.production.local'),
+			'DATABASE_URL=postgres://from-production-local\n',
+		)
+
+		const env = createEnv(
+			z.object({
+				DATABASE_URL: z.string(),
+			}),
+		)
+
+		expect(env.DATABASE_URL).toBe('postgres://from-production-local')
+	})
+
+	it('does not validate until an env value is read', () => {
+		delete process.env.DATABASE_URL
+
+		const env = createEnv(
+			z.object({
+				DATABASE_URL: z.string(),
+			}),
+		)
+
+		expect(() => env).not.toThrow()
+		expect(() => env.DATABASE_URL).toThrow(/expected string/)
+	})
+})

package/src/env.ts

@@ -1,7 +1,10 @@
 import { config } from 'dotenv'
-import { z } from 'zod'
 
-export function createEnv<T extends z.ZodTypeAny>(schema: T): z.infer<T> {
+type EnvSchema<T extends object> = {
+	parse(input: unknown): T
+}
+
+export function createEnv<T extends object>(schema: EnvSchema<T>): T {
 	const raw =
 		process.env.RAILWAY_ENVIRONMENT_NAME ??
 		(process.env.NODE_ENV === 'production' ? 'production' : 'development')
@@ -20,9 +23,33 @@ export function createEnv<T extends z.ZodTypeAny>(schema: T): z.infer<T> {
 		processEnv: fileEnvironment,
 	})
 
-	for (const [key, value] of Object.entries(fileEnvironment)) {
-		process.env[key] ??= value
+	let parsed: T | undefined
+
+	function parseEnv() {
+		if (parsed !== undefined) return parsed
+
+		const env: NodeJS.ProcessEnv = { ...fileEnvironment }
+
+		for (const [key, value] of Object.entries(process.env)) {
+			if (value !== undefined) env[key] = value
+		}
+
+		parsed = schema.parse(env)
+		return parsed
 	}
 
-	return schema.parse(process.env)
+	return new Proxy({} as Record<PropertyKey, unknown>, {
+		get(_target, property, receiver) {
+			return Reflect.get(parseEnv() as object, property, receiver)
+		},
+		has(_target, property) {
+			return property in (parseEnv() as object)
+		},
+		ownKeys() {
+			return Reflect.ownKeys(parseEnv() as object)
+		},
+		getOwnPropertyDescriptor(_target, property) {
+			return Object.getOwnPropertyDescriptor(parseEnv() as object, property)
+		},
+	}) as T
 }