@sap-ux/flp-config-inquirer 0.1.0

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,85 @@
+# @sap-ux/flp-config-inquirer
+
+Provides Inquirer-based prompting to allow input and validation of data required to generate an **FLP** (*Fiori Launchpad*) configuration.
+
+## Installation
+
+Npm
+`npm install --save @sap-ux/flp-config-inquirer`
+
+Yarn
+`yarn add @sap-ux/flp-config-inquirer`
+
+Pnpm
+`pnpm add @sap-ux/flp-config-inquirer`
+
+## Explainer
+
+The `@sap-ux/flp-config-inquirer` package provides a set of prompts for collecting user input required to generate FLP configuration. It leverages [Inquirer.js](https://www.npmjs.com/package/inquirer) for interactive command-line user interfaces.
+
+You can retrieve the prompts using `getPrompts` and execute them with your own prompting mechanism. However, it is recommended to use the `prompt` function, which handles assigning default values to unanswered prompts based on provided prompt options. This ensures that hidden prompts or those not executed due to conditional logic are correctly populated.
+
+Configurability of prompts is entirely controlled using the `FLPConfigPromptOptions` parameter.
+
+- **Prompt Options**: Use `FLPConfigPromptOptions` to customize prompts, such as setting default values, hiding prompts, or adding validation.
+- **Defaults Handling**: When prompts are hidden or not executed, default values or functions can be provided to ensure all required answers are available.
+- **Conditional Prompts**: Some prompts may be conditionally displayed based on previous answers. The `prompt` function handles these conditions and default assignments.
+
+### Inquirer usage example:
+
+In the following example, the prompts are customized as follows:
+
+- Sets a default `semanticObject` of `'MySemanticObject'`.
+- Sets a default `action` of `'display'`.
+- Hides the `title` prompt and provides a default value of `'My Application Title'`.
+
+```ts
+import { prompt, promptNames, type FLPConfigPromptOptions, type FLPConfigAnswers } from '@sap-ux/flp-config-inquirer';
+import { type InquirerAdapter } from '@sap-ux/inquirer-common';
+import inquirer from 'inquirer';
+
+const promptOptions: FLPConfigPromptOptions = {
+    // Provides a default semantic object
+    [promptNames.semanticObject]: {
+        default: 'MySemanticObject'
+    },
+    // Provides a default action
+    [promptNames.action]: {
+        default: 'display'
+    },
+    // Hide the title prompt and provide a default value
+    [promptNames.title]: {
+        hide: true,
+        default: 'My Application Title'
+    }
+};
+
+const inquirerAdapter: InquirerAdapter = {
+    prompt: inquirer.prompt
+};
+
+// Assume there are no existing inbound keys
+const inboundKeys: string[] = [];
+
+// flpConfigAnswers will contain all values required to generate an FLP configuration
+const flpConfigAnswers: FLPConfigAnswers = await prompt(
+    inquirerAdapter,
+    inboundKeys,
+    promptOptions
+);
+
+// Use flpConfigAnswers as needed
+console.log('FLP Configuration Answers:', flpConfigAnswers);
+```
+
+## License
+
+Read [License](./LICENSE).
+
+## Keywords
+
+SAP Fiori Launchpad
+FLP Configuration
+Inquirer
+Prompting
+Generator

package/dist/i18n.d.ts

@@ -0,0 +1,20 @@
+import type { TOptions } from 'i18next';
+export declare const FLP_CONFIG_NAMESPACE = "flp-config-inquirer";
+/**
+ * Adds the `flp-config-inquirer` resource bundle to i18next.
+ * May be required to load i18n translations after initialising in the consumer module.
+ */
+export declare function addi18nResourceBundle(): void;
+/**
+ * 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/dist/i18n.js

@@ -0,0 +1,46 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FLP_CONFIG_NAMESPACE = void 0;
+exports.addi18nResourceBundle = addi18nResourceBundle;
+exports.initI18n = initI18n;
+exports.t = t;
+const i18next_1 = __importDefault(require("i18next"));
+const project_input_validator_1 = require("@sap-ux/project-input-validator");
+const flp_config_inquirer_i18n_json_1 = __importDefault(require("./translations/flp-config-inquirer.i18n.json"));
+exports.FLP_CONFIG_NAMESPACE = 'flp-config-inquirer';
+/**
+ * Adds the `flp-config-inquirer` resource bundle to i18next.
+ * May be required to load i18n translations after initialising in the consumer module.
+ */
+function addi18nResourceBundle() {
+    i18next_1.default.addResourceBundle('en', exports.FLP_CONFIG_NAMESPACE, flp_config_inquirer_i18n_json_1.default);
+}
+/**
+ * Initialize i18next with the translations for this module.
+ */
+async function initI18n() {
+    await i18next_1.default.init({ lng: 'en', fallbackLng: 'en' });
+    addi18nResourceBundle();
+    // add the project-input-validator i18n resource bundle to ensure all translations are available
+    (0, project_input_validator_1.addi18nResourceBundle)();
+}
+/**
+ * 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: exports.FLP_CONFIG_NAMESPACE });
+    }
+    return i18next_1.default.t(key, options);
+}
+initI18n().catch(() => {
+    // Needed for lint
+});
+//# sourceMappingURL=i18n.js.map

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+import type { InquirerAdapter, PromptDefaultValue } from '@sap-ux/inquirer-common';
+import { promptNames } from './types';
+import type { FLPConfigAnswers, FLPConfigQuestion, FLPConfigPromptOptions } from './types';
+/**
+ * Get the inquirer prompts for the FLP configuration inquirer.
+ *
+ * @param inboundKeys - array of existing inbound keys to check for duplicates
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link FLPConfigPromptOptions} for details
+ * @returns the prompts used to provide input for FLP configuration
+ */
+declare function getPrompts(inboundKeys?: string[], promptOptions?: FLPConfigPromptOptions): Promise<FLPConfigQuestion[]>;
+/**
+ * Prompt for FLP configuration inputs.
+ *
+ * @param adapter - an instance of InquirerAdapter to handle prompting
+ * @param inboundKeys - array of existing inbound keys to check for duplicates
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link FLPConfigPromptOptions} for details
+ * @returns the prompt answers
+ */
+declare function prompt(adapter: InquirerAdapter, inboundKeys?: string[], promptOptions?: FLPConfigPromptOptions): Promise<FLPConfigAnswers>;
+export { getPrompts, prompt, promptNames, type InquirerAdapter, type PromptDefaultValue, type FLPConfigAnswers, type FLPConfigPromptOptions };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,81 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promptNames = void 0;
+exports.getPrompts = getPrompts;
+exports.prompt = prompt;
+const isNil_1 = __importDefault(require("lodash/isNil"));
+const i18n_1 = require("./i18n");
+const types_1 = require("./types");
+Object.defineProperty(exports, "promptNames", { enumerable: true, get: function () { return types_1.promptNames; } });
+const prompts_1 = require("./prompts");
+/**
+ * Get the inquirer prompts for the FLP configuration inquirer.
+ *
+ * @param inboundKeys - array of existing inbound keys to check for duplicates
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link FLPConfigPromptOptions} for details
+ * @returns the prompts used to provide input for FLP configuration
+ */
+async function getPrompts(inboundKeys = [], promptOptions) {
+    await (0, i18n_1.initI18n)();
+    return (0, prompts_1.getQuestions)(inboundKeys, promptOptions);
+}
+/**
+ * Prompt for FLP configuration inputs.
+ *
+ * @param adapter - an instance of InquirerAdapter to handle prompting
+ * @param inboundKeys - array of existing inbound keys to check for duplicates
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link FLPConfigPromptOptions} for details
+ * @returns the prompt answers
+ */
+async function prompt(adapter, inboundKeys = [], promptOptions) {
+    const flpPrompts = await getPrompts(inboundKeys, promptOptions);
+    const answers = await adapter.prompt(flpPrompts);
+    // Apply default values to prompts in case they have not been executed
+    if (promptOptions) {
+        const defaultAnswers = applyPromptOptionDefaults(answers, flpPrompts, promptOptions);
+        Object.assign(answers, defaultAnswers);
+    }
+    return answers;
+}
+/**
+ * Apply prompt option default values to prompt answers in case they have not been executed by the user selections.
+ * This can occur where some prompts are hidden by conditions.
+ *
+ * @param answers the answers from previous prompting, only answers without a value will be considered for defaulting
+ * @param flpPrompts the prompts that were used to prompt the user, will be used to apply default values if not answered or no default provided
+ * @param promptOptions the prompt options which may provide default values or functions
+ * @returns the default values for the unanswered prompts, based on the prompt options
+ */
+function applyPromptOptionDefaults(answers, flpPrompts, promptOptions) {
+    const defaultAnswers = {};
+    Object.entries(promptOptions).forEach(([key, promptOpt]) => {
+        const promptKey = key;
+        // Do we have an answer? If not, apply the default
+        const defaultValueOrFunc = promptOpt.default;
+        if ((0, isNil_1.default)(answers[promptKey]) && defaultValueOrFunc !== undefined) {
+            const defaultValue = getDefaultValue(answers, defaultValueOrFunc);
+            Object.assign(defaultAnswers, {
+                [promptKey]: defaultValue
+            });
+        }
+    });
+    return defaultAnswers;
+}
+/**
+ * Get the default value for a prompt based on the provided default value or function.
+ * If a function is provided, it will be called with the current answers to determine the default value.
+ *
+ * @param answers the current answers provided to default functions
+ * @param promptDefault the default value or function to determine the default value
+ * @returns the default value for the prompt or undefined if no default value is provided
+ */
+function getDefaultValue(answers, promptDefault) {
+    if (typeof promptDefault === 'function') {
+        return promptDefault(answers);
+    }
+    return promptDefault;
+}
+//# sourceMappingURL=index.js.map

package/dist/prompts/index.d.ts

@@ -0,0 +1,2 @@
+export * from './prompts';
+//# sourceMappingURL=index.d.ts.map

package/dist/prompts/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("./prompts"), exports);
+//# sourceMappingURL=index.js.map

