@gooddata/sdk-ui-dashboard 11.54.0-alpha.4 → 11.54.0-alpha.6

package/esm/sdk-ui-dashboard.d.ts

@@ -63,6 +63,7 @@ import { IAttributeOrMeasure } from '@gooddata/sdk-model';
 import { IAttributeWithReferences } from '@gooddata/sdk-backend-spi';
 import { IAutomationMetadataObject } from '@gooddata/sdk-model';
 import { IAutomationMetadataObjectDefinition } from '@gooddata/sdk-model';
+import { IAutomationRecipient } from '@gooddata/sdk-model';
 import { IAvailableDrillTargets } from '@gooddata/sdk-ui';
 import { IBackendCapabilities } from '@gooddata/sdk-backend-spi';
 import { IBaseWidget } from '@gooddata/sdk-model';
@@ -182,6 +183,7 @@ import { ISettings } from '@gooddata/sdk-model';
 import { IShareDialogInteractionData } from '@gooddata/sdk-ui-kit';
 import { ISharedObject } from '@gooddata/sdk-ui-kit';
 import { ISharingApplyPayload as ISharingApplyPayload_2 } from '@gooddata/sdk-ui-kit';
+import { ISlotProps } from '@gooddata/sdk-ui-kit';
 import { ITableDataAttributeScope } from '@gooddata/sdk-ui';
 import { ITempFilterContext } from '@gooddata/sdk-model';
 import { ITheme } from '@gooddata/sdk-model';
