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

package/filter/providers/FilterPageProvider.context.d.ts

@@ -0,0 +1,157 @@
+export default context;
+export type APIFilterValue = {
+    /**
+     * Filter value id
+     */
+    id: string;
+    /**
+     * Filter value label
+     */
+    label: string;
+    /**
+     * Number of hits for the filter value
+     */
+    hits: number;
+};
+export type APIFilter = {
+    /**
+     * Filter id
+     */
+    id: string;
+    /**
+     * Filter label
+     */
+    label: string;
+    /**
+     * Filter type
+     */
+    type: "range" | "multiselect" | "single_select";
+    /**
+     * Filter source
+     */
+    source?: string | undefined;
+    /**
+     * Minimum value for a range filter
+     */
+    minimum?: number | undefined;
+    /**
+     * Maximum value for a range filter
+     */
+    maximum?: number | undefined;
+    values: APIFilterValue[];
+};
+export type RouteFilterValue = {
+    /**
+     * Filter value id
+     */
+    id: string;
+    /**
+     * Filter value label
+     */
+    label: string;
+};
+export type RouteFilter = {
+    /**
+     * Filter id
+     */
+    id: string;
+    /**
+     * Filter label
+     */
+    label: string;
+    /**
+     * Filter source
+     */
+    source: string;
+    /**
+     * Filter type
+     */
+    type: "range" | "multiselect" | "single_select";
+    /**
+     * Selected values for the filter
+     */
+    values: RouteFilterValue[];
+};
+/**
+ * Object with the active filters for a route with filtered product list
+ */
+export type RouteFilters = {
+    [x: string]: RouteFilter;
+};
+export type GetSelectedFilterValuesFn = (filterId: string) => any;
+export type UpdateSelectedFilterValuesFn = (filterId: string, selectedValues: string[]) => void;
+export type FilterPageContext = {
+    /**
+     * Whether the filter selection has changed since the filters page
+     * was opened
+     */
+    hasChanged: boolean;
+    /**
+     * Whether a reset of the active filters is possible
+     */
+    resetPossible: boolean;
+    /**
+     * List of available filters from the API
+     */
+    apiFilters: APIFilter[];
+    /**
+     * Object that represents the current state of all filters
+     */
+    filters: RouteFilters;
+    /**
+     * Resets all filters which have been changed by the
+     * user
+     */
+    resetAllFilters: () => void;
+    /**
+     * Resets all filters which have been changed by the
+     * user since the filters page was opened
+     */
+    resetChangedFilters: () => void;
+    /**
+     * Applies the current filter selection to the parent route
+     * with a product list to be filtered
+     */
+    applyFilters: () => void;
+    /**
+     * Retrieves a list of currently
+     * selected values for a filter
+     */
+    getSelectedFilterValues: GetSelectedFilterValuesFn;
+    /**
+     * Updates the selection for a
+     * filter
+     */
+    updateSelectedFilterValues: UpdateSelectedFilterValuesFn;
+};
+/**
+ * @callback GetSelectedFilterValuesFn
+ * @param {string} filterId The id of the filter
+ */
+/**
+ * @callback UpdateSelectedFilterValuesFn
+ * @param {string} filterId The id of the filter to be updated
+ * @param {string[]} selectedValues The updated selected values
+ * @returns {void}
+ */
+/**
+ * @typedef {Object} FilterPageContext
+ * @property {boolean} hasChanged Whether the filter selection has changed since the filters page
+ * was opened
+ * @property {boolean} resetPossible Whether a reset of the active filters is possible
+ * @property {APIFilter[]} apiFilters List of available filters from the API
+ * @property {RouteFilters} filters Object that represents the current state of all filters
+ * @property {function():void} resetAllFilters Resets all filters which have been changed by the
+ * user
+ * @property {function():void} resetChangedFilters Resets all filters which have been changed by the
+ * user since the filters page was opened
+ * @property {function():void} applyFilters Applies the current filter selection to the parent route
+ * with a product list to be filtered
+ * @property {GetSelectedFilterValuesFn} getSelectedFilterValues Retrieves a list of currently
+ * selected values for a filter
+ * @property {UpdateSelectedFilterValuesFn} updateSelectedFilterValues Updates the selection for a
+ * filter
+ */
+/** @type {import('react').Context<FilterPageContext>} */
+declare const context: import("react").Context<FilterPageContext>;
+//# sourceMappingURL=FilterPageProvider.context.d.ts.map