package/dist/prompts/prompts.d.ts

@@ -0,0 +1,10 @@
+import type { FLPConfigPromptOptions, FLPConfigQuestion } from '../types';
+/**
+ * Generates a list of prompts for FLP (Fiori Launchpad) configuration.
+ *
+ * @param {string[]} [inboundKeys] - An array of existing inbound keys to check for duplicates.
+ * @param {FLPConfigPromptOptions} [promptOptions] - Optional configuration to control prompt behavior and defaults.
+ * @returns {FLPConfigQuestion[]} An array of FLPConfigQuestion objects to be used for prompting the user.
+ */
+export declare function getQuestions(inboundKeys?: string[], promptOptions?: FLPConfigPromptOptions): FLPConfigQuestion[];
+//# sourceMappingURL=prompts.d.ts.map

package/dist/prompts/prompts.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getQuestions = getQuestions;
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
+const basic_1 = require("./questions/basic");
+const types_1 = require("../types");
+/**
+ * Generates a list of prompts for FLP (Fiori Launchpad) configuration.
+ *
+ * @param {string[]} [inboundKeys] - An array of existing inbound keys to check for duplicates.
+ * @param {FLPConfigPromptOptions} [promptOptions] - Optional configuration to control prompt behavior and defaults.
+ * @returns {FLPConfigQuestion[]} An array of FLPConfigQuestion objects to be used for prompting the user.
+ */
+function getQuestions(inboundKeys = [], promptOptions) {
+    const isCLI = (0, fiori_generator_shared_1.getHostEnvironment)() === fiori_generator_shared_1.hostEnvironment.cli;
+    const existingKeyRef = { value: false };
+    const silentOverwrite = promptOptions?.silentOverwrite ?? false;
+    const keyedPrompts = {
+        [types_1.promptNames.semanticObject]: (0, basic_1.getSemanticObjectPrompt)(isCLI, promptOptions?.[types_1.promptNames.semanticObject]),
+        [types_1.promptNames.action]: (0, basic_1.getActionPrompt)(isCLI, promptOptions?.[types_1.promptNames.action]),
+        [types_1.promptNames.overwrite]: (0, basic_1.getOverwritePrompt)(inboundKeys, isCLI, existingKeyRef, promptOptions?.[types_1.promptNames.overwrite]),
+        [types_1.promptNames.title]: (0, basic_1.getTitlePrompt)(existingKeyRef, silentOverwrite, isCLI, promptOptions?.[types_1.promptNames.title]),
+        [types_1.promptNames.subTitle]: (0, basic_1.getSubTitlePrompt)(existingKeyRef, silentOverwrite, promptOptions?.[types_1.promptNames.subTitle])
+    };
+    const questions = [
+        keyedPrompts[types_1.promptNames.semanticObject],
+        keyedPrompts[types_1.promptNames.action],
+        keyedPrompts[types_1.promptNames.overwrite],
+        keyedPrompts[types_1.promptNames.title],
+        keyedPrompts[types_1.promptNames.subTitle]
+    ];
+    return questions;
+}
+//# sourceMappingURL=prompts.js.map

