@sap-ux/project-access 1.16.2 → 1.17.0

package/dist/constants.d.ts

@@ -13,4 +13,7 @@ export declare const FileName: {
     readonly Ui5MockYaml: "ui5-mock.yaml";
     readonly UI5DeployYaml: "ui5-deploy.yaml";
 };
+export declare const DirName: {
+    readonly Changes: "changes";
+};
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FileName = void 0;
+exports.DirName = exports.FileName = void 0;
 exports.FileName = {
     AdaptationConfig: 'config.json',
     CapJavaApplicationYaml: 'application.yaml',
@@ -16,4 +16,7 @@ exports.FileName = {
     Ui5MockYaml: 'ui5-mock.yaml',
     UI5DeployYaml: 'ui5-deploy.yaml'
 };
+exports.DirName = {
+    Changes: 'changes'
+};
 //# sourceMappingURL=constants.js.map

package/dist/index.d.ts

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

package/dist/index.js

@@ -14,9 +14,11 @@ 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.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getProjectType = exports.getNodeModulesPath = exports.getMtaPath = 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.FileName = void 0;
+exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMtaPath = exports.getI18nPropertiesPaths = 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.getFilePaths = exports.FileName = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "FileName", { enumerable: true, get: function () { return constants_1.FileName; } });
+var file_1 = require("./file");
+Object.defineProperty(exports, "getFilePaths", { enumerable: true, get: function () { return file_1.getFilePaths; } });
 var project_1 = require("./project");
 Object.defineProperty(exports, "findAllApps", { enumerable: true, get: function () { return project_1.findAllApps; } });
 Object.defineProperty(exports, "findCapProjects", { enumerable: true, get: function () { return project_1.findCapProjects; } });
@@ -32,8 +34,10 @@ Object.defineProperty(exports, "getCapProjectType", { enumerable: true, get: fun
 Object.defineProperty(exports, "getCdsFiles", { enumerable: true, get: function () { return project_1.getCdsFiles; } });
 Object.defineProperty(exports, "getCdsRoots", { enumerable: true, get: function () { return project_1.getCdsRoots; } });
 Object.defineProperty(exports, "getCdsServices", { enumerable: true, get: function () { return project_1.getCdsServices; } });
+Object.defineProperty(exports, "getI18nPropertiesPaths", { enumerable: true, get: function () { return project_1.getI18nPropertiesPaths; } });
 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; } });
 Object.defineProperty(exports, "getProjectType", { enumerable: true, get: function () { return project_1.getProjectType; } });
 Object.defineProperty(exports, "getWebappPath", { enumerable: true, get: function () { return project_1.getWebappPath; } });
 Object.defineProperty(exports, "isCapJavaProject", { enumerable: true, get: function () { return project_1.isCapJavaProject; } });
@@ -41,7 +45,5 @@ Object.defineProperty(exports, "isCapNodeJsProject", { enumerable: true, get: fu
 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; } });
 __exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/project/i18n/i18n.d.ts

@@ -0,0 +1,18 @@
+import type { I18nPropertiesPaths, Manifest } from '../../types';
+/**
+ * Return absolute paths to i18n.properties files from manifest.
+ *
+ * @param manifestPath - path to manifest.json; used to parse manifest.json if not provided as second argument and to resolve absolute paths
+ * @param manifest - optionally, parsed content of manifest.json, pass to avoid reading it again.
+ * @returns - absolute paths to i18n.properties
+ */
+export declare function getI18nPropertiesPaths(manifestPath: string, manifest?: Manifest): Promise<I18nPropertiesPaths>;
+/**
+ * Return paths to i18n.properties files from manifest,
+ * relative to the manifest.json.
+ *
+ * @param manifest - parsed content of manifest.json
+ * @returns - paths to i18n.properties files from sap.app and models
+ */
+export declare function getRelativeI18nPropertiesPaths(manifest: Manifest): I18nPropertiesPaths;
+//# sourceMappingURL=i18n.d.ts.map

package/dist/project/i18n/i18n.js

