fiberx-backend-toolkit 0.0.37 → 0.0.40

package/dist/config/constants.d.ts

@@ -9,6 +9,11 @@ export declare const SEEDERS_DIR: string;
 export declare const SEQUELIZE_META_TABLE_NAME = "sequelize_database_tables_meta";
 export declare const SEQUELIZE_SEEDER_META_TABLE_NAME = "sequelize_database_table_seeder_meta";
 export declare const REQUEST_ID_COOKIE_MAX_AGE: number;
+export declare const REQUEST_ID_COOKIE_NAME = "request_id";
+export declare const REQUEST_ID_HEADERS_NAME = "X-Request-Id";
+export declare const DEVICE_ID_COOKIE_MAX_AGE: number;
+export declare const DEVICE_ID_COOKIE_NAME = "device_id";
+export declare const DEVICE_ID_HEADERS_NAME = "X-Device-Id";
 export declare const CORS_ALLOWED_METHODS: string[];
 export declare const CORS_ALLOWED_HEADERS: string[];
 export declare const CORS_MAX_AGE_IN_SECONDS = 600;

package/dist/config/constants.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ALPHABET_CORPUS = exports.REQUEST_RATE_LIMITTER_OPTIONS = exports.CORS_MAX_AGE_IN_MICRO_SECONDS = exports.CORS_MAX_AGE_IN_SECONDS = exports.CORS_ALLOWED_HEADERS = exports.CORS_ALLOWED_METHODS = exports.REQUEST_ID_COOKIE_MAX_AGE = exports.SEQUELIZE_SEEDER_META_TABLE_NAME = exports.SEQUELIZE_META_TABLE_NAME = exports.SEEDERS_DIR = exports.MIGRATIONS_DIR = exports.MODELS_DIR = exports.SCHEMA_SNAPSHOTS_DIR = exports.SCHEMAS_DIR = exports.ENV_VAR_DIR = exports.LOG_DIR = exports.BASE_DIR = void 0;
+exports.ALPHABET_CORPUS = exports.REQUEST_RATE_LIMITTER_OPTIONS = exports.CORS_MAX_AGE_IN_MICRO_SECONDS = exports.CORS_MAX_AGE_IN_SECONDS = exports.CORS_ALLOWED_HEADERS = exports.CORS_ALLOWED_METHODS = exports.DEVICE_ID_HEADERS_NAME = exports.DEVICE_ID_COOKIE_NAME = exports.DEVICE_ID_COOKIE_MAX_AGE = exports.REQUEST_ID_HEADERS_NAME = exports.REQUEST_ID_COOKIE_NAME = exports.REQUEST_ID_COOKIE_MAX_AGE = exports.SEQUELIZE_SEEDER_META_TABLE_NAME = exports.SEQUELIZE_META_TABLE_NAME = exports.SEEDERS_DIR = exports.MIGRATIONS_DIR = exports.MODELS_DIR = exports.SCHEMA_SNAPSHOTS_DIR = exports.SCHEMAS_DIR = exports.ENV_VAR_DIR = exports.LOG_DIR = exports.BASE_DIR = void 0;
 const path_1 = __importDefault(require("path"));
 // Database constants
 exports.BASE_DIR = process.cwd();
