@temboplus/afloat 0.1.81 → 0.2.0-beta.2

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

@@ -0,0 +1,204 @@
+import { BaseRepository } from "@/lib/api/index.js";
+import { Payout } from "@/modules/payout/payout.model.js";
+import { Amount } from "@temboplus/frontend-core";
+import { PayoutAPI } from "./payout.api-contract.js";
+import { PayoutChannel } from "./payout.dtos.js";
+import { PayoutQuery } from "./payout.query.js";
+import { PayoutFilters } from "./payout.dtos.js";
+import { Paged } from "@/lib/query/index.js";
+import { Wallet } from "../wallet/wallet.model.js";
+import { BeneficiaryInfo } from "../beneficiary/beneficiary-info.model.js";
+/**
+ * Input type for payout creation mutation
+ */
+export interface CreatePayoutInput {
+    /** The wallet to pay from */
+    wallet: Wallet;
+    /** The payout channel to use (MOBILE or BANK) */
+    channel: PayoutChannel;
+    /** Contact information for the payout receiver */
+    receiver: BeneficiaryInfo;
+    /** The amount to pay out */
+    amount: Amount;
+    /** Optional notes/narration for the payout */
+    notes?: string;
+}
+/**
+ * Input type for payout approval mutation
+ */
+export interface ApprovePayoutInput {
+    id: string;
+    notes?: string;
+}
+/**
+ * Input type for payout rejection mutation
+ */
+export interface RejectPayoutInput {
+    id: string;
+    notes?: string;
+}
+/**
+ * Flexible query input type - supports the class, filters interface, URL params, etc.
+ */
+export type PayoutQueryInput = PayoutQuery | PayoutFilters | Record<string, string> | URLSearchParams | null | undefined;
+/**
+ * Repository class for managing payout operations including creation, approval,
+ * rejection, and retrieval of payouts.
+ *
+ * This repository handles pure API communication without permission checking.
+ * Permission validation should be handled at the service layer or route handlers.
+ *
+ * @extends {BaseRepository<PayoutAPI>}
+ *
+ * @example
+ * ```typescript
+ * const repo = new PayoutRepository({ token: userToken });
+ * const payouts = await repo.getPayouts();
+ * ```
+ */
+export declare class PayoutRepository extends BaseRepository<PayoutAPI> {
+    /**
+     * Creates an instance of PayoutRepository initialized with the payout contract.
+     *
+     * @param options - Optional configuration
+     * @param options.token - Authentication token for API calls
+     * @param options.root - Custom API root URL
+     *
+     * @example
+     * ```typescript
+     * const repo = new PayoutRepository({
+     *   token: "user-auth-token"
+     * });
+     * ```
+     */
+    constructor(options?: {
+        token?: string;
+        root?: string;
+    });
+    /**
+     * Get paginated payouts with filtering.
+     * Always returns paginated results with metadata.
+     *
+     * @param query - Query parameters in any supported format
+     * @returns Promise resolving to paginated payouts
+     *
+     * @example
+     * ```typescript
+     * // From API route with URL search params
+     * const { searchParams } = new URL(req.url);
+     * const result = await repo.getPayouts(searchParams);
+     *
+     * // From client with typed params
+     * const filters: PayoutFilters = { page: 1, limit: 20, approvalStatus: 'Pending' };
+     * const result2 = await repo.getPayouts(filters);
+     *
+     * // With PayoutQuery instance
+     * const query = PayoutQuery.create().wherePending().withPagination(1, 50);
+     * const result3 = await repo.getPayouts(query);
+     * ```
+     */
+    getPayouts(query?: PayoutQueryInput): Promise<Paged<Payout>>;
+    /**
+     * Get all payouts without pagination.
+     * Returns a plain array of all matching results.
+     *
+     * @param query - Query parameters (pagination params will be ignored)
+     * @returns Promise resolving to array of all payouts
+     *
+     * @example
+     * ```typescript
+     * // Get all pending payouts for a dropdown
+     * const allPending = await repo.getAllPayouts({ approvalStatus: 'Pending' });
+     *
+     * // Get all payouts without any filters
+     * const allPayouts = await repo.getAllPayouts();
+     * ```
+     */
+    getAllPayouts(query?: PayoutQueryInput): Promise<Payout[]>;
+    /**
+     * Convenience method for Next.js API routes.
+     * Extracts search params directly from Request object and returns paginated results.
+     */
+    getPayoutsFromRequest(req: Request): Promise<Paged<Payout>>;
+    /**
+     * Creates a new payout with the provided input data.
+     *
+     * @param input - The payout creation data
+     * @param input.wallet - The wallet to pay from
+     * @param input.channel - The payout channel to use
+     * @param input.receiver - Contact information for the payout receiver
+     * @param input.amount - The amount to pay out
+     * @param input.notes - Optional notes for the payout
+     * @returns Promise that resolves to the created payout
+     * @throws {APIError} If the input is invalid or if the creation operation fails
+     *
+     * @example
+     * ```typescript
+     * const payout = await repo.pay({
+     *   wallet: selectedWallet,
+     *   channel: PayoutChannel.MOBILE,
+     *   receiver: { name: "John Doe", phone: "+255123456789" },
+     *   amount: Amount.from(10000, "TZS"),
+     *   notes: "Payment for services"
+     * });
+     * ```
+     */
+    pay(input: CreatePayoutInput): Promise<Payout>;
+    /**
+     * Approves a payout with optional notes.
+     *
+     * @param input.id - The ID of the payout to approve
+     * @param input.notes - Optional notes for the approval
+     * @returns Promise that resolves to the approved payout
+     * @throws {APIError} If payout is not found, already approved, or if the operation fails
+     *
+     * @example
+     * ```typescript
+     * const approvedPayout = await repo.approve({
+     *   id: "payout-id",
+     *   notes: "Approved after verification"
+     * });
+     * ```
+     */
+    approve(input: ApprovePayoutInput): Promise<Payout>;
+    /**
+     * Rejects a payout with optional notes.
+     *
+     * @param input.id - The ID of the payout to reject
+     * @param input.notes - Optional notes for the rejection
+     * @returns Promise that resolves to the rejected payout
+     * @throws {APIError} If payout is not found, already rejected, or if the operation fails
+     *
+     * @example
+     * ```typescript
+     * const rejectedPayout = await repo.reject({
+     *   id: "payout-id",
+     *   notes: "Insufficient documentation"
+     * });
+     * ```
+     */
+    reject(input: RejectPayoutInput): Promise<Payout>;
+    /**
+     * Retrieves a payout by its ID.
+     *
+     * @param id - The ID of the payout to retrieve
+     * @returns Promise that resolves to the payout instance if found
+     * @throws {APIError} If the payout is not found or another error occurs
+     *
+     * @example
+     * ```typescript
+     * const payout = await repo.getByID("payout-id");
+     * console.log(`Payout status: ${payout.status}`);
+     * ```
+     */
+    getByID(id: string): Promise<Payout>;
+    /**
+     * Get count of payouts matching a query
+     * Uses the same query syntax as getPayouts but only returns the count
+     */
+    count(query?: PayoutQueryInput): Promise<number>;
+    /**
+     * Check if any payouts exist matching a query
+     */
+    exists(query?: PayoutQueryInput): Promise<boolean>;
+}

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

