@temboplus/afloat 0.1.80 → 0.2.0-beta.1

package/dist/modules/auth/user.model.d.ts

@@ -0,0 +1,363 @@
+import { Permission } from "../login/permission.type.js";
+import { Profile } from "../profile/profile.model.js";
+import { LogIn } from "../login/login.model.js";
+import { CompanyMembership } from "./company-membership.model.js";
+import { Role } from "../team-member/role.model.js";
+import z from "zod";
+/**
+ * Zod schema for User JSON serialization
+ * Composes the schemas from nested objects
+ */
+export declare const UserJSONSchema: z.ZodObject<{
+    logIn: z.ZodObject<{
+        id: z.ZodString;
+        profileId: z.ZodString;
+        name: z.ZodString;
+        identity: z.ZodString;
+        type: z.ZodString;
+        roleId: z.ZodString;
+        isActive: z.ZodBoolean;
+        isArchived: z.ZodBoolean;
+        resetPassword: z.ZodBoolean;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+        access: z.ZodArray<z.ZodString, "many">;
+        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name: string;
+        createdAt: string;
+        id: string;
+        version: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        updatedAt: string;
+        access: string[];
+    }, {
+        type: string;
+        name: string;
+        createdAt: string;
+        id: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        updatedAt: string;
+        access: string[];
+        version?: string | undefined;
+    }>;
+    companyProfile: 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>>;
+        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;
+    }>;
+    role: z.ZodOptional<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;
+    }>>;
+    token: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    token: string;
+    version: string;
+    companyProfile: {
+        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;
+    };
+    logIn: {
+        type: string;
+        name: string;
+        createdAt: string;
+        id: string;
+        version: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        updatedAt: string;
+        access: string[];
+    };
+    role?: {
+        name: string;
+        createdAt: string;
+        id: string;
+        version: string;
+        updatedAt: string;
+        access: string[];
+        description?: string | undefined;
+    } | undefined;
+}, {
+    token: string;
+    companyProfile: {
+        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;
+    };
+    logIn: {
+        type: string;
+        name: string;
+        createdAt: string;
+        id: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        updatedAt: string;
+        access: string[];
+        version?: string | undefined;
+    };
+    version?: string | undefined;
+    role?: {
+        name: string;
+        createdAt: string;
+        id: string;
+        updatedAt: string;
+        access: string[];
+        version?: string | undefined;
+        description?: string | undefined;
+    } | undefined;
+}>;
+/**
+ * Infer the UserJSON type from the schema
+ */
+export type UserJSON = z.infer<typeof UserJSONSchema>;
+export type UserData = {
+    logIn: LogIn;
+    companyProfile: Profile;
+    role?: Role;
+    token: string;
+};
+/**
+ * Represents the currently authenticated user session.
+ *
+ * This class combines:
+ * - LogIn: User account data (identity, permissions, resetPassword, etc.)
+ * - CompanyMembership: User's relationship to their company (company profile + role)
+ * - Token: Session authentication token
+ *
+ * The User represents "who is logged in right now" with their full context.
+ *
+ * Note: The role in CompanyMembership may be undefined if the user doesn't have
+ * permission to view role details (Permissions.Role.ViewRole).
+ */
+export declare class User {
+    private readonly _logIn;
+    private readonly _membership;
+    private readonly _token;
+    private readonly _permissionMap;
+    private constructor();
+    /**
+     * Creates a User instance from the provided data.
+     *
+     * @param data - User session data
+     * @returns A new User instance, or undefined if data is invalid
+     *
+     * @example
+     * ```typescript
+     * const user = User.from({
+     *   logIn: logIn,
+     *   companyProfile: profile,
+     *   role: role, // optional
+     *   token: "auth-token"
+     * });
+     * ```
+     */
+    static from(data: UserData): User | undefined;
+    /**
+     * Gets the user's login data.
+     */
+    get logIn(): LogIn;
+    /**
+     * Gets the user's company membership (includes company profile and role).
+     */
+    get membership(): CompanyMembership;
+    /**
+     * Gets the user's authentication token.
+     */
+    get token(): string;
+    /**
+     * Convenience getter for the user's ID.
+     */
+    get id(): string;
+    /**
+     * Convenience getter for the user's name.
+     */
+    get name(): string;
+    /**
+     * Convenience getter for the user's identity (email).
+     */
+    get identity(): string;
+    /**
+     * Convenience getter for the user's role ID.
+     */
+    get roleId(): string;
+    /**
+     * Convenience getter for whether the user must reset their password.
+     */
+    get resetPassword(): boolean;
+    /**
+     * Convenience getter for the company profile.
+     */
+    get profile(): Profile;
+    /**
+     * Convenience getter for the user's role (may be undefined).
+     */
+    get role(): Role | undefined;
+    /**
+     * Convenience getter for permissions array.
+     */
+    get access(): ReadonlyArray<string>;
+    /**
+     * Checks if the user has a specific permission.
+     *
+     * @param permission - The permission to check
+     * @returns true if the user has the permission
+     */
+    can(permission: Permission): boolean;
+    /**
+     * Checks if the user has any of the specified permissions.
+     *
+     * @param permissions - Array of permissions to check
+     * @returns true if the user has at least one permission
+     */
+    canAny(permissions: Permission[]): boolean;
+    /**
+     * Checks if the user has all of the specified permissions.
+     *
+     * @param permissions - Array of permissions to check
+     * @returns true if the user has all permissions
+     */
+    canAll(permissions: Permission[]): boolean;
+    /**
+     * Checks if the user can manage team members.
+     */
+    canManageTeam(): boolean;
+    /**
+     * Checks if the user can view role details.
+     */
+    canViewRoles(): boolean;
+    /**
+   * Serializes the User instance to a JSON-compatible object
+   *
+   * This method creates a complete snapshot of the user session including
+   * all nested objects (LogIn, Profile, Role). All data can be reconstructed
+   * from this JSON representation without needing backend calls.
+   *
+   * @returns {UserJSON} A plain object containing all necessary User data
+   *
+   * @example
+   * ```typescript
+   * const user = User.from({ ... });
+   * const json = user.toJSON();
+   * // Store in localStorage
+   * localStorage.setItem('currentUser', JSON.stringify(json));
+   * ```
+   */
+    toJSON(): UserJSON;
+    /**
+     * Serializes the User instance to a JSON string
+     *
+     * @returns {string} JSON string representation of the User
+     */
+    toJSONString(): string;
+    /**
+     * Creates a User instance from a JSON-compatible object or string
+     *
+     * This static method reconstructs a complete User instance from data that was
+     * previously serialized using toJSON(). It validates the input data and
+     * ensures all nested objects (LogIn, Profile, Role) are properly reconstructed.
+     *
+     * @param {UserJSON | string} json - Either a UserJSON object or a JSON string
+     * @returns {User | undefined} A User instance if valid, undefined otherwise
+     *
+     * @example
+     * ```typescript
+     * // From localStorage
+     * const stored = localStorage.getItem('currentUser');
+     * const user = User.fromJSON(stored!);
+     *
+     * // From object
+     * const userJson = {
+     *   logIn: { id: "...", ... },
+     *   companyProfile: { id: "...", ... },
+     *   token: "..."
+     * };
+     * const user = User.fromJSON(userJson);
+     * ```
+     */
+    static fromJSON(json: UserJSON | string): User | undefined;
+    /**
+     * Type guard using Zod schema validation
+     */
+    static isUserJSON(obj: unknown): obj is UserJSON;
+}

