@temboplus/afloat 0.1.77-beta.23 → 0.1.77-beta.25

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

@@ -0,0 +1,178 @@
+import { BeneficiaryType, BeneficiaryDTO } from "@/modules/beneficiary/beneficiary.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";
+import { z } from "zod";
+export declare const MobileBeneficiaryInfoJSONSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Mobile">;
+    name: z.ZodString;
+    phoneNumber: z.ZodString;
+    mnoId: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "Mobile";
+    name: string;
+    version: string;
+    phoneNumber: string;
+    mnoId: string;
+}, {
+    type: "Mobile";
+    name: string;
+    phoneNumber: string;
+    mnoId: string;
+    version?: string | undefined;
+}>;
+export declare const BankBeneficiaryInfoJSONSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Bank">;
+    accName: z.ZodString;
+    swiftCode: z.ZodString;
+    countryCode: z.ZodString;
+    accNo: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "Bank";
+    version: string;
+    countryCode: string;
+    accName: string;
+    swiftCode: string;
+    accNo: string;
+}, {
+    type: "Bank";
+    countryCode: string;
+    accName: string;
+    swiftCode: string;
+    accNo: string;
+    version?: string | undefined;
+}>;
+export declare const BeneficiaryInfoJSONSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"Mobile">;
+    name: z.ZodString;
+    phoneNumber: z.ZodString;
+    mnoId: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "Mobile";
+    name: string;
+    version: string;
+    phoneNumber: string;
+    mnoId: string;
+}, {
+    type: "Mobile";
+    name: string;
+    phoneNumber: string;
+    mnoId: string;
+    version?: string | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"Bank">;
+    accName: z.ZodString;
+    swiftCode: z.ZodString;
+    countryCode: z.ZodString;
+    accNo: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "Bank";
+    version: string;
+    countryCode: string;
+    accName: string;
+    swiftCode: string;
+    accNo: string;
+}, {
+    type: "Bank";
+    countryCode: string;
+    accName: string;
+    swiftCode: string;
+    accNo: string;
+    version?: string | undefined;
+}>]>;
+export type MobileBeneficiaryInfoJSON = z.infer<typeof MobileBeneficiaryInfoJSONSchema>;
+export type BankBeneficiaryInfoJSON = z.infer<typeof BankBeneficiaryInfoJSONSchema>;
+export type BeneficiaryInfoJSON = z.infer<typeof BeneficiaryInfoJSONSchema>;
+/**
+ * Abstract base class for beneficiary information.
+ */
+declare abstract class BaseBeneficiaryInfo {
+    readonly type: BeneficiaryType;
+    readonly countryCode: ISO2CountryCode;
+    constructor(type: BeneficiaryType, countryCode: ISO2CountryCode);
+    abstract get channelId(): MNOId | BankSwiftCode;
+    abstract get channelName(): string;
+    abstract get accountName(): string;
+    abstract get accountNumber(): string;
+    abstract get accountNameLabel(): string;
+    abstract get accountNumberLabel(): string;
+    abstract get channelLabel(): string;
+    abstract validate(): boolean;
+    abstract toJSON(): BeneficiaryInfoJSON;
+    toJSONString(): string;
+    get isMobile(): boolean;
+    get isBank(): boolean;
+    get displayName(): string;
+}
+/**
+ * Mobile beneficiary information implementation.
+ */
+export declare class MobileBeneficiaryInfo extends BaseBeneficiaryInfo {
+    readonly name: string;
+    readonly phoneNumber: PhoneNumber;
+    readonly mnoId: MNOId;
+    constructor(name: string, phoneNumber: PhoneNumber, mnoId?: MNOId);
+    static from(data: {
+        name: string;
+        phoneNumber: PhoneNumber;
+        mnoId?: MNOId;
+    }): MobileBeneficiaryInfo | undefined;
+    static fromBeneficiaryDTO(info: BeneficiaryDTO): MobileBeneficiaryInfo | undefined;
+    static fromPayoutDTO(info: PayoutDTO): MobileBeneficiaryInfo | undefined;
+    static is(obj: unknown): obj is MobileBeneficiaryInfo;
+    validate(): boolean;
+    getValidationDetails(): {
+        isValid: boolean;
+        errors: string[];
+        warnings: string[];
+    };
+    get accountName(): string;
+    get accountNumber(): string;
+    get accountNameLabel(): string;
+    get accountNumberLabel(): string;
+    get channelLabel(): string;
+    get channelId(): MNOId;
+    get channelName(): string;
+    toJSON(): MobileBeneficiaryInfoJSON;
+    static fromJSON(json: MobileBeneficiaryInfoJSON | string): MobileBeneficiaryInfo | undefined;
+    static fromJSONString(jsonString: string): MobileBeneficiaryInfo | undefined;
+    static isMobileBeneficiaryInfoJSON(obj: unknown): obj is MobileBeneficiaryInfoJSON;
+}
+/**
+ * Bank beneficiary information implementation.
+ */
+export declare class BankBeneficiaryInfo extends BaseBeneficiaryInfo {
+    readonly accName: string;
+    readonly bank: Bank;
+    readonly accNo: string;
+    constructor(accName: string, bank: Bank, accNo: string);
+    static from(data: {
+        accName: string;
+        bank: Bank;
+        accNo: string;
+    }): BankBeneficiaryInfo | undefined;
+    static fromBeneficiaryDTO(info: BeneficiaryDTO): BankBeneficiaryInfo | undefined;
+    static fromPayoutDTO(info: PayoutDTO): BankBeneficiaryInfo | undefined;
+    static is(obj: unknown): obj is BankBeneficiaryInfo;
+    validate(): boolean;
+    get accountName(): string;
+    get accountNumber(): string;
+    get accountNameLabel(): string;
+    get accountNumberLabel(): string;
+    get channelLabel(): string;
+    get channelId(): BankSwiftCode;
+    get channelName(): string;
+    toJSON(): BankBeneficiaryInfoJSON;
+    static fromJSON(json: BankBeneficiaryInfoJSON | string): BankBeneficiaryInfo | undefined;
+    static fromJSONString(jsonString: string): BankBeneficiaryInfo | undefined;
+    static isBankBeneficiaryInfoJSON(obj: unknown): obj is BankBeneficiaryInfoJSON;
+}
+/**
+ * Union type representing either a mobile or bank beneficiary.
+ */
+export type BeneficiaryInfo = MobileBeneficiaryInfo | BankBeneficiaryInfo;
+export {};

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

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

