@open-kingdom/shared-poly-util-env-config 0.0.2-4

package/README.md

@@ -0,0 +1,51 @@
+# @open-kingdom/shared-poly-util-env-config
+
+Centralized configuration service for accessing environment variables. Works in both Node.js and browser environments.
+
+## Usage
+
+### Backend (Node.js)
+
+```typescript
+import { createConfigService, nodeEnvAdapter } from '@open-kingdom/shared-poly-util-env-config';
+
+const envKeys = ['PORT', 'JWT_SECRET', 'JWT_EXPIRES_IN', 'BASE_URL'] as const;
+const configService = createConfigService(envKeys, nodeEnvAdapter);
+
+// Type-safe access to environment variables
+const port = configService.get('PORT', '3000');
+const secret = configService.getOrThrow('JWT_SECRET');
+```
+
+### Frontend (Vite)
+
+```typescript
+import { createConfigService, createBrowserEnvAdapter } from '@open-kingdom/shared-poly-util-env-config';
+
+const envKeys = ['VITE_API_URL', 'VITE_APP_NAME'] as const;
+const configService = createConfigService(envKeys, createBrowserEnvAdapter(import.meta));
+
+const apiUrl = configService.get('VITE_API_URL');
+```
+
+## API
+
+### `createConfigService(keys, adapter)`
+
+Factory function to create a typed ConfigService instance.
+
+- `keys`: Array of environment variable keys (used for type inference)
+- `adapter`: Either `nodeEnvAdapter` or result of `createBrowserEnvAdapter(import.meta)`
+
+### `createBrowserEnvAdapter(importMeta)`
+
+Factory function to create a browser environment adapter.
+
+- `importMeta`: Pass `import.meta` from your Vite app
+
+### `ConfigService<TKeys>`
+
+- `get(key)`: Returns the value or undefined
+- `get(key, defaultValue)`: Returns the value or the default
+- `getOrThrow(key)`: Returns the value or throws if not set
+- `has(key)`: Returns true if the variable is set

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/config-service.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAC"}

package/dist/index.js

@@ -0,0 +1 @@
+export * from './lib/config-service.js';

package/dist/lib/config-service.d.ts

@@ -0,0 +1,19 @@
+export type EnvAdapter = {
+    get(key: string): string | undefined;
+};
+export declare const nodeEnvAdapter: EnvAdapter;
+interface ViteImportMeta {
+    env: Record<string, string | undefined>;
+}
+export declare function createBrowserEnvAdapter(importMeta: ViteImportMeta): EnvAdapter;
+export declare class ConfigService<TKeys extends string = string> {
+    private readonly adapter;
+    constructor(adapter: EnvAdapter);
+    get(key: TKeys): string | undefined;
+    get(key: TKeys, defaultValue: string): string;
+    getOrThrow(key: TKeys): string;
+    has(key: TKeys): boolean;
+}
+export declare function createConfigService<TKeys extends readonly string[]>(_keys: TKeys, adapter: EnvAdapter): ConfigService<TKeys[number]>;
+export {};
+//# sourceMappingURL=config-service.d.ts.map

package/dist/lib/config-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-service.d.ts","sourceRoot":"","sources":["../../src/lib/config-service.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,UAAU,GAAG;IACvB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACtC,CAAC;AAGF,eAAO,MAAM,cAAc,EAAE,UAE5B,CAAC;AAGF,UAAU,cAAc;IACtB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;CACzC;AAGD,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,cAAc,GACzB,UAAU,CAIZ;AAGD,qBAAa,aAAa,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM;IAC1C,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAAP,OAAO,EAAE,UAAU;IAGhD,GAAG,CAAC,GAAG,EAAE,KAAK,GAAG,MAAM,GAAG,SAAS;IACnC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM;IAM7C,UAAU,CAAC,GAAG,EAAE,KAAK,GAAG,MAAM;IAW9B,GAAG,CAAC,GAAG,EAAE,KAAK,GAAG,OAAO;CAGzB;AAGD,wBAAgB,mBAAmB,CAAC,KAAK,SAAS,SAAS,MAAM,EAAE,EACjE,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,UAAU,GAClB,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAE9B"}

package/dist/lib/config-service.js

@@ -0,0 +1,36 @@
+// Node.js adapter - reads from process.env
+export const nodeEnvAdapter = {
+    get: (key) => process.env[key],
+};
+// Browser adapter factory - pass import.meta from your Vite app
+export function createBrowserEnvAdapter(importMeta) {
+    return {
+        get: (key) => importMeta.env[key],
+    };
+}
+// Configuration service for type-safe environment variable access
+export class ConfigService {
+    adapter;
+    constructor(adapter) {
+        this.adapter = adapter;
+    }
+    get(key, defaultValue) {
+        return this.adapter.get(key) ?? defaultValue;
+    }
+    // Get value or throw if not set
+    getOrThrow(key) {
+        const value = this.adapter.get(key);
+        if (value === undefined) {
+            throw new Error(`Environment variable ${key} is not set`);
+        }
+        return value;
+    }
+    // Check if variable is set
+    has(key) {
+        return this.adapter.get(key) !== undefined;
+    }
+}
+// Factory to create a typed ConfigService
+export function createConfigService(_keys, adapter) {
+    return new ConfigService(adapter);
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@open-kingdom/shared-poly-util-env-config",
+  "version": "0.0.2-4",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "development": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "nx": {
+    "tags": [
+      "scope:shared",
+      "type:util",
+      "environment:poly"
+    ]
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  }
+}