@temboplus/afloat 0.1.77-beta.8 → 0.1.78

package/dist/modules/wallet/narration.model.d.ts

@@ -1,229 +0,0 @@
-import { ContactInfo, MobileContactInfo, BankContactInfo } from "../contact/contact-info.model.js";
-/** Prefix for Ecobank mobile transfer narrations */
-export declare const ECOBANK_PREFIX = "MOBILE TRANSFER ";
-/** V2 format prefix for payout narrations using contact details */
-export declare const NARR_V2_PREFIX: string;
-/** V1 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;
-/** V1 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;
-/**
- * Interface for the JSON representation of Narration
- */
-export interface NarrationJson {
-    text: string;
-    version?: string;
-}
-/**
- * Handles payout narration generation and parsing for the Afloat platform.
- *
- * This class provides functionality to:
- * - Generate standardized payout narrations using contact details (V2 format)
- * - Parse existing narrations to extract contact information
- * - Format narration text for different display contexts
- * - Handle V2 (PAY format), V1, and legacy narration formats for backward compatibility
- * - Serialize/deserialize to/from JSON format
- *
- * @example
- * ```typescript
- * // Generate V2 narration using contact info
- * const mobileContact = new MobileContactInfo("John Doe", phoneNumber);
- * const narration = Narration.generateDefaultPayoutNarration(mobileContact);
- * // Result: "PAYOUT +255123456789 JOHN DOE"
- *
- * const bankContact = new BankContactInfo("Jane Smith", bank, "1234567890");
- * const narration = Narration.generateDefaultPayoutNarration(bankContact);
- * // Result: "PAYOUT CORUTZTZ 1234567890 JANE SMITH"
- *
- * // Extract contact details from narration
- * const existingNarration = new Narration("PAYOUT +255123456789 JOHN DOE");
- * const contactInfo = existingNarration.getContactDetails();
- * // Returns: MobileContactInfo instance
- * ```
- */
-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 the default payout narration based on contact information using the V2 format.
-     * 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 using V2 format, or empty string if contact type is unrecognized
-     *
-     * @example
-     * ```typescript
-     * const mobileContact = new MobileContactInfo("John Doe", phoneNumber);
-     * const narration = Narration.generateDefaultPayoutNarration(mobileContact);
-     * // Returns: "PAYOUT +255123456789 JOHN DOE"
-     *
-     * const bankContact = new BankContactInfo("Jane Smith", bank, "1234567890");
-     * const narration = Narration.generateDefaultPayoutNarration(bankContact);
-     * // Returns: "PAYOUT CORUTZTZ 1234567890 JANE SMITH"
-     * ```
-     */
-    static generateDefaultPayoutNarration(data: ContactInfo): string;
-    /**
-     * Generates a V2 standardized mobile money payout narration with contact details.
-     * Format: "PAY {phone_number} {name}"
-     *
-     * @param data - Mobile contact information containing phone number and name
-     * @returns Formatted V2 mobile payout narration in uppercase
-     *
-     * @example
-     * ```typescript
-     * const contact = new MobileContactInfo("John Doe", phoneNumber);
-     * const narration = Narration.generateMobilePayoutNarrationV2(contact);
-     * // Returns: "PAYOUT +255123456789 JOHN DOE"
-     * ```
-     */
-    static generateMobilePayoutNarrationV2(data: MobileContactInfo): string;
-    /**
-     * Generates a V2 standardized bank payout narration with contact details.
-     * Format: "PAY {swift_code} {account_number} {account_name}"
-     *
-     * @param data - Bank contact information containing bank details, account number, and account name
-     * @returns Formatted V2 bank payout narration in uppercase
-     *
-     * @example
-     * ```typescript
-     * const contact = new BankContactInfo("Jane Smith", bank, "1234567890");
-     * const narration = Narration.generateBankPayoutNarrationV2(contact);
-     * // Returns: "PAYOUT CORUTZTZ 1234567890 JANE SMITH"
-     * ```
-     */
-    static generateBankPayoutNarrationV2(data: BankContactInfo): string;
-    /**
-     * Extracts contact information from the narration text.
-     * Supports V2 (PAY format), V1, and legacy formats for comprehensive contact detection.
-     *
-     * @returns Parsed ContactInfo (BankContactInfo or MobileContactInfo) if successful, undefined otherwise
-     *
-     * @example
-     * ```typescript
-     * // V2 format
-     * const v2Narration = new Narration("PAYOUT +255123456789 JOHN DOE");
-     * const v2Contact = v2Narration.getContactDetails();
-     * // Returns: MobileContactInfo instance
-     *
-     * // V1 format
-     * const v1Narration = new Narration("PAYOUT TO BANK CRDB 1234567890 Jane Smith");
-     * const v1Contact = v1Narration.getContactDetails();
-     * // Returns: BankContactInfo instance
-     * ```
-     */
-    getContactDetails: () => ContactInfo | undefined;
-    /**
-     * Extracts bank contact information from the narration text.
-     * Handles V2 format (PAY with SWIFT code and details), V1 format, and legacy format.
-     * Also handles Ecobank-prefixed narrations by stripping the prefix.
-     *
-     * V2 format: "PAYOUT {swift_code} {account_number} {account_name}"
-     * V1 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
-     * // V2 format
-     * const v2Narration = new Narration("PAYOUT CORUTZTZ 1234567890 JANE SMITH");
-     * const v2Contact = v2Narration.getBankContactDetails();
-     *
-     * // V1 format
-     * const v1Narration = new Narration("PAYOUT TO BANK CRDB 1234567890 Jane Smith");
-     * const v1Contact = v1Narration.getBankContactDetails();
-     * ```
-     */
-    getBankContactDetails: () => BankContactInfo | undefined;
-    /**
-     * Extracts mobile contact information from the narration text.
-     * Handles V2 format (PAY with phone number and name), V1 format, and legacy format.
-     * Also handles Ecobank-prefixed narrations by stripping the prefix.
-     *
-     * V2 format: "PAYOUT {phone_number} {name}"
-     * V1 format: "PAYOUT TO MOBILE {phone_number} {name}"
-     * Legacy format: "TO_MOMO => {json_object}"
-     *
-     * @returns MobileContactInfo if parsing is successful, undefined otherwise
-     *
-     * @example
-     * ```typescript
-     * // V2 format
-     * const v2Narration = new Narration("PAYOUT +255123456789 JOHN DOE");
-     * const v2Contact = v2Narration.getMobileContactDetails();
-     *
-     * // V1 format
-     * const v1Narration = new Narration("PAYOUT TO MOBILE +255123456789 John Doe");
-     * const v1Contact = v1Narration.getMobileContactDetails();
-     * ```
-     */
-    getMobileContactDetails: () => MobileContactInfo | undefined;
-    /**
-     * Serializes the Narration instance to a JSON-compatible object.
-     *
-     * @returns {NarrationJson} A plain object containing the narration data
-     *
-     * @example
-     * ```typescript
-     * const narration = new Narration("PAYOUT +255123456789 JOHN DOE");
-     * const json = narration.toJson();
-     * // Returns: { text: "PAYOUT +255123456789 JOHN DOE", version: "2.0" }
-     * ```
-     */
-    toJson(): NarrationJson;
-    /**
-     * Creates a Narration instance from a JSON-compatible object.
-     *
-     * @param {NarrationJson | string} json - Either a NarrationJson object or a JSON string
-     * @returns {Narration | undefined} A Narration instance if valid, undefined otherwise
-     *
-     * @example
-     * ```typescript
-     * // From object
-     * const narration = Narration.fromJson({ text: "PAYOUT +255123456789 JOHN DOE" });
-     *
-     * // From JSON string
-     * const narration = Narration.fromJson('{"text":"PAYOUT +255123456789 JOHN DOE"}');
-     * ```
-     */
-    static fromJson(json: NarrationJson | string): Narration | undefined;
-    /**
-     * Type guard to check if an object is a valid NarrationJson
-     *
-     * @param obj - The object to validate
-     * @returns True if the object conforms to NarrationJson structure
-     */
-    static isNarrationJson(obj: unknown): obj is NarrationJson;
-    /**
-     * Type guard to check if an unknown object is a valid Narration instance.
-     *
-     * @param obj - The object to check
-     * @returns Type predicate indicating if the object is a Narration instance
-     */
-    static is(obj: unknown): obj is Narration;
-}

