@sap-ux/preview-middleware 0.16.160 → 0.16.163

package/dist/base/flex.js

@@ -14,7 +14,7 @@ const path_1 = require("path");
  */
 async function readChanges(project, logger) {
     const changes = {};
-    const files = await project.byGlob('/**/changes/*.*');
+    const files = await project.byGlob('/**/changes/**/*.*');
     for (const file of files) {
         try {
             changes[`sap.ui.fl.${(0, path_1.parse)(file.getName()).name}`] = JSON.parse(await file.getString());
@@ -65,16 +65,37 @@ function deleteChange(data, webappPath, logger) {
     if (fileName) {
         const path = (0, path_1.join)(webappPath, 'changes');
         if ((0, fs_1.existsSync)(path)) {
-            const files = (0, fs_1.readdirSync)(path);
-            const file = files.find((element) => element.includes(fileName));
-            if (file) {
-                logger.debug(`Write change ${file}`);
-                const filePath = (0, path_1.join)(path, file);
+            // Changes can be in subfolders of changes directory. For eg: New Annotation File Change
+            const files = [];
+            readDirectoriesRecursively(path, files);
+            const filePath = files.find((element) => element.includes(fileName));
+            if (filePath) {
+                const fileNameWithExt = filePath.split(path_1.sep).pop();
+                logger.debug(`Write change ${fileNameWithExt}`);
                 (0, fs_1.unlinkSync)(filePath);
-                return { success: true, message: `FILE_DELETED ${file}` };
+                return { success: true, message: `FILE_DELETED ${fileNameWithExt}` };
             }
         }
     }
     return { success: false };
 }
+/**
+ * Recursively find all files in the given folder.
+ *
+ * @param path path to the folder.
+ * @param files all files in the given folder and subfolders.
+ */
+function readDirectoriesRecursively(path, files = []) {
+    const items = (0, fs_1.readdirSync)(path);
+    items.forEach((item) => {
+        const fullPath = (0, path_1.join)(path, item);
+        const stats = (0, fs_1.statSync)(fullPath);
+        if (stats.isDirectory()) {
+            readDirectoriesRecursively(fullPath, files);
+        }
+        else if (stats.isFile()) {
+            files.push(fullPath);
+        }
+    });
+}
 //# sourceMappingURL=flex.js.map

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

@@ -1,144 +1,166 @@
-"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["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);
-  }
-
-  /**
-   * 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.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
+   *
+   * @param data Data to be send to the server
+   * @returns Generic Promise<T>
+   */
+  async function writeAnnotationFile(data) {
+    return request(ApiEndpoints.ANNOTATION_FILE, RequestMethod.POST, data);
+  }
+
+  /**
+   * Writes a new annotation file to the project's workspace
+   *
+   * @returns Generic Promise<DataSoruceAnnotationMap>
+   */
+  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.writeAnnotationFile = writeAnnotationFile;
+  __exports.getDataSourceAnnotationFileMap = getDataSourceAnnotationFileMap;
+  __exports.getExistingController = getExistingController;
+  __exports.writeChange = writeChange;
+  return __exports;
 });
 //# sourceMappingURL=api-handler.js.map

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

@@ -6,6 +6,7 @@ export const enum ApiEndpoints {
     FRAGMENT = '/adp/api/fragment',
     CONTROLLER = '/adp/api/controller',
     CODE_EXT = '/adp/api/code_ext',
+    ANNOTATION_FILE = '/adp/api/annotation',
     MANIFEST_APP_DESCRIPTOR = '/manifest.appdescr_variant'
 }
 
@@ -33,6 +34,17 @@ export interface CodeExtResponse {
     isRunningInBAS: boolean;
 }
 
