@sap-ux/project-access 1.0.0

package/dist/project/cap.js

@@ -0,0 +1,118 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCapModelAndServices = exports.getCapCustomPaths = exports.getCapProjectType = exports.isCapJavaProject = exports.isCapNodeJsProject = void 0;
+const path_1 = require("path");
+const constants_1 = require("../constants");
+const file_1 = require("../file");
+const module_loader_1 = require("./module-loader");
+/**
+ * Returns true if the project is a CAP Node.js project.
+ *
+ * @param packageJson - the parsed package.json object
+ * @returns - true if the project is a CAP Node.js project
+ */
+function isCapNodeJsProject(packageJson) {
+    var _a;
+    return !!(packageJson.cds || ((_a = packageJson.dependencies) === null || _a === void 0 ? void 0 : _a['@sap/cds']));
+}
+exports.isCapNodeJsProject = isCapNodeJsProject;
+/**
+ * Returns true if the project is a CAP Java project.
+ *
+ * @param projectRoot - the root path of the project
+ * @returns - true if the project is a CAP project
+ */
+function isCapJavaProject(projectRoot) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const { srv } = yield getCapCustomPaths(projectRoot);
+        return file_1.fileExists(path_1.join(projectRoot, srv, 'src', 'main', 'resources', 'application.yaml'));
+    });
+}
+exports.isCapJavaProject = isCapJavaProject;
+/**
+ * Returns the CAP project type, undefined if it is not a CAP project.
+ *
+ * @param projectRoot - root of the project, where the package.json resides.
+ * @returns - CAPJava for Java based CAP projects; CAPNodejs for node.js based CAP projects; undefined if it is no CAP project
+ */
+function getCapProjectType(projectRoot) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (yield isCapJavaProject(projectRoot)) {
+            return 'CAPJava';
+        }
+        let packageJson;
+        try {
+            packageJson = yield file_1.readJSON(path_1.join(projectRoot, constants_1.FileName.Package));
+        }
+        catch (_a) {
+            // Ignore errors while reading the package.json file
+        }
+        if (packageJson && isCapNodeJsProject(packageJson)) {
+            return 'CAPNodejs';
+        }
+        return undefined;
+    });
+}
+exports.getCapProjectType = getCapProjectType;
+/**
+ * Get CAP CDS project custom paths for project root.
+ *
+ * @param capProjectPath - project root of cap project
+ * @returns - paths to app, db, and srv for CAP project
+ */
+function getCapCustomPaths(capProjectPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const result = {
+            app: 'app/',
+            db: 'db/',
+            srv: 'srv/'
+        };
+        try {
+            const cds = yield module_loader_1.loadModuleFromProject(capProjectPath, '@sap/cds');
+            const cdsCustomPaths = cds.env.for('cds', capProjectPath);
+            if (cdsCustomPaths.folders) {
+                result.app = cdsCustomPaths.folders.app;
+                result.db = cdsCustomPaths.folders.db;
+                result.srv = cdsCustomPaths.folders.srv;
+            }
+        }
+        catch (error) {
+            // In case of issues, fall back to the defaults
+        }
+        return result;
+    });
+}
+exports.getCapCustomPaths = getCapCustomPaths;
+/**
+ * Return the CAP model and all services.
+ *
+ * @param projectRoot - CAP project root where package.json resides
+ */
+function getCapModelAndServices(projectRoot) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cds = yield module_loader_1.loadModuleFromProject(projectRoot, '@sap/cds');
+        const capProjectPaths = yield getCapCustomPaths(projectRoot);
+        const modelPaths = [
+            path_1.join(projectRoot, capProjectPaths.app),
+            path_1.join(projectRoot, capProjectPaths.srv),
+            path_1.join(projectRoot, capProjectPaths.db)
+        ];
+        const model = yield cds.load(modelPaths);
+        const services = cds.compile.to['serviceinfo'](model, { root: projectRoot });
+        return {
+            model,
+            services
+        };
+    });
+}
+exports.getCapModelAndServices = getCapModelAndServices;
+//# sourceMappingURL=cap.js.map

package/dist/project/dependencies.d.ts

@@ -0,0 +1,10 @@
+import type { Package } from '../types';
+/**
+ * Helper to check for dependency/devDependency.
+ *
+ * @param packageJson - content of package.json to check
+ * @param dependency - name of the dependency
+ * @returns - true: has dependency; false: no dependency
+ */
+export declare const hasDependency: (packageJson: Package, dependency: string) => boolean;
+//# sourceMappingURL=dependencies.d.ts.map

