@skyscanner/backpack-web 9.1.0-alpha.1 → 9.2.0-beta.2

package/bpk-react-utils/index.js

@@ -1,88 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "Portal", {
-  enumerable: true,
-  get: function () {
-    return _Portal.default;
-  }
-});
-Object.defineProperty(exports, "TransitionInitialMount", {
-  enumerable: true,
-  get: function () {
-    return _TransitionInitialMount.default;
-  }
-});
-Object.defineProperty(exports, "cssModules", {
-  enumerable: true,
-  get: function () {
-    return _cssModules.default;
-  }
-});
-exports.default = void 0;
-Object.defineProperty(exports, "deprecated", {
-  enumerable: true,
-  get: function () {
-    return _deprecated.default;
-  }
-});
-Object.defineProperty(exports, "isDeviceIos", {
-  enumerable: true,
-  get: function () {
-    return _deviceDetection.isDeviceIos;
-  }
-});
-Object.defineProperty(exports, "isDeviceIpad", {
-  enumerable: true,
-  get: function () {
-    return _deviceDetection.isDeviceIpad;
-  }
-});
-Object.defineProperty(exports, "isDeviceIphone", {
-  enumerable: true,
-  get: function () {
-    return _deviceDetection.isDeviceIphone;
-  }
-});
-Object.defineProperty(exports, "isRTL", {
-  enumerable: true,
-  get: function () {
-    return _isRTL.default;
-  }
-});
-Object.defineProperty(exports, "withDefaultProps", {
-  enumerable: true,
-  get: function () {
-    return _withDefaultProps.default;
-  }
-});
-Object.defineProperty(exports, "wrapDisplayName", {
-  enumerable: true,
-  get: function () {
-    return _wrapDisplayName.default;
-  }
-});
-
-var _wrapDisplayName = _interopRequireDefault(require("./src/wrapDisplayName"));
-
-var _Portal = _interopRequireDefault(require("./src/Portal"));
-
-var _TransitionInitialMount = _interopRequireDefault(require("./src/TransitionInitialMount"));
-
-var _cssModules = _interopRequireDefault(require("./src/cssModules"));
-
-var _deprecated = _interopRequireDefault(require("./src/deprecated"));
-
-var _deviceDetection = require("./src/deviceDetection");
-
-var _withDefaultProps = _interopRequireDefault(require("./src/withDefaultProps"));
-
-var _isRTL = _interopRequireDefault(require("./src/isRTL"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /*
  * Backpack - Skyscanner's Design System
  *
@@ -100,16 +15,43 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var _default = {
-  Portal: _Portal.default,
-  TransitionInitialMount: _TransitionInitialMount.default,
-  cssModules: _cssModules.default,
-  deprecated: _deprecated.default,
-  withDefaultProps: _withDefaultProps.default,
-  wrapDisplayName: _wrapDisplayName.default,
-  isDeviceIphone: _deviceDetection.isDeviceIphone,
-  isDeviceIpad: _deviceDetection.isDeviceIpad,
-  isDeviceIos: _deviceDetection.isDeviceIos,
-  isRTL: _isRTL.default
+
+/* @flow strict */
+
+import wrapDisplayName from './src/wrapDisplayName';
+import Portal from './src/Portal';
+import TransitionInitialMount from './src/TransitionInitialMount';
+import cssModules from './src/cssModules';
+import deprecated from './src/deprecated';
+import {
+  isDeviceIphone,
+  isDeviceIpad,
+  isDeviceIos,
+} from './src/deviceDetection';
+import withDefaultProps from './src/withDefaultProps';
+import isRTL from './src/isRTL';
+
+export {
+  Portal,
+  TransitionInitialMount,
+  cssModules,
+  deprecated,
+  withDefaultProps,
+  wrapDisplayName,
+  isDeviceIphone,
+  isDeviceIpad,
+  isDeviceIos,
+  isRTL,
+};
+export default {
+  Portal,
+  TransitionInitialMount,
+  cssModules,
+  deprecated,
+  withDefaultProps,
+  wrapDisplayName,
+  isDeviceIphone,
+  isDeviceIpad,
+  isDeviceIos,
+  isRTL,
 };
-exports.default = _default;

package/bpk-react-utils/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "bpk-react-utils",
+  "version": "7.0.0",
+  "description": "Utilities for Backpack's React components.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:Skyscanner/backpack.git"
+  },
+  "author": "Backpack Design System <backpack@skyscanner.net>",
+  "main": "index.js",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "gitHead": "c2217d61875a1f3aa2bb9ed9583c50e3f1523501",
+  "dependencies": {
+    "object-assign": "^4.1.1",
+    "prop-types": "^15.7.2",
+    "react-transition-group": "^2.5.3"
+  },
+  "peerDependencies": {
+    "react": "^17.0.2",
+    "react-dom": "^16.3.0 || ^17.0.0"
+  }
+}

