@sap-ux/odata-service-inquirer 0.5.60 → 0.6.0

package/dist/types.js

@@ -7,12 +7,14 @@ exports.SAP_CLIENT_KEY = exports.hostEnvironment = exports.ValidationLink = expo
 var DatasourceType;
 (function (DatasourceType) {
     DatasourceType["sapSystem"] = "sapSystem";
-    DatasourceType["businessHub"] = "businessHub";
     DatasourceType["capProject"] = "capProject";
     DatasourceType["odataServiceUrl"] = "odataServiceUrl";
     DatasourceType["none"] = "none";
     DatasourceType["metadataFile"] = "metadataFile";
+    // @deprecated
     DatasourceType["projectSpecificDestination"] = "projectSpecificDestination";
+    // @deprecated
+    DatasourceType["businessHub"] = "businessHub";
 })(DatasourceType || (exports.DatasourceType = DatasourceType = {}));
 exports.SapSystemTypes = {
     abapOnPrem: 'abapOnPrem',
@@ -55,6 +57,10 @@ var promptNames;
      * Newly created systems can be named for storage
      */
     promptNames["userSystemName"] = "userSystemName";
+    /**
+     * System selection
+     */
+    promptNames["systemSelection"] = "systemSelection";
 })(promptNames || (exports.promptNames = promptNames = {}));
 /**
  * Implementation of IValidationLink interface.

package/dist/utils/index.d.ts

@@ -1,8 +1,10 @@
-import type { TelemetryProperties, ToolsSuiteTelemetryClient } from '@sap-ux/telemetry';
-import { PromptState } from './prompt-state';
-import { OdataVersion } from '@sap-ux/odata-service-writer';
 import { ODataVersion } from '@sap-ux/axios-extension';
+import { type Destination } from '@sap-ux/btp-utils';
+import { OdataVersion } from '@sap-ux/odata-service-writer';
+import type { TelemetryProperties, ToolsSuiteTelemetryClient } from '@sap-ux/telemetry';
 import type { ListChoiceOptions } from 'inquirer';
+import { PromptState } from './prompt-state';
+export type TelemPropertyDestinationType = 'AbapODataCatalogDest' | 'GenericODataFullUrlDest' | 'GenericODataPartialUrlDest' | 'Unknown';
 /**
  * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
  *
@@ -25,6 +27,13 @@ export declare function setTelemetryClient(toolsSuiteTelemetryClient: ToolsSuite
  * @param telemetryData the telemetry values to report
  */
 export declare function sendTelemetryEvent(eventName: string, telemetryData: TelemetryProperties): void;
+/**
+ * Used only to generate telemetry events in the case of destination errors.
+ *
+ * @param destination
+ * @returns the telemetry property destination type
+ */
+export declare function getTelemPropertyDestinationType(destination: Destination): TelemPropertyDestinationType;
 /**
  * Validate xml and parse the odata version from the metadata xml.
  *

package/dist/utils/index.js

@@ -7,21 +7,22 @@ exports.PromptState = void 0;
 exports.getHostEnvironment = getHostEnvironment;
 exports.setTelemetryClient = setTelemetryClient;
 exports.sendTelemetryEvent = sendTelemetryEvent;
+exports.getTelemPropertyDestinationType = getTelemPropertyDestinationType;
 exports.parseOdataVersion = parseOdataVersion;
 exports.originToRelative = originToRelative;
 exports.convertODataVersionType = convertODataVersionType;
 exports.getDefaultChoiceIndex = getDefaultChoiceIndex;
+const axios_extension_1 = require("@sap-ux/axios-extension");
 const btp_utils_1 = require("@sap-ux/btp-utils");
+const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
 const telemetry_1 = require("@sap-ux/telemetry");
+const fast_xml_parser_1 = require("fast-xml-parser");
 const os_name_1 = __importDefault(require("os-name"));
+const i18n_1 = require("../i18n");
+const logger_helper_1 = __importDefault(require("../prompts/logger-helper"));
 const types_1 = require("../types");
 const prompt_state_1 = require("./prompt-state");
 Object.defineProperty(exports, "PromptState", { enumerable: true, get: function () { return prompt_state_1.PromptState; } });
-const fast_xml_parser_1 = require("fast-xml-parser");
-const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
-const logger_helper_1 = __importDefault(require("../prompts/logger-helper"));
-const i18n_1 = require("../i18n");
-const axios_extension_1 = require("@sap-ux/axios-extension");
 const osVersionName = (0, os_name_1.default)();
 /**
  * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
@@ -54,6 +55,7 @@ function setTelemetryClient(toolsSuiteTelemetryClient) {
 function sendTelemetryEvent(eventName, telemetryData) {
     const telemetryEvent = createTelemetryEvent(eventName, telemetryData);
     if (telemetryClient) {
+        // Do not wait for the telemetry event to be sent, it cannot be recovered if it fails, do not block the process
         /* eslint-disable @typescript-eslint/no-floating-promises */
         telemetryClient.reportEvent(telemetryEvent, telemetry_1.SampleRate.NoSampling);
     }
