@temboplus/afloat 0.1.77-beta.7 → 0.1.77-beta.9

package/dist/modules/payout/payout.model.d.ts

@@ -1,6 +1,119 @@
 import { PayoutDTO, PayoutStatus, PayoutApprovalStatus, PayoutAuthorizer } from "@/modules/payout/payout.dtos.js";
 import { Amount } from "@temboplus/frontend-core";
 import { ContactInfo } from "../contact/contact-info.model.js";
+import z from "zod";
+/**
+ * Zod schema for Payout JSON serialization
+ * This mirrors the PayoutDTO structure but is specifically for JSON serialization
+ */
+export declare const PayoutJSONSchema: z.ZodObject<{
+    id: z.ZodString;
+    profileId: z.ZodString;
+    payeeName: z.ZodString;
+    channel: z.ZodString;
+    msisdn: z.ZodString;
+    amount: z.ZodNumber;
+    currencyCode: z.ZodString;
+    countryCode: z.ZodString;
+    description: z.ZodString;
+    notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    status: z.ZodNativeEnum<typeof PayoutStatus>;
+    statusMessage: z.ZodString;
+    partnerReference: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+    actionedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    approvalStatus: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof PayoutApprovalStatus>>>;
+    createdBy: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        identity: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        identity: string;
+    }, {
+        name: string;
+        id: string;
+        identity: string;
+    }>>>;
+    actionedBy: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        identity: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        identity: string;
+    }, {
+        name: string;
+        id: string;
+        identity: string;
+    }>>>;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    status: PayoutStatus;
+    id: string;
+    version: string;
+    profileId: string;
+    createdAt: string;
+    updatedAt: string;
+    description: string;
+    channel: string;
+    countryCode: string;
+    currencyCode: string;
+    msisdn: string;
+    amount: number;
+    payeeName: string;
+    statusMessage: string;
+    notes?: string | null | undefined;
+    partnerReference?: string | null | undefined;
+    actionedAt?: string | null | undefined;
+    approvalStatus?: PayoutApprovalStatus | null | undefined;
+    createdBy?: {
+        name: string;
+        id: string;
+        identity: string;
+    } | null | undefined;
+    actionedBy?: {
+        name: string;
+        id: string;
+        identity: string;
+    } | null | undefined;
+}, {
+    status: PayoutStatus;
+    id: string;
+    profileId: string;
+    createdAt: string;
+    updatedAt: string;
+    description: string;
+    channel: string;
+    countryCode: string;
+    currencyCode: string;
+    msisdn: string;
+    amount: number;
+    payeeName: string;
+    statusMessage: string;
+    version?: string | undefined;
+    notes?: string | null | undefined;
+    partnerReference?: string | null | undefined;
+    actionedAt?: string | null | undefined;
+    approvalStatus?: PayoutApprovalStatus | null | undefined;
+    createdBy?: {
+        name: string;
+        id: string;
+        identity: string;
+    } | null | undefined;
+    actionedBy?: {
+        name: string;
+        id: string;
+        identity: string;
+    } | null | undefined;
+}>;
+/**
+ * Infer the PayoutJSON type from the schema
+ */
+export type PayoutJSON = z.infer<typeof PayoutJSONSchema>;
 /**
  * Payout class that wraps the Zod schema and provides additional functionality
  */
