@temboplus/afloat 0.1.60 → 0.1.62

package/dist/features/auth/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/dist/features/auth/profile/profile.repository.d.ts

@@ -0,0 +1,56 @@
+import { BaseRepository } from "@/lib/api/base-repository";
+import { profileContract } from "./profile.api-contract";
+import { Profile } from "@/models/profile.model";
+/**
+ * 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/{script/npm/src/src/features/auth/storage/client_store.d.ts → dist/features/auth/storage/client-store.d.ts}

@@ -1,6 +1,6 @@
-import { User } from "../../../models/user/index.js";
 import { type StoreApi, type UseBoundStore } from "zustand";
-import type { AuthStore } from "./types.js";
+import type { AuthStore } from "./types";
+import { User } from "@/models/user.model";
 /** Type definition for the store's state */
 type State = {
     user: string | undefined;
@@ -27,4 +27,3 @@ export declare const createClientStore: () => AuthStore;
  */
 export declare const useClientUser: () => User | undefined;
 export {};
-//# sourceMappingURL=client_store.d.ts.map

package/{esm/src/features/auth/storage/client_token_handler.d.ts → dist/features/auth/storage/client-token-handler.d.ts}

@@ -1,4 +1,4 @@
-import type { TokenHandler } from "./types.js";
+import type { TokenHandler } from "./types";
 /**
  * Client-side implementation of TokenHandler.
  * Manages tokens using sessionStorage.
@@ -29,4 +29,3 @@ export declare class ClientTokenHandler implements TokenHandler {
      */
     clearToken(): void;
 }
-//# sourceMappingURL=client_token_handler.d.ts.map

package/{script/npm/src/src → dist}/features/auth/storage/types.d.ts

@@ -1,4 +1,4 @@
-import type { User } from "../../../models/user/index.js";
+import type { User } from "@/models/user.model";
 /**
  * Interface defining the contract for auth storage implementations.
  * This allows for different storage strategies in different environments.
@@ -39,4 +39,3 @@ export interface TokenHandler {
      */
     clearToken(): void;
 }
-//# sourceMappingURL=types.d.ts.map

package/dist/features/contact/contact-input-handler.d.ts

@@ -0,0 +1,16 @@
+import { ContactInfo } from "../../models/contact-info.model";
+import { ContactInputDTO } from "./contact.dtos";
+/**
+ * Factory for resolving and validating a raw `ContactInput` into a typed and valid version.
+ */
+export declare class ValidatedContactInputFactory {
+    private handlers;
+    /**
+     * Resolves a raw contact input into a valid and strongly-typed `ContactInput`.
+     *
+     * @param {ContactInputDTO} data - The unvalidated input object
+     * @returns {ContactInputDTO} - A valid and converted input ready for use
+     * @throws {Error} - If the input cannot be handled by any handler
+     */
+    resolve(data: ContactInfo): ContactInputDTO;
+}

package/{esm/src/features/contact/contract.d.ts → dist/features/contact/contact.api-contract.d.ts}