package/dist/project/dependencies.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasDependency = void 0;
+/**
+ * Helper to check for dependency/devDependency.
+ *
+ * @param packageJson - content of package.json to check
+ * @param dependency - name of the dependency
+ * @returns - true: has dependency; false: no dependency
+ */
+const hasDependency = (packageJson, dependency) => { var _a, _b; return !!(((_a = packageJson.dependencies) === null || _a === void 0 ? void 0 : _a[dependency]) || ((_b = packageJson.devDependencies) === null || _b === void 0 ? void 0 : _b[dependency])); };
+exports.hasDependency = hasDependency;
+//# sourceMappingURL=dependencies.js.map

package/dist/project/index.d.ts

@@ -0,0 +1,5 @@
+export { getCapModelAndServices, getCapProjectType, isCapJavaProject, isCapNodeJsProject } from './cap';
+export { loadModuleFromProject } from './module-loader';
+export { findAllApps, findProjectRoot, getAppRootFromWebappPath } from './search';
+export { getWebappPath } from './ui5-config';
+//# sourceMappingURL=index.d.ts.map

package/dist/project/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCapProjectType = exports.getCapModelAndServices = void 0;
+var cap_1 = require("./cap");
+Object.defineProperty(exports, "getCapModelAndServices", { enumerable: true, get: function () { return cap_1.getCapModelAndServices; } });
+Object.defineProperty(exports, "getCapProjectType", { enumerable: true, get: function () { return cap_1.getCapProjectType; } });
+Object.defineProperty(exports, "isCapJavaProject", { enumerable: true, get: function () { return cap_1.isCapJavaProject; } });
+Object.defineProperty(exports, "isCapNodeJsProject", { enumerable: true, get: function () { return cap_1.isCapNodeJsProject; } });
+var module_loader_1 = require("./module-loader");
+Object.defineProperty(exports, "loadModuleFromProject", { enumerable: true, get: function () { return module_loader_1.loadModuleFromProject; } });
+var search_1 = require("./search");
+Object.defineProperty(exports, "findAllApps", { enumerable: true, get: function () { return search_1.findAllApps; } });
+Object.defineProperty(exports, "findProjectRoot", { enumerable: true, get: function () { return search_1.findProjectRoot; } });
+Object.defineProperty(exports, "getAppRootFromWebappPath", { enumerable: true, get: function () { return search_1.getAppRootFromWebappPath; } });
+var ui5_config_1 = require("./ui5-config");
+Object.defineProperty(exports, "getWebappPath", { enumerable: true, get: function () { return ui5_config_1.getWebappPath; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,9 @@
+/**
+ * Load module from project or app. Throws error if module is not installed.
+ *
+ * @param projectRoot - root path of the project/app.
+ * @param moduleName - name of the npm module.
+ * @returns - loaded module.
+ */
+export declare function loadModuleFromProject<T>(projectRoot: string, moduleName: string): Promise<T>;
+//# sourceMappingURL=module-loader.d.ts.map

package/dist/project/module-loader.js

@@ -0,0 +1,53 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadModuleFromProject = void 0;
+/**
+ * Load module from project or app. Throws error if module is not installed.
+ *
+ * @param projectRoot - root path of the project/app.
+ * @param moduleName - name of the npm module.
+ * @returns - loaded module.
+ */
+function loadModuleFromProject(projectRoot, moduleName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let module;
+        try {
+            const modulePath = require.resolve(moduleName, { paths: [projectRoot] });
+            module = (yield Promise.resolve().then(() => __importStar(require(modulePath))));
+        }
+        catch (error) {
+            throw Error(`Module '${moduleName}' not installed in project '${projectRoot}'`);
+        }
+        return module;
+    });
+}
+exports.loadModuleFromProject = loadModuleFromProject;
+//# sourceMappingURL=module-loader.js.map

package/dist/project/search.d.ts

@@ -0,0 +1,23 @@
+import type { AllAppResults, WorkspaceFolder } from '../types';
+/**
+ * Find root folder of the project containing the given file.
+ *
+ * @param path path of a project file
+ * @param sapuxRequired if true, only find sapux projects
+ */
+export declare function findProjectRoot(path: string, sapuxRequired?: boolean): Promise<string>;
+/**
+ * Get the application root for a given webapp path.
+ *
+ * @param webappPath - path to webapp folder, where manifest.json is
+ * @returns - root path of the application, where usually ui5.yaml and package.json are
+ */
+export declare function getAppRootFromWebappPath(webappPath: string): Promise<string | null>;
+/**
+ * Find all app that are supported by Fiori tools for a given list of roots (workspace folders).
+ *
+ * @param wsFolders - list of roots, either as vscode WorkspaceFolder[] or array of paths
+ * @returns - results as path to apps plus files already parsed, e.g. manifest.json
+ */
+export declare function findAllApps(wsFolders: WorkspaceFolder[] | string[] | undefined): Promise<AllAppResults[]>;
+//# sourceMappingURL=search.d.ts.map

package/dist/project/search.js

@@ -0,0 +1,238 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findAllApps = exports.getAppRootFromWebappPath = exports.findProjectRoot = void 0;
+const path_1 = require("path");
+const constants_1 = require("../constants");
+const file_1 = require("../file");
+const dependencies_1 = require("./dependencies");
+const cap_1 = require("./cap");
+const ui5_config_1 = require("./ui5-config");
+/**
+ * WorkspaceFolder type guard.
+ *
+ * @param value - value to type check
+ * @returns - true: is a vscode workspace array; no: not a vscode workspace array
+ */
+function isWorkspaceFolder(value) {
+    return value && value.length > 0 && value[0].uri !== undefined;
+}
+/**
+ * Search all manifest.json files in given workspaces. This is used as starting point to find all tools
+ * supported apps.
+ *
+ * @param wsFolders - workspace folders
+ * @returns - array of path to manifest.json files
+ */
+function findAllManifest(wsFolders) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // extract root path if provided as VSCode folder
+        let wsRoots;
+        if (wsFolders && isWorkspaceFolder(wsFolders)) {
+            wsRoots = [];
+            wsFolders
+                .filter((each) => each.uri.scheme === 'file')
+                .forEach((folder) => {
+                wsRoots.push(folder.uri.fsPath);
+            });
+        }
+        else {
+            wsRoots = wsFolders || [];
+        }
+        // find all manifest files
+        const manifests = [];
+        for (const root of wsRoots) {
+            try {
+                manifests.push(...(yield file_1.findFiles(constants_1.FileName.Manifest, root, ['.git', 'node_modules', 'dist'])));
+            }
+            catch (_a) {
+                // ignore exceptions during find
+            }
+        }
+        return manifests;
+    });
+}
+/**
+ * Find root folder of the project containing the given file.
+ *
+ * @param path path of a project file
+ * @param sapuxRequired if true, only find sapux projects
+ */
+function findProjectRoot(path, sapuxRequired = true) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const packageJson = yield file_1.findFileUp(constants_1.FileName.Package, path);
+        if (!packageJson) {
+            throw new Error(`Could not find any project root for '${path}'. Search was done for ${sapuxRequired ? 'Fiori elements' : 'All'} projects.`);
+        }
+        let root = path_1.dirname(packageJson);
+        if (sapuxRequired) {
+            const sapux = (yield file_1.readJSON(packageJson)).sapux;
+            if (!sapux) {
+                root = yield findProjectRoot(path_1.dirname(root), sapuxRequired);
+            }
+        }
+        return root;
+    });
+}
+exports.findProjectRoot = findProjectRoot;
+/**
+ * Find app root and project root from given paths and sapux entry.
+ *
+ *
+ * @param sapux - value of sapux in package.json, either boolean or string array
+ * @param path - path where the search started from
+ * @param root - root of the app or project, where package.json is located
+ * @returns - appRoot and projectRoot or null
+ */
+function findRootsWithSapux(sapux, path, root) {
+    if (typeof sapux === 'boolean' && sapux === true) {
+        return {
+            appRoot: root,
+            projectRoot: root
+        };
+    }
+    else if (Array.isArray(sapux)) {
+        // Backward compatibility for FE apps in CAP projects that have no app package.json,
+        // but are listed in CAP root sapux array
+        const pathWithSep = path.endsWith(path_1.sep) ? path : path + path_1.sep;
+        const relAppPaths = sapux.map((a) => path_1.join(...a.split(/[\\/]/)));
+        const relApp = relAppPaths.find((app) => pathWithSep.startsWith(path_1.join(root, app) + path_1.sep));
+        if (relApp) {
+            return {
+                appRoot: path_1.join(root, relApp),
+                projectRoot: root
+            };
+        }
+    }
+    // The first package.json we found when searching up contains sapux, but not true -> not supported
+    return null;
+}
+/**
+ * Get the application root for a given webapp path.
+ *
+ * @param webappPath - path to webapp folder, where manifest.json is
+ * @returns - root path of the application, where usually ui5.yaml and package.json are
+ */
+function getAppRootFromWebappPath(webappPath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const ui5YamlPath = yield file_1.findFileUp(constants_1.FileName.Ui5Yaml, webappPath);
+        let appRoot = path_1.dirname(webappPath);
+        if (ui5YamlPath) {
+            const candidate = path_1.dirname(ui5YamlPath);
+            const webapp = yield ui5_config_1.getWebappPath(candidate);
+            if (webapp === webappPath) {
+                appRoot = candidate;
+            }
+        }
+        return appRoot;
+    });
+}
+exports.getAppRootFromWebappPath = getAppRootFromWebappPath;
+/**
+ * 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
+ */
+function findRootsForPath(path) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            // Get the root of the app, that is where the package.json is, otherwise not supported
+            const appRoot = yield findProjectRoot(path, false);
+            if (!appRoot) {
+                return null;
+            }
+            const appPckJson = yield file_1.readJSON(path_1.join(appRoot, constants_1.FileName.Package));
+            // Check for most common app, Fiori elements with sapux=true in package.json
+            if (appPckJson.sapux) {
+                return findRootsWithSapux(appPckJson.sapux, path, appRoot);
+            }
+            if (cap_1.isCapNodeJsProject(appPckJson) || (yield cap_1.isCapJavaProject(appRoot))) {
+                // App is part of a CAP project, but doesn't have own package.json and is not mentioned in sapux array
+                // in root -> not supported
+                return null;
+            }
+            // Now we have the app root folder. Check for freestyle non CAP
+            if ((yield file_1.fileExists(path_1.join(appRoot, constants_1.FileName.Ui5LocalYaml))) &&
+                dependencies_1.hasDependency(appPckJson, '@sap/ux-ui5-tooling')) {
+                return {
+                    appRoot,
+                    projectRoot: appRoot
+                };
+            }
+            // Project must be CAP, find project root
+            try {
+                const { root } = path_1.parse(appRoot);
+                let projectRoot = path_1.dirname(appRoot);
+                while (projectRoot !== root) {
+                    if (yield 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 (path_1.join(projectRoot, 'app') !== appRoot) {
+                            return {
+                                appRoot,
+                                projectRoot
+                            };
+                        }
+                    }
+                    projectRoot = path_1.dirname(projectRoot);
+                }
+            }
+            catch (_a) {
+                // No project root can be found at parent folder.
+            }
+        }
+        catch (_b) {
+            // Finding root should not throw error. Return null instead.
+        }
+        return null;
+    });
+}
+/**
+ * Find all app that are supported by Fiori tools for a given list of roots (workspace folders).
+ *
+ * @param wsFolders - list of roots, either as vscode WorkspaceFolder[] or array of paths
+ * @returns - results as path to apps plus files already parsed, e.g. manifest.json
+ */
+function findAllApps(wsFolders) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const result = [];
+        const manifestPaths = yield findAllManifest(wsFolders);
+        for (const manifestPath of manifestPaths) {
+            try {
+                // All UI5 apps have at least sap.app: { id: <ID>, type: "application" } in manifest.json
+                const manifest = yield file_1.readJSON(path_1.join(manifestPath, constants_1.FileName.Manifest));
+                if (!manifest['sap.app'] || !manifest['sap.app'].id || manifest['sap.app'].type !== 'application') {
+                    continue;
+                }
+                const roots = yield findRootsForPath(manifestPath);
+                if (roots) {
+                    result.push({ appRoot: roots.appRoot, projectRoot: roots.projectRoot, manifest, manifestPath });
+                }
+            }
+            catch (_a) {
+                // ignore exceptions for invalid manifests
+            }
+        }
+        return result;
+    });
+}
+exports.findAllApps = findAllApps;
+//# sourceMappingURL=search.js.map

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

