@sap-ux/project-access 1.9.0 → 1.10.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { FileName } from './constants';
-export { findAllApps, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readUi5Yaml } from './project';
+export { findAllApps, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml } from './project';
 export { getFilePaths } from './file';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,7 +14,7 @@ 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 });
-exports.getFilePaths = exports.readUi5Yaml = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findAllApps = exports.FileName = void 0;
+exports.getFilePaths = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findAllApps = exports.FileName = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "FileName", { enumerable: true, get: function () { return constants_1.FileName; } });
 var project_1 = require("./project");
@@ -31,6 +31,7 @@ Object.defineProperty(exports, "getWebappPath", { enumerable: true, get: functio
 Object.defineProperty(exports, "isCapJavaProject", { enumerable: true, get: function () { return project_1.isCapJavaProject; } });
 Object.defineProperty(exports, "isCapNodeJsProject", { enumerable: true, get: function () { return project_1.isCapNodeJsProject; } });
 Object.defineProperty(exports, "loadModuleFromProject", { enumerable: true, get: function () { return project_1.loadModuleFromProject; } });
+Object.defineProperty(exports, "readCapServiceMetadataEdmx", { enumerable: true, get: function () { return project_1.readCapServiceMetadataEdmx; } });
 Object.defineProperty(exports, "readUi5Yaml", { enumerable: true, get: function () { return project_1.readUi5Yaml; } });
 var file_1 = require("./file");
 Object.defineProperty(exports, "getFilePaths", { enumerable: true, get: function () { return file_1.getFilePaths; } });

package/dist/project/cap.d.ts

@@ -41,11 +41,20 @@ export declare function getCapModelAndServices(projectRoot: string): Promise<{
     model: csn;
     services: ServiceInfo[];
 }>;
+/**
+ * Return the EDMX string of a CAP service.
+ *
+ * @param root - CAP project root where package.json resides
+ * @param uri - service path, e.g 'incident/'
+ * @param version - optional OData version v2 or v4
+ * @returns - string containing the edmx
+ */
+export declare function readCapServiceMetadataEdmx(root: string, uri: string, version?: 'v2' | 'v4'): Promise<string>;
 /**
  * Get CAP CDS project environment config for project root.
  *
  * @param capProjectPath - project root of a CAP project
- * @returns - environment config for CAP project
+ * @returns - environment config for a CAP project
  */
 export declare function getCapEnvironment(capProjectPath: string): Promise<CdsEnvironment>;
 /**

package/dist/project/cap.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toReferenceUri = exports.toAbsoluteUri = exports.getCapEnvironment = exports.getCapModelAndServices = exports.getCapCustomPaths = exports.getCapProjectType = exports.isCapJavaProject = exports.isCapNodeJsProject = void 0;
+exports.toReferenceUri = exports.toAbsoluteUri = exports.getCapEnvironment = exports.readCapServiceMetadataEdmx = exports.getCapModelAndServices = exports.getCapCustomPaths = exports.getCapProjectType = exports.isCapJavaProject = exports.isCapNodeJsProject = void 0;
 const path_1 = require("path");
 const constants_1 = require("../constants");
 const file_1 = require("../file");
@@ -99,7 +99,7 @@ exports.getCapCustomPaths = getCapCustomPaths;
  */
 function getCapModelAndServices(projectRoot) {
     return __awaiter(this, void 0, void 0, function* () {
-        const cds = yield (0, module_loader_1.loadModuleFromProject)(projectRoot, '@sap/cds');
+        const cds = yield loadCdsModuleFromProject(projectRoot);
         const capProjectPaths = yield getCapCustomPaths(projectRoot);
         const modelPaths = [
             (0, path_1.join)(projectRoot, capProjectPaths.app),
@@ -115,20 +115,68 @@ function getCapModelAndServices(projectRoot) {
     });
 }
 exports.getCapModelAndServices = getCapModelAndServices;
+/**
+ * Return the EDMX string of a CAP service.
+ *
+ * @param root - CAP project root where package.json resides
+ * @param uri - service path, e.g 'incident/'
+ * @param version - optional OData version v2 or v4
+ * @returns - string containing the edmx
+ */
+function readCapServiceMetadataEdmx(root, uri, version = 'v4') {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const { model, services } = yield getCapModelAndServices(root);
+            const service = findServiceByUri(services, uri);
+            if (!service) {
+                throw Error(`Service for uri: '${uri}' not found. Available services: ${JSON.stringify(services)}`);
+            }
+            const cds = yield loadCdsModuleFromProject(root);
+            const edmx = cds.compile.to.edmx(model, { service: service.name, version });
+            return edmx;
+        }
+        catch (error) {
+            throw Error(`Error while reading CAP service metadata. Path: '${root}', service uri: '${uri}', error: '${error.toString()}'}`);
+        }
+    });
+}
+exports.readCapServiceMetadataEdmx = readCapServiceMetadataEdmx;
+/**
+ * Find a service in a list of services.
+ *
+ * @param services - list of services from cds.compile.to['serviceinfo'](model)
+ * @param uri - search uri (usually from data source in manifest.json)
+ * @returns - name and uri of the service, undefined if service not found
+ */
+function findServiceByUri(services, uri) {
+    const searchUri = uri.replace(/[\\/]/g, '/'); // replace all \ and / in service uri due to issues on Windows with backslashes
+    return services.find((srv) => srv.urlPath.replace(/[\\/]/g, '/') === searchUri);
+}
 /**
  * Get CAP CDS project environment config for project root.
  *
  * @param capProjectPath - project root of a CAP project
- * @returns - environment config for CAP project
+ * @returns - environment config for a CAP project
  */
 function getCapEnvironment(capProjectPath) {
     return __awaiter(this, void 0, void 0, function* () {
-        const module = yield (0, module_loader_1.loadModuleFromProject)(capProjectPath, '@sap/cds');
-        const cds = 'default' in module ? module.default : module;
+        const cds = yield loadCdsModuleFromProject(capProjectPath);
         return cds.env.for('cds', capProjectPath);
     });
 }
 exports.getCapEnvironment = getCapEnvironment;
+/**
+ * Load CAP CDS module for a project based on its root.
+ *
+ * @param capProjectPath - project root of a CAP project
+ * @returns - CAP CDS module for a CAP project
+ */
+function loadCdsModuleFromProject(capProjectPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const module = yield (0, module_loader_1.loadModuleFromProject)(capProjectPath, '@sap/cds');
+        return 'default' in module ? module.default : module;
+    });
+}
 /**
  * Get absolute path to a resource.
  *

package/dist/project/index.d.ts

@@ -1,4 +1,4 @@
-export { getCapCustomPaths, getCapModelAndServices, getCapProjectType, isCapJavaProject, isCapNodeJsProject, getCapEnvironment } from './cap';
+export { getCapCustomPaths, getCapModelAndServices, getCapProjectType, isCapJavaProject, isCapNodeJsProject, getCapEnvironment, readCapServiceMetadataEdmx } from './cap';
 export { getAppProgrammingLanguage } from './info';
 export { loadModuleFromProject } from './module-loader';
 export { findAllApps, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath } from './search';

package/dist/project/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapCustomPaths = void 0;
+exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapCustomPaths = void 0;
 var cap_1 = require("./cap");
 Object.defineProperty(exports, "getCapCustomPaths", { enumerable: true, get: function () { return cap_1.getCapCustomPaths; } });
 Object.defineProperty(exports, "getCapModelAndServices", { enumerable: true, get: function () { return cap_1.getCapModelAndServices; } });
@@ -8,6 +8,7 @@ Object.defineProperty(exports, "getCapProjectType", { enumerable: true, get: fun
 Object.defineProperty(exports, "isCapJavaProject", { enumerable: true, get: function () { return cap_1.isCapJavaProject; } });
 Object.defineProperty(exports, "isCapNodeJsProject", { enumerable: true, get: function () { return cap_1.isCapNodeJsProject; } });
 Object.defineProperty(exports, "getCapEnvironment", { enumerable: true, get: function () { return cap_1.getCapEnvironment; } });
+Object.defineProperty(exports, "readCapServiceMetadataEdmx", { enumerable: true, get: function () { return cap_1.readCapServiceMetadataEdmx; } });
 var info_1 = require("./info");
 Object.defineProperty(exports, "getAppProgrammingLanguage", { enumerable: true, get: function () { return info_1.getAppProgrammingLanguage; } });
 var module_loader_1 = require("./module-loader");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",