@konplit-services/common 1.0.126 → 1.0.131

package/build/helper/date-processing.d.ts

@@ -0,0 +1,6 @@
+import { PLAN_INTERVAL } from "./plan-types";
+export declare const formatDate: (dataString: string) => string;
+export declare const formatDateTime: (dataString: string) => string;
+declare type PlanInterval = keyof typeof PLAN_INTERVAL;
+export declare const getDuration: (duration: PlanInterval) => number;
+export {};

package/build/helper/date-processing.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDuration = exports.formatDateTime = exports.formatDate = void 0;
+const dayjs_1 = __importDefault(require("dayjs"));
+const plan_types_1 = require("./plan-types");
+const formatDate = (dataString) => {
+    return (0, dayjs_1.default)(dataString).format("YYYY-MM-DD");
+};
+exports.formatDate = formatDate;
+const formatDateTime = (dataString) => {
+    return (0, dayjs_1.default)(dataString).format("YYYY-MM-DD HH:mm:ss");
+};
+exports.formatDateTime = formatDateTime;
+const getDuration = (duration) => {
+    const currentDate = (0, dayjs_1.default)();
+    switch (duration) {
+        case plan_types_1.PLAN_INTERVAL.HOURLY:
+            const newDurationHourly = currentDate.add(2, "hour").valueOf();
+            return newDurationHourly;
+        case plan_types_1.PLAN_INTERVAL.DAILY:
+            const newDurationDaily = currentDate.add(1, "day").valueOf();
+            return newDurationDaily;
+        case plan_types_1.PLAN_INTERVAL.WEEKLY:
+            const newDurationWeekly = currentDate.add(1, "week").valueOf();
+            return newDurationWeekly;
+        case plan_types_1.PLAN_INTERVAL.MONTHLY:
+            const newDurationMonthly = currentDate.add(1, "month").valueOf();
+            return newDurationMonthly;
+        case plan_types_1.PLAN_INTERVAL.QUARTERLY:
+            const newDurationQuarterly = currentDate.add(3, "month").valueOf();
+            return newDurationQuarterly;
+        case plan_types_1.PLAN_INTERVAL["6MONTHS"]:
+            const newDuration6Months = currentDate.add(6, "month").valueOf();
+            return newDuration6Months;
+        case plan_types_1.PLAN_INTERVAL.YEARLY:
+            const newDurationYearly = currentDate.add(1, "year").valueOf();
+            return newDurationYearly;
+        default:
+            throw new Error("Invalid duration");
+    }
+};
+exports.getDuration = getDuration;

package/build/helper/index.d.ts

@@ -39,3 +39,6 @@ export * from "./api-config-types";
 export * from "./settings-types";
 export * from "./business-types";
 export * from "./card-validate";
+export * from "./date-processing";
+export * from "./timestamp";
+export * from "./keys";

package/build/helper/index.js

@@ -55,3 +55,6 @@ __exportStar(require("./api-config-types"), exports);
 __exportStar(require("./settings-types"), exports);
 __exportStar(require("./business-types"), exports);
 __exportStar(require("./card-validate"), exports);
+__exportStar(require("./date-processing"), exports);
+__exportStar(require("./timestamp"), exports);
+__exportStar(require("./keys"), exports);

package/build/helper/keys.d.ts

