@temboplus/afloat 0.1.53 → 0.1.55

package/script/src/models/payout/api.d.ts

@@ -1,29 +0,0 @@
-/**
- * Arguments for retrieving payouts from the API.
- *
- * @interface GetPayoutsAPIArgs
- *
- * @property {number} [rangeStart] - The starting index for pagination. If not provided, defaults to beginning.
- * @property {number} [rangeEnd] - The ending index for pagination. If not provided, defaults to 10.
- * @property {boolean} [pending] - Filter for pending payouts only. If true, returns only pending payouts.
- *
- * @example
- * ```ts
- * // Get first 10 payouts
- * const args: GetPayoutsAPIArgs = {
- *   rangeStart: 0,
- *   rangeEnd: 10
- * };
- *
- * // Get only pending payouts
- * const pendingArgs: GetPayoutsAPIArgs = {
- *   pending: true
- * };
- * ```
- */
-export interface GetPayoutsAPIArgs {
-    rangeStart?: number;
-    rangeEnd?: number;
-    pending?: boolean;
-}
-//# sourceMappingURL=api.d.ts.map

package/script/src/models/payout/api.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../../src/src/models/payout/api.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,iBAAiB;IAChC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB"}

package/script/src/models/payout/api.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/script/src/models/payout/channel.d.ts

@@ -1,58 +0,0 @@
-import { type TZPhoneNumber } from "@temboplus/frontend-core";
-/**
- * Represents the available channels through which payouts can be processed.
- * @enum {string}
- * @readonly
- */
-export declare enum PAYOUT_CHANNEL {
-    /** Payment processed through mobile money services */
-    MOBILE = "Mobile",
-    /** Payment processed through traditional banking channels */
-    BANK = "Bank",
-    /** Payment processed through CRDB named account */
-    CRDB_NAMED_ACC = "CRDB_NAMED_ACC"
-}
-/**
- * Valid payout channel codes that can be used in the system
- *
- * @remarks
- * - `TZ-BANK-B2C`: Code for bank transfers
- * - `TZ-VERTO-B2C`: Code for Verto transfers
- * - `TZ-${telecom}-B2C`: Pattern for mobile money transfers where the telecom company is the provider code
- *
- * @see {@link createPayoutChannelCode} for functions to generate valid codes
- */
-export type PayoutChannelCode = "TZ-BANK-B2C" | "TZ-VERTO-B2C" | `TZ-${string}-B2C`;
-/**
- * Utility functions to create standardized payout channel codes
- *
- * @example
- * ```ts
- * // Create bank channel code
- * const bankCode = createPayoutChannelCode.bank(); // Returns "TZ-BANK-B2C"
- *
- * // Create mobile channel code
- * const mobileCode = createPayoutChannelCode.mobile(phoneNumber); // Returns "TZ-VODACOM-B2C" for Vodacom number
- * ```
- */
-export declare const createPayoutChannelCode: {
-    /**
-     * Creates a bank transfer channel code
-     * @returns {"TZ-BANK-B2C"} Standard bank transfer code
-     */
-    bank: () => "TZ-BANK-B2C";
-    /**
-     * Creates a Verto transfer channel code
-     * @returns {"TZ-VERTO-B2C"} Standard Verto transfer code
-     */
-    verto: () => "TZ-VERTO-B2C";
-    /**
-     * Creates a mobile money channel code based on the telecom provider
-     * @param {TZPhoneNumber} phoneNumber - Phone number object containing telecom information
-     * @returns {PayoutChannelCode} Channel code in format "TZ-{TELECOM}-B2C"
-     *
-     * @see {@link TZPhoneNumber} from "@jsr/temboplus__tembo-core" for phone number structure
-     */
-    mobile: (phoneNumber: TZPhoneNumber) => PayoutChannelCode;
-};
-//# sourceMappingURL=channel.d.ts.map

package/script/src/models/payout/channel.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../../../src/src/models/payout/channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,KAAK,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAE/E;;;;GAIG;AACH,oBAAY,cAAc;IACxB,sDAAsD;IACtD,MAAM,WAAW;IACjB,6DAA6D;IAC7D,IAAI,SAAS;IACb,mDAAmD;IACnD,cAAc,mBAAmB;CAClC;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,iBAAiB,GACzB,aAAa,GACb,cAAc,GACd,MAAM,MAAM,MAAM,CAAC;AAEvB;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,uBAAuB;IAClC;;;OAGG;gBACO,aAAa;IAEvB;;;OAGG;iBACQ,cAAc;IAEzB;;;;;;OAMG;0BAC4B,aAAa,KAAG,iBAAiB;CAOjE,CAAC"}

