@sap-ux/adp-tooling 0.3.4 → 0.4.1

package/dist/preview/adp-preview.js

@@ -167,11 +167,10 @@ class AdpPreview {
      * @param router router that is to be enhanced with the API
      */
     addApis(router) {
-        /**
-         * FRAGMENT Routes
-         */
         router.get("/adp/api/fragment" /* ApiRoutes.FRAGMENT */, this.routesHandler.handleReadAllFragments);
         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);
     }
 }
 exports.AdpPreview = AdpPreview;

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

@@ -17,6 +17,30 @@ export default class RoutesHandler {
      * @param logger Logger instance
      */
     constructor(project: ReaderCollection, util: MiddlewareUtils, logger: ToolsLogger);
+    /**
+     * Reads files from workspace by given search pattern.
+     *
+     * @param pattern Search pattern
+     * @returns Array of files
+     */
+    private readAllFilesByGlob;
+    /**
+     * Sends response with data to the client.
+     *
+     * @param res Response
+     * @param data Data that is sent to the client
+     * @param contentType Content type, defaults to json
+     */
+    private sendFilesResponse;
+    /**
+     * Sanitizes and handles error messages.
+     *
+     * @param res Response
+     * @param next Next function
+     * @param e Error
+     * @param e.message Error message
+     */
+    private handleErrorMessage;
     /**
      * Handler for reading all fragment files from the workspace.
      *
@@ -33,5 +57,21 @@ export default class RoutesHandler {
      * @param next Next Function
      */
     handleWriteFragment: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    /**
+     * Handler for reading all controller extension files from the workspace.
+     *
+     * @param _ Request
+     * @param res Response
+     * @param next Next Function
+     */
+    handleReadAllControllers: (_: Request, res: Response, next: NextFunction) => Promise<void>;
+    /**
+     * Handler for writing a controller extension file to the workspace.
+     *
+     * @param req Request
+     * @param res Response
+     * @param next Next Function
+     */
+    handleWriteControllerExt: (req: Request, res: Response, next: NextFunction) => Promise<void>;
 }
 //# sourceMappingURL=routes-handler.d.ts.map

package/dist/preview/routes-handler.js

@@ -38,6 +38,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const sanitize_filename_1 = __importDefault(require("sanitize-filename"));
+const ejs_1 = require("ejs");
 /**
  * @description Handles API Routes
  */
