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

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

@@ -0,0 +1,146 @@
+"use strict";
+
+var _getAutocompleteSource = _interopRequireDefault(require("./getAutocompleteSource"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils', function () {
+  describe('Data', function () {
+    describe('getAutocompleteSource', function () {
+      it('should handle a null config', function () {
+        var SOURCE = (0, _getAutocompleteSource.default)(null);
+        expect(typeof SOURCE === 'function').toBeTruthy();
+        SOURCE('query', function (results) {
+          expect(Array.isArray(results)).toBeTruthy();
+          expect(results.length).toEqual(0);
+        });
+      });
+      it('should get any specified options from the config', function () {
+        var CONFIG = {
+          data: {
+            options: [{
+              value: 'a',
+              label: 'Alpha'
+            }, {
+              value: 'b',
+              label: 'Bravo'
+            }]
+          }
+        };
+        var SOURCE = (0, _getAutocompleteSource.default)(CONFIG);
+        expect(typeof SOURCE === 'function').toBeTruthy();
+        SOURCE('a', function (results) {
+          expect(results.length).toEqual(2);
+          expect(results).toEqual([{
+            value: 'a',
+            label: 'Alpha'
+          }, {
+            value: 'b',
+            label: 'Bravo'
+          }]);
+        });
+        SOURCE('al', function (results) {
+          expect(results.length).toEqual(1);
+          expect(results).toEqual([{
+            value: 'a',
+            label: 'Alpha'
+          }]);
+        });
+      });
+      it('should handle an empty query', function () {
+        var CONFIG = {
+          data: {
+            options: [{
+              value: 'a',
+              label: 'Alpha'
+            }, {
+              value: 'b',
+              label: 'Bravo'
+            }]
+          }
+        };
+        var SOURCE = (0, _getAutocompleteSource.default)(CONFIG);
+        SOURCE('', function (results) {
+          expect(results.length).toEqual(2);
+          expect(results).toEqual([{
+            value: 'a',
+            label: 'Alpha'
+          }, {
+            value: 'b',
+            label: 'Bravo'
+          }]);
+        });
+      });
+      it('should handle an undefined query', function () {
+        var CONFIG = {
+          data: {
+            options: [{
+              value: 'a',
+              label: 'Alpha'
+            }, {
+              value: 'b',
+              label: 'Bravo'
+            }]
+          }
+        };
+        var SOURCE = (0, _getAutocompleteSource.default)(CONFIG);
+        SOURCE(undefined, function (results) {
+          expect(results.length).toEqual(2);
+          expect(results).toEqual([{
+            value: 'a',
+            label: 'Alpha'
+          }, {
+            value: 'b',
+            label: 'Bravo'
+          }]);
+        });
+      });
+      it('should handle a null query', function () {
+        var CONFIG = {
+          data: {
+            options: [{
+              value: 'a',
+              label: 'Alpha'
+            }, {
+              value: 'b',
+              label: 'Bravo'
+            }]
+          }
+        };
+        var SOURCE = (0, _getAutocompleteSource.default)(CONFIG);
+        SOURCE(null, function (results) {
+          expect(results.length).toEqual(2);
+          expect(results).toEqual([{
+            value: 'a',
+            label: 'Alpha'
+          }, {
+            value: 'b',
+            label: 'Bravo'
+          }]);
+        });
+      });
+      it('should handle a missing label on an option', function () {
+        var CONFIG = {
+          data: {
+            options: [{
+              value: 'a',
+              label: 'Alpha'
+            }, {
+              value: 'b'
+            }]
+          }
+        };
+        var SOURCE = (0, _getAutocompleteSource.default)(CONFIG);
+        expect(typeof SOURCE === 'function').toBeTruthy();
+        SOURCE('a', function (results) {
+          expect(results.length).toEqual(1);
+          expect(results).toEqual([{
+            value: 'a',
+            label: 'Alpha'
+          }]);
+        });
+      });
+    });
+  });
+});

