Merge pull request #55 from episerver/feature/AFORM-3800-submit-multi…

…steps-2

Add multi step submission

src/@episerver/forms-react/src/components/FormBody.tsx

@@ -1,6 +1,6 @@
 import React, { useEffect, useRef } from "react";
-import { useForms, useFormsDispatch } from "../context/store";
-import { FormContainer, FormSubmitter, IdentityInfo, SubmitButtonType, equals, isInArray, isNull, isNullOrEmpty, FormSubmitModel, FormSubmitResult, SubmitButton, ElementValidationResult, FormValidationResult } from "@episerver/forms-sdk";
+import { useForms } from "../context/store";
+import { FormContainer, FormSubmitter, IdentityInfo, equals, isInArray, isNull, isNullOrEmpty, FormSubmitModel, FormSubmitResult, SubmitButton, FormValidationResult, FormCache, FormConstants } from "@episerver/forms-sdk";
 import { RenderElementInStep } from "./RenderElementInStep";
 import { DispatchFunctions } from "../context/dispatchFunctions";
 import { FormStepNavigation } from "./FormStepNavigation";
@@ -21,6 +21,9 @@ export const FormBody = (props: FormBodyProps) => {
     const statusMessage = useRef<string>("");
     const statusDisplay = useRef<string>("hide");
 
+    const formCache = new FormCache();
+    const localFormCache = new FormCache(window.localStorage);
+
     //TODO: these variables should be get from api or sdk
     const validateFail = useRef<boolean>(false),
         isFormFinalized = useRef<boolean>(false),
@@ -32,6 +35,7 @@ export const FormBody = (props: FormBodyProps) => {
         isReadOnlyMode = false,
         readOnlyModeMessage = "",
         currentStepIndex = formContext?.currentStepIndex ?? 0,
+        submissionStorageKey = FormConstants.FormSubmissionId + form.key,
         isStepValidToDisplay = true;
 
     if((isFormFinalized.current || isProgressiveSubmit.current) && isSuccess.current)
@@ -70,7 +74,7 @@ export const FormBody = (props: FormBodyProps) => {
         }
 
         //Find submit button, if found then check property 'finalizeForm' of submit button. Otherwise, button Next/Previous was clicked.
-        let buttonId = e.nativeEvent.submitter.id;
+        let buttonId = e.nativeEvent.submitter?.id;
         let submitButton = form.formElements.find(fe => fe.key === buttonId) as SubmitButton;
         if (!isNull(submitButton)) {
             //when submitting by SubmitButton, isProgressiveSubmit default is true
@@ -96,10 +100,11 @@ export const FormBody = (props: FormBodyProps) => {
             formKey: form.key,
             locale: form.locale,
             isFinalized: submitButton?.properties?.finalizeForm || isLastStep,
-            partialSubmissionKey: formContext?.submissionKey ?? "",
+            partialSubmissionKey: localFormCache.get(submissionStorageKey) ?? formContext?.submissionKey ?? "",
             hostedPageUrl: window.location.pathname,
             submissionData: formSubmissions,
-            accessToken: formContext?.identityInfo?.accessToken
+            accessToken: formContext?.identityInfo?.accessToken,
+            currentStepIndex: currentStepIndex
         }
 
         dispatchFunctions.updateIsSubmitting(true);
@@ -131,11 +136,19 @@ export const FormBody = (props: FormBodyProps) => {
                 //set focus on the 1st invalid element of current step
                 dispatchFunctions.updateFocusOn(getFirstInvalidElement(formValidationResults));
             }
+
             validateFail.current = response.validationFail;
             isSuccess.current = response.success;
             isFormFinalized.current = isLastStep && response.success;
             dispatchFunctions.updateSubmissionKey(response.submissionKey);
             dispatchFunctions.updateIsSubmitting(false);
+
+            localFormCache.set(submissionStorageKey, response.submissionKey)
+
+            if (isFormFinalized.current) {
+                formCache.remove(submissionStorageKey)
+                localFormCache.remove(submissionStorageKey)
+            }
         });
     }
 