@@ -133,7 +246,134 @@ export declare class Payout {
      */
     static is(obj: unknown): obj is Payout;
     /**
-     * Converts Payout instance to a plain object
+   * Serializes the Payout instance to a JSON-compatible object
+   *
+   * Converts all Date objects to ISO strings for proper JSON serialization.
+   * The resulting object can be safely stringified and stored or transmitted.
+   *
+   * @returns {PayoutJSON} A plain object containing all payout data
+   *
+   * @example
+   * ```typescript
+   * const payout = Payout.create(payoutData);
+   * const json = payout.toJSON();
+   * // {
+   * //   id: "payout-123",
+   * //   amount: 50000,
+   * //   currencyCode: "TZS",
+   * //   createdAt: "2024-01-15T10:30:00.000Z",
+   * //   ...
+   * // }
+   * ```
+   */
+    toJSON(): PayoutJSON;
+    /**
+     * Serializes the Payout instance to a JSON string
+     *
+     * @returns {string} JSON string representation of the payout
+     *
+     * @example
+     * ```typescript
+     * const payout = Payout.create(payoutData);
+     * const jsonString = payout.toJSONString();
+     *
+     * // Store in localStorage
+     * localStorage.setItem('pendingPayout', jsonString);
+     *
+     * // Or send to server
+     * await fetch('/api/cache-payout', {
+     *   method: 'POST',
+     *   body: jsonString
+     * });
+     * ```
+     */
+    toJSONString(): string;
+    /**
+     * Creates a Payout instance from a JSON-compatible object or string
+     *
+     * This method reconstructs a Payout instance from data that was previously
+     * serialized using toJSON(). It validates the input data using Zod schema
+     * and converts ISO date strings back to Date objects.
+     *
+     * @param {PayoutJSON | string} json - Either a PayoutJSON object or a JSON string
+     * @returns {Payout | undefined} A Payout instance if valid, undefined otherwise
+     *
+     * @example
+     * ```typescript
+     * // From localStorage
+     * const stored = localStorage.getItem('pendingPayout');
+     * const payout = Payout.fromJSON(stored!);
+     *
+     * if (payout) {
+     *   console.log(payout.amount.label); // "TSh 50,000.00"
+     *   console.log(payout.status); // "PENDING"
+     * }
+     *
+     * // From object
+     * const payoutJson = {
+     *   id: "payout-123",
+     *   amount: 50000,
+     *   currencyCode: "TZS",
+     *   createdAt: "2024-01-15T10:30:00.000Z",
+     *   ...
+     * };
+     * const payout = Payout.fromJSON(payoutJson);
+     * ```
+     */
+    static fromJSON(json: PayoutJSON | string): Payout | undefined;
+    /**
+     * Type guard using Zod schema validation
+     *
+     * Checks if an unknown value conforms to the PayoutJSON structure
+     * without attempting to create a Payout instance.
+     *
+     * @param {unknown} obj - The object to validate
+     * @returns {boolean} True if the object is a valid PayoutJSON
+     *
+     * @example
+     * ```typescript
+     * const data = JSON.parse(localStorage.getItem('payout'));
+     *
+     * if (Payout.isPayoutJSON(data)) {
+     *   const payout = Payout.fromJSON(data);
+     *   // TypeScript knows data is PayoutJSON here
+     * }
+     * ```
+     */
+    static isPayoutJSON(obj: unknown): obj is PayoutJSON;
+    /**
+     * Creates multiple Payout instances from a JSON array
+     *
+     * @param {PayoutJSON[] | string} jsonArray - Array of PayoutJSON objects or JSON string
+     * @returns {Payout[]} Array of Payout instances (invalid items are filtered out)
+     *
+     * @example
+     * ```typescript
+     * // From API response
+     * const response = await fetch('/api/payouts');
+     * const jsonArray = await response.json();
+     * const payouts = Payout.fromJSONArray(jsonArray);
+     *
+     * // From stored array
+     * const stored = localStorage.getItem('recentPayouts');
+     * const payouts = Payout.fromJSONArray(stored!);
+     * ```
+     */
+    static fromJSONArray(jsonArray: PayoutJSON[] | string): Payout[];
+    /**
+     * Serializes an array of Payout instances to JSON
+     *
+     * @param {Payout[]} payouts - Array of Payout instances to serialize
+     * @returns {PayoutJSON[]} Array of PayoutJSON objects
+     *
+     * @example
+     * ```typescript
+     * const payouts = [payout1, payout2, payout3];
+     * const jsonArray = Payout.toJSONArray(payouts);
+     *
+     * // Store or transmit
+     * localStorage.setItem('recentPayouts', JSON.stringify(jsonArray));
+     * ```
      */
-    toJSON(): PayoutDTO;
+    static toJSONArray(payouts: Payout[]): PayoutJSON[];
 }

package/dist/modules/profile/profile.model.d.ts

@@ -1,4 +1,42 @@
-import { ProfileDTO } from "./profile.dtos.js";
+import { z } from "zod";
+/**
+ * Zod schema for Profile JSON serialization
+ */
+export declare const ProfileJSONSchema: z.ZodObject<{
+    id: z.ZodString;
+    firstName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    lastName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    displayName: z.ZodString;
+    phone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    accountNo: z.ZodString;
+    email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    autoApprove: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    displayName: string;
+    accountNo: string;
+    version: 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;
+    version?: string | undefined;
+}>;
+/**
+ * Infer the ProfileJSON type from the schema
+ */
+export type ProfileJSON = z.infer<typeof ProfileJSONSchema>;
 /**
  * Represents a user profile in the system.
  *
@@ -25,16 +63,16 @@ export declare class Profile {
     /**
      * Gets the profile schema used for validation.
      */
