@skyscanner/backpack-web 23.2.1 → 23.3.0

package/bpk-react-utils/index.d.ts

@@ -0,0 +1,58 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/// <reference types="react" />
+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, };
+declare const _default: {
+    Portal: typeof Portal;
+    TransitionInitialMount: ({ appearActiveClassName, appearClassName, children, transitionTimeout, }: {
+        appearClassName: string;
+        appearActiveClassName: string;
+        transitionTimeout: number;
+        children: import("react").ReactNode;
+    }) => JSX.Element;
+    cssModules: (styles?: {
+        [key: string]: any;
+    }) => (...classNames: (string | number | boolean | {} | null | undefined)[]) => string;
+    deprecated: any;
+    withDefaultProps: (WrappedComponent: import("react").ComponentType<any>, defaultProps: {
+        [rest: string]: any;
+        className?: string | undefined;
+    }) => {
+        ({ children, className: innerClassName, ...rest }: {
+            [rest: string]: any;
+            children?: import("react").ReactNode;
+            className?: string | null | undefined;
+        }): JSX.Element;
+        displayName: string;
+    };
+    wrapDisplayName: (Component: string | import("react").ComponentType<any> | null, hoc: string) => string;
+    isDeviceIphone: () => boolean;
+    isDeviceIpad: () => boolean;
+    isDeviceIos: () => boolean;
+    isRTL: () => boolean;
+};
+export default _default;

package/bpk-react-utils/index.js

@@ -90,6 +90,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+// @ts-expect-error Untyped import. See `decisions/imports-ts-suppressions.md`.
 var _default = {
   Portal: _Portal.default,
   TransitionInitialMount: _TransitionInitialMount.default,

package/bpk-react-utils/src/Portal.d.ts

@@ -0,0 +1,76 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Component } from 'react';
+import type { ReactNode } from 'react';
+type InteractionEvents = TouchEvent | MouseEvent | KeyboardEvent;
+type Props = {
+    children: string | ReactNode;
+    isOpen: boolean;
+    beforeClose: ((arg0: () => void) => void) | null | undefined;
+    className: string | null | undefined;
+    onClose: (arg0: InteractionEvents, arg1: {
+        source: 'ESCAPE' | 'DOCUMENT_CLICK';
+    }) => void;
+    onOpen: (arg0: HTMLElement, arg1?: HTMLElement | null | undefined) => void;
+    onRender: (arg0: HTMLElement | null | undefined, arg1: HTMLElement | null | undefined) => void;
+    style: {} | null | undefined;
+    renderTarget: null | HTMLElement | (() => null | HTMLElement);
+    target: null | HTMLElement | JSX.Element | (() => HTMLElement);
+    targetRef: ((arg0: null | Element | Text | undefined) => void) | null | undefined;
+    closeOnEscPressed: boolean;
+};
+type State = {
+    isVisible: boolean;
+};
+declare class Portal extends Component<Props, State> {
+    portalElement: null | HTMLDivElement;
+    shouldClose: boolean;
+    static defaultProps: {
+        beforeClose: null;
+        className: null;
+        onClose: () => null;
+        onOpen: () => null;
+        onRender: () => null;
+        style: null;
+        renderTarget: null;
+        target: null;
+        targetRef: null;
+        closeOnEscPressed: boolean;
+    };
+    constructor(props: Props);
+    componentDidMount(): void;
+    componentDidUpdate(prevProps: Props): void;
+    componentWillUnmount(): void;
+    onDocumentMouseDown(event: MouseEvent | TouchEvent): void;
+    onDocumentMouseUp(event: MouseEvent | TouchEvent): void;
+    onDocumentKeyDown(event: KeyboardEvent): void;
+    onDocumentMouseMove(): void;
+    getClickEventProperties(event: MouseEvent | TouchEvent): {
+        isNotLeftClick: boolean;
+        isTargetClick: boolean;
+        isPortalClick: boolean;
+    };
+    getTargetElement(): HTMLElement | null;
+    getRenderTarget(): HTMLElement;
+    open(): void;
+    close(): void;
+    supportsPassiveEvents(): boolean;
+    render(): import("react").ReactPortal | null;
+}
+export default Portal;

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

