@carbon/ibm-products 2.0.0-rc.3 → 2.0.0-rc.32

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

@@ -1,43 +1,36 @@
 "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;
-
+exports.scssCompile = exports.scssCheck = exports.required = exports.mockHTMLElement = exports.invalid = exports.expectWarnAsync = exports.expectWarn = exports.expectMultipleWarn = exports.expectMultipleError = exports.expectLogging = 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 _require = require('child_process'),
+  execFileSync = _require.execFileSync;
 var _require2 = require('path'),
-    resolve = _require2.resolve;
-
+  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.
@@ -47,19 +40,18 @@ var scssCheck = function scssCheck(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
+  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.
@@ -69,6 +61,7 @@ var scssCompile = function scssCompile(file) {
     }).toString()
   );
 };
+
 /**
  * A helper function to mock properties of the HTML element prototype.
  * @param {*} options An object containing one or more properties, being the
@@ -83,22 +76,18 @@ var scssCompile = function scssCompile(file) {
  * 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.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) {
@@ -110,23 +99,23 @@ var mockHTMLElement = function mockHTMLElement(options) {
       }
     }
   };
-}; // a utility function used by expectWarn/Error to convert an argument
-// match element to an expect matcher
-
+};
 
+// 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
-
+};
 
+// 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
@@ -140,60 +129,46 @@ var makeMatcherArray = function makeMatcherArray(args) {
  * @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();
-        }
+      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
@@ -208,22 +183,53 @@ var expectWarnAsync = /*#__PURE__*/function () {
  * @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;
 };
+exports.expectMultipleWarn = expectMultipleWarn;
+var checkLogging = function checkLogging(mock, message) {
+  if (message) {
+    var _expect4;
+    expect(mock).toBeCalled();
+    (_expect4 = expect(mock)).toHaveBeenCalledWith.apply(_expect4, (0, _toConsumableArray2.default)(makeMatcherArray(message)));
+  }
+};
+
+/**
+ * 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 {errors: {string|regex|function|[]}, warnings: {string|regex|function|[]}} messages the expected parameters for the call to
+ * console.error or 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.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.
+ */
+var expectLogging = function expectLogging(_ref2, test) {
+  var errors = _ref2.errors,
+    warnings = _ref2.warnings;
+  var error = jest.spyOn(console, 'error').mockImplementation(jest.fn());
+  var warn = jest.spyOn(console, 'warn').mockImplementation(jest.fn());
+  var result = test();
+  checkLogging(error, errors);
+  checkLogging(warn, warnings);
+  error.mockRestore();
+  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
@@ -237,22 +243,15 @@ var expectMultipleWarn = function expectMultipleWarn(messages, test) {
  * @param {Function} test the test function to call, during which the call to
  * console.error will be expected.
  */
-
-
-exports.expectMultipleWarn = expectMultipleWarn;
-
+exports.expectLogging = expectLogging;
 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)));
-
+  checkLogging(error, 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
@@ -267,63 +266,54 @@ var expectError = function expectError(message, test) {
  * @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.
@@ -332,12 +322,8 @@ var required = function required(propName, componentName) {
  * @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

@@ -1,20 +1,14 @@
 "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; }
-
+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
@@ -27,19 +21,15 @@ var unwrapIfFragment = function unwrapIfFragment(children) {
   // *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;
-
+        _step;
       try {
         for (_iterator.s(); !(_step = _iterator.n()).done;) {
           var child = _step.value;
@@ -50,13 +40,12 @@ var unwrapIfFragment = function unwrapIfFragment(children) {
       } finally {
         _iterator.f();
       }
-    }; // children is nothing, one fragment, array with one or more children, or a single item
-
+    };
 
+    // 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 {
@@ -66,17 +55,16 @@ var unwrapIfFragment = function unwrapIfFragment(children) {
         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
+  // 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

@@ -4,17 +4,15 @@ 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

@@ -1,16 +1,14 @@
 "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 _window = window,
-        crypto = _window.crypto;
+      crypto = _window.crypto;
     delete window.crypto;
     var mockMath = Object.create(global.Math);
     var mockMathRandom = jest.fn().mockReturnValue(0.5);

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

@@ -4,13 +4,12 @@ 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

@@ -5,11 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 exports.elementOrParentIsFloatingMenu = elementOrParentIsFloatingMenu;
-
 var _keyboardNavigation = require("./keyboardNavigation");
-
 var _settings = require("../../../settings");
-
 /**
  * Copyright IBM Corp. 2020
  *
@@ -24,13 +21,13 @@ var _settings = require("../../../settings");
  */
 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.
@@ -41,26 +38,21 @@ function elementOrParentIsFloatingMenu(node) {
  * @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;
-
+    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) {
@@ -70,7 +62,6 @@ function wrapFocus(_ref) {
       var _tabbable = Array.prototype.find.call(bodyNode.querySelectorAll(_keyboardNavigation.selectorTabbable), function (elem) {
         return Boolean(elem.offsetParent);
       });
-
       if (_tabbable) {
         _tabbable.focus();
       } else if (bodyNode !== oldActiveNode) {
@@ -79,6 +70,5 @@ function wrapFocus(_ref) {
     }
   }
 }
-
 var _default = wrapFocus;
 exports.default = _default;

package/lib/index.js

@@ -12,11 +12,8 @@ Object.defineProperty(exports, "pkg", {
     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;