package/filter/providers/FilterPageProvider.context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilterPageProvider.context.d.ts","sourceRoot":"","sources":["../../../filter/providers/FilterPageProvider.context.js"],"names":[],"mappings":";;;;;QAKc,MAAM;;;;WACN,MAAM;;;;UACN,MAAM;;;;;;QAMN,MAAM;;;;WACN,MAAM;;;;UACN,OAAO,GAAC,aAAa,GAAC,eAAe;;;;;;;;;;;;;YAIrC,cAAc,EAAE;;;;;;QAMhB,MAAM;;;;WACN,MAAM;;;;;;QAKN,MAAM;;;;WACN,MAAM;;;;YACN,MAAM;;;;UACN,OAAO,GAAC,aAAa,GAAC,eAAe;;;;YACrC,gBAAgB,EAAE;;;;;;;;mDAWrB,MAAM;sDAKN,MAAM,kBACN,MAAM,EAAE,KACN,IAAI;;;;;;gBAIH,OAAO;;;;mBAEP,OAAO;;;;gBACP,SAAS,EAAE;;;;aACX,YAAY;;;;;qBACZ,MAAW,IAAI;;;;;yBAEf,MAAW,IAAI;;;;;kBAEf,MAAW,IAAI;;;;;6BAEf,yBAAyB;;;;;gCAEzB,4BAA4B;;AA1B1C;;;GAGG;AAEH;;;;;GAKG;AACH;;;;;;;;;;;;;;;;;GAiBG;AAEH,yDAAyD;AACzD,uBADW,OAAO,OAAO,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAWlD"}

package/filter/providers/FilterPageProvider.d.ts

@@ -0,0 +1,24 @@
+import type { ReactNode } from 'react';
+import type { APIFilter, RouteFilters } from './FilterPageProvider.context';
+interface FilterPageProviderProps {
+    /** Array of available filters, injected from Redux. */
+    filters?: APIFilter[] | null;
+    /** Object with the active filters for a filtered product list. */
+    activeFilters?: RouteFilters | null;
+    /** Id of the route with the product list that's supposed to be filtered. */
+    parentRouteId?: string | null;
+    /** Callback invoked when users pressed the apply button. */
+    onApply?: (filters: RouteFilters | null) => void;
+    /** Provider children. */
+    children?: ReactNode;
+}
+declare const _default: import("react-redux").ConnectedComponent<({ filters: filtersProp, activeFilters: activeFiltersProp, parentRouteId, onApply, children, }: FilterPageProviderProps) => import("react").JSX.Element, {
+    children?: ReactNode;
+    activeFilters?: (RouteFilters | null) | undefined;
+    parentRouteId?: string | null | undefined;
+    onApply?: ((filters: RouteFilters | null) => void) | undefined;
+    context?: import("react-redux/es/components/Context").ReactReduxContextInstance | undefined;
+    store?: import("redux").Store | undefined;
+}>;
+export default _default;
+//# sourceMappingURL=FilterPageProvider.d.ts.map

package/filter/providers/FilterPageProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FilterPageProvider.d.ts","sourceRoot":"","sources":["../../../filter/providers/FilterPageProvider.tsx"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAkB,SAAS,EAAE,MAAM,OAAO,CAAC;AASvD,OAAO,KAAK,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAyC5E,UAAU,uBAAuB;IAC/B,uDAAuD;IACvD,OAAO,CAAC,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IAC7B,kEAAkE;IAClE,aAAa,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IACpC,4EAA4E;IAC5E,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,4DAA4D;IAC5D,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,KAAK,IAAI,CAAC;IACjD,yBAAyB;IACzB,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;iKAoCE,uBAAuB;;qBA3CR,YAAY,GAAG,IAAI;oBAEnB,MAAM,GAAG,IAAI;eAEnB,CAAC,OAAO,EAAE,YAAY,GAAG,IAAI,KAAK,IAAI;;;;AAiQlD,wBAKsB"}

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.16",
   "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.16",
+    "@shopgate/pwa-common-commerce": "7.32.0-beta.16",
+    "@shopgate/pwa-core": "7.32.0-beta.16",
+    "@shopgate/pwa-ui-ios": "7.32.0-beta.16",
+    "@shopgate/pwa-ui-material": "7.32.0-beta.16",
+    "@shopgate/pwa-ui-shared": "7.32.0-beta.16",
     "@stripe/react-stripe-js": "^1.16.5",
     "@stripe/stripe-js": "^1.44.1",
     "@virtuous/conductor": "~2.5.0",

package/page/widgets/CategoryList/CategoryList.js

@@ -6,7 +6,8 @@ import WidgetHeadline from "../../components/WidgetHeadline";
 import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
 const useStyles = makeStyles()(theme => ({
   headline: {
-    paddingBottom: theme.spacing(0)
+    paddingBottom: theme.spacing(0),
+    background: theme.palette.background.surface
   }
 }));