package/bpk-react-utils/src/Portal.js

@@ -1,20 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = require("react");
-
-var _reactDom = require("react-dom");
-
-var _objectAssign = _interopRequireDefault(require("object-assign"));
-
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /*
  * Backpack - Skyscanner's Design System
  *
@@ -32,20 +15,30 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+import { Component } from 'react';
+import { createPortal } from 'react-dom';
+import assign from 'object-assign';
+import PropTypes from 'prop-types';
+
 const KEYCODES = {
-  ESCAPE: 'Escape'
+  ESCAPE: 'Escape',
 };
 
-class Portal extends _react.Component {
+class Portal extends Component {
   constructor() {
     super();
+
     this.portalElement = null;
+
     this.state = {
-      isVisible: false
-    }; // shouldClose is used to keep track of the user's mouse-down events in order to
-    // prevent the dialog closing if the mouse leaves / enters the portal during the click
+      isVisible: false,
+    };
 
+    // shouldClose is used to keep track of the user's mouse-down events in order to
+    // prevent the dialog closing if the mouse leaves / enters the portal during the click
     this.shouldClose = false;
+
     this.close = this.close.bind(this);
     this.onDocumentMouseUp = this.onDocumentMouseUp.bind(this);
     this.onDocumentMouseDown = this.onDocumentMouseDown.bind(this);
@@ -63,11 +56,11 @@ class Portal extends _react.Component {
     if (this.props.targetRef) {
       this.props.targetRef(this.getTargetElement());
     }
-  } // When the consumer updates `isOpen` to be `false`, we
+  }
+
+  // When the consumer updates `isOpen` to be `false`, we
   // call their beforeClose function so that they can trigger the close.
   // If they don't provide `beforeClose` we just call `close` directly.
-
-
   componentDidUpdate(prevProps) {
     if (this.props.isOpen) {
       if (!prevProps.isOpen) {
@@ -90,8 +83,11 @@ class Portal extends _react.Component {
 
   onDocumentMouseDown(event) {
     const clickEventProperties = this.getClickEventProperties(event);
-
-    if (clickEventProperties.isNotLeftClick || clickEventProperties.isTargetClick || clickEventProperties.isPortalClick) {
+    if (
+      clickEventProperties.isNotLeftClick ||
+      clickEventProperties.isTargetClick ||
+      clickEventProperties.isPortalClick
+    ) {
       this.shouldClose = false;
       return;
     }
@@ -102,7 +98,11 @@ class Portal extends _react.Component {
   onDocumentMouseUp(event) {
     const clickEventProperties = this.getClickEventProperties(event);
 
-    if (clickEventProperties.isNotLeftClick || clickEventProperties.isTargetClick || clickEventProperties.isPortalClick) {
+    if (
+      clickEventProperties.isNotLeftClick ||
+      clickEventProperties.isTargetClick ||
+      clickEventProperties.isPortalClick
+    ) {
       this.shouldClose = false;
       return;
     }
@@ -110,19 +110,19 @@ class Portal extends _react.Component {
     if (this.shouldClose) {
       // `onClose` tells the consumer that they should change `isOpen` to false.
       // Once the consumer has responded to `onClose`, `beforeClose` and `close` will be called.
-      this.props.onClose(event, {
-        source: 'DOCUMENT_CLICK'
-      });
+      this.props.onClose(event, { source: 'DOCUMENT_CLICK' });
     }
   }
 
   onDocumentKeyDown(event) {
-    if (event.key === KEYCODES.ESCAPE && this.props.isOpen && this.props.closeOnEscPressed) {
+    if (
+      event.key === KEYCODES.ESCAPE &&
+      this.props.isOpen &&
+      this.props.closeOnEscPressed
+    ) {
       // `onClose` tells the consumer that they should change `isOpen` to false.
       // Once the consumer has responded to `onClose`, `beforeClose` and `close` will be called.
-      this.props.onClose(event, {
-        source: 'ESCAPE'
-      });
+      this.props.onClose(event, { source: 'ESCAPE' });
     }
   }
 
@@ -132,29 +132,41 @@ class Portal extends _react.Component {
 
   getClickEventProperties(event) {
     const isNotLeftClick = event.button && event.button !== 0;
+
     const targetElement = this.getTargetElement();
-    const isTargetClick = targetElement && event.target instanceof Node && (event.target === targetElement || targetElement.contains(event.target));
-    const isPortalClick = this.portalElement && event.target instanceof Node && (event.target === this.portalElement || this.portalElement.contains(event.target));
+    const isTargetClick =
+      targetElement &&
+      event.target instanceof Node &&
+      (event.target === targetElement || targetElement.contains(event.target));
+
+    const isPortalClick =
+      this.portalElement &&
+      event.target instanceof Node &&
+      (event.target === this.portalElement ||
+        this.portalElement.contains(event.target));
+
     return {
       isNotLeftClick: !!isNotLeftClick,
       isTargetClick: !!isTargetClick,
-      isPortalClick: !!isPortalClick
+      isPortalClick: !!isPortalClick,
     };
   }
 
   getTargetElement() {
-    var _this$props$target;
-
-    return typeof this.props.target === 'function' ? this.props.target() : (_this$props$target = this.props.target) === null || _this$props$target === void 0 ? void 0 : _this$props$target.ref.current;
+    return typeof this.props.target === 'function'
+      ? this.props.target()
+      : this.props.target?.ref.current;
   }
 
   getRenderTarget() {
-    const target = typeof this.props.renderTarget === 'function' ? this.props.renderTarget() : this.props.renderTarget;
+    const target =
+      typeof this.props.renderTarget === 'function'
+        ? this.props.renderTarget()
+        : this.props.renderTarget;
 
     if (target) {
       return target;
     }
-
     if (document.body) {
       return document.body;
     }
@@ -169,27 +181,35 @@ class Portal extends _react.Component {
 
     this.portalElement = document.createElement('div');
     this.getRenderTarget().appendChild(this.portalElement);
-    const passiveArgs = this.supportsPassiveEvents() ? {
-      passive: true
-    } : false;
-    document.addEventListener('touchstart', this.onDocumentMouseDown, passiveArgs);
-    document.addEventListener('touchmove', this.onDocumentMouseMove, passiveArgs);
+
+    const passiveArgs = this.supportsPassiveEvents()
+      ? { passive: true }
+      : false;
+    document.addEventListener(
+      'touchstart',
+      this.onDocumentMouseDown,
+      passiveArgs,
+    );
+    document.addEventListener(
+      'touchmove',
+      this.onDocumentMouseMove,
+      passiveArgs,
+    );
     document.addEventListener('touchend', this.onDocumentMouseUp, passiveArgs);
     document.addEventListener('mousedown', this.onDocumentMouseDown, false);
     document.addEventListener('mouseup', this.onDocumentMouseUp, false);
     document.addEventListener('keydown', this.onDocumentKeyDown, false);
 
     if (this.props.style) {
-      (0, _objectAssign.default)(this.portalElement.style, this.props.style);
+      assign(this.portalElement.style, this.props.style);
     }
 
     if (this.props.className) {
       this.portalElement.className = this.props.className;
     }
-
-    this.setState({
-      isVisible: true
-    }, () => this.props.onOpen(this.portalElement, this.getTargetElement()));
+    this.setState({ isVisible: true }, () =>
+      this.props.onOpen(this.portalElement, this.getTargetElement()),
+    );
   }
 
   close() {
@@ -198,7 +218,6 @@ class Portal extends _react.Component {
     }
 
     const renderTarget = this.getRenderTarget();
-
     if (renderTarget) {
       renderTarget.removeChild(this.portalElement);
     }
@@ -209,69 +228,60 @@ class Portal extends _react.Component {
     document.removeEventListener('mousedown', this.onDocumentMouseDown);
     document.removeEventListener('mouseup', this.onDocumentMouseUp);
     document.removeEventListener('keydown', this.onDocumentKeyDown);
+
     this.portalElement = null;
-    this.setState({
-      isVisible: false
-    });
-  } // This function is taken from modernizr
+    this.setState({ isVisible: false });
+  }
+
+  // This function is taken from modernizr
   // See https://github.com/modernizr/modernizr
   // eslint-disable-next-line class-methods-use-this
-
-
   supportsPassiveEvents() {
     let supportsPassiveOption = false;
-
     try {
       const opts = Object.defineProperty({}, 'passive', {
         // eslint-disable-next-line getter-return
         get() {
           supportsPassiveOption = true;
-        }
-
+        },
       });
       window.addEventListener('test', null, opts);
     } catch (e) {
       return false;
     }
-
     return supportsPassiveOption;
   }
 
   render() {
     const {
       portalElement,
-      props: {
-        children
-      },
-      state: {
-        isVisible
-      }
+      props: { children },
+      state: { isVisible },
     } = this;
 
     if (!isVisible || !portalElement) {
       return null;
     }
 
-    return /*#__PURE__*/(0, _reactDom.createPortal)(children, portalElement);
+    return createPortal(children, portalElement);
   }
