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

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SAP_CLIENT_KEY = exports.hostEnvironment = exports.ValidationLink = exports.promptNames = exports.SapSystemTypes = exports.DatasourceType = void 0;
+exports.SAP_CLIENT_KEY = exports.promptNames = exports.SapSystemTypes = exports.DatasourceType = void 0;
 /**
  * This file contains types that are exported by the module and are needed for consumers using the APIs `prompt` and `getPrompts`.
  */
@@ -62,45 +62,5 @@ var promptNames;
      */
     promptNames["systemSelection"] = "systemSelection";
 })(promptNames || (exports.promptNames = promptNames = {}));
-/**
- * Implementation of IValidationLink interface.
- * Provides a toString() for serialization on CLI since IValidationLink rendering is only supported by YeomanUI.
- */
-class ValidationLink {
-    // Having to redeclare properties from an interface should not be required see: https://github.com/Microsoft/TypeScript/issues/5326
-    message;
-    link;
-    /**
-     * Constructor for ValidationLink.
-     *
-     * @param validationLink The validation link object to be used for serialization
-     */
-    constructor(validationLink) {
-        Object.assign(this, validationLink);
-    }
-    /**
-     * Serialize the validation link object to a string.
-     *
-     * @returns The validation link object as a string
-     */
-    toString() {
-        return `${this.message} ${this.link.text}${this.link.url ? ' : ' + this.link.url : ''}`;
-    }
-}
-exports.ValidationLink = ValidationLink;
-exports.hostEnvironment = {
-    vscode: {
-        name: 'Visual Studio Code',
-        technical: 'VSCode'
-    },
-    bas: {
-        name: 'SAP Business Application Studio',
-        technical: 'SBAS'
-    },
-    cli: {
-        name: 'CLI',
-        technical: 'CLI'
-    }
-};
 exports.SAP_CLIENT_KEY = 'sap-client';
 //# sourceMappingURL=types.js.map

package/dist/utils/index.d.ts

@@ -1,39 +1,17 @@
 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';
+import { type HostEnvironmentId } from '@sap-ux/fiori-generator-shared';
 /**
  * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
  *
  * @returns the platform name and technical name
  */
