@nimbus-cqrs/utils 2.0.0-beta.0 → 2.0.2

package/README.md

@@ -5,10 +5,70 @@
 
 # Nimbus Utils
 
-The utils package of the Nimbus framework.
+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.
 
 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
+
+```bash
+# Deno
+deno add jsr:@nimbus-cqrs/utils
+
+# NPM
+npm install @nimbus-cqrs/utils
+
+# Bun
+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,
+});
+```
+
 # License
 
 Copyright 2024-present Overlap GmbH & Co KG (https://overlap.at)

package/esm/lib/getEnv.js

@@ -1,4 +1,4 @@
-import { GenericException, getLogger } from '../deps/jsr.io/@nimbus/core/2.0.0/src/index.js';
+import { GenericException, getLogger } from '@nimbus-cqrs/core';
 import process from 'node:process';
 /**
  * Get environment variables from the process.env object.

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "@nimbus-cqrs/utils",
-  "version": "2.0.0-beta.0",
-  "description": "Utility helpers shared across the Nimbus CQRS framework.",
+  "version": "2.0.2",
+  "description": "Simplify Event-Driven Applications - Utility helpers shared across the Nimbus framework.",
+  "keywords": [
+    "nimbus",
+    "cqrs",
+    "event-sourcing",
+    "event-driven",
+    "typescript",
+    "utils"
+  ],
   "author": "Daniel Gördes <d.goerdes@overlap.at> (https://overlap.at)",
   "homepage": "https://nimbus.overlap.at",
   "repository": {
@@ -25,7 +33,7 @@
   "dependencies": {
     "@opentelemetry/api": "^1.9.1",
     "zod": "^4.3.6",
-    "@nimbus-cqrs/core": "^2.0.0-beta.0"
+    "@nimbus-cqrs/core": "^2.0.2"
   },
   "devDependencies": {
     "@types/node": "^22.0.0"