@sap-ux/preview-middleware 0.19.28 → 0.19.30

package/dist/base/flp.d.ts

@@ -4,7 +4,7 @@ import type { Request, Router } from 'express';
 import type { Logger, ToolsLogger } from '@sap-ux/logger';
 import type { MiddlewareUtils } from '@ui5/server';
 import { type Manifest } from '@sap-ux/project-access';
-import { AdpPreview, type AdpPreviewConfig, type CommonChangeProperties, type OperationType } from '@sap-ux/adp-tooling';
+import { AdpPreview, type AdpPreviewConfig, type CommonChangeProperties, type OperationType, type CommonAdditionalChangeInfoProperties } from '@sap-ux/adp-tooling';
 import type { FlpConfig, MiddlewareConfig, RtaConfig, TestConfig } from '../types';
 import { type TemplateConfig } from './config';
 /**
@@ -21,7 +21,7 @@ export type EnhancedRequest = Request & {
         baseUrl?: string;
     };
 };
-type OnChangeRequestHandler = (type: OperationType, change: CommonChangeProperties, fs: MemFsEditor, logger: Logger) => Promise<void>;
+type OnChangeRequestHandler = (type: OperationType, change: CommonChangeProperties, fs: MemFsEditor, logger: Logger, extendedChange?: CommonAdditionalChangeInfoProperties) => Promise<void>;
 /**
  * Class handling preview of a sandbox FLP.
  */

package/dist/base/flp.js