package/dist/modules/{contact/contact.api-contract.d.ts → beneficiary/beneficiary.api-contract.d.ts}

@@ -1,28 +1,28 @@
 import { z } from "zod";
 /**
- * Contact API contract
- * Defines the REST endpoints for managing contacts
+ * Beneficiary API contract
+ * Defines the REST endpoints for managing beneficiaries
  *
- * @property {Object} postContact - Create a new contact (POST /)
- * @property {Object} editContact - Update an existing contact (PATCH /:id)
- * @property {Object} getContacts - Retrieve contacts list (GET /)
- * @property {Object} deleteContact - Delete a contact (DELETE /:id)
+ * @property {Object} createBeneficiary - Create a new beneficiary (POST /)
+ * @property {Object} editBeneficiary - Update an existing beneficiary (PATCH /:id)
+ * @property {Object} getBeneficiaries - Retrieve beneficiaries list (GET /)
+ * @property {Object} deleteBeneficiary - Delete a beneficiary (DELETE /:id)
  */
 export declare const contract: {
-    createContact: {
+    createBeneficiary: {
         method: "POST";
         body: z.ZodObject<{
             displayName: z.ZodString;
             accountNo: z.ZodString;
             channel: z.ZodString;
-            type: z.ZodNativeEnum<typeof import("./contact.dtos.js").ContactType>;
+            type: z.ZodNativeEnum<typeof import("./beneficiary.dtos.js").BeneficiaryType>;
         }, "strip", z.ZodTypeAny, {
-            type: import("./contact.dtos.js").ContactType;
+            type: import("./beneficiary.dtos.js").BeneficiaryType;
             displayName: string;
             accountNo: string;
             channel: string;
         }, {
-            type: import("./contact.dtos.js").ContactType;
+            type: import("./beneficiary.dtos.js").BeneficiaryType;
             displayName: string;
             accountNo: string;
             channel: string;
@@ -38,9 +38,9 @@ export declare const contract: {
                 displayName: z.ZodString;
                 accountNo: z.ZodString;
                 channel: z.ZodString;
-                type: z.ZodNativeEnum<typeof import("./contact.dtos.js").ContactType>;
+                type: z.ZodNativeEnum<typeof import("./beneficiary.dtos.js").BeneficiaryType>;
             }, "strip", z.ZodTypeAny, {
-                type: import("./contact.dtos.js").ContactType;
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
                 createdAt: string;
                 id: string;
                 displayName: string;
@@ -49,7 +49,7 @@ export declare const contract: {
                 updatedAt: string;
                 channel: string;
             }, {
-                type: import("./contact.dtos.js").ContactType;
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
                 createdAt: string;
                 id: string;
                 displayName: string;
@@ -60,20 +60,20 @@ export declare const contract: {
             }>;
         };
     };
-    editContact: {
+    editBeneficiary: {
         method: "PATCH";
         body: z.ZodObject<{
             displayName: z.ZodString;
             accountNo: z.ZodString;
             channel: z.ZodString;
-            type: z.ZodNativeEnum<typeof import("./contact.dtos.js").ContactType>;
+            type: z.ZodNativeEnum<typeof import("./beneficiary.dtos.js").BeneficiaryType>;
         }, "strip", z.ZodTypeAny, {
-            type: import("./contact.dtos.js").ContactType;
+            type: import("./beneficiary.dtos.js").BeneficiaryType;
             displayName: string;
             accountNo: string;
             channel: string;
         }, {
-            type: import("./contact.dtos.js").ContactType;
+            type: import("./beneficiary.dtos.js").BeneficiaryType;
             displayName: string;
             accountNo: string;
             channel: string;
@@ -89,9 +89,9 @@ export declare const contract: {
                 displayName: z.ZodString;
                 accountNo: z.ZodString;
                 channel: z.ZodString;
-                type: z.ZodNativeEnum<typeof import("./contact.dtos.js").ContactType>;
+                type: z.ZodNativeEnum<typeof import("./beneficiary.dtos.js").BeneficiaryType>;
             }, "strip", z.ZodTypeAny, {
-                type: import("./contact.dtos.js").ContactType;
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
                 createdAt: string;
                 id: string;
                 displayName: string;
@@ -100,7 +100,7 @@ export declare const contract: {
                 updatedAt: string;
                 channel: string;
             }, {
-                type: import("./contact.dtos.js").ContactType;
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
                 createdAt: string;
                 id: string;
                 displayName: string;
@@ -111,7 +111,7 @@ export declare const contract: {
             }>;
         };
     };
-    getContacts: {
+    getBeneficiaries: {
         query: z.ZodObject<{
             orderByDesc: z.ZodString;
         }, "strip", z.ZodTypeAny, {
@@ -131,9 +131,9 @@ export declare const contract: {
                 displayName: z.ZodString;
                 accountNo: z.ZodString;
                 channel: z.ZodString;
-                type: z.ZodNativeEnum<typeof import("./contact.dtos.js").ContactType>;
+                type: z.ZodNativeEnum<typeof import("./beneficiary.dtos.js").BeneficiaryType>;
             }, "strip", z.ZodTypeAny, {
-                type: import("./contact.dtos.js").ContactType;
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
                 createdAt: string;
                 id: string;
                 displayName: string;
@@ -142,7 +142,7 @@ export declare const contract: {
                 updatedAt: string;
                 channel: string;
             }, {
-                type: import("./contact.dtos.js").ContactType;
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
                 createdAt: string;
                 id: string;
                 displayName: string;
@@ -166,9 +166,9 @@ export declare const contract: {
                 displayName: z.ZodString;
                 accountNo: z.ZodString;
                 channel: z.ZodString;
-                type: z.ZodNativeEnum<typeof import("./contact.dtos.js").ContactType>;
+                type: z.ZodNativeEnum<typeof import("./beneficiary.dtos.js").BeneficiaryType>;
             }, "strip", z.ZodTypeAny, {
-                type: import("./contact.dtos.js").ContactType;
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
                 createdAt: string;
                 id: string;
                 displayName: string;
@@ -177,7 +177,7 @@ export declare const contract: {
                 updatedAt: string;
                 channel: string;
             }, {
-                type: import("./contact.dtos.js").ContactType;
+                type: import("./beneficiary.dtos.js").BeneficiaryType;
                 createdAt: string;
                 id: string;
                 displayName: string;
@@ -188,7 +188,7 @@ export declare const contract: {
             }>;
         };
     };
-    deleteContact: {
+    deleteBeneficiary: {
         method: "DELETE";
         body: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
         path: "/:id";
@@ -200,4 +200,4 @@ export declare const contract: {
 /**
  * Export type for use in client implementations
  */
-export type ContactAPI = typeof contract;
+export type BeneficiaryAPI = typeof contract;

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

@@ -0,0 +1,84 @@
+import { z } from "zod";
+/**
+ * Schema for beneficiary channel types.
+ *
+ * @remarks
+ * Currently supports two channel types:
+ * - "Bank": For traditional banking channels
+ * - "Mobile": For mobile money channels
+ *
+ * @see {@link BeneficiaryType} for the inferred type
+ */
+export declare enum BeneficiaryType {
+    Bank = "Bank",
+    Mobile = "Mobile"
+}
+/**
+ * Type representing user-provided beneficiary information.
+ * Used for creating or updating beneficiaries.
+ *
+ * @see {@link beneficiaryInputSchema} for validation rules
+ * @see {@link BeneficiaryDTOSchemas} for all available schemas
+ */
+export type BeneficiaryInputDTO = z.infer<typeof BeneficiaryDTOSchemas.beneficiaryInputDTO>;
+/**
+ * Type representing a complete beneficiary record.
+ * Includes both user-provided and system-generated fields.
+ *
+ * @see {@link beneficiarySchema} for validation rules
+ */
+export type BeneficiaryDTO = z.infer<typeof BeneficiaryDTOSchemas.beneficiaryDTO>;
+/**
+ * Collection of all beneficiary-related schemas.
+ */
+export declare const BeneficiaryDTOSchemas: {
+    /** Schema for complete beneficiary records */
+    beneficiaryDTO: 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 BeneficiaryType>;
+    }, "strip", z.ZodTypeAny, {
+        type: BeneficiaryType;
+        createdAt: string;
+        id: string;
+        displayName: string;
+        accountNo: string;
+        profileId: string;
+        updatedAt: string;
+        channel: string;
+    }, {
+        type: BeneficiaryType;
+        createdAt: string;
+        id: string;
+        displayName: string;
+        accountNo: string;
+        profileId: string;
+        updatedAt: string;
+        channel: string;
+    }>;
+    /** Schema for beneficiary input validation */
+    beneficiaryInputDTO: z.ZodObject<{
+        displayName: z.ZodString;
+        accountNo: z.ZodString;
+        channel: z.ZodString;
+        type: z.ZodNativeEnum<typeof BeneficiaryType>;
+    }, "strip", z.ZodTypeAny, {
+        type: BeneficiaryType;
+        displayName: string;
+        accountNo: string;
+        channel: string;
+    }, {
+        type: BeneficiaryType;
+        displayName: string;
+        accountNo: string;
+        channel: string;
+    }>;
+    /** Schema for beneficiary channel types */
+    beneficiaryType: z.ZodNativeEnum<typeof BeneficiaryType>;
+};