@@ -7,33 +7,35 @@ 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"));
 var _jsxRuntime = require("react/jsx-runtime");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-/*
- * Backpack - Skyscanner's Design System
- *
- * Copyright 2016 Skyscanner Ltd
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /*
+                                                                                                                                                                                                                                                                                                                                                                                           * Backpack - Skyscanner's Design System
+                                                                                                                                                                                                                                                                                                                                                                                           *
+                                                                                                                                                                                                                                                                                                                                                                                           * Copyright 2016 Skyscanner Ltd
+                                                                                                                                                                                                                                                                                                                                                                                           *
+                                                                                                                                                                                                                                                                                                                                                                                           * Licensed under the Apache License, Version 2.0 (the "License");
+                                                                                                                                                                                                                                                                                                                                                                                           * you may not use this file except in compliance with the License.
+                                                                                                                                                                                                                                                                                                                                                                                           * You may obtain a copy of the License at
+                                                                                                                                                                                                                                                                                                                                                                                           *
+                                                                                                                                                                                                                                                                                                                                                                                           *   http://www.apache.org/licenses/LICENSE-2.0
+                                                                                                                                                                                                                                                                                                                                                                                           *
+                                                                                                                                                                                                                                                                                                                                                                                           * Unless required by applicable law or agreed to in writing, software
+                                                                                                                                                                                                                                                                                                                                                                                           * distributed under the License is distributed on an "AS IS" BASIS,
+                                                                                                                                                                                                                                                                                                                                                                                           * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+                                                                                                                                                                                                                                                                                                                                                                                           * See the License for the specific language governing permissions and
+                                                                                                                                                                                                                                                                                                                                                                                           * limitations under the License.
+                                                                                                                                                                                                                                                                                                                                                                                           */ // @ts-expect-error Untyped import. See `decisions/imports-ts-suppressions.md`.
 const KEYCODES = {
   ESCAPE: 'Escape'
 };
 class Portal extends _react.Component {
-  constructor() {
-    super();
+  constructor(props) {
+    super(props);
+    _defineProperty(this, "portalElement", void 0);
+    _defineProperty(this, "shouldClose", void 0);
     this.portalElement = null;
     this.state = {
       isVisible: false
@@ -115,6 +117,7 @@ class Portal extends _react.Component {
     this.shouldClose = false;
   }
   getClickEventProperties(event) {
+    // @ts-expect-error FIXME: TS2339: Property 'button' does not exist on type 'TouchEvent | MouseEvent'.
     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));
@@ -142,8 +145,8 @@ class Portal extends _react.Component {
     if (this.portalElement) {
       return;
     }
-    this.portalElement = document.createElement('div');
-    this.getRenderTarget().appendChild(this.portalElement);
+    const portalElement = document.createElement('div');
+    this.getRenderTarget().appendChild(portalElement);
     const passiveArgs = this.supportsPassiveEvents() ? {
       passive: true
     } : false;
@@ -154,14 +157,15 @@ class Portal extends _react.Component {
     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);
+      (0, _objectAssign.default)(portalElement.style, this.props.style);
     }
     if (this.props.className) {
-      this.portalElement.className = this.props.className;
+      portalElement.className = this.props.className;
     }
+    this.portalElement = portalElement;
     this.setState({
       isVisible: true
-    }, () => this.props.onOpen(this.portalElement, this.getTargetElement()));
+    }, () => this.props.onOpen(portalElement, this.getTargetElement()));
   }
   close() {
     if (!this.portalElement) {
@@ -195,6 +199,7 @@ class Portal extends _react.Component {
           supportsPassiveOption = true;
         }
       });
+      // @ts-expect-error FIXME: TS2769: No overload matches this call.
       window.addEventListener('test', null, opts);
     } catch (e) {
       return false;
@@ -227,22 +232,7 @@ class Portal extends _react.Component {
     }), 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
