@sap-ux/adp-tooling 0.2.4 → 0.3.0

package/README.md

@@ -1,12 +1,17 @@
 #  `@sap-ux/adp-tooling`
 
-Module containing different tooling modules helpful when working with SAP UI5 adaptation projects.
+A module containing different tooling modules helpful when working with SAP UI5 adaptation projects.
 
-## preview
+## Submodules
+
+### preview
 The submodule preview contains functionality allowing to preview adaptation projects. It is not a standalone UI5 middleware but designed to be integrated into the `@sap-ux/preview-middleware.`.
 
-## writer
+### writer
 The submodule writer contains functionality to generate the core project structure of an SAP UI5 adaptation project. It is not a standalone generator but designed to be integrated into `@sap-ux/create` or any kind of yeoman generator.
 
-## base
-The submodule contains functionality required in different scenarios, e.g. prompting for generation or when initializing the preview.
+### base
+The submodule contains functionality required in different scenarios, e.g. prompting for generation or when initializing the preview.
+
+## Templates
+The templates folder contains ejs templates to be used for the generation of new adaptation projects as well as to generate artifacts in existing adaptation projects.

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

@@ -1,20 +1,30 @@
-import type { ToolsLogger } from '@sap-ux/logger';
-import type { AdpPreviewConfig, DescriptorVariant } from '../types';
-import type { NextFunction, Request, Response } from 'express';
-import type { MergedAppDescriptor } from '@sap-ux/axios-extension';
 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 { UI5FlexLayer } from '@sap-ux/project-access';
+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"
+}
 /**
  * Instance of an adaptation project handling requests and data transformation.
  */
 export declare class AdpPreview {
     private readonly config;
     private readonly project;
+    private readonly util;
     private readonly logger;
     /**
      * Merged descriptor variant with reference app manifest
      */
     private mergedDescriptor;
+    /**
+     * Routes handler class to handle API requests
+     */
+    private routesHandler;
     /**
      * @returns merged manifest.
      */
@@ -30,9 +40,10 @@ export declare class AdpPreview {
      *
      * @param config adp config
      * @param project reference to the root of the project
+     * @param util middleware utilities provided by the UI5 CLI
      * @param logger logger instance
      */
-    constructor(config: AdpPreviewConfig, project: ReaderCollection, logger: ToolsLogger);
+    constructor(config: AdpPreviewConfig, project: ReaderCollection, util: MiddlewareUtils, logger: ToolsLogger);
     /**
      * Fetch all required configurations from the backend and initialize all configurations.
      *
@@ -48,5 +59,11 @@ export declare class AdpPreview {
      * @param next next middleware that is to be called if the request cannot be handled
      */
     proxy(req: Request, res: Response, next: NextFunction): Promise<void>;
+    /**
+     * Add additional APIs to the router that are required for adaptation projects only.
+     *
+     * @param router router that is to be enhanced with the API
+     */
+    addApis(router: Router): void;
 }
 //# sourceMappingURL=adp-preview.d.ts.map

package/dist/preview/adp-preview.js

@@ -15,10 +15,15 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
     function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
     function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AdpPreview = void 0;
+const express_1 = __importDefault(require("express"));
 const yazl_1 = require("yazl");
 const system_access_1 = require("@sap-ux/system-access");
+const routes_handler_1 = __importDefault(require("./routes-handler"));
 /**
  * Create a buffer based on the given zip file object.
  *
@@ -97,12 +102,15 @@ class AdpPreview {
      *
      * @param config adp config
      * @param project reference to the root of the project
+     * @param util middleware utilities provided by the UI5 CLI
      * @param logger logger instance
      */
-    constructor(config, project, logger) {
+    constructor(config, project, util, logger) {
         this.config = config;
         this.project = project;
+        this.util = util;
         this.logger = logger;
+        this.routesHandler = new routes_handler_1.default(project, util, logger);
     }
     /**
      * Fetch all required configurations from the backend and initialize all configurations.
@@ -153,6 +161,18 @@ class AdpPreview {
             }
         });
     }
+    /**
+     * Add additional APIs to the router that are required for adaptation projects only.
+     *
+     * @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);
+    }
 }
 exports.AdpPreview = AdpPreview;
 //# sourceMappingURL=adp-preview.js.map

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

@@ -0,0 +1,37 @@
+import type { ReaderCollection } from '@ui5/fs';
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { MiddlewareUtils } from '@ui5/server';
+import type { NextFunction, Request, Response } from 'express';
+/**
+ * @description Handles API Routes
+ */
+export default class RoutesHandler {
+    private readonly project;
+    private readonly util;
+    private readonly logger;
+    /**
+     * Constructor taking project as input.
+     *
+     * @param project Reference to the root of the project
+     * @param util middleware utilities provided by the UI5 CLI
+     * @param logger Logger instance
+     */
+    constructor(project: ReaderCollection, util: MiddlewareUtils, logger: ToolsLogger);
+    /**
+     * Handler for reading all fragment files from the workspace.
+     *
+     * @param _ Request
+     * @param res Response
+     * @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>;
+}
+//# sourceMappingURL=routes-handler.d.ts.map

package/dist/preview/routes-handler.js

@@ -0,0 +1,134 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const sanitize_filename_1 = __importDefault(require("sanitize-filename"));
+/**
+ * @description Handles API Routes
+ */
+class RoutesHandler {
+    /**
+     * Constructor taking project as input.
+     *
+     * @param project Reference to the root of the project
+     * @param util middleware utilities provided by the UI5 CLI
+     * @param logger Logger instance
+     */
+    constructor(project, util, logger) {
+        this.project = project;
+        this.util = util;
+        this.logger = logger;
+        /**
+         * Handler for reading all fragment files from the workspace.
+         *
+         * @param _ Request
+         * @param res Response
+         * @param next Next Function
+         */
+        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) => ({
+                    fragmentName: f.getName()
+                }));
+                res.status(200 /* HttpStatusCodes.OK */)
+                    .contentType('application/json')
+                    .send({
+                    fragments,
+                    message: `${fragments.length} fragments found in the project workspace.`
+                });
+                this.logger.debug(`Read fragments ${JSON.stringify(fragments)}`);
+            }
+            catch (e) {
+                this.logger.error(e.message);
+                res.status(500 /* HttpStatusCodes.INTERNAL_SERVER_ERROR */).send({ message: e.message });
+                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) {
+                    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 {
+                    res.status(400 /* HttpStatusCodes.BAD_REQUEST */).send('Fragment name was not provided!');
+                    this.logger.debug('Bad request. Fragment name was not provided!');
+                }
+            }
+            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);
+            }
+        });
+    }
+}
+exports.default = RoutesHandler;
+//# sourceMappingURL=routes-handler.js.map

