@temboplus/afloat 0.1.61 → 0.1.63

package/{script/npm/src/src/models/contact/derivatives/contact.d.ts → dist/models/contact.model.d.ts}

@@ -1,5 +1,6 @@
-import { type ContactData, type ContactType } from "../schemas.js";
-import { type ContactInfo } from "./contact_info.js";
+import { type ContactDTO, ContactType } from "../features/contact/contact.dtos";
+import { type ContactInfo } from "./contact-info.model";
+import { Country, ISO2CountryCode } from "@temboplus/frontend-core";
 /**
  * Contact class that wraps the Zod schema and provides additional functionality
  */
@@ -46,14 +47,6 @@ export declare class Contact {
      * For bank contacts, constructs from SWIFT code and account number
      */
     get info(): ContactInfo | 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(): string;
     /**
      * Account number for the contact
      *
@@ -94,21 +87,36 @@ export declare class Contact {
      * - "Display Name" as fallback
      */
     get accNameLabel(): string;
+    /**
+     * Country code associated with this contact
+     *
+     * @returns {string} Two-letter ISO country code
+     * @throws an error if the country code is not a valid ISO-2 country code
+     */
+    get countryCode(): ISO2CountryCode;
+    get channelName(): string;
+    /**
+     * Country object associated with this contact
+     *
+     * @returns {Country} Country instance representing the contact's country
+     * @throws
+     */
+    get country(): Country;
     /**
      * Creates a Contact instance from raw data
      * @throws {ZodError} if validation fails
      */
-    static create(data: ContactData): Contact;
+    static create(data: ContactDTO): Contact;
     /**
      * Creates multiple Contact instances from an array of raw data
      * @throws {ZodError} if validation fails for any item
      */
-    static createMany(dataArray: ContactData[]): Contact[];
+    static createMany(dataArray: ContactDTO[]): Contact[];
     /**
      * Creates a Contact instance from raw data without throwing
      * @returns {Contact | null} Contact instance or null if validation fails
      */
-    static createSafe(data: ContactData): Contact | null;
+    static createSafe(data: ContactDTO): Contact | null;
     /**
      * Checks if an unknown value contains valid data to construct a Contact instance.
      * This is useful when validating raw data structures before instantiation.
@@ -129,7 +137,7 @@ export declare class Contact {
      * @throws {never} This method never throws errors
      *
      * @remarks
-     * This method performs strict validation against the {@link ContactData} schema.
+     * This method performs strict validation against the {@link ContactDTO} schema.
      */
     static canConstruct(obj: unknown): obj is Contact;
     /**
@@ -167,6 +175,5 @@ export declare class Contact {
     /**
      * Converts Payout instance to a plain object
      */
-    toJSON(): ContactData;
+    toJSON(): ContactDTO;
 }
-//# sourceMappingURL=contact.d.ts.map

package/dist/models/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./contact-info.model";
+export * from "./contact.model";
+export * from "./payout.model";
+export * from "./profile.model";
+export * from "./user.model";
+export * from "./wallet.model";
+export * from "./statement-entry.model";
+export * from "./permission";
+export * from "./managed-user.model";
+export * from "./role.model";
+export * from "./narration.model";

package/{esm/src/models/user/managed-user.d.ts → dist/models/managed-user.model.d.ts}