@@ -0,0 +1,127 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRelativeI18nPropertiesPaths = exports.getI18nPropertiesPaths = void 0;
+const path_1 = require("path");
+const file_1 = require("../../file");
+/**
+ * Return absolute paths to i18n.properties files from manifest.
+ *
+ * @param manifestPath - path to manifest.json; used to parse manifest.json if not provided as second argument and to resolve absolute paths
+ * @param manifest - optionally, parsed content of manifest.json, pass to avoid reading it again.
+ * @returns - absolute paths to i18n.properties
+ */
+function getI18nPropertiesPaths(manifestPath, manifest) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const parsedManifest = manifest !== null && manifest !== void 0 ? manifest : (yield (0, file_1.readJSON)(manifestPath));
+        const manifestFolder = (0, path_1.dirname)(manifestPath);
+        const relativeI18nPropertiesPaths = getRelativeI18nPropertiesPaths(parsedManifest);
+        const i18nPropertiesPaths = {
+            'sap.app': (0, path_1.join)(manifestFolder, relativeI18nPropertiesPaths['sap.app']),
+            models: {}
+        };
+        for (const modelKey in relativeI18nPropertiesPaths.models) {
+            i18nPropertiesPaths.models[modelKey] = {
+                path: (0, path_1.join)(manifestFolder, relativeI18nPropertiesPaths.models[modelKey].path)
+            };
+        }
+        return i18nPropertiesPaths;
+    });
+}
+exports.getI18nPropertiesPaths = getI18nPropertiesPaths;
+/**
+ * Return paths to i18n.properties files from manifest,
+ * relative to the manifest.json.
+ *
+ * @param manifest - parsed content of manifest.json
+ * @returns - paths to i18n.properties files from sap.app and models
+ */
+function getRelativeI18nPropertiesPaths(manifest) {
+    return {
+        'sap.app': getI18nAppPath(manifest),
+        models: getI18nModelPaths(manifest)
+    };
+}
+exports.getRelativeI18nPropertiesPaths = getRelativeI18nPropertiesPaths;
+/**
+ * Get the i18n path from sap.app.i18n part of the manifest.
+ *
+ * 1. from `sap.app.i18n` if `i18n` is string
+ * 2. from `sap.app.bundleName` as `bundleName` wins over `bundleUrl`
+ * 3. from `sap.app.bundleUrl`
+ * 4. default which is `'i18n/i18n.properties'`
+ *
+ * @param manifest - parsed content of manifest.json
+ * @returns - path to i18n.properties file
+ */
+function getI18nAppPath(manifest) {
+    var _a, _b;
+    const defaultPath = (0, path_1.join)('i18n/i18n.properties');
+    if (typeof ((_a = manifest === null || manifest === void 0 ? void 0 : manifest['sap.app']) === null || _a === void 0 ? void 0 : _a.i18n) === 'string') {
+        return (0, path_1.join)(manifest['sap.app'].i18n);
+    }
+    if (typeof ((_b = manifest === null || manifest === void 0 ? void 0 : manifest['sap.app']) === null || _b === void 0 ? void 0 : _b.i18n) === 'object') {
+        // bundleName wins over `bundleUrl`
+        if ('bundleName' in manifest['sap.app'].i18n) {
+            // module name is in dot notation
+            const withoutAppId = manifest['sap.app'].i18n.bundleName.replace(manifest['sap.app'].id, '');
+            const i18nPath = `${(0, path_1.join)(...withoutAppId.split('.'))}.properties`;
+            return (0, path_1.join)(i18nPath);
+        }
+        if ('bundleUrl' in manifest['sap.app'].i18n) {
+            return (0, path_1.join)(manifest['sap.app'].i18n.bundleUrl);
+        }
+    }
+    // default
+    return defaultPath;
+}
+/**
+ * Get the i18n path from UI5 resource models declared in sap.ui5.models part of the manifest.
+ * By default the model used for internationalization in the UI is 'i18n'. For
+ * internationalization of annotations the model is '@18n'.
+ *
+ * for For `sap.ui5` namespace
+ * 1. from `sap.ui5.models.{resource model key}.bundleName` as `bundleName` wins over `bundleUrl`
+ * 2. from `sap.ui5.models.{resource model key}.bundleUrl`
+ * 3. from `sap.ui5.models.{resource model key}.uri`
+ *
+ * @param manifest - parsed content of manifest.json
+ * @returns - paths to i18n.properties file from models
+ */
+function getI18nModelPaths(manifest) {
+    var _a, _b;
+    const result = {};
+    const models = (_b = (_a = manifest === null || manifest === void 0 ? void 0 : manifest['sap.ui5']) === null || _a === void 0 ? void 0 : _a.models) !== null && _b !== void 0 ? _b : {};
+    const resourceModelKeys = Object.keys(models).filter((key) => models[key].type === 'sap.ui.model.resource.ResourceModel');
+    for (const modelKey of resourceModelKeys) {
+        const i18nModel = models[modelKey];
+        // settings wins over `uri`
+        if (i18nModel.settings) {
+            // bundleName wins over `bundleUrl`
+            if (i18nModel.settings.bundleName) {
+                // module name is in dot notation
+                const withoutAppId = i18nModel.settings.bundleName.replace(manifest['sap.app'].id, '');
+                const i18nPath = `${(0, path_1.join)(...withoutAppId.split('.'))}.properties`;
+                result[modelKey] = { path: (0, path_1.join)(i18nPath) };
+                continue;
+            }
+            if (i18nModel.settings.bundleUrl) {
+                result[modelKey] = { path: (0, path_1.join)(i18nModel.settings.bundleUrl) };
+                continue;
+            }
+        }
+        if (i18nModel.uri) {
+            result[modelKey] = { path: (0, path_1.join)(i18nModel.uri) };
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=i18n.js.map

package/dist/project/i18n/index.d.ts

@@ -0,0 +1,2 @@
+export { getI18nPropertiesPaths } from './i18n';
+//# sourceMappingURL=index.d.ts.map

package/dist/project/i18n/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getI18nPropertiesPaths = void 0;
+var i18n_1 = require("./i18n");
+Object.defineProperty(exports, "getI18nPropertiesPaths", { enumerable: true, get: function () { return i18n_1.getI18nPropertiesPaths; } });
+//# sourceMappingURL=index.js.map

package/dist/project/index.d.ts

@@ -1,6 +1,7 @@
 export { getCapCustomPaths, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, isCapJavaProject, isCapNodeJsProject, getCapEnvironment, readCapServiceMetadataEdmx } from './cap';
 export { getNodeModulesPath } from './dependencies';
-export { getAppProgrammingLanguage, getAppType, getProjectType } from './info';
+export { getI18nPropertiesPaths } from './i18n';
+export { getAppProgrammingLanguage, getAppType, 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.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.loadModuleFromProject = exports.getProjectType = exports.getAppType = exports.getAppProgrammingLanguage = exports.getNodeModulesPath = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapCustomPaths = void 0;
+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.getNodeModulesPath = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = 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; } });
@@ -14,9 +14,12 @@ Object.defineProperty(exports, "getCapEnvironment", { enumerable: true, get: fun
 Object.defineProperty(exports, "readCapServiceMetadataEdmx", { enumerable: true, get: function () { return cap_1.readCapServiceMetadataEdmx; } });
 var dependencies_1 = require("./dependencies");
 Object.defineProperty(exports, "getNodeModulesPath", { enumerable: true, get: function () { return dependencies_1.getNodeModulesPath; } });
+var i18n_1 = require("./i18n");
+Object.defineProperty(exports, "getI18nPropertiesPaths", { enumerable: true, get: function () { return i18n_1.getI18nPropertiesPaths; } });
 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, "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");
 Object.defineProperty(exports, "loadModuleFromProject", { enumerable: true, get: function () { return module_loader_1.loadModuleFromProject; } });

package/dist/project/info.d.ts

@@ -1,5 +1,12 @@
 import type { Editor } from 'mem-fs-editor';
-import type { AppProgrammingLanguage, AppType, ProjectType } from '../types';
+import type { AppProgrammingLanguage, AppType, Project, ProjectType } from '../types';
+/**
+ * Returns the project structure for a given Fiori project.
+ *
+ * @param root - project root folder
+ * @returns - project structure with project info like project type, apps, root folder
+ */
+export declare function getProject(root: string): Promise<Project>;
 /**
  * Get the used programming language of an application.
  *

package/dist/project/info.js

@@ -9,13 +9,98 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProjectType = exports.getAppType = exports.getAppProgrammingLanguage = void 0;
+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");
 const cap_1 = require("./cap");
-const ui5_config_1 = require("./ui5-config");
+const i18n_1 = require("./i18n/i18n");
 const search_1 = require("./search");
+const service_1 = require("./service");
+const ui5_config_1 = require("./ui5-config");
+/**
+ * Returns the project structure for a given Fiori project.
+ *
+ * @param root - project root folder
+ * @returns - project structure with project info like project type, apps, root folder
+ */
+function getProject(root) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const checkCapType = yield (0, cap_1.getCapProjectType)(root);
+        const projectType = checkCapType !== null && checkCapType !== void 0 ? checkCapType : 'EDMXBackend';
+        const packageJson = yield (0, file_1.readJSON)((0, path_1.join)(root, constants_1.FileName.Package));
+        const appFolders = getAppFolders(packageJson);
+        const apps = yield getApps(root, appFolders);
+        return {
+            root,
+            projectType,
+            apps
+        };
+    });
+}
+exports.getProject = getProject;
+/**
+ * Returns the application folders from sapux flag of the package.json. For single app
+ * projects, this is just an array with one empty string. For CAP projects, this is an
+ * array of operating system specific relative paths to the apps.
+ *
+ * @param packageJson - parsed package.json
+ * @returns - array of operating specific application folders
+ */
+function getAppFolders(packageJson) {
+    return Array.isArray(packageJson.sapux)
+        ? packageJson.sapux.map((appFolder) => (0, path_1.join)(...appFolder.split(/[/\\]/)))
+        : [''];
+}
+/**
+ * Get the application structure for each application in the project.
+ *
+ * @param root - project root folder
+ * @param appFolders - array of relative application folders
+ * @returns - map of application structures
+ */
+function getApps(root, appFolders) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const apps = {};
+        for (const appFolder of appFolders) {
+            const applicationStructure = yield getApplicationStructure(root, appFolder);
+            if (applicationStructure) {
+                apps[appFolder] = applicationStructure;
+            }
+        }
+        return apps;
+    });
+}
+/**
+ * Get the application structure for a given application.
+ *
+ * @param root - project root folder
+ * @param appFolder - relative application folder
+ * @returns - application structure with application info like manifest, changes, main service, services, annotations
+ */
+function getApplicationStructure(root, appFolder) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const appRoot = (0, path_1.join)(root, appFolder);
+        const absoluteWebappPath = yield (0, ui5_config_1.getWebappPath)(appRoot);
+        const manifest = (0, path_1.join)(absoluteWebappPath, constants_1.FileName.Manifest);
+        if (!(yield (0, file_1.fileExists)(manifest))) {
+            return undefined;
+        }
+        const manifestObject = yield (0, file_1.readJSON)(manifest);
+        const changes = (0, path_1.join)(absoluteWebappPath, constants_1.DirName.Changes);
+        const i18n = yield (0, i18n_1.getI18nPropertiesPaths)(manifest, manifestObject);
+        const mainService = (0, service_1.getMainService)(manifestObject);
+        const services = yield (0, service_1.getServicesAndAnnotations)(manifest, manifestObject);
+        return {
+            appRoot,
+            manifest,
+            changes,
+            i18n,
+            mainService,
+            services
+        };
+    });
+}
 /**
  * Get the used programming language of an application.
  *

package/dist/project/search.js

@@ -176,20 +176,22 @@ function findRootsForPath(path) {
                 // in root -> not supported
                 return null;
             }
-            // Now we have the app root folder. Check for freestyle non CAP
-            if ((yield (0, file_1.fileExists)((0, path_1.join)(appRoot, constants_1.FileName.Ui5LocalYaml))) &&
-                (0, dependencies_1.hasDependency)(appPckJson, '@sap/ux-ui5-tooling')) {
+            // Check if app is included in CAP project
+            const projectRoot = yield findCapProjectRoot(appRoot);
+            if (projectRoot) {
+                // App included in CAP
                 return {
                     appRoot,
-                    projectRoot: appRoot
+                    projectRoot
                 };
             }
-            // Project must be CAP, find project root
-            const projectRoot = yield findCapProjectRoot(appRoot);
-            if (projectRoot) {
+            else if (
+            // Check for freestyle non CAP
+            (yield (0, file_1.fileExists)((0, path_1.join)(appRoot, constants_1.FileName.Ui5LocalYaml))) &&
+                (0, dependencies_1.hasDependency)(appPckJson, '@sap/ux-ui5-tooling')) {
                 return {
                     appRoot,
-                    projectRoot
+                    projectRoot: appRoot
                 };
             }
         }

package/dist/project/service.d.ts

@@ -0,0 +1,21 @@
+import type { Manifest, ServiceSpecification } from '../types';
+/**
+ * Get the main service name from the manifest.
+ * LROP: by definition the service name can be read from the UI5 model with "" as name.
+ * OVP: the main model needs to be read from the sap.ovp config and then the service can be derived.
+ *
+ * @param manifest - application manifest
+ * @returns - main service name
+ */
+export declare function getMainService(manifest: Manifest): string | undefined;
+/**
+ * Return the service annotation specification for a specific app.
+ *
+ * @param manifestPath - path to manifest.json
+ * @param manifest - optionally, parsed content of manifest.json, pass to avoid reading it again.
+ * @returns - service and annotation specification
+ */
+export declare function getServicesAndAnnotations(manifestPath: string, manifest: Manifest): Promise<{
+    [index: string]: ServiceSpecification;
+}>;
+//# sourceMappingURL=service.d.ts.map

