@sap-ux/flp-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,16 @@
+# @sap-ux/flp-config-sub-generator
+
+## Features
+
+The SAP Fiori Launchpad configuration sub-generator enables users to add Fiori launchpad configuration to SAP Fiori applications
+
+## Installation
+
+The SAP Fiori Launchpad 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 SAP Reuse Library sub-generator
+
+Open the Command Palette in MS Visual Studio Code ( CMD/CTRL + Shift + P ) and execute the Fiori: Add FLP Embedded Configuration.
+
+## Keywords
+SAP Fiori Generator

package/generators/app/index.d.ts

@@ -0,0 +1,54 @@
+import Generator from 'yeoman-generator';
+import type { FlpConfigOptions } from './types';
+/**
+ * FLP config generator adds an inbound navigation config to an existing manifest.json.
+ */
+export default class extends Generator {
+    private readonly appWizard;
+    private readonly vscode?;
+    private readonly launchFlpConfigAsSubGenerator;
+    private readonly existingApp;
+    private readonly appRootPath;
+    private readonly prompts;
+    private answers;
+    private abort;
+    private manifest;
+    private manifestPath;
+    options: FlpConfigOptions;
+    setPromptsCallback: (fn: object) => void;
+    /**
+     * Constructor for FLP config generator.
+     *
+     * @param args - arguments passed to the generator
+     * @param opts - options passed to the generator
+     */
+    constructor(args: string | string[], opts: FlpConfigOptions);
+    initializing(): Promise<void>;
+    prompting(): Promise<void>;
+    writing(): Promise<void>;
+    /**
+     * Updates the manifest and i18n files with the inbound config.
+     *
+     * @param inboundConfig - the inbound config
+     * @param inboundConfig.semanticObject - the semantic object
+     * @param inboundConfig.action - the action
+     * @param inboundConfig.title - the title
+     * @param inboundConfig.subTitle - the subtitle
+     * @returns a promise that resolves when the files have been updated
+     */
+    private _updateFiles;
+    /**
+     * Update the i18n file. If a i18n.properties file does not exits, it tries to create.
+     *
+     * @param manifestPath - path to manifest.json
+     * @param manifest - parsed content of manifest.json
+     * @param titles - the titles to be added to the i18n file
+     * @param titles.title - the title to be added to the i18n file
+     * @param titles.subTitle - the subtitle to be added to the i18n file
+     * @returns true if the i18n file was updated with the key/values
+     */
+    private _updateI18n;
+    end(): Promise<void>;
+}
+export type { FlpConfigOptions };
+//# sourceMappingURL=index.d.ts.map

package/generators/app/index.js

