nestjs-backend-common 0.0.0

package/.github/README.md

@@ -0,0 +1,9 @@
+# NestJS Backend Common
+
+All the utility functions and common modules I usually use in my NestJS applications will be published and maintained here.
+
+## [Increase Version](https://docs.npmjs.com/cli/v8/commands/npm-version)
+
+```bash
+npm version patch --no-git-tag-version
+```

package/.github/workflows/publish.yml

@@ -0,0 +1,46 @@
+name: Publish The Library
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  # https://stackoverflow.com/a/72183279/8784518
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Check the current published version
+        run: |
+          LAST_PUBLISHED_VERSION=$(npm view nestjs-backend-common version 2> /dev/null || echo "")
+          PACKAGE_VERSION=$(cat package.json | grep version | head -1 | awk -F: '{ print $2 }' | sed 's/[",]//g')
+          if [[ $LAST_PUBLISHED_VERSION == $PACKAGE_VERSION ]]; then
+            echo "Version is published already, if you need to publish a new version please increase the version in package.json"
+          fi
+
+      - uses: pnpm/action-setup@v4
+        name: Install pnpm
+        with:
+          version: 10
+          run_install: false
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: "pnpm"
+          registry-url: "https://registry.npmjs.org/"
+
+      - name: Install Dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Publish Package on npm 📦
+        run: pnpm publish --provenance --access public --no-git-checks
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.prettierignore

@@ -0,0 +1,8 @@
+# Add files here to ignore them from prettier formatting
+
+/dist
+/coverage
+/.nx/cache
+/.nx/workspace-data
+/node_modules
+pnpm-lock.yaml

package/.prettierrc

@@ -0,0 +1,27 @@
+{
+  "arrowParens": "always",
+  "useTabs": false,
+  "bracketSpacing": true,
+  "endOfLine": "lf",
+  "printWidth": 70,
+  "quoteProps": "consistent",
+  "tabWidth": 2,
+  "trailingComma": "all",
+  "semi": true,
+  "singleQuote": true,
+  "overrides": [
+    {
+      "files": ["*.yml", "*.yaml"],
+      "options": {
+        "singleQuote": false,
+        "tabWidth": 2
+      }
+    },
+    {
+      "files": "*.md",
+      "options": {
+        "tabWidth": 2
+      }
+    }
+  ]
+}

package/dist/src/correlation-id/correlation-id.constant.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CORRELATION_ID_CLS_KEY = exports.CORRELATION_ID_HEADER_NAME = void 0;
+exports.CORRELATION_ID_HEADER_NAME = 'correlation-id';
+exports.CORRELATION_ID_CLS_KEY = 'CORRELATION_ID_CLS_KEY';
+//# sourceMappingURL=correlation-id.constant.js.map

package/dist/src/correlation-id/correlation-id.constant.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"correlation-id.constant.js","sourceRoot":"","sources":["../../../src/correlation-id/correlation-id.constant.ts"],"names":[],"mappings":";;;AAAa,QAAA,0BAA0B,GAAG,gBAAgB,CAAC;AAC9C,QAAA,sBAAsB,GAAG,wBAAwB,CAAC"}

package/dist/src/correlation-id/correlation-id.interceptor.js

@@ -0,0 +1,58 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var CorrelationIdInterceptor_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CorrelationIdInterceptor = void 0;
+const common_1 = require("@nestjs/common");
+const graphql_1 = require("@nestjs/graphql");
+const crypto_1 = require("crypto");
+const correlation_id_constant_1 = require("./correlation-id.constant");
+let CorrelationIdInterceptor = CorrelationIdInterceptor_1 = class CorrelationIdInterceptor {
+    clsService;
+    logger = new common_1.Logger(CorrelationIdInterceptor_1.name);
+    constructor(clsService) {
+        this.clsService = clsService;
+    }
+    intercept(executionContext, next) {
+        let correlationId;
+        switch (executionContext.getType()) {
+            case 'http': {
+                const request = executionContext
+                    .switchToHttp()
+                    .getRequest();
+                const correlationIdValue = Array.isArray(request.headers[correlation_id_constant_1.CORRELATION_ID_HEADER_NAME])
+                    ? request.headers[correlation_id_constant_1.CORRELATION_ID_HEADER_NAME][0]
+                    : request.headers[correlation_id_constant_1.CORRELATION_ID_HEADER_NAME];
+                correlationId = correlationIdValue ?? (0, crypto_1.randomUUID)();
+                break;
+            }
+            case 'graphql': {
+                const ctx = graphql_1.GqlExecutionContext.create(executionContext);
+                const req = ctx.getContext().req;
+                correlationId = req.headers[correlation_id_constant_1.CORRELATION_ID_HEADER_NAME];
+                break;
+            }
+            case 'rpc': {
+                const { correlationId: correlationIdValue } = executionContext
+                    .switchToRpc()
+                    .getContext();
+                correlationId = correlationIdValue ?? (0, crypto_1.randomUUID)();
+                break;
+            }
+            default:
+                throw new Error('Unimplemented request type');
+        }
+        this.clsService.set(correlation_id_constant_1.CORRELATION_ID_CLS_KEY, correlationId);
+        return next.handle();
+    }
+};
+exports.CorrelationIdInterceptor = CorrelationIdInterceptor;
+exports.CorrelationIdInterceptor = CorrelationIdInterceptor = CorrelationIdInterceptor_1 = __decorate([
+    (0, common_1.Injectable)()
+], CorrelationIdInterceptor);
+//# sourceMappingURL=correlation-id.interceptor.js.map

