@konplit-services/common 1.0.387 → 1.0.389

package/build/app.configs.d.ts

@@ -191,6 +191,10 @@ interface PayPlus {
     clientId: string;
     secret: string;
 }
+interface BucketI {
+    bucketName: string;
+    region: string;
+}
 interface BVN {
     bvnclientid: string;
     bvnSecret: string;
@@ -280,6 +284,7 @@ declare class AppConfigs {
         password: string;
     };
     getMessageQueueNames(): MessageQueue;
+    getS3BucketDetail(): BucketI;
     getEmailTemplates(): EmailTemplate;
     getCloudinaryKey(): string;
     getMailSenderKey(): string;

package/build/app.configs.js

@@ -335,6 +335,18 @@ class AppConfigs {
             reminder: this.env.MESSAGEQUEUE_REMINDER,
         };
     }
+    getS3BucketDetail() {
+        if (!this.env.BUCKET_NAME) {
+            throw new Error("BUCKET_NAME is required");
+        }
+        if (!this.env.BUCKET_REGION) {
+            throw new Error("BUCKET_REGION is required");
+        }
+        return {
+            bucketName: this.env.BUCKET_NAME,
+            region: this.env.BUCKET_REGION,
+        };
+    }
     getEmailTemplates() {
         if (!this.env.EMAIL_TEMPLATE_FORGET_PASSWORD) {
             throw new Error("EMAIL_TEMPLATE_FORGET_PASSWORD is required");

package/build/events/refund-events/inteterfaces/index.d.ts

@@ -7,3 +7,9 @@ export * from "./refund-init-fund-reserve.interface";
 export * from "./refund-reverse-fund.interface";
 export * from "./refund-status-check.interface";
 export * from "./refund-bank-status-check.interface";
+export * from "./refund-settlement-ledger-created.interface";
+export * from "./refund-settlement-ledger-insufficient.interface";
+export * from "./refund-settlement-ledger-release.interface";
+export * from "./refund-settlement-ledger-reserve-fund.interface";
+export * from "./refund-settlement-ledger-reserve-res.interface";
+export * from "./refund-settlement-ledger-reverse.interface";

package/build/events/refund-events/inteterfaces/index.js

@@ -23,3 +23,9 @@ __exportStar(require("./refund-init-fund-reserve.interface"), exports);
 __exportStar(require("./refund-reverse-fund.interface"), exports);
 __exportStar(require("./refund-status-check.interface"), exports);
 __exportStar(require("./refund-bank-status-check.interface"), exports);
+__exportStar(require("./refund-settlement-ledger-created.interface"), exports);
+__exportStar(require("./refund-settlement-ledger-insufficient.interface"), exports);
+__exportStar(require("./refund-settlement-ledger-release.interface"), exports);
+__exportStar(require("./refund-settlement-ledger-reserve-fund.interface"), exports);
+__exportStar(require("./refund-settlement-ledger-reserve-res.interface"), exports);
+__exportStar(require("./refund-settlement-ledger-reverse.interface"), exports);

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

@@ -1,4 +1,4 @@
-import { REFUND_TYPE } from "../../../helper";
+import { REFUND_SOURCE, REFUND_TYPE } from "../../../helper";
 import { StreamEvent, StreamName, Subjects } from "../../subjects";
 export interface RefundBankPaymentStatusCheckEvent {
     subject: Subjects.RefundBankPaymentStatusCheck;
@@ -9,6 +9,7 @@ export interface RefundBankPaymentStatusCheckEvent {
         refundId: string;
         transactionId: string;
         refundType: REFUND_TYPE;
+        refundSource: REFUND_SOURCE;
         amount: number;
         reason?: string;
         accountNumber: string;

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

@@ -1,4 +1,4 @@
-import { REFUND_TYPE } from "../../../helper";
+import { REFUND_SOURCE, REFUND_TYPE } from "../../../helper";
 import { StreamEvent, StreamName, Subjects } from "../../subjects";
 export interface RefundBankTransferCreatedEvent {
     subject: Subjects.RefundBankTransferInitiated;
@@ -9,6 +9,7 @@ export interface RefundBankTransferCreatedEvent {
         refundId: string;
         transactionId: string;
         refundType: REFUND_TYPE;
+        refundSource: REFUND_SOURCE;
         amount: number;
         reason?: string;
         accountNumber: string;

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

@@ -1,4 +1,4 @@
-import { REFUND_TYPE } from "../../../helper";
+import { REFUND_SOURCE, REFUND_TYPE } from "../../../helper";
 import { StreamEvent, StreamName, Subjects } from "../../subjects";
 export interface RefundCardPaymentCreatedEvent {
     subject: Subjects.RefundCardPayentInitiated;
@@ -9,6 +9,7 @@ export interface RefundCardPaymentCreatedEvent {
         refundId: string;
         transactionId: string;
         refundType: REFUND_TYPE;
+        refundSource: REFUND_SOURCE;
         amount: number;
         reason?: string;
     };

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

@@ -1,3 +1,4 @@
+import { REFUND_SOURCE } from "../../../helper";
 import { StreamEvent, StreamName, Subjects } from "../../subjects";
 export interface RefundCompletedCreatedEvent {
     subject: Subjects.RefundCompletedCreated;
@@ -7,6 +8,7 @@ export interface RefundCompletedCreatedEvent {
         merchantId: string;
         refundId: string;
         transactionId: string;
+        refundSource: REFUND_SOURCE;
         processorResponse?: Record<string, any>;
     };
 }

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

@@ -1,4 +1,4 @@
-import { REFUND_WALLET_RESPONSE } from "../../../helper";
+import { REFUND_SOURCE, REFUND_WALLET_RESPONSE } from "../../../helper";
 import { StreamEvent, StreamName, Subjects } from "../../subjects";
 export interface RefundFundReserveResponseInitetiatedEvent {
     subject: Subjects.RefundFundReserveUpdated;
@@ -9,6 +9,7 @@ export interface RefundFundReserveResponseInitetiatedEvent {
         refundId: string;
         transactionId: string;
         responseType: REFUND_WALLET_RESPONSE;
+        refundSource: REFUND_SOURCE;
         amount: number;
         reason?: string;
     };

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

@@ -1,4 +1,4 @@
-import { REFUND_TYPE } from "../../../helper";
+import { REFUND_SOURCE, REFUND_TYPE } from "../../../helper";
 import { StreamEvent, StreamName, Subjects } from "../../subjects";
 export interface RefundFundReserveInitetiatedEvent {
     subject: Subjects.RefundFundReserveInitiated;
@@ -10,6 +10,7 @@ export interface RefundFundReserveInitetiatedEvent {
         transactionId: string;
         amount: number;
         refundType: REFUND_TYPE;
+        refundSource: REFUND_SOURCE;
         reason?: string;
     };
 }

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

@@ -1,4 +1,4 @@
-import { REFUND_TYPE } from "../../../helper";
+import { REFUND_SOURCE, REFUND_TYPE } from "../../../helper";
 import { StreamEvent, StreamName, Subjects } from "../../subjects";
 export interface RefundReversFundInitetiatedEvent {
     subject: Subjects.RefundFundReverseCreated;
@@ -10,6 +10,7 @@ export interface RefundReversFundInitetiatedEvent {
         transactionId: string;
         amount: number;
         refundType: REFUND_TYPE;
+        refundSource: REFUND_SOURCE;
         reason?: string;
     };
 }

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

@@ -0,0 +1,18 @@
+import { REFUND_SOURCE, REFUND_TYPE } from "../../../helper";
+import { StreamEvent, StreamName, Subjects } from "../../subjects";
+export interface RefundFundSettlementLedgerCreatedEvent {
+    subject: Subjects.RefundSettlementLedgerCreated;
+    streamName: StreamName.name;
+    streamEvents: StreamEvent.Event;
+    data: {
+        merchantId: string;
+        refundId: string;
+        transactionId: string;
+        amount: number;
+        refundType: REFUND_TYPE;
+        refundSource: REFUND_SOURCE;
+        reason?: string;
+        transactionDate: Date;
+        fees: number;
+    };
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,17 @@
+import { REFUND_SOURCE, REFUND_TYPE } from "../../../helper";
+import { StreamEvent, StreamName, Subjects } from "../../subjects";
+export interface RefundFundSettlementLedgerInsufficientFundEvent {
+    subject: Subjects.RefundSettlementLedgerInsufficientFund;
+    streamName: StreamName.name;
+    streamEvents: StreamEvent.Event;
+    data: {
+        merchantId: string;
+        refundId: string;
+        transactionId: string;
+        amount: number;
+        refundType: REFUND_TYPE;
+        refundSource: REFUND_SOURCE;
+        reason?: string;
+        transactionDate: Date;
+    };
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,18 @@
+import { REFUND_SOURCE, REFUND_TYPE } from "../../../helper";
+import { StreamEvent, StreamName, Subjects } from "../../subjects";
+export interface RefundFundSettlementLedgerReleaseFundEvent {
+    subject: Subjects.RefundSettlementLedgerReleaseFund;
+    streamName: StreamName.name;
+    streamEvents: StreamEvent.Event;
+    data: {
+        merchantId: string;
+        refundId: string;
+        transactionId: string;
+        amount: number;
+        refundType: REFUND_TYPE;
+        refundSource: REFUND_SOURCE;
+        reason?: string;
+        transactionDate: Date;
+        fees: number;
+    };
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,17 @@
+import { REFUND_SOURCE, REFUND_TYPE } from "../../../helper";
+import { StreamEvent, StreamName, Subjects } from "../../subjects";
+export interface RefundFundSettlementLedgerReserveFundEvent {
+    subject: Subjects.RefundSettlementLedgerReserveFund;
+    streamName: StreamName.name;
+    streamEvents: StreamEvent.Event;
+    data: {
+        merchantId: string;
+        refundId: string;
+        transactionId: string;
+        amount: number;
+        refundType: REFUND_TYPE;
+        refundSource: REFUND_SOURCE;
+        reason?: string;
+        transactionDate: Date;
+    };
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,16 @@
+import { REFUND_SOURCE, REFUND_WALLET_RESPONSE } from "../../../helper";
+import { StreamEvent, StreamName, Subjects } from "../../subjects";
+export interface RefundFundSettlementLedgerReserveFundEventResponseEvent {
+    subject: Subjects.RefundSettlementLedgerReserveFundResponse;
+    streamName: StreamName.name;
+    streamEvents: StreamEvent.Event;
+    data: {
+        merchantId: string;
+        refundId: string;
+        transactionId: string;
+        responseType: REFUND_WALLET_RESPONSE;
+        refundSource: REFUND_SOURCE;
+        amount: number;
+        reason?: string;
+    };
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,16 @@
+import { REFUND_SOURCE, REFUND_TYPE } from "../../../helper";
+import { StreamEvent, StreamName, Subjects } from "../../subjects";
+export interface RefundFundSettlementLedgerReverseFundToLedgerEvent {
+    subject: Subjects.RefundSettlementLedgerReverseFundToLedger;
+    streamName: StreamName.name;
+    streamEvents: StreamEvent.Event;
+    data: {
+        merchantId: string;
+        refundId: string;
+        transactionId: string;
+        amount: number;
+        refundType: REFUND_TYPE;
+        refundSource: REFUND_SOURCE;
+        reason?: string;
+    };
+}

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

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/events/subjects.d.ts

@@ -81,6 +81,12 @@ export declare enum Subjects {
     RefundCompletedCreated = "events.refund.completed.created",
     RefundFailedCreated = "events.refund.failed.created",
     RefundFundReverseCreated = "events.refund.reverse.created",
+    RefundSettlementLedgerCreated = "events.refund.settlement.ledger.created",
+    RefundSettlementLedgerInsufficientFund = "events.refund.settlement.ledger.insufficient.fund",
+    RefundSettlementLedgerReleaseFund = "events.refund.settlement.ledger.release.fund",
+    RefundSettlementLedgerReserveFund = "events.refund.settlement.ledger.reserve.fund",
+    RefundSettlementLedgerReserveFundResponse = "events.refund.settlement.ledger.reserve.fund.response",
+    RefundSettlementLedgerReverseFundToLedger = "events.refund.settlement.ledger.reverse.fund.to.ledger",
     BANKACCOUNT_CREATED = "events.bank.account.created",
     BANKACCOUNT_UPDATED = "events.bank.account.updated",
     BANKACCOUNT_DELETED = "events.bank.account.deleted",

package/build/events/subjects.js

@@ -102,6 +102,12 @@ var Subjects;
     Subjects["RefundCompletedCreated"] = "events.refund.completed.created";
     Subjects["RefundFailedCreated"] = "events.refund.failed.created";
     Subjects["RefundFundReverseCreated"] = "events.refund.reverse.created";
+    Subjects["RefundSettlementLedgerCreated"] = "events.refund.settlement.ledger.created";
+    Subjects["RefundSettlementLedgerInsufficientFund"] = "events.refund.settlement.ledger.insufficient.fund";
+    Subjects["RefundSettlementLedgerReleaseFund"] = "events.refund.settlement.ledger.release.fund";
+    Subjects["RefundSettlementLedgerReserveFund"] = "events.refund.settlement.ledger.reserve.fund";
+    Subjects["RefundSettlementLedgerReserveFundResponse"] = "events.refund.settlement.ledger.reserve.fund.response";
+    Subjects["RefundSettlementLedgerReverseFundToLedger"] = "events.refund.settlement.ledger.reverse.fund.to.ledger";
     //APICONFIG
     Subjects["BANKACCOUNT_CREATED"] = "events.bank.account.created";
     Subjects["BANKACCOUNT_UPDATED"] = "events.bank.account.updated";

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

@@ -30,11 +30,12 @@ export declare const calculateDelay: (targetDate: string | Date) => {
     delay: number;
 };
 /**
- * Check if there's enough time before settlement to refund via settlement ledger.
+ * Determines if a refund can still be processed using the settlement ledger,
+ * based on the transaction's creation date (must be the same UTC day).
  *
- * @param settlementDateTime - The UTC datetime of the next settlement (ISO string or Date)
- * @param bufferInMinutes - Minimum safe time (in minutes) required before settlement
- * @returns boolean - true if refund can safely be processed from settlement ledger
+ * @param transactionCreatedAt - Transaction createdAt timestamp (UTC string or Date)
+ * @param bufferInMinutes - Minimum time (in minutes) required before day ends
+ * @returns boolean - true if refund can still be processed from the settlement ledger
  */
-export declare const canRefundFromSettlementLedger: (settlementDateTime: string | Date, bufferInMinutes?: number) => boolean;
+export declare function canRefundFromSettlementLedgerByDay(transactionCreatedAt: string | Date, bufferInMinutes?: number): boolean;
 export {};

package/build/helper/date-processing.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.canRefundFromSettlementLedger = exports.calculateDelay = exports.getFutureDateFromPlan = exports.getDuration = exports.convertDateToUTC = exports.convertDateToUTCString = exports.convertDateToUTCRange = exports.convertDateToUTCRangeString = exports.getCurrentDayRange = exports.getPreviousDayRange = exports.convertToDate = exports.formatDateTime = exports.interswitchRefundDateFormat = exports.formatDate = void 0;
+exports.canRefundFromSettlementLedgerByDay = exports.calculateDelay = exports.getFutureDateFromPlan = exports.getDuration = exports.convertDateToUTC = exports.convertDateToUTCString = exports.convertDateToUTCRange = exports.convertDateToUTCRangeString = exports.getCurrentDayRange = exports.getPreviousDayRange = exports.convertToDate = exports.formatDateTime = exports.interswitchRefundDateFormat = exports.formatDate = void 0;
 const dayjs_1 = __importDefault(require("dayjs"));
 const utc_1 = __importDefault(require("dayjs/plugin/utc"));
 // Extend dayjs with the UTC plugin
@@ -155,16 +155,21 @@ const calculateDelay = (targetDate) => {
 };
 exports.calculateDelay = calculateDelay;
 /**
- * Check if there's enough time before settlement to refund via settlement ledger.
+ * Determines if a refund can still be processed using the settlement ledger,
+ * based on the transaction's creation date (must be the same UTC day).
  *
- * @param settlementDateTime - The UTC datetime of the next settlement (ISO string or Date)
- * @param bufferInMinutes - Minimum safe time (in minutes) required before settlement
- * @returns boolean - true if refund can safely be processed from settlement ledger
+ * @param transactionCreatedAt - Transaction createdAt timestamp (UTC string or Date)
+ * @param bufferInMinutes - Minimum time (in minutes) required before day ends
+ * @returns boolean - true if refund can still be processed from the settlement ledger
  */
-const canRefundFromSettlementLedger = (settlementDateTime, bufferInMinutes = 60) => {
-    const nowUtc = dayjs_1.default.utc();
-    const settlementUtc = dayjs_1.default.utc(settlementDateTime);
-    const diffInMinutes = settlementUtc.diff(nowUtc, "minute");
-    return diffInMinutes >= bufferInMinutes;
-};
-exports.canRefundFromSettlementLedger = canRefundFromSettlementLedger;
+function canRefundFromSettlementLedgerByDay(transactionCreatedAt, bufferInMinutes = 60) {
+    const now = dayjs_1.default.utc();
+    const txnDay = dayjs_1.default.utc(transactionCreatedAt).startOf("day");
+    const nextDay = txnDay.add(1, "day");
+    const cutoffTime = nextDay.subtract(bufferInMinutes, "minute");
+    // You can refund if:
+    // 1. It’s still the same UTC day as transaction's createdAt
+    // 2. There’s still enough buffer time before the new day starts
+    return now.isBefore(cutoffTime);
+}
+exports.canRefundFromSettlementLedgerByDay = canRefundFromSettlementLedgerByDay;

package/build/helper/refund.d.ts

@@ -12,6 +12,10 @@ export declare enum REFUND_WALLET_RESPONSE {
     RESERVED = "RESERVED",
     NOT_RESERVED = "NOT_RESERVED"
 }
+export declare enum REFUND_SOURCE {
+    balance = "balance",
+    settlement_ledger = "settlement_ledger"
+}
 export declare enum REFUND_STATUS_INTERSWITCH {
     SUCCESS = "SUCCESS",
     PENDING = "PENDING",

package/build/helper/refund.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.REFUND_CHANNEL = exports.REFUND_TYPE = exports.REFUND_STATUS_INTERSWITCH = exports.REFUND_WALLET_RESPONSE = exports.REFUND_STATUS = void 0;
+exports.REFUND_CHANNEL = exports.REFUND_TYPE = exports.REFUND_STATUS_INTERSWITCH = exports.REFUND_SOURCE = exports.REFUND_WALLET_RESPONSE = exports.REFUND_STATUS = void 0;
 var REFUND_STATUS;
 (function (REFUND_STATUS) {
     REFUND_STATUS["COMPLETED"] = "COMPLETED";
@@ -17,6 +17,11 @@ var REFUND_WALLET_RESPONSE;
     REFUND_WALLET_RESPONSE["RESERVED"] = "RESERVED";
     REFUND_WALLET_RESPONSE["NOT_RESERVED"] = "NOT_RESERVED";
 })(REFUND_WALLET_RESPONSE = exports.REFUND_WALLET_RESPONSE || (exports.REFUND_WALLET_RESPONSE = {}));
+var REFUND_SOURCE;
+(function (REFUND_SOURCE) {
+    REFUND_SOURCE["balance"] = "balance";
+    REFUND_SOURCE["settlement_ledger"] = "settlement_ledger";
+})(REFUND_SOURCE = exports.REFUND_SOURCE || (exports.REFUND_SOURCE = {}));
 var REFUND_STATUS_INTERSWITCH;
 (function (REFUND_STATUS_INTERSWITCH) {
     REFUND_STATUS_INTERSWITCH["SUCCESS"] = "SUCCESS";

package/package.json

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