@@ -0,0 +1,217 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = require("path");
+const yeoman_generator_1 = __importDefault(require("yeoman-generator"));
+const logger_1 = __importDefault(require("../utils/logger"));
+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 flp_config_inquirer_1 = require("@sap-ux/flp-config-inquirer");
+const app_config_writer_1 = require("@sap-ux/app-config-writer");
+const project_access_1 = require("@sap-ux/project-access");
+const i18n_1 = require("@sap-ux/i18n");
+const feature_toggle_1 = require("@sap-ux/feature-toggle");
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const inquirer_common_1 = require("@sap-ux/inquirer-common");
+const constants_1 = require("../utils/constants");
+const utils_1 = require("../utils");
+const prompts_1 = require("../utils/prompts");
+const telemetryEvents_1 = require("../telemetryEvents");
+/**
+ * FLP config generator adds an inbound navigation config to an existing manifest.json.
+ */
+class default_1 extends yeoman_generator_1.default {
+    appWizard;
+    vscode;
+    launchFlpConfigAsSubGenerator;
+    existingApp;
+    appRootPath;
+    prompts;
+    answers;
+    abort = false;
+    manifest;
+    manifestPath;
+    options;
+    setPromptsCallback;
+    /**
+     * Constructor for FLP config generator.
+     *
+     * @param args - arguments passed to the generator
+     * @param opts - options passed to the generator
+     */
+    constructor(args, opts) {
+        super(args, opts);
+        this.appWizard = opts.appWizard ?? yeoman_ui_types_1.AppWizard.create(opts);
+        this.vscode = opts.vscode;
+        this.launchFlpConfigAsSubGenerator = opts.launchFlpConfigAsSubGenerator ?? false;
+        this.appRootPath = opts.data?.appRootPath ?? opts?.appRootPath ?? this.destinationRoot();
+        this.options = opts;
+        logger_1.default.configureLogging(this.options.logger, this.rootGeneratorName(), this.log, this.options.logWrapper, this.options.logLevel);
+        // If launched standalone, set the header, title and description
+        if (!this.launchFlpConfigAsSubGenerator) {
+            this.appWizard.setHeaderTitle(constants_1.generatorTitle);
+            this.prompts = new yeoman_ui_types_1.Prompts((0, prompts_1.getYUIDetails)(this.appRootPath));
+            this.setPromptsCallback = (fn) => {
+                if (this.prompts) {
+                    this.prompts.setCallback(fn);
+                }
+            };
+            this.existingApp = true; // generator is launched standalone so app must exist
+        }
+    }
+    async initializing() {
+        if (this.env.conflicter) {
+            this.env.conflicter.force = this.options.force ?? true;
+        }
+        await fiori_generator_shared_1.TelemetryHelper.initTelemetrySettings({
+            consumerModule: {
+                name: '@sap-ux/flp-config-sub-generator',
+                version: this.rootGeneratorVersion()
+            },
+            internalFeature: (0, feature_toggle_1.isInternalFeaturesSettingEnabled)(),
+            watchTelemetrySettingStore: false
+        });
+        if (this.existingApp) {
+            this.manifestPath = (0, path_1.join)(await (0, project_access_1.getWebappPath)(this.appRootPath), project_access_1.FileName.Manifest);
+            this.manifest = this.fs.readJSON(this.manifestPath);
+            if (!this.manifest) {
+                (0, deploy_config_generator_shared_1.handleErrorMessage)(this.appWizard, (0, utils_1.t)('error.noManifest', { path: this.manifestPath }));
+            }
+            if (!this.manifest['sap.app']) {
+                (0, deploy_config_generator_shared_1.handleErrorMessage)(this.appWizard, (0, utils_1.t)('error.sapNotDefined'));
+            }
+        }
+    }
+    async prompting() {
+        // FLP answers may already be provided. e.g. headless or LCAP flow.
+        if (this.launchFlpConfigAsSubGenerator &&
+            this.options.inboundConfig?.semanticObject !== undefined &&
+            this.options.inboundConfig?.action !== undefined &&
+            this.options.inboundConfig?.title !== undefined &&
+            this.options.skipPrompt) {
+            this.answers = {
+                overwrite: true,
+                semanticObject: this.options.inboundConfig.semanticObject,
+                action: this.options.inboundConfig.action,
+                title: this.options.inboundConfig.title,
+                subTitle: this.options.inboundConfig.subTitle
+            };
+            return;
+        }
+        // Get existing inbounds
+        let inbounds = {};
+        if (this.manifest?.['sap.app']?.crossNavigation?.inbounds) {
+            inbounds = this.manifest?.['sap.app']?.crossNavigation?.inbounds;
+        }
+        const silentOverwrite = this.options.overwrite;
+        let questions = (await (0, flp_config_inquirer_1.getPrompts)(inbounds, undefined, {
+            silentOverwrite,
+            inboundId: { hide: true },
+            emptyInboundsInfo: { hide: true },
+            additionalParameters: { hide: true },
+            createAnotherInbound: { hide: true }
+        }));
+        // Show specific prompt for config update when launched standalone or on CLI. Otherwise it should be handled by consuming generator in YUI.
+        if (((0, fiori_generator_shared_1.getHostEnvironment)() === fiori_generator_shared_1.hostEnvironment.cli || !this.options.launchFlpConfigAsSubGenerator) &&
+            this.options.data?.additionalPrompts?.confirmConfigUpdate?.show) {
+            const confirmConfigUpdatePrompts = (0, deploy_config_generator_shared_1.getConfirmConfigUpdatePrompt)(this.options.data.additionalPrompts.confirmConfigUpdate.configType);
+            questions = (0, inquirer_common_1.withCondition)(questions, (answers) => answers.confirmConfigUpate);
+            questions.unshift(...confirmConfigUpdatePrompts);
+        }
+        this.answers = {};
+        const answers = await this.prompt(questions);
+        if (answers.s4Continue === false || (answers.overwrite === false && !silentOverwrite)) {
+            this.abort = true;
+            process.exit(0); // only relevant for CLI
+        }
+        if (answers.subTitle === '') {
+            // '' (empty string) should be set as undefined
+            answers.subTitle = undefined;
+        }
+        Object.assign(this.answers, answers);
+    }
+    async writing() {
+        if (this.abort === false && this.existingApp) {
+            await this._updateFiles(this.answers);
+        }
+    }
+    /**
+     * Updates the manifest and i18n files with the inbound config.
+     *
+     * @param inboundConfig - the inbound config
+     * @param inboundConfig.semanticObject - the semantic object
+     * @param inboundConfig.action - the action
+     * @param inboundConfig.title - the title
+     * @param inboundConfig.subTitle - the subtitle
+     * @returns a promise that resolves when the files have been updated
+     */
+    async _updateFiles({ semanticObject, action, title, subTitle }) {
+        let keysAdded = false;
+        if (title) {
+            keysAdded = await this._updateI18n(this.manifestPath, this.manifest, {
+                title,
+                subTitle
+            });
+        }
+        await (0, app_config_writer_1.generateInboundNavigationConfig)(this.appRootPath, {
+            semanticObject,
+            action,
+            title: keysAdded ? `{{${constants_1.i18nKeyTitle}}}` : title,
+            subTitle: keysAdded && subTitle ? `{{${constants_1.i18nKeySubTitle}}}` : subTitle
+        }, true, this.fs);
+    }
+    /**
+     * Update the i18n file. If a i18n.properties file does not exits, it tries to create.
+     *
+     * @param manifestPath - path to manifest.json
+     * @param manifest - parsed content of manifest.json
+     * @param titles - the titles to be added to the i18n file
+     * @param titles.title - the title to be added to the i18n file
+     * @param titles.subTitle - the subtitle to be added to the i18n file
+     * @returns true if the i18n file was updated with the key/values
+     */
+    async _updateI18n(manifestPath, manifest, { title, subTitle }) {
+        let createProps = false;
+        const { 'sap.app': i18nPath } = await (0, project_access_1.getI18nPropertiesPaths)(manifestPath, manifest);
+        try {
+            const i18nEntries = [{ key: constants_1.i18nKeyTitle, value: title }];
+            if (subTitle) {
+                i18nEntries.push({ key: constants_1.i18nKeySubTitle, value: subTitle });
+            }
+            createProps = await (0, i18n_1.createPropertiesI18nEntries)(i18nPath, i18nEntries, this.appRootPath, this.fs);
+        }
+        catch (error) {
+            const errorMsg = (0, utils_1.t)('warning.updatei18n', { path: i18nPath });
+            this.appWizard.showWarning(errorMsg, yeoman_ui_types_1.MessageType.notification);
+            logger_1.default.logger?.error(errorMsg);
+        }
+        return createProps;
+    }
+    async end() {
+        // The app would not have been generated until after the writing phase due to the current ordering of the composeWith from Fiori generators
+        if (this.abort === false && !this.existingApp) {
+            this.manifestPath = (0, path_1.join)(await (0, project_access_1.getWebappPath)(this.appRootPath), project_access_1.FileName.Manifest);
+            this.manifest = this.fs.readJSON(this.manifestPath);
+            await this._updateFiles(this.answers);
+        }
+        try {
+            if (!this.options.launchFlpConfigAsSubGenerator &&
+                (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);
+            }
+            (0, fiori_generator_shared_1.sendTelemetry)(telemetryEvents_1.EventName.GENERATION_SUCCESS, fiori_generator_shared_1.TelemetryHelper.createTelemetryData({
+                appType: 'flp-config',
+                ...this.options.telemetryData
+            }) ?? {}).catch((error) => {
+                logger_1.default.logger.error((0, utils_1.t)('error.telemetry', { error }));
+            });
+        }
+        catch (error) {
+            logger_1.default.logger?.error((0, utils_1.t)('error.endPhase', { error }));
+        }
+    }
+}
+exports.default = default_1;
+//# sourceMappingURL=index.js.map

