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

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,19 @@
+# @sap-ux/abap-deploy-config-sub-generator
+
+## Features
+
+The ABAP deployment configuration sub-generator enables users to create deployment configuration files to a SAP Fiori application.
+
+## Installation
+
+The  ABAP deployment configuration sub-generator is installed as part of the [@sap/generator-fiori](https://www.npmjs.com/package/@sap/generator-fiori) generator and cannot be used stand alone. Furthermore, usage requires that the [SAP Fiori Tools Extension](https://marketplace.visualstudio.com/items?itemName=SAPSE.sap-ux-fiori-tools-extension-pack) pack is installed from the VSCode marketplace.
+
+## Launch the  ABAP deployment configuration sub-generator
+
+Open the Command Palette in MS Visual Studio Code ( CMD/CTRL + Shift + P ) and execute the Fiori: Add Deployment Configuration command.
+
+
+## Keywords
+SAP Fiori Elements
+Yeoman
+Generator

package/generators/app/index.d.ts

@@ -0,0 +1,48 @@
+import { DeploymentGenerator } from '@sap-ux/deploy-config-generator-shared';
+import type { AbapDeployConfigOptions } from './types';
+/**
+ * ABAP deploy config generator.
+ */
+export default class extends DeploymentGenerator {
+    private readonly appWizard;
+    private readonly vscode;
+    private readonly launchDeployConfigAsSubGenerator;
+    private readonly launchStandaloneFromYui?;
+    private abort;
+    private backendConfig;
+    private indexGenerationAllowed;
+    private configExists;
+    private answers;
+    private projectType;
+    /**
+     * Constructor for the ABAP deploy config generator.
+     *
+     * @param args - arguments passed to the generator
+     * @param opts - options passed to the generator
+     */
+    constructor(args: string | string[], opts: AbapDeployConfigOptions);
+    initializing(): Promise<void>;
+    private _initDestinationRoot;
+    private _processProjectConfig;
+    private _processIndexHtmlConfig;
+    private _initBackendConfig;
+    private _initializing;
+    prompting(): Promise<void>;
+    private _processAbapTargetAnswers;
+    private _processBspAppAnswers;
+    /**
+     * Reconcile answers with options.
+     *
+     * Options may be passed from parent generator, or from the command line.
+     */
+    private _reconcileAnswersWithOptions;
+    writing(): Promise<void>;
+    private _writing;
+    install(): void;
+    private _install;
+    end(): Promise<void>;
+}
+export { getAbapQuestions } from './questions';
+export { indexHtmlExists } from '../utils';
+export { AbapDeployConfigOptions, DeployProjectType } from './types';
+//# sourceMappingURL=index.d.ts.map

package/generators/app/index.js

@@ -0,0 +1,262 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeployProjectType = exports.indexHtmlExists = exports.getAbapQuestions = void 0;
+const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+const deploy_config_generator_shared_1 = require("@sap-ux/deploy-config-generator-shared");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const abap_deploy_config_inquirer_1 = require("@sap-ux/abap-deploy-config-inquirer");
+const abap_deploy_config_writer_1 = require("@sap-ux/abap-deploy-config-writer");
+const telemetry_1 = require("@sap-ux/telemetry");
+const ui5_config_1 = require("@sap-ux/ui5-config");
+const project_access_1 = require("@sap-ux/project-access");
+const store_1 = require("@sap-ux/store");
+const utils_1 = require("../utils");
+const questions_1 = require("./questions");
+const telemetryEvents_1 = require("../telemetryEvents");
+const types_1 = require("./types");
+const i18n_1 = require("../utils/i18n");
+const feature_toggle_1 = require("@sap-ux/feature-toggle");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const constants_1 = require("@sap-ux/abap-deploy-config-inquirer/dist/constants");
+/**
+ * ABAP deploy config generator.
+ */
+class default_1 extends deploy_config_generator_shared_1.DeploymentGenerator {
+    appWizard;
+    vscode;
+    launchDeployConfigAsSubGenerator;
+    launchStandaloneFromYui;
+    abort = false;
+    backendConfig;
+    indexGenerationAllowed;
+    configExists;
+    answers;
+    projectType;
+    /**
+     * Constructor for the ABAP deploy config generator.
+     *
+     * @param args - arguments passed to the generator
+     * @param opts - options passed to the generator
+     */
+    constructor(args, opts) {
+        super(args, opts);
+        this.launchDeployConfigAsSubGenerator = opts.launchDeployConfigAsSubGenerator ?? false;
+        this.launchStandaloneFromYui = opts.launchStandaloneFromYui;
+        this.appWizard = opts.appWizard || yeoman_ui_types_1.AppWizard.create(opts);
+        this.vscode = opts.vscode;
+        this.options = opts;
+    }
+    async initializing() {
+        await super.initializing();
+        await (0, i18n_1.initI18n)();
+        if (this.env.conflicter) {
+            this.env.conflicter.force = this.options.force ?? true;
+        }
+        deploy_config_generator_shared_1.DeploymentGenerator.logger?.debug((0, utils_1.t)('debug.initTelemetry'));
+        await (0, telemetry_1.initTelemetrySettings)({
+            consumerModule: {
+                name: '@sap-ux/abap-deploy-config-sub-generator',
+                version: this.rootGeneratorVersion()
+            },
+            internalFeature: (0, feature_toggle_1.isInternalFeaturesSettingEnabled)(),
+            watchTelemetrySettingStore: false
+        });
+        if (!this.launchDeployConfigAsSubGenerator) {
+            await this._initializing();
+        }
+    }
+    _initDestinationRoot() {
+        if (this.options.appRootPath) {
+            this.destinationRoot(this.options.appRootPath);
+            deploy_config_generator_shared_1.DeploymentGenerator.logger?.debug((0, utils_1.t)('debug.appRootPath', { appRootPath: this.options.appRootPath }));
+        }
+    }
+    _processProjectConfig() {
+        this.options.base = this.options.base || project_access_1.FileName.Ui5Yaml;
+        this.options.config = this.options.config || project_access_1.FileName.UI5DeployYaml;
+        // check base exists
+        const baseExists = this.fs.exists(this.destinationPath(this.options.base));
+        if (!baseExists) {
+            this.abort = true;
+            (0, utils_1.handleProjectDoesNotExist)(this.appWizard, this.destinationPath(this.options.base));
+        }
+        // check config exists
+        this.configExists = this.fs.exists(this.destinationPath(this.options.config));
+        if (this.configExists) {
+            deploy_config_generator_shared_1.DeploymentGenerator.logger?.debug((0, utils_1.t)('debug.configExists', { configPath: this.destinationPath(this.options.config) }));
+        }
+    }
+    async _processIndexHtmlConfig() {
+        const htmlIndexExists = await (0, utils_1.indexHtmlExists)(this.fs, this.destinationPath());
+        if (htmlIndexExists) {
+            this.indexGenerationAllowed = false;
+            if (this.options.index) {
+                deploy_config_generator_shared_1.DeploymentGenerator.logger?.debug((0, utils_1.t)('debug.indexExists'));
+            }
+            delete this.options.index;
+        }
+        else {
+            this.indexGenerationAllowed = true;
+        }
+    }
+    async _initBackendConfig() {
+        const ui5Config = await ui5_config_1.UI5Config.newInstance(this.fs.read(this.destinationPath(this.options.base ?? project_access_1.FileName.Ui5Yaml)));
+        this.projectType =
+            ui5Config.getType() === 'library' ? types_1.DeployProjectType.Library : types_1.DeployProjectType.Application;
+        this.backendConfig = ui5Config.getBackendConfigsFromFioriToolsProxydMiddleware()[0];
+    }
+    async _initializing() {
+        this._initDestinationRoot();
+        try {
+            this._processProjectConfig();
+            await this._processIndexHtmlConfig();
+            await this._initBackendConfig();
+        }
+        catch (e) {
+            if (e === deploy_config_generator_shared_1.ErrorMessages.abortSignal) {
+                deploy_config_generator_shared_1.DeploymentGenerator.logger?.debug((0, utils_1.t)('debug.initFailed', { error: e }));
+            }
+            else {
+                throw e;
+            }
+        }
+    }
+    async prompting() {
+        this.answers = {};
+        if (this.abort) {
+            return;
+        }
+        if (!this.launchDeployConfigAsSubGenerator) {
+            const { prompts: abapDeployConfigPrompts, answers: abapAnswers = {} } = await (0, questions_1.getAbapQuestions)({
+                appRootPath: this.destinationRoot(),
+                connectedSystem: this.options.connectedSystem,
+                backendConfig: this.backendConfig,
+                configFile: this.options.config,
+                indexGenerationAllowed: this.indexGenerationAllowed,
+                showOverwriteQuestion: (0, deploy_config_generator_shared_1.showOverwriteQuestion)(this.launchDeployConfigAsSubGenerator, this.launchStandaloneFromYui, this.options.overwrite, this.configExists),
+                projectType: this.projectType,
+                logger: deploy_config_generator_shared_1.DeploymentGenerator.logger
+            });
+            const prompAnswers = await this.prompt(abapDeployConfigPrompts);
+            this.answers = (0, abap_deploy_config_inquirer_1.reconcileAnswers)(prompAnswers, abapAnswers);
+        }
+        this._reconcileAnswersWithOptions();
+    }
+    _processAbapTargetAnswers() {
+        this.answers.destination = this.options.destination || this.answers.destination;
+        this.answers.url = this.options.url || this.answers.url;
+        this.answers.client = this.options.client || this.answers.client;
+        this.answers.scp = this.options.scp || this.answers.scp;
+        this.answers.isS4HC = this.options.isS4HC || this.answers.isS4HC;
+        if (!(0, btp_utils_1.isAppStudio)() && this.answers.scp) {
+            // ensure there is no client for SCP on vscode
+            delete this.answers.client;
+        }
+    }
+    _processBspAppAnswers() {
+        this.answers.ui5AbapRepo = (this.options.ui5AbapRepo || this.answers.ui5AbapRepo)?.toUpperCase();
+        // Set package
+        if (!this.answers.package) {
+            this.answers.package =
+                (0, abap_deploy_config_inquirer_1.getPackageAnswer)(this.options, this.options.package) ||
+                    (0, abap_deploy_config_inquirer_1.getPackageAnswer)(this.answers) ||
+                    (this.answers.scp ? '' : constants_1.DEFAULT_PACKAGE_ABAP);
+        }
+        // Set transport
+        if (!this.answers.transport) {
+            this.answers.transport =
+                (0, abap_deploy_config_inquirer_1.getTransportAnswer)(this.options) || (0, abap_deploy_config_inquirer_1.getTransportAnswer)(this.answers);
+        }
+    }
+    /**
+     * Reconcile answers with options.
+     *
+     * Options may be passed from parent generator, or from the command line.
+     */
+    _reconcileAnswersWithOptions() {
+        this._processAbapTargetAnswers();
+        this._processBspAppAnswers();
+        this.answers.index = this.options.index || this.answers.index;
+        this.answers.description = this.options.description || this.answers.description;
+        this.answers.overwrite = this.options.overwrite || this.answers.overwrite;
+    }
+    async writing() {
+        if (!this.launchDeployConfigAsSubGenerator) {
+            await this._writing();
+        }
+    }
+    async _writing() {
+        if (this.abort || this.answers.overwrite === false) {
+            return;
+        }
+        await (0, abap_deploy_config_writer_1.generate)(this.destinationPath(), {
+            target: {
+                url: this.answers.url,
+                client: this.answers.client,
+                scp: this.answers.scp,
+                destination: this.answers.destination,
+                authenticationType: this.answers.isS4HC ? store_1.AuthenticationType.ReentranceTicket : undefined // only reentrance ticket is relevant for writing to deploy config
+            },
+            app: {
+                name: this.answers.ui5AbapRepo,
+                description: this.answers.description,
+                package: this.answers.package,
+                transport: this.answers.transport
+            },
+            index: this.answers.index
+        }, {
+            baseFile: this.options.base,
+            deployFile: this.options.config
+        }, this.fs);
+    }
+    install() {
+        if (!this.launchDeployConfigAsSubGenerator && this.answers.overwrite !== false) {
+            this._install();
+        }
+    }
+    _install() {
+        if (!this.options.skipInstall) {
+            this.spawnCommand('npm', [
+                'install',
+                '--no-audit',
+                '--no-fund',
+                '--silent',
+                '--prefer-offline',
+                '--no-progress'
+            ]);
+        }
+        else {
+            deploy_config_generator_shared_1.DeploymentGenerator.logger?.info((0, utils_1.t)('info.skippedInstallation'));
+        }
+    }
+    async end() {
+        if (this.abort || this.answers.overwrite === false) {
+            return;
+        }
+        // Delayed process of deploy configuration generation if integrated with app generator
+        if (this.launchDeployConfigAsSubGenerator) {
+            await this._initializing();
+            await this._writing();
+            this._install();
+        }
+        if (this.launchStandaloneFromYui &&
+            (0, fiori_generator_shared_1.isExtensionInstalled)(this.vscode, fiori_generator_shared_1.YUI_EXTENSION_ID, fiori_generator_shared_1.YUI_MIN_VER_FILES_GENERATED_MSG)) {
+            this.appWizard?.showInformation((0, utils_1.t)('info.filesGenerated'), yeoman_ui_types_1.MessageType.notification);
+        }
+        // Send telemetry data after adding deployment configuration
+        (0, fiori_generator_shared_1.sendTelemetry)(telemetryEvents_1.EventName.DEPLOY_CONFIG, fiori_generator_shared_1.TelemetryHelper.createTelemetryData({
+            DeployTarget: 'ABAP',
+            ...this.options.telemetryData
+        }) ?? {}, this.destinationRoot())?.catch((error) => {
+            deploy_config_generator_shared_1.DeploymentGenerator.logger.error((0, utils_1.t)('error.telemetry', { error }));
+        });
+    }
+}
+exports.default = default_1;
+var questions_2 = require("./questions");
+Object.defineProperty(exports, "getAbapQuestions", { enumerable: true, get: function () { return questions_2.getAbapQuestions; } });
+var utils_2 = require("../utils");
+Object.defineProperty(exports, "indexHtmlExists", { enumerable: true, get: function () { return utils_2.indexHtmlExists; } });
+var types_2 = require("./types");
+Object.defineProperty(exports, "DeployProjectType", { enumerable: true, get: function () { return types_2.DeployProjectType; } });
+//# sourceMappingURL=index.js.map

package/generators/app/questions.d.ts

@@ -0,0 +1,33 @@
+import type { ILogWrapper } from '@sap-ux/fiori-generator-shared';
+import type { AbapDeployConfigAnswersInternal, AbapDeployConfigQuestion } from '@sap-ux/abap-deploy-config-inquirer';
+import type { FioriToolsProxyConfigBackend } from '@sap-ux/ui5-config';
+import type { ConnectedSystem } from '@sap-ux/deploy-config-generator-shared';
+import { DeployProjectType } from './types';
+/**
+ * Retrieves the ABAP prompt questions from the inquirer.
+ *
+ * @param params - the parameters required for retrieving the questions
+ * @param params.appRootPath - the path to the app
+ * @param params.connectedSystem - the connected system
+ * @param params.backendConfig - the backend configuration
+ * @param params.configFile - the deployment configuration file name
+ * @param params.indexGenerationAllowed - whether index generation is allowed
+ * @param params.showOverwriteQuestion - whether the overwrite question should be shown
+ * @param params.projectType - the project type
+ * @param params.logger - the logger
+ * @returns - the prompts and answers
+ */
+export declare function getAbapQuestions({ appRootPath, connectedSystem, backendConfig, configFile, indexGenerationAllowed, showOverwriteQuestion, projectType, logger }: {
+    appRootPath: string;
+    connectedSystem?: ConnectedSystem;
+    backendConfig?: FioriToolsProxyConfigBackend;
+    configFile?: string;
+    indexGenerationAllowed?: boolean;
+    showOverwriteQuestion?: boolean;
+    projectType?: DeployProjectType;
+    logger?: ILogWrapper;
+}): Promise<{
+    prompts: AbapDeployConfigQuestion[];
+    answers: Partial<AbapDeployConfigAnswersInternal>;
+}>;
+//# sourceMappingURL=questions.d.ts.map

package/generators/app/questions.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAbapQuestions = getAbapQuestions;
+const abap_deploy_config_inquirer_1 = require("@sap-ux/abap-deploy-config-inquirer");
+const project_access_1 = require("@sap-ux/project-access");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const constants_1 = require("../utils/constants");
+const types_1 = require("./types");
+/**
+ * Get the ABAP target based on the provided parameters.
+ *
+ * @param destination - the destination used during app generation
+ * @param backendSystem - the backend system used during app generation
+ * @param existingAbapDeployTask - possible existing deploy configuration (ui5-deploy.yaml)
+ * @param backendConfig - the existing base configuration (ui5.yaml)
+ * @returns - the ABAP target
+ */
+function getAbapTarget(destination, backendSystem, existingAbapDeployTask, backendConfig) {
+    let url, scp, client, destinationName, authenticationType;
+    if ((0, btp_utils_1.isAppStudio)() && destination) {
+        // the destination used during app generation
+        destinationName = destination.Name;
+    }
+    else if (backendSystem) {
+        // the backend system used during app generation
+        url = backendSystem.url;
+        client = backendSystem.client;
+        scp = !!backendSystem.serviceKeys;
+        authenticationType = backendSystem.authenticationType;
+    }
+    else if (existingAbapDeployTask?.target) {
+        // possible existing deploy configuration (ui5-deploy.yaml)
+        url = existingAbapDeployTask.target.url;
+        client = existingAbapDeployTask.target.client;
+        scp = existingAbapDeployTask.target.scp;
+        authenticationType = existingAbapDeployTask.target.authenticationType;
+        destinationName = existingAbapDeployTask.target.destination;
+    }
+    else if (backendConfig) {
+        // the existing base configuration (ui5.yaml)
+        url = backendConfig.url;
+        scp = backendConfig.scp;
+        client = backendConfig.client;
+        authenticationType = backendConfig.authenticationType;
+        destinationName = backendConfig?.destination;
+    }
+    return {
+        url,
+        scp,
+        client: client || '', // Needs to default to empty string
+        destination: destinationName,
+        authenticationType
+    };
+}
+/**
+ * Retrieves the ABAP prompt questions from the inquirer.
+ *
+ * @param params - the parameters required for retrieving the questions
+ * @param params.appRootPath - the path to the app
+ * @param params.connectedSystem - the connected system
+ * @param params.backendConfig - the backend configuration
+ * @param params.configFile - the deployment configuration file name
+ * @param params.indexGenerationAllowed - whether index generation is allowed
+ * @param params.showOverwriteQuestion - whether the overwrite question should be shown
+ * @param params.projectType - the project type
+ * @param params.logger - the logger
+ * @returns - the prompts and answers
+ */
+async function getAbapQuestions({ appRootPath, connectedSystem, backendConfig, configFile = project_access_1.FileName.UI5DeployYaml, indexGenerationAllowed = false, showOverwriteQuestion = false, projectType = types_1.DeployProjectType.Application, logger }) {
+    const { backendSystem, serviceProvider, destination } = connectedSystem || {};
+    let existingAbapDeployTask;
+    try {
+        const ui5DeployConfig = await (0, project_access_1.readUi5Yaml)(appRootPath, configFile);
+        existingAbapDeployTask = ui5DeployConfig.findCustomTask(constants_1.ABAP_DEPLOY_TASK)?.configuration;
+    }
+    catch {
+        // not an issue if the file does not exist
+    }
+    const abapTarget = getAbapTarget(destination, backendSystem, existingAbapDeployTask, backendConfig);
+    const deployAppConfig = existingAbapDeployTask?.app;
+    logger?.debug(`Retrieve ABAP prompts using: \n App path: ${appRootPath}, 
+        ABAPTarget: ${JSON.stringify(abapTarget)}, SystemName: ${backendSystem?.name}, 
+        ServiceProvider: ${!!serviceProvider}, showOverwriteQuestion ${showOverwriteQuestion}, indexGenerationAllowed ${indexGenerationAllowed}`);
+    return (0, abap_deploy_config_inquirer_1.getPrompts)({
+        backendTarget: {
+            abapTarget,
+            systemName: backendSystem?.name,
+            serviceProvider,
+            type: projectType
+        },
+        ui5AbapRepo: { default: deployAppConfig?.name },
+        description: { default: deployAppConfig?.description },
+        packageManual: { default: deployAppConfig?.package },
+        transportManual: { default: deployAppConfig?.transport },
+        index: { indexGenerationAllowed },
+        packageAutocomplete: { useAutocomplete: true },
+        overwrite: { hide: !showOverwriteQuestion }
+    }, logger, (0, fiori_generator_shared_1.getHostEnvironment)() !== fiori_generator_shared_1.hostEnvironment.cli);
+}
+//# sourceMappingURL=questions.js.map

package/generators/app/types.d.ts

@@ -0,0 +1,55 @@
+import type { AbapDeployConfigAnswersInternal } from '@sap-ux/abap-deploy-config-inquirer';
+import type { AppWizard } from '@sap-devx/yeoman-ui-types';
+import type { ConnectedSystem } from '@sap-ux/deploy-config-generator-shared';
+import type { TelemetryData } from '@sap-ux/fiori-generator-shared';
+export interface AbapDeployConfigOptions extends AbapDeployConfigAnswersInternal {
+    /**
+     * VSCode instance
+     */
+    vscode?: unknown;
+    /**
+     * AppWizard instance
+     */
+    appWizard?: AppWizard;
+    /**
+     * Whether the generator is launched as a subgenerator
+     */
+    launchDeployConfigAsSubGenerator?: boolean;
+    /**
+     * Whether the generator is launched as a standalone generator in a YUI context
+     */
+    launchStandaloneFromYui?: boolean;
+    /**
+     * Path to the application root where the deployment configuration will be added.
+     */
+    appRootPath?: string;
+    /**
+     * The connected destination or backend system and service provider
+     */
+    connectedSystem?: ConnectedSystem;
+    /**
+     * The name of the base config file e.g. ui5.yaml
+     */
+    base?: string;
+    /**
+     * The name of the deploy config file e.g. ui5-deploy.yaml
+     */
+    config?: string;
+    /**
+     * Option to skip the installation of dependencies
+     */
+    skipInstall?: boolean;
+    /**
+     * Option to force the conflicter property of the yeoman environment (prevents additional prompt for overwriting files)
+     */
+    force?: boolean;
+    /**
+     * Telemetry data to be send after deployment configuration has been added
+     */
+    telemetryData?: TelemetryData;
+}
+export declare enum DeployProjectType {
+    Application = "application",
+    Library = "library"
+}
+//# sourceMappingURL=types.d.ts.map

package/generators/app/types.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeployProjectType = void 0;
+var DeployProjectType;
+(function (DeployProjectType) {
+    DeployProjectType["Application"] = "application";
+    DeployProjectType["Library"] = "library";
+})(DeployProjectType || (exports.DeployProjectType = DeployProjectType = {}));
+//# sourceMappingURL=types.js.map

package/generators/telemetryEvents/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Event names for telemetry for the abap deploy config generator
+ */
+export declare enum EventName {
+    DEPLOY_CONFIG = "DEPLOY_CONFIG"
+}
+//# sourceMappingURL=index.d.ts.map

package/generators/telemetryEvents/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventName = void 0;
+/**
+ * Event names for telemetry for the abap deploy config generator
+ */
+var EventName;
+(function (EventName) {
+    EventName["DEPLOY_CONFIG"] = "DEPLOY_CONFIG";
+})(EventName || (exports.EventName = EventName = {}));
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,17 @@
+{
+    "error": {
+        "telemetry": "Failed to send telemetry data after deployment configuration has been added. {{- error}}"
+    },
+    "info": {
+        "filesGenerated": "The files have been generated.",
+        "skippedInstallation": "Option `--skipInstall` was specified. Installation of dependencies will be skipped."
+    },
+    "debug": {
+        "configExists": "Existing deployment configuration file found at {{- configPath}}",
+        "configNotFound": "No existing deployment configuration file found",
+        "indexExists": "'webapp/index.html' already exists and won't be overwritten",
+        "initFailed": "Initializing failed, unable to process project configuration. {{- error}}",
+        "initTelemetry": "Initializing telemetry",
+        "appRootPath": "App loaded from {{- appRootPath}}"
+    }
+}

package/generators/utils/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const ABAP_DEPLOY_TASK = "deploy-to-abap";
+//# sourceMappingURL=constants.d.ts.map

package/generators/utils/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ABAP_DEPLOY_TASK = void 0;
+exports.ABAP_DEPLOY_TASK = 'deploy-to-abap';
+//# sourceMappingURL=constants.js.map

package/generators/utils/error-handler.d.ts

@@ -0,0 +1,9 @@
+import type { AppWizard } from '@sap-devx/yeoman-ui-types';
+/**
+ * Handle the case where the project does not exist.
+ *
+ * @param appWizard - the appWizard instance
+ * @param path - the path that does not exist
+ */
+export declare function handleProjectDoesNotExist(appWizard: AppWizard, path: string): void;
+//# sourceMappingURL=error-handler.d.ts.map

package/generators/utils/error-handler.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleProjectDoesNotExist = handleProjectDoesNotExist;
+const deploy_config_generator_shared_1 = require("@sap-ux/deploy-config-generator-shared");
+/**
+ * Handle the case where the project does not exist.
+ *
+ * @param appWizard - the appWizard instance
+ * @param path - the path that does not exist
+ */
+function handleProjectDoesNotExist(appWizard, path) {
+    const errorMsg = deploy_config_generator_shared_1.ErrorMessages.fileDoesNotExist(path);
+    (0, deploy_config_generator_shared_1.handleErrorMessage)(appWizard, errorMsg);
+    throw deploy_config_generator_shared_1.ErrorMessages.abortSignal;
+}
+//# sourceMappingURL=error-handler.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,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initI18n = initI18n;
+exports.t = t;
+const i18next_1 = __importDefault(require("i18next"));
+const abap_deploy_config_sub_generator_i18n_json_1 = __importDefault(require("../translations/abap-deploy-config-sub-generator.i18n.json"));
+const abapDeployGenI18nNamespace = 'abap-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', abapDeployGenI18nNamespace, abap_deploy_config_sub_generator_i18n_json_1.default));
+}
+/**
+ * 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: abapDeployGenI18nNamespace });
+    }
+    return i18next_1.default.t(key, options);
+}
+initI18n().catch(() => {
+    // Needed for lint
+});
+//# sourceMappingURL=i18n.js.map

package/generators/utils/index.d.ts

@@ -0,0 +1,4 @@
+export { indexHtmlExists } from './project';
+export { handleProjectDoesNotExist } from './error-handler';
+export { t } from './i18n';
+//# sourceMappingURL=index.d.ts.map

package/generators/utils/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.t = exports.handleProjectDoesNotExist = exports.indexHtmlExists = void 0;
+var project_1 = require("./project");
+Object.defineProperty(exports, "indexHtmlExists", { enumerable: true, get: function () { return project_1.indexHtmlExists; } });
+var error_handler_1 = require("./error-handler");
+Object.defineProperty(exports, "handleProjectDoesNotExist", { enumerable: true, get: function () { return error_handler_1.handleProjectDoesNotExist; } });
+var i18n_1 = require("./i18n");
+Object.defineProperty(exports, "t", { enumerable: true, get: function () { return i18n_1.t; } });
+//# sourceMappingURL=index.js.map

package/generators/utils/project.d.ts

@@ -0,0 +1,10 @@
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Checks if index.html exists in Fiori project's custom webapp folder path.
+ *
+ * @param fs - the memfs editor instance
+ * @param path - the project path
+ * @returns true if index.html exists
+ */
+export declare function indexHtmlExists(fs: Editor, path: string): Promise<boolean>;
+//# sourceMappingURL=project.d.ts.map