@@ -464,11 +464,11 @@ class FlpSandbox {
     async flexPostHandler(req, res) {
         this.fs = this.fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
         try {
-            const change = req.body;
+            const body = req.body;
             if (this.onChangeRequest) {
-                await this.onChangeRequest('write', change, this.fs, this.logger);
+                await this.onChangeRequest('write', body.change, this.fs, this.logger, body.additionalChangeInfo);
             }
-            const { success, message } = (0, flex_1.writeChange)(change, this.utils.getProject().getSourcePath(), this.fs, this.logger);
+            const { success, message } = (0, flex_1.writeChange)(body.change, this.utils.getProject().getSourcePath(), this.fs, this.logger);
             if (success) {
                 this.fs.commit(() => this.sendResponse(res, 'text/plain', 200, message ?? ''));
             }

package/dist/client/adp/add-fragment.js

@@ -0,0 +1,48 @@
+"use strict";
+
+sap.ui.define(["sap/ui/rta/command/CommandFactory", "./utils", "./dialog-factory", "sap/ui/rta/plugin/AddXMLPlugin"], function (CommandFactory, ___utils, ___dialog_factory, AddXMLPlugin) {
+  "use strict";
+
+  const createDeferred = ___utils["createDeferred"];
+  const DialogFactory = ___dialog_factory["DialogFactory"];
+  const DialogNames = ___dialog_factory["DialogNames"];
+  /**
+   * Initializes the AddXMLPlugin and includes it in the Runtime Authoring (RTA) plugins.
+   *
+   * @param rta Runtime Authoring instance
+   */
+  function initAddXMLPlugin(rta) {
+    const flexSettings = rta.getFlexSettings();
+    const commandFactory = new CommandFactory({
+      flexSettings
+    });
+    const plugin = new AddXMLPlugin({
+      commandFactory,
+      fragmentHandler: async overlay => await handleFragmentCreation(rta, overlay)
+    });
+    const plugins = rta.getPlugins();
+    plugins.addXMLPlugin = plugin;
+    rta.setPlugins(plugins);
+  }
+
+  /**
+   * Handles the creation of a fragment by opening a dialog and resolving the deferred data.
+   *
+   * @param rta Runtime Authoring instance
+   * @param overlay UI5 Element overlay
+   * @returns A promise that resolves with DeferredXmlFragmentData
+   */
+  async function handleFragmentCreation(rta, overlay) {
+    const deferred = createDeferred();
+    await DialogFactory.createDialog(overlay, rta, DialogNames.ADD_FRAGMENT, {
+      deferred
+    });
+    return deferred.promise;
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.initAddXMLPlugin = initAddXMLPlugin;
+  return __exports;
+});
+//# sourceMappingURL=add-fragment.js.map

package/dist/client/adp/add-fragment.ts

@@ -0,0 +1,51 @@
+import type RuntimeAuthoring from 'sap/ui/rta/RuntimeAuthoring';
+import type UI5Element from 'sap/ui/core/Element';
+import CommandFactory from 'sap/ui/rta/command/CommandFactory';
+import { Deferred, createDeferred } from './utils';
+import { DialogFactory, DialogNames } from './dialog-factory';
+import AddXMLPlugin from 'sap/ui/rta/plugin/AddXMLPlugin';
+
+export interface AddFragmentData {
+    deferred: Deferred<DeferredXmlFragmentData>;
+}
+
+export type DeferredXmlFragmentData = {
+    fragment: string;
+    fragmentPath: string;
+    targetAggregation: string;
+    index: number;
+};
+
+/**
+ * Initializes the AddXMLPlugin and includes it in the Runtime Authoring (RTA) plugins.
+ *
+ * @param rta Runtime Authoring instance
+ */
+export function initAddXMLPlugin(rta: RuntimeAuthoring): void {
+    const flexSettings = rta.getFlexSettings();
+    const commandFactory = new CommandFactory({ flexSettings });
+
+    const plugin = new AddXMLPlugin({
+        commandFactory,
+        fragmentHandler: async (overlay: UI5Element) => await handleFragmentCreation(rta, overlay)
+    });
+
+    const plugins = rta.getPlugins();
+    plugins.addXMLPlugin = plugin;
+    rta.setPlugins(plugins);
+}
+
+/**
+ * Handles the creation of a fragment by opening a dialog and resolving the deferred data.
+ *
+ * @param rta Runtime Authoring instance
+ * @param overlay UI5 Element overlay
+ * @returns A promise that resolves with DeferredXmlFragmentData
+ */
+async function handleFragmentCreation(rta: RuntimeAuthoring, overlay: UI5Element): Promise<DeferredXmlFragmentData> {
+    const deferred = createDeferred<DeferredXmlFragmentData>();
+
+    await DialogFactory.createDialog(overlay, rta, DialogNames.ADD_FRAGMENT, { deferred });
+
+    return deferred.promise;
+}

package/dist/client/adp/api-handler.js

@@ -1,155 +1,157 @@
-"use strict";
-
-sap.ui.define(["../utils/error"], function (___utils_error) {
-  "use strict";
-
-  const getError = ___utils_error["getError"];
-  var ApiEndpoints = /*#__PURE__*/function (ApiEndpoints) {
-    ApiEndpoints["CHANGES"] = "/preview/api/changes";
-    ApiEndpoints["FRAGMENT"] = "/adp/api/fragment";
-    ApiEndpoints["CONTROLLER"] = "/adp/api/controller";
-    ApiEndpoints["CODE_EXT"] = "/adp/api/code_ext";
-    ApiEndpoints["ANNOTATION_FILE"] = "/adp/api/annotation";
-    ApiEndpoints["MANIFEST_APP_DESCRIPTOR"] = "/manifest.appdescr_variant";
-    return ApiEndpoints;
-  }(ApiEndpoints || {});
-  var RequestMethod = /*#__PURE__*/function (RequestMethod) {
-    RequestMethod["GET"] = "GET";
-    RequestMethod["PUT"] = "PUT";
-    RequestMethod["POST"] = "POST";
-    RequestMethod["PATCH"] = "PATCH";
-    RequestMethod["DELETE"] = "DELETE";
-    return RequestMethod;
-  }(RequestMethod || {});
-  /**
-   * Requests a given endpoint
-   *
-   * @param endpoint API Endpoint
-   * @param method RequestMethod
-   * @param data Data to be sent to the server
-   * @returns Data from the server request
-   */
-  async function request(endpoint, method, data) {
-    const config = {
-      method,
-      body: JSON.stringify(data),
-      headers: {
-        'content-type': 'application/json'
-      }
-    };
-    try {
-      const response = await fetch(endpoint, config);
-      if (!response.ok) {
-        const errorData = await response.json();
-        const message = errorData?.message ?? '';
-        throw new Error(`Request failed, status: ${response.status}. ${message}`.trim());
-      }
-      switch (method) {
-        case RequestMethod.GET:
-          return response.json();
-        case RequestMethod.POST:
-          /**
-           * Since POST usually creates something
-           * and returns nothing (or a message) we just parse the text from res.send(msg)
-           */
-          return response.text();
-        default:
-          return response.json();
-      }
-    } catch (e) {
-      throw getError(e);
-    }
-  }
-
-  /**
-   * Retrieves all XML fragments from the project's workspace
-   *
-   * @returns Generic Promise<T>
-   */
-  async function getFragments() {
-    return request(ApiEndpoints.FRAGMENT, RequestMethod.GET);
-  }
-
-  /**
-   * Writes an XML fragment to the project's workspace
-   *
-   * @param data Data to be send to the server
-   * @returns Generic Promise<T>
-   */
-  async function writeFragment(data) {
-    return request(ApiEndpoints.FRAGMENT, RequestMethod.POST, data);
-  }
-
-  /**
-   * Retrieves manifest.appdescr_variant from the project's workspace
-   *
-   * @returns Generic Promise<T>
-   */
-  async function getManifestAppdescr() {
-    return request(ApiEndpoints.MANIFEST_APP_DESCRIPTOR, RequestMethod.GET);
-  }
-
-  /**
-   * Retrieves all controller extensions from the project's workspace
-   *
-   * @returns Generic Promise<T>
-   */
-  async function readControllers() {
-    return request(ApiEndpoints.CONTROLLER, RequestMethod.GET);
-  }
-
-  /**
-   * Writes a Controller to the project's workspace
-   *
-   * @param data Data to be send to the server
-   * @returns Generic Promise<T>
-   */
-  async function writeController(data) {
-    return request(ApiEndpoints.CONTROLLER, RequestMethod.POST, data);
-  }
-
-  /**
-   * Writes a new annotation file to the project's workspace
-   *
-   * @returns Generic Promise<DataSourceAnnotationMap>
-   */
-  async function getDataSourceAnnotationFileMap() {
-    return request(ApiEndpoints.ANNOTATION_FILE, RequestMethod.GET);
-  }
-
-  /**
-   * Checks for existing controller in the project's workspace
-   *
-   * @param controllerName Name of the controller
-   * @returns {CodeExtResponse} Returns path to existing controller if found
-   */
-  async function getExistingController(controllerName) {
-    return request(`${ApiEndpoints.CODE_EXT}/${controllerName}`, RequestMethod.GET);
-  }
-
-  /**
-   * Writes a change object to the project's workspace
-   *
-   * @param data Data to be send to the server
-   * @returns Generic Promise<T>
-   */
-  async function writeChange(data) {
-    return request(ApiEndpoints.CHANGES, RequestMethod.POST, data);
-  }
-  var __exports = {
-    __esModule: true
-  };
-  __exports.ApiEndpoints = ApiEndpoints;
-  __exports.RequestMethod = RequestMethod;
-  __exports.request = request;
-  __exports.getFragments = getFragments;
-  __exports.writeFragment = writeFragment;
-  __exports.getManifestAppdescr = getManifestAppdescr;
-  __exports.readControllers = readControllers;
-  __exports.writeController = writeController;
-  __exports.getDataSourceAnnotationFileMap = getDataSourceAnnotationFileMap;
-  __exports.getExistingController = getExistingController;
-  __exports.writeChange = writeChange;
-  return __exports;
+"use strict";
+
+sap.ui.define(["../utils/error"], function (___utils_error) {
+  "use strict";
+
+  const getError = ___utils_error["getError"];
+  var ApiEndpoints = /*#__PURE__*/function (ApiEndpoints) {
+    ApiEndpoints["CHANGES"] = "/preview/api/changes";
+    ApiEndpoints["FRAGMENT"] = "/adp/api/fragment";
+    ApiEndpoints["CONTROLLER"] = "/adp/api/controller";
+    ApiEndpoints["CODE_EXT"] = "/adp/api/code_ext";
+    ApiEndpoints["ANNOTATION_FILE"] = "/adp/api/annotation";
+    ApiEndpoints["MANIFEST_APP_DESCRIPTOR"] = "/manifest.appdescr_variant";
+    return ApiEndpoints;
+  }(ApiEndpoints || {});
+  var RequestMethod = /*#__PURE__*/function (RequestMethod) {
+    RequestMethod["GET"] = "GET";
+    RequestMethod["PUT"] = "PUT";
+    RequestMethod["POST"] = "POST";
+    RequestMethod["PATCH"] = "PATCH";
+    RequestMethod["DELETE"] = "DELETE";
+    return RequestMethod;
+  }(RequestMethod || {});
+  /**
+   * Requests a given endpoint
+   *
+   * @param endpoint API Endpoint
+   * @param method RequestMethod
+   * @param data Data to be sent to the server
+   * @returns Data from the server request
+   */
+  async function request(endpoint, method, data) {
+    const config = {
+      method,
+      body: JSON.stringify(data),
+      headers: {
+        'content-type': 'application/json'
+      }
+    };
+    try {
+      const response = await fetch(endpoint, config);
+      if (!response.ok) {
+        const errorData = await response.json();
+        const message = errorData?.message ?? '';
+        throw new Error(`Request failed, status: ${response.status}. ${message}`.trim());
+      }
+      switch (method) {
+        case RequestMethod.GET:
+          return response.json();
+        case RequestMethod.POST:
+          /**
+           * Since POST usually creates something
+           * and returns nothing (or a message) we just parse the text from res.send(msg)
+           */
+          return response.text();
+        default:
+          return response.json();
+      }
+    } catch (e) {
+      throw getError(e);
+    }
+  }
+
+  /**
+   * Retrieves all XML fragments from the project's workspace
+   *
+   * @returns Generic Promise<T>
+   */
+  async function getFragments() {
+    return request(ApiEndpoints.FRAGMENT, RequestMethod.GET);
+  }
+
+  /**
+   * Writes an XML fragment to the project's workspace
+   *
+   * @param data Data to be send to the server
+   * @returns Generic Promise<T>
+   */
+  async function writeFragment(data) {
+    return request(ApiEndpoints.FRAGMENT, RequestMethod.POST, data);
+  }
+
+  /**
+   * Retrieves manifest.appdescr_variant from the project's workspace
+   *
+   * @returns Generic Promise<T>
+   */
+  async function getManifestAppdescr() {
+    return request(ApiEndpoints.MANIFEST_APP_DESCRIPTOR, RequestMethod.GET);
+  }
+
+  /**
+   * Retrieves all controller extensions from the project's workspace
+   *
+   * @returns Generic Promise<T>
+   */
+  async function readControllers() {
+    return request(ApiEndpoints.CONTROLLER, RequestMethod.GET);
+  }
+
+  /**
+   * Writes a Controller to the project's workspace
+   *
+   * @param data Data to be send to the server
+   * @returns Generic Promise<T>
+   */
+  async function writeController(data) {
+    return request(ApiEndpoints.CONTROLLER, RequestMethod.POST, data);
+  }
+
+  /**
+   * Writes a new annotation file to the project's workspace
+   *
+   * @returns Generic Promise<DataSourceAnnotationMap>
+   */
+  async function getDataSourceAnnotationFileMap() {
+    return request(ApiEndpoints.ANNOTATION_FILE, RequestMethod.GET);
+  }
+
+  /**
+   * Checks for existing controller in the project's workspace
+   *
+   * @param controllerName Name of the controller
+   * @returns {CodeExtResponse} Returns path to existing controller if found
+   */
+  async function getExistingController(controllerName) {
+    return request(`${ApiEndpoints.CODE_EXT}/${controllerName}`, RequestMethod.GET);
+  }
+
+  /**
+   * Writes a change object to the project's workspace
+   *
+   * @param data Data to be send to the server
+   * @returns Generic Promise<T>
+   */
+  async function writeChange(data) {
+    return request(ApiEndpoints.CHANGES, RequestMethod.POST, {
+      change: data
+    });
+  }
+  var __exports = {
+    __esModule: true
+  };
+  __exports.ApiEndpoints = ApiEndpoints;
+  __exports.RequestMethod = RequestMethod;
+  __exports.request = request;
+  __exports.getFragments = getFragments;
+  __exports.writeFragment = writeFragment;
+  __exports.getManifestAppdescr = getManifestAppdescr;
+  __exports.readControllers = readControllers;
+  __exports.writeController = writeController;
+  __exports.getDataSourceAnnotationFileMap = getDataSourceAnnotationFileMap;
+  __exports.getExistingController = getExistingController;
+  __exports.writeChange = writeChange;
+  return __exports;
 });
 //# sourceMappingURL=api-handler.js.map

package/dist/client/adp/api-handler.ts

@@ -42,7 +42,7 @@ export interface AnnotationFileDetails {
 }
 
 export interface AnnotationDataSourceMap {
-    [key: string]: { serviceUrl: string; annotationDetails: AnnotationFileDetails, metadataReadErrorMsg: string };
+    [key: string]: { serviceUrl: string; annotationDetails: AnnotationFileDetails; metadataReadErrorMsg: string };
 }
 
 export interface AnnotationDataSourceResponse {
@@ -181,5 +181,5 @@ export async function getExistingController(controllerName: string): Promise<Cod
  * @returns Generic Promise<T>
  */
 export async function writeChange<T>(data: T): Promise<T> {
-    return request<T>(ApiEndpoints.CHANGES, RequestMethod.POST, data);
+    return request<T>(ApiEndpoints.CHANGES, RequestMethod.POST, { change: data });
 }

package/dist/client/adp/command-executor.js

@@ -1,77 +1,77 @@
-"use strict";
-
-sap.ui.define(["sap/m/MessageToast", "sap/ui/rta/command/CommandFactory", "../utils/error"], function (MessageToast, CommandFactory, ___utils_error) {
-  "use strict";
-
-  const getError = ___utils_error["getError"];
-  /**
-   * Class responsible for handling rta calls
-   */
-  class CommandExecutor {
-    /**
-     *
-     * @param rta Runtime Authoring
-     */
-    constructor(rta) {
-      this.rta = rta;
-    }
-
-    /**
-     * Generates command based on given values
-     *
-     * @param runtimeControl Managed object
-     * @param commandName Command name
-     * @param modifiedValue Modified value/s
-     * @param designMetadata Design time metadata
-     * @param flexSettings Additional flex settings
-     */
-    async getCommand(runtimeControl, commandName, modifiedValue, designMetadata, flexSettings) {
-      try {
-        return await CommandFactory.getCommandFor(runtimeControl, commandName, modifiedValue, designMetadata, flexSettings);
-      } catch (e) {
-        const error = getError(e);
-        const msgToastErrorMsg = `Could not get command for '${commandName}'. ${error.message}`;
-        error.message = msgToastErrorMsg;
-        MessageToast.show(msgToastErrorMsg);
-        throw error;
-      }
-    }
-
-    /**
-     * Creates composite command without nested commands
-     *
-     * @param runtimeControl Managed object
-     */
-    async createCompositeCommand(runtimeControl) {
-      try {
-        return await CommandFactory.getCommandFor(runtimeControl, 'composite');
-      } catch (e) {
-        const error = getError(e);
-        const msgToastErrorMsg = `Could not get composite command'. ${error.message}`;
-        error.message = msgToastErrorMsg;
-        MessageToast.show(msgToastErrorMsg);
-        throw error;
-      }
-    }
-
-    /**
-     * Pushed and executes the provided command
-     *
-     * @param command Command
-     */
-    async pushAndExecuteCommand(command) {
-      try {
-        /**
-         * The change will have pending state and will only be saved to the workspace when the user clicks save icon
-         */
-        await this.rta.getCommandStack().pushAndExecute(command);
-      } catch (e) {
-        const error = getError(e);
-        MessageToast.show(error.message);
-        throw error;
-      }
-    }
-  }
-  return CommandExecutor;
+"use strict";
+
+sap.ui.define(["sap/m/MessageToast", "sap/ui/rta/command/CommandFactory", "../utils/error"], function (MessageToast, CommandFactory, ___utils_error) {
+  "use strict";
+
+  const getError = ___utils_error["getError"];
+  /**
+   * Class responsible for handling rta calls
+   */
+  class CommandExecutor {
+    /**
+     *
+     * @param rta Runtime Authoring
+     */
+    constructor(rta) {
+      this.rta = rta;
+    }
+
+    /**
+     * Generates command based on given values
+     *
+     * @param runtimeControl Managed object
+     * @param commandName Command name
+     * @param modifiedValue Modified value/s
+     * @param designMetadata Design time metadata
+     * @param flexSettings Additional flex settings
+     */
+    async getCommand(runtimeControl, commandName, modifiedValue, designMetadata, flexSettings) {
+      try {
+        return await CommandFactory.getCommandFor(runtimeControl, commandName, modifiedValue, designMetadata, flexSettings);
+      } catch (e) {
+        const error = getError(e);
+        const msgToastErrorMsg = `Could not get command for '${commandName}'. ${error.message}`;
+        error.message = msgToastErrorMsg;
+        MessageToast.show(msgToastErrorMsg);
+        throw error;
+      }
+    }
+
+    /**
+     * Creates composite command without nested commands
+     *
+     * @param runtimeControl Managed object
+     */
+    async createCompositeCommand(runtimeControl) {
+      try {
+        return await CommandFactory.getCommandFor(runtimeControl, 'composite');
+      } catch (e) {
+        const error = getError(e);
+        const msgToastErrorMsg = `Could not get composite command'. ${error.message}`;
+        error.message = msgToastErrorMsg;
+        MessageToast.show(msgToastErrorMsg);
+        throw error;
+      }
+    }
+
+    /**
+     * Pushed and executes the provided command
+     *
+     * @param command Command
+     */
+    async pushAndExecuteCommand(command) {
+      try {
+        /**
+         * The change will have pending state and will only be saved to the workspace when the user clicks save icon
+         */
+        await this.rta.getCommandStack().pushAndExecute(command);
+      } catch (e) {
+        const error = getError(e);
+        MessageToast.show(error.message);
+        throw error;
+      }
+    }
+  }
+  return CommandExecutor;
 });
 //# sourceMappingURL=command-executor.js.map