@sap-ux/preview-middleware 0.13.18 → 0.13.19

package/dist/base/flex.d.ts

@@ -1,19 +1,8 @@
 /// <reference path="../../../../types/ui5.d.ts" />
 import type { Logger } from '@sap-ux/logger';
 import type { ReaderCollection } from '@ui5/fs';
-/**
- * Structure of a flex change.
- */
-export interface FlexChange {
-    [key: string]: string | object | undefined;
-    changeType: string;
-    reference: string;
-    moduleName?: string;
-    content?: {
-        codeRef?: string;
-        fragmentPath?: string;
-    };
-}
+import type { Editor } from 'mem-fs-editor';
+import type { CommonChangeProperties } from '@sap-ux/adp-tooling';
 /**
  * Read changes from the file system and return them.
  *
@@ -21,7 +10,7 @@ export interface FlexChange {
  * @param logger logger instance
  * @returns object with the file name as key and the file content as value
  */
-export declare function readChanges(project: ReaderCollection, logger: Logger): Promise<Record<string, FlexChange>>;
+export declare function readChanges(project: ReaderCollection, logger: Logger): Promise<Record<string, CommonChangeProperties>>;
 /**
  * Writes flex changes to the user's workspace.
  *
@@ -29,13 +18,14 @@ export declare function readChanges(project: ReaderCollection, logger: Logger):
  * @param data.fileName file name that is required for a valid change
  * @param data.fileType file type that is required
  * @param webappPath path to the webapp folder
+ * @param fs mem-fs editor
  * @param logger logger instance
  * @returns object with success flag and optional message
  */
 export declare function writeChange(data: object & {
     fileName?: string;
     fileType?: string;
-}, webappPath: string, logger: Logger): {
+}, webappPath: string, fs: Editor, logger: Logger): {
     success: boolean;
     message?: string;
 };

package/dist/base/flex.js

@@ -12,28 +12,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.deleteChange = exports.writeChange = exports.readChanges = void 0;
 const fs_1 = require("fs");
 const path_1 = require("path");
-/**
- * Map of change type specific correction functions.
- */
-const moduleNameContentMap = {
-    codeExt: (change) => { var _a, _b; return ((_b = (_a = change.content) === null || _a === void 0 ? void 0 : _a.codeRef) !== null && _b !== void 0 ? _b : '').replace('.js', ''); },
-    addXML: (change) => { var _a, _b; return (_b = (_a = change.content) === null || _a === void 0 ? void 0 : _a.fragmentPath) !== null && _b !== void 0 ? _b : ''; }
-};
-/**
- * Sets the moduleName property of the provided change to also support old changes with newer UI5 versions.
- *
- * @param change change to be fixed
- * @param logger logger instance
- */
-function tryFixChange(change, logger) {
-    try {
-        const prefix = change.reference.replace(/\./g, '/');
-        change.moduleName = `${prefix}/changes/${moduleNameContentMap[change.changeType](change)}`;
-    }
-    catch (error) {
-        logger.warn('Could not fix missing module name.');
-    }
-}
 /**
  * Read changes from the file system and return them.
  *
@@ -48,9 +26,6 @@ function readChanges(project, logger) {
         for (const file of files) {
             try {
                 const change = JSON.parse(yield file.getString());
-                if (moduleNameContentMap[change.changeType] && !change.moduleName) {
-                    tryFixChange(change, logger);
-                }
                 changes[`sap.ui.fl.${(0, path_1.parse)(file.getName()).name}`] = change;
                 logger.debug(`Read change from ${file.getPath()}`);
             }
@@ -69,20 +44,17 @@ exports.readChanges = readChanges;
  * @param data.fileName file name that is required for a valid change
  * @param data.fileType file type that is required
  * @param webappPath path to the webapp folder
+ * @param fs mem-fs editor
  * @param logger logger instance
  * @returns object with success flag and optional message
  */
