sm-utility 2.4.22 → 2.4.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sm-utility",
-  "version": "2.4.22",
+  "version": "2.4.23",
   "description": "reusable utility codes for sm projects",
   "main": "index.js",
   "types": "./index.d.ts",
@@ -21,6 +21,7 @@
   "devDependencies": {
     "@types/express": "^4.17.11",
     "@types/node": "^14.14.40",
+    "@types/request-ip": "0.0.41",
     "@types/uuid": "^8.3.1",
     "copyfiles": "^2.4.1",
     "typescript": "^4.2.4"
@@ -41,6 +42,7 @@
     "nanoid": "^3.3.6",
     "node-xlsx": "^0.24.0",
     "redis": "^4.1.0",
+    "request-ip": "3.3.0",
     "ts-node": "^10.9.1",
     "uuid": "^8.3.2",
     "winston": "^3.3.3"

package/request/index.d.ts

@@ -1,3 +1,4 @@
 export * from './axios-custom-client';
 export * from './axios';
 export * from './types';
+export * from './requestExtractor';

package/request/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./axios-custom-client"), exports);
 __exportStar(require("./axios"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./requestExtractor"), exports);

package/request/requestExtractor.d.ts

@@ -0,0 +1,25 @@
+import { Request } from 'express';
+export declare class IpAddress {
+    private readonly ip;
+    constructor(ip: string | null);
+    raw(): string;
+    sanitized(): string;
+}
+export declare class RequestExtractor {
+    private readonly req;
+    constructor(req: Request);
+    /**
+     * Extracts the ip address from the request headers.
+     *
+     * If the ip address is not in the cf-connecting-ip header (Cloudflare - HML and PROD), it will be extracted from the x-forwarded-for header (local development)
+     */
+    extractIp(): IpAddress;
+    /**
+     * Extracts the trace id (x-ray trace id) from the request headers
+     */
+    extractTraceId(): string | undefined;
+    /**
+     * Extracts the user agent from the request headers
+     */
+    extractUserAgent(): string | undefined;
+}

package/request/requestExtractor.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestExtractor = exports.IpAddress = void 0;
+const request_ip_1 = __importDefault(require("request-ip"));
+class IpAddress {
+    constructor(ip) {
+        this.ip = ip;
+    }
+    raw() {
+        return this.ip || 'unknown';
+    }
+    sanitized() {
+        var _a;
+        return ((_a = this.ip) === null || _a === void 0 ? void 0 : _a.replace(/^::ffff:/, '')) || 'unknown';
+    }
+}
+exports.IpAddress = IpAddress;
+class RequestExtractor {
+    constructor(req) {
+        this.req = req;
+    }
+    /**
+     * Extracts the ip address from the request headers.
+     *
+     * If the ip address is not in the cf-connecting-ip header (Cloudflare - HML and PROD), it will be extracted from the x-forwarded-for header (local development)
+     */
+    extractIp() {
+        const cloudflareIp = this.req.headers['cf-connecting-ip'];
+        const ip = cloudflareIp || request_ip_1.default.getClientIp(this.req);
+        return new IpAddress(ip);
+    }
+    /**
+     * Extracts the trace id (x-ray trace id) from the request headers
+     */
+    extractTraceId() {
+        return this.req.headers['x-amzn-trace-id'];
+    }
+    /**
+     * Extracts the user agent from the request headers
+     */
+    extractUserAgent() {
+        var _a;
+        return (_a = this.req) === null || _a === void 0 ? void 0 : _a.headers['user-agent'];
+    }
+}
+exports.RequestExtractor = RequestExtractor;