@@ -16,10 +16,15 @@ exports.MIGRATIONS_DIR = path_1.default.join(exports.BASE_DIR, "src/database/mig
 exports.SEEDERS_DIR = path_1.default.join(exports.BASE_DIR, "src/database/seeders");
 exports.SEQUELIZE_META_TABLE_NAME = "sequelize_database_tables_meta";
 exports.SEQUELIZE_SEEDER_META_TABLE_NAME = "sequelize_database_table_seeder_meta";
-exports.REQUEST_ID_COOKIE_MAX_AGE = (1000 * 60 * 60 * 24 * 7); // 7 days
+exports.REQUEST_ID_COOKIE_MAX_AGE = (1000 * 60 * 60 * 24 * 30); // 7 days
+exports.REQUEST_ID_COOKIE_NAME = "request_id";
+exports.REQUEST_ID_HEADERS_NAME = "X-Request-Id";
+exports.DEVICE_ID_COOKIE_MAX_AGE = (1000 * 60 * 60 * 24 * 180); // 180 days
+exports.DEVICE_ID_COOKIE_NAME = "device_id";
+exports.DEVICE_ID_HEADERS_NAME = "X-Device-Id";
 // CORS constants
 exports.CORS_ALLOWED_METHODS = ["GET", "POST", "PATCH", "DELETE", "OPTIONS"];
-exports.CORS_ALLOWED_HEADERS = ["Content-Type", "Authorization", "X-Device-Id", "X-Device-Name", "User-Agent"];
+exports.CORS_ALLOWED_HEADERS = ["Content-Type", "Authorization", exports.REQUEST_ID_HEADERS_NAME, exports.DEVICE_ID_HEADERS_NAME, "X-Device-Name", "User-Agent"];
 exports.CORS_MAX_AGE_IN_SECONDS = (600); // default: 10 min
 exports.CORS_MAX_AGE_IN_MICRO_SECONDS = (1000 * 60 * 10); // 10 minutes
 // Rate limitter

package/dist/middle_ware/cookie_manager_middle_ware.d.ts

@@ -5,9 +5,17 @@ declare class CookieManagerMiddleWare {
     private logger;
     private readonly default_cookie_options;
     private request_id_max_age;
+    private request_id_cookie_name;
+    private request_id_header_name;
     private request_id_generator;
+    private device_id_max_age;
+    private device_id_cookie_name;
+    private device_id_header_name;
+    private device_id_generator;
     constructor(options?: CookieManagerOptions);
     private getDefaultCookieOptions;
+    private handleRequestId;
+    private handleDeviceId;
     /** Get cookie value safely */
     get(req: Request, name: string): string | undefined;
     /** Set cookie with enforced defaults */

package/dist/middle_ware/cookie_manager_middle_ware.js

@@ -20,10 +20,23 @@ class CookieManagerMiddleWare {
     logger = new main_1.LoggerUtil(this.name);
     default_cookie_options = this.getDefaultCookieOptions();
     request_id_max_age;
+    request_id_cookie_name;
+    request_id_header_name;
     request_id_generator;
+    device_id_max_age;
+    device_id_cookie_name;
+    device_id_header_name;
+    device_id_generator;
     constructor(options = {}) {
         this.request_id_max_age = options?.request_id_max_age || constants_1.REQUEST_ID_COOKIE_MAX_AGE;
+        this.request_id_cookie_name = options.request_id_cookie_name || constants_1.DEVICE_ID_COOKIE_NAME;
+        this.request_id_header_name = options.request_id_header_name || constants_1.DEVICE_ID_HEADERS_NAME;
         this.request_id_generator = options?.request_id_generator || crypto_1.default.randomUUID;
+        // device id
+        this.device_id_max_age = options.device_id_max_age || constants_1.DEVICE_ID_COOKIE_MAX_AGE; // 180d
+        this.device_id_cookie_name = options.device_id_cookie_name || constants_1.DEVICE_ID_COOKIE_NAME;
+        this.device_id_header_name = options.device_id_header_name || constants_1.DEVICE_ID_HEADERS_NAME;
+        this.device_id_generator = options.device_id_generator || crypto_1.default.randomUUID;
         main_1.SafeExecuteUtil.setNamedInstance(this.name, this);
     }
     // Method to get default cookie options
@@ -35,6 +48,34 @@ class CookieManagerMiddleWare {
             secure: main_1.InputValidatorUtil.isProduction(),
         };
     }
+    // Method to Ensure request_id exists + rolling expiration
+    handleRequestId(req, res) {
+        let request_id = this.get(req, "request_id");
+        if (!request_id) {
+            request_id = this.request_id_generator();
+            this.logger.info(`Generated request_id: ${request_id}`);
+        }
+        // ALWAYS refresh TTL (rolling expiration)
+        this.set(res, "request_id", request_id, {
+            max_age: this.request_id_max_age,
+        });
+        res.setHeader("X-Request-Id", request_id);
+        return request_id;
+    }
+    // Method to Ensure device_id exists (long-lived)
+    handleDeviceId(req, res) {
+        let device_id = this.get(req, this.device_id_cookie_name);
+        if (!device_id) {
+            device_id = this.device_id_generator();
+            this.logger.info(`Generated device_id: ${device_id}`);
+        }
+        // persist long term
+        this.set(res, this.device_id_cookie_name, device_id, {
+            max_age: this.device_id_max_age,
+        });
+        res.setHeader(this.device_id_header_name, device_id);
+        return device_id;
+    }
     /** Get cookie value safely */
     get(req, name) {
         return req.cookies?.[name];
@@ -54,16 +95,11 @@ class CookieManagerMiddleWare {
         req.getCookie = (name) => this.get(req, name);
         req.setCookie = (name, value, options = {}) => this.set(res, name, value, options);
         req.clearCookie = (name) => this.clear(res, name);
-        // Request ID handling
-        let request_id = req.getCookie("request_id");
-        if (!request_id) {
-            request_id = this.request_id_generator();
-            this.set(res, "request_id", request_id, { max_age: this.request_id_max_age });
-            res.setHeader("X-Request-Id", request_id);
-            this.logger.info(`Generated request_id: ${request_id}`);
-        }
-        this.logger.info(`[REQ:${request_id}] ${req.method} ${req.originalUrl}`);
+        const request_id = this.handleRequestId(req, res);
+        const device_id = this.handleDeviceId(req, res);
         req.request_id = request_id;
+        req.device_id = device_id;
+        this.logger.info(`[REQ:${request_id}] [DEV:${device_id}] ${req.method} ${req.originalUrl}`);
         return next();
     }
 }

package/dist/types/express_decelaration.d.ts

@@ -0,0 +1,19 @@
+import "express-serve-static-core";
+declare module "express-serve-static-core" {
+    interface Response {
+        errResponse: (code?: number, msg?: string, data?: any) => Response;
+        successResponse: (code?: number, msg?: string, data?: any) => Response;
+        infoResponse: (code?: number, msg?: string, data?: any) => Response;
+        handle404Error: () => Response;
+    }
+    interface Request {
+        getCookie: (name: string) => string | undefined;
+        setCookie: (name: string, value: string, options?: {
+            max_age?: number;
+        }) => void;
+        clearCookie: (name: string) => void;
+        request_id?: string;
+        device_id?: string;
+        clientIp?: string;
+    }
+}

package/dist/types/express_decelaration.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("express-serve-static-core");

package/dist/types/main.d.ts

@@ -4,3 +4,4 @@ export * from "./util_type";
 export * from "./middle_ware_type";
 export * from "./database_type";
 export * from "./module_type";
+export * from "./express_decelaration";

package/dist/types/main.js

@@ -20,3 +20,4 @@ __exportStar(require("./util_type"), exports);
 __exportStar(require("./middle_ware_type"), exports);
 __exportStar(require("./database_type"), exports);
 __exportStar(require("./module_type"), exports);
+__exportStar(require("./express_decelaration"), exports);

package/dist/types/middle_ware_type.d.ts

@@ -20,7 +20,13 @@ export type RateLimitRecord = {
 };
 export interface CookieManagerOptions {
     request_id_max_age?: number;
+    request_id_cookie_name?: string;
+    request_id_header_name?: string;
     request_id_generator?: () => string;
+    device_id_max_age?: number;
+    device_id_cookie_name?: string;
+    device_id_header_name?: string;
+    device_id_generator?: () => string;
 }
 export interface ForceHTTPSOptions {
     enabled?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fiberx-backend-toolkit",
-    "version": "0.0.37",
+    "version": "0.0.40",
     "description": "A TypeScript backend toolkit providing shared domain logic, infrastructure helpers, and utilities for FiberX server-side applications and services.",
     "type": "commonjs",
     "main": "./dist/index.js",