@sap-ux/adp-tooling 0.5.5 → 0.7.0

package/dist/base/prompt.d.ts

@@ -3,18 +3,19 @@ export declare const enum flexLayer {
     CUSTOMER_BASE = "CUSTOMER_BASE",
     VENDOR = "VENDOR"
 }
+export type PromptDefaults = {
+    id?: string;
+    reference?: string;
+    url?: string;
+    ft?: boolean;
+    package?: string;
+    transport?: string;
+};
 /**
  * Prompt the user for the required properties for an adaptation project.
  *
  * @param defaults optional default values for the prompts
- * @param defaults.id initial id to be used for the new adaptation id prompt
- * @param defaults.reference initial id used for the original application id prompt
- * @param defaults.url initial url used for the target url prompt
  * @returns a configuration for the adp writer
  */
-export declare function promptGeneratorInput({ id, reference, url }?: {
-    id?: string;
-    reference?: string;
-    url?: string;
-}): Promise<AdpWriterConfig>;
+export declare function promptGeneratorInput(defaults?: PromptDefaults): Promise<AdpWriterConfig>;
 //# sourceMappingURL=prompt.d.ts.map

package/dist/base/prompt.js

@@ -18,12 +18,10 @@ const prompts_1 = __importDefault(require("prompts"));
  * Prompt the user for the required properties for an adaptation project.
  *
  * @param defaults optional default values for the prompts
- * @param defaults.id initial id to be used for the new adaptation id prompt
- * @param defaults.reference initial id used for the original application id prompt
- * @param defaults.url initial url used for the target url prompt
  * @returns a configuration for the adp writer
  */
