@temboplus/afloat 0.1.53 → 0.1.55

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

@@ -1,266 +0,0 @@
-import { ContactSchemas, } from "../schemas.js";
-import { MobileContactInfo } from "../index.js";
-import { Bank, TZPhoneNumber } from "@temboplus/frontend-core";
-import { BankContactInfo, } from "./contact_info.js";
-/**
- * Contact class that wraps the Zod schema and provides additional functionality
- */
-export class Contact {
-    /**
-     * 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 = ContactSchemas.contactData.parse(data);
-    }
-    /**
-     * Unique identifier for the contact
-     */
-    get id() {
-        return this.data.id;
-    }
-    /**
-     * Profile identifier associated with this contact
-     */
-    get profileId() {
-        return this.data.profileId;
-    }
-    /**
-     * Display name of the contact
-     */
-    get displayName() {
-        return this.data.displayName;
-    }
-    /**
-     * Type of contact (Bank or Mobile)
-     */
-    get type() {
-        return this.data.type;
-    }
-    /**
-     * Creation timestamp of the contact
-     */
-    get createdAt() {
-        return this.data.createdAt;
-    }
-    /**
-     * Update timestamp of the contact
-     */
-    get updatedAt() {
-        return this.data.updatedAt;
-    }
-    /**
-     * Detailed contact information based on contact type
-     *
-     * @returns {ContactInfo | undefined} Contact information object:
-     * - MobileContactInfo for mobile money contacts
-     * - BankContactInfo for bank contacts
-     * - undefined if contact information cannot be constructed
-     *
-     * @remarks
-     * For mobile contacts, constructs from phone number
-     * For bank contacts, constructs from SWIFT code and account number
-     */
-    get info() {
-        if (this.data.type === "Mobile") {
-            const phone = TZPhoneNumber.from(this.data.accountNo);
-            if (phone) {
-                return new MobileContactInfo(this.data.displayName, phone);
-            }
-        }
-        if (this.data.type === "Bank") {
-            const bank = Bank.fromSWIFTCode(this.data.channel);
-            if (bank) {
-                return new BankContactInfo(this.data.displayName, bank, this.data.accountNo);
-            }
-        }
-        return undefined;
-    }
-    /**
-     * Payment channel for the contact
-     *
-     * @returns {string} Channel information:
-     * - For valid contacts, returns formatted channel from ContactInfo
-     * - For invalid contacts, falls back to account number
-     */
-    get channel() {
-        const info = this.info;
-        if (info)
-            return info.channel;
-        return this.data.accountNo;
-    }
-    /**
-     * Account number for the contact
-     *
-     * @returns {string} Account number:
-     * - For valid contacts, returns formatted account number from ContactInfo
-     * - For invalid contacts, falls back to raw account number
-     */
-    get accNo() {
-        const info = this.info;
-        if (info)
-            return info.accNumber;
-        return this.data.accountNo;
-    }
-    /**
-     * Account name for the contact
-     * Always returns the display name
-     */
-    get accName() {
-        return this.data.displayName;
-    }
-    /**
-     * Label for the account number field based on contact type
-     *
-     * @returns {string} Appropriate label:
-     * - "Phone Number" for mobile contacts
-     * - "Bank Account Number" for bank contacts
-     * - "Account Number" as fallback
-     */
-    get accNoLabel() {
-        const info = this.info;
-        if (info instanceof MobileContactInfo)
-            return "Phone Number";
-        if (info instanceof BankContactInfo)
-            return "Bank Account Number";
-        return "Account Number";
-    }
-    /**
-     * Label for the channel field based on contact type
-     *
-     * @returns {string} Appropriate label:
-     * - "Channel" for mobile contacts
-     * - "Bank" for bank contacts
-     * - "Channel" as fallback
-     */
-    get channelLabel() {
-        const info = this.info;
-        if (info instanceof MobileContactInfo)
-            return "Channel";
-        if (info instanceof BankContactInfo)
-            return "Bank";
-        return "Channel";
-    }
-    /**
-     * Label for the account name field based on contact type
-     *
-     * @returns {string} Appropriate label:
-     * - "Full Name" for mobile contacts
-     * - "Bank Account Name" for bank contacts
-     * - "Display Name" as fallback
-     */
-    get accNameLabel() {
-        const info = this.info;
-        if (info instanceof MobileContactInfo)
-            return "Full Name";
-        if (info instanceof BankContactInfo)
-            return "Bank Account Name";
-        return "Display Name";
-    }
-    /**
-     * Creates a Contact instance from raw data
-     * @throws {ZodError} if validation fails
-     */
-    static create(data) {
-        return new Contact(data);
-    }
-    /**
-     * Creates multiple Contact instances from an array of raw data
-     * @throws {ZodError} if validation fails for any item
-     */
-    static createMany(dataArray) {
-        return dataArray.map((data) => new Contact(data));
-    }
-    /**
-     * Creates a Contact instance from raw data without throwing
-     * @returns {Contact | null} Contact instance or null if validation fails
-     */
-    static createSafe(data) {
-        try {
-            return new Contact(data);
-        }
-        catch {
-            return null;
-        }
-    }
-    /**
-     * Checks if an unknown value contains valid data to construct a Contact instance.
-     * This is useful when validating raw data structures before instantiation.
-     *
-     * @param {unknown} obj - The value containing potential contact data
-     * @returns {obj is Contact} Type predicate indicating if a Contact can be constructed
-     *
-     * @example
-     * ```typescript
-     * const rawData = await fetchFromAPI();
-     * if (Contact.canConstruct(rawData)) {
-     *   const contact = Contact.create(rawData);
-     *   // TypeScript knows contact is valid here
-     *   console.log(contact.displayName);
-     * }
-     * ```
-     *
-     * @throws {never} This method never throws errors
-     *
-     * @remarks
-     * This method performs strict validation against the {@link ContactData} schema.
-     */
-    static canConstruct(obj) {
-        if (!obj || typeof obj !== "object")
-            return false;
-        const result = ContactSchemas.contactData.safeParse(obj);
-        if (!result.success)
-            return false;
-        const contact = Contact.createSafe(result.data);
-        return contact !== null;
-    }
-    /**
-     * Validates if an unknown value is a Contact 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 Contact} Type predicate indicating if the value is a valid Contact
-     *
-     * @example
-     * ```typescript
-     * const maybeContact = getContactFromCache();
-     * if (Contact.is(maybeContact)) {
-     *   // TypeScript knows maybeContact is a Contact here
-     *   console.log(maybeContact.displayName);
-     * }
-     * ```
-     *
-     * @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 ContactData schema
-     * 4. Ensures the object is a proper Contact instance
-     *
-     * Use this method when:
-     * - Validating cached Contact instances
-     * - Checking serialized Contact 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 Contact.canConstruct(obj.data);
-    }
-    /**
-     * Converts Payout instance to a plain object
-     */
-    toJSON() {
-        return { ...this.data };
-    }
-}