@@ -1,4 +1,5 @@
-import { Role, type RoleData } from "../role.js";
+import { RoleDTO } from "@/features/admin/admin.dtos";
+import { Role } from "./role.model";
 export interface UserEntityData {
     id: string;
     name: string;
@@ -50,7 +51,7 @@ export interface ManagedUserData {
     resetPassword: boolean;
     isActive: boolean;
     isArchived: boolean;
-    role?: RoleData;
+    role?: RoleDTO;
     createdAt: string;
     updatedAt: string;
 }
@@ -105,4 +106,3 @@ export declare class ManagedUser extends UserEntity {
     static createMany(dataArray: any[]): ManagedUser[];
     toJSON(): any;
 }
-//# sourceMappingURL=managed-user.d.ts.map

package/dist/models/narration.model.d.ts

@@ -0,0 +1,184 @@
+import { BankContactInfo, ContactInfo, MobileContactInfo } from "./contact-info.model";
+/** Prefix for Ecobank mobile transfer narrations */
+export declare const ECOBANK_PREFIX = "MOBILE TRANSFER ";
+/** V2 format prefix for payout narrations using payout IDs */
+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 transaction IDs (V2 format)
+ * - Parse legacy narrations to extract contact information (deprecated)
+ * - Format narration text for different display contexts
+ * - Handle V2 (payout ID), V1, and legacy narration formats for backward compatibility
+ * - Serialize/deserialize to/from JSON format
+ *
+ * @example
+ * ```typescript
+ * // Generate V2 narration using payout ID (recommended)
+ * const narration = Narration.generateDefaultPayoutNarration("AF-2024-001234");
+ * // Result: "TEMBO-DISB #AF-2024-001234"
+ *
+ * // Create from existing text and serialize
+ * const existingNarration = new Narration("TEMBO-DISB #AF-2024-001234");
+ * const json = existingNarration.toJson();
+ * const restored = Narration.fromJson(json);
+ *
+ * // Extract payout ID from V2 narration
+ * const payoutId = existingNarration.getPayoutId(); // Returns: "AF-2024-001234"
+ * ```
+ */
+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);
+    /**
+     * Generates the default payout narration using the payout ID (V2 format).
+     * This is the standard method for creating payout narrations in the Afloat platform.
+     * Format: "TEMBO-DISB #{PAYOUT_ID}"
+     *
+     * Note: Only the prefix is uppercased, the payout ID preserves its original case.
+     *
+     * @param payoutId - Unique payout identifier (case will be preserved)
+     * @returns Formatted payout narration with uppercased prefix and original-case ID
+     *
+     * @example
+     * ```typescript
+     * const narration = Narration.generateDefaultPayoutNarration("AF-2024-001234");
+     * // Returns: "TEMBO-DISB #AF-2024-001234"
+     *
+     * const narration = Narration.generateDefaultPayoutNarration("tx-a1b2c3d4");
+     * // Returns: "TEMBO-DISB #tx-a1b2c3d4"
+     * ```
+     */
+    static generateDefaultPayoutNarration(payoutId: string): string;
+    /**
+     * Extracts the payout ID from a V2 format narration.
+     * Only works for V2 format narrations that use the "TEMBO-DISB #{PAYOUT_ID}" structure.
+     * Returns undefined for V1 and legacy formats.
+     *
+     * @returns The payout ID if the narration is V2 format, undefined otherwise
+     *
+     * @example
+     * ```typescript
+     * // V2 format (works)
+     * const v2Narration = new Narration("TEMBO-DISB #AF-2024-001234");
+     * const payoutId = v2Narration.getPayoutId(); // Returns: "AF-2024-001234"
+     *
+     * // V1 format (does not work - returns undefined)
+     * const v1Narration = new Narration("PAYOUT TO BANK CRDB 1234567890 Jane Smith");
+     * const payoutId = v1Narration.getPayoutId(); // Returns: undefined
+     * ```
+     */
+    getPayoutId(): string | undefined;
+    /**
+     * @deprecated Contact extraction from narrations is deprecated and should only be used for legacy/V1 format support.
+     * V2 narrations use payout IDs and do not contain contact information.
+     *
+     * Extracts contact information from legacy narration text.
+     * Only works for V1 and legacy formats - V2 format uses payout IDs instead.
+     *
+     * @returns Parsed ContactInfo (BankContactInfo or MobileContactInfo) if successful, undefined otherwise
+     *
+     * @example
+     * ```typescript
+     * // V1 format (works)
+     * const v1Narration = new Narration("PAYOUT TO BANK CRDB 1234567890 Jane Smith");
+     * const v1Contact = v1Narration.getContactDetails();
+     *
+     * // V2 format (does not work - returns undefined)
+     * const v2Narration = new Narration("TEMBO-DISB #AF-2024-001234");
+     * const v2Contact = v2Narration.getContactDetails(); // Returns undefined
+     * ```
+     */
+    getContactDetails: () => ContactInfo | undefined;
+    /**
+     * @deprecated Contact extraction from narrations is deprecated and should only be used for legacy/V1 format support.
+     * V2 narrations use payout IDs and do not contain contact information.
+     *
+     * Extracts bank contact information from legacy narration text.
+     * Only works for V1 and legacy formats. V2 format uses payout IDs and will return undefined.
+     *
+     * 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
+     */
+    getBankContactDetails: () => BankContactInfo | 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("TEMBO-DISB #AF-2024-001234");
+     * const json = narration.toJson();
+     * // Returns: { text: "TEMBO-DISB #AF-2024-001234", 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: "TEMBO-DISB #AF-2024-001234" });
+     *
+     * // From JSON string
+     * const narration = Narration.fromJson('{"text":"TEMBO-DISB #AF-2024-001234"}');
+     * ```
+     */
+    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;
+    /**
+     * @deprecated Contact extraction from narrations is deprecated and should only be used for legacy/V1 format support.
+     * V2 narrations use payout IDs and do not contain contact information.
+     *
+     * Extracts mobile contact information from legacy narration text.
+     * Only works for V1 and legacy formats. V2 format uses payout IDs and will return undefined.
+     *
+     * V1 format: "PAYOUT TO MOBILE {phone_number} {name}"
+     * Legacy format: "TO_MOMO => {json_object}"
+     *
+     * @returns MobileContactInfo if parsing is successful, undefined otherwise
+     */
+    getMobileContactDetails: () => MobileContactInfo | undefined;
+}

package/{script/npm/src/src/models/payout/derivatives/payout.d.ts → dist/models/payout.model.d.ts}

@@ -1,7 +1,6 @@
 import { Amount } from "@temboplus/frontend-core";
-import type { PayoutApprover, PayoutData } from "../index.js";
-import { type ContactInfo } from "../../contact/index.js";
-import { type PAYOUT_APPROVAL_STATUS, PAYOUT_STATUS } from "../status.js";
+import { PayoutApprovalStatus, PayoutAuthorizer, PayoutDTO, PayoutStatus } from "../features/payout/payout.dtos";
+import { ContactInfo } from "./contact-info.model";
 /**
  * Payout class that wraps the Zod schema and provides additional functionality
  */
@@ -29,7 +28,7 @@ export declare class Payout {
     /** Description of the payout purpose */
     get description(): string;
     /** Optional additional notes about the payout */
-    get notes(): string | undefined;
+    get notes(): string | undefined | null;
     /**
      * Current status of the payout
      * Derived from both approval status and transaction status:
@@ -42,23 +41,23 @@ export declare class Payout {
      * @returns {PAYOUT_STATUS} Current status of the payout
      * @see {@link PAYOUT_STATUS} for all possible status values
      */
-    get status(): PAYOUT_STATUS;
+    get status(): PayoutStatus;
     /** Status message providing details about current state */
     get statusMessage(): string;
     /** Optional reference ID from payment partner */
-    get partnerReference(): string | undefined;
+    get partnerReference(): string | undefined | null;
     /** 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;
+    get actionedAt(): Date | undefined | null;
     /** Current approval status of the payout */
-    get approvalStatus(): PAYOUT_APPROVAL_STATUS;
+    get approvalStatus(): PayoutApprovalStatus | undefined | null;
     /** Information about who created the payout */
-    get createdBy(): PayoutApprover | undefined;
+    get createdBy(): PayoutAuthorizer | undefined | null;
     /** Information about who last actioned the payout */
-    get actionedBy(): PayoutApprover | undefined;
+    get actionedBy(): PayoutAuthorizer | undefined | null;
     /**
      * Constructs contact information based on payout channel
      *
@@ -71,7 +70,7 @@ export declare class Payout {
      * For bank payouts, expects msisdn in format "SWIFTCODE:ACCOUNTNUMBER"
      *
      * @example
-     * ```ts
+     * ``
      * // Mobile payout
      * payout.contactInfo // Returns MobileContactInfo with phone details
      *
