@nimbus-cqrs/utils 2.1.2 → 2.3.0

package/README.md

@@ -5,11 +5,21 @@
 
 # Nimbus Utils
 
-A small collection of utility helpers used across the Nimbus framework — currently a single helper, `getEnv`, for reading required environment variables in a fail-fast way.
+> **Deprecated.** This package is deprecated. Import `getEnv` from [`@nimbus-cqrs/core`](https://www.npmjs.com/package/@nimbus-cqrs/core) instead. `@nimbus-cqrs/utils` remains available as a thin re-export for backwards compatibility.
 
 Refer to the [Nimbus main repository](https://github.com/overlap-dev/Nimbus) or the [Nimbus documentation](https://nimbus.overlap.at) for more information about the Nimbus framework.
 
-## Install
+## Migration
+
+```typescript
+// Before
+import { getEnv } from "@nimbus-cqrs/utils";
+
+// After
+import { getEnv } from "@nimbus-cqrs/core";
+```
+
+## Install (legacy)
 
 ```bash
 # Deno
@@ -22,52 +32,7 @@ npm install @nimbus-cqrs/utils
 bun add @nimbus-cqrs/utils
 ```
 
-# Examples
-
-For detailed documentation, please refer to the [Nimbus documentation](https://nimbus.overlap.at).
-
-## getEnv
-
-`getEnv` reads a list of environment variables from `process.env` and returns them as a plain object. If any of the requested variables are missing it logs the missing names through the Nimbus logger and throws a `GenericException`, so misconfiguration fails loudly at startup instead of leaking through as `undefined` later.
-
-```typescript
-import { getEnv } from "@nimbus-cqrs/utils";
-
-const env = getEnv({
-    variables: ["MONGO_URI", "MONGO_DB_NAME"],
-});
-
-console.log(env.MONGO_URI); // "mongodb://localhost:27017"
-console.log(env.MONGO_DB_NAME); // "my-app"
-```
-
-If, for example, `MONGO_DB_NAME` is not set, the call throws a `GenericException` whose `data` carries the list of missing variables:
-
-```json
-{
-    "name": "GenericException",
-    "message": "Undefined environment variables",
-    "data": {
-        "undefinedVariables": ["MONGO_DB_NAME"]
-    }
-}
-```
-
-A typical pattern is to call `getEnv` once at application startup, before any subsystem that needs those values is initialized:
-
-```typescript
-import { getEnv } from "@nimbus-cqrs/utils";
-import { MongoConnectionManager } from "@nimbus-cqrs/mongodb";
-
-const env = getEnv({
-    variables: ["MONGO_URI", "MONGO_DB_NAME"],
-});
-
-const mongo = new MongoConnectionManager({
-    uri: env.MONGO_URI,
-    dbName: env.MONGO_DB_NAME,
-});
-```
+Prefer installing `@nimbus-cqrs/core` directly.
 
 # License
 

package/esm/_dnt.polyfills.d.ts

@@ -0,0 +1,7 @@
+declare global {
+    interface Error {
+        cause?: unknown;
+    }
+}
+export {};
+//# sourceMappingURL=_dnt.polyfills.d.ts.map

package/esm/_dnt.polyfills.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_dnt.polyfills.d.ts","sourceRoot":"","sources":["../src/_dnt.polyfills.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,KAAK;QACb,KAAK,CAAC,EAAE,OAAO,CAAC;KACjB;CACF;AAED,OAAO,EAAE,CAAC"}

package/esm/_dnt.polyfills.js

@@ -0,0 +1 @@
+export {};

package/esm/index.d.ts

@@ -1,2 +1,3 @@
+import "./_dnt.polyfills.js";
 export * from './lib/getEnv.js';
 //# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,CAAC;AAC7B,cAAc,iBAAiB,CAAC"}

package/esm/index.js

@@ -1 +1,2 @@
+import "./_dnt.polyfills.js";
 export * from './lib/getEnv.js';

package/esm/lib/getEnv.d.ts

@@ -1,15 +1,5 @@
-type GetEnvInput = {
-    variables: string[];
-};
 /**
- * Get environment variables from the process.env object.
- * Throws an exception if any of the variables are not defined
- * and logs the missing variable names.
- *
- * @param variables - The list of environment variables to get
- * @returns {Record<string, string>} Object of the environment variables
- * @throws {GenericException} Thrown if any of the requested variables are not defined
+ * @deprecated Import {@link getEnv} from `@nimbus-cqrs/core` instead.
  */
-export declare const getEnv: ({ variables, }: GetEnvInput) => Record<string, string>;
-export {};
+export { getEnv } from '@nimbus-cqrs/core';
 //# sourceMappingURL=getEnv.d.ts.map

package/esm/lib/getEnv.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getEnv.d.ts","sourceRoot":"","sources":["../../src/lib/getEnv.ts"],"names":[],"mappings":"AAGA,KAAK,WAAW,GAAG;IACf,SAAS,EAAE,MAAM,EAAE,CAAC;CACvB,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,MAAM,GAAI,gBAEpB,WAAW,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CA2BrC,CAAC"}
+{"version":3,"file":"getEnv.d.ts","sourceRoot":"","sources":["../../src/lib/getEnv.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,MAAM,EAAE,MAAM,qDAAqD,CAAC"}

package/esm/lib/getEnv.js

@@ -1,34 +1,4 @@
-import { GenericException, getLogger } from '@nimbus-cqrs/core';
-import process from 'node:process';
 /**
- * Get environment variables from the process.env object.
- * Throws an exception if any of the variables are not defined
- * and logs the missing variable names.
- *
- * @param variables - The list of environment variables to get
- * @returns {Record<string, string>} Object of the environment variables
- * @throws {GenericException} Thrown if any of the requested variables are not defined
+ * @deprecated Import {@link getEnv} from `@nimbus-cqrs/core` instead.
  */
-export const getEnv = ({ variables, }) => {
-    const envVars = {};
-    const missingEnvVars = [];
-    for (const variable of variables) {
-        if (!process.env[variable]) {
-            missingEnvVars.push(variable);
-        }
-        envVars[variable] = process.env[variable];
-    }
-    if (missingEnvVars.length > 0) {
-        getLogger().error({
-            category: 'Nimbus',
-            message: 'Undefined environment variables',
-            data: {
-                undefinedVariables: missingEnvVars,
-            },
-        });
-        throw new GenericException('Undefined environment variables', {
-            undefinedVariables: missingEnvVars,
-        });
-    }
-    return envVars;
-};
+export { getEnv } from '@nimbus-cqrs/core';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nimbus-cqrs/utils",
-  "version": "2.1.2",
+  "version": "2.3.0",
   "description": "Simplify Event-Driven Applications - Utility helpers shared across the Nimbus framework.",
   "keywords": [
     "nimbus",
@@ -32,8 +32,8 @@
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.1",
-    "zod": "^4.3.6",
-    "@nimbus-cqrs/core": "^2.1.2"
+    "zod": "^4.4.3",
+    "@nimbus-cqrs/core": "^2.3.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0"