@sap-ux/project-access 1.3.1 → 1.4.0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { FileName } from './constants';
-export { findAllApps, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getCapModelAndServices, getCapProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readUi5Yaml } from './project';
+export { findAllApps, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getCapEnvironment, getCapModelAndServices, getCapProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readUi5Yaml } from './project';
 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.readUi5Yaml = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.FileName = void 0;
+exports.readUi5Yaml = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = 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");
@@ -22,6 +22,7 @@ Object.defineProperty(exports, "findAllApps", { enumerable: true, get: function
 Object.defineProperty(exports, "findProjectRoot", { enumerable: true, get: function () { return project_1.findProjectRoot; } });
 Object.defineProperty(exports, "getAppRootFromWebappPath", { enumerable: true, get: function () { return project_1.getAppRootFromWebappPath; } });
 Object.defineProperty(exports, "getAppProgrammingLanguage", { enumerable: true, get: function () { return project_1.getAppProgrammingLanguage; } });
+Object.defineProperty(exports, "getCapEnvironment", { enumerable: true, get: function () { return project_1.getCapEnvironment; } });
 Object.defineProperty(exports, "getCapModelAndServices", { enumerable: true, get: function () { return project_1.getCapModelAndServices; } });
 Object.defineProperty(exports, "getCapProjectType", { enumerable: true, get: function () { return project_1.getCapProjectType; } });
 Object.defineProperty(exports, "getWebappPath", { enumerable: true, get: function () { return project_1.getWebappPath; } });

package/dist/project/cap.d.ts

@@ -1,4 +1,8 @@
-import type { CapCustomPaths, CapProjectType, csn, Package } from '../types';
+import type { CapCustomPaths, CapProjectType, CdsEnvironment, csn, Package } from '../types';
+interface ServiceInfo {
+    name: string;
+    urlPath: string;
+}
 /**
  * Returns true if the project is a CAP Node.js project.
  *
@@ -34,9 +38,14 @@ export declare function getCapCustomPaths(capProjectPath: string): Promise<CapCu
  */
 export declare function getCapModelAndServices(projectRoot: string): Promise<{
     model: csn;
-    services: {
-        name: string;
-        urlPath: string;
-    }[];
+    services: ServiceInfo[];
 }>;
+/**
+ * Get CAP CDS project environment config for project root.
+ *
+ * @param capProjectPath - project root of a CAP project
+ * @returns - environment config for CAP project
+ */
+export declare function getCapEnvironment(capProjectPath: string): Promise<CdsEnvironment>;
+export {};
 //# sourceMappingURL=cap.d.ts.map

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.getCapModelAndServices = exports.getCapCustomPaths = exports.getCapProjectType = exports.isCapJavaProject = exports.isCapNodeJsProject = void 0;
+exports.getCapEnvironment = 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");
@@ -77,8 +77,7 @@ function getCapCustomPaths(capProjectPath) {
             srv: 'srv/'
         };
         try {
-            const cds = yield (0, module_loader_1.loadModuleFromProject)(capProjectPath, '@sap/cds');
-            const cdsCustomPaths = cds.env.for('cds', capProjectPath);
+            const cdsCustomPaths = yield getCapEnvironment(capProjectPath);
             if (cdsCustomPaths.folders) {
                 result.app = cdsCustomPaths.folders.app;
                 result.db = cdsCustomPaths.folders.db;
@@ -115,4 +114,17 @@ function getCapModelAndServices(projectRoot) {
     });
 }
 exports.getCapModelAndServices = getCapModelAndServices;
+/**
+ * Get CAP CDS project environment config for project root.
+ *
+ * @param capProjectPath - project root of a CAP project
+ * @returns - environment config for CAP project
+ */
+function getCapEnvironment(capProjectPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cds = yield (0, module_loader_1.loadModuleFromProject)(capProjectPath, '@sap/cds');
+        return cds.env.for('cds', capProjectPath);
+    });
+}
+exports.getCapEnvironment = getCapEnvironment;
 //# sourceMappingURL=cap.js.map

package/dist/project/index.d.ts

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

package/dist/project/index.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCapProjectType = exports.getCapModelAndServices = void 0;
+exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCapProjectType = exports.getCapModelAndServices = void 0;
 var cap_1 = require("./cap");
 Object.defineProperty(exports, "getCapModelAndServices", { enumerable: true, get: function () { return cap_1.getCapModelAndServices; } });
 Object.defineProperty(exports, "getCapProjectType", { enumerable: true, get: function () { return cap_1.getCapProjectType; } });
 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; } });
 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/dist/types/cap/index.d.ts

@@ -4,6 +4,16 @@ export interface CapCustomPaths {
     db: string;
     srv: string;
 }
+export interface CdsEnvironment {
+    folders?: CapCustomPaths;
+    i18n?: CapI18n;
+}
+export interface CapI18n {
+    default_language?: string;
+    fallback_bundle?: string;
+    file?: string;
+    folders?: string[];
+}
 type SELECT = {
     SELECT: {
         distinct?: true;

package/package.json

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