package/esm/src/models/contact/derivatives/contact.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"contact.test.d.ts","sourceRoot":"","sources":["../../../../../src/src/models/contact/derivatives/contact.test.ts"],"names":[],"mappings":""}

package/esm/src/models/contact/derivatives/contact_info.d.ts

@@ -1,188 +0,0 @@
-import type { ContactType } from "../index.js";
-import { Bank, TZPhoneNumber } 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.
- *
- * @abstract
- * @class BaseContactInfo
- * @property {ContactType} type - The type of contact (either "Mobile" or "Bank")
- */
-declare abstract class BaseContactInfo {
-    readonly type: ContactType;
-    /**
-     * Creates a new instance of BaseContactInfo
-     * @param {ContactType} type - The type of contact to create
-     */
-    constructor(type: ContactType);
-    /**
-     * Validates the contact information according to type-specific rules
-     * @abstract
-     * @returns {boolean} True if the contact information is valid, false otherwise
-     */
-    abstract validate(): boolean;
-    /**
-     * 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 displayName(): 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 accNumber(): string;
-    /**
-     * Gets the service provider or institution name for the contact
-     * @abstract
-     * @returns {string} The contact's channel (telecom company for mobile, bank name for bank)
-     */
-    abstract get channel(): 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 displayNameLabel(): 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 accNumberLabel(): 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;
-}
-/**
- * Implementation of BaseContactInfo for mobile phone contacts.
- * Handles storage and validation of contact details specific to mobile numbers.
- *
- * @extends BaseContactInfo
- * @class MobileContactInfo
- * @property {string} name - The contact's personal name
- * @property {TZPhoneNumber} phoneNumber - The contact's phone number object
- */
-export declare class MobileContactInfo extends BaseContactInfo {
-    readonly name: string;
-    readonly phoneNumber: TZPhoneNumber;
-    /**
-     * Creates a new mobile contact
-     * @param {string} name - The contact's personal name
-     * @param {TZPhoneNumber} phoneNumber - The contact's phone number
-     */
-    constructor(name: string, phoneNumber: TZPhoneNumber);
-    /**
-     * Validates the mobile contact information
-     * Checks that:
-     * - Phone number is defined and valid
-     * - Contact name is not empty
-     * @returns {boolean} True if all validation checks pass
-     */
-    validate(): boolean;
-    /**
-     * Validates if an unknown value is a valid MobileContactInfo object.
-     * Checks both the structural integrity and data validity of name and phone number properties.
-     *
-     * @param {unknown} obj - The value to validate
-     * @returns {obj is MobileContactInfo} Type predicate indicating if the value is a valid MobileContactInfo
-     *
-     * @example
-     * const maybeContact = JSON.parse(someData);
-     * if (MobileContactInfo.is(maybeContact)) {
-     *   // maybeContact is typed as MobileContactInfo
-     *   console.log(maybeContact.name);
-     *   console.log(maybeContact.TZPhoneNumber.label);
-     * }
-     *
-     * @remarks
-     * - Name must be a non-empty string
-     * - Phone number can be either:
-     *   - A string that can be parsed into a valid TZPhoneNumber
-     *   - A TZPhoneNumber object with valid properties
-     * - Returns false if either property is invalid or missing
-     */
-    static is(obj: unknown): obj is MobileContactInfo;
-    get displayName(): string;
-    /**
-     * Gets the phone number formatted according to the 255 standard
-     * @returns {string} Formatted phone number
-     */
-    get accNumber(): string;
-    get channel(): string;
-    get displayNameLabel(): string;
-    get accNumberLabel(): string;
-    get channelLabel(): string;
-}
-/**
- * Implementation of BaseContactInfo for bank account contacts.
- * Handles storage and validation of contact details specific to bank accounts.
- *
- * @extends BaseContactInfo
- * @class BankContactInfo
- * @property {string} accName - The bank account holder's name
- * @property {Bank} bank - The bank object containing institution details
- * @property {string} accNo - The bank account number
- */
-export declare class BankContactInfo extends BaseContactInfo {
-    readonly accName: string;
-    readonly bank: Bank;
-    readonly accNo: string;
-    /**
-     * Creates a new bank contact
-     * @param {string} accName - The account holder's name
-     * @param {Bank} bank - The bank object
-     * @param {string} accNo - The account number
-     */
-    constructor(accName: string, bank: Bank, accNo: string);
-    /**
-     * Validates the bank contact information
-     * Checks that:
-     * - Bank object is valid
-     * - Account name meets requirements
-     * - Account number meets bank-specific format requirements
-     * @returns {boolean} True if all validation checks pass
-     */
-    validate(): boolean;
-    /**
-     * Validates if an unknown value is a valid BankContactInfo object.
-     * Checks both the structural integrity and data validity of account name, account number, and bank details.
-     *
-     * @param {unknown} obj - The value to validate
-     * @returns {obj is BankContactInfo} Type predicate indicating if the value is a valid BankContactInfo
-     *
-     * @example
-     * const maybeBank = JSON.parse(someData);
-     * if (BankContactInfo.is(maybeBank)) {
-     *   // maybeBank is typed as BankContactInfo
-     *   console.log(maybeBank.accName);
-     *   console.log(maybeBank.accNumber);
-     *   console.log(maybeBank.bank.name);
-     * }
-     *
-     * @remarks
-     * - Account name must be a valid string (validated by {@link validateAccName})
-     * - Account number must be a valid string (validated by {@link validateBankAccNo})
-     * - Bank must be a valid Bank object (validated by {@link Bank.is})
-     * - Returns false if any property is invalid or missing
-     * - All properties are required and must pass their respective validations
-     */
-    static is(obj: unknown): obj is BankContactInfo;
-    get displayName(): string;
-    get accNumber(): string;
-    get channel(): string;
-    get displayNameLabel(): string;
-    get accNumberLabel(): string;
-    get channelLabel(): string;
-}
-/**
- * Union type representing either a mobile or bank contact
- * Used for type-safe handling of contact information throughout the application
- */
-export type ContactInfo = MobileContactInfo | BankContactInfo;
-export {};
-//# sourceMappingURL=contact_info.d.ts.map

