@diamir/nestjs-process 11.0.0

package/LICENSE

@@ -0,0 +1,6 @@
+Copyright 2025 WEB&SÖHNE<backend@diamir.io>
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

package/README.md

@@ -0,0 +1,43 @@
+<p align="center">
+  <a href="https://webundsoehne.com" target="blank">
+    <img src="https://webundsoehne.com/wp-content/uploads/webundsoehne-logo.png" width="320" alt="Web und Söhne - Logo" />
+  </a>
+</p>
+Web & Söhne is Austria's leading expert in programming and implementing complex and large web projects.
+
+---
+
+# nestjs-process
+
+<!-- TOC -->
+* [nestjs-process](#nestjs-process)
+  * [SetApiInfoHeaderMiddleware](#setapiinfoheadermiddleware)
+  * [setEnvironmentVariables](#setenvironmentvariables)
+  * [requireNodeEnv](#requirenodeenv)
+  * [registerExitListeners](#registerexitlisteners)
+<!-- TOC -->
+
+## SetApiInfoHeaderMiddleware
+
+NestJs middleware to set
+
+- `X-Api-Name`: read from `process.env?.PACKAGE_NAME`
+- `X-Api-Version`: rad from `process.env?.PACKAGE_VERSION`
+
+response header. (To be used with [setEnvironmentVariables](#setenvironmentvariables))
+
+## setEnvironmentVariables
+
+Writes additional env-vars to the process:
+- `process.env.PACKAGE_NAME`
+- `process.env.PACKAGE_VERSION`
+
+Sets the `process.title` to the Package-Name and -Version from `npm_` env vars or reading from the `package.json`
+
+## requireNodeEnv
+
+Throw error if `process.env.NODE_ENV` is not set
+
+## registerExitListeners
+
+Register `SIGTERM` and `SIGINT` listener

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@diamir/nestjs-process",
+  "version": "11.0.0",
+  "description": "",
+  "author": "Backend <backend@diamir.io>",
+  "repository": "https://github.com/tailoredmedia/backend-nx-skeleton",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [],
+  "main": "./src/index.js",
+  "dependencies": {},
+  "peerDependencies": {
+    "@nestjs/common": ">= 11.0.0"
+  },
+  "peerDependenciesMeta": {},
+  "engines": {
+    "node": ">= 20"
+  },
+  "types": "./src/index.d.ts",
+  "type": "commonjs"
+}

package/src/environment.d.ts

@@ -0,0 +1,2 @@
+export declare function setEnvironmentVariables(packageFile?: string): Promise<void>;
+export declare function requireNodeEnv(errorMessage?: string): void;

package/src/environment.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setEnvironmentVariables = setEnvironmentVariables;
+exports.requireNodeEnv = requireNodeEnv;
+const promises_1 = require("node:fs/promises");
+const node_path_1 = require("node:path");
+async function setEnvironmentVariables(packageFile = (0, node_path_1.join)(process.cwd(), 'package.json')) {
+    const name = process.env.PACKAGE_NAME ??
+        process.env.npm_package_name ??
+        ((0, node_path_1.basename)(process.env.PWD ?? '').length ? (0, node_path_1.basename)(process.env.PWD) : undefined);
+    const version = process.env.PACKAGE_VERSION ?? process.env.npm_package_version;
+    let packageJson;
+    if (!(name && version)) {
+        packageJson = JSON.parse(await (0, promises_1.readFile)(packageFile, { encoding: 'utf8' }));
+    }
+    process.env.PACKAGE_NAME = name ?? packageJson?.name ?? 'nestjs';
+    process.env.PACKAGE_VERSION = version ?? packageJson?.version ?? '0.0.0';
+    process.title = `${process.env.PACKAGE_NAME}-${process.env.PACKAGE_VERSION}`;
+}
+function requireNodeEnv(errorMessage = 'NODE_ENV environment variable is not set.') {
+    if (!process.env.NODE_ENV) {
+        throw new Error(errorMessage);
+    }
+}

package/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './environment';
+export * from './info-header';
+export * from './process';

package/src/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./environment"), exports);
+__exportStar(require("./info-header"), exports);
+__exportStar(require("./process"), exports);

package/src/info-header.d.ts

@@ -0,0 +1,5 @@
+import type { NestMiddleware, OnModuleInit } from '@nestjs/common';
+export declare class SetApiInfoHeaderMiddleware implements NestMiddleware, OnModuleInit {
+    onModuleInit(): Promise<void>;
+    use(_req: never, res: any, next: () => unknown): void;
+}

package/src/info-header.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SetApiInfoHeaderMiddleware = void 0;
+const environment_1 = require("./environment");
+class SetApiInfoHeaderMiddleware {
+    async onModuleInit() {
+        await (0, environment_1.setEnvironmentVariables)();
+    }
+    use(_req, res, next) {
+        res.setHeader('X-Api-Name', process.env?.PACKAGE_NAME);
+        res.setHeader('X-Api-Version', process.env?.PACKAGE_VERSION ?? process.env?.npm_package_version ?? '0.0.0');
+        next();
+    }
+}
+exports.SetApiInfoHeaderMiddleware = SetApiInfoHeaderMiddleware;

package/src/process.d.ts

@@ -0,0 +1 @@
+export declare function registerExitListeners(name?: string): void;

package/src/process.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerExitListeners = registerExitListeners;
+const common_1 = require("@nestjs/common");
+function registerExitListeners(name = 'module') {
+    const logger = new common_1.Logger('ExitListener');
+    function getListener(sig) {
+        return () => {
+            logger.verbose(`---- ${name} exiting via ${sig} ----`);
+            process.exit();
+        };
+    }
+    process.on('SIGTERM', getListener('SIGTERM'));
+    process.on('SIGINT', getListener('SIGINT'));
+    process.on('exit', (code) => {
+        logger.log(`++++ ${name} exiting with code ${code} ++++`);
+    });
+    logger.debug('Exit listeners registered.');
+}