+export interface AnnotationFileResponse {
+    annotationExistsInWS: boolean;
+    annotationPath: string;
+    annotationPathFromRoot: string;
+    isRunningInBAS: boolean;
+}
+
+interface DataSoruceAnnotationMap {
+    [key: string]: { serviceUrl: string; isRunningInBAS: boolean; annotationDetails: AnnotationFileResponse };
+}
+
 export interface ControllersResponse {
     controllers: Controllers;
     message: string;
@@ -139,6 +151,25 @@ export async function writeController<T>(data: T): Promise<T> {
     return request<T>(ApiEndpoints.CONTROLLER, RequestMethod.POST, data);
 }
 
+/**
+ * Writes a new annotation file to the project's workspace
+ *
+ * @param data Data to be send to the server
+ * @returns Generic Promise<T>
+ */
+export async function writeAnnotationFile<T>(data: T): Promise<T> {
+    return request<T>(ApiEndpoints.ANNOTATION_FILE, RequestMethod.POST, data);
+}
+
+/**
+ * Writes a new annotation file to the project's workspace
+ *
+ * @returns Generic Promise<DataSoruceAnnotationMap>
+ */
+export async function getDataSourceAnnotationFileMap(): Promise<DataSoruceAnnotationMap> {
+    return request<DataSoruceAnnotationMap>(ApiEndpoints.ANNOTATION_FILE, RequestMethod.GET);
+}
+
 /**
  * Checks for existing controller in the project's workspace
  *

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

package/dist/client/adp/control-utils.js

@@ -1,46 +1,46 @@
-"use strict";
-
-sap.ui.define([], function () {
-  "use strict";
-
-  /**
-   * Handles calling control specific functions for retrieving control data
-   */
-  class ControlUtils {
-    /**
-     * Returns ManagedObject runtime control
-     *
-     * @param overlayControl Overlay
-     * @returns {ManagedObject} Managed Object instance
-     */
-    static getRuntimeControl(overlayControl) {
-      let runtimeControl;
-      if (overlayControl.getElementInstance) {
-        runtimeControl = overlayControl.getElementInstance();
-      } else {
-        runtimeControl = overlayControl.getElement();
-      }
-      return runtimeControl;
-    }
-
-    /**
-     * Returns control aggregation names in an array
-     *
-     * @param control Managed Object runtime control
-     * @param name Aggregation name
-     * @returns Array of control aggregations
-     */
-    static getControlAggregationByName(control, name) {
-      let result = [];
-      const aggregation = (control ? control.getMetadata().getAllAggregations() : {})[name];
-      if (aggregation) {
-        // This executes a _sGetter function that can vary from control to control (_sGetter can be: getContent, getItems, etc)
-        const names = aggregation._sGetter && control[aggregation._sGetter]() || [];
-        result = Array.isArray(names) ? names : [names];
-      }
-      return result;
-    }
-  }
-  return ControlUtils;
+"use strict";
+
+sap.ui.define([], function () {
+  "use strict";
+
+  /**
+   * Handles calling control specific functions for retrieving control data
+   */
+  class ControlUtils {
+    /**
+     * Returns ManagedObject runtime control
+     *
+     * @param overlayControl Overlay
+     * @returns {ManagedObject} Managed Object instance
+     */
+    static getRuntimeControl(overlayControl) {
+      let runtimeControl;
+      if (overlayControl.getElementInstance) {
+        runtimeControl = overlayControl.getElementInstance();
+      } else {
+        runtimeControl = overlayControl.getElement();
+      }
+      return runtimeControl;
+    }
+
+    /**
+     * Returns control aggregation names in an array
+     *
+     * @param control Managed Object runtime control
+     * @param name Aggregation name
+     * @returns Array of control aggregations
+     */
+    static getControlAggregationByName(control, name) {
+      let result = [];
+      const aggregation = (control ? control.getMetadata().getAllAggregations() : {})[name];
+      if (aggregation) {
+        // This executes a _sGetter function that can vary from control to control (_sGetter can be: getContent, getItems, etc)
+        const names = aggregation._sGetter && control[aggregation._sGetter]() || [];
+        result = Array.isArray(names) ? names : [names];
+      }
+      return result;
+    }
+  }
+  return ControlUtils;
 });
 //# sourceMappingURL=control-utils.js.map