package/esm/src/models/contact/derivatives/contact_info.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"contact_info.d.ts","sourceRoot":"","sources":["../../../../../src/src/models/contact/derivatives/contact_info.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EACL,IAAI,EAEJ,aAAa,EACd,MAAM,0BAA0B,CAAC;AAMlC;;;;;;;GAOG;AACH,uBAAe,eAAe;IAC5B,SAAgB,IAAI,EAAE,WAAW,CAAC;IAElC;;;OAGG;gBACS,IAAI,EAAE,WAAW;IAI7B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,IAAI,OAAO;IAE5B;;;;OAIG;IACH,QAAQ,KAAK,WAAW,IAAI,MAAM,CAAC;IAEnC;;;;OAIG;IACH,QAAQ,KAAK,SAAS,IAAI,MAAM,CAAC;IAEjC;;;;OAIG;IACH,QAAQ,KAAK,OAAO,IAAI,MAAM,CAAC;IAE/B;;;;OAIG;IACH,QAAQ,KAAK,gBAAgB,IAAI,MAAM,CAAC;IAExC;;;;OAIG;IACH,QAAQ,KAAK,cAAc,IAAI,MAAM,CAAC;IAEtC;;;;OAIG;IACH,QAAQ,KAAK,YAAY,IAAI,MAAM,CAAC;CACrC;AAED;;;;;;;;GAQG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;aAOlC,IAAI,EAAE,MAAM;aACZ,WAAW,EAAE,aAAa;IAP5C;;;;OAIG;gBAEe,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,aAAa;IAK5C;;;;;;OAMG;IACH,QAAQ,IAAI,OAAO;IAMnB;;;;;;;;;;;;;;;;;;;;;OAqBG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,iBAAiB;IA6BxD,IAAa,WAAW,IAAI,MAAM,CAEjC;IAED;;;OAGG;IACH,IAAa,SAAS,IAAI,MAAM,CAE/B;IAED,IAAa,OAAO,IAAI,MAAM,CAE7B;IAED,IAAa,gBAAgB,IAAI,MAAM,CAEtC;IAED,IAAa,cAAc,IAAI,MAAM,CAEpC;IAED,IAAa,YAAY,IAAI,MAAM,CAElC;CACF;AAED;;;;;;;;;GASG;AACH,qBAAa,eAAgB,SAAQ,eAAe;aAQhC,OAAO,EAAE,MAAM;aACf,IAAI,EAAE,IAAI;aACV,KAAK,EAAE,MAAM;IAT/B;;;;;OAKG;gBAEe,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,IAAI,EACV,KAAK,EAAE,MAAM;IAK/B;;;;;;;OAOG;IACH,QAAQ,IAAI,OAAO;IAMnB;;;;;;;;;;;;;;;;;;;;;;OAsBG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,eAAe;IA8BtD,IAAa,WAAW,IAAI,MAAM,CAEjC;IAED,IAAa,SAAS,IAAI,MAAM,CAE/B;IAED,IAAa,OAAO,IAAI,MAAM,CAE7B;IAED,IAAa,gBAAgB,IAAI,MAAM,CAEtC;IAED,IAAa,cAAc,IAAI,MAAM,CAEpC;IAED,IAAa,YAAY,IAAI,MAAM,CAElC;CACF;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG,iBAAiB,GAAG,eAAe,CAAC"}