@instructure/ui-react-utils 10.26.1 → 11.0.1-snapshot-0

package/src/deprecated.ts

@@ -1,237 +0,0 @@
-/*
- * 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.
- */
-import { decorator } from '@instructure/ui-decorator'
-import { logWarnDeprecated as warnDeprecated } from '@instructure/console'
-import { ComponentClass } from 'react'
-import PropTypes from 'prop-types'
-
-export interface DeprecatedDecorator {
-  (version: string, oldProps?: Record<string, any> | null, message?: string): (
-    ComposedComponent: any
-  ) => any
-  deprecatePropValues: (...args: any[]) => PropTypes.Validator<unknown>
-  warnDeprecatedProps: (...args: any[]) => void
-  warnDeprecatedComponent: (...args: any[]) => void
-  changedPackageWarning: (...args: any[]) => string
-}
-
-/**
- * ---
- * category: utilities/react
- * ---
- * Deprecate React component props. Warnings will display in the console when deprecated
- * props are used. Include the version number when the deprecated component will be removed.
- *
- * ```js-code
- *  class Example extends Component {
- *    static propTypes = {
- *      currentProp: PropTypes.func
- *    }
- *  }
- *  export default deprecated('7.0.0', {
- *    deprecatedProp: 'currentProp',
- *    nowNonExistentProp: true
- *  })(Example)
- * ```
- *
- * @param {string} version
- * @param {object} oldProps (if this argument is null or undefined, the entire component is deprecated)
- * @param {string} message
- * @return {function} React component with deprecated props behavior
- * @module deprecated
- */
-const deprecated = (() => {
-  if (process.env.NODE_ENV === 'production') {
-    const deprecated: DeprecatedDecorator = function () {
-      return (ComposedComponent: ComponentClass) => ComposedComponent
-    }
-    deprecated.deprecatePropValues = () => () => null
-    deprecated.warnDeprecatedProps = () => {}
-    deprecated.warnDeprecatedComponent = () => {}
-    deprecated.changedPackageWarning = () => ''
-    return deprecated
-  }
-  const deprecated = decorator(
-    (
-      ComposedComponent,
-      version: string,
-      oldProps?: Record<string, any>,
-      message = ''
-    ) => {
-      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
-    }
-  )
-  /**
-   * ---
-   * category: utilities
-   * ---
-   * Trigger a console warning if the specified prop variant is 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 as DeprecatedDecorator).deprecatePropValues = (
-    propType: PropTypes.Validator<unknown>,
-    deprecated: string[] = [],
-    message:
-      | string
-      | ((arg: { props: any; propName: string; propValue: any }) => string)
-  ) => {
-    return (
-      props: Record<string, any>,
-      propName: string,
-      componentName: string,
-      ...rest
-    ) => {
-      const isDeprecatedValue = deprecated.includes(props[propName])
-
-      const warningMessage =
-        message && typeof message === 'function'
-          ? message({ props, propName, propValue: props[propName] })
-          : `The '${
-              props[propName]
-            }' value for the \`${propName}\` prop is deprecated. ${
-              message || ''
-            }`
-      warnDeprecated(!isDeprecatedValue, `[${componentName}] ${warningMessage}`)
-
-      return isDeprecatedValue
-        ? null
-        : propType(props, propName, componentName, ...rest)
-    }
-  }
-
-  function warnDeprecatedProps(
-    componentName: string,
-    version: string,
-    props: Record<string, any>,
-    oldProps: Record<string, any>,
-    message = ''
-  ) {
-    Object.keys(oldProps).forEach((oldProp) => {
-      if (typeof props[oldProp] !== 'undefined') {
-        const newProp =
-          typeof oldProps[oldProp] === 'string' ? oldProps[oldProp] : null
-
-        const newPropMessage = newProp ? `. Use \`${newProp}\` instead` : ''
-
-        warnDeprecated(
-          false,
-          `[${componentName}] \`${oldProp}\` is deprecated and will be removed in version ${version}${newPropMessage}. ${message}`
-        )
-      }
-    })
-  }
-  ;(deprecated as DeprecatedDecorator).warnDeprecatedProps = warnDeprecatedProps
-
-  function warnDeprecatedComponent(
-    version: string,
-    componentName: string,
-    message: string
-  ) {
-    warnDeprecated(
-      false,
-      `[${componentName}] is deprecated and will be removed in version ${version}. ${
-        message || ''
-      }`
-    )
-  }
-  /**
-   * ---
-   * category: utilities
-   * ---
-   * @param {String} version the version of the package in which the component or function was 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 as DeprecatedDecorator).warnDeprecatedComponent =
-    warnDeprecatedComponent
-
-  /**
-   * ---
-   * category: utilities
-   * ---
-   * @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 as DeprecatedDecorator).changedPackageWarning = (
-    prevPackage: string,
-    newPackage: string
-  ) => {
-    return `It has been moved from @instructure/${prevPackage} to @instructure/${newPackage}.`
-  }
-
-  return deprecated as DeprecatedDecorator
-})()
-
-export default deprecated
-export { deprecated }

package/src/experimental.ts

@@ -1,127 +0,0 @@
-/*
- * 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.
- */
-import { decorator } from '@instructure/ui-decorator'
-import { logWarn as warn } from '@instructure/console'
-import { ComponentClass } from 'react'
-
-/**
- * ---
- * category: utilities/react
- * ---
- * Flag React component and component props as experimental.
- * Warnings will display in the console when experimental components/props
- * props are used.
- *
- * ```js-code
- *  class Example extends Component {
- *    static propTypes = {
- *      currentProp: PropTypes.func
- *    }
- *  }
- *  export default experimental(['experimentalProp'])(Example)
- * ```
- *
- * @module experimental
- * @param {array} experimentalProps (if this argument is null or undefined, the entire component is flagged)
- * @param {string} message
- * @return {function} React component flagged as experimental
- */
-const experimental =
-  process.env.NODE_ENV == 'production'
-    ? () => (ReactComponent: ComponentClass<any>) => ReactComponent
-    : decorator(
-        (ComposedComponent, experimentalProps: string[], message: string) => {
-          return class ExperimentalComponent<
-            P extends Readonly<any>,
-            S extends Readonly<any>,
-            SS
-          > extends ComposedComponent {
-            componentDidMount() {
-              if (
-                !(this.props as any).__dangerouslyIgnoreExperimentalWarnings
-              ) {
-                if (experimentalProps) {
-                  warnExperimentalProps(
-                    ComposedComponent.name,
-                    this.props,
-                    experimentalProps,
-                    message
-                  )
-                } else {
-                  warnExperimentalComponent(ComposedComponent.name, message)
-                }
-              }
-
-              if (super.componentDidMount) {
-                super.componentDidMount()
-              }
-            }
-
-            componentDidUpdate(prevProps: P, prevState: S, prevContext: SS) {
-              if (
-                !(this.props as any).__dangerouslyIgnoreExperimentalWarnings
-              ) {
-                if (experimentalProps) {
-                  warnExperimentalProps(
-                    ComposedComponent.name,
-                    this.props,
-                    experimentalProps,
-                    message
-                  )
-                } else {
-                  warnExperimentalComponent(ComposedComponent.name, message)
-                }
-              }
-
-              if (super.componentDidUpdate) {
-                super.componentDidUpdate(prevProps, prevState, prevContext)
-              }
-            }
-          }
-        }
-      )
-
-function warnExperimentalProps(
-  name: string,
-  props: Record<string, any>,
-  experimentalProps: string[],
-  message = ''
-) {
-  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: string, message = '') {
-  warn(
-    false,
-    `[${name}] is experimental and its API could change significantly in a future release. ${message}`
-  )
-}
-
-export default experimental
-export { experimental }

package/src/hack.ts

@@ -1,128 +0,0 @@
-/*
- * 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.
- */
-import { decorator } from '@instructure/ui-decorator'
-
-import { logWarn as warn } from '@instructure/console'
-
-/**
- * ---
- * category: utilities/react
- * ---
- * Flag React component props as hack props.
- * Warnings will display in the console when hack props are used.
- *
- * ```js-code
- *  class Example extends Component {
- *    static propTypes = {
- *      currentProp: PropTypes.func
- *    }
- *  }
- *  export default hack(['hackProp'])(Example)
- * ```
- *
- * @module hack
- * @param {array} hackProps
- * @param {string} message
- * @return {function} React component flagged as having hack props
- */
-const hack =
-  process.env.NODE_ENV == 'production'
-    ? () => (Component: React.ComponentClass<any>) => Component
-    : decorator((ComposedComponent, hackProps: string[], message: string) => {
-        return class HackComponent<
-          P extends Readonly<any>,
-          S extends Readonly<any>,
-          SS
-        > extends ComposedComponent {
-          componentDidMount() {
-            if (hackProps) {
-              warnHackProps(
-                ComposedComponent.name,
-                this.props,
-                hackProps,
-                message
-              )
-            }
-
-            if (super.componentDidMount) {
-              super.componentDidMount()
-            }
-          }
-
-          componentDidUpdate(prevProps: P, prevState: S, prevContext: SS) {
-            if (hackProps) {
-              warnHackProps(
-                ComposedComponent.name,
-                this.props,
-                hackProps,
-                message
-              )
-            }
-
-            if (super.componentDidUpdate) {
-              super.componentDidUpdate(prevProps, prevState, prevContext)
-            }
-          }
-        }
-      })
-
-function warnHackProps(
-  name: string,
-  props: Record<string, unknown>,
-  hackProps: string[],
-  message = ''
-) {
-  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 {
-  /**
-   * ---
-   * category: utilities/react
-   * ---
-   * Flag React component props as hack props.
-   * Warnings will display in the console when hack props are used.
-   *
-   * ```js
-   *  class Example extends Component {
-   *    static propTypes = {
-   *      currentProp: PropTypes.func
-   *    }
-   *  }
-   *  export default hack(['hackProp'])(Example)
-   * ```
-   *
-   * @module hack
-   * @param {array} hackProps
-   * @param {string} message
-   * @return {function} React component flagged as having hack props
-   */
-  hack
-}

package/types/deprecated.d.ts

@@ -1,37 +0,0 @@
-import PropTypes from 'prop-types';
-export interface DeprecatedDecorator {
-    (version: string, oldProps?: Record<string, any> | null, message?: string): (ComposedComponent: any) => any;
-    deprecatePropValues: (...args: any[]) => PropTypes.Validator<unknown>;
-    warnDeprecatedProps: (...args: any[]) => void;
-    warnDeprecatedComponent: (...args: any[]) => void;
-    changedPackageWarning: (...args: any[]) => string;
-}
-/**
- * ---
- * category: utilities/react
- * ---
- * Deprecate React component props. Warnings will display in the console when deprecated
- * props are used. Include the version number when the deprecated component will be removed.
- *
- * ```js-code
- *  class Example extends Component {
- *    static propTypes = {
- *      currentProp: PropTypes.func
- *    }
- *  }
- *  export default deprecated('7.0.0', {
- *    deprecatedProp: 'currentProp',
- *    nowNonExistentProp: true
- *  })(Example)
- * ```
- *
- * @param {string} version
- * @param {object} oldProps (if this argument is null or undefined, the entire component is deprecated)
- * @param {string} message
- * @return {function} React component with deprecated props behavior
- * @module deprecated
- */
-declare const deprecated: DeprecatedDecorator;
-export default deprecated;
-export { deprecated };
-//# sourceMappingURL=deprecated.d.ts.map

package/types/deprecated.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"deprecated.d.ts","sourceRoot":"","sources":["../src/deprecated.ts"],"names":[],"mappings":"AA0BA,OAAO,SAAS,MAAM,YAAY,CAAA;AAElC,MAAM,WAAW,mBAAmB;IAClC,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,CAC1E,iBAAiB,EAAE,GAAG,KACnB,GAAG,CAAA;IACR,mBAAmB,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;IACrE,mBAAmB,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IAC7C,uBAAuB,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAA;IACjD,qBAAqB,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAA;CAClD;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,QAAA,MAAM,UAAU,qBA0KZ,CAAA;AAEJ,eAAe,UAAU,CAAA;AACzB,OAAO,EAAE,UAAU,EAAE,CAAA"}

package/types/experimental.d.ts

@@ -1,27 +0,0 @@
-import { ComponentClass } from 'react';
-/**
- * ---
- * category: utilities/react
- * ---
- * Flag React component and component props as experimental.
- * Warnings will display in the console when experimental components/props
- * props are used.
- *
- * ```js-code
- *  class Example extends Component {
- *    static propTypes = {
- *      currentProp: PropTypes.func
- *    }
- *  }
- *  export default experimental(['experimentalProp'])(Example)
- * ```
- *
- * @module experimental
- * @param {array} experimentalProps (if this argument is null or undefined, the entire component is flagged)
- * @param {string} message
- * @return {function} React component flagged as experimental
- */
-declare const experimental: (...args: unknown[]) => (ComposedComponent: ComponentClass<any>) => any;
-export default experimental;
-export { experimental };
-//# sourceMappingURL=experimental.d.ts.map

package/types/experimental.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"experimental.d.ts","sourceRoot":"","sources":["../src/experimental.ts"],"names":[],"mappings":"AAyBA,OAAO,EAAE,cAAc,EAAE,MAAM,OAAO,CAAA;AAEtC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,QAAA,MAAM,YAAY,yEAqDX,CAAA;AAuBP,eAAe,YAAY,CAAA;AAC3B,OAAO,EAAE,YAAY,EAAE,CAAA"}

package/types/hack.d.ts

@@ -1,47 +0,0 @@
-/**
- * ---
- * category: utilities/react
- * ---
- * Flag React component props as hack props.
- * Warnings will display in the console when hack props are used.
- *
- * ```js-code
- *  class Example extends Component {
- *    static propTypes = {
- *      currentProp: PropTypes.func
- *    }
- *  }
- *  export default hack(['hackProp'])(Example)
- * ```
- *
- * @module hack
- * @param {array} hackProps
- * @param {string} message
- * @return {function} React component flagged as having hack props
- */
-declare const hack: (...args: unknown[]) => (ComposedComponent: import("react").ComponentClass<any>) => any;
-export default hack;
-export { 
-/**
- * ---
- * category: utilities/react
- * ---
- * Flag React component props as hack props.
- * Warnings will display in the console when hack props are used.
- *
- * ```js
- *  class Example extends Component {
- *    static propTypes = {
- *      currentProp: PropTypes.func
- *    }
- *  }
- *  export default hack(['hackProp'])(Example)
- * ```
- *
- * @module hack
- * @param {array} hackProps
- * @param {string} message
- * @return {function} React component flagged as having hack props
- */
-hack };
-//# sourceMappingURL=hack.d.ts.map

package/types/hack.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"hack.d.ts","sourceRoot":"","sources":["../src/hack.ts"],"names":[],"mappings":"AA2BA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,QAAA,MAAM,IAAI,yFAuCF,CAAA;AAgBR,eAAe,IAAI,CAAA;AACnB,OAAO;AACL;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,IAAI,EACL,CAAA"}