@sap-ux/adp-tooling 0.15.0 → 0.15.2

package/dist/base/helper.d.ts

@@ -1,6 +1,7 @@
 import type { Editor } from 'mem-fs-editor';
-import { type ManifestNamespace } from '@sap-ux/project-access';
+import type { UI5Config } from '@sap-ux/ui5-config';
 import type { Inbound } from '@sap-ux/axios-extension';
+import { type ManifestNamespace } from '@sap-ux/project-access';
 import type { DescriptorVariant, AdpPreviewConfig } from '../types';
 /**
  * Get the app descriptor variant.
@@ -37,11 +38,27 @@ export declare function flpConfigurationExists(variant: DescriptorVariant): bool
  */
 export declare function isTypescriptSupported(basePath: string, fs?: Editor): boolean;
 /**
- * Returns the adaptation project configuration, throws an error if not found.
+ * Reads the UI5 YAML configuration and returns the parsed `UI5Config` instance.
  *
- * @param {string} basePath - The path to the adaptation project.
- * @param {string} yamlPath - The path to yaml configuration file.
- * @returns {Promise<AdpPreviewConfig>} the adp configuration
+ * @param {string} basePath - Adaptation project root
+ * @param {string} yamlPath - Relative or absolute path to the ui5.yaml file
+ * @returns {Promise<UI5Config>} The `UI5Config` object.
+ */
+export declare function readUi5Config(basePath: string, yamlPath: string): Promise<UI5Config>;
+/**
+ * Extracts the `adp` preview configuration from a UI5 YAML config (if present).
+ *
+ * @param {UI5Config} ui5Conf Parsed UI5 configuration
+ * @returns The `AdpPreviewConfig` object if found, otherwise `undefined`.
+ */
+export declare function extractAdpConfig(ui5Conf: UI5Config): AdpPreviewConfig | undefined;
+/**
+ * Convenience wrapper that reads the ui5.yaml and directly returns the ADP preview configuration.
+ * Throws if the configuration cannot be found.
+ *
+ * @param basePath  Adaptation project root
+ * @param yamlPath  Relative or absolute path to the ui5.yaml file
+ * @returns The `AdpPreviewConfig` object if found, otherwise throws an error.
  */
 export declare function getAdpConfig(basePath: string, yamlPath: string): Promise<AdpPreviewConfig>;
 /**

package/dist/base/helper.js

@@ -4,6 +4,8 @@ exports.getVariant = getVariant;
 exports.updateVariant = updateVariant;
 exports.flpConfigurationExists = flpConfigurationExists;
 exports.isTypescriptSupported = isTypescriptSupported;
+exports.readUi5Config = readUi5Config;
+exports.extractAdpConfig = extractAdpConfig;
 exports.getAdpConfig = getAdpConfig;
 exports.getWebappFiles = getWebappFiles;
 exports.filterAndMapInboundsToManifest = filterAndMapInboundsToManifest;
@@ -58,29 +60,48 @@ function isTypescriptSupported(basePath, fs) {
     return fs ? fs.exists(path) : (0, fs_1.existsSync)(path);
 }
 /**
- * Returns the adaptation project configuration, throws an error if not found.
+ * Reads the UI5 YAML configuration and returns the parsed `UI5Config` instance.
  *
- * @param {string} basePath - The path to the adaptation project.
- * @param {string} yamlPath - The path to yaml configuration file.
- * @returns {Promise<AdpPreviewConfig>} the adp configuration
+ * @param {string} basePath - Adaptation project root
+ * @param {string} yamlPath - Relative or absolute path to the ui5.yaml file
+ * @returns {Promise<UI5Config>} The `UI5Config` object.
  */
