@sap-ux/odata-service-inquirer 0.1.1

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+import { type InquirerAdapter } from '@sap-ux/inquirer-common';
+import { type Logger } from '@sap-ux/logger';
+import { OdataVersion } from '@sap-ux/odata-service-writer';
+import { type ToolsSuiteTelemetryClient } from '@sap-ux/telemetry';
+import { DatasourceType, promptNames, type CapRuntime, type CapService, type OdataServiceAnswers, type OdataServicePromptOptions, type OdataServiceQuestion } from './types';
+/**
+ * Get the inquirer prompts for odata service.
+ *
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
+ * @param logger - a logger compatible with the {@link Logger} interface
+ * @param enableGuidedAnswers - if true, the prompts will use guided answers to help users with validation errors
+ * @param telemetryClient - the telemetry client to use for sending telemetry data
+ * @param isYUI - if true, the prompt is being called from the Yeoman UI extension host
+ * @returns the prompts used to provide input for odata service generation and a reference to the answers object which will be populated with the user's responses once `inquirer.prompt` returns
+ */
+declare function getPrompts(promptOptions?: OdataServicePromptOptions, logger?: Logger, enableGuidedAnswers?: boolean, telemetryClient?: ToolsSuiteTelemetryClient, isYUI?: boolean): Promise<{
+    prompts: OdataServiceQuestion[];
+    answers: {
+        odataService: Partial<OdataServiceAnswers>;
+    };
+}>;
+/**
+ * Prompt for odata service writer inputs.
+ *
+ * @param adapter - optionally provide references to a calling inquirer instance, this supports integration to Yeoman generators, for example
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
+ * @param logger - a logger compatible with the {@link Logger} interface
+ * @param enableGuidedAnswers - if true, the prompts will use guided answers to help users with validation errors
+ * @param telemetryClient - the telemetry client to use for sending telemetry data
+ * @param isYUI - if true, the prompt is being called from the Yeoman UI extension host
+ * @returns the prompt answers
+ */
+declare function prompt(adapter: InquirerAdapter, promptOptions?: OdataServicePromptOptions, logger?: Logger, enableGuidedAnswers?: boolean, telemetryClient?: ToolsSuiteTelemetryClient, isYUI?: boolean): Promise<OdataServiceAnswers>;
+export { DatasourceType, OdataVersion, getPrompts, prompt, promptNames, type CapRuntime, type CapService, type InquirerAdapter, type OdataServiceAnswers, type OdataServicePromptOptions };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,73 @@
+"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.promptNames = exports.prompt = exports.getPrompts = exports.OdataVersion = exports.DatasourceType = void 0;
+const logger_1 = require("@sap-ux/logger");
+const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
+Object.defineProperty(exports, "OdataVersion", { enumerable: true, get: function () { return odata_service_writer_1.OdataVersion; } });
+const error_handler_1 = require("./error-handler/error-handler");
+const prompts_1 = require("./prompts");
+const logger_helper_1 = __importDefault(require("./prompts/logger-helper"));
+const types_1 = require("./types");
+Object.defineProperty(exports, "DatasourceType", { enumerable: true, get: function () { return types_1.DatasourceType; } });
+Object.defineProperty(exports, "promptNames", { enumerable: true, get: function () { return types_1.promptNames; } });
+const utils_1 = require("./utils");
+/**
+ * Get the inquirer prompts for odata service.
+ *
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
+ * @param logger - a logger compatible with the {@link Logger} interface
+ * @param enableGuidedAnswers - if true, the prompts will use guided answers to help users with validation errors
+ * @param telemetryClient - the telemetry client to use for sending telemetry data
+ * @param isYUI - if true, the prompt is being called from the Yeoman UI extension host
+ * @returns the prompts used to provide input for odata service generation and a reference to the answers object which will be populated with the user's responses once `inquirer.prompt` returns
+ */
+function getPrompts(promptOptions, logger, enableGuidedAnswers = false, telemetryClient, isYUI = false) {
+    return __awaiter(this, void 0, void 0, function* () {
+        logger_helper_1.default.logger = logger !== null && logger !== void 0 ? logger : new logger_1.ToolsLogger({ logPrefix: '@sap-ux/odata-service-inquirer' });
+        error_handler_1.ErrorHandler.logger = logger_helper_1.default.logger;
+        error_handler_1.ErrorHandler.guidedAnswersEnabled = enableGuidedAnswers;
+        utils_1.PromptState.isYUI = isYUI;
+        (0, utils_1.setTelemetryClient)(telemetryClient);
+        return {
+            prompts: yield (0, prompts_1.getQuestions)(promptOptions),
+            // Return reference to derived answers object that will be populated with user responses (after prompting is complete)
+            answers: utils_1.PromptState
+        };
+    });
+}
+exports.getPrompts = getPrompts;
+/**
+ * Prompt for odata service writer inputs.
+ *
+ * @param adapter - optionally provide references to a calling inquirer instance, this supports integration to Yeoman generators, for example
+ * @param promptOptions - options that can control some of the prompt behavior. See {@link OdataServicePromptOptions} for details
+ * @param logger - a logger compatible with the {@link Logger} interface
+ * @param enableGuidedAnswers - if true, the prompts will use guided answers to help users with validation errors
+ * @param telemetryClient - the telemetry client to use for sending telemetry data
+ * @param isYUI - if true, the prompt is being called from the Yeoman UI extension host
+ * @returns the prompt answers
+ */
+function prompt(adapter, promptOptions, logger, enableGuidedAnswers, telemetryClient, isYUI = false) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const odataServicePrompts = (yield getPrompts(promptOptions, logger, enableGuidedAnswers, telemetryClient, isYUI))
+            .prompts;
+        const answers = yield adapter.prompt(odataServicePrompts);
+        // Add dervied service answers to the answers object
+        Object.assign(answers, utils_1.PromptState.odataService);
+        return answers;
+    });
+}
+exports.prompt = prompt;
+//# sourceMappingURL=index.js.map