@@ -76,6 +78,26 @@ function createTelemetryEvent(eventName, telemetryData) {
         measurements: {}
     };
 }
+/**
+ * Used only to generate telemetry events in the case of destination errors.
+ *
+ * @param destination
+ * @returns the telemetry property destination type
+ */
+function getTelemPropertyDestinationType(destination) {
+    if ((0, btp_utils_1.isAbapODataDestination)(destination)) {
+        return 'AbapODataCatalogDest';
+    }
+    else if ((0, btp_utils_1.isFullUrlDestination)(destination)) {
+        return 'GenericODataFullUrlDest';
+    }
+    else if ((0, btp_utils_1.isPartialUrlDestination)(destination)) {
+        return 'GenericODataPartialUrlDest';
+    }
+    else {
+        return 'Unknown';
+    }
+}
 /**
  * Validate xml and parse the odata version from the metadata xml.
  *

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.5.60",
+  "version": "0.6.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -26,10 +26,11 @@
     "i18next": "23.5.1",
     "inquirer-autocomplete-prompt": "2.0.1",
     "os-name": "4.0.1",
-    "@sap-ux/axios-extension": "1.17.1",
-    "@sap-ux/btp-utils": "0.15.2",
-    "@sap-ux/guided-answers-helper": "0.0.2",
-    "@sap-ux/telemetry": "0.5.41",
+    "@sap-ux/axios-extension": "1.17.2",
+    "@sap-ux/btp-utils": "0.16.0",
+    "@sap-ux/fiori-generator-shared": "0.7.6",
+    "@sap-ux/guided-answers-helper": "0.1.0",
+    "@sap-ux/telemetry": "0.5.42",
     "@sap-ux/inquirer-common": "0.4.10",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/project-access": "1.28.6",
@@ -42,7 +43,6 @@
     "@types/inquirer": "8.2.6",
     "@types/lodash": "4.14.202",
     "jest-extended": "3.2.4",
-    "lodash": "4.17.21",
     "@sap-ux/odata-service-writer": "0.23.1",
     "@sap-ux/feature-toggle": "0.2.2"
   },

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

@@ -1,43 +0,0 @@
-import { type CatalogService, ServiceType, V2CatalogService, type Annotations, type ServiceProvider } from '@sap-ux/axios-extension';
-import type { ListChoiceOptions } from 'inquirer';
-import type { ServiceAnswer } from './types';
-import type { ConnectionValidator } from '../../../connectionValidator';
-/**
- * Get the service choices from the specified catalogs.
- *
- * @param catalogs catalogs to get the services from. There should be one per odata version required.
- * @returns service choices based on the provided catalogs
- */
-export declare function getServiceChoices(catalogs: CatalogService[]): Promise<ListChoiceOptions<ServiceAnswer>[]>;
-/**
- * Gets the service metadata and annotations for the specified service path.
- *
- * @param servicePath service path
- * @param catalog the catalog service used to get the annotations for the specified service path
- * @param serviceProvider the service provider for the connected system
- * @returns Promise<string | boolean>, string error message or true if successful
- */
-export declare function getServiceMetadata(servicePath: string, catalog: CatalogService, serviceProvider: ServiceProvider): Promise<{
-    annotations: Annotations[];
-    metadata: string;
-    serviceProvider: ServiceProvider;
-} | string>;
-/**
- * Get service type for 'Not Determined' services from `ServiceTypeForHUBServices()`
- *
- * @param servicePath service path
- * @param serviceType service type
- * @param catalog the catalog service used to get the service type for the specified service path
- * @returns service type
- */
-export declare function getServiceType(servicePath: string, serviceType: string | undefined, catalog: V2CatalogService): Promise<ServiceType | undefined>;
-/**
- * Requests and sets the service details to the PromptState.odataService properties.
- * If an error occurs, the error message is returned for use in validators.
- *
- * @param service the specific service to get details for
- * @param connectionValidator a reference to the connection validator which has an active connection to the backend
- * @returns true if successful, setting the PromptState.odataService properties, or an error message indicating why the service details could not be retrieved.
- */
-export declare function getServiceDetails(service: ServiceAnswer, connectionValidator: ConnectionValidator): Promise<string | boolean>;
-//# sourceMappingURL=service-helper.d.ts.map

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

