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

package/page/components/Widgets/hooks.d.ts

@@ -0,0 +1,13 @@
+import { type WidgetsPreviewContextType } from './WidgetsPreviewContext';
+/**
+ * Hook to handle communication with the parent window in a page preview iframe.
+ * @param isActive Whether the preview communication is active.
+ */
+export declare const usePreviewIframeCommunication: (isActive?: boolean) => void;
+/**
+ * The useWidgetsPreview hook provides access to the context that is wrapped around the Widgets
+ * component when it's rendered in preview mode.
+ * @returns The widget preview context.
+ */
+export declare const useWidgetsPreview: () => WidgetsPreviewContextType;
+//# sourceMappingURL=hooks.d.ts.map

package/page/components/Widgets/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../../../../page/components/Widgets/hooks.ts"],"names":[],"mappings":"AAcA,OAAO,EAEL,KAAK,yBAAyB,EAC/B,MAAM,yBAAyB,CAAC;AAoBjC;;;GAGG;AACH,eAAO,MAAM,6BAA6B,GAAI,kBAAgB,SA8G7D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,QAAO,yBAA8D,CAAC"}

package/page/components/Widgets/hooks.js

@@ -10,9 +10,13 @@ import { getScrollContainer } from "./helpers";
 import { WidgetsPreviewContext } from "./WidgetsPreviewContext";
 import { dispatchWidgetPreviewEvent, useWidgetPreviewEvent } from "./events";
 