@@ -0,0 +1,3 @@
+export * from "./profile.dtos.js";
+export * from "./profile.model.js";
+export * from "./profile.repository.js";

package/{script/npm/src/src/features/auth/profile/contract.d.ts → dist/modules/profile/profile.api-contract.d.ts}

@@ -8,13 +8,14 @@ export declare const profileContract: {
         responses: {
             200: import("zod").ZodObject<{
                 id: import("zod").ZodString;
-                firstName: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
-                lastName: import("zod").ZodNullable<import("zod").ZodOptional<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").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
+                phone: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
                 accountNo: import("zod").ZodString;
-                email: import("zod").ZodNullable<import("zod").ZodOptional<import("zod").ZodString>>;
-            }, import("zod").UnknownKeysParam, import("zod").ZodTypeAny, {
+                email: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+                autoApprove: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodBoolean>>;
+            }, "strip", import("zod").ZodTypeAny, {
                 id: string;
                 displayName: string;
                 accountNo: string;
@@ -22,6 +23,7 @@ export declare const profileContract: {
                 lastName?: string | null | undefined;
                 phone?: string | null | undefined;
                 email?: string | null | undefined;
+                autoApprove?: boolean | null | undefined;
             }, {
                 id: string;
                 displayName: string;
@@ -30,8 +32,8 @@ export declare const profileContract: {
                 lastName?: string | null | undefined;
                 phone?: string | null | undefined;
                 email?: string | null | undefined;
+                autoApprove?: boolean | null | undefined;
             }>;
         };
     };
 };
-//# sourceMappingURL=contract.d.ts.map

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

@@ -0,0 +1,80 @@
+import { z } from "zod";
+/**
+ * Zod schema for validating user profile data.
+ * Defines validation rules and constraints for each profile field.
+ *
+ * @const {ProfileType}
+ *
+ * @property {string} id - Unique identifier for the profile
+ * @property {string | null | undefined} firstName - User's first name, can be null or undefined
+ * @property {string | null | undefined} lastName - User's last name, can be null or undefined
+ * @property {string} displayName - User's display name
+ * @property {string | null | undefined} phone - User's contact phone number, can be null or undefined
+ * @property {string} accountNo - User's account number
+ * @property {string | null | undefined} email - User's email address, can be null or undefined
+ * @property {boolean | null | undefined} autoApprove - Auto-approval setting, can be null or undefined
+ */
+declare const profileDTOSchema: 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;
+    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;
+}>;
+/**
+ * TypeScript type representing a validated user profile.
+ * Use this type for profile instances that have been validated against the schema.
+ */
+export type ProfileDTO = z.infer<typeof profileDTOSchema>;
+export declare const ProfileDTOSchemas: {
+    profileDTOSchema: 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;
+        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;
+    }>;
+};
+export {};

