@instructure/ui-react-utils 8.53.3-snapshot-6 → 8.53.3-snapshot-1

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [8.53.3-snapshot-6](https://github.com/instructure/instructure-ui/compare/v8.53.2...v8.53.3-snapshot-6) (2024-02-20)
+## [8.53.3-snapshot-1](https://github.com/instructure/instructure-ui/compare/v8.53.2...v8.53.3-snapshot-1) (2024-02-20)
 
 **Note:** Version bump only for package @instructure/ui-react-utils
 

package/es/__new-tests__/ComponentIdentifier.test.js

@@ -0,0 +1,77 @@
+var _h;
+/*
+ * 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 React, { Component } from 'react';
+import PropTypes from 'prop-types';
+import { render } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import { ComponentIdentifier } from '../ComponentIdentifier';
+describe('ComponentIdentifier', () => {
+  var _App;
+  beforeAll(() => {
+    // Mocking console warnings to prevent test output pollution
+    jest.spyOn(console, 'warn').mockImplementation(() => {});
+  });
+  afterAll(() => {
+    jest.restoreAllMocks();
+  });
+  class Trigger extends ComponentIdentifier {}
+  Trigger.displayName = 'Trigger';
+  class App extends Component {
+    render() {
+      const trigger = ComponentIdentifier.pick(Trigger, this.props.children);
+      return /*#__PURE__*/React.createElement("div", null, _h || (_h = /*#__PURE__*/React.createElement("h2", null, "Trigger")), trigger);
+    }
+  }
+  App.displayName = "App";
+  App.propTypes = {
+    children: PropTypes.node
+  };
+  App.defaultProps = {
+    children: null
+  };
+  it('should render only child', () => {
+    let buttonRef;
+    render( /*#__PURE__*/React.createElement(App, null, /*#__PURE__*/React.createElement(Trigger, null, /*#__PURE__*/React.createElement("button", {
+      ref: el => buttonRef = el
+    }, "Click Me"))));
+    expect(buttonRef.textContent).toEqual('Click Me');
+  });
+  it('should not error when no children provided', () => {
+    const renderApp = () => render(_App || (_App = /*#__PURE__*/React.createElement(App, null, /*#__PURE__*/React.createElement(Trigger, null))));
+    expect(renderApp).not.toThrow();
+  });
+  it('should pass props', () => {
+    let buttonRef;
+    const onClick = jest.fn();
+    render( /*#__PURE__*/React.createElement(App, null, /*#__PURE__*/React.createElement(Trigger, {
+      onClick: onClick
+    }, /*#__PURE__*/React.createElement("button", {
+      ref: el => buttonRef = el
+    }, "Click Me"))));
+    buttonRef.click();
+    expect(onClick).toHaveBeenCalled();
+  });
+});

package/es/__new-tests__/DeterministicIdContext.test.js

