@sap-ux/odata-service-inquirer 0.7.14 → 0.8.0

package/dist/index.d.ts

@@ -1,9 +1,11 @@
 import { type InquirerAdapter } from '@sap-ux/inquirer-common';
+import type { Question } from 'inquirer';
 import { type Logger } from '@sap-ux/logger';
 import { OdataVersion } from '@sap-ux/odata-service-writer';
 import { type ToolsSuiteTelemetryClient } from '@sap-ux/telemetry';
 import { ERROR_TYPE, ErrorHandler } from '@sap-ux/inquirer-common';
-import { SystemSelectionAnswerType } from './prompts/datasources/sap-system/system-selection';
+import { type SystemSelectionAnswers, SystemSelectionAnswerType } from './prompts/datasources/sap-system/system-selection';
+import type { ServiceAnswer } from './prompts/datasources/sap-system/service-selection';
 import type { NewSystemChoice, CfAbapEnvServiceChoice } from './prompts/datasources/sap-system/system-selection/prompt-helpers';
 import { DatasourceType, promptNames, type CapRuntime, type CapService, type OdataServiceAnswers, type OdataServicePromptOptions, type OdataServiceQuestion, type SapSystemType } from './types';
 /**
@@ -20,6 +22,16 @@ declare function getPrompts(promptOptions?: OdataServicePromptOptions, logger?:
     prompts: OdataServiceQuestion[];
     answers: Partial<OdataServiceAnswers>;
 }>;
+/**
+ * Get the system selection questions.
+ *
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
+ * @returns the prompts used to provide input for system selection and a reference to the answers object which will be populated with the user's responses once `inquirer.prompt` returns
+ */
+declare function getSystemSelectionQuestions(promptOptions?: OdataServicePromptOptions): Promise<{
+    prompts: Question<SystemSelectionAnswers & ServiceAnswer>[];
+    answers: Partial<OdataServiceAnswers>;
+}>;
 /**
  * Prompt for odata service writer inputs.
  *
@@ -32,5 +44,5 @@ declare function getPrompts(promptOptions?: OdataServicePromptOptions, logger?:
  * @returns the prompt answers
  */
 declare function prompt(adapter: InquirerAdapter, promptOptions?: OdataServicePromptOptions, logger?: Logger, enableGuidedAnswers?: boolean, telemetryClient?: ToolsSuiteTelemetryClient, isYUI?: boolean): Promise<OdataServiceAnswers>;
-export { DatasourceType, ERROR_TYPE, ErrorHandler, getPrompts, OdataVersion, prompt, promptNames, SystemSelectionAnswerType, type CapRuntime, type CapService, type InquirerAdapter, type OdataServiceAnswers, type OdataServicePromptOptions, type SapSystemType, NewSystemChoice, CfAbapEnvServiceChoice };
+export { DatasourceType, ERROR_TYPE, ErrorHandler, getPrompts, OdataVersion, prompt, promptNames, SystemSelectionAnswerType, type CapRuntime, type CapService, type InquirerAdapter, type OdataServiceAnswers, type OdataServicePromptOptions, type SapSystemType, NewSystemChoice, CfAbapEnvServiceChoice, getSystemSelectionQuestions };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.promptNames = exports.OdataVersion = exports.ErrorHandler = exports.ERROR_TYPE = exports.DatasourceType = void 0;
 exports.getPrompts = getPrompts;
 exports.prompt = prompt;
+exports.getSystemSelectionQuestions = getSystemSelectionQuestions;
 const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
 Object.defineProperty(exports, "OdataVersion", { enumerable: true, get: function () { return odata_service_writer_1.OdataVersion; } });
 const inquirer_autocomplete_prompt_1 = __importDefault(require("inquirer-autocomplete-prompt"));
