@gooddata/sdk-ui-dashboard 11.55.0-alpha.2 → 11.55.0-alpha.4

package/esm/presentation/automations/scheduledEmail/blocks/ScheduledEmailDialogWidgetAttachments.js

@@ -0,0 +1,28 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useScheduledEmailDialogContext } from "../../contexts/ScheduledEmailDialogContext.js";
+import { DefaultScheduledEmailDialogWidgetAttachments } from "../DefaultScheduledEmailDialog/components/DefaultScheduledEmailDialogWidgetAttachments.js";
+import { useScheduledEmailDialogWidgetAttachmentsProps } from "../state/useScheduledEmailDialogFieldProps.js";
+import { WhenScheduledEmailDialogLoaded } from "./WhenScheduledEmailDialogLoaded.js";
+/**
+ * The scheduled-export dialog's widget-attachments field, connected to the dialog's state.
+ *
+ * Renders {@link DefaultScheduledEmailDialogWidgetAttachments} with the props of
+ * {@link useScheduledEmailDialogWidgetAttachmentsProps}; every prop passed here replaces the hook's
+ * value for that prop wholesale. Renders nothing while `useScheduledEmailDialogContext().isLoading`
+ * is true and when the dialog context has no `widget` (a dashboard schedule renders
+ * {@link ScheduledEmailDialogDashboardAttachments} instead), the same visibility the default dialog
+ * gives the field.
+ *
+ * @alpha
+ */
+export function ScheduledEmailDialogWidgetAttachments(props) {
+    return (_jsx(WhenScheduledEmailDialogLoaded, { children: _jsx(ConnectedScheduledEmailDialogWidgetAttachments, { ...props }) }));
+}
+function ConnectedScheduledEmailDialogWidgetAttachments(overrides) {
+    const defaultProps = useScheduledEmailDialogWidgetAttachmentsProps();
+    const { widget } = useScheduledEmailDialogContext();
+    if (!widget) {
+        return null;
+    }
+    return _jsx(DefaultScheduledEmailDialogWidgetAttachments, { ...defaultProps, ...overrides });
+}

package/esm/presentation/automations/scheduledEmail/state/useIsInPlatformChannel.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Whether the draft's selected notification channel delivers in-platform only.
+ * The subject and message fields hide for such a channel.
+ */
+export declare function useIsInPlatformChannel(): boolean;
+//# sourceMappingURL=useIsInPlatformChannel.d.ts.map

package/esm/presentation/automations/scheduledEmail/state/useIsInPlatformChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useIsInPlatformChannel.d.ts","sourceRoot":"","sources":["../../../../../src/presentation/automations/scheduledEmail/state/useIsInPlatformChannel.ts"],"names":[],"mappings":"AAMA;;;GAGG;AACH,wBAAgB,sBAAsB,IAAI,OAAO,CAOhD"}

package/esm/presentation/automations/scheduledEmail/state/useIsInPlatformChannel.js

@@ -0,0 +1,13 @@
+// (C) 2026 GoodData Corporation
+import { useScheduledEmailDialogContext } from "../../contexts/ScheduledEmailDialogContext.js";
+import { useScheduledExportDraft } from "./ScheduledExportDraftContext.js";
+/**
+ * Whether the draft's selected notification channel delivers in-platform only.
+ * The subject and message fields hide for such a channel.
+ */
+export function useIsInPlatformChannel() {
+    const { notificationChannels } = useScheduledEmailDialogContext();
+    const { editedAutomation } = useScheduledExportDraft();
+    const selectedChannel = notificationChannels.find((channel) => channel.id === editedAutomation.notificationChannel);
+    return selectedChannel?.destinationType === "inPlatform";
+}

package/esm/presentation/automations/scheduledEmail/state/useScheduledEmailDialogFieldProps.d.ts

