@sap-ux/deploy-config-sub-generator 0.0.1

package/generators/prompts/sub-gen.d.ts

@@ -0,0 +1,39 @@
+import type { FioriToolsProxyConfigBackend } from '@sap-ux/ui5-config';
+import type { Editor } from 'mem-fs-editor';
+import type { ApiHubConfig } from '@sap-ux/cf-deploy-config-sub-generator';
+import type { AbapDeployConfigAnswersInternal } from '@sap-ux/abap-deploy-config-sub-generator';
+import type { CommonPromptOptions, PromptDefaultValue } from '@sap-ux/inquirer-common';
+import type { Question } from 'inquirer';
+import type { DeployConfigOptions, Target } from '../types';
+/**
+ * Retrieves the combined sub generator prompts.
+ *
+ * @param fs - instance of fs
+ * @param options - deploy config options
+ * @param promptOpts - options for prompts
+ * @param promptOpts.launchDeployConfigAsSubGenerator - whether the generator is launched as a sub generator
+ * @param promptOpts.launchStandaloneFromYui - whether the generator is launched standalone from YUI
+ * @param promptOpts.extensionPromptOpts - extension prompt options
+ * @param promptOpts.supportedTargets - supported deployment targets
+ * @param promptOpts.backendConfig - backend configuration
+ * @param promptOpts.cfDestination - CF destination
+ * @param promptOpts.isCap - whether the project is a CAP project
+ * @param promptOpts.apiHubConfig - API Hub configuration
+ * @param promptOpts.isLibrary - whether the project is a library
+ * @returns - deployment configuration answers
+ */
+export declare function getSubGenPrompts(fs: Editor, options: DeployConfigOptions, { launchDeployConfigAsSubGenerator, launchStandaloneFromYui, extensionPromptOpts, supportedTargets, backendConfig, cfDestination, isCap, apiHubConfig, isLibrary }: {
+    launchDeployConfigAsSubGenerator: boolean;
+    launchStandaloneFromYui: boolean;
+    extensionPromptOpts?: Record<string, CommonPromptOptions & PromptDefaultValue<string | boolean>>;
+    supportedTargets: Target[];
+    backendConfig: FioriToolsProxyConfigBackend;
+    cfDestination: string;
+    isCap: boolean;
+    apiHubConfig: ApiHubConfig;
+    isLibrary: boolean;
+}): Promise<{
+    questions: Question[];
+    abapAnswers: Partial<AbapDeployConfigAnswersInternal>;
+}>;
+//# sourceMappingURL=sub-gen.d.ts.map

