@sap-ux/cf-deploy-config-inquirer 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,64 @@
+# @sap-ux/cf-deploy-config-inquirer
+
+Prompts module that can provide prompts for Cloud Foundry deployment config writer.
+
+## Installation
+Npm
+`npm install --save @sap-ux/cf-deploy-config-inquirer`
+
+Yarn
+`yarn add @sap-ux/cf-deploy-config-inquirer`
+
+Pnpm
+`pnpm add @sap-ux/cf-deploy-config-inquirer`
+
+
+## Explainer
+
+Prompts may be retrieved using `getPrompts` and then executed in another prompting module that supports `inquirer` type prompts. 
+
+`getPrompts` is provided to allow consumers to access cloud foundry prompts. There may be cases where these can be transformed to support other prompting frameworks. Most prompt configuration is possible via `CfDeployConfigPromptOptions` and calling `prompt`. This is the recommended approach.
+
+Configurability of prompts is entirely controlled using the `CfDeployConfigPromptOptions` parameter. 
+
+See [Inquirer.js](https://www.npmjs.com/package/inquirer) for valid default properties.
+
+### Cloud Foundry Deploy Config Inquirer usage example:
+
+```TypeScript
+import type { InquirerAdapter } from '@sap-ux/inquirer-common';
+import type { CfDeployConfigAnswers, CfDeployConfigPromptOptions } from '@sap-ux/cf-deploy-config-inquirer';
+import { prompt as cfDeployConfigPrompt, promptNames } from '@sap-ux/cf-deploy-config-inquirer';
+
+const promptOptions = {
+    [promptNames.destinationName]: {
+        defaultValue: 'defaultDestination',
+        hint: false
+    },
+    [promptNames.addManagedAppRouter]: true,
+    [promptNames.overwrite]: true
+};
+
+/**
+ * Pass an Inquirer prompt function https://www.npmjs.com/package/inquirer#methods
+ */
+const inqAdaptor = {
+    prompt: this.prompt.bind(this) // the inquirer prompting function, here we use the generators reference
+};
+
+const cfDeployConfigAnswers: CfDeployConfigAnswers = await cfDeployConfigPrompt(
+    inqAdaptor as InquirerAdapter,
+    promptOpts
+);
+```
+
+## License
+
+Read [License](./LICENSE).
+
+## Keywords
+SAP UI5 Application
+Inquirer
+Prompting
+Generator
+Deployment

package/dist/i18n.d.ts

@@ -0,0 +1,15 @@
+import type { TOptions } from 'i18next';
+export declare const defaultProjectNumber = 1;
+/**
+ * Initialize i18next with the translations for this module.
+ */
+export declare function initI18nCfDeployConfigInquirer(): 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,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultProjectNumber = void 0;
+exports.initI18nCfDeployConfigInquirer = initI18nCfDeployConfigInquirer;
+exports.t = t;
+const i18next_1 = __importDefault(require("i18next"));
+const cf_deploy_config_inquirer_i18n_json_1 = __importDefault(require("./translations/cf-deploy-config-inquirer.i18n.json"));
+const cfInquirerNamespace = 'cf-deploy-config-inquirer';
+exports.defaultProjectNumber = 1;
+/**
+ * Initialize i18next with the translations for this module.
+ */
+async function initI18nCfDeployConfigInquirer() {
+    await i18next_1.default.init({
+        lng: 'en',
+        fallbackLng: 'en',
+        interpolation: {
+            defaultVariables: {
+                defaultProjectNumber: exports.defaultProjectNumber
+            }
+        }
+    }, () => i18next_1.default.addResourceBundle('en', cfInquirerNamespace, cf_deploy_config_inquirer_i18n_json_1.default));
+}
+/**
+ * Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+function t(key, options) {
+    if (!options?.ns) {
+        options = Object.assign(options ?? {}, { ns: cfInquirerNamespace });
+    }
+    return i18next_1.default.t(key, options);
+}
+initI18nCfDeployConfigInquirer().catch(() => {
+    // Needed for lint
+});
+//# sourceMappingURL=i18n.js.map

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import type { CfDeployConfigPromptOptions, CfDeployConfigQuestions, CfSystemChoice, CfDeployConfigAnswers } from './types';
+import { promptNames } from './types';
+import type { InquirerAdapter } from '@sap-ux/inquirer-common';
+import type { Logger } from '@sap-ux/logger';
+/**
+ * Retrieves Cloud Foundry deployment configuration prompts.
+ *
+ * This function returns a list of cf deployment questions based on the provided application root and prompt options.
+ *
+ * @param {CfDeployConfigPromptOptions} promptOptions - The configuration options for prompting during cf target deployment.
+ * @param logger - The logger instance to use for logging.
+ * @returns {Promise<CfDeployConfigQuestions[]>} A promise that resolves to an array of questions for cf target prompting.
+ */
+declare function getPrompts(promptOptions: CfDeployConfigPromptOptions, logger?: Logger): Promise<CfDeployConfigQuestions[]>;
+/**
+ * Prompt for cf inquirer inputs.
+ *
+ * @param adapter - optionally provide references to a calling inquirer instance, this supports integration to Yeoman generators, for example
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link CfDeployConfigPromptOptions} for details
+ * @param logger - logger instance to use for logging
+ * @returns the prompt answers
+ */
+declare function prompt(adapter: InquirerAdapter, promptOptions: CfDeployConfigPromptOptions, logger?: Logger): Promise<CfDeployConfigAnswers>;
+export { getPrompts, CfDeployConfigPromptOptions, CfSystemChoice, promptNames, prompt };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,48 @@
+"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 prompts_1 = require("./prompts");
+const types_1 = require("./types");
+Object.defineProperty(exports, "promptNames", { enumerable: true, get: function () { return types_1.promptNames; } });
+const i18n_1 = require("./i18n");
+const inquirer_autocomplete_prompt_1 = __importDefault(require("inquirer-autocomplete-prompt"));
+const logger_helper_1 = __importDefault(require("./logger-helper"));
+/**
+ * Retrieves Cloud Foundry deployment configuration prompts.
+ *
+ * This function returns a list of cf deployment questions based on the provided application root and prompt options.
+ *
+ * @param {CfDeployConfigPromptOptions} promptOptions - The configuration options for prompting during cf target deployment.
+ * @param logger - The logger instance to use for logging.
+ * @returns {Promise<CfDeployConfigQuestions[]>} A promise that resolves to an array of questions for cf target prompting.
+ */
+async function getPrompts(promptOptions, logger) {
+    if (logger) {
+        logger_helper_1.default.logger = logger;
+    }
+    await (0, i18n_1.initI18nCfDeployConfigInquirer)();
+    return (0, prompts_1.getQuestions)(promptOptions, logger_helper_1.default.logger);
+}
+/**
+ * Prompt for cf inquirer inputs.
+ *
+ * @param adapter - optionally provide references to a calling inquirer instance, this supports integration to Yeoman generators, for example
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link CfDeployConfigPromptOptions} for details
+ * @param logger - logger instance to use for logging
+ * @returns the prompt answers
+ */
+async function prompt(adapter, promptOptions, logger) {
+    const cfPrompts = await getPrompts(promptOptions, logger);
+    if (adapter?.promptModule && promptOptions[types_1.promptNames.destinationName]?.useAutocomplete) {
+        const pm = adapter.promptModule;
+        pm.registerPrompt('autocomplete', inquirer_autocomplete_prompt_1.default);
+    }
+    const answers = await adapter.prompt(cfPrompts);
+    return answers;
+}
+//# sourceMappingURL=index.js.map

package/dist/logger-helper.d.ts

@@ -0,0 +1,20 @@
+import { type Logger } from '@sap-ux/logger';
+/**
+ * Static logger prevents passing of logger references through all functions, as this is a cross-cutting concern.
+ */
+export default class LoggerHelper {
+    private static _logger;
+    /**
+     * Get the logger.
+     *
+     * @returns the logger
+     */
+    static get logger(): Logger;
+    /**
+     * Set the logger.
+     *
+     * @param value the logger to set
+     */
+    static set logger(value: Logger);
+}
+//# sourceMappingURL=logger-helper.d.ts.map

package/dist/logger-helper.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("@sap-ux/logger");
+/**
+ * Static logger prevents passing of logger references through all functions, as this is a cross-cutting concern.
+ */
+class LoggerHelper {
+    static _logger = new logger_1.ToolsLogger({ logPrefix: '@sap-ux/cf-deploy-config-inquirer' });
+    /**
+     * Get the logger.
+     *
+     * @returns the logger
+     */
+    static get logger() {
+        return LoggerHelper._logger;
+    }
+    /**
+     * Set the logger.
+     *
+     * @param value the logger to set
+     */
+    static set logger(value) {
+        LoggerHelper._logger = value;
+    }
+}
+exports.default = LoggerHelper;
+//# sourceMappingURL=logger-helper.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/prompt-helpers.d.ts

@@ -0,0 +1,16 @@
+import type { CfSystemChoice } from '../types';
+import { type Destinations } from '@sap-ux/btp-utils';
+/**
+ * Retrieves an array of Cloud Foundry system choices.
+ *
+ * @param {Destinations} [destinations] - Optional destinations object retrieved from BTP.
+ * @returns {Promise<CfSystemChoice[]>} - List of system choices formatted for selection prompts.
+ */
+export declare function getCfSystemChoices(destinations?: Destinations): Promise<CfSystemChoice[]>;
+/**
+ * Retrieves and caches the list of available BTP destinations if running in BAS.
+ *
+ * @returns {Promise<Destinations | undefined>} - A promise resolving to a list of destinations or undefined if not in BAS.
+ */
+export declare function fetchBTPDestinations(): Promise<Destinations | undefined>;
+//# sourceMappingURL=prompt-helpers.d.ts.map

package/dist/prompts/prompt-helpers.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCfSystemChoices = getCfSystemChoices;
+exports.fetchBTPDestinations = fetchBTPDestinations;
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const logger_helper_1 = __importDefault(require("../logger-helper"));
+const i18n_1 = require("../i18n");
+/**
+ * Generates a sorted list of Cloud Foundry system destination choices from provided destinations.
+ *
+ * @param {Destinations} [destinations] - Object containing destination details retrieved from BTP.
+ * @returns {CfSystemChoice[]} - Array of destination choices formatted for selection prompts.
+ */
+function createDestinationChoices(destinations = {}) {
+    return Object.values(destinations)
+        .filter((destination) => destination && typeof destination.Name === 'string' && typeof destination.Host === 'string')
+        .sort((a, b) => a.Name.localeCompare(b.Name, undefined, { numeric: true, caseFirst: 'lower' }))
+        .map((destination) => ({
+        name: `${(0, btp_utils_1.getDisplayName)(destination) ?? 'Unknown'} - ${destination.Host}`,
+        value: destination.Name,
+        scp: (0, btp_utils_1.isAbapEnvironmentOnBtp)(destination) || false,
+        url: destination.Host
+    }));
+}
+/**
+ * Retrieves an array of Cloud Foundry system choices.
+ *
+ * @param {Destinations} [destinations] - Optional destinations object retrieved from BTP.
+ * @returns {Promise<CfSystemChoice[]>} - List of system choices formatted for selection prompts.
+ */
+async function getCfSystemChoices(destinations) {
+    return destinations ? createDestinationChoices(destinations) : [];
+}
+/**
+ * Retrieves and caches the list of available BTP destinations if running in BAS.
+ *
+ * @returns {Promise<Destinations | undefined>} - A promise resolving to a list of destinations or undefined if not in BAS.
+ */
+async function fetchBTPDestinations() {
+    if ((0, btp_utils_1.isAppStudio)()) {
+        const destinations = await (0, btp_utils_1.listDestinations)();
+        return destinations;
+    }
+    logger_helper_1.default.logger.warn((0, i18n_1.t)('warning.btpDestinationListWarning'));
+    return undefined;
+}
+//# sourceMappingURL=prompt-helpers.js.map

package/dist/prompts/prompts.d.ts

@@ -0,0 +1,11 @@
+import type { CfDeployConfigPromptOptions, CfDeployConfigQuestions } from '../types';
+import type { Logger } from '@sap-ux/logger';
+/**
+ * Retrieves a list of deployment questions based on the application root and prompt options.
+ *
+ * @param {CfDeployConfigPromptOptions} promptOptions - The configuration options for prompting during cf target deployment.
+ * @param {Logger} [log] - The logger instance to use for logging.
+ * @returns {CfDeployConfigQuestions[]} Returns an array of questions related to cf deployment configuration.
+ */
+export declare function getQuestions(promptOptions: CfDeployConfigPromptOptions, log?: Logger): Promise<CfDeployConfigQuestions[]>;
+//# sourceMappingURL=prompts.d.ts.map

package/dist/prompts/prompts.js

@@ -0,0 +1,145 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getQuestions = getQuestions;
+const inquirer_common_1 = require("@sap-ux/inquirer-common");
+const i18n_1 = require("../i18n");
+const types_1 = require("../types");
+const validators = __importStar(require("./validators"));
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const prompt_helpers_1 = require("./prompt-helpers");
+/**
+ * Retrieves the prompt configuration for selecting a Cloud Foundry destination name.
+ *
+ * This function generates a prompt that allows users to specify a destination name. The prompt can be rendered as a list or
+ * an input field depending on the provided options. If the environment supports
+ * autocomplete, it can provide suggestions based on existing destinations.
+ *
+ * @param {DestinationNamePromptOptions} destinationOptions - The options for configuring
+ *        the destination name prompt.
+ * @param {string} destinationOptions.destination - The Cloud Foundry destination name
+ *        to be used.
+ * @param {string} destinationOptions.defaultValue - The default destination value for CF.
+ * @param {boolean} [destinationOptions.addDestinationHintMessage] - A flag to indicate
+ *        whether to show a hint for the destination name.
+ * @param {CfSystemChoice[]} [destinationOptions.additionalChoiceList] - Additional choices
+ *        available for the destination. If additional choices are provided and the environment is VsCode, the prompt
+ *        type will render as a list instead of an input field.
+ * @param {boolean} [destinationOptions.useAutocomplete] - A flag to indicate whether
+ *        to use an autocomplete feature for the destination name input.
+ * @param {boolean} [destinationOptions.addBTPDestinationList] - A flag to indicate whether to include BTP destination choices.
+ * @returns {Promise<CfDeployConfigQuestions>} A promise that resolves to the configuration
+ *          of the prompt, which includes the question and any related options for rendering
+ *          the prompt in a user interface.
+ */
+async function getDestinationNamePrompt(destinationOptions) {
+    const { hint = false, additionalChoiceList = [], defaultValue, useAutocomplete = false, addBTPDestinationList = true } = destinationOptions;
+    const isBAS = (0, btp_utils_1.isAppStudio)();
+    const destinations = addBTPDestinationList ? await (0, prompt_helpers_1.fetchBTPDestinations)() : {};
+    const destinationList = [...additionalChoiceList, ...(await (0, prompt_helpers_1.getCfSystemChoices)(destinations))];
+    // If BAS is used or additional choices are provided, the prompt should be a list
+    // If VsCode is used and additional choices are not provided, the prompt should be an input field
+    // If VsCode is used and additional choices are provided, the prompt should be a list
+    const basePromptType = isBAS || additionalChoiceList.length ? 'list' : 'input';
+    // If autocomplete is enabled and there are destination choices, the prompt should be an autocomplete
+    const promptType = useAutocomplete && destinationList.length ? 'autocomplete' : basePromptType;
+    return {
+        guiOptions: {
+            mandatory: !isBAS,
+            breadcrumb: (0, i18n_1.t)('prompts.destinationNameMessage')
+        },
+        type: promptType,
+        default: () => defaultValue,
+        name: types_1.promptNames.destinationName,
+        message: () => (hint ? (0, i18n_1.t)('prompts.directBindingDestinationHint') : (0, i18n_1.t)('prompts.destinationNameMessage')),
+        validate: (destination) => {
+            return validators.validateDestinationQuestion(destination, !destination && isBAS);
+        },
+        source: (prevAnswers, input) => (0, inquirer_common_1.searchChoices)(input, destinationList),
+        choices: () => destinationList
+    };
+}
+/**
+ * Creates a prompt for managing application router during cf deployment.
+ *
+ *
+ * This function returns a confirmation question that asks whether to add a managed application router
+ * to the cf deployment. The prompt only appears if no mta file is found.
+ *
+ * @returns {ConfirmQuestion<CfDeployConfigAnswers>} Returns a confirmation question object for configuring the application router.
+ */
+function getAddManagedRouterPrompt() {
+    return {
+        type: 'confirm',
+        name: types_1.promptNames.addManagedAppRouter,
+        guiOptions: {
+            breadcrumb: (0, i18n_1.t)('prompts.addApplicationRouterBreadcrumbMessage')
+        },
+        message: () => (0, i18n_1.t)('prompts.generateManagedApplicationToRouterMessage'),
+        default: () => true
+    };
+}
+/**
+ *
+ * @returns A confirmation question object which overwrites destination.
+ */
+function getOverwritePrompt() {
+    return {
+        type: 'confirm',
+        name: types_1.promptNames.overwrite,
+        guiOptions: {
+            hint: (0, i18n_1.t)('prompts.overwriteHintMessage')
+        },
+        default: () => {
+            return true;
+        },
+        message: () => (0, i18n_1.t)('prompts.overwriteMessage')
+    };
+}
+/**
+ * Retrieves a list of deployment questions based on the application root and prompt options.
+ *
+ * @param {CfDeployConfigPromptOptions} promptOptions - The configuration options for prompting during cf target deployment.
+ * @param {Logger} [log] - The logger instance to use for logging.
+ * @returns {CfDeployConfigQuestions[]} Returns an array of questions related to cf deployment configuration.
+ */
+async function getQuestions(promptOptions, log) {
+    const destinationOptions = promptOptions[types_1.promptNames.destinationName];
+    const addOverwriteQuestion = promptOptions[types_1.promptNames.overwrite] ?? false;
+    const addManagedAppRouter = promptOptions[types_1.promptNames.addManagedAppRouter] ?? false;
+    const questions = [];
+    // Collect questions into an array
+    questions.push(await getDestinationNamePrompt(destinationOptions));
+    if (addManagedAppRouter) {
+        log?.info((0, i18n_1.t)('info.addManagedAppRouter'));
+        questions.push(getAddManagedRouterPrompt());
+    }
+    if (addOverwriteQuestion) {
+        log?.info((0, i18n_1.t)('info.overwriteDestination'));
+        questions.push(getOverwritePrompt());
+    }
+    return questions;
+}
+//# sourceMappingURL=prompts.js.map

package/dist/prompts/validators.d.ts

@@ -0,0 +1,12 @@
+import type { CfSystemChoice } from '../types';
+/**
+ * Validates the destination name or input string. If `allowEmptyChoice` is true,
+ * the validation will pass immediately. Otherwise, the input will be validated
+ * against rules (non-empty, valid characters, length check).
+ *
+ * @param {string} input - The destination name or input string to validate.
+ * @param {boolean} allowEmptyChoice - Whether to allow an empty input as a valid choice.
+ * @returns {boolean|string} `true` if the input is valid or empty choices are allowed, otherwise an error message.
+ */
+export declare function validateDestinationQuestion(input: string | CfSystemChoice, allowEmptyChoice?: boolean): boolean | string;
+//# sourceMappingURL=validators.d.ts.map

package/dist/prompts/validators.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateDestinationQuestion = validateDestinationQuestion;
+const i18n_1 = require("../i18n");
+/**
+ *
+ * @param input The input string to check for emptiness.
+ * @returns returns true if the input string is not empty, otherwise false.
+ */
+function isNotEmpty(input) {
+    return !!input?.trim();
+}
+/**
+ * Validates the input string for the following:
+ * - It must not be empty after trimming whitespace.
+ * - It must contain only alphanumeric characters, underscores, or dashes.
+ * - It must not exceed 200 characters.
+ *
+ * @param {string} input - The input string to validate.
+ * @returns {boolean|string} `true` if the input is valid, otherwise an error message.
+ */
+function validateInput(input) {
+    if (!isNotEmpty(input)) {
+        return (0, i18n_1.t)('errors.emptyDestinationNameError');
+    }
+    const result = /^[a-z0-9_-]+$/i.test(input);
+    if (!result) {
+        return (0, i18n_1.t)('errors.destinationNameError');
+    }
+    if (input.length > 200) {
+        return (0, i18n_1.t)('errors.destinationNameLengthError');
+    }
+    return true;
+}
+/**
+ * Validates the destination name or input string. If `allowEmptyChoice` is true,
+ * the validation will pass immediately. Otherwise, the input will be validated
+ * against rules (non-empty, valid characters, length check).
+ *
+ * @param {string} input - The destination name or input string to validate.
+ * @param {boolean} allowEmptyChoice - Whether to allow an empty input as a valid choice.
+ * @returns {boolean|string} `true` if the input is valid or empty choices are allowed, otherwise an error message.
+ */
+function validateDestinationQuestion(input, allowEmptyChoice = false) {
+    if (allowEmptyChoice) {
+        return true;
+    }
+    return typeof input === 'string' ? validateInput(input) : true;
+}
+//# sourceMappingURL=validators.js.map

package/dist/translations/cf-deploy-config-inquirer.i18n.json

@@ -0,0 +1,22 @@
+{
+    "prompts": {
+        "destinationNameMessage": "Destination name",
+        "addApplicationRouterBreadcrumbMessage": "Add to Router",
+        "generateManagedApplicationToRouterMessage": "Add application to managed application router?",
+        "directBindingDestinationHint": "Destination name - The app router is configured to use direct service binding",
+        "overwriteMessage": "Editing the deployment configuration will overwrite existing configuration, are you sure you want to continue?",
+        "overwriteHintMessage": "Deployment config will abort if you choose no. Click Finish to abort."
+    },
+    "errors": {
+        "emptyDestinationNameError": "You must provide a destination name in order to continue.",
+        "destinationNameError": "The destination name must only contain letters, digits, dashes and underscores.",
+        "destinationNameLengthError": "Destination name cannot contain more than 200 characters"
+    },
+    "warning": {
+        "btpDestinationListWarning": "BTP destinations are only retrieved on BAS"
+    },
+    "info": {
+        "addManagedAppRouter": "Add managed application router is enabled",
+        "overwriteDestination": "Overwriting destination is enabled"
+    }
+}

package/dist/types.d.ts

@@ -0,0 +1,81 @@
+import type { YUIQuestion } from '@sap-ux/inquirer-common';
+import type { AutocompleteQuestionOptions } from 'inquirer-autocomplete-prompt';
+/**
+ * Enum defining prompt names for Cloud Foundry (CF) deployment configuration.
+ */
+export declare enum promptNames {
+    /** The prompt to specify the destination name for CF deployment. */
+    destinationName = "destinationName",
+    /** The prompt to specify if a managed app router should be added to the deployment. */
+    addManagedAppRouter = "addManagedAppRouter",
+    /** The prompt for confirming destination overwrite. */
+    overwrite = "overwriteDestinationName"
+}
+/**
+ * Configuration options for the 'destinationName' prompt used in deployment settings.
+ */
+export type DestinationNamePromptOptions = {
+    /** Default value to suggest for the destination name. */
+    defaultValue: string;
+    /** Flag to indicate if a hint message should be shown to indicate the app router is configured.*/
+    hint?: boolean;
+    /**
+     * List of additional destination choices available for the prompt.
+     * - In BAS environments, this list will be appended to BTP destination options.
+     * - If `additionalChoiceList` is provided and the environment is VS Code,
+     *   the prompt will render as a list, allowing users to select from the provided choices instead of input.
+     */
+    additionalChoiceList?: CfSystemChoice[];
+    /**
+     * Indicates BTP destination list choices should be available for the prompt.
+     * If `addBTPDestinationList` is set to true, the prompt will include BTP destination choices else it will not.
+     * By default, this is set to true.
+     */
+    addBTPDestinationList?: boolean;
+    /**
+     * Flag to indicate if the destination prompt should use auto completion
+     */
+    useAutocomplete?: boolean;
+};
+/**
+ * Defines options for boolean-type prompts in CF deployment configuration.
+ */
+type booleanValuePromptOptions = Record<promptNames.overwrite, boolean> & Record<promptNames.addManagedAppRouter, boolean>;
+/**
+ * Defines options for string-type prompts in CF deployment configuration.
+ */
+type stringValuePromptOptions = Record<promptNames.destinationName, DestinationNamePromptOptions>;
+/**
+ * Configuration options for CF deployment prompts.
+ */
+export type CfDeployConfigPromptOptions = Partial<stringValuePromptOptions & booleanValuePromptOptions>;
+/**
+ * Represents a question in the CF deployment configuration.
+ * Extends `YUIQuestion` with optional autocomplete functionality.
+ */
+export type CfDeployConfigQuestions = YUIQuestion<CfDeployConfigAnswers> & Partial<Pick<AutocompleteQuestionOptions, 'source'>>;
+/**
+ * User responses for CF deployment configuration.
+ */
+export interface CfDeployConfigAnswers {
+    /** The selected Cloud Foundry destination. */
+    destinationName?: string;
+    /** Indicates whether the user opted to include a managed application router. */
+    addManagedRouter?: boolean;
+    overwrite?: boolean;
+}
+/**
+ * Interface for selectable system choices within prompts.
+ */
+export interface CfSystemChoice {
+    /** Display name of the system choice. */
+    name: string;
+    /** Value associated with the system choice. */
+    value: string;
+    /** Flag indicating if the system choice is an scp destination. */
+    scp: boolean;
+    /** URL associated with the system choice. */
+    url: string;
+}
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promptNames = void 0;
+/**
+ * Enum defining prompt names for Cloud Foundry (CF) deployment configuration.
+ */
+var promptNames;
+(function (promptNames) {
+    /** The prompt to specify the destination name for CF deployment. */
+    promptNames["destinationName"] = "destinationName";
+    /** The prompt to specify if a managed app router should be added to the deployment. */
+    promptNames["addManagedAppRouter"] = "addManagedAppRouter";
+    /** The prompt for confirming destination overwrite. */
+    promptNames["overwrite"] = "overwriteDestinationName";
+})(promptNames || (exports.promptNames = promptNames = {}));
+//# sourceMappingURL=types.js.map

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@sap-ux/cf-deploy-config-inquirer",
+  "description": "Prompts module that can provide prompts for cf deployment config writer",
+  "version": "0.0.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/cf-deploy-config-inquirer"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Acf-deploy-config-inquirer"
+  },
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "files": [
+    "LICENSE",
+    "dist",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "dependencies": {
+    "i18next": "23.5.1",
+    "inquirer-autocomplete-prompt": "2.0.1",
+    "@sap-ux/inquirer-common": "0.4.6",
+    "@sap-ux/btp-utils": "0.15.2",
+    "@sap-ux/logger": "0.6.0"
+  },
+  "devDependencies": {
+    "@sap-devx/yeoman-ui-types": "1.14.4",
+    "@types/inquirer-autocomplete-prompt": "2.0.1",
+    "@types/inquirer": "8.2.6",
+    "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"
+  }
+}