@sap-ux/project-access 1.27.0 → 1.27.2

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, getSpecificationPath, getI18nPropertiesPaths, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getMtaPath, getNodeModulesPath, getProject, getProjectType, getWebappPath, isCapProject, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml, getCapServiceName, refreshSpecificationDistTags, toReferenceUri, filterDataSourcesByType, updatePackageScript, findCapProjectRoot } 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, getCapServiceName, refreshSpecificationDistTags, toReferenceUri, filterDataSourcesByType, updatePackageScript, findCapProjectRoot, hasUI5CliV3, findRootsForPath } 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.findCapProjectRoot = exports.updatePackageScript = exports.filterDataSourcesByType = exports.toReferenceUri = exports.refreshSpecificationDistTags = exports.getCapServiceName = 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;
+exports.findRootsForPath = exports.hasUI5CliV3 = exports.findCapProjectRoot = exports.updatePackageScript = exports.filterDataSourcesByType = exports.toReferenceUri = exports.refreshSpecificationDistTags = exports.getCapServiceName = 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; } });
@@ -64,6 +64,8 @@ Object.defineProperty(exports, "toReferenceUri", { enumerable: true, get: functi
 Object.defineProperty(exports, "filterDataSourcesByType", { enumerable: true, get: function () { return project_1.filterDataSourcesByType; } });
 Object.defineProperty(exports, "updatePackageScript", { enumerable: true, get: function () { return project_1.updatePackageScript; } });
 Object.defineProperty(exports, "findCapProjectRoot", { enumerable: true, get: function () { return project_1.findCapProjectRoot; } });
+Object.defineProperty(exports, "hasUI5CliV3", { enumerable: true, get: function () { return project_1.hasUI5CliV3; } });
+Object.defineProperty(exports, "findRootsForPath", { enumerable: true, get: function () { return project_1.findRootsForPath; } });
 __exportStar(require("./types"), exports);
 __exportStar(require("./library"), exports);
 //# sourceMappingURL=index.js.map

package/dist/project/index.d.ts

@@ -4,10 +4,10 @@ export { addPackageDevDependency, getNodeModulesPath } from './dependencies';
 export { getCapI18nFolderNames, getI18nPropertiesPaths } from './i18n';
 export { getAppProgrammingLanguage, getAppType, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getProject, getProjectType } from './info';
 export { loadModuleFromProject } from './module-loader';
-export { findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, findCapProjectRoot } from './search';
+export { findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, findCapProjectRoot, findRootsForPath } from './search';
 export { getWebappPath, readUi5Yaml } from './ui5-config';
 export { getMtaPath } from './mta';
 export { createApplicationAccess, createProjectAccess } from './access';
-export { updatePackageScript } from './script';
+export { updatePackageScript, hasUI5CliV3 } from './script';
 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.getSpecificationPath = exports.getSpecification = exports.updatePackageScript = exports.createProjectAccess = exports.createApplicationAccess = exports.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = 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.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getNodeModulesPath = exports.addPackageDevDependency = exports.filterDataSourcesByType = exports.clearCdsModuleCache = exports.toReferenceUri = exports.getCapServiceName = 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.hasUI5CliV3 = exports.updatePackageScript = exports.createProjectAccess = exports.createApplicationAccess = exports.getMtaPath = 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.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getNodeModulesPath = exports.addPackageDevDependency = exports.filterDataSourcesByType = exports.clearCdsModuleCache = exports.toReferenceUri = exports.getCapServiceName = 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; } });