package/dist/modules/wallet/statement-entry.model.d.ts

@@ -1,200 +0,0 @@
-import { WalletStatementEntryDTO } from "@/modules/wallet/wallet.dtos.js";
-import { Amount, AmountJson } from "@temboplus/frontend-core";
-import { NarrationJson, Narration } from "./narration.model.js";
-/**
- * Interface for the JSON representation of WalletStatementEntry
- */
-export interface WalletStatementEntryJson {
-    accountNo?: string;
-    debitOrCredit: string;
-    tranRefNo: string;
-    narration: NarrationJson;
-    txnDate: string;
-    valueDate: string;
-    amountCredited: AmountJson;
-    amountDebited: AmountJson;
-    balance: AmountJson;
-    currencyCode: string;
-    version?: string;
-}
-/**
- * Represents a single entry in a Wallet's statement history.
- *
- * This class provides methods for creating, validating, and accessing statement entry data.
- * It integrates with the Zod schema validation for data integrity and includes narration parsing capabilities.
- * The narration field now uses the Narration class for enhanced functionality.
- */
-export declare class WalletStatementEntry {
-    private _accountNo?;
-    private _debitOrCredit;
-    private _tranRefNo;
-    private _narration;
-    private _txnDate;
-    private _valueDate;
-    private _amountCredited;
-    private _amountDebited;
-    private _balance;
-    private _currencyCode;
-    /**
-     * Gets the statement entry schema used for validation.
-     */
-    static get schema(): import("zod").ZodObject<{
-        accountNo: import("zod").ZodEffects<import("zod").ZodOptional<import("zod").ZodString>, string | undefined, string | undefined>;
-        debitOrCredit: import("zod").ZodString;
-        tranRefNo: import("zod").ZodString;
-        narration: import("zod").ZodString;
-        txnDate: import("zod").ZodDate;
-        valueDate: import("zod").ZodDate;
-        amountCredited: import("zod").ZodNumber;
-        amountDebited: import("zod").ZodNumber;
-        balance: import("zod").ZodNumber;
-        currencyCode: import("zod").ZodDefault<import("zod").ZodEffects<import("zod").ZodOptional<import("zod").ZodString>, string | undefined, string | undefined>>;
-    }, "strip", import("zod").ZodTypeAny, {
-        currencyCode: string;
-        debitOrCredit: string;
-        tranRefNo: string;
-        narration: string;
-        txnDate: Date;
-        valueDate: Date;
-        amountCredited: number;
-        amountDebited: number;
-        balance: number;
-        accountNo?: string | undefined;
-    }, {
-        debitOrCredit: string;
-        tranRefNo: string;
-        narration: string;
-        txnDate: Date;
-        valueDate: Date;
-        amountCredited: number;
-        amountDebited: number;
-        balance: number;
-        accountNo?: string | undefined;
-        currencyCode?: string | undefined;
-    }>;
-    /**
-     * Private constructor to enforce use of static factory methods.
-     * Assumes data is already validated and dates are Date objects.
-     * @param data - Object containing statement entry information conforming to WalletStatementEntryDTO.
-     * @param narration - Narration instance for the transaction
-     */
-    private constructor();
-    /**
-     * Creates a new WalletStatementEntry instance after validating the input data.
-     * Handles date coercion via the schema and uses currencyCode from the data.
-     *
-     * @param data - Object containing statement entry information. Dates can be strings or Date objects.
-     * @returns A new WalletStatementEntry instance, or undefined if validation fails.
-     */
-    static create(data: {
-        accountNo?: string | null;
-        debitOrCredit: string;
-        tranRefNo: string;
-        narration: string | Narration;
-        txnDate: string | Date;
-        valueDate: string | Date;
-        amountCredited: number;
-        amountDebited: number;
-        balance: number;
-        currencyCode?: string;
-    }): WalletStatementEntry | undefined;
-    get accountNo(): string | undefined;
-    get debitOrCredit(): string;
-    get tranRefNo(): string;
-    get narration(): Narration;
-    get txnDate(): Date;
-    get valueDate(): Date;
-    get amountCredited(): Amount;
-    get amountDebited(): Amount;
-    get balance(): Amount;
-    get currencyCode(): string;
-    /**
-     * Serializes the WalletStatementEntry instance to a JSON-compatible object.
-     * Dates are converted to ISO strings, amounts are serialized using Amount.toJson(),
-     * and narration is serialized using Narration.toJson().
-     *
-     * @returns {WalletStatementEntryJson} A plain object containing all necessary data
-     */
-    toJson(): WalletStatementEntryJson;
-    /**
-     * Creates a WalletStatementEntry instance from a JSON-compatible object.
-     *
-     * @param {WalletStatementEntryJson | string} json - Either a WalletStatementEntryJson object or a JSON string
-     * @returns {WalletStatementEntry | undefined} A WalletStatementEntry instance if valid, undefined otherwise
-     */
-    static fromJson(json: WalletStatementEntryJson | string): WalletStatementEntry | undefined;
-    /**
-     * Type guard to check if an object is a valid WalletStatementEntryJson
-     *
-     * @param obj - The object to validate
-     * @returns True if the object conforms to WalletStatementEntryJson structure
-     */
-    static isWalletStatementEntryJson(obj: unknown): obj is WalletStatementEntryJson;
-    /**
-     * Validates the current statement entry instance data against the schema.
-     * @returns True if the statement entry instance data is valid, false otherwise.
-     */
-    validate(): boolean;
-    /**
-     * Type guard to check if an unknown object is a valid WalletStatementEntry instance.
-     * Performs structural checks (duck typing).
-     * @param obj - The object to check.
-     * @returns Type predicate indicating if the object is a WalletStatementEntry instance.
-     */
-    static is(obj: unknown): obj is WalletStatementEntry;
-    /**
-     * Checks if two WalletStatementEntry instances are equal based on their transaction reference numbers.
-     * @param other - Another WalletStatementEntry to compare with.
-     * @returns True if both entries have the same transaction reference number.
-     */
-    equals(other: WalletStatementEntry): boolean;
-    /**
-     * Creates a copy of this WalletStatementEntry with the same data.
-     * @returns A new WalletStatementEntry instance with identical data.
-     */
-    clone(): WalletStatementEntry | undefined;
-    /**
-     * Returns a string representation of the statement entry for debugging.
-     * @returns A formatted string with key transaction details.
-     */
-    toString(): string;
-    /**
-     * Serializes an array of WalletStatementEntry instances to JSON-compatible objects
-     *
-     * @param entries - Array of WalletStatementEntry instances to serialize
-     * @returns Array of WalletStatementEntryJson objects
-     */
-    static toJsonArray(entries: WalletStatementEntry[]): WalletStatementEntryJson[];
-    /**
-     * Creates WalletStatementEntry instances from an array of JSON-compatible objects
-     *
-     * @param jsonArray - Array of WalletStatementEntryJson objects or JSON string
-     * @returns Array of WalletStatementEntry instances (invalid items are filtered out)
-     */
-    static fromJsonArray(jsonArray: WalletStatementEntryJson[] | string): WalletStatementEntry[];
-    /**
-     * Legacy method for backwards compatibility - creates object representation
-     * @deprecated Use toJson() instead for proper serialization
-     */
-    toObject(): Omit<WalletStatementEntryDTO, "amountCredited" | "amountDebited" | "balance" | "narration"> & {
-        amountCredited: AmountJson;
-        amountDebited: AmountJson;
-        balance: AmountJson;
-        narration: string;
-    };
-    /**
-     * Legacy method for backwards compatibility - converts to JSON string
-     * @deprecated Use JSON.stringify(entry.toJson()) instead
-     */
-    toJSON(): string;
-    /**
-     * Legacy method for backwards compatibility
-     * @deprecated Use fromJson() instead
-     */
-    static fromJSON(jsonString: string): WalletStatementEntry | undefined;
-    /**
-     * Legacy method for backwards compatibility - creates from plain object
-     * @deprecated Use fromJson() for serialized data or create() for raw data
-     */
-    static from(data: any): WalletStatementEntry | undefined;
-}

