@shopgate/engage 7.32.0-beta.14 → 7.32.0-beta.15

package/filter/providers/FilterPageProvider.js

@@ -1,28 +1,40 @@
-import React, { useMemo, useState, useEffect, useCallback } from 'react';
-import PropTypes from 'prop-types';
+import "core-js/modules/es.array.includes.js";
+import "core-js/modules/es.string.replace.js";
+import { useMemo, useState, useEffect, useCallback } from 'react';
 import { connect } from 'react-redux';
 import debounce from 'lodash/debounce';
 import isEqual from 'lodash/isEqual';
 import { router } from '@shopgate/engage/core';
+import { useRoute } from '@shopgate/engage/core/hooks';
+import { parseObjectToQueryString } from '@shopgate/engage/core/helpers';
 import { getFiltersByHash } from '@shopgate/engage/filter';
-// eslint-disable-next-line no-unused-vars, import/named
-import Context, { APIFilter, RouteFilters } from "./FilterPageProvider.context";
+import Context from "./FilterPageProvider.context";
 import { buildInitialFilters, buildUpdatedFilters } from "../helpers";
+import { jsx as _jsx } from "react/jsx-runtime";
+const FILTER_PATH_SUFFIX = '/filter';
 
 /**
- * @param {Object} state The application state.
- * @param {Object} props The component props.
- * @returns {Object}
+ * A single stored filter value carrying id and label.
+ */
+
+/**
+ * A filter as kept in the provider's internal state. `value` holds either the selected values of a
+ * list filter or the `[min, max]` tuple of a range filter.
+ */
+
+const buildInitialFiltersTyped = buildInitialFilters;
+const buildUpdatedFiltersTyped = buildUpdatedFilters;
+/**
+ * Maps the available filters from the application state onto the provider props.
+ * @returns The mapped state props.
  */
