@temboplus/afloat 0.1.81 → 0.2.0-beta.2

package/dist/modules/login/login.model.d.ts

@@ -0,0 +1,168 @@
+import { LogInDTO } from "./login.dtos.js";
+import { z } from "zod";
+/**
+ * Zod schema for LogIn JSON serialization
+ * This schema validates the JSON representation of a LogIn instance
+ */
+export declare const LogInJSONSchema: 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;
+}>;
+/**
+ * Infer the LogInJSON type from the schema
+ */
+export type LogInJSON = z.infer<typeof LogInJSONSchema>;
+/**
+ * Represents the authenticated user's identity and account information.
+ *
+ * This class encapsulates the complete user account data returned from /login/me:
+ * - Basic identity: name, email (identity)
+ * - Account metadata: id, profileId, type, roleId
+ * - Account status: isActive, isArchived, resetPassword
+ * - Permissions: access array
+ * - Audit trail: createdAt, updatedAt
+ */
+export declare class LogIn {
+    private readonly _id;
+    private readonly _profileId;
+    private readonly _name;
+    private readonly _identity;
+    private readonly _type;
+    private readonly _roleId;
+    private readonly _isActive;
+    private readonly _isArchived;
+    private readonly _resetPassword;
+    private readonly _createdAt;
+    private readonly _updatedAt;
+    private readonly _access;
+    private constructor();
+    /**
+     * Creates a LogIn instance from a validated DTO.
+     *
+     * @param dto - The login data transfer object from /login/me endpoint
+     * @returns A new LogIn instance
+     * @throws {ZodError} If the DTO fails validation
+     *
+     * @example
+     * ```typescript
+     * const logIn = LogIn.from({
+     *   id: "n4mpb2HqHUlg",
+     *   profileId: "M63ZW3q5Mg0n",
+     *   name: "Admin",
+     *   identity: "admin@test.temboplus.com",
+     *   type: "password",
+     *   roleId: "4jS7pR8E9K6W",
+     *   isActive: true,
+     *   isArchived: false,
+     *   resetPassword: false,
+     *   createdAt: "2024-04-25T11:13:00.000Z",
+     *   updatedAt: "2024-04-25T11:13:00.000Z",
+     *   access: ["profile.getCurrent", "profile.update", ...]
+     * });
+     * ```
+     */
+    static from(dto: LogInDTO): LogIn;
+    /**
+     * Gets the user's unique identifier.
+     */
+    get id(): string;
+    /**
+     * Gets the profile ID this user belongs to.
+     */
+    get profileId(): string;
+    /**
+     * Gets the user's name.
+     */
+    get name(): string;
+    /**
+     * Gets the user's identity (email address).
+     */
+    get identity(): string;
+    /**
+     * Gets the user's authentication type (e.g., "password").
+     */
+    get type(): string;
+    /**
+     * Gets the user's role ID.
+     */
+    get roleId(): string;
+    /**
+     * Gets whether the account is active.
+     */
+    get isActive(): boolean;
+    /**
+     * Gets whether the account is archived.
+     */
+    get isArchived(): boolean;
+    /**
+     * Gets whether the user must reset their password.
+     */
+    get resetPassword(): boolean;
+    /**
+     * Gets the account creation date.
+     */
+    get createdAt(): Date;
+    /**
+     * Gets the last update date.
+     */
+    get updatedAt(): Date;
+    /**
+     * Gets the user's permissions/access list.
+     */
+    get access(): ReadonlyArray<string>;
+    /**
+    * Serializes the LogIn instance to a JSON-compatible object
+    */
+    toJSON(): LogInJSON;
+    /**
+     * Serializes the LogIn instance to a JSON string
+     */
+    toJSONString(): string;
+    /**
+     * Creates a LogIn instance from a JSON-compatible object or string
+     */
+    static fromJSON(json: LogInJSON | string): LogIn | undefined;
+    /**
+     * Type guard using Zod schema validation
+     */
+    static isLogInJSON(obj: unknown): obj is LogInJSON;
+}

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