package/generators/prompts/sub-gen.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSubGenPrompts = void 0;
+const inquirer_common_1 = require("@sap-ux/inquirer-common");
+const path_1 = require("path");
+const utils_1 = require("../utils");
+const deploy_config_generator_shared_1 = require("@sap-ux/deploy-config-generator-shared");
+const abap_deploy_config_sub_generator_1 = require("@sap-ux/abap-deploy-config-sub-generator");
+const cf_deploy_config_sub_generator_1 = require("@sap-ux/cf-deploy-config-sub-generator");
+const project_access_1 = require("@sap-ux/project-access");
+const deploy_target_1 = require("./deploy-target");
+/**
+ * Retrieves the combined sub generator prompts.
+ *
+ * @param fs - instance of fs
+ * @param options - deploy config options
+ * @param promptOpts - options for prompts
+ * @param promptOpts.launchDeployConfigAsSubGenerator - whether the generator is launched as a sub generator
+ * @param promptOpts.launchStandaloneFromYui - whether the generator is launched standalone from YUI
+ * @param promptOpts.extensionPromptOpts - extension prompt options
+ * @param promptOpts.supportedTargets - supported deployment targets
+ * @param promptOpts.backendConfig - backend configuration
+ * @param promptOpts.cfDestination - CF destination
+ * @param promptOpts.isCap - whether the project is a CAP project
+ * @param promptOpts.apiHubConfig - API Hub configuration
+ * @param promptOpts.isLibrary - whether the project is a library
+ * @returns - deployment configuration answers
+ */
+async function getSubGenPrompts(fs, options, { launchDeployConfigAsSubGenerator, launchStandaloneFromYui, extensionPromptOpts, supportedTargets, backendConfig, cfDestination, isCap, apiHubConfig, isLibrary }) {
+    deploy_config_generator_shared_1.DeploymentGenerator.logger?.debug((0, utils_1.t)('debug.loadingPrompts'));
+    const configExists = fs.exists((0, path_1.join)(options.appRootPath, options.config || project_access_1.FileName.UI5DeployYaml));
+    const showOverwrite = (0, deploy_config_generator_shared_1.showOverwriteQuestion)(configExists, launchDeployConfigAsSubGenerator, launchStandaloneFromYui, options.overwrite);
+    const indexGenerationAllowed = !isLibrary && launchStandaloneFromYui && !(await (0, abap_deploy_config_sub_generator_1.indexHtmlExists)(fs, options.appRootPath));
+    // ABAP prompts
+    const { prompts: abapPrompts, answers: abapAnswers } = await (0, abap_deploy_config_sub_generator_1.getAbapQuestions)({
+        appRootPath: options.appRootPath,
+        connectedSystem: options.connectedSystem,
+        backendConfig,
+        configFile: options.config,
+        indexGenerationAllowed,
+        showOverwriteQuestion: showOverwrite,
+        logger: deploy_config_generator_shared_1.DeploymentGenerator.logger
+    });
+    // CF prompts
+    const cfPrompts = await (0, cf_deploy_config_sub_generator_1.getCFQuestions)({
+        projectRoot: options.projectRoot,
+        isAbapDirectServiceBinding: options.isAbapDirectServiceBinding,
+        cfDestination: cfDestination,
+        isCap: isCap,
+        addOverwrite: showOverwrite,
+        apiHubConfig: apiHubConfig
+    });
+    // Combine all prompts
+    const questions = combineAllPrompts(options.projectRoot, {
+        supportedTargets,
+        abapPrompts,
+        cfPrompts,
+        extensionPromptOpts,
+        launchStandaloneFromYui
+    });
+    return { questions, abapAnswers: abapAnswers };
+}
+exports.getSubGenPrompts = getSubGenPrompts;
+/**
+ * Merges all prompts for deployment configuration.
+ *
+ * @param projectRoot - the project root path
+ * @param opts - the prompt opts for the deployment configuration prompts
+ * @param opts.supportedTargets - the support deployment targets
+ * @param opts.abapPrompts - abap specific prompts
+ * @param opts.cfPrompts - cf specific prompts
+ * @param opts.extensionPromptOpts - extension prompt options
+ * @param opts.launchStandaloneFromYui - whether the generator is launched standalone from YUI
+ * @returns - all the different prompts combined
+ */
+function combineAllPrompts(projectRoot, { supportedTargets, abapPrompts, cfPrompts, extensionPromptOpts, launchStandaloneFromYui }) {
+    const questions = (0, deploy_target_1.getDeployTargetQuestion)(supportedTargets, projectRoot, extensionPromptOpts, launchStandaloneFromYui);
+    questions.push(...(0, inquirer_common_1.withCondition)(abapPrompts, (answers) => answers.targetName === deploy_config_generator_shared_1.TargetName.ABAP));
+    questions.push(...(0, inquirer_common_1.withCondition)(cfPrompts, (answers) => answers.targetName === deploy_config_generator_shared_1.TargetName.CF));
+    return questions;
+}
+//# sourceMappingURL=sub-gen.js.map

package/generators/translations/deploy-config-sub-generator.i18n.json

@@ -0,0 +1,12 @@
+{
+    "prompts": {
+        "deployTarget": {
+            "breadcrumb": "Target Type",
+            "message": "Please choose the target"
+        }
+    },
+    "debug": {
+        "exit": "Exiting the deployment generator",
+        "loadingPrompts": "Loading deploy prompts..."
+    }
+}

package/generators/types/index.d.ts