@@ -0,0 +1,70 @@
+/// <reference types="node" />
+/**
+ * Hashing a secret using sha256
+ * @param secret - the secret to hash
+ * @returns hashed secret
+ */
+declare const hashingKey: (secret: string) => Buffer;
+/**
+ * Generates an MD5 signature from the provided data
+ * @param data - the data to sign
+ * @returns MD5 hash of the data
+ */
+declare const generateSignMD5: (data: Record<string, string>) => string;
+/**
+ * Generates an MD5 signature for Fidelity transactions
+ * @param request_ref - the request reference
+ * @param client_secret - the client secret
+ * @returns MD5 hash of the data
+ */
+declare const generateSignMD5Fedilty: (request_ref: string, client_secret: string) => string;
+/**
+ * Generates the signature cipher for a request
+ * @param httpMethod - the request method (e.g., GET, POST)
+ * @param url - the request URL
+ * @param timestamp - the timestamp of the request
+ * @param nonce - unique ID
+ * @param clientId - the client ID
+ * @param clientSecret - the client secret
+ * @param amount - the amount to be charged
+ * @param authData - the card auth data
+ * @returns the generated signature cipher string
+ */
+declare const generateSignatureCipher: (httpMethod: string, url: string, timestamp: string, nonce: string, clientId: string, clientSecret: string, amount?: string, authData?: string) => string;
+/**
+ * Generates authentication data by encrypting card information using RSA
+ * @param options - card details and public key modulus and exponent
+ * @returns encrypted authentication data in Base64
+ */
+declare const authData: (options: {
+    card: string;
+    pin: string;
+    exp: string;
+    cvv: string;
+    publicKeyModulus: string;
+    publicKeyExponent: string;
+}) => string;
+/**
+ * Generates a unique order ID based on the current year and month
+ * @returns the generated order ID
+ */
+declare const generateOrderId: () => string;
+/**
+ * Generates a unique transaction ID
+ * @param clientCode - the client code
+ * @returns the generated transaction ID
+ */
+declare const generateTransactionID: (clientCode: string) => string;
+/**
+ * Generates a Base64-encoded key from client ID and secret key
+ * @param client_id - the client ID
+ * @param secret_key - the secret key
+ * @returns Base64 encoded key
+ */
+declare const generateBase64Key: (client_id: string, secret_key: string) => string;
+/**
+ * Generates a Base64-encoded key for BVN using NIBSS details
+ * @returns Base64 encoded key for BVN
+ */
+declare const generateBase64KeyNibssBVN: () => string;
+export { hashingKey, generateSignMD5, generateSignMD5Fedilty, authData, generateOrderId, generateBase64Key, generateSignatureCipher, generateBase64KeyNibssBVN, generateTransactionID, };

package/build/helper/keys.js

