cocobase 1.3.5 → 1.5.0

package/dist/cjs/core/auth.d.ts

@@ -1,4 +1,5 @@
-import { CocobaseConfig, AppUser, AppUserList, Query, AuthCallbacks } from "../types/types.js";
+import { CocobaseConfig, AppUser, AppUserList, Query, AuthCallbacks, Response, LoginResult } from "../types/types.js";
+import { RegisterParams, RegisterWithFilesParams, LoginParams, UpdateUserParams, UpdateUserWithFilesParams, GoogleLoginParams, GithubLoginParams, Verify2FAParams } from "../types/params.js";
 /**
  * Authentication handler for Cocobase client.
  *
@@ -15,7 +16,7 @@ export declare class AuthHandler {
     private baseURL;
     private apiKey?;
     private token?;
-    private user?;
+    user?: AppUser;
     private callbacks;
     /**
      * Creates a new AuthHandler instance.
@@ -135,34 +136,50 @@ export declare class AuthHandler {
     /**
      * Authenticates a user with email and password.
      *
-     * @param email - User's email address
-     * @param password - User's password
-     * @returns Promise that resolves when login is complete
+     * @param params - Login parameters
+     * @returns Promise resolving to LoginResult indicating success or 2FA requirement
      *
      * @example
      * ```typescript
-     * await db.auth.login('user@example.com', 'password123');
-     * console.log('Logged in as:', db.auth.getUser()?.email);
+     * const result = await db.auth.login({
+     *   email: 'user@example.com',
+     *   password: 'password123'
+     * });
+     *
+     * if (result.requires_2fa) {
+     *   // Show 2FA input form to user
+     *   console.log(result.message); // "2FA code sent to your email"
+     *   // Later, call verify2FALogin with the code
+     * } else {
+     *   // Login successful
+     *   console.log('Logged in as:', result.user?.email);
+     * }
      * ```
      */
-    login(email: string, password: string): Promise<void>;
+    login(params: LoginParams): Promise<LoginResult>;
     /**
      * Registers a new user with email, password, and optional additional data.
      *
-     * @param email - User's email address
-     * @param password - User's password
-     * @param data - Optional additional user data
-     * @returns Promise that resolves when registration is complete
+     * @param params - Registration parameters
+     * @returns Promise resolving to LoginResult (registration may require 2FA if enabled)
      *
      * @example
      * ```typescript
-     * await db.auth.register('user@example.com', 'password123', {
-     *   username: 'johndoe',
-     *   fullName: 'John Doe'
+     * const result = await db.auth.register({
+     *   email: 'user@example.com',
+     *   password: 'password123',
+     *   data: { username: 'johndoe', fullName: 'John Doe' },
+     *   roles: ['user'] // optional, if allowed by project config
      * });
+     *
+     * if (result.requires_2fa) {
+     *   // Handle 2FA verification
+     * } else {
+     *   console.log('Registered as:', result.user?.email);
+     * }
      * ```
      */
-    register(email: string, password: string, data?: Record<string, any>): Promise<void>;
+    register(params: RegisterParams): Promise<LoginResult>;
     /**
      * Authenticates a user using Google Sign-In with ID token.
      *
@@ -190,10 +207,10 @@ export declare class AuthHandler {
      * });
      *
      * // Mobile - After getting ID token from Google Sign-In SDK
-     * const user = await db.auth.loginWithGoogle(idToken, 'mobile');
+     * const user = await db.auth.loginWithGoogle({ idToken, platform: 'mobile' });
      * ```
      */
-    loginWithGoogle(idToken: string, platform?: "web" | "mobile" | "ios" | "android"): Promise<AppUser>;
+    loginWithGoogle(params: GoogleLoginParams): Promise<AppUser>;
     /**
      * Authenticates a user using GitHub OAuth with authorization code.
      *
@@ -231,35 +248,32 @@ export declare class AuthHandler {
      * }
      * ```
      */