package/dist/modules/beneficiary/beneficiary-info.model.d.ts

@@ -0,0 +1,178 @@
+import { BeneficiaryType, BeneficiaryDTO } from "@/modules/beneficiary/beneficiary.dtos.js";
+import { PayoutDTO } from "@/modules/payout/payout.dtos.js";
+import { Bank, ISO2CountryCode, PhoneNumber } from "@temboplus/frontend-core";
+import type { BankSwiftCode, MNOId } from "@temboplus/frontend-core";
+import { z } from "zod";
+export declare const MobileBeneficiaryInfoJSONSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Mobile">;
+    name: z.ZodString;
+    phoneNumber: z.ZodString;
+    mnoId: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "Mobile";
+    name: string;
+    version: string;
+    phoneNumber: string;
+    mnoId: string;
+}, {
+    type: "Mobile";
+    name: string;
+    phoneNumber: string;
+    mnoId: string;
+    version?: string | undefined;
+}>;
+export declare const BankBeneficiaryInfoJSONSchema: z.ZodObject<{
+    type: z.ZodLiteral<"Bank">;
+    accName: z.ZodString;
+    swiftCode: z.ZodString;
+    countryCode: z.ZodString;
+    accNo: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "Bank";
+    version: string;
+    countryCode: string;
+    accName: string;
+    swiftCode: string;
+    accNo: string;
+}, {
+    type: "Bank";
+    countryCode: string;
+    accName: string;
+    swiftCode: string;
+    accNo: string;
+    version?: string | undefined;
+}>;
+export declare const BeneficiaryInfoJSONSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"Mobile">;
+    name: z.ZodString;
+    phoneNumber: z.ZodString;
+    mnoId: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "Mobile";
+    name: string;
+    version: string;
+    phoneNumber: string;
+    mnoId: string;
+}, {
+    type: "Mobile";
+    name: string;
+    phoneNumber: string;
+    mnoId: string;
+    version?: string | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"Bank">;
+    accName: z.ZodString;
+    swiftCode: z.ZodString;
+    countryCode: z.ZodString;
+    accNo: z.ZodString;
+    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+}, "strip", z.ZodTypeAny, {
+    type: "Bank";
+    version: string;
+    countryCode: string;
+    accName: string;
+    swiftCode: string;
+    accNo: string;
+}, {
+    type: "Bank";
+    countryCode: string;
+    accName: string;
+    swiftCode: string;
+    accNo: string;
+    version?: string | undefined;
+}>]>;
+export type MobileBeneficiaryInfoJSON = z.infer<typeof MobileBeneficiaryInfoJSONSchema>;
+export type BankBeneficiaryInfoJSON = z.infer<typeof BankBeneficiaryInfoJSONSchema>;
+export type BeneficiaryInfoJSON = z.infer<typeof BeneficiaryInfoJSONSchema>;
+/**
+ * Abstract base class for beneficiary information.
+ */
+declare abstract class BaseBeneficiaryInfo {
+    readonly type: BeneficiaryType;
+    readonly countryCode: ISO2CountryCode;
+    constructor(type: BeneficiaryType, countryCode: ISO2CountryCode);
+    abstract get channelId(): MNOId | BankSwiftCode;
+    abstract get channelName(): string;
+    abstract get accountName(): string;
+    abstract get accountNumber(): string;
+    abstract get accountNameLabel(): string;
+    abstract get accountNumberLabel(): string;
+    abstract get channelLabel(): string;
+    abstract validate(): boolean;
+    abstract toJSON(): BeneficiaryInfoJSON;
+    toJSONString(): string;
+    get isMobile(): boolean;
+    get isBank(): boolean;
+    get displayName(): string;
+}
+/**
+ * Mobile beneficiary information implementation.
+ */
+export declare class MobileBeneficiaryInfo extends BaseBeneficiaryInfo {
+    readonly name: string;
+    readonly phoneNumber: PhoneNumber;
+    readonly mnoId: MNOId;
+    constructor(name: string, phoneNumber: PhoneNumber, mnoId?: MNOId);
+    static from(data: {
+        name: string;
+        phoneNumber: PhoneNumber;
+        mnoId?: MNOId;
+    }): MobileBeneficiaryInfo | undefined;
+    static fromBeneficiaryDTO(info: BeneficiaryDTO): MobileBeneficiaryInfo | undefined;
+    static fromPayoutDTO(info: PayoutDTO): MobileBeneficiaryInfo | undefined;
+    static is(obj: unknown): obj is MobileBeneficiaryInfo;
+    validate(): boolean;
+    getValidationDetails(): {
+        isValid: boolean;
+        errors: string[];
+        warnings: string[];
+    };
+    get accountName(): string;
+    get accountNumber(): string;
+    get accountNameLabel(): string;
+    get accountNumberLabel(): string;
+    get channelLabel(): string;
+    get channelId(): MNOId;
+    get channelName(): string;
+    toJSON(): MobileBeneficiaryInfoJSON;
+    static fromJSON(json: MobileBeneficiaryInfoJSON | string): MobileBeneficiaryInfo | undefined;
+    static fromJSONString(jsonString: string): MobileBeneficiaryInfo | undefined;
+    static isMobileBeneficiaryInfoJSON(obj: unknown): obj is MobileBeneficiaryInfoJSON;
+}
+/**
+ * Bank beneficiary information implementation.
+ */
+export declare class BankBeneficiaryInfo extends BaseBeneficiaryInfo {
+    readonly accName: string;
+    readonly bank: Bank;
+    readonly accNo: string;
+    constructor(accName: string, bank: Bank, accNo: string);
+    static from(data: {
+        accName: string;
+        bank: Bank;
+        accNo: string;
+    }): BankBeneficiaryInfo | undefined;
+    static fromBeneficiaryDTO(info: BeneficiaryDTO): BankBeneficiaryInfo | undefined;
+    static fromPayoutDTO(info: PayoutDTO): BankBeneficiaryInfo | undefined;
+    static is(obj: unknown): obj is BankBeneficiaryInfo;
+    validate(): boolean;
+    get accountName(): string;
+    get accountNumber(): string;
+    get accountNameLabel(): string;
+    get accountNumberLabel(): string;
+    get channelLabel(): string;
+    get channelId(): BankSwiftCode;
+    get channelName(): string;
+    toJSON(): BankBeneficiaryInfoJSON;
+    static fromJSON(json: BankBeneficiaryInfoJSON | string): BankBeneficiaryInfo | undefined;
+    static fromJSONString(jsonString: string): BankBeneficiaryInfo | undefined;
+    static isBankBeneficiaryInfoJSON(obj: unknown): obj is BankBeneficiaryInfoJSON;
+}
+/**
+ * Union type representing either a mobile or bank beneficiary.
+ */
+export type BeneficiaryInfo = MobileBeneficiaryInfo | BankBeneficiaryInfo;
+export {};

package/dist/modules/beneficiary/beneficiary-input-handler.d.ts

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