@temboplus/afloat 0.1.77-beta.9 → 0.1.79

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

@@ -1,179 +0,0 @@
-import { BaseRepository } from "@/lib/api/base-repository.js";
-import { teamManagementContract } from "./team-member.contract.js";
-import { Role } from "./role.model.js";
-import { CreateTeamMemberRequestDTO, CreateTeamMemberResponseDTO, UpdateTeamMemberRequestDTO, ResetPasswordRequestDTO, TeamMemberQueryParamsDTO } from "./team-member.dtos.js";
-import { TeamMember } from "./team-member.model.js";
-/**
- * Repository class for managing team members through API interactions.
- * Handles team member creation, updates, archiving, and role management.
- *
- * This repository handles pure API communication without permission checking.
- * Permission validation should be handled at the service layer or route handlers.
- *
- * @extends {BaseRepository<typeof teamManagementContract>}
- *
- * @example
- * ```typescript
- * const repo = new TeamMemberRepository({ token: adminToken });
- * const members = await repo.getAllTeamMembers();
- * ```
- */
-export declare class TeamMemberRepository extends BaseRepository<typeof teamManagementContract> {
-    /**
-     * Creates an instance of TeamMemberRepository using the team management 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 TeamMemberRepository({
-     *   token: "admin-auth-token",
-     *   root: "https://api-staging.afloat.money/v1"
-     * });
-     * ```
-     */
-    constructor(options?: {
-        token?: string;
-        root?: string;
-    });
-    /**
-     * Creates a new team member account.
-     *
-     * @param input - The data required to create a new team member
-     * @returns Promise that resolves to the newly created team member response
-     * @throws {APIError} If the creation operation fails
-     *
-     * @example
-     * ```typescript
-     * const newMember = await repo.createTeamMember({
-     *   identity: "newmember@example.com",
-     *   name: "New Member",
-     *   roleId: "role-id"
-     * });
-     * ```
-     */
-    createTeamMember(input: CreateTeamMemberRequestDTO): Promise<CreateTeamMemberResponseDTO>;
-    /**
-     * Updates an existing team member by ID.
-     *
-     * @param id - The unique identifier of the team member to update
-     * @param input - The data to update the team member with
-     * @returns Promise that resolves to the updated team member
-     * @throws {APIError} If the update operation fails
-     *
-     * @example
-     * ```typescript
-     * const updatedMember = await repo.updateTeamMember("member-id", {
-     *   name: "Updated Name",
-     *   roleId: "new-role-id"
-     * });
-     * ```
-     */
-    updateTeamMember(id: string, input: UpdateTeamMemberRequestDTO): Promise<TeamMember>;
-    /**
-     * Archives (soft deletes) a team member by ID.
-     *
-     * @param id - The unique identifier of the team member to archive
-     * @returns Promise that resolves to the updated team member object
-     * @throws {APIError} If the archive operation fails
-     *
-     * @example
-     * ```typescript
-     * const archivedMember = await repo.archiveTeamMember("member-id");
-     * ```
-     */
-    archiveTeamMember(id: string): Promise<TeamMember>;
-    /**
-     * Unarchives a previously archived team member by ID.
-     *
-     * @param id - The unique identifier of the team member to unarchive
-     * @returns Promise that resolves to the updated team member object
-     * @throws {APIError} If the unarchive operation fails
-     *
-     * @example
-     * ```typescript
-     * const restoredMember = await repo.unArchiveTeamMember("member-id");
-     * ```
-     */
-    unArchiveTeamMember(id: string): Promise<TeamMember>;
-    /**
-     * Resets a team member's password.
-     *
-     * @param id - The unique identifier of the team member
-     * @param input - Optional password reset configuration
-     * @returns Promise that resolves to success status
-     * @throws {APIError} If the password reset operation fails
-     *
-     * @example
-     * ```typescript
-     * const result = await repo.resetTeamMemberPassword("member-id", {
-     *   sendNotification: true
-     * });
-     * ```
-     */
-    resetTeamMemberPassword(id: string, input?: ResetPasswordRequestDTO): Promise<{
-        success: boolean;
-    }>;
-    /**
-     * Retrieves all team members.
-     * Results are ordered in descending order by creation date by default.
-     *
-     * @param query - Optional query parameters for filtering and eager loading
-     * @returns Promise that resolves to an array of team members
-     * @throws {APIError} If the fetch operation fails
-     *
-     * @example
-     * ```typescript
-     * // Get all team members with role information
-     * const members = await repo.getAllTeamMembers({ eager: "role" });
-     *
-     * // Get team members with custom query
-     * const activeMembers = await repo.getAllTeamMembers({ isActive: 1 });
-     * ```
-     */
-    getAllTeamMembers(query?: TeamMemberQueryParamsDTO): Promise<TeamMember[]>;
-    /**
-     * Retrieves a specific team member by ID.
-     *
-     * @param id - The unique identifier of the team member to retrieve
-     * @param query - Optional query parameters for eager loading
-     * @returns Promise that resolves to the team member
-     * @throws {APIError} If the team member is not found or fetch operation fails
-     *
-     * @example
-     * ```typescript
-     * const member = await repo.getTeamMember("member-id", { eager: "role" });
-     * console.log(`Member: ${member.name}, Role: ${member.role?.name}`);
-     * ```
-     */
-    getTeamMember(id: string, query?: TeamMemberQueryParamsDTO): Promise<TeamMember>;
-    /**
-     * Retrieves all available roles in the system.
-     *
-     * @returns Promise that resolves to an array of roles
-     * @throws {APIError} If the fetch operation fails
-     *
-     * @example
-     * ```typescript
-     * const roles = await repo.getAllRoles();
-     * roles.forEach(role => console.log(`Role: ${role.name}`));
-     * ```
-     */
-    getAllRoles(): Promise<Role[]>;
-    /**
-     * Retrieves a specific role by ID.
-     *
-     * @param id - The unique identifier of the role to retrieve
-     * @returns Promise that resolves to the role
-     * @throws {APIError} If the role is not found or fetch operation fails
-     *
-     * @example
-     * ```typescript
-     * const role = await repo.getRole("role-id");
-     * console.log(`Role: ${role.name}, Permissions: ${role.permissions.size}`);
-     * ```
-     */
-    getRole(id: string): Promise<Role>;
-}

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

