@sap-ux/adp-flp-config-sub-generator 0.0.2

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,20 @@
+# @sap-ux/adp-flp-config-sub-generator
+
+## Features
+
+The SAP Adaptation Project FLP sub-generator enables users to create a FLP configuration for an Adaptation Project.
+
+## Installation
+
+The SAP Adaptation Project FLP Configuration sub-generator is included in the [@sap/generator-fiori](https://www.npmjs.com/package/@sap/generator-fiori) generator and cannot be used independently. Additionally, it requires the [SAP Fiori Tools Extension](https://marketplace.visualstudio.com/items?itemName=SAPSE.sap-ux-fiori-tools-extension-pack) pack from the VSCode marketplace.
+
+
+## Launch the SAP Reference Library sub-generator
+
+Open the Command Palette in MS Visual Studio Code ( CMD/CTRL + Shift + P ) and execute the Fiori: Adaptation Project FLP configuration command.
+
+
+## Keywords
+SAP Fiori Elements
+Yeoman
+Generator

package/generators/app/index.d.ts

@@ -0,0 +1,94 @@
+import type { FlpConfigOptions } from './types';
+import Generator from 'yeoman-generator';
+/**
+ * Generator for adding a FLP configuration to an adaptation project.
+ *
+ * @extends Generator
+ */
+export default class extends Generator {
+    setPromptsCallback: (fn: object) => void;
+    private prompts;
+    private readonly launchAsSubGen;
+    private readonly appWizard;
+    private readonly vscode;
+    private readonly toolsLogger;
+    private readonly projectRootPath;
+    private manifest;
+    private answers;
+    private logger;
+    private authenticationRequired;
+    private abort;
+    private configuredSystem;
+    private ui5Yaml;
+    private credentials;
+    /**
+     * Creates an instance of the generator.
+     *
+     * @param {string | string[]} args - The arguments passed to the generator.
+     * @param {FlpConfigOptions} opts - The options for the generator.
+     */
+    constructor(args: string | string[], opts: FlpConfigOptions);
+    initializing(): Promise<void>;
+    prompting(): Promise<void>;
+    writing(): Promise<void>;
+    end(): void;
+    /**
+     * Retrieves the merged manifest for the project.
+     *
+     * @returns {Promise<Manifest>} The project manifest.
+     */
+    private _getManifest;
+    /**
+     * Prompts the user for authentication credentials.
+     *
+     * @returns {void}
+     */
+    private _promptAuthentication;
+    /**
+     * Handles errors that occur during the fetching of the manifest.
+     *
+     * @param {Error | AxiosError} error - The error that occurred.
+     */
+    private _handleFetchingError;
+    /**
+     * Adds navigations steps and callback function for the generator prompts.
+     */
+    private _setupFLPConfigPage;
+    /**
+     * Sets up the prompts for the generator.
+     */
+    private _setupPrompts;
+    /**
+     * Finds the configured system based on the provided target in ui5.yaml configuration.
+     *
+     * @param {AbapTarget} target - The target ABAP system.
+     * @returns {Promise<string>} The configured system.
+     */
+    private _findConfiguredSystem;
+    /**
+     * Shows an error notification with the provided message and aborts the generator execution.
+     *
+     * @param {string} message - The error message to display.
+     */
+    private _abortExecution;
+    /**
+     * Retrieves the error handler message for the provided error.
+     *
+     * @param {Error | AxiosError} error - The error to handle.
+     * @returns {ValidationLink | string | undefined} The validation link or error message.
+     */
+    private _getErrorHandlerMessage;
+    /**
+     * Checks if authentication is required based on the provided error.
+     *
+     * @param {Error | AxiosError} error - The error to check.
+     * @returns {boolean} True if authentication is required, false otherwise.
+     */
+    private _checkAuthRequired;
+    /**
+     * Configures logging for the generator.
+     */
+    private _setupLogging;
+}
+export type { FlpConfigOptions };
+//# sourceMappingURL=index.d.ts.map

package/generators/app/index.js

@@ -0,0 +1,345 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const yeoman_generator_1 = __importDefault(require("yeoman-generator"));
+const path_1 = __importStar(require("path"));
+const axios_extension_1 = require("@sap-ux/axios-extension");
+const adp_tooling_1 = require("@sap-ux/adp-tooling");
+const logger_1 = require("@sap-ux/logger");
+const telemetryEvents_1 = require("../telemetryEvents");
+const flp_config_inquirer_1 = require("@sap-ux/flp-config-inquirer");
+const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const feature_toggle_1 = require("@sap-ux/feature-toggle");
+const project_access_1 = require("@sap-ux/project-access");
+const logger_2 = __importDefault(require("../utils/logger"));
+const i18n_1 = require("../utils/i18n");
+const inquirer_common_1 = require("@sap-ux/inquirer-common");
+const system_access_1 = require("@sap-ux/system-access");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+/**
+ * Generator for adding a FLP configuration to an adaptation project.
+ *
+ * @extends Generator
+ */
+class default_1 extends yeoman_generator_1.default {
+    setPromptsCallback;
+    prompts;
+    // Flag to determine if the generator was launched as a sub-generator or standalone
+    launchAsSubGen;
+    appWizard;
+    vscode;
+    toolsLogger;
+    projectRootPath = '';
+    manifest;
+    answers;
+    logger;
+    authenticationRequired = false;
+    // Flag to determine if the generator was aborted
+    abort = false;
+    configuredSystem;
+    ui5Yaml;
+    credentials;
+    /**
+     * Creates an instance of the generator.
+     *
+     * @param {string | string[]} args - The arguments passed to the generator.
+     * @param {FlpConfigOptions} opts - The options for the generator.
+     */
+    constructor(args, opts) {
+        super(args, opts);
+        this.appWizard = opts.appWizard ?? yeoman_ui_types_1.AppWizard.create(opts);
+        this.launchAsSubGen = !!opts.launchAsSubGen;
+        this.manifest = opts.manifest;
+        this.toolsLogger = new logger_1.ToolsLogger();
+        this.projectRootPath = opts.data?.projectRootPath ?? this.destinationRoot();
+        this.options = opts;
+        this.vscode = opts.vscode;
+        this._setupPrompts();
+        this._setupLogging();
+    }
+    async initializing() {
+        await (0, i18n_1.initI18n)();
+        // Check if the project is supported
+        if ((await (0, project_access_1.getAppType)(this.projectRootPath)) !== 'Fiori Adaptation' || (0, adp_tooling_1.isCFEnvironment)(this.projectRootPath)) {
+            throw new Error((0, i18n_1.t)('error.projectNotSupported'));
+        }
+        // Force the generator to overwrite existing files without additional prompting
+        if (this.env.conflicter) {
+            this.env.conflicter.force = this.options.force ?? true;
+        }
+        this._setupFLPConfigPage();
+        this.ui5Yaml = await (0, adp_tooling_1.getAdpConfig)(this.projectRootPath, (0, path_1.join)(this.projectRootPath, project_access_1.FileName.Ui5Yaml));
+        this.configuredSystem = await this._findConfiguredSystem(this.ui5Yaml.target);
+        if (!this.configuredSystem) {
+            return;
+        }
+        if (!this.manifest) {
+            try {
+                this.manifest = await this._getManifest();
+            }
+            catch (error) {
+                this.authenticationRequired = this._checkAuthRequired(error);
+                if (this.authenticationRequired) {
+                    return;
+                }
+                this._handleFetchingError(error);
+            }
+        }
+        // Add telemetry to be sent once adp-flp-config is generated
+        await fiori_generator_shared_1.TelemetryHelper.initTelemetrySettings({
+            consumerModule: {
+                name: '@sap/generator-fiori-deployment:adp-flp-config',
+                version: this.rootGeneratorVersion()
+            },
+            internalFeature: (0, feature_toggle_1.isInternalFeaturesSettingEnabled)(),
+            watchTelemetrySettingStore: false
+        });
+    }
+    async prompting() {
+        if (this.authenticationRequired) {
+            await this._promptAuthentication();
+        }
+        if (this.abort) {
+            return;
+        }
+        const inbounds = (0, adp_tooling_1.getInboundsFromManifest)(this.manifest);
+        const appId = (0, adp_tooling_1.getRegistrationIdFromManifest)(this.manifest);
+        const prompts = await (0, flp_config_inquirer_1.getPrompts)(inbounds, appId, {
+            overwrite: { hide: true },
+            createAnotherInbound: { hide: true },
+            emptyInboundsInfo: { hide: (0, fiori_generator_shared_1.isCli)() }
+        });
+        this.answers = await this.prompt(prompts);
+    }
+    async writing() {
+        if (this.abort) {
+            return;
+        }
+        try {
+            await (0, adp_tooling_1.generateInboundConfig)(this.projectRootPath, this.answers, this.fs);
+        }
+        catch (error) {
+            this.logger.error(`Writing phase failed: ${error}`);
+            throw new Error((0, i18n_1.t)('error.updatingApp'));
+        }
+    }
+    end() {
+        if (this.abort) {
+            return;
+        }
+        if (!this.launchAsSubGen) {
+            this.appWizard?.showInformation((0, i18n_1.t)('info.flpConfigAdded'), yeoman_ui_types_1.MessageType.notification);
+        }
+        const telemetryData = fiori_generator_shared_1.TelemetryHelper.createTelemetryData({
+            appType: 'adp-flp-config',
+            ...this.options.telemetryData
+        }) ?? {};
+        if (telemetryData) {
+            (0, fiori_generator_shared_1.sendTelemetry)(telemetryEvents_1.EventName.ADP_FLP_CONFIG_ADDED, telemetryData, this.projectRootPath).catch((error) => {
+                this.logger.error((0, i18n_1.t)('error.telemetry', { error }));
+            });
+        }
+    }
+    /**
+     * Retrieves the merged manifest for the project.
+     *
+     * @returns {Promise<Manifest>} The project manifest.
+     */
+    async _getManifest() {
+        const { target, ignoreCertErrors = false } = this.ui5Yaml;
+        const requestOptions = { ignoreCertErrors };
+        if (this.credentials) {
+            requestOptions['auth'] = { username: this.credentials.username, password: this.credentials.password };
+        }
+        const provider = await (0, system_access_1.createAbapServiceProvider)(target, requestOptions, false, this.toolsLogger);
+        const variant = (0, adp_tooling_1.getVariant)(this.projectRootPath);
+        const manifestService = await adp_tooling_1.ManifestService.initMergedManifest(provider, this.projectRootPath, variant, this.toolsLogger);
+        return manifestService.getManifest();
+    }
+    /**
+     * Prompts the user for authentication credentials.
+     *
+     * @returns {void}
+     */
+    async _promptAuthentication() {
+        const prompts = await (0, inquirer_common_1.getCredentialsPrompts)(async (credentials) => {
+            this.credentials = credentials;
+            try {
+                this.manifest = await this._getManifest();
+            }
+            catch (error) {
+                if (!(0, axios_extension_1.isAxiosError)(error)) {
+                    this.logger.error(`Manifest fetching failed: ${error}`);
+                    throw new Error((0, i18n_1.t)('error.fetchingManifest'));
+                }
+                this.authenticationRequired = this._checkAuthRequired(error);
+                if (this.authenticationRequired) {
+                    return (0, i18n_1.t)('error.authenticationFailed');
+                }
+                return this._getErrorHandlerMessage(error) ?? false;
+            }
+            return true;
+        });
+        this.prompts.splice(0, 0, [
+            {
+                name: (0, i18n_1.t)('yuiNavSteps.flpCredentialsName'),
+                description: (0, i18n_1.t)('yuiNavSteps.flpCredentialsDesc', { system: this.configuredSystem })
+            }
+        ]);
+        await this.prompt(prompts);
+    }
+    /**
+     * Handles errors that occur during the fetching of the manifest.
+     *
+     * @param {Error | AxiosError} error - The error that occurred.
+     */
+    _handleFetchingError(error) {
+        if ((0, axios_extension_1.isAxiosError)(error)) {
+            this.logger.error(`Manifest fetching failed: ${error}. Status: ${error.response?.status}. URI: ${error.request?.path}`);
+            const errorHelp = this._getErrorHandlerMessage(error);
+            if (errorHelp) {
+                this._abortExecution(typeof errorHelp === 'string'
+                    ? errorHelp
+                    : `${errorHelp?.message} ([${errorHelp.link.text}](${errorHelp.link.url}))`);
+            }
+            return;
+        }
+        this.logger.error(`Manifest fetching failed: ${error}`);
+        throw new Error((0, i18n_1.t)('error.fetchingManifest'));
+    }
+    /**
+     * Adds navigations steps and callback function for the generator prompts.
+     */
+    _setupFLPConfigPage() {
+        // if launched as a sub-generator, the navigation steps will be set by the parent generator
+        if (!this.launchAsSubGen) {
+            this.prompts.splice(0, 0, [
+                {
+                    name: (0, i18n_1.t)('yuiNavSteps.flpConfigName'),
+                    description: (0, i18n_1.t)('yuiNavSteps.flpConfigDesc', { projectName: path_1.default.basename(this.projectRootPath) })
+                }
+            ]);
+        }
+    }
+    /**
+     * Sets up the prompts for the generator.
+     */
+    _setupPrompts() {
+        // If launched as a sub-generator, the prompts will be set by the parent generator
+        if (!this.launchAsSubGen) {
+            this.prompts = new yeoman_ui_types_1.Prompts([]);
+            this.setPromptsCallback = (fn) => {
+                if (this.prompts) {
+                    this.prompts.setCallback(fn);
+                }
+            };
+        }
+    }
+    /**
+     * Finds the configured system based on the provided target in ui5.yaml configuration.
+     *
+     * @param {AbapTarget} target - The target ABAP system.
+     * @returns {Promise<string>} The configured system.
+     */
+    async _findConfiguredSystem(target) {
+        let configuredSystem;
+        if ((0, btp_utils_1.isAppStudio)()) {
+            configuredSystem = target?.destination;
+            if (!configuredSystem) {
+                this._abortExecution((0, i18n_1.t)('error.destinationNotFound'));
+                return;
+            }
+            const destinations = await (0, btp_utils_1.listDestinations)();
+            if (!(configuredSystem in destinations)) {
+                this._abortExecution((0, i18n_1.t)('error.destinationNotFoundInStore', { destination: configuredSystem }));
+                return;
+            }
+        }
+        else {
+            const url = target?.url;
+            if (!url) {
+                this._abortExecution((0, i18n_1.t)('error.systemNotFound'));
+                return;
+            }
+            configuredSystem = (await (0, system_access_1.getCredentialsFromStore)(target, this.toolsLogger))?.name;
+            if (!configuredSystem) {
+                this._abortExecution((0, i18n_1.t)('error.systemNotFoundInStore', { systemUrl: url }));
+                return;
+            }
+        }
+        return configuredSystem;
+    }
+    /**
+     * Shows an error notification with the provided message and aborts the generator execution.
+     *
+     * @param {string} message - The error message to display.
+     */
+    _abortExecution(message) {
+        if ((0, fiori_generator_shared_1.isCli)()) {
+            this.toolsLogger.error(message);
+        }
+        else {
+            this.vscode.window.showErrorMessage(message);
+        }
+        this.abort = true;
+    }
+    /**
+     * Retrieves the error handler message for the provided error.
+     *
+     * @param {Error | AxiosError} error - The error to handle.
+     * @returns {ValidationLink | string | undefined} The validation link or error message.
+     */
+    _getErrorHandlerMessage(error) {
+        const errorHandler = new inquirer_common_1.ErrorHandler();
+        return errorHandler.getValidationErrorHelp(error);
+    }
+    /**
+     * Checks if authentication is required based on the provided error.
+     *
+     * @param {Error | AxiosError} error - The error to check.
+     * @returns {boolean} True if authentication is required, false otherwise.
+     */
+    _checkAuthRequired(error) {
+        if ((0, axios_extension_1.isAxiosError)(error)) {
+            if (error.response?.status === 401) {
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * Configures logging for the generator.
+     */
+    _setupLogging() {
+        logger_2.default.configureLogging(this.options.logger, this.rootGeneratorName(), this.log, this.options.vscode, this.options.logLevel, this.options.logWrapper);
+        this.logger = logger_2.default.logger;
+    }
+}
+exports.default = default_1;
+//# sourceMappingURL=index.js.map

package/generators/app/types.d.ts

@@ -0,0 +1,37 @@
+import type { AppWizard } from '@sap-devx/yeoman-ui-types';
+import type { Manifest } from '@sap-ux/project-access';
+import type Generator from 'yeoman-generator';
+import type { TelemetryData } from '@sap-ux/fiori-generator-shared';
+export interface FlpConfigOptions extends Generator.GeneratorOptions {
+    /**
+     * VSCode instance
+     */
+    vscode?: unknown;
+    /**
+     * Option to force the conflicter property of the yeoman environment (prevents additional prompt for overwriting files)
+     */
+    force?: boolean;
+    /**
+     * AppWizard instance
+     */
+    appWizard?: AppWizard;
+    /**
+     * Whether the generator is launched as a subgenerator
+     */
+    launchAsSubGen?: boolean;
+    /**
+     * The manifest of the base application
+     */
+    manifest: Manifest;
+    /**
+     * Telemetry data to be send after deployment configuration has been added
+     */
+    telemetryData?: TelemetryData;
+    /**
+     * Additional data for the generator
+     */
+    data?: {
+        projectRootPath: string;
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/generators/app/types.js

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

package/generators/telemetryEvents/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Event names for telemetry for the adaptation project fiori launchpad configuration generator
+ */
+export declare enum EventName {
+    ADP_FLP_CONFIG_ADDED = "ADP_FLP_CONFIG_ADDED"
+}
+//# 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 adaptation project fiori launchpad configuration generator
+ */
+var EventName;
+(function (EventName) {
+    EventName["ADP_FLP_CONFIG_ADDED"] = "ADP_FLP_CONFIG_ADDED";
+})(EventName || (exports.EventName = EventName = {}));
+//# sourceMappingURL=index.js.map

package/generators/translations/adp-flp-config-sub-generator.i18n.json

@@ -0,0 +1,24 @@
+{
+    "yuiNavSteps": {
+        "flpCredentialsName": "FLP Configuration - Credentials",
+        "flpCredentialsDesc": "Enter credentials for your adaptation project's system ({{- system}})",
+        "sysConfirmDesc": "Validates connection to configured system",
+        "flpConfigName": "FLP Configuration",
+        "flpConfigDesc": "FLP Configuration for {{- projectName}}"
+    },
+    "info": {
+        "flpConfigAdded": "FLP Configuration added successfully"
+    },
+    "error": {
+        "projectNotSupported": "Unable to find a supported adaptation project",
+        "fetchingManifest": "Error fetching merged manifest for base application",
+        "destinationNotFound": "Missing destination configuration in ui5.yaml",
+        "destinationNotInSubaccount": "Destination not found in the subaccount: {{- destination}}",
+        "systemNotFound": "Missing system configuration in ui5.yaml",
+        "systemNotFoundInStore": "System not found in the system store: {{- systemUrl}}",
+        "writingPhase": "Error in writing phase of the adaptation project FLP configuration",
+        "telemetry": "Error sending telemetry data: {{- error}}",
+        "updatingApp": "Error updating app with FLP configuration. Inspect the logs for full error.",
+        "authenticationFailed": "Authentication failed."
+    }
+}

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 adp_flp_config_sub_generator_i18n_json_1 = __importDefault(require("../translations/adp-flp-config-sub-generator.i18n.json"));
+const inquirer_common_1 = require("@sap-ux/inquirer-common");
+const adpFlpConfigI18nNamespace = 'adp-flp-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', adpFlpConfigI18nNamespace, adp_flp_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: adpFlpConfigI18nNamespace });
+    }
+    return i18next_1.default.t(key, options);
+}
+exports.t = t;
+initI18n().catch(() => {
+    // Needed for lint
+});
+//# sourceMappingURL=i18n.js.map

package/generators/utils/logger.d.ts

@@ -0,0 +1,33 @@
+import { LogWrapper, type ILogWrapper } from '@sap-ux/fiori-generator-shared';
+import type { Logger } from 'yeoman-environment';
+import type { IVSCodeExtLogger, LogLevel } from '@vscode-logging/logger';
+/**
+ * Static logger prevents passing of logger references through all functions, as this is a cross-cutting concern.
+ */
+export default class AdpFlpConfigLogger {
+    private static _logger;
+    /**
+     * Get the logger.
+     *
+     * @returns the logger
+     */
+    static get logger(): ILogWrapper;
+    /**
+     * Set the logger.
+     *
+     * @param value the logger to set
+     */
+    static set logger(value: ILogWrapper);
+    /**
+     * Configures the vscode logger.
+     *
+     * @param vscLogger - the vscode logger
+     * @param loggerName - the logger name
+     * @param yoLogger - the yeoman logger
+     * @param vscode - the vscode instance
+     * @param logLevel - the log level
+     * @param logWrapper - log wrapper instance
+     */
+    static configureLogging(vscLogger: IVSCodeExtLogger, loggerName: string, yoLogger: Logger, vscode?: unknown, logLevel?: LogLevel, logWrapper?: LogWrapper): void;
+}
+//# sourceMappingURL=logger.d.ts.map

package/generators/utils/logger.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+/**
+ * Static logger prevents passing of logger references through all functions, as this is a cross-cutting concern.
+ */
+class AdpFlpConfigLogger {
+    static _logger = fiori_generator_shared_1.DefaultLogger;
+    /**
+     * Get the logger.
+     *
+     * @returns the logger
+     */
+    static get logger() {
+        return AdpFlpConfigLogger._logger;
+    }
+    /**
+     * Set the logger.
+     *
+     * @param value the logger to set
+     */
+    static set logger(value) {
+        AdpFlpConfigLogger._logger = value;
+    }
+    /**
+     * Configures the vscode logger.
+     *
+     * @param vscLogger - the vscode logger
+     * @param loggerName - the logger name
+     * @param yoLogger - the yeoman logger
+     * @param vscode - the vscode instance
+     * @param logLevel - the log level
+     * @param logWrapper - log wrapper instance
+     */
+    static configureLogging(vscLogger, loggerName, yoLogger, vscode, logLevel, logWrapper) {
+        const logger = logWrapper ?? new fiori_generator_shared_1.LogWrapper(loggerName, yoLogger, logLevel, vscLogger, vscode);
+        AdpFlpConfigLogger.logger = logger;
+    }
+}
+exports.default = AdpFlpConfigLogger;
+//# sourceMappingURL=logger.js.map

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@sap-ux/adp-flp-config-sub-generator",
+  "description": "Generator for adding FLP configuration to an Adaptation Project",
+  "version": "0.0.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/adp-flp-config-sub-generator"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue"
+  },
+  "license": "Apache-2.0",
+  "main": "generators/app/index.js",
+  "files": [
+    "LICENSE",
+    "generators",
+    "!generators/*.map",
+    "!generators/**/*.map"
+  ],
+  "dependencies": {
+    "@sap-devx/yeoman-ui-types": "1.14.4",
+    "i18next": "23.5.1",
+    "yeoman-generator": "5.10.0",
+    "@sap-ux/adp-tooling": "0.12.125",
+    "@sap-ux/axios-extension": "1.18.5",
+    "@sap-ux/btp-utils": "1.0.1",
+    "@sap-ux/feature-toggle": "0.2.3",
+    "@sap-ux/fiori-generator-shared": "0.7.27",
+    "@sap-ux/flp-config-inquirer": "0.2.31",
+    "@sap-ux/inquirer-common": "0.6.14",
+    "@sap-ux/logger": "0.6.0",
+    "@sap-ux/project-access": "1.29.5",
+    "@sap-ux/store": "1.0.0",
+    "@sap-ux/system-access": "0.5.30"
+  },
+  "devDependencies": {
+    "@jest/types": "29.6.3",
+    "@types/fs-extra": "9.0.13",
+    "@types/inquirer": "8.2.6",
+    "@types/vscode": "1.73.1",
+    "@types/yeoman-environment": "2.10.11",
+    "@types/yeoman-generator": "5.2.11",
+    "@types/yeoman-test": "4.0.6",
+    "@vscode-logging/logger": "2.0.0",
+    "fs-extra": "10.0.0",
+    "rimraf": "5.0.5",
+    "typescript": "5.3.3",
+    "yeoman-test": "6.3.0"
+  },
+  "engines": {
+    "node": ">=18.x"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rimraf --glob generators test/test-output coverage *.tsbuildinfo",
+    "watch": "tsc --watch",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
+    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global"
+  }
+}