@@ -0,0 +1,178 @@
+"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.generateTransactionID = exports.generateBase64KeyNibssBVN = exports.generateSignatureCipher = exports.generateBase64Key = exports.generateOrderId = exports.authData = exports.generateSignMD5Fedilty = exports.generateSignMD5 = exports.hashingKey = void 0;
+const crypto = __importStar(require("crypto"));
+const forge = __importStar(require("node-forge"));
+const timestamp_1 = require("./timestamp");
+const util_1 = require("../util");
+const app_configs_1 = require("../app.configs");
+/**
+ * Hashing a secret using sha256
+ * @param secret - the secret to hash
+ * @returns hashed secret
+ */
+const hashingKey = (secret) => {
+    return crypto.createHash("sha256").update(secret).digest();
+};
+exports.hashingKey = hashingKey;
+/**
+ * Converts a card string to its hexadecimal representation
+ * @param card_string - the card string
+ * @throws Error if the card string is invalid
+ * @returns the hexadecimal representation of the card string
+ */
+const toHex = (card_string) => {
+    if (typeof card_string !== "string") {
+        throw new Error("Invalid card string");
+    }
+    return Array.from(card_string)
+        .map((char) => char.charCodeAt(0).toString(16))
+        .join("");
+};
+/**
+ * Generates an MD5 signature from the provided data
+ * @param data - the data to sign
+ * @returns MD5 hash of the data
+ */
+const generateSignMD5 = (data) => {
+    const { nqrApiKey } = app_configs_1.appConfigs.getNIBSSDetails().nqrCode;
+    const keys = Object.keys(data).sort();
+    let signStrtemp = "";
+    keys.forEach((element, index) => {
+        if (index === 0) {
+            signStrtemp += `${element}=${data[element]}`;
+        }
+        else {
+            signStrtemp += `&${element}=${data[element]}`;
+        }
+    });
+    signStrtemp += nqrApiKey;
+    const hash = crypto.createHash("md5").update(signStrtemp).digest("hex");
+    return hash.toUpperCase();
+};
+exports.generateSignMD5 = generateSignMD5;
+/**
+ * Generates an MD5 signature for Fidelity transactions
+ * @param request_ref - the request reference
+ * @param client_secret - the client secret
+ * @returns MD5 hash of the data
+ */
+const generateSignMD5Fedilty = (request_ref, client_secret) => {
+    const dataform = `${request_ref};${client_secret}`;
+    return crypto.createHash("md5").update(dataform).digest("hex");
+};
+exports.generateSignMD5Fedilty = generateSignMD5Fedilty;
+/**
+ * Generates the signature cipher for a request
+ * @param httpMethod - the request method (e.g., GET, POST)
+ * @param url - the request URL
+ * @param timestamp - the timestamp of the request
+ * @param nonce - unique ID
+ * @param clientId - the client ID
+ * @param clientSecret - the client secret
+ * @param amount - the amount to be charged
+ * @param authData - the card auth data
+ * @returns the generated signature cipher string
+ */
+const generateSignatureCipher = (httpMethod, url, timestamp, nonce, clientId, clientSecret, amount, authData) => {
+    let signatureCipher = `${httpMethod}&${url}&${timestamp}&${nonce}&${clientId}&${clientSecret}`;
+    if (amount !== undefined && amount !== null) {
+        signatureCipher += `&${amount}`;
+    }
+    if (authData !== undefined && authData !== null) {
+        signatureCipher += `&${authData}`;
+    }
+    return signatureCipher;
+};
+exports.generateSignatureCipher = generateSignatureCipher;
+/**
+ * Generates authentication data by encrypting card information using RSA
+ * @param options - card details and public key modulus and exponent
+ * @returns encrypted authentication data in Base64
+ */
+const authData = (options) => {
+    const authString = `1Z${options.card}Z${options.pin}Z${options.exp}Z${options.cvv}`;
+    const vv = toHex(authString);
+    const authDataBytes = forge.util.hexToBytes(vv);
+    const clearSecureBytes = forge.util.createBuffer();
+    const { rsa } = forge.pki;
+    const modulos = new forge.jsbn.BigInteger(options.publicKeyModulus, 16);
+    const exp = new forge.jsbn.BigInteger(options.publicKeyExponent, 16);
+    const publicKey = rsa.setPublicKey(modulos, exp);
+    clearSecureBytes.putBytes(authDataBytes);
+    const vvvv = clearSecureBytes.getBytes();
+    const authBytes = publicKey.encrypt(vvvv);
+    return forge.util.encode64(authBytes);
+};
+exports.authData = authData;
+/**
+ * Generates a unique order ID based on the current year and month
+ * @returns the generated order ID
+ */
+const generateOrderId = () => {
+    const yyyymm = (0, timestamp_1.getYearMonth)();
+    const id = (0, util_1.uniqueId)("abcdefkpvlxnm0123456789", 24);
+    return `${yyyymm}${id}`;
+};
+exports.generateOrderId = generateOrderId;
+/**
+ * Generates a unique transaction ID
+ * @param clientCode - the client code
+ * @returns the generated transaction ID
+ */
+const generateTransactionID = (clientCode) => {
+    const now = new Date();
+    const year = now.getFullYear().toString().slice(-2);
+    const month = String(now.getMonth() + 1).padStart(2, "0");
+    const day = String(now.getDate()).padStart(2, "0");
+    const hours = String(now.getHours()).padStart(2, "0");
+    const minutes = String(now.getMinutes()).padStart(2, "0");
+    const seconds = String(now.getSeconds()).padStart(2, "0");
+    const random12Digits = Math.floor(100000000000 + Math.random() * 900000000000);
+    return `${clientCode}${year}${month}${day}${hours}${minutes}${seconds}${random12Digits}`;
+};
+exports.generateTransactionID = generateTransactionID;
+/**
+ * Generates a Base64-encoded key from client ID and secret key
+ * @param client_id - the client ID
+ * @param secret_key - the secret key
+ * @returns Base64 encoded key
+ */
+const generateBase64Key = (client_id, secret_key) => {
+    const dataToString = `${client_id}:${secret_key}`;
+    return Buffer.from(dataToString).toString("base64");
+};
+exports.generateBase64Key = generateBase64Key;
+/**
+ * Generates a Base64-encoded key for BVN using NIBSS details
+ * @returns Base64 encoded key for BVN
+ */
+const generateBase64KeyNibssBVN = () => {
+    const { bvnclientid, bvnSecret } = app_configs_1.appConfigs.getNIBSSDetails().bvn;
+    const dataToString = `${bvnclientid}:${bvnSecret}`;
+    return Buffer.from(dataToString).toString("base64");
+};
+exports.generateBase64KeyNibssBVN = generateBase64KeyNibssBVN;