-    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, {
+    static get schema(): z.ZodObject<{
+        id: z.ZodString;
+        firstName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        lastName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        displayName: z.ZodString;
+        phone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        accountNo: z.ZodString;
+        email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        autoApprove: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
         id: string;
         displayName: string;
         accountNo: string;
@@ -113,31 +151,12 @@ export declare class Profile {
      * Returns the display name if it exists, otherwise returns the first and last name combined.
      */
     getName(): string;
-    /**
-     * Creates a plain object representation of the profile for validation or serialization.
-     *
-     * @returns A plain object matching the ProfileType interface
-     */
-    toObject(): ProfileDTO;
-    /**
-     * Converts the profile to a JSON string.
-     *
-     * @returns A JSON string representation of the profile
-     */
-    toJSON(): string;
     /**
      * Validates the profile data against the Zod schema.
      *
      * @returns True if the profile is valid, false otherwise
      */
     validate(): boolean;
-    /**
-     * Creates a Profile instance from a JSON string.
-     *
-     * @param jsonString - JSON string containing profile data
-     * @returns A new Profile instance, or undefined if parsing failed
-     */
-    static fromJSON(jsonString: string): Profile | undefined;
     /**
      * Creates a Profile instance from a plain object.
      *
@@ -152,4 +171,20 @@ export declare class Profile {
      * @returns Type predicate indicating if the object is a valid Profile
      */
     static is(obj: unknown): obj is Profile;
+    /**
+   * Serializes the Profile instance to a JSON-compatible object
+   */
+    toJSON(): ProfileJSON;
+    /**
+     * Serializes the Profile instance to a JSON string
+     */
+    toJSONString(): string;
+    /**
+     * Creates a Profile instance from a JSON-compatible object or string
+     */
+    static fromJSON(json: ProfileJSON | string): Profile | undefined;
+    /**
+     * Type guard using Zod schema validation
+     */
+    static isProfileJSON(obj: unknown): obj is ProfileJSON;
 }

package/dist/modules/team-member/role.model.d.ts

@@ -1,4 +1,37 @@
+import z from "zod";
 import { RoleDTO } from "./team-member.dtos.js";
+/**
+ * Zod schema for Role JSON serialization
+ */
+export declare const RoleJSONSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    access: z.ZodArray<z.ZodString, "many">;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    id: string;
+    version: string;
+    createdAt: string;
+    updatedAt: string;
+    access: string[];
+    description?: string | undefined;
+}, {
+    name: string;
+    id: string;
+    createdAt: string;
+    updatedAt: string;
+    access: string[];
+    version?: string | undefined;
+    description?: string | undefined;
+}>;
+/**
+ * Infer the RoleJSON type from the schema
+ */
+export type RoleJSON = z.infer<typeof RoleJSONSchema>;
 export declare class Role {
     readonly id: string;
     readonly name: string;
@@ -9,5 +42,20 @@ export declare class Role {
     constructor(data: RoleDTO);
     hasPermission(permission: string): boolean;
     static from(data: RoleDTO): Role | undefined;
-    toJSON(): any;
+    /**
+   * Serializes the Role instance to a JSON-compatible object
+   */
+    toJSON(): RoleJSON;
+    /**
+     * Serializes the Role instance to a JSON string
+     */
+    toJSONString(): string;
+    /**
+     * Creates a Role instance from a JSON-compatible object or string
+     */
+    static fromJSON(json: RoleJSON | string): Role | undefined;
+    /**
+     * Type guard using Zod schema validation
+     */
+    static isRoleJSON(obj: unknown): obj is RoleJSON;
 }

package/dist/modules/team-member/team-member.model.d.ts

@@ -1,3 +1,4 @@
+import z from "zod";
 import { Role } from "./role.model.js";
 import { RoleDTO } from "./team-member.dtos.js";
 export interface TeamMemberData {
@@ -14,6 +15,93 @@ export interface TeamMemberData {
     createdAt: string;
     updatedAt: string;
 }
+/**
+ * Zod schema for TeamMember JSON serialization
+ */
+export declare const TeamMemberJSONSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    identity: z.ZodString;
+    type: z.ZodString;
+    profileId: z.ZodString;
+    roleId: z.ZodString;
+    resetPassword: z.ZodBoolean;
+    isActive: z.ZodBoolean;
+    isArchived: z.ZodBoolean;
+    role: z.ZodOptional<z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        access: z.ZodArray<z.ZodString, "many">;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        version: string;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        description?: string | undefined;
+    }, {
+        name: string;
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        version?: string | undefined;
+        description?: string | undefined;
+    }>>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    name: string;
+    id: string;
+    version: string;
+    profileId: string;
+    identity: string;
+    roleId: string;
+    isActive: boolean;
+    isArchived: boolean;
+    resetPassword: boolean;
+    createdAt: string;
+    updatedAt: string;
+    role?: {
+        name: string;
+        id: string;
+        version: string;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        description?: string | undefined;
+    } | undefined;
+}, {
+    type: string;
+    name: string;
+    id: string;
+    profileId: string;
+    identity: string;
+    roleId: string;
+    isActive: boolean;
+    isArchived: boolean;
+    resetPassword: boolean;
+    createdAt: string;
+    updatedAt: string;
+    version?: string | undefined;
+    role?: {
+        name: string;
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+        version?: string | undefined;
+        description?: string | undefined;
+    } | undefined;
+}>;
+export type TeamMemberJSON = z.infer<typeof TeamMemberJSONSchema>;
 /**
  * Represents a team member from the admin management perspective.
  *
@@ -123,15 +211,27 @@ export declare class TeamMember {
      */
     getLastUpdateInfo(): string;
     /**
-     * Converts the TeamMember instance to a plain object.
+   * Serializes the TeamMember instance to a JSON-compatible object
+   */
+    toJSON(): TeamMemberJSON;
+    /**
+     * Serializes the TeamMember instance to a JSON string
+     */
+    toJSONString(): string;
+    /**
+     * Creates a TeamMember instance from a JSON-compatible object or string
+     */
+    static fromJSON(json: TeamMemberJSON | string): TeamMember | undefined;
+    /**
+     * Type guard using Zod schema validation
      */
-    toObject(): any;
+    static isTeamMemberJSON(obj: unknown): obj is TeamMemberJSON;
     /**
-     * Converts the TeamMember instance to a JSON string.
+     * Creates multiple TeamMember instances from a JSON array
      */
-    toJson(): string;
+    static fromJSONArray(jsonArray: TeamMemberJSON[] | string): TeamMember[];
     /**
-     * Alias for toJson() to maintain consistency with other models
+     * Serializes an array of TeamMember instances to JSON
      */
-    toJSON(): any;
+    static toJSONArray(members: TeamMember[]): TeamMemberJSON[];
 }

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