@@ -84,17 +83,17 @@ export declare class Payout {
      * Creates a Payout instance from raw data
      * @throws {ZodError} if validation fails
      */
-    static create(data: PayoutData): Payout;
+    static create(data: PayoutDTO): Payout;
     /**
      * Creates multiple Payout instances from an array of raw data
      * @throws {ZodError} if validation fails for any item
      */
-    static createMany(dataArray: PayoutData[]): Payout[];
+    static createMany(dataArray: PayoutDTO[]): Payout[];
     /**
      * Creates a Payout instance from raw data without throwing
      * @returns {Payout | null} Payout instance or null if validation fails
      */
-    static createSafe(data: PayoutData): Payout | null;
+    static createSafe(data: PayoutDTO): 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.
@@ -153,6 +152,5 @@ export declare class Payout {
     /**
      * Converts Payout instance to a plain object
      */
-    toJSON(): PayoutData;
+    toJSON(): PayoutDTO;
 }
-//# sourceMappingURL=payout.d.ts.map

package/{esm/src → dist}/models/permission.d.ts

@@ -51,5 +51,4 @@ export declare const Permissions: {
 /**
  * Permission Type
  */
-export type Permission = typeof Permissions.Profile[keyof typeof Permissions.Profile] | typeof Permissions.Contact[keyof typeof Permissions.Contact] | typeof Permissions.Payment[keyof typeof Permissions.Payment] | typeof Permissions.Payout[keyof typeof Permissions.Payout] | typeof Permissions.Transfer[keyof typeof Permissions.Transfer] | typeof Permissions.UserManagement[keyof typeof Permissions.UserManagement] | typeof Permissions.Role[keyof typeof Permissions.Role] | typeof Permissions.Wallet[keyof typeof Permissions.Wallet];
-//# sourceMappingURL=permission.d.ts.map
+export type Permission = (typeof Permissions.Profile)[keyof typeof Permissions.Profile] | (typeof Permissions.Contact)[keyof typeof Permissions.Contact] | (typeof Permissions.Payment)[keyof typeof Permissions.Payment] | (typeof Permissions.Payout)[keyof typeof Permissions.Payout] | (typeof Permissions.Transfer)[keyof typeof Permissions.Transfer] | (typeof Permissions.UserManagement)[keyof typeof Permissions.UserManagement] | (typeof Permissions.Role)[keyof typeof Permissions.Role] | (typeof Permissions.Wallet)[keyof typeof Permissions.Wallet];

package/{script/npm/src/src/models/user/profile.d.ts → dist/models/profile.model.d.ts}

@@ -1,38 +1,4 @@
-import { z } from "zod";
-import { PhoneNumber } from "@temboplus/frontend-core";
-/**
- * Type definition for profile schema using Zod.
- * This type helper ensures type safety when implementing the actual schema.
- */
-type ProfileZodSchemaType = z.ZodObject<{
-    id: z.ZodString;
-    firstName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    lastName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    displayName: z.ZodString;
-    phone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    accountNo: z.ZodString;
-    email: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-}>;
-/**
- * Zod schema for validating user profile data.
- * Defines validation rules and constraints for each profile field.
- *
- * @const {ProfileType}
- *
- * @property {string} id - Unique identifier for the profile
- * @property {string | null | undefined} firstName - User's first name, can be null or undefined
- * @property {string | null | undefined} lastName - User's last name, can be null or undefined
- * @property {string} displayName - User's display name
- * @property {string | null | undefined} phone - User's contact phone number, can be null or undefined
- * @property {string} accountNo - User's account number
- * @property {string | null | undefined} email - User's email address, can be null or undefined
- */
-export declare const profileSchema: ProfileZodSchemaType;
-/**
- * TypeScript type representing a validated user profile.
- * Use this type for profile instances that have been validated against the schema.
- */
-export type ProfileType = z.infer<typeof profileSchema>;
+import { ProfileDTO } from "@/features/auth/profile/profile.dtos";
 /**
  * Represents a user profile in the system.
  *
@@ -48,16 +14,45 @@ export declare class Profile {
     private _lastName?;
     /** User's display name, can be used for presentation */
     private _displayName;
-    /** User's phone number, stored as a PhoneNumber object */
+    /** User's phone number */
     private _phone?;
     /** User's account number */
     private _accountNo;
     /** User's email address */
     private _email?;
+    /** Auto-approval setting */
+    private _autoApprove?;
     /**
      * Gets the profile schema used for validation.
      */
-    static get schema(): ProfileZodSchemaType;
+    static get schema(): import("zod").ZodObject<{
+        id: import("zod").ZodString;
+        firstName: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+        lastName: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+        displayName: import("zod").ZodString;
+        phone: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+        accountNo: import("zod").ZodString;
+        email: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+        autoApprove: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodBoolean>>;
+    }, "strip", import("zod").ZodTypeAny, {
+        id: string;
+        displayName: string;
+        accountNo: string;
+        firstName?: string | null | undefined;
+        lastName?: string | null | undefined;
+        phone?: string | null | undefined;
+        email?: string | null | undefined;
+        autoApprove?: boolean | null | undefined;
+    }, {
+        id: string;
+        displayName: string;
+        accountNo: string;
+        firstName?: string | null | undefined;
+        lastName?: string | null | undefined;
+        phone?: string | null | undefined;
+        email?: string | null | undefined;
+        autoApprove?: boolean | null | undefined;
+    }>;
     /**
      * Creates a new Profile instance with the provided data.
      *
@@ -79,6 +74,7 @@ export declare class Profile {
         phone?: string | null;
         accountNo: string;
         email?: string | null;
+        autoApprove?: boolean | null;
     }): Profile | undefined;
     /**
      * Gets the profile's unique identifier.
@@ -99,7 +95,7 @@ export declare class Profile {
     /**
      * Gets the user's phone number object.
      */
-    get phone(): PhoneNumber | null | undefined;
+    get phone(): string | null | undefined;
     /**
      * Gets the user's account number.
      */
@@ -109,9 +105,9 @@ export declare class Profile {
      */
     get email(): string | null | undefined;
     /**
-     * Gets the user's formatted phone number in international format.
+     * Gets the auto-approval setting.
      */
-    get formattedPhone(): string | null | undefined;
+    get autoApprove(): boolean | null | undefined;
     /**
      * Gets the user's name for display purposes.
      * Returns the display name if it exists, otherwise returns the first and last name combined.
@@ -122,7 +118,7 @@ export declare class Profile {
      *
      * @returns A plain object matching the ProfileType interface
      */
-    toObject(): ProfileType;
+    toObject(): ProfileDTO;
     /**
      * Converts the profile to a JSON string.
      *
@@ -157,5 +153,3 @@ export declare class Profile {
      */
     static is(obj: unknown): obj is Profile;
 }
-export {};
-//# sourceMappingURL=profile.d.ts.map

package/{script/npm/src/src/models/role.d.ts → dist/models/role.model.d.ts}

@@ -1,11 +1,4 @@
-export interface RoleData {
-    id: string;
-    name: string;
-    description?: string;
-    access: string[];
-    createdAt: string;
-    updatedAt: string;
-}
+import { RoleDTO } from "@/features/admin/admin.dtos";
 export declare class Role {
     readonly id: string;
     readonly name: string;
@@ -13,9 +6,8 @@ export declare class Role {
     readonly permissions: ReadonlySet<string>;
     readonly createdAt: Date;
     readonly updatedAt: Date;
-    constructor(data: RoleData);
+    constructor(data: RoleDTO);
     hasPermission(permission: string): boolean;
     static from(data: any): Role | undefined;
     toJSON(): any;
 }
-//# sourceMappingURL=role.d.ts.map