package/dist/prompts/questions/basic.d.ts

@@ -0,0 +1,47 @@
+import type { ActionPromptOptions, ExistingInboundRef, FLPConfigQuestion, OverwritePromptOptions, SemanticObjectPromptOptions, SubTitlePromptOptions, TitlePromptOptions } from '../../types';
+/**
+ * Creates the 'semanticObject' prompt for FLP configuration.
+ *
+ * @param {boolean} isCLI - Indicates if the platform is CLI.
+ * @param {SemanticObjectPromptOptions} [options] - Optional configuration for the semantic object prompt, including default values.
+ * @returns {FLPConfigQuestion} The prompt configuration for the semantic object.
+ */
+export declare function getSemanticObjectPrompt(isCLI: boolean, options?: SemanticObjectPromptOptions): FLPConfigQuestion;
+/**
+ * Creates the 'action' prompt for FLP configuration.
+ *
+ * @param {boolean} isCLI - Indicates if the platform is CLI.
+ * @param {ActionPromptOptions} [options] - Optional configuration for the action prompt, including default values.
+ * @returns {FLPConfigQuestion} The prompt configuration for the action.
+ */
+export declare function getActionPrompt(isCLI: boolean, options?: ActionPromptOptions): FLPConfigQuestion;
+/**
+ * Creates the 'overwrite' prompt for FLP configuration.
+ *
+ * @param {string[]} inboundKeys - A list of existing inbound keys to check for duplicates.
+ * @param {boolean} isCLI - Indicates if the platform is CLI (affects message formatting).
+ * @param {ExistingInboundRef} existingKeyRef - A reference object to track whether a key conflict exists.
+ * @param {OverwritePromptOptions} [options] - Optional configuration for the overwrite prompt, including default behavior and visibility.
+ * @returns {FLPConfigQuestion} The prompt configuration for overwrite.
+ */
+export declare function getOverwritePrompt(inboundKeys: string[], isCLI: boolean, existingKeyRef: ExistingInboundRef, options?: OverwritePromptOptions): FLPConfigQuestion;
+/**
+ * Creates the 'title' prompt for FLP configuration.
+ *
+ * @param {ExistingInboundRef} existingKeyRef - A reference object to track whether an inbound id exists.
+ * @param {boolean} silentOverwrite - A flag indicating if overwrites should be silent.
+ * @param {boolean} isCLI - Indicates if the platform is CLI.
+ * @param {TitlePromptOptions} [options] - Optional configuration for the title prompt, including default values.
+ * @returns {FLPConfigQuestion} The prompt configuration for the title.
+ */
+export declare function getTitlePrompt(existingKeyRef: ExistingInboundRef, silentOverwrite: boolean, isCLI: boolean, options?: TitlePromptOptions): FLPConfigQuestion;
+/**
+ * Creates the 'subTitle' prompt for FLP configuration.
+ *
+ * @param {ExistingInboundRef} existingKeyRef - A reference object to track whether an inbound id exists.
+ * @param {boolean} silentOverwrite - A flag indicating if overwrites should be silent.
+ * @param {SubTitlePromptOptions} [options] - Optional configuration for the subtitle prompt, including default values.
+ * @returns {FLPConfigQuestion} The prompt configuration for the subtitle.
+ */
+export declare function getSubTitlePrompt(existingKeyRef: ExistingInboundRef, silentOverwrite: boolean, options?: SubTitlePromptOptions): FLPConfigQuestion;
+//# sourceMappingURL=basic.d.ts.map