@@ -0,0 +1,89 @@
+var _dec, _class, _class2, _div, _WrapperComponent, _div2, _div3;
+/*
+ * 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 React from 'react';
+import { render, screen } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import { withDeterministicId, DeterministicIdContextProvider, generateInstanceCounterMap } from '../DeterministicIdContext';
+let TestComponent = (_dec = withDeterministicId(), _dec(_class = (_class2 = class TestComponent extends React.Component {
+  render() {
+    return /*#__PURE__*/React.createElement("div", {
+      "data-testid": "test-component",
+      id: this.props.deterministicId()
+    }, this.props.children);
+  }
+}, _class2.displayName = "TestComponent", _class2)) || _class);
+class WrapperComponent extends React.Component {
+  render() {
+    return _div || (_div = /*#__PURE__*/React.createElement("div", null, /*#__PURE__*/React.createElement(TestComponent, null)));
+  }
+}
+WrapperComponent.displayName = "WrapperComponent";
+const uniqueIds = el => {
+  const idList = Array.from(el.children).map(child => child.id);
+  return new Set(idList).size === idList.length;
+};
+describe('DeterministicIdContext', () => {
+  it('can be found and tested with ReactTestUtils', () => {
+    render(_WrapperComponent || (_WrapperComponent = /*#__PURE__*/React.createElement(WrapperComponent, null)));
+    const testComponent = screen.getByTestId('test-component');
+    expect(testComponent).toBeInTheDocument();
+    expect(testComponent.id).toBeDefined();
+  });
+  it('should generate unique ids without Provider wrapper', () => {
+    render(_div2 || (_div2 = /*#__PURE__*/React.createElement("div", {
+      "data-testid": "test-components"
+    }, /*#__PURE__*/React.createElement(TestComponent, null), /*#__PURE__*/React.createElement(TestComponent, null), /*#__PURE__*/React.createElement(TestComponent, null), /*#__PURE__*/React.createElement(TestComponent, null), /*#__PURE__*/React.createElement(TestComponent, null))));
+    const el = screen.getByTestId('test-components');
+    expect(uniqueIds(el)).toBe(true);
+  });
+  it('should generate unique ids when components are rendered both out and inside of provider', () => {
+    render(_div3 || (_div3 = /*#__PURE__*/React.createElement("div", {
+      "data-testid": "test-components"
+    }, /*#__PURE__*/React.createElement(DeterministicIdContextProvider, null, /*#__PURE__*/React.createElement(TestComponent, null), /*#__PURE__*/React.createElement(TestComponent, null), /*#__PURE__*/React.createElement(TestComponent, null)), /*#__PURE__*/React.createElement(TestComponent, null), /*#__PURE__*/React.createElement(TestComponent, null))));
+    const el = screen.getByTestId('test-components');
+    expect(uniqueIds(el)).toBe(true);
+  });
+  it('should generate unique ids with provider only', () => {
+    const Wrapper = ({
+      children
+    }) => {
+      return /*#__PURE__*/React.createElement(DeterministicIdContextProvider, {
+        instanceCounterMap: generateInstanceCounterMap()
+      }, /*#__PURE__*/React.createElement("div", {
+        "data-testid": "wrapper"
+      }, children));
+    };
+    const children = [];
+    for (let i = 0; i < 10; i++) {
+      children.push( /*#__PURE__*/React.createElement(TestComponent, {
+        key: i
+      }));
+    }
+    render( /*#__PURE__*/React.createElement(Wrapper, null, children));
+    const el = screen.getByTestId('wrapper');
+    expect(uniqueIds(el)).toBe(true);
+  });
+});

package/es/__new-tests__/callRenderProp.test.js