package/build/helper/status.d.ts

@@ -2,6 +2,7 @@ export declare enum Status {
     Error = "Error",
     Success = "Success",
     Pending = "Pending",
+    Settled = "Settled",
     Failed = "Failed",
     Blocked = "Blocked",
     Disabled = "Disabled",

package/build/helper/status.js

@@ -6,6 +6,7 @@ var Status;
     Status["Error"] = "Error";
     Status["Success"] = "Success";
     Status["Pending"] = "Pending";
+    Status["Settled"] = "Settled";
     Status["Failed"] = "Failed";
     Status["Blocked"] = "Blocked";
     Status["Disabled"] = "Disabled";

package/build/helper/timestamp.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @param month The month from 1 - 12
+ * @returns The formatted month as a string from 01 - 12
+ */
+export declare const monthFormat: (month: number) => string;
+/**
+ * @returns The current timestamp in milliseconds
+ */
+export declare const getCurrentTimeStampMill: () => number;
+/**
+ * @returns The current timestamp in seconds
+ */
+export declare const getCurrentTimeStampSeconds: () => number;
+/**
+ * @returns The current Year and Month as a string
+ */
+export declare const getYearMonth: () => string;

package/build/helper/timestamp.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getYearMonth = exports.getCurrentTimeStampSeconds = exports.getCurrentTimeStampMill = exports.monthFormat = void 0;
+/**
+ * @param month The month from 1 - 12
+ * @returns The formatted month as a string from 01 - 12
+ */
+const monthFormat = (month) => {
+    const months = {
+        1: "01",
+        2: "02",
+        3: "03",
+        4: "04",
+        5: "05",
+        6: "06",
+        7: "07",
+        8: "08",
+        9: "09",
+        10: "10",
+        11: "11",
+        12: "12",
+    };
+    if (!(month in months))
+        throw new Error("Invalid month");
+    return months[month];
+};
+exports.monthFormat = monthFormat;
+/**
+ * @returns The current timestamp in milliseconds
+ */
+const getCurrentTimeStampMill = () => {
+    const date = new Date();
+    return date.getTime();
+};
+exports.getCurrentTimeStampMill = getCurrentTimeStampMill;
+/**
+ * @returns The current timestamp in seconds
+ */
+const getCurrentTimeStampSeconds = () => {
+    const millionSecond = (0, exports.getCurrentTimeStampMill)();
+    return Math.floor(millionSecond / 1000);
+};
+exports.getCurrentTimeStampSeconds = getCurrentTimeStampSeconds;
+/**
+ * @returns The current Year and Month as a string
+ */
+const getYearMonth = () => {
+    const date = new Date();
+    const year = date.getFullYear();
+    const month = (0, exports.monthFormat)(date.getMonth() + 1);
+    return `${year}${month}`;
+};
+exports.getYearMonth = getYearMonth;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@konplit-services/common",
-  "version": "1.0.126",
+  "version": "1.0.131",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
@@ -22,9 +22,11 @@
     "@types/express": "^4.17.13",
     "@types/jsonwebtoken": "^8.5.8",
     "@types/node": "^18.6.1",
+    "@types/node-forge": "^1.3.11",
     "@types/swagger-jsdoc": "^6.0.4",
     "@types/swagger-ui-express": "^4.1.6",
     "axios": "^1.7.2",
+    "dayjs": "^1.11.13",
     "express": "^4.18.1",
     "express-validator": "^6.14.2",
     "ioredis": "^5.4.1",
@@ -33,6 +35,7 @@
     "mongoose": "^6.9.2",
     "nanoid": "^3.3.7",
     "nats": "^2.25.0",
+    "node-forge": "^1.3.1",
     "node-ipinfo": "^3.5.0",
     "swagger-jsdoc": "^6.2.8",
     "swagger-ui-express": "^5.0.0",