@shopgate/engage 7.32.0-beta.4 → 7.32.0-beta.5

package/page/hooks/index.d.ts

@@ -1,60 +1,61 @@
-import type { WidgetContextType } from '../components/Widgets/WidgetContext';
-
+import { type WidgetContextType } from '@shopgate/engage/page/components/Widgets';
 /**
  * The useWidget hook provides access to the context that is wrapped around a widget.
  * @returns The widget context.
  */
-export declare function useWidget<C = Record<string, any>>(): WidgetContextType<C>
-
-
-export type UseWidgetProductsOptions = {
-  /**
-   * The search value to use for the product search
-   */
-  value: string;
-  /**
-   * The type of product search to perform.
-   */
-  type: 'searchTerm' | 'productIds' | 'brand' | 'category' | 'highlights';
-  /**
-   * The number of products to return per page.
-   * @default 32
-   */
-  limit?: number;
-  /**
-   * Sort order for the products
-   * @default 'relevance'
-   */
-  sort?: 'relevance' | 'priceAsc' | 'priceDesc' | 'nameAsc' | 'nameDesc';
-};
-
-export type UseWidgetProductsResult = {
-  /**
-   * Function to fetch the next page of products.
-   */
-  fetchNext: () => void;
-  /**
-   * Whether there are more products to fetch.
-   */
-  hasNext: boolean;
-  /**
-   * Whether the products are currently being fetched.
-   */
-  isFetching: boolean;
-  /**
-   * Number of products available in the current result set.
-   */
-  totalResultCount: number;
-  /**
-   * Array of product results.
-   */
-  results: Object[];
+export declare const useWidget: <C = Record<string, unknown>>() => WidgetContextType<C>;
+/**
+ * Options for the {@link useWidgetProducts} hook.
+ */
+export interface UseWidgetProductsOptions {
+    /**
+     * The search value to use for the product search.
+     */
+    value: string;
+    /**
+     * The type of product search to perform.
+     */
+    type: 'searchTerm' | 'productIds' | 'brand' | 'category' | 'highlights';
+    /**
+     * The number of products to return per page.
+     * @default 32
+     */
+    limit?: number;
+    /**
+     * Sort order for the products.
+     * @default 'relevance'
+     */
+    sort?: 'relevance' | 'priceAsc' | 'priceDesc' | 'nameAsc' | 'nameDesc';
+}
+/**
+ * Result of the {@link useWidgetProducts} hook.
+ */
+export interface UseWidgetProductsResult {
+    /**
+     * Function to fetch the next page of products.
+     */
+    fetchNext: () => void;
+    /**
+     * Whether there are more products to fetch.
+     */
+    hasNext: boolean;
+    /**
+     * Whether the products are currently being fetched.
+     */
+    isFetching: boolean;
+    /**
+     * Number of products available in the current result set.
+     */
+    totalResultCount: number;
+    /**
+     * Array of product results.
+     */
+    results: unknown[];
 }
-
 /**
- * The useWidgetProducts hook provides an easy way to retrieve products based on a search term or
- * other criteria.
+ * Retrieves the products for the current widget.
+ * @param options Hook options.
+ * @returns The products and a function to fetch more products.
  */
-export declare function useWidgetProducts(
-  options: UseWidgetProductsOptions
-): UseWidgetProductsResult;
+export declare const useWidgetProducts: (options?: UseWidgetProductsOptions) => UseWidgetProductsResult;
+//# sourceMappingURL=index.d.ts.map

package/page/hooks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../page/hooks/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAiB,KAAK,iBAAiB,EAAE,MAAM,0CAA0C,CAAC;AAMjG;;;GAGG;AACH,eAAO,MAAM,SAAS,GAAI,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAAK,iBAAiB,CAAC,CAAC,CAC1B,CAAC;AA2CpD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,YAAY,GAAG,YAAY,GAAG,OAAO,GAAG,UAAU,GAAG,YAAY,CAAC;IACxE;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,IAAI,CAAC,EAAE,WAAW,GAAG,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,UAAU,CAAC;CACxE;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,IAAI,CAAC;IACtB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,OAAO,EAAE,OAAO,EAAE,CAAC;CACpB;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,GAC5B,UAAS,wBAAyD,KACjE,uBAyIF,CAAC"}

package/page/hooks/index.js

@@ -6,21 +6,9 @@ import { transformDisplayOptions } from '@shopgate/engage/core/helpers';
 import { fetchProductsByQuery } from '@shopgate/engage/product';
 import { makeGetWidgetProducts } from "../selectors";
 
-/**
- * @typedef {import('../components/Widgets/WidgetContext').WidgetContextType WidgetContextType}
- */
-
-/**
- * @typedef {import('./index').UseWidgetProductsOptions} UseWidgetProductsOptions
- */
-
-/**
- * @typedef {import('./index').UseWidgetProductsResult} UseWidgetProductsResult
- */
-
 /**
  * The useWidget hook provides access to the context that is wrapped around a widget.
- * @returns {WidgetContextType} The widget context.
+ * @returns The widget context.
  */
 export const useWidget = () => useContext(WidgetContext);
 const REQUEST_TYPE_MAPPING = {
@@ -31,10 +19,27 @@ const REQUEST_TYPE_MAPPING = {
   category: 5
 };
 
+/**
+ * Shape of the memoized widget products selector result. The underlying selector and its
+ * dependencies live in untyped JS, so the shape is described here at the consumption boundary.
+ */
+
+/**
+ * Shape of the result returned by the (untyped) `fetchProductsByQuery` thunk.
+ */
+
+/**
+ * Options for the {@link useWidgetProducts} hook.
+ */
+
+/**
+ * Result of the {@link useWidgetProducts} hook.
+ */
+
 /**
  * Retrieves the products for the current widget.
- * @param {UseWidgetProductsOptions} options Hook options
- * @returns {UseWidgetProductsResult} The products and a function to fetch more products.
+ * @param options Hook options.
+ * @returns The products and a function to fetch more products.
  */
 export const useWidgetProducts = (options = {}) => {
   const {

package/page/selectors/index.d.ts

@@ -0,0 +1,32 @@
+export * from "@shopgate/pwa-common/selectors/page";
+export function makeGetPrivacyPolicyLink(): string | null;
+export function makeGetPage({ type, slug, }: {
+    type?: PageType | undefined;
+    slug?: string | null | undefined;
+}): Function;
+export function makeGetWidgetsFromPage({ type, slug, dropzone, }: {
+    type?: PageType | undefined;
+    dropzone?: "cmsWidgetList" | undefined;
+    slug?: string | null | undefined;
+}): Function;
+/**
+ * Determines whether the new CMS version 2 is enabled.
+ */
+export const getIsCms2Enabled: ((state: any, ...params: any) => boolean) & import("reselect").OutputSelectorFields<(args_0: boolean, args_1: boolean) => boolean, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
+export function makeGetUnifiedCMSPageData({ slug }: {
+    slug: string;
+}): Function;
+export function makeGetWidgetProducts(type: "searchTerm" | "productIds" | "brand" | "category" | "highlights", options: Object, id: string): Function;
+/**
+ * List of available page types.
+ */
+export type PageType = "cms" | "category";
+/**
+ * List of available dropzone types.
+ */
+export type DropzoneType = "cmsWidgetList";
+//# sourceMappingURL=index.d.ts.map

package/page/selectors/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../page/selectors/index.js"],"names":[],"mappings":";AAmCO,4CAFM,MAAM,GAAC,IAAI,CAuBvB;AAyBM,6CAJJ;IAA0B,IAAI;IACD,IAAI;CACjC,YAcF;AAYM,kEANJ;IAA0B,IAAI;IACA,QAAQ;IAET,IAAI;CACjC,YAqBF;AAED;;GAEG;AACH;;;;EAIE;AASK,oDAHJ;IAAuB,IAAI,EAAnB,MAAM;CACd,YAwCF;AA2FM,4CANI,YAAY,GAAG,YAAY,GAAG,OAAO,GAAG,UAAU,GAAE,YAAY,WAEhE,MAAM,MACN,MAAM,YAkBhB;;;;uBA5NY,KAAK,GAAG,UAAU;;;;2BAKlB,eAAe"}

package/page/widgets/Video/Video.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The VideoWidget is used to display a video.
+ */
+declare const Video: () => import("react").JSX.Element;
+export default Video;
+//# sourceMappingURL=Video.d.ts.map

package/page/widgets/Video/Video.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Video.d.ts","sourceRoot":"","sources":["../../../../page/widgets/Video/Video.tsx"],"names":[],"mappings":"AAGA;;GAEG;AACH,QAAA,MAAM,KAAK,mCAgBV,CAAC;AAEF,eAAe,KAAK,CAAC"}

package/page/widgets/Video/Video.js

@@ -1,10 +1,8 @@
-import React from 'react';
 import { useVideoWidget } from "./hooks";
 import WidgetVideo from "../../components/WidgetVideo";
 
 /**
  * The VideoWidget is used to display a video.
- * @returns {JSX.Element}
  */
 import { jsx as _jsx } from "react/jsx-runtime";
 const Video = () => {

package/page/widgets/Video/hooks.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Configuration of the Video widget.
+ */
+export interface VideoWidgetConfig {
+    /**
+     * The video URL.
+     */
+    url: string;
+    /**
+     * Whether the video should be muted.
+     */
+    muted?: boolean;
+    /**
+     * Whether the video should loop.
+     */
+    loop?: boolean;
+    /**
+     * Whether the video should display controls.
+     */
+    controls?: boolean;
+    /**
+     * Whether the video should autoplay.
+     */
+    autoplay?: boolean;
+    /**
+     * The border radius option.
+     */
+    borderRadius: 'default' | 'none' | 'rounded' | 'custom';
+    /**
+     * The custom border radius value.
+     */
+    borderRadiusCustom?: number;
+    /**
+     * The link URL.
+     */
+    link?: string;
+}
+/**
+ * Resolved data returned by {@link useVideoWidget}. Reuses the field docs from
+ * {@link VideoWidgetConfig} for the pass-through fields via `Pick`.
+ */
+export interface UseVideoWidgetResult extends Pick<VideoWidgetConfig, 'url' | 'muted' | 'loop' | 'controls' | 'autoplay' | 'link'> {
+    /**
+     * The resolved border radius value in pixels.
+     */
+    borderRadius: number;
+}
+/**
+ * Hook to access the Video widget configuration and data.
+ * @returns The resolved Video widget data.
+ */
+export declare const useVideoWidget: () => UseVideoWidgetResult;
+//# sourceMappingURL=hooks.d.ts.map

package/page/widgets/Video/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../../page/widgets/Video/hooks.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC;IACxD;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,IAAI,CAChD,iBAAiB,EACjB,KAAK,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,UAAU,GAAG,MAAM,CAC5D;IACC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,QAAO,oBAoBjC,CAAC"}

package/page/widgets/Video/hooks.js

@@ -2,27 +2,19 @@ import { useWidget } from '@shopgate/engage/page/hooks';
 import { resolveBorderRadiusFromWidgetConfig } from "../../helpers";
 
 /**
- * @typedef {Object} VideoWidgetConfig
- * @property {string} url The video URL.
- * @property {boolean} [muted] Whether the video should be muted.
- * @property {boolean} [loop] Whether the video should loop.
- * @property {boolean} [controls] Whether the video should display controls.
- * @property {boolean} [autoplay] Whether the video should autoplay.
- * @property {number} [borderRadius] The border radius preset.
- * @property {string} [link] The link URL.
+ * Configuration of the Video widget.
  */
 
 /**
- * @typedef {ReturnType< typeof import('@shopgate/engage/page/hooks')
- *   .useWidget<VideoWidgetConfig> >} UseWidgetReturnType
+ * Resolved data returned by {@link useVideoWidget}. Reuses the field docs from
+ * {@link VideoWidgetConfig} for the pass-through fields via `Pick`.
  */
 
-// eslint-disable-next-line valid-jsdoc
 /**
  * Hook to access the Video widget configuration and data.
+ * @returns The resolved Video widget data.
  */
 export const useVideoWidget = () => {
-  /** @type {UseWidgetReturnType}  */
   const {
     config
   } = useWidget();

package/page/widgets/Video/index.d.ts

@@ -0,0 +1,2 @@
+export { default } from './Video';
+//# sourceMappingURL=index.d.ts.map

package/page/widgets/Video/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../page/widgets/Video/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC"}

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

@@ -0,0 +1,2 @@
+export const WIDGET_ID: "@shopgate/engage/product/ProductGrid";
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../product/components/ProductGrid/constants.js"],"names":[],"mappings":"AAAA,wBAAyB,sCAAsC,CAAC"}

package/product/components/ProductGrid/constants.js

@@ -0,0 +1 @@
+export const WIDGET_ID = '@shopgate/engage/product/ProductGrid';

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

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ * - Before hydration, when the grid is rendered outside a page-builder widget
+ *   (Category / Search / legacy Products widget), the single legacy
+ *   `useWidgetSettings` scalar is honored flat across all breakpoints. This
+ *   reproduces the old theme grid and preserves the merchant's configured value.
+ * - Otherwise (inside a widget, pre-hydration) the built-in responsive default
+ *   from the app settings is used ({ xs: 2, md: 4 }), so the inherited legacy
+ *   `columns: 2` default no longer pins tablet to 2.
+ * @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":"AAYA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,qBAAqB,QAAO,MAwBxC,CAAC"}

package/product/components/ProductGrid/hooks.js

@@ -0,0 +1,49 @@
+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 { 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.
+ * - Before hydration, when the grid is rendered outside a page-builder widget
+ *   (Category / Search / legacy Products widget), the single legacy
+ *   `useWidgetSettings` scalar is honored flat across all breakpoints. This
+ *   reproduces the old theme grid and preserves the merchant's configured value.
+ * - Otherwise (inside a widget, pre-hydration) the built-in responsive default
+ *   from the app settings is used ({ xs: 2, md: 4 }), so the inherited legacy
+ *   `columns: 2` default no longer pins tablet to 2.
+ * @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 { xs: 2, md: 4 } until hydrated, the source value after.
+  const appSettingsColumns = useSelector(getProductGridColumns);
+  const {
+    columns: legacyColumns
+  } = useWidgetSettings(WIDGET_ID) || {};
+  const breakpoints = useMemo(() => {
+    // Only special case: pre-hydration, outside a widget, honor the legacy
+    // scalar flat across every breakpoint.
+    if (!areAppSettingsHydrated && !isInsideWidget && typeof legacyColumns === 'number') {
+      return {
+        xs: legacyColumns
+      };
+    }
+    return appSettingsColumns;
+  }, [areAppSettingsHydrated, isInsideWidget, legacyColumns, appSettingsColumns]);
+  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/ProductGrid/spec.js

@@ -23,6 +23,9 @@ jest.mock('@shopgate/engage/components', () => {
 jest.mock("./components/Iterator", () => function Iterator() {
   return null;
 });
+jest.mock("./hooks", () => ({
+  useProductGridColumns: jest.fn(() => 2)
+}));
 jest.mock('@shopgate/engage/product', () => ({
   ProductListTypeProvider: ({
     children

package/settings/reducers/appSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"appSettings.d.ts","sourceRoot":"","sources":["../../../settings/reducers/appSettings.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAG/E,KAAK,iBAAiB,GAAG,wBAAwB,GAAG,aAAa,CAAC;AAQlE;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,gBAalC,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,WAAW,EAAE,OAAO,CAAC,gBAAgB,EAAE,iBAAiB,CAW5D,CAAC;AAEH,eAAe,WAAW,CAAC"}
+{"version":3,"file":"appSettings.d.ts","sourceRoot":"","sources":["../../../settings/reducers/appSettings.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AACpD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAG/E,KAAK,iBAAiB,GAAG,wBAAwB,GAAG,aAAa,CAAC;AAQlE;;;GAGG;AACH,eAAO,MAAM,oBAAoB,EAAE,gBAqBlC,CAAC;AAEF;;;;;GAKG;AACH,QAAA,MAAM,WAAW,EAAE,OAAO,CAAC,gBAAgB,EAAE,iBAAiB,CAW5D,CAAC;AAEH,eAAe,WAAW,CAAC"}

package/settings/reducers/appSettings.js

@@ -19,6 +19,14 @@ export const DEFAULT_APP_SETTINGS = {
         borderEnabled: true
       }
     }
+  },
+  productList: {
+    grid: {
+      columns: {
+        xs: 2,
+        md: 4
+      }
+    }
   }
 };
 

package/settings/selectors/appSettings.d.ts

@@ -41,4 +41,12 @@ export declare const getTabBarSettings: ((state: AppSettingsState) => {
 }> & {
     clearCache: () => void;
 };
+/**
+ * Selects the ProductGrid columns setting (keyed by breakpoint).
+ */
+export declare const getProductGridColumns: ((state: AppSettingsState) => Partial<Record<import("../../styles/theme").Breakpoint, number>>) & import("reselect").OutputSelectorFields<(args_0: AppSettingsSlice) => Partial<Record<import("../../styles/theme").Breakpoint, number>>, {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
 //# sourceMappingURL=appSettings.d.ts.map

package/settings/selectors/appSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"appSettings.d.ts","sourceRoot":"","sources":["../../../settings/selectors/appSettings.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAG/E;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,OAAO,gBAAgB,KAAG,gBACR,CAAC;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB;;;;CAGrC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;CAG7B,CAAC"}
+{"version":3,"file":"appSettings.d.ts","sourceRoot":"","sources":["../../../settings/selectors/appSettings.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAG/E;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAAI,OAAO,gBAAgB,KAAG,gBACR,CAAC;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB;;;;CAGrC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;CAG7B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB;;;;CAGjC,CAAC"}

package/settings/selectors/appSettings.js

@@ -20,4 +20,9 @@ export const getAreAppSettingsHydrated = createSelector(getAppSettingsState, app
 /**
  * Selects the tab bar settings.
  */
-export const getTabBarSettings = createSelector(getAppSettingsState, appSettings => appSettings.navigation.tabBar);
+export const getTabBarSettings = createSelector(getAppSettingsState, appSettings => appSettings.navigation.tabBar);
+
+/**
+ * Selects the ProductGrid columns setting (keyed by breakpoint).
+ */
+export const getProductGridColumns = createSelector(getAppSettingsState, appSettings => appSettings.productList.grid.columns);

package/settings/types/appSettings.d.ts

@@ -1,8 +1,28 @@
+import type { Breakpoint } from '@shopgate/engage/styles/theme';
 export interface AppSettingsState {
     settings: {
         appSettings: AppSettingsSlice;
     };
 }
+/**
+ * Number of product columns to render, keyed by breakpoint. Partial: any unset
+ * breakpoint cascades down to the next smaller defined value (see
+ * useResponsiveValue).
+ */
+export type ProductColumns = Partial<Record<Breakpoint, number>>;
+/**
+ * Settings for the ProductGrid list type.
+ */
+export interface ProductGridSettings {
+    columns: ProductColumns;
+}
+/**
+ * Settings for the various product-list types. Add a key and its own settings
+ * interface per future type (e.g. slider).
+ */
+export interface ProductListSettings {
+    grid: ProductGridSettings;
+}
 export interface AppSettings {
     navigation: {
         tabBar: {
@@ -15,6 +35,7 @@ export interface AppSettings {
             };
         };
     };
+    productList: ProductListSettings;
 }
 /**
  * The stored app settings slice. Extends the raw {@link AppSettings} values

package/settings/types/appSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"appSettings.d.ts","sourceRoot":"","sources":["../../../settings/types/appSettings.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE;QACR,WAAW,EAAE,gBAAgB,CAAC;KAC/B,CAAC;CACH;AAED,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE;QACV,MAAM,EAAE;YACN,OAAO,EAAE,OAAO,GAAG,UAAU,CAAA;YAC7B,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;YAC7B,UAAU,EAAE,OAAO,CAAC;YACpB,YAAY,EAAE,OAAO,CAAC;YACtB,KAAK,EAAE;gBACL,aAAa,EAAE,OAAO,CAAC;aACxB,CAAA;SACF,CAAA;KACF,CAAA;CACF;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD;;;;OAIG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB"}
+{"version":3,"file":"appSettings.d.ts","sourceRoot":"","sources":["../../../settings/types/appSettings.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAEhE,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE;QACR,WAAW,EAAE,gBAAgB,CAAC;KAC/B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,cAAc,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,mBAAmB,CAAC;CAC3B;AAED,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE;QACV,MAAM,EAAE;YACN,OAAO,EAAE,OAAO,GAAG,UAAU,CAAA;YAC7B,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC;YAC7B,UAAU,EAAE,OAAO,CAAC;YACpB,YAAY,EAAE,OAAO,CAAC;YACtB,KAAK,EAAE;gBACL,aAAa,EAAE,OAAO,CAAC;aACxB,CAAA;SACF,CAAA;KACF,CAAA;IACD,WAAW,EAAE,mBAAmB,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,WAAW;IACnD;;;;OAIG;IACH,UAAU,EAAE,OAAO,CAAC;CACrB"}