-
 }
 
 Portal.propTypes = {
-  children: _propTypes.default.node.isRequired,
-  isOpen: _propTypes.default.bool.isRequired,
-  beforeClose: _propTypes.default.func,
-  className: _propTypes.default.string,
-  onClose: _propTypes.default.func,
-  onOpen: _propTypes.default.func,
-  onRender: _propTypes.default.func,
-  style: _propTypes.default.object,
-  // eslint-disable-line react/forbid-prop-types
-  renderTarget: _propTypes.default.func,
-  target: _propTypes.default.oneOfType([_propTypes.default.func, _propTypes.default.node]),
-  targetRef: _propTypes.default.func,
-  closeOnEscPressed: _propTypes.default.bool
+  children: PropTypes.node.isRequired,
+  isOpen: PropTypes.bool.isRequired,
+  beforeClose: PropTypes.func,
+  className: PropTypes.string,
+  onClose: PropTypes.func,
+  onOpen: PropTypes.func,
+  onRender: PropTypes.func,
+  style: PropTypes.object, // eslint-disable-line react/forbid-prop-types
+  renderTarget: PropTypes.func,
+  target: PropTypes.oneOfType([PropTypes.func, PropTypes.node]),
+  targetRef: PropTypes.func,
+  closeOnEscPressed: PropTypes.bool,
 };
