@temboplus/afloat 0.1.77-beta.8 → 0.1.78

package/dist/modules/contact/contact-info.model.d.ts

@@ -1,446 +0,0 @@
-import { ContactType, ContactDTO } from "@/modules/contact/contact.dtos.js";
-import { PayoutDTO } from "@/modules/payout/payout.dtos.js";
-import { Bank, ISO2CountryCode, PhoneNumber } from "@temboplus/frontend-core";
-import type { BankSwiftCode, MNOId } from "@temboplus/frontend-core";
-/**
- * Abstract base class that provides a common interface for different types of contact information.
- * This class defines the structure and validation requirements for both mobile and bank contacts.
- *
- * Serves as the foundation for type-safe contact handling throughout the application,
- * ensuring consistent behavior between mobile money and bank transfer contacts.
- *
- * **Country Code Handling:**
- * The country code is always derived from the underlying domain objects (PhoneNumber or Bank)
- * rather than being passed as a separate parameter, ensuring consistency and single source of truth.
- *
- * @abstract
- * @class BaseContactInfo
- *
- * @property {ContactType} type - The type of contact (either "Mobile" or "Bank")
- * @property {ISO2CountryCode} countryCode - The ISO2 country code derived from PhoneNumber or Bank
- *
- * @example
- * ```typescript
- * // Cannot instantiate directly - use concrete implementations
- * const mobileContact = MobileContactInfo.from({ name: "John Doe", phoneNumber });
- * const bankContact = BankContactInfo.from({ accName: "Jane Smith", bank, accNo: "123456789" });
- *
- * // Polymorphic usage
- * function processContact(contact: BaseContactInfo) {
- *   console.log(`Processing ${contact.type} contact: ${contact.displayName}`);
- *   console.log(`Channel: ${contact.channelDisplayName}`);
- *   console.log(`Country: ${contact.countryCode}`); // Always available
- * }
- * ```
- */
-declare abstract class BaseContactInfo {
-    readonly type: ContactType;
-    readonly countryCode: ISO2CountryCode;
-    /**
-     * Creates a new instance of BaseContactInfo.
-     * Protected constructor ensures only subclasses can instantiate.
-     *
-     * @protected
-     * @param {ContactType} type - The type of contact to create ("Mobile" or "Bank")
-     * @param {ISO2CountryCode} countryCode - The ISO2 country code derived from domain objects
-     */
-    constructor(type: ContactType, countryCode: ISO2CountryCode);
-    /**
-     * Gets the typed channel identifier for the contact.
-     * Returns MNO ID for mobile contacts, SWIFT code for bank contacts.
-     *
-     * @abstract
-     * @returns {MNOId | BankSwiftCode} The typed channel identifier
-     *
-     * @example
-     * ```typescript
-     * const mobileChannel: MNOId = mobileContact.channelId; // "VODACOM", "SAFARICOM", etc.
-     * const bankChannel: BankSwiftCode = bankContact.channelId; // "CORUTZTZ", "KCBLKENX", etc.
-     * ```
-     */
-    abstract get channelId(): MNOId | BankSwiftCode;
-    /**
-     * Gets the human-readable channel name for display purposes.
-     * Returns mobile money service name for mobile contacts, bank short name for bank contacts.
-     *
-     * @abstract
-     * @returns {string} The display-friendly channel name
-     *
-     * @example
-     * ```typescript
-     * console.log(mobileContact.channelName); // "M-Pesa", "Airtel Money", etc.
-     * console.log(bankContact.channelName); // "CRDB", "KCB", etc.
-     * ```
-     */
-    abstract get channelName(): string;
-    /**
-     * Gets the primary display name for the contact.
-     *
-     * @abstract
-     * @returns {string} The contact's display name (personal name for mobile, account name for bank)
-     */
-    abstract get accountName(): string;
-    /**
-     * Gets the primary account/identification number for the contact.
-     *
-     * @abstract
-     * @returns {string} The contact's number (phone number for mobile, account number for bank)
-     */
-    abstract get accountNumber(): string;
-    /**
-     * Gets the localized label for the display name field.
-     *
-     * @abstract
-     * @returns {string} The appropriate label for the display name based on contact type
-     */
-    abstract get accountNameLabel(): string;
-    /**
-     * Gets the localized label for the account number field.
-     *
-     * @abstract
-     * @returns {string} The appropriate label for the account number based on contact type
-     */
-    abstract get accountNumberLabel(): string;
-    /**
-     * Gets the localized label for the channel field.
-     *
-     * @abstract
-     * @returns {string} The appropriate label for the channel based on contact type
-     */
-    abstract get channelLabel(): string;
-    /**
-     * Validates that all contact information is consistent and correct.
-     *
-     * @abstract
-     * @returns {boolean} True if the contact information is valid
-     */
-    abstract validate(): boolean;
-    /**
-     * Converts the contact info to a plain JavaScript object for serialization.
-     *
-     * @abstract
-     * @returns {Record<string, unknown>} Plain object representation
-     */
-    abstract toObject(): Record<string, unknown>;
-    /**
-     * Serializes the contact info to a JSON string.
-     *
-     * @returns {string} JSON string representation
-     *
-     * @example
-     * ```typescript
-     * const contact = MobileContactInfo.from({ name: "John", phoneNumber });
-     * const jsonString = contact.toJSON();
-     * // Store or transmit jsonString
-     * ```
-     */
-    toJSON(): string;
-}
-/**
- * Implementation of BaseContactInfo for mobile phone contacts.
- * Handles storage, validation, and display of contact details specific to mobile money services.
- *
- * This class properly delegates MNO-related logic to country-specific implementations,
- * supporting both countries with Mobile Number Portability (MNP) and those without.
- * The country code is always derived from the PhoneNumber object, ensuring consistency.
- *
- * **Key Features:**
- * - Automatic MNO detection for countries without MNP (e.g., Tanzania)
- * - Explicit MNO requirement for countries with MNP (e.g., Kenya)
- * - Country-specific validation through MNOUtils delegation
- * - Comprehensive error handling with structured context
- * - Country code derived from PhoneNumber (single source of truth)
- *
- * **MNP Handling:**
- * - **Tanzania (no MNP)**: MNO is always auto-detected from phone number prefix, ignoring any provided MNO
- * - **Kenya (has MNP)**: MNO must be explicitly provided as numbers can be ported
- *
- * @extends BaseContactInfo
- * @class MobileContactInfo
- *
- * @property {string} name - The contact's personal name
- * @property {PhoneNumber} phoneNumber - The validated phone number object
- * @property {MNOId} mnoId - The mobile network operator identifier (always available after construction)
- *
- * @example
- * ```typescript
- * // Preferred: Use static factory method
- * const tzContact = MobileContactInfo.from({
- *   name: "John Doe",
- *   phoneNumber: tzPhoneNumber
- * });
- * console.log(tzContact?.channelName); // "M-Pesa" (Vodacom's service)
- *
- * // From JSON
- * const jsonContact = MobileContactInfo.fromJSON(jsonString);
- * ```
- */
-export declare class MobileContactInfo extends BaseContactInfo {
-    readonly name: string;
-    readonly phoneNumber: PhoneNumber;
-    readonly mnoId: MNOId;
-    /**
-     * Creates a new mobile contact with comprehensive validation.
-     *
-     * **Validation Process:**
-     * 1. Validates name is non-empty
-     * 2. Validates phone number structure
-     * 3. Extracts country code from PhoneNumber object
-     * 4. Handles MNO validation based on country MNP status
-     *
-     * @deprecated Use {@link MobileContactInfo.from} static factory method instead
-     * @param {string} name - The contact's personal name (required, non-empty)
-     * @param {PhoneNumber} phoneNumber - The validated phone number object (contains country code)
-     * @param {MNOId} [mnoId] - MNO ID. Required for MNP countries (KE), ignored for non-MNP countries (TZ)
-     *
-     * @throws {ContactInfoError} When any validation fails
-     */
-    constructor(name: string, phoneNumber: PhoneNumber, mnoId?: MNOId);
-    /**
-     * Creates a MobileContactInfo instance from data object.
-     * This is the preferred method for creating instances.
-     *
-     * @static
-     * @param {Object} data - The mobile contact data
-     * @param {string} data.name - The contact's personal name
-     * @param {PhoneNumber} data.phoneNumber - The validated phone number object
-     * @param {MNOId} [data.mnoId] - MNO ID (required for MNP countries)
-     *
-     * @returns {MobileContactInfo | undefined} New instance if successful, undefined if validation fails
-     *
-     * @example
-     * ```typescript
-     * const contact = MobileContactInfo.from({
-     *   name: "John Doe",
-     *   phoneNumber: tzPhone,
-     *   mnoId: TZMNOId.VODACOM // Optional for TZ, required for KE
-     * });
-     * ```
-     */
-    static from(data: {
-        name: string;
-        phoneNumber: PhoneNumber;
-        mnoId?: MNOId;
-    }): MobileContactInfo | undefined;
-    /**
-     * Creates a MobileContactInfo instance from a ContactDTO object.
-     * Handles validation and MNO extraction from the DTO's channel field.
-     *
-     * @static
-     * @param {ContactDTO} info - The contact data transfer object
-     * @returns {MobileContactInfo | undefined} New instance if successful, undefined if validation fails
-     *
-     * @example
-     * ```typescript
-     * const contactDTO = {
-     *   type: "Mobile",
-     *   accountNo: "+255712345678",
-     *   displayName: "John Doe",
-     *   channel: "VODACOM"
-     * };
-     *
-     * const contact = MobileContactInfo.fromContactDTO(contactDTO);
-     * ```
-     */
-    static fromContactDTO(info: ContactDTO): MobileContactInfo | undefined;
-    /**
-     * Creates a MobileContactInfo instance from a PayoutDTO object.
-     * Extracts mobile contact information from payout data structure.
-     *
-     * @static
-     * @param {PayoutDTO} info - The payout data transfer object
-     * @returns {MobileContactInfo | undefined} New instance if successful, undefined if parsing fails
-     *
-     * @example
-     * ```typescript
-     * const payoutDTO = {
-     *   msisdn: "+255712345678",
-     *   countryCode: "TZ",
-     *   payeeName: "John Doe",
-     *   channel: "VODACOM"
-     * };
-     *
-     * const contact = MobileContactInfo.fromPayoutDTO(payoutDTO);
-     * ```
-     */
-    static fromPayoutDTO(info: PayoutDTO): MobileContactInfo | undefined;
-    /**
-     * Creates a MobileContactInfo instance from a JSON string.
-     *
-     * @static
-     * @param {string} jsonString - JSON string containing mobile contact data
-     * @returns {MobileContactInfo | undefined} New instance if successful, undefined if parsing fails
-     *
-     * @example
-     * ```typescript
-     * const jsonString = '{"name":"John Doe","phoneNumber":"+255712345678","mnoId":"VODACOM"}';
-     * const contact = MobileContactInfo.fromJSON(jsonString);
-     * ```
-     */
-    static fromJSON(jsonString: string): MobileContactInfo | undefined;
-    /**
-     * Type guard to validate if an unknown object is a valid MobileContactInfo instance.
-     *
-     * @static
-     * @param {unknown} obj - The object to validate
-     * @returns {obj is MobileContactInfo} Type predicate indicating validity
-     *
-     * @example
-     * ```typescript
-     * if (MobileContactInfo.is(unknownData)) {
-     *   console.log(unknownData.name); // Type-safe access
-     * }
-     * ```
-     */
-    static is(obj: unknown): obj is MobileContactInfo;
-    /**
-     * Validates that all contact information is consistent and correct.
-     *
-     * @returns {boolean} True if all validations pass, false otherwise
-     */
-    validate(): boolean;
-    /**
-     * Provides detailed validation results with specific error and warning information.
-     *
-     * @returns {Object} Detailed validation results
-     */
-    getValidationDetails(): {
-        isValid: boolean;
-        errors: string[];
-        warnings: string[];
-    };
-    /**
-     * Converts the mobile contact info to a plain object for serialization.
-     *
-     * @override
-     * @returns {Record<string, unknown>} Plain object representation
-     */
-    toObject(): Record<string, unknown>;
-    get accountName(): string;
-    get accountNumber(): string;
-    get accountNameLabel(): string;
-    get accountNumberLabel(): string;
-    get channelLabel(): string;
-    get channelId(): MNOId;
-    get channelName(): string;
-}
-/**
- * Implementation of BaseContactInfo for bank account contacts.
- * Handles storage, validation, and display of contact details specific to bank transfers.
- *
- * @extends BaseContactInfo
- * @class BankContactInfo
- *
- * @example
- * ```typescript
- * const bank = Bank.from("CORUTZTZ", "TZ");
- * const contact = BankContactInfo.from({
- *   accName: "John Doe",
- *   bank,
- *   accNo: "0150123456789"
- * });
- * ```
- */
-export declare class BankContactInfo extends BaseContactInfo {
-    readonly accName: string;
-    readonly bank: Bank;
-    readonly accNo: string;
-    /**
-     * Creates a new bank contact with comprehensive validation.
-     *
-     * @deprecated Use {@link BankContactInfo.from} static factory method instead
-     * @param {string} accName - The bank account holder's name
-     * @param {Bank} bank - The bank institution object
-     * @param {string} accNo - The bank account number
-     *
-     * @throws {ContactInfoError} When validation fails
-     */
-    constructor(accName: string, bank: Bank, accNo: string);
-    /**
-     * Creates a BankContactInfo instance from data object.
-     * This is the preferred method for creating instances.
-     *
-     * @static
-     * @param {Object} data - The bank contact data
-     * @param {string} data.accName - The account holder's name
-     * @param {Bank} data.bank - The bank institution object
-     * @param {string} data.accNo - The bank account number
-     *
-     * @returns {BankContactInfo | undefined} New instance if successful, undefined if validation fails
-     *
-     * @example
-     * ```typescript
-     * const bank = Bank.from("CORUTZTZ", "TZ");
-     * const contact = BankContactInfo.from({
-     *   accName: "John Doe",
-     *   bank,
-     *   accNo: "0150123456789"
-     * });
-     * ```
-     */
-    static from(data: {
-        accName: string;
-        bank: Bank;
-        accNo: string;
-    }): BankContactInfo | undefined;
-    /**
-     * Creates a BankContactInfo instance from a ContactDTO object.
-     *
-     * @static
-     * @param {ContactDTO} info - The contact data transfer object
-     * @returns {BankContactInfo | undefined} New instance if successful, undefined if validation fails
-     */
-    static fromContactDTO(info: ContactDTO): BankContactInfo | undefined;
-    /**
-     * Creates a BankContactInfo instance from a PayoutDTO object.
-     *
-     * @static
-     * @param {PayoutDTO} info - The payout data transfer object
-     * @returns {BankContactInfo | undefined} New instance if successful, undefined if parsing fails
-     */
-    static fromPayoutDTO(info: PayoutDTO): BankContactInfo | undefined;
-    /**
-     * Creates a BankContactInfo instance from a JSON string.
-     *
-     * @static
-     * @param {string} jsonString - JSON string containing bank contact data
-     * @returns {BankContactInfo | undefined} New instance if successful, undefined if parsing fails
-     *
-     * @example
-     * ```typescript
-     * const jsonString = '{"accName":"John Doe","swiftCode":"CORUTZTZ","accNo":"0150123456789"}';
-     * const contact = BankContactInfo.fromJSON(jsonString);
-     * ```
-     */
-    static fromJSON(jsonString: string): BankContactInfo | undefined;
-    /**
-     * Type guard to validate if an unknown object is a valid BankContactInfo instance.
-     *
-     * @static
-     * @param {unknown} obj - The object to validate
-     * @returns {obj is BankContactInfo} Type predicate indicating validity
-     */
-    static is(obj: unknown): obj is BankContactInfo;
-    validate(): boolean;
-    /**
-     * Converts the bank contact info to a plain object for serialization.
-     *
-     * @override
-     * @returns {Record<string, unknown>} Plain object representation
-     */
-    toObject(): Record<string, unknown>;
-    get accountName(): string;
-    get accountNumber(): string;
-    get accountNameLabel(): string;
-    get accountNumberLabel(): string;
-    get channelLabel(): string;
-    get channelId(): BankSwiftCode;
-    get channelName(): string;
-}
-/**
- * Union type representing either a mobile or bank contact.
- *
- * @typedef {MobileContactInfo | BankContactInfo} ContactInfo
- */
-export type ContactInfo = MobileContactInfo | BankContactInfo;
-export {};