-import { jsx as _jsx } from "react/jsx-runtime";
 const mapStateToProps = (state, props) => ({
   filters: getFiltersByHash(state, props)
 });
 
 /**
- * @param {Object} next The next component props.
- * @param {Object} prev The previous component props.
- * @returns {boolean}
+ * Compares the mapped state props to decide whether the connected component needs to re-render.
+ * @returns Whether the state props are considered equal.
  */
 const areStatePropsEqual = (next, prev) => {
   if (!prev.filters && next.filters || !isEqual(prev.filters, next.filters)) {
@@ -34,25 +46,19 @@ const areStatePropsEqual = (next, prev) => {
 /**
  * The FilterPageProvider component provides all relevant data and callbacks to represent and modify
  * the current state of the "filter" page.
- * @param {Object} props Provider props
- * @param {APIFilter[]} props.filters Array of available filters
- * @param {RouteFilters} props.activeFilters Object with the active filters for a filtered product
- * list
- * @param {string} props.parentRouteId Id of the route with the product list that's supposed to be
- * filtered
- * @param {Function} [props.onApply] Callback invoked when users pressed the apply button
- * @param {string} [props.categoryId] A category to be used for filter selection from Redux
- * @param {string} [props.searchPhrase] A search phrase to be used for filter selection from Redux
- * @param {NodeList} children Provider children
- * @returns {JSX.Element}
+ * @returns The rendered component.
  */
 const FilterPageProvider = ({
-  filters: filtersProp,
-  activeFilters: activeFiltersProp,
-  parentRouteId,
-  onApply,
-  children
+  filters: filtersProp = null,
+  activeFilters: activeFiltersProp = null,
+  parentRouteId = null,
+  onApply = () => setTimeout(router.pop, 250),
+  children = null
 }) => {
+  const {
+    pathname,
+    query
+  } = useRoute();
   const [currentFilters, setCurrentFilters] = useState(activeFiltersProp || {});
 
   /**
@@ -60,7 +66,7 @@ const FilterPageProvider = ({
    * It's created from the "filters" array that contains all available filters, and the
    * "activeFilters" object that represents filters with an active value selection.
    */
-  const [initialFilters, setInitialFilters] = useState(buildInitialFilters(filtersProp, activeFiltersProp));
+  const [initialFilters, setInitialFilters] = useState(buildInitialFiltersTyped(filtersProp, activeFiltersProp));
 
   /**
    * Storage that hosts an object that represents the a partial state of the filters page with
@@ -82,7 +88,7 @@ const FilterPageProvider = ({
       if (Object.keys(currentState).length > 0) {
         return currentState;
       }
-      return buildInitialFilters(filtersProp, activeFiltersProp);
+      return buildInitialFiltersTyped(filtersProp, activeFiltersProp);
     });
   }, [activeFiltersProp, filtersProp]);
 
@@ -91,37 +97,23 @@ const FilterPageProvider = ({
    *
    * Reset is possible whenever filters where selected by the user before, or when filters where
    * modified since the filters page was opened.
-   * @type {boolean}
    */
   const resetPossible = useMemo(() => !!(Object.keys(currentFilters).length || Object.keys(changedFilters).length), [changedFilters, currentFilters]);
 
   /**
    * Whether the filter selection has changed since the filters page was opened
-   * @type {boolean}
    */
   const hasChanged = useMemo(() => Object.keys(changedFilters).length > 0 || !!(Object.keys(currentFilters).length === 0 && activeFiltersProp), [activeFiltersProp, changedFilters, currentFilters]);
-
-  /**
-   * Retrieves a list of currently selected values for a filter
-   * @callback getSelectedFilterValues
-   * @param {string} filterId The id of the filter
-   * @returns {string[]}
-   */
-  const getSelectedFilterValues = useCallback(
-  /**
-   * @param {string} filterId The id of the filter
-   * @returns {string[]}
-   */
-  filterId => {
+  const getSelectedFilterValues = useCallback(filterId => {
     const value = changedFilters[filterId] ? changedFilters[filterId].value : initialFilters[filterId]?.value || [];
-    return value.map(entry => entry.id || entry);
+    return value.map(entry => typeof entry === 'object' ? entry.id : entry);
   }, [changedFilters, initialFilters]);
 
   /**
    * Resets all filters which have been changed by the user
    */
   const resetAllFilters = useCallback(() => {
-    setInitialFilters(buildInitialFilters(filtersProp, {}));
+    setInitialFilters(buildInitialFiltersTyped(filtersProp, {}));
     setCurrentFilters({});
     setChangedFilters({});
   }, [filtersProp]);
@@ -132,77 +124,33 @@ const FilterPageProvider = ({
   const resetChangedFilters = useCallback(() => {
     setChangedFilters({});
   }, []);
-
-  /**
-   * Adds or updates the selection for a changed filter
-   * @callback updateChangedFilterInternal
-   * @param {string} filterId The id of the filter to be updated
-   * @param {string[]} selectedValues The updated selected values
-   */
-  const updateChangedFilterInternal = useCallback(
-  /**
-   * @param {string} filterId The id of the filter to be updated
-   * @param {string[]} selectedValues The updated selected values
-   */
-  (filterId, selectedValues) => {
+  const updateChangedFilterInternal = useCallback((filterId, selectedValues) => {
     setChangedFilters(currentState => ({
       ...currentState,
       [filterId]: selectedValues
     }));
   }, []);
-
-  /**
-   * Removes a changed filter
-   * @callback removeChangedFilterInternal
-   * @param {string} filterId The id of the filter to be updated
-   * @param {string[]} selectedValues The updated selected values
-   */
-  const removeChangedFilterInternal = useCallback(
-  /**
-   * @param {string} filterId The id of the filter to be removed
-   */
-  filterId => {
+  const removeChangedFilterInternal = useCallback(filterId => {
     setChangedFilters(currentState => {
-      // Separate the given id from the other set filters.
-      const {
-        [filterId]: removed,
-        ...remainingFilters
-      } = currentState;
+      const remainingFilters = {
+        ...currentState
+      };
+      delete remainingFilters[filterId];
       return remainingFilters;
     });
   }, []);
-
-  /**
-   * Updates the selection for a filter
-   *
-   * @param {string} filterId The id of the filter to be updated
-   * @param {string[]} selectedValues The updated selected values
-   */
-  const updateSelectedFilterValues = useCallback(debounce(
-  /**
-   * @param {string} filterId The id of the filter to be updated
-   * @param {string[]} selectedValues The updated selected values
-   */
-  (filterId, selectedValues) => {
-    // Retrieve data of filter to be updated from the filters array.
-    const filter = filtersProp.find(entry => entry.id === filterId);
-
-    // Retrieve the values for the updated filter that where set when the filter page was opened
+  const updateSelectedFilterValues = useCallback(debounce((filterId, selectedValues) => {
+    const filter = (filtersProp || []).find(entry => entry.id === filterId);
+    if (!filter) {
+      return;
+    }
     const {
       value: initialValues
     } = initialFilters[filterId];
-
-    // Prepare the update payload
-    let stateValue = [].concat(selectedValues);
-
-    /**
-     * No initial values where set for this filter, and the update contains no values. So we
-     * can remove the filter from the changedFilters storage.
-     */
-    if (initialValues.length === 0 && selectedValues.length === 0) {
-      removeChangedFilterInternal(filterId);
-      return;
-    }
+    const hasValueList = Array.isArray(filter.values);
+    const orderByFilter = ids => hasValueList ? filter.values.filter(entry => ids.includes(entry.id)).map(entry => entry.id) : ids;
+    const selectedValueIds = orderByFilter(selectedValues);
+    const initialValueIds = orderByFilter(initialValues.map(entry => typeof entry === 'object' ? entry.id : entry));
 
     /**
      * When the filter update would recreate the state that the filter initially had, we
@@ -210,25 +158,21 @@ const FilterPageProvider = ({
      *
      * That enables proper behavior for the "reset" and "update" button states.
      */
-    if (initialValues.length !== 0 && selectedValues.length !== 0) {
-      if (initialValues.every((initial, i) => initial === selectedValues[i])) {
-        removeChangedFilterInternal(filterId);
-        return;
-      }
+    if (initialValueIds.length === selectedValueIds.length && initialValueIds.every((initial, i) => initial === selectedValueIds[i])) {
+      removeChangedFilterInternal(filterId);
+      return;
     }
-    if (Array.isArray(filter.values)) {
+    let stateValue = [].concat(selectedValueIds);
+    if (hasValueList) {
       /**
        * The selectedValues array only contains a list of ids.
        * For the getProducts request that's dispatched after the current filter selection was
        * applied, id and label is required at the filter values level.
        */
-      stateValue = selectedValues.map(valueId => {
-        const match = filter.values.find(entry => entry.id === valueId);
-        return {
-          id: match.id,
-          label: match.label
-        };
-      });
+      stateValue = selectedValueIds.map(valueId => filter.values.find(entry => entry.id === valueId)).filter(match => Boolean(match)).map(match => ({
+        id: match.id,
+        label: match.label
+      }));
     }
     updateChangedFilterInternal(filterId, {
       id: filterId,
@@ -242,15 +186,27 @@ const FilterPageProvider = ({
   }, 50), [filtersProp, initialFilters, removeChangedFilterInternal, updateChangedFilterInternal]);
 
   /**
-   * Applies the current filter selection to the parent route with a product list to be filtered
+   * Applies the current filter selection to the parent route with a product list to be filtered.
+   * When the filter page was entered directly, no parent route exists in the history stack. In
+   * that case the product list route is derived from the current pathname and replaces the
+   * filter page.
    */
   const applyFilters = useCallback(() => {
-    const filters = buildUpdatedFilters(currentFilters, changedFilters);
+    const filters = buildUpdatedFiltersTyped(currentFilters, changedFilters);
+    if (!parentRouteId) {
+      router.replace({
+        pathname: `${pathname.slice(0, -FILTER_PATH_SUFFIX.length)}${parseObjectToQueryString(query)}`,
+        state: {
+          filters
+        }
+      });
+      return;
+    }
     router.update(parentRouteId, {
       filters
     });
     onApply(filters);
-  }, [changedFilters, currentFilters, onApply, parentRouteId]);
+  }, [changedFilters, currentFilters, onApply, parentRouteId, pathname, query]);
   const value = useMemo(() => ({
     resetPossible,
     hasChanged,
@@ -267,17 +223,6 @@ const FilterPageProvider = ({
     children: children
   });
 };
-FilterPageProvider.defaultProps = {
-  children: null,
-  activeFilters: null,
-  parentRouteId: null,
-  filters: null,
-  onApply: () => setTimeout(router.pop, 250)
-};
-
-/**
- * @type FilterPageProvider
- */
 export default connect(mapStateToProps, null, null, {
   areStatePropsEqual
 })(FilterPageProvider);

package/locations/components/GlobalLocationSwitcher/GlobalLocationSwitcherBar.js

@@ -8,7 +8,7 @@ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 const useStyles = makeStyles()(theme => ({
   wrapper: {
     color: theme.palette.text.primary,
-    background: theme.palette.background.emphasized
+    background: theme.palette.background.surface
   },
   inner: {
     display: 'flex',
@@ -16,7 +16,8 @@ const useStyles = makeStyles()(theme => ({
     margin: theme.spacing(0, 2),
     borderBottom: `1px solid ${theme.components.border.light}`,
     alignItems: 'center',
-    height: theme.components.filterBar.height
+    height: theme.components.filterBar.height,
+    justifyContent: 'space-between'
   },
   innerStandalone: {
     borderBottom: 'none'
@@ -26,6 +27,7 @@ const useStyles = makeStyles()(theme => ({
   },
   button: {
     marginLeft: theme.spacing(2),
+    marginTop: theme.spacing(0.5),
     textTransform: 'none'
   }
 }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopgate/engage",
-  "version": "7.32.0-beta.14",
+  "version": "7.32.0-beta.15",
   "description": "Shopgate's ENGAGE library.",
   "license": "Apache-2.0",
   "author": "Shopgate <support@shopgate.com>",
@@ -18,12 +18,12 @@
   "dependencies": {
     "@emotion/react": "^11.14.0",
     "@shopgate/native-modules": "1.0.0-beta.34",
-    "@shopgate/pwa-common": "7.32.0-beta.14",
-    "@shopgate/pwa-common-commerce": "7.32.0-beta.14",
-    "@shopgate/pwa-core": "7.32.0-beta.14",
-    "@shopgate/pwa-ui-ios": "7.32.0-beta.14",
-    "@shopgate/pwa-ui-material": "7.32.0-beta.14",
-    "@shopgate/pwa-ui-shared": "7.32.0-beta.14",
+    "@shopgate/pwa-common": "7.32.0-beta.15",
+    "@shopgate/pwa-common-commerce": "7.32.0-beta.15",
+    "@shopgate/pwa-core": "7.32.0-beta.15",
+    "@shopgate/pwa-ui-ios": "7.32.0-beta.15",
+    "@shopgate/pwa-ui-material": "7.32.0-beta.15",
+    "@shopgate/pwa-ui-shared": "7.32.0-beta.15",
     "@stripe/react-stripe-js": "^1.16.5",
     "@stripe/stripe-js": "^1.44.1",
     "@virtuous/conductor": "~2.5.0",

package/product/components/FilterBar/components/Content/components/FilterButton/index.js

@@ -1,35 +1,28 @@
 import React from 'react';
 import PropTypes from 'prop-types';
 import { makeStyles } from '@shopgate/engage/styles';
-import { Grid, I18n, Ripple, FilterIcon, Typography } from '@shopgate/engage/components';
+import { i18n } from '@shopgate/engage/core/helpers';
+import { Badge, I18n, FilterIcon, Typography } from '@shopgate/engage/components';
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 const useStyles = makeStyles()(theme => ({
   button: {
+    display: 'flex',
+    alignItems: 'center',
+    gap: theme.spacing(0.75),
     color: 'inherit',
-    fontSize: theme.components.icon.medium,
     outline: 0,
-    padding: 0,
-    minWidth: theme.components.navigator.height,
-    height: theme.components.filterBar.height,
-    position: 'relative',
-    zIndex: 1,
-    overflow: 'hidden'
-  },
-  filterButton: {
-    display: 'flex'
+    flexShrink: 0,
+    margin: theme.spacing(0, 1.5),
+    padding: theme.spacing(0.25, 1),
+    border: `1px solid ${theme.components.border.medium}`,
+    borderRadius: theme.shape.borderRadius
   },
-  filterButtonLabel: {
-    alignSelf: 'center',
-    paddingRight: theme.spacing(1)
+  buttonActive: {
+    borderColor: theme.components.badge.background
   },
-  filterButtonRipple: {
-    display: 'flex',
-    height: '100%',
-    width: '100%',
-    justifyContent: 'center',
-    alignItems: 'center',
-    margin: 0,
-    padding: '6px 10px'
+  icon: {
+    fontSize: theme.components.icon.medium,
+    display: 'flex'
   }
 }));
 
@@ -39,39 +32,38 @@ const useStyles = makeStyles()(theme => ({
  * @return {JSX}
  */
 function FilterButton({
-  openFilters
+  openFilters,
+  filterCount
 }) {
   const {
     classes,
     cx
   } = useStyles();
-  return /*#__PURE__*/_jsx("button", {
-    className: cx(classes.button, 'theme__filter-bar__filter-button'),
+  return /*#__PURE__*/_jsxs("button", {
+    className: cx(classes.button, {
+      [classes.buttonActive]: filterCount > 0
+    }, 'theme__filter-bar__filter-button'),
     onClick: openFilters,
     "data-test-id": "filterButton",
+    "aria-label": i18n.text('titles.filter'),
     type: "button",
-    children: /*#__PURE__*/_jsx(Ripple, {
-      className: classes.filterButtonRipple,
-      fill: true,
-      children: /*#__PURE__*/_jsxs(Grid, {
-        component: "div",
-        children: [/*#__PURE__*/_jsx(Grid.Item, {
-          className: classes.filterButton,
-          component: "div",
-          children: /*#__PURE__*/_jsx(Typography, {
-            variant: "subtitle2",
-            component: "span",
-            className: classes.filterButtonLabel,
-            children: /*#__PURE__*/_jsx(I18n.Text, {
-              string: "titles.filter"
-            })
-          })
-        }), /*#__PURE__*/_jsx(Grid.Item, {
-          component: "div",
-          children: /*#__PURE__*/_jsx(FilterIcon, {})
-        })]
+    children: [/*#__PURE__*/_jsx("span", {
+      className: classes.icon,
+      children: /*#__PURE__*/_jsx(FilterIcon, {})
+    }), /*#__PURE__*/_jsx(Typography, {
+      variant: "subtitle2",
+      component: "span",
+      children: /*#__PURE__*/_jsx(I18n.Text, {
+        string: "titles.filter"
       })
-    })
+    }), /*#__PURE__*/_jsx(Badge, {
+      count: filterCount,
+      max: 9,
+      "aria-hidden": true
+    })]
   });
 }
+FilterButton.defaultProps = {
+  filterCount: 0
+};
 export default FilterButton;

package/product/components/FilterBar/components/Content/components/FilterChips/components/FilterChip/index.d.ts

@@ -0,0 +1,38 @@
+import type { ReactNode } from 'react';
+export interface FilterChipProps {
+    /**
+     * Id of the filter value. Used as the test id and passed back to `onRemove`.
+     */
+    id: string;
+    /**
+     * The chip label.
+     */
+    children: ReactNode;
+    /**
+     * Whether the chip renders a remove button (default `true`).
+     */
+    removable?: boolean;
+    /**
+     * Aria label for the label button, which opens the filter page.
+     */
+    editLabel?: string;
+    /**
+     * Aria label for the remove button.
+     */
+    removeLabel?: string;
+    /**
+     * Invoked when the chip label is clicked.
+     */
+    onClick?: () => void;
+    /**
+     * Invoked with the chip id when the remove button is clicked.
+     */
+    onRemove?: (id: string) => void;
+}
+/**
+ * A removable chip representing one active filter within the filter bar.
+ * @returns The rendered component.
+ */
+declare const FilterChip: ({ id, children, removable, editLabel, removeLabel, onClick, onRemove, }: FilterChipProps) => import("react").JSX.Element;
+export default FilterChip;
+//# sourceMappingURL=index.d.ts.map

package/product/components/FilterBar/components/Content/components/FilterChips/components/FilterChip/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../../../../product/components/FilterBar/components/Content/components/FilterChips/components/FilterChip/index.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAiB,SAAS,EAAE,MAAM,OAAO,CAAC;AAwDtD,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC;CACjC;AAED;;;GAGG;AACH,QAAA,MAAM,UAAU,GAAI,yEAQjB,eAAe,gCAwBjB,CAAC;AAEF,eAAe,UAAU,CAAC"}

package/product/components/FilterBar/components/Content/components/FilterChips/components/FilterChip/index.js

@@ -0,0 +1,88 @@
+import { useCallback } from 'react';
+import noop from 'lodash/noop';
+import Button from '@shopgate/pwa-common/components/Button';
+import { CrossIcon } from '@shopgate/engage/components';
+import { makeStyles } from '@shopgate/engage/styles';
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+const useStyles = makeStyles()((theme, {
+  removable
+}) => ({
+  chip: {
+    display: 'flex',
+    alignItems: 'center',
+    minWidth: 0,
+    maxWidth: '72%',
+    height: 30,
+    borderRadius: theme.shape.borderRadius,
+    border: `1px solid ${theme.palette.secondary.main}`,
+    background: theme.palette.background.surface,
+    color: theme.palette.text.primary,
+    paddingLeft: removable ? theme.spacing(0.75) : theme.spacing(1.25),
+    paddingRight: theme.spacing(1.25),
+    outline: 0
+  },
+  name: {
+    ...theme.typography.body2,
+    fontWeight: theme.typography.fontWeightMedium,
+    display: 'block',
+    color: 'inherit',
+    padding: 0,
+    paddingLeft: removable ? theme.spacing(0.5) : 0,
+    maxWidth: '100%',
+    overflow: 'hidden',
+    textOverflow: 'ellipsis',
+    whiteSpace: 'nowrap'
+  },
+  removeButton: {
+    display: 'flex',
+    flexShrink: 0,
+    padding: 0,
+    color: theme.palette.secondary.main
+  }
+}));
+
+/**
+ * `Button` is untyped JavaScript whose optional props read as required from TypeScript.
+ */
+const ChipButton = Button;
+/**
+ * A removable chip representing one active filter within the filter bar.
+ * @returns The rendered component.
+ */
+const FilterChip = ({
+  id,
+  children,
+  removable = true,
+  editLabel,
+  removeLabel,
+  onClick = noop,
+  onRemove = noop
+}) => {
+  const {
+    classes
+  } = useStyles({
+    removable
+  });
+  const handleRemove = useCallback(() => {
+    onRemove(id);
+  }, [onRemove, id]);
+  return /*#__PURE__*/_jsxs("div", {
+    className: classes.chip,
+    "data-test-id": id,
+    children: [removable && /*#__PURE__*/_jsx(ChipButton, {
+      className: classes.removeButton,
+      onClick: handleRemove,
+      testId: "removeFilter",
+      "aria-label": removeLabel,
+      children: /*#__PURE__*/_jsx(CrossIcon, {
+        size: 16
+      })
+    }), /*#__PURE__*/_jsx(ChipButton, {
+      className: classes.name,
+      onClick: onClick,
+      "aria-label": editLabel,
+      children: children
+    })]
+  });
+};
+export default FilterChip;