+
 Portal.defaultProps = {
   beforeClose: null,
   className: null,
@@ -282,7 +292,7 @@ Portal.defaultProps = {
   renderTarget: null,
   target: null,
   targetRef: null,
-  closeOnEscPressed: true
+  closeOnEscPressed: true,
 };
-var _default = Portal;
-exports.default = _default;
+
+export default Portal;

package/bpk-react-utils/src/TransitionInitialMount.js

@@ -1,20 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _objectAssign = _interopRequireDefault(require("object-assign"));
-
-var _propTypes = _interopRequireDefault(require("prop-types"));
-
-var _react = _interopRequireDefault(require("react"));
-
-var _CSSTransition = _interopRequireDefault(require("react-transition-group/CSSTransition"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /*
  * Backpack - Skyscanner's Design System
  *
@@ -32,34 +15,49 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+/* @flow strict */
+
+import assign from 'object-assign';
+import PropTypes from 'prop-types';
+import React, { type Node } from 'react';
+import CSSTransition from 'react-transition-group/CSSTransition';
+
 // Object.assign() is used unpolyfilled in react-transition-group.
 // It will use the native implementation if it's present and isn't buggy.
-Object.assign = _objectAssign.default;
+Object.assign = assign;
+
+type Props = {
+  appearClassName: string,
+  appearActiveClassName: string,
+  transitionTimeout: number,
+  children: Node,
+};
 
 const TransitionInitialMount = ({
   appearActiveClassName,
   appearClassName,
   children,
-  transitionTimeout
-}) => /*#__PURE__*/_react.default.createElement(_CSSTransition.default, {
-  classNames: {
-    appear: appearClassName,
-    appearActive: appearActiveClassName
-  },
-  in: true,
-  appear: true,
-  timeout: {
-    exit: 0,
-    enter: 0,
-    appear: transitionTimeout
-  }
-}, children);
+  transitionTimeout,
+}: Props) => (
+  <CSSTransition
+    classNames={{
+      appear: appearClassName,
+      appearActive: appearActiveClassName,
+    }}
+    in
+    appear
+    timeout={{ exit: 0, enter: 0, appear: transitionTimeout }}
+  >
+    {children}
+  </CSSTransition>
+);
 
 TransitionInitialMount.propTypes = {
-  children: _propTypes.default.node.isRequired,
-  appearClassName: _propTypes.default.string.isRequired,
-  appearActiveClassName: _propTypes.default.string.isRequired,
-  transitionTimeout: _propTypes.default.number.isRequired
+  children: PropTypes.node.isRequired,
+  appearClassName: PropTypes.string.isRequired,
+  appearActiveClassName: PropTypes.string.isRequired,
+  transitionTimeout: PropTypes.number.isRequired,
 };
-var _default = TransitionInitialMount;
-exports.default = _default;
+
+export default TransitionInitialMount;

package/bpk-react-utils/src/cssModules.js

@@ -1,10 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
 /*
  * Backpack - Skyscanner's Design System
  *
@@ -22,13 +15,15 @@ exports.default = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var _default = (styles = {}) => (...classNames) => classNames.reduce((className, currentClass) => {
-  if (currentClass && typeof currentClass === 'string') {
-    const realName = styles[currentClass] || currentClass;
-    return className ? `${className} ${realName}` : realName;
-  }
 
-  return className;
-}, '');
+/* @flow strict */
 
-exports.default = _default;
+export default (styles: {} = {}) =>
+  (...classNames: Array<?string | ?boolean | ?number | ?{}>) =>
+    classNames.reduce((className, currentClass) => {
+      if (currentClass && typeof currentClass === 'string') {
+        const realName = styles[currentClass] || currentClass;
+        return className ? `${className} ${realName}` : realName;
+      }
+      return className;
+    }, '');

package/bpk-react-utils/src/deprecated.js

@@ -1,10 +1,3 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
 /*
  * Backpack - Skyscanner's Design System
  *
@@ -22,19 +15,26 @@ exports.default = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+/* @flow strict */
+import { type PropType } from 'prop-types';
+
 // We disable eslint on the below line because it breaks the flow type definitions and the FlowIssue comment below
 // We can remove this when we migrate this file to TypeScript.
 // $FlowIssue[value-as-type] - PropType is imported as a type so is incorrectly reporting the PropType is not a valid type
-const deprecated = (propType, alternativeSuggestion) => // eslint-disable-line
-(props, propName, componentName, ...rest) => {
-  if (props[propName] != null) {
-    const message = `Warning: "${propName}" property of "${componentName}" has been deprecated. ${alternativeSuggestion}`; // eslint-disable-next-line no-console
-
-    console.warn(message);
-  }
-
-  return propType(props, propName, componentName, ...rest);
-};
+const deprecated = (propType: PropType, alternativeSuggestion: string) => // eslint-disable-line
+  (
+    props: { [string]: any },
+    propName: string,
+    componentName: string,
+    ...rest: [any]
+  ) => {
+    if (props[propName] != null) {
+      const message = `Warning: "${propName}" property of "${componentName}" has been deprecated. ${alternativeSuggestion}`;
+      // eslint-disable-next-line no-console
+      console.warn(message);
+    }
+    return propType(props, propName, componentName, ...rest);
+  };
 
-var _default = deprecated;
-exports.default = _default;
+export default deprecated;