package/script/src/models/payout/channel.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPayoutChannelCode = exports.PAYOUT_CHANNEL = void 0;
-const frontend_core_1 = require("@temboplus/frontend-core");
-/**
- * Represents the available channels through which payouts can be processed.
- * @enum {string}
- * @readonly
- */
-var PAYOUT_CHANNEL;
-(function (PAYOUT_CHANNEL) {
-    /** Payment processed through mobile money services */
-    PAYOUT_CHANNEL["MOBILE"] = "Mobile";
-    /** Payment processed through traditional banking channels */
-    PAYOUT_CHANNEL["BANK"] = "Bank";
-    /** Payment processed through CRDB named account */
-    PAYOUT_CHANNEL["CRDB_NAMED_ACC"] = "CRDB_NAMED_ACC";
-})(PAYOUT_CHANNEL || (exports.PAYOUT_CHANNEL = PAYOUT_CHANNEL = {}));
-/**
- * Utility functions to create standardized payout channel codes
- *
- * @example
- * ```ts
- * // Create bank channel code
- * const bankCode = createPayoutChannelCode.bank(); // Returns "TZ-BANK-B2C"
- *
- * // Create mobile channel code
- * const mobileCode = createPayoutChannelCode.mobile(phoneNumber); // Returns "TZ-VODACOM-B2C" for Vodacom number
- * ```
- */
-exports.createPayoutChannelCode = {
-    /**
-     * Creates a bank transfer channel code
-     * @returns {"TZ-BANK-B2C"} Standard bank transfer code
-     */
-    bank: () => "TZ-BANK-B2C",
-    /**
-     * Creates a Verto transfer channel code
-     * @returns {"TZ-VERTO-B2C"} Standard Verto transfer code
-     */
-    verto: () => "TZ-VERTO-B2C",
-    /**
-     * Creates a mobile money channel code based on the telecom provider
-     * @param {TZPhoneNumber} phoneNumber - Phone number object containing telecom information
-     * @returns {PayoutChannelCode} Channel code in format "TZ-{TELECOM}-B2C"
-     *
-     * @see {@link TZPhoneNumber} from "@jsr/temboplus__tembo-core" for phone number structure
-     */
-    mobile: function (phoneNumber) {
-        //! fix: Channeling all Vodacom numbers to Tigo. Request from Mr. Tesha to solve some specific problem
-        if (phoneNumber.networkOperator.id === frontend_core_1.NetworkOperator.VODACOM) {
-            return `TZ-${frontend_core_1.NetworkOperator.TIGO.toString().toUpperCase()}-B2C`;
-        }
-        return `TZ-${phoneNumber.networkOperator.id.toString().toUpperCase()}-B2C`;
-    },
-};

package/script/src/models/payout/derivatives/payout.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"payout.d.ts","sourceRoot":"","sources":["../../../../../src/src/models/payout/derivatives/payout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAuB,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9D,OAAO,EAEL,KAAK,WAAW,EAEjB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,KAAK,sBAAsB,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAG1E;;GAEG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;IAElC;;OAEG;IACH,OAAO;IAKP,uCAAuC;IACvC,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,qDAAqD;IACrD,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,kCAAkC;IAClC,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,2CAA2C;IAC3C,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,+CAA+C;IAC/C,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,wCAAwC;IACxC,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,iDAAiD;IACjD,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAE9B;IAED;;;;;;;;;;;OAWG;IACH,IAAI,MAAM,IAAI,aAAa,CAe1B;IAED,2DAA2D;IAC3D,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED,iDAAiD;IACjD,IAAI,gBAAgB,IAAI,MAAM,GAAG,SAAS,CAEzC;IAED,wCAAwC;IACxC,IAAI,SAAS,IAAI,IAAI,CAEpB;IAED,6CAA6C;IAC7C,IAAI,SAAS,IAAI,IAAI,CAEpB;IAED,4CAA4C;IAC5C,IAAI,cAAc,IAAI,sBAAsB,CAE3C;IAED,+CAA+C;IAC/C,IAAI,SAAS,IAAI,cAAc,GAAG,SAAS,CAE1C;IAED,qDAAqD;IACrD,IAAI,UAAU,IAAI,cAAc,GAAG,SAAS,CAE3C;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,WAAW,IAAI,WAAW,GAAG,SAAS,CA8BzC;IAED;;;OAGG;IACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM;IAIvC;;;OAGG;IACH,MAAM,CAAC,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,GAAG,MAAM,EAAE;IAIpD;;;OAGG;WACW,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI;IAQzD;;;;;;;;;;;;;;;;;;;;;OAqBG;WACW,YAAY,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM;IAUvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;WACW,EAAE,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM;IAO7C;;OAEG;IACI,MAAM,IAAI,UAAU;CAG5B"}

package/script/src/models/payout/derivatives/payout.js