-function writeChange(data, webappPath, logger) {
+function writeChange(data, webappPath, fs, logger) {
     const fileName = data.fileName;
     const fileType = data.fileType;
     if (fileName && fileType) {
         logger.debug(`Write change ${fileName}.${fileType}`);
-        const path = (0, path_1.join)(webappPath, 'changes');
-        if (!(0, fs_1.existsSync)(path)) {
-            (0, fs_1.mkdirSync)(path);
-        }
-        const filePath = (0, path_1.join)(path, fileName + '.' + fileType);
-        (0, fs_1.writeFileSync)(filePath, JSON.stringify(data, null, 2));
+        const filePath = (0, path_1.join)(webappPath, 'changes', fileName + '.' + fileType);
+        fs.writeJSON(filePath, data);
         const message = `FILE_CREATED ${fileName}.${fileType}`;
         return { success: true, message };
     }

package/dist/base/flp.d.ts

@@ -1,11 +1,12 @@
 /// <reference path="../../../../types/ui5.d.ts" />
 import type { ReaderCollection } from '@ui5/fs';
+import type { Editor as MemFsEditor } from 'mem-fs-editor';
 import type { Router } from 'express';
-import type { App, FlpConfig, MiddlewareConfig, RtaConfig, TestConfig } from '../types';
 import type { Logger, ToolsLogger } from '@sap-ux/logger';
 import type { MiddlewareUtils } from '@ui5/server';
 import type { Manifest, UI5FlexLayer } from '@sap-ux/project-access';
-import { type AdpPreviewConfig } from '@sap-ux/adp-tooling';
+import { type AdpPreviewConfig, type CommonChangeProperties, type OperationType } from '@sap-ux/adp-tooling';
+import type { App, FlpConfig, MiddlewareConfig, RtaConfig, TestConfig } from '../types';
 /**
  * Enhanced request handler that exposes a list of endpoints for the cds-plugin-ui5.
  */
@@ -53,6 +54,7 @@ export interface TemplateConfig {
     };
     locateReuseLibsScript?: boolean;
 }
+type OnChangeRequestHandler = (type: OperationType, change: CommonChangeProperties, fs: MemFsEditor, logger: Logger) => Promise<void>;
 /**
  * Class handling preview of a sandbox FLP.
  */
@@ -60,6 +62,7 @@ export declare class FlpSandbox {
     private readonly project;
     private readonly utils;
     private readonly logger;
+    protected onChangeRequest: OnChangeRequestHandler | undefined;
     protected templateConfig: TemplateConfig;
     readonly config: FlpConfig;
     readonly rta?: RtaConfig;
@@ -74,6 +77,12 @@ export declare class FlpSandbox {
      * @param logger logger instance
      */
     constructor(config: Partial<MiddlewareConfig>, project: ReaderCollection, utils: MiddlewareUtils, logger: Logger);
+    /**
+     * Registers a handler function to be called when a change request occurs.
+     *
+     * @param {OnChangeRequestHandler} handler - The function to be executed when a change request occurs.
+     */
+    addOnChangeRequestHandler(handler: OnChangeRequestHandler): void;
     /**
      * Initialize the FLP sandbox router.
      *
@@ -173,4 +182,5 @@ export declare class FlpSandbox {
  * @param logger logger instance
  */
 export declare function initAdp(rootProject: ReaderCollection, config: AdpPreviewConfig, flp: FlpSandbox, util: MiddlewareUtils, logger: ToolsLogger): Promise<void>;
+export {};
 //# sourceMappingURL=flp.d.ts.map

package/dist/base/flp.js

@@ -10,13 +10,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initAdp = exports.FlpSandbox = void 0;
+const mem_fs_1 = require("mem-fs");
+const mem_fs_editor_1 = require("mem-fs-editor");
 const ejs_1 = require("ejs");
 const fs_1 = require("fs");
 const path_1 = require("path");
 const express_1 = require("express");
-const flex_1 = require("./flex");
-const project_access_1 = require("@sap-ux/project-access");
 const adp_tooling_1 = require("@sap-ux/adp-tooling");
+const project_access_1 = require("@sap-ux/project-access");
+const flex_1 = require("./flex");
 const test_1 = require("./test");
 const DEVELOPER_MODE_CONFIG = new Map([
     // Run application in design time mode
@@ -114,6 +116,14 @@ class FlpSandbox {
         logger.debug(`Config: ${JSON.stringify({ flp: this.config, rta: this.rta, test: this.test })}`);
         this.router = (0, express_1.Router)();
     }
+    /**
+     * Registers a handler function to be called when a change request occurs.
+     *
+     * @param {OnChangeRequestHandler} handler - The function to be executed when a change request occurs.
+     */
+    addOnChangeRequestHandler(handler) {
+        this.onChangeRequest = handler;
+    }
     /**
      * Initialize the FLP sandbox router.
      *
@@ -321,16 +331,27 @@ class FlpSandbox {
      * Create required routes for flex.
      */
     createFlexHandler() {
+        const fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
         const api = `${PREVIEW_URL.api}/changes`;
         this.router.use(api, (0, express_1.json)());
         this.router.get(api, ((_req, res) => __awaiter(this, void 0, void 0, function* () {
-            this.sendResponse(res, 'application/json', 200, JSON.stringify(yield (0, flex_1.readChanges)(this.project, this.logger)));
+            const changes = yield (0, flex_1.readChanges)(this.project, this.logger);
+            if (this.onChangeRequest) {
+                for (const change of Object.values(changes)) {
+                    yield this.onChangeRequest('read', change, fs, this.logger);
+                }
+            }
+            res.status(200).contentType('application/json').send(changes);
         })));
         this.router.post(api, ((req, res) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const { success, message } = (0, flex_1.writeChange)(req.body, this.utils.getProject().getSourcePath(), this.logger);
+                const change = req.body;
+                if (this.onChangeRequest) {
+                    yield this.onChangeRequest('write', change, fs, this.logger);
+                }
+                const { success, message } = (0, flex_1.writeChange)(change, this.utils.getProject().getSourcePath(), fs, this.logger);
                 if (success) {
-                    this.sendResponse(res, 'text/plain', 200, message !== null && message !== void 0 ? message : '');
+                    fs.commit(() => res.status(200).send(message));
                 }
                 else {
                     this.sendResponse(res, 'text/plain', 400, 'INVALID_DATA');
@@ -565,6 +586,7 @@ function initAdp(rootProject, config, flp, util, logger) {
             const { name, manifest } = descriptor;
             yield flp.init(manifest, name, adp.resources);
             flp.router.use(adp.descriptor.url, adp.proxy.bind(adp));
+            flp.addOnChangeRequestHandler(adp.onChangeRequest.bind(adp));
             flp.router.use((0, express_1.json)());
             adp.addApis(flp.router);
         }

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

@@ -1,143 +1,143 @@
-"use strict";
-
-sap.ui.define([], function () {
-  "use strict";
-
-  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 new Error(e.message);
-    }
-  }
-
-  /**
-   * 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([], function () {
+  "use strict";
+
+  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 new Error(e.message);
+    }
+  }
+
+  /**
+   * 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;
 });
 //# sourceMappingURL=api-handler.js.map

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

@@ -1,56 +1,56 @@
-"use strict";
-
-sap.ui.define(["sap/m/MessageToast", "sap/ui/rta/command/CommandFactory"], function (MessageToast, CommandFactory) {
-  "use strict";
-
-  /**
-   * 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 errorMsg = `Could not get command for '${commandName}'. ${e.message}`;
-        MessageToast.show(errorMsg);
-        throw new Error(errorMsg);
-      }
-    }
-
-    /**
-     * 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) {
-        MessageToast.show(e.message);
-        throw new Error(e.message);
-      }
-    }
-  }
-  return CommandExecutor;
+"use strict";
+
+sap.ui.define(["sap/m/MessageToast", "sap/ui/rta/command/CommandFactory"], function (MessageToast, CommandFactory) {
+  "use strict";
+
+  /**
+   * 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 errorMsg = `Could not get command for '${commandName}'. ${e.message}`;
+        MessageToast.show(errorMsg);
+        throw new Error(errorMsg);
+      }
+    }
+
+    /**
+     * 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) {
+        MessageToast.show(e.message);
+        throw new Error(e.message);
+      }
+    }
+  }
+  return CommandExecutor;
 });
 //# sourceMappingURL=command-executor.js.map