package/dist/utils/Data/getOptions.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var getOptions = function getOptions(config, callback) {
+  if (config) {
+    if (config.options) {
+      return callback(config.options);
+    } else if (config.data && config.data.options) {
+      return callback(config.data.options);
+    }
+  }
+
+  callback([]);
+};
+
+var _default = getOptions;
+exports.default = _default;

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

@@ -0,0 +1,71 @@
+"use strict";
+
+var _getOptions = _interopRequireDefault(require("./getOptions"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils', function () {
+  describe('Data', function () {
+    describe('getOptions', function () {
+      it('should handle a null config', function () {
+        (0, _getOptions.default)(null, function (options) {
+          expect(options).toEqual([]);
+        });
+      });
+      it('should get any specified options from the config', function () {
+        var CONFIG = {
+          options: [{
+            value: 'a',
+            label: 'Alpha'
+          }, {
+            value: 'b',
+            label: 'Bravo'
+          }]
+        };
+        (0, _getOptions.default)(CONFIG, function (options) {
+          expect(options).toEqual(CONFIG.options);
+        });
+      });
+      it('should get any specified options from the data property of the config', function () {
+        var CONFIG = {
+          data: {
+            options: [{
+              value: 'a',
+              label: 'Alpha'
+            }, {
+              value: 'b',
+              label: 'Bravo'
+            }]
+          }
+        };
+        (0, _getOptions.default)(CONFIG, function (options) {
+          expect(options).toEqual(CONFIG.data.options);
+        });
+      });
+      it('should use the top-level options over those in the data property', function () {
+        var CONFIG = {
+          options: [{
+            value: 'a',
+            label: 'Alpha'
+          }, {
+            value: 'b',
+            label: 'Bravo'
+          }],
+          data: {
+            options: [{
+              value: 'c',
+              label: 'Charlie'
+            }, {
+              value: 'd',
+              label: 'Delta'
+            }]
+          }
+        };
+        (0, _getOptions.default)(CONFIG, function (options) {
+          expect(options).toEqual(CONFIG.options);
+        });
+      });
+    });
+  });
+});

package/dist/utils/Data/getSourceData.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+/**
+ * Gets the value of a field within the top-level JSON form data,
+ * based on a dot-separated field identifier.
+ * 
+ * Example:
+ *   getSourceData({
+ *     'alpha': {
+ *       'bravo': 'Charlie'
+ *     }
+ *   }, 'alpha.bravo') will return the value 'Charlie'.
+ * 
+ * @param {object} data The top-level JSON form data to iterate through.
+ * @param {string} fieldId The dot-separated path to the field.
+ * @returns The value of the field specified.
+ */
+var getSourceData = function getSourceData(data, fieldId) {
+  if (!fieldId) {
+    return undefined;
+  }
+
+  return fieldId.split('.').reduce(function (obj, prop) {
+    return obj ? obj[prop] : undefined;
+  }, data);
+};
+
+var _default = getSourceData;
+exports.default = _default;

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