-    loginWithGithub(code: string, redirectUri: string, platform?: "web" | "mobile" | "ios" | "android"): Promise<AppUser>;
+    loginWithGithub(params: GithubLoginParams): Promise<AppUser>;
     /**
      * Register a new user with file uploads (avatar, cover photo, etc.)
      *
-     * @param email - User email
-     * @param password - User password
-     * @param data - Additional user data (optional)
-     * @param files - Object mapping field names to File objects (optional)
+     * @param params - Registration parameters with files
      *
      * @example
      * ```typescript
      * // Register with avatar
-     * await db.auth.registerWithFiles(
-     *   'john@example.com',
-     *   'password123',
-     *   { username: 'johndoe', full_name: 'John Doe' },
-     *   { avatar: avatarFile }
-     * );
+     * await db.auth.registerWithFiles({
+     *   email: 'john@example.com',
+     *   password: 'password123',
+     *   data: { username: 'johndoe', full_name: 'John Doe' },
+     *   files: { avatar: avatarFile }
+     * });
      *
      * // Register with avatar and cover photo
-     * await db.auth.registerWithFiles(
-     *   'john@example.com',
-     *   'password123',
-     *   { username: 'johndoe' },
-     *   { avatar: avatarFile, cover_photo: coverFile }
-     * );
+     * await db.auth.registerWithFiles({
+     *   email: 'john@example.com',
+     *   password: 'password123',
+     *   data: { username: 'johndoe' },
+     *   files: { avatar: avatarFile, cover_photo: coverFile }
+     * });
      * ```
      */
-    registerWithFiles(email: string, password: string, data?: Record<string, any>, files?: Record<string, File | File[]>): Promise<AppUser>;
+    registerWithFiles(params: RegisterWithFilesParams): Promise<LoginResult>;
     /**
      * Logs out the current user by clearing the token and user data.
      *
@@ -298,53 +312,50 @@ export declare class AuthHandler {
     /**
      * Updates the current user's profile data.
      *
-     * @param data - User data to update (optional)
-     * @param email - New email address (optional)
-     * @param password - New password (optional)
+     * @param params - Update parameters
      * @returns Promise resolving to the updated user object
      *
      * @example
      * ```typescript
      * await db.auth.updateUser({
-     *   bio: 'Updated bio',
-     *   website: 'https://example.com'
+     *   data: { bio: 'Updated bio', website: 'https://example.com' }
      * });
+     *
+     * // Update email
+     * await db.auth.updateUser({ email: 'newemail@example.com' });
+     *
+     * // Update password
+     * await db.auth.updateUser({ password: 'newpassword123' });
      * ```
      */
-    updateUser(data?: Record<string, any> | null, email?: string | null, password?: string | null): Promise<AppUser>;
+    updateUser(params: UpdateUserParams): Promise<AppUser>;
     /**
      * Update current user with file uploads
      *
-     * @param data - User data to update (optional)
-     * @param email - New email (optional)
-     * @param password - New password (optional)
-     * @param files - Object mapping field names to File objects (optional)
+     * @param params - Update parameters with files
      *
      * @example
      * ```typescript
      * // Update only avatar
-     * await db.auth.updateUserWithFiles(
-     *   undefined, undefined, undefined,
-     *   { avatar: newAvatarFile }
-     * );
+     * await db.auth.updateUserWithFiles({
+     *   files: { avatar: newAvatarFile }
+     * });
      *
      * // Update bio and avatar
-     * await db.auth.updateUserWithFiles(
-     *   { bio: 'Updated bio' },
-     *   undefined, undefined,
-     *   { avatar: newAvatarFile }
-     * );
+     * await db.auth.updateUserWithFiles({
+     *   data: { bio: 'Updated bio' },
+     *   files: { avatar: newAvatarFile }
+     * });
      *
      * // Update multiple fields and files
-     * await db.auth.updateUserWithFiles(
-     *   { username: 'newusername', bio: 'New bio' },
-     *   'newemail@example.com',
-     *   undefined,
-     *   { avatar: newAvatar, cover_photo: newCover }
-     * );
+     * await db.auth.updateUserWithFiles({
+     *   data: { username: 'newusername', bio: 'New bio' },
+     *   email: 'newemail@example.com',
+     *   files: { avatar: newAvatar, cover_photo: newCover }
+     * });
      * ```
      */
-    updateUserWithFiles(data?: Record<string, any> | null, email?: string | null, password?: string | null, files?: Record<string, File | File[]>): Promise<AppUser>;
+    updateUserWithFiles(params: UpdateUserWithFilesParams): Promise<AppUser>;
     /**
      * Checks if the current user has a specific role.
      *
@@ -389,6 +400,98 @@ export declare class AuthHandler {
      * ```
      */
     getUserById<T = any>(userId: string): Promise<AppUser>;
