@temboplus/afloat 0.1.77-beta.9 → 0.1.78

package/script/npm/src/src/models/payout/narration.js

@@ -0,0 +1,312 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Narration = exports.LEGACY_MOBILE_NARR_PREFIX = exports.MOBILE_NARR_PREFIX = exports.LEGACY_BANK_NARR_PREFIX = exports.BANK_NARR_PREFIX = exports.ECOBANK_PREFIX = void 0;
+const afloat_1 = require("@temboplus/afloat");
+const mod_js_1 = require("../../../deps/jsr.io/@temboplus/frontend-core/0.2.21/mod.js");
+/** Prefix for Ecobank mobile transfer narrations */
+exports.ECOBANK_PREFIX = "MOBILE TRANSFER ";
+/** Current format prefix for bank payout narrations */
+exports.BANK_NARR_PREFIX = "PAYOUT TO BANK";
+/** Legacy format prefix for bank payout narrations */
+exports.LEGACY_BANK_NARR_PREFIX = "TO_BANK";
+/** Current format prefix for mobile money payout narrations */
+exports.MOBILE_NARR_PREFIX = "PAYOUT TO MOBILE";
+/** Legacy format prefix for mobile money payout narrations */
+exports.LEGACY_MOBILE_NARR_PREFIX = "TO_MOMO";
+/**
+ * Handles payout narration generation and parsing for the Afloat platform.
+ *
+ * This class provides functionality to:
+ * - Generate standardized default narrations for mobile money and bank payouts
+ * - Parse existing narrations to extract contact information
+ * - Format narration text for different display contexts
+ * - Handle both current and legacy narration formats for backward compatibility
+ *
+ * @example
+ * ```typescript
+ * // Generate default narration for a mobile contact
+ * const mobileContact = new MobileContactInfo("John Doe", phoneNumber);
+ * const narration = Narration.generateDefaultPayoutNarration(mobileContact);
+ * // Result: "PAYOUT TO MOBILE +255123456789 JOHN DOE"
+ *
+ * // Parse narration to extract contact details
+ * const existingNarration = new Narration("PAYOUT TO BANK CRDB 1234567890 Jane Smith");
+ * const contact = existingNarration.getContactDetails();
+ * ```
+ */
+class Narration {
+    /**
+     * Creates a new Narration instance.
+     *
+     * @param text - The narration text to wrap
+     */
+    constructor(text) {
+        /** The raw narration text */
+        Object.defineProperty(this, "text", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Extracts contact information from the narration text.
+         * Attempts to parse both bank and mobile contact details from the narration.
+         *
+         * @returns Parsed ContactInfo (BankContactInfo or MobileContactInfo) if successful, undefined otherwise
+         *
+         * @example
+         * ```typescript
+         * const narration = new Narration("PAYOUT TO BANK CRDB 1234567890 Jane Smith");
+         * const contact = narration.getContactDetails();
+         * // Returns: BankContactInfo instance with parsed details
+         * ```
+         */
+        Object.defineProperty(this, "getContactDetails", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: () => {
+                const result1 = this.getBankContactDetails();
+                const result2 = this.getMobileContactDetails();
+                if (result1)
+                    return result1;
+                if (result2)
+                    return result2;
+            }
+        });
+        /**
+         * Extracts bank contact information from the narration text.
+         * Handles both current format ("PAYOUT TO BANK") and legacy format ("TO_BANK").
+         * Also handles Ecobank-prefixed narrations by stripping the prefix.
+         *
+         * Current format: "PAYOUT TO BANK {bank_name} {account_number} {account_name}"
+         * Legacy format: "TO_BANK => {json_object}"
+         *
+         * @returns BankContactInfo if parsing is successful, undefined otherwise
+         *
+         * @example
+         * ```typescript
+         * // Current format
+         * const narration = new Narration("PAYOUT TO BANK CRDB 1234567890 Jane Smith");
+         * const contact = narration.getBankContactDetails();
+         *
+         * // Legacy format
+         * const legacyNarration = new Narration('TO_BANK => {"account_number":"1234567890","account_name":"Jane Smith","swift_code":"CORUTZTZ"}');
+         * const legacyContact = narration.getBankContactDetails();
+         * ```
+         */
+        Object.defineProperty(this, "getBankContactDetails", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: () => {
+                let narr = this.text.trim();
+                if (narr.startsWith(exports.ECOBANK_PREFIX)) {
+                    narr = narr.substring(exports.ECOBANK_PREFIX.length);
+                }
+                try {
+                    // Handle legacy format: "TO_BANK => {json}"
+                    if (narr.startsWith(exports.LEGACY_BANK_NARR_PREFIX)) {
+                        const json = narr.split("=>")[1].trim();
+                        const map = JSON.parse(json);
+                        const accNo = map["account_number"];
+                        const accName = map["account_name"];
+                        const code = map["swift_code"];
+                        const bank = mod_js_1.Bank.fromSWIFTCode(code);
+                        if (accNo && accName && bank) {
+                            return new afloat_1.BankContactInfo(accName, bank, accNo);
+                        }
+                    }
+                    // Handle current format: "PAYOUT TO BANK {bank} {accNo} {accName}"
+                    if (narr.startsWith(exports.BANK_NARR_PREFIX)) {
+                        const data = narr.replace(exports.BANK_NARR_PREFIX, "").trim().split(" ");
+                        const bank = mod_js_1.Bank.fromBankName(data[0]);
+                        const accNo = data[1];
+                        const accName = data.slice(2).map(capitalizeFirstLetter).join(" ");
+                        if (accName && accNo && bank) {
+                            return new afloat_1.BankContactInfo(accName, bank, accNo);
+                        }
+                    }
+                }
+                catch (_) {
+                    return undefined;
+                }
+            }
+        });
+        /**
+         * Extracts mobile contact information from the narration text.
+         * Handles both current format ("PAYOUT TO MOBILE") and legacy format ("TO_MOMO").
+         * Also handles Ecobank-prefixed narrations by stripping the prefix.
+         *
+         * Current format: "PAYOUT TO MOBILE {phone_number} {name}"
+         * Legacy format: "TO_MOMO => {json_object}"
+         *
+         * @returns MobileContactInfo if parsing is successful, undefined otherwise
+         *
+         * @example
+         * ```typescript
+         * // Current format
+         * const narration = new Narration("PAYOUT TO MOBILE +255123456789 John Doe");
+         * const contact = narration.getMobileContactDetails();
+         *
+         * // Legacy format
+         * const legacyNarration = new Narration('TO_MOMO => {"phone_number":"+255123456789","username":"John Doe"}');
+         * const legacyContact = narration.getMobileContactDetails();
+         * ```
+         */
+        Object.defineProperty(this, "getMobileContactDetails", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: () => {
+                let narr = this.text.trim();
+                if (narr.startsWith(exports.ECOBANK_PREFIX)) {
+                    narr = narr.substring(exports.ECOBANK_PREFIX.length);
+                }
+                try {
+                    // Handle legacy format: "TO_MOMO => {json}"
+                    if (narr.startsWith(exports.LEGACY_MOBILE_NARR_PREFIX)) {
+                        const json = narr.split("=>")[1].trim();
+                        const map = JSON.parse(json);
+                        const phoneNumber = mod_js_1.TZPhoneNumber.from(map["phone_number"]);
+                        let username = map["username"];
+                        if (username === undefined)
+                            username = "";
+                        // Clean up username: remove extra spaces and capitalize each word
+                        let names = username.split(" ");
+                        names = names.filter((n) => n.trim().length > 0);
+                        username = names.map(capitalizeFirstLetter).join(" ");
+                        if (phoneNumber && username) {
+                            return new afloat_1.MobileContactInfo(username, phoneNumber);
+                        }
+                    }
+                    // Handle current format: "PAYOUT TO MOBILE {phone} {username}"
+                    if (narr.startsWith(exports.MOBILE_NARR_PREFIX)) {
+                        const data = narr.replace(exports.MOBILE_NARR_PREFIX, "").trim().split(" ");
+                        const phone = mod_js_1.TZPhoneNumber.from(data[0]);
+                        const username = data.slice(1).map(capitalizeFirstLetter).join(" ");
+                        if (phone && username) {
+                            return new afloat_1.MobileContactInfo(username, phone);
+                        }
+                    }
+                }
+                catch (_) {
+                    return undefined;
+                }
+            }
+        });
+        this.text = text;
+    }
+    /**
+     * Returns a medium-length version of the narration text suitable for table columns.
+     * Truncates to 47 characters + "..." if longer than 50 characters.
+     *
+     * @returns Truncated narration text for medium-width displays
+     */
+    get mediumText() {
+        if (this.text.length > 50) {
+            return this.text.substring(0, 47) + "...";
+        }
+        return this.text;
+    }
+    /**
+     * Returns a short version of the narration text suitable for compact displays.
+     * Truncates to 32 characters + "..." if longer than 35 characters.
+     *
+     * @returns Truncated narration text for narrow displays
+     */
+    get shortText() {
+        if (this.text.length > 35) {
+            return this.text.substring(0, 32) + "...";
+        }
+        return this.text;
+    }
+    /**
+     * Generates a default payout narration based on contact information.
+     * Automatically determines whether to generate mobile or bank narration based on contact type.
+     *
+     * @param data - Contact information (either MobileContactInfo or BankContactInfo)
+     * @returns Formatted default narration string in uppercase, or empty string if contact type is unrecognized
+     *
+     * @example
+     * ```typescript
+     * const mobileContact = new MobileContactInfo("John Doe", phoneNumber);
+     * const narration = Narration.generateDefaultPayoutNarration(mobileContact);
+     * // Returns: "PAYOUT TO MOBILE +255123456789 JOHN DOE"
+     *
+     * const bankContact = new BankContactInfo("Jane Smith", bank, "1234567890");
+     * const narration = Narration.generateDefaultPayoutNarration(bankContact);
+     * // Returns: "PAYOUT TO BANK CRDB 1234567890 JANE SMITH"
+     * ```
+     */
+    static generateDefaultPayoutNarration(data) {
+        if (afloat_1.MobileContactInfo.is(data)) {
+            return Narration.generateMobilePayoutNarration(data);
+        }
+        else if (afloat_1.BankContactInfo.is(data)) {
+            return Narration.generateBankPayoutNarration(data);
+        }
+        else {
+            return "";
+        }
+    }
+    /**
+     * Generates a standardized mobile money payout narration.
+     * Format: "PAYOUT TO MOBILE {phone_number} {name}"
+     *
+     * @param data - Mobile contact information containing phone number and name
+     * @returns Formatted mobile payout narration in uppercase
+     *
+     * @example
+     * ```typescript
+     * const contact = new MobileContactInfo("John Doe", phoneNumber);
+     * const narration = Narration.generateMobilePayoutNarration(contact);
+     * // Returns: "PAYOUT TO MOBILE +255123456789 JOHN DOE"
+     * ```
+     */
+    static generateMobilePayoutNarration(data) {
+        const { phoneNumber, name } = data;
+        return `${exports.MOBILE_NARR_PREFIX.trim()} ${phoneNumber.label.trim()} ${name.trim()}`.toUpperCase();
+    }
+    /**
+     * Generates a standardized bank payout narration.
+     * Format: "PAYOUT TO BANK {bank_short_name} {account_number} {account_name}"
+     *
+     * @param data - Bank contact information containing bank details, account number, and account name
+     * @returns Formatted bank payout narration in uppercase
+     *
+     * @example
+     * ```typescript
+     * const contact = new BankContactInfo("Jane Smith", bank, "1234567890");
+     * const narration = Narration.generateBankPayoutNarration(contact);
+     * // Returns: "PAYOUT TO BANK CRDB 1234567890 JANE SMITH"
+     * ```
+     */
+    static generateBankPayoutNarration(data) {
+        const { bank, accName, accNo } = data;
+        return `${exports.BANK_NARR_PREFIX.trim()} ${bank.shortName.trim()} ${accNo.trim()} ${accName.trim()}`.toUpperCase();
+    }
+}
+exports.Narration = Narration;
+/**
+ * Capitalizes the first letter of a string and converts the rest to lowercase.
+ * Used for standardizing name formatting in narrations.
+ *
+ * @param str - The string to capitalize
+ * @returns String with first letter capitalized and rest in lowercase
+ *
+ * @example
+ * ```typescript
+ * capitalizeFirstLetter("john") // Returns: "John"
+ * capitalizeFirstLetter("SMITH") // Returns: "Smith"
+ * capitalizeFirstLetter("") // Returns: ""
+ * ```
+ */
+function capitalizeFirstLetter(str) {
+    if (str.length === 0) {
+        return str; // Return an empty string if input is empty
+    }
+    const firstLetter = str.charAt(0).toUpperCase();
+    const restOfString = str.slice(1).toLowerCase();
+    return firstLetter + restOfString;
+}