@@ -1000,16 +1002,18 @@ export declare function changeDashboardDensity(density: DashboardDensity, correl
  *
  * The command is rejected when the ad-hoc override is not allowed: the dashboard timezone
  * feature is disabled or the dashboard's timezone configuration does not allow user overrides
- * in view mode.
+ * in view mode — the latter bypassable via `bypassUserOverrideCheck`.
  *
  * @param timezoneId - concrete IANA timezone id, the BROWSER_DETECTED sentinel (resolved to the
  *  viewer's browser timezone by the handler), or undefined to clear the override
  * @param correlationId - specify correlation id to use for this command. this will be included in all
  *  events that will be emitted during the command processing
+ * @param bypassUserOverrideCheck - see
+ *  {@link IChangeDashboardTimezoneOverridePayload.bypassUserOverrideCheck}
  *
  * @alpha
  */
-export declare function changeDashboardTimezoneOverride(timezoneId: string | undefined, correlationId?: string): IChangeDashboardTimezoneOverride;
+export declare function changeDashboardTimezoneOverride(timezoneId: string | undefined, correlationId?: string, bypassUserOverrideCheck?: boolean): IChangeDashboardTimezoneOverride;
 
 /**
  * Command for date filter selection change.
@@ -5978,12 +5982,12 @@ export declare interface IAlertingDialogProps {
 export declare interface IAlertingDialogSlots {
     /**
      * Wraps or replaces the dialog header (the title input row). Must have a stable reference
-     * identity — see {@link ISlotProps}.
+     * identity — see {@link @gooddata/sdk-ui-kit#ISlotProps}.
      */
     Header?: ComponentType<ISlotProps<AlertingDialogHeaderDefaultProps>>;
     /**
      * Wraps or replaces the dialog's filters region (the filter and parameter chips). Must have
-     * a stable reference identity — see {@link ISlotProps}.
+     * a stable reference identity — see {@link @gooddata/sdk-ui-kit#ISlotProps}.
      *
      * Renders only in the fully rendered dialog: not while the dialog context reports loading,
      * and not while the stale-filters confirmation step is shown.
@@ -5993,6 +5997,40 @@ export declare interface IAlertingDialogSlots {
      * updated array, not a delta.
      */
     Filters?: ComponentType<ISlotProps<IAlertingDialogFiltersProps>>;
+    /**
+     * Wraps or replaces the dialog's destination region (the "Action" row selecting the
+     * notification channel). Must have a stable reference identity — see {@link @gooddata/sdk-ui-kit#ISlotProps}.
+     *
+     * Renders only in the fully rendered dialog — not while the dialog context reports loading,
+     * not while the stale-filters confirmation step is shown — **and only when more than one
+     * notification channel exists**: with a single channel the default dialog hides the whole
+     * row, and the slot with it.
+     */
+    Destination?: ComponentType<ISlotProps<IAutomationDialogDestinationProps>>;
+    /**
+     * Wraps or replaces the dialog's recipients region. Must have a stable reference identity —
+     * see {@link @gooddata/sdk-ui-kit#ISlotProps}.
+     *
+     * Renders only in the fully rendered dialog: not while the dialog context reports loading,
+     * and not while the stale-filters confirmation step is shown.
+     */
+    Recipients?: ComponentType<ISlotProps<IAutomationDialogRecipientsProps>>;
+    /**
+     * Wraps or replaces the dialog's action bar (the footer row: documentation link, Delete in
+     * edit mode, Cancel and the submit button). Must have a stable reference identity — see
+     * {@link @gooddata/sdk-ui-kit#ISlotProps}.
+     *
+     * Renders only in the fully rendered dialog: not while the dialog context reports loading
+     * (the loading dialog keeps its own footer), and not while the stale-filters confirmation
+     * step is shown.
+     *
+     * A replacement that does not render `Default` loses the submit button's Enter-key detection
+     * id (Enter no longer submits), the validation aria wiring, and the default row's ordering.
+     * Wraps that render `<Default {...defaultProps} />` keep everything; note the Enter-key path
+     * invokes the dialog's own submit handler and disabled state, so `defaultProps` overrides
+     * affect the buttons only.
+     */
+    ActionBar?: ComponentType<ISlotProps<IAutomationDialogActionBarProps>>;
 }
 
 /**
@@ -6233,6 +6271,79 @@ export declare interface IAttributesDropdownProps extends IDashboardAttributeFil
     onParameterSelect?: (ref: IdentifierRef) => void;
 }
 
+/**
+ * Members shared by both automation dialogs' action-bar regions (the footer row).
+ *
+ * @alpha
+ */
+export declare interface IAutomationDialogActionBarProps {
+    /**
+     * Label of the cancel button.
+     */
+    cancelButtonText: string;
+    /**
+     * Label of the submit button ("Create" / "Save" per mode).
+     */
+    submitButtonText: string;
+    /**
+     * Closes the dialog without saving.
+     */
+    onCancel: () => void;
+    /**
+     * Submits the automation.
+     */
+    onSubmit: () => void;
+    /**
+     * Whether submitting is currently disabled (validation, saving, execution-timestamp mode).
+     */
+    isSubmitDisabled: boolean;
+    /**
+     * Whether a save is in flight; drives the progress spinner and disables Delete.
+     */
+    isSaving: boolean;
+    /**
+     * Tooltip shown on the disabled submit button, when there is one.
+     */
+    submitButtonTooltipText?: string;
+    /**
+     * Text of the documentation link. Absent (with {@link IAutomationDialogActionBarProps.helpLinkHref})
+     * when the workspace is white-labeled.
+     */
+    helpLinkText?: string;
+    /**
+     * Target of the documentation link. Absent when the workspace is white-labeled.
+     */
+    helpLinkHref?: string;
+    /**
+     * Opens the delete confirmation. Absent when creating a new automation.
+     */
+    onDelete?: () => void;
+    /**
+     * Label of the delete button. Present with {@link IAutomationDialogActionBarProps.onDelete}.
+     */
+    deleteButtonText?: string;
+}
+
+/**
+ * Members shared by both automation dialogs' destination regions.
+ *
+ * @alpha
+ */
+export declare interface IAutomationDialogDestinationProps {
+    /**
+     * Notification channels the automation can target.
+     */
+    notificationChannels: INotificationChannelIdentifier[] | INotificationChannelMetadataObject[];
+    /**
+     * Id of the automation's currently selected notification channel.
+     */
+    selectedNotificationChannelId: string | undefined;
+    /**
+     * Called with the id of the newly selected notification channel.
+     */
+    onChange: (notificationChannelId: string) => void;
+}
+
 /**
  * Members shared by both automation dialogs' filters regions.
  *
@@ -6306,6 +6417,54 @@ export declare interface IAutomationDialogHeaderProps {
     onChange: (value: string) => void;
 }
 
+/**
+ * Members shared by both automation dialogs' recipients regions.
+ *
+ * @alpha
+ */
+export declare interface IAutomationDialogRecipientsProps {
+    /**
+     * Currently selected recipients.
+     */
+    value: IAutomationRecipient[];
+    /**
+     * Replaces the selection with the complete updated array.
+     */
+    onChange: (recipients: IAutomationRecipient[]) => void;
+    /**
+     * The logged-in user as a recipient candidate.
+     */
+    loggedUser?: IAutomationRecipient;
+    /**
+     * Restricts the selection to the logged-in user.
+     */
+    allowOnlyLoggedUserRecipients?: boolean;
+    /**
+     * Allows removing the last recipient.
+     */
+    allowEmptySelection?: boolean;
+    /**
+     * Allows recipients that are not workspace users.
+     */
+    allowExternalRecipients?: boolean;
+    /**
+     * Maximum number of recipients.
+     */
+    maxRecipients?: number;
+    /**
+     * Notification channels, used to derive channel-specific recipient constraints.
+     */
+    notificationChannels?: INotificationChannelIdentifier[] | INotificationChannelMetadataObject[];
+    /**
+     * Id of the automation's currently selected notification channel.
+     */
+    notificationChannelId?: string;
+    /**
+     * When set, the only addable recipient is this external address.
+     */
+    externalRecipientOverride?: string;
+}
+
 /**
  * Automation filters grouped by tab, returned by {@link selectAutomationFiltersByTab}.
  * @alpha
@@ -6701,6 +6860,12 @@ export declare interface IChangeDashboardTimezoneOverridePayload {
      * the dashboard/workspace configuration applies again.
      */
     readonly timezoneId: string | undefined;
+    /**
+     * Skips the check that the dashboard's timezone configuration allows user overrides in view
+     * mode, for restoring a timezone the platform already committed to (an export render, an
+     * automation deep link). The dashboard timezone feature flag is still honored.
+     */
+    readonly bypassUserOverrideCheck?: boolean;
 }
 
 /**
@@ -13134,7 +13299,9 @@ export declare interface IDateFiltersCustomizer {
  * @remarks
  * Extends the shared {@link IAlertingDialogProps} with customization only the default implementation
  * supports. Slots render only in the fully rendered dialog: not while the dialog context reports
- * loading, and not while the stale-filters confirmation step is shown.
+ * loading, and not while the stale-filters confirmation step is shown. The Destination slot
+ * additionally renders only when more than one notification channel exists — see
+ * {@link IAlertingDialogSlots.Destination}.
  *
  * @alpha
  */