package/dist/prompts/questions/basic.js

@@ -0,0 +1,136 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSemanticObjectPrompt = getSemanticObjectPrompt;
+exports.getActionPrompt = getActionPrompt;
+exports.getOverwritePrompt = getOverwritePrompt;
+exports.getTitlePrompt = getTitlePrompt;
+exports.getSubTitlePrompt = getSubTitlePrompt;
+const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+const project_input_validator_1 = require("@sap-ux/project-input-validator");
+const i18n_1 = require("../../i18n");
+const types_1 = require("../../types");
+/**
+ * Creates the 'semanticObject' prompt for FLP configuration.
+ *
+ * @param {boolean} isCLI - Indicates if the platform is CLI.
+ * @param {SemanticObjectPromptOptions} [options] - Optional configuration for the semantic object prompt, including default values.
+ * @returns {FLPConfigQuestion} The prompt configuration for the semantic object.
+ */
+function getSemanticObjectPrompt(isCLI, options) {
+    return {
+        name: types_1.promptNames.semanticObject,
+        type: 'input',
+        guiOptions: {
+            mandatory: true,
+            breadcrumb: true
+        },
+        message: (0, i18n_1.t)('prompts.semanticObject'),
+        default: options?.default,
+        filter: (val) => val?.trim(),
+        validate: (val) => (0, project_input_validator_1.validateText)(val, isCLI, 30, ['_'])
+    };
+}
+/**
+ * Creates the 'action' prompt for FLP configuration.
+ *
+ * @param {boolean} isCLI - Indicates if the platform is CLI.
+ * @param {ActionPromptOptions} [options] - Optional configuration for the action prompt, including default values.
+ * @returns {FLPConfigQuestion} The prompt configuration for the action.
+ */
+function getActionPrompt(isCLI, options) {
+    return {
+        name: types_1.promptNames.action,
+        type: 'input',
+        guiOptions: {
+            mandatory: true,
+            breadcrumb: true
+        },
+        message: (0, i18n_1.t)('prompts.action'),
+        default: options?.default,
+        filter: (val) => val?.trim(),
+        validate: (val) => (0, project_input_validator_1.validateText)(val, isCLI, 60, ['_'])
+    };
+}
+/**
+ * Creates the 'overwrite' prompt for FLP configuration.
+ *
+ * @param {string[]} inboundKeys - A list of existing inbound keys to check for duplicates.
+ * @param {boolean} isCLI - Indicates if the platform is CLI (affects message formatting).
+ * @param {ExistingInboundRef} existingKeyRef - A reference object to track whether a key conflict exists.
+ * @param {OverwritePromptOptions} [options] - Optional configuration for the overwrite prompt, including default behavior and visibility.
+ * @returns {FLPConfigQuestion} The prompt configuration for overwrite.
+ */
+function getOverwritePrompt(inboundKeys, isCLI, existingKeyRef, options) {
+    return {
+        type: 'confirm',
+        name: types_1.promptNames.overwrite,
+        message: (previousAnswers) => `${isCLI
+            ? (0, i18n_1.t)('validators.inboundConfigKeyExists', {
+                inboundKey: `${previousAnswers.semanticObject}-${previousAnswers.action}`
+            })
+            : ''} ${(0, i18n_1.t)('validators.flpConfigOverwrite')}`,
+        guiOptions: {
+            applyDefaultWhenDirty: true
+        },
+        default: options?.default ?? (() => !existingKeyRef.value),
+        when: options?.hide
+            ? false
+            : (previousAnswers) => {
+                existingKeyRef.value =
+                    inboundKeys.indexOf(`${previousAnswers.semanticObject}-${previousAnswers.action}`) > -1;
+                return existingKeyRef.value;
+            },
+        additionalMessages: (_, previousAnswers) => ({
+            message: (0, i18n_1.t)('validators.inboundConfigKeyExists', {
+                inboundKey: `${previousAnswers.semanticObject}-${previousAnswers.action}`
+            }),
+            severity: yeoman_ui_types_1.Severity.warning
+        })
+    };
+}
+/**
+ * Creates the 'title' prompt for FLP configuration.
+ *
+ * @param {ExistingInboundRef} existingKeyRef - A reference object to track whether an inbound id exists.
+ * @param {boolean} silentOverwrite - A flag indicating if overwrites should be silent.
+ * @param {boolean} isCLI - Indicates if the platform is CLI.
+ * @param {TitlePromptOptions} [options] - Optional configuration for the title prompt, including default values.
+ * @returns {FLPConfigQuestion} The prompt configuration for the title.
+ */
+function getTitlePrompt(existingKeyRef, silentOverwrite, isCLI, options) {
+    return {
+        when: ({ overwrite }) => overwrite !== false || !existingKeyRef.value || silentOverwrite,
+        name: types_1.promptNames.title,
+        type: 'input',
+        guiOptions: {
+            mandatory: true,
+            breadcrumb: true
+        },
+        message: (0, i18n_1.t)('prompts.title'),
+        default: options?.default,
+        filter: (val) => val?.trim(),
+        validate: (val) => (0, project_input_validator_1.validateText)(val, isCLI, 0)
+    };
+}
+/**
+ * Creates the 'subTitle' prompt for FLP configuration.
+ *
+ * @param {ExistingInboundRef} existingKeyRef - A reference object to track whether an inbound id exists.
+ * @param {boolean} silentOverwrite - A flag indicating if overwrites should be silent.
+ * @param {SubTitlePromptOptions} [options] - Optional configuration for the subtitle prompt, including default values.
+ * @returns {FLPConfigQuestion} The prompt configuration for the subtitle.
+ */
+function getSubTitlePrompt(existingKeyRef, silentOverwrite, options) {
+    return {
+        when: ({ overwrite }) => overwrite !== false || !existingKeyRef.value || silentOverwrite,
+        name: types_1.promptNames.subTitle,
+        type: 'input',
+        guiOptions: {
+            breadcrumb: (0, i18n_1.t)('prompts.subTitle')
+        },
+        message: (0, i18n_1.t)('prompts.subTitle'),
+        default: options?.default,
+        filter: (val) => val?.trim()
+    };
+}
+//# sourceMappingURL=basic.js.map

