@sap-ux/adp-tooling 0.13.1 → 0.13.4

package/dist/base/abap/manifest-service.js

@@ -130,7 +130,7 @@ class ManifestService {
      */
     async fetchMergedManifest(basePath, descriptorVariantId) {
         const zip = new adm_zip_1.default();
-        const files = (0, helper_1.getWebappFiles)(basePath);
+        const files = await (0, helper_1.getWebappFiles)(basePath);
         for (const file of files) {
             zip.addFile(file.relativePath, Buffer.from(file.content, 'utf-8'));
         }

package/dist/base/helper.d.ts

@@ -5,9 +5,9 @@ import type { DescriptorVariant, AdpPreviewConfig } from '../types';
  *
  * @param {string} basePath - The path to the adaptation project.
  * @param {Editor} fs - The mem-fs editor instance.
- * @returns {DescriptorVariant} The app descriptor variant.
+ * @returns {Promise<DescriptorVariant>} The app descriptor variant.
  */
-export declare function getVariant(basePath: string, fs?: Editor): DescriptorVariant;
+export declare function getVariant(basePath: string, fs?: Editor): Promise<DescriptorVariant>;
 /**
  * Writes the updated variant content to the manifest.appdescr_variant file.
  *
@@ -15,7 +15,7 @@ export declare function getVariant(basePath: string, fs?: Editor): DescriptorVar
  * @param {DescriptorVariant} variant - The descriptor variant object.
  * @param {Editor} fs - The mem-fs editor instance.
  */
-export declare function updateVariant(basePath: string, variant: DescriptorVariant, fs: Editor): void;
+export declare function updateVariant(basePath: string, variant: DescriptorVariant, fs: Editor): Promise<void>;
 /**
  * Checks if FLP configuration changes exist in the manifest.appdescr_variant.
  *
@@ -23,10 +23,10 @@ export declare function updateVariant(basePath: string, variant: DescriptorVaria
  * or `appdescr_app_addNewInbound` present in the content of the descriptor variant.
  *
  * @param {string} basePath - The base path of the project where the manifest.appdescr_variant is located.
- * @returns {boolean} Returns `true` if FLP configuration changes exist, otherwise `false`.
+ * @returns {Promise<boolean>} Returns `true` if FLP configuration changes exist, otherwise `false`.
  * @throws {Error} Throws an error if the variant could not be retrieved.
  */
-export declare function flpConfigurationExists(basePath: string): boolean;
+export declare function flpConfigurationExists(basePath: string): Promise<boolean>;
 /**
  * Checks whether TypeScript is supported in the project by verifying the existence of `tsconfig.json`.
  *
@@ -47,10 +47,10 @@ export declare function getAdpConfig(basePath: string, yamlPath: string): Promis
  * Get all files in the webapp folder.
  *
  * @param {string} basePath - The path to the adaptation project.
- * @returns {Array<{ relativePath: string; content: string }>} The files in the webapp folder.
+ * @returns {Promise<{ relativePath: string; content: string }[]>} The files in the webapp folder.
  */
-export declare function getWebappFiles(basePath: string): {
+export declare function getWebappFiles(basePath: string): Promise<{
     relativePath: string;
     content: string;
-}[];
+}[]>;
 //# sourceMappingURL=helper.d.ts.map

package/dist/base/helper.js

@@ -8,19 +8,20 @@ exports.getAdpConfig = getAdpConfig;
 exports.getWebappFiles = getWebappFiles;
 const fs_1 = require("fs");
 const path_1 = require("path");
-const ui5_config_1 = require("@sap-ux/ui5-config");
+const project_access_1 = require("@sap-ux/project-access");
 /**
  * Get the app descriptor variant.
  *
  * @param {string} basePath - The path to the adaptation project.
  * @param {Editor} fs - The mem-fs editor instance.
- * @returns {DescriptorVariant} The app descriptor variant.
+ * @returns {Promise<DescriptorVariant>} The app descriptor variant.
  */
-function getVariant(basePath, fs) {
+async function getVariant(basePath, fs) {
+    const webappPath = await (0, project_access_1.getWebappPath)(basePath);
     if (fs) {
-        return fs.readJSON((0, path_1.join)(basePath, 'webapp', 'manifest.appdescr_variant'));
+        return fs.readJSON((0, path_1.join)(webappPath, project_access_1.FileName.ManifestAppDescrVar));
     }
-    return JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(basePath, 'webapp', 'manifest.appdescr_variant'), 'utf-8'));
+    return JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(webappPath, project_access_1.FileName.ManifestAppDescrVar), 'utf-8'));
 }
 /**
  * Writes the updated variant content to the manifest.appdescr_variant file.
@@ -29,8 +30,8 @@ function getVariant(basePath, fs) {
  * @param {DescriptorVariant} variant - The descriptor variant object.
  * @param {Editor} fs - The mem-fs editor instance.
  */