package/generators/app/types.d.ts

@@ -0,0 +1,74 @@
+import type Generator from 'yeoman-generator';
+import type { AppWizard } from '@sap-devx/yeoman-ui-types';
+import type { VSCodeInstance, TelemetryData, LogWrapper } from '@sap-ux/fiori-generator-shared';
+import type { ManifestNamespace } from '@sap-ux/project-access';
+export interface FlpConfigOptions extends Generator.GeneratorOptions {
+    /**
+     * VSCode instance
+     */
+    vscode?: VSCodeInstance;
+    /**
+     * AppWizard instance
+     */
+    appWizard?: AppWizard;
+    /**
+     * Whether the generator is launched as a subgenerator
+     */
+    launchFlpConfigAsSubGenerator?: boolean;
+    /**
+     * Path to the application root where the Fiori launchpad configuration will be added.
+     */
+    appRootPath?: string;
+    /**
+     * Skips the prompting phase
+     */
+    skipPrompt?: boolean;
+    /**
+     * FLP configuration answers
+     */
+    inboundConfig: Partial<ManifestNamespace.Inbound[string]>;
+    /**
+     * 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;
+    /**
+     * Option to overwrite existing configuration without prompting
+     */
+    overwrite?: boolean;
+    /**
+     * Data which may be passed from external sources e.g extensions like Application modeler
+     */
+    data?: {
+        /**
+         * Path to the application root where the Fiori launchpad configuration will be added.
+         */
+        appRootPath?: string;
+        /**
+         * Config for additional prompts
+         */
+        additionalPrompts?: {
+            /**
+             * Prompt to confirm the the update of non-productive configurations as they are centrally managed as part of the CI pipeline.
+             */
+            confirmConfigUpdate?: {
+                /**
+                 * Whether the prompt should be shown.
+                 */
+                show?: boolean;
+                /**
+                 * The type of configuration being updated. This will be added to the start of the prompt message.
+                 */
+                configType?: string;
+            };
+        };
+    };
+    /**
+     * Logger instance
+     */
+    logWrapper?: LogWrapper;
+}
+//# 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 FLP config generator
+ */
+export declare enum EventName {
+    GENERATION_SUCCESS = "GENERATION_SUCCESS"
+}
+//# 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 FLP config generator
+ */
+var EventName;
+(function (EventName) {
+    EventName["GENERATION_SUCCESS"] = "GENERATION_SUCCESS";
+})(EventName || (exports.EventName = EventName = {}));
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,14 @@
+{
+    "error": {
+        "endPhase": "Error end phase deployment-generator:flp: {{- error}}",
+        "telemetry": "Failed to send telemetry data after FLP configuration has been added. {{- error}}",
+        "noManifest": "Manifest not found at path: {{- path}}",
+        "sapNotDefined": "Manifest is missing required section 'sap.app'"
+    },
+    "warning": {
+        "updatei18n": "Cannot update i18n properties file: {{- path}}"
+    },
+    "info": {
+        "filesGenerated": "The files have been generated."
+    }
+}

