@6thbridge/utils 0.3.9-0 → 1.0.1

package/lib/types/authentication.entity.d.ts

@@ -0,0 +1,30 @@
+import { AuthenticationTypes, ClientEntity, UserEntity } from "../types";
+export type AuthorizationClientResponse = Pick<ClientEntity, 'name' | 'clientId' | 'logo' | 'email' | 'status'>;
+export type AuthorizationUserResponse = Pick<UserEntity, 'clientId' | 'name' | 'email' | 'firstName' | 'lastName' | 'roleId'> & {
+    userId: string;
+};
+export declare class ValidateUserAccessDTO {
+    domain: string;
+    secret: string;
+    requestClientId: string;
+    contextClientId: string;
+    country: string;
+    currency: string;
+    token: string;
+}
+export declare class ValidateUserAccessResponseDTO {
+    domain: string;
+    country: string;
+    currency: string;
+    locale: string;
+    requestClientId: string;
+    contextClientId: string;
+    contextClient: AuthorizationClientResponse;
+    requestClient: AuthorizationClientResponse;
+    authenticationType: AuthenticationTypes;
+    requestUserId: string;
+    contextUserId: string;
+    requestUser: AuthorizationUserResponse;
+    contextUser: AuthorizationUserResponse;
+    permissions: string;
+}

package/lib/types/authentication.entity.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ValidateUserAccessResponseDTO = exports.ValidateUserAccessDTO = void 0;
+class ValidateUserAccessDTO {
+}
+exports.ValidateUserAccessDTO = ValidateUserAccessDTO;
+class ValidateUserAccessResponseDTO {
+}
+exports.ValidateUserAccessResponseDTO = ValidateUserAccessResponseDTO;
+//# sourceMappingURL=authentication.entity.js.map

package/lib/types/authentication.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"authentication.entity.js","sourceRoot":"","sources":["../../src/types/authentication.entity.ts"],"names":[],"mappings":";;;AAIA,MAAa,qBAAqB;CAQjC;AARD,sDAQC;AAED,MAAa,6BAA6B;CAezC;AAfD,sEAeC"}

package/lib/types/context.entity.d.ts

@@ -2,25 +2,26 @@ import { RequestUserEntity } from './user.entity';
 import { RequestClientEntity } from './client.entity';
 import express from 'express';
 import { LoggerInterface } from '../logger';
