@temboplus/afloat 0.1.80 → 0.2.0-beta.1

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

@@ -0,0 +1,261 @@
+import { z } from "zod";
+/**
+ * Collection of team management schemas for export.
+ * Provides access to all team member and role validation schemas.
+ */
+export declare const TeamManagementDTOSchemas: {
+    role: 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;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        createdAt: string;
+        id: string;
+        updatedAt: string;
+        access: string[];
+        description?: string | undefined;
+    }, {
+        name: string;
+        createdAt: string;
+        id: string;
+        updatedAt: string;
+        access: string[];
+        description?: string | undefined;
+    }>;
+    teamMember: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        identity: z.ZodString;
+        type: z.ZodString;
+        profileId: z.ZodString;
+        roleId: z.ZodString;
+        resetPassword: z.ZodBoolean;
+        isActive: z.ZodBoolean;
+        isArchived: z.ZodBoolean;
+        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;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            createdAt: string;
+            id: string;
+            updatedAt: string;
+            access: string[];
+            description?: string | undefined;
+        }, {
+            name: string;
+            createdAt: string;
+            id: string;
+            updatedAt: string;
+            access: string[];
+            description?: string | undefined;
+        }>>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name: string;
+        createdAt: string;
+        id: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        updatedAt: string;
+        role?: {
+            name: string;
+            createdAt: string;
+            id: string;
+            updatedAt: string;
+            access: string[];
+            description?: string | undefined;
+        } | undefined;
+    }, {
+        type: string;
+        name: string;
+        createdAt: string;
+        id: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        updatedAt: string;
+        role?: {
+            name: string;
+            createdAt: string;
+            id: string;
+            updatedAt: string;
+            access: string[];
+            description?: string | undefined;
+        } | undefined;
+    }>;
+    teamMemberQueryParams: z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        name: z.ZodOptional<z.ZodString>;
+        identity: z.ZodOptional<z.ZodString>;
+        type: z.ZodOptional<z.ZodString>;
+        profileId: z.ZodOptional<z.ZodString>;
+        roleId: z.ZodOptional<z.ZodString>;
+        resetPassword: z.ZodOptional<z.ZodNumber>;
+        isActive: z.ZodOptional<z.ZodNumber>;
+        isArchived: z.ZodOptional<z.ZodNumber>;
+        createdAt: z.ZodOptional<z.ZodString>;
+        updatedAt: z.ZodOptional<z.ZodString>;
+        eager: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type?: string | undefined;
+        name?: string | undefined;
+        createdAt?: string | undefined;
+        eager?: string | undefined;
+        id?: string | undefined;
+        profileId?: string | undefined;
+        identity?: string | undefined;
+        roleId?: string | undefined;
+        isActive?: number | undefined;
+        isArchived?: number | undefined;
+        resetPassword?: number | undefined;
+        updatedAt?: string | undefined;
+    }, {
+        type?: string | undefined;
+        name?: string | undefined;
+        createdAt?: string | undefined;
+        eager?: string | undefined;
+        id?: string | undefined;
+        profileId?: string | undefined;
+        identity?: string | undefined;
+        roleId?: string | undefined;
+        isActive?: number | undefined;
+        isArchived?: number | undefined;
+        resetPassword?: number | undefined;
+        updatedAt?: string | undefined;
+    }>;
+    createTeamMemberRequest: z.ZodObject<{
+        name: z.ZodString;
+        identity: z.ZodString;
+        password: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        roleId: z.ZodOptional<z.ZodString>;
+        resetPassword: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        identity: string;
+        roleId?: string | undefined;
+        resetPassword?: boolean | undefined;
+        password?: string | undefined;
+    }, {
+        name: string;
+        identity: string;
+        roleId?: string | undefined;
+        resetPassword?: boolean | undefined;
+        password?: string | undefined;
+    }>;
+    updateTeamMemberRequest: z.ZodObject<{
+        name: z.ZodOptional<z.ZodString>;
+        roleId: z.ZodOptional<z.ZodString>;
+        password: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        resetPassword: z.ZodOptional<z.ZodBoolean>;
+        isActive: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        name?: string | undefined;
+        roleId?: string | undefined;
+        isActive?: boolean | undefined;
+        resetPassword?: boolean | undefined;
+        password?: string | undefined;
+    }, {
+        name?: string | undefined;
+        roleId?: string | undefined;
+        isActive?: boolean | undefined;
+        resetPassword?: boolean | undefined;
+        password?: string | undefined;
+    }>;
+    resetPasswordRequest: z.ZodObject<{
+        newPassword: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        sendNotification: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        newPassword?: string | undefined;
+        sendNotification?: boolean | undefined;
+    }, {
+        newPassword?: string | undefined;
+        sendNotification?: boolean | undefined;
+    }>;
+    createTeamMemberResponse: z.ZodObject<{
+        id: z.ZodString;
+        name: z.ZodString;
+        identity: z.ZodString;
+        type: z.ZodString;
+        profileId: z.ZodString;
+        resetPassword: z.ZodBoolean;
+        roleId: z.ZodString;
+        isActive: z.ZodBoolean;
+        isArchived: z.ZodBoolean;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name: string;
+        createdAt: string;
+        id: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        updatedAt: string;
+    }, {
+        type: string;
+        name: string;
+        createdAt: string;
+        id: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        updatedAt: string;
+    }>;
+    password: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>;
+};
+/**
+ * TypeScript type for a validated role object.
+ * Use this type for role instances that have been validated against the schema.
+ */
+export type RoleDTO = z.infer<typeof TeamManagementDTOSchemas.role>;
+/**
+ * TypeScript type for a create team member request object.
+ * Use this type for team member creation requests that have been validated against the schema.
+ */
+export type CreateTeamMemberRequestDTO = z.infer<typeof TeamManagementDTOSchemas.createTeamMemberRequest>;
+/**
+ * TypeScript type for an update team member request object.
+ * Use this type for team member update requests that have been validated against the schema.
+ */
+export type UpdateTeamMemberRequestDTO = z.infer<typeof TeamManagementDTOSchemas.updateTeamMemberRequest>;
+/**
+ * TypeScript type for a reset password request object.
+ * Use this type for password reset requests that have been validated against the schema.
+ */
+export type ResetPasswordRequestDTO = z.infer<typeof TeamManagementDTOSchemas.resetPasswordRequest>;
+/**
+ * TypeScript type for a create team member response object.
+ * Use this type for team member creation responses that have been validated against the schema.
+ */
+export type CreateTeamMemberResponseDTO = z.infer<typeof TeamManagementDTOSchemas.createTeamMemberResponse>;
+/**
+ * TypeScript type for team member query parameters.
+ * Use this type for query parameter objects that have been validated against the schema.
+ * All fields are optional to allow flexible filtering and searching.
+ */
+export type TeamMemberQueryParamsDTO = z.infer<typeof TeamManagementDTOSchemas.teamMemberQueryParams>;

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