package/script/npm/src/src/models/payout/schemas.d.ts

@@ -0,0 +1,156 @@
+import { z } from "zod";
+import { PAYOUT_APPROVAL_STATUS, PAYOUT_STATUS } from "./status.js";
+/**
+ * Type definition for identifier schema
+ * Used for tracking who created or actioned a payout
+ * Contains a name and unique identity string
+ */
+type IdentifierType = z.ZodObject<{
+    name: z.ZodString;
+    identity: z.ZodString;
+}>;
+/**
+ * Type definition for payout status enum
+ * Represents all possible states of a payout:
+ *
+ * @see {@link PAYOUT_STATUS} for the enum definition in "@models/payout/status.ts"
+ */
+type PayoutStatusType = z.ZodEnum<[
+    typeof PAYOUT_STATUS.CREATED,
+    typeof PAYOUT_STATUS.PAID,
+    typeof PAYOUT_STATUS.FAILED,
+    typeof PAYOUT_STATUS.REJECTED,
+    typeof PAYOUT_STATUS.PENDING,
+    typeof PAYOUT_STATUS.QUEUED,
+    typeof PAYOUT_STATUS.REVERSED
+]>;
+/**
+ * Type definition for payout approval status enum
+ * Represents the approval state of a payout:
+ *
+ * @see {@link PAYOUT_APPROVAL_STATUS} for the enum definition in "@models/payout/status.ts"
+ */
+type ApprovalPayoutStatusType = z.ZodEnum<[
+    typeof PAYOUT_APPROVAL_STATUS.APPROVED,
+    typeof PAYOUT_APPROVAL_STATUS.PENDING,
+    typeof PAYOUT_APPROVAL_STATUS.REJECTED
+]>;
+/**
+ * Type definition for payout input schema
+ * Extends the base payout type with payee information required for creating new payouts
+ *
+ * @extends {BasePayoutType}
+ * @property {z.ZodString} payeeName - Name of the payment recipient
+ */
+type PayoutInputType = z.ZodObject<{
+    channel: z.ZodString;
+    msisdn: z.ZodString;
+    amount: z.ZodNumber;
+    description: z.ZodString;
+    notes: Optional<z.ZodString>;
+    payeeName: z.ZodString;
+}>;
+/**
+ * Type definition for complete payout schema
+ * Extends the base payout type with additional fields for tracking
+ * the full lifecycle of a payout transaction
+ *
+ * @extends {BasePayoutType}
+ * @property {z.ZodString} id - Unique identifier for the payout
+ * @property {z.ZodString} profileId - ID of the profile initiating the payout
+ * @property {z.ZodString} payeeName - Name of the payment recipient
+ * @property {PayoutStatusType} status - Current status of the payout
+ * @property {z.ZodString} statusMessage - Detailed message about the current status
+ * @property {z.ZodString} partnerReference - Optional reference from payment partner
+ * @property {z.ZodDate} createdAt - Timestamp of payout creation
+ * @property {z.ZodDate} updatedAt - Timestamp of last payout update
+ * @property {ApprovalPayoutStatusType} approvalStatus - Current approval state
+ * @property {IdentifierType} createdBy - User who created the payout
+ * @property {IdentifierType} actionedBy - User who last actioned the payout
+ */
+type PayoutType = z.ZodObject<{
+    channel: z.ZodString;
+    msisdn: z.ZodString;
+    amount: z.ZodNumber;
+    description: z.ZodString;
+    notes: Optional<z.ZodString>;
+    id: z.ZodString;
+    profileId: z.ZodString;
+    payeeName: z.ZodString;
+    status: PayoutStatusType;
+    statusMessage: z.ZodString;
+    partnerReference: Optional<z.ZodString>;
+    createdAt: z.ZodDate;
+    updatedAt: z.ZodDate;
+    approvalStatus: ApprovalPayoutStatusType;
+    createdBy: Optional<IdentifierType>;
+    actionedBy: Optional<IdentifierType>;
+}>;
+/**
+ * Type representing a Zod schema that transforms nullable values to undefined
+ * @template T - The original Zod schema type
+ * @property {z.ZodNullable<T>} - The nullable version of the input schema
+ * @property {T["_output"] | undefined} - The output type, allowing the original type or undefined
+ * @property {T["_input"] | null} - The input type, allowing the original type or null
+ */
+type MakeOptionalResult<T extends z.ZodType> = z.ZodEffects<z.ZodNullable<T>, T["_output"] | undefined, T["_input"] | null>;
+/**
+ * Type representing a fully optional field that transforms nulls to undefined
+ * @template T - The original Zod schema type
+ * Combines MakeOptionalResult with ZodOptional to allow both:
+ * 1. The field to be optional (can be omitted from object)
+ * 2. When present, the value can be null (transformed to undefined) or the original type
+ */
+type Optional<T extends z.ZodType> = z.ZodOptional<MakeOptionalResult<T>>;
+/**
+ * Schema for identifying users in the payout process
+ * Used to track who created or actioned a payout
+ */
+declare const identifierSchema: IdentifierType;
+/**
+ * Type definition inferred from identifierSchema
+ * Represents the structure of a user who actions the payout
+ */
+type PayoutApprover = z.infer<typeof identifierSchema>;
+/**
+ * Type definition inferred from payoutInputSchema
+ * Represents the structure of data required to create a new payout
+ */
+type PayoutInput = z.infer<typeof payoutInputSchema>;
+/**
+ * Schema for creating a new payout
+ * Extends base payout schema with payee information
+ */
+declare const payoutInputSchema: PayoutInputType;
+/**
+ * Type definition inferred from payoutSchema
+ * Represents the complete payout record structure
+ */
+type PayoutData = z.infer<typeof payoutSchema>;
+/**
+ * Schema for complete payout record
+ * Extends base payout schema with additional fields for:
+ * - Identification (id, profileId)
+ * - Status tracking
+ * - Timestamps
+ * - Approval information
+ * - User tracking (created by, actioned by)
+ */
+declare const payoutSchema: PayoutType;
+/**
+ * Export object containing all payout-related schemas
+ * Used for validation and type checking throughout the application
+ */
+export declare const PayoutSchemas: {
+    readonly payoutData: PayoutType;
+    readonly payoutInput: PayoutInputType;
+    readonly payoutTransactionStatus: PayoutStatusType;
+    readonly payoutApprovalStatus: ApprovalPayoutStatusType;
+    readonly payoutApprover: IdentifierType;
+};
+/**
+ * Export types for use in other parts of the application
+ * These types can be used for type checking and documentation
+ */
+export type { PayoutApprover, PayoutData, PayoutInput };
+//# sourceMappingURL=schemas.d.ts.map

