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

package/dist/prompts/datasources/sap-system/abap-on-btp/cf-helper.js

@@ -1,54 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getABAPInstanceChoices = getABAPInstanceChoices;
-const cf_tools_1 = require("@sap/cf-tools");
-const error_handler_1 = require("../../../../error-handler/error-handler");
-const i18n_1 = require("../../../../i18n");
-const prompt_helpers_1 = require("../../../prompt-helpers");
-const AbapEnvType = {
-    ABAP: 'abap',
-    ABAP_TRIAL: 'abap-trial',
-    ABAP_CANARY: 'abap-canary',
-    ABAP_OEM: 'abap-oem',
-    ABAP_OEM_CANARY: 'abap-oem-canary',
-    ABAP_HAAS: 'abap-haas',
-    ABAP_STAGING: 'abap-staging',
-    ABAP_INTERNAL_STAGING: 'abap-internal-staging',
-    DESTINATION: 'destination'
-};
-/**
- * Get the name sorted list of ABAP instance choices from an active CF login. If not logged in, an error message is logged.
- *
- * @returns The list of ABAP instance choices
- */
-async function getABAPInstanceChoices() {
-    const choices = [];
-    try {
-        const filteredInstances = [
-            AbapEnvType.ABAP,
-            AbapEnvType.ABAP_TRIAL,
-            AbapEnvType.ABAP_CANARY,
-            AbapEnvType.ABAP_OEM,
-            AbapEnvType.ABAP_OEM_CANARY,
-            AbapEnvType.ABAP_HAAS,
-            AbapEnvType.ABAP_STAGING,
-            AbapEnvType.ABAP_INTERNAL_STAGING
-        ];
-        const serviceInstanceInfo = await (0, cf_tools_1.apiGetServicesInstancesFilteredByType)(filteredInstances);
-        if (serviceInstanceInfo.length > 0) {
-            serviceInstanceInfo.forEach((service) => {
-                choices.push({ name: service['label'], value: service });
-            });
-        }
-        else {
-            // No envs found
-            prompt_helpers_1.errorHandler.logErrorMsgs(error_handler_1.ERROR_TYPE.NO_ABAP_ENVS, (0, i18n_1.t)('errors.noAbapEnvsInCFSpace'));
-        }
-    }
-    catch (error) {
-        // Cannot connect to CF
-        prompt_helpers_1.errorHandler.logErrorMsgs(error_handler_1.ERROR_TYPE.NO_ABAP_ENVS, (0, i18n_1.t)('errors.abapEnvsCFDiscoveryFailed'));
-    }
-    return choices.sort((a, b) => (a.name ? a.name.localeCompare(b.name ?? '') : 0));
-}
-//# sourceMappingURL=cf-helper.js.map

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