woodsportal-client-sdk 1.1.5-dev.0 → 4.0.0-dev.0

package/dist/authentication-BfYhAeMs.d.ts

@@ -0,0 +1,463 @@
+import { M as MutationOptions, P as PreLoginPayload, C as ChangePasswordPayload, L as LoginPayload, V as VerifyEmailPayload, F as ForgetPasswordPayload, a as ResetPasswordPayload, R as ResetPasswordVerifyTokenPayload } from './index-CCwMopD8.js';
+
+type MfaMethod = 'EMAIL_OTP' | 'SMS_OTP' | 'TOTP' | 'BACKUP_CODE' | 'PASSKEY' | 'PASSKEY_PRIMARY';
+type MfaMethodStatus = 'READY' | 'NOT_ENROLLED';
+type MfaMethodNotReadyReason = 'PHONE_NOT_VERIFIED' | 'NOT_ENROLLED' | 'POLICY_BLOCKED' | string;
+interface MfaMethodOption {
+    method: MfaMethod;
+    status: MfaMethodStatus;
+    destinationMasked?: string;
+    reason?: MfaMethodNotReadyReason;
+}
+interface TokenResponse {
+    token?: string;
+    refreshToken?: string;
+    expiresIn?: number;
+    refreshExpiresIn?: number;
+}
+interface LoginResponseData {
+    tokenData?: TokenResponse;
+    loggedInDetails?: Record<string, unknown>;
+    twoFactorRequired?: boolean;
+    otpDelivery?: string;
+    otpDestinationMasked?: string;
+    mfaMethods?: MfaMethodOption[];
+    defaultMethod?: MfaMethod;
+}
+interface TwoFaVerificationRequest {
+    token: string;
+    otp: string;
+    method: MfaMethod;
+}
+interface MfaOtpSendRequest {
+    token: string;
+    method: MfaMethod;
+}
+interface MfaPendingPasskeyOptionsRequest {
+    token: string;
+    portalId?: string | number;
+}
+interface MfaPendingPasskeyVerifyRequest {
+    token: string;
+    challengeId: string;
+    credential: Record<string, unknown>;
+    portalId?: string | number;
+}
+interface MfaEnrollmentStatus {
+    policyAllowedMethods?: MfaMethod[];
+    enrolledMethods?: MfaMethod[];
+    readyMethods?: MfaMethod[];
+    totpEnrolled?: boolean;
+    phoneVerified?: boolean;
+    passkeyCount?: number;
+    unusedBackupCodes?: number;
+    defaultMethod?: MfaMethod;
+    preferredMethod?: MfaMethod;
+    methods?: MfaMethodOption[];
+}
+interface MfaPreferenceRequest {
+    defaultMethod: MfaMethod;
+}
+interface PhoneVerifyStartRequest {
+    phone: string;
+}
+interface PhoneVerifyConfirmRequest {
+    phone: string;
+    code: string;
+}
+interface TotpEnrollVerifyRequest {
+    code: string;
+    portalId?: string | number;
+    hubId?: string | number;
+}
+interface TotpDisableRequest {
+    password: string;
+}
+interface WebAuthnVerifyRequest {
+    challengeId: string;
+    credential: Record<string, unknown>;
+    nickname?: string;
+    portalId?: string | number;
+}
+interface PasskeyLoginOptionsRequest {
+    email: string;
+    hubId?: string | number;
+    portalId?: string | number;
+}
+interface PasskeyLoginVerifyRequest {
+    challengeId: string;
+    credential: Record<string, unknown>;
+    portalId?: string | number;
+}
+interface MfaStatusQuery {
+    portalId?: string | number;
+}
+
+type LoginPortal = 'PORTAL_CLIENT' | 'PORTAL_ADMIN' | 'SUPER_ADMIN';
+type LoginStatus = 'SUCCESS' | 'FAILURE' | string;
+interface SecurityOverview {
+    passwordLastChanged?: string;
+    emailVerified?: boolean;
+    email?: string;
+    twoFactorAuthEnabled?: boolean;
+    mfaRequired?: boolean;
+    methods?: MfaMethodOption[];
+    readyMethods?: MfaMethod[];
+    preferredMethod?: MfaMethod;
+    defaultMethod?: MfaMethod;
+    totpEnrolled?: boolean;
+    phoneVerified?: boolean;
+    passkeyCount?: number;
+    unusedBackupCodes?: number;
+}
+interface LoginHistoryRow {
+    loginHistoryId?: number;
+    userId?: number;
+    portalId?: number;
+    hubspotId?: number;
+    ipAddress?: string;
+    userAgent?: string;
+    loginTime?: string;
+    loginStatus?: LoginStatus;
+    loginPortal?: LoginPortal;
+    logoutTime?: string;
+    failureReason?: string;
+    countryCode?: string;
+    deviceType?: string;
+}
+interface PaginationResponse<T> {
+    content?: T[];
+    page?: number;
+    limit?: number;
+    totalElements?: number;
+    totalPages?: number;
+}
+interface ActiveSession {
+    familyId?: string;
+    current?: boolean;
+    deviceType?: string;
+    userAgent?: string;
+    ipAddressMasked?: string;
+    countryCode?: string;
+    lastActiveAt?: string;
+    expiresAt?: number;
+    rememberMe?: boolean;
+    portalId?: number;
+    loginPortal?: LoginPortal;
+}
+interface SecurityOverviewQuery {
+    portalId?: string | number;
+}
+interface SecurityLoginActivityQuery {
+    page?: number;
+    limit?: number;
+    sort?: string;
+    loginPortal?: LoginPortal;
+}
+interface SecuritySessionsQuery {
+    currentFamilyId?: string;
+    refreshToken?: string;
+}
+interface RevokeSecuritySessionPayload {
+    familyId: string;
+    refreshToken?: string;
+}
+
+declare function getAccessToken(): string | null;
+declare function isExpiresAccessToken(): boolean;
+declare function isAuthenticateApp(): boolean;
+declare function isAuthenticated(): boolean;
+declare function isAccessTokenExpired(): boolean;
+
+type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'silent';
+type LogMeta = Record<string, unknown>;
+interface SdkLogger {
+    debug(context: string, message: string, meta?: LogMeta): void;
+    info(context: string, message: string, meta?: LogMeta): void;
+    warn(context: string, message: string, meta?: LogMeta): void;
+    error(context: string, error: unknown, meta?: LogMeta): void;
+}
+interface LoggerConfig {
+    level?: LogLevel;
+    namespace?: string;
+    enabled?: boolean;
+    sinks?: Partial<Pick<SdkLogger, 'debug' | 'info' | 'warn' | 'error'>>;
+    httpTracing?: boolean;
+}
+
+interface StorageKeyConfig {
+    loginDetails?: string;
+    refreshToken?: string;
+    portal?: string;
+    subscriptionType?: string;
+    authUser?: string;
+}
+
+interface HttpClientConfig {
+    baseURL?: string;
+    timeout?: number;
+    headers?: Record<string, string>;
+    skipCurrentPublicPath?: () => boolean;
+    routes?: {
+        unauthorized?: string;
+        login?: string;
+    };
+    hubId?: string;
+    devPortalId?: string;
+    onLogout?: () => void | Promise<void>;
+    logger?: LoggerConfig;
+    storageKeys?: StorageKeyConfig;
+    onServiceUnavailable?: (error: unknown) => void;
+}
+declare function initializeHttpClient(clientConfig: HttpClientConfig): void;
+declare function getFormErrors(error: unknown): string | null;
+declare function getFieldErrors(error: unknown): any;
+declare function getAuthRefreshToken(refreshToken: string | null): Promise<{
+    token: string | null;
+    success: boolean;
+}>;
+
+declare function getRefreshToken(): string | null;
+
+declare function getSsoDetails(options?: MutationOptions<any, any>): {
+    mutate: (payload?: unknown) => Promise<any>;
+    getDetails: (payload?: unknown) => Promise<any>;
+    getSsoDetails: (payload?: unknown) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function generateSsoUrl(options?: MutationOptions<any, any>): {
+    mutate: (payload?: PreLoginPayload | undefined) => Promise<any>;
+    generateUrl: (payload?: PreLoginPayload | undefined) => Promise<any>;
+    generateSsoUrl: (payload?: PreLoginPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function ssoCallback(options?: MutationOptions<any, any>): {
+    mutate: (payload?: PreLoginPayload | undefined) => Promise<any>;
+    callback: (payload?: PreLoginPayload | undefined) => Promise<any>;
+    ssoCallback: (payload?: PreLoginPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+
+declare function getSecurityOverview(options?: MutationOptions<any, any>): {
+    mutate: (payload?: SecurityOverviewQuery | undefined) => Promise<any>;
+    getOverview: (payload?: SecurityOverviewQuery | undefined) => Promise<any>;
+    getSecurityOverview: (payload?: SecurityOverviewQuery | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function getSecurityLoginActivity(options?: MutationOptions<any, any>): {
+    mutate: (payload?: SecurityLoginActivityQuery | undefined) => Promise<any>;
+    getLoginActivity: (payload?: SecurityLoginActivityQuery | undefined) => Promise<any>;
+    getSecurityLoginActivity: (payload?: SecurityLoginActivityQuery | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function getSecuritySessions(options?: MutationOptions<any, any>): {
+    mutate: (payload?: SecuritySessionsQuery | undefined) => Promise<any>;
+    getSessions: (payload?: SecuritySessionsQuery | undefined) => Promise<any>;
+    getSecuritySessions: (payload?: SecuritySessionsQuery | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function revokeSecuritySession(options?: MutationOptions<any, any>): {
+    mutate: (payload?: RevokeSecuritySessionPayload | undefined) => Promise<any>;
+    revokeSession: (payload?: RevokeSecuritySessionPayload | undefined) => Promise<any>;
+    revokeSecuritySession: (payload?: RevokeSecuritySessionPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function revokeOtherSecuritySessions(options?: MutationOptions<any, any>): {
+    mutate: (payload?: {
+        refreshToken?: string;
+    } | undefined) => Promise<any>;
+    revokeOtherSessions: (payload?: {
+        refreshToken?: string;
+    } | undefined) => Promise<any>;
+    revokeOtherSecuritySessions: (payload?: {
+        refreshToken?: string;
+    } | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+
+declare function verifyOtp(options?: MutationOptions<any, any>): {
+    mutate: (payload?: TwoFaVerificationRequest | undefined) => Promise<any>;
+    verifyOtp: (payload?: TwoFaVerificationRequest | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function sendMfaOtp(options?: MutationOptions<any, any>): {
+    mutate: (payload?: MfaOtpSendRequest | undefined) => Promise<any>;
+    sendOtp: (payload?: MfaOtpSendRequest | undefined) => Promise<any>;
+    sendMfaOtp: (payload?: MfaOtpSendRequest | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function pendingPasskeyOptions(options?: MutationOptions<any, any>): {
+    mutate: (payload?: MfaPendingPasskeyOptionsRequest | undefined) => Promise<any>;
+    pendingPasskeyOptions: (payload?: MfaPendingPasskeyOptionsRequest | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function pendingPasskeyVerify(options?: MutationOptions<any, any>): {
+    mutate: (payload?: MfaPendingPasskeyVerifyRequest | undefined) => Promise<any>;
+    pendingPasskeyVerify: (payload?: MfaPendingPasskeyVerifyRequest | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function getMfaStatus(options?: MutationOptions<any, any>): {
+    mutate: (payload?: MfaStatusQuery | undefined) => Promise<any>;
+    getStatus: (payload?: MfaStatusQuery | undefined) => Promise<any>;
+    getMfaStatus: (payload?: MfaStatusQuery | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function setMfaPreferences(options?: MutationOptions<any, any>): {
+    mutate: (payload?: (MfaPreferenceRequest & MfaStatusQuery) | undefined) => Promise<any>;
+    setPreferences: (payload?: (MfaPreferenceRequest & MfaStatusQuery) | undefined) => Promise<any>;
+    setMfaPreferences: (payload?: (MfaPreferenceRequest & MfaStatusQuery) | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function startPhoneVerify(options?: MutationOptions<any, any>): {
+    mutate: (payload?: PhoneVerifyStartRequest | undefined) => Promise<any>;
+    startPhoneVerify: (payload?: PhoneVerifyStartRequest | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function confirmPhoneVerify(options?: MutationOptions<any, any>): {
+    mutate: (payload?: PhoneVerifyConfirmRequest | undefined) => Promise<any>;
+    confirmPhoneVerify: (payload?: PhoneVerifyConfirmRequest | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function totpEnrollStart(options?: MutationOptions<any, any>): {
+    mutate: (payload?: MfaStatusQuery | undefined) => Promise<any>;
+    totpEnrollStart: (payload?: MfaStatusQuery | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function totpEnrollVerify(options?: MutationOptions<any, any>): {
+    mutate: (payload?: TotpEnrollVerifyRequest | undefined) => Promise<any>;
+    totpEnrollVerify: (payload?: TotpEnrollVerifyRequest | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function totpDisable(options?: MutationOptions<any, any>): {
+    mutate: (payload?: TotpDisableRequest | undefined) => Promise<any>;
+    totpDisable: (payload?: TotpDisableRequest | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function webauthnRegisterOptions(options?: MutationOptions<any, any>): {
+    mutate: (payload?: MfaStatusQuery | undefined) => Promise<any>;
+    webauthnRegisterOptions: (payload?: MfaStatusQuery | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function webauthnRegisterVerify(options?: MutationOptions<any, any>): {
+    mutate: (payload?: WebAuthnVerifyRequest | undefined) => Promise<any>;
+    webauthnRegisterVerify: (payload?: WebAuthnVerifyRequest | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function webauthnAuthOptions(options?: MutationOptions<any, any>): {
+    mutate: (payload?: MfaStatusQuery | undefined) => Promise<any>;
+    webauthnAuthOptions: (payload?: MfaStatusQuery | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function webauthnAuthVerify(options?: MutationOptions<any, any>): {
+    mutate: (payload?: WebAuthnVerifyRequest | undefined) => Promise<any>;
+    webauthnAuthVerify: (payload?: WebAuthnVerifyRequest | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function listWebauthnCredentials(options?: MutationOptions<any, any>): {
+    mutate: (payload?: MfaStatusQuery | undefined) => Promise<any>;
+    listWebauthnCredentials: (payload?: MfaStatusQuery | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function deleteWebauthnCredential(options?: MutationOptions<any, any>): {
+    mutate: (payload?: ({
+        credentialRecordId: string | number;
+    } & MfaStatusQuery) | undefined) => Promise<any>;
+    deleteWebauthnCredential: (payload?: ({
+        credentialRecordId: string | number;
+    } & MfaStatusQuery) | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function passkeyLoginOptions(options?: MutationOptions<any, any>): {
+    mutate: (payload?: PasskeyLoginOptionsRequest | undefined) => Promise<any>;
+    passkeyLoginOptions: (payload?: PasskeyLoginOptionsRequest | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function passkeyLoginVerify(options?: MutationOptions<any, any>): {
+    mutate: (payload?: PasskeyLoginVerifyRequest | undefined) => Promise<any>;
+    passkeyLoginVerify: (payload?: PasskeyLoginVerifyRequest | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+
+declare function me(options?: MutationOptions<any, any>): {
+    mutate: (payload?: unknown) => Promise<any>;
+    me: (payload?: unknown) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function profile(options?: MutationOptions<any, any>): {
+    mutate: (payload?: any) => Promise<any>;
+    profile: (payload?: any) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function profileUpdate(options?: MutationOptions<any, any>): {
+    mutate: (payload?: any) => Promise<any>;
+    updateProfile: (payload?: any) => Promise<any>;
+    profileUpdate: (payload?: any) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function changePassword(options?: MutationOptions<any, any>): {
+    mutate: (payload?: ChangePasswordPayload | undefined) => Promise<any>;
+    changePassword: (payload?: ChangePasswordPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+
+declare function preLogin(options?: MutationOptions<any, any>): {
+    mutate: (payload?: PreLoginPayload | undefined) => Promise<any>;
+    preLogin: (payload?: PreLoginPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function login(options?: MutationOptions<any, any>): {
+    mutate: (payload?: LoginPayload | undefined) => Promise<any>;
+    login: (payload?: LoginPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+interface ClientSessionPayload {
+    accessToken: string;
+    refreshToken?: string;
+}
+declare function clientSession(options?: MutationOptions<any, any>): {
+    mutate: (payload?: ClientSessionPayload | undefined) => Promise<any>;
+    clientSession: (payload?: ClientSessionPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function verifyEmail(options?: MutationOptions<any, any>): {
+    mutate: (payload?: VerifyEmailPayload | undefined) => Promise<any>;
+    verifyEmail: (payload?: VerifyEmailPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function resetPasswordVerifyToken(options?: MutationOptions<any, any>): {
+    mutate: (payload?: ResetPasswordVerifyTokenPayload | undefined) => Promise<any>;
+    resetPasswordVerifyToken: (payload?: ResetPasswordVerifyTokenPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function resetPassword(options?: MutationOptions<any, any>): {
+    mutate: (payload?: ResetPasswordPayload | undefined) => Promise<any>;
+    resetPassword: (payload?: ResetPasswordPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function forgetPassword(options?: MutationOptions<any, any>): {
+    mutate: (payload?: ForgetPasswordPayload | undefined) => Promise<any>;
+    forgetPassword: (payload?: ForgetPasswordPayload | undefined) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function logout(options?: MutationOptions<any, any>): {
+    mutate: (payload?: unknown) => Promise<any>;
+    logout: (payload?: unknown) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function registerExistingUser(options?: MutationOptions<any, any>): {
+    mutate: (payload?: any) => Promise<any>;
+    registerExistingUser: (payload?: any) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function verifyEmailResend(options?: MutationOptions<any, any>): {
+    mutate: (payload?: any) => Promise<any>;
+    verifyEmailResend: (payload?: any) => Promise<any>;
+    isLoading: () => boolean;
+};
+declare function resendEmail(options?: MutationOptions<any, any>): {
+    mutate: (payload?: any) => Promise<any>;
+    resendEmail: (payload?: any) => Promise<any>;
+    isLoading: () => boolean;
+};
+
+export { type MfaPendingPasskeyVerifyRequest as $, webauthnRegisterOptions as A, webauthnRegisterVerify as B, webauthnAuthOptions as C, webauthnAuthVerify as D, listWebauthnCredentials as E, deleteWebauthnCredential as F, passkeyLoginOptions as G, passkeyLoginVerify as H, getSecurityOverview as I, getSecurityLoginActivity as J, getSecuritySessions as K, revokeSecuritySession as L, revokeOtherSecuritySessions as M, getSsoDetails as N, generateSsoUrl as O, ssoCallback as P, getRefreshToken as Q, getAuthRefreshToken as R, getAccessToken as S, isAuthenticated as T, isAuthenticateApp as U, isAccessTokenExpired as V, isExpiresAccessToken as W, type LoggerConfig as X, type TwoFaVerificationRequest as Y, type MfaOtpSendRequest as Z, type MfaPendingPasskeyOptionsRequest as _, logout as a, type MfaStatusQuery as a0, type MfaPreferenceRequest as a1, type PhoneVerifyStartRequest as a2, type PhoneVerifyConfirmRequest as a3, type TotpEnrollVerifyRequest as a4, type TotpDisableRequest as a5, type WebAuthnVerifyRequest as a6, type PasskeyLoginOptionsRequest as a7, type PasskeyLoginVerifyRequest as a8, type SecurityOverviewQuery as a9, type SecurityLoginActivityQuery as aa, type SecuritySessionsQuery as ab, type RevokeSecuritySessionPayload as ac, type ActiveSession as ad, type HttpClientConfig as ae, type LogLevel as af, type LoginHistoryRow as ag, type LoginResponseData as ah, type MfaEnrollmentStatus as ai, type MfaMethod as aj, type MfaMethodOption as ak, type PaginationResponse as al, type SecurityOverview as am, type StorageKeyConfig as an, getFieldErrors as ao, getFormErrors as ap, initializeHttpClient as aq, resetPassword as b, clientSession as c, resetPasswordVerifyToken as d, verifyEmailResend as e, forgetPassword as f, resendEmail as g, changePassword as h, profile as i, profileUpdate as j, verifyOtp as k, login as l, me as m, pendingPasskeyOptions as n, pendingPasskeyVerify as o, preLogin as p, getMfaStatus as q, registerExistingUser as r, sendMfaOtp as s, setMfaPreferences as t, startPhoneVerify as u, verifyEmail as v, confirmPhoneVerify as w, totpEnrollStart as x, totpEnrollVerify as y, totpDisable as z };