+    /**
+     * Enables Two-Factor Authentication (2FA) for the current user.
+     *
+     * @returns Promise that resolves when 2FA is enabled
+     *
+     * @example
+     * ```typescript
+     * await db.auth.enable2FA();
+     * console.log('2FA enabled for user');
+     * ```
+     */
+    enable2FA(): Promise<void>;
+    /**
+     * Disables Two-Factor Authentication (2FA) for the current user.
+     *
+     * @returns Promise that resolves when 2FA is disabled
+     *
+     * @example
+     * ```typescript
+     * await db.auth.disable2FA();
+     * console.log('2FA disabled for user');
+     * ```
+     */
+    disable2FA(): Promise<void>;
+    /**
+     * Sends a Two-Factor Authentication (2FA) code to the user's registered method (e.g., email, SMS).
+     *
+     * @returns Promise that resolves when the 2FA code is sent
+     *
+     * @example
+     * ```typescript
+     * await db.auth.send2FACode();
+     * console.log('2FA code sent to user');
+     * ```
+     */
+    send2FACode(email: string): Promise<void>;
+    /**
+     * Completes login after 2FA verification.
+     * Call this after login() returns requires_2fa: true and the user provides the 2FA code.
+     *
+     * @param params - 2FA verification parameters
+     * @returns Promise resolving to the authenticated user
+     *
+     * @example
+     * ```typescript
+     * // First, attempt login
+     * const result = await db.auth.login({ email: 'user@example.com', password: 'password123' });
+     *
+     * if (result.requires_2fa) {
+     *   // User enters the 2FA code they received
+     *   const user = await db.auth.verify2FALogin({ email: 'user@example.com', code: '123456' });
+     *   console.log('Logged in as:', user.email);
+     * }
+     * ```
+     */
+    verify2FALogin(params: Verify2FAParams): Promise<AppUser>;
+    /**
+     * Requests an email verification to be sent to the user's email address.
+     *
+     * @returns Promise that resolves when the verification email is requested
+     *
+     * @example
+     * ```typescript
+     * await db.auth.requestEmailVerification();
+     * console.log('Verification email requested');
+     * ```
+     */
+    requestEmailVerification(): Promise<Response>;
+    /**
+     * Verifies the user's email using the provided token.
+     *
+     * @param token - Verification token
+     * @returns Promise that resolves when the email is verified
+     *
+     * @example
+     * ```typescript
+     * await db.auth.verifyEmail('verification-token');
+     * console.log('Email verified');
+     * ```
+     */
+    verifyEmail(token: string): Promise<Response>;
+    /**   * Resends the email verification to the user's email address.
+     *
+     * @returns Promise that resolves when the verification email is resent
+     *
+     * @example
+     * ```typescript
+     * await db.auth.resendVerificationEmail();
+     * console.log('Verification email resent');
+     * ```
+     */
+    resendVerificationEmail(): Promise<void>;
 }
 export default AuthHandler;
 //# sourceMappingURL=auth.d.ts.map

