@instructure/ui-react-utils 8.33.1 → 8.33.2

package/es/safeCloneElement.js

@@ -21,10 +21,10 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 import React from 'react';
 import { logWarn as warn } from '@instructure/console';
 import { createChainedFunction } from '@instructure/ui-utils';
-
 /**
  * ---
  * category: utilities/react
@@ -39,19 +39,21 @@ function safeCloneElement(element, props) {
   const originalRef = element.ref;
   const originalRefIsAFunction = typeof originalRef === 'function';
   const cloneRefIsFunction = typeof cloneRef === 'function';
-  const mergedProps = { ...props
+  const mergedProps = {
+    ...props
   };
-
   if (element.props.style && props.style) {
     // merge with existing styles
-    mergedProps.style = { ...element.props.style,
+    mergedProps.style = {
+      ...element.props.style,
       ...props.style
     };
-  } // prevent overriding existing keys
-
+  }
 
-  mergedProps.key = element.key || props.key; // Add chained function to preserve existing event handlers
+  // prevent overriding existing keys
+  mergedProps.key = element.key || props.key;
 
+  // Add chained function to preserve existing event handlers
   Object.keys(props).forEach(prop => {
     // If prop looks like an event handler "on*" and either
     // props[props] or element.props[prop] is a function create a chained function.
@@ -63,20 +65,17 @@ function safeCloneElement(element, props) {
       mergedProps[prop] = createChainedFunction(element.props[prop], props[prop]);
     }
   });
-
   for (var _len = arguments.length, children = new Array(_len > 2 ? _len - 2 : 0), _key = 2; _key < _len; _key++) {
     children[_key - 2] = arguments[_key];
   }
-
   if (originalRef == null || cloneRef == null) {
     return /*#__PURE__*/React.cloneElement(element, mergedProps, ...children);
   }
-
   warn(originalRefIsAFunction, `Cloning an element with a ref that will be overwritten because the ref \
 is not a function. Use a composable callback-style ref instead. \
 Ignoring ref: ${originalRef}`);