@@ -13142,8 +13309,39 @@ export declare interface IDefaultAlertingDialogProps extends IAlertingDialogProp
     /**
      * Section-level overrides. Each slot receives `{ Default, defaultProps }` and may render its own
      * content (replace) or `<Default {...defaultProps} />` inside its own markup (wrap).
+     *
+     * @example
+     * The dialog is reached through the `Dashboard` component override; define slot components at
+     * module scope (see {@link @gooddata/sdk-ui-kit#ISlotProps}):
+     * ```tsx
+     * function HeaderWithBanner({ Default, defaultProps }: ISlotProps<AlertingDialogHeaderDefaultProps>) {
+     *     return (
+     *         <>
+     *             <WarningBanner>Alerts may take up to 5 minutes.</WarningBanner>
+     *             <Default {...defaultProps} />
+     *         </>
+     *     );
+     * }
+     *
+     * <Dashboard
+     *     AlertingDialogComponent={(props) => (
+     *         <DefaultAlertingDialog {...props} slots={{ Header: HeaderWithBanner }} />
+     *     )}
+     * />;
+     * ```
      */
     slots?: IAlertingDialogSlots;
+    /**
+     * Content rendered as the first child of the dialog's scrollable content area, above the
+     * form. Rendered only in the fully rendered dialog: not while the dialog context reports
+     * loading, and not while the stale-filters confirmation step is shown.
+     */
+    topContent?: ReactNode;
+    /**
+     * Content rendered as the last child of the dialog's scrollable content area, below the
+     * form. Same rendering conditions as {@link IDefaultAlertingDialogProps.topContent}.
+     */
+    bottomContent?: ReactNode;
 }
 
 /**
@@ -13179,8 +13377,8 @@ export declare interface IDefaultDashboardToolbarGroupProps {
  * Extends the shared {@link IScheduledEmailDialogProps} with customization only the default implementation
  * supports. Slots render only in the fully rendered dialog: not while the dialog context reports
  * loading, and not while the stale-filters confirmation step is shown. The Filters slot
- * additionally renders only while the Filters tab is selected — see
- * {@link IScheduledEmailDialogSlots.Filters}.
+ * additionally renders only while the Filters tab is selected; the Destination and Recipients
+ * slots only while the General tab is — see {@link IScheduledEmailDialogSlots}.
  *
  * @alpha
  */