package/generators/utils/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const i18nKeyTitle = "flpTitle";
+export declare const i18nKeySubTitle = "flpSubtitle";
+export declare const generatorTitle = "Fiori Launchpad Configuration Generator";
+//# sourceMappingURL=constants.d.ts.map

package/generators/utils/constants.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generatorTitle = exports.i18nKeySubTitle = exports.i18nKeyTitle = void 0;
+exports.i18nKeyTitle = 'flpTitle';
+exports.i18nKeySubTitle = 'flpSubtitle';
+exports.generatorTitle = 'Fiori Launchpad Configuration Generator';
+//# sourceMappingURL=constants.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,34 @@
+"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 flp_config_sub_generator_i18n_json_1 = __importDefault(require("../translations/flp-config-sub-generator.i18n.json"));
+const ui5LibGeneratorNs = 'ui5-lib-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', ui5LibGeneratorNs, flp_config_sub_generator_i18n_json_1.default));
+}
+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: ui5LibGeneratorNs });
+    }
+    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,2 @@
+export * from './i18n';
+//# sourceMappingURL=index.d.ts.map

package/generators/utils/index.js

@@ -0,0 +1,18 @@
+"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("./i18n"), exports);
+//# sourceMappingURL=index.js.map

package/generators/utils/logger.d.ts

