chore: added js doc

src/hooks/useReimbursementAccountStepFormSubmit.ts

@@ -10,6 +10,15 @@ type UseReimbursementAccountStepFormSubmitParams = Pick<SubStepProps, 'isEditing
     fieldIds: Array<keyof ReimbursementAccountDraftValues>;
 };
 
+/**
+ * Hook for handling submit method in ReimbursementAccount substeps.
+ * When user is in editing mode we should save values only when user confirm that
+ * @param formId - ID for particular form
+ * @param isEditing - if form is in editing mode
+ * @param onNext - callback
+ * @param fieldIds - field IDs for particular step
+ */
+
 export default function useReimbursementAccountStepFormSubmit({
     formId = ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM,
     isEditing,

src/hooks/useSubStep/index.ts

@@ -3,6 +3,9 @@ import type {SubStepProps, UseSubStep} from './types';
 
 /**
  * This hook ensures uniform handling of components across different screens, enabling seamless integration and navigation through sub steps of the VBBA flow.
+ * @param bodyContent - array of components to display in particular step
+ * @param onFinished - callback triggered after finish last step
+ * @param startFrom - initial index for bodyContent array
  */
 export default function useSubStep<TProps extends SubStepProps>({bodyContent, onFinished, startFrom = 0}: UseSubStep<TProps>) {
     const [screenIndex, setScreenIndex] = useState(startFrom);

src/libs/ValidationUtils.ts

@@ -74,6 +74,7 @@ function isValidPastDate(date: string | Date): boolean {
 
 /**
  * Used to validate a value that is "required".
+ * @param value - field value
  */
 function isRequiredFulfilled(value?: string | boolean | Date | unknown[] | Record<string, unknown> | null): boolean {
     if (!value) {
@@ -91,11 +92,15 @@ function isRequiredFulfilled(value?: string | boolean | Date | unknown[] | Recor
     }
     return Boolean(value);
 }
-
+/**
+ * Used for getting errors for required fields.
+ */
 type GetFieldRequiredErrorsReturn<K extends string[]> = {[P in K[number]]: string};
 
 /**
  * Used to add requiredField error to the fields passed.
+ * @param values - all form values
+ * @param requiredFields - required fields for particular form
  */
 function getFieldRequiredErrors<T extends OnyxFormValuesFields, K extends string[]>(values: T, requiredFields: K): GetFieldRequiredErrorsReturn<K> {
     const errors: GetFieldRequiredErrorsReturn<K> = {} as GetFieldRequiredErrorsReturn<K>;

src/libs/actions/BankAccounts.ts

@@ -144,8 +144,8 @@ function getVBBADataForOnyx(currentStep?: BankAccountStep): OnyxData {
     };
 }
 
-function addBusinessWebsiteForDraft(website: string) {
-    Onyx.merge(ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM_DRAFT, {website});
+function addBusinessWebsiteForDraft(websiteUrl: string) {
+    Onyx.merge(ONYXKEYS.FORMS.REIMBURSEMENT_ACCOUNT_FORM_DRAFT, {website: websiteUrl});
 }
 
 /**
@@ -251,6 +251,8 @@ function deletePaymentBankAccount(bankAccountID: number) {
  * Update the user's personal information on the bank account in database.
  *
  * This action is called by the requestor step in the Verified Bank Account flow
+ * @param bankAccountID - ID for bank account
+ * @param params - User personal data
  */
 function updatePersonalInformationForBankAccount(bankAccountID: number, params: RequestorStepProps) {
     API.write(
@@ -308,6 +310,13 @@ function clearReimbursementAccount() {
     Onyx.set(ONYXKEYS.REIMBURSEMENT_ACCOUNT, null);
 }
 
+/**
+ * Function to display and fetch data for Reimbursement Account step
+ * @param stepToOpen - current step to open
+ * @param subStep - particular step
+ * @param localCurrentStep - last step on device
+ * @param policyID - policy ID
+ */
 function openReimbursementAccountPage(stepToOpen: ReimbursementAccountStep, subStep: ReimbursementAccountSubStep, localCurrentStep: ReimbursementAccountStep, policyID: string) {
     const onyxData: OnyxData = {
         optimisticData: [
@@ -352,6 +361,7 @@ function openReimbursementAccountPage(stepToOpen: ReimbursementAccountStep, subS
 
 /**
  * Updates the bank account in the database with the company step data
+ * @param params - Business step form data
  */
 function updateCompanyInformationForBankAccount(bankAccountID: number, params: CompanyStepProps) {
     API.write(
@@ -367,6 +377,7 @@ function updateCompanyInformationForBankAccount(bankAccountID: number, params: C
 
 /**
  * Add beneficial owners for the bank account and verify the accuracy of the information provided
+ * @param params - Beneficial Owners step form params
  */
 function updateBeneficialOwnersForBankAccount(bankAccountID: number, params: BeneficialOwnersStepProps) {
     API.write(
@@ -382,6 +393,7 @@ function updateBeneficialOwnersForBankAccount(bankAccountID: number, params: Ben
 
 /**
  * Accept the ACH terms and conditions and verify the accuracy of the information provided
+ * @param params - Verification step form params
  */
 function acceptACHContractForBankAccount(bankAccountID: number, params: ACHContractStepProps) {
     API.write(
@@ -397,7 +409,7 @@ function acceptACHContractForBankAccount(bankAccountID: number, params: ACHContr
 
 /**
  * Create the bank account with manually entered data.
- *
+ * @param plaidMask - scheme for Plaid account number
  */
 function connectBankAccountManually(bankAccountID: number, accountNumber?: string, routingNumber?: string, plaidMask?: string, policyID?: string) {
     const parameters: ConnectBankAccountManuallyParams = {