package/generators/utils/project.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.indexHtmlExists = indexHtmlExists;
+const project_access_1 = require("@sap-ux/project-access");
+const path_1 = require("path");
+/**
+ * Checks if index.html exists in Fiori project's custom webapp folder path.
+ *
+ * @param fs - the memfs editor instance
+ * @param path - the project path
+ * @returns true if index.html exists
+ */
+async function indexHtmlExists(fs, path) {
+    const customWebappPath = await (0, project_access_1.getWebappPath)(path);
+    const indexHtmlPath = (0, path_1.join)(customWebappPath, 'index.html');
+    return fs.exists(indexHtmlPath);
+}
+//# sourceMappingURL=project.js.map

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@sap-ux/abap-deploy-config-sub-generator",
+  "description": "Sub generator for ABAP deployment configuration",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/abap-deploy-config-sub-generator"
+  },
+  "version": "0.0.1",
+  "license": "Apache-2.0",
+  "main": "generators/app/index.js",
+  "files": [
+    "LICENSE",
+    "generators",
+    "!generators/*.map",
+    "!generators/**/*.map"
+  ],
+  "engines": {
+    "node": ">=18.x"
+  },
+  "dependencies": {
+    "i18next": "23.5.1",
+    "@sap-devx/yeoman-ui-types": "1.14.4",
+    "@sap-ux/abap-deploy-config-inquirer": "1.1.9",
+    "@sap-ux/abap-deploy-config-writer": "0.0.68",
+    "@sap-ux/btp-utils": "0.17.1",
+    "@sap-ux/deploy-config-generator-shared": "0.0.5",
+    "@sap-ux/feature-toggle": "0.2.3",
+    "@sap-ux/fiori-generator-shared": "0.7.14",
+    "@sap-ux/logger": "0.6.0",
+    "@sap-ux/project-access": "1.28.9",
+    "@sap-ux/telemetry": "0.5.47",
+    "@sap-ux/ui5-config": "0.26.0"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "9.0.13",
+    "@types/mem-fs": "1.1.2",
+    "@types/mem-fs-editor": "7.0.1",
+    "@types/yeoman-test": "4.0.6",
+    "fs-extra": "10.0.0",
+    "memfs": "3.4.13",
+    "mem-fs-editor": "9.4.0",
+    "unionfs": "4.4.0",
+    "yeoman-test": "6.3.0",
+    "@sap-ux/store": "0.9.3",
+    "@sap-ux/system-access": "0.5.22"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "watch": "tsc --watch",
+    "clean": "rimraf --glob generators test/test-output coverage *.tsbuildinfo",
+    "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors",
+    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global"
+  }
+}