@@ -9,54 +9,61 @@ import { z } from "zod";
  * @property {Object} deleteContact - Delete a contact (DELETE /:id)
  */
 export declare const contract: {
-    postContact: {
+    createContact: {
         method: "POST";
         body: z.ZodObject<{
             displayName: z.ZodString;
             accountNo: z.ZodString;
             channel: z.ZodString;
-            type: z.ZodEnum<["Bank", "Mobile"]>;
-        }, z.UnknownKeysParam, z.ZodTypeAny, {
-            type: "Bank" | "Mobile";
+            countryCode: z.ZodDefault<z.ZodString>;
+            type: z.ZodNativeEnum<typeof import("./contact.dtos").ContactType>;
+        }, "strip", z.ZodTypeAny, {
+            type: import("./contact.dtos").ContactType;
             displayName: string;
             accountNo: string;
             channel: string;
+            countryCode: string;
         }, {
-            type: "Bank" | "Mobile";
+            type: import("./contact.dtos").ContactType;
             displayName: string;
             accountNo: string;
             channel: string;
+            countryCode?: string | undefined;
         }>;
         path: "/";
         responses: {
             [x: number]: import("@ts-rest/core").AppRouteResponse;
             201: z.ZodObject<{
+                id: z.ZodString;
+                profileId: z.ZodString;
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            } & {
                 displayName: z.ZodString;
                 accountNo: z.ZodString;
                 channel: z.ZodString;
-                type: z.ZodEnum<["Bank", "Mobile"]>;
-                id: z.ZodString;
-                profileId: z.ZodString;
-                createdAt: z.ZodDate;
-                updatedAt: z.ZodDate;
-            }, z.UnknownKeysParam, z.ZodTypeAny, {
-                type: "Bank" | "Mobile";
+                countryCode: z.ZodDefault<z.ZodString>;
+                type: z.ZodNativeEnum<typeof import("./contact.dtos").ContactType>;
+            }, "strip", z.ZodTypeAny, {
+                type: import("./contact.dtos").ContactType;
                 id: string;
                 displayName: string;
                 accountNo: string;
                 channel: string;
                 profileId: string;
-                createdAt: Date;
-                updatedAt: Date;
+                countryCode: string;
+                createdAt: string;
+                updatedAt: string;
             }, {
-                type: "Bank" | "Mobile";
+                type: import("./contact.dtos").ContactType;
                 id: string;
                 displayName: string;
                 accountNo: string;
                 channel: string;
                 profileId: string;
-                createdAt: Date;
-                updatedAt: Date;
+                createdAt: string;
+                updatedAt: string;
+                countryCode?: string | undefined;
             }>;
         };
     };
@@ -66,48 +73,55 @@ export declare const contract: {
             displayName: z.ZodString;
             accountNo: z.ZodString;
             channel: z.ZodString;
-            type: z.ZodEnum<["Bank", "Mobile"]>;
-        }, z.UnknownKeysParam, z.ZodTypeAny, {
-            type: "Bank" | "Mobile";
+            countryCode: z.ZodDefault<z.ZodString>;
+            type: z.ZodNativeEnum<typeof import("./contact.dtos").ContactType>;
+        }, "strip", z.ZodTypeAny, {
+            type: import("./contact.dtos").ContactType;
             displayName: string;
             accountNo: string;
             channel: string;
+            countryCode: string;
         }, {
-            type: "Bank" | "Mobile";
+            type: import("./contact.dtos").ContactType;
             displayName: string;
             accountNo: string;
             channel: string;
+            countryCode?: string | undefined;
         }>;
         path: "/:id";
         responses: {
             [x: number]: import("@ts-rest/core").AppRouteResponse;
             200: z.ZodObject<{
+                id: z.ZodString;
+                profileId: z.ZodString;
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            } & {
                 displayName: z.ZodString;
                 accountNo: z.ZodString;
                 channel: z.ZodString;
-                type: z.ZodEnum<["Bank", "Mobile"]>;
-                id: z.ZodString;
-                profileId: z.ZodString;
-                createdAt: z.ZodDate;
-                updatedAt: z.ZodDate;
-            }, z.UnknownKeysParam, z.ZodTypeAny, {
-                type: "Bank" | "Mobile";
+                countryCode: z.ZodDefault<z.ZodString>;
+                type: z.ZodNativeEnum<typeof import("./contact.dtos").ContactType>;
+            }, "strip", z.ZodTypeAny, {
+                type: import("./contact.dtos").ContactType;
                 id: string;
                 displayName: string;
                 accountNo: string;
                 channel: string;
                 profileId: string;
-                createdAt: Date;
-                updatedAt: Date;
+                countryCode: string;
+                createdAt: string;
+                updatedAt: string;
             }, {
-                type: "Bank" | "Mobile";
+                type: import("./contact.dtos").ContactType;
                 id: string;
                 displayName: string;
                 accountNo: string;
                 channel: string;
                 profileId: string;
-                createdAt: Date;
-                updatedAt: Date;
+                createdAt: string;
+                updatedAt: string;
+                countryCode?: string | undefined;
             }>;
         };
     };
@@ -124,33 +138,76 @@ export declare const contract: {
         responses: {
             [x: number]: import("@ts-rest/core").AppRouteResponse;
             200: z.ZodArray<z.ZodObject<{
+                id: z.ZodString;
+                profileId: z.ZodString;
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            } & {
                 displayName: z.ZodString;
                 accountNo: z.ZodString;
                 channel: z.ZodString;
-                type: z.ZodEnum<["Bank", "Mobile"]>;
+                countryCode: z.ZodDefault<z.ZodString>;
+                type: z.ZodNativeEnum<typeof import("./contact.dtos").ContactType>;
+            }, "strip", z.ZodTypeAny, {
+                type: import("./contact.dtos").ContactType;
+                id: string;
+                displayName: string;
+                accountNo: string;
+                channel: string;
+                profileId: string;
+                countryCode: string;
+                createdAt: string;
+                updatedAt: string;
+            }, {
+                type: import("./contact.dtos").ContactType;
+                id: string;
+                displayName: string;
+                accountNo: string;
+                channel: string;
+                profileId: string;
+                createdAt: string;
+                updatedAt: string;
+                countryCode?: string | undefined;
+            }>, "many">;
+        };
+    };
+    getByID: {
+        method: "GET";
+        path: "/:id";
+        responses: {
+            [x: number]: import("@ts-rest/core").AppRouteResponse;
+            200: z.ZodObject<{
                 id: z.ZodString;
                 profileId: z.ZodString;
-                createdAt: z.ZodDate;
-                updatedAt: z.ZodDate;
-            }, z.UnknownKeysParam, z.ZodTypeAny, {
-                type: "Bank" | "Mobile";
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            } & {
+                displayName: z.ZodString;
+                accountNo: z.ZodString;
+                channel: z.ZodString;
+                countryCode: z.ZodDefault<z.ZodString>;
+                type: z.ZodNativeEnum<typeof import("./contact.dtos").ContactType>;
+            }, "strip", z.ZodTypeAny, {
+                type: import("./contact.dtos").ContactType;
                 id: string;
                 displayName: string;
                 accountNo: string;
                 channel: string;
                 profileId: string;
-                createdAt: Date;
-                updatedAt: Date;
+                countryCode: string;
+                createdAt: string;
+                updatedAt: string;
             }, {
-                type: "Bank" | "Mobile";
+                type: import("./contact.dtos").ContactType;
                 id: string;
                 displayName: string;
                 accountNo: string;
                 channel: string;
                 profileId: string;
-                createdAt: Date;
-                updatedAt: Date;
-            }>, "many">;
+                createdAt: string;
+                updatedAt: string;
+                countryCode?: string | undefined;
+            }>;
         };
     };
     deleteContact: {
@@ -167,4 +224,3 @@ export declare const contract: {
  * Export type for use in client implementations
  */
 export type ContactAPI = typeof contract;
-//# sourceMappingURL=contract.d.ts.map

package/dist/features/contact/contact.dtos.d.ts

@@ -0,0 +1,90 @@
+import { z } from "zod";
+/**
+ * Schema for contact channel types.
+ *
+ * @remarks
+ * Currently supports two channel types:
+ * - "Bank": For traditional banking channels
+ * - "Mobile": For mobile money channels
+ *
+ * @see {@link ContactType} for the inferred type
+ */
+export declare enum ContactType {
+    Bank = "Bank",
+    Mobile = "Mobile"
+}
+/**
+ * Type representing user-provided contact information.
+ * Used for creating or updating contacts.
+ *
+ * @see {@link contactInputSchema} for validation rules
+ * @see {@link ContactDTOSchemas} for all available schemas
+ */
+export type ContactInputDTO = z.infer<typeof ContactDTOSchemas.contactInputDTO>;
+/**
+ * Type representing a complete contact record.
+ * Includes both user-provided and system-generated fields.
+ *
+ * @see {@link contactSchema} for validation rules
+ */
+export type ContactDTO = z.infer<typeof ContactDTOSchemas.contactDTO>;
+/**
+ * Collection of all contact-related schemas.
+ */
+export declare const ContactDTOSchemas: {
+    /** Schema for complete contact records */
+    contactDTO: z.ZodObject<{
+        id: z.ZodString;
+        profileId: z.ZodString;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    } & {
+        displayName: z.ZodString;
+        accountNo: z.ZodString;
+        channel: z.ZodString;
+        countryCode: z.ZodDefault<z.ZodString>;
+        type: z.ZodNativeEnum<typeof ContactType>;
+    }, "strip", z.ZodTypeAny, {
+        type: ContactType;
+        id: string;
+        displayName: string;
+        accountNo: string;
+        channel: string;
+        profileId: string;
+        countryCode: string;
+        createdAt: string;
+        updatedAt: string;
+    }, {
+        type: ContactType;
+        id: string;
+        displayName: string;
+        accountNo: string;
+        channel: string;
+        profileId: string;
+        createdAt: string;
+        updatedAt: string;
+        countryCode?: string | undefined;
+    }>;
+    /** Schema for contact input validation */
+    contactInputDTO: z.ZodObject<{
+        displayName: z.ZodString;
+        accountNo: z.ZodString;
+        channel: z.ZodString;
+        countryCode: z.ZodDefault<z.ZodString>;
+        type: z.ZodNativeEnum<typeof ContactType>;
+    }, "strip", z.ZodTypeAny, {
+        type: ContactType;
+        displayName: string;
+        accountNo: string;
+        channel: string;
+        countryCode: string;
+    }, {
+        type: ContactType;
+        displayName: string;
+        accountNo: string;
+        channel: string;
+        countryCode?: string | undefined;
+    }>;
+    /** Schema for contact channel types */
+    contactType: z.ZodNativeEnum<typeof ContactType>;
+};

package/dist/features/contact/contact.repository.d.ts

@@ -0,0 +1,116 @@
+import { BaseRepository } from "../../lib/api/base-repository";
+import { contract } from "./contact.api-contract";
+import { Contact } from "../../models/contact.model";
+import { ContactInfo } from "@/models";
+/**
+ * Repository class for managing Contact data through API interactions.
+ * Handles contact creation, updates, deletion, and retrieval operations.
+ *
+ * This repository handles pure API communication without permission checking.
+ * Permission validation should be handled at the service layer or route handlers.
+ *
+ * @extends {BaseRepository<typeof contract>}
+ *
+ * @example
+ * ```typescript
+ * const repo = new ContactRepository({ token: userToken });
+ * const contacts = await repo.getAll();
+ * ```
+ */
+export declare class ContactRepository extends BaseRepository<typeof contract> {
+    /**
+     * Creates an instance of ContactRepository using the contact 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 ContactRepository({
+     *   token: "user-auth-token",
+     *   root: "https://api-staging.afloat.money/v1"
+     * });
+     * ```
+     */
+    constructor(options?: {
+        token?: string;
+        root?: string;
+    });
+    /**
+     * Creates a new contact record.
+     *
+     * @param info - The data required to create a new contact
+     * @returns Promise that resolves to the newly created contact
+     * @throws {APIError} If the creation operation fails
+     *
+     * @example
+     * ```typescript
+     * const newContact = await repo.create({
+     *   name: "John Doe",
+     *   email: "john@example.com",
+     *   phone: "+1234567890"
+     * });
+     * ```
+     */
+    create(info: ContactInfo): Promise<Contact>;
+    /**
+     * Updates an existing contact record by ID.
+     *
+     * @param id - The unique identifier of the contact to edit
+     * @param info - The data to update the contact with
+     * @returns Promise that resolves to the updated contact
+     * @throws {APIError} If the update operation fails
+     *
+     * @example
+     * ```typescript
+     * const updatedContact = await repo.edit("contact-id", {
+     *   name: "Jane Doe",
+     *   email: "jane@example.com"
+     * });
+     * ```
+     */
+    edit(id: string, info: ContactInfo): Promise<Contact>;
+    /**
+     * Deletes a contact record by ID.
+     *
+     * @param id - The unique identifier of the contact to remove
+     * @returns Promise that resolves when the deletion is complete
+     * @throws {APIError} If the deletion operation fails
+     *
+     * @example
+     * ```typescript
+     * await repo.remove("contact-id");
+     * console.log("Contact deleted successfully");
+     * ```
+     */
+    remove(id: string): Promise<void>;
+    /**
+     * Retrieves all contacts.
+     * Results are ordered in descending order by creation date by default.
+     *
+     * @returns Promise that resolves to an array of contacts
+     * @throws {APIError} If the fetch operation fails
+     *
+     * @example
+     * ```typescript
+     * const contacts = await repo.getAll();
+     * contacts.forEach(contact => console.log(`Contact: ${contact.name}`));
+     * ```
+     */
+    getAll(): Promise<Contact[]>;
+    /**
+     * Retrieves a contact by its unique identifier.
+     *
+     * @param id - The unique identifier of the contact to retrieve
+     * @returns Promise that resolves to the requested contact
+     * @throws {APIError} If the contact is not found or fetch operation fails
+     *
+     * @example
+     * ```typescript
+     * const contact = await repo.getByID("contact-id");
+     * console.log(`Contact: ${contact.name}, Email: ${contact.email}`);
+     * ```
+     */
+    getByID(id: string): Promise<Contact>;
+}

package/dist/features/contact/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./contact.repository";
+export * from "./contact.dtos";

package/dist/features/payout/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./payout.repository";
+export * from "./payout.dtos";
+export * from "./payout-channel-handler";