@@ -202,6 +215,7 @@ export const FormBody = (props: FormBodyProps) => {
                 <FormStepNavigation
                     isFormFinalized={isFormFinalized.current}
                     history = {props.history}
+                    handleSubmit = {handleSubmit}
                 />
             </div>
         </form>

src/@episerver/forms-react/src/components/FormStepNavigation.tsx

@@ -7,16 +7,17 @@ import { useHistory } from "react-router-dom";
 interface FormStepNavigationProps {
     isFormFinalized: boolean
     history?: any
+    handleSubmit: (e: any) => void
 }
 
 export const FormStepNavigation = (props: FormStepNavigationProps) => {
     const formContext = useForms();
     const formCache = new FormCache();
     const form = formContext?.formContainer ?? {} as FormContainer;
     const depend = new StepDependCondition(form, formContext?.dependencyInactiveElements ?? []);
-    const { isFormFinalized, history } = props;
+    const { isFormFinalized, history, handleSubmit } = props;
     const dispatchFuncs = new DispatchFunctions();
-    const stepLocalizations = useRef<Record<string, string>>(form.steps?.filter(s => !isNull(s.formStep.localizations))[0]?.formStep.localizations);
+    const stepLocalizations = useRef<Record<string, string>>(form.steps?.filter(s => !isNull(s.formStep.localizations))[0]?.formStep.localizations).current;
 
     const submittable = true
     const stepCount = form.steps.length;
@@ -36,6 +37,7 @@ export const FormStepNavigation = (props: FormStepNavigationProps) => {
 
     const handleNextStep = (event: React.MouseEvent<HTMLButtonElement>) => {
         event.preventDefault()
+        handleSubmit(event)
         goToStep(depend.findNextStep(currentStepIndex) ?? 0)
     }
 
@@ -63,13 +65,13 @@ export const FormStepNavigation = (props: FormStepNavigationProps) => {
                         disabled={prevButtonDisableState}
                         onClick={(event) => handlePrevStep(event)}
                     >
-                        {stepLocalizations.current["previousButtonLabel"]}
+                        {stepLocalizations["previousButtonLabel"]}
                     </button>
 
                     <div className="Form__NavigationBar__ProgressBar">
                         <div className="Form__NavigationBar__ProgressBar--Progress" style={{ width: progressWidth }}></div>
                         <div className="Form__NavigationBar__ProgressBar--Text">
-                            <span className="Form__NavigationBar__ProgressBar__ProgressLabel">{stepLocalizations.current["pageButtonLabel"]}</span>
+                            <span className="Form__NavigationBar__ProgressBar__ProgressLabel">{stepLocalizations["pageButtonLabel"]}</span>
                             <span className="Form__NavigationBar__ProgressBar__CurrentStep">{currentDisplayStepIndex}</span>/
                             <span className="Form__NavigationBar__ProgressBar__StepsCount">{stepCount}</span>
                         </div>
@@ -83,7 +85,7 @@ export const FormStepNavigation = (props: FormStepNavigationProps) => {
                         disabled={nextButtonDisableState}
                         onClick={handleNextStep}
                     >
-                        {stepLocalizations.current["nextButtonLabel"]}
+                        {stepLocalizations["nextButtonLabel"]}
                     </button>
                 </nav>
             }

src/@episerver/forms-sdk/src/form-submit/formSubmit.ts

@@ -33,6 +33,10 @@ export interface FormSubmitModel {
      * The access token to identify login user
      */
     accessToken?: string;
+    /**
+     * The current index of submitted step
+     */
+    currentStepIndex: number;
 }
 
 export interface FormSubmitResult {
@@ -99,6 +103,7 @@ export class FormSubmitter {
             formData.append("IsFinalized", model.isFinalized.toString());
             formData.append("PartialSubmissionKey", model.partialSubmissionKey);
             formData.append("HostedPageUrl", model.hostedPageUrl);
+            formData.append("CurrentStep", model.currentStepIndex.toString());
 
             //append form submission to FormData object
             model.submissionData.forEach(data => {

src/@episerver/forms-sdk/src/models/enums/FormConstants.ts

@@ -1,5 +1,6 @@
 export enum FormConstants {
     FormAccessToken = "form_access_token",
     FormFieldPrefix = "__field_",
-    FormCurrentStep = "form_current_step_"
+    FormCurrentStep = "form_current_step_",
+    FormSubmissionId = "form_submission_id_"
 }