package/dist/cjs/core/auth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../../src/core/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAEd,OAAO,EACP,WAAW,EACX,KAAK,EAEL,aAAa,EACd,MAAM,mBAAmB,CAAC;AAQ3B;;;;;;;;;;;GAWG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,KAAK,CAAC,CAAS;IACvB,OAAO,CAAC,IAAI,CAAC,CAAU;IACvB,OAAO,CAAC,SAAS,CAAqB;IAEtC;;;;OAIG;gBACS,MAAM,EAAE,cAAc;IAKlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,WAAW,CAAC,SAAS,EAAE,aAAa,GAAG,IAAI;IAI3C;;OAEG;IACH,kBAAkB,IAAI,IAAI;IAI1B;;;;OAIG;IACH,QAAQ,IAAI,MAAM,GAAG,SAAS;IAI9B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM;IAMtB;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,OAAO;IAKrB;;;;OAIG;IACH,OAAO,IAAI,OAAO,GAAG,SAAS;IAI9B;;;;;;;;;OASG;YACW,OAAO;IAsDrB;;;;;;;OAOG;IACH,OAAO,CAAC,kBAAkB;IAiB1B;;;;;;;;;;;OAWG;IACG,QAAQ;IAmBd;;;;;;;;;;;;OAYG;IACG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAqB3C;;;;;;;;;;;;;;;OAeG;IACG,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAqB1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,eAAe,CACnB,OAAO,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,GAC9C,OAAO,CAAC,OAAO,CAAC;IAqBnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACG,eAAe,CACnB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,KAAK,GAAG,SAAS,GAC9C,OAAO,CAAC,OAAO,CAAC;IAqBnB;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACG,iBAAiB,CACrB,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,MAAM,EAChB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC1B,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,GACpC,OAAO,CAAC,OAAO,CAAC;IA4CnB;;;;;;;;OAQG;IACH,MAAM;IAeN;;;;;;;;;;;OAWG;IACH,eAAe,IAAI,OAAO;IAI1B;;;;;;;;;;OAUG;IACG,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAaxC;;;;;;;;;;;;;;;OAeG;IACG,UAAU,CACd,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,EACjC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,GACvB,OAAO,CAAC,OAAO,CAAC;IA2BnB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACG,mBAAmB,CACvB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,EACjC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,EACxB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,GAAG,IAAI,EAAE,CAAC,GACpC,OAAO,CAAC,OAAO,CAAC;IAuDnB;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAO9B;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC;IAOvD;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;CAGvD;AAED,eAAe,WAAW,CAAC"}
+{"version":3,"file":"auth.d.ts","sourceRoot":"","sources":["../../../src/core/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EAEd,OAAO,EACP,WAAW,EACX,KAAK,EAEL,aAAa,EACb,QAAQ,EACR,WAAW,EAEZ,MAAM,mBAAmB,CAAC;AAQ3B,OAAO,EACL,cAAc,EACd,uBAAuB,EACvB,WAAW,EACX,gBAAgB,EAChB,yBAAyB,EACzB,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EAChB,MAAM,oBAAoB,CAAC;AAC5B;;;;;;;;;;;GAWG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,KAAK,CAAC,CAAS;IACtB,IAAI,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,SAAS,CAAqB;IAEtC;;;;OAIG;gBACS,MAAM,EAAE,cAAc;IAKlC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACH,WAAW,CAAC,SAAS,EAAE,aAAa,GAAG,IAAI;IAI3C;;OAEG;IACH,kBAAkB,IAAI,IAAI;IAI1B;;;;OAIG;IACH,QAAQ,IAAI,MAAM,GAAG,SAAS;IAI9B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM;IAMtB;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,OAAO;IAKrB;;;;OAIG;IACH,OAAO,IAAI,OAAO,GAAG,SAAS;IAI9B;;;;;;;;;OASG;YACW,OAAO;IAoDrB;;;;;;;OAOG;IACH,OAAO,CAAC,kBAAkB;IAiB1B;;;;;;;;;;;OAWG;IACG,QAAQ;IAmBd;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,KAAK,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;IAqCtD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;IAoC5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,eAAe,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBlE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACG,eAAe,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBlE;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,WAAW,CAAC;IAyD9E;;;;;;;;OAQG;IACH,MAAM;IAeN;;;;;;;;;;;OAWG;IACH,eAAe,IAAI,OAAO;IAI1B;;;;;;;;;;OAUG;IACG,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC;IAaxC;;;;;;;;;;;;;;;;;;OAkBG;IACG,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC;IA4B5D;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,mBAAmB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,OAAO,CAAC;IAwD9E;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAO9B;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC;IAOvD;;;;;;;;;;;;OAYG;IACH,WAAW,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAMtD;;;;;;;;;;OAUG;IACH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAS1B;;;;;;;;;;OAUG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAS3B;;;;;;;;;;OAUG;IACH,WAAW,CAAC,KAAK,EAAC,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWxC;;;;;;;;;;;;;;;;;;OAkBG;IACG,cAAc,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC;IAmB/D;;;;;;;;;;OAUG;IACH,wBAAwB,IAAI,OAAO,CAAC,QAAQ,CAAC;IAS7C;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAS7C;;;;;;;;;OASG;IACH,uBAAuB,IAAI,OAAO,CAAC,IAAI,CAAC;CAQzC;AAED,eAAe,WAAW,CAAC"}