@sap-ux/adp-tooling 0.5.5 → 0.6.0

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

@@ -7,7 +7,8 @@ import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
 import type { AdpPreviewConfig, DescriptorVariant } from '../types';
 export declare const enum ApiRoutes {
     FRAGMENT = "/adp/api/fragment",
-    CONTROLLER = "/adp/api/controller"
+    CONTROLLER = "/adp/api/controller",
+    CODE_EXT = "/adp/api/code_ext/:controllerName"
 }
 /**
  * Instance of an adaptation project handling requests and data transformation.

package/dist/preview/adp-preview.js

@@ -126,6 +126,7 @@ class AdpPreview {
         router.post("/adp/api/fragment" /* ApiRoutes.FRAGMENT */, express_1.default.json(), this.routesHandler.handleWriteFragment);
         router.get("/adp/api/controller" /* ApiRoutes.CONTROLLER */, this.routesHandler.handleReadAllControllers);
         router.post("/adp/api/controller" /* ApiRoutes.CONTROLLER */, express_1.default.json(), this.routesHandler.handleWriteControllerExt);
+        router.get("/adp/api/code_ext/:controllerName" /* ApiRoutes.CODE_EXT */, this.routesHandler.handleGetControllerExtensionData);
     }
 }
 exports.AdpPreview = AdpPreview;

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

@@ -1,6 +1,6 @@
-import type { ReaderCollection } from '@ui5/fs';
 import type { ToolsLogger } from '@sap-ux/logger';
 import type { MiddlewareUtils } from '@ui5/server';
+import type { ReaderCollection } from '@ui5/fs';
 import type { NextFunction, Request, Response } from 'express';
 /**
  * @description Handles API Routes
@@ -65,6 +65,14 @@ export default class RoutesHandler {
      * @param next Next Function
      */
     handleReadAllControllers: (_: Request, res: Response, next: NextFunction) => Promise<void>;
+    /**
+     * Handler for retrieving existing controller extension data from the workspace.
+     *
+     * @param req Request
+     * @param res Response
+     * @param next Next Function
+     */
+    handleGetControllerExtensionData: (req: Request, res: Response, next: NextFunction) => Promise<void>;
     /**
      * Handler for writing a controller extension file to the workspace.
      *

package/dist/preview/routes-handler.js

@@ -36,9 +36,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const fs = __importStar(require("fs"));
+const os = __importStar(require("os"));
 const path = __importStar(require("path"));
-const sanitize_filename_1 = __importDefault(require("sanitize-filename"));
 const ejs_1 = require("ejs");
+const sanitize_filename_1 = __importDefault(require("sanitize-filename"));
 /**
  * @description Handles API Routes
  */
@@ -141,6 +142,58 @@ class RoutesHandler {
                 this.handleErrorMessage(res, next, e);
             }
         });
+        /**
+         * Handler for retrieving existing controller extension data from the workspace.
+         *
+         * @param req Request
+         * @param res Response
+         * @param next Next Function
+         */
+        this.handleGetControllerExtensionData = (req, res, next) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                const params = req.params;
+                const controllerName = (0, sanitize_filename_1.default)(params.controllerName);
+                const codeExtFiles = yield this.readAllFilesByGlob('/**/changes/*_codeExt.change');
+                let controllerExists = false;
+                let controllerPath = '';
+                let controllerPathFromRoot = '';
+                const project = this.util.getProject();
+                const sourcePath = project.getSourcePath();
+                const projectName = project.getName();
+                const getPath = (projectPath, fileName) => path
+                    .join(projectPath, "changes" /* FolderNames.Changes */, "coding" /* FolderNames.Coding */, fileName)
+                    .split(path.sep)
+                    .join(path.posix.sep);
+                for (const file of codeExtFiles) {
+                    const fileStr = yield file.getString();
+                    const change = JSON.parse(fileStr);
+                    if (change.selector.controllerName === controllerName) {
+                        const fileName = change.content.codeRef.replace('coding/', '');
+                        controllerPath = getPath(sourcePath, fileName);
+                        controllerPathFromRoot = getPath(projectName, fileName);
+                        controllerExists = true;
+                        break;
+                    }
+                }
+                if (controllerExists && !fs.existsSync(controllerPath)) {
+                    const errorMsg = `Controller extension file was not found at ${controllerPath}`;
+                    this.logger.debug(errorMsg);
+                    res.status(404 /* HttpStatusCodes.NOT_FOUND */).send({ message: errorMsg });
+                    return;
+                }
+                this.sendFilesResponse(res, {
+                    controllerExists,
+                    controllerPath: os.platform() === 'win32' ? `/${controllerPath}` : controllerPath,
+                    controllerPathFromRoot
+                });
+                this.logger.debug(controllerExists
+                    ? `Controller exists at '${controllerPath}'`
+                    : `Controller with controllerName '${controllerName}' does not exist`);
+            }
+            catch (e) {
+                this.handleErrorMessage(res, next, e);
+            }
+        });
         /**
          * Handler for writing a controller extension file to the workspace.
          *

package/dist/types.d.ts

@@ -49,6 +49,48 @@ export interface Content {
     content: object;
     texts?: object;
 }
+interface CommonChangeProperties {
+    changeType: string;
+    reference: string;
+    namespace: string;
+    projectId: string;
+    moduleName: string;
+    support: {
+        generator: string;
+        sapui5Version: string;
+        command?: string;
+    };
+    originalLanguage: string;
+    layer: string;
+    fileType: string;
+    fileName: string;
+    texts: Record<string, unknown>;
+}
+export interface AddXMLChange extends CommonChangeProperties {
+    changeType: 'addXML';
+    creation: string;
+    packageName: string;
+    content: {
+        targetAggregation: string;
+        index: number;
+        fragmentPath: string;
+    };
+    selector: {
+        id: string;
+        idIsLocal: boolean;
+    };
+    dependentSelector: Record<string, unknown>;
+    jsOnly: boolean;
+}
+export interface CodeExtChange extends CommonChangeProperties {
+    changeType: 'codeExt';
+    content: {
+        codeRef: string;
+    };
+    selector: {
+        controllerName: string;
+    };
+}
 export declare const enum FolderNames {
     Changes = "changes",
     Fragments = "fragments",

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.5.5",
+  "version": "0.6.0",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",