@instructure/ui-react-utils 8.33.1 → 8.33.2

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.33.2](https://github.com/instructure/instructure-ui/compare/v8.33.1...v8.33.2) (2023-01-25)
+
+**Note:** Version bump only for package @instructure/ui-react-utils
+
 ## [8.33.1](https://github.com/instructure/instructure-ui/compare/v8.33.0...v8.33.1) (2023-01-06)
 
 **Note:** Version bump only for package @instructure/ui-react-utils

package/es/ComponentIdentifier.js

@@ -1,8 +1,6 @@
 import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
 const _excluded = ["children"];
-
 var _dec, _class, _class2;
-
 /*
  * The MIT License (MIT)
  *
@@ -26,12 +24,14 @@ var _dec, _class, _class2;
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 import React, { Component } from 'react';
 import PropTypes from 'prop-types';
 import { matchComponentTypes } from './matchComponentTypes';
 import { ensureSingleChild } from './ensureSingleChild';
-import deprecated from './deprecated'; // TODO delete this class, its not used anywhere, see livegrep
+import deprecated from './deprecated';
 
+// TODO delete this class, its not used anywhere, see livegrep
 /**
 ---
 category: utilities/react
@@ -68,16 +68,13 @@ Abstract component identifier. Helpful for picking out a specific child.
   ```
   @module ComponentIdentifier
 **/
-
 let ComponentIdentifier = (_dec = deprecated('8.0.0', void 0, 'This component will be removed in InstUI 9.0 since its not used.'), _dec(_class = (_class2 = class ComponentIdentifier extends Component {
   render() {
     const _this$props = this.props,
-          children = _this$props.children,
-          props = _objectWithoutProperties(_this$props, _excluded);
-
+      children = _this$props.children,
+      props = _objectWithoutProperties(_this$props, _excluded);
     return ensureSingleChild(children, props);
   }
-
 }, _class2.displayName = "ComponentIdentifier", _class2.propTypes = {
   children: PropTypes.node
 }, _class2.defaultProps = {

package/es/DeterministicIdContext/DeterministicIdContextProvider.js

@@ -25,6 +25,7 @@ import React from 'react';
 import { generateInstanceCounterMap } from './generateInstanceCounterMap';
 import { DeterministicIdContext } from './DeterministicIdContext';
 const defaultContextValue = generateInstanceCounterMap();
+
 /**
  * ---
  * category: components/utilities
@@ -35,12 +36,11 @@ const defaultContextValue = generateInstanceCounterMap();
 
 const DeterministicIdContextProvider = _ref => {
   let children = _ref.children,
-      instanceCounterMap = _ref.instanceCounterMap;
+    instanceCounterMap = _ref.instanceCounterMap;
   return /*#__PURE__*/React.createElement(DeterministicIdContext.Provider, {
     value: instanceCounterMap
   }, children);
 };
-
 DeterministicIdContextProvider.defaultProps = {
   instanceCounterMap: defaultContextValue
 };

package/es/DeterministicIdContext/generateInstanceCounterMap.js

@@ -21,9 +21,9 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 function generateInstanceCounterMap() {
   return new Map();
 }
-
 export default generateInstanceCounterMap;
 export { generateInstanceCounterMap };

package/es/DeterministicIdContext/index.js

@@ -21,6 +21,7 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 export { generateInstanceCounterMap } from './generateInstanceCounterMap';
 export { DeterministicIdContextProvider } from './DeterministicIdContextProvider';
 export { DeterministicIdContext } from './DeterministicIdContext';

package/es/DeterministicIdContext/withDeterministicId.js

@@ -27,7 +27,6 @@ import { DeterministicIdContext } from './DeterministicIdContext';
 import { decorator } from '@instructure/ui-decorator';
 import { generateId } from '@instructure/ui-utils';
 import { warn } from '@instructure/console';
-
 /**
  * This decorator is used to enable the decorated class to use the `DeterministicIdContext` which is needed
  * for deterministic id generation.
@@ -40,35 +39,32 @@ const withDeterministicId = decorator(ComposedComponent => {
   const WithDeterministicId = /*#__PURE__*/forwardRef((props, ref) => {
     const componentName = ComposedComponent.componentId || ComposedComponent.displayName || ComposedComponent.name;
     const instanceCounterMap = useContext(DeterministicIdContext);
-
     const deterministicId = function () {
       let instanceName = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : componentName;
       return generateId(instanceName, instanceCounterMap);
     };
-
     if (props.deterministicId) {
       warn(false, `Manually passing the "deterministicId" property is not allowed on the ${componentName} component.\n`, props.deterministicId);
     }
-
     return /*#__PURE__*/React.createElement(ComposedComponent, Object.assign({
       ref: ref,
       deterministicId: deterministicId
     }, props));
   });
-  hoistNonReactStatics(WithDeterministicId, ComposedComponent); // we have to pass these on, because sometimes users
+  hoistNonReactStatics(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;
 });
 export default withDeterministicId;

package/es/callRenderProp.js

@@ -21,8 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-import React from 'react';
 
+import React from 'react';
 /**
  * ---
  * category: utilities/react
@@ -34,7 +34,6 @@ import React from '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
@@ -42,14 +41,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.createElement(value, props);
   }
-
   return value;
 }
-
 export default callRenderProp;
 export { callRenderProp };

package/es/deprecated.js

@@ -23,28 +23,20 @@
  */
 import { decorator } from '@instructure/ui-decorator';
 import { logWarnDeprecated as warnDeprecated } from '@instructure/console';
-
 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 = decorator(function (ComposedComponent, version, oldProps) {
     let message = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : '';
-
     /**
      * ---
      * category: utilities/react
@@ -71,31 +63,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;
   })
   /**
@@ -107,9 +94,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;
@@ -121,15 +106,12 @@ const deprecated = (() => {
         propValue: props[propName]
       }) : `The '${props[propName]}' value for the \`${propName}\` prop is deprecated. ${message || ''}`;
       warnDeprecated(!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 => {
@@ -140,10 +122,8 @@ const deprecated = (() => {
       }
     });
   }
-
   ;
   deprecated.warnDeprecatedProps = warnDeprecatedProps;
-
   function warnDeprecatedComponent(version, componentName, message) {
     warnDeprecated(false, `[${componentName}] is deprecated and will be removed in version ${version}. ${message || ''}`);
   }
@@ -155,10 +135,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
@@ -166,15 +145,11 @@ 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;
 })();
-
 export default deprecated;
 export { deprecated };

package/es/ensureSingleChild.js

@@ -21,8 +21,10 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
 import React, { Children } from 'react';
 import { safeCloneElement } from './safeCloneElement';
+
 /**
  * ---
  * category: utilities/react
@@ -37,11 +39,9 @@ import { safeCloneElement } from './safeCloneElement';
  * @param {Object} props - props for child
  * @returns {ReactElement|null} cloned instance for a single child, or children wrapped in a span
  */
-
 function ensureSingleChild(child) {
   let props = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
   const childCount = Children.count(child);
-
   if (childCount === 0) {
     return null;
   } else if (typeof child === 'string' && child.length > 0 || childCount > 1) {
@@ -51,6 +51,5 @@ function ensureSingleChild(child) {
     return safeCloneElement(Array.isArray(child) ? child[0] : child, props);
   }
 }
-
 export default ensureSingleChild;
 export { ensureSingleChild };

package/es/experimental.js

@@ -33,12 +33,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) {
@@ -47,27 +45,22 @@ const experimental = process.env.NODE_ENV == 'production' ? () => ReactComponent
           warnExperimentalComponent(ComposedComponent.name, message);
         }
       }
-
       if (super.componentDidUpdate) {
         super.componentDidUpdate(prevProps, prevState, prevContext);
       }
     }
-
   };
 });