@@ -0,0 +1,141 @@
+import type Generator from 'yeoman-generator';
+import type { Answers } from 'inquirer';
+import type { AppWizard, Prompts } from '@sap-devx/yeoman-ui-types';
+import type { ApiHubConfig } from '@sap-ux/cf-deploy-config-writer';
+import type { LogWrapper, VSCodeInstance } from '@sap-ux/fiori-generator-shared';
+import type { OdataServiceAnswers } from '@sap-ux/odata-service-inquirer';
+import type { FioriToolsProxyConfigBackend } from '@sap-ux/ui5-config';
+import type { CommonPromptOptions } from '@sap-ux/inquirer-common';
+export interface DeployConfigOptions extends Generator.GeneratorOptions {
+    /**
+     * The target deployment
+     */
+    target?: string;
+    /**
+     * Instance of the AppWizard
+     */
+    appWizard: AppWizard;
+    /**
+     * Whether the deploy config should be launched as a sub generator
+     * All prompts (CF & ABAP) wil be combined into one step
+     */
+    launchDeployConfigAsSubGenerator?: boolean;
+    /**
+     * Host URL passed from the generator
+     */
+    appGenServiceHost: string;
+    /**
+     * Service path passed from the generator
+     */
+    appGenServicePath: string;
+    /**
+     * Client passed from the generator
+     */
+    appGenClient: string;
+    /**
+     * The connected system from the generator
+     */
+    connectedSystem?: OdataServiceAnswers['connectedSystem'];
+    /**
+     * Name of the project
+     */
+    projectName: string;
+    /**
+     * Path to the root of the project (target folder)
+     */
+    projectPath: string;
+    /**
+     * Telemetry data to be added to the deployment telemetry event
+     */
+    telemetryData?: Record<string, string>;
+    /**
+     * API Hub configuration
+     */
+    apiHubConfig?: ApiHubConfig;
+    /**
+     * Instance of the logger
+     */
+    logWrapper?: LogWrapper;
+    /**
+     * Optional data passed from extension e.g Application Modeler
+     */
+    data: {
+        /**
+         * Project folder root
+         */
+        destinationRoot: string;
+    };
+}
+/**
+ * The deployment target (CF or ABAP)
+ */
+export interface Target {
+    name: string;
+    description: string;
+}
+/**
+ * The deployment configuration generator.
+ */
+export interface DeployConfigGenerator {
+    /**
+     * Instance of the Application Wizard
+     */
+    appWizard: AppWizard;
+    /**
+     * Instance of vscode
+     */
+    vscode: VSCodeInstance;
+    /**
+     * Options loaded from extension generators
+     */
+    extensionPromptOpts?: Record<string, CommonPromptOptions>;
+    /**
+     * The generator namespace that will be used for calling subgens
+     */
+    genNamespace: string;
+    /**
+     * Indicates the generator should be launched as a sub generator and combine all prompts into one step
+     */
+    launchDeployConfigAsSubGenerator: boolean;
+    /**
+     * Indicates the generator is launched standalone from YUI
+     */
+    launchStandaloneFromYui: boolean;
+    /**
+     * The target deployment e.g CF or ABAP
+     */
+    target: string | undefined;
+    /**
+     * The deploy config prompts
+     */
+    prompts: Prompts;
+    /**
+     * The deploy config answers
+     */
+    answers?: Answers;
+    /**
+     * The bas destination
+     */
+    cfDestination: string;
+    /**
+     * The path to the mta file
+     */
+    mtaPath?: string;
+    /**
+     * The API Hub configuration
+     */
+    apiHubConfig: ApiHubConfig;
+    /**
+     * The backend configuration,
+     */
+    backendConfig: FioriToolsProxyConfigBackend;
+    /**
+     * Whether the project is CAP
+     */
+    isCap: boolean;
+    /**
+     * Whether the project is a library
+     */
+    isLibrary: boolean;
+}
+//# sourceMappingURL=index.d.ts.map

package/generators/types/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/generators/utils/config.d.ts

@@ -0,0 +1,17 @@
+import type { FioriToolsProxyConfigBackend } from '@sap-ux/ui5-config';
+import type { Editor } from 'mem-fs-editor';
+import type { DeployConfigOptions } from '../types';
+/**
+ * Retrieves backend configuration from either the base config (ui5.yaml) or from the options passed in.
+ *
+ * @param fs - file system editor
+ * @param options - options passed in
+ * @param launchStandaloneFromYui - flag to indicate if this generator is launched in YUI standalone
+ * @param projectRoot - project root
+ * @returns - backend configuration
+ */
+export declare function getBackendConfig(fs: Editor, options: DeployConfigOptions, launchStandaloneFromYui: boolean, projectRoot: string): Promise<{
+    backendConfig: FioriToolsProxyConfigBackend;
+    isLibrary: boolean;
+}>;
+//# sourceMappingURL=config.d.ts.map

