@sap-ux/odata-service-inquirer 0.1.1

package/dist/prompts/datasources/metadata-file/index.js

@@ -0,0 +1,47 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMetadataFileQuestion = void 0;
+const i18n_1 = require("../../../i18n");
+const types_1 = require("../../../types");
+const validators_1 = require("./validators");
+const utils_1 = require("../../../utils");
+/**
+ * Returns the metadata file question based on the provided @type{MetadataPromptOptions}.
+ *
+ * @param promptOptions - The metadata prompt options
+ * @returns the metadata file question
+ */
+function getMetadataFileQuestion(promptOptions) {
+    const metadataFileQuestion = {
+        type: 'input',
+        guiType: 'file-browser',
+        name: types_1.promptNames.metadataFilePath,
+        guiOptions: { mandatory: true, breadcrumb: true },
+        message: (0, i18n_1.t)('prompts.metadataFile.message'),
+        validate: (path) => __awaiter(this, void 0, void 0, function* () {
+            utils_1.PromptState.reset();
+            const validateResult = yield (0, validators_1.validateMetadataFile)(path, promptOptions === null || promptOptions === void 0 ? void 0 : promptOptions.requiredOdataVersion);
+            if (typeof validateResult === 'string' || typeof validateResult === 'boolean') {
+                return validateResult;
+            }
+            if (validateResult.metadata) {
+                utils_1.PromptState.odataService.odataVersion = validateResult.version;
+                utils_1.PromptState.odataService.metadata = validateResult.metadata;
+                utils_1.PromptState.odataService.servicePath = (0, i18n_1.t)('prompts.metadataFile.placeholder_odata_service_url'); // Dummy path used by v4 preview server middleware
+            }
+            return true;
+        })
+    };
+    return metadataFileQuestion;
+}
+exports.getMetadataFileQuestion = getMetadataFileQuestion;
+//# sourceMappingURL=index.js.map

package/dist/prompts/datasources/metadata-file/validators.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Validates the metadata file, returning an error string, if not valid, or an object with the valid metadata and version.
+ *
+ * @param path
+ * @param odataVersion
+ * @returns
+ */
+import { OdataVersion } from '@sap-ux/odata-service-writer';
+export declare const validateMetadataFile: (path: string, odataVersion?: OdataVersion) => Promise<{
+    version: OdataVersion;
+    metadata: string;
+} | string | boolean>;
+//# sourceMappingURL=validators.d.ts.map

package/dist/prompts/datasources/metadata-file/validators.js

@@ -0,0 +1,45 @@
+"use strict";
+/**
+ * Validates the metadata file, returning an error string, if not valid, or an object with the valid metadata and version.
+ *
+ * @param path
+ * @param odataVersion
+ * @returns
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateMetadataFile = void 0;
+const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
+const promises_1 = require("fs/promises");
+const validators_1 = require("../../validators");
+const i18n_1 = require("../../../i18n");
+const validateMetadataFile = (path, odataVersion) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!path) {
+        return false;
+    }
+    try {
+        const metadata = yield (0, promises_1.readFile)(path, 'utf-8');
+        metadata.replace(/ & /g, ' & ');
+        const { validationMsg, version } = (0, validators_1.validateODataVersion)(metadata, odataVersion);
+        if (validationMsg) {
+            return validationMsg;
+        }
+        return {
+            version: version !== null && version !== void 0 ? version : odata_service_writer_1.OdataVersion.v4,
+            metadata
+        };
+    }
+    catch (error) {
+        return (0, i18n_1.t)('prompts.validationMessages.metadataFilePathNotValid');
+    }
+});
+exports.validateMetadataFile = validateMetadataFile;
+//# sourceMappingURL=validators.js.map

package/dist/prompts/index.d.ts

@@ -0,0 +1,2 @@
+export * from './prompts';
+//# sourceMappingURL=index.d.ts.map

package/dist/prompts/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./prompts"), exports);
+//# sourceMappingURL=index.js.map

package/dist/prompts/logger-helper.d.ts

@@ -0,0 +1,20 @@
+import { type Logger } from '@sap-ux/logger';
+/**
+ * Static logger prevents passing of logger references through all functions, as this is a cross-cutting concern.
+ */
+export default class LoggerHelper {
+    private static _logger;
+    /**
+     * Get the logger.
+     *
+     * @returns the logger
+     */
+    static get logger(): Logger;
+    /**
+     * Set the logger.
+     *
+     * @param value the logger to set
+     */
+    static set logger(value: Logger);
+}
+//# sourceMappingURL=logger-helper.d.ts.map

