@temboplus/afloat 0.1.77-beta.2 → 0.1.77-beta.21

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

@@ -27,7 +27,9 @@ export declare enum PayoutStatus {
     /** Payout has been rejected */
     REJECTED = "REJECTED",
     /** Payout has been reversed */
-    REVERSED = "REVERSED"
+    REVERSED = "REVERSED",
+    /** Payout has been queued for processing */
+    QUEUED = "QUEUED"
 }
 /**
  * Represents the approval status for payouts that require authorization.
@@ -142,17 +144,17 @@ declare const PayoutDTOSchema: z.ZodObject<{
     }>>>;
 }, "strip", z.ZodTypeAny, {
     status: PayoutStatus;
+    createdAt: Date;
     id: string;
     profileId: string;
-    createdAt: Date;
     updatedAt: Date;
     description: string;
     channel: string;
-    countryCode: import("@temboplus/frontend-core").ISO2CountryCode;
-    currencyCode: import("@temboplus/frontend-core").CurrencyCode;
     msisdn: string;
     amount: number;
     payeeName: string;
+    countryCode: import("@temboplus/frontend-core").ISO2CountryCode;
+    currencyCode: import("@temboplus/frontend-core").CurrencyCode;
     statusMessage: string;
     notes?: string | null | undefined;
     partnerReference?: string | null | undefined;
@@ -170,9 +172,9 @@ declare const PayoutDTOSchema: z.ZodObject<{
     } | null | undefined;
 }, {
     status: PayoutStatus;
+    createdAt: Date;
     id: string;
     profileId: string;
-    createdAt: Date;
     updatedAt: Date;
     description: string;
     channel: string;
@@ -180,9 +182,9 @@ declare const PayoutDTOSchema: z.ZodObject<{
     amount: number;
     payeeName: string;
     statusMessage: string;
+    notes?: string | null | undefined;
     countryCode?: string | undefined;
     currencyCode?: string | undefined;
-    notes?: string | null | undefined;
     partnerReference?: string | null | undefined;
     actionedAt?: Date | null | undefined;
     approvalStatus?: PayoutApprovalStatus | null | undefined;
@@ -213,6 +215,7 @@ declare const PayoutFiltersSchema: z.ZodObject<{
     id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     partnerReference: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     channel: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    currencyCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     status: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof PayoutStatus>>>;
     approvalStatus: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof PayoutApprovalStatus>>>;
     minAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
@@ -227,31 +230,33 @@ declare const PayoutFiltersSchema: z.ZodObject<{
     id?: string | null | undefined;
     profileId?: string | null | undefined;
     search?: string | null | undefined;
-    startDate?: string | null | undefined;
-    endDate?: string | null | undefined;
     channel?: string | null | undefined;
     msisdn?: string | null | undefined;
     payeeName?: string | null | undefined;
+    currencyCode?: string | null | undefined;
     partnerReference?: string | null | undefined;
     approvalStatus?: PayoutApprovalStatus | null | undefined;
+    startDate?: string | null | undefined;
+    endDate?: string | null | undefined;
     minAmount?: number | null | undefined;
     maxAmount?: number | null | undefined;
 }, {
     status?: PayoutStatus | null | undefined;
+    page?: number | undefined;
+    limit?: number | undefined;
     id?: string | null | undefined;
     profileId?: string | null | undefined;
     search?: string | null | undefined;
-    startDate?: string | null | undefined;
-    endDate?: string | null | undefined;
-    page?: number | undefined;
-    limit?: number | undefined;
     channel?: string | null | undefined;
     msisdn?: string | null | undefined;
     payeeName?: string | null | undefined;
+    currencyCode?: string | null | undefined;
     partnerReference?: string | null | undefined;
     approvalStatus?: PayoutApprovalStatus | null | undefined;
     sortBy?: string | undefined;
     sortOrder?: "asc" | "desc" | undefined;
+    startDate?: string | null | undefined;
+    endDate?: string | null | undefined;
     minAmount?: number | null | undefined;
     maxAmount?: number | null | undefined;
 }>;
@@ -280,29 +285,27 @@ declare const PayoutURLQueryParamsSchema: z.ZodObject<{
     sortBy: string;
     sortOrder: "asc" | "desc";
     status?: PayoutStatus | undefined;
+    page?: number | undefined;
+    limit?: number | undefined;
     id?: string | undefined;
     profileId?: string | undefined;
     search?: string | undefined;
-    startDate?: string | undefined;
-    endDate?: string | undefined;
-    page?: number | undefined;
-    limit?: number | undefined;
     channel?: string | undefined;
     msisdn?: string | undefined;
     payeeName?: string | undefined;
     partnerReference?: string | undefined;
     approvalStatus?: PayoutApprovalStatus | undefined;
+    startDate?: string | undefined;
+    endDate?: string | undefined;
     minAmount?: number | undefined;
     maxAmount?: number | undefined;
 }, {
     status?: string | undefined;
+    page?: string | undefined;
+    limit?: string | undefined;
     id?: string | undefined;
     profileId?: string | undefined;
     search?: string | undefined;
-    startDate?: string | undefined;
-    endDate?: string | undefined;
-    page?: string | undefined;
-    limit?: string | undefined;
     channel?: string | undefined;
     msisdn?: string | undefined;
     payeeName?: string | undefined;
@@ -310,6 +313,8 @@ declare const PayoutURLQueryParamsSchema: z.ZodObject<{
     approvalStatus?: string | undefined;
     sortBy?: string | undefined;
     sortOrder?: "asc" | "desc" | undefined;
+    startDate?: string | undefined;
+    endDate?: string | undefined;
     minAmount?: string | undefined;
     maxAmount?: string | undefined;
 }>;
@@ -388,17 +393,17 @@ export declare const PayoutDTOSchemas: {
         }>>>;
     }, "strip", z.ZodTypeAny, {
         status: PayoutStatus;
+        createdAt: Date;
         id: string;
         profileId: string;
-        createdAt: Date;
         updatedAt: Date;
         description: string;
         channel: string;
-        countryCode: import("@temboplus/frontend-core").ISO2CountryCode;
-        currencyCode: import("@temboplus/frontend-core").CurrencyCode;
         msisdn: string;
         amount: number;
         payeeName: string;
+        countryCode: import("@temboplus/frontend-core").ISO2CountryCode;
+        currencyCode: import("@temboplus/frontend-core").CurrencyCode;
         statusMessage: string;
         notes?: string | null | undefined;
         partnerReference?: string | null | undefined;
@@ -416,9 +421,9 @@ export declare const PayoutDTOSchemas: {
         } | null | undefined;
     }, {
         status: PayoutStatus;
+        createdAt: Date;
         id: string;
         profileId: string;
-        createdAt: Date;
         updatedAt: Date;
         description: string;
         channel: string;
@@ -426,9 +431,9 @@ export declare const PayoutDTOSchemas: {
         amount: number;
         payeeName: string;
         statusMessage: string;
+        notes?: string | null | undefined;
         countryCode?: string | undefined;
         currencyCode?: string | undefined;
-        notes?: string | null | undefined;
         partnerReference?: string | null | undefined;
         actionedAt?: Date | null | undefined;
         approvalStatus?: PayoutApprovalStatus | null | undefined;
@@ -494,6 +499,7 @@ export declare const PayoutDTOSchemas: {
         id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         partnerReference: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         channel: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        currencyCode: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         status: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof PayoutStatus>>>;
         approvalStatus: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof PayoutApprovalStatus>>>;
         minAmount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
@@ -508,31 +514,33 @@ export declare const PayoutDTOSchemas: {
         id?: string | null | undefined;
         profileId?: string | null | undefined;
         search?: string | null | undefined;
-        startDate?: string | null | undefined;
-        endDate?: string | null | undefined;
         channel?: string | null | undefined;
         msisdn?: string | null | undefined;
         payeeName?: string | null | undefined;
+        currencyCode?: string | null | undefined;
         partnerReference?: string | null | undefined;
         approvalStatus?: PayoutApprovalStatus | null | undefined;
+        startDate?: string | null | undefined;
+        endDate?: string | null | undefined;
         minAmount?: number | null | undefined;
         maxAmount?: number | null | undefined;
     }, {
         status?: PayoutStatus | null | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
         id?: string | null | undefined;
         profileId?: string | null | undefined;
         search?: string | null | undefined;
-        startDate?: string | null | undefined;
-        endDate?: string | null | undefined;
-        page?: number | undefined;
-        limit?: number | undefined;
         channel?: string | null | undefined;
         msisdn?: string | null | undefined;
         payeeName?: string | null | undefined;
+        currencyCode?: string | null | undefined;
         partnerReference?: string | null | undefined;
         approvalStatus?: PayoutApprovalStatus | null | undefined;
         sortBy?: string | undefined;
         sortOrder?: "asc" | "desc" | undefined;
+        startDate?: string | null | undefined;
+        endDate?: string | null | undefined;
         minAmount?: number | null | undefined;
         maxAmount?: number | null | undefined;
     }>;
@@ -558,29 +566,27 @@ export declare const PayoutDTOSchemas: {
         sortBy: string;
         sortOrder: "asc" | "desc";
         status?: PayoutStatus | undefined;
+        page?: number | undefined;
+        limit?: number | undefined;
         id?: string | undefined;
         profileId?: string | undefined;
         search?: string | undefined;
-        startDate?: string | undefined;
-        endDate?: string | undefined;
-        page?: number | undefined;
-        limit?: number | undefined;
         channel?: string | undefined;
         msisdn?: string | undefined;
         payeeName?: string | undefined;
         partnerReference?: string | undefined;
         approvalStatus?: PayoutApprovalStatus | undefined;
+        startDate?: string | undefined;
+        endDate?: string | undefined;
         minAmount?: number | undefined;
         maxAmount?: number | undefined;
     }, {
         status?: string | undefined;
+        page?: string | undefined;
+        limit?: string | undefined;
         id?: string | undefined;
         profileId?: string | undefined;
         search?: string | undefined;
-        startDate?: string | undefined;
-        endDate?: string | undefined;
-        page?: string | undefined;
-        limit?: string | undefined;
         channel?: string | undefined;
         msisdn?: string | undefined;
         payeeName?: string | undefined;
@@ -588,6 +594,8 @@ export declare const PayoutDTOSchemas: {
         approvalStatus?: string | undefined;
         sortBy?: string | undefined;
         sortOrder?: "asc" | "desc" | undefined;
+        startDate?: string | undefined;
+        endDate?: string | undefined;
         minAmount?: string | undefined;
         maxAmount?: string | undefined;
     }>;

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;
+    createdAt: string;
+    id: string;
+    version: string;
+    profileId: string;
+    updatedAt: string;
+    description: string;
+    channel: string;
+    msisdn: string;
+    amount: number;
+    payeeName: string;
+    countryCode: string;
+    currencyCode: 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;
+    createdAt: string;
+    id: string;
+    profileId: string;
+    updatedAt: string;
+    description: string;
+    channel: string;
+    msisdn: string;
+    amount: number;
+    payeeName: string;
+    countryCode: string;
+    currencyCode: 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/payout/payout.query.d.ts

@@ -1,5 +1,6 @@
 import { QueryBuilder } from "@/lib/query/index.js";
 import { PayoutStatus, PayoutApprovalStatus, PayoutFilters } from "./payout.dtos.js";
+import { Amount } from "@temboplus/frontend-core";
 /**
  * Payout-specific query builder that extends the base QueryBuilder
  * and handles all possible input conversions (DTOs, URL params, etc.)
@@ -41,12 +42,13 @@ export declare class PayoutQuery extends QueryBuilder {
     whereRejected(): this;
     wherePaid(): this;
     whereFailed(): this;
-    whereAmountBetween(min: number, max: number): this;
+    whereAmountBetween(min: Amount, max: Amount): this;
     wherePayee(payeeName: string): this;
     whereMsisdn(msisdn: string): this;
     whereProfileId(profileId: string): this;
     wherePartnerReference(partnerReference: string): this;
     whereSearch(searchTerm: string): this;
+    whereCurrencyCode(currencyCode: string): this;
     /**
      * Apply all filters from PayoutFilters object
      */
@@ -56,7 +58,7 @@ export declare class PayoutQuery extends QueryBuilder {
      */
     toFilters(): PayoutFilters;
     /**
-     * Convert to URL-safe string parameters
+     * Convert to user-friendly URL parameters (for browser URLs)
      */
     toUrlParams(): Record<string, string>;
     /**
@@ -78,7 +80,7 @@ export declare class PayoutQuery extends QueryBuilder {
     /**
      * Create new instance with date range
      */
-    withDateRange(startDate?: string, endDate?: string): PayoutQuery;
+    withDateRange(startDate?: string | Date, endDate?: string | Date): PayoutQuery;
     /**
      * Create new instance with status filter
      */
@@ -91,6 +93,12 @@ export declare class PayoutQuery extends QueryBuilder {
      * Create new instance with channel filter
      */
     withChannel(channel?: string): PayoutQuery;
+    /**
+     * Includes default relations for eager loading.
+     * This ensures that related data (createdBy, actionedBy) is fetched automatically.
+     * @returns The current query builder instance.
+     */
+    includeDefaultRelations(): this;
     /**
      * Reset to first page
      */