package/dist/prompts/datasources/cap-project/cap-helpers.d.ts

@@ -0,0 +1,26 @@
+import type { CapService, CapServiceChoice } from '../../../types';
+import type { CapProjectChoice, CapProjectPaths } from './types';
+export declare const enterCapPathChoiceValue = "enterCapPath";
+/**
+ * Search for CAP projects in the specified paths and create prompt choices from the results.
+ * The resulting choices will include an additional entry to enter a custom path.
+ *
+ * @param paths - The paths used to search for CAP projects
+ * @returns The CAP project prompt choices
+ */
+export declare function getCapProjectChoices(paths: string[]): Promise<CapProjectChoice[]>;
+/**
+ * Gets the CAP service choices for the specified CAP project paths.
+ *
+ * @param capProjectPaths - The CAP project paths
+ * @returns The CAP project service choices
+ */
+export declare function getCapServiceChoices(capProjectPaths: CapProjectPaths): Promise<CapServiceChoice[]>;
+/**
+ * Get the edmx metadata for the CAP service.
+ *
+ * @param capService - The CAP service
+ * @returns The edmx metadata for the CAP service
+ */
+export declare function getCapEdmx(capService: CapService): Promise<string | undefined>;
+//# sourceMappingURL=cap-helpers.d.ts.map

package/dist/prompts/datasources/cap-project/cap-helpers.js