package/dist/src/correlation-id/correlation-id.interceptor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"correlation-id.interceptor.js","sourceRoot":"","sources":["../../../src/correlation-id/correlation-id.interceptor.ts"],"names":[],"mappings":";;;;;;;;;;AAEA,2CAMwB;AACxB,6CAAsD;AACtD,mCAAoC;AAIpC,uEAGmC;AAG5B,IAAM,wBAAwB,gCAA9B,MAAM,wBAAwB;IAGN;IAFrB,MAAM,GAAG,IAAI,eAAM,CAAC,0BAAwB,CAAC,IAAI,CAAC,CAAC;IAE3D,YAA6B,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IAAG,CAAC;IAEvD,SAAS,CAAC,gBAAkC,EAAE,IAAiB;QAC7D,IAAI,aAAqB,CAAC;QAE1B,QAAQ,gBAAgB,CAAC,OAAO,EAA0B,EAAE,CAAC;YAC3D,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,OAAO,GAAY,gBAAgB;qBACtC,YAAY,EAAE;qBACd,UAAU,EAAE,CAAC;gBAChB,MAAM,kBAAkB,GAAG,KAAK,CAAC,OAAO,CACtC,OAAO,CAAC,OAAO,CAAC,oDAA0B,CAAC,CAC5C;oBACC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,oDAA0B,CAAC,CAAC,CAAC,CAAC;oBAChD,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,oDAA0B,CAAC,CAAC;gBAEhD,aAAa,GAAG,kBAAkB,IAAI,IAAA,mBAAU,GAAE,CAAC;gBAEnD,MAAM;YACR,CAAC;YACD,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,GAAG,GAAG,6BAAmB,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;gBACzD,MAAM,GAAG,GAAY,GAAG,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC;gBAE1C,aAAa,GAAG,GAAG,CAAC,OAAO,CACzB,oDAA0B,CACjB,CAAC;gBAEZ,MAAM;YACR,CAAC;YACD,KAAK,KAAK,CAAC,CAAC,CAAC;gBACX,MAAM,EAAE,aAAa,EAAE,kBAAkB,EAAE,GAAG,gBAAgB;qBAC3D,WAAW,EAAE;qBACb,UAAU,EAA8B,CAAC;gBAE5C,aAAa,GAAG,kBAAkB,IAAI,IAAA,mBAAU,GAAE,CAAC;gBAEnD,MAAM;YACR,CAAC;YACD;gBACE,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAClD,CAAC;QAED,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,gDAAsB,EAAE,aAAa,CAAC,CAAC;QAE3D,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;IACvB,CAAC;CACF,CAAA;AAlDY,4DAAwB;mCAAxB,wBAAwB;IADpC,IAAA,mBAAU,GAAE;GACA,wBAAwB,CAkDpC"}

package/dist/src/correlation-id/correlation-id.module.js

@@ -0,0 +1,37 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var CorrelationIdModule_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CorrelationIdModule = void 0;
+const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
+const nestjs_cls_1 = require("nestjs-cls");
+const correlation_id_interceptor_1 = require("./correlation-id.interceptor");
+const correlation_id_service_1 = require("./correlation-id.service");
+let CorrelationIdModule = CorrelationIdModule_1 = class CorrelationIdModule {
+    forRoot(options) {
+        return {
+            global: options?.isGlobal ?? false,
+            module: CorrelationIdModule_1,
+            imports: [nestjs_cls_1.ClsModule],
+            providers: [
+                {
+                    provide: core_1.APP_INTERCEPTOR,
+                    useClass: correlation_id_interceptor_1.CorrelationIdInterceptor,
+                },
+                correlation_id_service_1.CorrelationIdService,
+            ],
+            exports: [correlation_id_service_1.CorrelationIdService],
+        };
+    }
+};
+exports.CorrelationIdModule = CorrelationIdModule;
+exports.CorrelationIdModule = CorrelationIdModule = CorrelationIdModule_1 = __decorate([
+    (0, common_1.Module)({})
+], CorrelationIdModule);
+//# sourceMappingURL=correlation-id.module.js.map

