Merge pull request #580 from etn-ccis/bug/5680_typeDocs

Type Docs

login-workflow/docs/API.md

@@ -1,39 +1,43 @@
 # API
+
 This document outlines the various exports and configuration options for the React Auth Workflow package.
 
 ## RegistrationContextProviderProps
+
 The `RegistrationContextProvider` manages the state of the registration workflow. It is a React Context Provider that wraps the entire registration workflow. It is responsible for managing the state of the registration workflow and providing the necessary actions to the various screens. The `RegistrationContextProviderProps` type is used to configure the `RegistrationContextProvider`.
 
 ### Type Declaration
--  **actions**:  _`RegistrationUIActions`_
+
+-   **actions**: _`RegistrationUIActions`_
     -   Returns an object of functions that are used to manage the registration workflow. See [RegistrationUIActions](#registrationuiactions) for more information.
--  **language**: _`string`_
+-   **language**: _`string`_
     -   The language code to use for the registration workflow. This is used to determine which language to use for the UI and for the API calls.
--  **navigate**: _`(destination: -1 | string) => void`_
+-   **navigate**: _`(destination: -1 | string) => void`_
     -   A function that is used to navigate to a new URL. This is used to navigate to the various screens of the registration workflow and destination: -1 navigates back to the previous screen the user last visited.
--  **routeConfig**: _`RouteConfig`_
+-   **routeConfig**: _`RouteConfig`_
     -   An object that defines the various routes for the registration workflow. See [RouteConfig](#routeconfig) for more information.
--  **i18n**: (optional) _`i18n`_
+-   **i18n**: (optional) _`i18n`_
     -   An optional i18n object that is used to translate the UI. If not provided, the default i18n object will be used.
--  **errorConfig**: (optional) _`ErrorContextProviderProps`_
+-   **errorConfig**: (optional) _`ErrorContextProviderProps`_
     -   An optional object that is used to configure the error handling of the registration workflow. See [ErrorContextProviderProps](#errorcontextproviderprops) for more information.
 
 ## RegistrationUIActions
 
 ### Type Declaration
--  **loadEula**: _`(language: string) => Promise<string>`_
+
+-   **loadEula**: _`(language: string) => Promise<string>`_
     -   A function that is used to load the EULA. This function will be called when the user lands on the EULA screen.
-- **acceptEula**: _`() => Promise<boolean>`_
+-   **acceptEula**: _`() => Promise<boolean>`_
     -   A function that is used to accept the EULA. This function will be called when the user clicks the Next button on the EULA screen.
-- **requestRegistrationCode**: _`(email: string) => Promise<string>`_
+-   **requestRegistrationCode**: _`(email: string) => Promise<string>`_
     -   A function that is used to request a registration code. This function will be called when the user lands on the Verify Code screen as well as when a user clicks the Resend Verification Code button.
-- **validateUserRegistrationRequest**: _`(validationCode: string, validationEmail?: string) => Promise<{codeValid: boolean | string; accountExists?: boolean}>`_
+-   **validateUserRegistrationRequest**: _`(validationCode: string, validationEmail?: string) => Promise<{codeValid: boolean | string; accountExists?: boolean}>`_
     -   A function that is used to validate a registration code. This function will be called when the user clicks the Next button on the Verify Code screen screen.
-- **createPassword**: _`(password: string) => Promise<boolean>`_
+-   **createPassword**: _`(password: string) => Promise<boolean>`_
     -   A function that is used to create a password. This function will be called when the user clicks the Next button on the Create Password screen.
-- **setAccountDetails**: _`(details: AccountDetails) => Promise<boolean>`_
+-   **setAccountDetails**: _`(details: AccountDetails) => Promise<boolean>`_
     -   A function that is used to set the account details. This function will be called when the user clicks the Next button on the Account Details screen.
-- **completeRegistration**: _`(userData: any, validationCode: number | string, validationEmail: string) => Promise<{ email: string, organizationName: string }>`_
+-   **completeRegistration**: _`(userData: object) => Promise<{ email: string, organizationName: string }>`_
     -   A function that is used to complete the registration. This function will be called when the user clicks the Next button on the final registration workflow screen.
 
 ## RouteConfig
@@ -56,62 +60,69 @@ Type to represent the customizable route configuration of the authentication scr
     -   The URL path for the Contact/Support screen
 
 ## ErrorContextProviderProps
+
 The `ErrorContextProvider` manages the state of the error handling. It is a React Context Provider that is embedded into the entire authentication workflow. It is responsible for managing the state of the error handling and providing the necessary actions to the various screens. The `ErrorContextProviderProps` type is used to configure the `ErrorContextProvider`.
 
 ### Type Declaration
--  **mode**: (default: "dialog") _`"dialog" | "message-box" | "none"`_
+
+-   **mode**: (default: "dialog") _`"dialog" | "message-box" | "none"`_
     -   The mode to use for displaying errors. If set to "dialog", errors will be displayed in a dialog. If set to "message-box", errors will be displayed in a message box. If set to "none", errors will not be displayed.
-- **onClose**: (optional) _`() => void`_
+-   **onClose**: (optional) _`() => void`_
     -   A function that is called when the error dialog is closed.
-- **dialogConfig**: (optional) _`{ title?: string, dismissLabel?: string }`_
+-   **dialogConfig**: (optional) _`{ title?: string, dismissLabel?: string }`_
     -   An optional object that is used to configure the error dialog. See [DialogConfig](#dialogconfig) for more information.
-- **messageBoxConfig**: (optional) _`{ dismissible?: boolean, position?: "top" | "bottom", fontColor?: string, backgroundColor?: string, sx?: SxProps }`_
+-   **messageBoxConfig**: (optional) _`{ dismissible?: boolean, position?: "top" | "bottom", fontColor?: string, backgroundColor?: string, sx?: SxProps }`_
     -   An optional object that is used to configure the error message box. See [MessageBoxConfig](#messageboxconfig) for more information.
-  
+
 ## DialogConfig
+
 Type to represent the customizable configuration of the error dialog.
 
 ### Type Declaration
-- **title**: (optional) _`string`_
+
+-   **title**: (optional) _`string`_
     -   The title to display in the error dialog.
-- **dismissLabel**: (optional) _`string`_
+-   **dismissLabel**: (optional) _`string`_
     -   The label to display on the dismiss button in the error dialog.
 
 ## MessageBoxConfig
+
 Type to represent the customizable configuration of the error message box.
 
 ### Type Declaration
-- **dismissible**: (default: true) _`boolean`_
+
+-   **dismissible**: (default: true) _`boolean`_
     -   Determines if the error message box can be dismissed.
-- **position**: (default: "top") _`"top" | "bottom"`_
+-   **position**: (default: "top") _`"top" | "bottom"`_
     -   Determines if the error message box should be displayed at the top or bottom of the screen.
-- **fontColor**: (default: "#ffffff") _`string`_
+-   **fontColor**: (default: "#ffffff") _`string`_
     -   The font color to use for the error message box.
-- **backgroundColor**: (default: theme.palette.error.main) _`string`_
+-   **backgroundColor**: (default: theme.palette.error.main) _`string`_
     -   The background color to use for the error message box.
 
 ## Components
 
-Exported components that can be used to customize the auth workflow. 
+Exported components that can be used to customize the auth workflow.
+
+-   [BasicDialog](./components/basic-dialog.md)
+-   [ChangePasswordDialog](./components/change-password-dialog.md)
+-   [ErrorManager](./components/error-manager.md)
+-   [PasswordTextField](./components/password-text-field.md)
+-   [RegistrationWorkflow](./components/registration-workflow.md)
+-   [SetPassword](./components/set-password.md)
+-   [WorkflowCard](./components/workflow-card.md)
 
-- [BasicDialog](./components/basic-dialog.md)
-- [ChangePasswordDialog](./components/change-password-dialog.md)
-- [ErrorManager](./components/error-manager.md)
-- [PasswordTextField](./components/password-text-field.md)
-- [RegistrationWorkflow](./components/registration-workflow.md)
-- [SetPassword](./components/set-password.md)
-- [WorkflowCard](./components/workflow-card.md)
 ## Screens
 
-Exported screens that can be used to customize the auth workflow. 
-
-- [AccountDetailsScreen](./screens/account-details.md)
-- [ContactScreen](./screens/contact.md)
-- [CreateAccountScreen](./screens/create-account.md)
-- [CreatePasswordScreen](./screens/create-password.md)
-- [EulaScreen](./screens/eula.md)
-- [ForgotPasswordScreen](./screens/forgot-password.md)
-- [LoginScreen](./screens/login.md)
-- [ResetPasswordScreen](./screens/reset-password.md)
-- [SuccessScreen](./screens/success.md)
-- [VerifyCodeScreen](./screens/verify-code.md)
+Exported screens that can be used to customize the auth workflow.
+
+-   [AccountDetailsScreen](./screens/account-details.md)
+-   [ContactScreen](./screens/contact.md)
+-   [CreateAccountScreen](./screens/create-account.md)
+-   [CreatePasswordScreen](./screens/create-password.md)
+-   [EulaScreen](./screens/eula.md)
+-   [ForgotPasswordScreen](./screens/forgot-password.md)
+-   [LoginScreen](./screens/login.md)
+-   [ResetPasswordScreen](./screens/reset-password.md)
+-   [SuccessScreen](./screens/success.md)
+-   [VerifyCodeScreen](./screens/verify-code.md)

login-workflow/docs/migration-guide-3-4.md

@@ -63,8 +63,6 @@ loadEula: async (language: string): Promise<string> => {
 
 The `userData` parameter will now pass all data collected from the registration workflow, including custom data.
 
-The `validationCode` parameter now supports numbers or string.
-
 ```tsx
 // before
 completeRegistration: async (
@@ -80,9 +78,7 @@ completeRegistration: async (
 
 // after
 completeRegistration: async (
-    userData: any, // TODO: this should be properly typed
-    validationCode: string | number,
-    validationEmail?: string
+    userData: object,
 ): Promise<{ email: string; organizationName: string }> => {
     ...
 },