@shopgate/engage 7.32.0-beta.2 → 7.32.0-beta.20

package/product/components/ProductGrid/hooks.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Resolves the number of product columns for the ProductGrid, keyed by the
+ * active breakpoint.
+ *
+ * Precedence:
+ * - Once the app settings are hydrated from a source (admin sync / jsonp), they
+ *   are authoritative everywhere.
+ * @returns The resolved number of columns for the active breakpoint.
+ */
+export declare const useProductGridColumns: () => number;
+//# sourceMappingURL=hooks.d.ts.map

package/product/components/ProductGrid/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../../product/components/ProductGrid/hooks.ts"],"names":[],"mappings":"AAiBA;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,QAAO,MAmCxC,CAAC"}

package/product/components/ProductGrid/hooks.js

@@ -0,0 +1,48 @@
+import "core-js/modules/es.array.reduce.js";
+import { useContext, useMemo } from 'react';
+import { useSelector } from 'react-redux';
+import { WidgetContext } from '@shopgate/engage/page/components/Widgets/WidgetContext';
+import { useWidgetSettings } from '@shopgate/engage/core/hooks';
+import { useResponsiveValue } from '@shopgate/engage/styles';
+import { getAreAppSettingsHydrated, getProductGridColumns } from '@shopgate/engage/settings/selectors/appSettings';
+import { SCREEN_SIZE_BREAKPOINTS } from '@shopgate/engage/settings/constants/appSettings';
+import { WIDGET_ID } from "./constants";
+
+/**
+ * Resolves the number of product columns for the ProductGrid, keyed by the
+ * active breakpoint.
+ *
+ * Precedence:
+ * - Once the app settings are hydrated from a source (admin sync / jsonp), they
+ *   are authoritative everywhere.
+ * @returns The resolved number of columns for the active breakpoint.
+ */
+export const useProductGridColumns = () => {
+  // Widget-scope detection: the WidgetContext carries a `code` only when the
+  // grid renders inside a page-builder widget (WidgetProvider).
+  const {
+    code: widgetCode
+  } = useContext(WidgetContext);
+  const isInsideWidget = Boolean(widgetCode);
+  const areAppSettingsHydrated = useSelector(getAreAppSettingsHydrated);
+  // The built-in default { small: 2, large: 4 } until hydrated, the source value after.
+  const appSettingsColumns = useSelector(getProductGridColumns);
+  const {
+    columns: legacyColumns
+  } = useWidgetSettings(WIDGET_ID) || {};
+  const sizes = useMemo(() => {
+    // Only special case: pre-hydration, outside a widget, honor the legacy
+    // scalar flat across every breakpoint.
+    if (!areAppSettingsHydrated && !isInsideWidget && typeof legacyColumns === 'number') {
+      return {
+        small: legacyColumns
+      };
+    }
+    return appSettingsColumns;
+  }, [areAppSettingsHydrated, isInsideWidget, legacyColumns, appSettingsColumns]);
+  const breakpoints = useMemo(() => Object.entries(sizes).reduce((acc, [size, value]) => {
+    acc[SCREEN_SIZE_BREAKPOINTS[size]] = value;
+    return acc;
+  }, {}), [sizes]);
+  return useResponsiveValue(breakpoints);
+};

package/product/components/ProductGrid/index.js

@@ -4,11 +4,11 @@ import PropTypes from 'prop-types';
 import { ViewContext, InfiniteContainer, LoadingIndicator } from '@shopgate/engage/components';
 import { ProductListTypeProvider } from '@shopgate/engage/product';
 import { ITEMS_PER_LOAD } from '@shopgate/engage/core/constants';
-import { useResponsiveValue } from '@shopgate/engage/styles';
 import Iterator from "./components/Iterator";
 import Layout from "./components/Layout";
+import { useProductGridColumns } from "./hooks";
 import { jsx as _jsx } from "react/jsx-runtime";
