@sap-ux/project-access 1.16.0 → 1.16.2

package/dist/constants.d.ts

@@ -1,5 +1,6 @@
 export declare const FileName: {
     readonly AdaptationConfig: "config.json";
+    readonly CapJavaApplicationYaml: "application.yaml";
     readonly ExtConfigJson: ".extconfig.json";
     readonly Manifest: "manifest.json";
     readonly ManifestAppDescrVar: "manifest.appdescr_variant";

package/dist/constants.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileName = void 0;
 exports.FileName = {
     AdaptationConfig: 'config.json',
+    CapJavaApplicationYaml: 'application.yaml',
     ExtConfigJson: '.extconfig.json',
     Manifest: 'manifest.json',
     ManifestAppDescrVar: 'manifest.appdescr_variant',

package/dist/project/cap.d.ts

@@ -1,4 +1,5 @@
 import type { CapCustomPaths, CapProjectType, CdsEnvironment, csn, Package, ServiceDefinitions } from '../types';
+import type { Logger } from '@sap-ux/logger';
 interface ServiceInfo {
     name: string;
     urlPath: string;
@@ -34,12 +35,15 @@ export declare function getCapProjectType(projectRoot: string): Promise<CapProje
  */
 export declare function getCapCustomPaths(capProjectPath: string): Promise<CapCustomPaths>;
 /**
- * Return the CAP model and all services.
+ * Return the CAP model and all services. The cds.root will be set to the provided project root path.
  *
- * @param projectRoot - CAP project root where package.json resides
+ * @param projectRoot - CAP project root where package.json resides or object specifying project root and optional logger to log additonal info
  * @returns {*}  {Promise<{ model: csn; services: ServiceInfo[] }>} - CAP Model and Services
  */
-export declare function getCapModelAndServices(projectRoot: string): Promise<{
+export declare function getCapModelAndServices(projectRoot: string | {
+    projectRoot: string;
+    logger?: Logger;
+}): Promise<{
     model: csn;
     services: ServiceInfo[];
 }>;

package/dist/project/cap.js

@@ -37,7 +37,7 @@ function isCapJavaProject(projectRoot, capCustomPaths) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
         const srv = (_a = capCustomPaths === null || capCustomPaths === void 0 ? void 0 : capCustomPaths.srv) !== null && _a !== void 0 ? _a : (yield getCapCustomPaths(projectRoot)).srv;
-        return (0, file_1.fileExists)((0, path_1.join)(projectRoot, srv, 'src', 'main', 'resources', 'application.yaml'));
+        return (0, file_1.fileExists)((0, path_1.join)(projectRoot, srv, 'src', 'main', 'resources', constants_1.FileName.CapJavaApplicationYaml));
     });
 }
 exports.isCapJavaProject = isCapJavaProject;
@@ -99,23 +99,35 @@ function getCapCustomPaths(capProjectPath) {
 }
 exports.getCapCustomPaths = getCapCustomPaths;
 /**
- * Return the CAP model and all services.
+ * Return the CAP model and all services. The cds.root will be set to the provided project root path.
  *
- * @param projectRoot - CAP project root where package.json resides
+ * @param projectRoot - CAP project root where package.json resides or object specifying project root and optional logger to log additonal info
  * @returns {*}  {Promise<{ model: csn; services: ServiceInfo[] }>} - CAP Model and Services
  */
 function getCapModelAndServices(projectRoot) {
     var _a;
     return __awaiter(this, void 0, void 0, function* () {
-        const cds = yield loadCdsModuleFromProject(projectRoot);
-        const capProjectPaths = yield getCapCustomPaths(projectRoot);
+        let _projectRoot;
+        let _logger;
+        if (typeof projectRoot === 'object') {
+            _projectRoot = projectRoot.projectRoot;
+            _logger = projectRoot.logger;
+        }
+        else {
+            _projectRoot = projectRoot;
+        }
+        const cds = yield loadCdsModuleFromProject(_projectRoot);
+        _logger === null || _logger === void 0 ? void 0 : _logger.info(`@sap-ux/project-access:getCapModelAndServices - Using 'cds.home': ${cds.home}`);
+        _logger === null || _logger === void 0 ? void 0 : _logger.info(`@sap-ux/project-access:getCapModelAndServices - Using 'cds.version': ${cds.version}`);
+        _logger === null || _logger === void 0 ? void 0 : _logger.info(`@sap-ux/project-access:getCapModelAndServices - Using 'cds.root': ${cds.root}`);
+        const capProjectPaths = yield getCapCustomPaths(_projectRoot);
         const modelPaths = [
-            (0, path_1.join)(projectRoot, capProjectPaths.app),
-            (0, path_1.join)(projectRoot, capProjectPaths.srv),
-            (0, path_1.join)(projectRoot, capProjectPaths.db)
+            (0, path_1.join)(_projectRoot, capProjectPaths.app),
+            (0, path_1.join)(_projectRoot, capProjectPaths.srv),
+            (0, path_1.join)(_projectRoot, capProjectPaths.db)
         ];
         const model = yield cds.load(modelPaths);
-        let services = (_a = cds.compile.to.serviceinfo(model, { root: projectRoot })) !== null && _a !== void 0 ? _a : [];
+        let services = (_a = cds.compile.to.serviceinfo(model, { root: _projectRoot })) !== null && _a !== void 0 ? _a : [];
         if (services.map) {
             services = services.map((value) => {
                 return {
@@ -359,6 +371,8 @@ function loadCdsModuleFromProject(capProjectPath) {
         if (global) {
             global.cds = cds;
         }
+        // Ensure we use a known root path, otherwise `cwd` is used which varies between invocations.
+        cds.root = capProjectPath;
         return cds;
     });
 }

package/dist/project/info.js

@@ -96,17 +96,21 @@ exports.getAppType = getAppType;
 function getApplicationType(application) {
     return __awaiter(this, void 0, void 0, function* () {
         let appType;
-        const packageJson = yield (0, file_1.readJSON)((0, path_1.join)(application.projectRoot, constants_1.FileName.Package));
+        const rootPackageJsonPath = (0, path_1.join)(application.projectRoot, constants_1.FileName.Package);
+        const packageJson = (yield (0, file_1.fileExists)(rootPackageJsonPath)) ? yield (0, file_1.readJSON)(rootPackageJsonPath) : null;
         if (application.projectRoot === application.appRoot) {
-            appType = packageJson.sapux ? 'SAP Fiori elements' : 'SAPUI5 freestyle';
+            appType = (packageJson === null || packageJson === void 0 ? void 0 : packageJson.sapux) ? 'SAP Fiori elements' : 'SAPUI5 freestyle';
         }
-        else {
+        else if (packageJson) {
             appType =
                 Array.isArray(packageJson.sapux) &&
                     packageJson.sapux.find((relAppPath) => (0, path_1.join)(application.projectRoot, ...relAppPath.split(/[/\\]/)) === application.appRoot)
                     ? 'SAP Fiori elements'
                     : 'SAPUI5 freestyle';
         }
+        else {
+            appType = 'SAPUI5 freestyle';
+        }
         return appType;
     });
 }

package/dist/project/search.js

@@ -185,29 +185,44 @@ function findRootsForPath(path) {
                 };
             }
             // Project must be CAP, find project root
-            try {
-                const { root } = (0, path_1.parse)(appRoot);
-                let projectRoot = (0, path_1.dirname)(appRoot);
-                while (projectRoot !== root) {
-                    if (yield (0, cap_1.getCapProjectType)(projectRoot)) {
-                        // We have found a CAP project as root. Check if the found app is not directly in CAP's 'app/' folder.
-                        // Sometime there is a <CAP_ROOT>/app/package.json file that is used for app router (not an app)
-                        if ((0, path_1.join)(projectRoot, 'app') !== appRoot) {
-                            return {
-                                appRoot,
-                                projectRoot
-                            };
-                        }
+            const projectRoot = yield findCapProjectRoot(appRoot);
+            if (projectRoot) {
+                return {
+                    appRoot,
+                    projectRoot
+                };
+            }
+        }
+        catch (_a) {
+            // Finding root should not throw error. Return null instead.
+        }
+        return null;
+    });
+}
+/**
+ * Find CAP project root path.
+ *
+ * @param path - path inside CAP project
+ * @returns - CAP project root path
+ */
+function findCapProjectRoot(path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const { root } = (0, path_1.parse)(path);
+            let projectRoot = (0, path_1.dirname)(path);
+            while (projectRoot !== root) {
+                if (yield (0, cap_1.getCapProjectType)(projectRoot)) {
+                    // We have found a CAP project as root. Check if the found app is not directly in CAP's 'app/' folder.
+                    // Sometime there is a <CAP_ROOT>/app/package.json file that is used for app router (not an app)
+                    if ((0, path_1.join)(projectRoot, 'app') !== path) {
+                        return projectRoot;
                     }
-                    projectRoot = (0, path_1.dirname)(projectRoot);
                 }
-            }
-            catch (_a) {
-                // No project root can be found at parent folder.
+                projectRoot = (0, path_1.dirname)(projectRoot);
             }
         }
-        catch (_b) {
-            // Finding root should not throw error. Return null instead.
+        catch (_a) {
+            // No project root can be found at parent folder.
         }
         return null;
     });
@@ -418,8 +433,8 @@ exports.findFioriArtifacts = findFioriArtifacts;
 function findCapProjects(options) {
     return __awaiter(this, void 0, void 0, function* () {
         const result = new Set();
-        const excludeFolders = ['node_modules', 'dist', 'src', 'webapp', 'MDKModule', 'gen'];
-        const fileNames = [constants_1.FileName.Pom, constants_1.FileName.Package];
+        const excludeFolders = ['node_modules', 'dist', 'webapp', 'MDKModule', 'gen'];
+        const fileNames = [constants_1.FileName.Pom, constants_1.FileName.Package, constants_1.FileName.CapJavaApplicationYaml];
         const wsRoots = wsFoldersToRootPaths(options.wsFolders);
         for (const root of wsRoots) {
             const filesToCheck = yield (0, file_1.findBy)({
@@ -427,7 +442,18 @@ function findCapProjects(options) {
                 root,
                 excludeFolders
             });
-            const foldersToCheck = Array.from(new Set(filesToCheck.map((file) => (0, path_1.dirname)(file)))); //only directories without duplicates
+            const appYamlsToCheck = Array.from(new Set(filesToCheck
+                .filter((file) => (0, path_1.basename)(file) === constants_1.FileName.CapJavaApplicationYaml)
+                .map((file) => (0, path_1.dirname)(file))));
+            const foldersToCheck = Array.from(new Set(filesToCheck
+                .filter((file) => (0, path_1.basename)(file) !== constants_1.FileName.CapJavaApplicationYaml)
+                .map((file) => (0, path_1.dirname)(file))));
+            for (const appYamlToCheck of appYamlsToCheck) {
+                const capRoot = yield findCapProjectRoot(appYamlToCheck);
+                if (capRoot) {
+                    result.add(capRoot);
+                }
+            }
             for (const folderToCheck of foldersToCheck) {
                 if ((yield (0, cap_1.getCapProjectType)(folderToCheck)) !== undefined) {
                     result.add(folderToCheck);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.16.0",
+  "version": "1.16.2",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",
@@ -33,7 +33,8 @@
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
     "@ui5/manifest": "1.61.0",
-    "vscode-uri": "3.0.7"
+    "vscode-uri": "3.0.7",
+    "@sap-ux/logger": "0.4.0"
   },
   "scripts": {
     "build": "tsc --build",