package/generators/utils/config.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBackendConfig = void 0;
+const path_1 = require("path");
+const abap_deploy_config_sub_generator_1 = require("@sap-ux/abap-deploy-config-sub-generator");
+const ui5_config_1 = require("@sap-ux/ui5-config");
+const project_access_1 = require("@sap-ux/project-access");
+/**
+ * Retrieves backend configuration from either the base config (ui5.yaml) or from the options passed in.
+ *
+ * @param fs - file system editor
+ * @param options - options passed in
+ * @param launchStandaloneFromYui - flag to indicate if this generator is launched in YUI standalone
+ * @param projectRoot - project root
+ * @returns - backend configuration
+ */
+async function getBackendConfig(fs, options, launchStandaloneFromYui, projectRoot) {
+    let backendConfig;
+    let isLibrary = false;
+    // This is called when this generator is called as a subgenerator from
+    // application generator or application modeler launcher (i.e. this.launchDeployConfigAsSubGenerator === true).
+    if (launchStandaloneFromYui) {
+        // Launched from app modeler where deploy config might already exist
+        // need to retrieve backendConfig information.
+        const ui5Config = await ui5_config_1.UI5Config.newInstance(fs.read((0, path_1.join)(projectRoot, options.base ?? project_access_1.FileName.Ui5Yaml)));
+        backendConfig = ui5Config.getBackendConfigsFromFioriToolsProxydMiddleware()[0];
+        isLibrary = ui5Config.getType() === abap_deploy_config_sub_generator_1.DeployProjectType.Library;
+    }
+    else {
+        // Launched as subgenerator from app gen
+        backendConfig = {
+            destination: options.connectedSystem?.destination?.Name,
+            url: options.appGenServiceHost,
+            client: options.appGenClient,
+            scp: !!options.connectedSystem?.backendSystem?.serviceKeys || false
+        };
+    }
+    return { backendConfig, isLibrary };
+}
+exports.getBackendConfig = getBackendConfig;
+//# sourceMappingURL=config.js.map

package/generators/utils/constants.d.ts

@@ -0,0 +1,6 @@
+import type { Target } from '../types';
+export declare const generatorNamespace: (bundledRootGeneratorName: string, subGenName: string) => string;
+export declare const abapChoice: Target;
+export declare const cfChoice: Target;
+export declare const generatorTitle = "Deployment Configuration Generator";
+//# sourceMappingURL=constants.d.ts.map

package/generators/utils/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generatorTitle = exports.cfChoice = exports.abapChoice = exports.generatorNamespace = void 0;
+// When deployment generator is bundled the namespacing is relative to the root generator
+const deploy_config_generator_shared_1 = require("@sap-ux/deploy-config-generator-shared");
+const generatorNamespace = (bundledRootGeneratorName, subGenName) => `${bundledRootGeneratorName}_${subGenName}`;
+exports.generatorNamespace = generatorNamespace;
+exports.abapChoice = { name: deploy_config_generator_shared_1.TargetName.ABAP, description: 'ABAP' };
+exports.cfChoice = { name: deploy_config_generator_shared_1.TargetName.CF, description: 'Cloud Foundry' };
+exports.generatorTitle = 'Deployment Configuration Generator';
+//# sourceMappingURL=constants.js.map

package/generators/utils/environment.d.ts

@@ -0,0 +1,34 @@
+import { type ApiHubConfig } from '@sap-ux/cf-deploy-config-sub-generator';
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Check if the MTA is installed.
+ *
+ * @param choice - the choice (CF or ABAP)
+ * @param projectPath - path to the project
+ * @returns - true if the MTA is installed, otherwise an error message
+ */
+export declare function isMTAInstalled(choice: string, projectPath: string): boolean | string;
+/**
+ * Get the Api Hub Enterprise Key value from the node env if available.
+ *
+ * @returns The api hub enterprise config or undefined if the key is not found.
+ */
+export declare function getEnvApiHubConfig(): ApiHubConfig | undefined;
+/**
+ * Returns the destination name for API Hub Enterprise.
+ *
+ * @param memFs - reference to a mem-fs editor
+ * @param opts -options representing the project app path and service path
+ * @param opts.appPath - path to project
+ * @param opts.servicePath - service path
+ * @param apiHubConfig - API Hub Config
+ * @returns - destination name
+ */
+export declare function getApiHubOptions(memFs: Editor, { appPath, servicePath }: {
+    appPath: string;
+    servicePath: string | undefined;
+}, apiHubConfig?: ApiHubConfig): Promise<{
+    destinationName: string | undefined;
+    servicePath: string | undefined;
+}>;
+//# sourceMappingURL=environment.d.ts.map