@@ -0,0 +1,125 @@
+"use strict";
+
+var _getSourceData = _interopRequireDefault(require("./getSourceData"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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('getSourceData', function () {
+      it('should return the value at the top level', function () {
+        var FIELD_ID = 'field';
+        var VALUE = 'value';
+
+        var DATA = _defineProperty({}, FIELD_ID, VALUE);
+
+        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        expect(value).toEqual(VALUE);
+      });
+      it('should return a nested value', function () {
+        var FIELD_ID = 'field.nested';
+        var VALUE = 'nested value';
+        var DATA = {
+          field: {
+            nested: VALUE
+          }
+        };
+        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        expect(value).toEqual(VALUE);
+      });
+      it('should return a deeply nested value', function () {
+        var FIELD_ID = 'field.nested.and.even.further.down';
+        var VALUE = 'deeply nested value';
+        var DATA = {
+          field: {
+            nested: {
+              and: {
+                even: {
+                  further: {
+                    down: VALUE
+                  }
+                }
+              }
+            }
+          }
+        };
+        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        expect(value).toEqual(VALUE);
+      });
+      it('should handle null data', function () {
+        var FIELD_ID = 'field.nested';
+        var value = (0, _getSourceData.default)(null, FIELD_ID);
+        expect(value).toBeUndefined();
+      });
+      it('should handle undefined data', function () {
+        var FIELD_ID = 'field.nested';
+        var value = (0, _getSourceData.default)(undefined, FIELD_ID);
+        expect(value).toBeUndefined();
+      });
+      it('should handle missing value', function () {
+        var FIELD_ID = 'field.nested';
+        var VALUE = 'other value';
+        var DATA = {
+          field: {
+            other: VALUE
+          }
+        };
+        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        expect(value).toBeUndefined();
+      });
+      it('should handle null fieldId', function () {
+        var VALUE = 'value';
+        var DATA = {
+          field: VALUE
+        };
+        var value = (0, _getSourceData.default)(DATA, null);
+        expect(value).toBeUndefined();
+      });
+      it('should handle undefined fieldId', function () {
+        var VALUE = 'value';
+        var DATA = {
+          field: VALUE
+        };
+        var value = (0, _getSourceData.default)(DATA, undefined);
+        expect(value).toBeUndefined();
+      });
+      it('should handle empty fieldId', function () {
+        var VALUE = 'value';
+        var DATA = {
+          field: VALUE
+        };
+        var value = (0, _getSourceData.default)(DATA, '');
+        expect(value).toBeUndefined();
+      });
+      it('should handle fieldId with trailing dot', function () {
+        var FIELD_ID = 'field.';
+        var VALUE = 'value';
+        var DATA = {
+          field: VALUE
+        };
+        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        expect(value).toBeUndefined();
+      });
+      it('should handle fieldId with leading dot', function () {
+        var FIELD_ID = '.field';
+        var VALUE = 'value';
+        var DATA = {
+          field: VALUE
+        };
+        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        expect(value).toBeUndefined();
+      });
+      it('should handle fieldId that is just a dot', function () {
+        var FIELD_ID = '.';
+        var VALUE = 'value';
+        var DATA = {
+          field: VALUE
+        };
+        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        expect(value).toBeUndefined();
+      });
+    });
+  });
+});

package/dist/utils/Data/index.js

