@temboplus/afloat 0.1.77-beta.8 → 0.1.78

package/esm/src/models/payout/channel.d.ts

@@ -0,0 +1,58 @@
+import { type TZPhoneNumber } from "../../../deps/jsr.io/@temboplus/frontend-core/0.2.21/mod.js";
+/**
+ * Represents the available channels through which payouts can be processed.
+ * @enum {string}
+ * @readonly
+ */
+export declare enum PAYOUT_CHANNEL {
+    /** Payment processed through mobile money services */
+    MOBILE = "Mobile",
+    /** Payment processed through traditional banking channels */
+    BANK = "Bank",
+    /** Payment processed through CRDB named account */
+    CRDB_NAMED_ACC = "CRDB_NAMED_ACC"
+}
+/**
+ * Valid payout channel codes that can be used in the system
+ *
+ * @remarks
+ * - `TZ-BANK-B2C`: Code for bank transfers
+ * - `TZ-VERTO-B2C`: Code for Verto transfers
+ * - `TZ-${telecom}-B2C`: Pattern for mobile money transfers where the telecom company is the provider code
+ *
+ * @see {@link createPayoutChannelCode} for functions to generate valid codes
+ */
+export type PayoutChannelCode = "TZ-BANK-B2C" | "TZ-VERTO-B2C" | `TZ-${string}-B2C`;
+/**
+ * Utility functions to create standardized payout channel codes
+ *
+ * @example
+ * ```ts
+ * // Create bank channel code
+ * const bankCode = createPayoutChannelCode.bank(); // Returns "TZ-BANK-B2C"
+ *
+ * // Create mobile channel code
+ * const mobileCode = createPayoutChannelCode.mobile(phoneNumber); // Returns "TZ-VODACOM-B2C" for Vodacom number
+ * ```
+ */
+export declare const createPayoutChannelCode: {
+    /**
+     * Creates a bank transfer channel code
+     * @returns {"TZ-BANK-B2C"} Standard bank transfer code
+     */
+    bank: () => "TZ-BANK-B2C";
+    /**
+     * Creates a Verto transfer channel code
+     * @returns {"TZ-VERTO-B2C"} Standard Verto transfer code
+     */
+    verto: () => "TZ-VERTO-B2C";
+    /**
+     * Creates a mobile money channel code based on the telecom provider
+     * @param {TZPhoneNumber} phoneNumber - Phone number object containing telecom information
+     * @returns {PayoutChannelCode} Channel code in format "TZ-{TELECOM}-B2C"
+     *
+     * @see {@link TZPhoneNumber} from "@jsr/temboplus__tembo-core" for phone number structure
+     */
+    mobile: (phoneNumber: TZPhoneNumber) => PayoutChannelCode;
+};
+//# sourceMappingURL=channel.d.ts.map

package/esm/src/models/payout/channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../../../src/src/models/payout/channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,KAAK,aAAa,EAAE,MAAM,6DAA6D,CAAC;AAElH;;;;GAIG;AACH,oBAAY,cAAc;IACxB,sDAAsD;IACtD,MAAM,WAAW;IACjB,6DAA6D;IAC7D,IAAI,SAAS;IACb,mDAAmD;IACnD,cAAc,mBAAmB;CAClC;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,iBAAiB,GACzB,aAAa,GACb,cAAc,GACd,MAAM,MAAM,MAAM,CAAC;AAEvB;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,uBAAuB;IAClC;;;OAGG;gBACO,aAAa;IAEvB;;;OAGG;iBACQ,cAAc;IAEzB;;;;;;OAMG;0BAC4B,aAAa,KAAG,iBAAiB;CAOjE,CAAC"}

package/esm/src/models/payout/channel.js

