@ukhomeoffice/cop-react-form-renderer 0.1.0-beta

package/dist/utils/Data/setupFormData.test.js

@@ -0,0 +1,216 @@
+"use strict";
+
+var _setupFormData = _interopRequireDefault(require("./setupFormData"));
+
+var _userProfile = _interopRequireDefault(require("../../json/userProfile.json"));
+
+var _userProfileData = _interopRequireDefault(require("../../json/userProfile.data.json"));
+
+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); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { 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('Data', function () {
+    describe('setupFormData', function () {
+      it('should populate a simple form', function () {
+        var PAGES = [];
+        var COMPONENTS = [{
+          fieldId: 'testField',
+          source: {
+            field: 'sourceField'
+          }
+        }];
+        var DATA = {
+          sourceField: 'VALUE'
+        };
+        var RESULT = (0, _setupFormData.default)(PAGES, COMPONENTS, DATA);
+        expect(RESULT).toEqual({
+          sourceField: 'VALUE',
+          testField: 'VALUE'
+        });
+      });
+      it('should handle a missing source field', function () {
+        var PAGES = [];
+        var COMPONENTS = [{
+          fieldId: 'testField',
+          source: {
+            field: 'otherSourceField'
+          }
+        }];
+        var DATA = {
+          sourceField: 'VALUE'
+        };
+        var RESULT = (0, _setupFormData.default)(PAGES, COMPONENTS, DATA);
+        expect(RESULT).toEqual({
+          sourceField: 'VALUE',
+          testField: undefined
+        });
+      });
+      it('should handle a nested source field', function () {
+        var PAGES = [];
+        var COMPONENTS = [{
+          fieldId: 'testField',
+          source: {
+            field: 'nested.sourceField'
+          }
+        }];
+        var DATA = {
+          nested: {
+            sourceField: 'VALUE'
+          }
+        };
+        var RESULT = (0, _setupFormData.default)(PAGES, COMPONENTS, DATA);
+        expect(RESULT).toEqual({
+          nested: {
+            sourceField: 'VALUE'
+          },
+          testField: 'VALUE'
+        });
+      });
+      it('should handle a missing nested source field', function () {
+        var PAGES = [];
+        var COMPONENTS = [{
+          fieldId: 'testField',
+          source: {
+            field: 'nested.otherSourceField'
+          }
+        }];
+        var DATA = {
+          nested: {
+            sourceField: 'VALUE'
+          }
+        };
+        var RESULT = (0, _setupFormData.default)(PAGES, COMPONENTS, DATA);
+        expect(RESULT).toEqual({
+          nested: {
+            sourceField: 'VALUE'
+          },
+          testField: undefined
+        });
+      });
+      it('should handle an entirely missing nested source field', function () {
+        var PAGES = [];
+        var COMPONENTS = [{
+          fieldId: 'testField',
+          source: {
+            field: 'otherNested.sourceField'
+          }
+        }];
+        var DATA = {
+          nested: {
+            sourceField: 'VALUE'
+          }
+        };
+        var RESULT = (0, _setupFormData.default)(PAGES, COMPONENTS, DATA);
+        expect(RESULT).toEqual({
+          nested: {
+            sourceField: 'VALUE'
+          },
+          testField: undefined
+        });
+      });
+      it('should handle sources within pages', function () {
+        var PAGES = [{
+          components: [{
+            fieldId: 'pageField',
+            source: {
+              field: 'pageSourceField'
+            }
+          }]
+        }, {
+          components: [{
+            fieldId: 'secondPageField',
+            source: {
+              field: 'secondPageSourceField'
+            }
+          }]
+        }];
+        var COMPONENTS = [{
+          fieldId: 'testField',
+          source: {
+            field: 'nested.sourceField'
+          }
+        }];
+        var DATA = {
+          nested: {
+            sourceField: 'VALUE'
+          },
+          pageSourceField: 'PAGE 1',
+          secondPageSourceField: 'Bob'
+        };
+        var RESULT = (0, _setupFormData.default)(PAGES, COMPONENTS, DATA);
+        expect(RESULT).toEqual({
+          nested: {
+            sourceField: 'VALUE'
+          },
+          pageSourceField: 'PAGE 1',
+          secondPageSourceField: 'Bob',
+          testField: 'VALUE',
+          pageField: 'PAGE 1',
+          secondPageField: 'Bob'
+        });
+      });
+      it('should ignore sources within pages that reference a top-level component', function () {
+        var PAGES = [{
+          components: [{
+            fieldId: 'pageField',
+            use: 'testField',
+            source: {
+              field: 'pageSourceField'
+            }
+          }]
+        }, {
+          components: [{
+            fieldId: 'secondPageField',
+            source: {
+              field: 'secondPageSourceField'
+            }
+          }]
+        }];
+        var COMPONENTS = [{
+          fieldId: 'testField',
+          source: {
+            field: 'nested.sourceField'
+          }
+        }];
+        var DATA = {
+          nested: {
+            sourceField: 'VALUE'
+          },
+          pageSourceField: 'PAGE 1',
+          secondPageSourceField: 'Bob'
+        };
+        var RESULT = (0, _setupFormData.default)(PAGES, COMPONENTS, DATA);
+        expect(RESULT).toEqual({
+          nested: {
+            sourceField: 'VALUE'
+          },
+          pageSourceField: 'PAGE 1',
+          secondPageSourceField: 'Bob',
+          testField: 'VALUE',
+          secondPageField: 'Bob'
+        });
+      });
+      it('should populate data for the user profile configuration and source', function () {
+        var pages = _userProfile.default.pages,
+            components = _userProfile.default.components;
+        var RESULT = (0, _setupFormData.default)(pages, components, _userProfileData.default); // It should produce an aggregation of the original source data (USER_PROFILE_DATA)
+        // and data calculated for the fields, based on that source data.
+
+        expect(RESULT).toEqual(_objectSpread(_objectSpread({}, _userProfileData.default), {}, {
+          firstName: _userProfileData.default.keycloakContext.givenName,
+          surname: _userProfileData.default.keycloakContext.familyName,
+          team: _userProfileData.default.staffDetailsDataContext.defaultteam,
+          staffGradeId: _userProfileData.default.staffDetailsDataContext.gradeid,
+          linemanagerEmail: _userProfileData.default.extendedStaffDetailsContext.linemanagerEmail,
+          delegateEmails: _userProfileData.default.extendedStaffDetailsContext.delegateEmails
+        }));
+      });
+    });
+  });
+});

