@oneblink/apps-react 10.3.1 → 11.0.0-beta.10

package/dist/hooks/useMfa.d.ts

@@ -1,22 +1,42 @@
 import * as React from 'react';
-import { authService } from '../apps';
+import { mfaService } from '../apps';
+import { MiscTypes } from '@oneblink/types';
 type MfaState = {
     isExternalIdentityProviderUser: boolean;
     isLoading: boolean;
     isMfaEnabled: boolean;
+    mfaSettings: mfaService.MfaSettings;
+    isSetupSuccessOpen: boolean;
     loadingError?: Error;
     isSettingUpMfa: boolean;
-    isDisablingMfa: boolean;
+    settingUpMfaMethod?: mfaService.MfaMethod;
+    isSetupMethodDialogOpen: boolean;
+    disablingMfaMethod?: mfaService.MfaMethod;
+    isSettingPreferredMfaMethod: boolean;
     setupError?: Error;
-    mfaSetup?: Awaited<ReturnType<typeof authService.setupMfa>>;
+    mfaAuthenticatorAppSetup?: Awaited<ReturnType<typeof mfaService.setupMfaAuthenticatorApp>>;
+    isPhoneNumberDialogOpen: boolean;
+    phoneVerificationCodeSentAt?: number;
+    isRemovePhoneNumberDialogOpen: boolean;
 };
 export declare const MfaContext: React.Context<MfaState & {
-    beginMfaSetup: () => void;
-    cancelMfaSetup: () => void;
-    completeMfaSetup: () => void;
-    beginDisablingMfa: () => void;
+    beginMfaSetup: (mfaMethod: mfaService.MfaMethod) => Promise<void>;
+    openMfaSetupMethodDialog: () => void;
+    closeMfaSetupMethodDialog: () => void;
+    beginDisablingMfaMethod: (mfaMethod: mfaService.MfaMethod) => void;
+    setPreferredMfaMethod: (mfaMethod: mfaService.MfaMethod) => Promise<void>;
+    openPhoneNumberDialog: () => void;
+    closePhoneNumberDialog: () => void;
+    savePhoneNumber: (phoneNumber: string) => Promise<void>;
+    verifyPhoneNumber: (code: string) => Promise<void>;
+    beginRemovingPhoneNumber: () => void;
+    cancelRemovingPhoneNumber: () => void;
+    completeRemovingPhoneNumber: () => Promise<void>;
+    hideSetupSuccess: () => void;
+    cancelMfaAuthenticatorAppSetup: () => void;
+    completeMfaAuthenticatorAppSetup: () => Promise<void>;
     cancelDisablingMfa: () => void;
-    completeDisablingMfa: () => void;
+    completeDisablingMfa: () => Promise<void>;
     clearMfaSetupError: () => void;
     loadMfa: () => void;
 }>;
@@ -36,23 +56,36 @@ export declare const MfaContext: React.Context<MfaState & {
  *   useUserMeetsMfaRequirement,
  * } from '@oneblink/apps-react'
  *