@@ -0,0 +1,121 @@
+var _div, _div2;
+/*
+ * 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 React from 'react';
+import PropTypes from 'prop-types';
+import { render } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import { callRenderProp } from '../callRenderProp';
+describe('callRenderProp', () => {
+  it('strings', () => {
+    expect(callRenderProp('foo')).toEqual('foo');
+  });
+  it('numbers', () => {
+    expect(callRenderProp(2)).toEqual(2);
+  });
+  it('arrays', () => {
+    const prop = ['foo', 'bar', 'baz'];
+    expect(callRenderProp(prop)).toStrictEqual(prop);
+    expect(callRenderProp([])).toStrictEqual([]);
+  });
+  it('booleans', () => {
+    expect(callRenderProp(false)).toEqual(false);
+  });
+  it('JSX literals', () => {
+    const Foo = () => _div || (_div = /*#__PURE__*/React.createElement("div", null, "hello"));
+    expect(callRenderProp( /*#__PURE__*/React.createElement(Foo, null))).toStrictEqual( /*#__PURE__*/React.createElement(Foo, null));
+  });
+  it('React classes', () => {
+    class Foo extends React.Component {
+      render() {
+        return _div2 || (_div2 = /*#__PURE__*/React.createElement("div", null, "hello"));
+      }
+    }
+    Foo.displayName = "Foo";
+    const Result = callRenderProp(Foo);
+    expect(Result).toStrictEqual( /*#__PURE__*/React.createElement(Foo, null));
+    const _render = render(Result),
+      getByText = _render.getByText;
+    expect(getByText('hello')).toBeInTheDocument();
+  });
+  it('functions', () => {
+    const Baz = function () {
+      return 'some text';
+    };
+    const result = callRenderProp(Baz);
+    const _render2 = render( /*#__PURE__*/React.createElement("div", null, result)),
+      getByText = _render2.getByText;
+    expect(getByText('some text')).toBeInTheDocument();
+  });
+  it('fat arrow functions', () => {
+    const Baz = () => 'some text';
+
+    // in this test we are trying to test that it works with fat arrow functions,
+    // but the babel config when we run these tests is currently configured
+    // to transpile fat arrow functions down to normal functions.
+    // Real, untranspiled, fat-arrow functions don't have a `prototype` but when
+    // they are transpiled down they do. So this next line is to make sure
+    // the thing we are testing really doesn't have a prototype like it would
+    // if it was a real untranspiled fat arrow function.
+    if (Baz.prototype) Baz.prototype = void 0;
+    const result = callRenderProp(Baz);
+    const _render3 = render( /*#__PURE__*/React.createElement("div", null, result)),
+      getByText = _render3.getByText;
+    expect(getByText('some text')).toBeInTheDocument();
+  });
+  describe('passing props', () => {
+    it('should pass props correctly to functions', () => {
+      const someFunc = ({
+        shape
+      }) => /*#__PURE__*/React.createElement("div", null, shape);
+      const result = callRenderProp(someFunc, {
+        shape: 'rectangle'
+      });
+      const _render4 = render( /*#__PURE__*/React.createElement("div", null, result)),
+        getByText = _render4.getByText;
+      expect(getByText('rectangle')).toBeInTheDocument();
+    });
+    it('should pass props correctly to React classes', () => {
+      class Foo extends React.Component {
+        render() {
+          return /*#__PURE__*/React.createElement("div", null, this.props.shape);
+        }
+      }
+      Foo.displayName = "Foo";
+      Foo.propTypes = {
+        shape: PropTypes.oneOf(['circle', 'rectangle'])
+      };
+      Foo.defaultProps = {
+        shape: 'circle'
+      };
+      const result = callRenderProp(Foo, {
+        shape: 'rectangle'
+      });
+      const _render5 = render( /*#__PURE__*/React.createElement("div", null, result)),
+        getByText = _render5.getByText;
+      expect(getByText('rectangle')).toBeInTheDocument();
+    });
+  });
+});

package/es/__new-tests__/deprecated.test.js