-function promptGeneratorInput({ id, reference, url } = {}) {
+function promptGeneratorInput(defaults = {}) {
+    var _a;
     return __awaiter(this, void 0, void 0, function* () {
         const app = yield (0, prompts_1.default)([
             {
@@ -46,7 +44,7 @@ function promptGeneratorInput({ id, reference, url } = {}) {
                         return 'New adaptation id:';
                     }
                 },
-                initial: id,
+                initial: defaults.id,
                 format: (input, values) => {
                     if (values.layer === "CUSTOMER_BASE" /* flexLayer.CUSTOMER_BASE */ && !input.startsWith('customer.')) {
                         return `customer.${input}`;
@@ -61,7 +59,7 @@ function promptGeneratorInput({ id, reference, url } = {}) {
                 type: 'text',
                 name: 'reference',
                 message: 'Original application id:',
-                initial: reference,
+                initial: defaults.reference,
                 validate: (input) => (input === null || input === void 0 ? void 0 : input.length) > 0
             },
             {
@@ -75,11 +73,41 @@ function promptGeneratorInput({ id, reference, url } = {}) {
                 type: 'text',
                 name: 'url',
                 message: 'Target system url:',
-                initial: url,
+                initial: defaults.url,
+                validate: (input) => (input === null || input === void 0 ? void 0 : input.length) > 0
+            },
+            {
+                type: 'text',
+                name: 'client',
+                message: 'Client (optional):',
+                validate: (input) => (input ? input.length < 4 : true)
+            }
+        ]);
+        const deploy = yield (0, prompts_1.default)([
+            {
+                type: 'text',
+                name: 'package',
+                message: 'Deployment package:',
+                initial: (_a = defaults.package) !== null && _a !== void 0 ? _a : '$TMP',
+                validate: (input) => (input === null || input === void 0 ? void 0 : input.length) > 0
+            },
+            {
+                type: 'text',
+                name: 'transport',
+                message: 'Transport request (optional):',
+                initial: defaults.transport
+            }
+        ]);
+        const options = yield (0, prompts_1.default)([
+            {
+                type: 'confirm',
+                name: 'fioriTools',
+                message: 'Enable Fiori tools?',
+                initial: defaults.ft !== false,
                 validate: (input) => (input === null || input === void 0 ? void 0 : input.length) > 0
             }
         ]);
-        return { app, target };
+        return { app, target, options, deploy };
     });
 }
 exports.promptGeneratorInput = promptGeneratorInput;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { AdpPreviewConfig, AdpWriterConfig } from './types';
 export * from './preview/adp-preview';
 export { generate } from './writer';
-export * from './base/prompt';
+export { promptGeneratorInput, PromptDefaults } from './base/prompt';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,9 +14,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generate = void 0;
+exports.promptGeneratorInput = exports.generate = void 0;
 __exportStar(require("./preview/adp-preview"), exports);
 var writer_1 = require("./writer");
 Object.defineProperty(exports, "generate", { enumerable: true, get: function () { return writer_1.generate; } });
-__exportStar(require("./base/prompt"), exports);
+var prompt_1 = require("./base/prompt");
+Object.defineProperty(exports, "promptGeneratorInput", { enumerable: true, get: function () { return prompt_1.promptGeneratorInput; } });
 //# sourceMappingURL=index.js.map

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

@@ -1,5 +1,6 @@
 import type { UI5FlexLayer } from '@sap-ux/project-access';
 import type { DestinationAbapTarget, UrlAbapTarget } from '@sap-ux/system-access';
+import type { Adp } from '@sap-ux/ui5-config';
 export interface DescriptorVariant {
     layer: UI5FlexLayer;
     reference: string;
@@ -33,6 +34,16 @@ export interface AdpWriterConfig {
         name?: string;
         description?: string;
     };
+    /**
+     * Optional: configuration for deployment to ABAP
+     */
+    deploy?: Adp;
+    options?: {
+        /**
+         * Optional: if set to true then the generated project will be recognized by the SAP Fiori tools
+         */
+        fioriTools?: boolean;
+    };
 }
 export interface ManifestAppdescr {
     fileName: string;
@@ -49,6 +60,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/dist/writer/index.d.ts

@@ -1,7 +1,7 @@
 import type { Editor } from 'mem-fs-editor';
 import type { AdpWriterConfig } from '../types';
 /**
- * Writes the adp-project template to the memfs editor instance.
+ * Writes the adp-project template to the mem-fs-editor instance.
  *
  * @param basePath - the base path
  * @param config - the writer configuration

package/dist/writer/index.js

@@ -14,6 +14,7 @@ const path_1 = require("path");
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const ui5_config_1 = require("@sap-ux/ui5-config");
+const options_1 = require("./options");
 /**
  * Set default values for optional properties.
  *
@@ -26,7 +27,9 @@ function setDefaults(config) {
     const configWithDefaults = {
         app: Object.assign({}, config.app),
         target: Object.assign({}, config.target),
-        ui5: Object.assign({}, config.ui5)
+        ui5: Object.assign({}, config.ui5),
+        deploy: config.deploy ? Object.assign({}, config.deploy) : undefined,
+        options: Object.assign({}, config.options)
     };
     (_a = (_f = configWithDefaults.app).title) !== null && _a !== void 0 ? _a : (_f.title = `Adaptation of ${config.app.reference}`);
     (_b = (_g = configWithDefaults.app).layer) !== null && _b !== void 0 ? _b : (_g.layer = 'CUSTOMER_BASE');
@@ -36,7 +39,7 @@ function setDefaults(config) {
     return configWithDefaults;
 }
 /**
- * Writes the adp-project template to the memfs editor instance.
+ * Writes the adp-project template to the mem-fs-editor instance.
  *
  * @param basePath - the base path
  * @param config - the writer configuration
@@ -56,48 +59,16 @@ function generate(basePath, config, fs) {
         });
         // ui5.yaml
         const ui5ConfigPath = (0, path_1.join)(basePath, 'ui5.yaml');
-        const ui5Config = yield ui5_config_1.UI5Config.newInstance(fs.read(ui5ConfigPath));
-        ui5Config.addCustomMiddleware([
-            {
-                name: 'preview-middleware',
-                afterMiddleware: 'compression',
-                configuration: {
-                    adp: {
-                        target: fullConfig.target,
-                        ignoreCertErrors: false
-                    },
-                    rta: {
-                        editors: [
-                            {
-                                path: '/local/editor.html',
-                                developerMode: true
-                            }
-                        ]
-                    }
-                }
-            },
-            {
-                name: 'ui5-proxy-middleware',
-                afterMiddleware: 'preview-middleware',
-                configuration: {
-                    ui5: {
-                        path: ['/resources', '/test-resources'],
-                        url: 'https://ui5.sap.com'
-                    }
-                }
-            },
-            {
-                name: 'backend-proxy-middleware',
-                afterMiddleware: 'preview-middleware',
-                configuration: {
-                    backend: Object.assign(Object.assign({}, fullConfig.target), { path: '/sap' }),
-                    options: {
-                        secure: true
-                    }
-                }
-            }
-        ]);
+        const baseUi5ConfigContent = fs.read(ui5ConfigPath);
+        const ui5Config = yield ui5_config_1.UI5Config.newInstance(baseUi5ConfigContent);
+        (0, options_1.enhanceUI5Yaml)(ui5Config, fullConfig);
         fs.write(ui5ConfigPath, ui5Config.toString());
+        // ui5-deploy.yaml
+        if ((0, options_1.hasDeployConfig)(fullConfig)) {
+            const ui5DeployConfig = yield ui5_config_1.UI5Config.newInstance(baseUi5ConfigContent);
+            (0, options_1.enhanceUI5DeployYaml)(ui5DeployConfig, fullConfig);
+            fs.write((0, path_1.join)(basePath, 'ui5-deploy.yaml'), ui5DeployConfig.toString());
+        }
         return fs;
     });
 }

package/dist/writer/options.d.ts

@@ -0,0 +1,31 @@
+import type { UI5Config } from '@sap-ux/ui5-config';
+import type { AdpWriterConfig } from '../types';
+/**
+ * Generate the configuration for the middlewares required for the ui5.yaml.
+ *
+ * @param ui5Config configuration representing the ui5.yaml
+ * @param config full project configuration
+ */
+export declare function enhanceUI5Yaml(ui5Config: UI5Config, config: AdpWriterConfig): void;
+/**
+ * Writer configuration with deploy configuration.
+ */
+type AdpWriterConfigWithDeploy = AdpWriterConfig & {
+    deploy: NonNullable<AdpWriterConfig['deploy']>;
+};
+/**
+ * Checks if a writer config has a deploy configuration.
+ *
+ * @param config a writer configuration
+ * @returns typecasted config if it contains a deploy config
+ */
+export declare function hasDeployConfig(config: AdpWriterConfig): config is AdpWriterConfigWithDeploy;
+/**
+ * Generate the configuration for the tasks required for the ui5-deploy.yaml.
+ *
+ * @param ui5Config configuration representing the ui5.yaml
+ * @param config full project configuration
+ */
+export declare function enhanceUI5DeployYaml(ui5Config: UI5Config, config: AdpWriterConfigWithDeploy): void;
+export {};
+//# sourceMappingURL=options.d.ts.map

package/dist/writer/options.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.enhanceUI5DeployYaml = exports.hasDeployConfig = exports.enhanceUI5Yaml = void 0;
+/**
+ * Generate the configuration for the middlewares required for the ui5.yaml.
+ *
+ * @param ui5Config configuration representing the ui5.yaml
+ * @param config full project configuration
+ */
+function enhanceUI5Yaml(ui5Config, config) {
+    var _a;
+    const middlewares = ((_a = config.options) === null || _a === void 0 ? void 0 : _a.fioriTools) ? getFioriToolsMiddlwares(config) : getOpenSourceMiddlewares(config);
+    ui5Config.addCustomMiddleware(middlewares);
+}
+exports.enhanceUI5Yaml = enhanceUI5Yaml;
+/**
+ * Checks if a writer config has a deploy configuration.
+ *
+ * @param config a writer configuration
+ * @returns typecasted config if it contains a deploy config
+ */
+function hasDeployConfig(config) {
+    return !!config.deploy;
+}
+exports.hasDeployConfig = hasDeployConfig;
+/**
+ * Generate the configuration for the tasks required for the ui5-deploy.yaml.
+ *
+ * @param ui5Config configuration representing the ui5.yaml
+ * @param config full project configuration
+ */
+function enhanceUI5DeployYaml(ui5Config, config) {
+    var _a;
+    ui5Config.addAbapDeployTask(config.target, config.deploy, ((_a = config.options) === null || _a === void 0 ? void 0 : _a.fioriTools) === true);
+}
+exports.enhanceUI5DeployYaml = enhanceUI5DeployYaml;
+/**
+ * Get a list of required middlewares using the Fiori tools.
+ *
+ * @param config full project configuration
+ * @returns list of required middlewares.
+ */
+function getFioriToolsMiddlwares(config) {
+    return [
+        {
+            name: 'fiori-tools-preview',
+            afterMiddleware: 'compression',
+            configuration: {
+                adp: {
+                    target: config.target,
+                    ignoreCertErrors: false
+                }
+            }
+        },
+        {
+            name: 'fiori-tools-proxy',
+            afterMiddleware: 'fiori-tools-preview',
+            configuration: {
+                ignoreCertErrors: false,
+                ui5: {
+                    path: ['/resources', '/test-resources'],
+                    url: 'https://ui5.sap.com'
+                },
+                backend: [
+                    Object.assign(Object.assign({}, config.target), { path: '/sap' })
+                ]
+            }
+        }
+    ];
+}
+/**
+ * Get a list of required middlewares using the open source middlewares.
+ *
+ * @param config full project configuration
+ * @returns list of required middlewares.
+ */
+function getOpenSourceMiddlewares(config) {
+    return [
+        {
+            name: 'preview-middleware',
+            afterMiddleware: 'compression',
+            configuration: {
+                adp: {
+                    target: config.target,
+                    ignoreCertErrors: false
+                },
+                rta: {
+                    editors: [
+                        {
+                            path: '/test/adaptation-editor.html',
+                            developerMode: true
+                        }
+                    ]
+                }
+            }
+        },
+        {
+            name: 'ui5-proxy-middleware',
+            afterMiddleware: 'preview-middleware'
+        },
+        {
+            name: 'backend-proxy-middleware',
+            afterMiddleware: 'preview-middleware',
+            configuration: {
+                backend: Object.assign(Object.assign({}, config.target), { path: '/sap' }),
+                options: {
+                    secure: true
+                }
+            }
+        }
+    ];
+}
+//# sourceMappingURL=options.js.map

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.7.0",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -32,7 +32,7 @@
     "@sap-ux/axios-extension": "1.7.3",
     "@sap-ux/logger": "0.4.0",
     "@sap-ux/system-access": "0.3.5",
-    "@sap-ux/ui5-config": "0.20.0"
+    "@sap-ux/ui5-config": "0.21.0"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
@@ -46,7 +46,7 @@
     "nock": "13.2.1",
     "rimraf": "5.0.1",
     "supertest": "6.3.3",
-    "@sap-ux/project-access": "1.15.1",
+    "@sap-ux/project-access": "1.15.4",
     "@sap-ux/store": "0.4.0"
   },
   "peerDependencies": {

package/templates/project/package.json

@@ -5,19 +5,22 @@
     "description": "<%= package.description %>",
     "keywords": [
         "ui5",
-        "openui5",
-        "sapui5"
+        "sapui5",
+        "adaptation-project"
     ],
     "dependencies": {},
     "devDependencies": {
-        "@sap-ux/backend-proxy-middleware": "^0.6.68",
-        "@sap-ux/preview-middleware": "^0.5.0",
-        "@sap-ux/ui5-proxy-middleware": "^1.1.34",
+        <%if (locals.options?.fioriTools) {%>"@sap/ux-ui5-tooling": "^1.11.4"<%} else {%>"@sap-ux/backend-proxy-middleware": "^0.7.5",
+        "@sap-ux/preview-middleware": "^0.11.1",
+        "@sap-ux/ui5-proxy-middleware": "^1.3.0",
+        "@sap-ux/deploy-tooling": "^0.11.7"<%}%>,
         "@ui5/cli": "^3.6.0"
     },
     "scripts": {
         "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"
+        "start": "<%= locals.options?.fioriTools ? 'fiori run' : 'ui5 serve' %> --open /test/flp.html#app-preview",
+        "start-editor": "<%= locals.options?.fioriTools ? 'fiori run' : 'ui5 serve' %> --open /test/adaptation-editor.html"<%if (locals.deploy) {%>,
+        "deploy": "ui5 build --config ui5-deploy.yaml --exclude-task <%= locals.options?.fioriTools ? 'deploy-to-abap' : 'abap-deploy-task' %> generateFlexChangesBundle generateComponentPreload --clean-dest && <%= locals.options?.fioriTools ? 'fiori deploy' : 'deploy' %> --config ui5-deploy.yaml",
+        "undeploy": "<%= locals.options?.fioriTools ? 'fiori undeploy' : 'undeploy' %> --config ui5-deploy.yaml --lrep 'apps/<%= app.reference %>/appVariants/<%= app.id %>/'"<%}%>
     }
 }