@@ -0,0 +1,53 @@
+import { NetworkOperator } from "../../../deps/jsr.io/@temboplus/frontend-core/0.2.21/mod.js";
+/**
+ * Represents the available channels through which payouts can be processed.
+ * @enum {string}
+ * @readonly
+ */
+export var PAYOUT_CHANNEL;
+(function (PAYOUT_CHANNEL) {
+    /** Payment processed through mobile money services */
+    PAYOUT_CHANNEL["MOBILE"] = "Mobile";
+    /** Payment processed through traditional banking channels */
+    PAYOUT_CHANNEL["BANK"] = "Bank";
+    /** Payment processed through CRDB named account */
+    PAYOUT_CHANNEL["CRDB_NAMED_ACC"] = "CRDB_NAMED_ACC";
+})(PAYOUT_CHANNEL || (PAYOUT_CHANNEL = {}));
+/**
+ * Utility functions to create standardized payout channel codes
+ *
+ * @example
+ * ```ts
+ * // Create bank channel code
+ * const bankCode = createPayoutChannelCode.bank(); // Returns "TZ-BANK-B2C"
+ *
+ * // Create mobile channel code
+ * const mobileCode = createPayoutChannelCode.mobile(phoneNumber); // Returns "TZ-VODACOM-B2C" for Vodacom number
+ * ```
+ */
+export const createPayoutChannelCode = {
+    /**
+     * Creates a bank transfer channel code
+     * @returns {"TZ-BANK-B2C"} Standard bank transfer code
+     */
+    bank: () => "TZ-BANK-B2C",
+    /**
+     * Creates a Verto transfer channel code
+     * @returns {"TZ-VERTO-B2C"} Standard Verto transfer code
+     */
+    verto: () => "TZ-VERTO-B2C",
+    /**
+     * Creates a mobile money channel code based on the telecom provider
+     * @param {TZPhoneNumber} phoneNumber - Phone number object containing telecom information
+     * @returns {PayoutChannelCode} Channel code in format "TZ-{TELECOM}-B2C"
+     *
+     * @see {@link TZPhoneNumber} from "@jsr/temboplus__tembo-core" for phone number structure
+     */
+    mobile: function (phoneNumber) {
+        //! fix: Channeling all Vodacom numbers to Tigo. Request from Mr. Tesha to solve some specific problem
+        if (phoneNumber.networkOperator.id === NetworkOperator.VODACOM) {
+            return `TZ-${NetworkOperator.TIGO.toString().toUpperCase()}-B2C`;
+        }
+        return `TZ-${phoneNumber.networkOperator.id.toString().toUpperCase()}-B2C`;
+    },
+};

package/{dist/modules/payout/payout.model.d.ts → esm/src/models/payout/derivatives/payout.d.ts}

@@ -1,6 +1,7 @@
-import { PayoutDTO, PayoutStatus, PayoutApprovalStatus, PayoutAuthorizer } from "@/modules/payout/payout.dtos.js";
-import { Amount } from "@temboplus/frontend-core";
-import { ContactInfo } from "../contact/contact-info.model.js";
+import { Amount } from "../../../../deps/jsr.io/@temboplus/frontend-core/0.2.21/mod.js";
+import type { PayoutApprover, PayoutData } from "../index.js";
+import { type ContactInfo } from "../../contact/index.js";
+import { type PAYOUT_APPROVAL_STATUS, PAYOUT_STATUS } from "../status.js";
 /**
  * Payout class that wraps the Zod schema and provides additional functionality
  */
