@sap-ux/adp-tooling 0.9.18 → 0.9.20

package/dist/preview/adp-preview.d.ts

@@ -2,10 +2,11 @@
 import type { ReaderCollection } from '@ui5/fs';
 import type { MiddlewareUtils } from '@ui5/server';
 import type { NextFunction, Request, Response, Router } from 'express';
-import type { ToolsLogger } from '@sap-ux/logger';
+import type { Logger, ToolsLogger } from '@sap-ux/logger';
 import type { UI5FlexLayer } from '@sap-ux/project-access';
 import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
-import type { AdpPreviewConfig, DescriptorVariant } from '../types';
+import type { AdpPreviewConfig, CommonChangeProperties, DescriptorVariant, OperationType } from '../types';
+import type { Editor } from 'mem-fs-editor';
 export declare const enum ApiRoutes {
     FRAGMENT = "/adp/api/fragment",
     CONTROLLER = "/adp/api/controller",
@@ -89,5 +90,15 @@ export declare class AdpPreview {
      * @returns {void} A promise that resolves when the APIs have been added.
      */
     addApis(router: Router): void;
+    /**
+     * Handles different types of change requests to project files.
+     *
+     * @param {string} type - The type of change request.
+     * @param {CommonChangeProperties} change - An object containing properties common to all change types.
+     * @param {Editor} fs - An instance of an editor interface for file system operations.
+     * @param {Logger} logger - An instance of a logging interface for message logging.
+     * @returns {Promise<void>} A promise that resolves when the change request has been processed.
+     */
+    onChangeRequest(type: OperationType, change: CommonChangeProperties, fs: Editor, logger: Logger): Promise<void>;
 }
 //# sourceMappingURL=adp-preview.d.ts.map

package/dist/preview/adp-preview.js

@@ -16,6 +16,7 @@ exports.AdpPreview = void 0;
 const adm_zip_1 = __importDefault(require("adm-zip"));
 const system_access_1 = require("@sap-ux/system-access");
 const routes_handler_1 = __importDefault(require("./routes-handler"));
+const change_handler_1 = require("./change-handler");
 /**
  * Instance of an adaptation project handling requests and data transformation.
  */
@@ -146,11 +147,38 @@ class AdpPreview {
      */
     addApis(router) {
         router.get("/adp/api/fragment" /* ApiRoutes.FRAGMENT */, this.routesHandler.handleReadAllFragments);
-        router.post("/adp/api/fragment" /* ApiRoutes.FRAGMENT */, this.routesHandler.handleWriteFragment);
         router.get("/adp/api/controller" /* ApiRoutes.CONTROLLER */, this.routesHandler.handleReadAllControllers);
         router.post("/adp/api/controller" /* ApiRoutes.CONTROLLER */, this.routesHandler.handleWriteControllerExt);
         router.get("/adp/api/code_ext/:controllerName" /* ApiRoutes.CODE_EXT */, this.routesHandler.handleGetControllerExtensionData);
     }
+    /**
+     * Handles different types of change requests to project files.
+     *
+     * @param {string} type - The type of change request.
+     * @param {CommonChangeProperties} change - An object containing properties common to all change types.
+     * @param {Editor} fs - An instance of an editor interface for file system operations.
+     * @param {Logger} logger - An instance of a logging interface for message logging.
+     * @returns {Promise<void>} A promise that resolves when the change request has been processed.
+     */
+    onChangeRequest(type, change, fs, logger) {
+        return __awaiter(this, void 0, void 0, function* () {
+            switch (type) {
+                case 'read':
+                    if (change_handler_1.moduleNameContentMap[change.changeType] && !change.moduleName) {
+                        (0, change_handler_1.tryFixChange)(change, logger);
+                    }
+                    break;
+                case 'write':
+                    if ((0, change_handler_1.isAddXMLChange)(change)) {
+                        (0, change_handler_1.addXmlFragment)(this.util.getProject().getSourcePath(), change, fs, logger);
+                    }
+                    break;
+                default:
+                    // no need to handle delete changes
+                    break;
+            }
+        });
+    }
 }
 exports.AdpPreview = AdpPreview;
 //# sourceMappingURL=adp-preview.js.map

package/dist/preview/change-handler.d.ts

@@ -0,0 +1,41 @@
+import type { Editor } from 'mem-fs-editor';
+import type { AddXMLChange, CommonChangeProperties } from '../types';
+import type { Logger } from '@sap-ux/logger';
+/**
+ * A mapping object that defines how to extract change content data from changes based on their type.
+ */
+export declare const moduleNameContentMap: {
+    [key: string]: (change: CommonChangeProperties) => string;
+};
+/**
+ * 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
+ */
+/**
+ * Attempts to fix a change object by setting its moduleName based on its reference and changeType
+ * to also support old changes with newer UI5 versions.
+ *
+ * @param {CommonChangeProperties} change - The change object to be fixed.
+ * @param {Logger} logger - An instance for logging warnings, errors, or informational messages.
+ */
+export declare function tryFixChange(change: CommonChangeProperties, logger: Logger): void;
+/**
+ * Determines whether a given change is of type `AddXMLChange`.
+ *
+ * @param {CommonChangeProperties} change - The change object to check.
+ * @returns {boolean} `true` if the `changeType` is either 'addXML' or 'addXMLAtExtensionPoint',
+ *          indicating the change is of type `AddXMLChange`.
+ */
+export declare function isAddXMLChange(change: CommonChangeProperties): change is AddXMLChange;
+/**
+ * Asynchronously adds an XML fragment to the project if it doesn't already exist.
+ *
+ * @param {string} basePath - The base path of the project.
+ * @param {AddXMLChange} change - The change data, including the fragment path.
+ * @param {Editor} fs - The mem-fs-editor instance.
+ * @param {Logger} logger - The logging instance.
+ */
+export declare function addXmlFragment(basePath: string, change: AddXMLChange, fs: Editor, logger: Logger): void;
+//# sourceMappingURL=change-handler.d.ts.map

package/dist/preview/change-handler.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addXmlFragment = exports.isAddXMLChange = exports.tryFixChange = exports.moduleNameContentMap = void 0;
+const path_1 = require("path");
+const project_access_1 = require("@sap-ux/project-access");
+/**
+ * A mapping object that defines how to extract change content data from changes based on their type.
+ */
+exports.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
+ */
+/**
+ * Attempts to fix a change object by setting its moduleName based on its reference and changeType
+ * to also support old changes with newer UI5 versions.
+ *
+ * @param {CommonChangeProperties} change - The change object to be fixed.
+ * @param {Logger} logger - An instance for logging warnings, errors, or informational messages.
+ */
+function tryFixChange(change, logger) {
+    try {
+        const prefix = change.reference.replace(/\./g, '/');
+        change.moduleName = `${prefix}/changes/${exports.moduleNameContentMap[change.changeType](change)}`;
+    }
+    catch (error) {
+        logger.warn('Could not fix missing module name.');
+    }
+}
+exports.tryFixChange = tryFixChange;
+/**
+ * Determines whether a given change is of type `AddXMLChange`.
+ *
+ * @param {CommonChangeProperties} change - The change object to check.
+ * @returns {boolean} `true` if the `changeType` is either 'addXML' or 'addXMLAtExtensionPoint',
+ *          indicating the change is of type `AddXMLChange`.
+ */
+function isAddXMLChange(change) {
+    return change.changeType === 'addXML' || change.changeType === 'addXMLAtExtensionPoint';
+}
+exports.isAddXMLChange = isAddXMLChange;
+/**
+ * Asynchronously adds an XML fragment to the project if it doesn't already exist.
+ *
+ * @param {string} basePath - The base path of the project.
+ * @param {AddXMLChange} change - The change data, including the fragment path.
+ * @param {Editor} fs - The mem-fs-editor instance.
+ * @param {Logger} logger - The logging instance.
+ */
+function addXmlFragment(basePath, change, fs, logger) {
+    const { fragmentPath } = change.content;
+    const fullPath = (0, path_1.join)(basePath, project_access_1.DirName.Changes, fragmentPath);
+    try {
+        if (fs.exists(fullPath)) {
+            logger.info(`XML Fragment "${fragmentPath}" already exists.`);
+            return;
+        }
+        const fragmentTemplatePath = (0, path_1.join)(__dirname, '../../templates/rta', "fragment.xml" /* TemplateFileName.Fragment */);
+        fs.copy(fragmentTemplatePath, fullPath);
+        logger.info(`XML Fragment "${fragmentPath}" was created`);
+    }
+    catch (error) {
+        logger.error(`Failed to create XML Fragment "${fragmentPath}": ${error}`);
+    }
+}
+exports.addXmlFragment = addXmlFragment;
+//# sourceMappingURL=change-handler.js.map

package/dist/preview/routes-handler.d.ts

@@ -50,14 +50,6 @@ export default class RoutesHandler {
      * @param next Next Function
      */
     handleReadAllFragments: (_: Request, res: Response, next: NextFunction) => Promise<void>;
-    /**
-     * Handler for writing a fragment file to the workspace.
-     *
-     * @param req Request
-     * @param res Response
-     * @param next Next Function
-     */
-    handleWriteFragment: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     /**
      * Handler for reading all controller extension files from the workspace.
      *

package/dist/preview/routes-handler.js

@@ -80,47 +80,6 @@ class RoutesHandler {
                 this.handleErrorMessage(res, next, e);
             }
         });
-        /**
-         * Handler for writing a fragment file to the workspace.
-         *
-         * @param req Request
-         * @param res Response
-         * @param next Next Function
-         */
-        this.handleWriteFragment = (req, res, next) => __awaiter(this, void 0, void 0, function* () {
-            try {
-                const data = req.body;
-                const fragmentName = (0, sanitize_filename_1.default)(data.fragmentName);
-                const sourcePath = this.util.getProject().getSourcePath();
-                if (!fragmentName) {
-                    res.status(400 /* HttpStatusCodes.BAD_REQUEST */).send('Fragment name was not provided!');
-                    this.logger.debug('Bad request. Fragment name was not provided!');
-                    return;
-                }
-                const fullPath = path.join(sourcePath, project_access_1.DirName.Changes, project_access_1.DirName.Fragments);
-                const filePath = path.join(fullPath, `${fragmentName}.fragment.xml`);
-                if (!fs.existsSync(fullPath)) {
-                    fs.mkdirSync(fullPath, { recursive: true });
-                }
-                if (fs.existsSync(filePath)) {
-                    res.status(409 /* HttpStatusCodes.CONFLICT */).send(`Fragment with name "${fragmentName}" already exists`);
-                    this.logger.debug(`XML Fragment with name "${fragmentName}" was created`);
-                    return;
-                }
-                // Copy the template XML Fragment to the project's workspace
-                const fragmentTemplatePath = path.join(__dirname, '../../templates/rta', "fragment.xml" /* TemplateFileName.Fragment */);
-                fs.copyFileSync(fragmentTemplatePath, filePath);
-                const message = 'XML Fragment created';
-                res.status(201 /* HttpStatusCodes.CREATED */).send(message);
-                this.logger.debug(`XML Fragment with name "${fragmentName}" was created`);
-            }
-            catch (e) {
-                const sanitizedMsg = (0, sanitize_filename_1.default)(e.message);
-                this.logger.error(sanitizedMsg);
-                res.status(500 /* HttpStatusCodes.INTERNAL_SERVER_ERROR */).send(sanitizedMsg);
-                next(e);
-            }
-        });
         /**
          * Handler for reading all controller extension files from the workspace.
          *

package/dist/types.d.ts

@@ -61,7 +61,7 @@ export interface Content {
     content: object;
     texts?: object;
 }
-interface CommonChangeProperties {
+export interface CommonChangeProperties {
     changeType: string;
     reference: string;
     namespace: string;
@@ -135,6 +135,7 @@ export declare const enum HttpStatusCodes {
     NOT_IMPLEMETED = 501,
     SERVICE_UNAVAILABLE = 503
 }
+export type OperationType = 'read' | 'write' | 'delete';
 /**
  * Represents a constructor type that creates an instance of IWriter.
  *

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aadp-tooling"
   },
-  "version": "0.9.18",
+  "version": "0.9.20",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -30,7 +30,7 @@
     "prompts": "2.4.2",
     "adm-zip": "0.5.10",
     "@sap-ux/axios-extension": "1.11.7",
-    "@sap-ux/project-access": "1.19.10",
+    "@sap-ux/project-access": "1.19.11",
     "@sap-ux/logger": "0.5.1",
     "@sap-ux/system-access": "0.3.21",
     "@sap-ux/ui5-config": "0.22.1",