package/dist/modules/contact/contact-input-handler.d.ts

@@ -1,16 +0,0 @@
-import { ContactInfo } from "@/modules/contact/contact-info.model.js";
-import { ContactInputDTO } from "./contact.dtos.js";
-/**
- * Factory for resolving and validating a raw `ContactInput` into a typed and valid version.
- */
-export declare class ValidatedContactInputFactory {
-    private handlers;
-    /**
-     * Resolves a raw contact input into a valid and strongly-typed `ContactInput`.
-     *
-     * @param {ContactInputDTO} data - The unvalidated input object
-     * @returns {ContactInputDTO} - A valid and converted input ready for use
-     * @throws {Error} - If the input cannot be handled by any handler
-     */
-    resolve(data: ContactInfo): ContactInputDTO;
-}

package/dist/modules/contact/contact.dtos.d.ts

@@ -1,84 +0,0 @@
-import { z } from "zod";
-/**
- * Schema for contact channel types.
- *
- * @remarks
- * Currently supports two channel types:
- * - "Bank": For traditional banking channels
- * - "Mobile": For mobile money channels
- *
- * @see {@link ContactType} for the inferred type
- */
-export declare enum ContactType {
-    Bank = "Bank",
-    Mobile = "Mobile"
-}
-/**
- * Type representing user-provided contact information.
- * Used for creating or updating contacts.
- *
- * @see {@link contactInputSchema} for validation rules
- * @see {@link ContactDTOSchemas} for all available schemas
- */
-export type ContactInputDTO = z.infer<typeof ContactDTOSchemas.contactInputDTO>;
-/**
- * Type representing a complete contact record.
- * Includes both user-provided and system-generated fields.
- *
- * @see {@link contactSchema} for validation rules
- */
-export type ContactDTO = z.infer<typeof ContactDTOSchemas.contactDTO>;
-/**
- * Collection of all contact-related schemas.
- */
-export declare const ContactDTOSchemas: {
-    /** Schema for complete contact records */
-    contactDTO: z.ZodObject<{
-        id: z.ZodString;
-        profileId: z.ZodString;
-        createdAt: z.ZodString;
-        updatedAt: z.ZodString;
-    } & {
-        displayName: z.ZodString;
-        accountNo: z.ZodString;
-        channel: z.ZodString;
-        type: z.ZodNativeEnum<typeof ContactType>;
-    }, "strip", z.ZodTypeAny, {
-        type: ContactType;
-        id: string;
-        displayName: string;
-        accountNo: string;
-        profileId: string;
-        createdAt: string;
-        updatedAt: string;
-        channel: string;
-    }, {
-        type: ContactType;
-        id: string;
-        displayName: string;
-        accountNo: string;
-        profileId: string;
-        createdAt: string;
-        updatedAt: string;
-        channel: string;
-    }>;
-    /** Schema for contact input validation */
-    contactInputDTO: z.ZodObject<{
-        displayName: z.ZodString;
-        accountNo: z.ZodString;
-        channel: z.ZodString;
-        type: z.ZodNativeEnum<typeof ContactType>;
-    }, "strip", z.ZodTypeAny, {
-        type: ContactType;
-        displayName: string;
-        accountNo: string;
-        channel: string;
-    }, {
-        type: ContactType;
-        displayName: string;
-        accountNo: string;
-        channel: string;
-    }>;
-    /** Schema for contact channel types */
-    contactType: z.ZodNativeEnum<typeof ContactType>;
-};