-  return /*#__PURE__*/React.cloneElement(element, { ...mergedProps,
-
+  return /*#__PURE__*/React.cloneElement(element, {
+    ...mergedProps,
     ref(component) {
       if (cloneRefIsFunction) {
         ;
@@ -84,12 +83,9 @@ Ignoring ref: ${originalRef}`);
       } else {
         cloneRef.current = component;
       }
-
       originalRef(component);
     }
-
   }, ...children);
 }
-
 export default safeCloneElement;
 export { safeCloneElement };

package/es/windowMessageListener.js

@@ -23,6 +23,7 @@
  */
 import { decorator } from '@instructure/ui-decorator';
 import { ownerWindow } from '@instructure/ui-dom-utils';
+
 /**
  * ---
  * category: utilities/react
@@ -36,42 +37,33 @@ import { ownerWindow } from '@instructure/ui-dom-utils';
  * @param {Function} validSource an optional function that would restrict message handling to a specified source.
  * @returns {Function} a function that decorates a React component with the behavior
  */
-
 const windowMessageListener = decorator((ComposedComponent, messageHandler, validSource) => {
   var _class;
-
   return _class = class extends ComposedComponent {
     constructor() {
       super(...arguments);
-
       this.handleMessage = e => {
         if (this.sourceIsValid(e.source) && e.origin === origin(this) && e.data) {
           messageHandler.call(this, e.data);
         }
       };
     }
-
     componentDidMount() {
       const win = ownerWindow(this);
       win.addEventListener('message', this.handleMessage, false);
-
       if (super.componentDidMount) {
         super.componentDidMount();
       }
     }
-
     componentWillUnmount() {
       const win = ownerWindow(this);
       win.removeEventListener('message', this.handleMessage, false);
-
       if (super.componentDidMount) {
         super.componentDidMount();
       }
     }
-
     sourceIsValid(eventSource) {
       const expectedSource = typeof validSource === 'function' ? validSource.call(this) : validSource;
-
       if (!expectedSource) {
         return true;
       } else if (eventSource) {
@@ -82,11 +74,11 @@ const windowMessageListener = decorator((ComposedComponent, messageHandler, vali
         return false;
       }
     }
-
   }, _class.postMessage = function (target, message, origin) {
     target.postMessage(message, origin);
   }, _class;
 });
+
 /**
  * Return the origin of the owner window of the DOM element
  *
@@ -95,11 +87,9 @@ const windowMessageListener = decorator((ComposedComponent, messageHandler, vali
  * @param {DOMElement} node
  * @returns {String} the origin
  */
-
 function origin(node) {
   const ownWindow = ownerWindow(node);
   const location = ownWindow.location;
-
   if (location.protocol === 'file:') {
     return '*';
   } else if (location.origin) {
@@ -110,6 +100,5 @@ function origin(node) {
     return `${location.protocol}//${location.hostname}`;
   }
 }
-
 export default windowMessageListener;
 export { origin, windowMessageListener };

package/lib/ComponentIdentifier.js

@@ -1,32 +1,20 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = exports.ComponentIdentifier = void 0;
-
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
-
 var _react = _interopRequireWildcard(require("react"));
-
 var _propTypes = _interopRequireDefault(require("prop-types"));
-
 var _matchComponentTypes = require("./matchComponentTypes");
-
 var _ensureSingleChild = require("./ensureSingleChild");
-
 var _deprecated = _interopRequireDefault(require("./deprecated"));
-
 const _excluded = ["children"];
-
 var _dec, _class, _class2;
-
 // TODO delete this class, its not used anywhere, see livegrep
-
 /**
 ---
 category: utilities/react
@@ -66,24 +54,21 @@ Abstract component identifier. Helpful for picking out a specific child.
 let ComponentIdentifier = (_dec = (0, _deprecated.default)('8.0.0', void 0, 'This component will be removed in InstUI 9.0 since its not used.'), _dec(_class = (_class2 = class ComponentIdentifier extends _react.Component {
   render() {
     const _this$props = this.props,
-          children = _this$props.children,
-          props = (0, _objectWithoutProperties2.default)(_this$props, _excluded);
+      children = _this$props.children,
+      props = (0, _objectWithoutProperties2.default)(_this$props, _excluded);
     return (0, _ensureSingleChild.ensureSingleChild)(children, props);
   }
-
 }, _class2.displayName = "ComponentIdentifier", _class2.propTypes = {
   children: _propTypes.default.node
 }, _class2.defaultProps = {
   children: null
 }, _class2.pick = (component, children) => {
   let result;
-
   _react.default.Children.forEach(children, child => {
     if ((0, _matchComponentTypes.matchComponentTypes)(child, [component])) {
       result = child;
     }
   });
-
   return result;
 }, _class2)) || _class);
 exports.ComponentIdentifier = ComponentIdentifier;

package/lib/DeterministicIdContext/DeterministicIdContext.js

@@ -1,16 +1,12 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DeterministicIdContext = void 0;
-
 var _react = _interopRequireDefault(require("react"));
-
 var _generateInstanceCounterMap = require("./generateInstanceCounterMap");
-
 /*
  * The MIT License (MIT)
  *
@@ -34,6 +30,6 @@ var _generateInstanceCounterMap = require("./generateInstanceCounterMap");
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-const DeterministicIdContext = /*#__PURE__*/_react.default.createContext((0, _generateInstanceCounterMap.generateInstanceCounterMap)());
 
+const DeterministicIdContext = /*#__PURE__*/_react.default.createContext((0, _generateInstanceCounterMap.generateInstanceCounterMap)());
 exports.DeterministicIdContext = DeterministicIdContext;

package/lib/DeterministicIdContext/DeterministicIdContextProvider.js

@@ -1,18 +1,13 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DeterministicIdContextProvider = void 0;
-
 var _react = _interopRequireDefault(require("react"));
-
 var _generateInstanceCounterMap = require("./generateInstanceCounterMap");
-
 var _DeterministicIdContext = require("./DeterministicIdContext");
-
 /*
  * The MIT License (MIT)
  *
@@ -36,7 +31,9 @@ var _DeterministicIdContext = require("./DeterministicIdContext");
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 const defaultContextValue = (0, _generateInstanceCounterMap.generateInstanceCounterMap)();
+
 /**
  * ---
  * category: components/utilities
@@ -47,12 +44,11 @@ const defaultContextValue = (0, _generateInstanceCounterMap.generateInstanceCoun
 
 const DeterministicIdContextProvider = _ref => {
   let children = _ref.children,
-      instanceCounterMap = _ref.instanceCounterMap;
+    instanceCounterMap = _ref.instanceCounterMap;
   return /*#__PURE__*/_react.default.createElement(_DeterministicIdContext.DeterministicIdContext.Provider, {
     value: instanceCounterMap
   }, children);
 };
-
 exports.DeterministicIdContextProvider = DeterministicIdContextProvider;
 DeterministicIdContextProvider.defaultProps = {
   instanceCounterMap: defaultContextValue

package/lib/DeterministicIdContext/generateInstanceCounterMap.js

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 exports.generateInstanceCounterMap = generateInstanceCounterMap;
-
 /*
  * The MIT License (MIT)
  *
@@ -29,9 +28,9 @@ exports.generateInstanceCounterMap = generateInstanceCounterMap;
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 function generateInstanceCounterMap() {
   return new Map();
 }
-
 var _default = generateInstanceCounterMap;
 exports.default = _default;

package/lib/DeterministicIdContext/index.js

@@ -27,11 +27,7 @@ Object.defineProperty(exports, "withDeterministicId", {
     return _withDeterministicId.withDeterministicId;
   }
 });
-
 var _generateInstanceCounterMap = require("./generateInstanceCounterMap");
-
 var _DeterministicIdContextProvider = require("./DeterministicIdContextProvider");
-
 var _DeterministicIdContext = require("./DeterministicIdContext");
-
 var _withDeterministicId = require("./withDeterministicId");

package/lib/DeterministicIdContext/withDeterministicId.js

@@ -1,26 +1,17 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.withDeterministicId = exports.default = void 0;
-
 var _react = _interopRequireWildcard(require("react"));
-
 var _hoistNonReactStatics = _interopRequireDefault(require("hoist-non-react-statics"));
-
 var _DeterministicIdContext = require("./DeterministicIdContext");
-
 var _decorator = require("@instructure/ui-decorator/lib/decorator.js");
-
 var _generateId = require("@instructure/ui-utils/lib/generateId.js");
-
 var _console = require("@instructure/console");
-
 /*
  * The MIT License (MIT)
  *
@@ -57,35 +48,32 @@ const withDeterministicId = (0, _decorator.decorator)(ComposedComponent => {
   const WithDeterministicId = /*#__PURE__*/(0, _react.forwardRef)((props, ref) => {
     const componentName = ComposedComponent.componentId || ComposedComponent.displayName || ComposedComponent.name;
     const instanceCounterMap = (0, _react.useContext)(_DeterministicIdContext.DeterministicIdContext);
-
     const deterministicId = function () {
       let instanceName = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : componentName;
       return (0, _generateId.generateId)(instanceName, instanceCounterMap);
     };
-
     if (props.deterministicId) {
       (0, _console.warn)(false, `Manually passing the "deterministicId" property is not allowed on the ${componentName} component.\n`, props.deterministicId);
     }
-
     return /*#__PURE__*/_react.default.createElement(ComposedComponent, Object.assign({
       ref: ref,
       deterministicId: deterministicId
     }, props));
   });
-  (0, _hoistNonReactStatics.default)(WithDeterministicId, ComposedComponent); // we have to pass these on, because sometimes users
+  (0, _hoistNonReactStatics.default)(WithDeterministicId, ComposedComponent);
+
+  // we have to pass these on, because sometimes users
   // access propTypes of the component in other components
   // eslint-disable-next-line react/forbid-foreign-prop-types
-
   WithDeterministicId.propTypes = ComposedComponent.propTypes;
-  WithDeterministicId.defaultProps = ComposedComponent.defaultProps; // These static fields exist on InstUI components
-  //@ts-expect-error fix this
+  WithDeterministicId.defaultProps = ComposedComponent.defaultProps;
 
+  // These static fields exist on InstUI components
+  //@ts-expect-error fix this
   WithDeterministicId.allowedProps = ComposedComponent.allowedProps;
-
   if (process.env.NODE_ENV !== 'production') {
     WithDeterministicId.displayName = `WithDeterministicId(${ComposedComponent.displayName})`;
   }
-
   return WithDeterministicId;
 });
 exports.withDeterministicId = withDeterministicId;

package/lib/callRenderProp.js

@@ -1,15 +1,12 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.callRenderProp = callRenderProp;
 exports.default = void 0;
-
 var _react = _interopRequireDefault(require("react"));
-
 /*
  * The MIT License (MIT)
  *
@@ -45,7 +42,6 @@ var _react = _interopRequireDefault(require("react"));
  */
 function callRenderProp(value) {
   let props = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
-
   if (typeof value === 'function') {
     // In react 16, `createElement` accepts a function. In react 15 we get an
     // error on rendering the result. Evaluate the function here if it is not a
@@ -53,14 +49,11 @@ function callRenderProp(value) {
     // fat arrow functions don't have a prototype
     if (!(value.prototype && value.prototype.isReactComponent)) {
       return value(props);
-    } // TODO type 'value' properly
-
-
+    }
+    // TODO type 'value' properly
     return /*#__PURE__*/_react.default.createElement(value, props);
   }
-
   return value;
 }
-
 var _default = callRenderProp;
 exports.default = _default;

package/lib/deprecated.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.deprecated = exports.default = void 0;
-
 var _decorator = require("@instructure/ui-decorator/lib/decorator.js");
-
 var _console = require("@instructure/console");
-
 /*
  * The MIT License (MIT)
  *
@@ -32,27 +29,21 @@ var _console = require("@instructure/console");
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 const deprecated = (() => {
   if (process.env.NODE_ENV === 'production') {
     const deprecated = function () {
       return ComposedComponent => ComposedComponent;
-    }; // eslint-disable-next-line react/display-name
-
-
+    };
+    // eslint-disable-next-line react/display-name
     deprecated.deprecatePropValues = () => () => null;
-
     deprecated.warnDeprecatedProps = () => {};
-
     deprecated.warnDeprecatedComponent = () => {};
-
     deprecated.changedPackageWarning = () => '';
-
     return deprecated;
   }
-
   const deprecated = (0, _decorator.decorator)(function (ComposedComponent, version, oldProps) {
     let message = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : '';
-
     /**
      * ---
      * category: utilities/react
@@ -79,31 +70,26 @@ const deprecated = (() => {
      * @module deprecated
      */
     class DeprecatedComponent extends ComposedComponent {}
-
     DeprecatedComponent.prototype.componentDidMount = function () {
       if (oldProps) {
         warnDeprecatedProps(ComposedComponent.name, version, this.props, oldProps, message);
       } else {
         warnDeprecatedComponent(version, ComposedComponent.name, message);
       }
-
       if (ComposedComponent.prototype.componentDidMount) {
         ComposedComponent.prototype.componentDidMount.call(this);
       }
     };
-
     DeprecatedComponent.prototype.componentDidUpdate = function (prevProps, prevState, prevContext) {
       if (oldProps) {
         warnDeprecatedProps(ComposedComponent.name, version, this.props, oldProps, message);
       } else {
         warnDeprecatedComponent(version, ComposedComponent.name, message);
       }
-
       if (ComposedComponent.prototype.componentDidUpdate) {
         ComposedComponent.prototype.componentDidUpdate.call(this, prevProps, prevState, prevContext);
       }
     };
-
     return DeprecatedComponent;
   })
   /**
@@ -115,9 +101,7 @@ const deprecated = (() => {
    * @param {function} propType - validates the prop type. Returns null if valid, error otherwise
    * @param {array} deprecated - an array of the deprecated variant names
    * @param {string|function} message - a string with additional information (like the version the prop will be removed) or a function returning a string
-   */
-  ;
-
+   */;
   deprecated.deprecatePropValues = function (propType) {
     let deprecated = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : [];
     let message = arguments.length > 2 ? arguments[2] : void 0;
@@ -129,15 +113,12 @@ const deprecated = (() => {
         propValue: props[propName]
       }) : `The '${props[propName]}' value for the \`${propName}\` prop is deprecated. ${message || ''}`;
       (0, _console.logWarnDeprecated)(!isDeprecatedValue, `[${componentName}] ${warningMessage}`);
-
       for (var _len = arguments.length, rest = new Array(_len > 3 ? _len - 3 : 0), _key = 3; _key < _len; _key++) {
         rest[_key - 3] = arguments[_key];
       }
-
       return isDeprecatedValue ? null : propType(props, propName, componentName, ...rest);
     };
   };
