feat(generator-adp): Create a yeoman package for Adaptation Project generator

.changeset/angry-crabs-argue.md

@@ -0,0 +1,8 @@
+---
+'@sap-ux/generator-adp': minor
+'@sap-ux/axios-extension': patch
+'@sap-ux/inquirer-common': patch
+'@sap-ux/adp-tooling': patch
+---
+
+feat(generator-adp): Create a yeoman package for Adaptation Project generator

packages/adp-tooling/package.json

@@ -46,6 +46,7 @@
         "@sap-ux/odata-service-writer": "workspace:*",
         "@sap-ux/nodejs-utils": "workspace:*",
         "@sap-ux/i18n": "workspace:*",
+        "@sap-ux/store": "workspace:*",
         "adm-zip": "0.5.10",
         "ejs": "3.1.10",
         "i18next": "23.11.2",

packages/adp-tooling/src/base/constants/index.ts

@@ -0,0 +1,21 @@
+export const S4HANA_APPS_PARAMS = {
+    'sap.app/type': 'application',
+    'sap.fiori/cloudDevAdaptationStatus': 'released',
+    'fields':
+        'sap.app/id,repoName,sap.fiori/cloudDevAdaptationStatus,sap.app/ach,sap.fiori/registrationIds,sap.app/title,url,fileType'
+};
+
+export const ABAP_APPS_PARAMS = {
+    'fields': 'sap.app/id,sap.app/ach,sap.fiori/registrationIds,sap.app/title,url,fileType,repoName',
+    'sap.ui/technology': 'UI5',
+    'sap.app/type': 'application',
+    'fileType': 'appdescr'
+};
+
+export const ABAP_VARIANT_APPS_PARAMS = {
+    'fields': 'sap.app/id,sap.app/ach,sap.fiori/registrationIds,sap.app/title,url,fileType,repoName',
+    'sap.ui/technology': 'UI5',
+    'sap.app/type': 'application',
+    'fileType': 'appdescr_variant',
+    'originLayer': 'VENDOR'
+};

packages/adp-tooling/src/client/abap-provider.ts

@@ -0,0 +1,116 @@
+import { isAppStudio } from '@sap-ux/btp-utils';
+import type { AbapTarget } from '@sap-ux/ui5-config';
+import type { AuthenticationType } from '@sap-ux/store';
+import type { Logger, ToolsLogger } from '@sap-ux/logger';
+import { createAbapServiceProvider } from '@sap-ux/system-access';
+import type { AbapServiceProvider, AxiosRequestConfig, ProviderConfiguration } from '@sap-ux/axios-extension';
+
+import type { TargetSystems } from './target-systems';
+
+export type RequestOptions = AxiosRequestConfig & Partial<ProviderConfiguration>;
+
+/**
+ * Service for managing and providing access to an ABAP service provider.
+ */
+export class AbapProvider {
+    private provider: AbapServiceProvider;
+    private system: string | undefined;
+
+    /**
+     * Constructs an instance of AbapProvider.
+     *
+     * @param {TargetSystems} targetSystems - The endpoints service for retrieving system details.
+     * @param {ToolsLogger} [logger] - The logger.
+     */
+    constructor(private readonly targetSystems: TargetSystems, private readonly logger?: ToolsLogger) {}
+
+    /**
+     * Retrieves the configured ABAP service provider if set, otherwise throws an error.
+     *
+     * @returns {AbapServiceProvider} - The configured ABAP service provider.
+     */
+    public getProvider(): AbapServiceProvider {
+        if (!this.provider) {
+            throw new Error('Provider was not set!');
+        }
+        return this.provider;
+    }
+
+    /**
+     * Retrieves ABAP service provider connected ABAP system.
+     *
+     * @returns {string | undefined} - the connected system.
+     */
+    public getSystem(): string | undefined {
+        return this.system;
+    }
+
+    /**
+     * Configures the ABAP service provider using the specified system details and credentials.
+     *
+     * @param {string} system - The system identifier.
+     * @param {string} [client] - The client, if applicable.
+     * @param {string} [username] - The username for authentication.
+     * @param {string} [password] - The password for authentication.
+     */
+    public async setProvider(system: string, client?: string, username?: string, password?: string): Promise<void> {
+        try {
+            const requestOptions: RequestOptions = {
+                ignoreCertErrors: false
+            };
+
+            const target = await this.determineTarget(system, requestOptions, client);
+
+            if (username && password) {
+                requestOptions.auth = { username, password };
+            }
+
+            this.provider = await createAbapServiceProvider(target, requestOptions, false, {} as Logger);
+            this.system = system;
+        } catch (e) {
+            this.logger?.error(`Failed to instantiate provider for system: ${system}. Reason: ${e.message}`);
+            throw new Error(e.message);
+        }
+    }
+
+    /**
+     * Determines the target configuration for the ABAP service provider based on whether the application
+     * is running within SAP App Studio or outside of it.
+     *
+     * @param {string} system - The system identifier, which could be a URL or a system name.
+     * @param {RequestOptions} requestOptions - The request options to be configured during this setup.
+     * @param {string} [client] - Optional client number, used in systems where multiple clients exist.
+     * @returns {Promise<AbapTarget>} - The configuration object for the ABAP service provider, tailored based on the running environment.
+     */
+    public async determineTarget(system: string, requestOptions: RequestOptions, client?: string): Promise<AbapTarget> {
+        let target: AbapTarget;
+
+        if (isAppStudio()) {
+            target = {
+                destination: system
+            };
+        } else {
+            const details = await this.targetSystems.getSystemByName(system);
+
+            target = {
+                client: details?.Client ?? client,
+                url: details?.Url
+            } as AbapTarget;
+
+            if (details?.Authentication) {
+                target.authenticationType = details?.Authentication as AuthenticationType;
+            }
+
+            const username = details?.Credentials?.username;
+            const password = details?.Credentials?.password;
+            if (username && password) {
+                requestOptions.auth = {
+                    username,
+                    password
+                };
+            }
+        }
+
+        return target;
+    }
+}

