@shopgate/engage 7.31.6 → 7.32.0-beta.10

package/page/components/Widgets/WidgetsPreviewProvider.js

@@ -1,17 +1,16 @@
-import React, { useMemo, useState, useCallback } from 'react';
-import PropTypes from 'prop-types';
+import { useMemo, useState, useCallback } from 'react';
 import { useWidgetPreviewEvent, dispatchWidgetPreviewEvent } from "./events";
 import { WidgetsPreviewContext } from "./WidgetsPreviewContext";
 
+/**
+ * Props of the {@link WidgetsPreviewProvider} component.
+ */
+import { jsx as _jsx } from "react/jsx-runtime";
 /**
  * The WidgetsPreviewProvider component is used by the Widgets component when it's rendered
  * in preview mode. It provides functionality for the Widget component that's needed when
  * the widgets are rendered in the preview iframe.
- * @param {Object} props The component props.
- * @param {React.ReactNode} props.children The child components to render.
- * @returns {JSX.Element}
  */
-import { jsx as _jsx } from "react/jsx-runtime";
 const WidgetsPreviewProvider = ({
   children
 }) => {

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

@@ -0,0 +1,5 @@
+/**
+ * Whether to consider vertical margins when calculating the overlay position.
+ */
+export declare const CONSIDER_CONTAINER_MARGINS_ON_SCROLL_DEFAULT = false;
+//# sourceMappingURL=constants.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../../page/components/Widgets/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,4CAA4C,QAAQ,CAAC"}

package/page/components/Widgets/constants.js

@@ -1,7 +1,4 @@
 /**
- * List of allowed origins for cms page preview iFrame communication.
+ * Whether to consider vertical margins when calculating the overlay position.
  */
-export const ALLOWED_PAGE_PREVIEW_ORIGINS = ['https://next.admin.shopgatedev.com', 'https://next.admin.shopgatepg.com', 'https://next.admin.shopgate.com', 'https://next.us.admin.shopgate.com', 'http://localhost:1337'];
-
-// Whether to consider vertical margins when calculating the overlay position.
 export const CONSIDER_CONTAINER_MARGINS_ON_SCROLL_DEFAULT = false;

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

@@ -0,0 +1,38 @@
+/**
+ * Names of the events that are dispatched in the context of widget preview iframe communication.
+ */
+export type WidgetPreviewEventName = 'highlight-widget' | 'widget-clicked' | 'set-active-widget-id';
+/**
+ * Detail payload of a widget preview event.
+ */
+export interface WidgetPreviewEventDetail {
+    /**
+     * The code of the widget related to the event.
+     */
+    widgetCode: string;
+    /**
+     * Optional payload data related to the event.
+     */
+    payload?: unknown;
+}
+/**
+ * Handler for a widget preview event.
+ */
+export type WidgetPreviewEventHandler = (event: CustomEvent<WidgetPreviewEventDetail>) => void;
+/**
+ * Hook to listen for widget preview events.
+ * These events are dispatched in the context of iFrame communication at the widget preview.
+ * @param eventName Name of the listened event
+ * @param handler A callback function to handle the event
+ */
+export declare const useWidgetPreviewEvent: (eventName: WidgetPreviewEventName, handler: WidgetPreviewEventHandler) => void;
+/**
+ * Dispatches widget preview related events.
+ * Used to trigger iFrame postMessage events to the parent window or to react on incoming
+ * postMessage events from the parent window.
+ * @param eventName Name of the event to dispatch
+ * @param widgetCode Code of the widget to dispatch the event for
+ * @param payload Optional payload to include with the event
+ */
+export declare const dispatchWidgetPreviewEvent: (eventName: WidgetPreviewEventName, widgetCode: string, payload?: unknown) => void;
+//# sourceMappingURL=events.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../page/components/Widgets/events.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,GAAG,gBAAgB,GAAG,sBAAsB,CAAC;AAEpG;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,wBAAwB,CAAC,KAAK,IAAI,CAAC;AAE/F;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,GAChC,WAAW,sBAAsB,EACjC,SAAS,yBAAyB,SASnC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,0BAA0B,GACrC,WAAW,sBAAsB,EACjC,YAAY,MAAM,EAClB,UAAS,OAAc,SAUxB,CAAC"}

package/page/components/Widgets/events.js

@@ -1,26 +1,22 @@
 import { useEffect } from 'react';
 
 /**
- * @typedef {"highlight-widget"|"widget-clicked"|"set-active-widget-id"} WidgetPreviewEventName
+ * Names of the events that are dispatched in the context of widget preview iframe communication.
  */
 
 /**
- * @typedef {Object} WidgetPreviewEventDetail
- * @property {string} widgetCode The code of the widget related to the event.
- * @property {any} [payload] Optional payload data related to the event.
+ * Detail payload of a widget preview event.
  */
 
 /**
- * @callback WidgetPreviewEventHandler
- * @param {CustomEvent<WidgetPreviewEventDetail>} event The custom event dispatched for the widget
- * preview.
+ * Handler for a widget preview event.
  */
 
 /**
  * Hook to listen for widget preview events.
  * These events are dispatched in the context of iFrame communication at the widget preview.
- * @param {WidgetPreviewEventName} eventName Name of the listened event
- * @param {WidgetPreviewEventHandler} handler A callback function to handle the event
+ * @param eventName Name of the listened event
+ * @param handler A callback function to handle the event
  */
 export const useWidgetPreviewEvent = (eventName, handler) => {
   useEffect(() => {
@@ -35,9 +31,9 @@ export const useWidgetPreviewEvent = (eventName, handler) => {
  * Dispatches widget preview related events.
  * Used to trigger iFrame postMessage events to the parent window or to react on incoming
  * postMessage events from the parent window.
- * @param {WidgetPreviewEventName} eventName Name of the event to dispatch
- * @param {string} widgetCode Code of the widget to dispatch the event for
- * @param {Object} [payload] Optional payload to include with the event
+ * @param eventName Name of the event to dispatch
+ * @param widgetCode Code of the widget to dispatch the event for
+ * @param payload Optional payload to include with the event
  */
 export const dispatchWidgetPreviewEvent = (eventName, widgetCode, payload = null) => {
   const event = new CustomEvent(`widget-preview-${eventName}`, {

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

@@ -0,0 +1,50 @@
+/**
+ * Retrieves the scroll container for the current page. Depending on the PWA mode this can be
+ * a scrollable article element or the window.
+ * @returns The scroll container element, or null if it could not be found.
+ */
+export declare const getScrollContainer: () => HTMLElement | null;
+/**
+ * Parameters for {@link checkScheduled}.
+ */
+export interface ScheduledParams {
+    /**
+     * The start date of the scheduling in ISO format.
+     */
+    from?: string;
+    /**
+     * The end date of the scheduling in ISO format.
+     */
+    to?: string;
+    /**
+     * The timezone offset in minutes. If not provided, the local timezone offset will be used.
+     */
+    timezoneOffset?: number;
+}
+/**
+ * The scheduling status of a widget.
+ */
+export interface ScheduledStatus {
+    /**
+     * Indicates if the widget is scheduled.
+     */
+    isScheduled: boolean;
+    /**
+     * Indicates if the widget is currently active within the scheduled time frame.
+     */
+    isActive: boolean;
+    /**
+     * Indicates if the scheduled time frame has expired.
+     */
+    isExpired: boolean;
+}
+/**
+ * Retrieves the scheduling status of a widget based on the provided parameters.
+ * @param params The parameters for the function.
+ * @param params.from The start date of the scheduling in ISO format.
+ * @param params.to The end date of the scheduling in ISO format.
+ * @param params.timezoneOffset The timezone offset in minutes.
+ * @returns An object containing the scheduling status.
+ */
+export declare function checkScheduled({ from, to, timezoneOffset }?: ScheduledParams): ScheduledStatus;
+//# sourceMappingURL=helpers.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../../page/components/Widgets/helpers.ts"],"names":[],"mappings":"AAEA;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,QAAO,WAAW,GAAG,IACwC,CAAC;AAE7F;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,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;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,EAAE,IAAI,EAAE,EAAE,EAAE,cAAc,EAAE,GAAE,eAAoB,GACjD,eAAe,CAqBjB"}

package/page/components/Widgets/helpers.js

@@ -4,30 +4,25 @@ import { PAGE_PREVIEW_PATTERN } from '@shopgate/engage/page/constants';
 /**
  * Retrieves the scroll container for the current page. Depending on the PWA mode this can be
  * a scrollable article element or the window.
- * @returns {HTMLElement|null}
+ * @returns The scroll container element, or null if it could not be found.
  */
 export const getScrollContainer = () => document.querySelector(`.route__${PAGE_PREVIEW_PATTERN.replace(/^\/+/, '')}`);
 
 /**
- * @typedef {Object} ScheduledParams
- * @property {string} [from] The start date of the scheduling in ISO format.
- * @property {string} [to] The end date of the scheduling in ISO format.
- * @property {number} [timezoneOffset] The timezone offset in minutes. If not provided, the local
- * timezone offset will be used.
+ * Parameters for {@link checkScheduled}.
  */
 
 /**
- * @typedef {Object} ScheduledStatus
- * @property {boolean} isScheduled Indicates if the widget is scheduled.
- * @property {boolean} isActive Indicates if the widget is currently active within the
- * scheduled time frame.
- * @property {boolean} isExpired Indicates if the scheduled time frame has expired.
+ * The scheduling status of a widget.
  */
 
 /**
  * Retrieves the scheduling status of a widget based on the provided parameters.
- * @param {ScheduledParams} [params] The parameters for the function.
- * @returns {ScheduledStatus} An object containing the scheduling status.
+ * @param params The parameters for the function.
+ * @param params.from The start date of the scheduling in ISO format.
+ * @param params.to The end date of the scheduling in ISO format.
+ * @param params.timezoneOffset The timezone offset in minutes.
+ * @returns An object containing the scheduling status.
  */
 export function checkScheduled({
   from,

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,SAyG7D,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,QAAO,yBAA8D,CAAC"}

package/page/components/Widgets/hooks.js

@@ -1,109 +1,22 @@
-import "core-js/modules/es.array.includes.js";
-import "core-js/modules/web.url.js";
-import "core-js/modules/web.url.to-json.js";
-import "core-js/modules/web.url-search-params.js";
-import { useEffect, useCallback, useRef, useContext, useMemo } from 'react';
-import { logger } from '@shopgate/engage/core/helpers';
+import { useContext, useMemo } from 'react';
 import { useDispatch } from 'react-redux';
 import { useRoute } from '@shopgate/engage/core/hooks';
 import { receivePageConfigV2 } from '@shopgate/engage/page/action-creators';
 import { PAGE_PREVIEW_SLUG } from '@shopgate/engage/page/constants';
-import { ALLOWED_PAGE_PREVIEW_ORIGINS, CONSIDER_CONTAINER_MARGINS_ON_SCROLL_DEFAULT } from "./constants";
+import { useIframeMessenger } from '@shopgate/engage/admin-preview/hooks';
+import { ALLOWED_ADMIN_PREVIEW_ORIGINS } from '@shopgate/engage/admin-preview/constants';
+import { CONSIDER_CONTAINER_MARGINS_ON_SCROLL_DEFAULT } from "./constants";
 import { getScrollContainer } from "./helpers";
 import { WidgetsPreviewContext } from "./WidgetsPreviewContext";
 import { dispatchWidgetPreviewEvent, useWidgetPreviewEvent } from "./events";
 
 /**
- * @typedef {Object} MessageData
- * @property {string} type Identifier for the kind of message
- * @property {any} [payload] Optional data payload for this message
+ * Message payload exchanged with the parent window in the page preview iframe.
  */
 
-/**
- * @typedef {Object} IframeMessengerResult
- * @property {function(MessageData, string=): void} sendToParent
- *   - Send data up to window.parent. If targetOrigin is omitted, uses the
- *     most recently seen origin (from an incoming message). If none seen yet,
- *     falls back to parentOrigins[0] or "*".
- */
-
-/**
- * Hook for postMessage communication when your component is inside an iframe.
- *
- * Listens on window for "message" events from any origin in parentOrigins,
- * and only calls onMessage(data, rawEvent) if both origin and source match.
- *
- * @param {function(MessageData, any): void} onMessage
- *   Callback invoked when a trusted message arrives. Receives data and the
- *   raw event (so you can inspect origin, source, etc.).
- * @param {string[]} parentOrigins
- *   Array of allowed parent origin strings (e.g.
- *   ['https://a.example.com','https://b.example.com']).
- * @returns {IframeMessengerResult}
- *   An object with a single method:
- *   • sendToParent(data, [targetOrigin]): void
- *     – Posts data up to window.parent. By default it uses the most recently
- *       seen origin (from an incoming message). If none, uses parentOrigins[0].
- */
-function useIframeMessenger(onMessage, parentOrigins) {
-  // Keep a ref to the latest onMessage callback so the listener always has it.
-  const onMessageRef = useRef(onMessage);
-  useEffect(() => {
-    onMessageRef.current = onMessage;
-  }, [onMessage]);
-
-  // Keep track of the last allowed origin we heard from
-  const lastOriginRef = useRef(null);
-
-  /**
-   * Send a message up to the parent window.
-   * @param {MessageData} data       - The data object to post.
-   * @param {string}      [targetOrigin]
-   *   Optional override for the origin to post to. Must be one of
-   *   parentOrigins. If omitted, uses the last seen origin (lastOriginRef),
-   *   or parentOrigins[0], or "*" if array is empty.
-   */
-  const sendToParent = useCallback((data, targetOrigin) => {
-    // Determine which origin to use: explicit, then last seen, then first, then "*".
-    const originToUse = typeof targetOrigin === 'string' ? targetOrigin : lastOriginRef.current || new URL(document.referrer).origin || parentOrigins[0] || '*';
-    if (!originToUse) {
-      logger.warn('useIframeMessenger: no targetOrigin available. ' + 'Provide parentOrigins or pass targetOrigin.');
-      return;
-    }
-    window.parent.postMessage(data, originToUse);
-  }, [parentOrigins]);
-
-  // Attach / detach the "message" listener.
-  useEffect(() => {
-    /**
-     * Handler for incoming postMessage events.
-     * @param {any} rawEvent  – The original MessageEvent object.
-     */
-    function handler(rawEvent) {
-      // Only proceed if the origin is in our whitelist.
-      if (!parentOrigins.includes(rawEvent.origin)) return;
-      // Ensure the message actually came from window.parent.
-      if (rawEvent.source !== window.parent) return;
-
-      // Record this origin as most recently seen.
-      lastOriginRef.current = rawEvent.origin;
-
-      // Forward the event.data and the raw event to the callback.
-      onMessageRef.current(rawEvent.data, rawEvent);
-    }
-    window.addEventListener('message', handler);
-    return () => {
-      window.removeEventListener('message', handler);
-    };
-  }, [parentOrigins, sendToParent]);
-  return {
-    sendToParent
-  };
-}
-
 /**
  * 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();
@@ -128,12 +41,15 @@ export const usePreviewIframeCommunication = (isActive = false) => {
       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) {
@@ -147,13 +63,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.
@@ -194,7 +110,7 @@ export const usePreviewIframeCommunication = (isActive = false) => {
         });
       }
     }
-  }, ALLOWED_PAGE_PREVIEW_ORIGINS);
+  }, ALLOWED_ADMIN_PREVIEW_ORIGINS);
   useWidgetPreviewEvent('widget-clicked', e => {
     if (!isActive) {
       return;
@@ -208,14 +124,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

@@ -2,131 +2,129 @@
  * 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.
  */
 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;
+    /**
+     * Bottom margin for the widget.
+     */
+    marginBottom: number;
+    /**
+     * Left margin for the widget.
+     */
+    marginLeft: number;
+    /**
+     * Right margin for the widget.
+     */
+    marginRight: number;
 }
-
 /**
  * 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