package/generators/utils/environment.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getApiHubOptions = exports.getEnvApiHubConfig = exports.isMTAInstalled = void 0;
+// Legacy package, dependent on external dependencies for async operations and no 'type: module' defined in package.json
+const hasbin = require("hasbin");
+const cf_deploy_config_sub_generator_1 = require("@sap-ux/cf-deploy-config-sub-generator");
+const deploy_config_generator_shared_1 = require("@sap-ux/deploy-config-generator-shared");
+const fs_1 = require("fs");
+const path_1 = require("path");
+/**
+ * Check if the MTA is installed.
+ *
+ * @param choice - the choice (CF or ABAP)
+ * @param projectPath - path to the project
+ * @returns - true if the MTA is installed, otherwise an error message
+ */
+function isMTAInstalled(choice, projectPath) {
+    if ((choice === 'cf' && !hasbin.sync(deploy_config_generator_shared_1.mtaExecutable)) ||
+        (choice === 'abap' && !hasbin.sync(deploy_config_generator_shared_1.mtaExecutable) && (0, fs_1.existsSync)((0, path_1.join)(projectPath, 'mta.yaml')))) {
+        deploy_config_generator_shared_1.ErrorHandler.getErrorMsgFromType(deploy_config_generator_shared_1.ERROR_TYPE.NO_MTA_BIN);
+        return ' ';
+    }
+    return true;
+}
+exports.isMTAInstalled = isMTAInstalled;
+/**
+ * Get the Api Hub Enterprise Key value from the node env if available.
+ *
+ * @returns The api hub enterprise config or undefined if the key is not found.
+ */
+function getEnvApiHubConfig() {
+    const apiHubKey = process.env['API_HUB_API_KEY'];
+    const apiHubType = process.env['API_HUB_TYPE'];
+    // Legacy apps .env file will not define a type variable
+    return apiHubKey
+        ? {
+            apiHubKey,
+            apiHubType: apiHubType === "API_HUB_ENTERPRISE" /* ApiHubType.apiHubEnterprise */ ? "API_HUB_ENTERPRISE" /* ApiHubType.apiHubEnterprise */ : "API_HUB" /* ApiHubType.apiHub */
+        }
+        : undefined;
+}
+exports.getEnvApiHubConfig = getEnvApiHubConfig;
+/**
+ * Returns the destination name for API Hub Enterprise.
+ *
+ * @param memFs - reference to a mem-fs editor
+ * @param opts -options representing the project app path and service path
+ * @param opts.appPath - path to project
+ * @param opts.servicePath - service path
+ * @param apiHubConfig - API Hub Config
+ * @returns - destination name
+ */
+async function getApiHubOptions(memFs, { appPath, servicePath }, apiHubConfig) {
+    let destinationName;
+    if (apiHubConfig?.apiHubType === "API_HUB_ENTERPRISE" /* ApiHubType.apiHubEnterprise */) {
+        // appGenDestination may not have been passed in options e.g. launched from app modeler
+        if (!servicePath) {
+            // Load service path from manifest.json file
+            const manifest = await (0, cf_deploy_config_sub_generator_1.loadManifest)(memFs, appPath);
+            servicePath = manifest?.['sap.app'].dataSources?.mainService?.uri;
+        }
+        destinationName = (0, deploy_config_generator_shared_1.generateDestinationName)(cf_deploy_config_sub_generator_1.API_BUSINESS_HUB_ENTERPRISE_PREFIX, servicePath);
+    }
+    return { destinationName, servicePath };
+}
+exports.getApiHubOptions = getApiHubOptions;
+//# sourceMappingURL=environment.js.map

package/generators/utils/i18n.d.ts