@@ -0,0 +1,223 @@
+/*
+ * 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 React, { Component } from 'react';
+import PropTypes from 'prop-types';
+import { render } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import { deprecated } from '../deprecated';
+class TestComponent extends Component {
+  render() {
+    return /*#__PURE__*/React.createElement("div", null, this.props.qux, " ", this.props.bar);
+  }
+}
+TestComponent.displayName = "TestComponent";
+TestComponent.propTypes = {
+  bar: PropTypes.string,
+  qux: PropTypes.string
+};
+TestComponent.defaultProps = {
+  bar: null,
+  qux: 'Hello'
+};
+describe('@deprecated', () => {
+  describe('deprecated props', () => {
+    var _DeprecatedComponent, _DeprecatedComponent2, _DeprecatedComponent3;
+    const DeprecatedComponent = deprecated('2.1.0', {
+      foo: 'bar',
+      baz: true
+    })(TestComponent);
+    it('should warn when suggesting new prop when using old prop', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      render(_DeprecatedComponent || (_DeprecatedComponent = /*#__PURE__*/React.createElement(DeprecatedComponent, {
+        foo: "Jane"
+      })));
+      const expectedWarningMessage = 'Warning: [TestComponent] `foo` is deprecated and will be removed in version 2.1.0. Use `bar` instead. ';
+      expect(consoleWarningSpy).toHaveBeenCalledWith(expect.stringContaining(expectedWarningMessage), expect.any(String));
+      consoleWarningSpy.mockRestore();
+    });
+    it('should warn when using old prop with no new prop', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      render(_DeprecatedComponent2 || (_DeprecatedComponent2 = /*#__PURE__*/React.createElement(DeprecatedComponent, {
+        baz: "Goodbye"
+      })));
+      const expectedWarningMessage = 'Warning: [TestComponent] `baz` is deprecated and will be removed in version 2.1.0.';
+      expect(consoleWarningSpy).toHaveBeenCalledWith(expect.stringContaining(expectedWarningMessage), expect.any(String));
+      consoleWarningSpy.mockRestore();
+    });
+    it('should not output a warning using new prop', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      render(_DeprecatedComponent3 || (_DeprecatedComponent3 = /*#__PURE__*/React.createElement(DeprecatedComponent, {
+        bar: "Jane"
+      })));
+      expect(consoleWarningSpy).not.toHaveBeenCalled();
+      consoleWarningSpy.mockRestore();
+    });
+  });
+  describe('deprecated component', () => {
+    var _DeprecatedComponent4;
+    const DeprecatedComponent = deprecated('3.4.0')(TestComponent);
+    it('should warn that the entire component is deprecated if no old props are supplied', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      render(_DeprecatedComponent4 || (_DeprecatedComponent4 = /*#__PURE__*/React.createElement(DeprecatedComponent, null)));
+      const expectedWarningMessage = 'Warning: [TestComponent] is deprecated and will be removed in version 3.4.0.';
+      expect(consoleWarningSpy).toHaveBeenCalledWith(expect.stringContaining(expectedWarningMessage), expect.any(String));
+      consoleWarningSpy.mockRestore();
+    });
+  });
+  describe('deprecated component with a changed package message', () => {
+    var _DeprecatedComponent5;
+    const DeprecatedComponent = deprecated('5.0.0', null, deprecated.changedPackageWarning('ui-forms', 'ui-number-input'))(TestComponent);
+    it('should warn that the component is deprecated and output a warning that the package changed', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      const expectedWarningMessage = 'Warning: [TestComponent] is deprecated and will be removed in version 5.0.0. It has been moved from @instructure/ui-forms to @instructure/ui-number-input.';
+      render(_DeprecatedComponent5 || (_DeprecatedComponent5 = /*#__PURE__*/React.createElement(DeprecatedComponent, null)));
+      expect(consoleWarningSpy).toHaveBeenCalledWith(expect.stringContaining(expectedWarningMessage), expect.any(String));
+      consoleWarningSpy.mockRestore();
+    });
+  });
+  describe('component with deprecated prop values', () => {
+    it('should not warn when an allowed prop value is supplied', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      class DeprecatedPropValueComponent extends Component {
+        render() {
+          return /*#__PURE__*/React.createElement("div", null, this.props.color);
+        }
+      }
+      DeprecatedPropValueComponent.displayName = "DeprecatedPropValueComponent";
+      DeprecatedPropValueComponent.propTypes = {
+        color: deprecated.deprecatePropValues(PropTypes.oneOf(['red', 'yellow', 'blue', 'orange', 'gold']), ['blue', 'orange', 'gold'])
+      };
+      DeprecatedPropValueComponent.defaultProps = {
+        color: 'red'
+      };
+      render( /*#__PURE__*/React.createElement(DeprecatedPropValueComponent, {
+        color: "yellow"
+      }));
+      expect(consoleWarningSpy).not.toHaveBeenCalled();
+      consoleWarningSpy.mockRestore();
+    });
+    it('should warn when a forbidden prop value is supplied', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      const color = 'orange';
+      class DeprecatedPropValueComponent extends Component {
+        render() {
+          return /*#__PURE__*/React.createElement("div", null, this.props.color);
+        }
+      }
+      DeprecatedPropValueComponent.displayName = "DeprecatedPropValueComponent";
+      DeprecatedPropValueComponent.propTypes = {
+        color: deprecated.deprecatePropValues(PropTypes.oneOf(['red', 'yellow', 'blue', 'orange', 'gold']), ['blue', 'orange', 'gold'])
+      };
+      DeprecatedPropValueComponent.defaultProps = {
+        color: 'red'
+      };
+      render( /*#__PURE__*/React.createElement(DeprecatedPropValueComponent, {
+        color: color
+      }));
+      const expectedWarningMessage = `The '${color}' value for the \`color\` prop is deprecated.`;
+      expect(consoleWarningSpy).toHaveBeenCalledWith(expect.stringContaining(expectedWarningMessage), expect.any(String));
+      consoleWarningSpy.mockRestore();
+    });
+    it('should warn with additional message text when a forbidden prop value is supplied and has message text', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      const color = 'gold';
+      const message = 'It will be removed in v8.0.0.';
+      class DeprecatedPropValueComponent extends Component {
+        render() {
+          return /*#__PURE__*/React.createElement("div", null, this.props.color);
+        }
+      }
+      DeprecatedPropValueComponent.displayName = "DeprecatedPropValueComponent";
+      DeprecatedPropValueComponent.propTypes = {
+        color: deprecated.deprecatePropValues(PropTypes.oneOf(['red', 'yellow', 'blue', 'orange', 'gold']), ['blue', 'orange', 'gold'], 'It will be removed in v8.0.0.')
+      };
+      DeprecatedPropValueComponent.defaultProps = {
+        color: 'red'
+      };
+      render( /*#__PURE__*/React.createElement(DeprecatedPropValueComponent, {
+        color: color
+      }));
+      const expectedWarningMessage = `The '${color}' value for the \`color\` prop is deprecated. ${message}`;
+      expect(consoleWarningSpy).toHaveBeenCalledWith(expect.stringContaining(expectedWarningMessage), expect.any(String));
+      consoleWarningSpy.mockRestore();
+    });
+    it('should call functional message with the correct props', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      const messageMock = jest.fn();
+      const color = 'gold';
+      class DeprecatedPropValueComponent extends Component {
+        render() {
+          return /*#__PURE__*/React.createElement("div", null, this.props.color);
+        }
+      }
+      DeprecatedPropValueComponent.displayName = "DeprecatedPropValueComponent";
+      DeprecatedPropValueComponent.propTypes = {
+        color: deprecated.deprecatePropValues(PropTypes.oneOf(['red', 'yellow', 'blue', 'orange', 'gold']), ['blue', 'orange', 'gold'], messageMock)
+      };
+      DeprecatedPropValueComponent.defaultProps = {
+        color: 'red'
+      };
+      render( /*#__PURE__*/React.createElement(DeprecatedPropValueComponent, {
+        color: color
+      }));
+      const _messageMock$mock$cal = messageMock.mock.calls[0][0],
+        props = _messageMock$mock$cal.props,
+        propName = _messageMock$mock$cal.propName,
+        propValue = _messageMock$mock$cal.propValue;
+      expect(props).toEqual({
+        color
+      });
+      expect(propName).toBe('color');
+      expect(propValue).toBe(color);
+      expect(consoleWarningSpy).toHaveBeenCalled();
+      consoleWarningSpy.mockRestore();
+    });
+    it('should warn with a completely custom message when provided message is functional and prop value is forbidden', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      const color = 'gold';
+      class DeprecatedPropValueComponent extends Component {
+        render() {
+          return /*#__PURE__*/React.createElement("div", null, this.props.color);
+        }
+      }
+      DeprecatedPropValueComponent.displayName = "DeprecatedPropValueComponent";
+      DeprecatedPropValueComponent.propTypes = {
+        color: deprecated.deprecatePropValues(PropTypes.oneOf(['red', 'yellow', 'blue', 'orange', 'gold']), ['blue', 'orange', 'gold'], ({
+          propValue,
+          propName
+        }) => `The ${propValue} value for ${propName} has been deprecated. Use the FooBar component with the 'baz' prop set instead.`)
+      };
+      DeprecatedPropValueComponent.defaultProps = {
+        color: 'red'
+      };
+      render( /*#__PURE__*/React.createElement(DeprecatedPropValueComponent, {
+        color: color
+      }));
+      const expectedWarningMessage = `The ${color} value for color has been deprecated. Use the FooBar component with the 'baz' prop set instead.`;
+      expect(consoleWarningSpy).toHaveBeenCalledWith(expect.stringContaining(expectedWarningMessage), expect.any(String));
+      consoleWarningSpy.mockRestore();
+    });
+  });
+});