package/script/npm/src/src/models/payout/schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../../../../../src/src/models/payout/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACL,sBAAsB,EACtB,aAAa,EACd,MAAM,aAAa,CAAC;AAErB;;;;GAIG;AACH,KAAK,cAAc,GAAG,CAAC,CAAC,SAAS,CAAC;IAChC,IAAI,EAAE,CAAC,CAAC,SAAS,CAAC;IAClB,QAAQ,EAAE,CAAC,CAAC,SAAS,CAAC;CACvB,CAAC,CAAC;AAEH;;;;;GAKG;AACH,KAAK,gBAAgB,GAAG,CAAC,CAAC,OAAO,CAAC;IAChC,OAAO,aAAa,CAAC,OAAO;IAC5B,OAAO,aAAa,CAAC,IAAI;IACzB,OAAO,aAAa,CAAC,MAAM;IAC3B,OAAO,aAAa,CAAC,QAAQ;IAC7B,OAAO,aAAa,CAAC,OAAO;IAC5B,OAAO,aAAa,CAAC,MAAM;IAC3B,OAAO,aAAa,CAAC,QAAQ;CAC9B,CAAC,CAAC;AAEH;;;;;GAKG;AACH,KAAK,wBAAwB,GAAG,CAAC,CAAC,OAAO,CAAC;IACxC,OAAO,sBAAsB,CAAC,QAAQ;IACtC,OAAO,sBAAsB,CAAC,OAAO;IACrC,OAAO,sBAAsB,CAAC,QAAQ;CACvC,CAAC,CAAC;AAkBH;;;;;;GAMG;AACH,KAAK,eAAe,GAAG,CAAC,CAAC,SAAS,CAAC;IACjC,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;IACrB,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC;IACpB,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC;IACpB,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC7B,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;CACxB,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;GAiBG;AACH,KAAK,UAAU,GAAG,CAAC,CAAC,SAAS,CAAC;IAC5B,OAAO,EAAE,CAAC,CAAC,SAAS,CAAC;IACrB,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC;IACpB,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC;IACpB,WAAW,EAAE,CAAC,CAAC,SAAS,CAAC;IACzB,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC7B,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC;IAChB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;IACvB,SAAS,EAAE,CAAC,CAAC,SAAS,CAAC;IACvB,MAAM,EAAE,gBAAgB,CAAC;IACzB,aAAa,EAAE,CAAC,CAAC,SAAS,CAAC;IAC3B,gBAAgB,EAAE,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IACxC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC;IACrB,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC;IACrB,cAAc,EAAE,wBAAwB,CAAC;IACzC,SAAS,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;IACpC,UAAU,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;CACtC,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,KAAK,kBAAkB,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,UAAU,CACzD,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,EAChB,CAAC,CAAC,SAAS,CAAC,GAAG,SAAS,EACxB,CAAC,CAAC,QAAQ,CAAC,GAAG,IAAI,CACnB,CAAC;AAEF;;;;;;GAMG;AACH,KAAK,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;AA2B1E;;;GAGG;AACH,QAAA,MAAM,gBAAgB,EAAE,cAGtB,CAAC;AAEH;;;GAGG;AACH,KAAK,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;AAsCvD;;;GAGG;AACH,KAAK,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAErD;;;GAGG;AACH,QAAA,MAAM,iBAAiB,EAAE,eAEvB,CAAC;AAEH;;;GAGG;AACH,KAAK,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAE/C;;;;;;;;GAQG;AACH,QAAA,MAAM,YAAY,EAAE,UAalB,CAAC;AAEH;;;GAGG;AACH,eAAO,MAAM,aAAa;;;;;;CAMhB,CAAC;AAEX;;;GAGG;AACH,YAAY,EAAE,cAAc,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC"}