-};
-Portal.defaultProps = {
+_defineProperty(Portal, "defaultProps", {
   beforeClose: null,
   className: null,
   onClose: () => null,
@@ -253,6 +243,6 @@ Portal.defaultProps = {
   target: null,
   targetRef: null,
   closeOnEscPressed: true
-};
+});
 var _default = Portal;
 exports.default = _default;

package/bpk-react-utils/src/TransitionInitialMount.d.ts

@@ -0,0 +1,27 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { ReactNode } from 'react';
+type Props = {
+    appearClassName: string;
+    appearActiveClassName: string;
+    transitionTimeout: number;
+    children: string | ReactNode;
+};
+declare const TransitionInitialMount: ({ appearActiveClassName, appearClassName, children, transitionTimeout, }: Props) => JSX.Element;
+export default TransitionInitialMount;

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

@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _objectAssign = _interopRequireDefault(require("object-assign"));
-var _propTypes = _interopRequireDefault(require("prop-types"));
 var _CSSTransition = _interopRequireDefault(require("react-transition-group/CSSTransition"));
 var _jsxRuntime = require("react/jsx-runtime");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -25,7 +24,13 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */ // Object.assign() is used unpolyfilled in react-transition-group.
+ */
+
+// @ts-expect-error Untyped import. See `decisions/imports-ts-suppressions.md`.
+
+// @ts-expect-error Untyped import. See `decisions/imports-ts-suppressions.md`.
+
+// 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;
 const TransitionInitialMount = ({
@@ -47,11 +52,5 @@ const TransitionInitialMount = ({
   },
   children: children
 });
-TransitionInitialMount.propTypes = {
-  children: _propTypes.default.node.isRequired,
-  appearClassName: _propTypes.default.string.isRequired,
-  appearActiveClassName: _propTypes.default.string.isRequired,
-  transitionTimeout: _propTypes.default.number.isRequired
-};
 var _default = TransitionInitialMount;
 exports.default = _default;

package/bpk-react-utils/src/cssModules.d.ts

@@ -0,0 +1,22 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare const _default: (styles?: {
+    [key: string]: any;
+}) => (...classNames: Array<string | boolean | number | {} | null | undefined>) => string;
+export default _default;

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

@@ -20,7 +20,8 @@ exports.default = void 0;
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */ // We disable eslint on the below line because it breaks the flow type definitions and the FlowIssue comment below
+ */ // TODO: Remove this file once all BPK components have been migrated to TS
+// 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) =>

package/bpk-react-utils/src/deviceDetection.d.ts

@@ -0,0 +1,22 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare const isDeviceIphone: () => boolean;
+declare const isDeviceIpad: () => boolean;
+declare const isDeviceIos: () => boolean;
+export { isDeviceIphone, isDeviceIpad, isDeviceIos };

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

@@ -20,7 +20,9 @@ exports.isDeviceIphone = exports.isDeviceIpad = exports.isDeviceIos = void 0;
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */const isDeviceIphone = () => /iPhone/i.test(typeof window !== 'undefined' ? window.navigator.userAgent : '');
+ */
+
+const isDeviceIphone = () => /iPhone/i.test(typeof window !== 'undefined' ? window.navigator.userAgent : '');
 exports.isDeviceIphone = isDeviceIphone;
 const isDeviceIpad = () => /iPad/i.test(typeof window !== 'undefined' ? window.navigator.userAgent : '');
 exports.isDeviceIpad = isDeviceIpad;

package/bpk-react-utils/src/isRTL.d.ts

@@ -0,0 +1,20 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare const isRTL: () => boolean;
+export default isRTL;

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

@@ -20,7 +20,9 @@ exports.default = void 0;
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */const DIRECTIONS = {
+ */
+
+const DIRECTIONS = {
   LTR: 'ltr',
   RTL: 'rtl'
 };

package/bpk-react-utils/src/withDefaultProps.d.ts

@@ -0,0 +1,33 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { ReactNode, ComponentType } from 'react';
+type Props = {
+    children?: ReactNode | string;
+    className?: string | null;
+    [rest: string]: any;
+};
+type DefaultProps = {
+    className?: string;
+    [rest: string]: any;
+};
+declare const withDefaultProps: (WrappedComponent: ComponentType<any>, defaultProps: DefaultProps) => {
+    ({ children, className: innerClassName, ...rest }: Props): JSX.Element;
+    displayName: string;
+};
+export default withDefaultProps;

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

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _propTypes = _interopRequireDefault(require("prop-types"));
 var _wrapDisplayName = _interopRequireDefault(require("./wrapDisplayName"));
 var _jsxRuntime = require("react/jsx-runtime");
 const _excluded = ["className"],
@@ -39,12 +38,12 @@ const withDefaultProps = (WrappedComponent, defaultProps) => {
       className: defaultClassName
     } = defaultProps,
     defaultRest = _objectWithoutProperties(defaultProps, _excluded);
-  const component = props => {
-    const {
-        children,
-        className: innerClassName
-      } = props,
-      rest = _objectWithoutProperties(props, _excluded2);
+  const component = _ref => {
+    let {
+        children = null,
+        className: innerClassName = null
+      } = _ref,
+      rest = _objectWithoutProperties(_ref, _excluded2);
     const classNames = [];
     if (defaultClassName) {
       classNames.push(defaultClassName);
@@ -52,23 +51,11 @@ const withDefaultProps = (WrappedComponent, defaultProps) => {
     if (innerClassName) {
       classNames.push(innerClassName);
     }
-    return (
-      /*#__PURE__*/
-      // $FlowFixMe[cannot-spread-inexact] - inexact rest. See 'decisions/flowfixme.md'.
-      (0, _jsxRuntime.jsx)(WrappedComponent, _objectSpread(_objectSpread(_objectSpread({
-        className: classNames.join(' ')
-      }, defaultRest), rest), {}, {
-        children: children
-      }))
-    );
-  };
-  component.propTypes = {
-    children: _propTypes.default.node,
-    className: _propTypes.default.string
-  };
-  component.defaultProps = {
-    children: null,
-    className: null
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)(WrappedComponent, _objectSpread(_objectSpread(_objectSpread({
+      className: classNames.join(' ')
+    }, defaultRest), rest), {}, {
+      children: children
+    }));
   };
   component.displayName = (0, _wrapDisplayName.default)(WrappedComponent, 'withDefaultProps');
   return component;

package/bpk-react-utils/src/wrapDisplayName.d.ts

@@ -0,0 +1,21 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { ComponentType } from 'react';
+declare const wrapDisplayName: (Component: ComponentType<any> | string | null, hoc: string) => string;
+export default wrapDisplayName;

package/bpk-scrim-utils/src/BpkScrim.d.ts

@@ -0,0 +1,24 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { SyntheticEvent } from 'react';
+type Props = {
+    onClose?: (e?: SyntheticEvent) => void | null;
+};
+declare const BpkScrim: ({ onClose }: Props) => JSX.Element;
+export default BpkScrim;

package/bpk-scrim-utils/src/BpkScrim.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _propTypes = _interopRequireDefault(require("prop-types"));
 var _bpkReactUtils = require("../../bpk-react-utils");
 var _bpkScrimModule = _interopRequireDefault(require("./bpk-scrim.module.css"));
 var _jsxRuntime = require("react/jsx-runtime");
@@ -28,22 +27,18 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 
 const getClassName = (0, _bpkReactUtils.cssModules)(_bpkScrimModule.default);
-const BpkScrim = props => /*#__PURE__*/(0, _jsxRuntime.jsx)(_bpkReactUtils.TransitionInitialMount, {
+const BpkScrim = ({
+  onClose = () => {}
+}) => /*#__PURE__*/(0, _jsxRuntime.jsx)(_bpkReactUtils.TransitionInitialMount, {
   appearClassName: getClassName('bpk-scrim--appear'),
   appearActiveClassName: getClassName('bpk-scrim--appear-active'),
   transitionTimeout: 200,
   children: /*#__PURE__*/(0, _jsxRuntime.jsx)("div", {
     role: "presentation",
     className: getClassName('bpk-scrim'),
-    onMouseDown: props.onClose,
-    onTouchStart: props.onClose
+    onMouseDown: onClose,
+    onTouchStart: onClose
   })
 });
-BpkScrim.propTypes = {
-  onClose: _propTypes.default.func
-};
-BpkScrim.defaultProps = {
-  onClose: null
-};
 var _default = BpkScrim;
 exports.default = _default;

package/bpk-scrim-utils/src/scroll-utils.d.ts

@@ -0,0 +1,24 @@
+/*
+ * Backpack - Skyscanner's Design System
+ *
+ * Copyright 2016 Skyscanner Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export declare const storeScroll: () => void;
+export declare const restoreScroll: () => void;
+export declare const fixBody: () => void;
+export declare const unfixBody: () => void;
+export declare const lockScroll: () => void;
+export declare const unlockScroll: () => void;