@@ -28,7 +29,7 @@ export declare class Payout {
     /** Description of the payout purpose */
     get description(): string;
     /** Optional additional notes about the payout */
-    get notes(): string | undefined | null;
+    get notes(): string | undefined;
     /**
      * Current status of the payout
      * Derived from both approval status and transaction status:
@@ -41,42 +42,59 @@ export declare class Payout {
      * @returns {PAYOUT_STATUS} Current status of the payout
      * @see {@link PAYOUT_STATUS} for all possible status values
      */
-    get status(): PayoutStatus;
+    get status(): PAYOUT_STATUS;
     /** Status message providing details about current state */
     get statusMessage(): string;
     /** Optional reference ID from payment partner */
-    get partnerReference(): string | undefined | null;
+    get partnerReference(): string | undefined;
     /** Timestamp when payout was created */
     get createdAt(): Date;
     /** Timestamp when payout was last updated */
     get updatedAt(): Date;
     /** Timestamp when payout was last updated */
-    get actionedAt(): Date | undefined | null;
+    get actionedAt(): Date | undefined;
     /** Current approval status of the payout */
-    get approvalStatus(): PayoutApprovalStatus | undefined | null;
+    get approvalStatus(): PAYOUT_APPROVAL_STATUS;
     /** Information about who created the payout */
-    get createdBy(): PayoutAuthorizer | undefined | null;
+    get createdBy(): PayoutApprover | undefined;
     /** Information about who last actioned the payout */
-    get actionedBy(): PayoutAuthorizer | undefined | null;
+    get actionedBy(): PayoutApprover | undefined;
     /**
-     * Tries to construct contact information from the payout data.
+     * Constructs contact information based on payout channel
+     *
+     * @returns {ContactInfo | undefined} Contact information object:
+     * - MobileContactInfo for mobile money payouts
+     * - BankContactInfo for bank transfers
+     * - undefined if contact info cannot be constructed
+     *
+     * @remarks
+     * For bank payouts, expects msisdn in format "SWIFTCODE:ACCOUNTNUMBER"
+     *
+     * @example
+     * ```ts
+     * // Mobile payout
+     * payout.contactInfo // Returns MobileContactInfo with phone details
+     *
+     * // Bank payout
+     * payout.contactInfo // Returns BankContactInfo with bank and account details
+     * ```
      */
     get contactInfo(): ContactInfo | undefined;
     /**
      * Creates a Payout instance from raw data
      * @throws {ZodError} if validation fails
      */
-    static create(data: PayoutDTO): Payout;
+    static create(data: PayoutData): Payout;
     /**
      * Creates multiple Payout instances from an array of raw data
      * @throws {ZodError} if validation fails for any item
      */
-    static createMany(dataArray: PayoutDTO[]): Payout[];
+    static createMany(dataArray: PayoutData[]): Payout[];
     /**
      * Creates a Payout instance from raw data without throwing
      * @returns {Payout | null} Payout instance or null if validation fails
      */
-    static createSafe(data: PayoutDTO): Payout | null;
+    static createSafe(data: PayoutData): Payout | null;
     /**
      * Checks if an unknown value contains valid data to construct a Payout instance.
      * This is useful when validating raw data structures before instantiation.
@@ -135,5 +153,6 @@ export declare class Payout {
     /**
      * Converts Payout instance to a plain object
      */
-    toJSON(): PayoutDTO;
+    toJSON(): PayoutData;
 }
+//# sourceMappingURL=payout.d.ts.map

