@sap-ux/odata-service-inquirer 0.1.1

package/dist/types.d.ts

@@ -0,0 +1,176 @@
+import type { IValidationLink } from '@sap-devx/yeoman-ui-types';
+import type { YUIQuestion } from '@sap-ux/inquirer-common';
+import type { OdataVersion } from '@sap-ux/odata-service-writer';
+import type { ListChoiceOptions } from 'inquirer';
+/**
+ * This file contains types that are exported by the module and are needed for consumers using the APIs `prompt` and `getPrompts`.
+ */
+export declare enum DatasourceType {
+    sapSystem = "sapSystem",
+    businessHub = "businessHub",
+    capProject = "capProject",
+    odataServiceUrl = "odataServiceUrl",
+    none = "none",
+    metadataFile = "metadataFile",
+    projectSpecificDestination = "projectSpecificDestination"
+}
+/**
+ * Answers returned by the OdataServiceInquirer prompt API.
+ * These values may be used to write an OData service and may be derived from the user's input rather than direct answers.
+ */
+export interface OdataServiceAnswers {
+    /**
+     * The data source type answer.
+     */
+    datasourceType: DatasourceType;
+    /**
+     * The odata service metadata (edmx) document.
+     */
+    metadata?: string;
+    /**
+     * The selected CAP service.
+     */
+    capService?: CapService;
+    /**
+     * The odata version of the selected service.
+     */
+    odataVersion?: OdataVersion;
+    /**
+     * The relative path of the selected service.
+     */
+    servicePath?: string;
+    /**
+     * Metadata file path
+     */
+    metadataFilePath?: string;
+}
+/**
+ * Enumeration of prompt names used by OdataServiceInquirerPromptOptions
+ */
+export declare enum promptNames {
+    /**
+     * Data source type
+     */
+    datasourceType = "datasourceType",
+    /**
+     * Metadata file path
+     */
+    metadataFilePath = "metadataFilePath",
+    /**
+     * Cap project
+     */
+    capProject = "capProject",
+    /**
+     * Cap service
+     */
+    capService = "capService"
+}
+export type CapRuntime = 'Node.js' | 'Java';
+export interface CapService {
+    /**
+     * The path to the CAP project.
+     */
+    projectPath: string;
+    /**
+     * The name of the CAP service as identified by the cds model.
+     */
+    serviceName: string;
+    /**
+     * The URL path to the service, as specfied in the manifest.json of generated apps
+     * This is also provided as `OdataServicePromptAnswers` property `servicePath`
+     */
+    urlPath?: string;
+    /**
+     * The relative path (from the `projectPath`) to the service cds file.
+     */
+    serviceCdsPath?: string;
+    /**
+     * The runtime of the CAP service.
+     */
+    capType?: CapRuntime;
+    /**
+     * The relative path (from the `projectPath`) to the app folder
+     */
+    appPath?: string;
+}
+export interface CapServiceChoice extends ListChoiceOptions {
+    value: CapService;
+}
+export type CapProjectPromptOptions = {
+    /**
+     * The search paths for the CAP projects, this is a mandatory option as searching the entire file system is not recommended.
+     */
+    capSearchPaths: string[];
+    /**
+     * The default selected CAP project choice, this is used to pre-select a CAP project based on the CAP project path.
+     */
+    defaultChoice?: string;
+};
+export type CapServicePromptOptions = {
+    /**
+     * The default selected CAP service choice, this is used to pre-select a CAP service based on the specified CAP service name.
+     */
+    defaultChoice?: Pick<CapService, 'serviceName' | 'projectPath'>;
+};
+export type DatasourceTypePromptOptions = {
+    /**
+     * Default datasource type
+     */
+    default?: DatasourceType;
+    /**
+     * Include the no datasource option in the datasource type prompt
+     */
+    includeNone?: boolean;
+    /**
+     * Include the `projectSpecificDestination` option in the datasource type prompt
+     */
+    includeProjectSpecificDest?: boolean;
+};
+export type MetadataPromptOptions = {
+    /**
+     * Used to validate the metadata file contains the required odata version edmx
+     */
+    requiredOdataVersion?: OdataVersion;
+};
+/**
+ * Provide the correct type checking for object value prompt options
+ */
+type odataServiceInquirerPromptOptions = Record<promptNames.datasourceType, DatasourceTypePromptOptions> & Record<promptNames.metadataFilePath, MetadataPromptOptions> & Record<promptNames.capProject, CapProjectPromptOptions> & Record<promptNames.capService, CapServicePromptOptions>;
+export type OdataServiceQuestion = YUIQuestion<OdataServiceAnswers>;
+export type OdataServicePromptOptions = Partial<odataServiceInquirerPromptOptions>;
+/**
+ * Implementation of IValidationLink interface.
+ * Provides a toString() for serialization on CLI since IValidationLink rendering is only supported by YeomanUI.
+ */
+export declare class ValidationLink implements IValidationLink {
+    message: IValidationLink['message'];
+    link: IValidationLink['link'];
+    /**
+     * Constructor for ValidationLink.
+     *
+     * @param validationLink The validation link object to be used for serialization
+     */
+    constructor(validationLink: IValidationLink);
+    /**
+     * Serialize the validation link object to a string.
+     *
+     * @returns The validation link object as a string
+     */
+    toString(): string;
+}
+export declare const hostEnvironment: {
+    vscode: {
+        name: string;
+        technical: string;
+    };
+    bas: {
+        name: string;
+        technical: string;
+    };
+    cli: {
+        name: string;
+        technical: string;
+    };
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hostEnvironment = exports.ValidationLink = exports.promptNames = 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`.
+ */
+var DatasourceType;
+(function (DatasourceType) {
+    DatasourceType["sapSystem"] = "sapSystem";
+    DatasourceType["businessHub"] = "businessHub";
+    DatasourceType["capProject"] = "capProject";
+    DatasourceType["odataServiceUrl"] = "odataServiceUrl";
+    DatasourceType["none"] = "none";
+    DatasourceType["metadataFile"] = "metadataFile";
+    DatasourceType["projectSpecificDestination"] = "projectSpecificDestination";
+})(DatasourceType || (exports.DatasourceType = DatasourceType = {}));
+/**
+ * Enumeration of prompt names used by OdataServiceInquirerPromptOptions
+ */
+var promptNames;
+(function (promptNames) {
+    /**
+     * Data source type
+     */
+    promptNames["datasourceType"] = "datasourceType";
+    /**
+     * Metadata file path
+     */
+    promptNames["metadataFilePath"] = "metadataFilePath";
+    /**
+     * Cap project
+     */
+    promptNames["capProject"] = "capProject";
+    /**
+     * Cap service
+     */
+    promptNames["capService"] = "capService";
+})(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 {
+    /**
+     * 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'
+    }
+};
+//# sourceMappingURL=types.js.map

package/dist/utils/index.d.ts

@@ -0,0 +1,26 @@
+import type { TelemetryProperties, ToolsSuiteTelemetryClient } from '@sap-ux/telemetry';
+import { PromptState } from './prompt-state';
+/**
+ * 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 getPlatform(): {
+    name: string;
+    technical: string;
+};
+/**
+ * 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;
+export { PromptState };
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/index.js

@@ -0,0 +1,70 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptState = exports.sendTelemetryEvent = exports.setTelemetryClient = exports.getPlatform = void 0;
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const telemetry_1 = require("@sap-ux/telemetry");
+const os_name_1 = __importDefault(require("os-name"));
+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)();
+/**
+ * Determine if the current prompting environment is cli or a hosted extension (app studio or vscode).
+ *
+ * @returns the platform name and technical name
+ */
+function getPlatform() {
+    if (!prompt_state_1.PromptState.isYUI) {
+        return types_1.hostEnvironment.cli;
+    }
+    else {
+        return (0, btp_utils_1.isAppStudio)() ? types_1.hostEnvironment.bas : types_1.hostEnvironment.vscode;
+    }
+}
+exports.getPlatform = getPlatform;
+let telemetryClient;
+/**
+ * Set the telemetry client.
+ *
+ * @param toolsSuiteTelemetryClient the telemetry client instance to use when sending telemetry events
+ */
+function setTelemetryClient(toolsSuiteTelemetryClient) {
+    telemetryClient = toolsSuiteTelemetryClient;
+}
+exports.setTelemetryClient = setTelemetryClient;
+/**
+ * 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) {
+        /* eslint-disable @typescript-eslint/no-floating-promises */
+        telemetryClient.reportEvent(telemetryEvent, telemetry_1.SampleRate.NoSampling);
+    }
+}
+exports.sendTelemetryEvent = sendTelemetryEvent;
+/**
+ * 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: getPlatform().technical,
+        OperatingSystem: osVersionName
+    });
+    return {
+        eventName,
+        properties: telemProps,
+        measurements: {}
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/utils/prompt-state.d.ts

@@ -0,0 +1,13 @@
+import type { OdataServiceAnswers } from '../types';
+/**
+ * Much of the values returned by the service inquirer prompting are derived from prompt answers and are not direct answer values.
+ * Since inquirer does not provide a way to return values that are not direct answers from prompts, this class will maintain the derived values
+ * across prompts statically for the lifespan of the prompting session.
+ *
+ */
+export declare class PromptState {
+    static odataService: Partial<OdataServiceAnswers>;
+    static isYUI: boolean;
+    static reset(): void;
+}
+//# sourceMappingURL=prompt-state.d.ts.map

package/dist/utils/prompt-state.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromptState = void 0;
+/**
+ * Much of the values returned by the service inquirer prompting are derived from prompt answers and are not direct answer values.
+ * Since inquirer does not provide a way to return values that are not direct answers from prompts, this class will maintain the derived values
+ * across prompts statically for the lifespan of the prompting session.
+ *
+ */
+class PromptState {
+    static reset() {
+        PromptState.odataService = {};
+    }
+}
+exports.PromptState = PromptState;
+PromptState.odataService = {};
+PromptState.isYUI = false;
+//# sourceMappingURL=prompt-state.js.map

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@sap-ux/odata-service-inquirer",
+  "description": "Prompts module that can prompt users for inputs required for odata service writing",
+  "version": "0.1.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/odata-sevice-inquirer"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aodata-service-inquirer"
+  },
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "files": [
+    "LICENSE",
+    "dist",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "dependencies": {
+    "@sap/wing-service-explorer": "1.8.0",
+    "i18next": "23.5.1",
+    "os-name": "4.0.1",
+    "@sap-ux/btp-utils": "0.14.3",
+    "@sap-ux/telemetry": "0.4.21",
+    "@sap-ux/inquirer-common": "0.2.7",
+    "@sap-ux/logger": "0.5.1",
+    "@sap-ux/project-access": "1.19.14"
+  },
+  "devDependencies": {
+    "@sap-devx/yeoman-ui-types": "1.14.4",
+    "@types/inquirer-autocomplete-prompt": "2.0.1",
+    "@types/inquirer": "8.2.6",
+    "@types/lodash": "4.14.202",
+    "jest-extended": "3.2.4",
+    "lodash": "4.17.21",
+    "@sap-ux/odata-service-writer": "0.17.1",
+    "@sap-ux/feature-toggle": "0.1.1"
+  },
+  "engines": {
+    "node": ">=18.x"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rimraf --glob dist test/test-output coverage *.tsbuildinfo",
+    "watch": "tsc --watch",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
+    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global"
+  }
+}