@temboplus/afloat 0.2.0-beta.1 → 0.2.0-beta.11

package/dist/lib/api/base-repository.d.ts

@@ -6,24 +6,24 @@ export declare const setGlobalTokenGetter: (getter: TokenGetter) => void;
  * BaseRepository - Generic base class for API repositories
  *
  * Provides a consistent way to interact with the Afloat API using ts-rest contracts.
- * Handles authentication token management through multiple fallback mechanisms.
+ * Handles authentication token management through explicit repository options
+ * or a host-provided global token getter.
  *
  * **Token Resolution Order:**
  * 1. Direct token provided in constructor
- * 2. Global authentication state via getCurrentToken()
+ * 2. Global token getter configured by the host app
  *
  * @template TContract - The API contract extending `AppRouter` from `@ts-rest/core`
  *
  * @example
  * ```typescript
- * // Usage 1: Direct token usage (Recommended for server-side usage)
+ * // Recommended authenticated usage
  * const repo = new WalletRepository("wallet", walletContract, {
  *   token: "user-auth-token"
  * });
  *
- * // Usage 2: Global auth state (Recommended for client-side usage)
- * // Token automatically retrieved from AfloatAuth.instance
- * const repo = new WalletRepository("wallet", walletContract);
+ * // Advanced: the host app may also provide a global token getter,
+ * // but explicit tokens are the recommended integration path.
  * ```
  */
 export declare class BaseRepository<TContract extends AppRouter> {
@@ -64,8 +64,8 @@ export declare class BaseRepository<TContract extends AppRouter> {
      *   root: "https://api-staging.afloat.money/v1"
      * });
      *