package/dist/modules/wallet/wallet-manager.session.d.ts

@@ -1,143 +0,0 @@
-import { Country, type CountryCode } from "@temboplus/frontend-core";
-import { Wallet } from "./wallet.model.js";
-import { User } from "../auth/user.model.js";
-/**
- * Defines the shape of the persisted wallet session state.
- * IMPORTANT: Properties like selectedWalletId/selectedCountryCode are guaranteed
- * non-nullable and valid ONLY when isInitialized is true.
- */
-interface WalletSession {
-    userId: string;
-    wallets: Wallet[];
-    selectedWalletId: string;
-    selectedCountryCode: CountryCode;
-    lastSynced: Date | string;
-    isInitialized: boolean;
-}
-/**
- * Defines the complete state shape including actions and internal getters.
- */
-interface WalletState extends WalletSession {
-    setWallets: (wallets: Wallet[]) => void;
-    setSelectedWallet: (wallet: Wallet) => void;
-    setSelectedCountry: (countryCode: CountryCode) => void;
-    reset: () => void;
-    _getWalletsByCountry: (countryCode: CountryCode) => Wallet[];
-    _getSelectedWallet: () => Wallet;
-}
-export declare const walletsStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<WalletState>, "persist"> & {
-    persist: {
-        setOptions: (options: Partial<import("zustand/middleware").PersistOptions<WalletState, unknown>>) => void;
-        clearStorage: () => void;
-        rehydrate: () => Promise<void> | void;
-        hasHydrated: () => boolean;
-        onHydrate: (fn: (state: WalletState) => void) => () => void;
-        onFinishHydration: (fn: (state: WalletState) => void) => () => void;
-        getOptions: () => Partial<import("zustand/middleware").PersistOptions<WalletState, unknown>>;
-    };
-}>;
-/**
- * WalletSessionManager handles wallet-related operations and state management coordination.
- * It uses a Zustand store (`useWalletStore`) for state and interacts with WalletRepo.
- *
- * IMPORTANT: This manager enforces the invariant that an initialized user session
- * always has at least one wallet and a valid selection. Methods that return selected
- * data (`getSelectedWallet`, `getSelectedCountry`, etc.) will THROW AN ERROR if called
- * before the session is initialized via the `initialize()` method.
- */
-export declare class WalletSessionManager {
-    private repo;
-    private static _instance;
-    /**
-     * @private
-     */
-    private constructor();
-    /**
-     * Gets the singleton instance of WalletSessionManager.
-     * @returns {WalletSessionManager} The singleton instance.
-     */
-    static get instance(): WalletSessionManager;
-    /**
-     * Checks if the wallet session is initialized.
-     * @returns {boolean} True if initialized, false otherwise.
-     */
-    isInitialized(): boolean;
-    /**
-     * Initializes the wallet manager for the current user.
-     * Fetches wallets if the store isn't already initialized.
-     * Throws an error if the user is not authenticated or if the user is found to have no wallets.
-     * @async
-     * @returns {Promise<void>} Resolves when initialization is complete.
-     * @throws {Error} If user not authenticated or user has no wallets.
-     */
-    initialize(user: User): Promise<void>;
-    /**
-     * Fetches the latest wallet data from the server and updates the store.
-     * Throws an error if the user has no wallets or if the fetch fails.
-     * Ensures the store is updated and marked as initialized.
-     * @async
-     * @returns {Promise<void>} Resolves when refresh is complete.
-     * @throws {Error} If fetch fails or user has no wallets.
-     */
-    refreshWallets(): Promise<void>;
-    /**
-     * Gets all available wallets. Guaranteed non-empty after successful initialization.
-     * @returns {Wallet[]} Non-empty array of Wallet instances.
-     * @throws {Error} If called before initialization is complete.
-     */
-    getWallets(): Wallet[];
-    /**
-     * Gets unique available country codes based on current wallets.
-     * @returns {CountryCode[]} Array of CountryCodes. Guaranteed non-empty after initialization.
-     * @throws {Error} If called before initialization is complete.
-     */
-    getCountries(): CountryCode[];
-    /**
-     * Gets wallets for a specific country.
-     * @param {CountryCode} countryCode The country code to filter by.
-     * @returns {Wallet[]} Array of Wallet instances for the country. May be empty if no wallets match the code, but the overall list isn't empty.
-     * @throws {Error} If called before initialization is complete.
-     */
-    getWalletsByCountry(countryCode: CountryCode): Wallet[];
-    /**
-     * Gets the currently selected wallet instance.
-     * @returns {Wallet} The selected Wallet instance (guaranteed non-nullable).
-     * @throws {Error} If called before initialization is complete or if state is inconsistent.
-     */
-    getSelectedWallet(): Wallet;
-    /**
-     * Gets the currently selected country code.
-     * @returns {CountryCode} The selected CountryCode (guaranteed non-nullable).
-     * @throws {Error} If called before initialization is complete.
-     */
-    getSelectedCountryCode(): CountryCode;
-    /**
-     * Gets the currently selected Country object.
-     * @returns {Country} The selected Country object (guaranteed non-nullable).
-     * @throws {Error} If called before initialization or if Country.fromCode fails for the selected code.
-     */
-    getSelectedCountry(): Country;
-    /**
-     * Changes the selected wallet in the store.
-     * Throws error if the provided walletId is not found in the current list.
-     * @param {string} walletId - The ID of the wallet to select.
-     * @returns {void}
-     * @throws {Error} If wallet with given ID is not found or if called before initialization.
-     */
-    changeWallet(walletId: string): void;
-    /**
-     * Changes the selected country in the store.
-     * Automatically selects the first available wallet for that country.
-     * Throws error if no wallets exist for the given countryCode or if called before initialization.
-     * @param {CountryCode} countryCode - The country code to select.
-     * @returns {void}
-     * @throws {Error} If no wallets found for the country code or if called before initialization.
-     */
-    changeCountry(countryCode: CountryCode): void;
-    /**
-     * Resets the wallet store to  initial (uninitialized) state.
-     * Typically used during user logout.
-     */
-    reset(): void;
-}
-export {};