package/dist/project/service.js

@@ -0,0 +1,91 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getServicesAndAnnotations = exports.getMainService = void 0;
+const path_1 = require("path");
+const file_1 = require("../file");
+/**
+ * Get the main service name from the manifest.
+ * LROP: by definition the service name can be read from the UI5 model with "" as name.
+ * OVP: the main model needs to be read from the sap.ovp config and then the service can be derived.
+ *
+ * @param manifest - application manifest
+ * @returns - main service name
+ */
+function getMainService(manifest) {
+    var _a, _b, _c, _d;
+    const model = typeof ((_a = manifest === null || manifest === void 0 ? void 0 : manifest['sap.ovp']) === null || _a === void 0 ? void 0 : _a.globalFilterModel) === 'string' ? manifest['sap.ovp'].globalFilterModel : '';
+    return typeof ((_d = (_c = (_b = manifest === null || manifest === void 0 ? void 0 : manifest['sap.ui5']) === null || _b === void 0 ? void 0 : _b.models) === null || _c === void 0 ? void 0 : _c[model]) === null || _d === void 0 ? void 0 : _d.dataSource) === 'string'
+        ? manifest['sap.ui5'].models[model].dataSource
+        : undefined;
+}
+exports.getMainService = getMainService;
+/**
+ * Return the service annotation specification for a specific app.
+ *
+ * @param manifestPath - path to manifest.json
+ * @param manifest - optionally, parsed content of manifest.json, pass to avoid reading it again.
+ * @returns - service and annotation specification
+ */
+function getServicesAndAnnotations(manifestPath, manifest) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const parsedManifest = manifest !== null && manifest !== void 0 ? manifest : (yield (0, file_1.readJSON)(manifestPath));
+        const manifestFolder = (0, path_1.dirname)(manifestPath);
+        const services = {};
+        const dataSources = (_b = (_a = parsedManifest === null || parsedManifest === void 0 ? void 0 : parsedManifest['sap.app']) === null || _a === void 0 ? void 0 : _a.dataSources) !== null && _b !== void 0 ? _b : {};
+        for (const name in dataSources) {
+            if (dataSources[name].type !== 'OData') {
+                continue;
+            }
+            services[name] = getServiceSpecification(manifestFolder, name, dataSources);
+        }
+        return services;
+    });
+}
+exports.getServicesAndAnnotations = getServicesAndAnnotations;
+/**
+ * Get the service specification for a given service.
+ *
+ * @param webappFolder - relative path to webapp folder from project root
+ * @param name - name of the service
+ * @param dataSources - dataSources from manifest
+ * @returns - service specification
+ */
+function getServiceSpecification(webappFolder, name, dataSources) {
+    var _a, _b, _c, _d, _e;
+    const dataSource = dataSources[name];
+    const uri = dataSource.uri;
+    const local = typeof ((_a = dataSource.settings) === null || _a === void 0 ? void 0 : _a.localUri) === 'string'
+        ? (0, path_1.join)(webappFolder, dataSource.settings.localUri)
+        : '';
+    const odataVersion = (_c = (_b = dataSource.settings) === null || _b === void 0 ? void 0 : _b.odataVersion) !== null && _c !== void 0 ? _c : '2.0';
+    const annotations = [];
+    const annotationNames = (_d = dataSource.settings) === null || _d === void 0 ? void 0 : _d.annotations;
+    if (Array.isArray(annotationNames)) {
+        for (const annotationName of annotationNames) {
+            const annotation = dataSources[annotationName];
+            if (annotation) {
+                annotations.push({
+                    uri: annotation.uri,
+                    local: ((_e = annotation.settings) === null || _e === void 0 ? void 0 : _e.localUri) ? (0, path_1.join)(webappFolder, annotation.settings.localUri) : undefined
+                });
+            }
+        }
+    }
+    return {
+        uri,
+        local,
+        odataVersion,
+        annotations
+    };
+}
+//# sourceMappingURL=service.js.map

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