@@ -1,265 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Payout = void 0;
-const frontend_core_1 = require("@temboplus/frontend-core");
-const schemas_js_1 = require("../schemas.js");
-const index_js_1 = require("../../contact/index.js");
-const status_js_1 = require("../status.js");
-const channel_js_1 = require("../channel.js");
-/**
- * Payout class that wraps the Zod schema and provides additional functionality
- */
-class Payout {
-    /**
-     * Private constructor - use static methods to create instances
-     */
-    constructor(data) {
-        Object.defineProperty(this, "data", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.data = schemas_js_1.PayoutSchemas.payoutData.parse(data);
-    }
-    // Getters for all properties
-    /** Unique identifier for the payout */
-    get id() {
-        return this.data.id;
-    }
-    /** Profile identifier associated with this payout */
-    get profileId() {
-        return this.data.profileId;
-    }
-    /** Name of the payee/recipient */
-    get payeeName() {
-        return this.data.payeeName;
-    }
-    /** Payment channel used for this payout */
-    get channel() {
-        return this.data.channel;
-    }
-    /** Mobile number or bank account identifier */
-    get msisdn() {
-        return this.data.msisdn;
-    }
-    /**
-     * Amount to be paid out
-     * @returns {Amount} Amount object representing the payout value
-     */
-    get amount() {
-        return frontend_core_1.Amount.from(this.data.amount);
-    }
-    /** Description of the payout purpose */
-    get description() {
-        return this.data.description;
-    }
-    /** Optional additional notes about the payout */
-    get notes() {
-        return this.data.notes;
-    }
-    /**
-     * Current status of the payout
-     * Derived from both approval status and transaction status:
-     * - Returns REJECTED if approval status is "Rejected"
-     * - Returns FAILED if approved but transaction failed
-     * - Returns PAID if approved and transaction succeeded
-     * - Returns PENDING if awaiting approval
-     * - Falls back to transaction status in other cases
-     *
-     * @returns {PAYOUT_STATUS} Current status of the payout
-     * @see {@link PAYOUT_STATUS} for all possible status values
-     */
-    get status() {
-        if (this.data.approvalStatus === "Rejected") {
-            return status_js_1.PAYOUT_STATUS.REJECTED;
-        }
-        if (this.data.approvalStatus === "Approved") {
-            if (this.data.status === "FAILED") {
-                return status_js_1.PAYOUT_STATUS.FAILED;
-            }
-            return status_js_1.PAYOUT_STATUS.PAID;
-        }
-        if (this.data.approvalStatus === "Pending") {
-            return status_js_1.PAYOUT_STATUS.PENDING;
-        }
-        return this.data.status;
-    }
-    /** Status message providing details about current state */
-    get statusMessage() {
-        return this.data.statusMessage;
-    }
-    /** Optional reference ID from payment partner */
-    get partnerReference() {
-        return this.data.partnerReference;
-    }
-    /** Timestamp when payout was created */
-    get createdAt() {
-        return this.data.createdAt;
-    }
-    /** Timestamp when payout was last updated */
-    get updatedAt() {
-        return this.data.updatedAt;
-    }
-    /** Current approval status of the payout */
-    get approvalStatus() {
-        return this.data.approvalStatus;
-    }
-    /** Information about who created the payout */
-    get createdBy() {
-        return this.data.createdBy;
-    }
-    /** Information about who last actioned the payout */
-    get actionedBy() {
-        return this.data.actionedBy;
-    }
-    /**
-     * Constructs contact information based on payout channel
-     *
-     * @returns {ContactInfo | undefined} Contact information object:
-     * - MobileContactInfo for mobile money payouts
-     * - BankContactInfo for bank transfers
-     * - undefined if contact info cannot be constructed
-     *
-     * @remarks
-     * For bank payouts, expects msisdn in format "SWIFTCODE:ACCOUNTNUMBER"
-     *
-     * @example
-     * ```ts
-     * // Mobile payout
-     * payout.contactInfo // Returns MobileContactInfo with phone details
-     *
-     * // Bank payout
-     * payout.contactInfo // Returns BankContactInfo with bank and account details
-     * ```
-     */
-    get contactInfo() {
-        let contactInfo;
-        // extracting mobile contact information
-        const phone = frontend_core_1.TZPhoneNumber.from(this.data.msisdn);
-        if (phone) {
-            contactInfo = new index_js_1.MobileContactInfo(this.data.payeeName, phone);
-        }
-        // extracting bank contact information
-        const isBankPayout = this.data.channel === channel_js_1.createPayoutChannelCode.bank() ||
-            this.data.channel === channel_js_1.createPayoutChannelCode.verto();
-        if (isBankPayout) {
-            // getting bank information from payout msisdn
-            const text = this.data.msisdn.trim().split(":");
-            try {
-                const swiftcode = text[0];
-                const accNo = text[1];
-                const bank = frontend_core_1.Bank.fromSWIFTCode(swiftcode);
-                if (bank) {
-                    contactInfo = new index_js_1.BankContactInfo(this.data.payeeName, bank, accNo);
-                }
-            }
-            catch (_) {
-                //
-            }
-        }
-        return contactInfo;
-    }
-    /**
-     * Creates a Payout instance from raw data
-     * @throws {ZodError} if validation fails
-     */
-    static create(data) {
-        return new Payout(data);
-    }
-    /**
-     * Creates multiple Payout instances from an array of raw data
-     * @throws {ZodError} if validation fails for any item
-     */
-    static createMany(dataArray) {
-        return dataArray.map((data) => new Payout(data));
-    }
-    /**
-     * Creates a Payout instance from raw data without throwing
-     * @returns {Payout | null} Payout instance or null if validation fails
-     */
-    static createSafe(data) {
-        try {
-            return new Payout(data);
-        }
-        catch {
-            return null;
-        }
-    }
-    /**
-     * Checks if an unknown value contains valid data to construct a Payout instance.
-     * This is useful when validating raw data structures before instantiation.
-     *
-     * @param {unknown} obj - The value containing potential payout data
-     * @returns {obj is Payout} Type predicate indicating if a Payout can be constructed
-     *
-     * @example
-     * ```typescript
-     * const rawData = await fetchPayoutData();
-     * if (Payout.canConstruct(rawData)) {
-     *   const payout = Payout.create(rawData);
-     *   // TypeScript knows payout is valid here
-     *   console.log(payout.amount.toString());
-     * }
-     * ```
-     *
-     * @throws {never} This method never throws errors
-     *
-     * @remarks
-     * This method performs strict validation against the {@link PayoutData} schema
-     */
-    static canConstruct(obj) {
-        if (!obj || typeof obj !== "object")
-            return false;
-        const result = schemas_js_1.PayoutSchemas.payoutData.safeParse(obj);
-        if (!result.success)
-            return false;
-        const payout = Payout.createSafe(result.data);
-        return payout !== null;
-    }
-    /**
-     * Validates if an unknown value is a Payout instance.
-     * This is a runtime type guard that ensures proper object structure and data validity.
-     *
-     * @param {unknown} obj - The value to validate
-     * @returns {obj is Payout} Type predicate indicating if the value is a valid Payout
-     *
-     * @example
-     * ```typescript
-     * const maybePayout = getPayoutFromCache();
-     * if (Payout.is(maybePayout)) {
-     *   // TypeScript knows maybePayout is a Payout here
-     *   console.log(maybePayout.status);
-     * }
-     * ```
-     *
-     * @throws {never} This method never throws errors
-     *
-     * @remarks
-     * This method performs a complete structural validation:
-     * 1. Checks if the value is an object
-     * 2. Verifies presence of internal data property
-     * 3. Validates the data against PayoutData schema
-     * 4. Ensures the object is a proper Payout instance
-     *
-     * Use this method when:
-     * - Validating cached Payout instances
-     * - Checking serialized Payout objects
-     * - Verifying API responses
-     * - Type narrowing in conditional blocks
-     */
-    static is(obj) {
-        if (!obj || typeof obj !== "object")
-            return false;
-        if (!("data" in obj))
-            return false;
-        return Payout.canConstruct(obj.data);
-    }
-    /**
-     * Converts Payout instance to a plain object
-     */
-    toJSON() {
-        return { ...this.data };
-    }
-}
-exports.Payout = Payout;

package/script/src/models/payout/derivatives/payout.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"payout.test.d.ts","sourceRoot":"","sources":["../../../../../src/src/models/payout/derivatives/payout.test.ts"],"names":[],"mappings":""}

package/script/src/models/payout/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./status.js";
-export * from "./schemas.js";
-export * from "./channel.js";
-export * from "./api.js";
-export * from "./derivatives/payout.js";
-//# sourceMappingURL=index.d.ts.map

package/script/src/models/payout/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/src/models/payout/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,cAAc,CAAC;AAC7B,cAAc,UAAU,CAAC;AACzB,cAAc,yBAAyB,CAAC"}

package/script/src/models/payout/index.js

@@ -1,21 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./status.js"), exports);
-__exportStar(require("./schemas.js"), exports);
-__exportStar(require("./channel.js"), exports);
-__exportStar(require("./api.js"), exports);
-__exportStar(require("./derivatives/payout.js"), exports);

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

@@ -1,156 +0,0 @@
-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/src/models/payout/schemas.d.ts.map

@@ -1 +0,0 @@
-{"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"}