@sap-ux/odata-service-inquirer 2.14.9 → 2.14.11

package/dist/index.d.ts

@@ -30,9 +30,10 @@ declare function getPrompts(promptOptions?: OdataServicePromptOptions, logger?:
  *
  * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
  * @param isYUI - if true, the prompt is being called from the Yeoman UI extension host. PromptState.isYUI will be set to this value
+ * @param logger - set an externally configured logger
  * @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, isYUI?: boolean): Promise<{
+declare function getSystemSelectionQuestions(promptOptions?: OdataServicePromptOptions, isYUI?: boolean, logger?: Logger): Promise<{
     prompts: Question<SystemSelectionAnswers & ServiceAnswer>[];
     answers: Partial<OdataServiceAnswers>;
 }>;

package/dist/index.js

@@ -58,12 +58,16 @@ async function getPrompts(promptOptions, logger, enableGuidedAnswers = false, te
  *
  * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
  * @param isYUI - if true, the prompt is being called from the Yeoman UI extension host. PromptState.isYUI will be set to this value
+ * @param logger - set an externally configured logger
  * @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, isYUI) {
+async function getSystemSelectionQuestions(promptOptions, isYUI, logger) {
     if (isYUI !== undefined) {
         utils_1.PromptState.isYUI = isYUI;
     }
+    if (logger) {
+        logger_helper_1.default.logger = logger;
+    }
     return {
         prompts: await (0, system_selection_1.getSystemSelectionQuestions)(promptOptions),
         answers: utils_1.PromptState.odataService

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

@@ -15,6 +15,8 @@ const logger_helper_1 = __importDefault(require("../../../logger-helper"));
 const prompt_helpers_1 = require("../../../prompt-helpers");
 const service_helper_1 = require("../service-selection/service-helper");
 const value_help_download_1 = require("../external-services/value-help-download");
+const isEqual_1 = __importDefault(require("lodash/isEqual"));
+const sortBy_1 = __importDefault(require("lodash/sortBy"));
 const cliServicePromptName = 'cliServiceSelection';
 /**
  * Get the service selection prompt for an Abap system connection (on-prem or on-btp). The service selection prompt is used to select a service from the system catalog.
@@ -32,6 +34,7 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
     let previousSystemUrl;
     let previousClient;
     let previousService;
+    let previousServiceFilter;
     // State shared across validate and additionalMessages functions
     let hasBackendAnnotations;
     // Wrap to allow pass by ref to nested prompts
@@ -55,12 +58,14 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
         choices: async (answers) => {
             if (serviceChoices.length === 0 ||
                 previousSystemUrl !== connectValidator.validatedUrl ||
-                previousClient !== connectValidator.validatedClient) {
+                previousClient !== connectValidator.validatedClient ||
+                !(0, isEqual_1.default)((0, sortBy_1.default)(previousServiceFilter), (0, sortBy_1.default)(promptOptions?.serviceFilter))) {
                 // if we have a catalog, use it to list services
                 if (connectValidator.catalogs[odata_service_writer_1.OdataVersion.v2] || connectValidator.catalogs[odata_service_writer_1.OdataVersion.v4]) {
                     serviceChoices = await createServiceChoicesFromCatalog(connectValidator.catalogs, requiredOdataVersion, promptOptions?.serviceFilter);
                     previousSystemUrl = connectValidator.validatedUrl;
                     previousClient = connectValidator.validatedClient;
+                    previousServiceFilter = promptOptions?.serviceFilter ? [...promptOptions.serviceFilter] : undefined;
                     // Telemetry event for successful service listing using a destination
                     if (answers?.[`${types_1.promptNames.systemSelection}`]?.type === 'destination') {
                         (0, service_helper_1.sendDestinationServiceSuccessTelemetryEvent)(answers?.[`${types_1.promptNames.systemSelection}`]?.system);
@@ -98,7 +103,8 @@ function getSystemServiceQuestion(connectValidator, promptNamespace, promptOptio
                     showCollabDraftWarning: !!promptOptions?.showCollaborativeDraftWarning,
                     edmx: convertedMetadataRef.convertedMetadata
                 }
-                : undefined
+                : undefined,
+            serviceFilter: promptOptions?.serviceFilter
         }),
         default: () => (0, utils_1.getDefaultChoiceIndex)(serviceChoices),
         // Warning: only executes in YUI and cli when automcomplete is used

package/dist/prompts/datasources/sap-system/service-selection/service-helper.d.ts

@@ -73,12 +73,14 @@ type ShowCollabDraftWarnOptions = {
  * @param options.hasAnnotations used to determine whether to show a warning message that annotations could not be retrieved
  * @param options.showCollabDraftWarnOptions to show the collaborative draft warning, the option `showCollabDraftWarning` must be true
  *  and the edmx metadata must be provided
+ * @param options.serviceFilter if a service filter has been specified this may alter the user messages when no services are listed
  * @returns the service selection prompt additional message
  */
-export declare function getSelectedServiceMessage(serviceChoices: ListChoiceOptions<ServiceAnswer>[], selectedService: ServiceAnswer | undefined, connectValidator: ConnectionValidator, { requiredOdataVersion, hasAnnotations, showCollabDraftWarnOptions }: {
+export declare function getSelectedServiceMessage(serviceChoices: ListChoiceOptions<ServiceAnswer>[], selectedService: ServiceAnswer | undefined, connectValidator: ConnectionValidator, { requiredOdataVersion, hasAnnotations, showCollabDraftWarnOptions, serviceFilter }: {
     requiredOdataVersion?: OdataVersion;
     hasAnnotations?: boolean;
     showCollabDraftWarnOptions?: ShowCollabDraftWarnOptions;
+    serviceFilter?: string[];
 }): Promise<IMessageSeverity | undefined>;
 export {};
 //# sourceMappingURL=service-helper.d.ts.map

package/dist/prompts/datasources/sap-system/service-selection/service-helper.js

@@ -127,7 +127,7 @@ async function getServiceChoices(catalogs, serviceFilter) {
         logServiceCatalogErrorsForHelp(requestErrors, catalogs.length);
     }
     if (serviceFilter) {
-        flatServices = flatServices.filter((service) => serviceFilter.includes(service.id));
+        flatServices = flatServices.filter((service) => serviceFilter.includes(service.id) || serviceFilter.includes(service.path));
     }
     return createServiceChoices(flatServices);
 }
@@ -295,10 +295,22 @@ function getSelectedServiceLabel(username) {
  * @param options.hasAnnotations used to determine whether to show a warning message that annotations could not be retrieved
  * @param options.showCollabDraftWarnOptions to show the collaborative draft warning, the option `showCollabDraftWarning` must be true
  *  and the edmx metadata must be provided
+ * @param options.serviceFilter if a service filter has been specified this may alter the user messages when no services are listed
  * @returns the service selection prompt additional message
  */
-async function getSelectedServiceMessage(serviceChoices, selectedService, connectValidator, { requiredOdataVersion, hasAnnotations = true, showCollabDraftWarnOptions }) {
+async function getSelectedServiceMessage(serviceChoices, selectedService, connectValidator, { requiredOdataVersion, hasAnnotations = true, showCollabDraftWarnOptions, serviceFilter }) {
+    // Note that the order of these conditions is critical
     if (serviceChoices?.length === 0) {
+        if (serviceFilter && serviceFilter.length > 0) {
+            return {
+                message: (0, i18n_1.t)('warnings.specifiedServicesNotAvailable', {
+                    odataVersion: requiredOdataVersion ? `V${requiredOdataVersion} ` : undefined,
+                    service: serviceFilter[0],
+                    count: serviceFilter.length
+                }),
+                severity: yeoman_ui_types_1.Severity.warning
+            };
+        }
         if (requiredOdataVersion) {
             return {
                 message: (0, i18n_1.t)('warnings.noServicesAvailableForOdataVersion', {

package/dist/prompts/datasources/sap-system/system-selection/prompt-helpers.d.ts

@@ -51,5 +51,7 @@ export declare function createSystemChoices(destinationFilters?: Partial<Destina
  * @param defaultChoice the default choice value
  * @returns the index of the default choice in the system choices list
  */
-export declare function findDefaultSystemSelectionIndex(systemChoices: ListChoiceOptions<SystemSelectionAnswerType>[], defaultChoice: string | undefined): number;
+export declare function findDefaultSystemSelectionIndex(systemChoices: ListChoiceOptions<SystemSelectionAnswerType>[], defaultChoice: string | {
+    value?: string;
+} | undefined): number;
 //# sourceMappingURL=prompt-helpers.d.ts.map

package/dist/prompts/datasources/sap-system/system-selection/prompt-helpers.js

@@ -212,22 +212,23 @@ async function createSystemChoices(destinationFilters, includeCloudFoundryAbapEn
  * @returns the index of the default choice in the system choices list
  */
 function findDefaultSystemSelectionIndex(systemChoices, defaultChoice) {
-    if (!defaultChoice) {
+    const choice = typeof defaultChoice === 'string' ? defaultChoice : defaultChoice?.value;
+    if (!choice) {
         return -1;
     }
-    const defaultChoiceIndex = systemChoices.findIndex((choice) => {
-        const { type: systemType, system } = choice.value;
+    const defaultChoiceIndex = systemChoices.findIndex((systemChoice) => {
+        const { type: systemType, system } = systemChoice.value;
         if (systemType === 'destination') {
-            return system.Name === defaultChoice;
+            return system.Name === choice;
         }
         if (systemType === 'backendSystem') {
-            return system.name === defaultChoice;
+            return system.name === choice;
         }
         if (systemType === 'newSystemChoice') {
-            return defaultChoice === exports.NewSystemChoice;
+            return choice === exports.NewSystemChoice;
         }
         if (systemType === 'cfAbapEnvService') {
-            return defaultChoice === exports.CfAbapEnvServiceChoice;
+            return choice === exports.CfAbapEnvServiceChoice;
         }
     });
     return defaultChoiceIndex;

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

@@ -100,7 +100,7 @@ async function getSystemConnectionQuestions(connectionValidator, promptOptions,
     const requiredOdataVersion = promptOptions?.serviceSelection?.requiredOdataVersion;
     const destinationFilters = promptOptions?.systemSelection?.destinationFilters;
     const systemChoices = await (0, prompt_helpers_1.createSystemChoices)(destinationFilters, promptOptions?.systemSelection?.includeCloudFoundryAbapEnvChoice, promptOptions?.systemSelection?.hideNewSystem);
-    const defaultChoiceIndex = (0, prompt_helpers_1.findDefaultSystemSelectionIndex)(systemChoices, promptOptions?.systemSelection?.defaultChoice);
+    let defaultChoiceIndex = (0, prompt_helpers_1.findDefaultSystemSelectionIndex)(systemChoices, promptOptions?.systemSelection?.defaultChoice);
     const shouldOnlyShowDefaultChoice = promptOptions?.systemSelection?.onlyShowDefaultChoice && promptOptions?.systemSelection?.defaultChoice;
     const questions = [
         {
@@ -113,7 +113,13 @@ async function getSystemConnectionQuestions(connectionValidator, promptOptions,
             },
             source: (prevAnswers, input) => (0, inquirer_common_1.searchChoices)(input, systemChoices),
             choices: shouldOnlyShowDefaultChoice ? [systemChoices[defaultChoiceIndex]] : systemChoices,
-            default: shouldOnlyShowDefaultChoice ? 0 : defaultChoiceIndex,
+            default: () => {
+                if (shouldOnlyShowDefaultChoice) {
+                    return 0;
+                }
+                defaultChoiceIndex = (0, prompt_helpers_1.findDefaultSystemSelectionIndex)(systemChoices, promptOptions?.systemSelection?.defaultChoice); // Recalc to allow default choice to be bound to ref from another prompt
+                return defaultChoiceIndex;
+            },
             validate: async (selectedSystem) => {
                 if (!selectedSystem) {
                     return false;

package/dist/translations/odata-service-inquirer.i18n.json

@@ -261,8 +261,10 @@
         "certificateErrors": "A certificate error occurred when connecting to the host: {{-url}}. Certificate error: {{error}}.",
         "allowingUnauthorizedCertsNode": "Setting the `NODE_TLS_REJECT_UNAUTHORIZED` environment variable to `0` makes TLS connections and HTTPS requests insecure by disabling certificate verification. It is important to understand the security risks when using this setting.",
         "certErrorIgnoredByNodeSetting": "An SSL certificate error is being ignored by the 'NODE_TLS_REJECT_UNAUTHORIZED=0' Node.js setting. This makes TLS connections and HTTPS requests insecure by disabling certificate verification. For details of the certification error, see the logs.",
-        "noExternalServiceMetdataFetched": "No external service metadata were fetched. $t(texts.seeLogForDetails).",
-        "missingServices": "OData V{{odataVersion}} services are not available."
+        "noExternalServiceMetdataFetched": "No external service metadata was fetched. $t(texts.seeLogForDetails)",
+        "missingServices": "OData V{{odataVersion}} services are not available.",
+        "specifiedServicesNotAvailable_one": "The required OData service: {{-service}} is not available from the {{odataVersion}}services catalog. Please ensure the service is available.",
+        "specifiedServicesNotAvailable_other": "The required OData services are not available from the {{odataVersion}}services catalog. Please ensure the services are available. $t(texts.seeLogForDetails)"
     },
     "texts": {
         "suggestedSystemNameClient": ", client {{client}}",

package/dist/types.d.ts

@@ -286,9 +286,12 @@ export type SystemSelectionPromptOptions = {
      * Provide a default choice for the system selection prompt, this is used to pre-select a system based on the system name.
      * Set as string literal types `NewSystemChoice` or `CfAbapEnvServiceChoice` to specify the default choice to create a new system connection config in VSCode
      * or to select the Cloud Foundry Abap environments service discovery choice in BAS respectively.
+     * Supported as object reference `{ value: }` to allow binding to runtime variables of other prompts or as string
      *
      */
-    defaultChoice?: string;
+    defaultChoice?: string | {
+        value?: 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,
@@ -296,7 +299,7 @@ export type SystemSelectionPromptOptions = {
      */
     onlyShowDefaultChoice?: boolean;
     /**
-     * If true, the 'New System' option is not added to the system selection list.
+     * If true, the 'New System' option is not added to the system selection list. Default is false - the 'New System' option will be available.
      */
     hideNewSystem?: boolean;
 };
@@ -327,7 +330,7 @@ export type ServiceSelectionPromptOptions = {
      */
     showCollaborativeDraftWarning?: boolean;
     /**
-     * A list of service ids ({@link ODataServiceInfo.id}), used to filter the catalog results
+     * A list of service ids ({@link ODataServiceInfo.id}) or service paths ({@link ODataServiceInfo.path}), used to filter the service catalog results
      */
     serviceFilter?: string[];
 } & Pick<CommonPromptOptions, 'additionalMessages'>;

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": "2.14.9",
+  "version": "2.14.11",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -28,18 +28,19 @@
     "fast-xml-parser": "4.4.1",
     "i18next": "25.3.0",
     "inquirer-autocomplete-prompt": "2.0.1",
+    "lodash": "4.17.21",
     "os-name": "4.0.1",
     "@sap-ux/axios-extension": "1.25.6",
-    "@sap-ux/btp-utils": "1.1.6",
+    "@sap-ux/guided-answers-helper": "0.4.2",
     "@sap-ux/telemetry": "0.6.56",
+    "@sap-ux/fiori-generator-shared": "0.13.54",
+    "@sap-ux/btp-utils": "1.1.6",
     "@sap-ux/inquirer-common": "0.10.14",
     "@sap-ux/logger": "0.8.0",
-    "@sap-ux/fiori-generator-shared": "0.13.54",
     "@sap-ux/nodejs-utils": "0.2.11",
-    "@sap-ux/guided-answers-helper": "0.4.2",
+    "@sap-ux/project-access": "1.34.2",
     "@sap-ux/project-input-validator": "0.6.45",
-    "@sap-ux/store": "1.5.0",
-    "@sap-ux/project-access": "1.34.2"
+    "@sap-ux/store": "1.5.0"
   },
   "devDependencies": {
     "@sap-ux/vocabularies-types": "0.14.5",
@@ -48,9 +49,9 @@
     "@types/inquirer": "8.2.6",
     "@types/lodash": "4.14.202",
     "jest-extended": "6.0.0",
-    "@sap-ux/fiori-generator-shared": "0.13.54",
-    "@sap-ux/fiori-elements-writer": "2.8.40",
+    "@sap-ux/fiori-elements-writer": "2.8.42",
     "@sap-ux/fiori-freestyle-writer": "2.5.29",
+    "@sap-ux/fiori-generator-shared": "0.13.54",
     "@sap-ux/feature-toggle": "0.3.5",
     "@sap-ux/odata-service-writer": "0.29.8",
     "@sap-ux/cap-config-writer": "0.12.45"