-
 function warnExperimentalProps(name, props, experimentalProps) {
   let message = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : '';
   experimentalProps.forEach(experimentalProp => {
     warn(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] : '';
   warn(false, `[${name}] is experimental and its API could change significantly in a future release. ${message}`);
 }
-
 export default experimental;
 export {
 /**

package/es/getDisplayName.js

@@ -35,6 +35,5 @@
 function getDisplayName(ReactComponent) {
   return typeof ReactComponent === 'string' ? ReactComponent : ReactComponent.displayName || ReactComponent.name;
 }
-
 export default getDisplayName;
 export { getDisplayName };

package/es/getElementType.js

@@ -21,8 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-import { logWarn as warn } from '@instructure/console';
 
+import { logWarn as warn } from '@instructure/console';
 /**
  * ---
  * category: utilities/react
@@ -37,31 +37,25 @@ import { logWarn as warn } from '@instructure/console';
  */
 function getElementType(Component, props, getDefault) {
   var _Component$defaultPro, _Component$defaultPro2;
-
   if (props.as && props.as !== ((_Component$defaultPro = Component.defaultProps) === null || _Component$defaultPro === void 0 ? void 0 : _Component$defaultPro.as)) {
     return props.as;
   }
-
   if (typeof getDefault === 'function') {
     return getDefault();
   }
-
   if (props.href) {
     return 'a';
   }
-
   if (props.to) {
-    warn( // if to prop is used without as
+    warn(
+    // if to prop is used without as
     !props.as, `[${Component.displayName}] \`as\` prop should be provided when using \`to\``);
     return 'a';
   }
-
   if (typeof props.onClick === 'function') {
     return 'button';
   }
-
   return ((_Component$defaultPro2 = Component.defaultProps) === null || _Component$defaultPro2 === void 0 ? void 0 : _Component$defaultPro2.as) || 'span';
 }
-
 export default getElementType;
 export { getElementType };

package/es/getInteraction.js

@@ -40,20 +40,22 @@
  */
 export function getInteraction() {
   let _ref = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {},
-      _ref$props = _ref.props,
-      props = _ref$props === void 0 ? {} : _ref$props,
-      _ref$interactionTypes = _ref.interactionTypes,
-      interactionTypes = _ref$interactionTypes === void 0 ? ['disabled', 'readonly'] : _ref$interactionTypes;
-
+    _ref$props = _ref.props,
+    props = _ref$props === void 0 ? {} : _ref$props,
+    _ref$interactionTypes = _ref.interactionTypes,
+    interactionTypes = _ref$interactionTypes === void 0 ? ['disabled', 'readonly'] : _ref$interactionTypes;
   const interaction = props.interaction,
-        disabled = props.disabled,
-        readOnly = props.readOnly; // interaction is the source of truth when it is provided
+    disabled = props.disabled,
+    readOnly = props.readOnly;
 
-  if (interaction) return interaction; // if there's no interaction specified, use disabled or readOnly if they are defined as props (note, disabled will win
-  // over readOnly if both are provided)
+  // interaction is the source of truth when it is provided
+  if (interaction) return interaction;
 
+  // if there's no interaction specified, use disabled or readOnly if they are defined as props (note, disabled will win
+  // over readOnly if both are provided)
   if (interactionTypes.includes('disabled') && disabled) return 'disabled';
-  if (interactionTypes.includes('readonly') && readOnly) return 'readonly'; // We were provided with nothing, use enabled by default
+  if (interactionTypes.includes('readonly') && readOnly) return 'readonly';
 
+  // We were provided with nothing, use enabled by default
   return 'enabled';
 }

package/es/hack.js

@@ -23,6 +23,7 @@
  */
 import { decorator } from '@instructure/ui-decorator';
 import { logWarn as warn } from '@instructure/console';
+
 /**
  * ---
  * category: utilities/react
@@ -44,39 +45,32 @@ import { logWarn as warn } from '@instructure/console';
  * @param {string} message
  * @return {function} React component flagged as having hack props
  */
-
 const hack = process.env.NODE_ENV == 'production' ? () => Component => Component : decorator((ComposedComponent, hackProps, message) => {
   return class HackComponent extends ComposedComponent {
     componentDidMount() {
       if (hackProps) {
         warnHackProps(ComposedComponent.name, this.props, hackProps, message);
       }
-
       if (super.componentDidMount) {
         super.componentDidMount();
       }
     }
-
     componentDidUpdate(prevProps, prevState, prevContext) {
       if (hackProps) {
         warnHackProps(ComposedComponent.name, this.props, hackProps, message);
       }
-
       if (super.componentDidUpdate) {
         super.componentDidUpdate(prevProps, prevState, prevContext);
       }
     }
-
   };
 });
-
 function warnHackProps(name, props, hackProps) {
   let message = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : '';
   hackProps.forEach(hackProp => {
     warn(typeof props[hackProp] === 'undefined', `[${name}] The \`${hackProp}\` prop is a temporary hack and will be removed in a future release. ${message}`);
   });
 }
-
 export default hack;
 export {
 /**

package/es/matchComponentTypes.js

@@ -21,8 +21,8 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-import { getDisplayName } from './getDisplayName';
 
+import { getDisplayName } from './getDisplayName';
 /**
  * ---
  * category: utilities/react
@@ -37,7 +37,6 @@ import { getDisplayName } from './getDisplayName';
  */
 function matchComponentTypes(componentInstance) {
   let types = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : [];
-
   if (componentInstance && componentInstance.type) {
     const displayNames = types.map(type => getDisplayName(type));
     return displayNames.indexOf(getDisplayName(componentInstance.type)) >= 0;
@@ -45,6 +44,5 @@ function matchComponentTypes(componentInstance) {
     return false;
   }
 }
-
 export default matchComponentTypes;
 export { matchComponentTypes };

package/es/omitProps.js

@@ -44,29 +44,22 @@ function omitProps(props, propsToOmit, exclude) {
   const keysToOmit = exclude ? propKeys.concat(exclude) : propKeys;
   return omit(props, keysToOmit);
 }
-
 const hasOwnProperty = Object.prototype.hasOwnProperty;
-
 const omit = (originalObject, keysToOmit) => {
   // code based on babel's _objectWithoutProperties
   const newObject = {};
-
   for (const key in originalObject) {
     // special case because we always want to omit these and === is faster than
     // concat'ing them in
     if (key === 'theme' || key === 'children' || key === 'className' || key === 'style' || key === 'styles' || key === 'makeStyles' || key === 'themeOverride' || key === 'deterministicId') {
       continue;
     }
-
     if (keysToOmit.includes(key) || !hasOwnProperty.call(originalObject, key)) {
       continue;
     }
-
     newObject[key] = originalObject[key];
   }
-
   return newObject;
 };
-
 export default omitProps;
 export { omitProps };

package/es/passthroughProps.js

@@ -23,6 +23,7 @@
  */
 // list of "valid" props https://github.com/emotion-js/emotion/blob/master/packages/is-prop-valid/src/props.js
 import isPropValid from '@emotion/is-prop-valid';
+
 /**
  * Removes disallowed keys from the given object. Allowed keys: Valid props for
  * HTML or SVG elements (see https://github.com/emotion-js/emotion/tree/main/packages/is-prop-valid)
@@ -31,16 +32,15 @@ import isPropValid from '@emotion/is-prop-valid';
  * 'makeStyles', 'deterministicId'
  * @param props The props to process
  */
-
 function passthroughProps(props) {
   const validProps = {};
-  Object.keys(props) // style and className need to be explicitly passed through
+  Object.keys(props)
+  // style and className need to be explicitly passed through
   // styles and makeStyle can not pass through
   .filter(propName => isPropValid(propName) && propName !== 'style' && propName !== 'className' && propName !== 'children' && propName !== 'styles' && propName !== 'makeStyles' && propName !== 'deterministicId').forEach(propName => {
     validProps[propName] = props[propName];
   });
   return validProps;
 }
-
 export { passthroughProps };
 export default passthroughProps;

package/es/pickProps.js

@@ -38,25 +38,21 @@ function pickProps(props, propTypesOrAllowedPropList, include) {
   const propKeys = Array.isArray(propTypesOrAllowedPropList) ? propTypesOrAllowedPropList : Object.keys(propTypesOrAllowedPropList || {});
   const combined = include ? propKeys.concat(include) : propKeys;
   return pick(props, combined);
-} // this was the fastest implementation from testing: https://jsperf.com/pick-props
-
+}
 
+// this was the fastest implementation from testing: https://jsperf.com/pick-props
 function pick(obj, keys) {
   const res = {};
   const len = keys.length;
   let idx = -1;
   let key;
-
   while (++idx < len) {
     key = keys[idx];
-
     if (key in obj) {
       res[key] = obj[key];
     }
   }
-
   return res;
 }
-
 export default pickProps;
 export { pickProps };