@6thbridge/utils 0.1.16

package/lib/types/context.entity.js

@@ -0,0 +1,105 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContextEntity = exports.INTERNAL_REQUEST_SOURCE = void 0;
+const _ = __importStar(require("lodash"));
+const crypto_1 = require("crypto");
+const logger_1 = require("../logger/logger");
+exports.INTERNAL_REQUEST_SOURCE = "internal";
+class ContextEntity {
+    constructor() {
+        this.logger = new logger_1.Logger({});
+    }
+    static fromRequest(req) {
+        var _a, _b, _c, _d, _e;
+        const context = new ContextEntity();
+        context.requestSource = req.headers.source;
+        context.authenticationType = (req.headers["authentication-type"]);
+        context.clientId = (req.headers["client-id"] || req.headers["request-client-id"]);
+        context.requestClientId = (req.headers["request-client-id"] || req.headers["client-id"]);
+        context.contextClientId = (req.headers["context-client-id"] || req.headers["client-id"]);
+        context.userId = ((_a = req.params) === null || _a === void 0 ? void 0 : _a.userId) || ((_b = req.body) === null || _b === void 0 ? void 0 : _b.userId) || ((_c = req.query) === null || _c === void 0 ? void 0 : _c.userId);
+        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.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,
+            contextClientId: context.contextClientId,
+            userId: context.userId,
+            ip: context.ip,
+            url: context.request.originalUrl,
+            requestSource: context.requestSource
+        });
+        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
+        });
+    }
+    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 || "";
+    }
+}
+exports.ContextEntity = ContextEntity;
+//# sourceMappingURL=context.entity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"context.entity.js","sourceRoot":"","sources":["../../src/types/context.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,0CAA4B;AAK5B,mCAAkC;AAClC,6CAAwC;AAE3B,QAAA,uBAAuB,GAAG,UAAU,CAAC;AAElD,MAAa,aAAa;IA4BtB;QACI,IAAI,CAAC,MAAM,GAAI,IAAI,eAAM,CAAC,EAAE,CAAC,CAAC;IAClC,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,GAAoB;;QACnC,MAAM,OAAO,GAAG,IAAI,aAAa,EAAE,CAAC;QACpC,OAAO,CAAC,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,MAAgB,CAAC;QACrD,OAAO,CAAC,kBAAkB,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAW,CAAC;QAC5E,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,IAAI,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAW,CAAC;QACnG,OAAO,CAAC,eAAe,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,mBAAmB,CAAC,IAAI,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAW,CAAC;QACnG,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,GAAG,GAAG,CAAC,OAAO,CAAC,cAAc,CAAW,IAAI,IAAA,mBAAU,GAAE,CAAC;QAC1E,OAAO,CAAC,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAW,IAAI,GAAG,CAAC,EAAE,CAAC;QACjE,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,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAW,IAAI,IAAI,CAAA;QAC7D,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;YACxB,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;SACvC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACnB,CAAC;IACD,KAAK;QACD,OAAO,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IACD,WAAW;QACP,OAAO,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,CAAC;IAChF,CAAC;IAED,mBAAmB;;QACf,IAAI,CAAC,MAAM,GAAG,IAAI,eAAM,CAAC;YACrB,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;SACpC,CAAC,CAAC;IACP,CAAC;IAED,aAAa,CAAC,UAAkB;;QAC5B,OAAO,CAAA,MAAA,IAAI,CAAC,WAAW,0CAAE,QAAQ,CAAC,UAAU,CAAC,KAAI,KAAK,CAAC;IAC3D,CAAC;IAED,UAAU,CAAC,OAAe;;QACtB,OAAO,CAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,QAAQ,CAAC,OAAO,CAAC,KAAI,KAAK,CAAC;IACrD,CAAC;IACD,SAAS;;QACL,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;IACxF,CAAC;IAED,kBAAkB;QACd,OAAO,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;IACvD,CAAC;IACD,kBAAkB;QACd,OAAO,IAAI,CAAC,eAAe,IAAI,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;IACvD,CAAC;CACJ;AAnGD,sCAmGC"}