@@ -1,4 +1,5 @@
 import { ContactInfo, MobileContactInfo, BankContactInfo } from "../contact/contact-info.model.js";
+import z from "zod";
 /** Prefix for Ecobank mobile transfer narrations */
 export declare const ECOBANK_PREFIX = "MOBILE TRANSFER ";
 /** V2 format prefix for payout narrations using contact details */
@@ -12,12 +13,19 @@ 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
+ * Zod schema for Narration JSON serialization
  */
-export interface NarrationJson {
+export declare const NarrationJSONSchema: z.ZodObject<{
+    text: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    version: string;
     text: string;
-    version?: string;
-}
+}, {
+    text: string;
+    version?: string | undefined;
+}>;
+export type NarrationJSON = z.infer<typeof NarrationJSONSchema>;
 /**
  * Handles payout narration generation and parsing for the Afloat platform.
  *
@@ -184,46 +192,34 @@ export declare class Narration {
      */
     getMobileContactDetails: () => MobileContactInfo | undefined;
     /**
-     * Serializes the Narration instance to a JSON-compatible object.
-     *
-     * @returns {NarrationJson} A plain object containing the narration data
+     * Type guard to check if an unknown object is a valid Narration instance.
      *
-     * @example
-     * ```typescript
-     * const narration = new Narration("PAYOUT +255123456789 JOHN DOE");
-     * const json = narration.toJson();
-     * // Returns: { text: "PAYOUT +255123456789 JOHN DOE", version: "2.0" }
-     * ```
+     * @param obj - The object to check
+     * @returns Type predicate indicating if the object is a Narration instance
      */
-    toJson(): NarrationJson;
+    static is(obj: unknown): obj is Narration;
     /**
-     * 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"}');
-     * ```
+   * Serializes the Narration instance to a JSON-compatible object
+   */
+    toJSON(): NarrationJSON;
+    /**
+     * Serializes the Narration instance to a JSON string
      */
-    static fromJson(json: NarrationJson | string): Narration | undefined;
+    toJSONString(): string;
     /**
-     * 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
+     * Creates a Narration instance from a JSON-compatible object or string
      */
-    static isNarrationJson(obj: unknown): obj is NarrationJson;
+    static fromJSON(json: NarrationJSON | string): Narration | undefined;
     /**
-     * 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
+     * Type guard using Zod schema validation
      */
-    static is(obj: unknown): obj is Narration;
+    static isNarrationJSON(obj: unknown): obj is NarrationJSON;
+    /**
+     * @deprecated Use toJSON() instead
+     */
+    toJson(): NarrationJSON;
+    /**
+     * @deprecated Use fromJSON() instead
+     */
+    static fromJson(json: NarrationJSON | string): Narration | undefined;
 }