package/script/npm/src/src/models/payout/schemas.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PayoutSchemas = void 0;
+const zod_1 = require("zod");
+const status_js_1 = require("./status.js");
+/**
+ * Creates a Zod schema that transforms null values to undefined
+ * This is useful when dealing with APIs that return null but you want to use undefined in your codebase
+ *
+ * @template T - The type of Zod schema being transformed
+ * @param {T} schema - The original Zod schema to transform
+ * @returns {MakeOptionalResult<T>} A new schema that:
+ *   - Accepts the original type or null as input
+ *   - Outputs the original type or undefined
+ *   - Automatically transforms null to undefined during validation
+ *
+ * @example
+ * const userSchema = z.object({
+ *   name: makeOptional(z.string()), // accepts: string | null, outputs: string | undefined
+ * });
+ *
+ * // These are all valid:
+ * userSchema.parse({ name: "John" })    // { name: "John" }
+ * userSchema.parse({ name: null })      // { name: undefined }
+ */
+const makeOptional = (schema) => schema.nullable().transform((val) => val === null ? undefined : val);
+/**
+ * Schema for identifying users in the payout process
+ * Used to track who created or actioned a payout
+ */
+const identifierSchema = zod_1.z.object({
+    name: zod_1.z.string(),
+    identity: zod_1.z.string(),
+});
+/**
+ * Schema for payout status
+ * Defines all possible states a payout can be in
+ */
+const payoutStatusSchema = zod_1.z.enum([
+    status_js_1.PAYOUT_STATUS.CREATED,
+    status_js_1.PAYOUT_STATUS.PAID,
+    status_js_1.PAYOUT_STATUS.FAILED,
+    status_js_1.PAYOUT_STATUS.REJECTED,
+    status_js_1.PAYOUT_STATUS.PENDING,
+    status_js_1.PAYOUT_STATUS.QUEUED,
+    status_js_1.PAYOUT_STATUS.REVERSED,
+]);
+/**
+ * Schema for payout approval status
+ * Defines all possible approval states
+ */
+const approvalPayoutStatusSchema = zod_1.z.enum([
+    status_js_1.PAYOUT_APPROVAL_STATUS.APPROVED,
+    status_js_1.PAYOUT_APPROVAL_STATUS.PENDING,
+    status_js_1.PAYOUT_APPROVAL_STATUS.REJECTED,
+]);
+/**
+ * Base schema for payout operations
+ * Contains common fields used across all payout operations
+ */
+const basePayoutSchema = zod_1.z.object({
+    channel: zod_1.z.string(),
+    msisdn: zod_1.z.string(),
+    amount: zod_1.z.coerce.number(),
+    description: zod_1.z.string(),
+    notes: makeOptional(zod_1.z.string()).optional(),
+});
+/**
+ * Schema for creating a new payout
+ * Extends base payout schema with payee information
+ */
+const payoutInputSchema = basePayoutSchema.extend({
+    payeeName: zod_1.z.string(),
+});
+/**
+ * Schema for complete payout record
+ * Extends base payout schema with additional fields for:
+ * - Identification (id, profileId)
+ * - Status tracking
+ * - Timestamps
+ * - Approval information
+ * - User tracking (created by, actioned by)
+ */
+const payoutSchema = basePayoutSchema.extend({
+    id: zod_1.z.string(),
+    profileId: zod_1.z.string(),
+    payeeName: zod_1.z.string(),
+    status: payoutStatusSchema,
+    statusMessage: zod_1.z.string(),
+    partnerReference: makeOptional(zod_1.z.string()).optional(),
+    createdAt: zod_1.z.coerce.date(),
+    updatedAt: zod_1.z.coerce.date(),
+    actionedAt: zod_1.z.coerce.date().nullish(),
+    approvalStatus: approvalPayoutStatusSchema,
+    createdBy: makeOptional(identifierSchema).optional(),
+    actionedBy: makeOptional(identifierSchema).optional(),
+});
+/**
+ * Export object containing all payout-related schemas
+ * Used for validation and type checking throughout the application
+ */
+exports.PayoutSchemas = {
+    payoutData: payoutSchema, // Complete payout record schema
+    payoutInput: payoutInputSchema, // New payout input schema
+    payoutTransactionStatus: payoutStatusSchema, // Payout status enum schema
+    payoutApprovalStatus: approvalPayoutStatusSchema, // Approval status enum schema
+    payoutApprover: identifierSchema, // Identifier schema for approvers
+};