package/dist/prompts/logger-helper.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("@sap-ux/logger");
+/**
+ * Static logger prevents passing of logger references through all functions, as this is a cross-cutting concern.
+ */
+class LoggerHelper {
+    /**
+     * Get the logger.
+     *
+     * @returns the logger
+     */
+    static get logger() {
+        return LoggerHelper._logger;
+    }
+    /**
+     * Set the logger.
+     *
+     * @param value the logger to set
+     */
+    static set logger(value) {
+        LoggerHelper._logger = value;
+    }
+}
+LoggerHelper._logger = new logger_1.ToolsLogger({ logPrefix: '@sap-ux/odata-service-inquirer' });
+exports.default = LoggerHelper;
+//# sourceMappingURL=logger-helper.js.map

package/dist/prompts/prompt-helpers.d.ts

@@ -0,0 +1,14 @@
+import type { ListChoiceOptions } from 'inquirer';
+import { ErrorHandler } from '../error-handler/error-handler';
+import { type DatasourceTypePromptOptions } from '../types';
+export declare const errorHandler: ErrorHandler;
+/**
+ * Get the datasource type choices.
+ *
+ * @param options - optionally include some of the supported datasource type choices
+ * @param options.includeNone - Include the `NONE` option in the datasource type prompt
+ * @param options.includeProjectSpecificDest - Include the `projectSpecificDestination` option in the datasource type prompt
+ * @returns The datasource type choices
+ */
+export declare function getDatasourceTypeChoices({ includeNone, includeProjectSpecificDest }?: DatasourceTypePromptOptions): ListChoiceOptions[];
+//# sourceMappingURL=prompt-helpers.d.ts.map

package/dist/prompts/prompt-helpers.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDatasourceTypeChoices = exports.errorHandler = void 0;
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const error_handler_1 = require("../error-handler/error-handler");
+const i18n_1 = require("../i18n");
+const types_1 = require("../types");
+// Error handling is a cross-cutting concern, a single instance is required
+exports.errorHandler = new error_handler_1.ErrorHandler();
+/**
+ * Get the datasource type choices.
+ *
+ * @param options - optionally include some of the supported datasource type choices
+ * @param options.includeNone - Include the `NONE` option in the datasource type prompt
+ * @param options.includeProjectSpecificDest - Include the `projectSpecificDestination` option in the datasource type prompt
+ * @returns The datasource type choices
+ */
+function getDatasourceTypeChoices({ includeNone = false, includeProjectSpecificDest = false } = {}) {
+    const choices = [
+        {
+            name: (0, i18n_1.t)('prompts.datasourceType.sapSystemChoiceText'),
+            value: types_1.DatasourceType.sapSystem
+        },
+        {
+            name: (0, i18n_1.t)('prompts.datasourceType.odataServiceUrlChoiceText'),
+            value: types_1.DatasourceType.odataServiceUrl
+        },
+        { name: (0, i18n_1.t)('prompts.datasourceType.businessHubChoiceText'), value: types_1.DatasourceType.businessHub }
+    ];
+    if ((0, btp_utils_1.isAppStudio)() && includeProjectSpecificDest) {
+        choices.push({
+            name: (0, i18n_1.t)('prompts.datasourceType.projectSpecificDestChoiceText'),
+            value: types_1.DatasourceType.projectSpecificDestination
+        });
+    }
+    choices.push({ name: (0, i18n_1.t)('prompts.datasourceType.capProjectChoiceText'), value: types_1.DatasourceType.capProject });
+    choices.push({ name: (0, i18n_1.t)('prompts.datasourceType.metadataFileChoiceText'), value: types_1.DatasourceType.metadataFile });
+    if (includeNone) {
+        choices.unshift({ name: (0, i18n_1.t)('prompts.datasourceType.noneName'), value: types_1.DatasourceType.none });
+    }
+    return choices;
+}
+exports.getDatasourceTypeChoices = getDatasourceTypeChoices;
+//# sourceMappingURL=prompt-helpers.js.map