@@ -13188,8 +13386,41 @@ export declare interface IDefaultScheduledEmailDialogProps extends IScheduledEma
     /**
      * Section-level overrides. Each slot receives `{ Default, defaultProps }` and may render its own
      * content (replace) or `<Default {...defaultProps} />` inside its own markup (wrap).
+     *
+     * @example
+     * The dialog is reached through the `Dashboard` component override; define slot components at
+     * module scope (see {@link @gooddata/sdk-ui-kit#ISlotProps}):
+     * ```tsx
+     * function RecipientsWithNote({ Default, defaultProps }: ISlotProps<IScheduledEmailDialogRecipientsProps>) {
+     *     return (
+     *         <>
+     *             <Default {...defaultProps} />
+     *             <Note>External recipients receive a public link.</Note>
+     *         </>
+     *     );
+     * }
+     *
+     * <Dashboard
+     *     ScheduledEmailDialogComponent={(props) => (
+     *         <DefaultScheduledEmailDialog {...props} slots={{ Recipients: RecipientsWithNote }} />
+     *     )}
+     * />;
+     * ```
      */
     slots?: IScheduledEmailDialogSlots;
+    /**
+     * Content rendered as the first child of the dialog's scrollable content area, above the
+     * form. Rendered only in the fully rendered dialog: not while the dialog context reports
+     * loading, and not while the stale-filters confirmation step is shown. Rendered on both
+     * tabs — it is a content-area child, not a tab child.
+     */
+    topContent?: ReactNode;
+    /**
+     * Content rendered as the last child of the dialog's scrollable content area, below the
+     * form. Same rendering conditions as {@link IDefaultScheduledEmailDialogProps.topContent}.
+     * Rendered on both tabs — it is a content-area child, not a tab child.
+     */
+    bottomContent?: ReactNode;
 }
 
 /**
@@ -17687,6 +17918,18 @@ export declare interface IScheduledEmailDialogProps {
     onDeleteError?: (error: GoodDataSdkError) => void;
 }
 
+/**
+ * Props of the default scheduled email dialog's recipients region.
+ *
+ * @alpha
+ */
+export declare interface IScheduledEmailDialogRecipientsProps extends IAutomationDialogRecipientsProps {
+    /**
+     * Submits the dialog from the recipients input. The default dialog always supplies it.
+     */
+    onKeyDownSubmit: (e: KeyboardEvent_2) => void;
+}
+
 /**
  * Section-level overrides of the default scheduled email dialog.
  *
@@ -17695,12 +17938,12 @@ export declare interface IScheduledEmailDialogProps {
 export declare interface IScheduledEmailDialogSlots {
     /**
      * Wraps or replaces the dialog header (the title input row). Must have a stable reference
-     * identity — see {@link ISlotProps}.
+     * identity — see {@link @gooddata/sdk-ui-kit#ISlotProps}.
      */
     Header?: ComponentType<ISlotProps<ScheduledEmailDialogHeaderDefaultProps>>;
     /**
      * Wraps or replaces the Filters tab content (the filter and parameter chips). Must have a
-     * stable reference identity — see {@link ISlotProps}.
+     * stable reference identity — see {@link @gooddata/sdk-ui-kit#ISlotProps}.
      *
      * Renders only in the fully rendered dialog **and only while the Filters tab is selected**:
      * not while the dialog context reports loading, not while the stale-filters confirmation
@@ -17715,13 +17958,48 @@ export declare interface IScheduledEmailDialogSlots {
     Filters?: ComponentType<ISlotProps<IScheduledEmailDialogFiltersProps>>;
     /**
      * Wraps or replaces the "Time zone" section on the General tab. Must have a stable reference
-     * identity — see {@link ISlotProps}.
+     * identity — see {@link @gooddata/sdk-ui-kit#ISlotProps}.
      *
      * Renders only when the dialog shows the section at all: the dashboard-timezone feature is
      * enabled and the dashboard allows the view-mode timezone override. When the section is
      * hidden, the slot is not rendered either.
      */
     Timezone?: ComponentType<ISlotProps<ScheduledEmailDialogTimezoneDefaultProps>>;