@@ -1,175 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getServiceChoices = getServiceChoices;
-exports.getServiceMetadata = getServiceMetadata;
-exports.getServiceType = getServiceType;
-exports.getServiceDetails = getServiceDetails;
-const axios_extension_1 = require("@sap-ux/axios-extension");
-const i18n_1 = require("../../../../i18n");
-const logger_helper_1 = __importDefault(require("../../../logger-helper"));
-const utils_1 = require("../../../../utils");
-const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
-const prompt_helpers_1 = require("../../../prompt-helpers");
-// Service ids continaining these paths should not be offered as UI compatible services
-const nonUIServicePaths = ['/IWBEP/COMMON/'];
-/**
- * Builds and formats the service choices list.
- *
- * @param serviceInfos service information to build the choices from. Services with a service id containing '/IWBEP/COMMON' are ignored.
- * @returns service choices list
- */
-const createServiceChoices = (serviceInfos) => {
-    const choices = [];
-    // Provide additional service information in trace mode (YUI only)
-    let isLogTrace = false;
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Only specific loggers have this method
-    if (typeof logger_helper_1.default.logger.getLogLevel === 'function') {
-        isLogTrace = logger_helper_1.default.logger.getLogLevel() === 'trace';
-    }
-    serviceInfos
-        // Exclude non-UI compatible services
-        ?.filter((service) => !nonUIServicePaths.some((path) => service.path.includes(path)))
-        .forEach((service) => {
-        let serviceName = service.name;
-        const servicePath = service.path;
-        serviceName = `${serviceName} (${service.serviceVersion}) - OData V${service.odataVersion}`;
-        if (isLogTrace) {
-            serviceName = `${serviceName} Service Type: ${service.serviceType}`;
-        }
-        choices.push({
-            name: serviceName,
-            value: {
-                servicePath,
-                serviceODataVersion: service.odataVersion,
-                toString: () => serviceName,
-                serviceType: service.serviceType
-            }
-        });
-    });
-    return choices.sort((a, b) => (a.name ? a.name.localeCompare(b.name ?? '') : 0));
-};
-/**
- * Logs the catalog reuest errors.
- *
- * @param requestErrors catalog request errors
- */
-function logErrorsForHelp(requestErrors) {
-    // Log the first error only
-    const catalogErrors = Object.values(requestErrors);
-    if (catalogErrors.length > 0) {
-        catalogErrors.forEach((error) => prompt_helpers_1.errorHandler.logErrorMsgs(error));
-    }
-}
-/**
- * Get the service choices from the specified catalogs.
- *
- * @param catalogs catalogs to get the services from. There should be one per odata version required.
- * @returns service choices based on the provided catalogs
- */
-async function getServiceChoices(catalogs) {
-    const requestErrors = {};
-    const listServicesRequests = catalogs.map(async (catalog) => {
-        try {
-            return await catalog.listServices();
-        }
-        catch (error) {
-            logger_helper_1.default.logger.error((0, i18n_1.t)('errors.serviceCatalogRequest', {
-                catalogRequestUri: catalog.getUri(),
-                entitySet: catalog.entitySet,
-                error
-            }));
-            // Save any errors for processing later as we may show more useful message to the user
-            Object.assign(requestErrors, {
-                [catalog instanceof axios_extension_1.V2CatalogService ? axios_extension_1.ODataVersion.v2 : axios_extension_1.ODataVersion.v4]: error
-            });
-            return [];
-        }
-    });
-    const serviceInfos = await Promise.all(listServicesRequests);
-    const flatServices = serviceInfos?.flat() ?? [];
-    logger_helper_1.default.logger.debug(`Number of services available: ${flatServices.length}`);
-    if (flatServices.length === 0) {
-        logErrorsForHelp(requestErrors);
-    }
-    return createServiceChoices(flatServices);
-}
-/**
- * Gets the service metadata and annotations for the specified service path.
- *
- * @param servicePath service path
- * @param catalog the catalog service used to get the annotations for the specified service path
- * @param serviceProvider the service provider for the connected system
- * @returns Promise<string | boolean>, string error message or true if successful
- */
-async function getServiceMetadata(servicePath, catalog, serviceProvider) {
-    let annotations = [];
-    try {
-        try {
-            annotations = await catalog.getAnnotations({ path: servicePath });
-        }
-        catch {
-            logger_helper_1.default.logger.info((0, i18n_1.t)('prompts.validationMessages.noAnnotations'));
-        }
-        const odataService = serviceProvider.service(servicePath);
-        const metadata = await odataService.metadata();
-        return {
-            annotations,
-            metadata,
-            serviceProvider
-        };
-    }
-    catch (error) {
-        logger_helper_1.default.logger.error((0, i18n_1.t)('errors.serviceMetadataErrorLog', { servicePath, error }));
-        return (0, i18n_1.t)('errors.serviceMetadataErrorUI', { servicePath });
-    }
-}
-/**
- * Get service type for 'Not Determined' services from `ServiceTypeForHUBServices()`
- *
- * @param servicePath service path
- * @param serviceType service type
- * @param catalog the catalog service used to get the service type for the specified service path
- * @returns service type
- */
-async function getServiceType(servicePath, serviceType, catalog) {
-    let resolvedServiceType;
-    if (serviceType === axios_extension_1.ServiceType.NotDetermined) {
-        try {
-            resolvedServiceType = (await catalog.getServiceType(servicePath)) ?? axios_extension_1.ServiceType.NotDetermined;
-        }
-        catch (e) {
-            logger_helper_1.default.logger.error((0, i18n_1.t)('errors.serviceTypeRequestError', { error: e.message }));
-        }
-    }
-    return resolvedServiceType ?? serviceType;
-}
-/**
- * Requests and sets the service details to the PromptState.odataService properties.
- * If an error occurs, the error message is returned for use in validators.
- *
- * @param service the specific service to get details for
- * @param connectionValidator a reference to the connection validator which has an active connection to the backend
- * @returns true if successful, setting the PromptState.odataService properties, or an error message indicating why the service details could not be retrieved.
- */
-async function getServiceDetails(service, connectionValidator) {
-    const serviceCatalog = connectionValidator.catalogs[service.serviceODataVersion];
-    if (!serviceCatalog || !connectionValidator.serviceProvider) {
-        logger_helper_1.default.logger.error('ConenctionValidator is not initialized');
-        return false;
-    }
-    const serviceResult = await getServiceMetadata(service.servicePath, serviceCatalog, connectionValidator.serviceProvider);
-    if (typeof serviceResult === 'string') {
-        return serviceResult;
-    }
-    utils_1.PromptState.odataService.annotations = serviceResult?.annotations;
-    utils_1.PromptState.odataService.metadata = serviceResult?.metadata;
-    utils_1.PromptState.odataService.odataVersion =
-        service.serviceODataVersion === axios_extension_1.ODataVersion.v2 ? odata_service_writer_1.OdataVersion.v2 : odata_service_writer_1.OdataVersion.v4;
-    utils_1.PromptState.odataService.servicePath = service.servicePath;
-    utils_1.PromptState.odataService.origin = connectionValidator.validatedUrl;
-    return true;
-}
-//# sourceMappingURL=service-helper.js.map