package/dist/src/correlation-id/correlation-id.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"correlation-id.module.js","sourceRoot":"","sources":["../../../src/correlation-id/correlation-id.module.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAuD;AACvD,uCAA+C;AAC/C,2CAAuC;AAEvC,6EAAwE;AACxE,qEAAgE;AAIzD,IAAM,mBAAmB,2BAAzB,MAAM,mBAAmB;IAC9B,OAAO,CAAC,OAAoC;QAC1C,OAAO;YACL,MAAM,EAAE,OAAO,EAAE,QAAQ,IAAI,KAAK;YAClC,MAAM,EAAE,qBAAmB;YAC3B,OAAO,EAAE,CAAC,sBAAS,CAAC;YACpB,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,sBAAe;oBACxB,QAAQ,EAAE,qDAAwB;iBACnC;gBACD,6CAAoB;aACrB;YACD,OAAO,EAAE,CAAC,6CAAoB,CAAC;SAChC,CAAC;IACJ,CAAC;CACF,CAAA;AAhBY,kDAAmB;8BAAnB,mBAAmB;IAD/B,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,mBAAmB,CAgB/B"}

package/dist/src/correlation-id/correlation-id.service.js

@@ -0,0 +1,28 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var CorrelationIdService_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CorrelationIdService = void 0;
+const common_1 = require("@nestjs/common");
+const crypto_1 = require("crypto");
+const correlation_id_constant_1 = require("./correlation-id.constant");
+let CorrelationIdService = CorrelationIdService_1 = class CorrelationIdService {
+    clsService;
+    logger = new common_1.Logger(CorrelationIdService_1.name);
+    constructor(clsService) {
+        this.clsService = clsService;
+    }
+    get correlationId() {
+        return (this.clsService.get(correlation_id_constant_1.CORRELATION_ID_CLS_KEY) ?? (0, crypto_1.randomUUID)());
+    }
+};
+exports.CorrelationIdService = CorrelationIdService;
+exports.CorrelationIdService = CorrelationIdService = CorrelationIdService_1 = __decorate([
+    (0, common_1.Injectable)()
+], CorrelationIdService);
+//# sourceMappingURL=correlation-id.service.js.map

package/dist/src/correlation-id/correlation-id.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"correlation-id.service.js","sourceRoot":"","sources":["../../../src/correlation-id/correlation-id.service.ts"],"names":[],"mappings":";;;;;;;;;;AAAA,2CAAoD;AACpD,mCAAoC;AAGpC,uEAAmE;AAG5D,IAAM,oBAAoB,4BAA1B,MAAM,oBAAoB;IAGF;IAFZ,MAAM,GAAG,IAAI,eAAM,CAAC,sBAAoB,CAAC,IAAI,CAAC,CAAC;IAEhE,YAA6B,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IAAG,CAAC;IAEvD,IAAI,aAAa;QACf,OAAO,CACL,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,gDAAsB,CAAC,IAAI,IAAA,mBAAU,GAAE,CAC5D,CAAC;IACJ,CAAC;CACF,CAAA;AAVY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;GACA,oBAAoB,CAUhC"}

package/dist/src/correlation-id/correlation-id.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=correlation-id.type.js.map

package/dist/src/correlation-id/correlation-id.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"correlation-id.type.js","sourceRoot":"","sources":["../../../src/correlation-id/correlation-id.type.ts"],"names":[],"mappings":""}

package/dist/src/correlation-id/index.js