package/dist/utils/Data/setupRefDataUrlForComponent.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { 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; }
+
+var setupRefDataUrlForComponent = function setupRefDataUrlForComponent(component, data) {
+  if (component && component.data && component.data.url) {
+    return _objectSpread(_objectSpread({}, component), {}, {
+      data: _objectSpread(_objectSpread({}, component.data), {}, {
+        url: _copReactComponents.Utils.interpolateString(component.data.url, data)
+      })
+    });
+  }
+
+  return component;
+};
+
+var _default = setupRefDataUrlForComponent;
+exports.default = _default;

package/dist/utils/Data/setupRefDataUrlForComponent.test.js

@@ -0,0 +1,83 @@
+"use strict";
+
+var _setupRefDataUrlForComponent = _interopRequireDefault(require("./setupRefDataUrlForComponent"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils', function () {
+  describe('Data', function () {
+    describe('setupRefDataUrlForComponent', function () {
+      var DATA = {
+        environmentContext: {
+          refData: '/ref-data'
+        }
+      };
+      it('can handle a null component', function () {
+        expect((0, _setupRefDataUrlForComponent.default)(null, DATA)).toBeNull();
+      });
+      it('can handle an undefined component', function () {
+        expect((0, _setupRefDataUrlForComponent.default)(undefined, DATA)).toBeUndefined();
+      });
+      it('can handle a component with no data property', function () {
+        var COMPONENT = {
+          id: 'component'
+        };
+        expect((0, _setupRefDataUrlForComponent.default)(COMPONENT, DATA)).toEqual(COMPONENT);
+      });
+      it('can handle a component with no data.url property', function () {
+        var COMPONENT = {
+          id: 'component',
+          data: {
+            options: []
+          }
+        };
+        expect((0, _setupRefDataUrlForComponent.default)(COMPONENT, DATA)).toEqual(COMPONENT);
+      });
+      it('should appropriately updates the component URL', function () {
+        var COMPONENT = {
+          id: 'component',
+          // eslint-disable-next-line no-template-curly-in-string
+          data: {
+            url: '${environmentContext.refData}/v1/teams'
+          }
+        };
+        expect((0, _setupRefDataUrlForComponent.default)(COMPONENT, DATA)).toEqual({
+          id: COMPONENT.id,
+          data: {
+            url: "".concat(DATA.environmentContext.refData, "/v1/teams")
+          }
+        });
+      });
+      it('should leave a URL alone that does not require replacement', function () {
+        var COMPONENT = {
+          id: 'component',
+          data: {
+            url: '/somewhere-else/v1/teams'
+          }
+        };
+        expect((0, _setupRefDataUrlForComponent.default)(COMPONENT, DATA)).toEqual({
+          id: COMPONENT.id,
+          data: {
+            url: COMPONENT.data.url
+          }
+        });
+      });
+      it('should appropriately handle a missing value in the data', function () {
+        var COMPONENT = {
+          id: 'component',
+          // eslint-disable-next-line no-template-curly-in-string
+          data: {
+            url: '${environmentContext.referenceData}/v1/teams'
+          }
+        };
+        expect((0, _setupRefDataUrlForComponent.default)(COMPONENT, DATA)).toEqual({
+          id: COMPONENT.id,
+          data: {
+            url: '/v1/teams'
+          }
+        });
+      });
+    });
+  });
+});