package/{script/npm/src/src/models/user/profile.d.ts → dist/modules/profile/profile.model.d.ts}

@@ -1,38 +1,42 @@
 import { z } from "zod";
-import { PhoneNumber } from "@temboplus/frontend-core";
 /**
- * Type definition for profile schema using Zod.
- * This type helper ensures type safety when implementing the actual schema.
+ * Zod schema for Profile JSON serialization
  */
-type ProfileZodSchemaType = z.ZodObject<{
+export declare const ProfileJSONSchema: z.ZodObject<{
     id: z.ZodString;
-    firstName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    lastName: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    firstName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    lastName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     displayName: z.ZodString;
-    phone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    phone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     accountNo: z.ZodString;
-    email: z.ZodNullable<z.ZodOptional<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;
 }>;
 /**
- * Zod schema for validating user profile data.
- * Defines validation rules and constraints for each profile field.
- *
- * @const {ProfileType}
- *
- * @property {string} id - Unique identifier for the profile
- * @property {string | null | undefined} firstName - User's first name, can be null or undefined
- * @property {string | null | undefined} lastName - User's last name, can be null or undefined
- * @property {string} displayName - User's display name
- * @property {string | null | undefined} phone - User's contact phone number, can be null or undefined
- * @property {string} accountNo - User's account number
- * @property {string | null | undefined} email - User's email address, can be null or undefined
- */
-export declare const profileSchema: ProfileZodSchemaType;
-/**
- * TypeScript type representing a validated user profile.
- * Use this type for profile instances that have been validated against the schema.
+ * Infer the ProfileJSON type from the schema
  */
-export type ProfileType = z.infer<typeof profileSchema>;
+export type ProfileJSON = z.infer<typeof ProfileJSONSchema>;
 /**
  * Represents a user profile in the system.
  *
@@ -48,16 +52,45 @@ export declare class Profile {
     private _lastName?;
     /** User's display name, can be used for presentation */
     private _displayName;
-    /** User's phone number, stored as a PhoneNumber object */
+    /** User's phone number */
     private _phone?;
     /** User's account number */
     private _accountNo;
     /** User's email address */
     private _email?;
+    /** Auto-approval setting */
+    private _autoApprove?;
     /**
      * Gets the profile schema used for validation.
      */
-    static get schema(): ProfileZodSchemaType;
+    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;
+        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;
+    }>;
     /**
      * Creates a new Profile instance with the provided data.
      *
@@ -79,6 +112,7 @@ export declare class Profile {
         phone?: string | null;
         accountNo: string;
         email?: string | null;
+        autoApprove?: boolean | null;
     }): Profile | undefined;
     /**
      * Gets the profile's unique identifier.
@@ -99,7 +133,7 @@ export declare class Profile {
     /**
      * Gets the user's phone number object.
      */