package/esm/src/models/payout/derivatives/payout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"payout.d.ts","sourceRoot":"","sources":["../../../../../src/src/models/payout/derivatives/payout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAuB,MAAM,gEAAgE,CAAC;AAC7G,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9D,OAAO,EAEL,KAAK,WAAW,EAEjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,KAAK,sBAAsB,EAC3B,aAAa,EACd,MAAM,cAAc,CAAC;AAGtB;;GAEG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;IAElC;;OAEG;IACH,OAAO;IAKP,uCAAuC;IACvC,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,qDAAqD;IACrD,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,kCAAkC;IAClC,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,2CAA2C;IAC3C,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,+CAA+C;IAC/C,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,wCAAwC;IACxC,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,iDAAiD;IACjD,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAE9B;IAED;;;;;;;;;;;OAWG;IACH,IAAI,MAAM,IAAI,aAAa,CAe1B;IAED,2DAA2D;IAC3D,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED,iDAAiD;IACjD,IAAI,gBAAgB,IAAI,MAAM,GAAG,SAAS,CAEzC;IAED,wCAAwC;IACxC,IAAI,SAAS,IAAI,IAAI,CAEpB;IAED,6CAA6C;IAC7C,IAAI,SAAS,IAAI,IAAI,CAEpB;IAED,6CAA6C;IAC7C,IAAI,UAAU,IAAI,IAAI,GAAG,SAAS,CAOjC;IAED,4CAA4C;IAC5C,IAAI,cAAc,IAAI,sBAAsB,CAE3C;IAED,+CAA+C;IAC/C,IAAI,SAAS,IAAI,cAAc,GAAG,SAAS,CAE1C;IAED,qDAAqD;IACrD,IAAI,UAAU,IAAI,cAAc,GAAG,SAAS,CAE3C;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,WAAW,IAAI,WAAW,GAAG,SAAS,CA+BzC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAIvC;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,MAAM,EAAE;IAIpD;;;OAGG;WACW,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI;IAQzD;;;;;;;;;;;;;;;;;;;;;OAqBG;WACW,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM;IAUvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM;IAO7C;;OAEG;IACI,MAAM,IAAI,UAAU;CAG5B"}

package/esm/src/models/payout/derivatives/payout.js