+    /**
+     * Wraps or replaces the dialog's destination region (the notification-channel select on the
+     * General tab). Must have a stable reference identity — see {@link @gooddata/sdk-ui-kit#ISlotProps}.
+     *
+     * Renders only in the fully rendered dialog **and only while the General tab is selected**:
+     * not while the dialog context reports loading, and not while the stale-filters confirmation
+     * step is shown. It unmounts — losing any local state — on every switch to the Filters tab.
+     */
+    Destination?: ComponentType<ISlotProps<IAutomationDialogDestinationProps>>;
+    /**
+     * Wraps or replaces the dialog's recipients region on the General tab. Must have a stable
+     * reference identity — see {@link @gooddata/sdk-ui-kit#ISlotProps}.
+     *
+     * Renders only in the fully rendered dialog **and only while the General tab is selected**:
+     * not while the dialog context reports loading, and not while the stale-filters confirmation
+     * step is shown. It unmounts — losing any local state — on every switch to the Filters tab.
+     */
+    Recipients?: ComponentType<ISlotProps<IScheduledEmailDialogRecipientsProps>>;
+    /**
+     * Wraps or replaces the dialog's action bar (the footer row: documentation link, Delete in
+     * edit mode, Cancel and the submit button). Must have a stable reference identity — see
+     * {@link @gooddata/sdk-ui-kit#ISlotProps}.
+     *
+     * Renders only in the fully rendered dialog: not while the dialog context reports loading
+     * (the loading dialog keeps its own footer), and not while the stale-filters confirmation
+     * step is shown. Unlike the Filters and Destination slots it renders on **both** tabs — the
+     * footer is tab-independent.
+     *
+     * A replacement that does not render `Default` loses the submit button's Enter-key detection
+     * id (Enter no longer submits), the validation aria wiring, and the default row's ordering.
+     * Wraps that render `<Default {...defaultProps} />` keep everything; note the Enter-key path
+     * invokes the dialog's own submit handler and disabled state, so `defaultProps` overrides
+     * affect the buttons only.
+     */
+    ActionBar?: ComponentType<ISlotProps<IAutomationDialogActionBarProps>>;
 }
 
 /**
@@ -20005,31 +20283,7 @@ export declare function isLayoutSectionPath(obj: unknown): obj is ILayoutSection
  */
 export declare function isLoadingPlaceholderWidget(obj: unknown): obj is IPlaceholderWidget;
 
