@temboplus/afloat 0.1.57 → 0.1.59

package/dist/features/auth/identity/identity.repository.d.ts

@@ -1,58 +0,0 @@
-import { identityContract } from "./identity.api-contract";
-import type { ClientInferResponseBody } from "@ts-rest/core";
-import { BaseRepository } from "@/lib/api";
-type GetUserIdentityResponse = ClientInferResponseBody<typeof identityContract.getUserCredentials>;
-/**
- * Repository class for retrieving user identity-related information.
- * Handles fetching user credentials and identity data 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 identityContract>}
- *
- * @example
- * ```typescript
- * const repo = new IdentityRepository({ token: userToken });
- * const identity = await repo.getIdentity();
- * ```
- */
-export declare class IdentityRepository extends BaseRepository<typeof identityContract> {
-    /**
-     * Creates an instance of IdentityRepository.
-     *
-     * @param options - Optional configuration
-     * @param options.token - Authentication token for API calls
-     * @param options.root - Custom API root URL
-     *
-     * @example
-     * ```typescript
-     * const repo = new IdentityRepository({
-     *   token: "user-auth-token",
-     *   root: "base-api-url"
-     * });
-     * ```
-     */
-    constructor(options?: {
-        token?: string;
-        root?: string;
-    });
-    /**
-     * Retrieves the current user's login credentials and identity information.
-     *
-     * @returns Promise that resolves to the user's login credentials
-     * @throws {APIError} If the request fails or returns an unexpected status
-     *
-     * @example
-     * ```typescript
-     * try {
-     *   const identity = await repo.getIdentity();
-     *   console.log("User identity:", identity);
-     * } catch (error) {
-     *   console.error("Failed to get user identity:", error.message);
-     * }
-     * ```
-     */
-    getIdentity(): Promise<GetUserIdentityResponse>;
-}
-export {};

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

@@ -1,5 +0,0 @@
-export * from "./auth.manager";
-export * from "./auth.repository";
-export * from "./access/access.repository";
-export * from "./identity/identity.repository";
-export * from "./profile/profile.repository";

package/dist/features/auth/profile/profile.dtos.d.ts

@@ -1,80 +0,0 @@
-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

@@ -1,56 +0,0 @@
-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/dist/features/contact/contact-input-handler.d.ts

@@ -1,16 +0,0 @@
-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/dist/features/contact/contact.dtos.d.ts

@@ -1,90 +0,0 @@
-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

@@ -1,116 +0,0 @@
-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

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

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

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

package/dist/features/payout/payout-channel-handler.d.ts

@@ -1,108 +0,0 @@
-import { Amount, MNOId, PhoneNumber } from "@temboplus/frontend-core";
-import { PayoutChannel, PayoutInputDTO } from "./payout.dtos";
-import { ContactInfo, MobileContactInfo, BankContactInfo } from "../../models/contact-info.model";
-import { Wallet } from "@/models/wallet.model";
-/**
- * Valid payout channel codes that can be used in the system
- *
- * @remarks
- * - `${countryCode}-BANK-B2C`: Code for bank transfers
- * - `${countryCode}-${telecom}-B2C`: Pattern for mobile money transfers where the telecom company is the provider code
- *
- * @see {@link PayoutChannelCodeFactory} for functions to generate valid codes
- */
-export type PayoutChannelCode = `${string}-BANK-B2C` | `${string}-${string}-B2C`;
-/**
- * Utility functions for generating payout narration strings
- */
-declare class PayoutNarrationGenerator {
-    /**
-     * Generates a narration string for a mobile payout.
-     *
-     * @param data - The mobile contact information used to generate the narration
-     * @returns A formatted, uppercase narration string for the mobile payout
-     * @throws Will throw an error if the provided data is not a valid MobileContactInfo instance
-     */
-    static generateMobilePayoutNarration(data: MobileContactInfo): string;
-    /**
-     * Generates a narration string for a bank payout.
-     *
-     * @param data - The bank contact information used to generate the narration
-     * @returns A formatted, uppercase narration string for the bank payout
-     * @throws Will throw an error if the provided data is not a valid BankContactInfo instance
-     */
-    static generateBankPayoutNarration(data: BankContactInfo): string;
-}
-/**
- * Factory for creating standardized payout channel codes
- *
- * @example
- * ```ts
- * // Create bank channel code
- * const bankCode = PayoutChannelCodeFactory.forBank(bankContactInfo); // Returns "TZ-BANK-B2C"
- *
- * // Create mobile channel code
- * const mobileCode = PayoutChannelCodeFactory.forMobile(phoneNumber); // Returns "TZ-VODACOM-B2C" for Vodacom number
- * ```
- */
-declare class PayoutChannelCodeFactory {
-    /**
-     * Creates a bank transfer channel code
-     * @param contactInfo - Bank contact information
-     * @throws {Error} If country is not supported
-     */
-    static forBank(contactInfo: BankContactInfo, wallet: Wallet): PayoutChannelCode;
-    /**
-     * Creates a mobile money channel code based on the telecom provider
-     * @param phoneNumber - Phone number object containing telecom information
-     * @returns {PayoutChannelCode} Channel code in format "TZ-{TELECOM}-B2C"
-     * @throws {Error} If phone number is invalid or country is not supported
-     *
-     * @see {@link PhoneNumber} from "@temboplus/frontend-core" for phone number structure
-     */
-    static forMobile(phoneNumber: PhoneNumber, mnoId: MNOId, wallet: Wallet): PayoutChannelCode;
-}
-/**
- * Factory class for creating payout input DTOs based on channel and contact information
- *
- * @example
- * ```ts
- * const factory = new PayoutInputFactory();
- * const payoutInput = factory.getPayoutInput({
- *   channel: PayoutChannel.MOBILE,
- *   receiver: mobileContactInfo,
- *   amount: new Amount(1000),
- *   notes: "Payment for services"
- * });
- * ```
- */
-export declare class PayoutInputFactory {
-    private readonly handlers;
-    /**
-     * Creates a payout input DTO based on the provided parameters
-     *
-     * @param args - Configuration object containing channel, receiver, amount, and optional notes
-     * @returns {PayoutInputDTO} The configured payout input data transfer object
-     * @throws {Error} If no suitable handler is found for the specified channel and contact type
-     */
-    getPayoutInput(args: {
-        channel: PayoutChannel;
-        receiver: ContactInfo;
-        amount: Amount;
-        notes?: string;
-    }, wallet: Wallet): PayoutInputDTO;
-}
-/**
- * @deprecated Use PayoutNarrationGenerator instead
- * @see {@link PayoutNarrationGenerator}
- */
-export declare const PayoutUtils: typeof PayoutNarrationGenerator;
-/**
- * @deprecated Use PayoutChannelCodeFactory instead
- * @see {@link PayoutChannelCodeFactory}
- */
-export declare const createPayoutChannelCode: {
-    bank: typeof PayoutChannelCodeFactory.forBank;
-    mobile: typeof PayoutChannelCodeFactory.forMobile;
-};
-export {};