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

package/dist/components/FormRenderer/onPageAction.js

@@ -95,21 +95,21 @@ const onPageAction = (action, patch, patchLabel, hooks, data, formState, validat
               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 < collectionArray.length) {
+            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 === collectionArray.length && form.page.formData[addAnotherName]) {
+            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:
-          // Only add item if the index is undefined,
+          // 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 item.
+          // 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 {

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/package.json

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