@@ -0,0 +1,237 @@
+import z from "zod";
+import { Role } from "./role.model.js";
+import { RoleDTO } from "./team-member.dtos.js";
+export interface TeamMemberData {
+    id: string;
+    name: string;
+    identity: string;
+    type: string;
+    profileId: string;
+    roleId: string;
+    resetPassword: boolean;
+    isActive: boolean;
+    isArchived: boolean;
+    role?: RoleDTO;
+    createdAt: string;
+    updatedAt: string;
+}
+/**
+ * Zod schema for TeamMember JSON serialization
+ */
+export declare const TeamMemberJSONSchema: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    identity: z.ZodString;
+    type: z.ZodString;
+    profileId: z.ZodString;
+    roleId: z.ZodString;
+    resetPassword: z.ZodBoolean;
+    isActive: z.ZodBoolean;
+    isArchived: z.ZodBoolean;
+    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;
+    }>>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+    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;
+    role?: {
+        name: string;
+        createdAt: string;
+        id: string;
+        version: string;
+        updatedAt: string;
+        access: string[];
+        description?: string | undefined;
+    } | undefined;
+}, {
+    type: string;
+    name: string;
+    createdAt: string;
+    id: string;
+    profileId: string;
+    identity: string;
+    roleId: string;
+    isActive: boolean;
+    isArchived: boolean;
+    resetPassword: boolean;
+    updatedAt: string;
+    version?: string | undefined;
+    role?: {
+        name: string;
+        createdAt: string;
+        id: string;
+        updatedAt: string;
+        access: string[];
+        version?: string | undefined;
+        description?: string | undefined;
+    } | undefined;
+}>;
+export type TeamMemberJSON = z.infer<typeof TeamMemberJSONSchema>;
+/**
+ * Represents a team member from the admin management perspective.
+ *
+ * This is how administrators view and manage people in the system.
+ * When a team member logs in, they become a User (authenticated session).
+ *
+ * TeamMember includes management metadata like:
+ * - isActive, isArchived (account status)
+ * - createdAt, updatedAt (audit trail)
+ * - role (their assigned role with permissions)
+ */
+export declare class TeamMember {
+    readonly id: string;
+    readonly name: string;
+    readonly identity: string;
+    readonly type: string;
+    readonly profileId: string;
+    readonly roleId: string;
+    readonly resetPassword: boolean;
+    readonly isActive: boolean;
+    readonly isArchived: boolean;
+    readonly role?: Role;
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+    readonly permissions: ReadonlySet<string>;
+    private constructor();
+    /**
+     * Creates a TeamMember instance from a DTO.
+     *
+     * @param data - Team member data from the API
+     * @returns A new TeamMember instance, or undefined if data is invalid
+     *
+     * @example
+     * ```typescript
+     * const member = TeamMember.from({
+     *   id: "member-123",
+     *   name: "John Doe",
+     *   identity: "john@example.com",
+     *   roleId: "role-456",
+     *   // ... other fields
+     * });
+     * ```
+     */
+    static from(data: TeamMemberData): TeamMember | undefined;
+    /**
+     * Creates a TeamMember instance from a JSON string.
+     *
+     * @param jsonString - JSON string containing team member data
+     * @returns A new TeamMember instance, or undefined if parsing failed
+     */
+    static fromJson(jsonString: string): TeamMember | undefined;
+    /**
+     * Creates multiple TeamMember instances from an array of data.
+     *
+     * @param dataArray - Array of team member data
+     * @returns Array of TeamMember instances (filters out invalid entries)
+     *
+     * @example
+     * ```typescript
+     * const members = TeamMember.createMany(apiResponse.data);
+     * ```
+     */
+    static createMany(dataArray: any[]): TeamMember[];
+    /**
+     * Check if team member has a specific permission
+     */
+    can(permission: string): boolean;
+    /**
+     * Check if team member has any of the specified permissions
+     */
+    canAny(permissions: string[]): boolean;
+    /**
+     * Check if team member has all of the specified permissions
+     */
+    canAll(permissions: string[]): boolean;
+    /**
+     * Check if team member account is active
+     */
+    isAccountActive(): boolean;
+    /**
+     * Check if team member account is archived
+     */
+    isAccountArchived(): boolean;
+    /**
+     * Check if team member needs to reset password
+     */
+    needsPasswordReset(): boolean;
+    /**
+     * Get comprehensive account status
+     */
+    getAccountStatus(): {
+        status: "active" | "inactive" | "archived" | "password_reset_required";
+        label: string;
+        color: "success" | "warning" | "error" | "default";
+        description: string;
+    };
+    /**
+     * Get role display name
+     */
+    getRoleName(): string;
+    /**
+     * Get formatted creation date
+     */
+    getCreatedDate(): string;
+    /**
+     * Get time since last update
+     */
+    getLastUpdateInfo(): string;
+    /**
+   * Serializes the TeamMember instance to a JSON-compatible object
+   */
+    toJSON(): TeamMemberJSON;
+    /**
+     * Serializes the TeamMember instance to a JSON string
+     */
+    toJSONString(): string;
+    /**
+     * Creates a TeamMember instance from a JSON-compatible object or string
+     */
+    static fromJSON(json: TeamMemberJSON | string): TeamMember | undefined;
+    /**
+     * Type guard using Zod schema validation
+     */
+    static isTeamMemberJSON(obj: unknown): obj is TeamMemberJSON;
+    /**
+     * Creates multiple TeamMember instances from a JSON array
+     */
+    static fromJSONArray(jsonArray: TeamMemberJSON[] | string): TeamMember[];
+    /**
+     * Serializes an array of TeamMember instances to JSON
+     */
+    static toJSONArray(members: TeamMember[]): TeamMemberJSON[];
+}

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

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

@@ -0,0 +1,6 @@
+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";