@sap-ux/project-access 1.32.7 → 1.32.9

package/README.md

@@ -1,4 +1,6 @@
-# @sap-ux/project-access
+[![Changelog](https://img.shields.io/badge/changelog-8A2BE2)](https://github.com/SAP/open-ux-tools/blob/main/packages/project-access/CHANGELOG.md) [![Github repo](https://img.shields.io/badge/github-repo-blue)](https://github.com/SAP/open-ux-tools/tree/main/packages/project-access)
+
+# [`@sap-ux/project-access`](https://github.com/SAP/open-ux-tools/tree/main/packages/project-access)
 
 Library that offers functions to find, read, and retrieve project information and artifacts.
 

package/dist/constants.d.ts

@@ -61,5 +61,6 @@ export declare const fioriToolsDirectory: string;
  * Directory where modules are cached
  */
 export declare const moduleCacheRoot: string;
-export declare const MinCdsVersionUi5Plugin = "6.8.2";
+export declare const MinCdsPluginUi5Version = "0.13.0";
+export declare const MinCdsVersion = "6.8.2";
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MinCdsVersionUi5Plugin = exports.moduleCacheRoot = exports.fioriToolsDirectory = exports.SchemaName = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
+exports.MinCdsVersion = exports.MinCdsPluginUi5Version = exports.moduleCacheRoot = exports.fioriToolsDirectory = exports.SchemaName = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
 const node_os_1 = require("node:os");
 const node_path_1 = require("node:path");
 exports.FileName = {
@@ -66,5 +66,6 @@ exports.fioriToolsDirectory = (0, node_path_1.join)((0, node_os_1.homedir)(), ex
  * Directory where modules are cached
  */
 exports.moduleCacheRoot = (0, node_path_1.join)(exports.fioriToolsDirectory, exports.DirName.ModuleCache);
-exports.MinCdsVersionUi5Plugin = '6.8.2';
+exports.MinCdsPluginUi5Version = '0.13.0';
+exports.MinCdsVersion = '6.8.2';
 //# sourceMappingURL=constants.js.map

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { FileName, DirName, FioriToolsSettings, MinCdsVersionUi5Plugin } from './constants';
+export { FileName, DirName, FioriToolsSettings, MinCdsPluginUi5Version, MinCdsVersion } from './constants';
 export { getFilePaths } from './file';
 export { addPackageDevDependency, clearCdsModuleCache, createApplicationAccess, createProjectAccess, deleteCapApp, filterDataSourcesByType, findAllApps, findCapProjectRoot, findCapProjects, findFioriArtifacts, findProjectRoot, findRootsForPath, getAllUi5YamlFileNames, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapServiceName, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getCapI18nFolderNames, getSpecification, getSpecificationPath, getI18nPropertiesPaths, getI18nBundles, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getMtaPath, getMockServerConfig, getMockDataPath, getNodeModulesPath, getProject, getProjectType, getWebappPath, hasUI5CliV3, isCapProject, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml, refreshSpecificationDistTags, toReferenceUri, updatePackageScript, getWorkspaceInfo, hasMinCdsVersion, checkCdsUi5PluginEnabled, readFlexChanges } from './project';
 export { execNpmCommand } from './command/npm-command';

package/dist/index.js

@@ -14,13 +14,14 @@ 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.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.hasUI5CliV3 = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMockDataPath = exports.getMockServerConfig = exports.getMtaPath = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getI18nBundles = exports.getI18nPropertiesPaths = exports.getSpecificationPath = exports.getSpecification = exports.getCapI18nFolderNames = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapServiceName = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppType = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.getAllUi5YamlFileNames = exports.findRootsForPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findCapProjectRoot = exports.findAllApps = exports.filterDataSourcesByType = exports.deleteCapApp = exports.createProjectAccess = exports.createApplicationAccess = exports.clearCdsModuleCache = exports.addPackageDevDependency = exports.getFilePaths = exports.MinCdsVersionUi5Plugin = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
-exports.hasDependency = exports.execNpmCommand = exports.readFlexChanges = exports.checkCdsUi5PluginEnabled = exports.hasMinCdsVersion = exports.getWorkspaceInfo = exports.updatePackageScript = exports.toReferenceUri = exports.refreshSpecificationDistTags = exports.readUi5Yaml = void 0;
+exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.hasUI5CliV3 = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMockDataPath = exports.getMockServerConfig = exports.getMtaPath = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getI18nBundles = exports.getI18nPropertiesPaths = exports.getSpecificationPath = exports.getSpecification = exports.getCapI18nFolderNames = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapServiceName = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppType = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.getAllUi5YamlFileNames = exports.findRootsForPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findCapProjectRoot = exports.findAllApps = exports.filterDataSourcesByType = exports.deleteCapApp = exports.createProjectAccess = exports.createApplicationAccess = exports.clearCdsModuleCache = exports.addPackageDevDependency = exports.getFilePaths = exports.MinCdsVersion = exports.MinCdsPluginUi5Version = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
+exports.hasDependency = exports.execNpmCommand = exports.readFlexChanges = exports.checkCdsUi5PluginEnabled = exports.hasMinCdsVersion = exports.getWorkspaceInfo = exports.updatePackageScript = exports.toReferenceUri = exports.refreshSpecificationDistTags = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = 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; } });
 Object.defineProperty(exports, "FioriToolsSettings", { enumerable: true, get: function () { return constants_1.FioriToolsSettings; } });
-Object.defineProperty(exports, "MinCdsVersionUi5Plugin", { enumerable: true, get: function () { return constants_1.MinCdsVersionUi5Plugin; } });
+Object.defineProperty(exports, "MinCdsPluginUi5Version", { enumerable: true, get: function () { return constants_1.MinCdsPluginUi5Version; } });
+Object.defineProperty(exports, "MinCdsVersion", { enumerable: true, get: function () { return constants_1.MinCdsVersion; } });
 var file_1 = require("./file");
 Object.defineProperty(exports, "getFilePaths", { enumerable: true, get: function () { return file_1.getFilePaths; } });
 var project_1 = require("./project");

package/dist/project/access.js

@@ -9,6 +9,8 @@ const search_1 = require("./search");
 const file_1 = require("../file");
 const constants_1 = require("../constants");
 const specification_1 = require("./specification");
+const flex_changes_1 = require("./flex-changes");
+const cap_1 = require("./cap");
 /**
  *
  */
@@ -163,6 +165,68 @@ class ApplicationAccessImp {
     async updateManifestJSON(manifest, memFs) {
         await (0, file_1.updateManifestJSON)(this.app.manifest, manifest, memFs ?? this.options?.fs);
     }
+    /**
+     * Reads and returns the parsed `manifest.json` file for the application.
+     *
+     * @param memFs - optional mem-fs-editor instance
+     * @returns A promise resolving to the parsed `manifest.json` content.
+     */
+    async readManifest(memFs) {
+        return (0, file_1.readJSON)(this.app.manifest, memFs ?? this.options?.fs);
+    }
+    /**
+     * Reads and returns all Flex Changes (`*.change` files) associated with the application.
+     *
+     * @param memFs - optional mem-fs-editor instance
+     * @returns A promise that resolves to an array of flex change files.
+     */
+    async readFlexChanges(memFs) {
+        return (0, flex_changes_1.readFlexChanges)(this.app.changes, memFs ?? this.options?.fs);
+    }
+    /**
+     * Reads and returns all annotation files associated with the application's main service.
+     *
+     * @param memFs - optional mem-fs-editor instance
+     * @returns A promise resolving to an array of annotation file descriptors.
+     */
+    async readAnnotationFiles(memFs) {
+        const annotationData = [];
+        const mainServiceName = this.app.mainService ?? 'mainService';
+        const mainService = this.app?.services?.[mainServiceName];
+        if (!mainService) {
+            return [];
+        }
+        if (mainService.uri && (this.projectType === 'CAPJava' || this.projectType === 'CAPNodejs')) {
+            const serviceUri = mainService?.uri ?? '';
+            if (serviceUri) {
+                const edmx = await (0, cap_1.readCapServiceMetadataEdmx)(this.root, serviceUri);
+                annotationData.push({
+                    fileContent: edmx,
+                    dataSourceUri: serviceUri
+                });
+            }
+        }
+        else {
+            if (mainService.local) {
+                const serviceFile = await (0, file_1.readFile)(mainService.local, memFs ?? this.options?.fs);
+                annotationData.push({
+                    dataSourceUri: mainService.local,
+                    fileContent: serviceFile.toString()
+                });
+            }
+            const { annotations = [] } = mainService;
+            for (const annotation of annotations) {
+                if (annotation.local) {
+                    const annotationFile = await (0, file_1.readFile)(annotation.local, memFs ?? this.options?.fs);
+                    annotationData.push({
+                        dataSourceUri: annotation.local,
+                        fileContent: annotationFile.toString()
+                    });
+                }
+            }
+        }
+        return annotationData;
+    }
     /**
      * Project structure.
      *

package/dist/project/cap.js

@@ -750,7 +750,7 @@ async function checkCdsUi5PluginEnabled(basePath, fs, moreInfo, cdsVersionInfo)
         // If it does, it uses that version information to determine if it satisfies the minimum CDS version required.
         // If 'cdsVersionInfo' is not available or does not contain version information,it falls back to check the version specified in the package.json file.
         hasMinCdsVersion: cdsVersionInfo?.version
-            ? (0, semver_1.satisfies)(cdsVersionInfo?.version, `>=${constants_1.MinCdsVersionUi5Plugin}`)
+            ? (0, semver_1.satisfies)(cdsVersionInfo?.version, `>=${constants_1.MinCdsVersion}`)
             : satisfiesMinCdsVersion(packageJson),
         isWorkspaceEnabled: workspaceEnabled,
         hasCdsUi5Plugin: (0, dependencies_1.hasDependency)(packageJson, 'cds-plugin-ui5'),
@@ -798,8 +798,7 @@ function getWorkspacePackages(packageJson) {
  * @returns - true: cds version satisfies the min cds version; false: cds version does not satisfy min cds version
  */
 function satisfiesMinCdsVersion(packageJson) {
-    return (hasMinCdsVersion(packageJson) ||
-        (0, semver_1.satisfies)(constants_1.MinCdsVersionUi5Plugin, packageJson.dependencies?.['@sap/cds'] ?? '0.0.0'));
+    return hasMinCdsVersion(packageJson) || (0, semver_1.satisfies)(constants_1.MinCdsVersion, packageJson.dependencies?.['@sap/cds'] ?? '0.0.0');
 }
 /**
  * Check if package.json has dependency to the minimum min version of @sap/cds,
@@ -809,6 +808,6 @@ function satisfiesMinCdsVersion(packageJson) {
  * @returns - true: min cds version is present; false: cds version needs update
  */
 function hasMinCdsVersion(packageJson) {
-    return (0, semver_1.gte)((0, semver_1.coerce)(packageJson.dependencies?.['@sap/cds']) ?? '0.0.0', constants_1.MinCdsVersionUi5Plugin);
+    return (0, semver_1.gte)((0, semver_1.coerce)(packageJson.dependencies?.['@sap/cds']) ?? '0.0.0', constants_1.MinCdsVersion);
 }
 //# sourceMappingURL=cap.js.map

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

@@ -4,7 +4,7 @@ import type { I18nBundles } from '../i18n';
 import type { ApplicationStructure, I18nPropertiesPaths, Project, ProjectType } from '../info';
 import type { Editor } from 'mem-fs-editor';
 import type { Package } from '../package';
-import type { Manifest } from '../webapp';
+import type { AnnotationFile, Manifest } from '../webapp';
 interface BaseAccess {
     readonly project: Project;
     readonly root: string;
@@ -117,6 +117,29 @@ export interface ApplicationAccess extends BaseAccess {
      * @param memFs - optional mem-fs-editor instance
      */
     updateManifestJSON(manifest: Manifest, memFs?: Editor): Promise<void>;
+    /**
+     * Reads and returns the parsed `manifest.json` file for the application.
+     *
+     * @param memFs - optional mem-fs-editor instance
+     * @returns A promise resolving to the parsed `manifest.json` content.
+     */
+    readManifest(memFs?: Editor): Promise<Manifest>;
+    /**
+     * Reads and returns all Flex Changes (`*.change` files) associated with the application.
+     *
+     * @param memFs - optional mem-fs-editor instance
+     * @returns A promise that resolves to an array of flex change files.
+     */
+    readFlexChanges(memFs?: Editor): Promise<{
+        [key: string]: string;
+    }>;
+    /**
+     * Reads and returns all annotation files associated with the application's main service.
+     *
+     * @param memFs - optional mem-fs-editor instance
+     * @returns A promise resolving to an array of annotation file descriptors.
+     */
+    readAnnotationFiles(memFs?: Editor): Promise<AnnotationFile[]>;
 }
 export interface ProjectAccessOptions {
     logger?: Logger;

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

@@ -1,4 +1,8 @@
 import type * as ManifestNamespace from '@ui5/manifest/types/manifest';
 export { ManifestNamespace };
 export type Manifest = ManifestNamespace.SAPJSONSchemaForWebApplicationManifestFile;
+export interface AnnotationFile {
+    dataSourceUri: string;
+    fileContent: string;
+}
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.32.7",
+  "version": "1.32.9",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",
@@ -29,8 +29,8 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "semver": "7.5.4",
-    "@sap-ux/i18n": "0.3.4",
-    "@sap-ux/ui5-config": "0.29.8"
+    "@sap-ux/i18n": "0.3.5",
+    "@sap-ux/ui5-config": "0.29.9"
   },
   "devDependencies": {
     "@types/mem-fs": "1.1.2",
@@ -38,7 +38,7 @@
     "@types/semver": "7.5.2",
     "@ui5/manifest": "1.76.0",
     "vscode-uri": "3.0.7",
-    "@sap-ux/logger": "0.7.0"
+    "@sap-ux/logger": "0.7.1"
   },
   "scripts": {
     "build": "tsc --build",