package/dist/prompts/prompts.d.ts

@@ -0,0 +1,9 @@
+import { type OdataServicePromptOptions, type OdataServiceQuestion } from '../types';
+/**
+ * Get the prompts for the OData service inquirer.
+ *
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
+ * @returns the prompts used to provide input for OData service generation
+ */
+export declare function getQuestions(promptOptions?: OdataServicePromptOptions): Promise<OdataServiceQuestion[]>;
+//# sourceMappingURL=prompts.d.ts.map

package/dist/prompts/prompts.js

@@ -0,0 +1,98 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getQuestions = void 0;
+const yeoman_ui_types_1 = require("@sap-devx/yeoman-ui-types");
+const inquirer_common_1 = require("@sap-ux/inquirer-common");
+const i18n_1 = require("../i18n");
+const types_1 = require("../types");
+const metadata_file_1 = require("./datasources/metadata-file");
+const prompt_helpers_1 = require("./prompt-helpers");
+const questions_1 = require("./datasources/cap-project/questions");
+const logger_helper_1 = __importDefault(require("./logger-helper"));
+/**
+ * Get the prompts for the OData service inquirer.
+ *
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
+ * @returns the prompts used to provide input for OData service generation
+ */
+function getQuestions(promptOptions) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const questions = [getDatasourceTypeQuestion(promptOptions === null || promptOptions === void 0 ? void 0 : promptOptions.datasourceType)];
+        // Add conditional questions depending on the selected source
+        questions.push(...(yield getDatasourceTypeConditionalQuestions(promptOptions)));
+        return questions;
+    });
+}
+exports.getQuestions = getQuestions;
+/**
+ * Get the datasource type question.
+ *
+ * @param options - options that can control some of the prompt behavior. See {@link DatasourceTypePromptOptions} for details
+ * @returns the datasource type question
+ */
+function getDatasourceTypeQuestion(options) {
+    var _a;
+    const choices = (0, prompt_helpers_1.getDatasourceTypeChoices)(options);
+    return {
+        type: 'list',
+        name: types_1.promptNames.datasourceType,
+        guiOptions: {
+            breadcrumb: true
+        },
+        default: (_a = options === null || options === void 0 ? void 0 : options.default) !== null && _a !== void 0 ? _a : -1,
+        message: (0, i18n_1.t)('prompts.datasourceType.message'),
+        choices,
+        additionalMessages: (source) => {
+            var _a;
+            if ([
+                types_1.DatasourceType.businessHub,
+                types_1.DatasourceType.none,
+                types_1.DatasourceType.odataServiceUrl,
+                types_1.DatasourceType.projectSpecificDestination,
+                types_1.DatasourceType.sapSystem
+            ].includes(source)) {
+                (_a = logger_helper_1.default.logger) === null || _a === void 0 ? void 0 : _a.warn((0, i18n_1.t)('prompts.datasourceType.notYetImplementedWarningMessage', { datasourceType: source }));
+                return {
+                    message: (0, i18n_1.t)('prompts.datasourceType.notYetImplementedWarningMessage', { datasourceType: source }),
+                    severity: yeoman_ui_types_1.Severity.warning
+                };
+            }
+            if (source === types_1.DatasourceType.businessHub) {
+                return {
+                    message: (0, i18n_1.t)('prompts.nonUIServiceTypeWarningMessage', {
+                        serviceTypeDesc: (0, i18n_1.t)('prompts.datasourceType.businessHubName')
+                    }),
+                    severity: yeoman_ui_types_1.Severity.warning
+                };
+            }
+        }
+    };
+}
+/**
+ * Apply addiitonal when conditions based on the datasource type answer.
+ *
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
+ * @returns the conditional questions based on the datasource type answer
+ */
+function getDatasourceTypeConditionalQuestions(promptOptions) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const conditionalQuestions = [];
+        conditionalQuestions.push(...(0, inquirer_common_1.withCondition)([(0, metadata_file_1.getMetadataFileQuestion)(promptOptions === null || promptOptions === void 0 ? void 0 : promptOptions.metadataFilePath)], (answers) => answers.datasourceType === types_1.DatasourceType.metadataFile));
+        conditionalQuestions.push(...(0, inquirer_common_1.withCondition)((0, questions_1.getLocalCapProjectPrompts)(promptOptions), (answers) => answers.datasourceType === types_1.DatasourceType.capProject));
+        //...further data sources to be added here
+        return conditionalQuestions;
+    });
+}
+//# sourceMappingURL=prompts.js.map

