@sap-ux/preview-middleware 0.17.37 → 0.17.39

package/README.md

@@ -13,27 +13,30 @@ When this middleware is used together with the `reload-middleware`, then the ord
 ```
 
 ## [Configuration Options](#configuration-options)
-| Option                 | Type      | Default Value    | Description                                                                                                                                                                                                                                               |
-| ---------------------- | --------- | ---------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `flp`                  |           |                  | Optional configuration object for the local Fiori launchpad                                                                                                                                                                                               |
-| `flp.path`             | `string`  | `/test/flp.html` | The mount point of the local Fiori launchpad.                                                                                                                                                                                                             |
-| `flp.init`             | `string`  | `undefined`      | Optional UI5 module/script to be executed after the standard initialization                                                                                                                                                                               |
-| `flp.intent`           |           |                  | Optional intent to be used for the application                                                                                                                                                                                                            |
-| `flp.intent.object`    | `string`  | `app`            | Optional intent object                                                                                                                                                                                                                                    |
-| `flp.intent.action`    | `string`  | `preview`        | Optional intent action                                                                                                                                                                                                                                    |
-| `flp.apps`             | `array`   | `undefined`      | Optional additional local apps that are available in local Fiori launchpad                                                                                                                                                                                |
-| `flp.libs`             | `boolean` | `undefined`      | Optional flag to add a generic script fetching the paths of used libraries not available in UI5. To disable set it to `false`, if not set, then the project is checked for a `load-reuse-libs` script and if available the libraries are fetched as well. |
-| `flp.theme`             | `string` | `undefined`      | Optional flag for setting the UI5 Theme.                                                                                                                                                                                                                  |
-| `adp.target`           |           |                  | Required configuration for adaptation projects defining the connected backend                                                                                                                                                                             |
-| `adp.ignoreCertErrors` | `boolean` | `false`          | Optional setting to ignore certification validation errors when working with e.g. development systems with self signed certificates                                                                                                                       |
-| `rta`                  |           |                  | Optional configuration allowing to add mount points for runtime adaptation                                                                                                                                                                                |
-| `rta.layer`            | `string`  | `(calculated)`   | Optional property for defining the runtime adaptation layer for changes (default is `CUSTOMER_BASE` or read from the project for adaptation projects)                                                                                                     |
-| `rta.editors`          | `array`   | `undefined`      | Optional list of mount points for editing                                                                                                                                                                                                                 |
-| `test`                 | `array`   | `undefined`      | Optional list of configurations for automated testing.                                                                                                                                                                                                    |
-| `debug`                | `boolean` | `false`          | Enables debug output                                                                                                                                                                                                                                      |
+| Option                  | Type      | Default Value    | Description                                                                                                                                                                                                                                               |
+|-------------------------|-----------|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `flp`                   |           |                  | Optional configuration object for the local Fiori launchpad                                                                                                                                                                                               |
+| `flp.path`              | `string`  | `/test/flp.html` | The mount point of the local Fiori launchpad.                                                                                                                                                                                                             |
+| `flp.init`              | `string`  | `undefined`      | Optional UI5 module/script to be executed after the standard initialization                                                                                                                                                                               |
+| `flp.intent`            |           |                  | Optional intent to be used for the application                                                                                                                                                                                                            |
+| `flp.intent.object`     | `string`  | `app`            | Optional intent object                                                                                                                                                                                                                                    |
+| `flp.intent.action`     | `string`  | `preview`        | Optional intent action                                                                                                                                                                                                                                    |
+| `flp.apps`              | `array`   | `undefined`      | Optional additional local apps that are available in local Fiori launchpad                                                                                                                                                                                |
+| `flp.libs`              | `boolean` | `undefined`      | Optional flag to add a generic script fetching the paths of used libraries not available in UI5. To disable set it to `false`, if not set, then the project is checked for a `load-reuse-libs` script and if available the libraries are fetched as well. |
+| `flp.theme`             | `string`  | `undefined`      | Optional flag for setting the UI5 Theme.                                                                                                                                                                                                                  |
+| `adp.target`            |           |                  | Required configuration for adaptation projects defining the connected backend                                                                                                                                                                             |
+| `adp.ignoreCertErrors`  | `boolean` | `false`          | Optional setting to ignore certification validation errors when working with e.g. development systems with self signed certificates                                                                                                                       |
+| `rta`                   |           |                  | 🚫 *Deprecated: use 'editors.rta' instead* <br/> Optional configuration allowing to add mount points for runtime adaptation                                                                                                                               |
+| `editors`               |           |                  | Optional list of configurations allowing to add mount points for additional editors                                                                                                                                                                       |
+| `editors.rta`           | `array`   | `undefined`      | Optional configuration allowing to add mount points for runtime adaptation                                                                                                                                                                                |
+| `editors.rta.layer`     | `string`  | `(calculated)`   | Optional property for defining the runtime adaptation layer for changes (default is `CUSTOMER_BASE` or read from the project for adaptation projects)                                                                                                     |
+| `editors.rta.endpoints` | `array`   | `undefined`      | Optional list of mount points for editing                                                                                                                                                                                                                 |
+| `test`                  | `array`   | `undefined`      | Optional list of configurations for automated testing.                                                                                                                                                                                                    |
+| `debug`                 | `boolean` | `false`          | Enables debug output                                                                                                                                                                                                                                      |
 
 ### [`flp.apps`](#configuration-option-flpapps)
 Array of additional application configurations:
+
 | Option                   | Type     | Default Value  | Description                                                                                                   |
 | ------------------------ | -------- | -------------- | ------------------------------------------------------------------------------------------------------------- |
 | `target`                 | `string` |                | Target path of the additional application                                                                     |
@@ -50,11 +53,11 @@ Array of additional application configurations:
 | `client`      | `string` optional              | sap-client parameter                                                                                                                            |
 | `scp`         | `boolean` optional             | If set to true the proxy will execute the required OAuth routine for the ABAP environment on SAP BTP                                            |
 
-### [`rta.editors`](#configuration-option-rtaeditors)
-| Option          | Type               | Description                                                                                    |
-| --------------- | -------------------| -----------------------------------------------------------------------------------------------|
-| `path`          | `string` mandatory | The mount point to be used for the editor.                                                     |
-| `developerMode` | `boolean` optional | Enables/disables the runtime adaptation developer mode (only supported for adaptation projects) |
+### [`editors`](#configuration-option-editors)
+| Option                        | Type               | Description                                                                                     |
+|-------------------------------|--------------------|-------------------------------------------------------------------------------------------------|
+| `rta.endpoints.path`          | `string` mandatory | The mount point to be used for the editor.                                                      |
+| `rta.endpoints.developerMode` | `boolean` optional | Enables/disables the runtime adaptation developer mode (only supported for adaptation projects) |
 
 ### [`test`](#configuration-option-test)
 | Option          | Type               | Description                                                                                                                                                                                                                                                                                                             |

package/dist/base/config.d.ts

@@ -1,5 +1,5 @@
 import { ToolsLogger, type Logger } from '@sap-ux/logger';
-import type { App, DefaultFlpPath, DefaultIntent, FlpConfig, Intent, InternalTestConfig, MiddlewareConfig, TestConfig } from '../types';
+import type { App, DefaultFlpPath, DefaultIntent, FlpConfig, Intent, InternalTestConfig, MiddlewareConfig, RtaConfig, TestConfig } from '../types';
 import { type Manifest, type UI5FlexLayer } from '@sap-ux/project-access';
 import { type Editor } from 'mem-fs-editor';
 import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
@@ -95,6 +95,14 @@ export declare function getFlpConfigWithDefaults(config?: Partial<FlpConfig>): F
  * @param logger logger instance
  */
 export declare function sanitizeConfig(config: MiddlewareConfig, logger: ToolsLogger): void;
+/**
+ * Sanitize the deprecated RTA configuration.
+ *
+ * @param deprecatedRtaConfig deprecated RTA configuration
+ * @param logger logger instance
+ * @returns sanitized RTA configuration
+ */
+export declare function sanitizeRtaConfig(deprecatedRtaConfig: MiddlewareConfig['rta'], logger: Logger): RtaConfig | undefined;
 /**
  * Add an application to the local FLP preview.
  *

package/dist/base/config.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_INTENT = exports.DEFAULT_PATH = exports.DEFAULT_THEME = exports.PREVIEW_URL = void 0;
 exports.getFlpConfigWithDefaults = getFlpConfigWithDefaults;
 exports.sanitizeConfig = sanitizeConfig;
+exports.sanitizeRtaConfig = sanitizeRtaConfig;
 exports.addApp = addApp;
 exports.getAppName = getAppName;
 exports.createFlpTemplateConfig = createFlpTemplateConfig;
@@ -118,8 +119,14 @@ function getFlpConfigWithDefaults(config = {}) {
  * @param logger logger instance
  */
 function sanitizeConfig(config, logger) {
-    if (config.rta && config.adp === undefined) {
-        config.rta.editors = config.rta.editors.map((editor) => {
+    //prettier-ignore
+    if (config.rta) { //NOSONAR
+        config.editors ??= {};
+        config.editors.rta = sanitizeRtaConfig(config.rta, logger); //NOSONAR
+        delete config.rta; //NOSONAR
+    }
+    if (config.editors?.rta && config.adp === undefined) {
+        config.editors.rta.endpoints = config.editors.rta.endpoints.map((editor) => {
             if (editor.developerMode) {
                 logger.error('developerMode is ONLY supported for SAP UI5 adaptation projects.');
                 logger.warn(`developerMode for ${editor.path} disabled`);
@@ -129,6 +136,23 @@ function sanitizeConfig(config, logger) {
         });
     }
 }
+/**
+ * Sanitize the deprecated RTA configuration.
+ *
+ * @param deprecatedRtaConfig deprecated RTA configuration
+ * @param logger logger instance
+ * @returns sanitized RTA configuration
+ */
+//prettier-ignore
+function sanitizeRtaConfig(deprecatedRtaConfig, logger) {
+    let rtaConfig;
+    if (deprecatedRtaConfig) {
+        const { editors, ...rta } = deprecatedRtaConfig;
+        rtaConfig = { ...rta, endpoints: [...editors] };
+        logger.warn(`The configuration option 'rta' is deprecated. Please use 'editors.rta' instead.`);
+    }
+    return rtaConfig;
+}
 /**
  * Retrieves the configuration settings for UI5 flexibility services.
  *
@@ -279,9 +303,9 @@ function getPreviewPaths(config, logger = new logger_1.ToolsLogger()) {
     const flpConfig = getFlpConfigWithDefaults(config.flp);
     urls.push({ path: `${flpConfig.path}#${flpConfig.intent.object}-${flpConfig.intent.action}`, type: 'preview' });
     // add editor urls
