@sap-ux/preview-middleware 0.5.7 → 0.6.1

package/dist/client/adp/controllers/AddFragment.controller.ts

@@ -0,0 +1,377 @@
+/** sap.m */
+import Input from 'sap/m/Input';
+import Button from 'sap/m/Button';
+import type Dialog from 'sap/m/Dialog';
+import type ComboBox from 'sap/m/ComboBox';
+import MessageToast from 'sap/m/MessageToast';
+
+/** sap.ui.core */
+import { ValueState } from 'sap/ui/core/library';
+import type UI5Element from 'sap/ui/core/Element';
+import Controller from 'sap/ui/core/mvc/Controller';
+
+/** sap.ui.base */
+import type Event from 'sap/ui/base/Event';
+import type ManagedObject from 'sap/ui/base/ManagedObject';
+import type ManagedObjectMetadata from 'sap/ui/base/ManagedObjectMetadata';
+
+/** sap.ui.model */
+import JSONModel from 'sap/ui/model/json/JSONModel';
+
+/** sap.ui.rta */
+import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
+
+/** sap.ui.dt */
+import OverlayRegistry from 'sap/ui/dt/OverlayRegistry';
+import type ElementOverlay from 'sap/ui/dt/ElementOverlay';
+
+import ControlUtils from '../control-utils';
+import CommandExecutor from '../command-executor';
+import { ManifestAppdescr, getFragments, getManifestAppdescr, writeFragment } from '../api-handler';
+
+interface CreateFragmentProps {
+    fragmentName: string;
+    index: string | number;
+    targetAggregation: string;
+}
+
+/**
+ * @namespace open.ux.preview.client.adp.controllers
+ */
+export default class AddFragment extends Controller {
+    /**
+     * Runtime control managed object
+     */
+    public runtimeControl: ManagedObject;
+    /**
+     * JSON Model that has the data
+     */
+    public model: JSONModel;
+    /**
+     * Dialog instance
+     */
+    public dialog: Dialog;
+    /**
+     * Runtime Authoring
+     */
+    private rta: RuntimeAuthoring;
+    /**
+     * Control Overlays
+     */
+    private overlays: UI5Element;
+    /**
+     * RTA Command Executor
+     */
+    private commandExecutor: CommandExecutor;
+
+    constructor(name: string, overlays: UI5Element, rta: RuntimeAuthoring) {
+        super(name);
+        this.rta = rta;
+        this.overlays = overlays;
+        this.commandExecutor = new CommandExecutor(this.rta);
+    }
+
+    /**
+     * Initializes controller, fills model with data and opens the dialog
+     */
+    async onInit() {
+        this.model = new JSONModel();
+
+        this.dialog = this.byId('addNewFragmentDialog') as unknown as Dialog;
+
+        await this.buildDialogData();
+
+        this.getView()?.setModel(this.model);
+
+        this.dialog.open();
+    }
+
+    /**
+     * Handles the change in aggregations
+     *
+     * @param event Event
+     */
+    onAggregationChanged(event: Event) {
+        const source = event.getSource<ComboBox>();
+
+        const selectedKey = source.getSelectedKey();
+        const selectedItem = source.getSelectedItem();
+
+        let selectedItemText = '';
+        if (selectedItem) {
+            selectedItemText = selectedItem.getText();
+        }
+
+        this.model.setProperty('/selectedAggregation/key', selectedKey);
+        this.model.setProperty('/selectedAggregation/value', selectedItemText);
+
+        let newSelectedControlChildren: string[] | number[] = Object.keys(
+            ControlUtils.getControlAggregationByName(this.runtimeControl, selectedItemText)
+        );
+
+        newSelectedControlChildren = newSelectedControlChildren.map((key) => {
+            return parseInt(key);
+        });
+
+        const updatedIndexArray: { key: number; value: number }[] = this.fillIndexArray(newSelectedControlChildren);
+
+        this.model.setProperty('/index', updatedIndexArray);
+        this.model.setProperty('/selectedIndex', updatedIndexArray.length - 1);
+    }
+
+    /**
+     * Handles the change in target indexes
+     *
+     * @param event Event
+     */
+    onIndexChanged(event: Event) {
+        const source = event.getSource<ComboBox>();
+        const selectedIndex = source.getSelectedItem()?.getText();
+        this.model.setProperty('/selectedIndex', selectedIndex);
+    }
+
+    /**
+     * Handles fragment name input change
+     *
+     * @param event Event
+     */
+    onFragmentNameInputChange(event: Event) {
+        const source = event.getSource<Input>();
+
+        const fragmentName: string = source.getValue().trim();
+        const fragmentList: { fragmentName: string }[] = this.model.getProperty('/fragmentList');
+
+        if (fragmentName.length <= 0) {
+            this.dialog.getBeginButton().setEnabled(false);
+            source.setValueState(ValueState.None);
+            this.model.setProperty('/newFragmentName', null);
+        } else {
+            const fileExists = fragmentList.find((f: { fragmentName: string }) => {
+                return f.fragmentName === `${fragmentName}.fragment.xml`;
+            });
+
+            const isValidName = /^[a-zA-Z_][a-zA-Z0-9_-]*$/.test(fragmentName);
+
+            if (fileExists) {
+                source.setValueState(ValueState.Error);
+                source.setValueStateText(
+                    'Enter a different name. The fragment name that you entered already exists in your project.'
+                );
+                this.dialog.getBeginButton().setEnabled(false);
+            } else if (!isValidName) {
+                source.setValueState(ValueState.Error);
+                source.setValueStateText('A Fragment Name cannot contain white spaces or special characters.');
+                this.dialog.getBeginButton().setEnabled(false);
+            } else {
+                this.dialog.getBeginButton().setEnabled(true);
+                source.setValueState(ValueState.None);
+                this.model.setProperty('/newFragmentName', fragmentName);
+            }
+        }
+    }
+
+    /**
+     * Handles create button press
+     *
+     * @param event Event
+     */
+    async onCreateBtnPress(event: Event) {
+        const source = event.getSource<Button>();
+        source.setEnabled(false);
+
+        const fragmentName = this.model.getProperty('/newFragmentName');
+        const index = parseInt(this.model.getProperty('/selectedIndex'));
+        const targetAggregation = this.model.getProperty('/selectedAggregation/value');
+        const fragmentData = {
+            index,
+            fragmentName,
+            targetAggregation
+        };
+
+        await this.createNewFragment(fragmentData);
+
+        this.handleDialogClose();
+    }
+
+    /**
+     * Handles the closing of the dialog
+     */
+    closeDialog() {
+        this.handleDialogClose();
+    }
+
+    /**
+     * Handles the dialog closing and destruction of it
+     */
+    handleDialogClose() {
+        this.dialog.close();
+        this.getView()?.destroy();
+    }
+
+    /**
+     * Builds data that is used in the dialog
+     */
+    async buildDialogData(): Promise<void> {
+        const selectorId = this.overlays.getId();
+
+        let controlMetadata: ManagedObjectMetadata;
+
+        const overlayControl = sap.ui.getCore().byId(selectorId) as unknown as ElementOverlay;
+        if (overlayControl) {
+            this.runtimeControl = ControlUtils.getRuntimeControl(overlayControl);
+            controlMetadata = this.runtimeControl.getMetadata();
+        } else {
+            throw new Error('Cannot get overlay control');
+        }
+
+        const allAggregations = Object.keys(controlMetadata.getAllAggregations());
+        const hiddenAggregations = ['customData', 'layoutData', 'dependents'];
+        const targetAggregation = allAggregations.filter((item) => {
+            if (hiddenAggregations.indexOf(item) === -1) {
+                return item;
+            }
+            return false;
+        });
+        const defaultAggregation = controlMetadata.getDefaultAggregationName();
+        const selectedControlName = controlMetadata.getName();
+
+        let selectedControlChildren: string[] | number[] = Object.keys(
+            ControlUtils.getControlAggregationByName(this.runtimeControl, defaultAggregation)
+        );
+
+        selectedControlChildren = selectedControlChildren.map((key) => {
+            return parseInt(key);
+        });
+
+        this.model.setProperty('/selectedControlName', selectedControlName);
+        this.model.setProperty('/selectedAggregation', {});
+
+        const indexArray = this.fillIndexArray(selectedControlChildren);
+
+        const controlAggregation: { key: string | number; value: string | number }[] = targetAggregation.map(
+            (elem, index) => {
+                return { key: index, value: elem };
+            }
+        );
+
+        if (defaultAggregation !== null) {
+            controlAggregation.forEach((obj) => {
+                if (obj.value === defaultAggregation) {
+                    obj.key = 'default';
+                    this.model.setProperty('/selectedAggregation/key', obj.key);
+                    this.model.setProperty('/selectedAggregation/value', obj.value);
+                }
+            });
+        } else {
+            this.model.setProperty('/selectedAggregation/key', controlAggregation[0].key);
+            this.model.setProperty('/selectedAggregation/value', controlAggregation[0].value);
+        }
+
+        try {
+            const { fragments } = await getFragments();
+
+            this.model.setProperty('/fragmentList', fragments);
+        } catch (e) {
+            throw new Error(e.message);
+        }
+
+        this.model.setProperty('/selectedIndex', indexArray.length - 1);
+        this.model.setProperty('/targetAggregation', controlAggregation);
+        this.model.setProperty('/index', indexArray);
+    }
+
+    /**
+     * Fills indexArray from selected control children
+     *
+     * @param selectedControlChildren Array of numbers
+     * @returns Array of key value pairs
+     */
+    private fillIndexArray(selectedControlChildren: number[]) {
+        let indexArray: { key: number; value: number }[] = [];
+        if (selectedControlChildren.length === 0) {
+            indexArray.push({ key: 0, value: 0 });
+        } else {
+            indexArray = selectedControlChildren.map((elem, index) => {
+                return { key: index + 1, value: elem + 1 };
+            });
+            indexArray.unshift({ key: 0, value: 0 });
+            indexArray.push({
+                key: selectedControlChildren.length + 1,
+                value: selectedControlChildren.length + 1
+            });
+        }
+        return indexArray;
+    }
+
+    /**
+     * Creates a new fragment for the specified control
+     *
+     * @param fragmentData Fragment Data
+     * @param fragmentData.index Index for XML Fragment placement
+     * @param fragmentData.fragmentName Fragment name
+     * @param fragmentData.targetAggregation Target aggregation for control
+     */
+    private async createNewFragment(fragmentData: CreateFragmentProps): Promise<void> {
+        const { fragmentName, index, targetAggregation } = fragmentData;
+        try {
+            await writeFragment<unknown>({ fragmentName });
+            MessageToast.show(`Fragment with name '${fragmentName}' was created.`);
+        } catch (e) {
+            // In case of error when creating a new fragment, we should not create a change file
+            MessageToast.show(e.message);
+            throw new Error(e.message);
+        }
+
+        await this.createFragmentChange({ fragmentName, index, targetAggregation });
+    }
+
+    /**
+     * Creates an addXML fragment command and pushes it to the command stack
+     *
+     * @param fragmentData Fragment Data
+     */
+    private async createFragmentChange(fragmentData: CreateFragmentProps) {
+        const { fragmentName, index, targetAggregation } = fragmentData;
+        let manifest: ManifestAppdescr;
+        try {
+            manifest = await getManifestAppdescr();
+
+            if (!manifest) {
+                // Highly unlikely since adaptation projects are required to have manifest.appdescr_variant
+                throw new Error('Could not retrieve manifest');
+            }
+        } catch (e) {
+            MessageToast.show(e.message);
+            throw new Error(e.message);
+        }
+
+        const { id, reference, namespace, layer } = manifest;
+
+        const flexSettings = {
+            baseId: reference,
+            developerMode: true,
+            layer: layer,
+            namespace: namespace,
+            projectId: id,
+            rootNamespace: namespace.split('/').slice(0, 2).join('/'),
+            scenario: undefined
+        };
+
+        const overlay = OverlayRegistry.getOverlay(this.runtimeControl as UI5Element);
+        const designMetadata = overlay.getDesignTimeMetadata();
+
+        const modifiedValue = {
+            fragmentPath: `fragments/${fragmentName}.fragment.xml`,
+            index: index ?? 0,
+            targetAggregation: targetAggregation ?? 'content'
+        };
+
+        await this.commandExecutor.generateAndExecuteCommand(
+            this.runtimeControl,
+            'addXML',
+            modifiedValue,
+            designMetadata,
+            flexSettings
+        );
+    }
+}