-/**
- * Contract of a section-level slot: the default implementation and the exact props the default
- * dialog would render it with.
- *
- * The component a customer assigns to a slot is rendered as an element type, so its reference
- * identity is load-bearing: define it at module scope (or memoize it), never inline in a render
- * function — an inline definition gets a fresh identity on every render of the declaring
- * component, which unmounts and remounts the region, losing focus and transient DOM state.
- *
- * Render `<Default {...defaultProps} />` inside your own markup to wrap the region rather than
- * replace it; a slot that does not spread `defaultProps` onto `Default` loses the default
- * behavior wired through them (including the dialog's initial-focus ref).
- *
- * @alpha
- */
-export declare interface ISlotProps<TProps> {
-    /**
-     * The default implementation of the region.
-     */
-    Default: ComponentType<TProps>;
-    /**
-     * The exact props the default dialog would render {@link ISlotProps.Default} with.
-     */
-    defaultProps: TProps;
-}
+export { ISlotProps }
 
 /**
  * @internal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-ui-dashboard",
-  "version": "11.54.0-alpha.4",
+  "version": "11.54.0-alpha.6",
   "description": "GoodData SDK - Dashboard Component",
   "license": "LicenseRef-LICENSE",
   "author": "GoodData Corporation",
@@ -60,20 +60,20 @@
     "ts-invariant": "0.10.3",
     "tslib": "2.8.1",
     "uuid": "11.1.1",
-    "@gooddata/sdk-backend-base": "11.54.0-alpha.4",
-    "@gooddata/sdk-ui-charts": "11.54.0-alpha.4",
-    "@gooddata/sdk-ui": "11.54.0-alpha.4",
-    "@gooddata/sdk-ui-ext": "11.54.0-alpha.4",
-    "@gooddata/sdk-model": "11.54.0-alpha.4",
-    "@gooddata/sdk-ui-filters": "11.54.0-alpha.4",
-    "@gooddata/sdk-backend-spi": "11.54.0-alpha.4",
-    "@gooddata/sdk-ui-geo": "11.54.0-alpha.4",
-    "@gooddata/sdk-ui-kit": "11.54.0-alpha.4",
-    "@gooddata/sdk-ui-semantic-search": "11.54.0-alpha.4",
-    "@gooddata/sdk-ui-pivot": "11.54.0-alpha.4",
-    "@gooddata/sdk-ui-theme-provider": "11.54.0-alpha.4",
-    "@gooddata/sdk-ui-vis-commons": "11.54.0-alpha.4",
-    "@gooddata/util": "11.54.0-alpha.4"
+    "@gooddata/sdk-backend-base": "11.54.0-alpha.6",
+    "@gooddata/sdk-backend-spi": "11.54.0-alpha.6",
+    "@gooddata/sdk-model": "11.54.0-alpha.6",
+    "@gooddata/sdk-ui": "11.54.0-alpha.6",
+    "@gooddata/sdk-ui-charts": "11.54.0-alpha.6",
+    "@gooddata/sdk-ui-ext": "11.54.0-alpha.6",
+    "@gooddata/sdk-ui-geo": "11.54.0-alpha.6",
+    "@gooddata/sdk-ui-kit": "11.54.0-alpha.6",
+    "@gooddata/sdk-ui-pivot": "11.54.0-alpha.6",
+    "@gooddata/sdk-ui-filters": "11.54.0-alpha.6",
+    "@gooddata/sdk-ui-theme-provider": "11.54.0-alpha.6",
+    "@gooddata/sdk-ui-semantic-search": "11.54.0-alpha.6",
+    "@gooddata/sdk-ui-vis-commons": "11.54.0-alpha.6",
+    "@gooddata/util": "11.54.0-alpha.6"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.17.0",
@@ -119,12 +119,12 @@
     "typescript": "5.9.3",
     "vitest": "4.1.8",
     "vitest-dom": "0.1.1",
-    "@gooddata/eslint-config": "11.54.0-alpha.4",
-    "@gooddata/i18n-toolkit": "11.54.0-alpha.4",
-    "@gooddata/oxlint-config": "11.54.0-alpha.4",
-    "@gooddata/sdk-backend-mockingbird": "11.54.0-alpha.4",
-    "@gooddata/reference-workspace": "11.54.0-alpha.4",
-    "@gooddata/stylelint-config": "11.54.0-alpha.4"
+    "@gooddata/i18n-toolkit": "11.54.0-alpha.6",
+    "@gooddata/oxlint-config": "11.54.0-alpha.6",
+    "@gooddata/eslint-config": "11.54.0-alpha.6",
+    "@gooddata/reference-workspace": "11.54.0-alpha.6",
+    "@gooddata/sdk-backend-mockingbird": "11.54.0-alpha.6",
+    "@gooddata/stylelint-config": "11.54.0-alpha.6"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",