@ukhomeoffice/cop-react-form-renderer 6.16.1 → 6.16.2-beta

package/dist/components/FormRenderer/onPageAction.js

@@ -61,6 +61,22 @@ const onPageAction = (action, patch, patchLabel, hooks, data, formState, validat
       setSubmitting(false);
     } else {
       let pageUpdate = next => onPageChange(_helpers.default.getNextPageId(type, pages, pageId, action, next));
+      let collectionName;
+      let addAnotherName;
+      if (action.collection) {
+        collectionName = action.collection;
+        const collectionNameCapitalised = collectionName.charAt(0).toUpperCase() + collectionName.slice(1);
+        addAnotherName = "addAnother".concat(collectionNameCapitalised).slice(0, -1);
+      }
+      let collectionArray;
+      let index;
+      if (collectionName) {
+        collectionArray = form.page.formData[collectionName];
+        if (collectionArray && collectionArray.length > 0 && form.page.formData["".concat(collectionName, "ActiveId")]) {
+          index = collectionArray.findIndex(obj => obj.id === form.page.formData["".concat(collectionName, "ActiveId")]);
+        }
+      }
+
       /* eslint-disable no-case-declarations */
       switch (action.type) {
         case _models.PageAction.TYPES.SUBMIT:
@@ -68,10 +84,37 @@ const onPageAction = (action, patch, patchLabel, hooks, data, formState, validat
           break;
         case _models.PageAction.TYPES.SAVE_AND_NAVIGATE:
           const state = _objectSpread({}, currentTask);
+          // If resetActiveId is true then point active ID to first entry in collection
+          if (collectionArray && collectionArray.length > 0 && action.resetActiveId) {
+            form.page.formData["".concat(collectionName, "ActiveId")] = collectionArray[0].id;
+          }
+          // If resetActiveId is false
+          if (collectionArray && collectionArray.length > 0 && !action.resetActiveId) {
+            // Truncate collection if user has selected no to more entries
+            if (index !== undefined && action.truncateCollection && form.page.formData[addAnotherName] === 'No') {
+              form.page.formData[collectionName] = collectionArray.filter((_data, idx) => idx <= index);
+            }
+            // Set addAnother field to yes if not reached last entry in collection
+            if (index !== undefined && index + 1 < form.page.formData[collectionName].length) {
+              form.page.formData[addAnotherName] = 'Yes';
+            }
+            // Set addAnother field to no if reached last entry
+            if (index !== undefined && index + 1 === form.page.formData[collectionName].length && form.page.formData[addAnotherName]) {
+              form.page.formData[addAnotherName] = 'No';
+            }
+          }
           pageUpdate = () => _handlers.default.navigate(action, pageId, onPageChange, state);
           break;
         case _models.PageAction.TYPES.COLLECTION_ADD:
-          _utils.default.CollectionPage.addEntry(action.collection, form.page.formData);
+          // Only add entry if the index is undefined,
+          // the array is empty
+          // or the active ID is the last one in the collection,
+          // otherwise move to next entry.
+          if (index === undefined || collectionArray.length === 0 || index + 1 === form.page.formData[collectionName].length) {
+            _utils.default.CollectionPage.addEntry(action.collection, form.page.formData);
+          } else {
+            form.page.formData["".concat(action.collection, "ActiveId")] = collectionArray[index + 1].id;
+          }
 
           // We need to delete the collection entry fields from formData as it will be holding previous values.
           if (form.page.formData["".concat(action.collection)] && form.page.formData["".concat(action.collection)].length > 0) {
@@ -105,16 +148,13 @@ const onPageAction = (action, patch, patchLabel, hooks, data, formState, validat
             removedEntryFieldsToDelete.forEach(i => delete form.page.formData[i]);
           }
 
-          // 3. Retrieve the collection array from formData.
-          const collectionArray = form.page.formData[action.collection];
-
-          // 4. Assign the fields in the last collection entry to formData.
+          // 3. Assign the fields in the last collection entry to formData.
           Object.assign(form.page.formData, collectionArray[collectionArray.length - 1]);
 
-          // 5. Assign the formData ID back to the formData.
+          // 4. Assign the formData ID back to the formData.
           form.page.formData.id = formDataId;
 
-          // 6. If the collection array has entries set the correct ActiveId 
+          // 5. If the collection array has entries set the correct ActiveId 
           // otherwise delete it as well as the collection array.
           if (collectionArray.length > 0) {
             form.page.formData["".concat(action.collection, "ActiveId")] = collectionArray[collectionArray.length - 1].id;

package/dist/components/FormRenderer/onPageAction.test.js

@@ -380,6 +380,74 @@ describe('components.FormRenderer.onPageAction', () => {
     // that's called as part of the onSubmit hook's onSuccess callback.
     expect(_handlers.default.navigateCalls).toEqual(1);
   });
+  it("should handle the ".concat(_models.PageAction.TYPES.COLLECTION_ADD, " Page Action type where active ID is not the last entry in collection"), () => {
+    // If the active ID is not the last entry in the collection
+    // then a new entry is not added
+    // and the active ID moves to the next entry ID.
+    const FORM_STATE = {
+      page: {
+        formData: {
+          'testCollection': [{
+            id: '1'
+          }, {
+            id: '2'
+          }],
+          testCollectionActiveId: '1'
+        }
+      }
+    };
+    const ACTION = {
+      type: _models.PageAction.TYPES.COLLECTION_ADD,
+      collection: 'testCollection'
+    };
+    const CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+      action: ACTION,
+      formState: FORM_STATE
+    });
+    _onPageAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+    preActionChecks();
+    expect(FORM_STATE.page.formData["".concat(ACTION.collection, "ActiveId")]).toEqual('2');
+    expect(FORM_STATE.page.formData[ACTION.collection].length).toEqual(2);
+    postActionChecks(CUSTOM_ARGS);
+
+    // This action type also sets up a call to handlers.navigate
+    // that's called as part of the onSubmit hook's onSuccess callback.
+    expect(_handlers.default.navigateCalls).toEqual(1);
+  });
+  it("should handle the ".concat(_models.PageAction.TYPES.COLLECTION_ADD, " Page Action type where active ID is the last entry in collection"), () => {
+    // If the active ID is the last entry in the collection
+    // then a new entry is added (although not picked up in this test)
+    // and the active ID becomes null.
+    const FORM_STATE = {
+      page: {
+        formData: {
+          'testCollection': [{
+            id: '1'
+          }, {
+            id: '2'
+          }],
+          testCollectionActiveId: '2'
+        }
+      }
+    };
+    const ACTION = {
+      type: _models.PageAction.TYPES.COLLECTION_ADD,
+      collection: 'testCollection'
+    };
+    const CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+      action: ACTION,
+      formState: FORM_STATE
+    });
+    _onPageAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+    preActionChecks();
+    expect(FORM_STATE.page.formData["".concat(ACTION.collection, "ActiveId")]).toEqual(null);
+    expect(FORM_STATE.page.formData[ACTION.collection].length).toEqual(2);
+    postActionChecks(CUSTOM_ARGS);
+
+    // This action type also sets up a call to handlers.navigate
+    // that's called as part of the onSubmit hook's onSuccess callback.
+    expect(_handlers.default.navigateCalls).toEqual(1);
+  });
   it("should clean previous collection entry fields at top level of formData", () => {
     const FORM_STATE = {
       page: {
@@ -708,6 +776,116 @@ describe('components.FormRenderer.onPageAction', () => {
         expect(FORM_STATE.page.formData.parent[0].child[0].id).toEqual('12345');
       });
     });
+    it("should work for the ".concat(_models.PageAction.TYPES.SAVE_AND_NAVIGATE, " action type to reset the active ID"), () => {
+      // In this test the action includes the resetActiveId field
+      // requiring that the active ID is pointed to the first entry in the collection
+      // so that user can cycle through the full collection again.
+      const FORM_STATE = {
+        page: {
+          formData: {
+            testCollection: [{
+              id: '1'
+            }, {
+              id: '2'
+            }, {
+              id: '3'
+            }],
+            testCollectionActiveId: '3'
+          }
+        }
+      };
+      const ACTION = {
+        type: _models.PageAction.TYPES.SAVE_AND_NAVIGATE,
+        collection: 'testCollection',
+        resetActiveId: true
+      };
+      const CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+        formState: FORM_STATE,
+        action: ACTION
+      });
+      _onPageAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+      preActionChecks();
+      // All the actions does in this case is set a function
+      // to be called in the onSuccess callback for the onSubmit hook.
+      postActionChecks(CUSTOM_ARGS);
+      expect(_handlers.default.navigateCalls).toEqual(1);
+      expect(FORM_STATE.page.formData["".concat(ACTION.collection, "ActiveId")]).toEqual('1');
+    });
+    it("should work for the ".concat(_models.PageAction.TYPES.SAVE_AND_NAVIGATE, " action type to truncate the collection"), () => {
+      // In this test the action includes the truncateCollection field
+      // and if the user has selected no to more entries
+      // then all entries after current index (from active ID) are truncated.
+      const FORM_STATE = {
+        page: {
+          formData: {
+            tests: [{
+              id: '1'
+            }, {
+              id: '2'
+            }, {
+              id: '3'
+            }],
+            testsActiveId: '2',
+            addAnotherTest: 'No'
+          }
+        }
+      };
+      const ACTION = {
+        type: _models.PageAction.TYPES.SAVE_AND_NAVIGATE,
+        collection: 'tests',
+        truncateCollection: true
+      };
+      const CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+        formState: FORM_STATE,
+        action: ACTION
+      });
+      _onPageAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+      preActionChecks();
+      // All the actions does in this case is set a function
+      // to be called in the onSuccess callback for the onSubmit hook.
+      postActionChecks(CUSTOM_ARGS);
+      expect(_handlers.default.navigateCalls).toEqual(1);
+      expect(FORM_STATE.page.formData["".concat(ACTION.collection, "ActiveId")]).toEqual('2');
+      expect(FORM_STATE.page.formData[ACTION.collection].length).toEqual(2);
+      expect(FORM_STATE.page.formData['addAnotherTest']).toEqual('No');
+    });
+    it("should work for the ".concat(_models.PageAction.TYPES.SAVE_AND_NAVIGATE, " action type to set addAnother to yes"), () => {
+      // If the user is midway through the collection
+      // then the addAnother field is set to yes 
+      // to allow the navigation to move to next entry.
+      const FORM_STATE = {
+        page: {
+          formData: {
+            tests: [{
+              id: '1'
+            }, {
+              id: '2'
+            }, {
+              id: '3'
+            }],
+            testsActiveId: '2',
+            addAnotherTest: 'No'
+          }
+        }
+      };
+      const ACTION = {
+        type: _models.PageAction.TYPES.SAVE_AND_NAVIGATE,
+        collection: 'tests'
+      };
+      const CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+        formState: FORM_STATE,
+        action: ACTION
+      });
+      _onPageAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+      preActionChecks();
+      // All the actions does in this case is set a function
+      // to be called in the onSuccess callback for the onSubmit hook.
+      postActionChecks(CUSTOM_ARGS);
+      expect(_handlers.default.navigateCalls).toEqual(1);
+      expect(FORM_STATE.page.formData["".concat(ACTION.collection, "ActiveId")]).toEqual('2');
+      expect(FORM_STATE.page.formData[ACTION.collection].length).toEqual(3);
+      expect(FORM_STATE.page.formData['addAnotherTest']).toEqual('Yes');
+    });
     it("should work for the ".concat(_models.PageAction.TYPES.NAVIGATE, " action type"), () => {
       const FORM_STATE = {
         page: {

package/dist/utils/CollectionPage/removeCollectionPageEntry.js

@@ -28,6 +28,8 @@ const removeCollectionPageEntry = (collectionName, formData, id) => {
   }
   const deletedEntry = collectionData[indexToDelete];
   collectionData.splice(indexToDelete, 1);
+  const data = formData;
+  data["".concat(collectionName, "ActiveId")] = collectionData.length > 0 ? collectionData[0].id : null;
   return deletedEntry;
 };
 var _default = exports.default = removeCollectionPageEntry;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "6.16.1",
+  "version": "6.16.2-beta",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",