@sapui5/sap.suite.ui.generic.template 1.148.0 → 1.148.2

package/src/sap/suite/ui/generic/template/lib/ai/EasyFill/EasyFillDialogController.js

@@ -0,0 +1,358 @@
+sap.ui.define([
+    "sap/ui/model/json/JSONModel",
+    "sap/m/MessageToast",
+    "sap/suite/ui/generic/template/genericUtilities/FeLogger",
+    "sap/suite/ui/generic/template/genericUtilities/FeError",
+    "sap/ui/core/ResizeHandler"
+], function(JSONModel, MessageToast, FeLogger, FeError, ResizeHandler) {
+    "use strict";
+
+    var sClassName = "lib.ai.EasyFill.EasyFillDialogController";
+    var oLogger = new FeLogger(sClassName).getLogger();
+
+    /**
+     * EasyFillDialogController
+     *
+     * Responsible for all EasyFill dialog lifecycle concerns:
+     * 1. Initializing and registering the easyFillDialogModel on the view (once per view lifetime).
+     * 2. Loading and opening the EasyFillDialog fragment with all event handler and formatter bindings.
+     * 3. Handling pure UI events: mode toggle, fullscreen, feedback, cancel, clear, AI Notice popover.
+     * 4. Providing formatter functions used by XML bindings in the dialog fragment.
+     *
+     * This module contains no OData, field collection, or AI call logic.
+     * All data operations are delegated to EasyFillAIOrchestrator, EasyFillFormRenderer,
+     * EasyFillTableRenderer, and EasyFillApplyHandler.
+     */
+    return {
+
+        /**
+         * Initializes the easyFillDialogModel on the view if it has not already been created.
+         * Also registers the "EasyFillFETransientChanges" deferred group on the OData model
+         * so that no batch calls are triggered until the user explicitly confirms.
+         *
+         * Should be called once before the dialog is opened for the first time.
+         *
+         * @param {object} oController - MVC controller (used to get the view and set the model)
+         * @param {object} oObjectPageModel - the OData model (used to register the deferred group)
+         * @param {object} oEasyFillLayoutMode - EasyFillLayoutMode enum
+         */
+        initDialogModel: function(oController, oObjectPageModel, oEasyFillLayoutMode) {
+            var bIsModelCreated = !!oController.getView().getModel("easyFillDialogModel");
+            if (bIsModelCreated) {
+                return; // Already initialized — nothing to do
+            }
+
+            // Register a deferred group so AI-staged changes are not submitted until confirmaton
+            var aDeferredGroups = oObjectPageModel.getDeferredGroups();
+            aDeferredGroups.push("EasyFillFETransientChanges");
+            oObjectPageModel.setDeferredGroups(aDeferredGroups);
+
+            // Initial model state — all fields set to their "empty / waiting for AI" defaults
+            var oData = {
+                isBusy: false,
+                isFormVisible: false,
+                isIllustrationVisible: true,
+                isSaveEnabled: false,
+                stateType: "Initial",
+                feedbackEnabled: true,
+                feedbackPressedUp: false,
+                feedbackPressedDown: false,
+                isEasyFillButtonEnabled: false,
+                llmData: {},
+                updatableFields: {},
+                nonUpdatableFields: {},
+                hasNonUpdatableFields: false,
+                easyFillMode: oEasyFillLayoutMode.CondensedMode,
+                sections: [],
+                isFullScreen: true,
+                hasTableUpdates: false,
+                attemptedMultipleNewRows: false,
+                isSplitterPageMode: false
+            };
+
+            oController.getView().setModel(new JSONModel(oData), "easyFillDialogModel");
+            oLogger.debug("initDialogModel: easyFillDialogModel created and registered on view");
+        },
+
+        /**
+         * Loads the EasyFillDialog fragment (if not already loaded) and opens it.
+         * Registers all event handlers and formatters on the fragment controller object.
+         *
+         * The dialog is kept alive after first open (not destroyed on close) so that the
+         * ObjectPageLayout and SmartForm structures are preserved between invocations.
+         *
+         * @param {object} oController - MVC controller
+         * @param {object} oTemplateUtils - FE template utilities (used for getDialogFragmentAsync)
+         * @param {object} oHandlers - map of event handler and formatter functions to bind to the fragment
+         * @returns {Promise<void>}
+         */
+        openDialog: function(oController, oTemplateUtils, oHandlers) {
+            var sFragmentName = "sap.suite.ui.generic.template.lib.ai.EasyFill.fragments.EasyFillDialog";
+
+            return oTemplateUtils.oCommonUtils.getDialogFragmentAsync(
+                sFragmentName,
+                oHandlers,
+                "easyFillPopup",
+                undefined,
+                true,  // keep alive — do not destroy on close
+                true   // use view as parent
+            ).then(function(oDialog) {
+                oDialog.open();
+
+                // Register a ResizeHandler on the ResponsiveSplitter
+                // The dialog is kept alive across opens so we must not register more than once.
+                if (!oDialog._easyFillResizeHandlerId) {
+                    oDialog.attachEventOnce("afterOpen", function() {
+                        // Locate the splitter by its stable fragment ID
+                        var oSplitter = oController.byId("EasyFillMainFlex") &&
+                            oController.byId("EasyFillMainFlex").findAggregatedObjects(true, function(o) {
+                                return o.isA("sap.ui.layout.ResponsiveSplitter");
+                            })[0];
+
+                        if (oSplitter) {
+                            var oDialogModel = oController.getView().getModel("easyFillDialogModel");
+                            // sapUiRSVisiblePaginator is added/removed by the splitter itself on resize
+                            oDialog._easyFillResizeHandlerId = ResizeHandler.register(oSplitter, function() {
+                                var bInPageMode = oSplitter.$().hasClass("sapUiRSVisiblePaginator");
+                                oDialogModel.setProperty("/isSplitterPageMode", bInPageMode);
+                                if (bInPageMode && !oDialogModel.getProperty("/isFullScreen")) {
+                                    // Reset fullscreen state so pane sizes are correct when dialog is widened again
+                                    oDialogModel.setProperty("/isFullScreen", true);
+                                    oController.byId("inputAreaSplitPane").getLayoutData().setSize("40%");
+                                    oController.byId("reviewAreaSplitPane").getLayoutData().setSize("60%");
+                                }
+                            });
+                        }
+                    });
+                }
+
+                oLogger.debug("openDialog: EasyFillDialog opened");
+            });
+        },
+
+        /**
+         * Closes the EasyFill dialog if it is currently open.
+         *
+         * @param {object} oController - MVC controller
+         */
+        closeDialog: function(oController) {
+            var oDialog = oController.byId("EasyFillDialog");
+            if (oDialog && oDialog.isOpen()) {
+                oDialog.close();
+                // Reset page-mode flag so the button is visible on the next open
+                oController.getView().getModel("easyFillDialogModel").setProperty("/isSplitterPageMode", false);
+                oLogger.debug("closeDialog: EasyFillDialog closed");
+            }
+        },
+
+        // ─── Event Handlers (bound to the fragment controller object) ────────────
+
+        /**
+         * Handles the layout mode SegmentedButton selection change (Condensed ↔ ObjectPage view).
+         * Re-builds the sections array in the dialog model for the selected mode.
+         *
+         * @param {sap.ui.base.Event} oEvent
+         * @param {object} oController - MVC controller
+         * @param {object} oTemplateUtils - FE template utilities (for entity type lookup)
+         * @param {object} oRb - i18n resource bundle
+         * @param {object} oFieldCollector - EasyFillFieldCollector
+         * @param {object} oEasyFillLayoutMode - EasyFillLayoutMode enum
+         */
+        onSelectionChange: function(oEvent, oController, oTemplateUtils, oRb, oFieldCollector, oEasyFillLayoutMode) {
+            var sSelectedKey = oEvent.getSource().getSelectedKey();
+            var oDialogModel = oController.getView().getModel("easyFillDialogModel");
+            var oEntityType = oTemplateUtils.oCommonUtils.getMetaModelEntityType(
+                oController.getOwnerComponent().getEntitySet()
+            );
+            oDialogModel.setProperty("/easyFillMode", sSelectedKey);
+            var oLLMResult = oDialogModel.getProperty("/llmData") || {};
+            // Use stored updatable subset when available; fall back to full LLM result
+            // only when it is absent (e.g. before the first AI submit).
+            // Important: an empty map is a valid state (all fields are non-updatable)
+            // and must not trigger fallback, otherwise non-updatable fields appear as filled.
+            var oStoredUpdatable = oDialogModel.getProperty("/updatableFields");
+            var oUpdatableFields = (oStoredUpdatable !== undefined && oStoredUpdatable !== null)
+                ? oStoredUpdatable
+                : oLLMResult;
+            var oNonUpdatableFields = oDialogModel.getProperty("/nonUpdatableFields") || {};
+            var aData = (sSelectedKey === oEasyFillLayoutMode.CondensedMode)
+                ? oFieldCollector.getSectionsForCondensedView(oLLMResult, oUpdatableFields, oNonUpdatableFields)
+                : oFieldCollector.getSectionsForObjectPageView(oEntityType, oLLMResult, oRb, oNonUpdatableFields);
+            oDialogModel.setProperty("/sections", aData);
+        },
+
+        /**
+         * Handles the feedback button press.
+         * Disables the feedback buttons and shows a thank-you toast.
+         *
+         * @param {object} oController - MVC controller
+         * @param {object} oRb - i18n resource bundle
+         */
+        onFeedbackPress: function(oController, oRb) {
+            var oDialogModel = oController.getView().getModel("easyFillDialogModel");
+            oDialogModel.setProperty("/feedbackEnabled", false);
+            MessageToast.show(oRb.getText("EASYFILL_RESULT_FEEDBACK"));
+        },
+
+        /**
+         * Handles the live change event on the input text area.
+         * Enforces the 2000 character limit by truncating excess input.
+         * Enables/disables the "Easy Fill" submit button based on whether there is any input.
+         *
+         * @param {sap.ui.base.Event} oEvent
+         * @param {object} oController - MVC controller
+         */
+        onLiveChange: function(oEvent, oController) {
+            var oTextArea = oEvent.getSource();
+            var sValue = oTextArea.getValue();
+            var iMaxLength = 2000;
+
+            // Enforce character limit by truncating excess input
+            if (sValue && sValue.length > iMaxLength) {
+                sValue = sValue.substring(0, iMaxLength);
+                oTextArea.setValue(sValue);
+            }
+
+            var oDialogModel = oController.getView().getModel("easyFillDialogModel");
+            oDialogModel.setProperty("/isEasyFillButtonEnabled", !!sValue);
+        },
+
+        /**
+         * Handles the fullscreen toggle button press.
+         * Adjusts the SplitPane layout data sizes to show only the review area or both panes.
+         *
+         * @param {object} oController - MVC controller
+         */
+        onToggleFullScreen: function(oController) {
+            var oDialogModel = oController.getView().getModel("easyFillDialogModel");
+            var bIsFullScreen = oDialogModel.getProperty("/isFullScreen");
+            oDialogModel.setProperty("/isFullScreen", !bIsFullScreen);
+
+            if (bIsFullScreen) {
+                // Collapse input pane to show only the review area
+                oController.byId("inputAreaSplitPane").getLayoutData().setSize("0%");
+                oController.byId("reviewAreaSplitPane").getLayoutData().setSize("100%");
+            } else {
+                // Restore split view
+                oController.byId("inputAreaSplitPane").getLayoutData().setSize("40%");
+                oController.byId("reviewAreaSplitPane").getLayoutData().setSize("60%");
+            }
+        },
+
+        /**
+         * Handles the "AI Notice" link press by lazily loading and opening the AINotice popover.
+         *
+         * @param {sap.ui.base.Event} oEvent
+         * @param {object} oTemplateUtils - FE template utilities (for fragment loading)
+         * @param {object} oAIPopoverRef - mutable ref object: { popover: null } — used to cache the popover
+         * @returns {Promise<void>}
+         */
+        onLinkPress: async function(oEvent, oTemplateUtils, oAIPopoverRef) {
+            if (!oAIPopoverRef.popover) {
+                oAIPopoverRef.popover = await this.getAIPopover(oTemplateUtils);
+            }
+            oAIPopoverRef.popover.openBy(oEvent.getSource());
+        },
+
+        // ─── Fragment / Popover Loading ───────────────────────────────────────────
+
+        /**
+         * Lazily loads the AINotice popover fragment and returns it.
+         * The popover is kept alive after first creation.
+         *
+         * @param {object} oTemplateUtils - FE template utilities (for getDialogFragmentAsync)
+         * @returns {Promise<sap.m.Popover>}
+         */
+        getAIPopover: function(oTemplateUtils) {
+            return oTemplateUtils.oCommonUtils.getDialogFragmentAsync(
+                "sap.suite.ui.generic.template.fragments.AINotice",
+                {
+                    onCloseAiPopover: function(oEvent) {
+                        var oControl = oEvent && oEvent.getSource && oEvent.getSource();
+                        while (oControl && !(oControl.isA && oControl.isA("sap.m.Popover"))) {
+                            oControl = oControl.getParent && oControl.getParent();
+                        }
+                        if (oControl && oControl.close) {
+                            oControl.close();
+                        }
+                    }
+                },
+                "aiPopover",
+                undefined,
+                true  // keep alive
+            );
+        },
+
+        // ─── Formatters (used in XML fragment bindings) ───────────────────────────
+
+        /**
+         * Resolves an i18n key pattern in a section title string.
+         * Matches {@i18n>SomeKey} or {i18n>SomeKey} patterns and replaces them with the translated text.
+         * Returns the title as-is if no i18n pattern is found.
+         *
+         * @param {string} sTitle - raw title string (may contain i18n pattern)
+         * @param {object} oController - MVC controller (used to access the i18n model)
+         * @returns {string}
+         */
+        formatSectionTitle: function(sTitle, oController) {
+            if (!sTitle) { return ""; }
+
+            var oResourceBundle = oController.getView().getModel("i18n").getResourceBundle();
+
+            // Handle i18n pattern in title
+            var oMatch = sTitle.match(/\{@?i18n>([^}]+)\}/);
+            if (oMatch) {
+                var sKey = oMatch[1];
+                return oResourceBundle.getText(sKey);
+            }
+            return sTitle;
+        },
+
+        /**
+         * Returns the IllustratedMessage illustration type string for a given dialog state.
+         *
+         * @param {string} sState - one of "Initial" | "NoEntries" | "Error"
+         * @returns {string} SAP illustration type string
+         */
+        formatIllustrationType: function(sState) {
+            switch (sState) {
+                case "Initial": return "sapIllus-NoSearchResults";
+                case "NoEntries": return "sapIllus-NoEntries";
+                case "Error": return "sapIllus-UnableToLoad";
+                default: return "sapIllus-NoSearchResults";
+            }
+        },
+
+        /**
+         * Returns the IllustratedMessage title i18n text for a given dialog state.
+         *
+         * @param {string} sState - one of "Initial" | "NoEntries" | "Error"
+         * @param {object} oRb - i18n resource bundle
+         * @returns {string}
+         */
+        formatIllustrationTitle: function(sState, oRb) {
+            switch (sState) {
+                case "Initial": return oRb.getText("EASY_FILL_ILLUSTRATION_TITLE_INITIAL");
+                case "NoEntries": return oRb.getText("EASY_FILL_ILLUSTRATION_TITLE_NO_ENTRIES");
+                case "Error": return oRb.getText("EASY_FILL_ILLUSTRATION_TITLE_ERROR");
+                default: return oRb.getText("EASY_FILL_ILLUSTRATION_TITLE_INITIAL");
+            }
+        },
+
+        /**
+         * Returns the IllustratedMessage description i18n text for a given dialog state.
+         *
+         * @param {string} sState - one of "Initial" | "NoEntries" | "Error"
+         * @param {object} oRb - i18n resource bundle
+         * @returns {string}
+         */
+        formatIllustrationDescription: function(sState, oRb) {
+            switch (sState) {
+                case "Initial": return oRb.getText("EASY_FILL_ILLUSTRATION_DESCRIPTION_INITIAL");
+                case "NoEntries": return oRb.getText("EASY_FILL_ILLUSTRATION_DESCRIPTION_NO_ENTRIES");
+                case "Error": return oRb.getText("EASY_FILL_ILLUSTRATION_DESCRIPTION_ERROR");
+                default: return oRb.getText("EASY_FILL_ILLUSTRATION_DESCRIPTION_INITIAL");
+            }
+        }
+    };
+});