@temboplus/afloat 0.1.75-0 → 0.1.77-beta.1

package/dist/lib/api/index.d.ts

@@ -1,2 +1 @@
-export * from "./common-schemas.js";
 export * from "./base-repository.js";

package/dist/lib/error/error.permission.d.ts

@@ -1,4 +1,4 @@
-import { Permission } from "@/models/permission.js";
+import { Permission } from "@/modules/login/permission.type.js";
 /**
  * Custom error class representing an error caused by missing required permissions.
  * Extends the built-in {@link Error} class to include the `requiredPermissions` property.

package/dist/lib/query/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./query.builder.js";
 export * from "./query.types.js";
+export * from "./pagination/pagination.schemas.js";
+export * from "./pagination/pagination.js";

package/dist/lib/query/pagination/pagination.d.ts

@@ -0,0 +1,73 @@
+/** Serialized pagination metadata for API responses */
+export type PaginationJson = {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+    hasNext: boolean;
+    hasPrev: boolean;
+};
+/**
+ * Represents pagination metadata for paginated API responses.
+ * Provides computed properties for navigation and page calculations.
+ */
+export declare class Pagination {
+    readonly page: number;
+    readonly limit: number;
+    readonly total: number;
+    /**
+     * @param page - Current page number (1-based)
+     * @param limit - Number of items per page
+     * @param total - Total number of items across all pages
+     */
+    constructor(page: number, limit: number, total: number);
+    /** Total number of pages */
+    get totalPages(): number;
+    /** Whether there is a next page available */
+    get hasNext(): boolean;
+    /** Whether there is a previous page available */
+    get hasPrev(): boolean;
+    /** Offset for database queries (0-based) */
+    get offset(): number;
+    /** Whether this is the first page */
+    get isFirstPage(): boolean;
+    /** Whether this is the last page */
+    get isLastPage(): boolean;
+    /**
+     * Creates a Pagination instance for the next page.
+     * @returns New Pagination instance or null if no next page exists
+     */
+    nextPage(): Pagination | null;
+    /**
+     * Creates a Pagination instance for the previous page.
+     * @returns New Pagination instance or null if no previous page exists
+     */
+    prevPage(): Pagination | null;
+    /** Converts to a plain object for JSON serialization */
+    toJSON(): {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    };
+}
+/** Generic paginated response structure */
+export interface Paged<T> {
+    results: T[];
+    pagination: Pagination;
+}
+/** Type for paginated responses after JSON serialization */
+export type PaginatedApiResponse<T> = {
+    results: T[];
+    pagination: PaginationJson;
+};
+/**
+ * Creates a paginated response from query results.
+ */
+export declare function createPaginatedResponse<T>(results: T[], page: number, limit: number, total: number): Paged<T>;
+/**
+ * Creates an empty paginated response.
+ */
+export declare function emptyPaginatedResponse<T>(page?: number, limit?: number): Paged<T>;

package/dist/lib/query/pagination/pagination.schemas.d.ts

