@sap-ux/project-access 1.24.0 → 1.25.1

package/dist/index.d.ts

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

package/dist/project/index.d.ts

@@ -9,5 +9,5 @@ export { getWebappPath, readUi5Yaml } from './ui5-config';
 export { getMtaPath } from './mta';
 export { createApplicationAccess, createProjectAccess } from './access';
 export { updatePackageScript } from './script';
-export { getSpecification, refreshSpecificationDistTags } from './specification';
+export { getSpecification, getSpecificationPath, refreshSpecificationDistTags } from './specification';
 //# sourceMappingURL=index.d.ts.map

package/dist/project/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.refreshSpecificationDistTags = exports.getSpecification = exports.updatePackageScript = 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.addPackageDevDependency = exports.filterDataSourcesByType = 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.refreshSpecificationDistTags = exports.getSpecificationPath = exports.getSpecification = exports.updatePackageScript = 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.addPackageDevDependency = exports.filterDataSourcesByType = 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; } });
@@ -51,5 +51,6 @@ var script_1 = require("./script");
 Object.defineProperty(exports, "updatePackageScript", { enumerable: true, get: function () { return script_1.updatePackageScript; } });
 var specification_1 = require("./specification");
 Object.defineProperty(exports, "getSpecification", { enumerable: true, get: function () { return specification_1.getSpecification; } });
+Object.defineProperty(exports, "getSpecificationPath", { enumerable: true, get: function () { return specification_1.getSpecificationPath; } });
 Object.defineProperty(exports, "refreshSpecificationDistTags", { enumerable: true, get: function () { return specification_1.refreshSpecificationDistTags; } });
 //# sourceMappingURL=index.js.map

package/dist/project/info.js