package/script/npm/src/src/models/payout/status.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Represents the current status of a payout transaction.
+ * @enum {string}
+ * @readonly
+ */
+export declare enum PAYOUT_STATUS {
+    QUEUED = "QUEUED",
+    /** Payout is awaiting processing */
+    PENDING = "PENDING",
+    /** Payout has been successfully processed */
+    PAID = "PAID",
+    /** Payout processing has failed */
+    FAILED = "FAILED",
+    /** Payout has been rejected */
+    REJECTED = "REJECTED",
+    /** Payout has been initially created but not yet processed */
+    CREATED = "CREATED",
+    REVERSED = "REVERSED"
+}
+/**
+ * Represents the approval status for payouts that require authorization.
+ * @enum {string}
+ * @readonly
+ */
+export declare enum PAYOUT_APPROVAL_STATUS {
+    /** Payout is awaiting approval decision */
+    PENDING = "Pending",
+    /** Payout has been approved */
+    APPROVED = "Approved",
+    /** Payout has been rejected during approval process */
+    REJECTED = "Rejected"
+}
+//# sourceMappingURL=status.d.ts.map

package/script/npm/src/src/models/payout/status.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../../../../../src/src/models/payout/status.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,oBAAY,aAAa;IACvB,MAAM,WAAW;IAEjB,oCAAoC;IACpC,OAAO,YAAY;IACnB,6CAA6C;IAC7C,IAAI,SAAS;IACb,mCAAmC;IACnC,MAAM,WAAW;IACjB,+BAA+B;IAC/B,QAAQ,aAAa;IACrB,8DAA8D;IAC9D,OAAO,YAAY;IAEnB,QAAQ,aAAa;CACtB;AAED;;;;GAIG;AACH,oBAAY,sBAAsB;IAChC,2CAA2C;IAC3C,OAAO,YAAY;IACnB,+BAA+B;IAC/B,QAAQ,aAAa;IACrB,uDAAuD;IACvD,QAAQ,aAAa;CACtB"}