@@ -0,0 +1,271 @@
+import { Amount, Bank, TZPhoneNumber } from "../../../../deps/jsr.io/@temboplus/frontend-core/0.2.21/mod.js";
+import { PayoutSchemas } from "../schemas.js";
+import { BankContactInfo, MobileContactInfo, } from "../../contact/index.js";
+import { PAYOUT_STATUS, } from "../status.js";
+import { createPayoutChannelCode } from "../channel.js";
+/**
+ * Payout class that wraps the Zod schema and provides additional functionality
+ */
+export class Payout {
+    /**
+     * Private constructor - use static methods to create instances
+     */
+    constructor(data) {
+        Object.defineProperty(this, "data", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.data = PayoutSchemas.payoutData.parse(data);
+    }
+    // Getters for all properties
+    /** Unique identifier for the payout */
+    get id() {
+        return this.data.id;
+    }
+    /** Profile identifier associated with this payout */
+    get profileId() {
+        return this.data.profileId;
+    }
+    /** Name of the payee/recipient */
+    get payeeName() {
+        return this.data.payeeName;
+    }
+    /** Payment channel used for this payout */
+    get channel() {
+        return this.data.channel;
+    }
+    /** Mobile number or bank account identifier */
+    get msisdn() {
+        return this.data.msisdn;
+    }
+    /**
+     * Amount to be paid out
+     * @returns {Amount} Amount object representing the payout value
+     */
+    get amount() {
+        return Amount.from(this.data.amount);
+    }
+    /** Description of the payout purpose */
+    get description() {
+        return this.data.description;
+    }
+    /** Optional additional notes about the payout */
+    get notes() {
+        return this.data.notes;
+    }
+    /**
+     * Current status of the payout
+     * Derived from both approval status and transaction status:
+     * - Returns REJECTED if approval status is "Rejected"
+     * - Returns FAILED if approved but transaction failed
+     * - Returns PAID if approved and transaction succeeded
+     * - Returns PENDING if awaiting approval
+     * - Falls back to transaction status in other cases
+     *
+     * @returns {PAYOUT_STATUS} Current status of the payout
+     * @see {@link PAYOUT_STATUS} for all possible status values
+     */
+    get status() {
+        if (this.data.approvalStatus === "Rejected") {
+            return PAYOUT_STATUS.REJECTED;
+        }
+        if (this.data.approvalStatus === "Approved") {
+            if (this.data.status === "FAILED") {
+                return PAYOUT_STATUS.FAILED;
+            }
+            return PAYOUT_STATUS.PAID;
+        }
+        if (this.data.approvalStatus === "Pending") {
+            return PAYOUT_STATUS.PENDING;
+        }
+        return this.data.status;
+    }
+    /** Status message providing details about current state */
+    get statusMessage() {
+        return this.data.statusMessage;
+    }
+    /** Optional reference ID from payment partner */
+    get partnerReference() {
+        return this.data.partnerReference;
+    }
+    /** Timestamp when payout was created */
+    get createdAt() {
+        return this.data.createdAt;
+    }
+    /** Timestamp when payout was last updated */
+    get updatedAt() {
+        return this.data.updatedAt;
+    }
+    /** Timestamp when payout was last updated */
+    get actionedAt() {
+        try {
+            // deno-lint-ignore no-explicit-any
+            return this.data.actionedAt ?? undefined;
+        }
+        catch (_) {
+            return undefined;
+        }
+    }
+    /** Current approval status of the payout */
+    get approvalStatus() {
+        return this.data.approvalStatus;
+    }
+    /** Information about who created the payout */
+    get createdBy() {
+        return this.data.createdBy;
+    }
+    /** Information about who last actioned the payout */
+    get actionedBy() {
+        return this.data.actionedBy;
+    }
+    /**
+     * Constructs contact information based on payout channel
+     *
+     * @returns {ContactInfo | undefined} Contact information object:
+     * - MobileContactInfo for mobile money payouts
+     * - BankContactInfo for bank transfers
+     * - undefined if contact info cannot be constructed
+     *
+     * @remarks
+     * For bank payouts, expects msisdn in format "SWIFTCODE:ACCOUNTNUMBER"
+     *
+     * @example
+     * ```ts
+     * // Mobile payout
+     * payout.contactInfo // Returns MobileContactInfo with phone details
+     *
+     * // Bank payout
+     * payout.contactInfo // Returns BankContactInfo with bank and account details
+     * ```
+     */
+    get contactInfo() {
+        let contactInfo;
+        // extracting mobile contact information
+        const phone = TZPhoneNumber.from(this.data.msisdn);
+        if (phone) {
+            contactInfo = new MobileContactInfo(this.data.payeeName, phone);
+        }
+        // extracting bank contact information
+        const isBankPayout = this.data.channel === createPayoutChannelCode.bank() ||
+            this.data.channel === createPayoutChannelCode.verto();
+        if (isBankPayout) {
+            // getting bank information from payout msisdn
+            const text = this.data.msisdn.trim().split(":");
+            try {
+                const swiftcode = text[0];
+                const accNo = text[1];
+                const bank = Bank.fromSWIFTCode(swiftcode);
+                if (bank) {
+                    contactInfo = new BankContactInfo(this.data.payeeName, bank, accNo);
+                }
+            }
+            catch (_) {
+                //
+            }
+        }
+        return contactInfo;
+    }
+    /**
+     * Creates a Payout instance from raw data
+     * @throws {ZodError} if validation fails
+     */
+    static create(data) {
+        return new Payout(data);
+    }
+    /**
+     * Creates multiple Payout instances from an array of raw data
+     * @throws {ZodError} if validation fails for any item
+     */
+    static createMany(dataArray) {
+        return dataArray.map((data) => new Payout(data));
+    }
+    /**
+     * Creates a Payout instance from raw data without throwing
+     * @returns {Payout | null} Payout instance or null if validation fails
+     */
+    static createSafe(data) {
+        try {
+            return new Payout(data);
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * Checks if an unknown value contains valid data to construct a Payout instance.
+     * This is useful when validating raw data structures before instantiation.
+     *
+     * @param {unknown} obj - The value containing potential payout data
+     * @returns {obj is Payout} Type predicate indicating if a Payout can be constructed
+     *
+     * @example
+     * ```typescript
+     * const rawData = await fetchPayoutData();
+     * if (Payout.canConstruct(rawData)) {
+     *   const payout = Payout.create(rawData);
+     *   // TypeScript knows payout is valid here
+     *   console.log(payout.amount.toString());
+     * }
+     * ```
+     *
+     * @throws {never} This method never throws errors
+     *
+     * @remarks
+     * This method performs strict validation against the {@link PayoutData} schema
+     */
+    static canConstruct(obj) {
+        if (!obj || typeof obj !== "object")
+            return false;
+        const result = PayoutSchemas.payoutData.safeParse(obj);
+        if (!result.success)
+            return false;
+        const payout = Payout.createSafe(result.data);
+        return payout !== null;
+    }
+    /**
+     * Validates if an unknown value is a Payout instance.
+     * This is a runtime type guard that ensures proper object structure and data validity.
+     *
+     * @param {unknown} obj - The value to validate
+     * @returns {obj is Payout} Type predicate indicating if the value is a valid Payout
+     *
+     * @example
+     * ```typescript
+     * const maybePayout = getPayoutFromCache();
+     * if (Payout.is(maybePayout)) {
+     *   // TypeScript knows maybePayout is a Payout here
+     *   console.log(maybePayout.status);
+     * }
+     * ```
+     *
+     * @throws {never} This method never throws errors
+     *
+     * @remarks
+     * This method performs a complete structural validation:
+     * 1. Checks if the value is an object
+     * 2. Verifies presence of internal data property
+     * 3. Validates the data against PayoutData schema
+     * 4. Ensures the object is a proper Payout instance
+     *
+     * Use this method when:
+     * - Validating cached Payout instances
+     * - Checking serialized Payout objects
+     * - Verifying API responses
+     * - Type narrowing in conditional blocks
+     */
+    static is(obj) {
+        if (!obj || typeof obj !== "object")
+            return false;
+        if (!("data" in obj))
+            return false;
+        return Payout.canConstruct(obj.data);
+    }
+    /**
+     * Converts Payout instance to a plain object
+     */
+    toJSON() {
+        return { ...this.data };
+    }
+}

package/esm/src/models/payout/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./status.js";
+export * from "./schemas.js";
+export * from "./channel.js";
+export * from "./api.js";
+export * from "./narration.js";
+export * from "./derivatives/payout.js";
+//# sourceMappingURL=index.d.ts.map

package/esm/src/models/payout/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/src/models/payout/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,yBAAyB,CAAC"}

package/esm/src/models/payout/index.js

@@ -0,0 +1,6 @@
+export * from "./status.js";
+export * from "./schemas.js";
+export * from "./channel.js";
+export * from "./api.js";
+export * from "./narration.js";
+export * from "./derivatives/payout.js";

package/esm/src/models/payout/narration.d.ts

@@ -0,0 +1,164 @@
+import { BankContactInfo, type ContactInfo, MobileContactInfo } from "@temboplus/afloat";
+/** Prefix for Ecobank mobile transfer narrations */
+export declare const ECOBANK_PREFIX = "MOBILE TRANSFER ";
+/** Current format prefix for bank payout narrations */
+export declare const BANK_NARR_PREFIX: string;
+/** Legacy format prefix for bank payout narrations */
+export declare const LEGACY_BANK_NARR_PREFIX: string;
+/** Current format prefix for mobile money payout narrations */
+export declare const MOBILE_NARR_PREFIX: string;
+/** Legacy format prefix for mobile money payout narrations */
+export declare const LEGACY_MOBILE_NARR_PREFIX: string;
+/**
+ * Handles payout narration generation and parsing for the Afloat platform.
+ *
+ * This class provides functionality to:
+ * - Generate standardized default narrations for mobile money and bank payouts
+ * - Parse existing narrations to extract contact information
+ * - Format narration text for different display contexts
+ * - Handle both current and legacy narration formats for backward compatibility
+ *
+ * @example
+ * ```typescript
+ * // Generate default narration for a mobile contact
+ * const mobileContact = new MobileContactInfo("John Doe", phoneNumber);
+ * const narration = Narration.generateDefaultPayoutNarration(mobileContact);
+ * // Result: "PAYOUT TO MOBILE +255123456789 JOHN DOE"
+ *
+ * // Parse narration to extract contact details
+ * const existingNarration = new Narration("PAYOUT TO BANK CRDB 1234567890 Jane Smith");
+ * const contact = existingNarration.getContactDetails();
+ * ```
+ */
+export declare class Narration {
+    /** The raw narration text */
+    text: string;
+    /**
+     * Creates a new Narration instance.
+     *
+     * @param text - The narration text to wrap
+     */
+    constructor(text: string);
+    /**
+     * Returns a medium-length version of the narration text suitable for table columns.
+     * Truncates to 47 characters + "..." if longer than 50 characters.
+     *
+     * @returns Truncated narration text for medium-width displays
+     */
+    get mediumText(): string;
+    /**
+     * Returns a short version of the narration text suitable for compact displays.
+     * Truncates to 32 characters + "..." if longer than 35 characters.
+     *
+     * @returns Truncated narration text for narrow displays
+     */
+    get shortText(): string;
+    /**
+     * Generates a default payout narration based on contact information.
+     * Automatically determines whether to generate mobile or bank narration based on contact type.
+     *
+     * @param data - Contact information (either MobileContactInfo or BankContactInfo)
+     * @returns Formatted default narration string in uppercase, or empty string if contact type is unrecognized
+     *
+     * @example
+     * ```typescript
+     * const mobileContact = new MobileContactInfo("John Doe", phoneNumber);
+     * const narration = Narration.generateDefaultPayoutNarration(mobileContact);
+     * // Returns: "PAYOUT TO MOBILE +255123456789 JOHN DOE"
+     *
+     * const bankContact = new BankContactInfo("Jane Smith", bank, "1234567890");
+     * const narration = Narration.generateDefaultPayoutNarration(bankContact);
+     * // Returns: "PAYOUT TO BANK CRDB 1234567890 JANE SMITH"
+     * ```
+     */
+    static generateDefaultPayoutNarration(data: ContactInfo): string;
+    /**
+     * Generates a standardized mobile money payout narration.
+     * Format: "PAYOUT TO MOBILE {phone_number} {name}"
+     *
+     * @param data - Mobile contact information containing phone number and name
+     * @returns Formatted mobile payout narration in uppercase
+     *
+     * @example
+     * ```typescript
+     * const contact = new MobileContactInfo("John Doe", phoneNumber);
+     * const narration = Narration.generateMobilePayoutNarration(contact);
+     * // Returns: "PAYOUT TO MOBILE +255123456789 JOHN DOE"
+     * ```
+     */
+    static generateMobilePayoutNarration(data: MobileContactInfo): string;
+    /**
+     * Generates a standardized bank payout narration.
+     * Format: "PAYOUT TO BANK {bank_short_name} {account_number} {account_name}"
+     *
+     * @param data - Bank contact information containing bank details, account number, and account name
+     * @returns Formatted bank payout narration in uppercase
+     *
+     * @example
+     * ```typescript
+     * const contact = new BankContactInfo("Jane Smith", bank, "1234567890");
+     * const narration = Narration.generateBankPayoutNarration(contact);
+     * // Returns: "PAYOUT TO BANK CRDB 1234567890 JANE SMITH"
+     * ```
+     */
+    static generateBankPayoutNarration(data: BankContactInfo): string;
+    /**
+     * Extracts contact information from the narration text.
+     * Attempts to parse both bank and mobile contact details from the narration.
+     *
+     * @returns Parsed ContactInfo (BankContactInfo or MobileContactInfo) if successful, undefined otherwise
+     *
+     * @example
+     * ```typescript
+     * const narration = new Narration("PAYOUT TO BANK CRDB 1234567890 Jane Smith");
+     * const contact = narration.getContactDetails();
+     * // Returns: BankContactInfo instance with parsed details
+     * ```
+     */
+    getContactDetails: () => ContactInfo | undefined;
+    /**
+     * Extracts bank contact information from the narration text.
+     * Handles both current format ("PAYOUT TO BANK") and legacy format ("TO_BANK").
+     * Also handles Ecobank-prefixed narrations by stripping the prefix.
+     *
+     * Current format: "PAYOUT TO BANK {bank_name} {account_number} {account_name}"
+     * Legacy format: "TO_BANK => {json_object}"
+     *
+     * @returns BankContactInfo if parsing is successful, undefined otherwise
+     *
+     * @example
+     * ```typescript
+     * // Current format
+     * const narration = new Narration("PAYOUT TO BANK CRDB 1234567890 Jane Smith");
+     * const contact = narration.getBankContactDetails();
+     *
+     * // Legacy format
+     * const legacyNarration = new Narration('TO_BANK => {"account_number":"1234567890","account_name":"Jane Smith","swift_code":"CORUTZTZ"}');
+     * const legacyContact = narration.getBankContactDetails();
+     * ```
+     */
+    getBankContactDetails: () => BankContactInfo | undefined;
+    /**
+     * Extracts mobile contact information from the narration text.
+     * Handles both current format ("PAYOUT TO MOBILE") and legacy format ("TO_MOMO").
+     * Also handles Ecobank-prefixed narrations by stripping the prefix.
+     *
+     * Current format: "PAYOUT TO MOBILE {phone_number} {name}"
+     * Legacy format: "TO_MOMO => {json_object}"
+     *
+     * @returns MobileContactInfo if parsing is successful, undefined otherwise
+     *
+     * @example
+     * ```typescript
+     * // Current format
+     * const narration = new Narration("PAYOUT TO MOBILE +255123456789 John Doe");
+     * const contact = narration.getMobileContactDetails();
+     *
+     * // Legacy format
+     * const legacyNarration = new Narration('TO_MOMO => {"phone_number":"+255123456789","username":"John Doe"}');
+     * const legacyContact = narration.getMobileContactDetails();
+     * ```
+     */
+    getMobileContactDetails: () => MobileContactInfo | undefined;
+}
+//# sourceMappingURL=narration.d.ts.map

package/esm/src/models/payout/narration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"narration.d.ts","sourceRoot":"","sources":["../../../../src/src/models/payout/narration.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,KAAK,WAAW,EAChB,iBAAiB,EAClB,MAAM,mBAAmB,CAAC;AAG3B,oDAAoD;AACpD,eAAO,MAAM,cAAc,qBAAqB,CAAC;AAEjD,uDAAuD;AACvD,eAAO,MAAM,gBAAgB,EAAE,MAAyB,CAAC;AACzD,sDAAsD;AACtD,eAAO,MAAM,uBAAuB,EAAE,MAAkB,CAAC;AAEzD,+DAA+D;AAC/D,eAAO,MAAM,kBAAkB,EAAE,MAA2B,CAAC;AAC7D,8DAA8D;AAC9D,eAAO,MAAM,yBAAyB,EAAE,MAAkB,CAAC;AAE3D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,SAAS;IACpB,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;gBACS,IAAI,EAAE,MAAM;IAIxB;;;;;OAKG;IACH,IAAI,UAAU,WAMb;IAED;;;;;OAKG;IACH,IAAI,SAAS,WAMZ;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,8BAA8B,CAAC,IAAI,EAAE,WAAW,GAAG,MAAM;IAUhE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,6BAA6B,CAAC,IAAI,EAAE,iBAAiB,GAAG,MAAM;IAKrE;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,2BAA2B,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM;IAKjE;;;;;;;;;;;;OAYG;IACH,iBAAiB,QAAO,WAAW,GAAG,SAAS,CAM7C;IAEF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,qBAAqB,QAAO,eAAe,GAAG,SAAS,CAqCrD;IAEF;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,uBAAuB,QAAO,iBAAiB,GAAG,SAAS,CAuCzD;CACH"}