@@ -0,0 +1,215 @@
+"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 __asyncValues = (this && this.__asyncValues) || function (o) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var m = o[Symbol.asyncIterator], i;
+    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
+    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
+    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCapEdmx = exports.getCapServiceChoices = exports.getCapProjectChoices = exports.enterCapPathChoiceValue = void 0;
+const project_access_1 = require("@sap-ux/project-access");
+const path_1 = require("path");
+const i18n_1 = require("../../../i18n");
+const logger_helper_1 = __importDefault(require("../../logger-helper"));
+const prompt_helpers_1 = require("../../prompt-helpers");
+exports.enterCapPathChoiceValue = 'enterCapPath';
+/**
+ * Search for CAP projects in the specified paths.
+ *
+ * @param paths - The paths used to search for CAP projects
+ * @returns The CAP project paths and the number of folders with the same name
+ */
+function getCapProjectPaths(paths) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const capProjectRoots = yield (0, project_access_1.findCapProjects)({ wsFolders: paths });
+        const capRootPaths = [];
+        // Keep track of duplicate folder names to append the path to the name when displaying the choices
+        const folderNameCount = new Map();
+        for (const root of capProjectRoots) {
+            const folderName = (0, path_1.basename)(root);
+            capRootPaths.push({ folderName, path: root });
+            folderNameCount.set(folderName, ((_a = folderNameCount.get(folderName)) !== null && _a !== void 0 ? _a : 0) + 1);
+        }
+        capRootPaths.sort((a, b) => a.folderName.localeCompare(b.folderName));
+        return {
+            capProjectPaths: capRootPaths,
+            folderCounts: folderNameCount
+        };
+    });
+}
+/**
+ * Search for CAP projects in the specified paths and create prompt choices from the results.
+ * The resulting choices will include an additional entry to enter a custom path.
+ *
+ * @param paths - The paths used to search for CAP projects
+ * @returns The CAP project prompt choices
+ */
+function getCapProjectChoices(paths) {
+    var _a, e_1, _b, _c;
+    var _d;
+    return __awaiter(this, void 0, void 0, function* () {
+        const { capProjectPaths, folderCounts } = yield getCapProjectPaths(paths);
+        const capChoices = [];
+        try {
+            for (var _e = true, capProjectPaths_1 = __asyncValues(capProjectPaths), capProjectPaths_1_1; capProjectPaths_1_1 = yield capProjectPaths_1.next(), _a = capProjectPaths_1_1.done, !_a; _e = true) {
+                _c = capProjectPaths_1_1.value;
+                _e = false;
+                const capProjectPath = _c;
+                const customCapPaths = yield (0, project_access_1.getCapCustomPaths)(capProjectPath.path);
+                const folderCount = (_d = folderCounts.get(capProjectPath.folderName)) !== null && _d !== void 0 ? _d : 1;
+                capChoices.push({
+                    name: `${capProjectPath.folderName}${folderCount > 1 ? ' (' + capProjectPath.path + ')' : ''}`,
+                    value: Object.assign(capProjectPath, customCapPaths)
+                });
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (!_e && !_a && (_b = capProjectPaths_1.return)) yield _b.call(capProjectPaths_1);
+            }
+            finally { if (e_1) throw e_1.error; }
+        }
+        return [
+            ...capChoices,
+            {
+                name: (0, i18n_1.t)('prompts.capProject.enterCapPathChoiceName'),
+                value: exports.enterCapPathChoiceValue
+            }
+        ];
+    });
+}
+exports.getCapProjectChoices = getCapProjectChoices;
+/**
+ * Create a cap service choice from the service info.
+ *
+ * @param capModel - The cap model
+ * @param serviceInfo - The service info
+ * @param projectPath - The project path
+ * @param appPath - The app path
+ * @returns a cap service choice
+ */
+function createCapServiceChoice(capModel, serviceInfo, projectPath, appPath) {
+    var _a, _b, _c;
+    const srvDef = (_a = capModel.definitions) === null || _a === void 0 ? void 0 : _a[serviceInfo.name];
+    /* eslint-disable-next-line  @typescript-eslint/no-explicit-any */
+    const serviceFilePath = (_b = srvDef === null || srvDef === void 0 ? void 0 : srvDef.$location) === null || _b === void 0 ? void 0 : _b.file;
+    logger_helper_1.default.logger.debug(`Cap service def: ${JSON.stringify(srvDef)}`);
+    logger_helper_1.default.logger.debug(`Cap service def $location.file: ${JSON.stringify(serviceFilePath)}`);
+    // Find the source path for the service definition file, we cannot resolve '../' path segments as
+    // we have no idea where the cwd was when the cds compiler was run. Remove the '../' or '..\\' path segments so the relative path can
+    // be resolved against the project root. This is a workaround until cds provides the correct path in the service info.
+    const absServicePath = (_c = capModel.$sources) === null || _c === void 0 ? void 0 : _c.find((source) => source.indexOf(serviceFilePath.replace(/\.\.\\\\|\.\.\\|\.\.\//g, '')) > -1);
+    logger_helper_1.default.logger.debug(`Source file path for service: ${serviceInfo.name}: ${absServicePath}`);
+    if (absServicePath && (0, path_1.isAbsolute)(absServicePath)) {
+        let serviceCdsFilePath = (0, path_1.relative)(projectPath, absServicePath);
+        // remove the file extension
+        serviceCdsFilePath = serviceCdsFilePath.substring(0, serviceCdsFilePath.lastIndexOf('.cds'));
+        logger_helper_1.default.logger.debug(`serviceCdsFilePath: ${serviceCdsFilePath}`);
+        const capService = {
+            serviceName: serviceInfo.name,
+            urlPath: !serviceInfo.urlPath.startsWith('/') ? `/${serviceInfo.urlPath}` : serviceInfo.urlPath,
+            serviceCdsPath: serviceCdsFilePath,
+            projectPath,
+            appPath,
+            // Assume Node.js if not defined
+            capType: serviceInfo.runtime ? serviceInfo.runtime : 'Node.js'
+        };
+        return {
+            name: capService.capType
+                ? capService.serviceName + ' (' + capService.capType + ')'
+                : capService.serviceName,
+            value: capService
+        };
+    }
+    logger_helper_1.default.logger.error(`Path for cds service file : ${serviceInfo.name} not found in cds model, $sources, or is not an absolute path`);
+    return undefined;
+}
+/**
+ * Gets the CAP service choices for the specified CAP project paths.
+ *
+ * @param capProjectPaths - The CAP project paths
+ * @returns The CAP project service choices
+ */
+function getCapServiceChoices(capProjectPaths) {
+    return __awaiter(this, void 0, void 0, function* () {
+        logger_helper_1.default.logger.debug(`getCapServiceChoices: ${JSON.stringify(capProjectPaths)}`);
+        if (!capProjectPaths) {
+            return [];
+        }
+        try {
+            let capServices = [];
+            let capModel;
+            try {
+                // Workaround for missing clear cache functionality in `getCapModelAnsdServices`, this resets the cds.resolve.cache.
+                // If this is not done then errors can be thrown where out-of-processs changes to the files system have occurred
+                yield (0, project_access_1.getCdsRoots)(capProjectPaths.path, true);
+                // Load the CAP model and services
+                const { model, services } = yield (0, project_access_1.getCapModelAndServices)({
+                    projectRoot: capProjectPaths.path,
+                    logger: logger_helper_1.default.logger
+                });
+                capServices = services;
+                capModel = model;
+            }
+            catch (error) {
+                prompt_helpers_1.errorHandler.logErrorMsgs(error);
+                logger_helper_1.default.logger.error((0, i18n_1.t)('errors.capModelAndServicesLoadError', { error: error === null || error === void 0 ? void 0 : error.message }));
+                return [];
+            }
+            // We need the relative service definitions file paths (.cds) for the generated annotation file
+            const projectPath = capProjectPaths.path;
+            const appPath = capProjectPaths.app;
+            logger_helper_1.default.logger.debug(`CDS model source paths: ${JSON.stringify(capModel.$sources)}`);
+            const serviceChoices = capServices
+                .map((service) => {
+                return createCapServiceChoice(capModel, service, projectPath, appPath);
+            })
+                .filter((service) => !!service); // filter undefined entries
+            return serviceChoices !== null && serviceChoices !== void 0 ? serviceChoices : [];
+        }
+        catch (err) {
+            prompt_helpers_1.errorHandler.logErrorMsgs(err);
+        }
+        return [];
+    });
+}
+exports.getCapServiceChoices = getCapServiceChoices;
+/**
+ * Get the edmx metadata for the CAP service.
+ *
+ * @param capService - The CAP service
+ * @returns The edmx metadata for the CAP service
+ */
+function getCapEdmx(capService) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!capService.urlPath) {
+            const errorMsg = (0, i18n_1.t)('errors.capServiceUrlPathNotDefined', { serviceName: capService.serviceName });
+            prompt_helpers_1.errorHandler.logErrorMsgs(errorMsg);
+            return undefined;
+        }
+        try {
+            return yield (0, project_access_1.readCapServiceMetadataEdmx)(capService.projectPath, capService.urlPath, 'v4');
+        }
+        catch (error) {
+            prompt_helpers_1.errorHandler.logErrorMsgs((0, i18n_1.t)('errors.cannotReadCapServiceMetadata', { serviceName: capService.serviceName }));
+            logger_helper_1.default.logger.error(error);
+        }
+    });
+}
+exports.getCapEdmx = getCapEdmx;
+//# sourceMappingURL=cap-helpers.js.map