package/lib/types/index.d.ts

@@ -0,0 +1,82 @@
+import { ContextEntity, INTERNAL_REQUEST_SOURCE } from "./context.entity";
+import { RequestUserEntity, UserEntity } from "./user.entity";
+import { ClientEntity, RequestClientEntity } from "./client.entity";
+import { BrokerDeadLetterPayloadEntity, BrokerRetryEntity } from "./broker.entity";
+import { LoggerInterface } from "../logger";
+import { OkResponse, ErrorResponse } from "../responses/express";
+declare module "axios" {
+    interface InternalAxiosRequestConfig {
+        meta: any;
+    }
+}
+type SaveActivityLogDTO = {
+    clientId: string;
+    userId: string;
+    service?: string;
+    reference?: string;
+    event: string;
+    timestamp: number;
+    message: string;
+    data: any;
+};
+declare class FunctionResponseDTO<T> {
+    error?: string;
+    statusCode?: number;
+    data?: T;
+    [x: string]: any;
+}
+declare enum TransactionChargeBearer {
+    merchant = "merchant",
+    customer = "customer"
+}
+declare class TransactionCharge {
+    chargeBearer?: TransactionChargeBearer;
+    platform?: {
+        percentage: number;
+        fixed: number;
+    };
+    provider?: {
+        percentage: number;
+        fixed: number;
+    };
+    tax?: {
+        percentage: number;
+        fixed: number;
+    };
+    cap?: {
+        minimum: number;
+        maximum: number;
+    };
+    custom?: {
+        percentage: number;
+        fixed: number;
+    };
+    VATOnChargeAndFees?: number;
+    providerPercentageFee?: number;
+    providerFixedFee?: number;
+    percentageAmount?: number;
+    fixedAmount?: number;
+    minimumCap?: number;
+    maximumCap?: number;
+    fixedTax?: number;
+    percentageTax?: number;
+    platformFixedAmount?: number;
+    platformPercentageAmount?: number;
+    chargeAmount?: number;
+    chargeType?: string;
+    [x: string]: any;
+}
+interface TransactionFee {
+    charge: number;
+    provider: number;
+    platform: number;
+    custom: number;
+    tax: number;
+    VAT: number;
+    cap?: number;
+    extra?: number;
+    total: number;
+    [x: string]: any;
+}
+export { INTERNAL_REQUEST_SOURCE, ContextEntity, RequestUserEntity, RequestClientEntity, SaveActivityLogDTO, ClientEntity, UserEntity, FunctionResponseDTO, BrokerRetryEntity, BrokerDeadLetterPayloadEntity, LoggerInterface, TransactionCharge, TransactionChargeBearer, TransactionFee, OkResponse, ErrorResponse, };
+export { CountryCode } from "libphonenumber-js";

