@konplit-services/common 1.8.0 → 1.9.0

package/build/events/Settlements-events/interfaces/settlement-created.interface.d.ts

@@ -10,11 +10,11 @@ export interface SettlementCreatedEvent {
         transactionId: string;
         accountNumber: string;
         accountName: string;
-        amount: string;
-        charges: string;
-        stampDuty: string;
-        tax: string;
-        transactionFee: string;
+        amount: number;
+        charges: number;
+        stampDuty: number;
+        tax: number;
+        transactionFee: number;
         settlementType: Settlement_TYPES;
         transactionDate: Date;
         schedule: SettlementSchedule;

package/build/events/Settlements-events/interfaces/settlement-pay-merchant-created.interface.d.ts

@@ -9,8 +9,8 @@ export interface SettlementPayMerchantEvent {
         merchantId: string;
         merchantName: string;
         accountNumber: string;
-        amount: string;
-        charges: string;
+        amount: number;
+        charges: number;
         transactionDate: Date;
         currency?: CURRENCY_TYPE;
         settlementProcessor: "nibss" | "interswitch";

package/build/events/Settlements-events/interfaces/settlement-pay-merchant-nibss-created.interface.d.ts

@@ -9,8 +9,8 @@ export interface SettlementPayMerchantNIBSSEvent {
         merchantId: string;
         accountNumber: string;
         merchantName: string;
-        amount: string;
-        charges: string;
+        amount: number;
+        charges: number;
         transactionDate: Date;
         currency?: CURRENCY_TYPE;
         settlementProcessor: "nibss" | "interswitch";

package/build/events/Settlements-events/interfaces/settlement-transfer-reserved-nibss.interface.d.ts

@@ -8,8 +8,8 @@ export interface SettlementTransferReservedNIBSSEvent {
         id: string;
         merchantId: string;
         accountNumber: string;
-        amount: string;
-        charges: string;
+        amount: number;
+        charges: number;
         merchantName: string;
         settlementProcessor: "nibss" | "interswitch";
         transactionDate: Date;

package/build/events/Settlements-events/interfaces/settlement-transfer-verify-nibss.interface.d.ts

@@ -6,8 +6,8 @@ export interface SettlementTransferVerifyNISSEvent {
     data: {
         merchantId: string;
         accountNumber: string;
-        amount: string;
-        charges: string;
+        amount: number;
+        charges: number;
         settlementId: string;
         merchantName: string;
         transferId: string;

package/build/events/Settlements-events/interfaces/settlement-transfer-verify.interface.d.ts

@@ -6,8 +6,8 @@ export interface SettlementTransferVerifyEvent {
     data: {
         merchantId: string;
         accountNumber: string;
-        amount: string;
-        charges: string;
+        amount: number;
+        charges: number;
         transferCode: string;
     };
 }

package/build/events/Settlements-events/interfaces/settlement-transter-initiation.interface.d.ts

@@ -9,8 +9,8 @@ export interface SettlementTransferInitiationEvent {
         merchantId: string;
         accountNumber: string;
         merchantName: string;
-        amount: string;
-        charges: string;
+        amount: number;
+        charges: number;
         settlementProcessor: "nibss" | "interswitch";
         transactionDate: Date;
         currency?: CURRENCY_TYPE;

package/build/events/Settlements-events/interfaces/settlement-transter-reserved.interface.d.ts

@@ -9,8 +9,8 @@ export interface SettlementTransferReservedEvent {
         merchantId: string;
         accountNumber: string;
         merchantName: string;
-        amount: string;
-        charges: string;
+        amount: number;
+        charges: number;
         settlementProcessor: "nibss" | "interswitch";
         transactionDate: Date;
         currency?: CURRENCY_TYPE;

package/build/events/Settlements-events/interfaces/settlement-transter-wallet.interface.d.ts

@@ -7,8 +7,8 @@ export interface SettlementTransferWalletEvent {
     data: {
         merchantId: string;
         accountNumber: string;
-        amount: string;
-        charges: string;
+        amount: number;
+        charges: number;
         currency?: CURRENCY_TYPE;
     };
 }

package/build/events/Settlements-events/interfaces/settlement-updated.interface.d.ts

@@ -8,8 +8,8 @@ export interface SettlementUpdatedEvent {
         id: string;
         merchantId: string;
         accountNumber: string;
-        amount: string;
-        charges: string;
+        amount: number;
+        charges: number;
         status?: Settlement_Status;
         settlementType: Settlement_TYPES;
         transactionDate: Date;

package/build/events/easypay-events/interfaces/insuficient-fund.interface.d.ts

@@ -8,7 +8,7 @@ export interface ETransferInsuficientFundCreatedEvent {
         merchantId: string;
         transferId: string;
         usage: Usage;
-        balance: string;
-        requestAmount: string;
+        balance: number;
+        requestAmount: number;
     };
 }

package/build/events/easypay-events/interfaces/reserve-fund-update.interface.d.ts

@@ -8,8 +8,8 @@ export interface ReservedFundCompletedEvent {
         merchantId: string;
         transferId: string;
         usage: Usage;
-        amount: string;
-        charges: string;
-        total: string;
+        amount: number;
+        charges: number;
+        total: number;
     };
 }

package/build/events/easypay-events/interfaces/reserve-fund.interface.d.ts

@@ -8,8 +8,8 @@ export interface ETransferReservedFundCreatedEvent {
         merchantId: string;
         transferId: string;
         usage: Usage;
-        amount: string;
-        charges: string;
-        total: string;
+        amount: number;
+        charges: number;
+        total: number;
     };
 }

package/build/events/invoices-events/interfaces/invoice-payment-created.interface.d.ts

@@ -8,7 +8,7 @@ export interface InvoicePaymentCreatedEvent {
         invoiceId: string;
         paymentRef: string;
         merchantId: string;
-        amount: string;
+        amount: number;
         usage: Usage;
         paidAt: Date;
     };

package/build/events/kore-events/interfaces/subscription-created.interface.d.ts

@@ -11,7 +11,7 @@ export interface SubscriptionCreatedEvent {
         cronPattern: string;
         reminderPattern: string;
         usage: Usage;
-        amount: string;
+        amount: number;
         endDate?: Date;
         startDate?: Date;
         limit?: number;

package/build/events/kore-events/interfaces/subscription-next.d.ts

@@ -11,7 +11,7 @@ export interface SubscriptionNextEvent {
         cronPattern: string;
         reminderPattern: string;
         usage: Usage;
-        amount: string;
+        amount: number;
         endDate?: Date;
         startDate?: Date;
         limit?: number;

package/build/events/kore-events/interfaces/subscription-reminder-next.d.ts

@@ -11,7 +11,7 @@ export interface SubscriptionReminderNextEvent {
         cronPattern: string;
         reminderPattern: string;
         usage: Usage;
-        amount: string;
+        amount: number;
         endDate?: Date;
         startDate?: Date;
         limit?: number;

package/build/events/kore-events/interfaces/subscription-reminder.interface.d.ts

@@ -11,7 +11,7 @@ export interface SubscriptionReminderCreatedEvent {
         cronPattern: string;
         reminderPattern: string;
         usage: Usage;
-        amount: string;
+        amount: number;
         endDate?: Date;
         startDate?: Date;
         limit?: number;

package/build/events/kore-events/interfaces/subscription-updated.interface.d.ts

@@ -12,7 +12,7 @@ export interface SubscriptionUpdatedEvent {
         reminderPattern: string;
         status: SUBSCRIPTION_STATUS;
         usage: Usage;
-        amount: string;
+        amount: number;
         endDate?: Date;
         startDate?: Date;
         limit?: number;

package/build/events/refund-events/inteterfaces/refund-bank-status-check.interface.d.ts

@@ -10,14 +10,14 @@ export interface RefundBankPaymentStatusCheckEvent {
         transactionId: string;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
-        amount: string;
+        amount: number;
         reason?: string;
         accountNumber: string;
         bankCode: string;
         code?: string;
         verificationTime: Date;
         responseData?: Record<string, any>;
-        totalAmount: string;
+        totalAmount: number;
         transactionDate: Date;
         fees: string;
     };

package/build/events/refund-events/inteterfaces/refund-bank-transfer.interface.d.ts

@@ -10,14 +10,14 @@ export interface RefundBankTransferCreatedEvent {
         transactionId: string;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
-        amount: string;
+        amount: number;
         reason?: string;
         accountNumber: string;
         bankCode: string;
         code?: string;
-        totalAmount: string;
+        totalAmount: number;
         transactionDate: Date;
-        fees: string;
+        fees: number;
     };
 }
 export interface RefundRequest {

package/build/events/refund-events/inteterfaces/refund-card-payment.interface.d.ts

@@ -10,10 +10,10 @@ export interface RefundCardPaymentCreatedEvent {
         transactionId: string;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
-        amount: string;
+        amount: number;
         reason?: string;
-        totalAmount: string;
+        totalAmount: number;
         transactionDate: Date;
-        fees: string;
+        fees: number;
     };
 }

package/build/events/refund-events/inteterfaces/refund-card-status-check.interface.d.ts

@@ -10,12 +10,12 @@ export interface RefundCardPaymentStatusCheckEvent {
         transactionId: string;
         refundReference: string;
         refundType: REFUND_TYPE;
-        amount: string;
+        amount: number;
         reason?: string;
         responseData?: Record<string, any>;
         refundSource: REFUND_SOURCE;
-        totalAmount: string;
+        totalAmount: number;
         transactionDate: Date;
-        fees: string;
+        fees: number;
     };
 }

package/build/events/refund-events/inteterfaces/refund-failed.interface.d.ts

@@ -9,12 +9,12 @@ export interface RefundFailedCreatedEvent {
         refundId: string;
         transactionId: string;
         processorResponse?: Record<string, any>;
-        amount: string;
+        amount: number;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
-        totalAmount: string;
+        totalAmount: number;
         reason?: string;
         transactionDate: Date;
-        fees: string;
+        fees: number;
     };
 }

package/build/events/refund-events/inteterfaces/refund-init-fund-reserve-res.interface.d.ts

@@ -10,11 +10,11 @@ export interface RefundFundReserveResponseInitetiatedEvent {
         transactionId: string;
         responseType: REFUND_WALLET_RESPONSE;
         refundSource: REFUND_SOURCE;
-        amount: string;
+        amount: number;
         reason?: string;
-        totalAmount: string;
+        totalAmount: number;
         refundType: REFUND_TYPE;
         transactionDate: Date;
-        fees: string;
+        fees: number;
     };
 }

package/build/events/refund-events/inteterfaces/refund-init-fund-reserve.interface.d.ts

@@ -8,12 +8,12 @@ export interface RefundFundReserveInitetiatedEvent {
         merchantId: string;
         refundId: string;
         transactionId: string;
-        amount: string;
+        amount: number;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
         reason?: string;
-        totalAmount: string;
+        totalAmount: number;
         transactionDate: Date;
-        fees: string;
+        fees: number;
     };
 }

package/build/events/refund-events/inteterfaces/refund-reverse-fund.interface.d.ts

@@ -8,7 +8,7 @@ export interface RefundReversFundInitetiatedEvent {
         merchantId: string;
         refundId: string;
         transactionId: string;
-        amount: string;
+        amount: number;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
         reason?: string;

package/build/events/refund-events/inteterfaces/refund-settlement-ledger-created.interface.d.ts

@@ -9,12 +9,12 @@ export interface RefundFundSettlementLedgerCreatedEvent {
         refundId: string;
         transactionId: string;
         settlementId: string;
-        amount: string;
+        amount: number;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
         reason?: string;
         transactionDate: Date;
-        fees: string;
+        fees: number;
         currency?: CURRENCY_TYPE;
     };
 }

package/build/events/refund-events/inteterfaces/refund-settlement-ledger-insufficient.interface.d.ts

@@ -8,7 +8,7 @@ export interface RefundFundSettlementLedgerInsufficientFundEvent {
         merchantId: string;
         refundId: string;
         transactionId: string;
-        amount: string;
+        amount: number;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
         reason?: string;

package/build/events/refund-events/inteterfaces/refund-settlement-ledger-notfound.interface.d.ts

@@ -8,12 +8,12 @@ export interface RefundFundSettlementLedgerNotFoundEvent {
         merchantId: string;
         refundId: string;
         transactionId: string;
-        amount: string;
+        amount: number;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
         reason?: string;
         transactionDate: Date;
-        fees: string;
+        fees: number;
         currency?: CURRENCY_TYPE;
     };
 }

package/build/events/refund-events/inteterfaces/refund-settlement-ledger-release.interface.d.ts

@@ -9,12 +9,12 @@ export interface RefundFundSettlementLedgerReleaseFundEvent {
         refundId: string;
         transactionId: string;
         settlementId: string;
-        amount: string;
+        amount: number;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
-        totalAmount: string;
+        totalAmount: number;
         reason?: string;
         transactionDate: Date;
-        fees: string;
+        fees: number;
     };
 }

package/build/events/refund-events/inteterfaces/refund-settlement-ledger-reserve-fund.interface.d.ts

@@ -8,8 +8,8 @@ export interface RefundFundSettlementLedgerReserveFundEvent {
         merchantId: string;
         refundId: string;
         transactionId: string;
-        amount: string;
-        totalAmount: string;
+        amount: number;
+        totalAmount: number;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
         reason?: string;

package/build/events/refund-events/inteterfaces/refund-settlement-ledger-reserve-res.interface.d.ts

@@ -10,11 +10,11 @@ export interface RefundFundSettlementLedgerReserveFundEventResponseEvent {
         transactionId: string;
         responseType: REFUND_WALLET_RESPONSE;
         refundSource: REFUND_SOURCE;
-        totalAmount: string;
-        amount: string;
+        totalAmount: number;
+        amount: number;
         reason?: string;
         refundType: REFUND_TYPE;
         transactionDate: Date;
-        fees: string;
+        fees: number;
     };
 }

package/build/events/refund-events/inteterfaces/refund-settlement-ledger-reverse.interface.d.ts

@@ -9,8 +9,8 @@ export interface RefundFundSettlementLedgerReverseFundToLedgerEvent {
         refundId: string;
         transactionId: string;
         settlementId: string;
-        amount: string;
-        totalAmount: string;
+        amount: number;
+        totalAmount: number;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
         reason?: string;

package/build/events/refund-events/inteterfaces/refund-ussd-payment.interface.d.ts

@@ -10,10 +10,10 @@ export interface RefundUSSDPaymentCreatedEvent {
         transactionId: string;
         refundType: REFUND_TYPE;
         refundSource: REFUND_SOURCE;
-        amount: string;
+        amount: number;
         reason?: string;
-        totalAmount: string;
+        totalAmount: number;
         transactionDate: Date;
-        fees: string;
+        fees: number;
     };
 }

package/build/events/refund-events/inteterfaces/refund-ussd-status-check.interface.d.ts

@@ -10,12 +10,12 @@ export interface RefundUSSDPaymentStatusCheckEvent {
         transactionId: string;
         refundReference: string;
         refundType: REFUND_TYPE;
-        amount: string;
+        amount: number;
         reason?: string;
         responseData?: Record<string, any>;
         refundSource: REFUND_SOURCE;
-        totalAmount: string;
+        totalAmount: number;
         transactionDate: Date;
-        fees: string;
+        fees: number;
     };
 }

package/build/events/revenue-events/interfaces/revenue-created.interface.d.ts

@@ -7,7 +7,7 @@ export interface RevenueCreatedEvent {
     data: {
         merchantId: string;
         id: string;
-        amount: string;
+        amount: number;
         source: string;
         status: Status.Success;
         type: REVENUE_TYPE;

package/build/events/transaction-events/interfaces/transaction-aborted.interface.d.ts

@@ -7,7 +7,7 @@ export interface TransactionAbortedEvent {
     data: {
         merchantId: string;
         transactionId: string;
-        amount: string;
+        amount: number;
         additionalData?: any;
         usage: Usage;
         channel: PaymentOptions;

package/build/events/transaction-events/interfaces/transaction-cancelled.interface.d.ts

@@ -7,7 +7,7 @@ export interface TransactionCancelledEvent {
     data: {
         merchantId: string;
         transactionId: string;
-        amount: string;
+        amount: number;
         additionalData?: any;
         usage: Usage;
         channel: PaymentOptions;

package/build/events/transaction-events/interfaces/transaction-completed.interface.d.ts

@@ -9,7 +9,7 @@ export interface TransactionCompletedEvent {
         accountId?: string;
         transactionId: string;
         trasactionType?: TRANSACTION_CHARGES_TYPE;
-        amount: string;
+        amount: number;
         additionalData?: any;
         usage: Usage;
         channel: PaymentOptions;

package/build/events/transaction-events/interfaces/transaction-declined.interface.d.ts

@@ -7,7 +7,7 @@ export interface TransactionDeclinedEvent {
     data: {
         merchantId: string;
         transactionId: string;
-        amount: string;
+        amount: number;
         additionalData?: any;
         usage: Usage;
         channel: PaymentOptions;

package/build/events/transaction-events/interfaces/transaction-failed.interface.d.ts

@@ -7,7 +7,7 @@ export interface TransactionFailedEvent {
     data: {
         merchantId: string;
         transactionId: string;
-        amount: string;
+        amount: number;
         additionalData?: any;
         usage: Usage;
         channel: PaymentOptions;

package/build/events/transaction-events/interfaces/transaction-processing.interface.d.ts

@@ -7,7 +7,7 @@ export interface TransactionProcessingEvent {
     data: {
         merchantId: string;
         transactionId: string;
-        amount: string;
+        amount: number;
         additionalData?: any;
         usage: Usage;
     };

package/build/events/transaction-events/interfaces/transaction-webhook.interface.d.ts

@@ -9,7 +9,7 @@ export interface TransactionWebhookEvent {
         merchantId: string;
         accountId: string;
         id: string;
-        amount: string;
+        amount: number;
         [key: string]: any;
     };
 }

package/build/events/transfers-events/interfaces/transfer-created.interface.d.ts

@@ -8,8 +8,8 @@ export interface TransferCreatedEvent {
         id: string;
         merchantId: string;
         accountNumber: string;
-        amount: string;
-        charges: string;
+        amount: number;
+        charges: number;
         status?: Settlement_Status;
         settlementType: Settlement_TYPES;
         transactionDate: Date;

package/build/events/transfers-events/interfaces/transfer-initiation.interface.d.ts

@@ -7,8 +7,8 @@ export interface TransferInitiationEvent {
     data: {
         merchantId: string;
         accountNumber: string;
-        amount: string;
-        charges: string;
+        amount: number;
+        charges: number;
         settlementType: Settlement_TYPES;
         transactionDate: Date;
         currency?: CURRENCY_TYPE;

package/build/events/transfers-events/interfaces/transfer-success.interface.d.ts

@@ -7,8 +7,8 @@ export interface TransferSucessEvent {
     data: {
         merchantId: string;
         accountNumber: string;
-        amount: string;
-        charges: string;
+        amount: number;
+        charges: number;
         currency?: CURRENCY_TYPE;
         sender: {
             lastname: string;

package/build/events/wallets/interfaces/ledger-credited.interface.d.ts

@@ -6,7 +6,7 @@ export interface LedgerCreditedEvent {
     streamEvents: StreamEvent.Event;
     data: {
         merchantId: string;
-        amount: string;
+        amount: number;
         currencyType?: CURRENCY_TYPE;
         entityId: string;
     };

package/build/events/wallets/interfaces/ledger-debited.interface.d.ts

@@ -6,7 +6,7 @@ export interface LedgerDebitedEvent {
     streamEvents: StreamEvent.Event;
     data: {
         merchantId: string;
-        amount: string;
+        amount: number;
         currencyType?: CURRENCY_TYPE;
         entityId?: string;
     };

package/build/events/wallets/interfaces/wallet-credited.interface.d.ts

@@ -6,7 +6,7 @@ export interface WalletCreditedEvent {
     streamEvents: StreamEvent.Event;
     data: {
         merchantId: string;
-        amount: string;
+        amount: number;
         currencyType?: CURRENCY_TYPE;
         entityId?: string;
     };

package/build/events/wallets/interfaces/wallet-debited.interface.d.ts

@@ -6,7 +6,7 @@ export interface WalletDebitedEvent {
     streamEvents: StreamEvent.Event;
     data: {
         merchantId: string;
-        amount: string;
+        amount: number;
         currencyType?: CURRENCY_TYPE;
         entityId?: string;
     };

package/build/helper/money.js

@@ -100,3 +100,4 @@ const toSmalletUnit = (value, exponent = 2) => {
     return BigInt(minorStr);
 };
 exports.toSmalletUnit = toSmalletUnit;
+const value = Number((0, exports.toSmalletUnit)("4543.367487363")); // 454337n

package/build/swagger/config.d.ts

@@ -1,2 +1,3 @@
 import { Application } from "express";
 export declare const configureSwagger: (app: Application, paths: string) => void;
+export declare const configureSwaggerForTransaction: (app: Application, paths: string) => void;

package/build/swagger/config.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.configureSwagger = void 0;
+exports.configureSwaggerForTransaction = exports.configureSwagger = void 0;
 const swagger_jsdoc_1 = __importDefault(require("swagger-jsdoc"));
 const swagger_ui_express_1 = __importDefault(require("swagger-ui-express"));
 const configureSwagger = (app, paths) => {
@@ -62,3 +62,59 @@ const configureSwagger = (app, paths) => {
     });
 };
 exports.configureSwagger = configureSwagger;
+const configureSwaggerForTransaction = (app, paths) => {
+    const options = {
+        definition: {
+            openapi: "3.1.0",
+            info: {
+                title: "Valuepay Payment System Documentation",
+                version: "1.0.0",
+                description: "This is a complete API definition for the Valuepay payment system documented with Swagger UI",
+                license: {
+                    name: "IEC Code Components End-user licence agreement",
+                    url: "https://spdx.org/licenses/IEC-Code-Components-EULA.html",
+                },
+                contact: {
+                    name: "Valuepay",
+                    url: "https://valuepayng.com",
+                    email: "info@valuepay.ng",
+                },
+            },
+            servers: [
+                {
+                    url: "https://konplit.com",
+                },
+                {
+                    url: " https://valuepay.konplit.com",
+                },
+            ],
+            components: {
+                securitySchemes: {
+                    bearerAuth: {
+                        type: "http",
+                        scheme: "bearer",
+                        bearerFormat: "JWT",
+                    },
+                },
+            },
+            security: [
+                {
+                    bearerAuth: [],
+                },
+            ],
+        },
+        apis: [paths],
+    };
+    const swaggerSpec = (0, swagger_jsdoc_1.default)(options);
+    app.use("/transactions/docs", swagger_ui_express_1.default.serve, swagger_ui_express_1.default.setup(swaggerSpec, {
+        explorer: true,
+        // customCssUrl:
+        //   "https://cdn.jsdelivr.net/npm/swagger-ui-themes@3.0.0/themes/3.x/theme-newspaper.css",
+    }));
+    // ➕ Serve raw Swagger JSON
+    app.get("/transactions/api-json", (_, res) => {
+        res.setHeader("Content-Type", "application/json");
+        res.send(swaggerSpec);
+    });
+};
+exports.configureSwaggerForTransaction = configureSwaggerForTransaction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@konplit-services/common",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",