@@ -62,28 +63,18 @@ class RoutesHandler {
          */
         this.handleReadAllFragments = (_, res, next) => __awaiter(this, void 0, void 0, function* () {
             try {
-                const files = yield this.project.byGlob('/**/changes/**/*.fragment.xml');
-                if (!files || files.length === 0) {
-                    res.status(200 /* HttpStatusCodes.OK */)
-                        .contentType('application/json')
-                        .send({ fragments: [], message: `No fragments found in the project workspace.` });
-                    return;
-                }
-                const fragments = files.map((f) => ({
+                const files = yield this.readAllFilesByGlob('/**/changes/fragments/*.fragment.xml');
+                const fileNames = files.map((f) => ({
                     fragmentName: f.getName()
                 }));
-                res.status(200 /* HttpStatusCodes.OK */)
-                    .contentType('application/json')
-                    .send({
-                    fragments,
-                    message: `${fragments.length} fragments found in the project workspace.`
+                this.sendFilesResponse(res, {
+                    fragments: fileNames,
+                    message: `${fileNames.length} fragments found in the project workspace.`
                 });
-                this.logger.debug(`Read fragments ${JSON.stringify(fragments)}`);
+                this.logger.debug(`Read fragments ${JSON.stringify(fileNames)}`);
             }
             catch (e) {
-                this.logger.error(e.message);
-                res.status(500 /* HttpStatusCodes.INTERNAL_SERVER_ERROR */).send({ message: e.message });
-                next(e);
+                this.handleErrorMessage(res, next, e);
             }
         });
         /**
@@ -98,28 +89,97 @@ class RoutesHandler {
                 const data = req.body;
                 const fragmentName = (0, sanitize_filename_1.default)(data.fragmentName);
                 const sourcePath = this.util.getProject().getSourcePath();
-                if (fragmentName) {
-                    const fullPath = path.join(sourcePath, "changes" /* FolderNames.Changes */, "fragments" /* FolderNames.Fragments */);
-                    const filePath = path.join(fullPath, `${fragmentName}.fragment.xml`);
-                    if (!fs.existsSync(fullPath)) {
-                        fs.mkdirSync(fullPath);
-                    }
-                    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`);
-                }
-                else {
+                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, "changes" /* FolderNames.Changes */, "fragments" /* FolderNames.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.
+         *
+         * @param _ Request
+         * @param res Response
+         * @param next Next Function
+         */
+        this.handleReadAllControllers = (_, res, next) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                const files = yield this.readAllFilesByGlob('/**/changes/coding/*.js');
+                const fileNames = files.map((f) => ({
+                    controllerName: f.getName()
+                }));
+                this.sendFilesResponse(res, {
+                    controllers: fileNames,
+                    message: `${fileNames.length} controllers found in the project workspace.`
+                });
+                this.logger.debug(`Read controllers ${JSON.stringify(fileNames)}`);
+            }
+            catch (e) {
+                this.handleErrorMessage(res, next, e);
+            }
+        });
+        /**
+         * Handler for writing a controller extension file to the workspace.
+         *
+         * @param req Request
+         * @param res Response
+         * @param next Next Function
+         */
+        this.handleWriteControllerExt = (req, res, next) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = req.body;
+                const controllerExtName = (0, sanitize_filename_1.default)(data.controllerName);
+                const projectId = data.projectId;
+                const sourcePath = this.util.getProject().getSourcePath();
+                if (!controllerExtName) {
+                    res.status(400 /* HttpStatusCodes.BAD_REQUEST */).send('Controller extension name was not provided!');
+                    this.logger.debug('Bad request. Controller extension name was not provided!');
+                    return;
+                }
+                const fullPath = path.join(sourcePath, "changes" /* FolderNames.Changes */, "coding" /* FolderNames.Coding */);
+                const filePath = path.join(fullPath, `${controllerExtName}.js`);
+                if (!fs.existsSync(fullPath)) {
+                    fs.mkdirSync(fullPath, { recursive: true });
+                }
+                if (fs.existsSync(filePath)) {
+                    res.status(409 /* HttpStatusCodes.CONFLICT */).send(`Controller extension with name "${controllerExtName}" already exists`);
+                    this.logger.debug(`Controller extension with name "${controllerExtName}" already exists`);
+                    return;
                 }
+                const controllerExtPath = `${projectId}.${controllerExtName}`;
+                const controllerTemplateFilePath = path.join(__dirname, '../../templates/rta', "controller.ejs" /* TemplateFileName.Controller */);
+                (0, ejs_1.renderFile)(controllerTemplateFilePath, { controllerExtPath }, {}, (err, str) => {
+                    if (err) {
+                        throw new Error('Error rendering template: ' + err.message);
+                    }
+                    fs.writeFileSync(filePath, str, { encoding: 'utf8' });
+                });
+                const message = 'Controller extension created!';
+                res.status(201 /* HttpStatusCodes.CREATED */).send(message);
+                this.logger.debug(`Controller extension with name "${controllerExtName}" was created`);
             }
             catch (e) {
                 const sanitizedMsg = (0, sanitize_filename_1.default)(e.message);
@@ -129,6 +189,41 @@ class RoutesHandler {
             }
         });
     }
+    /**
+     * Reads files from workspace by given search pattern.
+     *
+     * @param pattern Search pattern
+     * @returns Array of files
+     */
+    readAllFilesByGlob(pattern) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.project.byGlob(pattern);
+        });
+    }
+    /**
+     * Sends response with data to the client.
+     *
+     * @param res Response
+     * @param data Data that is sent to the client
+     * @param contentType Content type, defaults to json
+     */
+    sendFilesResponse(res, data, contentType = 'application/json') {
+        res.status(200 /* HttpStatusCodes.OK */).contentType(contentType).send(data);
+    }
+    /**
+     * Sanitizes and handles error messages.
+     *
+     * @param res Response
+     * @param next Next function
+     * @param e Error
+     * @param e.message Error message
+     */
+    handleErrorMessage(res, next, e) {
+        const sanitizedMsg = (0, sanitize_filename_1.default)(e.message);
+        this.logger.error(sanitizedMsg);
+        res.status(500 /* HttpStatusCodes.INTERNAL_SERVER_ERROR */).send({ message: sanitizedMsg });
+        next(e);
+    }
 }
 exports.default = RoutesHandler;
 //# sourceMappingURL=routes-handler.js.map

package/dist/types.d.ts

@@ -51,10 +51,12 @@ export interface Content {
 }
 export declare const enum FolderNames {
     Changes = "changes",
-    Fragments = "fragments"
+    Fragments = "fragments",
+    Coding = "coding"
 }
 export declare const enum TemplateFileName {
-    Fragment = "fragment.xml"
+    Fragment = "fragment.xml",
+    Controller = "controller.ejs"
 }
 export declare const enum HttpStatusCodes {
     OK = 200,

package/dist/writer/index.js

@@ -69,7 +69,7 @@ function generate(basePath, config, fs) {
                     rta: {
                         editors: [
                             {
-                                path: 'local/editor.html',
+                                path: '/local/editor.html',
                                 developerMode: true
                             }
                         ]

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

package/templates/project/package.json

@@ -16,7 +16,7 @@
         "@ui5/cli": "^3.6.0"
     },
     "scripts": {
-        "build": "ui5 build --clean-dest",
+        "build": "ui5 build --exclude-task generateFlexChangesBundle generateComponentPreload --clean-dest",
         "start": "ui5 serve --open /test/flp.html#app-preview",
         "editor": "ui5 serve --open /local/editor.html"
     }

package/templates/rta/controller.ejs

@@ -0,0 +1,80 @@
+sap.ui.define(
+    [
+        'sap/ui/core/mvc/ControllerExtension'
+        // ,'sap/ui/core/mvc/OverrideExecution'
+    ],
+    function (
+        ControllerExtension
+        // ,OverrideExecution
+    ) {
+        'use strict';
+        return ControllerExtension.extend("<%= controllerExtPath %>", {
+            // metadata: {
+            // 	// extension can declare the public methods
+            // 	// in general methods that start with "_" are private
+            // 	methods: {
+            // 		publicMethod: {
+            // 			public: true /*default*/ ,
+            // 			final: false /*default*/ ,
+            // 			overrideExecution: OverrideExecution.Instead /*default*/
+            // 		},
+            // 		finalPublicMethod: {
+            // 			final: true
+            // 		},
+            // 		onMyHook: {
+            // 			public: true /*default*/ ,
+            // 			final: false /*default*/ ,
+            // 			overrideExecution: OverrideExecution.After
+            // 		},
+            // 		couldBePrivate: {
+            // 			public: false
+            // 		}
+            // 	}
+            // },
+            // // adding a private method, only accessible from this controller extension
+            // _privateMethod: function() {},
+            // // adding a public method, might be called from or overridden by other controller extensions as well
+            // publicMethod: function() {},
+            // // adding final public method, might be called from, but not overridden by other controller extensions as well
+            // finalPublicMethod: function() {},
+            // // adding a hook method, might be called by or overridden from other controller extensions
+            // // override these method does not replace the implementation, but executes after the original method
+            // onMyHook: function() {},
+            // // method public per default, but made private via metadata
+            // couldBePrivate: function() {},
+            // // this section allows to extend lifecycle hooks or override public methods of the base controller
+            // override: {
+            // 	/**
+            // 	 * Called when a controller is instantiated and its View controls (if available) are already created.
+            // 	 * Can be used to modify the View before it is displayed, to bind event handlers and do other one-time initialization.
+            // 	 * @memberOf {{controllerExtPath}}
+            // 	 */
+            // 	onInit: function() {
+            // 	},
+            // 	/**
+            // 	 * Similar to onAfterRendering, but this hook is invoked before the controller's View is re-rendered
+            // 	 * (NOT before the first rendering! onInit() is used for that one!).
+            // 	 * @memberOf {{controllerExtPath}}
+            // 	 */
+            // 	onBeforeRendering: function() {
+            // 	},
+            // 	/**
+            // 	 * Called when the View has been rendered (so its HTML is part of the document). Post-rendering manipulations of the HTML could be done here.
+            // 	 * This hook is the same one that SAPUI5 controls get after being rendered.
+            // 	 * @memberOf {{controllerExtPath}}
+            // 	 */
+            // 	onAfterRendering: function() {
+            // 	},
+            // 	/**
+            // 	 * Called when the Controller is destroyed. Use this one to free resources and finalize activities.
+            // 	 * @memberOf {{controllerExtPath}}
+            // 	 */
+            // 	onExit: function() {
+            // 	},
+            // 	// override public method of the base controller
+            // 	basePublicMethod: function() {
+            // 	}
+            // }
+        });
+    }
+);