@@ -0,0 +1,83 @@
+import { z } from "zod";
+/** Zod schema for validating pagination query parameters */
+export declare const PaginationParamsSchema: z.ZodObject<{
+    page: z.ZodDefault<z.ZodNumber>;
+    limit: z.ZodDefault<z.ZodNumber>;
+}, "strip", z.ZodTypeAny, {
+    page: number;
+    limit: number;
+}, {
+    page?: number | undefined;
+    limit?: number | undefined;
+}>;
+/** Zod schema for validating pagination metadata */
+export declare const PaginationSchema: z.ZodObject<{
+    page: z.ZodNumber;
+    limit: z.ZodNumber;
+    total: z.ZodNumber;
+    totalPages: z.ZodNumber;
+    hasNext: z.ZodBoolean;
+    hasPrev: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+    hasNext: boolean;
+    hasPrev: boolean;
+}, {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+    hasNext: boolean;
+    hasPrev: boolean;
+}>;
+/**
+ * Creates a Zod schema for a paginated response with typed results.
+ */
+export declare function createPaginatedResponseSchema<T extends z.ZodTypeAny>(itemSchema: T): z.ZodObject<{
+    results: z.ZodArray<T, "many">;
+    pagination: z.ZodObject<{
+        page: z.ZodNumber;
+        limit: z.ZodNumber;
+        total: z.ZodNumber;
+        totalPages: z.ZodNumber;
+        hasNext: z.ZodBoolean;
+        hasPrev: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }, {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    results: T["_output"][];
+    pagination: {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    };
+}, {
+    results: T["_input"][];
+    pagination: {
+        page: number;
+        limit: number;
+        total: number;
+        totalPages: number;
+        hasNext: boolean;
+        hasPrev: boolean;
+    };
+}>;

package/dist/{features → modules}/auth/auth.contract.d.ts

@@ -54,6 +54,7 @@ export declare const authContract: {
                 resetPassword: z.ZodBoolean;
             }, "strip", z.ZodTypeAny, {
                 resetPassword: boolean;
+                access: string[];
                 profile: {
                     id: string;
                     displayName: string;
@@ -65,9 +66,9 @@ export declare const authContract: {
                     autoApprove?: boolean | null | undefined;
                 };
                 token: string;
-                access: string[];
             }, {
                 resetPassword: boolean;
+                access: string[];
                 profile: {
                     id: string;
                     displayName: string;
@@ -79,7 +80,6 @@ export declare const authContract: {
                     autoApprove?: boolean | null | undefined;
                 };
                 token: string;
-                access: string[];
             }>;
             400: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
         };
@@ -87,13 +87,6 @@ export declare const authContract: {
     access: {
         method: "GET";
         path: "/access";
-        headers: z.ZodObject<{
-            token: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            token: string;
-        }, {
-            token: string;
-        }>;
         responses: {
             200: z.ZodArray<z.ZodString, "many">;
         };

package/dist/{features → modules}/auth/auth.manager.d.ts

@@ -1,5 +1,5 @@
-import { Permission } from "@/models/permission.js";
-import { User } from "@/models/user.model.js";
+import { Permission } from "@/modules/login/permission.type.js";
+import { User } from "@/modules/auth/user.model.js";
 /**
  * Clean authentication manager for client-side usage only.
  *

package/dist/{features → modules}/auth/auth.repository.d.ts

@@ -1,5 +1,5 @@
 import { BaseRepository } from "@/lib/api/base-repository.js";
-import { User } from "@/models/user.model.js";
+import { User } from "@/modules/auth/user.model.js";
 import { authContract } from "./auth.contract.js";
 /**
  * Repository class for handling authentication-related operations.
@@ -63,4 +63,21 @@ export declare class AuthRepository extends BaseRepository<typeof authContract>
      * ```
      */
     updatePassword(currentPassword: string, newPassword: string): Promise<boolean>;
+    /**
+     * Retrieves the current user's access list.
+     *
+     * @returns Promise that resolves to an array of access permissions/roles
+     * @throws {APIError} If the request fails or returns an unexpected status
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   const accessList = await repo.getAccessList();
+     *   console.log("User has access to:", accessList);
+     * } catch (error) {
+     *   console.error("Failed to get access list:", error.message);
+     * }
+     * ```
+     */
+    getAccessList(): Promise<string[]>;
 }

package/dist/{features → modules}/auth/auth.store.d.ts

@@ -1,5 +1,5 @@
 import { type StoreApi, type UseBoundStore } from "zustand";
-import { User } from "@/models/user.model.js";
+import { User } from "@/modules/auth/user.model.js";
 /** Type definition for the store's internal state */
 type AuthState = {
     user: string | undefined;

package/dist/modules/auth/company-membership.model.d.ts

@@ -0,0 +1,58 @@
+import { Profile } from "../profile/profile.model.js";
+import { Role } from "../team-member/role.model.js";
+export interface CompanyMembershipData {
+    companyProfile: Profile;
+    role?: Role;
+}
+/**
+ * Represents a user's membership within a company.
+ *
+ * This class encapsulates the relationship between a user and their company:
+ * - The company profile the user belongs to
+ * - The user's role within that company (optional - depends on permissions)
+ *
+ * Note: Permissions are stored in LogIn.access, not here.
+ * This model focuses purely on the company-user relationship.
+ *
+ * The role may be undefined if the user doesn't have permission to view
+ * role details (Permissions.Role.ViewRole).
+ */
+export declare class CompanyMembership {
+    private readonly _companyProfile;
+    private readonly _role?;
+    private constructor();
+    /**
+     * Creates a CompanyMembership instance from the required data.
+     *
+     * @param data - The membership data
+     * @returns A new CompanyMembership instance, or undefined if invalid
+     *
+     * @example
+     * ```typescript
+     * const membership = CompanyMembership.from({
+     *   companyProfile: profile,
+     *   role: role // optional
+     * });
+     * ```
+     */
+    static from(data: CompanyMembershipData): CompanyMembership | undefined;
+    /**
+     * Gets the company profile.
+     */
+    get companyProfile(): Profile;
+    /**
+     * Gets the user's role (may be undefined if user lacks permission to view it).
+     */
+    get role(): Role | undefined;
+    /**
+     * Converts the membership to a plain object.
+     */
+    toObject(): {
+        companyProfile: ReturnType<Profile['toObject']>;
+        role?: ReturnType<Role['toJSON']>;
+    };
+    /**
+     * Converts the membership to a JSON string.
+     */
+    toJson(): string;
+}

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

@@ -0,0 +1,4 @@
+export * from "./auth.manager.js";
+export * from "./auth.repository.js";
+export * from "./user.model.js";
+export * from "./company-membership.model.js";

package/dist/{features → modules}/auth/storage/client-store.d.ts

@@ -1,6 +1,6 @@
 import { type StoreApi, type UseBoundStore } from "zustand";
 import type { AuthStore } from "./types.js";
-import { User } from "@/models/user.model.js";
+import { User } from "@/modules/auth/user.model.js";
 /** Type definition for the store's state */
 type State = {
     user: string | undefined;

package/dist/{features → modules}/auth/storage/types.d.ts

@@ -1,4 +1,4 @@
-import type { User } from "@/models/user.model";
+import { User } from "../user.model.js";
 /**
  * Interface defining the contract for auth storage implementations.
  * This allows for different storage strategies in different environments.

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

@@ -0,0 +1,140 @@
+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";
+export interface 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;
+    /**
+     * Creates a User instance from a JSON string.
+     *
+     * @param jsonString - JSON string containing user data
+     * @returns A new User instance, or undefined if parsing failed
+     */
+    static fromJson(jsonString: string): 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;
+    /**
+     * Converts the User instance to a plain object.
+     *
+     * @returns A plain object representation suitable for serialization
+     */
+    toObject(): Record<string, any>;
+    /**
+     * Converts the User instance to a JSON string.
+     *
+     * @returns A JSON string representation
+     */
+    toJson(): string;
+}

package/dist/{models → modules/contact}/contact-info.model.d.ts

@@ -1,5 +1,5 @@
-import { ContactType, ContactDTO } from "@/features/contact/contact.dtos.js";
-import { PayoutDTO } from "@/features/payout/payout.dtos.js";
+import { ContactType, ContactDTO } from "@/modules/contact/contact.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";
 /**

package/dist/{features → modules}/contact/contact-input-handler.d.ts

@@ -1,4 +1,4 @@
-import { ContactInfo } from "@/models/contact-info.model.js";
+import { ContactInfo } from "@/modules/contact/contact-info.model.js";
 import { ContactInputDTO } from "./contact.dtos.js";
 /**
  * Factory for resolving and validating a raw `ContactInput` into a typed and valid version.

package/dist/{models → modules/contact}/contact.model.d.ts

@@ -1,4 +1,4 @@
-import { ContactDTO, ContactType } from "@/features/contact/contact.dtos.js";
+import { ContactDTO, ContactType } from "@/modules/contact/contact.dtos.js";
 import { ContactInfo } from "./contact-info.model.js";
 /**
  * Contact class that wraps the Zod schema and provides additional functionality

package/dist/{features → modules}/contact/contact.repository.d.ts

@@ -1,6 +1,6 @@
 import { BaseRepository } from "@/lib/api/base-repository.js";
-import { ContactInfo } from "@/models/contact-info.model.js";
-import { Contact } from "@/models/contact.model.js";
+import { ContactInfo } from "@/modules/contact/contact-info.model.js";
+import { Contact } from "@/modules/contact/contact.model.js";
 import { contract } from "./contact.api-contract.js";
 /**
  * Repository class for managing Contact data through API interactions.

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

@@ -0,0 +1,4 @@
+export * from "./contact.repository.js";
+export * from "./contact.dtos.js";
+export * from "./contact-info.model.js";
+export * from "./contact.model.js";

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

@@ -0,0 +1,4 @@
+export * from "./login.dtos.js";
+export * from "./login.model.js";
+export * from "./login.repository.js";
+export * from "./permission.type.js";

package/dist/modules/login/login.api-contract.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Identity API contract
+ */
+export declare const identityContract: {
+    getUserCredentials: {
+        method: "GET";
+        path: "/me";
+        responses: {
+            200: import("zod").ZodObject<{
+                id: import("zod").ZodString;
+                profileId: import("zod").ZodString;
+                name: import("zod").ZodString;
+                identity: import("zod").ZodString;
+                type: import("zod").ZodString;
+                roleId: import("zod").ZodString;
+                isActive: import("zod").ZodBoolean;
+                isArchived: import("zod").ZodBoolean;
+                resetPassword: import("zod").ZodBoolean;
+                createdAt: import("zod").ZodString;
+                updatedAt: import("zod").ZodString;
+                access: import("zod").ZodArray<import("zod").ZodString, "many">;
+            }, "strip", import("zod").ZodTypeAny, {
+                type: string;
+                name: string;
+                id: string;
+                profileId: string;
+                identity: string;
+                roleId: string;
+                isActive: boolean;
+                isArchived: boolean;
+                resetPassword: boolean;
+                createdAt: string;
+                updatedAt: string;
+                access: string[];
+            }, {
+                type: string;
+                name: string;
+                id: string;
+                profileId: string;
+                identity: string;
+                roleId: string;
+                isActive: boolean;
+                isArchived: boolean;
+                resetPassword: boolean;
+                createdAt: string;
+                updatedAt: string;
+                access: string[];
+            }>;
+        };
+    };
+};

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

@@ -0,0 +1,85 @@
+import z from "zod";
+declare const LogInDTOSchema: 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">;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    name: string;
+    id: string;
+    profileId: string;
+    identity: string;
+    roleId: string;
+    isActive: boolean;
+    isArchived: boolean;
+    resetPassword: boolean;
+    createdAt: string;
+    updatedAt: string;
+    access: string[];
+}, {
+    type: string;
+    name: string;
+    id: string;
+    profileId: string;
+    identity: string;
+    roleId: string;
+    isActive: boolean;
+    isArchived: boolean;
+    resetPassword: boolean;
+    createdAt: string;
+    updatedAt: string;
+    access: string[];
+}>;
+export declare const LogInSchemas: {
+    loginDTO: 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">;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        name: string;
+        id: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+    }, {
+        type: string;
+        name: string;
+        id: string;
+        profileId: string;
+        identity: string;
+        roleId: string;
+        isActive: boolean;
+        isArchived: boolean;
+        resetPassword: boolean;
+        createdAt: string;
+        updatedAt: string;
+        access: string[];
+    }>;
+};
+export type LogInDTO = z.infer<typeof LogInDTOSchema>;
+export {};