@@ -0,0 +1,32 @@
+import { 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 FlpGenLogger {
+    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
+     */
+    static configureLogging(vscLogger: IVSCodeExtLogger, loggerName: string, yoLogger: Logger, vscode?: unknown, logLevel?: LogLevel): void;
+}
+//# sourceMappingURL=logger.d.ts.map

package/generators/utils/logger.js

@@ -0,0 +1,40 @@
+"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 FlpGenLogger {
+    static _logger = fiori_generator_shared_1.DefaultLogger;
+    /**
+     * Get the logger.
+     *
+     * @returns the logger
+     */
+    static get logger() {
+        return FlpGenLogger._logger;
+    }
+    /**
+     * Set the logger.
+     *
+     * @param value the logger to set
+     */
+    static set logger(value) {
+        FlpGenLogger._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
+     */
+    static configureLogging(vscLogger, loggerName, yoLogger, vscode, logLevel) {
+        const logWrapper = new fiori_generator_shared_1.LogWrapper(loggerName, yoLogger, logLevel, vscLogger, vscode);
+        FlpGenLogger.logger = logWrapper;
+    }
+}
+exports.default = FlpGenLogger;
+//# sourceMappingURL=logger.js.map

package/generators/utils/prompts.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Returns the details for the YUI prompt.
+ *
+ * @param appRootPath - path to the application to be displayed in YUI step description
+ * @returns step details
+ */
+export declare function getYUIDetails(appRootPath: string): {
+    name: string;
+    description: string;
+}[];
+//# sourceMappingURL=prompts.d.ts.map

package/generators/utils/prompts.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getYUIDetails = void 0;
+const path_1 = require("path");
+/**
+ * Returns the details for the YUI prompt.
+ *
+ * @param appRootPath - path to the application to be displayed in YUI step description
+ * @returns step details
+ */
+function getYUIDetails(appRootPath) {
+    return [
+        {
+            name: 'Fiori Launchpad Configuration',
+            description: `Configure Fiori Launchpad settings - ${(0, path_1.basename)(appRootPath)}`
+        }
+    ];
+}
+exports.getYUIDetails = getYUIDetails;
+//# sourceMappingURL=prompts.js.map

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@sap-ux/flp-config-sub-generator",
+  "description": "Generator for creating Fiori Launcpad configuration",
+  "version": "0.0.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/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",
+    "inquirer": "8.2.6",
+    "yeoman-generator": "5.10.0",
+    "@sap-ux/app-config-writer": "0.5.9",
+    "@sap-ux/deploy-config-generator-shared": "0.0.9",
+    "@sap-ux/feature-toggle": "0.2.3",
+    "@sap-ux/fiori-generator-shared": "0.7.18",
+    "@sap-ux/flp-config-inquirer": "0.2.6",
+    "@sap-ux/i18n": "0.2.0",
+    "@sap-ux/inquirer-common": "0.6.1",
+    "@sap-ux/project-access": "1.28.10"
+  },
+  "devDependencies": {
+    "@jest/types": "29.6.3",
+    "@types/inquirer": "8.2.6",
+    "@types/mem-fs": "1.1.2",
+    "@types/mem-fs-editor": "7.0.1",
+    "@types/yeoman-generator": "5.2.11",
+    "@types/yeoman-environment": "2.10.11",
+    "@types/yeoman-test": "4.0.6",
+    "@vscode-logging/logger": "2.0.0",
+    "memfs": "3.4.13",
+    "mem-fs-editor": "9.4.0",
+    "lodash": "4.17.21",
+    "@types/lodash": "4.14.202",
+    "rimraf": "5.0.5",
+    "typescript": "5.3.3",
+    "unionfs": "4.4.0",
+    "yeoman-test": "6.3.0",
+    "@sap-ux/nodejs-utils": "0.1.4"
+  },
+  "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"
+  }
+}