@sap-ux/project-access 1.20.3 → 1.21.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { FileName, DirName, FioriToolsSettings } from './constants';
 export { getFilePaths } from './file';
-export { createApplicationAccess, createProjectAccess, findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getCapI18nFolderNames, getI18nPropertiesPaths, getMtaPath, getNodeModulesPath, getProject, getProjectType, getWebappPath, isCapProject, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml, toReferenceUri, clearCdsModuleCache } from './project';
+export { createApplicationAccess, createProjectAccess, findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getCapI18nFolderNames, getI18nPropertiesPaths, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getMtaPath, getNodeModulesPath, getProject, getProjectType, getWebappPath, isCapProject, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml, toReferenceUri, clearCdsModuleCache } from './project';
 export * from './types';
 export * from './library';
 //# 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.clearCdsModuleCache = exports.toReferenceUri = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMtaPath = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppType = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.createProjectAccess = exports.createApplicationAccess = exports.getFilePaths = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
+exports.clearCdsModuleCache = exports.toReferenceUri = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMtaPath = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppType = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.createProjectAccess = exports.createApplicationAccess = exports.getFilePaths = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "FileName", { enumerable: true, get: function () { return constants_1.FileName; } });
 Object.defineProperty(exports, "DirName", { enumerable: true, get: function () { return constants_1.DirName; } });
