@sap-ux/adp-tooling 0.13.41 → 0.13.43

package/dist/base/constants/index.d.ts

@@ -6,6 +6,9 @@ export declare const CURRENT_SYSTEM_VERSION = "(system version)";
 export declare const LATEST_VERSION = "(latest)";
 export declare const SNAPSHOT_VERSION = "snapshot";
 export declare const SNAPSHOT_UNTESTED_VERSION = "snapshot-untested";
+export declare const RESOURCE_BUNDLE_TEXT = "\n\n# This is the resource bundle for ";
+export declare const TRANSLATION_UUID_TEXT = "\n#__ldi.translation.uuid=";
+export declare const BASE_I18N_DESCRIPTION = "#Make sure you provide a unique prefix to the newly added keys in this file, to avoid overriding of SAP Fiori application keys.";
 export declare const S4HANA_APPS_PARAMS: {
     'sap.app/type': string;
     'sap.fiori/cloudDevAdaptationStatus': string;

package/dist/base/constants/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ABAP_VARIANT_APPS_PARAMS = exports.ABAP_APPS_PARAMS = exports.S4HANA_APPS_PARAMS = exports.SNAPSHOT_UNTESTED_VERSION = exports.SNAPSHOT_VERSION = exports.LATEST_VERSION = exports.CURRENT_SYSTEM_VERSION = exports.SNAPSHOT_CDN_URL = exports.UI5_VERSIONS_NEO_CDN_URL = exports.UI5_VERSIONS_CDN_URL = exports.UI5_CDN_URL = void 0;
+exports.ABAP_VARIANT_APPS_PARAMS = exports.ABAP_APPS_PARAMS = exports.S4HANA_APPS_PARAMS = exports.BASE_I18N_DESCRIPTION = exports.TRANSLATION_UUID_TEXT = exports.RESOURCE_BUNDLE_TEXT = exports.SNAPSHOT_UNTESTED_VERSION = exports.SNAPSHOT_VERSION = exports.LATEST_VERSION = exports.CURRENT_SYSTEM_VERSION = exports.SNAPSHOT_CDN_URL = exports.UI5_VERSIONS_NEO_CDN_URL = exports.UI5_VERSIONS_CDN_URL = exports.UI5_CDN_URL = void 0;
 exports.UI5_CDN_URL = 'https://ui5.sap.com';
 exports.UI5_VERSIONS_CDN_URL = 'https://sapui5.hana.ondemand.com/version.json';
 exports.UI5_VERSIONS_NEO_CDN_URL = 'https://ui5.sap.com/neo-app.json';
@@ -9,6 +9,9 @@ exports.CURRENT_SYSTEM_VERSION = '(system version)';
 exports.LATEST_VERSION = '(latest)';
 exports.SNAPSHOT_VERSION = 'snapshot';
 exports.SNAPSHOT_UNTESTED_VERSION = 'snapshot-untested';
+exports.RESOURCE_BUNDLE_TEXT = '\n\n# This is the resource bundle for ';
+exports.TRANSLATION_UUID_TEXT = '\n#__ldi.translation.uuid=';
+exports.BASE_I18N_DESCRIPTION = '#Make sure you provide a unique prefix to the newly added keys in this file, to avoid overriding of SAP Fiori application keys.';
 exports.S4HANA_APPS_PARAMS = {
     'sap.app/type': 'application',
     'sap.fiori/cloudDevAdaptationStatus': 'released',

package/dist/index.d.ts

@@ -10,6 +10,7 @@ export * from './abap';
 export * from './source';
 export * from './preview/adp-preview';
 export * from './writer/writer-config';
+export * from './writer/descriptor-content';
 export * from './ui5';
 export { getCustomConfig } from './writer/project-utils';
 export { generate, migrate } from './writer';

package/dist/index.js

@@ -27,6 +27,7 @@ __exportStar(require("./abap"), exports);
 __exportStar(require("./source"), exports);
 __exportStar(require("./preview/adp-preview"), exports);
 __exportStar(require("./writer/writer-config"), exports);
+__exportStar(require("./writer/descriptor-content"), exports);
 __exportStar(require("./ui5"), exports);
 var project_utils_1 = require("./writer/project-utils");
 Object.defineProperty(exports, "getCustomConfig", { enumerable: true, get: function () { return project_utils_1.getCustomConfig; } });

package/dist/source/manifest.d.ts

@@ -8,6 +8,20 @@ import type { AbapServiceProvider } from '@sap-ux/axios-extension';
  * @returns {boolean} True if the application uses SAP Fiori Elements version 4 libraries.
  */
 export declare function isV4Application(manifest?: Manifest): boolean;
+/**
+ * Retrieves the default Fiori ID from the application's manifest.
+ *
+ * @param {Manifest | undefined} manifest - The manager responsible for fetching and handling the application manifest.
+ * @returns {Promise<string>} The Fiori registration IDs as a string if available, otherwise an empty string.
+ */
+export declare function getFioriId(manifest: Manifest | undefined): string;
+/**
+ * Retrieves the default Application Component Hierarchy (ACH) from the application's manifest.
+ *
+ * @param {Manifest | undefined} manifest - The manager responsible for fetching and handling the application manifest.
+ * @returns {Promise<string>} The ACH code as a string if available, otherwise an empty string.
+ */
+export declare function getAch(manifest: Manifest | undefined): string;
 /**
  * Checks if views are loaded synchronously or asynchronously in the UI5 settings of the manifest.
  * Sets the isAppSync property based on the loading method.

package/dist/source/manifest.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SourceManifest = void 0;
 exports.isV4Application = isV4Application;
+exports.getFioriId = getFioriId;
+exports.getAch = getAch;
 exports.isSyncLoadedView = isSyncLoadedView;
 const i18n_1 = require("../i18n");
 /**
@@ -13,6 +15,24 @@ const i18n_1 = require("../i18n");
 function isV4Application(manifest) {
     return !!manifest?.['sap.ui5']?.dependencies?.libs?.['sap.fe.templates'];
 }
+/**
+ * Retrieves the default Fiori ID from the application's manifest.
+ *
+ * @param {Manifest | undefined} manifest - The manager responsible for fetching and handling the application manifest.
+ * @returns {Promise<string>} The Fiori registration IDs as a string if available, otherwise an empty string.
+ */
+function getFioriId(manifest) {
+    return manifest?.['sap.fiori']?.registrationIds?.toString() ?? '';
+}
+/**
+ * Retrieves the default Application Component Hierarchy (ACH) from the application's manifest.
+ *
+ * @param {Manifest | undefined} manifest - The manager responsible for fetching and handling the application manifest.
+ * @returns {Promise<string>} The ACH code as a string if available, otherwise an empty string.
+ */
+function getAch(manifest) {
+    return manifest?.['sap.app']?.ach?.toString() ?? '';
+}
 /**
  * Checks if views are loaded synchronously or asynchronously in the UI5 settings of the manifest.
  * Sets the isAppSync property based on the loading method.

package/dist/types.d.ts

@@ -40,6 +40,8 @@ export interface OnpremApp {
     /** Reference associated with the ID of the base application. */
     reference: string;
     layer?: UI5FlexLayer;
+    fioriId?: string;
+    ach?: string;
     title?: string;
     /** Optional: Application variant change content. */
     content?: Content[];
@@ -91,6 +93,9 @@ export interface ConfigAnswers {
     username: string;
     password: string;
     application: SourceApplication;
+    fioriId?: string;
+    ach?: string;
+    shouldCreateExtProject?: boolean;
 }
 export interface AttributesAnswers {
     projectName: string;

package/dist/ui5/format.js

@@ -91,7 +91,7 @@ function removeTimestampFromVersion(version) {
  */
 function addSnapshot(version, latestVersion) {
     const versionParts = version.split('.');
-    return versionParts[3] && removeTimestampFromVersion(version) != latestVersion ? '-snapshot' : '';
+    return versionParts[2] && removeTimestampFromVersion(version) != latestVersion ? '-snapshot' : '';
 }
 /**
  * Function that parse the UI5 version. Returns NaN for snapshot or snapshot-untested. eturns x.xx for snapshot-x.xx.xx.

package/dist/ui5/version-info.d.ts

@@ -11,6 +11,25 @@ export interface VersionLabels {
  * @returns {string} The latest version string.
  */
 export declare function getLatestVersion(publicVersions: UI5Version): string;
+/**
+ * Retrieves the minimum SAP UI5 version to be specified in the application manifest.
+ * If the system version does not contain 'snapshot', the system version itself is used;
+ * otherwise, the latest stable version is used as the minimum version.
+ *
+ * @param {UI5Version} publicVersions - The public UI5 version data.
+ * @param {string} [systemVersion] - The version on the system.
+ * @returns {string} The SAP UI5 version string to be set in the manifest, which can be either
+ *         the current system version or the latest stable version, depending on the presence of 'snapshot'.
+ */
+export declare function getMinUI5VersionForManifest(publicVersions: UI5Version, systemVersion?: string): string;
+/**
+ * Determines whether the minimum SAP UI5 version should be set for the application manifest.
+ *
+ * @param {string} [systemVersion] - The version on the system.
+ * @returns {boolean} True if the minimum UI5 version should be set (i.e., the detected version is
+ *         available and the minor version is 90 or higher); otherwise, false.
+ */
+export declare function shouldSetMinUI5Version(systemVersion?: string): boolean;
 /**
  * Determines the appropriate UI5 version to use based on the given version string and the customer base flag.
  *

package/dist/ui5/version-info.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLatestVersion = getLatestVersion;
+exports.getMinUI5VersionForManifest = getMinUI5VersionForManifest;
+exports.shouldSetMinUI5Version = shouldSetMinUI5Version;
 exports.getVersionToBeUsed = getVersionToBeUsed;
 exports.getVersionLabels = getVersionLabels;
 exports.checkSystemVersionPattern = checkSystemVersionPattern;
@@ -19,6 +21,37 @@ const constants_1 = require("../base/constants");
 function getLatestVersion(publicVersions) {
     return publicVersions?.latest?.version;
 }
+/**
+ * Retrieves the minimum SAP UI5 version to be specified in the application manifest.
+ * If the system version does not contain 'snapshot', the system version itself is used;
+ * otherwise, the latest stable version is used as the minimum version.
+ *
+ * @param {UI5Version} publicVersions - The public UI5 version data.
+ * @param {string} [systemVersion] - The version on the system.
+ * @returns {string} The SAP UI5 version string to be set in the manifest, which can be either
+ *         the current system version or the latest stable version, depending on the presence of 'snapshot'.
+ */
+function getMinUI5VersionForManifest(publicVersions, systemVersion) {
+    if (!systemVersion || systemVersion?.includes('snapshot')) {
+        return getLatestVersion(publicVersions);
+    }
+    return systemVersion;
+}
+/**
+ * Determines whether the minimum SAP UI5 version should be set for the application manifest.
+ *
+ * @param {string} [systemVersion] - The version on the system.
+ * @returns {boolean} True if the minimum UI5 version should be set (i.e., the detected version is
+ *         available and the minor version is 90 or higher); otherwise, false.
+ */
+function shouldSetMinUI5Version(systemVersion) {
+    if (!systemVersion) {
+        return false;
+    }
+    const versionParts = systemVersion.split('.');
+    const minorVersion = versionParts.length > 1 ? parseInt(versionParts[1], 10) : NaN;
+    return !isNaN(minorVersion) && minorVersion >= 90;
+}
 /**
  * Determines the appropriate UI5 version to use based on the given version string and the customer base flag.
  *
@@ -63,7 +96,7 @@ function getVersionLabels(version, publicVersions) {
  */
 function checkSystemVersionPattern(version) {
     const pattern = /^[1-9]\.\d{1,3}\.\d{1,2}\.*/;
-    return version && pattern.test(version) ? version : undefined;
+    return version && pattern.test(version) ? (0, format_1.removeTimestampFromVersion)(version) : undefined;
 }
 /**
  * Retrieves and filters internal UI5 versions.

package/dist/writer/descriptor-content.d.ts

@@ -1,8 +1,27 @@
-import type { Content } from '../types';
+import { FlexLayer, type Content, type UI5Version } from '../types';
 /**
  * Returns a model enhancement change configuration.
  *
  * @returns {Content} The model change configuration.
  */
 export declare function getNewModelEnhanceWithChange(): Content;
+/**
+ * Adds support data entries for Fiori registration IDs and application component hierarchy (ACH) to a content array.
+ *
+ * @param {Content[]} content - The array to which support data entries will be added.
+ * @param {string} [fioriId] - The Fiori ID to set in the registration.
+ * @param {string} [ach] - The application component hierarchy code, which will be converted to uppercase.
+ */
+export declare function fillSupportData(content: Content[], fioriId?: string, ach?: string): void;
+/**
+ * Generates an array of content objects for a `manifest.appdescr_variant` file based on the application configuration.
+ *
+ * @param {FlexLayer} layer - The deployment layer of the application (e.g., CUSTOMER_BASE or VENDOR).
+ * @param {string | undefined} systemVersion - The minimum required SAPUI5 version for the application.
+ * @param {UI5Version} publicVersions - Publicly available SAPUI5 versions.
+ * @param {string} [fioriId] - Optional Fiori ID to be added to support information.
+ * @param {string} [ach] - Optional ACH ID used for support analytics.
+ * @returns {Content[]} An array of content objects describing descriptor variant changes to be applied to the manifest.
+ */
+export declare function getManifestContent(layer: FlexLayer, systemVersion: string | undefined, publicVersions: UI5Version, fioriId?: string, ach?: string): Content[];
 //# sourceMappingURL=descriptor-content.d.ts.map

package/dist/writer/descriptor-content.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getNewModelEnhanceWithChange = getNewModelEnhanceWithChange;
+exports.fillSupportData = fillSupportData;
+exports.getManifestContent = getManifestContent;
+const ui5_1 = require("../ui5");
 /**
  * Returns a model enhancement change configuration.
  *
@@ -17,4 +20,56 @@ function getNewModelEnhanceWithChange() {
         }
     };
 }
+/**
+ * Adds support data entries for Fiori registration IDs and application component hierarchy (ACH) to a content array.
+ *
+ * @param {Content[]} content - The array to which support data entries will be added.
+ * @param {string} [fioriId] - The Fiori ID to set in the registration.
+ * @param {string} [ach] - The application component hierarchy code, which will be converted to uppercase.
+ */
+function fillSupportData(content, fioriId, ach) {
+    if (fioriId) {
+        content.push({
+            changeType: 'appdescr_fiori_setRegistrationIds',
+            content: {
+                registrationIds: [fioriId]
+            }
+        });
+    }
+    if (ach) {
+        content.push({
+            changeType: 'appdescr_app_setAch',
+            content: {
+                ach: ach?.toUpperCase()
+            }
+        });
+    }
+}
+/**
+ * Generates an array of content objects for a `manifest.appdescr_variant` file based on the application configuration.
+ *
+ * @param {FlexLayer} layer - The deployment layer of the application (e.g., CUSTOMER_BASE or VENDOR).
+ * @param {string | undefined} systemVersion - The minimum required SAPUI5 version for the application.
+ * @param {UI5Version} publicVersions - Publicly available SAPUI5 versions.
+ * @param {string} [fioriId] - Optional Fiori ID to be added to support information.
+ * @param {string} [ach] - Optional ACH ID used for support analytics.
+ * @returns {Content[]} An array of content objects describing descriptor variant changes to be applied to the manifest.
+ */
+function getManifestContent(layer, systemVersion, publicVersions, fioriId, ach) {
+    const isCustomerBase = layer === "CUSTOMER_BASE" /* FlexLayer.CUSTOMER_BASE */;
+    const content = [];
+    if (!isCustomerBase) {
+        fillSupportData(content, fioriId, ach);
+    }
+    if ((0, ui5_1.shouldSetMinUI5Version)(systemVersion)) {
+        content.push({
+            changeType: 'appdescr_ui5_setMinUI5Version',
+            content: {
+                minUI5Version: (0, ui5_1.getMinUI5VersionForManifest)(publicVersions, systemVersion)
+            }
+        });
+    }
+    content.push(getNewModelEnhanceWithChange());
+    return content;
+}
 //# sourceMappingURL=descriptor-content.js.map

package/dist/writer/i18n/index.d.ts

@@ -0,0 +1,10 @@
+import { FlexLayer } from '../../types';
+/**
+ * Generates an internationalization description string for a specific layer within an application.
+ *
+ * @param {FlexLayer} layer - The UI5 Flex layer.
+ * @param {string} [appTitle] - The title of the application used in generating the i18n description.
+ * @returns {string} The internationalization description string.
+ */
+export declare function getI18nDescription(layer: FlexLayer, appTitle?: string): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/writer/i18n/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getI18nDescription = getI18nDescription;
+const uuid_1 = require("uuid");
+const __1 = require("../..");
+/**
+ * Generates an internationalization description string for a specific layer within an application.
+ *
+ * @param {FlexLayer} layer - The UI5 Flex layer.
+ * @param {string} [appTitle] - The title of the application used in generating the i18n description.
+ * @returns {string} The internationalization description string.
+ */
+function getI18nDescription(layer, appTitle) {
+    return layer === "CUSTOMER_BASE" /* FlexLayer.CUSTOMER_BASE */
+        ? __1.BASE_I18N_DESCRIPTION
+        : __1.BASE_I18N_DESCRIPTION + __1.RESOURCE_BUNDLE_TEXT + appTitle + __1.TRANSLATION_UUID_TEXT + (0, uuid_1.v4)();
+}
+//# sourceMappingURL=index.js.map

package/dist/writer/writer-config.d.ts

@@ -28,6 +28,10 @@ interface ConfigOptions {
      * Public UI5 Versions.
      */
     publicVersions: UI5Version;
+    /**
+     * System UI5 Version.
+     */
+    systemVersion: string | undefined;
     /**
      * Logger instance for debugging and error reporting.
      */

package/dist/writer/writer-config.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getConfig = getConfig;
 const abap_1 = require("../abap");
+const i18n_1 = require("./i18n");
 const project_utils_1 = require("./project-utils");
 const descriptor_content_1 = require("./descriptor-content");
 const ui5_1 = require("../ui5");
@@ -19,7 +20,7 @@ const ui5_1 = require("../ui5");
  * @returns {Promise<AdpWriterConfig>} A promise that resolves to the generated ADP writer configuration.
  */
 async function getConfig(options) {
-    const { configAnswers, attributeAnswers, layer, logger, packageJson, provider, publicVersions } = options;
+    const { configAnswers, attributeAnswers, layer, logger, packageJson, provider, publicVersions, systemVersion } = options;
     const ato = await provider.getAtoInfo();
     const operationsType = ato.operationsType ?? 'P';
     const target = await (0, abap_1.getProviderConfig)(configAnswers.system, logger);
@@ -30,18 +31,27 @@ async function getConfig(options) {
         ? (0, ui5_1.getLatestVersion)(publicVersions)
         : (0, ui5_1.getVersionToBeUsed)(attributeAnswers.ui5Version, isCustomerBase, publicVersions);
     const { namespace, title, enableTypeScript } = attributeAnswers;
-    const { application: { id, bspName } } = configAnswers;
-    return {
-        app: {
-            id: namespace,
-            reference: id,
-            layer,
-            title,
+    const { application: { id, bspName }, fioriId, ach } = configAnswers;
+    const app = {
+        id: namespace,
+        reference: id,
+        layer,
+        title,
+        content: (0, descriptor_content_1.getManifestContent)(layer, systemVersion, publicVersions, fioriId, ach),
+        i18nDescription: (0, i18n_1.getI18nDescription)(layer, title)
+    };
+    if (isCloudProject) {
+        const lrep = provider.getLayeredRepository();
+        const { activeLanguages: languages } = await lrep.getSystemInfo();
+        Object.assign(app, {
             bspName,
-            content: [(0, descriptor_content_1.getNewModelEnhanceWithChange)()]
-        },
+            languages
+        });
+    }
+    return {
+        app,
         ui5: {
-            minVersion: ui5Version?.split(' ')[0],
+            minVersion: ui5Version?.split(' ')?.[0],
             version: (0, ui5_1.getFormattedVersion)(ui5Version),
             frameworkUrl: (0, ui5_1.getOfficialBaseUI5VersionUrl)(ui5Version)
         },

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.41",
+  "version": "0.13.43",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -34,13 +34,13 @@
     "uuid": "10.0.0",
     "@sap-ux/axios-extension": "1.20.2",
     "@sap-ux/btp-utils": "1.0.3",
-    "@sap-ux/inquirer-common": "0.6.41",
+    "@sap-ux/inquirer-common": "0.6.42",
     "@sap-ux/logger": "0.6.0",
-    "@sap-ux/project-access": "1.29.21",
-    "@sap-ux/project-input-validator": "0.5.4",
+    "@sap-ux/project-access": "1.29.22",
+    "@sap-ux/project-input-validator": "0.5.6",
     "@sap-ux/system-access": "0.5.38",
     "@sap-ux/ui5-config": "0.27.2",
-    "@sap-ux/odata-service-writer": "0.26.17",
+    "@sap-ux/odata-service-writer": "0.26.18",
     "@sap-ux/nodejs-utils": "0.1.9",
     "@sap-ux/i18n": "0.2.3",
     "@sap-ux/store": "1.0.0"