@skyscanner/backpack-web 29.4.0 → 29.4.2

package/bpk-component-banner-alert/src/withBannerAlertState.d.ts

@@ -18,152 +18,95 @@
 
 /// <reference types="node" />
 import type { ComponentType } from 'react';
-
-type WithBannerAlertStateProps = {
-  onHide?: () => void;
-  hideAfter?: number;
+export type WithBannerAlertStateProps = {
+    onHide?: () => void;
+    hideAfter?: number;
 };
-declare const withBannerAlertState: <
-  P extends Partial<
-    import('./common-types').CommonProps & {
-      dismissButtonLabel: string;
-      onDismiss?: import('./common-types').OnDismissHandler;
-    } & {
-      children: import('react').ReactNode;
-      expanded?: boolean | undefined;
-      toggleButtonLabel: string;
-      onExpandToggle?: import('./common-types').OnExpandToggleHandler;
-    }
-  >,
->(
-  WrappedComponent: ComponentType<P>,
-) => {
-  new (props: P & WithBannerAlertStateProps): {
-    hideIntervalId?: NodeJS.Timeout | null | undefined;
-    componentDidMount(): void;
-    componentWillUnmount(): void;
-    onExpandToggle: () => void;
-    onDismiss: () => void;
-    onHide: () => void;
-    render(): JSX.Element;
-    context: any;
-    setState<
-      K extends keyof {
-        expanded?: boolean | undefined;
-        show?: boolean | undefined;
-      },
-    >(
-      state:
-        | {
+declare const withBannerAlertState: <P extends Partial<import("./common-types").CommonProps & {
+    dismissButtonLabel: string;
+    onDismiss?: import("./common-types").OnDismissHandler;
+} & {
+    children: import("react").ReactNode;
+    expanded?: boolean | undefined;
+    toggleButtonLabel: string;
+    onExpandToggle?: import("./common-types").OnExpandToggleHandler;
+}>>(WrappedComponent: ComponentType<P>) => {
+    new (props: P & WithBannerAlertStateProps): {
+        hideIntervalId?: NodeJS.Timeout | null | undefined;
+        componentDidMount(): void;
+        componentWillUnmount(): void;
+        onExpandToggle: () => void;
+        onDismiss: () => void;
+        onHide: () => void;
+        render(): JSX.Element;
+        context: any;
+        setState<K extends keyof {
+            expanded?: boolean | undefined;
+            show?: boolean | undefined;
+        }>(state: {
+            expanded?: boolean | undefined;
+            show?: boolean | undefined;
+        } | ((prevState: Readonly<{
+            expanded?: boolean | undefined;
+            show?: boolean | undefined;
+        }>, props: Readonly<P & WithBannerAlertStateProps>) => {
+            expanded?: boolean | undefined;
+            show?: boolean | undefined;
+        } | Pick<{
+            expanded?: boolean | undefined;
+            show?: boolean | undefined;
+        }, K> | null) | Pick<{
+            expanded?: boolean | undefined;
+            show?: boolean | undefined;
+        }, K> | null, callback?: (() => void) | undefined): void;
+        forceUpdate(callback?: (() => void) | undefined): void;
+        readonly props: Readonly<P & WithBannerAlertStateProps> & Readonly<{
+            children?: import("react").ReactNode;
+        }>;
+        state: Readonly<{
+            expanded?: boolean | undefined;
+            show?: boolean | undefined;
+        }>;
+        refs: {
+            [key: string]: import("react").ReactInstance;
+        };
+        shouldComponentUpdate?(nextProps: Readonly<P & WithBannerAlertStateProps>, nextState: Readonly<{
+            expanded?: boolean | undefined;
+            show?: boolean | undefined;
+        }>, nextContext: any): boolean;
+        componentDidCatch?(error: Error, errorInfo: import("react").ErrorInfo): void;
+        getSnapshotBeforeUpdate?(prevProps: Readonly<P & WithBannerAlertStateProps>, prevState: Readonly<{
+            expanded?: boolean | undefined;
+            show?: boolean | undefined;
+        }>): any;
+        componentDidUpdate?(prevProps: Readonly<P & WithBannerAlertStateProps>, prevState: Readonly<{
+            expanded?: boolean | undefined;
+            show?: boolean | undefined;
+        }>, snapshot?: any): void;
+        componentWillMount?(): void;
+        UNSAFE_componentWillMount?(): void;
+        componentWillReceiveProps?(nextProps: Readonly<P & WithBannerAlertStateProps>, nextContext: any): void;
+        UNSAFE_componentWillReceiveProps?(nextProps: Readonly<P & WithBannerAlertStateProps>, nextContext: any): void;
+        componentWillUpdate?(nextProps: Readonly<P & WithBannerAlertStateProps>, nextState: Readonly<{
             expanded?: boolean | undefined;
             show?: boolean | undefined;
-          }
-        | ((
-            prevState: Readonly<{
-              expanded?: boolean | undefined;
-              show?: boolean | undefined;
-            }>,
-            props: Readonly<P & WithBannerAlertStateProps>,
-          ) =>
-            | {
-                expanded?: boolean | undefined;
-                show?: boolean | undefined;
-              }
-            | Pick<
-                {
-                  expanded?: boolean | undefined;
-                  show?: boolean | undefined;
-                },
-                K
-              >
-            | null)
-        | Pick<
-            {
-              expanded?: boolean | undefined;
-              show?: boolean | undefined;
-            },
-            K
-          >
-        | null,
-      callback?: (() => void) | undefined,
-    ): void;
-    forceUpdate(callback?: (() => void) | undefined): void;
-    readonly props: Readonly<P & WithBannerAlertStateProps> &
-      Readonly<{
-        children?: import('react').ReactNode;
-      }>;
-    state: Readonly<{
-      expanded?: boolean | undefined;
-      show?: boolean | undefined;
-    }>;
-    refs: {
-      [key: string]: import('react').ReactInstance;
+        }>, nextContext: any): void;
+        UNSAFE_componentWillUpdate?(nextProps: Readonly<P & WithBannerAlertStateProps>, nextState: Readonly<{
+            expanded?: boolean | undefined;
+            show?: boolean | undefined;
+        }>, nextContext: any): void;
+    };
+    displayName: string;
+    defaultProps: {
+        onDismiss: null;
+        onExpandToggle: null;
+        onHide: null;
+        expanded: boolean;
+        show: boolean;
+        hideAfter: null;
+        animateOnLeave: boolean;
+        children: null;
     };
-    shouldComponentUpdate?(
-      nextProps: Readonly<P & WithBannerAlertStateProps>,
-      nextState: Readonly<{
-        expanded?: boolean | undefined;
-        show?: boolean | undefined;
-      }>,
-      nextContext: any,
-    ): boolean;
-    componentDidCatch?(
-      error: Error,
-      errorInfo: import('react').ErrorInfo,
-    ): void;
-    getSnapshotBeforeUpdate?(
-      prevProps: Readonly<P & WithBannerAlertStateProps>,
-      prevState: Readonly<{
-        expanded?: boolean | undefined;
-        show?: boolean | undefined;
-      }>,
-    ): any;
-    componentDidUpdate?(
-      prevProps: Readonly<P & WithBannerAlertStateProps>,
-      prevState: Readonly<{
-        expanded?: boolean | undefined;
-        show?: boolean | undefined;
-      }>,
-      snapshot?: any,
-    ): void;
-    componentWillMount?(): void;
-    UNSAFE_componentWillMount?(): void;
-    componentWillReceiveProps?(
-      nextProps: Readonly<P & WithBannerAlertStateProps>,
-      nextContext: any,
-    ): void;
-    UNSAFE_componentWillReceiveProps?(
-      nextProps: Readonly<P & WithBannerAlertStateProps>,
-      nextContext: any,
-    ): void;
-    componentWillUpdate?(
-      nextProps: Readonly<P & WithBannerAlertStateProps>,
-      nextState: Readonly<{
-        expanded?: boolean | undefined;
-        show?: boolean | undefined;
-      }>,
-      nextContext: any,
-    ): void;
-    UNSAFE_componentWillUpdate?(
-      nextProps: Readonly<P & WithBannerAlertStateProps>,
-      nextState: Readonly<{
-        expanded?: boolean | undefined;
-        show?: boolean | undefined;
-      }>,
-      nextContext: any,
-    ): void;
-  };
-  displayName: string;
-  defaultProps: {
-    onDismiss: null;
-    onExpandToggle: null;
-    onHide: null;
-    expanded: boolean;
-    show: boolean;
-    hideAfter: null;
-    animateOnLeave: boolean;
-    children: null;
-  };
-  contextType?: import('react').Context<any> | undefined;
+    contextType?: import("react").Context<any> | undefined;
 };
 export default withBannerAlertState;

package/bpk-component-barchart/src/BpkBarchart.js

@@ -18,7 +18,7 @@
 import debounce from 'lodash.debounce';
 import { Component } from 'react';
 import { scaleLinear, scaleBand } from 'd3-scale';
-import { spacingXs, lineHeightSm } from '@skyscanner/bpk-foundations-web/tokens/base.es6';
+import { lineHeightSm } from '@skyscanner/bpk-foundations-web/tokens/base.es6';
 import { cssModules } from "../../bpk-react-utils";
 import BpkMobileScrollContainer from "../../bpk-component-mobile-scroll-container";
 import BpkBarchartDefs from "./BpkBarchartDefs";
@@ -36,7 +36,7 @@ import STYLES from "./BpkBarchart.module.css";
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
 const getClassName = cssModules(STYLES);
-const spacing = remToPx(spacingXs);
+const spacing = remToPx('.375rem');
 const lineHeight = remToPx(lineHeightSm);
 const getMaxYValue = (dataPoints, outlierPercentage) => {
   const meanValue = dataPoints.reduce((d, t) => d + t, 0) / dataPoints.length;
@@ -214,16 +214,35 @@ class BpkBarchart extends Component {
   }
 }
 BpkBarchart.propTypes = {
+  /**
+   * **Required**
+   * An array of data points with a value for the x axis and y axis respectively.
+   * The keys for the x axis and y axis can be anything you choose.
+   * Specify the keys with the props `xScaleDataKey` and `yScaleDataKey`.
+   */
   data: dataProp,
+  /**
+   * The key in each data point that holds the value for the x axis of that data point.
+   */
   xScaleDataKey: PropTypes.string.isRequired,
+  /**
+   * The key in each data point that holds the value for the y axis of that data point.
+   */
   yScaleDataKey: PropTypes.string.isRequired,
   xAxisLabel: PropTypes.string.isRequired,
+  /**
+   * Override the default y axis domain.  This is an array with two elements, the lower and upper domain.
+   * If either value is set to `null` the default value is used instead.
+   */
   yAxisLabel: PropTypes.string.isRequired,
   initialWidth: PropTypes.number.isRequired,
   initialHeight: PropTypes.number.isRequired,
   className: PropTypes.string,
   leadingScrollIndicatorClassName: PropTypes.string,
   trailingScrollIndicatorClassName: PropTypes.string,
+  /**
+   * Values that are `outlierPercentage` percent above the mean of the whole dataset are considered outliers and rendered cut off instead of at their full height.
+   */
   outlierPercentage: PropTypes.number,
   showGridlines: PropTypes.bool,
   xAxisMargin: PropTypes.number,
@@ -238,6 +257,9 @@ BpkBarchart.propTypes = {
   onBarHover: PropTypes.func,
   onBarFocus: PropTypes.func,
   getBarLabel: PropTypes.func,
+  /**
+   * Must be a function which returns true based on the `point` argument
+   */
   getBarSelection: PropTypes.func,
   BarComponent: PropTypes.elementType,
   disableDataTable: PropTypes.bool

package/bpk-component-barchart/src/BpkChartAxis.js

@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */import PropTypes from 'prop-types';
-import { spacingXs, lineHeightSm } from '@skyscanner/bpk-foundations-web/tokens/base.es6';
+import { lineHeightSm } from '@skyscanner/bpk-foundations-web/tokens/base.es6';
 import { cssModules } from "../../bpk-react-utils";
 import { rtlConditionalValue } from "./RTLtransforms";
 import { ORIENTATION_X, ORIENTATION_Y } from "./orientation";
@@ -24,7 +24,7 @@ import STYLES from "./BpkChartAxis.module.css";
 import { jsx as _jsx } from "react/jsx-runtime";
 import { jsxs as _jsxs } from "react/jsx-runtime";
 const getClassName = cssModules(STYLES);
-const spacing = remToPx(spacingXs);
+const spacing = remToPx('.375rem');
 const lineHeight = remToPx(lineHeightSm);
 const getAxisConfig = ({
   height,

package/bpk-component-breakpoint/src/BpkBreakpoint.d.ts

@@ -30,6 +30,9 @@ declare const BREAKPOINTS: {
     readonly DESKTOP_ONLY: any;
 };
 type Props = {
+    /**
+     * The content to render when the breakpoint matches.
+     */
     children: ReactNode | ((matches: boolean) => ReactNode | null);
     query: string | (typeof BREAKPOINTS)[keyof typeof BREAKPOINTS];
     legacy?: boolean;

package/bpk-component-button/index.js

@@ -15,7 +15,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */import BpkButton from "./src/BpkButton"; // eslint-disable-line import/no-cycle
-import BpkButtonV2 from "./src/BpkButtonV2/BpkButton";
+import { BpkButtonV2 } from "./src/BpkButtonV2/BpkButton";
 import BpkButtonPrimary from "./src/BpkButtonPrimary";
 import BpkButtonPrimaryOnDark from "./src/BpkButtonPrimaryOnDark";
 import BpkButtonPrimaryOnLight from "./src/BpkButtonPrimaryOnLight";

package/bpk-component-button/src/BpkButtonV2/BpkButton.d.ts

@@ -18,19 +18,4 @@
 
 /// <reference types="react" />
 import type { Props } from './common-types';
-
-declare const BpkButtonV2: ({
-  blank,
-  children,
-  className,
-  disabled,
-  href,
-  iconOnly,
-  onClick,
-  rel: propRel,
-  size,
-  submit,
-  type,
-  ...rest
-}: Props) => JSX.Element;
-export default BpkButtonV2;
+export declare const BpkButtonV2: ({ blank, children, className, disabled, href, iconOnly, onClick, rel: propRel, size, submit, type, ...rest }: Props) => JSX.Element;

package/bpk-component-button/src/BpkButtonV2/BpkButton.js

@@ -20,7 +20,9 @@ import { BUTTON_TYPES, SIZE_TYPES } from "./common-types";
 import COMMON_STYLES from "./BpkButton.module.css";
 import { jsx as _jsx } from "react/jsx-runtime";
 const getCommonClassName = cssModules(COMMON_STYLES);
-const BpkButtonV2 = ({
+
+// eslint-disable-next-line import/prefer-default-export
+export const BpkButtonV2 = ({
   blank = false,
   children,
   className = null,
@@ -56,5 +58,4 @@ const BpkButtonV2 = ({
     ...rest,
     children: children
   });
-};
-export default BpkButtonV2;
+};

package/bpk-component-calendar/index.d.ts

@@ -30,4 +30,4 @@ import CustomPropTypes, { BpkCalendarGridPropTypes, BpkCalendarDatePropTypes } f
 import * as DateUtils from './src/date-utils';
 import themeAttributes from './src/themeAttributes';
 export default BpkCalendarContainer;
-export { BpkCalendarGrid, BpkCalendarGridHeader, BpkCalendarNav, BpkCalendarDate, DateUtils, CALENDAR_SELECTION_TYPE, DaysOfWeek, ReactComponent, WeekDay, WeekDayKey, SelectionConfiguration, ROW_TYPES, SELECTION_TYPES, composeCalendar, withCalendarState, themeAttributes, BpkCalendarGridWithTransition, CustomPropTypes, BpkCalendarGridPropTypes, BpkCalendarDatePropTypes, BpkCalendarGridProps, BpkCalendarDateProps };
+export { BpkCalendarGrid, BpkCalendarGridHeader, BpkCalendarNav, BpkCalendarDate, DateUtils, CALENDAR_SELECTION_TYPE, DaysOfWeek, ReactComponent, WeekDay, WeekDayKey, SelectionConfiguration, ROW_TYPES, SELECTION_TYPES, composeCalendar, withCalendarState, themeAttributes, BpkCalendarGridWithTransition, CustomPropTypes, BpkCalendarGridPropTypes, BpkCalendarDatePropTypes, BpkCalendarDateProps, BpkCalendarGridProps, };