@temboplus/afloat 0.1.53 → 0.1.55

package/dist/features/payout/payout-channel-handler.d.ts

@@ -0,0 +1,108 @@
+import { Amount, MNOId, PhoneNumber } from "@temboplus/frontend-core";
+import { PayoutChannel, PayoutInputDTO } from "./payout.dtos";
+import { ContactInfo, MobileContactInfo, BankContactInfo } from "../../models/contact-info.model";
+import { Wallet } from "@/models/wallet.model";
+/**
+ * Valid payout channel codes that can be used in the system
+ *
+ * @remarks
+ * - `${countryCode}-BANK-B2C`: Code for bank transfers
+ * - `${countryCode}-${telecom}-B2C`: Pattern for mobile money transfers where the telecom company is the provider code
+ *
+ * @see {@link PayoutChannelCodeFactory} for functions to generate valid codes
+ */
+export type PayoutChannelCode = `${string}-BANK-B2C` | `${string}-${string}-B2C`;
+/**
+ * Utility functions for generating payout narration strings
+ */
+declare class PayoutNarrationGenerator {
+    /**
+     * Generates a narration string for a mobile payout.
+     *
+     * @param data - The mobile contact information used to generate the narration
+     * @returns A formatted, uppercase narration string for the mobile payout
+     * @throws Will throw an error if the provided data is not a valid MobileContactInfo instance
+     */
+    static generateMobilePayoutNarration(data: MobileContactInfo): string;
+    /**
+     * Generates a narration string for a bank payout.
+     *
+     * @param data - The bank contact information used to generate the narration
+     * @returns A formatted, uppercase narration string for the bank payout
+     * @throws Will throw an error if the provided data is not a valid BankContactInfo instance
+     */
+    static generateBankPayoutNarration(data: BankContactInfo): string;
+}
+/**
+ * Factory for creating standardized payout channel codes
+ *
+ * @example
+ * ```ts
+ * // Create bank channel code
+ * const bankCode = PayoutChannelCodeFactory.forBank(bankContactInfo); // Returns "TZ-BANK-B2C"
+ *
+ * // Create mobile channel code
+ * const mobileCode = PayoutChannelCodeFactory.forMobile(phoneNumber); // Returns "TZ-VODACOM-B2C" for Vodacom number
+ * ```
+ */
+declare class PayoutChannelCodeFactory {
+    /**
+     * Creates a bank transfer channel code
+     * @param contactInfo - Bank contact information
+     * @throws {Error} If country is not supported
+     */
+    static forBank(contactInfo: BankContactInfo, wallet: Wallet): PayoutChannelCode;
+    /**
+     * Creates a mobile money channel code based on the telecom provider
+     * @param phoneNumber - Phone number object containing telecom information
+     * @returns {PayoutChannelCode} Channel code in format "TZ-{TELECOM}-B2C"
+     * @throws {Error} If phone number is invalid or country is not supported
+     *
+     * @see {@link PhoneNumber} from "@temboplus/frontend-core" for phone number structure
+     */
+    static forMobile(phoneNumber: PhoneNumber, mnoId: MNOId, wallet: Wallet): PayoutChannelCode;
+}
+/**
+ * Factory class for creating payout input DTOs based on channel and contact information
+ *
+ * @example
+ * ```ts
+ * const factory = new PayoutInputFactory();
+ * const payoutInput = factory.getPayoutInput({
+ *   channel: PayoutChannel.MOBILE,
+ *   receiver: mobileContactInfo,
+ *   amount: new Amount(1000),
+ *   notes: "Payment for services"
+ * });
+ * ```
+ */
+export declare class PayoutInputFactory {
+    private readonly handlers;
+    /**
+     * Creates a payout input DTO based on the provided parameters
+     *
+     * @param args - Configuration object containing channel, receiver, amount, and optional notes
+     * @returns {PayoutInputDTO} The configured payout input data transfer object
+     * @throws {Error} If no suitable handler is found for the specified channel and contact type
+     */
+    getPayoutInput(args: {
+        channel: PayoutChannel;
+        receiver: ContactInfo;
+        amount: Amount;
+        notes?: string;
+    }, wallet: Wallet): PayoutInputDTO;
+}
+/**
+ * @deprecated Use PayoutNarrationGenerator instead
+ * @see {@link PayoutNarrationGenerator}
+ */
+export declare const PayoutUtils: typeof PayoutNarrationGenerator;
+/**
+ * @deprecated Use PayoutChannelCodeFactory instead
+ * @see {@link PayoutChannelCodeFactory}
+ */
+export declare const createPayoutChannelCode: {
+    bank: typeof PayoutChannelCodeFactory.forBank;
+    mobile: typeof PayoutChannelCodeFactory.forMobile;
+};
+export {};