@instructure/ui-react-utils 11.7.3 → 11.7.4-pr-snapshot-1781695314229

package/lib/passthroughProps.js

@@ -1,53 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.passthroughProps = passthroughProps;
-var _isPropValid = _interopRequireDefault(require("@emotion/is-prop-valid"));
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-// list of "valid" props https://github.com/emotion-js/emotion/blob/master/packages/is-prop-valid/src/props.js
-
-/**
- * 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)
- *
- * Disallowed is anything else and 'style', 'styles', 'className', 'children',
- * '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
-  // styles and makeStyle can not pass through
-  .filter(propName => (0, _isPropValid.default)(propName) && propName !== 'style' && propName !== 'className' && propName !== 'children' && propName !== 'styles' && propName !== 'makeStyles' && propName !== 'deterministicId').forEach(propName => {
-    validProps[propName] = props[propName];
-  });
-  return validProps;
-}
-var _default = exports.default = passthroughProps;

package/lib/pickProps.js

@@ -1,64 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.pickProps = pickProps;
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/react
- * ---
- * Return a props object with only specified propTypes.
- *
- * @param props React component props
- * @param propTypesOrAllowedPropList React component propTypes or the list of allowed prop keys
- * @param include an optional array of prop names to include
- * @returns props object with only the included props
- * @module pickProps
- */
-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
-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;
-}
-var _default = exports.default = pickProps;

package/lib/safeCloneElement.js

@@ -1,105 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.safeCloneElement = safeCloneElement;
-var _react = require("react");
-var _console = require("@instructure/console");
-var _createChainedFunction = require("@instructure/ui-utils/lib/createChainedFunction.js");
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/react
- * ---
- * Clones a React element without overwriting refs.
- * @param element The element to clone
- * @param props Props of the element
- * @param children
- */
-function safeCloneElement(element, props, ...children) {
-  const cloneRef = props.ref;
-  // Support both React 18 (element.ref) and React 19+ (element.props.ref)
-  // TypeScript's ReactElement type does not always include a 'ref' property,
-  // so we use 'as any' to safely access it for React 18 compatibility.
-  let isReact19OrNewer = true;
-  const versArr = _react.version.split('.', 1);
-  if (versArr.length > 0 && parseInt(versArr[0], 10) < 19) {
-    isReact19OrNewer = false;
-  }
-  // this needs to happen in such tricky way because React 18 and earlier
-  // throw warning when one tries to access element.props.ref, see
-  // https://github.com/facebook/react/blob/18-3-1/packages/react/src/jsx/ReactJSXElement.js#L108
-  const originalRef = isReact19OrNewer ? element.props.ref : element.ref;
-  const originalRefIsAFunction = typeof originalRef === 'function';
-  const cloneRefIsFunction = typeof cloneRef === 'function';
-  const mergedProps = {
-    ...props
-  };
-  if (element.props.style && props.style) {
-    // merge with existing styles
-    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
-  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.
-    // If only one is a function it will just use that function with no extra overhead.
-    // This is necessary in cases where props[prop] is `null` or `undefined` which would
-    // otherwise unwantedly override element.props[prop].
-    if (prop.indexOf('on') === 0 && (typeof props[prop] === 'function' || typeof element.props[prop] === 'function')) {
-      ;
-      mergedProps[prop] = (0, _createChainedFunction.createChainedFunction)(element.props[prop], props[prop]);
-    }
-  });
-  if (originalRef == null || cloneRef == null) {
-    return /*#__PURE__*/(0, _react.cloneElement)(element, mergedProps, ...children);
-  }
-  (0, _console.logWarn)(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__*/(0, _react.cloneElement)(element, {
-    ...mergedProps,
-    ref(component) {
-      if (cloneRefIsFunction) {
-        ;
-        cloneRef(component);
-      } else {
-        cloneRef.current = component;
-      }
-      originalRefIsAFunction && originalRef(component);
-    }
-  }, ...children);
-}
-var _default = exports.default = safeCloneElement;

package/lib/windowMessageListener.js

@@ -1,110 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-exports.origin = origin;
-exports.windowMessageListener = void 0;
-var _decorator = require("@instructure/ui-decorator/lib/decorator.js");
-var _ownerWindow = require("@instructure/ui-dom-utils/lib/ownerWindow.js");
-/*
- * The MIT License (MIT)
- *
- * Copyright (c) 2015 - present Instructure, Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * ---
- * category: utilities/react
- * ---
- * A decorator or higher order component that provides methods
- * for cross-origin communication (between iframes/windows).
- *
- * see https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage
- * @module windowMessageListener
- * @param {Function} messageHandler a handler for messages receieved by the component
- * @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 = exports.windowMessageListener = (0, _decorator.decorator)((ComposedComponent, messageHandler, validSource) => {
-  return class extends ComposedComponent {
-    static postMessage = function (target, message, origin) {
-      target.postMessage(message, origin);
-    };
-    componentDidMount() {
-      const win = (0, _ownerWindow.ownerWindow)(this);
-      win.addEventListener('message', this.handleMessage, false);
-      if (super.componentDidMount) {
-        super.componentDidMount();
-      }
-    }
-    componentWillUnmount() {
-      const win = (0, _ownerWindow.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) {
-        const sourceFrame = eventSource.frameElement;
-        const sourceName = sourceFrame ? sourceFrame.getAttribute('name') : null;
-        return sourceName === expectedSource;
-      } else {
-        return false;
-      }
-    }
-    handleMessage = e => {
-      if (this.sourceIsValid(e.source) && e.origin === origin(this) && e.data) {
-        messageHandler.call(this, e.data);
-      }
-    };
-  };
-});
-
-/**
- * Return the origin of the owner window of the DOM element
- *
- * see https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage
- *
- * @param {DOMElement} node
- * @returns {String} the origin
- */
-function origin(node) {
-  const ownWindow = (0, _ownerWindow.ownerWindow)(node);
-  const {
-    location
-  } = ownWindow;
-  if (location.protocol === 'file:') {
-    return '*';
-  } else if (location.origin) {
-    return location.origin;
-  } else if (location.port) {
-    return `${location.protocol}//${location.hostname}:${location.port}`;
-  } else {
-    return `${location.protocol}//${location.hostname}`;
-  }
-}
-var _default = exports.default = windowMessageListener;