-    if (config.rta?.editors) {
-        config.rta.editors.forEach((editor) => {
-            urls.push({ path: editor.path, type: 'editor' });
+    if (config.editors?.rta) {
+        config.editors.rta.endpoints.forEach((endpoint) => {
+            urls.push({ path: endpoint.path, type: 'editor' });
         });
     }
     // add test urls if configured

package/dist/base/flp.d.ts

@@ -25,7 +25,7 @@ export declare class FlpSandbox {
     private manifest;
     protected onChangeRequest: OnChangeRequestHandler | undefined;
     protected templateConfig: TemplateConfig;
-    readonly config: FlpConfig;
+    readonly flpConfig: FlpConfig;
     readonly rta?: RtaConfig;
     readonly test?: TestConfig[];
     readonly router: EnhancedRouter;

package/dist/base/flp.js

@@ -27,7 +27,7 @@ class FlpSandbox {
     manifest;
     onChangeRequest;
     templateConfig;
-    config;
+    flpConfig;
     rta;
     test;
     router;
@@ -44,10 +44,10 @@ class FlpSandbox {
         this.project = project;
         this.utils = utils;
         this.logger = logger;
-        this.config = (0, config_1.getFlpConfigWithDefaults)(config.flp);
+        this.flpConfig = (0, config_1.getFlpConfigWithDefaults)(config.flp);
         this.test = config.test;
-        this.rta = config.rta;
-        logger.debug(`Config: ${JSON.stringify({ flp: this.config, rta: this.rta, test: this.test })}`);
+        this.rta = config.editors?.rta ?? (0, config_1.sanitizeRtaConfig)(config.rta, logger); //NOSONAR
+        logger.debug(`Config: ${JSON.stringify({ flp: this.flpConfig, rta: this.rta, test: this.test })}`);
         this.router = (0, express_1.Router)();
     }
     /**
@@ -68,16 +68,16 @@ class FlpSandbox {
      */
     async init(manifest, componentId, resources = {}, adp) {
         this.createFlexHandler();
-        this.config.libs ??= await this.hasLocateReuseLibsScript();
+        this.flpConfig.libs ??= await this.hasLocateReuseLibsScript();
         const id = manifest['sap.app']?.id ?? '';
-        this.templateConfig = (0, config_1.createFlpTemplateConfig)(this.config, manifest, resources);
+        this.templateConfig = (0, config_1.createFlpTemplateConfig)(this.flpConfig, manifest, resources);
         this.adp = adp;
         this.manifest = manifest;
         await (0, config_1.addApp)(this.templateConfig, manifest, {
             componentId,
             target: resources[componentId ?? id] ?? this.templateConfig.basePath,
             local: '.',
-            intent: this.config.intent
+            intent: this.flpConfig.intent
         }, this.logger);
         this.addStandardRoutes();
         if (this.rta) {
@@ -171,7 +171,7 @@ class FlpSandbox {
     async setApplicationDependencies() {
         if (this.adp) {
             await this.adp.sync();
-            const appName = (0, config_1.getAppName)(this.manifest, this.config.intent);
+            const appName = (0, config_1.getAppName)(this.manifest, this.flpConfig.intent);
             this.templateConfig.apps[appName].applicationDependencies = this.adp.descriptor;
         }
     }
@@ -185,7 +185,7 @@ class FlpSandbox {
      */
     async editorGetHandlerDeveloperMode(res, rta, previewUrl) {
         const scenario = rta.options?.scenario;
-        let templatePreviewUrl = `${previewUrl}?sap-ui-xx-viewCache=false&fiori-tools-rta-mode=forAdaptation&sap-ui-rta-skip-flex-validation=true&sap-ui-xx-condense-changes=true#${this.config.intent.object}-${this.config.intent.action}`;
+        let templatePreviewUrl = `${previewUrl}?sap-ui-xx-viewCache=false&fiori-tools-rta-mode=forAdaptation&sap-ui-rta-skip-flex-validation=true&sap-ui-xx-condense-changes=true#${this.flpConfig.intent.object}-${this.flpConfig.intent.action}`;
         if (scenario === 'ADAPTATION_PROJECT') {
             templatePreviewUrl = templatePreviewUrl.replace('?', `?sap-ui-layer=${rta.layer}&`);
         }
@@ -237,7 +237,7 @@ class FlpSandbox {
      */
     addEditorRoutes(rta) {
         const cpe = (0, path_1.dirname)(require.resolve('@sap-ux/control-property-editor-sources'));
-        for (const editor of rta.editors) {
+        for (const editor of rta.endpoints) {
             let previewUrl = editor.path.startsWith('/') ? editor.path : `/${editor.path}`;
             if (editor.developerMode) {
                 previewUrl = `${previewUrl}.inner.html`;
@@ -270,15 +270,15 @@ class FlpSandbox {
             // Redirect to the same URL but add the necessary parameter
             const params = structuredClone(req.query);
             params['sap-ui-xx-viewCache'] = 'false';
-            res.redirect(302, `${this.config.path}?${new URLSearchParams(params)}`);
+            res.redirect(302, `${this.flpConfig.path}?${new URLSearchParams(params)}`);
             return;
         }
         await this.setApplicationDependencies();
         // inform the user if a html file exists on the filesystem
         // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-        const file = await this.project.byPath(this.config.path);
+        const file = await this.project.byPath(this.flpConfig.path);
         if (file) {
-            this.logger.info(`HTML file returned at ${this.config.path} is loaded from the file system.`);
+            this.logger.info(`HTML file returned at ${this.flpConfig.path} is loaded from the file system.`);
             next();
         }
         else {
@@ -298,7 +298,7 @@ class FlpSandbox {
         // register static client sources
         this.router.use(config_1.PREVIEW_URL.client.path, (0, express_1.static)(config_1.PREVIEW_URL.client.local));
         // add route for the sandbox html
-        this.router.get(this.config.path, async (req, res, next) => {
+        this.router.get(this.flpConfig.path, async (req, res, next) => {
             await this.flpGetHandler(req, res, next);
         });
     }
@@ -372,7 +372,7 @@ class FlpSandbox {
      * Add additional routes for apps also to be shown in the local FLP.
      */
     async addRoutesForAdditionalApps() {
-        for (const app of this.config.apps) {
+        for (const app of this.flpConfig.apps) {
             let manifest;
             if (app.local) {
                 this.fs = this.fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
@@ -700,7 +700,7 @@ async function initAdp(rootProject, config, flp, util, logger) {
                 projectId: variant.id,
                 scenario: 'ADAPTATION_PROJECT'
             };
-            for (const editor of flp.rta.editors) {
+            for (const editor of flp.rta.endpoints) {
                 editor.pluginScript ??= 'open/ux/preview/client/adp/init';
             }
         }

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

@@ -1,155 +1,155 @@
-"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, 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