@carbon/ibm-products 1.0.0-rc.0 → 1.0.1

package/lib/global/js/utils/test-helper.js

@@ -0,0 +1,342 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.scssCompile = exports.scssCheck = exports.required = exports.mockHTMLElement = exports.invalid = exports.expectWarnAsync = exports.expectWarn = exports.expectMultipleWarn = exports.expectMultipleError = exports.expectError = exports.deprecatedUsage = exports.deprecated = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
+
+//
+// Copyright IBM Corp. 2021, 2021
+//
+// This source code is licensed under the Apache-2.0 license found in the
+// LICENSE file in the root directory of this source tree.
+//
+var _require = require('child_process'),
+    execFileSync = _require.execFileSync;
+
+var _require2 = require('path'),
+    resolve = _require2.resolve;
+
+var r = function r(file) {
+  return resolve(__dirname, file);
+};
+
+var loadPath1 = r('../../../../node_modules');
+var loadPath2 = r('../../../../../../node_modules');
+/**
+ * Check that an SCSS file compiles correctly. This function does not return
+ * a value, but if the SCSS file does not compile it will throw an Error
+ * containing details of the compilation failure.
+ * @param {string} file fully qualified file name of the SCSS file to check.
+ */
+
+var scssCheck = function scssCheck(file) {
+  // We use the sass cli because this is currently much faster than using
+  // the API owing to the overhead of @import resolution through the API.
+  // When the sass API is revised it may be feasible to switch back to
+  // using the API for SCSS compilation and checking.
+  execFileSync('sass', ['--style=expanded', '--no-source-map', '--load-path', loadPath1, '--load-path', loadPath2, file], {
+    stdio: ['ignore', 'ignore', 'pipe']
+  });
+};
+/**
+ * Compile an SCSS file, and return the compiled CSS as a String. If the SCSS
+ * file does not compile this function will throw an Error containing details
+ * of the compilation failure.
+ * @param {string} file fully qualified file name of the SCSS file to compile.
+ */
+
+
+exports.scssCheck = scssCheck;
+
+var scssCompile = function scssCompile(file) {
+  var compressed = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+  return (// We use the sass cli because this is currently much faster than using
+    // the API owing to the overhead of @import resolution through the API.
+    // When the sass API is revised it may be feasible to switch back to
+    // using the API for SCSS compilation and checking.
+    execFileSync('sass', [compressed ? '--style=compressed' : '--style=expanded', '--no-source-map', '--load-path', loadPath1, '--load-path', loadPath2, file], {
+      stdio: ['ignore', 'pipe', 'pipe']
+    }).toString()
+  );
+};
+/**
+ * A helper function to mock properties of the HTML element prototype.
+ * @param {*} options An object containing one or more properties, being the
+ * names of properties to add/replace in the HTML element prototype along with
+ * a property descriptor to apply. The property descriptor may contain a value
+ * field, and optionally a writable flag, or it may contain a get and/or a set
+ * method. Other property descriptor fields may also be included, but each
+ * mocked property will always be made configurable (in order to enable the
+ * mock to be restored later).
+ * @returns An object containing a mockRestore function which will return all
+ * replaced properties to their original states and remove all added properties.
+ * This function should be called after tests in order not to pollute other
+ * tests with the installed mocks.
+ */
+
+
+exports.scssCompile = scssCompile;
+var hep = HTMLElement.prototype;
+
+var mockHTMLElement = function mockHTMLElement(options) {
+  var originals = {};
+
+  for (var option in options) {
+    originals[option] = Object.getOwnPropertyDescriptor(hep, option);
+    Object.defineProperty(hep, option, // Ensure we'll be able to restore or delete the property later
+    Object.assign({}, options[option], {
+      configurable: true
+    }));
+  }
+
+  return {
+    mockRestore: function mockRestore() {
+      for (var _option in options) {
+        if (originals[_option]) {
+          Object.defineProperty(hep, _option, originals[_option]);
+        } else {
+          delete hep[_option];
+        }
+      }
+    }
+  };
+}; // a utility function used by expectWarn/Error to convert an argument
+// match element to an expect matcher
+
+
+exports.mockHTMLElement = mockHTMLElement;
+
+var makeMatcher = function makeMatcher(arg) {
+  return typeof arg === 'string' ? expect.stringContaining(arg) : arg instanceof RegExp ? expect.stringMatching(arg) : arg;
+}; // a utility function used by expectWarn/Error to convert a single argument
+// match or an array of argument matches to an array of expect matchers
+
+
+var makeMatcherArray = function makeMatcherArray(args) {
+  return Array.isArray(args) ? args.map(function (arg) {
+    return makeMatcher(arg);
+  }) : [makeMatcher(args)];
+};
+/**
+ * A helper function to enable a test to expect a single call to
+ * console.warn, for example when intentionally using a deprecated prop
+ * or supplying invalid parameters for the purposes of the test.
+ * @param {string|regex|function|[]} message the expected parameters for the call to
+ * console.warn, which must be called exactly once. A single string or regex or an
+ * expect matcher can be used to match a single-argument call to console.warn (most common),
+ * while an array of strings and/or regex and/or expect matchers can be used to match a
+ * multiple-argument call. Strings can be full or substring matches to the corresponding
+ * argument.
+ * @param {Function} test the test function to call, during which the call to
+ * console.warn will be expected.
+ */
+
+
+var expectWarn = function expectWarn(message, test) {
+  var _expect;
+
+  var warn = jest.spyOn(console, 'warn').mockImplementation(jest.fn());
+  var result = test();
+  expect(warn).toBeCalledTimes(1);
+
+  (_expect = expect(warn)).toHaveBeenCalledWith.apply(_expect, (0, _toConsumableArray2.default)(makeMatcherArray(message)));
+
+  warn.mockRestore();
+  return result;
+};
+/**
+ * An async version of expectWarn which awaits the test function and expects the call
+ * to console.warn to have been made.
+ */
+
+
+exports.expectWarn = expectWarn;
+
+var expectWarnAsync = /*#__PURE__*/function () {
+  var _ref = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee(message, test) {
+    var _expect2;
+
+    var warn;
+    return _regenerator.default.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            warn = jest.spyOn(console, 'warn').mockImplementation(jest.fn());
+            _context.next = 3;
+            return test();
+
+          case 3:
+            expect(warn).toBeCalledTimes(1);
+
+            (_expect2 = expect(warn)).toHaveBeenCalledWith.apply(_expect2, (0, _toConsumableArray2.default)(makeMatcherArray(message)));
+
+            warn.mockRestore();
+
+          case 6:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+
+  return function expectWarnAsync(_x, _x2) {
+    return _ref.apply(this, arguments);
+  };
+}();
+/**
+ * A helper function to enable a test to expect multiple calls to
+ * console.warn, for example when intentionally using a deprecated prop
+ * or supplying invalid parameters for the purposes of the test.
+ * @param {[]} messages the expected parameters for successive calls to console.warn,
+ * which must be called exactly as many times as there are elements in the array.
+ * Each element of the array can either be a string or a regex or an expect matcher,
+ * all of which can be used to match a single-argument call to console.warn (most common),
+ * or can be an array of strings and/or regex and/or expect matchers, to match a
+ * multiple-argument call. Strings can be full or substring matches to the corresponding
+ * argument.
+ * @param {Function} test the test function to call, during which the calls to
+ * console.warn will be expected.
+ */
+
+
+exports.expectWarnAsync = expectWarnAsync;
+
+var expectMultipleWarn = function expectMultipleWarn(messages, test) {
+  var warn = jest.spyOn(console, 'warn').mockImplementation(jest.fn());
+  var result = test();
+  expect(warn).toBeCalledTimes(messages.length);
+  messages.forEach(function (args, index) {
+    var _expect3;
+
+    return (_expect3 = expect(warn)).toHaveBeenNthCalledWith.apply(_expect3, [index + 1].concat((0, _toConsumableArray2.default)(makeMatcherArray(args))));
+  });
+  warn.mockRestore();
+  return result;
+};
+/**
+ * A helper function to enable a test to expect a single call to
+ * console.error, for example when intentionally omitting a required prop
+ * or supplying an invalid prop type or value for the purposes of the test.
+ * @param {string|regex|function|[]} message the expected parameters for the call to
+ * console.error, which must be called exactly once. A single string or regex or an
+ * expect matcher can be used to match a single-argument call to console.error (most common),
+ * while an array of strings and/or regex and/or expect matchers can be used to match a
+ * multiple-argument call. Strings can be full or substring matches to the corresponding
+ * argument.
+ * @param {Function} test the test function to call, during which the call to
+ * console.error will be expected.
+ */
+
+
+exports.expectMultipleWarn = expectMultipleWarn;
+
+var expectError = function expectError(message, test) {
+  var _expect4;
+
+  var error = jest.spyOn(console, 'error').mockImplementation(jest.fn());
+  var result = test();
+  expect(error).toBeCalledTimes(1);
+
+  (_expect4 = expect(error)).toHaveBeenCalledWith.apply(_expect4, (0, _toConsumableArray2.default)(makeMatcherArray(message)));
+
+  error.mockRestore();
+  return result;
+};
+/**
+ * A helper function to enable a test to expect multiple calls to
+ * console.warn, for example when intentionally using a deprecated prop
+ * or supplying invalid parameters for the purposes of the test.
+ * @param {[]} messages the expected parameters for successive calls to console.error,
+ * which must be called exactly as many times as there are elements in the array.
+ * Each element of the array can either be a string or a regex or an expect matcher,
+ * all of which can be used to match a single-argument call to console.error (most common),
+ * or can be an array of strings and/or regex and/or expect matchers, to match a
+ * multiple-argument call. Strings can be full or substring matches to the corresponding
+ * argument.
+ * @param {Function} test the test function to call, during which the calls to
+ * console.error will be expected.
+ */
+
+
+exports.expectError = expectError;
+
+var expectMultipleError = function expectMultipleError(messages, test) {
+  var error = jest.spyOn(console, 'error').mockImplementation(jest.fn());
+  var result = test();
+  expect(error).toBeCalledTimes(messages.length);
+  messages.forEach(function (args, index) {
+    var _expect5;
+
+    return (_expect5 = expect(error)).toHaveBeenNthCalledWith.apply(_expect5, [index + 1].concat((0, _toConsumableArray2.default)(makeMatcherArray(args))));
+  });
+  error.mockRestore();
+  return result;
+};
+/**
+ * Return an expect matcher for a prop deprecation, suitable to pass to expectWarn
+ * or expectMultipleWarn.
+ * @param {string} propName the prop name that is deprecated, or a matching regex
+ * @param {string} componentName the component name on which the prop is defined, or a matching regex
+ */
+
+
+exports.expectMultipleError = expectMultipleError;
+
+var deprecated = function deprecated(propName, componentName) {
+  var additionalInfo = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
+  return expect.stringMatching(new RegExp("^The prop `".concat(propName, "` of `").concat(componentName, "` has been deprecated and will soon be removed. ").concat(additionalInfo)));
+};
+/**
+ * Return an expect matcher for a prop usage deprecation, suitable to pass to expectWarn
+ * or expectMultipleWarn.
+ * @param {string} propName the prop name whose usage has changed
+ * @param {string} componentName the component name on which the prop is defined
+ */
+
+
+exports.deprecated = deprecated;
+
+var deprecatedUsage = function deprecatedUsage(propName, componentName) {
+  var additionalInfo = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
+  return expect.stringMatching(new RegExp("^The usage of the prop `".concat(propName, "` of `").concat(componentName, "` has been changed and support for the old usage will soon be removed. ").concat(additionalInfo)));
+};
+/**
+ * Return an expect matcher for a missing required prop, suitable to pass to expectError
+ * or expectMultipleError.
+ * @param {string} propName the prop name that is required, or a matching regex
+ * @param {string} componentName the component name on which the prop is defined, or a matching regex
+ */
+
+
+exports.deprecatedUsage = deprecatedUsage;
+
+var required = function required(propName, componentName) {
+  return expect.stringMatching(new RegExp("^Warning: Failed prop type: The prop `".concat(propName, "` is marked as required in `").concat(componentName, "`, but its value is `(.*)`.")));
+};
+/**
+ * Return an expect matcher for an invalid prop, suitable to pass to expectError
+ * or expectMultipleError.
+ * @param {string} propName the prop name that is invalid, or a matching regex
+ * @param {string} componentName the component name on which the prop is defined, or a matching regex
+ * @param {string} suppliedType the type that is being supplied, or a matching regex
+ * @param {string} expectedType the type that is expected, or a matching regex
+ */
+
+
+exports.required = required;
+
+var invalid = function invalid(propName, componentName, suppliedType, expectedType) {
+  return expect.stringMatching(new RegExp("^Warning: Failed prop type: Invalid prop `".concat(propName, "` of type `").concat(suppliedType, "` supplied to `").concat(componentName, "`, expected `").concat(expectedType, "`.")));
+};
+
+exports.invalid = invalid;

package/lib/global/js/utils/unwrap-if-fragment.js

@@ -0,0 +1,82 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+/**
+ * unwrapIfFragment - walks the passed children unwrapping fragments
+ * to create a flat array of all children
+ */
+var unwrapIfFragment = function unwrapIfFragment(children) {
+  // When passed one of the following
+  // - A fragment with zero or more children *1
+  // - An array with zero or more children *1
+  // - A single node
+  // *1 -  The children of the above can be any of the above
+  // Outputs - A flat array of child nodes
+  var newChildArray = [];
+
+  var isFragment = function isFragment(item) {
+    return item && item.type === _react.default.Fragment;
+  };
+
+  var addChildren = function addChildren(children) {
+    var loopOver = function loopOver(children) {
+      // children may be a single item
+      var _children = Array.isArray(children) ? children : [children];
+
+      var _iterator = _createForOfIteratorHelper(_children),
+          _step;
+
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var child = _step.value;
+          addChildren(child);
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+    }; // children is nothing, one fragment, array with one or more children, or a single item
+
+
+    if (!children) {
+      return;
+    }
+
+    if (isFragment(children)) {
+      loopOver(children.props.children);
+    } else {
+      if (Array.isArray(children)) {
+        loopOver(children);
+      } else {
+        newChildArray.push(children);
+      }
+    }
+  }; // nothing, one fragment, array with one or more children, or a single item
+
+
+  addChildren(children); // wrapping with React.Children caters for any missing keys
+
+  var keyedChildren = _react.default.Children.map(newChildArray, function (child) {
+    return child;
+  });
+
+  return keyedChildren;
+};
+
+var _default = unwrapIfFragment;
+exports.default = _default;

package/lib/global/js/utils/uuidv4.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+// https://stackoverflow.com/a/2117523
+function uuidv4() {
+  var randomValues = function randomValues(c) {
+    return typeof crypto !== 'undefined' ? crypto.getRandomValues(new Uint8Array(1))[0] & 15 >> c / 4 : Math.random() * 16 >> c / 4;
+  };
+
+  return ([1e7] + -1e3 + -4e3 + -8e3 + -1e11).replace(/[018]/g, function (c) {
+    return (c ^ randomValues(c)).toString(16);
+  });
+}
+
+var _default = uuidv4;
+exports.default = _default;

package/lib/global/js/utils/uuidv4.spec.js

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _uuidv = _interopRequireDefault(require("./uuidv4"));
+
+describe('uuidv4', function () {
+  beforeEach(function () {
+    jest.resetAllMocks();
+  });
+  it('Uses Math.random when window is not defined', function () {
+    var mockMath = Object.create(global.Math);
+    var mockMathRandom = jest.fn().mockReturnValue(0.5);
+    mockMath.random = mockMathRandom;
+    global.Math = mockMath;
+    expect((0, _uuidv.default)()).toEqual('98888888-9888-4888-a888-988888888888');
+  });
+  it('Uses crypto from window when window is defined', function () {
+    var mGetRandomValues = jest.fn().mockReturnValue(new Uint32Array(10));
+    Object.defineProperty(window, 'crypto', {
+      value: {
+        getRandomValues: mGetRandomValues
+      }
+    });
+    expect((0, _uuidv.default)()).toEqual('10000000-1000-4000-8000-100000000000');
+    expect(mGetRandomValues).toBeCalledWith(new Uint8Array(1));
+  });
+});

package/lib/global/js/utils/wait.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+// utility function for an async timeout
+function wait(ms) {
+  return new Promise(function (resolve) {
+    return setTimeout(resolve, ms);
+  });
+}
+
+var _default = wait;
+exports.default = _default;

package/lib/global/js/utils/wrapFocus.js

@@ -0,0 +1,84 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+exports.elementOrParentIsFloatingMenu = elementOrParentIsFloatingMenu;
+
+var _keyboardNavigation = require("./keyboardNavigation");
+
+var _settings = require("../../../settings");
+
+/**
+ * Copyright IBM Corp. 2020
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * @param {Node} node A DOM node.
+ * @param {string[]} selectorsFloatingMenus The CSS selectors that matches floating menus.
+ * @returns {boolean} `true` of the given `node` is in a floating menu.
+ */
+function elementOrParentIsFloatingMenu(node) {
+  var selectorsFloatingMenus = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [".".concat(_settings.carbon.prefix, "--overflow-menu-options"), ".".concat(_settings.carbon.prefix, "--tooltip"), '.flatpickr-calendar'];
+
+  if (node && typeof node.closest === 'function') {
+    return selectorsFloatingMenus.some(function (selector) {
+      return node.closest(selector);
+    });
+  }
+}
+/**
+ * Ensures the focus is kept in the given `modalNode`, implementing "focus-wrap" behavior.
+ * @param {object} options The options.
+ * @param {Node} options.bodyNode The DOM node of the inner modal.
+ * @param {Node} options.startTrapNode The DOM node of the focus sentinel the is placed earlier next to `modalNode`.
+ * @param {Node} options.endTrapNode The DOM node of the focus sentinel the is placed next to `modalNode`.
+ * @param {Node} options.currentActiveNode The DOM node that has focus.
+ * @param {Node} options.oldActiveNode The DOM node that previously had focus.
+ * @param {Node} [options.selectorsFloatingMenus] The CSS selectors that matches floating menus
+ */
+
+
+function wrapFocus(_ref) {
+  var bodyNode = _ref.bodyNode,
+      startTrapNode = _ref.startTrapNode,
+      endTrapNode = _ref.endTrapNode,
+      currentActiveNode = _ref.currentActiveNode,
+      oldActiveNode = _ref.oldActiveNode,
+      selectorsFloatingMenus = _ref.selectorsFloatingMenus;
+
+  if (bodyNode && currentActiveNode && oldActiveNode && !bodyNode.contains(currentActiveNode) && !elementOrParentIsFloatingMenu(currentActiveNode, selectorsFloatingMenus)) {
+    var comparisonResult = oldActiveNode.compareDocumentPosition(currentActiveNode);
+
+    if (currentActiveNode === startTrapNode || comparisonResult & _keyboardNavigation.DOCUMENT_POSITION_BROAD_PRECEDING) {
+      var arrayNodes = Array.from(bodyNode.querySelectorAll(_keyboardNavigation.selectorTabbable));
+      arrayNodes.reverse();
+      var tabbable = arrayNodes.find(function (elem) {
+        return Boolean(elem.offsetParent);
+      });
+
+      if (tabbable) {
+        tabbable.focus();
+      } else if (bodyNode !== oldActiveNode) {
+        bodyNode.focus();
+      }
+    } else if (currentActiveNode === endTrapNode || comparisonResult & _keyboardNavigation.DOCUMENT_POSITION_BROAD_FOLLOWING) {
+      var _tabbable = Array.prototype.find.call(bodyNode.querySelectorAll(_keyboardNavigation.selectorTabbable), function (elem) {
+        return Boolean(elem.offsetParent);
+      });
+
+      if (_tabbable) {
+        _tabbable.focus();
+      } else if (bodyNode !== oldActiveNode) {
+        bodyNode.focus();
+      }
+    }
+  }
+}
+
+var _default = wrapFocus;
+exports.default = _default;

package/lib/index.js

@@ -0,0 +1,30 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  pkg: true
+};
+Object.defineProperty(exports, "pkg", {
+  enumerable: true,
+  get: function get() {
+    return _settings.pkg;
+  }
+});
+
+var _settings = require("./settings");
+
+var _components = require("./components");
+
+Object.keys(_components).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _components[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _components[key];
+    }
+  });
+});