package/dist/prompts/datasources/cap-project/questions.d.ts

@@ -0,0 +1,14 @@
+import type { YUIQuestion } from '@sap-ux/inquirer-common';
+import type { Question } from 'inquirer';
+import type { OdataServicePromptOptions } from '../../../types';
+import { type CapServiceAnswers } from './types';
+/**
+ * Get the prompts for selecting a CAP project from local path discovery.
+ * Two prompts are returned, one for selecting a CAP project from a list of discovered projects and
+ * one for entering a custom path to a CAP project.
+ *
+ * @param promptOptions - The prompt options which control CAP project search paths and default value
+ * @returns the prompt used to provide input for selecting a CAP project
+ */
+export declare function getLocalCapProjectPrompts(promptOptions?: OdataServicePromptOptions): (YUIQuestion<CapServiceAnswers> | Question)[];
+//# sourceMappingURL=questions.d.ts.map

package/dist/prompts/datasources/cap-project/questions.js

@@ -0,0 +1,172 @@
+"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.getLocalCapProjectPrompts = void 0;
+const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
+const project_access_1 = require("@sap-ux/project-access");
+const i18n_1 = require("../../../i18n");
+const types_1 = require("../../../types");
+const utils_1 = require("../../../utils");
+const prompt_helpers_1 = require("../../prompt-helpers");
+const cap_helpers_1 = require("./cap-helpers");
+const types_2 = require("./types");
+const validators_1 = require("./validators");
+/**
+ * Find the specified choice in the list of CAP project choices and return its index.
+ *
+ * @param capChoices The list of CAP project choices
+ * @param defaultChoicePath The path of the default choice
+ * @returns The index of the default choice in the list of CAP project choices
+ */
+function getDefaultCapChoice(capChoices, defaultChoicePath) {
+    if (defaultChoicePath) {
+        return capChoices.findIndex((choice) => {
+            if (typeof choice.value === 'string') {
+                return choice.value === defaultChoicePath;
+            }
+            return choice.value.path === defaultChoicePath;
+        });
+    }
+    else if (capChoices.length === 2) {
+        return 0;
+    }
+    return -1;
+}
+/**
+ * Get the prompts for selecting a CAP project from local path discovery.
+ * Two prompts are returned, one for selecting a CAP project from a list of discovered projects and
+ * one for entering a custom path to a CAP project.
+ *
+ * @param promptOptions - The prompt options which control CAP project search paths and default value
+ * @returns the prompt used to provide input for selecting a CAP project
+ */
+function getLocalCapProjectPrompts(promptOptions) {
+    var _a, _b;
+    let capChoices = [];
+    const defaultCapPath = (_a = promptOptions === null || promptOptions === void 0 ? void 0 : promptOptions[types_1.promptNames.capProject]) === null || _a === void 0 ? void 0 : _a.defaultChoice;
+    const defaultCapService = (_b = promptOptions === null || promptOptions === void 0 ? void 0 : promptOptions[types_1.promptNames.capService]) === null || _b === void 0 ? void 0 : _b.defaultChoice;
+    let selectedCapProject;
+    let capServiceChoices;
+    let defaultServiceIndex = 0;
+    utils_1.PromptState.reset();
+    const prompts = [
+        {
+            when: () => __awaiter(this, void 0, void 0, function* () {
+                var _c, _d;
+                capChoices = yield (0, cap_helpers_1.getCapProjectChoices)((_d = (_c = promptOptions === null || promptOptions === void 0 ? void 0 : promptOptions[types_1.promptNames.capProject]) === null || _c === void 0 ? void 0 : _c.capSearchPaths) !== null && _d !== void 0 ? _d : []);
+                return (capChoices === null || capChoices === void 0 ? void 0 : capChoices.length) > 1;
+            }),
+            type: 'list',
+            name: types_1.promptNames.capProject,
+            message: (0, i18n_1.t)('prompts.capProject.message'),
+            default: () => {
+                const defChoice = getDefaultCapChoice(capChoices, defaultCapPath);
+                return defChoice;
+            },
+            choices: () => capChoices,
+            guiOptions: {
+                applyDefaultWhenDirty: true,
+                mandatory: true,
+                breadcrumb: (0, i18n_1.t)('prompts.capProject.breadcrumb')
+            }
+        },
+        {
+            when: (answers) => capChoices.length === 1 || (answers === null || answers === void 0 ? void 0 : answers.capProject) === cap_helpers_1.enterCapPathChoiceValue,
+            type: 'input',
+            guiType: 'folder-browser',
+            name: types_2.capInternalPromptNames.capProjectPath,
+            message: (0, i18n_1.t)('prompts.capProjectPath.message'),
+            default: () => {
+                if (defaultCapPath) {
+                    return defaultCapPath;
+                }
+            },
+            guiOptions: { mandatory: true, breadcrumb: (0, i18n_1.t)('prompts.capProject.breadcrumb') },
+            validate: (projectPath) => __awaiter(this, void 0, void 0, function* () {
+                const validCapPath = yield (0, validators_1.validateCapPath)(projectPath);
+                // Load the cap paths if the path is valid
+                if (validCapPath === true) {
+                    selectedCapProject = Object.assign({ path: projectPath }, yield (0, project_access_1.getCapCustomPaths)(projectPath));
+                    return true;
+                }
+                selectedCapProject = undefined;
+                return validCapPath;
+            })
+        },
+        {
+            when: (answers) => __awaiter(this, void 0, void 0, function* () {
+                if (typeof (answers === null || answers === void 0 ? void 0 : answers.capProject) === 'object') {
+                    selectedCapProject = answers.capProject;
+                }
+                if (selectedCapProject) {
+                    capServiceChoices = yield (0, cap_helpers_1.getCapServiceChoices)(selectedCapProject);
+                    return true;
+                }
+                return false;
+            }),
+            type: 'list',
+            name: types_1.promptNames.capService,
+            message: (0, i18n_1.t)('prompts.capService.message'),
+            choices: () => {
+                if (defaultCapService) {
+                    // Find the cap service, qualified by the provided project path
+                    defaultServiceIndex = capServiceChoices === null || capServiceChoices === void 0 ? void 0 : capServiceChoices.findIndex((choice) => {
+                        var _a, _b;
+                        // project path is an extra validation that the prompt options for each
+                        // of `defaultCapProject` and `defaultCapService` are compatible
+                        return ((_a = choice.value) === null || _a === void 0 ? void 0 : _a.projectPath) === (defaultCapService === null || defaultCapService === void 0 ? void 0 : defaultCapService.projectPath) &&
+                            ((_b = choice.value) === null || _b === void 0 ? void 0 : _b.serviceName) === (defaultCapService === null || defaultCapService === void 0 ? void 0 : defaultCapService.serviceName);
+                    });
+                }
+                return capServiceChoices;
+            },
+            guiOptions: {
+                applyDefaultWhenDirty: true,
+                mandatory: true,
+                breadcrumb: true
+            },
+            default: () => {
+                return (capServiceChoices === null || capServiceChoices === void 0 ? void 0 : capServiceChoices.length) > 1 ? defaultServiceIndex : 0;
+            },
+            validate: (capService) => __awaiter(this, void 0, void 0, function* () {
+                const errMsg = prompt_helpers_1.errorHandler.getErrorMsg(undefined, true);
+                if (errMsg) {
+                    return errMsg;
+                }
+                if (capService) {
+                    utils_1.PromptState.odataService.metadata = yield (0, cap_helpers_1.getCapEdmx)(capService);
+                    utils_1.PromptState.odataService.servicePath = capService.urlPath;
+                    utils_1.PromptState.odataService.odataVersion = odata_service_writer_1.OdataVersion.v4;
+                    return utils_1.PromptState.odataService.metadata !== undefined
+                        ? true
+                        : (0, i18n_1.t)('prompts.validationMessages.metadataInvalid');
+                }
+                return false;
+            })
+        }
+    ];
+    if ((0, utils_1.getPlatform)() === types_1.hostEnvironment.cli) {
+        prompts.push({
+            when: (answers) => __awaiter(this, void 0, void 0, function* () {
+                if (answers === null || answers === void 0 ? void 0 : answers.capService) {
+                    utils_1.PromptState.odataService.metadata = yield (0, cap_helpers_1.getCapEdmx)(answers === null || answers === void 0 ? void 0 : answers.capService);
+                    utils_1.PromptState.odataService.servicePath = answers === null || answers === void 0 ? void 0 : answers.capService.urlPath;
+                    utils_1.PromptState.odataService.odataVersion = odata_service_writer_1.OdataVersion.v4;
+                }
+                return false;
+            }),
+            name: types_2.capInternalPromptNames.capCliStateSetter
+        });
+    }
+    return prompts;
+}
+exports.getLocalCapProjectPrompts = getLocalCapProjectPrompts;
+//# sourceMappingURL=questions.js.map