package/lib/types/index.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionChargeBearer = exports.TransactionCharge = exports.BrokerDeadLetterPayloadEntity = exports.BrokerRetryEntity = exports.FunctionResponseDTO = exports.UserEntity = exports.ClientEntity = exports.RequestUserEntity = exports.ContextEntity = exports.INTERNAL_REQUEST_SOURCE = void 0;
+const context_entity_1 = require("./context.entity");
+Object.defineProperty(exports, "ContextEntity", { enumerable: true, get: function () { return context_entity_1.ContextEntity; } });
+Object.defineProperty(exports, "INTERNAL_REQUEST_SOURCE", { enumerable: true, get: function () { return context_entity_1.INTERNAL_REQUEST_SOURCE; } });
+const user_entity_1 = require("./user.entity");
+Object.defineProperty(exports, "RequestUserEntity", { enumerable: true, get: function () { return user_entity_1.RequestUserEntity; } });
+Object.defineProperty(exports, "UserEntity", { enumerable: true, get: function () { return user_entity_1.UserEntity; } });
+const client_entity_1 = require("./client.entity");
+Object.defineProperty(exports, "ClientEntity", { enumerable: true, get: function () { return client_entity_1.ClientEntity; } });
+const broker_entity_1 = require("./broker.entity");
+Object.defineProperty(exports, "BrokerDeadLetterPayloadEntity", { enumerable: true, get: function () { return broker_entity_1.BrokerDeadLetterPayloadEntity; } });
+Object.defineProperty(exports, "BrokerRetryEntity", { enumerable: true, get: function () { return broker_entity_1.BrokerRetryEntity; } });
+class FunctionResponseDTO {
+}
+exports.FunctionResponseDTO = FunctionResponseDTO;
+var TransactionChargeBearer;
+(function (TransactionChargeBearer) {
+    TransactionChargeBearer["merchant"] = "merchant";
+    TransactionChargeBearer["customer"] = "customer";
+})(TransactionChargeBearer || (exports.TransactionChargeBearer = TransactionChargeBearer = {}));
+class TransactionCharge {
+    constructor() {
+        this.VATOnChargeAndFees = 0; //in percentage
+        this.providerPercentageFee = 0;
+        this.percentageAmount = 0; //deprecated
+        this.fixedAmount = 0; //deprecated
+        this.minimumCap = 0;
+        this.maximumCap = 0;
+        this.fixedTax = 0;
+        this.percentageTax = 0;
+        this.platformFixedAmount = 0;
+        this.platformPercentageAmount = 0;
+    }
+}
+exports.TransactionCharge = TransactionCharge;
+//# sourceMappingURL=index.js.map

package/lib/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;AAAA,qDAAwE;AA+EpE,8FA/EI,8BAAa,OA+EJ;AADb,wGA9EmB,wCAAuB,OA8EnB;AA7E3B,+CAA4D;AA+ExD,kGA/EI,+BAAiB,OA+EJ;AAIjB,2FAnFuB,wBAAU,OAmFvB;AAlFd,mDAAkE;AAiF9D,6FAjFI,4BAAY,OAiFJ;AAhFhB,mDAAiF;AAoF7E,8GApFI,6CAA6B,OAoFJ;AAD7B,kGAnFmC,iCAAiB,OAmFnC;AA/DrB,MAAM,mBAAmB;CAKxB;AAyDG,kDAAmB;AAvDvB,IAAK,uBAGJ;AAHD,WAAK,uBAAuB;IACxB,gDAAqB,CAAA;IACrB,gDAAqB,CAAA;AACzB,CAAC,EAHI,uBAAuB,uCAAvB,uBAAuB,QAG3B;AAED,MAAM,iBAAiB;IAAvB;QAOI,uBAAkB,GAAY,CAAC,CAAA,CAAC,eAAe;QAG/C,0BAAqB,GAAY,CAAC,CAAA;QAElC,qBAAgB,GAAY,CAAC,CAAA,CAAC,YAAY;QAC1C,gBAAW,GAAY,CAAC,CAAA,CAAC,YAAY;QACrC,eAAU,GAAY,CAAC,CAAA;QACvB,eAAU,GAAY,CAAC,CAAA;QACvB,aAAQ,GAAY,CAAC,CAAA;QACrB,kBAAa,GAAY,CAAC,CAAA;QAC1B,wBAAmB,GAAY,CAAC,CAAA;QAChC,6BAAwB,GAAY,CAAC,CAAA;IAOzC,CAAC;CAAA;AA4BG,8CAAiB"}

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

@@ -0,0 +1,28 @@
+export declare class RequestUserEntity {
+    id: string;
+    clientId: string;
+    userId: string;
+    firstName?: string;
+    lastName?: string;
+    name: string;
+    email: string;
+    phoneNumber: string;
+    [key: string]: any;
+}
+export declare enum UserType {
+    user = "user",
+    customer = "customer"
+}
+export declare class UserEntity {
+    id: string;
+    type: UserType;
+    clientId: string;
+    userId: string;
+    firstName?: string;
+    lastName?: string;
+    name?: string;
+    email: string;
+    phoneNumber: string;
+    isInternalAdmin?: boolean;
+    [key: string]: any;
+}