-export declare function getHostEnvironment(): {
+export declare function getPromptHostEnvironment(): {
     name: string;
-    technical: string;
+    technical: HostEnvironmentId;
 };
-/**
- * Set the telemetry client.
- *
- * @param toolsSuiteTelemetryClient the telemetry client instance to use when sending telemetry events
- */
-export declare function setTelemetryClient(toolsSuiteTelemetryClient: ToolsSuiteTelemetryClient | undefined): void;
-/**
- * Send telemetry event.
- *
- * @param eventName the name of the telemetry event
- * @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

@@ -4,10 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PromptState = void 0;
-exports.getHostEnvironment = getHostEnvironment;
-exports.setTelemetryClient = setTelemetryClient;
-exports.sendTelemetryEvent = sendTelemetryEvent;
-exports.getTelemPropertyDestinationType = getTelemPropertyDestinationType;
+exports.getPromptHostEnvironment = getPromptHostEnvironment;
 exports.parseOdataVersion = parseOdataVersion;
 exports.originToRelative = originToRelative;
 exports.convertODataVersionType = convertODataVersionType;
@@ -15,87 +12,23 @@ 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 osVersionName = (0, os_name_1.default)();
+const fiori_generator_shared_1 = require("@sap-ux/fiori-generator-shared");
 /**
  * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
  *
  * @returns the platform name and technical name
  */
-function getHostEnvironment() {
+function getPromptHostEnvironment() {
     if (!prompt_state_1.PromptState.isYUI) {
-        return types_1.hostEnvironment.cli;
+        return fiori_generator_shared_1.hostEnvironment.cli;
     }
     else {
-        return (0, btp_utils_1.isAppStudio)() ? types_1.hostEnvironment.bas : types_1.hostEnvironment.vscode;
-    }
-}
-let telemetryClient;
-/**
- * Set the telemetry client.
- *
- * @param toolsSuiteTelemetryClient the telemetry client instance to use when sending telemetry events
- */
-function setTelemetryClient(toolsSuiteTelemetryClient) {
-    telemetryClient = toolsSuiteTelemetryClient;
-}
-/**
- * Send telemetry event.
- *
- * @param eventName the name of the telemetry event
- * @param telemetryData the telemetry values to report
- */
-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);
-    }
-}
-/**
- * Create telemetry event.
- *
- * @param eventName the name of the telemetry event
- * @param telemetryData the telemetry values to add to he returned telemetry event
- * @returns the telemetry event
- */
-function createTelemetryEvent(eventName, telemetryData) {
-    const telemProps = Object.assign(telemetryData, {
-        Platform: getHostEnvironment().technical,
-        OperatingSystem: osVersionName
-    });
-    return {
-        eventName,
-        properties: telemProps,
-        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';
+        return (0, btp_utils_1.isAppStudio)() ? fiori_generator_shared_1.hostEnvironment.bas : fiori_generator_shared_1.hostEnvironment.vscode;
     }
 }
 /**

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.6.0",
+  "version": "0.6.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -28,10 +28,10 @@
     "os-name": "4.0.1",
     "@sap-ux/axios-extension": "1.17.2",
     "@sap-ux/btp-utils": "0.16.0",
-    "@sap-ux/fiori-generator-shared": "0.7.6",
+    "@sap-ux/fiori-generator-shared": "0.7.7",
     "@sap-ux/guided-answers-helper": "0.1.0",
     "@sap-ux/telemetry": "0.5.42",
-    "@sap-ux/inquirer-common": "0.4.10",
+    "@sap-ux/inquirer-common": "0.5.0",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/project-access": "1.28.6",
     "@sap-ux/project-input-validator": "0.3.3",
@@ -43,8 +43,9 @@
     "@types/inquirer": "8.2.6",
     "@types/lodash": "4.14.202",
     "jest-extended": "3.2.4",
-    "@sap-ux/odata-service-writer": "0.23.1",
-    "@sap-ux/feature-toggle": "0.2.2"
+    "@sap-ux/fiori-generator-shared": "0.7.7",
+    "@sap-ux/feature-toggle": "0.2.2",
+    "@sap-ux/odata-service-writer": "0.23.1"
   },
   "engines": {
     "node": ">=18.x"

package/dist/error-handler/error-handler.d.ts

@@ -1,206 +0,0 @@
-import type { Destination } from '@sap-ux/btp-utils';
-import { type Logger } from '@sap-ux/logger';
-import { ValidationLink } from '../types';
-/**
- * Constants specific to error handling
- */
-export declare enum ERROR_TYPE {
-    AUTH = "AUTH",
-    AUTH_TIMEOUT = "AUTH_TIMEOUT",
-    REDIRECT = "REDIRECT",
-    CERT = "CERT",// General cert error
-    CERT_SELF_SIGNED = "CERT_SELF_SIGNED",
-    CERT_UKNOWN_OR_INVALID = "CERT_UKNOWN_OR_INVALID",
-    CERT_EXPIRED = "CERT_EXPIRED",
-    CERT_SELF_SIGNED_CERT_IN_CHAIN = "CERT_SELF_SIGNED_CERT_IN_CHAIN",
-    UNKNOWN = "UNKNOWN",
-    INVALID_URL = "INVALID_URL",
-    TIMEOUT = "TIMEOUT",
-    CONNECTION = "CONNECTION",
-    SERVICES_UNAVAILABLE = "SERVICES_UNAVAILABLE",// All services
-    SERVICE_UNAVAILABLE = "SERVICE_UNAVAILABLE",// HTTP 503 Not related to odata services
-    NO_ABAP_ENVS = "NO_ABAP_ENVS",
-    CATALOG_SERVICE_NOT_ACTIVE = "CATALOG_SERVICE_NOT_ACTIVE",
-    NO_SUCH_HOST = "NO_SUCH_HOST",
-    NOT_FOUND = "NOT_FOUND",
-    ODATA_URL_NOT_FOUND = "ODATA_URL_NOT_FOUND",
-    BAD_GATEWAY = "BAD_GATEWAY",// Can be caused by either local issue or endpoint configuration
-    INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR",
-    DESTINATION_BAD_GATEWAY_503 = "DESTINATION_BAD_GATEWAY_503",// Caused by endpoint using a firewall or proxy
-    DESTINATION_UNAVAILABLE = "DESTINATION_UNAVAILABLE",
-    DESTINATION_NOT_FOUND = "DESTINATION_NOT_FOUND",
-    DESTINATION_MISCONFIGURED = "DESTINATION_MISCONFIGURED",
-    NO_V2_SERVICES = "NO_V2_SERVICES",
-    NO_V4_SERVICES = "NO_V4_SERVICES",
-    BAD_REQUEST = "BAD_REQUEST",
-    DESTINATION_CONNECTION_ERROR = "DESTINATION_CONNECTION_ERROR",// General destination connection error where a specific root cause cannot be determined e.g. In the case of an internal server error
-    SERVER_HTTP_ERROR = "SERVER_HTTP_ERROR"
-}
-export declare const ERROR_MAP: Record<ERROR_TYPE, RegExp[]>;
-type ValidationLinkOrString = string | ValidationLink;
-/**
- * Maps errors to end-user messages using some basic root cause analysis based on regex matching.
- * This class will also log errors and provide help links for validation errors in some limited use cases.
- */
-export declare class ErrorHandler {
-    /** The last error message generated */
-    private currentErrorMsg;
-    /** The last error message type generated if determined */
-    private currentErrorType;
-    private static _guidedAnswersEnabled;
-    private static _logger;
-    private static readonly getMessageFromError;
-    private static readonly _errorTypeToMsg;
-    /**
-     *
-     * @param errorType
-     * @param error can be any object that will get stringified and passed to the specific error message for the error type entry, e.g. where the error message is parameterized
-     * @returns an error message for the specified error type
-     */
-    private static readonly _errorMsg;
-    /**
-     * Get the Guided Answers (help) node for the specified error type.
-     *
-     * @param errorType The error type for which a help node (help content id) may be returned
-     * @returns The Guided Answers node for the specified error type
-     */
-    private static readonly getHelpNode;
-    /**
-     * Find an error property for mapping to a general error type from most to least significant.
-     *
-     * @param error any type of error or object that has an error code, status, name or message
-     * @returns a value that can be used to look up a general error type
-     */
-    private static findErrorValueForMapping;
-    /**
-     * Create an instance of the ErrorHandler.
-     *
-     * @param logger the logger instance to use
-     * @param enableGuidedAnswers if true, the end user validation errors will include guided answers to provide help
-     */
-    constructor(logger?: Logger, enableGuidedAnswers?: boolean);
-    /**
-     * Get Guided Answers (context help) enabled value.
-     *
-     * @returns true if Guided Answers is enabled
-     */
-    static get guidedAnswersEnabled(): boolean;
-    /**
-     * Toggle Guided Answers (context help) for validation errors.
-     */
-    static set guidedAnswersEnabled(value: boolean);
-    /**
-     * Set the logger to be used for error messages.
-     *
-     * @param logger the logger instance to use
-     */
-    static set logger(logger: Logger);
-    /**
-     * Get the logger used for error messages.
-     *
-     * @returns the logger instance
-     */
-    static get logger(): Logger;
-    /**
-     * Tests if the error is a general certificate error.
-     *
-     * @param status the error type
-     * @returns true if the error is a general certificate error
-     */
-    static isCertError(status: string | number): boolean;
-    /**
-     * Get the error type for the specified error, mapping status code, error code, error name, error message to a few general error types.
-     *
-     * @param error the error, string or status code to get the type for
-     * @returns the error type
-     */
-    static getErrorType(error: string | number | Error): ERROR_TYPE;
-    /**
-     * Maps errors to a few generic types, log a detailed error.
-     *
-     * @param error If the error is a string this will be logged as is. Otherwise it will be mapped to a general error internally, possibly retained and logged.
-     * @param userMsg If provided this will be set as the userErrorMsg instead of an error to msg map
-     *  this allows a message more relevant to the context of where the error was generated to be used.
-     * @param retainError Defaults to true to retain the error state.
-     * @returns A user-friendly message for display in-line
-     */
-    logErrorMsgs(error: unknown, userMsg?: string, retainError?: boolean): string;
-    /**
-     * Maps an error to a user-friendly message. The specified error may by a string (e.g. error message), number (e.g. status code), Error, or Axios error.
-     *
-     * @param error The error to map
-     * @returns The mapped error message and error type
-     */
-    private static mapErrorToMsg;
-    /**
-     * Used by validate functions to report in-line user friendly errors.
-     * Checks if there is an existing error.
-     *
-     * @param error optional, if provided get the end user message that it maps to, otherwise get the previous error message, if a boolean is passed it will be interpreted as `reset`.
-     * @param reset optional, resets the previous error state if true, if error is omitted reset may be passed as the first argument
-     * @param fallback optional, return the message of the specified ERROR_TYPE if no previous end user message and no error specified
-     * @returns The error message
-     */
-    getErrorMsg(error?: any, reset?: boolean, fallback?: ERROR_TYPE): string | undefined;
-    /**
-     * Used by validate functions to report in-line user friendly errors messages with help links.
-     * If the error type is unknown, this will find a mapped error type and return the help (ValidationLink) if it exists.
-     * If an error is not provided the current error state will be used. This does not log the message to the console.
-     * If a system is provided, the error type may be refined to provide a more specific error message for the system which generatd the error.
-     *
-     * @param error optional, if provided get the help link message that it maps to, otherwise get the previously logged error message help link
-     * @param reset optional, resets the previous error state if true
-     * @param destination optional, if provided the destination may be used to determine a more relevant error message, specific to the system properties
-     * @returns An instance of @see {ValidationLink}
-     */
-    getValidationErrorHelp(error?: any, reset?: boolean, destination?: Destination): ValidationLinkOrString | undefined;
-    /**
-     * Get a more specific error type for the specified destination.
-     *
-     * @param errorType
-     * @param destination
-     * @returns
-     */
-    private static getDestinationSpecificError;
-    /**
-     * Get the error message for the specified error type.
-     *
-     * @param errorType The error type for which the message may be returned
-     * @param error optional, if provided may be used to get generate a more specific error message, or be included in the message
-     * @returns The error message for the specified error type
-     */
-    static getErrorMsgFromType(errorType: ERROR_TYPE, error?: any): string | undefined;
-    /**
-     * Checks if there is an existing error.
-     *
-     * @param reset - resets the current error state
-     * @returns true if there is an existing error
-     */
-    hasError(reset?: boolean): boolean;
-    /**
-     * Sets the current error state.
-     *
-     * @param errorType - the error type
-     * @param error - the original error, if any
-     */
-    setCurrentError(errorType: ERROR_TYPE, error?: any): void;
-    /**
-     * Gets the current error type state.
-     *
-     * @param reset - resets the current error state
-     * @returns The current error type
-     */
-    getCurrentErrorType(reset?: boolean): ERROR_TYPE | null;
-    /**
-     * Maps an error type to a validation link if help (Guided Answers topic) is available for the specified error.
-     * Otherwise the specified error message is returned. To retrieve the previous error state @see getValidationErrorHelp.
-     * Use this (getHelpForError) if the error type is known.
-     *
-     * @param errorType - the error type to be mapped to help link
-     * @param errorMsg - the message to appear with the help link
-     * @returns A validation help link or help link message
-     */
-    static getHelpForError(errorType: ERROR_TYPE, errorMsg?: string): ValidationLinkOrString | undefined;
-}
-export {};
-//# sourceMappingURL=error-handler.d.ts.map