package/dist/client/adp/init-dialogs.js

@@ -0,0 +1,51 @@
+"use strict";
+
+sap.ui.define(["sap/ui/core/mvc/XMLView", "./controllers/AddFragment.controller"], function (XMLView, __AddFragment) {
+  "use strict";
+
+  function _interopRequireDefault(obj) {
+    return obj && obj.__esModule && typeof obj.default !== "undefined" ? obj.default : obj;
+  }
+  const AddFragment = _interopRequireDefault(__AddFragment);
+  var DialogNames = /*#__PURE__*/function (DialogNames) {
+    DialogNames["ADD_FRAGMENT"] = "AddFragment";
+    return DialogNames;
+  }(DialogNames || {});
+  /**
+   * Adds a new item to the context menu
+   *
+   * @param rta Runtime Authoring
+   */
+  const initDialogs = rta => {
+    const contextMenu = rta.getDefaultPlugins().contextMenu;
+    contextMenu.addMenuItem({
+      id: 'ADD_FRAGMENT',
+      text: 'Add: Fragment',
+      handler: async overlays => await handler(overlays[0], rta, DialogNames.ADD_FRAGMENT),
+      icon: 'sap-icon://attachment-html'
+    });
+  };
+
+  /**
+   * Handler for new context menu entry
+   *
+   * @param overlays Control overlays
+   * @param rta Runtime Authoring
+   * @param dialogName Dialog name
+   */
+  async function handler(overlays, rta, dialogName) {
+    const controller = new AddFragment(`open.ux.preview.client.adp.controllers.${dialogName}`, overlays, rta);
+    await XMLView.create({
+      viewName: `open.ux.preview.client.adp.ui.${dialogName}`,
+      controller
+    });
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.DialogNames = DialogNames;
+  __exports.initDialogs = initDialogs;
+  __exports.handler = handler;
+  return __exports;
+});
+//# sourceMappingURL=init-dialogs.js.map

package/dist/client/adp/init-dialogs.ts

@@ -0,0 +1,43 @@
+/** sap.ui.core */
+import XMLView from 'sap/ui/core/mvc/XMLView';
+import type UI5Element from 'sap/ui/core/Element';
+
+/** sap.ui.rta */
+import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
+import AddFragment from './controllers/AddFragment.controller';
+
+export const enum DialogNames {
+    ADD_FRAGMENT = 'AddFragment'
+}
+
+/**
+ * Adds a new item to the context menu
+ *
+ * @param rta Runtime Authoring
+ */
+export const initDialogs = (rta: RuntimeAuthoring): void => {
+    const contextMenu = rta.getDefaultPlugins().contextMenu;
+
+    contextMenu.addMenuItem({
+        id: 'ADD_FRAGMENT',
+        text: 'Add: Fragment',
+        handler: async (overlays: UI5Element[]) => await handler(overlays[0], rta, DialogNames.ADD_FRAGMENT),
+        icon: 'sap-icon://attachment-html'
+    });
+};
+
+/**
+ * Handler for new context menu entry
+ *
+ * @param overlays Control overlays
+ * @param rta Runtime Authoring
+ * @param dialogName Dialog name
+ */
+export async function handler(overlays: UI5Element, rta: RuntimeAuthoring, dialogName: DialogNames): Promise<void> {
+    const controller = new AddFragment(`open.ux.preview.client.adp.controllers.${dialogName}`, overlays, rta);
+
+    await XMLView.create({
+        viewName: `open.ux.preview.client.adp.ui.${dialogName}`,
+        controller
+    });
+}

package/dist/client/adp/init.js

@@ -1,17 +1,19 @@
 "use strict";
 
-sap.ui.define(["../cpe/init", "sap/base/Log"], function (__init, log) {
+sap.ui.define(["sap/base/Log", "../cpe/init", "./init-dialogs"], function (log, __init, ___init_dialogs) {
   "use strict";
 
   function _interopRequireDefault(obj) {
     return obj && obj.__esModule && typeof obj.default !== "undefined" ? obj.default : obj;
   }
   const init = _interopRequireDefault(__init);
+  const initDialogs = ___init_dialogs["initDialogs"];
   var __exports = function (rta) {
-    // custom adaptation project plugin code goes here
-    log.debug('ADP init executed.');
+    // initialize fragment content menu entry
+    initDialogs(rta);
     // also initialize the editor
     init(rta);
+    log.debug('ADP init executed.');
   };
   return __exports;
 });

package/dist/client/adp/init.ts

@@ -1,10 +1,12 @@
+import log from 'sap/base/Log';
 import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
 import init from '../cpe/init';
-import log from 'sap/base/Log';
+import { initDialogs } from './init-dialogs';
 
-export default function(rta: RuntimeAuthoring) {
-    // custom adaptation project plugin code goes here
-    log.debug('ADP init executed.');
+export default function (rta: RuntimeAuthoring) {
+    // initialize fragment content menu entry
+    initDialogs(rta);
     // also initialize the editor
     init(rta);
-}
+    log.debug('ADP init executed.');
+}

package/dist/client/adp/ui/AddFragment.view.xml

@@ -0,0 +1,59 @@
+<mvc:View xmlns:mvc="sap.ui.core.mvc"
+    xmlns="sap.m"
+    xmlns:core="sap.ui.core"
+    xmlns:f="sap.ui.layout.form">
+        <Dialog id="addNewFragmentDialog" title="Add XML Fragment" contentWidth="500px" class="sapUiRTABorder">
+            <content>
+                <f:SimpleForm id="addNewFragmentDialog_Form"
+                    editable="true"
+                    layout="ResponsiveGridLayout"
+                    labelSpanS="4"
+                    singleContainerFullSize="false">
+                    <f:content>
+                        <Label text="Control Type" />
+                        <Text text="{/selectedControlName}" />
+                        <Label text="Target Aggregation" />
+                        <ComboBox
+                            change="onAggregationChanged"
+                            selectedKey="{/selectedAggregation/key}"
+                            items="{
+                                path: '/targetAggregation',
+                                sorter: { path: 'text' }
+                            }">
+                            <core:Item key="{key}" text="{value}" />
+                        </ComboBox>
+                        <Label text="Index" />
+                        <ComboBox
+                            selectedKey='{/selectedIndex}'
+                            items="{
+                                path: '/index',
+                                sorter: { path: 'text' }
+                            }">
+                            <core:Item key="{key}" text="{value}" />
+                        </ComboBox>
+                        <Label text="Fragment Name" />
+                        <Input 
+                            description=".fragment.xml" 
+                            value="{/newFragmentName}" 
+                            liveChange="onFragmentNameInputChange">
+                        </Input>
+                    </f:content>
+                </f:SimpleForm>
+            </content>
+            <beginButton>
+                <Button 
+                    id="createDialogBtn" 
+                    text="Create"
+                    press="onCreateBtnPress"
+                    enabled="false"
+                    type="Emphasized" />
+            </beginButton>
+            <endButton>
+                <Button 
+                    id="closeDialogBtn" 
+                    text="Cancel"
+                    press="closeDialog"
+                    type="Reject" />
+            </endButton>
+        </Dialog>
+</mvc:View>