@@ -0,0 +1,73 @@
+import { type KeyboardEvent } from "react";
+import { type IScheduledEmailDialogDashboardAttachmentsProps, type IScheduledEmailDialogEvaluationModeProps, type IScheduledEmailDialogMessageProps, type IScheduledEmailDialogRecurrenceProps, type IScheduledEmailDialogSubjectProps, type IScheduledEmailDialogWidgetAttachmentsProps } from "../types.js";
+/**
+ * Inputs of {@link useScheduledEmailDialogRecurrenceProps} that come from the dialog rather than its state.
+ *
+ * @alpha
+ */
+export interface IUseScheduledEmailDialogRecurrencePropsInput {
+    /**
+     * Key-down handler of the recurrence inputs; the dialog submits on Enter through it.
+     */
+    onKeyDownSubmit: (event: KeyboardEvent) => void;
+}
+/**
+ * The exact props the default scheduled-email dialog renders its recurrence field with.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export declare function useScheduledEmailDialogRecurrenceProps({ onKeyDownSubmit }: IUseScheduledEmailDialogRecurrencePropsInput): IScheduledEmailDialogRecurrenceProps;
+/**
+ * Inputs of {@link useScheduledEmailDialogSubjectProps} that come from the dialog rather than its state.
+ *
+ * @alpha
+ */
+export interface IUseScheduledEmailDialogSubjectPropsInput {
+    /**
+     * Called on Enter in the subject input when submit is not disabled.
+     */
+    onKeyDownSubmit: () => void;
+}
+/**
+ * The exact props the default scheduled-email dialog renders its subject field with.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export declare function useScheduledEmailDialogSubjectProps({ onKeyDownSubmit }: IUseScheduledEmailDialogSubjectPropsInput): IScheduledEmailDialogSubjectProps;
+/**
+ * The exact props the default scheduled-email dialog renders its message field with.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export declare function useScheduledEmailDialogMessageProps(): IScheduledEmailDialogMessageProps;
+/**
+ * The exact props the default scheduled-email dialog renders its widget-attachments field with.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export declare function useScheduledEmailDialogWidgetAttachmentsProps(): IScheduledEmailDialogWidgetAttachmentsProps;
+/**
+ * The exact props the default scheduled-email dialog renders its dashboard-attachments field with.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export declare function useScheduledEmailDialogDashboardAttachmentsProps(): IScheduledEmailDialogDashboardAttachmentsProps;
+/**
+ * The exact props the default scheduled-email dialog renders its evaluation-mode checkbox with.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export declare function useScheduledEmailDialogEvaluationModeProps(): IScheduledEmailDialogEvaluationModeProps;
+//# sourceMappingURL=useScheduledEmailDialogFieldProps.d.ts.map

package/esm/presentation/automations/scheduledEmail/state/useScheduledEmailDialogFieldProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useScheduledEmailDialogFieldProps.d.ts","sourceRoot":"","sources":["../../../../../src/presentation/automations/scheduledEmail/state/useScheduledEmailDialogFieldProps.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,OAAO,CAAC;AAO3C,OAAO,EACH,KAAK,8CAA8C,EACnD,KAAK,wCAAwC,EAC7C,KAAK,iCAAiC,EACtC,KAAK,oCAAoC,EACzC,KAAK,iCAAiC,EACtC,KAAK,2CAA2C,EACnD,MAAM,aAAa,CAAC;AAkCrB;;;;GAIG;AACH,MAAM,WAAW,4CAA4C;IACzD;;OAEG;IACH,eAAe,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;CACnD;AAED;;;;;;GAMG;AACH,wBAAgB,sCAAsC,CAAC,EACnD,eAAe,EAClB,EAAE,4CAA4C,GAAG,oCAAoC,CAwBrF;AAED;;;;GAIG;AACH,MAAM,WAAW,yCAAyC;IACtD;;OAEG;IACH,eAAe,EAAE,MAAM,IAAI,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,wBAAgB,mCAAmC,CAAC,EAChD,eAAe,EAClB,EAAE,yCAAyC,GAAG,iCAAiC,CAa/E;AAED;;;;;;GAMG;AACH,wBAAgB,mCAAmC,IAAI,iCAAiC,CAQvF;AAED;;;;;;GAMG;AACH,wBAAgB,6CAA6C,IAAI,2CAA2C,CAoC3G;AAED;;;;;;GAMG;AACH,wBAAgB,gDAAgD,IAAI,8CAA8C,CAuBjH;AAED;;;;;;GAMG;AACH,wBAAgB,0CAA0C,IAAI,wCAAwC,CAQrG"}

package/esm/presentation/automations/scheduledEmail/state/useScheduledEmailDialogFieldProps.js

@@ -0,0 +1,168 @@
+// (C) 2026 GoodData Corporation
+import { getTimezoneDisplayLabel } from "@gooddata/sdk-ui-kit";
+import { useAutomationsContext } from "../../contexts/AutomationsContext.js";
+import { useScheduledEmailDialogContext } from "../../contexts/ScheduledEmailDialogContext.js";
+import { getDefaultCronExpression } from "../utils/cron.js";
+import { TIMEZONE_DEFAULT } from "../utils/timezone.js";
+import { useScheduledExportActions } from "./ScheduledExportActionsContext.js";
+import { useScheduledExportDraft } from "./ScheduledExportDraftContext.js";
+import { useScheduledExportAttachments } from "./useScheduledExportAttachments.js";
+import { useScheduledExportDialogValidity } from "./useScheduledExportDialogValidity.js";
+const CLOSE_ON_PARENT_SCROLL = true;
+// Exhaustive by construction: a WidgetAttachmentType member missing here is a type error, so a
+// future union widening fails the build instead of silently narrowing a saved format away.
+const WIDGET_ATTACHMENT_TYPE_FLAGS = {
+    CSV: true,
+    CSV_RAW: true,
+    XLSX: true,
+    PNG: true,
+    PPTX: true,
+    PDF: true,
+    PDF_TABULAR: true,
+    HTML: true,
+};
+const WIDGET_ATTACHMENT_TYPES = new Set(Object.keys(WIDGET_ATTACHMENT_TYPE_FLAGS));
+// Exhaustive by construction: a DashboardAttachmentType member missing here is a type error.
+const DASHBOARD_ATTACHMENT_TYPE_FLAGS = {
+    PDF: true,
+    PDF_SLIDES: true,
+    PPTX: true,
+    XLSX: true,
+};
+const DASHBOARD_ATTACHMENT_TYPES = new Set(Object.keys(DASHBOARD_ATTACHMENT_TYPE_FLAGS));
+/**
+ * The exact props the default scheduled-email dialog renders its recurrence field with.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export function useScheduledEmailDialogRecurrenceProps({ onKeyDownSubmit, }) {
+    const { locale, weekStart, allowHourlyRecurrence, isWhiteLabeled } = useAutomationsContext();
+    const { dateFormat } = useScheduledEmailDialogContext();
+    const { editedAutomation, startDate, isTimezoneFeatureEnabled } = useScheduledExportDraft();
+    const { onRecurrenceChange } = useScheduledExportActions();
+    return {
+        startDate,
+        cronExpression: editedAutomation.schedule?.cron ?? getDefaultCronExpression(startDate),
+        cronDescription: editedAutomation.schedule?.cronDescription,
+        // display-only value; with the timezone feature on, show the friendly label used
+        // by the time zone picker instead of the raw IANA ID
+        timezone: isTimezoneFeatureEnabled
+            ? getTimezoneDisplayLabel(editedAutomation.schedule?.timezone ?? TIMEZONE_DEFAULT.identifier)
+            : (editedAutomation.schedule?.timezone ?? TIMEZONE_DEFAULT.identifier),
+        dateFormat: dateFormat ?? "MM/dd/yyyy",
+        locale,
+        weekStart,
+        allowHourlyRecurrence,
+        isWhiteLabeled,
+        closeDropdownsOnParentScroll: CLOSE_ON_PARENT_SCROLL,
+        onChange: onRecurrenceChange,
+        onKeyDownSubmit,
+    };
+}
+/**
+ * The exact props the default scheduled-email dialog renders its subject field with.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export function useScheduledEmailDialogSubjectProps({ onKeyDownSubmit, }) {
+    const { dashboardTitle } = useScheduledEmailDialogContext();
+    const { editedAutomation } = useScheduledExportDraft();
+    const { onSubjectChange } = useScheduledExportActions();
+    const { isSubmitDisabled } = useScheduledExportDialogValidity();
+    return {
+        dashboardTitle,
+        editedAutomation,
+        isSubmitDisabled,
+        onChange: onSubjectChange,
+        onKeyDownSubmit,
+    };
+}
+/**
+ * The exact props the default scheduled-email dialog renders its message field with.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export function useScheduledEmailDialogMessageProps() {
+    const { editedAutomation } = useScheduledExportDraft();
+    const { onMessageChange } = useScheduledExportActions();
+    return {
+        value: editedAutomation.details?.message ?? "",
+        onChange: onMessageChange,
+    };
+}
+/**
+ * The exact props the default scheduled-email dialog renders its widget-attachments field with.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export function useScheduledEmailDialogWidgetAttachmentsProps() {
+    const { settings, features: { enableSlideshowExports }, } = useAutomationsContext();
+    const { exportTemplates } = useScheduledEmailDialogContext();
+    const { selectedAttachments, xlsxSettings, pdfSettings, csvSettings, csvRawSettings, slidesTemplateIds } = useScheduledExportAttachments();
+    const { onWidgetAttachmentsChange, onXlsxSettingsChange, onPdfSettingsChange, onCsvSettingsChange, onCsvRawSettingsChange, onSlidesTemplateIdChange, } = useScheduledExportActions();
+    return {
+        selectedAttachments: selectedAttachments.filter((attachment) => WIDGET_ATTACHMENT_TYPES.has(attachment)),
+        onWidgetAttachmentsChange,
+        xlsxSettings,
+        onXlsxSettingsChange,
+        pdfSettings,
+        onPdfSettingsChange,
+        csvSettings,
+        onCsvSettingsChange,
+        csvRawSettings,
+        onCsvRawSettingsChange,
+        isSlidesExportEnabled: enableSlideshowExports,
+        isAccessibilityModeEnabled: settings?.enableAccessibilityMode === true,
+        exportTemplates,
+        slidesTemplateIds,
+        onSlidesTemplateIdChange,
+    };
+}
+/**
+ * The exact props the default scheduled-email dialog renders its dashboard-attachments field with.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export function useScheduledEmailDialogDashboardAttachmentsProps() {
+    const { features: { enableSlideshowExports }, } = useAutomationsContext();
+    const { exportTemplates, dashboardFilters, isCrossFiltering } = useScheduledEmailDialogContext();
+    const { selectedAttachments, xlsxSettings, slidesTemplateIds } = useScheduledExportAttachments();
+    const { onDashboardAttachmentsChange, onXlsxSettingsChange, onSlidesTemplateIdChange } = useScheduledExportActions();
+    return {
+        selectedAttachments: selectedAttachments.filter((attachment) => DASHBOARD_ATTACHMENT_TYPES.has(attachment)),
+        dashboardFilters,
+        isCrossFiltering,
+        onDashboardAttachmentsChange,
+        xlsxSettings,
+        onXlsxSettingsChange,
+        isSlidesExportEnabled: enableSlideshowExports,
+        exportTemplates,
+        slidesTemplateIds,
+        onSlidesTemplateIdChange,
+    };
+}
+/**
+ * The exact props the default scheduled-email dialog renders its evaluation-mode checkbox with.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export function useScheduledEmailDialogEvaluationModeProps() {
+    const { editedAutomation } = useScheduledExportDraft();
+    const { onEvaluationModeChange } = useScheduledExportActions();
+    return {
+        isShared: editedAutomation.evaluationMode === "SHARED",
+        onChange: onEvaluationModeChange,
+    };
+}

package/esm/presentation/automations/scheduledEmail/state/useScheduledEmailSubmitOnEnter.d.ts

@@ -0,0 +1,30 @@
+import { type KeyboardEvent } from "react";
+/**
+ * Inputs of {@link useScheduledEmailSubmitOnEnter} — the dialog's single save, from one
+ * {@link useSaveScheduledEmailToBackend} instance.
+ *
+ * @alpha
+ */
+export interface IUseScheduledEmailSubmitOnEnterInput {
+    /**
+     * `handleSaveScheduledEmail` of the dialog's {@link useSaveScheduledEmailToBackend} instance.
+     */
+    onSubmit: () => void;
+    /**
+     * `isSavingScheduledEmail` of the same instance; Enter does nothing while a save is in flight.
+     */
+    isSaving: boolean;
+}
+/**
+ * The Enter-to-submit key handler the default scheduled-export dialog attaches to its title, recipients
+ * and recurrence inputs: calls `onSubmit` on Enter unless the submit button would be disabled — the same
+ * guard {@link useScheduledEmailDialogActionBarProps} puts on the button (form validity, a save in
+ * flight, execution-timestamp mode). Pass the result as `onTitleKeyDown` / `onKeyDownSubmit` to the
+ * header and recipients blocks so every Enter path shares the dialog's one save.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export declare function useScheduledEmailSubmitOnEnter({ onSubmit, isSaving }: IUseScheduledEmailSubmitOnEnterInput): (event: KeyboardEvent) => void;
+//# sourceMappingURL=useScheduledEmailSubmitOnEnter.d.ts.map

package/esm/presentation/automations/scheduledEmail/state/useScheduledEmailSubmitOnEnter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useScheduledEmailSubmitOnEnter.d.ts","sourceRoot":"","sources":["../../../../../src/presentation/automations/scheduledEmail/state/useScheduledEmailSubmitOnEnter.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,aAAa,EAAe,MAAM,OAAO,CAAC;AAQxD;;;;;GAKG;AACH,MAAM,WAAW,oCAAoC;IACjD;;OAEG;IACH,QAAQ,EAAE,MAAM,IAAI,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,8BAA8B,CAAC,EAC3C,QAAQ,EACR,QAAQ,EACX,EAAE,oCAAoC,GAAG,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAavE"}

package/esm/presentation/automations/scheduledEmail/state/useScheduledEmailSubmitOnEnter.js

@@ -0,0 +1,26 @@
+// (C) 2026 GoodData Corporation
+import { useCallback } from "react";
+import { isEnterKey } from "@gooddata/sdk-ui-kit";
+import { useAutomationsContext } from "../../contexts/AutomationsContext.js";
+import { useScheduledExportDialogValidity } from "./useScheduledExportDialogValidity.js";
+/**
+ * The Enter-to-submit key handler the default scheduled-export dialog attaches to its title, recipients
+ * and recurrence inputs: calls `onSubmit` on Enter unless the submit button would be disabled — the same
+ * guard {@link useScheduledEmailDialogActionBarProps} puts on the button (form validity, a save in
+ * flight, execution-timestamp mode). Pass the result as `onTitleKeyDown` / `onKeyDownSubmit` to the
+ * header and recipients blocks so every Enter path shares the dialog's one save.
+ *
+ * Throws outside the scheduled-export dialog's state providers.
+ *
+ * @alpha
+ */
+export function useScheduledEmailSubmitOnEnter({ onSubmit, isSaving, }) {
+    const { isExecutionTimestampMode } = useAutomationsContext();
+    const { isSubmitDisabled } = useScheduledExportDialogValidity();
+    const disabled = isSubmitDisabled || isSaving || isExecutionTimestampMode;
+    return useCallback((event) => {
+        if (isEnterKey(event) && !disabled) {
+            onSubmit();
+        }
+    }, [disabled, onSubmit]);
+}