@@ -0,0 +1,14 @@
+import type { TOptions } from 'i18next';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+export declare function initI18n(): Promise<void>;
+/**
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+export declare function t(key: string, options?: TOptions): string;
+//# sourceMappingURL=i18n.d.ts.map

package/generators/utils/i18n.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.t = exports.initI18n = void 0;
+const i18next_1 = __importDefault(require("i18next"));
+const deploy_config_sub_generator_i18n_json_1 = __importDefault(require("../translations/deploy-config-sub-generator.i18n.json"));
+const inquirer_common_1 = require("@sap-ux/inquirer-common");
+const deployConfigSubGen = 'deploy-config-sub-generator';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+async function initI18n() {
+    await i18next_1.default.init({ lng: 'en', fallbackLng: 'en' }, () => i18next_1.default.addResourceBundle('en', deployConfigSubGen, deploy_config_sub_generator_i18n_json_1.default));
+    (0, inquirer_common_1.addi18nResourceBundle)();
+}
+exports.initI18n = initI18n;
+/**
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+function t(key, options) {
+    if (!options?.ns) {
+        options = Object.assign(options ?? {}, { ns: deployConfigSubGen });
+    }
+    return i18next_1.default.t(key, options);
+}
+exports.t = t;
+initI18n().catch(() => {
+    // Needed for lint
+});
+//# sourceMappingURL=i18n.js.map

package/generators/utils/index.d.ts

@@ -0,0 +1,6 @@
+export * from './config';
+export * from './constants';
+export * from './i18n';
+export * from './environment';
+export * from './targets';
+//# sourceMappingURL=index.d.ts.map

package/generators/utils/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./config"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./i18n"), exports);
+__exportStar(require("./environment"), exports);
+__exportStar(require("./targets"), exports);
+//# sourceMappingURL=index.js.map

package/generators/utils/targets.d.ts

@@ -0,0 +1,16 @@
+import type { Editor } from 'mem-fs-editor';
+import type { Target } from '../types';
+import type { ApiHubConfig } from '@sap-ux/cf-deploy-config-sub-generator';
+/**
+ * Generate a list of targets i.e. CF | ABAP and order based on the project type i.e. library, CF, abap or CAP.
+ *
+ * @param fs - reference to a mem-fs editor
+ * @param projectPath - project path
+ * @param isCap - is the target project a CAP project
+ * @param hasMtaConfig - does the target project contain MTA Config
+ * @param apiHubConfig - API Hub configuration
+ * @param configFile - config file to read UI5 properties, default to ui5.yaml
+ * @returns a list of Target options i.e. CF | ABAP
+ */
+export declare function getSupportedTargets(fs: Editor, projectPath: string, isCap?: boolean, hasMtaConfig?: boolean, apiHubConfig?: ApiHubConfig, configFile?: "ui5.yaml"): Promise<Target[]>;
+//# sourceMappingURL=targets.d.ts.map

package/generators/utils/targets.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSupportedTargets = void 0;
+const abap_deploy_config_sub_generator_1 = require("@sap-ux/abap-deploy-config-sub-generator");
+const project_access_1 = require("@sap-ux/project-access");
+const ui5_config_1 = require("@sap-ux/ui5-config");
+const path_1 = require("path");
+const constants_1 = require("./constants");
+/**
+ * Generate a list of targets i.e. CF | ABAP and order based on the project type i.e. library, CF, abap or CAP.
+ *
+ * @param fs - reference to a mem-fs editor
+ * @param projectPath - project path
+ * @param isCap - is the target project a CAP project
+ * @param hasMtaConfig - does the target project contain MTA Config
+ * @param apiHubConfig - API Hub configuration
+ * @param configFile - config file to read UI5 properties, default to ui5.yaml
+ * @returns a list of Target options i.e. CF | ABAP
+ */
+async function getSupportedTargets(fs, projectPath, isCap = false, hasMtaConfig = false, apiHubConfig, configFile = project_access_1.FileName.Ui5Yaml) {
+    const isApiHubEnt = apiHubConfig?.apiHubType === "API_HUB_ENTERPRISE" /* ApiHubType.apiHubEnterprise */;
+    const isProjectExtension = fs.exists((0, path_1.join)(projectPath, '.extconfig.json'));
+    let isLibrary = false;
+    try {
+        const ui5Config = await ui5_config_1.UI5Config.newInstance(fs.read((0, path_1.join)(projectPath, configFile)));
+        isLibrary = ui5Config.getType() === abap_deploy_config_sub_generator_1.DeployProjectType.Library;
+    }
+    catch {
+        // Ignore error, ui5.yaml may not be written yet
+    }
+    if (isApiHubEnt || isCap) {
+        return [constants_1.cfChoice];
+    }
+    else if (isLibrary || isProjectExtension) {
+        return [constants_1.abapChoice]; // Extension projects, Library and systems using Reentrance tickets for auth
+    }
+    else {
+        // If there's an mta.yaml in the hierarchy, it's probably a CF project
+        // Offer that first and let the user decide
+        return hasMtaConfig ? [constants_1.cfChoice, constants_1.abapChoice] : [constants_1.abapChoice, constants_1.cfChoice];
+    }
+}
+exports.getSupportedTargets = getSupportedTargets;
+//# sourceMappingURL=targets.js.map