-async function getAdpConfig(basePath, yamlPath) {
+async function readUi5Config(basePath, yamlPath) {
     const ui5ConfigPath = (0, path_1.isAbsolute)(yamlPath) ? yamlPath : (0, path_1.join)(basePath, yamlPath);
-    let ui5Conf;
-    let adp;
+    return (0, project_access_1.readUi5Yaml)((0, path_1.dirname)(ui5ConfigPath), (0, path_1.basename)(ui5ConfigPath));
+}
+/**
+ * Extracts the `adp` preview configuration from a UI5 YAML config (if present).
+ *
+ * @param {UI5Config} ui5Conf Parsed UI5 configuration
+ * @returns The `AdpPreviewConfig` object if found, otherwise `undefined`.
+ */
+function extractAdpConfig(ui5Conf) {
+    const customMiddleware = ui5Conf.findCustomMiddleware('fiori-tools-preview') ??
+        ui5Conf.findCustomMiddleware('preview-middleware');
+    return customMiddleware?.configuration?.adp;
+}
+/**
+ * Convenience wrapper that reads the ui5.yaml and directly returns the ADP preview configuration.
+ * Throws if the configuration cannot be found.
+ *
+ * @param basePath  Adaptation project root
+ * @param yamlPath  Relative or absolute path to the ui5.yaml file
+ * @returns The `AdpPreviewConfig` object if found, otherwise throws an error.
+ */
+async function getAdpConfig(basePath, yamlPath) {
     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;
+        const ui5Conf = await readUi5Config(basePath, yamlPath);
+        const adp = extractAdpConfig(ui5Conf);
+        if (!adp) {
+            throw new Error('Could not extract ADP configuration from ui5.yaml');
+        }
+        return adp;
     }
     catch (error) {
-        // do nothing here
-    }
-    if (!adp) {
+        const ui5ConfigPath = (0, path_1.isAbsolute)(yamlPath) ? yamlPath : (0, path_1.join)(basePath, yamlPath);
         throw new Error(`No system configuration found in ${(0, path_1.basename)(ui5ConfigPath)}`);
     }
-    return adp;
 }
 /**
  * Get all files in the webapp folder.

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

@@ -64,7 +64,8 @@ function getPrompts(basePath, dataSources) {
                 if (!(0, fs_1.existsSync)(filePath)) {
                     return (0, i18n_1.t)('validators.fileDoesNotExist');
                 }
-                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)))) {
+                const annotationFilePath = (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));
+                if ((0, fs_1.existsSync)(annotationFilePath)) {
                     return (0, i18n_1.t)('validators.annotationFileAlreadyExists');
                 }
                 return true;

package/dist/prompts/add-component-usages/index.js

@@ -100,7 +100,7 @@ function getPrompts(basePath, layer) {
     return [
         {
             type: 'input',
-            name: `usageId`,
+            name: 'usageId',
             message: (0, i18n_1.t)('prompts.component.usageIdLabel'),
             validate: (value) => validatePromptId(value, componentUsageChangeFiles, isCustomerBase),
             default: isCustomerBase ? "customer." /* NamespacePrefix.CUSTOMER */ : "" /* NamespacePrefix.EMPTY */,
@@ -135,7 +135,7 @@ function getPrompts(basePath, layer) {
         },
         {
             type: 'editor',
-            name: `settings`,
+            name: 'settings',
             message: (0, i18n_1.t)('prompts.component.settingsLabel'),
             validate: validatePromptJSON,
             store: false,
@@ -176,7 +176,7 @@ function getPrompts(basePath, layer) {
         },
         {
             type: 'list',
-            name: `libraryIsLazy`,
+            name: 'libraryIsLazy',
             message: (0, i18n_1.t)('prompts.component.libraryIsLazyLabel'),
             choices: isLazyDropDownOptions,
             default: isLazyDropDownOptions[1].value,

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.15.0",
+  "version": "0.15.2",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -43,7 +43,7 @@
     "@sap-ux/ui5-config": "0.29.0",
     "@sap-ux/ui5-info": "0.12.0",
     "@sap-ux/odata-service-writer": "0.27.12",
-    "@sap-ux/nodejs-utils": "0.2.1",
+    "@sap-ux/nodejs-utils": "0.2.2",
     "@sap-ux/i18n": "0.3.1",
     "@sap-ux/store": "1.1.2"
   },