package/script/npm/src/src/models/payout/status.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PAYOUT_APPROVAL_STATUS = exports.PAYOUT_STATUS = void 0;
+/**
+ * Represents the current status of a payout transaction.
+ * @enum {string}
+ * @readonly
+ */
+var PAYOUT_STATUS;
+(function (PAYOUT_STATUS) {
+    PAYOUT_STATUS["QUEUED"] = "QUEUED";
+    /** Payout is awaiting processing */
+    PAYOUT_STATUS["PENDING"] = "PENDING";
+    /** Payout has been successfully processed */
+    PAYOUT_STATUS["PAID"] = "PAID";
+    /** Payout processing has failed */
+    PAYOUT_STATUS["FAILED"] = "FAILED";
+    /** Payout has been rejected */
+    PAYOUT_STATUS["REJECTED"] = "REJECTED";
+    /** Payout has been initially created but not yet processed */
+    PAYOUT_STATUS["CREATED"] = "CREATED";
+    PAYOUT_STATUS["REVERSED"] = "REVERSED";
+})(PAYOUT_STATUS || (exports.PAYOUT_STATUS = PAYOUT_STATUS = {}));
+/**
+ * Represents the approval status for payouts that require authorization.
+ * @enum {string}
+ * @readonly
+ */
+var PAYOUT_APPROVAL_STATUS;
+(function (PAYOUT_APPROVAL_STATUS) {
+    /** Payout is awaiting approval decision */
+    PAYOUT_APPROVAL_STATUS["PENDING"] = "Pending";
+    /** Payout has been approved */
+    PAYOUT_APPROVAL_STATUS["APPROVED"] = "Approved";
+    /** Payout has been rejected during approval process */
+    PAYOUT_APPROVAL_STATUS["REJECTED"] = "Rejected";
+})(PAYOUT_APPROVAL_STATUS || (exports.PAYOUT_APPROVAL_STATUS = PAYOUT_APPROVAL_STATUS = {}));