+/**
+ * Message payload exchanged with the parent window in the page preview iframe.
+ */
+
 /**
  * Hook to handle communication with the parent window in a page preview iframe.
- * @param {boolean} isActive Whether the preview communication is active.
+ * @param isActive Whether the preview communication is active.
  */
 export const usePreviewIframeCommunication = (isActive = false) => {
   const dispatch = useDispatch();
@@ -32,17 +36,24 @@ export const usePreviewIframeCommunication = (isActive = false) => {
   const {
     sendToParent
   } = useIframeMessenger(data => {
+    // Allowed parents can also emit unrelated messages with arbitrary payloads.
+    if (typeof data !== 'object' || data === null) {
+      return;
+    }
     if (data.type === 'receivePageConfig') {
       // Page preview config received from the parent window.
       dispatch(receivePageConfigV2({
         type: 'cms',
         slug: PAGE_PREVIEW_SLUG,
-        data: data.payload
+        data: data.payload ?? {}
       }));
     } else if (data.type === 'scrollToWidget' && data.payload?.widgetCode) {
       // Parent window requested to scroll to a specific widget.
+      const {
+        widgetCode
+      } = data.payload;
       const scrollContainer = getScrollContainer();
-      const target = scrollContainer.querySelector(`#widget-code-${data.payload.widgetCode}`);
+      const target = scrollContainer?.querySelector(`#widget-code-${widgetCode}`);
       if (scrollContainer && target) {
         let marginTop = 0;
         if (considerVerticalMargins) {
@@ -56,13 +67,13 @@ export const usePreviewIframeCommunication = (isActive = false) => {
         const actualScrollTop = Math.min(scrollOffset, maxScrollTop);
 
         // Register the target element as the active widget.
-        dispatchWidgetPreviewEvent('set-active-widget-id', data.payload.widgetCode);
+        dispatchWidgetPreviewEvent('set-active-widget-id', widgetCode);
 
         /**
          * Callback to highlight the widget after scrolling.
          */
         const highlightWidget = () => {
-          dispatchWidgetPreviewEvent('highlight-widget', data.payload.widgetCode);
+          dispatchWidgetPreviewEvent('highlight-widget', widgetCode);
         };
 
         // Add listener to onScrollEnd if available, otherwise use scroll event.
@@ -103,7 +114,7 @@ export const usePreviewIframeCommunication = (isActive = false) => {
         });
       }
     }
-  }, ALLOWED_ADMIN_PREVIEW_ORIGINS);
+  }, ALLOWED_ADMIN_PREVIEW_ORIGINS, isActive);
   useWidgetPreviewEvent('widget-clicked', e => {
     if (!isActive) {
       return;
@@ -117,14 +128,9 @@ export const usePreviewIframeCommunication = (isActive = false) => {
   });
 };
 
-/**
- * @typedef {import('./WidgetsPreviewContext.js').WidgetsPreviewContextType}
- * WidgetsPreviewContextType
- */
-
 /**
  * The useWidgetsPreview hook provides access to the context that is wrapped around the Widgets
  * component when it's rendered in preview mode.
- * @returns {WidgetsPreviewContextType} The widget context.
+ * @returns The widget preview context.
  */
 export const useWidgetsPreview = () => useContext(WidgetsPreviewContext);

package/page/components/Widgets/index.d.ts

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

package/page/components/Widgets/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../page/components/Widgets/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,aAAa,EAAE,KAAK,iBAAiB,EAAE,MAAM,iBAAiB,CAAC"}

package/page/components/Widgets/types.d.ts

@@ -1,132 +1,156 @@
+import { type MediaMarginSettings } from '@shopgate/engage/settings/types/appSettings';
 /**
  * Visibility settings for a widget.
  */
 export interface WidgetDefinitionVisibility {
-  /**
-   * Whether the widget is hidden.
-   */
-  isHidden: boolean;
-  /**
-   * Start date for scheduled widgets.
-   */
-  scheduleStartDate: string;
-  /**
-   * End date for scheduled widgets.
-   */
-  scheduleEndDate: string
+    /**
+     * Whether the widget is hidden.
+     */
+    isHidden: boolean;
+    /**
+     * Start date for scheduled widgets.
+     */
+    scheduleStartDate: string;
+    /**
+     * End date for scheduled widgets.
+     */
+    scheduleEndDate: string;
 }
-
 /**
- * Layout settings for a widget.
+ * Layout settings for a widget. A side is null when it has no own configuration.
  */
 export interface WidgetDefinitionLayout {
-  /**
-   * Top margin for the widget.
-   */
-  marginTop: number;
-  /**
-   * Bottom margin for the widget.
-   */
-  marginBottom: number;
-  /**
-   * Left margin for the widget.
-   */
-  marginLeft: number;
-  /**
-   * Right margin for the widget.
-   */
-  marginRight: number;
+    /**
+     * Top margin for the widget.
+     */
+    marginTop: number | null;
+    /**
+     * Bottom margin for the widget.
+     */
+    marginBottom: number | null;
+    /**
+     * Left margin for the widget.
+     */
+    marginLeft: number | null;
+    /**
+     * Right margin for the widget.
+     */
+    marginRight: number | null;
+}
+/**
+ * Margins of a widget container after resolution. Every side is a number, never null.
+ */
+export type WidgetLayout = Record<keyof WidgetDefinitionLayout, number>;
+/**
+ * The sides on which a widget gets the media widget margins. An omitted side does not.
+ */
+export type AppliedMediaMargins = Partial<Record<keyof MediaMarginSettings, boolean>>;
+/**
+ * Static configuration a widget declares about itself. It is picked up at build time, so its
+ * values are known before the widget is loaded.
+ */
+export interface WidgetConfig {
+    /**
+     * How the container that the page builder renders around the widget behaves.
+     */
+    layout?: {
+        /**
+         * On which sides the widget gets the media widget margins that merchants configure in the
+         * theme settings. True for all sides, false for none, or an object to opt in per side.
+         * Margins configured for a single widget instance always win.
+         */
+        applyMediaMargins?: boolean | AppliedMediaMargins;
+    };
 }
-
 /**
  * Definition of a API widget
  */
 export interface WidgetDefinition {
-  /**
-   * Unique code for the widget.
-   */
-  code: string;
-  /**
-   * Name of the widget
-   */
-  widgetConfigDefinitionCode: string;
-  /**
-   * Individual configuration for the widget.
-   */
-  widgetConfig: Record<string, any>;
-  /**
-   * Whether the widget is a legacy custom widget provided by an extension that's configured
-   * via an HTML comment inside a HTML widget.
-   */
-  isCustomLegacyWidget?: boolean;
-  /**
-   * Visibility settings for the widget.
-   */
-  visibility: WidgetDefinitionVisibility;
-  /**
-   * Layout settings for the widget.
-   */
-  layout: WidgetDefinitionLayout;
-  /**
-   * Optional metadata for the widget (only available in preview mode)
-   */
-  meta?: {
-    /**
-     * Hidden state related data
-     */
-    hidden: {
-      /**
-       * Whether the widget is hidden.
-       */
-      isHidden: boolean;
-      /**
-       * Tooltip text for hidden related UI elements.
-       */
-      tooltip: string;
-      /**
-       * Label text for hidden related UI elements.
-       */
-      label: string;
-    };
     /**
-     * Scheduled state related data
-     */
-    scheduled: {
-      /**
-       * Indicates if the widget is scheduled.
-       */
-      isScheduled: boolean;
-      /**
-       * Indicates that the widget schedule time frame is currently active.
-       */
-      isActive: boolean;
-      /**
-       * Indicates if the scheduled time frame has expired
-       */
-      isExpired: boolean;
-      /**
-       * Tooltip text for schedule related UI elements.
-       */
-      tooltip: string;
-      /**
-       * Label text for schedule related UI elements.
-       */
-      label: string;
+     * Unique code for the widget.
+     */
+    code: string;
+    /**
+     * Name of the widget
+     */
+    widgetConfigDefinitionCode: string;
+    /**
+     * Individual configuration for the widget.
+     */
+    widgetConfig: Record<string, unknown>;
+    /**
+     * Whether the widget is a legacy custom widget provided by an extension that's configured
+     * via an HTML comment inside a HTML widget.
+     */
+    isCustomLegacyWidget?: boolean;
+    /**
+     * Visibility settings for the widget.
+     */
+    visibility: WidgetDefinitionVisibility;
+    /**
+     * Layout settings for the widget.
+     */
+    layout: WidgetDefinitionLayout;
+    /**
+     * Optional metadata for the widget (only available in preview mode)
+     */
+    meta?: {
+        /**
+         * Hidden state related data
+         */
+        hidden: {
+            /**
+             * Whether the widget is hidden.
+             */
+            isHidden: boolean;
+            /**
+             * Tooltip text for hidden related UI elements.
+             */
+            tooltip: string;
+            /**
+             * Label text for hidden related UI elements.
+             */
+            label: string;
+        };
+        /**
+         * Scheduled state related data
+         */
+        scheduled: {
+            /**
+             * Indicates if the widget is scheduled.
+             */
+            isScheduled: boolean;
+            /**
+             * Indicates that the widget schedule time frame is currently active.
+             */
+            isActive: boolean;
+            /**
+             * Indicates if the scheduled time frame has expired
+             */
+            isExpired: boolean;
+            /**
+             * Tooltip text for schedule related UI elements.
+             */
+            tooltip: string;
+            /**
+             * Label text for schedule related UI elements.
+             */
+            label: string;
+        };
     };
-  }
 }
-
 export interface ScheduledStatus {
-  /**
-   * Indicates if the widget is scheduled.
-   */
-  isScheduled: boolean;
-  /**
-   * Indicates if the widget is currently hidden based on the scheduling
-   */
-  isHidden: boolean;
-  /**
-   * Indicates if the scheduled time frame has expired.
-   */
-  isExpired: boolean;
+    /**
+     * Indicates if the widget is scheduled.
+     */
+    isScheduled: boolean;
+    /**
+     * Indicates if the widget is currently hidden based on the scheduling
+     */
+    isHidden: boolean;
+    /**
+     * Indicates if the scheduled time frame has expired.
+     */
+    isExpired: boolean;
 }
+//# sourceMappingURL=types.d.ts.map

package/page/components/Widgets/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../page/components/Widgets/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,mBAAmB,EAAE,MAAM,6CAA6C,CAAC;AAEvF;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,sBAAsB,EAAE,MAAM,CAAC,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,mBAAmB,EAAE,OAAO,CAAC,CAAC,CAAC;AAEtF;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;;;WAIG;QACH,iBAAiB,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC;KACnD,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,0BAA0B,EAAE,MAAM,CAAC;IACnC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;OAEG;IACH,UAAU,EAAE,0BAA0B,CAAC;IACvC;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAC;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE;QACL;;WAEG;QACH,MAAM,EAAE;YACN;;eAEG;YACH,QAAQ,EAAE,OAAO,CAAC;YAClB;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAChB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;QACF;;WAEG;QACH,SAAS,EAAE;YACT;;eAEG;YACH,WAAW,EAAE,OAAO,CAAC;YACrB;;eAEG;YACH,QAAQ,EAAE,OAAO,CAAC;YAClB;;eAEG;YACH,SAAS,EAAE,OAAO,CAAC;YACnB;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;YAChB;;eAEG;YACH,KAAK,EAAE,MAAM,CAAC;SACf,CAAC;KACH,CAAA;CACF;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;CACpB"}

package/page/components/Widgets/types.js

@@ -0,0 +1 @@
+export {};

package/page/components/index.d.ts

@@ -0,0 +1,5 @@
+export { default as NotFound } from './NotFound';
+export { default as Widgets } from './Widgets';
+export { default as ResponsiveWidgetImage } from './ResponsiveWidgetImage';
+export { default as WidgetRichText } from './WidgetRichText';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../page/components/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,WAAW,CAAC;AAC/C,OAAO,EAAE,OAAO,IAAI,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,kBAAkB,CAAC"}

package/page/constants/actionTypes.d.ts

@@ -0,0 +1,4 @@
+export declare const REQUEST_PAGE_CONFIG_V2 = "REQUEST_PAGE_CONFIG_V2";
+export declare const RECEIVE_PAGE_CONFIG_V2 = "RECEIVE_PAGE_CONFIG_V2";
+export declare const ERROR_PAGE_CONFIG_V2 = "ERROR_PAGE_CONFIG_V2";
+//# sourceMappingURL=actionTypes.d.ts.map

package/page/constants/actionTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actionTypes.d.ts","sourceRoot":"","sources":["../../../page/constants/actionTypes.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,sBAAsB,2BAA2B,CAAC;AAC/D,eAAO,MAAM,sBAAsB,2BAA2B,CAAC;AAC/D,eAAO,MAAM,oBAAoB,yBAAyB,CAAC"}

package/page/constants/index.d.ts

@@ -0,0 +1,25 @@
+import { PAGE_PATH, PAGE_PATTERN } from '@shopgate/pwa-common/constants/RoutePaths';
+export { PAGE_PREVIEW_PATTERN } from '@shopgate/engage/admin-preview/constants';
+export * from '@shopgate/pwa-common/constants/PageIDs';
+export { PAGE_PATH, PAGE_PATTERN };
+export * from './actionTypes';
+export declare const IMPRINT_PATH = "/page/imprint";
+export declare const PAYMENT_PATH = "/page/payment";
+export declare const PRIVACY_PATH = "/page/privacy";
+export declare const RETURN_POLICY_PATH = "/page/return_policy";
+export declare const SHIPPING_PATH = "/page/shipping";
+export declare const TERMS_PATH = "/page/terms";
+export declare const PAGE_PREVIEW_SLUG = "page_preview";
+/**
+ * Checks if the app is currently in page preview mode.
+ * @todo For backwards compatibility, this constant is still exported from the page package and
+ * mapped to the isAdminPreviewActive helper. It should be removed in the future. Note that this
+ * is a snapshot taken when this module is evaluated - consumers that can call
+ * isAdminPreviewActive() at usage time should do that instead.
+ */
+export declare const IS_PAGE_PREVIEW_ACTIVE: boolean;
+/**
+ * One hour in milliseconds
+ */
+export declare const PAGE_STATE_LIFETIME = 3600000;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../page/constants/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,2CAA2C,CAAC;AAEpF,OAAO,EAAE,oBAAoB,EAAE,MAAM,0CAA0C,CAAC;AAEhF,cAAc,wCAAwC,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,CAAC;AACnC,cAAc,eAAe,CAAC;AAE9B,eAAO,MAAM,YAAY,kBAAyB,CAAC;AACnD,eAAO,MAAM,YAAY,kBAAyB,CAAC;AACnD,eAAO,MAAM,YAAY,kBAAyB,CAAC;AACnD,eAAO,MAAM,kBAAkB,wBAA+B,CAAC;AAC/D,eAAO,MAAM,aAAa,mBAA0B,CAAC;AACrD,eAAO,MAAM,UAAU,gBAAuB,CAAC;AAE/C,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAEhD;;;;;;GAMG;AACH,eAAO,MAAM,sBAAsB,SAAyB,CAAC;AAE7D;;GAEG;AACH,eAAO,MAAM,mBAAmB,UAAU,CAAC"}

package/page/constants/index.js

@@ -1,4 +1,4 @@
-import { IS_ADMIN_PREVIEW_ACTIVE } from '@shopgate/engage/admin-preview/constants';
+import { isAdminPreviewActive } from '@shopgate/engage/admin-preview/helpers';
 import { PAGE_PATH, PAGE_PATTERN } from '@shopgate/pwa-common/constants/RoutePaths';
 export { PAGE_PREVIEW_PATTERN } from '@shopgate/engage/admin-preview/constants';
 export * from '@shopgate/pwa-common/constants/PageIDs';
@@ -15,9 +15,11 @@ export const PAGE_PREVIEW_SLUG = 'page_preview';
 /**
  * Checks if the app is currently in page preview mode.
  * @todo For backwards compatibility, this constant is still exported from the page package and
- * mapped to the IS_ADMIN_PREVIEW_ACTIVE constant. It should be removed in the future.
+ * mapped to the isAdminPreviewActive helper. It should be removed in the future. Note that this
+ * is a snapshot taken when this module is evaluated - consumers that can call
+ * isAdminPreviewActive() at usage time should do that instead.
  */
-export const IS_PAGE_PREVIEW_ACTIVE = IS_ADMIN_PREVIEW_ACTIVE;
+export const IS_PAGE_PREVIEW_ACTIVE = isAdminPreviewActive();
 
 /**
  * One hour in milliseconds

package/page/helpers/index.d.ts

@@ -1,84 +1,92 @@
-export type ProductsWidgetInputConfig = {
-  /**
-   * A search term to filter products by
-   */
-  searchTerm: string;
-  /**
-   * A brand to filter products by
-   */
-  brand: string;
-  /**
-   * A category to filter products by
-   */
-  category: string;
-  /**
-   * Array of product item numbers (selected via manual input)
-   */
-  manualItemNumbers: string[];
-  /**
-   * Array of product item numbers (selected via product selector)
-   */
-  selectorItemNumbers: string[];
+/**
+ * Configuration of the "Products" widget input.
+ */
+export interface ProductsWidgetInputConfig {
+    /**
+     * A search term to filter products by.
+     */
+    searchTerm: string;
+    /**
+     * A brand to filter products by.
+     */
+    brand: string;
+    /**
+     * A category to filter products by.
+     */
+    category: string;
+    /**
+     * Array of product item numbers (selected via manual input).
+     */
+    manualItemNumbers: string[];
+    /**
+     * Array of product item numbers (selected via product selector).
+     */
+    selectorItemNumbers: string[];
 }
-
-export type GetProductSearchParamsFromProductsInputConfigReturnValue = {
-  /**
-   * The type of product search to perform.
-   */
-  productsSearchType: 'searchTerm' | 'brand' | 'category' | 'productIds';
-  /**
-   * The value to use for the product search. Can be a string or an array of strings (for product IDs).
-   */
-  productsSearchValue: string | string[];
+/**
+ * Return value of {@link getProductSearchParamsFromProductsInputConfig}.
+ */
+export interface GetProductSearchParamsFromProductsInputConfigReturnValue {
+    /**
+     * The type of product search to perform.
+     */
+    productsSearchType: 'searchTerm' | 'brand' | 'category' | 'productIds';
+    /**
+     * The value to use for the product search. Can be a string or an array of strings
+     * (for product IDs).
+     */
+    productsSearchValue: string | string[];
 }
-
 /**
  * Helper to extract relevant search parameters from the widget configuration of the "Products"
  * input.
- *
  * The return value can be used to e.g. parametrize the useWidgetProducts hook.
+ * @param products Config object of the "Products" input.
+ * @returns The extracted product search parameters.
  */
-export declare function getProductSearchParamsFromProductsInputConfig(
-  products: ProductsWidgetInputConfig
-): GetProductSearchParamsFromProductsInputConfigReturnValue;
-
+export declare const getProductSearchParamsFromProductsInputConfig: (products?: Partial<ProductsWidgetInputConfig>) => GetProductSearchParamsFromProductsInputConfigReturnValue;
 /**
- * Helper to parse the image URL to return a high resolution version if required.
+ * Parses the image URL to return a high resolution version if required.
+ * @param url The original image URL.
+ * @param useHighRes Whether to return a high resolution version.
+ * @returns The parsed image URL.
  */
-export declare function parseImageUrl(
-  url: string,
-  useHighRes?: boolean
-): string;
-
-type BorderRadiusParams = {
-  /**
-   * The border radius option
-   */
-  borderRadius: 'default' | 'none' |'rounded' | 'custom';
-  /**
-   * The custom border radius value
-   */
-  customBorderRadius?: number
-};
-
+export declare const parseImageUrl: (url: string, useHighRes?: boolean) => string;
 /**
- * Retrieves the border radius based on the widget config
- * @returns The resolved border radius
+ * Parameters for {@link resolveBorderRadiusFromWidgetConfig}.
+ */
+interface BorderRadiusParams {
+    /**
+     * The border radius option.
+     */
+    borderRadius: 'default' | 'none' | 'rounded' | 'custom';
+    /**
+     * The custom border radius value.
+     */
+    borderRadiusCustom?: number;
+}
+/**
+ * Retrieves the border radius based on the widget config.
+ *
+ * `default` follows the app wide corner style, so it is returned as a reference to the theme's
+ * shape variable rather than a resolved length.
+ * @param params The helper parameters.
+ * @param params.borderRadius The border radius option.
+ * @param params.borderRadiusCustom The custom border radius value.
+ * @returns The resolved border radius as a CSS length.
  */
-export declare function resolveBorderRadiusFromWidgetConfig(
-  params: BorderRadiusParams
-)
-
+export declare const resolveBorderRadiusFromWidgetConfig: ({ borderRadius, borderRadiusCustom }: BorderRadiusParams) => string;
 /**
  * Validator factory for regular expressions.
  * @param regex The regular expression to match.
  * @returns A function that validates if a value matches the regex.
  */
-export declare function matchesRegex(regex: RegExp): (val: string) => boolean;
-
+export declare const matchesRegex: (regex: RegExp) => (val: string) => boolean;
 /**
  * Validates if a given string is a valid HTTPS URL.
  * @param val The string to validate.
  * @returns True if the string is a valid HTTPS URL, false otherwise.
  */
 export declare const isHttpsUrl: (val: string) => boolean;
+export {};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../page/helpers/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B;;OAEG;IACH,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,wDAAwD;IACvE;;OAEG;IACH,kBAAkB,EAAE,YAAY,GAAG,OAAO,GAAG,UAAU,GAAG,YAAY,CAAC;IACvE;;;OAGG;IACH,mBAAmB,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CACxC;AAED;;;;;;GAMG;AACH,eAAO,MAAM,6CAA6C,GACxD,WAAU,OAAO,CAAC,yBAAyB,CAAM,KAChD,wDAyBF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,GAAI,KAAK,MAAM,EAAE,aAAa,OAAO,KAAG,MAQjE,CAAC;AAEF;;GAEG;AACH,UAAU,kBAAkB;IAC1B;;OAEG;IACH,YAAY,EAAE,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,CAAC;IACxD;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,mCAAmC,GAC9C,sCAAsC,kBAAkB,KACvD,MAKF,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,YAAY,GAAI,OAAO,MAAM,MAAM,KAAK,MAAM,KAAG,OAAkC,CAAC;AAEjG;;;;GAIG;AACH,eAAO,MAAM,UAAU,QAP8B,MAAM,KAAG,OAOgB,CAAC"}