@sap-ux/odata-service-inquirer 0.2.3 → 0.3.0

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hostEnvironment = exports.ValidationLink = exports.promptNames = exports.DatasourceType = void 0;
+exports.SAP_CLIENT_KEY = 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`.
  */
@@ -35,6 +35,14 @@ var promptNames;
      * Cap service
      */
     promptNames["capService"] = "capService";
+    /**
+     * Odata service URL
+     */
+    promptNames["serviceUrl"] = "serviceUrl";
+    /**
+     * password
+     */
+    promptNames["serviceUrlPassword"] = "serviceUrlPassword";
 })(promptNames || (exports.promptNames = promptNames = {}));
 /**
  * Implementation of IValidationLink interface.
@@ -73,4 +81,5 @@ exports.hostEnvironment = {
         technical: 'CLI'
     }
 };
+exports.SAP_CLIENT_KEY = 'sap-client';
 //# sourceMappingURL=types.js.map

package/dist/utils/index.d.ts

@@ -1,11 +1,12 @@
 import type { TelemetryProperties, ToolsSuiteTelemetryClient } from '@sap-ux/telemetry';
 import { PromptState } from './prompt-state';
+import { OdataVersion } from '@sap-ux/odata-service-writer';
 /**
  * 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(): {
+export declare function getHostEnvironment(): {
     name: string;
     technical: string;
 };
@@ -22,5 +23,21 @@ export declare function setTelemetryClient(toolsSuiteTelemetryClient: ToolsSuite
  * @param telemetryData the telemetry values to report
  */
 export declare function sendTelemetryEvent(eventName: string, telemetryData: TelemetryProperties): void;
+/**
+ * Validate xml and parse the odata version from the metadata xml.
+ *
+ * @param metadata a metadata string
+ * @returns the odata version of the specified metadata, throws an error if the metadata is invalid
+ */
+export declare function parseOdataVersion(metadata: string): OdataVersion;
+/**
+ * Replaces the origin in the metadata URIs with a relative path.
+ * The path will be tested for '/sap/opu/odata/' and if found, the origin will be replaced with './'.
+ * This is to ensure that the SAP internal backend URIs are relative and that other non-SAP URIs are not affected.
+ *
+ * @param metadata a metadata string containing URIs which include origin (protocol, host, port)
+ * @returns the metadata string with URIs replaced with relative paths
+ */
+export declare function originToRelative(metadata: string): string;
 export { PromptState };
 //# sourceMappingURL=index.d.ts.map

package/dist/utils/index.js

@@ -3,20 +3,24 @@ 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;
+exports.PromptState = exports.originToRelative = exports.parseOdataVersion = exports.sendTelemetryEvent = exports.setTelemetryClient = exports.getHostEnvironment = 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 fast_xml_parser_1 = require("fast-xml-parser");
+const odata_service_writer_1 = require("@sap-ux/odata-service-writer");
+const logger_helper_1 = __importDefault(require("../prompts/logger-helper"));
+const i18n_1 = require("../i18n");
 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() {
+function getHostEnvironment() {
     if (!prompt_state_1.PromptState.isYUI) {
         return types_1.hostEnvironment.cli;
     }
@@ -24,7 +28,7 @@ function getPlatform() {
         return (0, btp_utils_1.isAppStudio)() ? types_1.hostEnvironment.bas : types_1.hostEnvironment.vscode;
     }
 }
-exports.getPlatform = getPlatform;
+exports.getHostEnvironment = getHostEnvironment;
 let telemetryClient;
 /**
  * Set the telemetry client.
@@ -58,7 +62,7 @@ exports.sendTelemetryEvent = sendTelemetryEvent;
  */
 function createTelemetryEvent(eventName, telemetryData) {
     const telemProps = Object.assign(telemetryData, {
-        Platform: getPlatform().technical,
+        Platform: getHostEnvironment().technical,
         OperatingSystem: osVersionName
     });
     return {
@@ -67,4 +71,50 @@ function createTelemetryEvent(eventName, telemetryData) {
         measurements: {}
     };
 }
+/**
+ * Validate xml and parse the odata version from the metadata xml.
+ *
+ * @param metadata a metadata string
+ * @returns the odata version of the specified metadata, throws an error if the metadata is invalid
+ */
+function parseOdataVersion(metadata) {
+    const options = {
+        attributeNamePrefix: '',
+        ignoreAttributes: false,
+        ignoreNameSpace: true,
+        parseAttributeValue: true,
+        removeNSPrefix: true
+    };
+    const parser = new fast_xml_parser_1.XMLParser(options);
+    try {
+        const parsed = parser.parse(metadata, true);
+        const odataVersion = parsed['Edmx']['Version'] === 1 ? odata_service_writer_1.OdataVersion.v2 : odata_service_writer_1.OdataVersion.v4;
+        return odataVersion;
+    }
+    catch (error) {
+        logger_helper_1.default.logger.error(error);
+        throw new Error((0, i18n_1.t)('prompts.validationMessages.metadataInvalid'));
+    }
+}
+exports.parseOdataVersion = parseOdataVersion;
+/**
+ * Replaces the origin in the metadata URIs with a relative path.
+ * The path will be tested for '/sap/opu/odata/' and if found, the origin will be replaced with './'.
+ * This is to ensure that the SAP internal backend URIs are relative and that other non-SAP URIs are not affected.
+ *
+ * @param metadata a metadata string containing URIs which include origin (protocol, host, port)
+ * @returns the metadata string with URIs replaced with relative paths
+ */
+function originToRelative(metadata) {
+    // Regex explanation:
+    // 1. Match the string "Uri=" literally
+    // 2. Match either "http" or "https"
+    // 3. Match the origin (protocol, host, port) as few times as possible
+    // 4. Match a single forward slash, indicating the first path segment of the URL (after the origin)
+    // 5. Match "sap/opu/odata" or "sap/opu/odata4" literally
+    return metadata.replace(new RegExp(/(Uri=")(http|https):\/{2}(.*?)(\/)(sap\/opu\/(odata\/|odata4\/))/, 'g'), 
+    // Retain the original path segment after the origin, matched with capture group 5 (index 4)
+    (match, ...patterns) => `${patterns[0]}./${patterns[4]}`);
+}
+exports.originToRelative = originToRelative;
 //# sourceMappingURL=index.js.map

package/dist/utils/prompt-state.js

@@ -9,7 +9,10 @@ exports.PromptState = void 0;
  */
 class PromptState {
     static reset() {
-        PromptState.odataService = {};
+        // Reset all values in the odataService object, do not reset the object reference itself as it may be used by external consumers
+        Object.keys(PromptState.odataService).forEach((key) => {
+            PromptState.odataService[key] = undefined;
+        });
     }
 }
 exports.PromptState = PromptState;

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.2.3",
+  "version": "0.3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -19,12 +19,15 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
-    "@sap/wing-service-explorer": "1.8.0",
+    "axios": "1.6.8",
+    "axios-logger": "2.8.0",
+    "fast-xml-parser": "4.2.7",
     "i18next": "23.5.1",
     "os-name": "4.0.1",
+    "@sap-ux/axios-extension": "1.13.1",
     "@sap-ux/btp-utils": "0.14.4",
     "@sap-ux/telemetry": "0.4.32",
-    "@sap-ux/inquirer-common": "0.2.8",
+    "@sap-ux/inquirer-common": "0.3.0",
     "@sap-ux/logger": "0.5.1",
     "@sap-ux/project-access": "1.22.0"
   },