@sap-ux/project-access 1.32.11 → 1.32.14

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 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 { 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, getPathMappings, 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';
 export * from './types';
 export * from './library';

package/dist/index.js

@@ -14,8 +14,8 @@ 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.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;
+exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.hasUI5CliV3 = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getPathMappings = 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 = exports.loadModuleFromProject = 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; } });
@@ -61,6 +61,7 @@ Object.defineProperty(exports, "getMtaPath", { enumerable: true, get: function (
 Object.defineProperty(exports, "getMockServerConfig", { enumerable: true, get: function () { return project_1.getMockServerConfig; } });
 Object.defineProperty(exports, "getMockDataPath", { enumerable: true, get: function () { return project_1.getMockDataPath; } });
 Object.defineProperty(exports, "getNodeModulesPath", { enumerable: true, get: function () { return project_1.getNodeModulesPath; } });
+Object.defineProperty(exports, "getPathMappings", { enumerable: true, get: function () { return project_1.getPathMappings; } });
 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; } });

package/dist/project/access.js

@@ -278,9 +278,25 @@ class ProjectAccessImp {
         return Object.keys(this._project.apps);
     }
     /**
-     * Returns an instance of an application for a given application ID. The contains information about the application, like paths and services.
+     * Get application ID (the relative path from project root to app root) for a given 'sap.app.id' from the manifest.
      *
-     * @param appId - application ID
+     * @param manifestAppId - The 'sap.app.id' from the manifest
+     * @returns - application ID (the relative path from project root to app root) or undefined if not found
+     */
+    async getApplicationIdByManifestAppId(manifestAppId) {
+        for (const [appId, { manifest: manifestPath }] of Object.entries(this._project.apps)) {
+            const manifestContent = await (0, file_1.readJSON)(manifestPath, this.options?.memFs);
+            if (manifestContent['sap.app']?.id === manifestAppId) {
+                return appId;
+            }
+        }
+        return undefined;
+    }
+    /**
+     * Returns an instance of an application for a given application ID (the relative path from project root to app root, NOT the 'sap.app.id' from the manifest).
+     * It contains information about the application, like paths and services.
+     *
+     * @param appId - application ID (the relative path from project root to app root, NOT the 'sap.app.id' from the manifest)
      * @returns - Instance of ApplicationAccess that contains information about the application, like paths and services
      */
     getApplication(appId) {
@@ -334,15 +350,15 @@ function isEditor(argument) {
  */
 async function createApplicationAccess(appRoot, fs) {
     try {
-        const apps = await (0, search_1.findAllApps)([appRoot]);
-        const app = apps.find((app) => app.appRoot === appRoot);
-        if (!app) {
-            throw new Error(`Could not find app with root ${appRoot}`);
-        }
         let options;
         if (fs) {
             options = isEditor(fs) ? { fs } : fs;
         }
+        const apps = await (0, search_1.findAllApps)([appRoot], options?.fs);
+        const app = apps.find((app) => app.appRoot === appRoot);
+        if (!app) {
+            throw new Error(`Could not find app with root ${appRoot}`);
+        }
         const project = await (0, info_1.getProject)(app.projectRoot, options?.fs);
         const appId = (0, node_path_1.relative)(project.root, appRoot);
         return new ApplicationAccessImp(project, appId, options);

package/dist/project/index.d.ts

@@ -5,7 +5,7 @@ export { getCapI18nFolderNames, getI18nPropertiesPaths, getI18nBundles } from '.
 export { getAppProgrammingLanguage, getAppType, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getProject, getProjectType } from './info';
 export { loadModuleFromProject } from './module-loader';
 export { findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, findCapProjectRoot, findRootsForPath } from './search';
-export { getWebappPath, readUi5Yaml, getAllUi5YamlFileNames, getMockServerConfig, getMockDataPath } from './ui5-config';
+export { getWebappPath, readUi5Yaml, getAllUi5YamlFileNames, getMockServerConfig, getMockDataPath, getPathMappings } from './ui5-config';
 export { getMtaPath } from './mta';
 export { createApplicationAccess, createProjectAccess } from './access';
 export { updatePackageScript, hasUI5CliV3 } from './script';

package/dist/project/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasUI5CliV3 = exports.updatePackageScript = exports.createProjectAccess = exports.createApplicationAccess = exports.getMtaPath = exports.getMockDataPath = exports.getMockServerConfig = exports.getAllUi5YamlFileNames = exports.readUi5Yaml = exports.getWebappPath = exports.findRootsForPath = exports.findCapProjectRoot = 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.getI18nBundles = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.hasDependency = exports.getNodeModulesPath = exports.addPackageDevDependency = exports.filterDataSourcesByType = exports.checkCdsUi5PluginEnabled = exports.hasMinCdsVersion = exports.getWorkspaceInfo = exports.toReferenceUri = exports.readCapServiceMetadataEdmx = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapServiceName = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.deleteCapApp = exports.clearCdsModuleCache = void 0;
-exports.readFlexChanges = exports.refreshSpecificationDistTags = exports.getSpecificationPath = exports.getSpecification = void 0;
+exports.updatePackageScript = exports.createProjectAccess = exports.createApplicationAccess = exports.getMtaPath = exports.getPathMappings = exports.getMockDataPath = exports.getMockServerConfig = exports.getAllUi5YamlFileNames = exports.readUi5Yaml = exports.getWebappPath = exports.findRootsForPath = exports.findCapProjectRoot = 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.getI18nBundles = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.hasDependency = exports.getNodeModulesPath = exports.addPackageDevDependency = exports.filterDataSourcesByType = exports.checkCdsUi5PluginEnabled = exports.hasMinCdsVersion = exports.getWorkspaceInfo = exports.toReferenceUri = exports.readCapServiceMetadataEdmx = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapServiceName = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.deleteCapApp = exports.clearCdsModuleCache = void 0;
+exports.readFlexChanges = exports.refreshSpecificationDistTags = exports.getSpecificationPath = exports.getSpecification = exports.hasUI5CliV3 = void 0;
 var cap_1 = require("./cap");
 Object.defineProperty(exports, "clearCdsModuleCache", { enumerable: true, get: function () { return cap_1.clearCdsModuleCache; } });
 Object.defineProperty(exports, "deleteCapApp", { enumerable: true, get: function () { return cap_1.deleteCapApp; } });
@@ -55,6 +55,7 @@ Object.defineProperty(exports, "readUi5Yaml", { enumerable: true, get: function
 Object.defineProperty(exports, "getAllUi5YamlFileNames", { enumerable: true, get: function () { return ui5_config_1.getAllUi5YamlFileNames; } });
 Object.defineProperty(exports, "getMockServerConfig", { enumerable: true, get: function () { return ui5_config_1.getMockServerConfig; } });
 Object.defineProperty(exports, "getMockDataPath", { enumerable: true, get: function () { return ui5_config_1.getMockDataPath; } });
+Object.defineProperty(exports, "getPathMappings", { enumerable: true, get: function () { return ui5_config_1.getPathMappings; } });
 var mta_1 = require("./mta");
 Object.defineProperty(exports, "getMtaPath", { enumerable: true, get: function () { return mta_1.getMtaPath; } });
 var access_1 = require("./access");

package/dist/project/ui5-config.d.ts

@@ -1,6 +1,9 @@
 import type { Editor } from 'mem-fs-editor';
 import type { MockserverConfig } from '@sap-ux/ui5-config';
 import { UI5Config } from '@sap-ux/ui5-config';
+type PathMappings = {
+    [key: string]: string | undefined;
+};
 /**
  * Get path to webapp.
  *
@@ -9,6 +12,17 @@ import { UI5Config } from '@sap-ux/ui5-config';
  * @returns - path to webapp folder
  */
 export declare function getWebappPath(appRoot: string, memFs?: Editor): Promise<string>;
+/**
+ * Get path mappings defined in 'ui5.yaml' depending on the project type defined in 'ui5.yaml'.
+ *
+ * @param appRoot - root to the application
+ * @param memFs - optional mem-fs editor instance
+ * @param fileName - optional name of yaml file to be read. Defaults to 'ui5.yaml'.
+ * @returns - path mappings
+ * @throws {Error} if ui5.yaml or 'type' cannot be read
+ * @throws {Error} if project type is not 'application', 'library', 'theme-library' or 'module'
+ */
+export declare function getPathMappings(appRoot: string, memFs?: Editor, fileName?: string): Promise<PathMappings>;
 /**
  * Checks if UI5 config yaml file exists and returns its content.
  *
@@ -49,4 +63,5 @@ export declare function getMockServerConfig(projectRoot: string, fileName?: stri
  * @returns The mock data path as a string. Returns an empty string if not found.
  */
 export declare function getMockDataPath(projectRoot: string, fileName?: string): Promise<string>;
+export {};
 //# sourceMappingURL=ui5-config.d.ts.map

package/dist/project/ui5-config.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getWebappPath = getWebappPath;
+exports.getPathMappings = getPathMappings;
 exports.readUi5Yaml = readUi5Yaml;
 exports.getAllUi5YamlFileNames = getAllUi5YamlFileNames;
 exports.getMockServerConfig = getMockServerConfig;
@@ -9,6 +10,23 @@ const node_path_1 = require("node:path");
 const ui5_config_1 = require("@sap-ux/ui5-config");
 const constants_1 = require("../constants");
 const file_1 = require("../file");
+const PATH_MAPPING_DEFAULTS = {
+    application: { webapp: constants_1.DirName.Webapp },
+    library: { src: 'src', test: 'test' },
+    'theme-library': { src: 'src', test: 'test' },
+    module: {}
+};
+/**
+ * Get base directory of the project where package.json is located.
+ *
+ * @param appRoot - root to the application
+ * @param memFs - optional mem-fs editor instance
+ * @returns - base directory of the project
+ */
+async function getBaseDir(appRoot, memFs) {
+    const packageJsonPath = await (0, file_1.findFileUp)(constants_1.FileName.Package, appRoot, memFs);
+    return packageJsonPath ? (0, node_path_1.dirname)(packageJsonPath) : appRoot;
+}
 /**
  * Get path to webapp.
  *
@@ -17,22 +35,52 @@ const file_1 = require("../file");
  * @returns - path to webapp folder
  */
 async function getWebappPath(appRoot, memFs) {
-    const ui5YamlPath = (0, node_path_1.join)(appRoot, constants_1.FileName.Ui5Yaml);
-    let webappPath = (0, node_path_1.join)(appRoot, constants_1.DirName.Webapp);
-    if (await (0, file_1.fileExists)(ui5YamlPath, memFs)) {
-        const yamlString = await (0, file_1.readFile)(ui5YamlPath, memFs);
-        const ui5Config = await ui5_config_1.UI5Config.newInstance(yamlString);
-        const relativeWebappPath = ui5Config.getConfiguration()?.paths?.webapp;
-        if (relativeWebappPath) {
-            // Search for folder with package.json inside
-            const packageJsonPath = await (0, file_1.findFileUp)(constants_1.FileName.Package, appRoot, memFs);
-            if (packageJsonPath) {
-                const packageJsonDirPath = (0, node_path_1.dirname)(packageJsonPath);
-                webappPath = (0, node_path_1.join)(packageJsonDirPath, relativeWebappPath);
-            }
+    let pathMappings = {};
+    try {
+        pathMappings = await getPathMappings(appRoot, memFs);
+    }
+    catch {
+        // For backward compatibility ignore errors and use default
+    }
+    return pathMappings?.webapp ?? (0, node_path_1.join)(appRoot, constants_1.DirName.Webapp);
+}
+/**
+ * Get path mappings defined in 'ui5.yaml' depending on the project type defined in 'ui5.yaml'.
+ *
+ * @param appRoot - root to the application
+ * @param memFs - optional mem-fs editor instance
+ * @param fileName - optional name of yaml file to be read. Defaults to 'ui5.yaml'.
+ * @returns - path mappings
+ * @throws {Error} if ui5.yaml or 'type' cannot be read
+ * @throws {Error} if project type is not 'application', 'library', 'theme-library' or 'module'
+ */
+async function getPathMappings(appRoot, memFs, fileName = constants_1.FileName.Ui5Yaml) {
+    let ui5Config;
+    let configuration;
+    let type;
+    try {
+        ui5Config = await readUi5Yaml(appRoot, fileName, memFs);
+        configuration = ui5Config.getConfiguration();
+        type = ui5Config.getType();
+    }
+    catch {
+        throw new Error(`Could not read 'type' from ${fileName} in project root: ${appRoot}`);
+    }
+    if (!(type in PATH_MAPPING_DEFAULTS)) {
+        throw new Error(`Unsupported project type for path mappings: ${type}`);
+    }
+    const baseDir = await getBaseDir(appRoot, memFs);
+    const pathMappings = {};
+    for (const [key, value] of Object.entries(configuration?.paths || {})) {
+        pathMappings[key] = (0, node_path_1.join)(baseDir, value ?? PATH_MAPPING_DEFAULTS[type][key]);
+    }
+    //Add defaults if no specific value exists
+    for (const [key, defaultValue] of Object.entries(PATH_MAPPING_DEFAULTS[type] ?? {})) {
+        if (!pathMappings[key]) {
+            pathMappings[key] = (0, node_path_1.join)(baseDir, defaultValue);
         }
     }
-    return webappPath;
+    return pathMappings;
 }
 /**
  * Checks if UI5 config yaml file exists and returns its content.

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

@@ -146,8 +146,27 @@ export interface ProjectAccessOptions {
     memFs?: Editor;
 }
 export interface ProjectAccess extends BaseAccess {
+    /**
+     * Returns list of application IDs.
+     *
+     * @returns - array of application IDs. For single application projects it will return ['']
+     */
     getApplicationIds: () => string[];
+    /**
+     * Returns an instance of an application for a given application ID (the relative path from project root to app root, NOT the 'sap.app.id' from the manifest).
+     * It contains information about the application, like paths and services.
+     *
+     * @param appId - application ID (the relative path from project root to app root, NOT the 'sap.app.id' from the manifest)
+     * @returns - Instance of ApplicationAccess that contains information about the application, like paths and services
+     */
     getApplication: (appId: string) => ApplicationAccess;
+    /**
+     * Get application ID (the relative path from project root to app root) for a given 'sap.app.id' from the manifest.
+     *
+     * @param manifestAppId - The 'sap.app.id' from the manifest
+     * @returns - application ID (the relative path from project root to app root) or undefined if not found
+     */
+    getApplicationIdByManifestAppId: (manifestAppId: string) => Promise<string | undefined>;
 }
 export {};
 //# sourceMappingURL=index.d.ts.map

package/package.json

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