package/dist/types.d.ts

@@ -34,5 +34,41 @@ export interface AdpWriterConfig {
         description?: string;
     };
 }
+export interface ManifestAppdescr {
+    fileName: string;
+    layer: string;
+    fileType: string;
+    reference: string;
+    id: string;
+    namespace: string;
+    version: string;
+    content: Content[];
+}
+export interface Content {
+    changeType: string;
+    content: object;
+    texts?: object;
+}
+export declare const enum FolderNames {
+    Changes = "changes",
+    Fragments = "fragments"
+}
+export declare const enum TemplateFileName {
+    Fragment = "fragment.xml"
+}
+export declare const enum HttpStatusCodes {
+    OK = 200,
+    CREATED = 201,
+    NO_CONTENT = 204,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    CONFLICT = 409,
+    INTERNAL_SERVER_ERROR = 500,
+    NOT_IMPLEMETED = 501,
+    SERVICE_UNAVAILABLE = 503
+}
 export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/writer/index.js

@@ -48,7 +48,7 @@ function generate(basePath, config, fs) {
         if (!fs) {
             fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
         }
-        const tmplPath = (0, path_1.join)(__dirname, '../../templates');
+        const tmplPath = (0, path_1.join)(__dirname, '../../templates/project');
         const fullConfig = setDefaults(config);
         fs.copyTpl((0, path_1.join)(tmplPath, '**/*.*'), (0, path_1.join)(basePath), fullConfig, undefined, {
             globOptions: { dot: 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.2.4",
+  "version": "0.3.0",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -23,22 +23,23 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
+    "sanitize-filename": "1.6.3",
     "ejs": "3.1.9",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "prompts": "2.4.2",
     "yazl": "2.5.1",
-    "@sap-ux/axios-extension": "1.4.6",
-    "@sap-ux/logger": "0.3.7",
-    "@sap-ux/system-access": "0.2.6",
-    "@sap-ux/ui5-config": "0.19.2"
+    "@sap-ux/axios-extension": "1.4.7",
+    "@sap-ux/logger": "0.3.8",
+    "@sap-ux/system-access": "0.2.7",
+    "@sap-ux/ui5-config": "0.19.3"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
     "@types/express": "4.17.17",
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
-    "@types/prompts": "2.0.14",
+    "@types/prompts": "2.4.4",
     "@types/supertest": "2.0.12",
     "@types/yazl": "2.4.2",
     "dotenv": "16.3.1",
@@ -46,8 +47,8 @@
     "nock": "13.2.1",
     "rimraf": "5.0.1",
     "supertest": "6.3.3",
-    "@sap-ux/project-access": "1.13.5",
-    "@sap-ux/store": "0.3.13"
+    "@sap-ux/project-access": "1.13.6",
+    "@sap-ux/store": "0.3.14"
   },
   "engines": {
     "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",

package/templates/rta/fragment.xml

@@ -0,0 +1,4 @@
+<!-- Use stable and unique IDs!-->
+<core:FragmentDefinition xmlns:core='sap.ui.core' xmlns='sap.m'>
+    <!--  add your xml here -->
+</core:FragmentDefinition>