@@ -0,0 +1,8 @@
+/**
+ * Get path to webapp.
+ *
+ * @param projectRoot - root path, where package.json or ui5.yaml is
+ * @returns - path to webapp folder
+ */
+export declare function getWebappPath(projectRoot: string): Promise<string>;
+//# sourceMappingURL=ui5-config.d.ts.map

package/dist/project/ui5-config.js

@@ -0,0 +1,40 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWebappPath = void 0;
+const path_1 = require("path");
+const ui5_config_1 = require("@sap-ux/ui5-config");
+const constants_1 = require("../constants");
+const file_1 = require("../file");
+/**
+ * Get path to webapp.
+ *
+ * @param projectRoot - root path, where package.json or ui5.yaml is
+ * @returns - path to webapp folder
+ */
+function getWebappPath(projectRoot) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        let webappPath = path_1.join(projectRoot, 'webapp');
+        const ui5YamlPath = path_1.join(projectRoot, constants_1.FileName.Ui5Yaml);
+        if (yield file_1.fileExists(ui5YamlPath)) {
+            const yamlString = yield file_1.readFile(ui5YamlPath);
+            const ui5Config = yield ui5_config_1.UI5Config.newInstance(yamlString);
+            const relativeWebappPath = (_b = (_a = ui5Config.getConfiguration()) === null || _a === void 0 ? void 0 : _a.paths) === null || _b === void 0 ? void 0 : _b.webapp;
+            if (relativeWebappPath) {
+                webappPath = path_1.join(projectRoot, relativeWebappPath);
+            }
+        }
+        return webappPath;
+    });
+}
+exports.getWebappPath = getWebappPath;
+//# sourceMappingURL=ui5-config.js.map