+import { RabbitMQClient } from '../index';
+import { AuthorizationClientResponse, AuthorizationUserResponse, ValidateUserAccessResponseDTO } from "./authentication.entity";
 export declare const INTERNAL_REQUEST_SOURCE = "internal";
 export declare class ContextEntity {
     requestSource?: string;
     clientId?: string;
     requestClientId?: string;
     contextClientId?: string;
-    requestClient?: RequestClientEntity;
-    contextClient?: RequestClientEntity;
+    requestClient?: RequestClientEntity | AuthorizationClientResponse;
+    contextClient?: RequestClientEntity | AuthorizationClientResponse;
     requestId?: string;
     authenticationType?: string;
     permissions?: string[];
-    features?: string[];
     os?: string;
     platform?: string;
     version?: string;
     request: express.Request | undefined | any;
     data?: any;
-    requestUser?: RequestUserEntity;
-    contextUser?: RequestUserEntity;
+    requestUser?: RequestUserEntity | AuthorizationUserResponse;
+    contextUser?: RequestUserEntity | AuthorizationUserResponse;
     contextUserId?: string;
     requestUserId?: string;
     userId?: string;
@@ -30,16 +31,9 @@ export declare class ContextEntity {
     countryCode?: string;
     locale?: string;
     origin?: string;
-    broker?: any;
-    [key: string]: any;
+    broker?: RabbitMQClient;
     constructor();
     static fromRequest(req: express.Request): ContextEntity;
+    static fromAuthorizationResult(req: express.Request, result: ValidateUserAccessResponseDTO): ContextEntity;
     clone(): this;
-    getClientId(): string | undefined;
-    createDefaultLogger(): void;
-    hasPermission(permission: string): boolean;
-    hasFeature(feature: string): boolean;
-    getUserId(): string;
-    getRequestClientId(): string;
-    getContextClientId(): string;
 }

package/lib/types/context.entity.js

@@ -33,7 +33,7 @@ class ContextEntity {
         this.logger = new logger_1.Logger({});
     }
     static fromRequest(req) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d;
         const context = new ContextEntity();
         context.requestSource = req.headers.source;
         context.authenticationType = req.headers['authentication-type'];
@@ -49,12 +49,10 @@ class ContextEntity {
         context.platform = req.headers.platform;
         context.version = req.headers.version;
         context.request = req;
-        context.data = req.body;
         context.currencyCode = req.headers['x-currency-code'];
         context.countryCode = req.headers['x-country-code'];
         context.locale = req.headers['x-locale-id'] || 'en';
         context.permissions = ((_d = req.headers.permissions) === null || _d === void 0 ? void 0 : _d.split(',')) || [];
-        context.features = ((_e = req.headers.features) === null || _e === void 0 ? void 0 : _e.split(',')) || [];
         context.logger = new logger_1.Logger({
             requestId: context.requestId,
             requestClientId: context.requestClientId,
@@ -66,41 +64,45 @@ class ContextEntity {
         });
         return context;
     }
-    clone() {
-        return _.cloneDeep(this);
-    }
-    getClientId() {
-        return this.contextClientId || this.requestClientId || this.contextClientId;
-    }
-    createDefaultLogger() {
-        var _a;
-        this.logger = new logger_1.Logger({
-            requestId: this.requestId,
-            requestClientId: this.requestClientId,
-            contextClientId: this.contextClientId,
-            userId: this.userId,
-            ip: this.ip,
-            url: (_a = this.request) === null || _a === void 0 ? void 0 : _a.originalUrl,
-            requestSource: this.requestSource,
+    static fromAuthorizationResult(req, result) {
+        const context = new ContextEntity();
+        context.requestSource = req.headers.source;
+        context.authenticationType = result.authenticationType;
+        context.requestClientId = result.requestClientId;
+        context.contextClientId = result.requestClientId;
+        context.requestClient = result.requestClient;
+        context.contextUser = result.contextUser;
+        context.requestUserId = result.requestUserId;
+        context.contextUserId = result.requestUserId;
+        context.requestUser = result.requestUser;
+        context.contextUser = result.contextUser;
+        context.requestId = req.headers['x-request-id'] || (0, crypto_1.randomUUID)();
+        context.ip = req.headers['cf-connecting-ip'] || req.ip;
+        context.os = req.headers.os;
+        context.platform = req.headers.platform;
+        context.version = req.headers.version;
+        context.request = req;
+        context.currencyCode = req.headers['x-currency-code'] || result.currency;
+        context.countryCode = req.headers['x-country-code'] || result.country;
+        context.locale = req.headers['x-locale-id'] || result.locale || 'en';
+        context.permissions = result.permissions.split(",") || [];
+        context.logger = new logger_1.Logger({
+            requestId: context.requestId,
+            requestClientId: context.requestClientId,
+            contextClientId: context.contextClientId,
+            userId: context.requestUserId,
+            ip: context.ip,
+            url: context.request.originalUrl,
+            requestSource: context.requestSource,
         });
+        //Deprecated fields
+        context.data = req.body;
+        context.userId = result.requestUserId;
+        context.clientId = result.requestClientId;
+        return context;
     }
-    hasPermission(permission) {
-        var _a;
-        return ((_a = this.permissions) === null || _a === void 0 ? void 0 : _a.includes(permission)) || false;
-    }
-    hasFeature(feature) {
-        var _a;
-        return ((_a = this.features) === null || _a === void 0 ? void 0 : _a.includes(feature)) || false;
-    }
-    getUserId() {
-        var _a, _b;
-        return ((_a = this === null || this === void 0 ? void 0 : this.contextUser) === null || _a === void 0 ? void 0 : _a.userId) || ((_b = this === null || this === void 0 ? void 0 : this.requestUser) === null || _b === void 0 ? void 0 : _b.userId) || (this === null || this === void 0 ? void 0 : this.userId) || '';
-    }
-    getRequestClientId() {
-        return this.requestClientId || this.clientId || '';
-    }
-    getContextClientId() {
-        return this.contextClientId || this.clientId || '';
+    clone() {
+        return _.cloneDeep(this);
     }
 }
 exports.ContextEntity = ContextEntity;

package/lib/types/context.entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.entity.js","sourceRoot":"","sources":["../../src/types/context.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAA4B;AAK5B,mCAAoC;AACpC,6CAA0C;AAE7B,QAAA,uBAAuB,GAAG,UAAU,CAAC;AAElD,MAAa,aAAa;IA8BxB;QACE,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,GAAoB;;QACrC,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,MAAgB,CAAC;QACrD,OAAO,CAAC,kBAAkB,GAAG,GAAG,CAAC,OAAO,CAAC,qBAAqB,CAAW,CAAC;QAC1E,OAAO,CAAC,QAAQ,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAW,CAAC;QAC5F,OAAO,CAAC,eAAe,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC;YACzD,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAW,CAAC;QACtC,OAAO,CAAC,eAAe,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC;YACzD,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAW,CAAC;QACtC,OAAO,CAAC,MAAM,GAAG,CAAA,MAAA,GAAG,CAAC,MAAM,0CAAE,MAAM,MAAI,MAAA,GAAG,CAAC,IAAI,0CAAE,MAAM,CAAA,KAAI,MAAA,GAAG,CAAC,KAAK,0CAAE,MAAM,CAAA,CAAC;QAC7E,OAAO,CAAC,SAAS,GAAI,GAAG,CAAC,OAAO,CAAC,cAAc,CAAY,IAAI,IAAA,mBAAU,GAAE,CAAC;QAC5E,OAAO,CAAC,EAAE,GAAI,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAY,IAAI,GAAG,CAAC,EAAE,CAAC;QACnE,OAAO,CAAC,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,EAAY,CAAC;QACtC,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,QAAkB,CAAC;QAClD,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,OAAiB,CAAC;QAChD,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;QACtB,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACxB,OAAO,CAAC,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAW,CAAC;QAChE,OAAO,CAAC,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAW,CAAC;QAC9D,OAAO,CAAC,MAAM,GAAI,GAAG,CAAC,OAAO,CAAC,aAAa,CAAY,IAAI,IAAI,CAAC;QAChE,OAAO,CAAC,WAAW,GAAG,CAAA,MAAC,GAAG,CAAC,OAAO,CAAC,WAAsB,0CAAE,KAAK,CAAC,GAAG,CAAC,KAAI,EAAE,CAAC;QAC5E,OAAO,CAAC,QAAQ,GAAG,CAAA,MAAC,GAAG,CAAC,OAAO,CAAC,QAAmB,0CAAE,KAAK,CAAC,GAAG,CAAC,KAAI,EAAE,CAAC;QACtE,OAAO,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC;YAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW;YAChC,aAAa,EAAE,OAAO,CAAC,aAAa;SACrC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,KAAK;QACH,OAAO,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IACD,WAAW;QACT,OAAO,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,CAAC;IAC9E,CAAC;IAED,mBAAmB;;QACjB,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC;YACvB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,GAAG,EAAE,MAAA,IAAI,CAAC,OAAO,0CAAE,WAAW;YAC9B,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC,CAAC;IACL,CAAC;IAED,aAAa,CAAC,UAAkB;;QAC9B,OAAO,CAAA,MAAA,IAAI,CAAC,WAAW,0CAAE,QAAQ,CAAC,UAAU,CAAC,KAAI,KAAK,CAAC;IACzD,CAAC;IAED,UAAU,CAAC,OAAe;;QACxB,OAAO,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,QAAQ,CAAC,OAAO,CAAC,KAAI,KAAK,CAAC;IACnD,CAAC;IACD,SAAS;;QACP,OAAO,CAAA,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,0CAAE,MAAM,MAAI,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,WAAW,0CAAE,MAAM,CAAA,KAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,CAAA,IAAI,EAAE,CAAC;IACtF,CAAC;IAED,kBAAkB;QAChB,OAAO,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;IACrD,CAAC;IACD,kBAAkB;QAChB,OAAO,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;IACrD,CAAC;CACF;AAvGD,sCAuGC"}
+{"version":3,"file":"context.entity.js","sourceRoot":"","sources":["../../src/types/context.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAA4B;AAK5B,mCAAoC;AACpC,6CAA0C;AAO7B,QAAA,uBAAuB,GAAG,UAAU,CAAC;AAElD,MAAa,aAAa;IA4BxB;QACE,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC,EAAE,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,GAAoB;;QACrC,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,MAAgB,CAAC;QACrD,OAAO,CAAC,kBAAkB,GAAG,GAAG,CAAC,OAAO,CAAC,qBAAqB,CAAW,CAAC;QAC1E,OAAO,CAAC,QAAQ,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAW,CAAC;QAC5F,OAAO,CAAC,eAAe,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC;YACzD,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAW,CAAC;QACtC,OAAO,CAAC,eAAe,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC;YACzD,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAW,CAAC;QACtC,OAAO,CAAC,MAAM,GAAG,CAAA,MAAA,GAAG,CAAC,MAAM,0CAAE,MAAM,MAAI,MAAA,GAAG,CAAC,IAAI,0CAAE,MAAM,CAAA,KAAI,MAAA,GAAG,CAAC,KAAK,0CAAE,MAAM,CAAA,CAAC;QAC7E,OAAO,CAAC,SAAS,GAAI,GAAG,CAAC,OAAO,CAAC,cAAc,CAAY,IAAI,IAAA,mBAAU,GAAE,CAAC;QAC5E,OAAO,CAAC,EAAE,GAAI,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAY,IAAI,GAAG,CAAC,EAAE,CAAC;QACnE,OAAO,CAAC,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,EAAY,CAAC;QACtC,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,QAAkB,CAAC;QAClD,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,OAAiB,CAAC;QAChD,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;QACtB,OAAO,CAAC,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAW,CAAC;QAChE,OAAO,CAAC,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAW,CAAC;QAC9D,OAAO,CAAC,MAAM,GAAI,GAAG,CAAC,OAAO,CAAC,aAAa,CAAY,IAAI,IAAI,CAAC;QAChE,OAAO,CAAC,WAAW,GAAG,CAAA,MAAC,GAAG,CAAC,OAAO,CAAC,WAAsB,0CAAE,KAAK,CAAC,GAAG,CAAC,KAAI,EAAE,CAAC;QAC5E,OAAO,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC;YAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW;YAChC,aAAa,EAAE,OAAO,CAAC,aAAa;SACrC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,MAAM,CAAC,uBAAuB,CAAC,GAAoB,EAAE,MAAqC;QACxF,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,MAAgB,CAAC;QACrD,OAAO,CAAC,kBAAkB,GAAG,MAAM,CAAC,kBAAkB,CAAC;QACvD,OAAO,CAAC,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;QACjD,OAAO,CAAC,eAAe,GAAI,MAAM,CAAC,eAAe,CAAC;QAClD,OAAO,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC7C,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QAEzC,OAAO,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAC7C,OAAO,CAAC,aAAa,GAAG,MAAM,CAAC,aAAa,CAAC;QAE7C,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QACzC,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;QAGzC,OAAO,CAAC,SAAS,GAAI,GAAG,CAAC,OAAO,CAAC,cAAc,CAAY,IAAI,IAAA,mBAAU,GAAE,CAAC;QAC5E,OAAO,CAAC,EAAE,GAAI,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAY,IAAI,GAAG,CAAC,EAAE,CAAC;QACnE,OAAO,CAAC,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,EAAY,CAAC;QACtC,OAAO,CAAC,QAAQ,GAAG,GAAG,CAAC,OAAO,CAAC,QAAkB,CAAC;QAClD,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,OAAiB,CAAC;QAChD,OAAO,CAAC,OAAO,GAAG,GAAG,CAAC;QACtB,OAAO,CAAC,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAW,IAAI,MAAM,CAAC,QAAQ,CAAC;QACnF,OAAO,CAAC,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAW,IAAI,MAAM,CAAC,OAAO,CAAC;QAChF,OAAO,CAAC,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAW,IAAI,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC;QAC/E,OAAO,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,CAAA;QACzD,OAAO,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC;YAC1B,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,MAAM,EAAE,OAAO,CAAC,aAAa;YAC7B,EAAE,EAAE,OAAO,CAAC,EAAE;YACd,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,WAAW;YAChC,aAAa,EAAE,OAAO,CAAC,aAAa;SACrC,CAAC,CAAC;QAEH,mBAAmB;QACnB,OAAO,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;QACxB,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC;QACtC,OAAO,CAAC,QAAQ,GAAG,MAAM,CAAC,eAAe,CAAC;QAE1C,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,KAAK;QACH,OAAO,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;CACF;AA7GD,sCA6GC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@6thbridge/utils",
-  "version": "0.3.9-0",
+  "version": "1.0.01",
   "description": "simple interface for the our commonly used functions",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/readme.md

@@ -1,79 +1,379 @@
-# bridge-utils
-
-bridge-utils - This is a utility package for reused component
+# @6thbridge/utils Documentation
+[](https://badge.fury.io/js/%406thbridge%2Futils)[](https://opensource.org/licenses/ISC)
+A comprehensive TypeScript utility library for Node.js applications, providing reusable components for common development tasks including database operations, caching, messaging, logging, and more.
+## Table of Contents
+- [Installation](#installation)
+- [Quick Start](#quick-start)
+- [Core Modules](#core-modules)
+- [API Reference](#api-reference)
+- [Examples](#examples)
+- [Testing](#testing)
+- [Contributing](#contributing)
+- [License](#license)
 
 ## Installation
+``` bash
+# Using npm
+npm install @6thbridge/utils
 
-```json
-"dependencies": {
-  "@6thbridge/utils": "^0.2.34" // see the "releases" section
-}
+# Using yarn
+yarn add @6thbridge/utils
 ```
+### Dependencies
+This package includes the following key dependencies:
+- **Database**: `mongoose`, , `ioredis` `mongoose-paginate-v2`
+- **Messaging**: `amqplib`, , `kafkajs` `amqp-connection-manager`
+- **Utilities**: `lodash`, `dayjs`, `joi`, `axios`
+- **Monitoring**: , `rollbar` `@opentelemetry/auto-instrumentations-node`
+
+## Quick Start
+``` typescript
+import { 
+  HelperUtil, 
+  ReferenceUtil, 
+  RedisClient, 
+  RabbitMQClient,
+  MongoDBRepository,
+  logger 
+} from '@6thbridge/utils';
 
-`npm install @6thbridge/utils`
+// Generate a reference
+const reference = ReferenceUtil.generateReference('production');
 
-## Requirements
+// Use Redis
+const redis = RedisClient.getInstance();
+await redis.connect({ url: 'redis://localhost:6379' });
 
-```javascript
-const utils = require('bridge-mix');
+// Clean data
+const cleanData = HelperUtil.removeFieldsWithEmptyValue(data);
+
+// Log information
+logger.info('Application started', { reference });
 ```
+## Core Modules
+### 🔧 [Utilities](./src/utils/README.md)
+Essential utility functions for data manipulation, reference generation, and common operations.
+- **HelperUtil**: Data cleaning, activity logging, async utilities
+- **ReferenceUtil**: Reference and UUID generation
+- **Phone Number Formatting**: International phone number formatting
 
-### Phone Number Formatter (Single)
+### 🗄️ [Database](./src/database/README.md)
+Database abstraction layers and repository patterns.
+- **MongoDBRepository**: MongoDB operations with Mongoose
+- **Redis Integration**: Caching and session management
 
-- To format a single phone number
+### 📨 [Brokers](./src/brokers/README.md)
+Message broker implementations for event-driven architecture.
+- **RabbitMQClient**: AMQP messaging with RabbitMQ
+- **KafkaJS Integration**: Apache Kafka message streaming
 
-```javascript
-let phoneNumber = '08012345678';
-phoneNumber = utils.helpers.formatPhoneNumber(phoneNumber, 'NG');
-console.log(phoneNumber); //2348012345678
+### 💾 [Cache](./src/cache/README.md)
+Caching solutions for improved performance.
+- **RedisClient**: Redis-based caching with clustering support
+- **Node-Cache**: In-memory caching for lightweight applications
+
+### 📝 [Logger](./src/logger/README.md)
+Comprehensive logging system with multiple levels and integrations.
+- **Structured Logging**: JSON-formatted logs
+- **Multiple Transports**: Console, file, and external service logging
+- **Error Tracking**: Integration with monitoring services
+
+### 🛡️ [Middlewares](./src/middlewares/README.md)
+Express.js middlewares for common functionality.
+- **Authentication**: JWT and API key validation
+- **Validation**: Request/response validation
+- **Error Handling**: Centralized error processing
+
+### 📊 [Monitoring](./src/monitoring/README.md)
+Application monitoring and observability tools.
+- **OpenTelemetry**: Distributed tracing
+- **Rollbar Integration**: Error monitoring and alerting
+
+## API Reference
+### HelperUtil
+``` typescript
+class HelperUtil {
+  // Async utility
+  static async sleep(durationInMs: number = 1000): Promise<void>
+  
+  // Data cleaning
+  static removeFieldsWithEmptyValue(value: any): any
+  
+  // Activity logging
+  static async saveActivityLog(activityLog: SaveActivityLogDTO, options?: any): Promise<void>
+}
+```
+### ReferenceUtil
+``` typescript
+class ReferenceUtil {
+  // Generate environment-specific reference
+  static generateReference(env: string): string
+  
+  // Generate reference with custom prefix
+  static generateReferenceWithPrefix(env: string, prefix: string): string
+  
+  // Generate UUID
+  static generateUUID(options?: any): string
+}
 ```
+### RedisClient
+``` typescript
+class RedisClient {
+  // Singleton pattern
+  static getInstance(): RedisClient
+  static resetInstance(): void
+  
+  // Connection management
+  connect(config?: RedisConnect): Commander
+  
+  // Redis operations
+  static getRedis(): Commander
+}
+```
+### RabbitMQClient
+``` typescript
+class RabbitMQClient {
+  // Singleton pattern
+  static getInstance(): RabbitMQClient
+  static resetInstance(): void
+  
+  // Connection and messaging
+  connect(config: RabbitMQConnectConfig): AmqpConnectionManager
+  static async sendToQueue(queueName: string, payload: any, options?: PublishOptions): Promise<any>
+  static async publishToExchange(exchangeName: string, routeKey: string, payload: any, options?: PublishOptions): Promise<any>
+  
+  // Message consumption
+  static listen(queueName: string, options: any, callback: Function): Promise<void>
+}
+```
+### MongoDBRepository
+``` typescript
+class MongoDBRepository {
+  constructor(Model: TypedModel<any>)
+  
+  // CRUD operations
+  create(payload: Record<string, any>, options?: CreateOptions): Promise<any>
+  findById(id: string, projection?: ProjectionType<any>, options?: QueryOptions): Promise<any>
+  findOne(condition: Record<string, any>, sort?: Record<string, number>, options?: FindOptions): Promise<any>
+  find(condition: Record<string, any>, sort?: Record<string, any>, options?: FindOptions): Promise<any>
+  
+  // Advanced operations
+  paginate(condition: Record<string, any>, sort?: Record<string, any>, options?: FindOptions): Promise<PaginateResult<any>>
+  updateOne(query: Record<string, any>, update: Record<string, any>, options?: MongooseOptions): Promise<any>
+  bulkWrite(bulkWritePayload: any): Promise<any>
+}
+```
+## Examples
+### Basic Usage Examples
+#### Data Cleaning
+``` typescript
+import { HelperUtil } from '@6thbridge/utils';
 
-### Phone Number Formatter (Multiple)
+const dirtyData = {
+  name: 'John Doe',
+  email: '',
+  phone: null,
+  address: undefined,
+  age: 30
+};
+
+const cleanData = HelperUtil.removeFieldsWithEmptyValue(dirtyData);
+// Result: { name: 'John Doe', age: 30 }
+```
+#### Reference Generation
+``` typescript
+import { ReferenceUtil } from '@6thbridge/utils';
+
+// Production reference
+const prodRef = ReferenceUtil.generateReference('production');
+// Example: L20240101120000ABCDE
+
+// Development reference with prefix
+const devRef = ReferenceUtil.generateReferenceWithPrefix('development', 'ORDER');
+// Example: DORDER20240101120000ABCDE
+```
+#### Redis Operations
+``` typescript
+import { RedisClient } from '@6thbridge/utils';
 
-- To format an array of phone numbers
+async function cacheExample() {
+  const redis = RedisClient.getInstance();
+  redis.connect({
+    url: 'redis://localhost:6379',
+    keepAlive: true
+  });
 
-```javascript
+  // Cache operations
+  await RedisClient.getRedis().set('user:123', JSON.stringify({ name: 'John' }));
+  const user = await RedisClient.getRedis().get('user:123');
+}
+```
+#### Message Queue
+``` typescript
+import { RabbitMQClient } from '@6thbridge/utils';
+
+async function messagingExample() {
+  const broker = RabbitMQClient.getInstance();
+  broker.connect({
+    url: 'amqp://localhost:5672',
+    queues: [
+      { queueName: 'user.created' }
+    ],
+    exchanges: [],
+    exchangeBindings: []
+  });
+
+  // Send message
+  await RabbitMQClient.sendToQueue('user.created', {
+    userId: '123',
+    event: 'USER_CREATED',
+    timestamp: new Date()
+  });
+
+  // Listen for messages
+  RabbitMQClient.listen('user.created', {}, (message, options) => {
+    console.log('Received:', JSON.parse(message));
+    options.ack();
+  });
+}
+```
+### Phone Number Formatting
+``` typescript
+import { formatPhoneNumber, formatPhoneNumberArray } from '@6thbridge/utils';
+
+// Single phone number
+let phoneNumber = '08012345678';
+phoneNumber = formatPhoneNumber(phoneNumber, 'NG');
+console.log(phoneNumber); // 2348012345678
+
+// Multiple phone numbers
 let phoneNumbers = ['08012345678', '08012345679'];
-phoneNumbers = utils.helpers.formatPhoneNumberArray(phoneNumbers, 'NG');
-console.log(phoneNumbers); //['2348012345678','2348012345679']
+phoneNumbers = formatPhoneNumberArray(phoneNumbers, 'NG');
+console.log(phoneNumbers); // ['2348012345678', '2348012345679']
 ```
+### Logging
+``` typescript
+import { logger } from '@6thbridge/utils';
 
-### Remove Empty Fields from Data
+// Different log levels
+logger.error('Database connection failed', { error: 'Connection refused' });
+logger.warn('High memory usage detected', { usage: '85%' });
+logger.info('User logged in', { userId: '123' });
+logger.debug('Processing request', { requestId: 'req-456' });
 
-- To format an array of phone numbers
+// Exception logging
+try {
+  // risky operation
+} catch (error) {
+  logger.exception(error, { context: 'user-registration' });
+}
+```
+## Environment Variables
+The library supports various environment variables for configuration:
+``` bash
+# Redis Configuration
+REDIS_HOST=127.0.0.1
+REDIS_PORT=6379
+REDIS_PASSWORD=your_password
+REDIS_URL=redis://localhost:6379
+REDIS_CLUSTER_URL=redis://node1:6379,redis://node2:6379
 
-```javascript
-let data = {
-  foo: '',
-  bar: 'value',
-};
-data = utils.helpers.removeFieldsWithEmptyValue(data);
-console.log(data); //{"bar":"value"}
+# RabbitMQ Configuration
+RABBITMQ_URL=amqp://localhost:5672
+RABBITMQ_CLUSTER_URL=amqp://node1:5672,amqp://node2:5672
+
+# Application Configuration
+APP_NAME=your-app-name
+TZ=Africa/Lagos
+LOG_OUT=1
+
+# Service URLs
+USER_SERVICE_URL=http://user-service:3000
 ```
+## Testing
+The library includes comprehensive test suites using Jest:
+``` bash
+# Run all tests
+yarn test
 
-### Logger
+# Run tests in watch mode
+yarn test --watch
 
-- Log data
+# Run tests with coverage
+yarn test --coverage
 
-```javascript
-logger.error('This is an error from the package', { foo: 'bar' }, new Error().stack);
-logger.warn('This is an warning message from the package', { foo: 'bar' }, new Error().stack);
-logger.debug('This is an debug message from the package', { foo: 'bar' }, new Error().stack);
-logger.critical('This is a critical message from the package', { foo: 'bar' }, new Error().stack);
-logger.info('This is a info message from the package', { foo: 'bar' }, new Error().stack);
-logger.exception(new Error('Custom Error'), { foo: 'bar' }, new Error().stack);
-logger.out(new Error('Custom Error'), { foo: 'bar' }, new Error().stack); //to console, only logs out when LOG_OUT=1
+# Run specific test file
+yarn test reference.util.test.ts
 ```
+### Writing Tests
+``` typescript
+import { ReferenceUtil } from '@6thbridge/utils';
 
-### Tests
+describe('ReferenceUtil', () => {
+  it('should generate production reference', () => {
+    const ref = ReferenceUtil.generateReference('production');
+    expect(ref).toMatch(/^L\d{14}[A-Z]{5}$/);
+  });
+});
+```
+## TypeScript Support
+This library is written in TypeScript and provides full type definitions:
+``` typescript
+import { 
+  RedisConnect, 
+  RabbitMQConnectConfig, 
+  SaveActivityLogDTO,
+  MongooseOptions 
+} from '@6thbridge/utils';
 
-#### Cli
+// Type-safe configuration
+const redisConfig: RedisConnect = {
+  url: 'redis://localhost:6379',
+  keepAlive: true,
+  heartbeat: 30
+};
+```
+## Performance Considerations
+- **Connection Pooling**: Redis and RabbitMQ clients use connection pooling
+- **Singleton Pattern**: Database and cache clients follow singleton pattern
+- **Lazy Loading**: Connections are established only when needed
+- **Memory Management**: Proper cleanup and connection closing
 
-```bash
-npm install
-npm test
+## Error Handling
+The library implements comprehensive error handling:
+``` typescript
+try {
+  await RedisClient.getRedis().set('key', 'value');
+} catch (error) {
+  logger.exception(error, { operation: 'redis-set' });
+}
 ```
+## Contributing
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+### Development Setup
+``` bash
+# Clone repository
+git clone https://github.com/6thbridge/utils.git
+
+# Install dependencies
+yarn install
 
-#### Contributors
+# Run tests
+yarn test
 
+# Build library
+yarn build
+```
+## License
+This project is licensed under the ISC License.
+## Contributors
 - [Micheal Akinwonmi](https://github.com/blackhades)
+
+## Support
+For support and questions, please open an issue on the GitHub repository.
+**Note**: This library is actively maintained and used in production environments. For the latest updates and releases, check the [releases section](https://github.com/6thbridge/utils/releases).

package/lib/brokers/index.d.ts

@@ -1,5 +0,0 @@
-import { RabbitMQ, RabbitMQInit } from './rabbitmq';
-export interface MessageBrokerInterface {
-    init(config: any): Promise<MessageBrokerInterface>;
-}
-export { RabbitMQInit, RabbitMQ };

package/lib/brokers/index.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RabbitMQ = void 0;
-const rabbitmq_1 = require("./rabbitmq");
-Object.defineProperty(exports, "RabbitMQ", { enumerable: true, get: function () { return rabbitmq_1.RabbitMQ; } });
-//# sourceMappingURL=index.js.map