-     * // Client-side using global auth state
-     * const repo = new WalletRepository("wallet", walletContract);
+     * // Advanced global token getter fallback is supported,
+     * // but explicit tokens are the recommended integration path.
      * ```
      */
     constructor(endpoint: string, contract: TContract, options?: {

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

@@ -64,7 +64,12 @@ export declare class QueryBuilder {
      */
     countAs(expression: string, alias: string): this;
     /**
-     * @returns an objection-find query
+     * Build the query into an objection-find compatible object.
+     *
+     * Pagination (rangeStart/rangeEnd) is only included if both `page` and `limit`
+     * have been explicitly set via `.paginate()` or in the constructor options.
+     *
+     * @returns An objection-find query object
      */
     build(): Record<string, any>;
     /**

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

@@ -1,15 +1,14 @@
-import { z } from "zod";
 /**
  * Auth API contract
  */
 export declare const authContract: {
     logIn: {
         method: "POST";
-        body: z.ZodObject<{
-            type: z.ZodDefault<z.ZodString>;
-            identity: z.ZodString;
-            password: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
+        body: import("zod").ZodObject<{
+            type: import("zod").ZodDefault<import("zod").ZodString>;
+            identity: import("zod").ZodString;
+            password: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
             type: string;
             identity: string;
             password: string;
@@ -20,17 +19,17 @@ export declare const authContract: {
         }>;
         path: "/login";
         responses: {
-            201: z.ZodObject<{
-                profile: 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>>;
-                }, "strip", z.ZodTypeAny, {
+            201: import("zod").ZodObject<{
+                profile: import("zod").ZodObject<{
+                    id: import("zod").ZodString;
+                    firstName: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+                    lastName: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+                    displayName: import("zod").ZodString;
+                    phone: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+                    accountNo: import("zod").ZodString;
+                    email: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodString>>;
+                    autoApprove: import("zod").ZodOptional<import("zod").ZodNullable<import("zod").ZodBoolean>>;
+                }, "strip", import("zod").ZodTypeAny, {
                     id: string;
                     displayName: string;
                     accountNo: string;
@@ -49,10 +48,10 @@ export declare const authContract: {
                     email?: string | null | undefined;
                     autoApprove?: boolean | null | undefined;
                 }>;
-                token: z.ZodString;
-                access: z.ZodArray<z.ZodString, "many">;
-                resetPassword: z.ZodBoolean;
-            }, "strip", z.ZodTypeAny, {
+                token: import("zod").ZodString;
+                access: import("zod").ZodArray<import("zod").ZodString, "many">;
+                resetPassword: import("zod").ZodBoolean;
+            }, "strip", import("zod").ZodTypeAny, {
                 token: string;
                 resetPassword: boolean;
                 access: string[];
@@ -81,22 +80,22 @@ export declare const authContract: {
                     autoApprove?: boolean | null | undefined;
                 };
             }>;
-            400: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+            400: import("zod").ZodObject<{}, "strip", import("zod").ZodTypeAny, {}, {}>;
         };
     };
     access: {
         method: "GET";
         path: "/access";
         responses: {
-            200: z.ZodArray<z.ZodString, "many">;
+            200: import("zod").ZodArray<import("zod").ZodString, "many">;
         };
     };
     resetPassword: {
         method: "PUT";
-        body: z.ZodObject<{
-            currentPassword: z.ZodString;
-            newPassword: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
+        body: import("zod").ZodObject<{
+            currentPassword: import("zod").ZodString;
+            newPassword: import("zod").ZodString;
+        }, "strip", import("zod").ZodTypeAny, {
             newPassword: string;
             currentPassword: string;
         }, {
@@ -104,6 +103,9 @@ export declare const authContract: {
             currentPassword: string;
         }>;
         path: "/password";
-        responses: {};
+        responses: {
+            200: import("zod").ZodObject<{}, "strip", import("zod").ZodTypeAny, {}, {}>;
+            400: import("zod").ZodObject<{}, "strip", import("zod").ZodTypeAny, {}, {}>;
+        };
     };
 };

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

@@ -0,0 +1,117 @@
+import { z } from "zod";
+/**
+ * Collection of all auth-related schemas.
+ */
+export declare const AuthDTOSchemas: {
+    /** Schema for login request validation */
+    logInRequestDTO: z.ZodObject<{
+        type: z.ZodDefault<z.ZodString>;
+        identity: z.ZodString;
+        password: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: string;
+        identity: string;
+        password: string;
+    }, {
+        identity: string;
+        password: string;
+        type?: string | undefined;
+    }>;
+    /** Schema for successful login responses */
+    logInResponseDTO: z.ZodObject<{
+        profile: 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>>;
+        }, "strip", z.ZodTypeAny, {
+            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;
+        }, {
+            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;
+        }>;
+        token: z.ZodString;
+        access: z.ZodArray<z.ZodString, "many">;
+        resetPassword: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        token: string;
+        resetPassword: boolean;
+        access: string[];
+        profile: {
+            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;
+        };
+    }, {
+        token: string;
+        resetPassword: boolean;
+        access: string[];
+        profile: {
+            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;
+        };
+    }>;
+    /** Schema for access list responses */
+    accessResponseDTO: z.ZodArray<z.ZodString, "many">;
+    /** Schema for reset password request validation */
+    resetPasswordRequestDTO: z.ZodObject<{
+        currentPassword: z.ZodString;
+        newPassword: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        newPassword: string;
+        currentPassword: string;
+    }, {
+        newPassword: string;
+        currentPassword: string;
+    }>;
+    /** Schema for empty responses */
+    emptyResponseDTO: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
+};
+/**
+ * Type representing the login request payload.
+ */
+export type AuthLogInRequestDTO = z.infer<typeof AuthDTOSchemas.logInRequestDTO>;
+/**
+ * Type representing a successful login response.
+ */
+export type AuthLogInResponseDTO = z.infer<typeof AuthDTOSchemas.logInResponseDTO>;
+/**
+ * Type representing the access list response.
+ */
+export type AuthAccessResponseDTO = z.infer<typeof AuthDTOSchemas.accessResponseDTO>;
+/**
+ * Type representing the reset password request payload.
+ */
+export type AuthResetPasswordRequestDTO = z.infer<typeof AuthDTOSchemas.resetPasswordRequestDTO>;
+/**
+ * Type representing an empty auth response.
+ */
+export type AuthEmptyResponseDTO = z.infer<typeof AuthDTOSchemas.emptyResponseDTO>;

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

@@ -1,6 +1,10 @@
 import { BaseRepository } from "@/lib/api/base-repository.js";
 import { User } from "@/modules/auth/user.model.js";
 import { authContract } from "./auth.contract.js";
+export type AuthLogInResult = {
+    token: string;
+    user: User;
+};
 /**
  * Repository class for handling authentication-related operations.
  * Provides methods for user login and password management.
@@ -10,7 +14,7 @@ import { authContract } from "./auth.contract.js";
  * @example
  * ```typescript
  * const authRepo = new AuthRepository();