-    get phone(): PhoneNumber | null | undefined;
+    get phone(): string | null | undefined;
     /**
      * Gets the user's account number.
      */
@@ -109,39 +143,20 @@ export declare class Profile {
      */
     get email(): string | null | undefined;
     /**
-     * Gets the user's formatted phone number in international format.
+     * Gets the auto-approval setting.
      */
-    get formattedPhone(): string | null | undefined;
+    get autoApprove(): boolean | null | undefined;
     /**
      * Gets the user's name for display purposes.
      * 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(): ProfileType;
-    /**
-     * 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.
      *
@@ -156,6 +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;
 }
-export {};
-//# sourceMappingURL=profile.d.ts.map

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

@@ -0,0 +1,56 @@
+import { BaseRepository } from "@/lib/api/base-repository.js";
+import { profileContract } from "./profile.api-contract.js";
+import { Profile } from "./profile.model.js";
+/**
+ * Repository class for managing user profile operations.
+ * Handles retrieving and updating user profile information from the API.
+ *
+ * This repository handles pure API communication without permission checking.
+ * Permission validation should be handled at the service layer or route handlers.
+ *
+ * @extends {BaseRepository<typeof profileContract>}
+ *
+ * @example
+ * ```typescript
+ * const repo = new ProfileRepository({ token: userToken });
+ * const profile = await repo.getCurrentProfile();
+ * ```
+ */
+export declare class ProfileRepository extends BaseRepository<typeof profileContract> {
+    /**
+     * Creates an instance of ProfileRepository.
+     *
+     * @param options - Optional configuration
+     * @param options.token - Authentication token for API calls
+     * @param options.root - Custom API root URL
+     *
+     * @example
+     * ```typescript
+     * const repo = new ProfileRepository({
+     *   token: "user-auth-token",
+     *   root: "base-api-url"
+     * });
+     * ```
+     */
+    constructor(options?: {
+        token?: string;
+        root?: string;
+    });
+    /**
+     * Retrieves the current user's profile information.
+     *
+     * @returns Promise that resolves to the user's profile
+     * @throws {APIError} If the request fails, profile data is invalid, or returns an unexpected status
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   const profile = await repo.getCurrentProfile();
+     *   console.log(`User: ${profile.name}, Email: ${profile.email}`);
+     * } catch (error) {
+     *   console.error("Failed to get profile:", error.message);
+     * }
+     * ```
+     */
+    getCurrentProfile(): Promise<Profile>;
+}

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

@@ -0,0 +1,4 @@
+export * from "./team-member.repository.js";
+export * from "./team-member.dtos.js";
+export * from "./team-member.model.js";
+export * from "./role.model.js";

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

@@ -0,0 +1,61 @@
+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;
+    createdAt: string;
+    id: string;
+    version: string;
+    updatedAt: string;
+    access: string[];
+    description?: string | undefined;
+}, {
+    name: string;
+    createdAt: string;
+    id: 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;
+    readonly description?: string;
+    readonly permissions: ReadonlySet<string>;
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+    constructor(data: RoleDTO);
+    hasPermission(permission: string): boolean;
+    static from(data: RoleDTO): Role | undefined;
+    /**
+   * 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;
+}