-export const WIDGET_ID = '@shopgate/engage/product/ProductGrid';
+export { WIDGET_ID } from "./constants";
 
 /**
  * The Product Grid component.
@@ -46,10 +46,7 @@ const ProductGrid = ({
   const {
     getContentRef
   } = useContext(ViewContext);
-  const columns = useResponsiveValue({
-    xs: 2,
-    md: 4
-  });
+  const columns = useProductGridColumns();
   if (!infiniteLoad) {
     return /*#__PURE__*/_jsx(Layout, {
       columns: columns,

package/product/components/ProductGridPrice/index.js

@@ -7,12 +7,8 @@ import { makeStyles } from '@shopgate/engage/styles';
 import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
 const useStyles = makeStyles()(theme => ({
   priceWrapper: {
-    marginTop: 4,
     alignItems: 'center'
   },
-  strikedPrice: {
-    fontSize: theme.typography.caption.fontSize
-  },
   basicPrice: {
     fontSize: theme.typography.body2.fontSize
   }
@@ -49,13 +45,11 @@ const ProductGridPrice = ({
         })
       }), price.msrp > 0 && price.unitPrice !== price.msrp && /*#__PURE__*/_jsx(Grid.Item, {
         children: /*#__PURE__*/_jsx(PriceStriked, {
-          className: classes.strikedPrice,
           value: price.msrp,
           currency: price.currency
         })
       }), !price.msrp && price.unitPriceStriked > 0 && price.unitPrice !== price.unitPriceStriked && /*#__PURE__*/_jsx(Grid.Item, {
         children: /*#__PURE__*/_jsx(PriceStriked, {
-          className: classes.strikedPrice,
           value: price.unitPriceStriked,
           currency: price.currency
         })

package/product/components/ProductImage/ProductImage.d.ts

@@ -0,0 +1,42 @@
+import type { ImageProps } from '@shopgate/pwa-common/components/Image';
+import type { ImageResolution, ProductImageContext } from '@shopgate/engage/settings/types/appSettings';
+/**
+ * Everything the underlying Image accepts is forwarded, minus the two this component owns:
+ * `backgroundColor`, derived from `noBackground`, and `placeholder`.
+ */
+export interface ProductImageProps extends Omit<ImageProps, 'backgroundColor' | 'placeholder'> {
+    /**
+     * The surface this image is rendered on. Determines the resolutions and aspect ratio, which are
+     * configured app wide. Ignored when an explicit `resolutions` prop is passed.
+     */
+    context?: ProductImageContext | null;
+    /**
+     * Drops the background behind the image.
+     */
+    noBackground?: boolean;
+    /**
+     * Image to show instead of the placeholder icon. The shop wide setting wins over this.
+     */
+    placeholderSrc?: string | null;
+    /**
+     * @deprecated Pass a `context` instead, so the image follows the configured aspect ratio.
+     */
+    ratio?: number[] | null;
+    /**
+     * @deprecated Pass a `context` instead, so the image follows the configured aspect ratio.
+     * Still honored, and still takes precedence over `context`.
+     */
+    resolutions?: ImageResolution[];
+}
+/**
+ * The product image component.
+ *
+ * Behaves like the core Image component, with a product placeholder for a missing or failed image.
+ * @param props The component props.
+ * @returns The rendered component.
+ */
+declare const ProductImage: (props: ProductImageProps) => import("react").JSX.Element;
+export { ProductImage as UnwrappedProductImage };
+declare const _default: import("react").MemoExoticComponent<(props: ProductImageProps) => import("react").JSX.Element>;
+export default _default;
+//# sourceMappingURL=ProductImage.d.ts.map

package/product/components/ProductImage/ProductImage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProductImage.d.ts","sourceRoot":"","sources":["../../../../product/components/ProductImage/ProductImage.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AAMxE,OAAO,KAAK,EACV,eAAe,EACf,mBAAmB,EACpB,MAAM,6CAA6C,CAAC;AA0BrD;;;GAGG;AACH,MAAM,WAAW,iBAAkB,SAAQ,IAAI,CAAC,UAAU,EAAE,iBAAiB,GAAG,aAAa,CAAC;IAC5F;;;OAGG;IACH,OAAO,CAAC,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACrC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IACxB;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;CACjC;AAuCD;;;;;;GAMG;AACH,QAAA,MAAM,YAAY,GAAI,OAAO,iBAAiB,gCA4E7C,CAAC;AAEF,OAAO,EAAE,YAAY,IAAI,qBAAqB,EAAE,CAAC;oEAOX,iBAAiB;AAOvD,wBAA2C"}

package/product/components/ProductImage/ProductImage.js

@@ -0,0 +1,158 @@
+import { useLayoutEffect, useMemo, memo } from 'react';
+import { useSelector } from 'react-redux';
+import { logger } from '@shopgate/pwa-core';
+import Image from '@shopgate/pwa-common/components/Image';
+import PlaceholderIcon from '@shopgate/pwa-ui-shared/icons/PlaceholderIcon';
+import SurroundPortals from '@shopgate/pwa-common/components/SurroundPortals';
+import { makeStyles, useTheme } from '@shopgate/engage/styles';
+import { useProductImageSettings } from '@shopgate/engage/settings/hooks';
+import { getProductImagePlaceholder } from '@shopgate/engage/settings/selectors/shopSettings';
+import { PORTAL_PRODUCT_IMAGE } from "../../../components/constants";
+import ProductImagePlaceholder from "./ProductImagePlaceholder";
+import { useProductImageShadow } from "./hooks";
+import { jsx as _jsx } from "react/jsx-runtime";
+const placeholderIconScale = 0.65;
+
+/**
+ * The context applied when a caller passes neither a context nor explicit resolutions.
+ */
+const DEFAULT_PRODUCT_IMAGE_CONTEXT = 'list';
+
+/**
+ * The resolutions and aspect ratio the image is rendered with.
+ */
+
+/**
+ * Everything the underlying Image accepts is forwarded, minus the two this component owns:
+ * `backgroundColor`, derived from `noBackground`, and `placeholder`.
+ */
+
+const useStyles = makeStyles()(theme => ({
+  rounded: {
+    borderRadius: theme.components.productImage.borderRadius,
+    overflow: 'hidden'
+  },
+  placeholderContent: {
+    position: 'absolute',
+    width: '100%',
+    height: '100%',
+    top: 0,
+    textAlign: 'center'
+  },
+  placeholder: {
+    position: 'absolute',
+    width: `${placeholderIconScale * 100}% !important`,
+    height: `${placeholderIconScale * 100}% !important`,
+    top: `${(1.0 - placeholderIconScale) * 50}%`,
+    left: `${(1.0 - placeholderIconScale) * 50}%`,
+    color: theme.palette.background.emphasized
+  },
+  innerShadow: {
+    position: 'relative',
+    overflow: 'hidden',
+    ':after': {
+      display: 'block',
+      content: '""',
+      position: 'absolute',
+      top: 0,
+      right: 0,
+      bottom: 0,
+      left: 0,
+      boxShadow: 'inset 0 0 20px rgba(0, 0, 0, .05)',
+      pointerEvents: 'none'
+    }
+  }
+}));
+
+/**
+ * The product image component.
+ *
+ * Behaves like the core Image component, with a product placeholder for a missing or failed image.
+ * @param props The component props.
+ * @returns The rendered component.
+ */
+const ProductImage = props => {
+  const {
+    alt = null,
+    className = null,
+    context = null,
+    noBackground = false,
+    placeholderSrc = null,
+    ratio = null,
+    resolutions = null,
+    src = null
+  } = props;
+  const productImageSettings = useProductImageSettings();
+
+  // An explicit resolutions prop wins over the context, which is only consulted without one.
+  const resolved = useMemo(() => {
+    if (resolutions) {
+      return {
+        resolutions,
+        ratio
+      };
+    }
+    return productImageSettings[context || DEFAULT_PRODUCT_IMAGE_CONTEXT] ?? productImageSettings[DEFAULT_PRODUCT_IMAGE_CONTEXT];
+  }, [context, productImageSettings, ratio, resolutions]);
+  useLayoutEffect(() => {
+    logger.assert(!(resolutions && context), 'ProductImage received both "resolutions" and "context". The explicit resolutions win - drop one of them.');
+    /* eslint-disable-next-line react-hooks/exhaustive-deps -- legacy: assert once at mount */
+  }, []);
+  const {
+    classes,
+    cx
+  } = useStyles();
+  const theme = useTheme();
+  const showInnerShadow = useProductImageShadow();
+  const isRounded = (context || DEFAULT_PRODUCT_IMAGE_CONTEXT) === 'list';
+
+  // Image decides when to show this.
+  const placeholder = placeholderSrc ? /*#__PURE__*/_jsx(ProductImagePlaceholder, {
+    src: placeholderSrc,
+    showInnerShadow: showInnerShadow,
+    noBackground: noBackground
+  }) : /*#__PURE__*/_jsx("div", {
+    "aria-hidden": true,
+    className: classes.placeholderContent,
+    "data-test-id": "placeHolder",
+    children: /*#__PURE__*/_jsx(PlaceholderIcon, {
+      className: classes.placeholder
+    })
+  });
+  return /*#__PURE__*/_jsx(SurroundPortals, {
+    portalName: PORTAL_PRODUCT_IMAGE,
+    portalProps: src ? {
+      src,
+      resolutions: resolved.resolutions,
+      ratio: resolved.ratio
+    } : undefined,
+    children: /*#__PURE__*/_jsx("div", {
+      className: cx(isRounded && classes.rounded, className, 'engage__product__product-image'),
+      children: /*#__PURE__*/_jsx(Image, {
+        ...props,
+        resolutions: resolved.resolutions,
+        ratio: resolved.ratio,
+        placeholder: placeholder,
+        className: showInnerShadow ? classes.innerShadow : '',
+        backgroundColor: noBackground ? 'transparent' : theme.palette.common.white,
+        "aria-hidden": !alt
+      })
+    })
+  });
+};
+export { ProductImage as UnwrappedProductImage };
+
+/**
+ * Supplies the shop wide placeholder image.
+ * @param props The component props.
+ * @returns The rendered component.
+ */
+const ConnectedProductImage = props => {
+  // The shop wide placeholder takes precedence over a passed one.
+  const placeholderSrc = useSelector(getProductImagePlaceholder) ?? props.placeholderSrc ?? null;
+  return /*#__PURE__*/_jsx(ProductImage, {
+    ...props,
+    placeholderSrc: placeholderSrc
+  });
+};
+export default /*#__PURE__*/memo(ConnectedProductImage);

package/product/components/ProductImage/ProductImagePlaceholder.d.ts

@@ -0,0 +1,23 @@
+export interface ProductImagePlaceholderProps {
+    /**
+     * Drops the background behind the placeholder.
+     */
+    noBackground?: boolean;
+    /**
+     * Whether the placeholder gets an inset shadow, matching the image it stands in for.
+     */
+    showInnerShadow?: boolean;
+    /**
+     * The merchant configured placeholder image. While it loads, and when it is absent, the
+     * built-in icon is shown instead.
+     */
+    src?: string | null;
+}
+/**
+ * The ProductImagePlaceholder component.
+ * @param props The components props.
+ * @returns The rendered component.
+ */
+declare const ProductImagePlaceholder: (props: ProductImagePlaceholderProps) => import("react").JSX.Element;
+export default ProductImagePlaceholder;
+//# sourceMappingURL=ProductImagePlaceholder.d.ts.map

package/product/components/ProductImage/ProductImagePlaceholder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProductImagePlaceholder.d.ts","sourceRoot":"","sources":["../../../../product/components/ProductImage/ProductImagePlaceholder.tsx"],"names":[],"mappings":"AAMA,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACrB;AAqCD;;;;GAIG;AACH,QAAA,MAAM,uBAAuB,GAAI,OAAO,4BAA4B,gCAwCnE,CAAC;AAEF,eAAe,uBAAuB,CAAC"}

package/product/components/ProductImage/ProductImagePlaceholder.js

@@ -1,5 +1,4 @@
-import React, { useEffect, useMemo, useState } from 'react';
-import PropTypes from 'prop-types';
+import { useEffect, useMemo, useState } from 'react';
 import PlaceholderIcon from '@shopgate/pwa-ui-shared/icons/PlaceholderIcon';
 import { makeStyles, useTheme } from '@shopgate/engage/styles';
 import { useLoadImage } from '@shopgate/engage/core';
@@ -40,14 +39,15 @@ const useStyles = makeStyles()(theme => ({
 
 /**
  * The ProductImagePlaceholder component.
- * @param {Object} props The components props.
- * @returns {JSX}
+ * @param props The components props.
+ * @returns The rendered component.
  */
-const ProductImagePlaceholder = ({
-  src,
-  showInnerShadow,
-  noBackground
-}) => {
+const ProductImagePlaceholder = props => {
+  const {
+    src = null,
+    showInnerShadow = false,
+    noBackground = false
+  } = props;
   const {
     classes,
     cx
@@ -65,14 +65,14 @@ const ProductImagePlaceholder = ({
         backgroundSize: 'contain',
         backgroundRepeat: 'no-repeat',
         backgroundPosition: 'center',
-        backgroundColor: noBackground ? 'transparent' : theme.palette.background.surface,
+        backgroundColor: noBackground ? 'transparent' : theme.palette.common.white,
         position: 'absolute'
       };
     }
     return {
-      backgroundColor: noBackground ? 'transparent' : theme.palette.background.surface
+      backgroundColor: noBackground ? 'transparent' : theme.palette.common.white
     };
-  }, [srcLoaded, noBackground, theme.palette.background.surface, src]);
+  }, [srcLoaded, noBackground, theme.palette.common.white, src]);
   const contentClasses = cx(classes.placeholderContent, {
     [classes.innerShadow]: showInnerShadow
   });
@@ -85,9 +85,4 @@ const ProductImagePlaceholder = ({
     }), !showPlaceholder && ' ']
   });
 };
-ProductImagePlaceholder.defaultProps = {
-  src: null,
-  noBackground: false,
-  showInnerShadow: false
-};
 export default ProductImagePlaceholder;

package/product/components/ProductImage/constants.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The widget id the legacy inner shadow setting is configured under.
+ *
+ * Extracted so the resolution hook can read it without importing the component.
+ */
+export declare const WIDGET_ID = "@shopgate/engage/product/ProductImage";
+//# sourceMappingURL=constants.d.ts.map

package/product/components/ProductImage/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../product/components/ProductImage/constants.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,SAAS,0CAA0C,CAAC"}

package/product/components/ProductImage/constants.js

@@ -0,0 +1,6 @@
+/**
+ * The widget id the legacy inner shadow setting is configured under.
+ *
+ * Extracted so the resolution hook can read it without importing the component.
+ */
+export const WIDGET_ID = '@shopgate/engage/product/ProductImage';

package/product/components/ProductImage/hooks.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Resolves whether product images render with an inset shadow.
+ * @param widgetId The widget id the legacy setting is configured under, for the product image
+ * components that have their own.
+ * @returns Whether to render the shadow.
+ */
+export declare const useProductImageShadow: (widgetId?: string) => boolean;
+//# sourceMappingURL=hooks.d.ts.map

package/product/components/ProductImage/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../../product/components/ProductImage/hooks.ts"],"names":[],"mappings":"AAYA;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAAI,WAAU,MAAkB,KAAG,OAiBpE,CAAC"}

package/product/components/ProductImage/hooks.js

@@ -0,0 +1,32 @@
+import { useMemo } from 'react';
+import { useSelector } from 'react-redux';
+// Imported via its module path rather than the "core/hooks" barrel, to keep this out of the
+// import cycle the barrel pulls in.
+import { useWidgetSettings } from '@shopgate/engage/core/hooks/useWidgetSettings';
+import { getAreAppSettingsHydrated, getImageSettings } from '@shopgate/engage/settings/selectors/appSettings';
+import { DEFAULT_SHOW_INNER_SHADOW } from '@shopgate/engage/settings/constants/imageSettings';
+import { WIDGET_ID } from "./constants";
+
+/**
+ * Resolves whether product images render with an inset shadow.
+ * @param widgetId The widget id the legacy setting is configured under, for the product image
+ * components that have their own.
+ * @returns Whether to render the shadow.
+ */
+export const useProductImageShadow = (widgetId = WIDGET_ID) => {
+  const areAppSettingsHydrated = useSelector(getAreAppSettingsHydrated);
+  const configured = useSelector(getImageSettings)?.product?.showInnerShadow;
+  const {
+    showInnerShadow: legacy
+  } = useWidgetSettings(widgetId) || {};
+  return useMemo(() => {
+    if (areAppSettingsHydrated) {
+      return configured ?? DEFAULT_SHOW_INNER_SHADOW;
+    }
+
+    // Until a source hydrates the app settings the legacy widget configuration wins, and failing
+    // that the built-in default, which is derived from the legacy app config flag so that each
+    // theme keeps its own behavior.
+    return legacy ?? DEFAULT_SHOW_INNER_SHADOW;
+  }, [areAppSettingsHydrated, configured, legacy]);
+};

package/product/components/ProductImage/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from './ProductImage';
+export type { ProductImageProps } from './ProductImage';
+//# sourceMappingURL=index.d.ts.map

package/product/components/ProductImage/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../product/components/ProductImage/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACzC,YAAY,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC"}