@@ -40,6 +40,9 @@ Object.defineProperty(exports, "getCdsRoots", { enumerable: true, get: function
 Object.defineProperty(exports, "getCdsServices", { enumerable: true, get: function () { return project_1.getCdsServices; } });
 Object.defineProperty(exports, "getCapI18nFolderNames", { enumerable: true, get: function () { return project_1.getCapI18nFolderNames; } });
 Object.defineProperty(exports, "getI18nPropertiesPaths", { enumerable: true, get: function () { return project_1.getI18nPropertiesPaths; } });
+Object.defineProperty(exports, "getMinUI5VersionFromManifest", { enumerable: true, get: function () { return project_1.getMinUI5VersionFromManifest; } });
+Object.defineProperty(exports, "getMinUI5VersionAsArray", { enumerable: true, get: function () { return project_1.getMinUI5VersionAsArray; } });
+Object.defineProperty(exports, "getMinimumUI5Version", { enumerable: true, get: function () { return project_1.getMinimumUI5Version; } });
 Object.defineProperty(exports, "getMtaPath", { enumerable: true, get: function () { return project_1.getMtaPath; } });
 Object.defineProperty(exports, "getNodeModulesPath", { enumerable: true, get: function () { return project_1.getNodeModulesPath; } });
 Object.defineProperty(exports, "getProject", { enumerable: true, get: function () { return project_1.getProject; } });

package/dist/project/cap.d.ts

@@ -1,10 +1,5 @@
-import type { CapCustomPaths, CapProjectType, CdsEnvironment, csn, Package, ServiceDefinitions } from '../types';
+import type { CapCustomPaths, CapProjectType, CdsEnvironment, csn, Package, ServiceDefinitions, ServiceInfo, CdsVersionInfo } from '../types';
 import type { Logger } from '@sap-ux/logger';
-interface ServiceInfo {
-    name: string;
-    urlPath: string;
-    runtime?: string;
-}
 /**
  * Returns true if the project is a CAP Node.js project.
  *
@@ -45,7 +40,7 @@ export declare function getCapCustomPaths(capProjectPath: string): Promise<CapCu
  * Return the CAP model and all services. The cds.root will be set to the provided project root path.
  *
  * @param projectRoot - CAP project root where package.json resides or object specifying project root and optional logger to log additional info
- * @returns {Promise<{ model: csn; services: ServiceInfo[] }>} - CAP Model and Services
+ * @returns {Promise<{ model: csn; services: ServiceInfo[]; cdsVersionInfo: CdsVersionInfo }>} - CAP Model and Services
  */
 export declare function getCapModelAndServices(projectRoot: string | {
     projectRoot: string;
@@ -53,6 +48,7 @@ export declare function getCapModelAndServices(projectRoot: string | {
 }): Promise<{
     model: csn;
     services: ServiceInfo[];
+    cdsVersionInfo: CdsVersionInfo;
 }>;
 /**
  * Returns a list of cds file paths (layers). By default return list of all, but you can also restrict it to one envRoot.
@@ -123,5 +119,4 @@ export declare const toReferenceUri: (projectRoot: string, relativeUriFrom: stri
  * Clear cache of path to global cds module.
  */
 export declare function clearGlobalCdsPathCache(): void;
-export {};
 //# sourceMappingURL=cap.d.ts.map

package/dist/project/cap.js

@@ -114,7 +114,7 @@ exports.getCapCustomPaths = getCapCustomPaths;
  * Return the CAP model and all services. The cds.root will be set to the provided project root path.
  *
  * @param projectRoot - CAP project root where package.json resides or object specifying project root and optional logger to log additional info
- * @returns {Promise<{ model: csn; services: ServiceInfo[] }>} - CAP Model and Services
+ * @returns {Promise<{ model: csn; services: ServiceInfo[]; cdsVersionInfo: CdsVersionInfo }>} - CAP Model and Services
  */
 function getCapModelAndServices(projectRoot) {
     var _a;
@@ -151,7 +151,12 @@ function getCapModelAndServices(projectRoot) {
         }
         return {
             model,
-            services
+            services,
+            cdsVersionInfo: {
+                home: cds.home,
+                version: cds.version,
+                root: cds.root
+            }
         };
     });
 }

package/dist/project/index.d.ts

@@ -1,7 +1,7 @@
 export { getCapCustomPaths, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, isCapProject, isCapJavaProject, isCapNodeJsProject, getCapEnvironment, readCapServiceMetadataEdmx, toReferenceUri, clearCdsModuleCache } from './cap';
 export { getNodeModulesPath } from './dependencies';
 export { getCapI18nFolderNames, getI18nPropertiesPaths } from './i18n';
-export { getAppProgrammingLanguage, getAppType, getProject, getProjectType } from './info';
+export { getAppProgrammingLanguage, getAppType, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getProject, getProjectType } from './info';
 export { loadModuleFromProject } from './module-loader';
 export { findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath } from './search';
 export { getWebappPath, readUi5Yaml } from './ui5-config';

package/dist/project/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createProjectAccess = exports.createApplicationAccess = exports.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.loadModuleFromProject = exports.getProjectType = exports.getProject = exports.getAppType = exports.getAppProgrammingLanguage = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getNodeModulesPath = exports.clearCdsModuleCache = exports.toReferenceUri = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapCustomPaths = void 0;
+exports.createProjectAccess = exports.createApplicationAccess = exports.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.loadModuleFromProject = exports.getProjectType = exports.getProject = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getAppType = exports.getAppProgrammingLanguage = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getNodeModulesPath = exports.clearCdsModuleCache = exports.toReferenceUri = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = 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; } });
@@ -23,6 +23,9 @@ Object.defineProperty(exports, "getI18nPropertiesPaths", { enumerable: true, get
 var info_1 = require("./info");
 Object.defineProperty(exports, "getAppProgrammingLanguage", { enumerable: true, get: function () { return info_1.getAppProgrammingLanguage; } });
 Object.defineProperty(exports, "getAppType", { enumerable: true, get: function () { return info_1.getAppType; } });
+Object.defineProperty(exports, "getMinUI5VersionFromManifest", { enumerable: true, get: function () { return info_1.getMinUI5VersionFromManifest; } });
+Object.defineProperty(exports, "getMinUI5VersionAsArray", { enumerable: true, get: function () { return info_1.getMinUI5VersionAsArray; } });
+Object.defineProperty(exports, "getMinimumUI5Version", { enumerable: true, get: function () { return info_1.getMinimumUI5Version; } });
 Object.defineProperty(exports, "getProject", { enumerable: true, get: function () { return info_1.getProject; } });
 Object.defineProperty(exports, "getProjectType", { enumerable: true, get: function () { return info_1.getProjectType; } });
 var module_loader_1 = require("./module-loader");

package/dist/project/info.d.ts

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { AppProgrammingLanguage, AppType, Project, ProjectType } from '../types';
+import type { AppProgrammingLanguage, AppType, Manifest, Project, ProjectType } from '../types';
 /**
  * Returns the project structure for a given Fiori project.
  *
@@ -29,4 +29,26 @@ export declare function getAppType(appRoot: string): Promise<AppType | undefined
  * @returns - project type like Edmx, CAPJava, CAPNodejs
  */
 export declare function getProjectType(projectRoot: string): Promise<ProjectType>;
+/**
+ * Returns the minUI5Version, as defined in manifest.
+ *
+ * @param manifest - manifest object
+ * @returns minUI5Version, if present
+ */
+export declare function getMinUI5VersionFromManifest(manifest: Manifest): string | string[] | undefined;
+/**
+ * Returns the minUI5Version as string[].
+ *
+ * @param manifest - manifest object
+ * @returns minUI5Version, as an array of strings
+ */
+export declare function getMinUI5VersionAsArray(manifest: Manifest): string[];
+/**
+ * Returns the minUI5Version in string format.
+ * If it is defined as an arry, returns the minimum version from it.
+ *
+ * @param manifest - manifest object
+ * @returns the minimum version as string
+ */
+export declare function getMinimumUI5Version(manifest: Manifest): string | undefined;
 //# sourceMappingURL=info.d.ts.map

package/dist/project/info.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProjectType = exports.getAppType = exports.getAppProgrammingLanguage = exports.getProject = void 0;
+exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getProjectType = exports.getAppType = exports.getAppProgrammingLanguage = exports.getProject = void 0;
 const path_1 = require("path");
 const constants_1 = require("../constants");
 const file_1 = require("../file");
@@ -18,6 +18,7 @@ const i18n_1 = require("./i18n/i18n");
 const search_1 = require("./search");
 const service_1 = require("./service");
 const ui5_config_1 = require("./ui5-config");
+const semver_1 = require("semver");
 /**
  * Returns the project structure for a given Fiori project.
  *
@@ -215,4 +216,54 @@ function getProjectType(projectRoot) {
     });
 }
 exports.getProjectType = getProjectType;
+/**
+ * Returns the minUI5Version, as defined in manifest.
+ *
+ * @param manifest - manifest object
+ * @returns minUI5Version, if present
+ */
+function getMinUI5VersionFromManifest(manifest) {
+    var _a;
+    const dependencies = (_a = manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.dependencies;
+    if (dependencies) {
+        return dependencies.minUI5Version;
+    }
+    return undefined;
+}
+exports.getMinUI5VersionFromManifest = getMinUI5VersionFromManifest;
+/**
+ * Returns the minUI5Version as string[].
+ *
+ * @param manifest - manifest object
+ * @returns minUI5Version, as an array of strings
+ */
+function getMinUI5VersionAsArray(manifest) {
+    let result = [];
+    const minUI5Version = getMinUI5VersionFromManifest(manifest);
+    if (minUI5Version) {
+        result = Array.isArray(minUI5Version) ? minUI5Version : [minUI5Version];
+    }
+    return result;
+}
+exports.getMinUI5VersionAsArray = getMinUI5VersionAsArray;
+/**
+ * Returns the minUI5Version in string format.
+ * If it is defined as an arry, returns the minimum version from it.
+ *
+ * @param manifest - manifest object
+ * @returns the minimum version as string
+ */
+function getMinimumUI5Version(manifest) {
+    let result;
+    const minUI5VersionArray = getMinUI5VersionAsArray(manifest);
+    if (minUI5VersionArray.length > 0) {
+        minUI5VersionArray.forEach((version) => {
+            if ((0, semver_1.valid)(version) && (!result || (0, semver_1.gte)(result, version))) {
+                result = version;
+            }
+        });
+    }
+    return result;
+}
+exports.getMinimumUI5Version = getMinimumUI5Version;
 //# sourceMappingURL=info.js.map

package/dist/types/cap/index.d.ts

@@ -223,5 +223,18 @@ export interface LinkedModel extends CSN {
     services: Definitions & ((namespace: string) => Definitions);
     definitions: Definitions;
 }
+export interface ServiceInfo {
+    name: string;
+    urlPath: string;
+    runtime?: string;
+}
+/**
+ * CDS version information extracted from package json that was used to compile the project when determining the service.
+ */
+export interface CdsVersionInfo {
+    home: string;
+    version: string;
+    root: string;
+}
 export {};
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.20.3",
+  "version": "1.21.0",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",
@@ -27,12 +27,14 @@
     "findit2": "2.2.3",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
+    "semver": "7.5.4",
     "@sap-ux/i18n": "0.0.7",
     "@sap-ux/ui5-config": "0.22.5"
   },
   "devDependencies": {
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
+    "@types/semver": "7.5.2",
     "@ui5/manifest": "1.61.0",
     "vscode-uri": "3.0.7",
     "@sap-ux/logger": "0.5.1"