@bagelink/auth 1.4.169 → 1.4.174

package/dist/index.d.mts

@@ -2,35 +2,16 @@ import { AxiosResponse, AxiosInstance } from 'axios';
 import * as vue from 'vue';
 import { App } from 'vue';
 
-interface User {
-    id: string;
-    email: string;
-    first_name?: string;
-    last_name?: string;
-    is_superuser?: boolean;
-    is_active?: boolean;
-}
-interface UserRegister {
-    email: string;
-    password: string;
-    first_name: string;
-    last_name: string;
-}
-interface NewUser extends UserRegister {
-    confirmPassword: string;
-}
-interface UpdatePasswordForm {
-    current_password: string;
-    new_password: string;
-    confirmNewPassword: string;
-}
 declare enum AuthState {
     LOGIN = "login",
     LOGOUT = "logout",
     SIGNUP = "signup",
     PASSWORD_RESET = "password_reset",
+    PASSWORD_CHANGE = "password_change",
     PROFILE_UPDATE = "profile_update",
-    AUTH_CHECK = "auth_check"
+    AUTH_CHECK = "auth_check",
+    EMAIL_VERIFIED = "email_verified",
+    SESSION_REFRESH = "session_refresh"
 }
 type AuthEventHandler = () => void;
 interface AuthEventMap {
@@ -38,84 +19,303 @@ interface AuthEventMap {
     [AuthState.LOGOUT]: AuthEventHandler;
     [AuthState.SIGNUP]: AuthEventHandler;
     [AuthState.PASSWORD_RESET]: AuthEventHandler;
+    [AuthState.PASSWORD_CHANGE]: AuthEventHandler;
     [AuthState.PROFILE_UPDATE]: AuthEventHandler;
     [AuthState.AUTH_CHECK]: AuthEventHandler;
+    [AuthState.EMAIL_VERIFIED]: AuthEventHandler;
+    [AuthState.SESSION_REFRESH]: AuthEventHandler;
 }
-interface Token {
-    access_token: string;
+type AuthenticationAccountType = 'person' | 'entity' | 'service';
+type AuthenticationMethodType = 'password' | 'email_token' | 'sso' | 'otp';
+interface AuthenticationAccount {
+    created_at?: string;
+    updated_at?: string;
+    account_type?: AuthenticationAccountType;
+    person_id?: string;
+    entity_id?: string;
+    display_name?: string;
+    is_active?: boolean;
+    is_verified?: boolean;
+    account_metadata?: string;
+    last_login_at?: string;
+    failed_login_attempts?: number;
+    locked_until?: string;
+    id: string;
 }
-interface PasswordRecovery {
-    email: string;
+interface PersonInfo {
+    id: string;
+    name: string;
+    email?: string;
+    roles: string[];
 }
-interface NewPassword {
-    new_password: string;
+interface AuthMethodInfo {
+    id: string;
+    type: string;
+    identifier?: string;
+    is_verified: boolean;
+    last_used?: string;
+    use_count: number;
 }
-interface UserUpdate {
-    email?: string;
-    is_active?: boolean;
-    is_superuser?: boolean;
-    first_name?: string;
-    last_name?: string;
+interface AccountInfo {
+    id: string;
+    account_type: string;
+    display_name: string;
+    is_active: boolean;
+    is_verified: boolean;
+    last_login?: string;
+    authentication_methods: AuthMethodInfo[];
+    person?: PersonInfo;
+    entity?: EntityInfo;
 }
-interface UserUpdateMe {
+interface EntityInfo {
+    id: string;
+    name: string;
+    type?: string;
+    metadata?: Record<string, any>;
+}
+interface SessionInfo {
+    id: string;
+    created_at: string;
+    expires_at: string;
+    ip_address?: string;
+    user_agent?: string;
+    is_current?: boolean;
+}
+/**
+ * Unified user representation that works for both person and entity accounts
+ * This is the primary interface for accessing user data in the application
+ */
+interface User {
+    /** Unique identifier (person_id or entity_id) */
+    id: string;
+    /** Account ID */
+    accountId: string;
+    /** Display name */
+    name: string;
+    /** Email address (from person or authentication methods) */
     email?: string;
+    /** Account type: 'person', 'entity', or 'service' */
+    type: AuthenticationAccountType;
+    /** User roles (only for person accounts) */
+    roles?: string[];
+    /** Is the account active */
+    isActive: boolean;
+    /** Is the account verified */
+    isVerified: boolean;
+    /** Last login timestamp */
+    lastLogin?: string;
+    /** Entity-specific info (only for entity accounts) */
+    entityType?: string;
+    /** Additional metadata */
+    metadata?: Record<string, any>;
+}
+interface RegisterRequest {
+    email: string;
+    first_name: string;
+    last_name: string;
+    phone_number?: string;
+    password?: string;
+}
+interface UpdateAccountRequest {
     first_name?: string;
     last_name?: string;
+    email?: string;
+    phone_number?: string;
 }
-interface UpdatePassword {
+interface PasswordLoginRequest {
+    email: string;
+    password: string;
+}
+interface ChangePasswordRequest {
     current_password: string;
     new_password: string;
 }
-interface UserCreate {
+interface ForgotPasswordRequest {
     email: string;
-    password: string;
-    first_name?: string;
-    last_name?: string;
-    is_active?: boolean;
-    is_superuser?: boolean;
 }
-interface SanitizedUserOut {
-    email: string;
-    is_active?: boolean;
-    is_superuser?: boolean;
-    first_name?: string;
-    last_name?: string;
-    id: string;
+interface ResetPasswordRequest {
+    token: string;
+    new_password: string;
 }
-interface SanitizedUserList {
-    data: SanitizedUserOut[];
-    count: number;
-}
-type LoginResponse = AxiosResponse<Token>;
-type PasswordRecoveryResponse = AxiosResponse;
-type ResetPasswordResponse = AxiosResponse;
-type GetUserResponse = AxiosResponse<SanitizedUserOut>;
-type UpdateUserResponse = AxiosResponse<SanitizedUserOut>;
-type DeleteUserResponse = AxiosResponse;
-type GetUsersResponse = AxiosResponse<SanitizedUserList>;
-type CreateUserResponse = AxiosResponse<SanitizedUserOut>;
-type GetMeResponse = AxiosResponse<SanitizedUserOut>;
-type UpdateMeResponse = AxiosResponse<SanitizedUserOut>;
-type UpdatePasswordResponse = AxiosResponse;
-type SignupResponse = AxiosResponse<SanitizedUserOut>;
+interface SendVerificationRequest {
+    email?: string;
+}
+interface VerifyEmailRequest {
+    token: string;
+}
+interface NewUser extends RegisterRequest {
+    confirmPassword: string;
+}
+interface UpdatePasswordForm extends ChangePasswordRequest {
+    confirmNewPassword: string;
+}
+interface MessageResponse {
+    message: string;
+}
+interface AuthStatusResponse {
+    status: string;
+    methods: string[];
+}
+interface AvailableMethodsResponse {
+    available_methods: {
+        [key: string]: any;
+    }[];
+}
+interface OTPMetadata {
+    nonce: string;
+    verification_hash: string;
+    timestamp: number;
+    expires_in_minutes: number;
+    autofill: {
+        [key: string]: any;
+    };
+}
+interface SSOMetadata {
+    provider: string;
+    sso_user_info: {
+        [key: string]: any;
+    };
+    can_create_account?: boolean;
+}
+interface AuthenticationResponse {
+    success: boolean;
+    account_id?: string;
+    session_token?: string;
+    requires_verification?: boolean;
+    verification_method?: AuthenticationMethodType;
+    message?: string;
+    metadata?: OTPMetadata | SSOMetadata | {
+        [key: string]: any;
+    };
+}
+interface SessionListResponse {
+    account_id: string;
+    sessions: SessionInfo[];
+}
+type LoginResponse = AxiosResponse<AuthenticationResponse>;
+type RegisterResponse = AxiosResponse<AuthenticationResponse>;
+type LogoutResponse = AxiosResponse<MessageResponse>;
+type GetMeResponse = AxiosResponse<AccountInfo>;
+type UpdateMeResponse = AxiosResponse<AccountInfo>;
+type DeleteMeResponse = AxiosResponse<MessageResponse>;
+type GetAccountResponse = AxiosResponse<AccountInfo>;
+type UpdateAccountResponse = AxiosResponse<AccountInfo>;
+type DeleteAccountResponse = AxiosResponse<MessageResponse>;
+type ActivateAccountResponse = AxiosResponse<AccountInfo>;
+type DeactivateAccountResponse = AxiosResponse<AccountInfo>;
+type ChangePasswordResponse = AxiosResponse<MessageResponse>;
+type ForgotPasswordResponse = AxiosResponse<MessageResponse>;
+type ResetPasswordResponse = AxiosResponse<MessageResponse>;
+type VerifyResetTokenResponse = AxiosResponse<MessageResponse>;
+type SendVerificationResponse = AxiosResponse<MessageResponse>;
+type VerifyEmailResponse = AxiosResponse<MessageResponse>;
+type RefreshSessionResponse = AxiosResponse<AuthenticationResponse>;
+type GetSessionsResponse = AxiosResponse<SessionListResponse>;
+type DeleteSessionResponse = AxiosResponse<MessageResponse>;
+type DeleteAllSessionsResponse = AxiosResponse<MessageResponse>;
+type CleanupSessionsResponse = AxiosResponse<MessageResponse>;
+type GetMethodsResponse = AxiosResponse<AvailableMethodsResponse>;
+/**
+ * Extract unified user from account info
+ */
+declare function accountToUser(account: AccountInfo | null): User | null;
 
 declare class AuthApi {
     private api;
     constructor(axiosInstance?: AxiosInstance, baseURL?: string);
     private setupInterceptors;
-    login(username: string, password: string): Promise<LoginResponse>;
-    logout(): void;
-    passwordRecovery(email?: string): Promise<PasswordRecoveryResponse>;
-    resetPassword(newPassword: NewPassword['new_password']): Promise<ResetPasswordResponse>;
+    /**
+     * Get available authentication methods
+     */
+    getAuthMethods(): Promise<GetMethodsResponse>;
+    /**
+     * Register a new account
+     */
+    register(data: RegisterRequest): Promise<RegisterResponse>;
+    /**
+     * Login with password
+     */
+    login(email: string, password: string): Promise<LoginResponse>;
+    /**
+     * Logout and clear session
+     */
+    logout(): Promise<LogoutResponse>;
+    /**
+     * Refresh current session
+     */
+    refreshSession(): Promise<RefreshSessionResponse>;
+    /**
+     * Get current user account info
+     */
     getCurrentUser(): Promise<GetMeResponse>;
-    signup(user: NewUser): Promise<SignupResponse>;
-    updatePassword(form: UpdatePasswordForm): Promise<UpdatePasswordResponse>;
-    updateUserProfile(user: Partial<User>): Promise<UpdateMeResponse>;
-    setUserStatus(userId: string, isActive: boolean): Promise<UpdateUserResponse>;
-    deleteUser(userId: string): Promise<DeleteUserResponse>;
-    getUsers(limit?: number, skip?: number): Promise<GetUsersResponse>;
-    createUser(user: UserCreate): Promise<CreateUserResponse>;
-    getUser(userId: string): Promise<GetUserResponse>;
+    /**
+     * Update current user profile
+     */
+    updateCurrentUser(data: UpdateAccountRequest): Promise<UpdateMeResponse>;
+    /**
+     * Delete current user account
+     */
+    deleteCurrentUser(): Promise<DeleteMeResponse>;
+    /**
+     * Get account information by ID
+     */
+    getAccount(accountId: string): Promise<GetAccountResponse>;
+    /**
+     * Update account by ID
+     */
+    updateAccount(accountId: string, data: UpdateAccountRequest): Promise<UpdateAccountResponse>;
+    /**
+     * Delete account by ID
+     */
+    deleteAccount(accountId: string): Promise<DeleteAccountResponse>;
+    /**
+     * Activate account by ID
+     */
+    activateAccount(accountId: string): Promise<ActivateAccountResponse>;
+    /**
+     * Deactivate account by ID
+     */
+    deactivateAccount(accountId: string): Promise<DeactivateAccountResponse>;
+    /**
+     * Change password (requires current password)
+     */
+    changePassword(data: ChangePasswordRequest): Promise<ChangePasswordResponse>;
+    /**
+     * Initiate forgot password flow
+     */
+    forgotPassword(email: string): Promise<ForgotPasswordResponse>;
+    /**
+     * Verify password reset token
+     */
+    verifyResetToken(token: string): Promise<VerifyResetTokenResponse>;
+    /**
+     * Reset password with token
+     */
+    resetPassword(data: ResetPasswordRequest): Promise<ResetPasswordResponse>;
+    /**
+     * Send email verification
+     */
+    sendVerification(data?: SendVerificationRequest, user?: AuthenticationAccount): Promise<SendVerificationResponse>;
+    /**
+     * Verify email with token
+     */
+    verifyEmail(token: string): Promise<VerifyEmailResponse>;
+    /**
+     * Get sessions for an account
+     */
+    getSessions(accountId: string): Promise<GetSessionsResponse>;
+    /**
+     * Revoke a specific session
+     */
+    revokeSession(sessionToken: string): Promise<DeleteSessionResponse>;
+    /**
+     * Revoke all sessions for an account
+     */
+    revokeAllSessions(accountId: string): Promise<DeleteAllSessionsResponse>;
+    /**
+     * Cleanup expired sessions (admin)
+     */
+    cleanupSessions(): Promise<CleanupSessionsResponse>;
 }
 
 declare function initAuth({ axios, baseURL, }: {
@@ -128,37 +328,92 @@ declare function initAuth({ axios, baseURL, }: {
     install(app: App): void;
 };
 declare function useAuth(): {
-    currentUser: vue.Ref<{
+    user: vue.ComputedRef<User | null>;
+    accountInfo: vue.Ref<{
         id: string;
-        email: string;
-        first_name?: string | undefined;
-        last_name?: string | undefined;
-        is_superuser?: boolean | undefined;
-        is_active?: boolean | undefined;
-    }, User | {
+        account_type: string;
+        display_name: string;
+        is_active: boolean;
+        is_verified: boolean;
+        last_login?: string | undefined;
+        authentication_methods: {
+            id: string;
+            type: string;
+            identifier?: string | undefined;
+            is_verified: boolean;
+            last_used?: string | undefined;
+            use_count: number;
+        }[];
+        person?: {
+            id: string;
+            name: string;
+            email?: string | undefined;
+            roles: string[];
+        } | undefined;
+        entity?: {
+            id: string;
+            name: string;
+            type?: string | undefined;
+            metadata?: Record<string, any> | undefined;
+        } | undefined;
+    } | null, AccountInfo | {
         id: string;
-        email: string;
-        first_name?: string | undefined;
-        last_name?: string | undefined;
-        is_superuser?: boolean | undefined;
-        is_active?: boolean | undefined;
-    }>;
+        account_type: string;
+        display_name: string;
+        is_active: boolean;
+        is_verified: boolean;
+        last_login?: string | undefined;
+        authentication_methods: {
+            id: string;
+            type: string;
+            identifier?: string | undefined;
+            is_verified: boolean;
+            last_used?: string | undefined;
+            use_count: number;
+        }[];
+        person?: {
+            id: string;
+            name: string;
+            email?: string | undefined;
+            roles: string[];
+        } | undefined;
+        entity?: {
+            id: string;
+            name: string;
+            type?: string | undefined;
+            metadata?: Record<string, any> | undefined;
+        } | undefined;
+    } | null>;
     getFullName: () => string;
     getIsLoggedIn: () => boolean;
-    logout: () => Promise<void>;
+    getEmail: () => string;
+    getRoles: () => string[];
+    getAccountType: () => AuthenticationAccountType;
+    isPersonAccount: () => boolean;
+    isEntityAccount: () => boolean;
     login: (credentials: {
         email: string;
         password: string;
-    }) => Promise<void>;
+    }) => Promise<AuthenticationResponse>;
+    logout: () => Promise<void>;
+    signup: (newUser: NewUser) => Promise<AuthenticationResponse>;
     checkAuth: () => Promise<boolean>;
-    signup: (user: NewUser) => Promise<void>;
-    recoverPassword: (email: string) => Promise<void>;
-    resetPassword: (newPassword: string) => Promise<void>;
-    updatePassword: (form: UpdatePasswordForm) => Promise<void>;
-    updateProfile: (user: Partial<User>) => Promise<void>;
-    toggleUserStatus: (userId: string, isActive: boolean) => Promise<void>;
-    deleteUser: (userId: string) => Promise<void>;
+    refreshSession: () => Promise<void>;
+    updateProfile: (updates: UpdateAccountRequest) => Promise<void>;
+    deleteCurrentUser: () => Promise<void>;
+    changePassword: (form: UpdatePasswordForm) => Promise<void>;
+    forgotPassword: (email: string) => Promise<void>;
+    verifyResetToken: (token: string) => Promise<void>;
+    resetPassword: (token: string, newPassword: string) => Promise<void>;
+    sendVerification: (email?: string) => Promise<void>;
+    verifyEmail: (token: string) => Promise<void>;
+    activateAccount: (accountId: string) => Promise<void>;
+    deactivateAccount: (accountId: string) => Promise<void>;
+    deleteAccount: (accountId: string) => Promise<void>;
+    getSessions: (accountId?: string) => Promise<GetSessionsResponse>;
+    revokeSession: (sessionToken: string) => Promise<void>;
+    revokeAllSessions: (accountId?: string) => Promise<void>;
 };
 
-export { AuthApi, AuthState, initAuth, useAuth };
-export type { AuthEventHandler, AuthEventMap, CreateUserResponse, DeleteUserResponse, GetMeResponse, GetUserResponse, GetUsersResponse, LoginResponse, NewPassword, NewUser, PasswordRecovery, PasswordRecoveryResponse, ResetPasswordResponse, SanitizedUserList, SanitizedUserOut, SignupResponse, Token, UpdateMeResponse, UpdatePassword, UpdatePasswordForm, UpdatePasswordResponse, UpdateUserResponse, User, UserCreate, UserRegister, UserUpdate, UserUpdateMe };
+export { AuthApi, AuthState, accountToUser, initAuth, useAuth };
+export type { AccountInfo, ActivateAccountResponse, AuthEventHandler, AuthEventMap, AuthMethodInfo, AuthStatusResponse, AuthenticationAccount, AuthenticationAccountType, AuthenticationMethodType, AuthenticationResponse, AvailableMethodsResponse, ChangePasswordRequest, ChangePasswordResponse, CleanupSessionsResponse, DeactivateAccountResponse, DeleteAccountResponse, DeleteAllSessionsResponse, DeleteMeResponse, DeleteSessionResponse, EntityInfo, ForgotPasswordRequest, ForgotPasswordResponse, GetAccountResponse, GetMeResponse, GetMethodsResponse, GetSessionsResponse, LoginResponse, LogoutResponse, MessageResponse, NewUser, OTPMetadata, PasswordLoginRequest, PersonInfo, RefreshSessionResponse, RegisterRequest, RegisterResponse, ResetPasswordRequest, ResetPasswordResponse, SSOMetadata, SendVerificationRequest, SendVerificationResponse, SessionInfo, SessionListResponse, UpdateAccountRequest, UpdateAccountResponse, UpdateMeResponse, UpdatePasswordForm, User, VerifyEmailRequest, VerifyEmailResponse, VerifyResetTokenResponse };