package/dist/prompts/datasources/cap-project/types.d.ts

@@ -0,0 +1,27 @@
+import type { CapCustomPaths } from '@sap-ux/project-access';
+import type { CapService, CapServiceChoice, promptNames } from '../../../types';
+import type { ListChoiceOptions } from 'inquirer';
+/**
+ * Enumeration of internal prompt names used internally and not supported for modification using OdataServiceInquirerPromptOptions
+ */
+export declare enum capInternalPromptNames {
+    capProjectPath = "capProjectPath",
+    capCliStateSetter = "capCliStateSetter"
+}
+/**
+ * Answers to CAP service prompt
+ */
+export interface CapServiceAnswers extends CapService {
+    [promptNames.capProject]: CapProjectChoice['value'];
+    [capInternalPromptNames.capProjectPath]: string;
+    [promptNames.capService]: CapServiceChoice['value'];
+}
+export type CapProjectRootPath = {
+    folderName: string;
+    path: string;
+};
+export type CapProjectPaths = CapProjectRootPath & CapCustomPaths;
+export interface CapProjectChoice extends ListChoiceOptions {
+    value: CapProjectPaths | string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/prompts/datasources/cap-project/types.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.capInternalPromptNames = void 0;
+/**
+ * Enumeration of internal prompt names used internally and not supported for modification using OdataServiceInquirerPromptOptions
+ */
+var capInternalPromptNames;
+(function (capInternalPromptNames) {
+    capInternalPromptNames["capProjectPath"] = "capProjectPath";
+    capInternalPromptNames["capCliStateSetter"] = "capCliStateSetter";
+})(capInternalPromptNames || (exports.capInternalPromptNames = capInternalPromptNames = {}));
+//# sourceMappingURL=types.js.map

package/dist/prompts/datasources/cap-project/validators.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Ensure the path specified is a valid CAP project.
+ *
+ * @param capProjectPath - The path to the CAP project
+ * @returns A boolean indicating if the path is a valid CAP project or an error message
+ */
+export declare function validateCapPath(capProjectPath: string): Promise<boolean | string>;
+//# sourceMappingURL=validators.d.ts.map

package/dist/prompts/datasources/cap-project/validators.js

@@ -0,0 +1,35 @@
+"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.validateCapPath = void 0;
+const project_access_1 = require("@sap-ux/project-access");
+const i18n_1 = require("../../../i18n");
+/**
+ * Ensure the path specified is a valid CAP project.
+ *
+ * @param capProjectPath - The path to the CAP project
+ * @returns A boolean indicating if the path is a valid CAP project or an error message
+ */
+function validateCapPath(capProjectPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (capProjectPath) {
+            try {
+                return !!(yield (0, project_access_1.getCapProjectType)(capProjectPath)) || (0, i18n_1.t)('prompts.validationMessages.capProjectNotFound');
+            }
+            catch (err) {
+                return (0, i18n_1.t)('prompts.validationMessages.capProjectNotFound');
+            }
+        }
+        return false;
+    });
+}
+exports.validateCapPath = validateCapPath;
+//# sourceMappingURL=validators.js.map

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

@@ -0,0 +1,10 @@
+import type { YUIQuestion } from '@sap-ux/inquirer-common';
+import type { MetadataPromptOptions, OdataServiceAnswers } from '../../../types';
+/**
+ * Returns the metadata file question based on the provided @type{MetadataPromptOptions}.
+ *
+ * @param promptOptions - The metadata prompt options
+ * @returns the metadata file question
+ */
+export declare function getMetadataFileQuestion(promptOptions?: MetadataPromptOptions): YUIQuestion<OdataServiceAnswers>;
+//# sourceMappingURL=index.d.ts.map