package/dist/prompts/validators.d.ts

@@ -0,0 +1,13 @@
+import { OdataVersion } from '@sap-ux/odata-service-writer';
+/**
+ * Validator function to verify if the specified metadata edmx version matches the specified required odata version.
+ *
+ * @param edmx the edmx to validate
+ * @param requiredVersion the required odata version to validate against
+ * @returns version and/or validation error message
+ */
+export declare function validateODataVersion(edmx: string, requiredVersion?: OdataVersion): {
+    validationMsg?: string;
+    version?: OdataVersion;
+};
+//# sourceMappingURL=validators.d.ts.map

package/dist/prompts/validators.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateODataVersion = void 0;
+const i18n_1 = require("../i18n");
+const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
+const wing_service_explorer_1 = require("@sap/wing-service-explorer");
+const logger_helper_1 = __importDefault(require("./logger-helper"));
+/**
+ * Validator function to verify if the specified metadata edmx version matches the specified required odata version.
+ *
+ * @param edmx the edmx to validate
+ * @param requiredVersion the required odata version to validate against
+ * @returns version and/or validation error message
+ */
+function validateODataVersion(edmx, requiredVersion) {
+    const metadataFactory = wing_service_explorer_1.MetadataFactory.getMetadataFactory();
+    try {
+        const explorer = metadataFactory.getMetadataExplorer(edmx);
+        // Wing service explorer does not export the type of the protocol, so we need to check the string
+        const version = explorer.getProtocolType().indexOf('v4') > 0 ? odata_service_writer_1.OdataVersion.v4 : odata_service_writer_1.OdataVersion.v2;
+        if (requiredVersion && requiredVersion !== version) {
+            const odataErrorMsg = (0, i18n_1.t)('prompts.validationMessages.odataVersionMismatch', {
+                providedOdataVersion: version,
+                requiredOdataVersion: requiredVersion
+            });
+            logger_helper_1.default.logger.error(odataErrorMsg);
+            return {
+                validationMsg: odataErrorMsg
+            };
+        }
+        return {
+            version
+        };
+    }
+    catch (err) {
+        return {
+            validationMsg: (0, i18n_1.t)('prompts.validationMessages.metadataInvalid')
+        };
+    }
+}
+exports.validateODataVersion = validateODataVersion;
+//# sourceMappingURL=validators.js.map

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