- * function Component() {
- *   const { isLoading, userMeetsMfaRequirement } =
- *     useUserMeetsMfaRequirement(true)
- *   // use MFA Requirement details here
+ * function Component({ teamMemberMfaRequirement }) {
+ *   const { mfaSetupRequired, isLoading, loadingError, refreshMfa } =
+ *     useUserMeetsMfaRequirement(teamMemberMfaRequirement)
+ *
+ *   if (isLoading) {
+ *     return <Loading />
+ *   }
+ *
+ *   if (loadingError) {
+ *     return <Error onRetry={refreshMfa} />
+ *   }
+ *
+ *   if (mfaSetupRequired) {
+ *     return <ConfigureMfa />
+ *   }
+ *
+ *   return <Application />
  * }
  *
- * function App() {
+ * function App({ teamMemberMfaRequirement }) {
  *   return (
  *     <MfaProvider isExternalIdentityProviderUser={false}>
- *       <Component />
+ *       <Component teamMemberMfaRequirement={teamMemberMfaRequirement} />
  *     </MfaProvider>
  *   )
  * }
  *
  * const root = document.getElementById('root')
  * if (root) {
- *   ReactDOM.render(<App />, root)
+ *   ReactDOM.render(<App teamMemberMfaRequirement={mfaRequirement} />, root)
  * }
  * ```
  *
@@ -65,35 +98,69 @@ export declare function MfaProvider({ children, isExternalIdentityProviderUser,
     isExternalIdentityProviderUser: boolean;
 }): import("react/jsx-runtime").JSX.Element;
 export default function useMfa(): MfaState & {
-    beginMfaSetup: () => void;
-    cancelMfaSetup: () => void;
-    completeMfaSetup: () => void;
-    beginDisablingMfa: () => void;
+    beginMfaSetup: (mfaMethod: mfaService.MfaMethod) => Promise<void>;
+    openMfaSetupMethodDialog: () => void;
+    closeMfaSetupMethodDialog: () => void;
+    beginDisablingMfaMethod: (mfaMethod: mfaService.MfaMethod) => void;
+    setPreferredMfaMethod: (mfaMethod: mfaService.MfaMethod) => Promise<void>;
+    openPhoneNumberDialog: () => void;
+    closePhoneNumberDialog: () => void;
+    savePhoneNumber: (phoneNumber: string) => Promise<void>;
+    verifyPhoneNumber: (code: string) => Promise<void>;
+    beginRemovingPhoneNumber: () => void;
+    cancelRemovingPhoneNumber: () => void;
+    completeRemovingPhoneNumber: () => Promise<void>;
+    hideSetupSuccess: () => void;
+    cancelMfaAuthenticatorAppSetup: () => void;
+    completeMfaAuthenticatorAppSetup: () => Promise<void>;
     cancelDisablingMfa: () => void;
-    completeDisablingMfa: () => void;
+    completeDisablingMfa: () => Promise<void>;
     clearMfaSetupError: () => void;
     loadMfa: () => void;
 };
 /**
- * React hook to check if the logged in user meets the MFA requirement of your
- * application. Will throw an Error if used outside of the `<MfaProvider />`
- * component.
+ * React hook to determine whether the logged in user must set up MFA before
+ * accessing your application. Reads MFA settings from the `<MfaProvider />`
+ * context. Will throw an Error if used outside of `<MfaProvider />`.
+ *
+ * Users signed in via an external identity provider are not required to set up
+ * MFA.
  *
- * Example
+ * #### Example
  *
  * ```js
- * import { useUserMeetsMfaRequirement } from '@oneblink/apps-react'
+ * import { MfaProvider, useUserMeetsMfaRequirement } from '@oneblink/apps-react'
  *
- * const isMfaRequired = true
+ * function Component({ teamMemberMfaRequirement }) {
+ *   const { mfaSetupRequired, isLoading, loadingError, refreshMfa } =
+ *     useUserMeetsMfaRequirement(teamMemberMfaRequirement)
  *
- * function Component() {
- *   const userMeetsMfaRequirement =
- *     useUserMeetsMfaRequirement(isMfaRequired)
+ *   if (isLoading) {
+ *     return <Loading />
+ *   }
+ *
+ *   if (loadingError) {
+ *     return <Error onRetry={refreshMfa} />
+ *   }
+ *
+ *   if (mfaSetupRequired) {
+ *     return <ConfigureMfa />
+ *   }
+ *
+ *   return <Application />
  * }
  * ```
  *
- * @returns
+ * @param mfaRequirement - The MFA requirement to enforce, e.g. from your
+ * organisation or app settings.
+ * @returns Whether MFA setup is required, along with loading state from the MFA
+ * provider.
  * @group Hooks
  */
-export declare function useUserMeetsMfaRequirement(isMfaRequired: boolean): boolean;
+export declare function useUserMeetsMfaRequirement(mfaRequirement: MiscTypes.MfaRequirement | undefined): {
+    mfaSetupRequired: boolean;
+    isLoading: boolean;
+    loadingError: Error | undefined;
+    refreshMfa: () => void;
+};
 export {};