- * const user = await authRepo.logIn("user@example.com", "password");
+ * const { token, user } = await authRepo.logIn("user@example.com", "password");
  * ```
  */
 export declare class AuthRepository extends BaseRepository<typeof authContract> {
@@ -30,20 +34,21 @@ export declare class AuthRepository extends BaseRepository<typeof authContract>
      *
      * @param email - The email of the user attempting to log in
      * @param password - The password of the user
-     * @returns Promise that resolves to a User object on successful login
+     * @returns Promise that resolves to the auth token and User object on successful login
      * @throws {APIError} If the email or password is invalid, or if another error occurs during login
      *
      * @example
      * ```typescript
      * try {
-     *   const user = await authRepo.logIn("user@example.com", "securePassword");
+     *   const { token, user } = await authRepo.logIn("user@example.com", "securePassword");
+     *   tokenStore.set(token);
      *   console.log(`Welcome ${user.name}!`);
      * } catch (error) {
      *   console.error("Login failed:", error.message);
      * }
      * ```
      */
-    logIn(email: string, password: string): Promise<User>;
+    logIn(email: string, password: string): Promise<AuthLogInResult>;
     /**
      * Updates the current user's password.
      *

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

@@ -14,12 +14,12 @@ export declare const CompanyMembershipJSONSchema: z.ZodObject<{
         accountNo: z.ZodString;
         email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         autoApprove: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
         id: string;
         displayName: string;
         accountNo: string;
-        version: string;
+        _version: string;
         firstName?: string | null | undefined;
         lastName?: string | null | undefined;
         phone?: string | null | undefined;
@@ -34,7 +34,7 @@ export declare const CompanyMembershipJSONSchema: z.ZodObject<{
         phone?: string | null | undefined;
         email?: string | null | undefined;
         autoApprove?: boolean | null | undefined;
-        version?: string | undefined;
+        _version?: string | undefined;
     }>;
     role: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
@@ -43,12 +43,12 @@ export declare const CompanyMembershipJSONSchema: z.ZodObject<{
         access: z.ZodArray<z.ZodString, "many">;
         createdAt: z.ZodString;
         updatedAt: z.ZodString;
-        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
         name: string;
         createdAt: string;
         id: string;
-        version: string;
+        _version: string;
         updatedAt: string;
         access: string[];
         description?: string | undefined;
@@ -58,17 +58,17 @@ export declare const CompanyMembershipJSONSchema: z.ZodObject<{
         id: string;
         updatedAt: string;
         access: string[];
-        version?: string | undefined;
+        _version?: string | undefined;
         description?: string | undefined;
     }>>;
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    version: string;
+    _version: string;
     companyProfile: {
         id: string;
         displayName: string;
         accountNo: string;
-        version: string;
+        _version: string;
         firstName?: string | null | undefined;
         lastName?: string | null | undefined;
         phone?: string | null | undefined;
@@ -79,7 +79,7 @@ export declare const CompanyMembershipJSONSchema: z.ZodObject<{
         name: string;
         createdAt: string;
         id: string;
-        version: string;
+        _version: string;
         updatedAt: string;
         access: string[];
         description?: string | undefined;
@@ -94,16 +94,16 @@ export declare const CompanyMembershipJSONSchema: z.ZodObject<{
         phone?: string | null | undefined;
         email?: string | null | undefined;
         autoApprove?: boolean | null | undefined;
-        version?: string | undefined;
+        _version?: string | undefined;
     };
-    version?: string | undefined;
+    _version?: string | undefined;
     role?: {
         name: string;
         createdAt: string;
         id: string;
         updatedAt: string;
         access: string[];
-        version?: string | undefined;
+        _version?: string | undefined;
         description?: string | undefined;
     } | undefined;
 }>;

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

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

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

@@ -22,13 +22,13 @@ export declare const UserJSONSchema: z.ZodObject<{
         createdAt: z.ZodString;
         updatedAt: z.ZodString;
         access: z.ZodArray<z.ZodString, "many">;
-        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
         type: string;
         name: string;
         createdAt: string;
         id: string;
-        version: string;
+        _version: string;
         profileId: string;
         identity: string;
         roleId: string;
@@ -50,7 +50,7 @@ export declare const UserJSONSchema: z.ZodObject<{
         resetPassword: boolean;
         updatedAt: string;
         access: string[];
-        version?: string | undefined;
+        _version?: string | undefined;
     }>;
     companyProfile: z.ZodObject<{
         id: z.ZodString;
@@ -61,12 +61,12 @@ export declare const UserJSONSchema: z.ZodObject<{
         accountNo: z.ZodString;
         email: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         autoApprove: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
-        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
         id: string;
         displayName: string;
         accountNo: string;
-        version: string;
+        _version: string;
         firstName?: string | null | undefined;
         lastName?: string | null | undefined;
         phone?: string | null | undefined;
@@ -81,7 +81,7 @@ export declare const UserJSONSchema: z.ZodObject<{
         phone?: string | null | undefined;
         email?: string | null | undefined;
         autoApprove?: boolean | null | undefined;
-        version?: string | undefined;
+        _version?: string | undefined;
     }>;
     role: z.ZodOptional<z.ZodObject<{
         id: z.ZodString;
@@ -90,12 +90,12 @@ export declare const UserJSONSchema: z.ZodObject<{
         access: z.ZodArray<z.ZodString, "many">;
         createdAt: z.ZodString;
         updatedAt: z.ZodString;
-        version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     }, "strip", z.ZodTypeAny, {
         name: string;
         createdAt: string;
         id: string;
-        version: string;
+        _version: string;
         updatedAt: string;
         access: string[];
         description?: string | undefined;
@@ -105,19 +105,17 @@ export declare const UserJSONSchema: z.ZodObject<{
         id: string;
         updatedAt: string;
         access: string[];
-        version?: string | undefined;
+        _version?: string | undefined;
         description?: string | undefined;
     }>>;
-    token: z.ZodString;
-    version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    _version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
-    token: string;
-    version: string;
+    _version: string;
     companyProfile: {
         id: string;
         displayName: string;
         accountNo: string;
-        version: string;
+        _version: string;
         firstName?: string | null | undefined;
         lastName?: string | null | undefined;
         phone?: string | null | undefined;
@@ -129,7 +127,7 @@ export declare const UserJSONSchema: z.ZodObject<{
         name: string;
         createdAt: string;
         id: string;
-        version: string;
+        _version: string;
         profileId: string;
         identity: string;
         roleId: string;
@@ -143,13 +141,12 @@ export declare const UserJSONSchema: z.ZodObject<{
         name: string;
         createdAt: string;
         id: string;
-        version: string;
+        _version: string;
         updatedAt: string;
         access: string[];
         description?: string | undefined;
     } | undefined;
 }, {
-    token: string;
     companyProfile: {
         id: string;
         displayName: string;
@@ -159,7 +156,7 @@ export declare const UserJSONSchema: z.ZodObject<{
         phone?: string | null | undefined;
         email?: string | null | undefined;
         autoApprove?: boolean | null | undefined;
-        version?: string | undefined;
+        _version?: string | undefined;
     };
     logIn: {
         type: string;
@@ -174,16 +171,16 @@ export declare const UserJSONSchema: z.ZodObject<{
         resetPassword: boolean;
         updatedAt: string;
         access: string[];
-        version?: string | undefined;
+        _version?: string | undefined;
     };
-    version?: string | undefined;
+    _version?: string | undefined;
     role?: {
         name: string;
         createdAt: string;
         id: string;
         updatedAt: string;
         access: string[];
-        version?: string | undefined;
+        _version?: string | undefined;
         description?: string | undefined;
     } | undefined;
 }>;
@@ -195,17 +192,15 @@ export type UserData = {
     logIn: LogIn;
     companyProfile: Profile;
     role?: Role;
-    token: string;
 };
 /**
- * Represents the currently authenticated user session.
+ * Represents the currently authenticated user context.
  *
  * 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.
+ * The User represents "who is logged in right now" with their full profile context.
  *
  * Note: The role in CompanyMembership may be undefined if the user doesn't have
  * permission to view role details (Permissions.Role.ViewRole).
@@ -213,7 +208,6 @@ export type UserData = {
 export declare class User {
     private readonly _logIn;
     private readonly _membership;
-    private readonly _token;
     private readonly _permissionMap;
     private constructor();
     /**
@@ -228,7 +222,6 @@ export declare class User {
      *   logIn: logIn,
      *   companyProfile: profile,
      *   role: role, // optional
-     *   token: "auth-token"
      * });
      * ```
      */
@@ -241,10 +234,6 @@ export declare class User {
      * 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.
      */
@@ -310,8 +299,8 @@ export declare class User {
    * 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.
+   * all nested objects (LogIn, Profile, Role). Authentication tokens are kept
+   * outside of the User model and are not serialized here.
    *
    * @returns {UserJSON} A plain object containing all necessary User data
    *
@@ -349,8 +338,7 @@ export declare class User {
      * // From object
      * const userJson = {
      *   logIn: { id: "...", ... },
-     *   companyProfile: { id: "...", ... },
-     *   token: "..."
+     *   companyProfile: { id: "...", ... }
      * };
      * const user = User.fromJSON(userJson);
      * ```