package/es/__new-tests__/experimental.test.js

@@ -0,0 +1,94 @@
+/*
+ * 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 React, { Component } from 'react';
+import PropTypes from 'prop-types';
+import { render } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import { experimental } from '../experimental';
+class TestComponent extends Component {
+  render() {
+    return /*#__PURE__*/React.createElement("div", null, this.props.qux, " ", this.props.bar);
+  }
+}
+TestComponent.displayName = "TestComponent";
+TestComponent.propTypes = {
+  bar: PropTypes.string,
+  qux: PropTypes.string
+};
+TestComponent.defaultProps = {
+  bar: void 0,
+  qux: 'Hello'
+};
+describe('@experimental', () => {
+  describe('experimental props', () => {
+    var _ExperimentalComponen, _ExperimentalComponen2, _ExperimentalComponen3;
+    const ExperimentalComponent = experimental(['bar'])(TestComponent);
+    it('should warn when using an experimental prop', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      render(_ExperimentalComponen || (_ExperimentalComponen = /*#__PURE__*/React.createElement(ExperimentalComponent, {
+        bar: "Jane"
+      })));
+      const expectedWarningMessage = 'Warning: [TestComponent] The `bar` prop is experimental and its API could change significantly in a future release.';
+      expect(consoleWarningSpy).toHaveBeenCalledWith(expect.stringContaining(expectedWarningMessage), expect.any(String));
+      consoleWarningSpy.mockRestore();
+    });
+    it('should not output a warning using a non-experimental prop', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      render(_ExperimentalComponen2 || (_ExperimentalComponen2 = /*#__PURE__*/React.createElement(ExperimentalComponent, {
+        qux: "Jane"
+      })));
+      expect(consoleWarningSpy).not.toHaveBeenCalled();
+      consoleWarningSpy.mockRestore();
+    });
+    it('should not output a warning for an experimental prop when dangerously ignored', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      render(_ExperimentalComponen3 || (_ExperimentalComponen3 = /*#__PURE__*/React.createElement(ExperimentalComponent, {
+        qux: "Jane",
+        __dangerouslyIgnoreExperimentalWarnings: true
+      })));
+      expect(consoleWarningSpy).not.toHaveBeenCalled();
+      consoleWarningSpy.mockRestore();
+    });
+  });
+  describe('experimental component', () => {
+    var _ExperimentalComponen4, _ExperimentalComponen5;
+    const ExperimentalComponent = experimental()(TestComponent);
+    it('should warn that the entire component is experimental if no props are supplied', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      render(_ExperimentalComponen4 || (_ExperimentalComponen4 = /*#__PURE__*/React.createElement(ExperimentalComponent, null)));
+      const expectedWarningMessage = 'Warning: [TestComponent] is experimental and its API could change significantly in a future release.';
+      expect(consoleWarningSpy).toHaveBeenCalledWith(expect.stringContaining(expectedWarningMessage), expect.any(String));
+      consoleWarningSpy.mockRestore();
+    });
+    it('should not output a warning for a component when dangerously ignored', () => {
+      const consoleWarningSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
+      render(_ExperimentalComponen5 || (_ExperimentalComponen5 = /*#__PURE__*/React.createElement(ExperimentalComponent, {
+        __dangerouslyIgnoreExperimentalWarnings: true
+      })));
+      expect(consoleWarningSpy).not.toHaveBeenCalled();
+      consoleWarningSpy.mockRestore();
+    });
+  });
+});