-
   function warnDeprecatedProps(componentName, version, props, oldProps) {
     let message = arguments.length > 4 && arguments[4] !== void 0 ? arguments[4] : '';
     Object.keys(oldProps).forEach(oldProp => {
@@ -148,10 +129,8 @@ const deprecated = (() => {
       }
     });
   }
-
   ;
   deprecated.warnDeprecatedProps = warnDeprecatedProps;
-
   function warnDeprecatedComponent(version, componentName, message) {
     (0, _console.logWarnDeprecated)(false, `[${componentName}] is deprecated and will be removed in version ${version}. ${message || ''}`);
   }
@@ -163,10 +142,9 @@ const deprecated = (() => {
    * @param {String} componentName the name of the component or Function.name of the utility function
    * @param {String} message a message to display as a console error in DEV env when condition is false
    */
-
-
   ;
   deprecated.warnDeprecatedComponent = warnDeprecatedComponent
+
   /**
    * ---
    * category: utilities
@@ -174,16 +152,12 @@ const deprecated = (() => {
    * @param {String} prevPackage the previous name of the package
    * @param {String} newPackage the new version of the package
    * @return {String} the formatted warning string
-   */
-  ;
-
+   */;
   deprecated.changedPackageWarning = (prevPackage, newPackage) => {
     return `It has been moved from @instructure/${prevPackage} to @instructure/${newPackage}.`;
   };
-
   return deprecated;
 })();
-
 exports.deprecated = deprecated;
 var _default = deprecated;
 exports.default = _default;

package/lib/ensureSingleChild.js

@@ -1,17 +1,13 @@
 "use strict";
 
 var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard").default;
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
 exports.ensureSingleChild = ensureSingleChild;
-
 var _react = _interopRequireWildcard(require("react"));
-
 var _safeCloneElement = require("./safeCloneElement");
-
 /*
  * The MIT License (MIT)
  *
@@ -52,9 +48,7 @@ var _safeCloneElement = require("./safeCloneElement");
  */
 function ensureSingleChild(child) {
   let props = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
-
   const childCount = _react.Children.count(child);
-
   if (childCount === 0) {
     return null;
   } else if (typeof child === 'string' && child.length > 0 || childCount > 1) {
@@ -64,6 +58,5 @@ function ensureSingleChild(child) {
     return (0, _safeCloneElement.safeCloneElement)(Array.isArray(child) ? child[0] : child, props);
   }
 }
-
 var _default = ensureSingleChild;
 exports.default = _default;

package/lib/experimental.js

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.experimental = exports.default = void 0;
-
 var _decorator = require("@instructure/ui-decorator/lib/decorator.js");
-
 var _console = require("@instructure/console");
-
 /*
  * The MIT License (MIT)
  *
@@ -32,6 +29,7 @@ var _console = require("@instructure/console");
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 const experimental = process.env.NODE_ENV == 'production' ? () => ReactComponent => ReactComponent : (0, _decorator.decorator)((ComposedComponent, experimentalProps, message) => {
   return class ExperimentalComponent extends ComposedComponent {
     componentDidMount() {
@@ -42,12 +40,10 @@ const experimental = process.env.NODE_ENV == 'production' ? () => ReactComponent
           warnExperimentalComponent(ComposedComponent.name, message);
         }
       }
-
       if (super.componentDidMount) {
         super.componentDidMount();
       }
     }
-
     componentDidUpdate(prevProps, prevState, prevContext) {
       if (!this.props.__dangerouslyIgnoreExperimentalWarnings) {
         if (experimentalProps) {
@@ -56,27 +52,22 @@ const experimental = process.env.NODE_ENV == 'production' ? () => ReactComponent
           warnExperimentalComponent(ComposedComponent.name, message);
         }
       }
-
       if (super.componentDidUpdate) {
         super.componentDidUpdate(prevProps, prevState, prevContext);
       }
     }
-
   };
 });
 exports.experimental = experimental;
-
 function warnExperimentalProps(name, props, experimentalProps) {
   let message = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : '';
   experimentalProps.forEach(experimentalProp => {
     (0, _console.logWarn)(typeof props[experimentalProp] === 'undefined', `[${name}] The \`${experimentalProp}\` prop is experimental and its API could change significantly in a future release. ${message}`);
   });
 }
-
 function warnExperimentalComponent(name) {
   let message = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : '';
   (0, _console.logWarn)(false, `[${name}] is experimental and its API could change significantly in a future release. ${message}`);
 }
-
 var _default = experimental;
 exports.default = _default;

package/lib/getDisplayName.js

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 exports.getDisplayName = getDisplayName;
-
 /*
  * The MIT License (MIT)
  *
@@ -43,6 +42,5 @@ exports.getDisplayName = getDisplayName;
 function getDisplayName(ReactComponent) {
   return typeof ReactComponent === 'string' ? ReactComponent : ReactComponent.displayName || ReactComponent.name;
 }
-
 var _default = getDisplayName;
 exports.default = _default;