@@ -0,0 +1,58 @@
+import { identityContract } from "./login.api-contract.js";
+import type { ClientInferResponseBody } from "@ts-rest/core";
+import { BaseRepository } from "@/lib/api/base-repository.js";
+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/{esm/src/models/permission.d.ts → dist/modules/login/permission.type.d.ts}

@@ -6,7 +6,7 @@ export declare const Permissions: {
         readonly ViewCurrent: "profile.getCurrent";
         readonly Update: "profile.update";
     };
-    readonly Contact: {
+    readonly Beneficiary: {
         readonly View: "contact.findById";
         readonly List: "contact.findAll";
         readonly Create: "contact.create";
@@ -38,18 +38,17 @@ export declare const Permissions: {
         readonly ViewRoles: "role.findAll";
         readonly ViewRole: "role.findById";
     };
-    readonly UserManagement: {
-        readonly ViewUsers: "login.findAll";
-        readonly ViewUser: "login.findById";
-        readonly CreateUser: "login.create";
-        readonly UpdateUser: "login.update";
-        readonly ArchiveUser: "login.archive";
-        readonly UnArchiveUser: "login.unarchive";
+    readonly TeamManagement: {
+        readonly ViewMembers: "login.findAll";
+        readonly ViewMember: "login.findById";
+        readonly CreateMember: "login.create";
+        readonly UpdateMember: "login.update";
+        readonly ArchiveMember: "login.archive";
+        readonly UnArchiveMember: "login.unarchive";
         readonly ResetPassword: "login.resetPassword";
     };
 };
 /**
  * Permission Type
  */
-export type Permission = typeof Permissions.Profile[keyof typeof Permissions.Profile] | typeof Permissions.Contact[keyof typeof Permissions.Contact] | typeof Permissions.Payment[keyof typeof Permissions.Payment] | typeof Permissions.Payout[keyof typeof Permissions.Payout] | typeof Permissions.Transfer[keyof typeof Permissions.Transfer] | typeof Permissions.UserManagement[keyof typeof Permissions.UserManagement] | typeof Permissions.Role[keyof typeof Permissions.Role] | typeof Permissions.Wallet[keyof typeof Permissions.Wallet];
-//# sourceMappingURL=permission.d.ts.map
+export type Permission = (typeof Permissions.Profile)[keyof typeof Permissions.Profile] | (typeof Permissions.Beneficiary)[keyof typeof Permissions.Beneficiary] | (typeof Permissions.Payment)[keyof typeof Permissions.Payment] | (typeof Permissions.Payout)[keyof typeof Permissions.Payout] | (typeof Permissions.Transfer)[keyof typeof Permissions.Transfer] | (typeof Permissions.TeamManagement)[keyof typeof Permissions.TeamManagement] | (typeof Permissions.Role)[keyof typeof Permissions.Role] | (typeof Permissions.Wallet)[keyof typeof Permissions.Wallet];

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

@@ -0,0 +1,5 @@
+export * from "./payout.repository.js";
+export * from "./payout.dtos.js";
+export * from "./payout-channel-handler.js";
+export * from "./payout.model.js";
+export * from "./payout.query.js";

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

@@ -0,0 +1,82 @@
+import { Wallet } from "@/modules/wallet/wallet.model.js";
+import { Amount, MNOId, PhoneNumber } from "@temboplus/frontend-core";
+import { PayoutChannel, PayoutInputDTO } from "./payout.dtos.js";
+import { BankBeneficiaryInfo, BeneficiaryInfo } from "../beneficiary/beneficiary-info.model.js";
+/**
+ * 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`;
+/**
+ * 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: BankBeneficiaryInfo, 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: BeneficiaryInfo;
+        amount: Amount;
+        notes?: string;
+    }, wallet: Wallet): PayoutInputDTO;
+}
+/**
+ * @deprecated Use PayoutChannelCodeFactory instead
+ * @see {@link PayoutChannelCodeFactory}
+ */
+export declare const createPayoutChannelCode: {
+    bank: typeof PayoutChannelCodeFactory.forBank;
+    mobile: typeof PayoutChannelCodeFactory.forMobile;
+};
+export {};