@@ -0,0 +1,88 @@
+{
+    "prompts": {
+        "datasourceType": {
+            "message": "Data source",
+            "projectSpecificDestName": "Project Specific Destination",
+            "businessHubName": "SAP Business Accelerator Hub",
+            "sapSystemName": "SAP System",
+            "odataServiceUrlName": "OData Service Url",
+            "capProjectName": "Local CAP Project",
+            "metadataFileName": "Metadata File",
+            "noneName": "None",
+            "projectSpecificDestChoiceText": "Connect to a $t(prompts.datasourceType.projectSpecificDestName)",
+            "businessHubChoiceText": "Connect to $t(prompts.datasourceType.businessHubName)",
+            "sapSystemChoiceText": "Connect to a $t(prompts.datasourceType.sapSystemName)",
+            "odataServiceUrlChoiceText": "Connect to an $t(prompts.datasourceType.odataServiceUrlName)",
+            "capProjectChoiceText": "Use a $t(prompts.datasourceType.capProjectName)",
+            "metadataFileChoiceText": "Upload a $t(prompts.datasourceType.metadataFileName)",
+            "notYetImplementedWarningMessage": "The selected data source type: {{ datasourceType }} is not yet implemented."
+        },
+        "metadataFile": {
+            "message": "Metadata file path",
+            "description": "Upload a metadata file",
+            "placeholder_odata_service_url": "/here/goes/your/serviceurl/"
+        },
+        "capProject": {
+            "message": "Choose your CAP project",
+            "description": "Select a local CAP project",
+            "breadcrumb": "CAP Project",
+            "enterCapPathChoiceName": "Manually select CAP project folder path"
+        },
+        "capProjectPath": {
+            "message": "CAP project folder path",
+            "description": "Select a local CAP project",
+            "breadcrumb": "CAP Project",
+            "enterCapPathChoiceName": "Manually select CAP project folder path"
+        },
+        "capService": {
+            "message": "OData service",
+            "description": "Select a local CAP service",
+            "breadcrumb": "CAP Service",
+            "enterCapPathChoiceName": "Manually select CAP service folder path"
+        },
+        "validationMessages": {
+            "odataVersionMismatch": "The template you have chosen supports V{{requiredOdataVersion}} OData services only. The provided version is V{{providedOdataVersion}}.",
+            "metadataInvalid": "The service metadata is invalid.",
+            "metadataFilePathNotValid": "Metadata file does not exist or is not accessible. Please specify a valid file path.",
+            "capProjectNotFound": "The folder you have selected does not seem to contain a valid CAP project. Please check and try again."
+        },
+        "nonUIServiceTypeWarningMessage": "Please note that {{serviceTypeDesc}} services are not intended to be used for the generation of SAP Fiori UI applications"
+    },
+    "errors": {
+        "cannotReadCapServiceMetadata": "An error occurred reading CAP service metadata: {{serviceName}}. See log for more details.",
+        "capModelAndServicesLoadError": "An error occurred loading the CAP model and services. {{- error}}",
+        "capServiceUrlPathNotDefined": "An error occurred reading CAP service metadata: {{serviceName}}. CAP service property `urlPath` is not defined but is required.",
+        "unknownError": "An error occurred: {{- error}}",
+        "servicesUnavailable": "An error occurred retrieving service(s) for SAP System.",
+        "certificateError": "A certificate error has occurred: {{- error}}",
+        "urlCertValidationError": "The system URL is using {{certErrorReason}} security certificate.",
+        "authenticationFailed": "Authentication incorrect {{error}}",
+        "authenticationTimeout": "Authorization was not verified within the allowed time. Please ensure you have authenticated using the associated browser window.",
+        "invalidUrl": "Not a valid URL",
+        "connectionError": "A connection error occurred, please ensure the target host is available on the network: {{- error}}",
+        "serviceUnavailable": "Selected service is returning an error.",
+        "catalogServiceNotActive": "Catalog service is not active",
+        "internalServerError": "The URL you have provided cannot be accessed and is returning: '{{- error}}'. Please ensure that the URL is accessible externally.",
+        "urlNotFound": "URL not found",
+        "odataServiceUrlNotFound": "The service URL you have provided is not a valid OData Service. Fiori applications require an OData service as the data source.",
+        "destinationUnavailable": "The selected destination references an instance that is not available. Please check your destination configuration and try again.",
+        "destinationNotFound": "The destination is mis-configured, HTTP Error 404 returned, the requested resource could not be found.",
+        "destinationMisconfigured": "The destination is mis-configured, HTML5.DynamicDestination property is missing.",
+        "noServicesAvailable": "There are no V{{version}} OData services available from the selected system and the template you have chosen supports V{{version}} OData services only",
+        "redirectError": "A redirect response was received from the server",
+        "abapEnvsUnavailable": "ABAP environments unavailable",
+        "noSuchHostError": "No such host is known"
+    },
+    "texts": {
+        "anExpiredCert": "an expired",
+        "aSelfSignedCert": "a self-signed",
+        "anUnknownOrInvalidCert": "an unknown or invalid",
+        "anUntrustedRootCert": "an untrusted root"
+    },
+    "guidedAnswers": {
+        "validationErrorHelpText": "Need help with this error?"
+    },
+    "telemetry": {
+        "unknownOsText": "Unknown"
+    }
+}