@@ -41,6 +41,7 @@ Object.defineProperty(exports, "findFioriArtifacts", { enumerable: true, get: fu
 Object.defineProperty(exports, "findProjectRoot", { enumerable: true, get: function () { return search_1.findProjectRoot; } });
 Object.defineProperty(exports, "getAppRootFromWebappPath", { enumerable: true, get: function () { return search_1.getAppRootFromWebappPath; } });
 Object.defineProperty(exports, "findCapProjectRoot", { enumerable: true, get: function () { return search_1.findCapProjectRoot; } });
+Object.defineProperty(exports, "findRootsForPath", { enumerable: true, get: function () { return search_1.findRootsForPath; } });
 var ui5_config_1 = require("./ui5-config");
 Object.defineProperty(exports, "getWebappPath", { enumerable: true, get: function () { return ui5_config_1.getWebappPath; } });
 Object.defineProperty(exports, "readUi5Yaml", { enumerable: true, get: function () { return ui5_config_1.readUi5Yaml; } });
@@ -51,6 +52,7 @@ Object.defineProperty(exports, "createApplicationAccess", { enumerable: true, ge
 Object.defineProperty(exports, "createProjectAccess", { enumerable: true, get: function () { return access_1.createProjectAccess; } });
 var script_1 = require("./script");
 Object.defineProperty(exports, "updatePackageScript", { enumerable: true, get: function () { return script_1.updatePackageScript; } });
+Object.defineProperty(exports, "hasUI5CliV3", { enumerable: true, get: function () { return script_1.hasUI5CliV3; } });
 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; } });

package/dist/project/script.d.ts

@@ -8,4 +8,11 @@ import type { Editor } from 'mem-fs-editor';
  * @param fs - optional memfs editor instance
  */
 export declare function updatePackageScript(basePath: string, scriptName: string, script: string, fs?: Editor): Promise<void>;
+/**
+ * Check if dev dependencies contains @ui5/cli version greater than 2.
+ *
+ * @param devDependencies dev dependencies from package.json
+ * @returns boolean
+ */
+export declare function hasUI5CliV3(devDependencies: any): boolean;
 //# sourceMappingURL=script.d.ts.map

package/dist/project/script.js

@@ -1,9 +1,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updatePackageScript = void 0;
+exports.hasUI5CliV3 = exports.updatePackageScript = void 0;
 const path_1 = require("path");
 const constants_1 = require("../constants");
 const file_1 = require("../file");
+const semver_1 = __importDefault(require("semver"));
 /**
  * Updates the package.json with a new script.
  *
@@ -22,4 +26,19 @@ async function updatePackageScript(basePath, scriptName, script, fs) {
     await (0, file_1.updatePackageJSON)(filePath, packageJson, fs);
 }
 exports.updatePackageScript = updatePackageScript;
+/**
+ * Check if dev dependencies contains @ui5/cli version greater than 2.
+ *
+ * @param devDependencies dev dependencies from package.json
+ * @returns boolean
+ */
+function hasUI5CliV3(devDependencies) {
+    let isV3 = false;
+    const ui5CliSemver = semver_1.default.coerce(devDependencies['@ui5/cli']);
+    if (ui5CliSemver && semver_1.default.gte(ui5CliSemver, '3.0.0')) {
+        isV3 = true;
+    }
+    return isV3;
+}
+exports.hasUI5CliV3 = hasUI5CliV3;
 //# sourceMappingURL=script.js.map

package/dist/project/search.d.ts

@@ -15,6 +15,25 @@ export declare function findProjectRoot(path: string, sapuxRequired?: boolean, s
  * @returns - root path of the application, where usually ui5.yaml and package.json are
  */
 export declare function getAppRootFromWebappPath(webappPath: string): Promise<string | null>;
+/**
+ * Find the app root and project root folder for a given path. In case of apps in non CAP projects they are the same.
+ * This function also validates if an app is supported by tools considering Fiori elements apps and SAPUI5
+ * freestyle apps. Only if project root and app root can be determined, they are returned, otherwise null is returned.
+ * This function is used e.g. to get a filtered list of all manifest.json files in a workspace for tools
+ * supported apps and retrieve the respective root paths.
+ *
+ * This function makes following assumptions:
+ * - All applications have a package.json in root folder.
+ * - If sapux=true in package.json the app is NOT inside a CAP project.
+ * - Freestyle application (non CAP) has in package.json dependency to @sap/ux-ui5-tooling and <appRoot>/ui5-local.yaml.
+ *
+ * @param path - path to check, e.g. to the manifest.json
+ * @returns - in case a supported app is found this function returns the appRoot and projectRoot path
+ */
+export declare function findRootsForPath(path: string): Promise<{
+    appRoot: string;
+    projectRoot: string;
+} | null>;
 /**
  * Find CAP project root path.
  *

package/dist/project/search.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findCapProjects = exports.findFioriArtifacts = exports.findAllApps = exports.findCapProjectRoot = exports.getAppRootFromWebappPath = exports.findProjectRoot = void 0;
+exports.findCapProjects = exports.findFioriArtifacts = exports.findAllApps = exports.findCapProjectRoot = exports.findRootsForPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = void 0;
 const path_1 = require("path");
 const constants_1 = require("../constants");
 const file_1 = require("../file");
@@ -186,6 +186,7 @@ async function findRootsForPath(path) {
     }
     return null;
 }
+exports.findRootsForPath = findRootsForPath;
 /**
  * Find CAP project root path.
  *

package/package.json

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