package/dist/prompts/questions/index.d.ts

@@ -0,0 +1,2 @@
+export * from './basic';
+//# sourceMappingURL=index.d.ts.map

package/dist/prompts/questions/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("./basic"), exports);
+//# sourceMappingURL=index.js.map

package/dist/translations/flp-config-inquirer.i18n.json

@@ -0,0 +1,12 @@
+{
+    "prompts": {
+        "semanticObject": "Semantic Object",
+        "action": "Action",
+        "title": "Title",
+        "subTitle": "Subtitle"
+    },
+    "validators": {
+        "inboundConfigKeyExists": "An inbound configuration with the key: '{{inboundKey}}' is already defined.",
+        "flpConfigOverwrite": "Overwrite existing configuration?"
+    }
+}

package/dist/types.d.ts

@@ -0,0 +1,83 @@
+import type { YUIQuestion, GuiOptions, PromptSeverityMessage } from '@sap-ux/inquirer-common';
+/**
+ * Enumeration of prompt names used in the FLP configuration.
+ */
+export declare enum promptNames {
+    semanticObject = "semanticObject",
+    action = "action",
+    overwrite = "overwrite",
+    title = "title",
+    subTitle = "subTitle"
+}
+/**
+ * Interface representing the answers collected from the FLP configuration prompts.
+ */
+export interface FLPConfigAnswers {
+    [promptNames.semanticObject]: string;
+    [promptNames.action]: string;
+    [promptNames.overwrite]?: boolean;
+    [promptNames.title]?: string;
+    [promptNames.subTitle]?: string;
+    s4Continue?: boolean;
+}
+/**
+ * Boolean reference to already existing inbound id key.
+ */
+export interface ExistingInboundRef {
+    value: boolean;
+}
+/**
+ * The question type specific to FLP configuration prompts.
+ */
+export interface FLPConfigQuestion extends YUIQuestion<FLPConfigAnswers> {
+    name: promptNames;
+    guiOptions?: GuiOptions;
+    additionalMessages?: PromptSeverityMessage;
+}
+/**
+ * Options for the 'semanticObject' prompt.
+ */
+export interface SemanticObjectPromptOptions {
+    default?: string;
+}
+/**
+ * Options for the 'action' prompt.
+ */
+export interface ActionPromptOptions {
+    default?: string;
+}
+/**
+ * Options for the 'overwrite' prompt.
+ */
+export interface OverwritePromptOptions {
+    hide?: boolean;
+    default?: boolean;
+}
+/**
+ * Options for the 'title' prompt.
+ */
+export interface TitlePromptOptions {
+    default?: string;
+}
+/**
+ * Options for the 'subTitle' prompt.
+ */
+export interface SubTitlePromptOptions {
+    default?: string;
+}
+/**
+ * The options which are common for the FLP config inquirer.
+ */
+type FLPConfigCommonInquirerOptions = {
+    silentOverwrite?: boolean;
+};
+/**
+ * The options for the FLP config inquirer & the prompts.
+ */
+type flpConfigPromptOptions = Record<promptNames.semanticObject, SemanticObjectPromptOptions> & Record<promptNames.action, ActionPromptOptions> & Record<promptNames.overwrite, OverwritePromptOptions> & Record<promptNames.title, TitlePromptOptions> & Record<promptNames.subTitle, SubTitlePromptOptions>;
+/**
+ * The options for the FLP config inquirer & the prompts.
+ */
+export type FLPConfigPromptOptions = Partial<flpConfigPromptOptions> & FLPConfigCommonInquirerOptions;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promptNames = void 0;
+/**
+ * Enumeration of prompt names used in the FLP configuration.
+ */
+var promptNames;
+(function (promptNames) {
+    promptNames["semanticObject"] = "semanticObject";
+    promptNames["action"] = "action";
+    promptNames["overwrite"] = "overwrite";
+    promptNames["title"] = "title";
+    promptNames["subTitle"] = "subTitle";
+})(promptNames || (exports.promptNames = promptNames = {}));
+//# sourceMappingURL=types.js.map

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@sap-ux/flp-config-inquirer",
+  "description": "Prompts module that can prompt users for inputs required for FLP configuration",
+  "version": "0.1.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/flp-config-inquirer"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aflp-config-inquirer"
+  },
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "files": [
+    "LICENSE",
+    "dist",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "dependencies": {
+    "i18next": "23.5.1",
+    "lodash": "4.17.21",
+    "@sap-ux/inquirer-common": "0.5.4",
+    "@sap-ux/btp-utils": "0.17.0",
+    "@sap-ux/project-input-validator": "0.3.4",
+    "@sap-ux/fiori-generator-shared": "0.7.10"
+  },
+  "devDependencies": {
+    "@sap-devx/yeoman-ui-types": "1.14.4",
+    "@types/inquirer": "8.2.6",
+    "@types/lodash": "4.14.202",
+    "inquirer": "8.2.6"
+  },
+  "engines": {
+    "node": ">=18.x"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rimraf --glob dist 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"
+  }
+}