@ukhomeoffice/cop-react-form-renderer 4.18.0 → 5.0.0-alpha

package/dist/utils/FormPage/getFormPages.test.js

@@ -1,98 +0,0 @@
-"use strict";
-
-var _getFormPages = _interopRequireDefault(require("./getFormPages"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-describe('utils', function () {
-  describe('FormPage', function () {
-    describe('getFormPages', function () {
-      var FORM_COMPONENTS = [{
-        id: 'a',
-        fieldId: 'a',
-        label: 'Alpha',
-        type: 'text'
-      }, {
-        id: 'b',
-        fieldId: 'b',
-        label: 'Bravo',
-        type: 'text'
-      }, // eslint-disable-next-line no-template-curly-in-string
-      {
-        id: 'c',
-        fieldId: 'c',
-        label: 'Charlie',
-        type: 'radios',
-        data: {
-          url: '${urls.refData}/v3/charlies'
-        }
-      }];
-      var FORM_DATA = {
-        urls: {
-          refData: 'https://ho.gov.uk/ref-data/'
-        }
-      };
-      it('should handle null or undefined pageOptions', function () {
-        expect((0, _getFormPages.default)(null, FORM_COMPONENTS, FORM_DATA)).toEqual([]);
-        expect((0, _getFormPages.default)(undefined, FORM_COMPONENTS, FORM_DATA)).toEqual([]);
-      });
-      it('should appropriately set up multiples pages with various configurations', function () {
-        var PAGE_1 = {
-          title: 'Page 1',
-          components: [{
-            type: 'heading',
-            size: 'l',
-            content: 'Page heading'
-          }]
-        };
-        var PAGE_2 = {
-          title: 'Page 2',
-          components: ["Opening paragraph", {
-            type: 'heading',
-            size: 'l',
-            content: 'Page heading'
-          }, "Closing paragraph", {
-            use: 'c'
-          }]
-        };
-        var PAGES = [PAGE_1, PAGE_2];
-        var C = FORM_COMPONENTS[2];
-        expect((0, _getFormPages.default)(PAGES, FORM_COMPONENTS, FORM_DATA)).toEqual([{
-          index: 0,
-          title: PAGE_1.title,
-          components: PAGE_1.components,
-          formData: FORM_DATA
-        }, {
-          index: 1,
-          title: PAGE_2.title,
-          components: [{
-            type: 'html',
-            tagName: 'p',
-            content: PAGE_2.components[0]
-          }, _objectSpread(_objectSpread({}, PAGE_2.components[1]), {}, {
-            full_path: PAGE_2.components[1].fieldId
-          }), {
-            type: 'html',
-            tagName: 'p',
-            content: PAGE_2.components[2]
-          }, _objectSpread(_objectSpread({
-            use: 'c'
-          }, C), {}, {
-            cya_label: C.label,
-            data: {
-              url: "".concat(FORM_DATA.urls.refData, "/v3/charlies")
-            },
-            full_path: C.fieldId
-          })],
-          formData: FORM_DATA
-        }]);
-      });
-    });
-  });
-});

package/dist/utils/FormPage/getPageActions.test.js

@@ -1,89 +0,0 @@
-"use strict";
-
-var _models = require("../../models");
-
-var _getPageActions = _interopRequireDefault(require("./getPageActions"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-// Local imports
-describe('utils', function () {
-  describe('FormPage', function () {
-    describe('getPageActions', function () {
-      it('should handle a null or undefined page', function () {
-        expect((0, _getPageActions.default)(null)).toBeUndefined();
-        expect((0, _getPageActions.default)(undefined)).toBeUndefined();
-      });
-      it('should handle a null or undefined actions array', function () {
-        expect((0, _getPageActions.default)({
-          actions: null
-        })).toBeUndefined();
-        expect((0, _getPageActions.default)({
-          actions: undefined
-        })).toBeUndefined();
-      });
-      it('should handle an array of strings', function () {
-        var actions = [_models.PageAction.TYPES.SAVE_AND_CONTINUE, _models.PageAction.TYPES.SAVE_AND_RETURN];
-        expect((0, _getPageActions.default)({
-          actions: actions
-        })).toEqual([_models.PageAction.DEFAULTS.saveAndContinue, _models.PageAction.DEFAULTS.saveAndReturn]);
-      });
-      it('should handle a null entry in the array', function () {
-        var actions = [_models.PageAction.TYPES.SAVE_AND_CONTINUE, _models.PageAction.TYPES.SAVE_AND_RETURN, null];
-        expect((0, _getPageActions.default)({
-          actions: actions
-        })).toEqual([_models.PageAction.DEFAULTS.saveAndContinue, _models.PageAction.DEFAULTS.saveAndReturn]);
-      });
-      it('should handle an undefined entry in the array', function () {
-        var actions = [undefined, _models.PageAction.TYPES.SAVE_AND_CONTINUE, undefined, _models.PageAction.TYPES.SAVE_AND_RETURN];
-        expect((0, _getPageActions.default)({
-          actions: actions
-        })).toEqual([_models.PageAction.DEFAULTS.saveAndContinue, _models.PageAction.DEFAULTS.saveAndReturn]);
-      });
-      it('should handle an object entry in the array', function () {
-        var actions = [{
-          type: 'navigate',
-          page: 'alpha'
-        }];
-        expect((0, _getPageActions.default)({
-          actions: actions
-        })).toEqual(actions);
-      });
-      it('should convert an href to a page', function () {
-        var actions = [{
-          type: 'navigate',
-          href: '/alpha/bravo'
-        }];
-        expect((0, _getPageActions.default)({
-          actions: actions
-        })).toEqual([{
-          type: 'navigate',
-          page: 'bravo',
-          href: '/alpha/bravo'
-        }]);
-      });
-      it('should convert a url to a page', function () {
-        var actions = [{
-          type: 'navigate',
-          url: '/alpha/bravo'
-        }];
-        expect((0, _getPageActions.default)({
-          actions: actions
-        })).toEqual([{
-          type: 'navigate',
-          page: 'bravo',
-          url: '/alpha/bravo'
-        }]);
-      });
-      it('should handle an action without a page, href, or url', function () {
-        var actions = [{
-          type: 'submit',
-          label: 'Charlie'
-        }];
-        expect((0, _getPageActions.default)({
-          actions: actions
-        })).toEqual(actions);
-      });
-    });
-  });
-});

package/dist/utils/FormPage/getParagraphFromText.test.js

@@ -1,29 +0,0 @@
-"use strict";
-
-var _models = require("../../models");
-
-var _getParagraphFromText = _interopRequireDefault(require("./getParagraphFromText"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-// Local imports
-describe('utils', function () {
-  describe('FormPage', function () {
-    describe('getParagraphFromText', function () {
-      it('should handle text content', function () {
-        var CONTENT = 'Appropriate text content';
-        expect((0, _getParagraphFromText.default)(CONTENT)).toEqual({
-          type: _models.ComponentTypes.HTML,
-          tagName: 'p',
-          content: CONTENT
-        });
-      });
-      it('should handle undefined content', function () {
-        expect((0, _getParagraphFromText.default)(undefined)).toEqual({
-          type: _models.ComponentTypes.HTML,
-          tagName: 'p'
-        });
-      });
-    });
-  });
-});

package/dist/utils/FormPage/showFormPage.test.js

@@ -1,182 +0,0 @@
-"use strict";
-
-var _showFormPage = _interopRequireDefault(require("./showFormPage"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-describe('utils', function () {
-  describe('FormPage', function () {
-    describe('showFormPage', function () {
-      var DATA = {
-        alpha: 'Alpha',
-        bravo: 'Bravo'
-      };
-      var HTML = {
-        type: 'html',
-        tagName: 'p',
-        content: 'Alpha'
-      };
-      var INSET_TEXT = {
-        type: 'inset-text',
-        content: 'Bravo'
-      };
-      var HEADING = {
-        type: 'heading',
-        size: 'm',
-        content: 'Charlie'
-      };
-      it('should NOT be shown when the page is null', function () {
-        expect((0, _showFormPage.default)(null, DATA)).toBeFalsy();
-      });
-      it('should NOT be shown when the page has a single show_when condition that is NOT matched', function () {
-        var PAGE = {
-          show_when: {
-            field: 'charlie',
-            op: '=',
-            value: 'Charlie'
-          }
-        };
-        expect((0, _showFormPage.default)(PAGE, DATA)).toBeFalsy();
-      });
-      it('should NOT be shown when the page has a multiple show_when conditions and at least one is NOT matched', function () {
-        var PAGE = {
-          show_when: [{
-            field: 'alpha',
-            op: '=',
-            value: 'Alpha'
-          }, {
-            field: 'charlie',
-            op: '=',
-            value: 'Charlie'
-          }]
-        };
-        expect((0, _showFormPage.default)(PAGE, DATA)).toBeFalsy();
-      });
-      it('SHOULD be shown when the page has a single show_when condition that IS matched', function () {
-        var PAGE = {
-          show_when: {
-            field: 'alpha',
-            op: '=',
-            value: 'Alpha'
-          }
-        };
-        expect((0, _showFormPage.default)(PAGE, DATA)).toBeTruthy();
-      });
-      it('SHOULD be shown when the page has a multiple show_when conditions that are ALL matched', function () {
-        var PAGE = {
-          show_when: [{
-            field: 'alpha',
-            op: '=',
-            value: 'Alpha'
-          }, {
-            field: 'charlie',
-            op: '!=',
-            value: 'Charlie'
-          }]
-        };
-        expect((0, _showFormPage.default)(PAGE, DATA)).toBeTruthy();
-      });
-      it('SHOULD be shown when the page has NO show_when conditions and NO editable components', function () {
-        var PAGE = {
-          components: [HTML, INSET_TEXT, HEADING]
-        };
-        expect((0, _showFormPage.default)(PAGE, DATA)).toBeTruthy();
-      });
-      it('should NOT be shown when the page has NO show_when conditions and NO SHOWN editable components', function () {
-        var TEXT = {
-          type: 'text',
-          show_when: {
-            field: 'charlie',
-            op: '=',
-            value: 'Charlie'
-          }
-        };
-        var RADIOS = {
-          type: 'radios',
-          show_when: {
-            field: 'charlie',
-            op: '=',
-            value: 'Charlie'
-          }
-        };
-        var PAGE = {
-          components: [TEXT, RADIOS]
-        };
-        expect((0, _showFormPage.default)(PAGE, DATA)).toBeFalsy();
-      });
-      it('SHOULD be shown when the page has NO show_when conditions and AT LEAST ONE SHOWN editable components', function () {
-        var TEXT = {
-          type: 'text',
-          show_when: {
-            field: 'alpha',
-            op: '=',
-            value: 'Alpha'
-          }
-        };
-        var RADIOS = {
-          type: 'radios',
-          show_when: {
-            field: 'charlie',
-            op: '=',
-            value: 'Charlie'
-          }
-        };
-        var PAGE = {
-          components: [TEXT, RADIOS]
-        };
-        expect((0, _showFormPage.default)(PAGE, DATA)).toBeTruthy();
-      });
-      it('SHOULD be shown when the page has multiple show_when conditions, with type "or" provided and ALL are matched', function () {
-        var PAGE = {
-          show_when: {
-            "type": "or",
-            "conditions": [{
-              field: 'alpha',
-              op: '=',
-              value: 'Alpha'
-            }, {
-              field: 'bravo',
-              op: '=',
-              value: 'Bravo'
-            }]
-          }
-        };
-        expect((0, _showFormPage.default)(PAGE, DATA)).toBeTruthy();
-      });
-      it('SHOULD be shown when the page has multiple show_when conditions, with type "or" provided and at least ONE is matched', function () {
-        var PAGE = {
-          show_when: {
-            "type": "or",
-            "conditions": [{
-              field: 'alpha',
-              op: '=',
-              value: 'Alpha'
-            }, {
-              field: 'charlie',
-              op: '=',
-              value: 'Charlie'
-            }]
-          }
-        };
-        expect((0, _showFormPage.default)(PAGE, DATA)).toBeTruthy();
-      });
-      it('should NOT be shown when the page has multiple show_when conditions, with type "or" provided and NONE are matched', function () {
-        var PAGE = {
-          show_when: {
-            "type": "or",
-            "conditions": [{
-              field: 'alpha',
-              op: '!=',
-              value: 'Alpha'
-            }, {
-              field: 'charlie',
-              op: '=',
-              value: 'Charlie'
-            }]
-          }
-        };
-        expect((0, _showFormPage.default)(PAGE, DATA)).toBeFalsy();
-      });
-    });
-  });
-});

package/dist/utils/FormPage/showFormPageCYA.test.js

@@ -1,30 +0,0 @@
-"use strict";
-
-var _showFormPageCYA = _interopRequireDefault(require("./showFormPageCYA"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-describe('utils.FormPage.showFormPageCYA', function () {
-  var DATA = {
-    alpha: 'Alpha',
-    bravo: 'Bravo'
-  };
-  it('should NOT be shown when the page is null', function () {
-    expect((0, _showFormPageCYA.default)(null, DATA)).toEqual(false);
-  });
-  it('should NOT be shown if the show_on_cya flag is false', function () {
-    var PAGE = {
-      show_on_cya: false
-    };
-    expect((0, _showFormPageCYA.default)(PAGE, DATA)).toEqual(false);
-  });
-  it('SHOULD be shown if the show_on_cya flag is true', function () {
-    var PAGE = {
-      show_on_cya: true
-    };
-    expect((0, _showFormPageCYA.default)(PAGE, DATA)).toEqual(true);
-  });
-  it('SHOULD be shown if the show_on_cya flag is missing', function () {
-    expect((0, _showFormPageCYA.default)({}, DATA)).toEqual(true);
-  });
-});

package/dist/utils/FormPage/useComponent.test.js

@@ -1,169 +0,0 @@
-"use strict";
-
-var _models = require("../../models");
-
-var _useComponent = _interopRequireDefault(require("./useComponent"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-describe('utils', function () {
-  describe('FormPage', function () {
-    describe('useComponent', function () {
-      var ZULU = {
-        id: 'z',
-        fieldId: 'z',
-        label: 'Zulu',
-        type: _models.ComponentTypes.TEXT
-      };
-      var CONTAINER = {
-        id: 'container',
-        fieldId: 'container',
-        label: 'Container',
-        type: _models.ComponentTypes.CONTAINER,
-        components: [{
-          id: 'f',
-          fieldId: 'f',
-          label: 'Foxtrot',
-          type: _models.ComponentTypes.TEXT
-        }, ZULU]
-      };
-      var FORM_COMPONENTS = [{
-        id: 'a',
-        fieldId: 'a',
-        label: 'Alpha',
-        type: _models.ComponentTypes.TEXT
-      }, {
-        id: 'b',
-        fieldId: 'b',
-        label: 'Bravo',
-        type: _models.ComponentTypes.TEXT
-      }, {
-        id: 'c',
-        fieldId: 'c',
-        label: 'Charlie',
-        type: _models.ComponentTypes.TEXT
-      }, {
-        id: 'd',
-        fieldId: 'd',
-        cya_label: 'Delta',
-        type: _models.ComponentTypes.TEXT
-      }, CONTAINER];
-      it('should handle a null toUse configuration', function () {
-        var TO_USE = null;
-        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual({});
-      });
-      it('should handle an unrecognised component reference', function () {
-        var TO_USE = {
-          use: 'e',
-          label: 'Echo'
-        };
-        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(TO_USE);
-      });
-      it('should use the appropriate component', function () {
-        var TO_USE = {
-          use: 'a'
-        };
-        var A = FORM_COMPONENTS[0];
-        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(_objectSpread(_objectSpread({
-          use: 'a'
-        }, A), {}, {
-          cya_label: A.label
-        }));
-      });
-      it('should allow the fieldId to be overridden', function () {
-        var TO_USE = {
-          use: 'a',
-          fieldId: 'alpha'
-        };
-        var A = FORM_COMPONENTS[0];
-        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(_objectSpread(_objectSpread({
-          use: 'a'
-        }, A), {}, {
-          cya_label: A.label,
-          fieldId: TO_USE.fieldId
-        }));
-      });
-      it('should allow the label to be overridden but keep the cya_label unaffected', function () {
-        var TO_USE = {
-          use: 'a',
-          label: 'Alpha foxtrot'
-        };
-        var A = FORM_COMPONENTS[0];
-        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(_objectSpread(_objectSpread({
-          use: 'a'
-        }, A), {}, {
-          cya_label: A.label,
-          label: TO_USE.label
-        }));
-      });
-      it('should allow the form component cya_label, if label is empty', function () {
-        var TO_USE = {
-          use: 'd',
-          label: ''
-        };
-        var A = FORM_COMPONENTS[3];
-        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(_objectSpread(_objectSpread({
-          use: 'd'
-        }, A), {}, {
-          cya_label: A.cya_label,
-          label: TO_USE.label
-        }));
-      });
-      it('should allow the form component cya_label, if label is not given', function () {
-        var TO_USE = {
-          use: 'd'
-        };
-        var A = FORM_COMPONENTS[3];
-        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(_objectSpread(_objectSpread({
-          use: 'd'
-        }, A), {}, {
-          cya_label: A.cya_label,
-          label: TO_USE.label
-        }));
-      });
-      it('should handle a container', function () {
-        var TO_USE = {
-          use: CONTAINER.id
-        };
-        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(_objectSpread(_objectSpread({
-          use: CONTAINER.id
-        }, CONTAINER), {}, {
-          cya_label: CONTAINER.label
-        }));
-      });
-      it('should handle a component nested inside a container', function () {
-        var ID = "".concat(CONTAINER.id, ".").concat(ZULU.id);
-        var TO_USE = {
-          use: ID
-        };
-        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(_objectSpread(_objectSpread({
-          use: ID
-        }, CONTAINER), {}, {
-          cya_label: CONTAINER.label,
-          components: [ZULU // Foxtrot is not included
-          ]
-        }));
-      });
-      it('should handle an unrecognised container reference', function () {
-        var ID = "unrecognised.".concat(ZULU.id);
-        var TO_USE = {
-          use: ID
-        };
-        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(TO_USE);
-      });
-      it('should handle an unrecognised component within a container', function () {
-        var ID = "".concat(CONTAINER.id, ".unrecognised");
-        var TO_USE = {
-          use: ID
-        };
-        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(TO_USE);
-      });
-    });
-  });
-});

package/dist/utils/Format/formatData.test.js

@@ -1,46 +0,0 @@
-"use strict";
-
-var _formatData = _interopRequireDefault(require("./formatData"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-// Local imports
-describe('utils', function () {
-  describe('Format', function () {
-    describe('formatData', function () {
-      it('should handle no format', function () {
-        var FORMAT = null;
-        var VALUE = 'AlPhA';
-        expect((0, _formatData.default)(FORMAT, VALUE)).toEqual(VALUE);
-      });
-      it('should handle no value', function () {
-        var FORMAT = {
-          type: 'lowercase'
-        };
-        var VALUE = null;
-        expect((0, _formatData.default)(FORMAT, VALUE)).toBeNull();
-      });
-      it('should format a string as lowercase', function () {
-        var FORMAT = {
-          type: 'lowercase'
-        };
-        var VALUE = 'AlPhA';
-        expect((0, _formatData.default)(FORMAT, VALUE)).toEqual('alpha');
-      });
-      it('should format a string as uppercase', function () {
-        var FORMAT = {
-          type: 'uppercase'
-        };
-        var VALUE = 'AlPhA';
-        expect((0, _formatData.default)(FORMAT, VALUE)).toEqual('ALPHA');
-      });
-      it('should leave an unknown format type alone', function () {
-        var FORMAT = {
-          type: 'not-a-real-type'
-        };
-        var VALUE = 'AlPhA';
-        expect((0, _formatData.default)(FORMAT, VALUE)).toEqual(VALUE);
-      });
-    });
-  });
-});