packages/adp-tooling/src/client/index.ts

@@ -0,0 +1,3 @@
+export * from './target-applications';
+export * from './target-systems';
+export * from './abap-provider';

packages/adp-tooling/src/client/target-applications.ts

@@ -0,0 +1,118 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { App, AppIndex } from '@sap-ux/axios-extension';
+
+import type { TargetApplication } from '../types';
+import type { AbapProvider } from './abap-provider';
+import { ABAP_APPS_PARAMS, ABAP_VARIANT_APPS_PARAMS, S4HANA_APPS_PARAMS } from '../base/constants';
+
+/**
+ * Compares two applications for sorting, using the title and falling back to the ID if titles are missing or equal.
+ * This function ensures that applications are sorted alphabetically by their title or ID in a case-insensitive manner.
+ *
+ * @param {TargetApplication} appA - The first application to compare.
+ * @param {TargetApplication} appB - The second application to compare.
+ * @returns {number} A number indicating the sort order.
+ */
+export const filterApps = (appA: TargetApplication, appB: TargetApplication): number => {
+    let titleA = appA.title.toUpperCase();
+    let titleB = appB.title.toUpperCase();
+
+    if (!titleA.trim()) {
+        titleA = appA.id.toUpperCase();
+    }
+    if (!titleB.trim()) {
+        titleB = appB.id.toUpperCase();
+    }
+    if (titleA < titleB) {
+        return -1;
+    }
+    if (titleA > titleB) {
+        return 1;
+    }
+    return 0;
+};
+
+/**
+ * Transforms raw application data into a structured Application object.
+ * This function maps properties from a loosely typed app data structure to a strongly typed Application object.
+ *
+ * @param {Partial<App>} app - The raw application data, possibly incomplete.
+ * @returns {TargetApplication} A structured application object with defined properties, even if some may be empty.
+ */
+export const mapApps = (app: Partial<App>): TargetApplication => ({
+    id: app['sap.app/id'] ?? '',
+    title: app['sap.app/title'] ?? '',
+    ach: app['sap.app/ach'] ?? '',
+    registrationIds: app['sap.fiori/registrationIds'] ?? [],
+    fileType: app['fileType'] ?? '',
+    bspUrl: app['url'] ?? '',
+    bspName: app['repoName'] ?? ''
+});
+
+/**
+ * Provides services related to managing and loading applications from an ABAP provider.
+ */
+export class TargetApplications {
+    private applications: TargetApplication[] | undefined;
+
+    /**
+     * Constructs an instance of ApplicationManager.
+     *
+     * @param {AbapProvider} abapProvider - The instance of AbapProvider class.
+     * @param {boolean} isCustomerBase - Indicates if the current base is a customer base, which affects how applications are loaded.
+     * @param {ToolsLogger} [logger] - The logger.
+     */
+    constructor(
+        private readonly abapProvider: AbapProvider,
+        private readonly isCustomerBase: boolean,
+        private readonly logger?: ToolsLogger
+    ) {}
+
+    /**
+     * Resets the current applications from the state.
+     */
+    public resetApps(): void {
+        this.applications = undefined;
+    }
+
+    /**
+     * Retrieves the currently loaded list of applications.
+     *
+     * @returns {TargetApplication[]} An array of applications.
+     */
+    public async getApps(): Promise<TargetApplication[]> {
+        if (!this.applications) {
+            this.applications = await this.loadApps();
+        }
+        return this.applications;
+    }
+
+    /**
+     * Loads applications based on system type and user parameters, merging results from different app sources as needed.
+     *
+     * @returns {TargetApplication[]} list of applications.
+     * @throws {Error} Throws an error if the app data cannot be loaded.
+     */
+    private async loadApps(): Promise<TargetApplication[]> {
+        let result: AppIndex = [];
+
+        try {
+            const provider = this.abapProvider.getProvider();
+            const isCloudSystem = await provider.isAbapCloud();
+            const appIndex = provider.getAppIndex();
+
+            result = await appIndex.search(isCloudSystem ? S4HANA_APPS_PARAMS : ABAP_APPS_PARAMS);
+
+            if (!isCloudSystem && this.isCustomerBase) {
+                const extraApps = await appIndex.search(ABAP_VARIANT_APPS_PARAMS);
+                result = result.concat(extraApps);
+            }
+
+            return result.map(mapApps).sort(filterApps);
+        } catch (e) {
+            const errorMsg = `Could not load applications: ${e.message}`;
+            this.logger?.error(errorMsg);
+            throw new Error(errorMsg);
+        }
+    }
+}