@@ -1,7 +0,0 @@
-export * from "./wallet.dtos.js";
-export * from "./wallet.model.js";
-export * from "./statement-entry.model.js";
-export * from "./narration.model.js";
-export * from "./wallet.repository.js";
-export * from "./wallet.utils.js";
-export * from "./wallet-manager.session.js";

package/dist/modules/wallet/narration.model.d.ts

@@ -1,225 +0,0 @@
-import { ContactInfo, MobileContactInfo, BankContactInfo } from "../contact/contact-info.model.js";
-import z from "zod";
-/** Prefix for Ecobank mobile transfer narrations */
-export declare const ECOBANK_PREFIX = "MOBILE TRANSFER ";
-/** V2 format prefix for payout narrations using contact details */
-export declare const NARR_V2_PREFIX: string;
-/** V1 format prefix for bank payout narrations */
-export declare const BANK_NARR_PREFIX: string;
-/** Legacy format prefix for bank payout narrations */
-export declare const LEGACY_BANK_NARR_PREFIX: string;
-/** V1 format prefix for mobile money payout narrations */
-export declare const MOBILE_NARR_PREFIX: string;
-/** Legacy format prefix for mobile money payout narrations */
-export declare const LEGACY_MOBILE_NARR_PREFIX: string;
-/**
- * Zod schema for Narration JSON serialization
- */
-export declare const NarrationJSONSchema: z.ZodObject<{
-    text: z.ZodString;
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-}, "strip", z.ZodTypeAny, {
-    version: string;
-    text: string;
-}, {
-    text: string;
-    version?: string | undefined;
-}>;
-export type NarrationJSON = z.infer<typeof NarrationJSONSchema>;
-/**
- * Handles payout narration generation and parsing for the Afloat platform.
- *
- * This class provides functionality to:
- * - Generate standardized payout narrations using contact details (V2 format)
- * - Parse existing narrations to extract contact information
- * - Format narration text for different display contexts
- * - Handle V2 (PAY format), V1, and legacy narration formats for backward compatibility
- * - Serialize/deserialize to/from JSON format
- *
- * @example
- * ```typescript
- * // Generate V2 narration using contact info
- * const mobileContact = new MobileContactInfo("John Doe", phoneNumber);
- * const narration = Narration.generateDefaultPayoutNarration(mobileContact);
- * // Result: "PAYOUT +255123456789 JOHN DOE"
- *
- * const bankContact = new BankContactInfo("Jane Smith", bank, "1234567890");
- * const narration = Narration.generateDefaultPayoutNarration(bankContact);
- * // Result: "PAYOUT CORUTZTZ 1234567890 JANE SMITH"
- *
- * // Extract contact details from narration
- * const existingNarration = new Narration("PAYOUT +255123456789 JOHN DOE");
- * const contactInfo = existingNarration.getContactDetails();
- * // Returns: MobileContactInfo instance
- * ```
- */
-export declare class Narration {
-    /** The raw narration text */
-    text: string;
-    /**
-     * Creates a new Narration instance.
-     *
-     * @param text - The narration text to wrap
-     */
-    constructor(text: string);
-    /**
-     * Returns a medium-length version of the narration text suitable for table columns.
-     * Truncates to 47 characters + "..." if longer than 50 characters.
-     *
-     * @returns Truncated narration text for medium-width displays
-     */
-    get mediumText(): string;
-    /**
-     * Returns a short version of the narration text suitable for compact displays.
-     * Truncates to 32 characters + "..." if longer than 35 characters.
-     *
-     * @returns Truncated narration text for narrow displays
-     */
-    get shortText(): string;
-    /**
-     * Generates the default payout narration based on contact information using the V2 format.
-     * Automatically determines whether to generate mobile or bank narration based on contact type.
-     *
-     * @param data - Contact information (either MobileContactInfo or BankContactInfo)
-     * @returns Formatted default narration string in uppercase using V2 format, or empty string if contact type is unrecognized
-     *
-     * @example
-     * ```typescript
-     * const mobileContact = new MobileContactInfo("John Doe", phoneNumber);
-     * const narration = Narration.generateDefaultPayoutNarration(mobileContact);
-     * // Returns: "PAYOUT +255123456789 JOHN DOE"
-     *
-     * const bankContact = new BankContactInfo("Jane Smith", bank, "1234567890");
-     * const narration = Narration.generateDefaultPayoutNarration(bankContact);
-     * // Returns: "PAYOUT CORUTZTZ 1234567890 JANE SMITH"
-     * ```
-     */
-    static generateDefaultPayoutNarration(data: ContactInfo): string;
-    /**
-     * Generates a V2 standardized mobile money payout narration with contact details.
-     * Format: "PAY {phone_number} {name}"
-     *
-     * @param data - Mobile contact information containing phone number and name
-     * @returns Formatted V2 mobile payout narration in uppercase
-     *
-     * @example
-     * ```typescript
-     * const contact = new MobileContactInfo("John Doe", phoneNumber);
-     * const narration = Narration.generateMobilePayoutNarrationV2(contact);
-     * // Returns: "PAYOUT +255123456789 JOHN DOE"
-     * ```
-     */
-    static generateMobilePayoutNarrationV2(data: MobileContactInfo): string;
-    /**
-     * Generates a V2 standardized bank payout narration with contact details.
-     * Format: "PAY {swift_code} {account_number} {account_name}"
-     *
-     * @param data - Bank contact information containing bank details, account number, and account name
-     * @returns Formatted V2 bank payout narration in uppercase
-     *
-     * @example
-     * ```typescript
-     * const contact = new BankContactInfo("Jane Smith", bank, "1234567890");
-     * const narration = Narration.generateBankPayoutNarrationV2(contact);
-     * // Returns: "PAYOUT CORUTZTZ 1234567890 JANE SMITH"
-     * ```
-     */
-    static generateBankPayoutNarrationV2(data: BankContactInfo): string;
-    /**
-     * Extracts contact information from the narration text.
-     * Supports V2 (PAY format), V1, and legacy formats for comprehensive contact detection.
-     *
-     * @returns Parsed ContactInfo (BankContactInfo or MobileContactInfo) if successful, undefined otherwise
-     *
-     * @example
-     * ```typescript
-     * // V2 format
-     * const v2Narration = new Narration("PAYOUT +255123456789 JOHN DOE");
-     * const v2Contact = v2Narration.getContactDetails();
-     * // Returns: MobileContactInfo instance
-     *
-     * // V1 format
-     * const v1Narration = new Narration("PAYOUT TO BANK CRDB 1234567890 Jane Smith");
-     * const v1Contact = v1Narration.getContactDetails();
-     * // Returns: BankContactInfo instance
-     * ```
-     */
-    getContactDetails: () => ContactInfo | undefined;
-    /**
-     * Extracts bank contact information from the narration text.
-     * Handles V2 format (PAY with SWIFT code and details), V1 format, and legacy format.
-     * Also handles Ecobank-prefixed narrations by stripping the prefix.
-     *
-     * V2 format: "PAYOUT {swift_code} {account_number} {account_name}"
-     * V1 format: "PAYOUT TO BANK {bank_name} {account_number} {account_name}"
-     * Legacy format: "TO_BANK => {json_object}"
-     *
-     * @returns BankContactInfo if parsing is successful, undefined otherwise
-     *
-     * @example
-     * ```typescript
-     * // V2 format
-     * const v2Narration = new Narration("PAYOUT CORUTZTZ 1234567890 JANE SMITH");
-     * const v2Contact = v2Narration.getBankContactDetails();
-     *
-     * // V1 format
-     * const v1Narration = new Narration("PAYOUT TO BANK CRDB 1234567890 Jane Smith");
-     * const v1Contact = v1Narration.getBankContactDetails();
-     * ```
-     */
-    getBankContactDetails: () => BankContactInfo | undefined;
-    /**
-     * Extracts mobile contact information from the narration text.
-     * Handles V2 format (PAY with phone number and name), V1 format, and legacy format.
-     * Also handles Ecobank-prefixed narrations by stripping the prefix.
-     *
-     * V2 format: "PAYOUT {phone_number} {name}"
-     * V1 format: "PAYOUT TO MOBILE {phone_number} {name}"
-     * Legacy format: "TO_MOMO => {json_object}"
-     *
-     * @returns MobileContactInfo if parsing is successful, undefined otherwise
-     *
-     * @example
-     * ```typescript
-     * // V2 format
-     * const v2Narration = new Narration("PAYOUT +255123456789 JOHN DOE");
-     * const v2Contact = v2Narration.getMobileContactDetails();
-     *
-     * // V1 format
-     * const v1Narration = new Narration("PAYOUT TO MOBILE +255123456789 John Doe");
-     * const v1Contact = v1Narration.getMobileContactDetails();
-     * ```
-     */
-    getMobileContactDetails: () => MobileContactInfo | undefined;
-    /**
-     * Type guard to check if an unknown object is a valid Narration instance.
-     *
-     * @param obj - The object to check
-     * @returns Type predicate indicating if the object is a Narration instance
-     */
-    static is(obj: unknown): obj is Narration;
-    /**
-   * Serializes the Narration instance to a JSON-compatible object
-   */
-    toJSON(): NarrationJSON;
-    /**
-     * Serializes the Narration instance to a JSON string
-     */
-    toJSONString(): string;
-    /**
-     * Creates a Narration instance from a JSON-compatible object or string
-     */
-    static fromJSON(json: NarrationJSON | string): Narration | undefined;
-    /**
-     * Type guard using Zod schema validation
-     */
-    static isNarrationJSON(obj: unknown): obj is NarrationJSON;
-    /**
-     * @deprecated Use toJSON() instead
-     */
-    toJson(): NarrationJSON;
-    /**
-     * @deprecated Use fromJSON() instead
-     */
-    static fromJson(json: NarrationJSON | string): Narration | undefined;
-}