@temboplus/afloat 0.2.0 → 0.2.1-beta.1

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

@@ -24,6 +24,8 @@ export declare const PayoutJSONSchema: z.ZodObject<{
     updatedAt: z.ZodString;
     actionedAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     approvalStatus: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof PayoutApprovalStatus>>>;
+    createdById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    actionedById: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     createdBy: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         id: z.ZodString;
         name: z.ZodString;
@@ -70,6 +72,8 @@ export declare const PayoutJSONSchema: z.ZodObject<{
     partnerReference?: string | null | undefined;
     actionedAt?: string | null | undefined;
     approvalStatus?: PayoutApprovalStatus | null | undefined;
+    createdById?: string | null | undefined;
+    actionedById?: string | null | undefined;
     createdBy?: {
         name: string;
         id: string;
@@ -99,6 +103,8 @@ export declare const PayoutJSONSchema: z.ZodObject<{
     partnerReference?: string | null | undefined;
     actionedAt?: string | null | undefined;
     approvalStatus?: PayoutApprovalStatus | null | undefined;
+    createdById?: string | null | undefined;
+    actionedById?: string | null | undefined;
     createdBy?: {
         name: string;
         id: string;
@@ -118,7 +124,27 @@ export type PayoutJSON = z.infer<typeof PayoutJSONSchema>;
  * Payout class that wraps the Zod schema and provides additional functionality
  */
 export declare class Payout {
-    private readonly data;
+    private readonly _id;
+    private readonly _profileId;
+    private readonly _payeeName;
+    private readonly _channel;
+    private readonly _msisdn;
+    private readonly _amount;
+    private readonly _currencyCode;
+    private readonly _countryCode;
+    private readonly _description;
+    private readonly _notes;
+    private readonly _status;
+    private readonly _statusMessage;
+    private readonly _partnerReference;
+    private readonly _createdAt;
+    private readonly _updatedAt;
+    private readonly _actionedAt;
+    private readonly _approvalStatus;
+    private readonly _createdById;
+    private readonly _actionedById;
+    private readonly _createdBy;
+    private readonly _actionedBy;
     /**
      * Private constructor - use static methods to create instances
      */
@@ -167,6 +193,10 @@ export declare class Payout {
     get actionedAt(): Date | undefined | null;
     /** Current approval status of the payout */
     get approvalStatus(): PayoutApprovalStatus | undefined | null;
+    /** Identifier of the user who created the payout */
+    get createdById(): string | undefined | null;
+    /** Identifier of the user who last actioned the payout */
+    get actionedById(): string | undefined | null;
     /** Information about who created the payout */
     get createdBy(): PayoutAuthorizer | undefined | null;
     /** Information about who last actioned the payout */
@@ -199,7 +229,7 @@ export declare class Payout {
      * 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
+     * @returns {obj is PayoutDTO} Type predicate indicating if a Payout can be constructed
      *
      * @example
      * ```typescript
@@ -216,7 +246,7 @@ export declare class Payout {
      * @remarks
      * This method performs strict validation against the {@link PayoutData} schema
      */
-    static canConstruct(obj: unknown): obj is Payout;
+    static canConstruct(obj: unknown): obj is PayoutDTO;
     /**
      * Validates if an unknown value is a Payout instance.
      * This is a runtime type guard that ensures proper object structure and data validity.
@@ -238,8 +268,8 @@ export declare class Payout {
      * @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
+     * 2. Verifies the instance can serialize to a valid flat PayoutJSON
+     * 3. Validates the JSON against PayoutData schema
      * 4. Ensures the object is a proper Payout instance
      *
      * Use this method when:
@@ -250,26 +280,26 @@ export declare class Payout {
      */
     static is(obj: unknown): obj is Payout;
     /**
-   * 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",
-   * //   ...
-   * // }
-   * ```
-   */
+     * 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
@@ -380,4 +410,5 @@ export declare class Payout {
      * ```
      */
     static toJSONArray(payouts: Payout[]): PayoutJSON[];
+    private toDTO;
 }

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

@@ -1,6 +1,7 @@
 import { QueryBuilder } from "@/lib/query/index.js";
 import { PayoutStatus, PayoutApprovalStatus, PayoutFilters } from "./payout.dtos.js";
 import { Amount } from "@temboplus/frontend-core";
+type PayoutUrlParams = Record<string, string | string[]>;
 /**
  * Represents an active filter with its label and value
  */
@@ -28,7 +29,7 @@ export declare class PayoutQuery extends QueryBuilder {
     /**
      * Create from URL search parameters (strings)
      */
-    static fromUrlParams(params: Record<string, string>): PayoutQuery;
+    static fromUrlParams(params: PayoutUrlParams): PayoutQuery;
     /**
      * Create from URLSearchParams object
      */
@@ -40,14 +41,20 @@ export declare class PayoutQuery extends QueryBuilder {
     /**
      * Create from any supported input type
      */
-    static from(input: QueryBuilder | PayoutFilters | Record<string, string> | URLSearchParams | null | undefined): PayoutQuery;
+    static from(input: QueryBuilder | PayoutFilters | PayoutUrlParams | URLSearchParams | null | undefined): PayoutQuery;
     /**
-     * Type guard for string records
+     * Type guard for URL param records
      */
-    private static isStringRecord;
+    private static isUrlParamsRecord;
+    private static searchParamsToRecord;
+    private static normalizeUrlParams;
+    private static toStringList;
     whereStatus(status: PayoutStatus): this;
+    whereStatusIn(statuses: PayoutStatus[]): this;
     whereApprovalStatus(approvalStatus: PayoutApprovalStatus): this;
+    whereApprovalStatusIn(approvalStatuses: PayoutApprovalStatus[]): this;
     whereChannel(channel: string): this;
+    whereChannelIn(channels: string[]): this;
     wherePending(): this;
     whereApproved(): this;
     whereRejected(): this;
@@ -56,7 +63,12 @@ export declare class PayoutQuery extends QueryBuilder {
     whereAmountBetween(min: Amount, max: Amount): this;
     wherePayee(payeeName: string): this;
     whereMsisdn(msisdn: string): this;
+    whereMsisdnIn(msisdns: string[]): this;
     whereProfileId(profileId: string): this;
+    whereCreatedById(createdById: string): this;
+    whereCreatedByIdIn(createdByIds: string[]): this;
+    whereActionedById(actionedById: string): this;
+    whereActionedByIdIn(actionedByIds: string[]): this;
     wherePartnerReference(partnerReference: string): this;
     whereSearch(searchTerm: string): this;
     whereCurrencyCode(currencyCode: string): this;
@@ -96,14 +108,46 @@ export declare class PayoutQuery extends QueryBuilder {
      * Create new instance with status filter
      */
     withStatus(status?: PayoutStatus): PayoutQuery;
+    /**
+     * Create new instance with status in filter
+     */
+    withStatusIn(statuses?: PayoutStatus[]): PayoutQuery;
     /**
      * Create new instance with approval status filter
      */
     withApprovalStatus(approvalStatus?: PayoutApprovalStatus): PayoutQuery;
+    /**
+     * Create new instance with approval status in filter
+     */
+    withApprovalStatusIn(approvalStatuses?: PayoutApprovalStatus[]): PayoutQuery;
     /**
      * Create new instance with channel filter
      */
     withChannel(channel?: string): PayoutQuery;
+    /**
+     * Create new instance with channel in filter
+     */
+    withChannelIn(channels?: string[]): PayoutQuery;
+    /**
+     * Create new instance with MSISDN in filter
+     */
+    withMsisdnIn(msisdns?: string[]): PayoutQuery;
+    /**
+     * Create new instance with creator ID filter
+     */
+    withCreatedById(createdById?: string): PayoutQuery;
+    /**
+     * Create new instance with creator ID in filter
+     */
+    withCreatedByIdIn(createdByIds?: string[]): PayoutQuery;
+    /**
+     * Create new instance with actioner ID filter
+     */
+    withActionedById(actionedById?: string): PayoutQuery;
+    /**
+     * Create new instance with actioner ID in filter
+     */
+    withActionedByIdIn(actionedByIds?: string[]): PayoutQuery;
     /**
      * Includes default relations for eager loading.
      * This ensures that related data (createdBy, actionedBy) is fetched automatically.
@@ -174,6 +218,9 @@ export declare class PayoutQuery extends QueryBuilder {
      * Extract primary sort order
      */
     private extractSortOrder;
+    private whereInValues;
+    private getValidStatuses;
+    private getValidApprovalStatuses;
     /**
      * Type guard for valid statuses
      */
@@ -183,3 +230,4 @@ export declare class PayoutQuery extends QueryBuilder {
      */
     private isValidApprovalStatus;
 }
+export {};

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

@@ -40,7 +40,7 @@ export interface RejectPayoutInput {
 /**
  * Flexible query input type - supports the class, filters interface, URL params, etc.
  */
-export type PayoutQueryInput = PayoutQuery | PayoutFilters | Record<string, string> | URLSearchParams | null | undefined;
+export type PayoutQueryInput = PayoutQuery | PayoutFilters | Record<string, string | string[]> | URLSearchParams | null | undefined;
 /**
  * Repository class for managing payout operations including creation, approval,
  * rejection, and retrieval of payouts.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temboplus/afloat",
-  "version": "0.2.0",
+  "version": "0.2.1-beta.1",
   "description": "A foundational library for Temboplus-Afloat projects.",
   "main": "./dist/index.cjs.js",
   "module": "./dist/index.esm.js",
@@ -57,6 +57,6 @@
     "typescript": "^5.9.3"
   },
   "dependencies": {
-    "@temboplus/frontend-core": "^1.0.1"
+    "@temboplus/frontend-core": "^1.0.2"
   }
 }