package/lib/types/user.entity.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserEntity = exports.UserType = exports.RequestUserEntity = void 0;
+class RequestUserEntity {
+}
+exports.RequestUserEntity = RequestUserEntity;
+var UserType;
+(function (UserType) {
+    UserType["user"] = "user";
+    UserType["customer"] = "customer";
+})(UserType || (exports.UserType = UserType = {}));
+class UserEntity {
+    constructor() {
+        this.isInternalAdmin = false;
+    }
+}
+exports.UserEntity = UserEntity;
+//# sourceMappingURL=user.entity.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"user.entity.js","sourceRoot":"","sources":["../../src/types/user.entity.ts"],"names":[],"mappings":";;;AACA,MAAa,iBAAiB;CAU7B;AAVD,8CAUC;AAGD,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,yBAAa,CAAA;IACb,iCAAqB,CAAA;AACvB,CAAC,EAHW,QAAQ,wBAAR,QAAQ,QAGnB;AAGD,MAAa,UAAU;IAAvB;QAUE,oBAAe,GAAa,KAAK,CAAC;IAEpC,CAAC;CAAA;AAZD,gCAYC"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@6thbridge/utils",
+  "version": "0.1.16",
+  "description": "simple interface for the our commonly used functions",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "test": "jest --verbose -c jest.config.js",
+    "build": "tsc -p tsconfig.json",
+    "prepare": "npm run build",
+    "version": "npm run format && git add -A src",
+    "postversion": "git push && git push --tags"
+  },
+  "author": {
+    "name": "Micheal Akinwonmi",
+    "email": "michealakinwonmi@gmail.com"
+  },
+  "license": "ISC",
+  "dependencies": {
+    "@aws-sdk/client-secrets-manager": "^3.504.0",
+    "amqp-connection-manager": "^4.1.14",
+    "amqplib": "^0.10.3",
+    "apitoolkit-express": "^2.2.4",
+    "axios": "^1.6.7",
+    "bignumber.js": "^9.1.2",
+    "dayjs": "^1.11.10",
+    "ioredis": "^5.3.2",
+    "joi": "^17.12.2",
+    "kafkajs": "^2.2.4",
+    "libphonenumber-js": "^1.10.57",
+    "lodash": "^4.17.21",
+    "mongoose-paginate-v2": "^1.8.0",
+    "node-cache": "^5.1.2",
+    "path-to-regexp": "^6.2.2",
+    "randomstring": "^1.3.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.13",
+    "@types/jest": "^29.5.12",
+    "@types/lodash": "^4.14.184",
+    "@types/randomstring": "^1.1.8",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.4.3"
+  },
+  "engines": {
+    "node": ">=14"
+  }
+}

package/readme.md

@@ -0,0 +1,66 @@
+bridge-utils
+===========
+bridge-utils - This is a utility package for reused component
+
+## Installation
+```json
+"dependencies": {
+  "@6thbridge/utils": "^0.1.17" // see the "releases" section
+}
+```
+```npm install @6thbridge/utils```
+## Requirements
+```javascript
+const utils = require('bridge-mix');
+```
+
+### Phone Number Formatter (Single)
+- To format a single phone number
+```javascript
+let phoneNumber = "08012345678";
+phoneNumber = utils.helpers.formatPhoneNumber(phoneNumber, "NG");
+console.log(phoneNumber); //2348012345678
+```
+
+### Phone Number Formatter (Multiple)
+- To format an array of phone numbers
+```javascript
+let phoneNumbers = ["08012345678", "08012345679"];
+phoneNumbers = utils.helpers.formatPhoneNumberArray(phoneNumbers, "NG");
+console.log(phoneNumbers); //['2348012345678','2348012345679']
+```
+
+### Remove Empty Fields from Data
+- To format an array of phone numbers
+```javascript
+let data = {
+    "foo": "",
+    "bar": "value"
+};
+data = utils.helpers.removeFieldsWithEmptyValue(data);
+console.log(data); //{"bar":"value"}
+```
+
+### Logger
+- Log data
+```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
+
+```
+
+### Tests
+#### Cli
+```bash
+npm install
+npm test
+```
+
+#### Contributors
+
+- [Micheal Akinwonmi](https://github.com/blackhades)