@@ -1,4 +1,77 @@
 import type { CapProjectType } from '../cap';
+import type { ManifestNamespace } from '../webapp';
+export interface Project {
+    /**
+     * Absolute path to the project root.
+     */
+    root: string;
+    /**
+     * Project type like 'EDMXBackend' | 'CAPJava' | 'CAPNodejs', see ProjectType.
+     */
+    projectType: ProjectType;
+    /**
+     * Applications in the project. For CAP projects the index is relative
+     * path to the app, like apps/myapp. For single app projects the index
+     * is an empty string ''.
+     */
+    apps: {
+        [index: string]: ApplicationStructure;
+    };
+}
+export interface ApplicationStructure {
+    /**
+     * Absolute path to the application root.
+     */
+    appRoot: string;
+    /**
+     * Absolute path to the manifest.json.
+     */
+    manifest: string;
+    /**
+     * Absolute path to the folder containing changes.
+     */
+    changes: string;
+    /**
+     * Absolute paths to i18n files.
+     */
+    i18n: I18nPropertiesPaths;
+    /**
+     * Main service of the application.
+     */
+    mainService?: string;
+    /**
+     * Service information with annotation references and local annotation files.
+     */
+    services: {
+        [index: string]: ServiceSpecification;
+    };
+}
+export interface I18nPropertiesPaths {
+    /**
+     * Absolute path to the i18n.properties file from sap.app namespace.
+     */
+    'sap.app': string;
+    models: {
+        [modelKey: string]: {
+            /**
+             * Absolute path to the i18n.properties files.
+             */
+            path: string;
+        };
+    };
+}
+export interface ServiceSpecification {
+    uri?: string;
+    local?: string;
+    odataVersion?: ManifestNamespace.Setting['odataVersion'];
+    annotations?: {
+        uri?: string;
+        /**
+         * Absolute path to the local annotation file
+         */
+        local?: string;
+    }[];
+}
 export type AppProgrammingLanguage = 'JavaScript' | 'TypeScript' | '';
 export type ProjectType = 'EDMXBackend' | CapProjectType;
 export type AppType = 'SAP Fiori elements' | 'SAPUI5 freestyle' | 'SAPUI5 Extension' | 'Fiori Reuse' | 'Fiori Adaptation';

package/package.json

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