package/dist/utils/FormPage/getFormPage.js

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _Data = _interopRequireDefault(require("../Data"));
+
+var _getParagraphFromText = _interopRequireDefault(require("./getParagraphFromText"));
+
+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); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { 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; }
+
+var getFormPage = function getFormPage(pageOptions, formComponents, formData) {
+  var components = pageOptions.components.map(function (componentOptions) {
+    if (typeof componentOptions === 'string') {
+      return (0, _getParagraphFromText.default)(componentOptions);
+    }
+
+    var ret = undefined;
+
+    if (componentOptions.use) {
+      ret = (0, _useComponent.default)(componentOptions, formComponents);
+    } else {
+      ret = _objectSpread({}, componentOptions);
+    }
+
+    return formData && formData.environmentContext ? _Data.default.refData.setupUrl(ret, formData) : ret;
+  });
+  return _objectSpread(_objectSpread({}, pageOptions), {}, {
+    formData: formData,
+    components: components
+  });
+};
+
+var _default = getFormPage;
+exports.default = _default;

package/dist/utils/FormPage/getFormPages.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _getFormPage = _interopRequireDefault(require("./getFormPage"));
+
+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); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { 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; }
+
+var getFormPages = function getFormPages(pages, components, formData) {
+  var formPages = [];
+
+  if (Array.isArray(pages)) {
+    pages.forEach(function (options, index) {
+      formPages.push(_objectSpread(_objectSpread({}, (0, _getFormPage.default)(options, components, formData)), {}, {
+        index: index
+      }));
+    });
+  }
+
+  return formPages;
+};
+
+var _default = getFormPages;
+exports.default = _default;

package/dist/utils/FormPage/getParagraphFromText.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _models = require("../../models");
+
+// Local imports
+var getParagraphFromText = function getParagraphFromText(content) {
+  return {
+    type: _models.ComponentTypes.HTML,
+    tagName: 'p',
+    content: content
+  };
+};
+
+var _default = getParagraphFromText;
+exports.default = _default;

package/dist/utils/FormPage/index.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _getFormPage = _interopRequireDefault(require("./getFormPage"));
+
+var _getFormPages = _interopRequireDefault(require("./getFormPages"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var FormPage = {
+  get: _getFormPage.default,
+  getAll: _getFormPages.default
+};
+var _default = FormPage;
+exports.default = _default;

package/dist/utils/FormPage/useComponent.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { 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; }
+
+var useComponent = function useComponent(toUse, formComponents) {
+  var formComponent = formComponents.find(function (fc) {
+    return fc.id === toUse.use;
+  });
+
+  if (formComponent) {
+    var fieldId = toUse.fieldId || formComponent.fieldId;
+    return _objectSpread(_objectSpread(_objectSpread({}, formComponent), toUse), {}, {
+      cya_label: formComponent.label,
+      fieldId: fieldId
+    });
+  }
+
+  return _objectSpread({}, toUse);
+};
+
+var _default = useComponent;
+exports.default = _default;

package/dist/utils/Hub/getFormHub.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _FormPage = _interopRequireDefault(require("../FormPage"));
+
+var _models = require("../../models");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+var getFormHub = function getFormHub(type, hub, components) {
+  if (type === _models.FormTypes.HUB && hub) {
+    if (hub.format === _models.HubFormats.CYA) {
+      return _models.HubFormats.CYA;
+    }
+
+    if (hub.components) {
+      return _FormPage.default.get(hub, components);
+    }
+  }
+
+  return undefined;
+};
+
+var _default = getFormHub;
+exports.default = _default;

package/dist/utils/Hub/index.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _getFormHub = _interopRequireDefault(require("./getFormHub"));
+
+var _models = require("../../models");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+var Hub = {
+  formats: _models.HubFormats,
+  get: _getFormHub.default
+};
+var _default = Hub;
+exports.default = _default;

package/dist/utils/Validate/index.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _validateComponent = _interopRequireDefault(require("./validateComponent"));
+
+var _validateEmail = _interopRequireDefault(require("./validateEmail"));
+
+var _validatePage = _interopRequireDefault(require("./validatePage"));
+
+var _validateRequired = _interopRequireDefault(require("./validateRequired"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+var Validate = {
+  component: _validateComponent.default,
+  email: _validateEmail.default,
+  page: _validatePage.default,
+  required: _validateRequired.default
+};
+var _default = Validate;
+exports.default = _default;

package/dist/utils/Validate/validateComponent.js

@@ -0,0 +1,49 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _models = require("../../models");
+
+var _validateRequired = _interopRequireDefault(require("./validateRequired"));
+
+var _validateEmail = _interopRequireDefault(require("./validateEmail"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
+/**
+ * Validates a single component.
+ * @param {object} component The component to validate.
+ * @param {object} formData The data to use that holds this component's value.
+ * @returns The first encountered error with the component.
+ */
+var validateComponent = function validateComponent(component, formData) {
+  var error = undefined;
+  var data = formData && _typeof(formData) === 'object' ? formData : {};
+
+  if (component) {
+    var value = data[component.fieldId];
+
+    if (component.required) {
+      error = (0, _validateRequired.default)(value, component.label);
+    }
+
+    if (!error && component.type === _models.ComponentTypes.EMAIL) {
+      error = (0, _validateEmail.default)(value, component.label);
+    }
+
+    component.error = error;
+  }
+
+  return error ? {
+    id: component.id,
+    error: error
+  } : undefined;
+};
+
+var _default = validateComponent;
+exports.default = _default;