@@ -17,10 +17,12 @@ const semver_1 = require("semver");
  * @returns - project structure with project info like project type, apps, root folder
  */
 async function getProject(root) {
-    const checkCapType = await (0, cap_1.getCapProjectType)(root);
-    const projectType = checkCapType ?? 'EDMXBackend';
-    const packageJson = await (0, file_1.readJSON)((0, path_1.join)(root, constants_1.FileName.Package));
-    const appFolders = getAppFolders(packageJson);
+    if (!(await (0, file_1.fileExists)((0, path_1.join)(root, constants_1.FileName.Package)))) {
+        throw new Error(`The project root folder '${root}' is not a Fiori project. No 'package.json' found.`);
+    }
+    const capProjectType = await (0, cap_1.getCapProjectType)(root);
+    const projectType = capProjectType ?? 'EDMXBackend';
+    const appFolders = await getAppFolders(root);
     const apps = await getApps(root, appFolders);
     return {
         root,
@@ -30,17 +32,16 @@ async function getProject(root) {
 }
 exports.getProject = getProject;
 /**
- * Returns the application folders from sapux flag of the package.json. For single app
+ * Returns the applications for the project. 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
+ * @param root - project root folder
  * @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(/[/\\]/)))
-        : [''];
+async function getAppFolders(root) {
+    const apps = await (0, search_1.findAllApps)([root]);
+    return apps.length > 0 ? apps.map((app) => (0, path_1.relative)(root, app.appRoot)) : [''];
 }
 /**
  * Get the application structure for each application in the project.
@@ -69,6 +70,7 @@ async function getApps(root, appFolders) {
 async function getApplicationStructure(root, appFolder) {
     const appRoot = (0, path_1.join)(root, appFolder);
     const absoluteWebappPath = await (0, ui5_config_1.getWebappPath)(appRoot);
+    const appType = (await getAppType(appRoot));
     const manifest = (0, path_1.join)(absoluteWebappPath, constants_1.FileName.Manifest);
     if (!(await (0, file_1.fileExists)(manifest))) {
         return undefined;
@@ -80,6 +82,7 @@ async function getApplicationStructure(root, appFolder) {
     const services = await (0, service_1.getServicesAndAnnotations)(manifest, manifestObject);
     return {
         appRoot,
+        appType,
         manifest,
         changes,
         i18n,

package/dist/project/module-loader.d.ts

@@ -1,4 +1,12 @@
 import type { Logger } from '@sap-ux/logger';
+/**
+ * Get the module path from project or app. Throws error if module is not installed.
+ *
+ * @param projectRoot - root path of the project/app.
+ * @param moduleName - name of the node module.
+ * @returns - path to module.
+ */
+export declare function getModulePath(projectRoot: string, moduleName: string): Promise<string>;
 /**
  * Load module from project or app. Throws error if module is not installed.
  *

package/dist/project/module-loader.js

@@ -23,13 +23,27 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteModule = exports.getModule = exports.loadModuleFromProject = void 0;
+exports.deleteModule = exports.getModule = exports.loadModuleFromProject = exports.getModulePath = void 0;
 const fs_1 = require("fs");
 const promises_1 = require("fs/promises");
 const path_1 = require("path");
 const dependencies_1 = require("./dependencies");
 const constants_1 = require("../constants");
 const command_1 = require("../command");
+/**
+ * Get the module path from project or app. Throws error if module is not installed.
+ *
+ * @param projectRoot - root path of the project/app.
+ * @param moduleName - name of the node module.
+ * @returns - path to module.
+ */
+async function getModulePath(projectRoot, moduleName) {
+    if (!(0, dependencies_1.getNodeModulesPath)(projectRoot, moduleName)) {
+        throw Error('Path to module not found.');
+    }
+    return require.resolve(moduleName, { paths: [projectRoot] });
+}
+exports.getModulePath = getModulePath;
 /**
  * Load module from project or app. Throws error if module is not installed.
  *
@@ -46,10 +60,7 @@ const command_1 = require("../command");
 async function loadModuleFromProject(projectRoot, moduleName) {
     let module;
     try {
-        if (!(0, dependencies_1.getNodeModulesPath)(projectRoot, moduleName)) {
-            throw Error('Path to module not found.');
-        }
-        const modulePath = require.resolve(moduleName, { paths: [projectRoot] });
+        const modulePath = await getModulePath(projectRoot, moduleName);
         module = (await Promise.resolve(`${modulePath}`).then(s => __importStar(require(s))));
     }
     catch (error) {

package/dist/project/search.js

@@ -194,6 +194,9 @@ async function findRootsForPath(path) {
  */
 async function findCapProjectRoot(path) {
     try {
+        if (!(0, path_1.isAbsolute)(path)) {
+            return null;
+        }
         const { root } = (0, path_1.parse)(path);
         let projectRoot = (0, path_1.dirname)(path);
         while (projectRoot !== root) {

package/dist/project/specification.d.ts

@@ -21,4 +21,16 @@ export declare function getSpecification<T>(root: string, options?: {
 export declare function refreshSpecificationDistTags(options?: {
     logger?: Logger;
 }): Promise<void>;
+/**
+ * Returns the path to the specification used.
+ * Can be path to node_modules in project, or cache.
+ *
+ * @param root - root path of the project/app
+ * @param [options] - optional options
+ * @param [options.logger] - optional logger instance
+ * @returns - path to specification
+ */
+export declare function getSpecificationPath(root: string, options?: {
+    logger?: Logger;
+}): Promise<string>;
 //# sourceMappingURL=specification.d.ts.map

package/dist/project/specification.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.refreshSpecificationDistTags = exports.getSpecification = void 0;
+exports.getSpecificationPath = exports.refreshSpecificationDistTags = exports.getSpecification = void 0;
 const fs_1 = require("fs");
 const promises_1 = require("fs/promises");
 const path_1 = require("path");
@@ -13,29 +13,14 @@ const file_1 = require("../file");
 const command_1 = require("../command");
 const specificationDistTagPath = (0, path_1.join)(constants_1.fioriToolsDirectory, constants_1.FileName.SpecificationDistTags);
 /**
- * Loads and return specification from project or cache.
- * 1. if package.json contains devDependency to specification, attempts to load from project.
- * 2. if not in package.json of project, attempts to load from cache.
+ * Gets the dist-tag for the provided project/app and returns it.
  *
  * @param root - root path of the project/app
  * @param [options] - optional options
  * @param [options.logger] - logger instance
  * @returns - specification instance
  */
-async function getSpecification(root, options) {
-    let specification;
-    const logger = options?.logger;
-    try {
-        const packageJson = await (0, file_1.readJSON)((0, path_1.join)(root, constants_1.FileName.Package));
-        if (packageJson.devDependencies?.['@sap/ux-specification']) {
-            logger?.debug(`Specification found in devDependencies of project '${root}', trying to load`);
-            // Early return with load module from project. If it throws an error it is not handled here.
-            return (0, module_loader_1.loadModuleFromProject)(root, '@sap/ux-specification');
-        }
-    }
-    catch {
-        logger?.debug(`Specification not found in project '${root}', trying to load from cache`);
-    }
+async function getProjectDistTag(root, options) {
     let distTag = 'latest';
     try {
         const webappPath = await (0, ui5_config_1.getWebappPath)(root);
@@ -47,8 +32,32 @@ async function getSpecification(root, options) {
         }
     }
     catch (error) {
-        logger?.error(`Failed to get minimum UI5 version from manifest: ${error} using 'latest'`);
+        options?.logger?.error(`Failed to get minimum UI5 version from manifest: ${error} using 'latest'`);
     }
+    return distTag;
+}
+/**
+ * Checks if package.json contains dev dependency to specification.
+ *
+ * @param root - root path of the project/app
+ * @returns If dev dependency to specification is found in package.json
+ */
+async function hasSpecificationDevDependency(root) {
+    const packageJson = await (0, file_1.readJSON)((0, path_1.join)(root, constants_1.FileName.Package));
+    return !!packageJson.devDependencies?.['@sap/ux-specification'];
+}
+/**
+ * Loads the specification module from cache and returns it.
+ *
+ * @param root - root path of the project/app
+ * @param [options] - optional options
+ * @param [options.logger] - logger instance
+ * @returns - specification instance
+ */
+async function getSpecificationModule(root, options) {
+    const logger = options?.logger;
+    let specification;
+    const distTag = await getProjectDistTag(root, { logger });
     try {
         specification = await getSpecificationByDistTag(distTag, { logger });
         logger?.debug(`Specification loaded from cache using dist-tag '${distTag}'`);
@@ -59,6 +68,30 @@ async function getSpecification(root, options) {
     }
     return specification;
 }
+/**
+ * Loads and return specification from project or cache.
+ * 1. if package.json contains devDependency to specification, attempts to load from project.
+ * 2. if not in package.json of project, attempts to load from cache.
+ *
+ * @param root - root path of the project/app
+ * @param [options] - optional options
+ * @param [options.logger] - logger instance
+ * @returns - specification instance
+ */
+async function getSpecification(root, options) {
+    const logger = options?.logger;
+    try {
+        if (await hasSpecificationDevDependency(root)) {
+            logger?.debug(`Specification found in devDependencies of project '${root}', trying to load`);
+            // Early return with load module from project. If it throws an error it is not handled here.
+            return (0, module_loader_1.loadModuleFromProject)(root, '@sap/ux-specification');
+        }
+    }
+    catch {
+        logger?.debug(`Specification not found in project '${root}', trying to load from cache`);
+    }
+    return await getSpecificationModule(root, { logger });
+}
 exports.getSpecification = getSpecification;
 /**
  * Refreshes the specification dist-tags cache. Also cleans specification modules in cache that are not required anymore.
@@ -126,4 +159,42 @@ async function convertDistTagToVersion(distTag, options) {
     const version = specificationDistTags[distTag] ?? specificationDistTags.latest;
     return version;
 }
+/**
+ * Gets the dist-tag of a project specification and returns the version from it.
+ *
+ * @param root - root path of the project/app
+ * @param [options] - optional options
+ * @param [options.logger] - optional logger instance
+ * @returns - version of specification
+ */
+async function getSpecificationVersion(root, options) {
+    const logger = options?.logger;
+    const distTag = await getProjectDistTag(root, { logger });
+    return await convertDistTagToVersion(distTag, { logger });
+}
+/**
+ * Returns the path to the specification used.
+ * Can be path to node_modules in project, or cache.
+ *
+ * @param root - root path of the project/app
+ * @param [options] - optional options
+ * @param [options.logger] - optional logger instance
+ * @returns - path to specification
+ */
+async function getSpecificationPath(root, options) {
+    const logger = options?.logger;
+    const moduleName = '@sap/ux-specification';
+    if (await hasSpecificationDevDependency(root)) {
+        const modulePath = await (0, module_loader_1.getModulePath)(root, moduleName);
+        logger?.debug(`Specification root found in project '${root}'`);
+        return modulePath.slice(0, modulePath.lastIndexOf(moduleName) + moduleName.length);
+    }
+    logger?.debug(`Specification not found in project '${root}', trying to find in cache`);
+    await getSpecificationModule(root, { logger });
+    const version = await getSpecificationVersion(root, { logger });
+    const moduleRoot = (0, path_1.join)(constants_1.moduleCacheRoot, moduleName, version);
+    const modulePath = await (0, module_loader_1.getModulePath)(moduleRoot, moduleName);
+    return modulePath.slice(0, modulePath.lastIndexOf(moduleName) + moduleName.length);
+}
+exports.getSpecificationPath = getSpecificationPath;
 //# sourceMappingURL=specification.js.map

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

@@ -45,6 +45,10 @@ export interface ApplicationStructure {
     services: {
         [index: string]: ServiceSpecification;
     };
+    /**
+     * Application type.
+     */
+    appType: AppType;
 }
 export interface I18nPropertiesPaths {
     /**

package/package.json

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