-function updateVariant(basePath, variant, fs) {
-    fs.writeJSON((0, path_1.join)(basePath, 'webapp', 'manifest.appdescr_variant'), variant);
+async function updateVariant(basePath, variant, fs) {
+    fs.writeJSON((0, path_1.join)(await (0, project_access_1.getWebappPath)(basePath), project_access_1.FileName.ManifestAppDescrVar), variant);
 }
 /**
  * Checks if FLP configuration changes exist in the manifest.appdescr_variant.
@@ -39,12 +40,12 @@ function updateVariant(basePath, variant, fs) {
  * or `appdescr_app_addNewInbound` present in the content of the descriptor variant.
  *
  * @param {string} basePath - The base path of the project where the manifest.appdescr_variant is located.
- * @returns {boolean} Returns `true` if FLP configuration changes exist, otherwise `false`.
+ * @returns {Promise<boolean>} Returns `true` if FLP configuration changes exist, otherwise `false`.
  * @throws {Error} Throws an error if the variant could not be retrieved.
  */
-function flpConfigurationExists(basePath) {
+async function flpConfigurationExists(basePath) {
     try {
-        const variant = getVariant(basePath);
+        const variant = await getVariant(basePath);
         return variant.content?.some(({ changeType }) => changeType === 'appdescr_app_changeInbound' || changeType === 'appdescr_app_addNewInbound');
     }
     catch (error) {
@@ -71,12 +72,19 @@ function isTypescriptSupported(basePath, fs) {
  */
 async function getAdpConfig(basePath, yamlPath) {
     const ui5ConfigPath = (0, path_1.isAbsolute)(yamlPath) ? yamlPath : (0, path_1.join)(basePath, yamlPath);
-    const ui5Conf = await ui5_config_1.UI5Config.newInstance((0, fs_1.readFileSync)(ui5ConfigPath, 'utf-8'));
-    const customMiddlerware = ui5Conf.findCustomMiddleware('fiori-tools-preview') ??
-        ui5Conf.findCustomMiddleware('preview-middleware');
-    const adp = customMiddlerware?.configuration?.adp;
+    let ui5Conf;
+    let adp;
+    try {
+        ui5Conf = await (0, project_access_1.readUi5Yaml)((0, path_1.dirname)(ui5ConfigPath), (0, path_1.basename)(ui5ConfigPath));
+        const customMiddleware = ui5Conf.findCustomMiddleware('fiori-tools-preview') ??
+            ui5Conf.findCustomMiddleware('preview-middleware');
+        adp = customMiddleware?.configuration?.adp;
+    }
+    catch (error) {
+        // do nothing here
+    }
     if (!adp) {
-        throw new Error('No system configuration found in ui5.yaml');
+        throw new Error(`No system configuration found in ${(0, path_1.basename)(ui5ConfigPath)}`);
     }
     return adp;
 }
@@ -84,10 +92,10 @@ async function getAdpConfig(basePath, yamlPath) {
  * Get all files in the webapp folder.
  *
  * @param {string} basePath - The path to the adaptation project.
- * @returns {Array<{ relativePath: string; content: string }>} The files in the webapp folder.
+ * @returns {Promise<{ relativePath: string; content: string }[]>} The files in the webapp folder.
  */
-function getWebappFiles(basePath) {
-    const dir = (0, path_1.join)(basePath, 'webapp');
+async function getWebappFiles(basePath) {
+    const dir = await (0, project_access_1.getWebappPath)(basePath);
     const files = [];
     const getFilesRecursivelySync = (directory) => {
         const dirents = (0, fs_1.readdirSync)(directory, { withFileTypes: true });

package/dist/preview/change-handler.js

@@ -251,7 +251,7 @@ async function addAnnotationFile(basePath, projectRoot, change, fs, logger) {
                 serviceUrl: datasoruces[dataSourceId].uri,
                 fileName: (0, path_1.basename)(dataSource[annotationDataSourceKey].uri)
             },
-            variant: (0, helper_1.getVariant)(projectRoot),
+            variant: await (0, helper_1.getVariant)(projectRoot),
             isCommand: false
         }, fs);
     }
@@ -268,7 +268,7 @@ async function addAnnotationFile(basePath, projectRoot, change, fs, logger) {
  * @returns Promise<ManifestService>
  */
 async function getManifestService(basePath, logger) {
-    const variant = (0, helper_1.getVariant)(basePath);
+    const variant = await (0, helper_1.getVariant)(basePath);
     const { target, ignoreCertErrors = false } = await (0, helper_1.getAdpConfig)(basePath, (0, path_1.join)(basePath, project_access_1.FileName.Ui5Yaml));
     const provider = await (0, system_access_1.createAbapServiceProvider)(target, { ignoreCertErrors }, true, logger);
     return await manifest_service_1.ManifestService.initMergedManifest(provider, basePath, variant, logger);

package/dist/preview/routes-handler.js

@@ -98,8 +98,8 @@ class RoutesHandler {
     handleReadAllFragments = async (_, res, next) => {
         try {
             const files = await this.readAllFilesByGlob('/**/changes/fragments/*.fragment.xml');
-            const fileNames = files.map((f) => ({
-                fragmentName: f.getName()
+            const fileNames = files.map((file) => ({
+                fragmentName: file.getName()
             }));
             this.sendFilesResponse(res, {
                 fragments: fileNames,
@@ -121,8 +121,8 @@ class RoutesHandler {
     handleReadAllControllers = async (_, res, next) => {
         try {
             const files = await this.readAllFilesByGlob('/**/changes/coding/*.js');
-            const fileNames = files.map((f) => ({
-                controllerName: f.getName()
+            const fileNames = files.map((file) => ({
+                controllerName: file.getName()
             }));
             this.sendFilesResponse(res, {
                 controllers: fileNames,
@@ -220,7 +220,7 @@ class RoutesHandler {
                 this.logger.debug(`Controller extension with name "${name}" already exists`);
                 return;
             }
-            generateControllerFile(rootPath, filePath, name);
+            await generateControllerFile(rootPath, filePath, name);
             const message = 'Controller extension created!';
             res.status(201 /* HttpStatusCodes.CREATED */).send(message);
             this.logger.debug(`Controller extension with name "${name}" was created`);
@@ -306,7 +306,7 @@ class RoutesHandler {
     async getManifestService() {
         const project = this.util.getProject();
         const basePath = project.getRootPath();
-        const variant = (0, helper_1.getVariant)(basePath);
+        const variant = await (0, helper_1.getVariant)(basePath);
         const { target, ignoreCertErrors = false } = await (0, helper_1.getAdpConfig)(basePath, path.join(basePath, project_access_1.FileName.Ui5Yaml));
         const provider = await (0, system_access_1.createAbapServiceProvider)(target, { ignoreCertErrors }, true, this.logger);
         return await manifest_service_1.ManifestService.initMergedManifest(provider, basePath, variant, this.logger);
@@ -324,8 +324,8 @@ exports.default = RoutesHandler;
  * @param {string} name - The name of the controller extension (used in TypeScript templates).
  * @throws {Error} Throws an error if rendering the template fails.
  */
-function generateControllerFile(rootPath, filePath, name) {
-    const id = (0, helper_1.getVariant)(rootPath)?.id;
+async function generateControllerFile(rootPath, filePath, name) {
+    const id = (await (0, helper_1.getVariant)(rootPath))?.id;
     const isTsSupported = (0, helper_1.isTypescriptSupported)(rootPath);
     const tmplFileName = isTsSupported ? "ts-controller.ejs" /* TemplateFileName.TSController */ : "controller.ejs" /* TemplateFileName.Controller */;
     const tmplPath = path.join(__dirname, '../../templates/rta', tmplFileName);

package/dist/prompts/add-annotations-to-odata/index.js

@@ -55,7 +55,7 @@ function getPrompts(basePath, dataSources) {
             },
             default: '',
             when: (answers) => answers.id !== '' && answers.fileSelectOption === 1 /* AnnotationFileSelectType.ExistingFile */,
-            validate: (value) => {
+            validate: async (value) => {
                 const validationResult = (0, project_input_validator_1.validateEmptyString)(value);
                 if (typeof validationResult === 'string') {
                     return validationResult;
@@ -64,8 +64,7 @@ function getPrompts(basePath, dataSources) {
                 if (!(0, fs_1.existsSync)(filePath)) {
                     return (0, i18n_1.t)('validators.fileDoesNotExist');
                 }
-                const fileName = filePath.split(path_1.sep).pop();
-                if ((0, fs_1.existsSync)((0, path_1.join)(basePath, 'webapp', 'changes', 'annotations', fileName))) {
+                if ((0, fs_1.existsSync)((0, path_1.join)(await (0, project_access_1.getWebappPath)(basePath), project_access_1.DirName.Changes, project_access_1.DirName.Annotations, (0, path_1.basename)(filePath)))) {
                     return (0, i18n_1.t)('validators.annotationFileAlreadyExists');
                 }
                 return true;

package/dist/writer/inbound-navigation.js

@@ -24,13 +24,13 @@ async function generateInboundConfig(basePath, config, fs) {
     if (!fs) {
         fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     }
-    const variant = (0, __1.getVariant)(basePath, fs);
+    const variant = await (0, __1.getVariant)(basePath, fs);
     if (!config?.inboundId) {
         config.addInboundId = true;
         config.inboundId = `${variant.id}.InboundID`;
     }
     (0, options_1.enhanceManifestChangeContentWithFlpConfig)(config, variant.id, variant.content);
-    (0, __1.updateVariant)(basePath, variant, fs);
+    await (0, __1.updateVariant)(basePath, variant, fs);
     await updateI18n(basePath, variant.id, config, fs);
     return fs;
 }

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.13.1",
+  "version": "0.13.4",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -34,15 +34,15 @@
     "uuid": "10.0.0",
     "@sap-ux/axios-extension": "1.18.6",
     "@sap-ux/btp-utils": "1.0.1",
-    "@sap-ux/inquirer-common": "0.6.20",
+    "@sap-ux/inquirer-common": "0.6.22",
     "@sap-ux/logger": "0.6.0",
-    "@sap-ux/project-access": "1.29.9",
+    "@sap-ux/project-access": "1.29.10",
     "@sap-ux/project-input-validator": "0.3.4",
     "@sap-ux/system-access": "0.5.31",
     "@sap-ux/ui5-config": "0.26.2",
-    "@sap-ux/odata-service-writer": "0.26.4",
+    "@sap-ux/odata-service-writer": "0.26.5",
     "@sap-ux/nodejs-utils": "0.1.7",
-    "@sap-ux/i18n": "0.2.1"
+    "@sap-ux/i18n": "0.2.2"
   },
   "devDependencies": {
     "@types/adm-zip": "0.5.5",

package/templates/rta/ts-controller.ejs

@@ -11,7 +11,7 @@ export default class <%= name %> extends ControllerExtension {
      * Can be used to modify the View before it is displayed, to bind event handlers and do other one-time initialization.
      * @memberOf <%= ns %>.<%= name %>
      */
-    onInit: () => {
+    onInit(this: <%- name %>) {
       const view = this.getView();
     },
   };