@@ -0,0 +1,34 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _getAutocompleteSource = _interopRequireDefault(require("./getAutocompleteSource"));
+
+var _getOptions = _interopRequireDefault(require("./getOptions"));
+
+var _getSourceData = _interopRequireDefault(require("./getSourceData"));
+
+var _refDataToOptions = _interopRequireDefault(require("./refDataToOptions"));
+
+var _setupFormData = _interopRequireDefault(require("./setupFormData"));
+
+var _setupRefDataUrlForComponent = _interopRequireDefault(require("./setupRefDataUrlForComponent"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+var Data = {
+  getAutocompleteSource: _getAutocompleteSource.default,
+  getOptions: _getOptions.default,
+  getSource: _getSourceData.default,
+  refData: {
+    setupUrl: _setupRefDataUrlForComponent.default,
+    toOptions: _refDataToOptions.default
+  },
+  setupForm: _setupFormData.default
+};
+var _default = Data;
+exports.default = _default;

package/dist/utils/Data/refDataToOptions.js

@@ -0,0 +1,33 @@
+"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; }
+
+/**
+ * Converts ref data items to options.
+ * @param {Array} refDataItems An array of ref data items.
+ * @returns An array of options.
+ */
+var refDataToOptions = function refDataToOptions(refDataItems) {
+  if (Array.isArray(refDataItems)) {
+    return refDataItems.map(function (opt) {
+      return _objectSpread(_objectSpread({}, opt), {}, {
+        value: opt.id || opt.value,
+        label: opt.name || opt.label
+      });
+    });
+  }
+
+  return [];
+};
+
+var _default = refDataToOptions;
+exports.default = _default;

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

@@ -0,0 +1,99 @@
+"use strict";
+
+var _refDataToOptions = _interopRequireDefault(require("./refDataToOptions"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils', function () {
+  describe('Data', function () {
+    describe('refDataToOptions', function () {
+      it('can handle a null refData', function () {
+        expect((0, _refDataToOptions.default)(null)).toEqual([]);
+      });
+      it('can handle an undefined refData', function () {
+        expect((0, _refDataToOptions.default)(undefined)).toEqual([]);
+      });
+      it('can handle genuine refData', function () {
+        var REF_DATA = [{
+          id: 'a',
+          name: 'Alpha'
+        }, {
+          id: 'b',
+          name: 'Bravo'
+        }, {
+          id: 'c',
+          name: 'Charlie'
+        }];
+        expect((0, _refDataToOptions.default)(REF_DATA)).toEqual([{
+          id: 'a',
+          name: 'Alpha',
+          value: 'a',
+          label: 'Alpha'
+        }, {
+          id: 'b',
+          name: 'Bravo',
+          value: 'b',
+          label: 'Bravo'
+        }, {
+          id: 'c',
+          name: 'Charlie',
+          value: 'c',
+          label: 'Charlie'
+        }]);
+      });
+      it('can handle refData that is already in a usable options format', function () {
+        var REF_DATA = [{
+          value: 'a',
+          label: 'Alpha'
+        }, {
+          value: 'b',
+          label: 'Bravo'
+        }, {
+          value: 'c',
+          label: 'Charlie'
+        }];
+        expect((0, _refDataToOptions.default)(REF_DATA)).toEqual([{
+          value: 'a',
+          label: 'Alpha'
+        }, {
+          value: 'b',
+          label: 'Bravo'
+        }, {
+          value: 'c',
+          label: 'Charlie'
+        }]);
+      });
+      it('can handle refData that is in a mixed format', function () {
+        var REF_DATA = [{
+          id: 'a',
+          name: 'Alpha',
+          type: 'Delta'
+        }, {
+          value: 'b',
+          label: 'Bravo'
+        }, {
+          id: 'c',
+          name: 'Charlie',
+          type: 'Delta'
+        }];
+        expect((0, _refDataToOptions.default)(REF_DATA)).toEqual([{
+          id: 'a',
+          name: 'Alpha',
+          value: 'a',
+          label: 'Alpha',
+          type: 'Delta'
+        }, {
+          value: 'b',
+          label: 'Bravo'
+        }, {
+          id: 'c',
+          name: 'Charlie',
+          value: 'c',
+          label: 'Charlie',
+          type: 'Delta'
+        }]);
+      });
+    });
+  });
+});

package/dist/utils/Data/setupFormData.js

@@ -0,0 +1,63 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _getSourceData = _interopRequireDefault(require("./getSourceData"));
+
+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 setupComponentSourceData = function setupComponentSourceData(component, data) {
+  if (component.source) {
+    data[component.fieldId] = (0, _getSourceData.default)(data, component.source.field);
+  }
+};
+
+var setupSourceDataForComponents = function setupSourceDataForComponents(components, data) {
+  components.forEach(function (component) {
+    return setupComponentSourceData(component, data);
+  });
+};
+
+var setupPageSourceData = function setupPageSourceData(pages, data) {
+  pages.forEach(function (page) {
+    page.components.filter(function (c) {
+      return !c.use;
+    }).forEach(function (component) {
+      return setupComponentSourceData(component, data);
+    });
+  });
+};
+/**
+ * This populates an object with data from source fields.
+ * Note that this doesn't currently support sequenced dependencies:
+ *    0: fieldA: source.field = fieldB
+ *    1: fieldB: source.field = fieldC
+ *    2: fieldC: 'value'
+ * In the above example, fieldA will not get a value as fieldB isn't
+ * set until after fieldA is processed.
+ * @param {*} pages 
+ * @param {*} components 
+ * @param {*} baseData 
+ * @returns 
+ */
+
+
+var setupFormData = function setupFormData(pages, components, baseData) {
+  var data = _objectSpread({}, baseData);
+
+  setupSourceDataForComponents(components, data);
+  setupPageSourceData(pages, data);
+  return data;
+};
+
+var _default = setupFormData;
+exports.default = _default;