@@ -14,6 +15,7 @@ Object.defineProperty(exports, "ERROR_TYPE", { enumerable: true, get: function (
 Object.defineProperty(exports, "ErrorHandler", { enumerable: true, get: function () { return inquirer_common_1.ErrorHandler; } });
 const i18n_1 = require("./i18n");
 const prompts_1 = require("./prompts");
+const system_selection_1 = require("./prompts/datasources/sap-system/system-selection");
 const logger_helper_1 = __importDefault(require("./prompts/logger-helper"));
 const types_1 = require("./types");
 Object.defineProperty(exports, "DatasourceType", { enumerable: true, get: function () { return types_1.DatasourceType; } });
@@ -48,6 +50,18 @@ async function getPrompts(promptOptions, logger, enableGuidedAnswers = false, te
         answers: utils_1.PromptState.odataService
     };
 }
+/**
+ * Get the system selection questions.
+ *
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
+ * @returns the prompts used to provide input for system selection and a reference to the answers object which will be populated with the user's responses once `inquirer.prompt` returns
+ */
+async function getSystemSelectionQuestions(promptOptions) {
+    return {
+        prompts: await (0, system_selection_1.getSystemSelectionQuestions)(promptOptions),
+        answers: utils_1.PromptState.odataService
+    };
+}
 /**
  * Prompt for odata service writer inputs.
  *

package/dist/prompts/datasources/sap-system/system-selection/questions.js

@@ -70,8 +70,9 @@ async function getSystemSelectionQuestions(promptOptions) {
     const connectValidator = new connectionValidator_1.ConnectionValidator();
     const questions = await getSystemConnectionQuestions(connectValidator, promptOptions);
     // Existing system (BackendSystem or Destination) selected,
-    // In future, make the service prompt optional by wrapping in condition `[promptOptions?.serviceSelection?.hide]`
-    questions.push(...(0, inquirer_common_1.withCondition)((0, questions_3.getSystemServiceQuestion)(connectValidator, systemSelectionPromptNamespace, promptOptions?.serviceSelection), (answers) => answers.systemSelection?.type !== 'newSystemChoice'));
+    if (!promptOptions?.serviceSelection?.hide) {
+        questions.push(...(0, inquirer_common_1.withCondition)((0, questions_3.getSystemServiceQuestion)(connectValidator, systemSelectionPromptNamespace, promptOptions?.serviceSelection), (answers) => answers.systemSelection?.type !== 'newSystemChoice'));
+    }
     // Create new system connection for storage only supported on non-App Studio environments
     if (!(0, btp_utils_1.isAppStudio)()) {
         questions.push(...(0, inquirer_common_1.withCondition)((0, questions_2.getNewSystemQuestions)(promptOptions), (answers) => answers.systemSelection?.type === 'newSystemChoice'));
@@ -92,6 +93,7 @@ async function getSystemConnectionQuestions(connectionValidator, promptOptions)
     const destinationFilters = promptOptions?.systemSelection?.destinationFilters;
     const systemChoices = await (0, prompt_helpers_1.createSystemChoices)(destinationFilters, promptOptions?.systemSelection?.includeCloudFoundryAbapEnvChoice);
     const defaultChoiceIndex = (0, prompt_helpers_1.findDefaultSystemSelectionIndex)(systemChoices, promptOptions?.systemSelection?.defaultChoice);
+    const shouldOnlyShowDefaultChoice = promptOptions?.systemSelection?.onlyShowDefaultChoice && promptOptions?.systemSelection?.defaultChoice;
     const questions = [
         {
             type: promptOptions?.systemSelection?.useAutoComplete ? 'autocomplete' : 'list',
@@ -102,8 +104,8 @@ async function getSystemConnectionQuestions(connectionValidator, promptOptions)
                 hint: (0, i18n_1.t)('prompts.systemSelection.hint')
             },
             source: (prevAnswers, input) => (0, inquirer_common_1.searchChoices)(input, systemChoices),
-            choices: systemChoices,
-            default: defaultChoiceIndex,
+            choices: shouldOnlyShowDefaultChoice ? [systemChoices[defaultChoiceIndex]] : systemChoices,
+            default: shouldOnlyShowDefaultChoice ? 0 : defaultChoiceIndex,
             validate: async (selectedSystem) => {
                 if (!selectedSystem) {
                     return false;

package/dist/types.d.ts

@@ -238,6 +238,12 @@ export type SystemSelectionPromptOptions = {
      *
      */
     defaultChoice?: string;
+    /**
+     * Only show the default choice in the system selection prompt, this is used to skip the system selection prompt if the default choice is already known.
+     * If the `defaultChoice` value is not found in the systems choices, or the `defaultChoice` option is not specified,
+     * this option will not be applied and the full list of choices will be presented to the user.
+     */
+    onlyShowDefaultChoice?: boolean;
 };
 export type MetadataPromptOptions = {
     /**
@@ -255,6 +261,11 @@ export type ServiceSelectionPromptOptions = {
      * Used to validate the selected service is of the required odata version
      */
     requiredOdataVersion?: OdataVersion;
+    /**
+     * This allows the prompt to be excluded where consuming generators only require the system connection functionality.
+     * If the service selection prompt is hidden then the odata service related answer properties will not be returned.
+     */
+    hide?: boolean;
 } & Pick<CommonPromptOptions, 'additionalMessages'>;
 export type SystemNamePromptOptions = {
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/odata-service-inquirer",
   "description": "Prompts module that can prompt users for inputs required for odata service writing",
-  "version": "0.7.14",
+  "version": "0.8.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -28,14 +28,14 @@
     "os-name": "4.0.1",
     "@sap-ux/axios-extension": "1.17.8",
     "@sap-ux/btp-utils": "0.17.2",
+    "@sap-ux/fiori-generator-shared": "0.7.17",
     "@sap-ux/guided-answers-helper": "0.1.1",
     "@sap-ux/telemetry": "0.5.50",
-    "@sap-ux/fiori-generator-shared": "0.7.17",
     "@sap-ux/inquirer-common": "0.5.15",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/project-access": "1.28.10",
-    "@sap-ux/project-input-validator": "0.3.4",
-    "@sap-ux/store": "1.0.0"
+    "@sap-ux/store": "1.0.0",
+    "@sap-ux/project-input-validator": "0.3.4"
   },
   "devDependencies": {
     "@sap-devx/yeoman-ui-types": "1.14.4",
@@ -44,8 +44,8 @@
     "@types/lodash": "4.14.202",
     "jest-extended": "3.2.4",
     "@sap-ux/fiori-generator-shared": "0.7.17",
-    "@sap-ux/odata-service-writer": "0.25.0",
-    "@sap-ux/feature-toggle": "0.2.3"
+    "@sap-ux/feature-toggle": "0.2.3",
+    "@sap-ux/odata-service-writer": "0.25.0"
   },
   "engines": {
     "node": ">=18.x"