@commercengine/storefront-sdk 0.2.1 → 0.3.1

package/dist/lib/auth.d.ts

@@ -1,32 +1,14 @@
 import { StorefrontAPIClient, StorefrontAPIConfig } from "./client";
-import type { components } from "../types/storefront";
+import { AddProfileImageContent, AddProfileImageFormData, AddProfileImagePathParams, ApiResult, ChangePasswordBody, ChangePasswordContent, CheckVerificationStatusBody, CheckVerificationStatusContent, CreateNotificationPreferencesBody, CreateNotificationPreferencesContent, CreateNotificationPreferencesPathParams, DeactivateUserPathParams, DeactivateUserResponse, ForgotPasswordBody, ForgotPasswordContent, GenerateOtpBody, GenerateOtpContent, GetAnonymousTokenContent, GetNotificationPreferencesContent, GetNotificationPreferencesPathParams, GetProfileImageContent, GetProfileImagePathParams, GetUserDetailContent, GetUserDetailPathParams, LoginWithEmailBody, LoginWithEmailContent, LoginWithPasswordBody, LoginWithPasswordContent, LoginWithPhoneBody, LoginWithPhoneContent, LoginWithWhatsappBody, LoginWithWhatsappContent, LogoutContent, RefreshTokenBody, RefreshTokenContent, RegisterWithEmailBody, RegisterWithEmailContent, RegisterWithPhoneBody, RegisterWithPhoneContent, RemoveProfileImagePathParams, RemoveProfileImageResponse, ResetPasswordBody, ResetPasswordContent, UpdateNotificationPreferencesBody, UpdateNotificationPreferencesContent, UpdateNotificationPreferencesPathParams, UpdateProfileImageContent, UpdateProfileImageFormData, UpdateProfileImagePathParams, UpdateUserBody, UpdateUserContent, UpdateUserPathParams, VerifyOtpBody, VerifyOtpContent } from "../types/storefront-api-types";
 /**
  * Client for interacting with authentication endpoints
  */
 export declare class AuthClient extends StorefrontAPIClient {
-    private tokenStorage;
-    private autoRefreshTimer;
-    constructor(config: StorefrontAPIConfig, tokenStorage?: TokenStorage);
-    setToken(token: string): void;
-    protected setRefreshToken(token: string): void;
-    clearToken(): void;
-    private setupAutoRefresh;
-    private clearAutoRefresh;
-    private handleTokenRefresh;
-    private getTokenExpiry;
+    constructor(config: StorefrontAPIConfig);
     /**
-     * Get an anonymous user token
-     *
-     * @param options - Options for anonymous authentication
-     * @returns Promise with user info and tokens
+     * Get anonymous token for guest users
      */
-    getAnonymousToken(options?: {
-        apiKey?: string;
-    }): Promise<{
-        user: components["schemas"]["AnonymousUser"];
-        access_token: string;
-        refresh_token: string;
-    }>;
+    getAnonymousToken(): Promise<ApiResult<GetAnonymousTokenContent>>;
     /**
      * Login with phone number
      *
@@ -35,10 +17,16 @@ export declare class AuthClient extends StorefrontAPIClient {
      * @param registerIfNotExists - Whether to register if user doesn't exist
      * @returns Promise with OTP token and action
      */
-    loginWithPhone(phoneNumber: string, countryCode?: string, registerIfNotExists?: boolean): Promise<{
-        otp_token: string;
-        otp_action: string;
-    }>;
+    loginWithPhone(body: LoginWithPhoneBody): Promise<ApiResult<LoginWithPhoneContent>>;
+    /**
+     * Login with WhatsApp
+     *
+     * @param phoneNumber - Phone number (without country code)
+     * @param countryCode - Country code (defaults to +91)
+     * @param registerIfNotExists - Whether to register if user doesn't exist
+     * @returns Promise with OTP token and action
+     */
+    loginWithWhatsApp(body: LoginWithWhatsappBody): Promise<ApiResult<LoginWithWhatsappContent>>;
     /**
      * Login with email
      *
@@ -46,26 +34,37 @@ export declare class AuthClient extends StorefrontAPIClient {
      * @param registerIfNotExists - Whether to register if user doesn't exist
      * @returns Promise with OTP token and action
      */
-    loginWithEmail(email: string, registerIfNotExists?: boolean): Promise<{
-        otp_token: string;
-        otp_action: string;
-    }>;
+    loginWithEmail(body: LoginWithEmailBody): Promise<ApiResult<LoginWithEmailContent>>;
     /**
      * Login with password
      *
-     * @param options - Login credentials
+     * @param credentials - Login credentials
+     * @returns Promise with user info and tokens
+     */
+    loginWithPassword(body: LoginWithPasswordBody): Promise<ApiResult<LoginWithPasswordContent>>;
+    /**
+     * Forgot password
+     *
+     * @param email - Email address
      * @returns Promise with user info and tokens
      */
-    loginWithPassword(options: {
-        email?: string;
-        phone?: string;
-        country_code?: string;
-        password: string;
-    }): Promise<{
-        user: components["schemas"]["User"];
-        access_token: string;
-        refresh_token: string;
-    }>;
+    forgotPassword(body: ForgotPasswordBody): Promise<ApiResult<ForgotPasswordContent>>;
+    /**
+     * Reset password
+     *
+     * @param email - Email address
+     * @returns Promise with user info and tokens
+     */
+    resetPassword(body: ResetPasswordBody): Promise<ApiResult<ResetPasswordContent>>;
+    /**
+     * Change password
+     *
+     * @param oldPassword - Old password
+     * @param newPassword - New password
+     * @param newPasswordConfirmation - New password confirmation
+     * @returns Promise with new access token and refresh token
+     */
+    changePassword(body: ChangePasswordBody): Promise<ApiResult<ChangePasswordContent>>;
     /**
      * Verify OTP
      *
@@ -74,229 +73,115 @@ export declare class AuthClient extends StorefrontAPIClient {
      * @param otpAction - OTP action from login request
      * @returns Promise with user info and tokens
      */
-    verifyOtp(otp: string, otpToken: string, otpAction: "login" | "register" | "reset-password" | "verify-phone" | "verify-email" | "update-phone" | "update-email"): Promise<{
-        user?: components["schemas"]["User"];
-        access_token?: string;
-        refresh_token?: string;
-    }>;
+    verifyOtp(body: VerifyOtpBody): Promise<ApiResult<VerifyOtpContent>>;
     /**
      * Register with phone
      *
      * @param options - Registration details
      * @returns Promise with user info and tokens
      */
-    registerWithPhone(options: {
-        country_code?: string;
-        phone: string;
-        first_name: string;
-        last_name?: string;
-        email: string;
-        otp_token?: string;
-    }): Promise<{
-        user: components["schemas"]["User"];
-        access_token: string;
-        refresh_token: string;
-    }>;
+    registerWithPhone(body: RegisterWithPhoneBody): Promise<ApiResult<RegisterWithPhoneContent>>;
     /**
      * Register with email
      *
      * @param options - Registration details
      * @returns Promise with user info and tokens
      */
-    registerWithEmail(options: {
-        email: string;
-        first_name: string;
-        last_name?: string;
-        phone: string;
-        otp_token?: string;
-    }): Promise<{
-        user: components["schemas"]["User"];
-        access_token: string;
-        refresh_token: string;
-    }>;
+    registerWithEmail(body: RegisterWithEmailBody): Promise<ApiResult<RegisterWithEmailContent>>;
     /**
-     * Refresh token
-     *
-     * @param refreshToken - Refresh token
-     * @returns Promise with new tokens
+     * Refresh the access token using a refresh token
+     * @param refreshToken - The refresh token to use for refreshing the access token
+     * @returns Promise with the new access token and refresh token
      */
-    refreshToken(refreshToken: string): Promise<{
-        access_token: string;
-        refresh_token: string;
-    }>;
+    refreshToken(body: RefreshTokenBody): Promise<ApiResult<RefreshTokenContent>>;
     /**
      * Logout
      *
      * @returns Promise that resolves when logout is complete
      */
-    logout(): Promise<void>;
+    logout(): Promise<ApiResult<LogoutContent>>;
     /**
-     * Override the base client's attemptTokenRefresh method
-     * to implement token refresh for 401 errors
+     * Get user details
      *
-     * @returns Promise that resolves to true if token was refreshed, false otherwise
+     * @param userId - User ID
+     * @returns Promise with user details
      */
-    protected attemptTokenRefresh(): Promise<boolean>;
+    getUserDetails(pathParams: GetUserDetailPathParams): Promise<ApiResult<GetUserDetailContent>>;
     /**
-     * Execute a request with automatic token refresh handling
-     * This wraps any API call in logic that will catch authentication errors,
-     * attempt to refresh the token, and retry the request once
+     * Update user details
      *
-     * @param requestFn - Function that executes the API request
-     * @returns Promise with the API response
-     */
-    executeWithTokenRefresh<T>(requestFn: () => Promise<T>): Promise<T>;
-}
-/**
- * Interface for client storage implementations (tokens and cart ID)
- */
-export interface ClientStorage {
-    getAccessToken(): string | null;
-    setAccessToken(token: string): void;
-    getRefreshToken(): string | null;
-    setRefreshToken(token: string): void;
-    clearTokens(): void;
-    getCartId(): string | null;
-    setCartId(cartId: string): void;
-    clearCartId(): void;
-}
-export type TokenStorage = ClientStorage;
-/**
- * Default in-memory implementation of client storage
- */
-export declare class MemoryTokenStorage implements ClientStorage {
-    private accessToken;
-    private refreshToken;
-    private cartId;
-    getAccessToken(): string | null;
-    setAccessToken(token: string): void;
-    getRefreshToken(): string | null;
-    setRefreshToken(token: string): void;
-    clearTokens(): void;
-    getCartId(): string | null;
-    setCartId(cartId: string): void;
-    clearCartId(): void;
-}
-/**
- * Browser storage implementation using localStorage
- */
-export declare class BrowserTokenStorage implements ClientStorage {
-    private accessTokenKey;
-    private refreshTokenKey;
-    private cartIdKey;
-    constructor(prefix?: string);
-    getAccessToken(): string | null;
-    setAccessToken(token: string): void;
-    getRefreshToken(): string | null;
-    setRefreshToken(token: string): void;
-    clearTokens(): void;
-    getCartId(): string | null;
-    setCartId(cartId: string): void;
-    clearCartId(): void;
-}
-/**
- * Cookie-based token storage for browser or server environments
- */
-export declare class CookieTokenStorage implements ClientStorage {
-    private accessTokenKey;
-    private refreshTokenKey;
-    private cartIdKey;
-    private cookieOptions;
-    constructor(prefix?: string, cookieOptions?: {
-        path: string;
-        secure: boolean;
-        sameSite: string;
-        httpOnly: boolean;
-        maxAge: number;
-    });
-    /**
-     * Get access token from cookies
-     * Works in both browser and Next.js server components
-     */
-    getAccessToken(): string | null;
-    /**
-     * Set access token in cookies
-     * Works in browser environment
-     */
-    setAccessToken(token: string): void;
-    /**
-     * Get refresh token from cookies
-     * Works in both browser and Next.js server components
-     */
-    getRefreshToken(): string | null;
-    /**
-     * Set refresh token in cookies
-     * Works in browser environment
-     */
-    setRefreshToken(token: string): void;
-    /**
-     * Clear all tokens from cookies
-     */
-    clearTokens(): void;
-    /**
-     * Get cart ID from cookies
-     * Works in both browser and Next.js server components
+     * @param userId - User ID
+     * @returns Promise with user details
      */
-    getCartId(): string | null;
+    updateUserDetails(pathParams: UpdateUserPathParams, body: UpdateUserBody): Promise<ApiResult<UpdateUserContent>>;
     /**
-     * Set cart ID in cookies
-     * Works in browser environment
+     * Add profile image
+     *
+     * @param userId - User ID
+     * @returns Promise with user details
      */
-    setCartId(cartId: string): void;
+    addProfileImage(pathParams: AddProfileImagePathParams, formData: AddProfileImageFormData): Promise<ApiResult<AddProfileImageContent>>;
     /**
-     * Clear cart ID from cookies
+     * Update profile image
+     *
+     * @param userId - User ID
+     * @returns Promise with user details
      */
-    clearCartId(): void;
-}
-/**
- * Next.js specific cookie storage implementation
- * Works with the Next.js cookies API
- */
-export declare class NextCookieTokenStorage implements ClientStorage {
-    private accessTokenKey;
-    private refreshTokenKey;
-    private cartIdKey;
-    private cookieStore;
-    constructor(cookieStore: any, prefix?: string);
+    updateProfileImage(pathParams: UpdateProfileImagePathParams, formData: UpdateProfileImageFormData): Promise<ApiResult<UpdateProfileImageContent>>;
     /**
-     * Get access token from Next.js cookies
+     * Delete profile image
+     *
+     * @param userId - User ID
+     * @returns Promise with user details
      */
-    getAccessToken(): string | null;
+    deleteProfileImage(pathParams: RemoveProfileImagePathParams): Promise<ApiResult<RemoveProfileImageResponse>>;
     /**
-     * Set access token in Next.js cookies
+     * Get profile image
+     *
+     * @param userId - User ID
+     * @returns Promise with user details
      */
-    setAccessToken(token: string): void;
+    getProfileImage(pathParams: GetProfileImagePathParams): Promise<ApiResult<GetProfileImageContent>>;
     /**
-     * Get refresh token from Next.js cookies
+     * Deactivate user account
+     *
+     * @param userId - User ID
+     * @returns Promise with user details
      */
-    getRefreshToken(): string | null;
+    deactivateUserAccount(pathParams: DeactivateUserPathParams): Promise<ApiResult<DeactivateUserResponse>>;
     /**
-     * Set refresh token in Next.js cookies
+     * Get user notification preferences
+     *
+     * @param userId - User ID
+     * @returns Promise with user details
      */
-    setRefreshToken(token: string): void;
+    getUserNotificationPreferences(pathParams: GetNotificationPreferencesPathParams): Promise<ApiResult<GetNotificationPreferencesContent>>;
     /**
-     * Clear all tokens from Next.js cookies
+     * Update user notification preferences
+     *
+     * @param userId - User ID
+     * @returns Promise with user details
      */
-    clearTokens(): void;
+    updateUserNotificationPreferences(pathParams: UpdateNotificationPreferencesPathParams, body: UpdateNotificationPreferencesBody): Promise<ApiResult<UpdateNotificationPreferencesContent>>;
     /**
-     * Get cart ID from Next.js cookies
+     * Create user notification preference
+     *
+     * @param userId - User ID
+     * @returns Promise with user details
      */
-    getCartId(): string | null;
+    createUserNotificationPreference(pathParams: CreateNotificationPreferencesPathParams, body: CreateNotificationPreferencesBody): Promise<ApiResult<CreateNotificationPreferencesContent>>;
     /**
-     * Set cart ID in Next.js cookies
+     * Generate OTP
+     *
+     * @param body - OTP generation body
+     * @returns Promise with OTP generation response
      */
-    setCartId(cartId: string): void;
+    generateOtp(body: GenerateOtpBody): Promise<ApiResult<GenerateOtpContent>>;
     /**
-     * Clear cart ID from Next.js cookies
+     * Check whether email or phone is already verified
+     *
+     * @param body - OTP generation body
+     * @returns Promise with OTP generation response
      */
-    clearCartId(): void;
+    checkEmailOrPhoneIsVerified(body: CheckVerificationStatusBody): Promise<ApiResult<CheckVerificationStatusContent>>;
 }
-/**
- * Helper to create a token storage instance based on environment
- * Automatically selects the best storage method based on context
- */
-export declare function createTokenStorage(options?: {
-    prefix?: string;
-    cookieStore?: any;
-    useLocalStorage?: boolean;
-}): TokenStorage;