@@ -0,0 +1,21 @@
+"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("./correlation-id.constant"), exports);
+__exportStar(require("./correlation-id.module"), exports);
+__exportStar(require("./correlation-id.service"), exports);
+__exportStar(require("./correlation-id.type"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/correlation-id/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/correlation-id/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,0DAAwC;AACxC,2DAAyC;AACzC,wDAAsC"}

package/dist/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("./correlation-id"), exports);
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,0CAAwB"}

package/dist/src/types/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/dist/src/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":""}

package/eslint.config.mjs

@@ -0,0 +1,99 @@
+// @ts-check
+
+import eslint from '@eslint/js';
+import perfectionist from 'eslint-plugin-perfectionist';
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
+import globals from 'globals';
+import { dirname } from 'path';
+import tseslint from 'typescript-eslint';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+export default tseslint.config(
+  {
+    ignores: ['eslint.config.mjs', '**/dist'],
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  eslintPluginPrettierRecommended,
+  {
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.jest,
+      },
+      ecmaVersion: 5,
+      sourceType: 'module',
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: __dirname,
+      },
+    },
+  },
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'error',
+      '@typescript-eslint/no-floating-promises': 'warn',
+      '@typescript-eslint/no-unsafe-argument': 'warn',
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      '@typescript-eslint/no-unsafe-call': 'off',
+    },
+  },
+  {
+    files: ['**/*.config.ts', '**/*.spec.ts', '**/*.e2e-spec.ts'],
+    rules: {
+      '@typescript-eslint/naming-convention': [
+        'error',
+        {
+          selector: 'typeParameter',
+          format: ['PascalCase'],
+
+          custom: {
+            regex: '^T[A-Z][a-zA-Z]+$',
+            match: true,
+          },
+        },
+      ],
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          argsIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+        },
+      ],
+      '@typescript-eslint/no-namespace': 'off',
+      '@typescript-eslint/no-empty-interface': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unsafe-argument': 'off',
+      '@typescript-eslint/no-empty-object-type': 'off',
+    },
+  },
+  {
+    plugins: {
+      perfectionist,
+    },
+    rules: {
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        {
+          argsIgnorePattern: '^_[^_].*$|^_$',
+          varsIgnorePattern: '^_[^_].*$|^_$',
+        },
+      ],
+      'perfectionist/sort-named-imports': 'error',
+      'perfectionist/sort-exports': 'error',
+      'perfectionist/sort-imports': 'error',
+      'perfectionist/sort-named-exports': 'error',
+      'perfectionist/sort-enums': 'error',
+    },
+  },
+  {
+    ignores: ['*decorator.ts', '*.spec.ts'],
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+    },
+  },
+);

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "nestjs-backend-common",
+  "version": "0.0.0",
+  "main": "dist/index",
+  "types": "dist/index",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/kasir-barati/nestjs-backend-common.git"
+  },
+  "keywords": [
+    "npm",
+    "common",
+    "nestjs",
+    "nodejs",
+    "javascript",
+    "typescript"
+  ],
+  "author": "kasir-barati",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/kasir-barati/nestjs-backend-common/issues"
+  },
+  "homepage": "https://github.com/kasir-barati/nestjs-backend-common#readme",
+  "description": "All the utility functions and common modules I usually use in my NestJS applications will be published and maintained here.",
+  "dependencies": {
+    "@nestjs/common": "^11.0.20",
+    "@nestjs/core": "^11.0.20",
+    "@nestjs/graphql": "^13.1.0",
+    "nestjs-cls": "^5.4.3"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.25.0",
+    "@types/express": "^5.0.1",
+    "@types/node": "^22.14.1",
+    "eslint-config-prettier": "^10.1.2",
+    "eslint-plugin-perfectionist": "^4.11.0",
+    "eslint-plugin-prettier": "^5.2.6",
+    "globals": "^16.0.0",
+    "prettier": "^3.5.3",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.30.1"
+  },
+  "scripts": {
+    "test": "jest",
+    "build": "rm -rf dist && tsc",
+    "lint": "eslint \"{src,apps,libs,test}/**/*.ts\"",
+    "lint:fix": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
+    "prepublish": "npm run build"
+  }
+}

package/src/correlation-id/correlation-id.constant.ts

@@ -0,0 +1,2 @@
+export const CORRELATION_ID_HEADER_NAME = 'correlation-id';
+export const CORRELATION_ID_CLS_KEY = 'CORRELATION_ID_CLS_KEY';

package/src/correlation-id/correlation-id.interceptor.ts

@@ -0,0 +1,71 @@
+import type { Request } from 'express';
+
+import {
+  CallHandler,
+  ExecutionContext,
+  Injectable,
+  Logger,
+  NestInterceptor,
+} from '@nestjs/common';
+import { GqlExecutionContext } from '@nestjs/graphql';
+import { randomUUID } from 'crypto';
+import { ClsService } from 'nestjs-cls';
+
+import { CommonExecutionContext } from '../types';
+import {
+  CORRELATION_ID_CLS_KEY,
+  CORRELATION_ID_HEADER_NAME,
+} from './correlation-id.constant';
+
+@Injectable()
+export class CorrelationIdInterceptor implements NestInterceptor {
+  private logger = new Logger(CorrelationIdInterceptor.name);
+
+  constructor(private readonly clsService: ClsService) {}
+
+  intercept(executionContext: ExecutionContext, next: CallHandler) {
+    let correlationId: string;
+
+    switch (executionContext.getType<CommonExecutionContext>()) {
+      case 'http': {
+        const request: Request = executionContext
+          .switchToHttp()
+          .getRequest();
+        const correlationIdValue = Array.isArray(
+          request.headers[CORRELATION_ID_HEADER_NAME],
+        )
+          ? request.headers[CORRELATION_ID_HEADER_NAME][0]
+          : request.headers[CORRELATION_ID_HEADER_NAME];
+
+        correlationId = correlationIdValue ?? randomUUID();
+
+        break;
+      }
+      case 'graphql': {
+        const ctx = GqlExecutionContext.create(executionContext);
+        const req: Request = ctx.getContext().req;
+
+        correlationId = req.headers[
+          CORRELATION_ID_HEADER_NAME
+        ] as string;
+
+        break;
+      }
+      case 'rpc': {
+        const { correlationId: correlationIdValue } = executionContext
+          .switchToRpc()
+          .getContext<{ correlationId?: string }>();
+
+        correlationId = correlationIdValue ?? randomUUID();
+
+        break;
+      }
+      default:
+        throw new Error('Unimplemented request type');
+    }
+
+    this.clsService.set(CORRELATION_ID_CLS_KEY, correlationId);
+
+    return next.handle();
+  }
+}

package/src/correlation-id/correlation-id.module.ts

@@ -0,0 +1,26 @@
+import { DynamicModule, Module } from '@nestjs/common';
+import { APP_INTERCEPTOR } from '@nestjs/core';
+import { ClsModule } from 'nestjs-cls';
+
+import { CorrelationIdInterceptor } from './correlation-id.interceptor';
+import { CorrelationIdService } from './correlation-id.service';
+import { CorrelationIdModuleOptions } from './correlation-id.type';
+
+@Module({})
+export class CorrelationIdModule {
+  forRoot(options?: CorrelationIdModuleOptions): DynamicModule {
+    return {
+      global: options?.isGlobal ?? false,
+      module: CorrelationIdModule,
+      imports: [ClsModule],
+      providers: [
+        {
+          provide: APP_INTERCEPTOR,
+          useClass: CorrelationIdInterceptor,
+        },
+        CorrelationIdService,
+      ],
+      exports: [CorrelationIdService],
+    };
+  }
+}

package/src/correlation-id/correlation-id.service.ts

@@ -0,0 +1,18 @@
+import { Injectable, Logger } from '@nestjs/common';
+import { randomUUID } from 'crypto';
+import { ClsService } from 'nestjs-cls';
+
+import { CORRELATION_ID_CLS_KEY } from './correlation-id.constant';
+
+@Injectable()
+export class CorrelationIdService {
+  private readonly logger = new Logger(CorrelationIdService.name);
+
+  constructor(private readonly clsService: ClsService) {}
+
+  get correlationId(): string {
+    return (
+      this.clsService.get(CORRELATION_ID_CLS_KEY) ?? randomUUID()
+    );
+  }
+}

package/src/correlation-id/correlation-id.type.ts

@@ -0,0 +1,7 @@
+export interface CorrelationIdModuleOptions {
+  /**
+   * @default false
+   * @description Register the module globally
+   */
+  isGlobal?: boolean;
+}

package/src/correlation-id/index.ts

@@ -0,0 +1,4 @@
+export * from './correlation-id.constant';
+export * from './correlation-id.module';
+export * from './correlation-id.service';
+export * from './correlation-id.type';

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './correlation-id';
+export * from './types';

package/src/types/index.ts

@@ -0,0 +1,3 @@
+import { ContextType } from '@nestjs/common';
+
+export type CommonExecutionContext = 'graphql' | ContextType;

package/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "node_modules",
+    "test",
+    "dist",
+    "**/*spec.ts",
+    "eslint.config.mjs"
+  ]
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2024",
+    "experimentalDecorators": true,
+    "module": "NodeNext",
+    "rootDir": "./",
+    "outDir": "./dist",
+    "moduleResolution": "nodenext",
+    "sourceMap": true,
+    "removeComments": false,
+    "newLine": "crlf",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": true,
+    "strictPropertyInitialization": false,
+    "skipLibCheck": true
+  }
+}