@sap-ux/project-access 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,22 @@
+# @sap-ux/project-access
+
+Library that offers functions to find, read, and retrieve project information and artifacts.
+
+
+## Installation
+Npm   
+`npm install --save @sap-ux/project-access`
+
+Yarn   
+`yarn add @sap-ux/project-access`
+
+Pnpm   
+`pnpm add @sap-ux/project-access`
+
+## Usage
+See usage in `test/` folder.
+
+## Keywords
+* SAP Fiori tools
+* SAP Fiori elements
+* SAP Fiori freestyle

package/dist/constants.d.ts

@@ -0,0 +1,8 @@
+export declare const FileName: {
+    readonly Manifest: "manifest.json";
+    readonly Package: "package.json";
+    readonly Ui5Yaml: "ui5.yaml";
+    readonly Ui5LocalYaml: "ui5-local.yaml";
+    readonly Ui5MockYaml: "ui5-mock.yaml";
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileName = void 0;
+exports.FileName = {
+    Manifest: 'manifest.json',
+    Package: 'package.json',
+    Ui5Yaml: 'ui5.yaml',
+    Ui5LocalYaml: 'ui5-local.yaml',
+    Ui5MockYaml: 'ui5-mock.yaml'
+};
+//# sourceMappingURL=constants.js.map

package/dist/file/file-access.d.ts

@@ -0,0 +1,26 @@
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Read file asynchronously. Throws error if file does not exist.
+ *
+ * @param path - path to file
+ * @param memFs - optional mem-fs-editor instance
+ * @returns - file content as string
+ */
+export declare function readFile(path: string, memFs?: Editor): Promise<string>;
+/**
+ * Read JSON file asynchronously. Throws error if file does not exist or is malformatted.
+ *
+ * @param path - path to JSON file
+ * @param memFs - optional mem-fs-editor instance
+ * @returns - file content as object of type T
+ */
+export declare function readJSON<T>(path: string, memFs?: Editor): Promise<T>;
+/**
+ * Checks if the provided file exists in the file system.
+ *
+ * @param path - the file path to check
+ * @param memFs - optional mem-fs-editor instance
+ * @returns - true if the file exists; false otherwise.
+ */
+export declare function fileExists(path: string, memFs?: Editor): Promise<boolean>;
+//# sourceMappingURL=file-access.d.ts.map

package/dist/file/file-access.js

@@ -0,0 +1,74 @@
+"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.fileExists = exports.readJSON = exports.readFile = void 0;
+const fs_1 = require("fs");
+/**
+ * Read file asynchronously. Throws error if file does not exist.
+ *
+ * @param path - path to file
+ * @param memFs - optional mem-fs-editor instance
+ * @returns - file content as string
+ */
+function readFile(path, memFs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (memFs) {
+            return memFs.read(path);
+        }
+        else {
+            return fs_1.promises.readFile(path, { encoding: 'utf8' });
+        }
+    });
+}
+exports.readFile = readFile;
+/**
+ * Read JSON file asynchronously. Throws error if file does not exist or is malformatted.
+ *
+ * @param path - path to JSON file
+ * @param memFs - optional mem-fs-editor instance
+ * @returns - file content as object of type T
+ */
+function readJSON(path, memFs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (memFs) {
+            return memFs.readJSON(path);
+        }
+        else {
+            return JSON.parse(yield readFile(path));
+        }
+    });
+}
+exports.readJSON = readJSON;
+/**
+ * Checks if the provided file exists in the file system.
+ *
+ * @param path - the file path to check
+ * @param memFs - optional mem-fs-editor instance
+ * @returns - true if the file exists; false otherwise.
+ */
+function fileExists(path, memFs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            if (memFs) {
+                return memFs.exists(path);
+            }
+            else {
+                yield fs_1.promises.access(path);
+                return true;
+            }
+        }
+        catch (_a) {
+            return false;
+        }
+    });
+}
+exports.fileExists = fileExists;
+//# sourceMappingURL=file-access.js.map

package/dist/file/file-search.d.ts

@@ -0,0 +1,40 @@
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Add missing dump function declaration as mem-fs-editor types do not expose this.
+ */
+declare module 'mem-fs-editor' {
+    type FileMap = {
+        [key: string]: {
+            state: 'modified' | 'deleted';
+        };
+    };
+    interface Editor {
+        /**
+         * Dump files to compare expected result. Provide a cwd for relative path.
+         * See also https://github.com/SBoudrias/mem-fs-editor#dumpcwd-filter for further details.
+         *
+         * @param [cwd] - optional, relative path
+         */
+        dump(cwd?: string): FileMap;
+    }
+}
+/**
+ * Search for 'filename' starting from 'root'. Returns array of paths that contain the file.
+ *
+ * @param filename - filename to search
+ * @param root - root folder to start search
+ * @param excludeFolders - list of folder names to exclude (search doesn't traverse into these folders)
+ * @param fs - optional mem-fs-editor instance
+ * @returns - array of paths that contain the filename
+ */
+export declare function findFiles(filename: string, root: string, excludeFolders: string[], fs?: Editor): Promise<string[]>;
+/**
+ * Find a file by name in parent folders starting from 'startPath'.
+ *
+ * @param fileName - file name to look for
+ * @param startPath - path for start searching up
+ * @param fs - optional mem-fs-editor instance
+ * @returns - path to file name if found, otherwise undefined
+ */
+export declare function findFileUp(fileName: string, startPath: string, fs?: Editor): Promise<string | undefined>;
+//# sourceMappingURL=file-search.d.ts.map

package/dist/file/file-search.js

@@ -0,0 +1,105 @@
+"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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findFileUp = exports.findFiles = void 0;
+const path_1 = require("path");
+const findit2_1 = __importDefault(require("findit2"));
+const file_access_1 = require("./file-access");
+/**
+ * Creates a filter function that removes files that have been deleted in an instance of a mem-fs-editor.
+ *
+ * @param changes - changes recorded in an instance of a mem-fs-editor
+ * @param filename - relevant filename
+ * @returns a filter function for string arrays
+ */
+function getMemFsFilter(changes, filename) {
+    const deleted = Object.entries(changes)
+        .filter(([, info]) => info.state === 'deleted')
+        .map(([file]) => path_1.join(path_1.basename(path_1.join(file)) === filename ? path_1.dirname(file) : file));
+    return (path) => !deleted.find((entry) => path.startsWith(entry));
+}
+/**
+ * Concatanates the given list of files with additional files that have been created using a mem-fs-editor and matching the filename.
+ *
+ * @param folders - existing list of folders
+ * @param changes - changes recorded in an instance of a mem-fs-editor
+ * @param filename - relevant filename
+ * @returns Concatanated and deduped list of folders containing the given filename
+ */
+function concatNewFoldersFromMemFs(folders, changes, filename) {
+    const modified = Object.entries(changes)
+        .filter(([file, info]) => info.state === 'modified' && path_1.basename(path_1.join(file)) === filename)
+        .map(([file]) => path_1.dirname(path_1.join(file)));
+    return [...new Set([...folders, ...modified])];
+}
+/**
+ * Search for 'filename' starting from 'root'. Returns array of paths that contain the file.
+ *
+ * @param filename - filename to search
+ * @param root - root folder to start search
+ * @param excludeFolders - list of folder names to exclude (search doesn't traverse into these folders)
+ * @param fs - optional mem-fs-editor instance
+ * @returns - array of paths that contain the filename
+ */
+function findFiles(filename, root, excludeFolders, fs) {
+    return new Promise((resolve, reject) => {
+        const results = [];
+        const finder = findit2_1.default(root);
+        finder.on('directory', (dir, _stat, stop) => {
+            const base = path_1.basename(dir);
+            if (excludeFolders.includes(base)) {
+                stop();
+            }
+        });
+        finder.on('file', (file) => {
+            if (file.endsWith(path_1.sep + filename)) {
+                results.push(path_1.dirname(file));
+            }
+        });
+        finder.on('end', () => {
+            if (fs) {
+                const changes = fs.dump('');
+                resolve(concatNewFoldersFromMemFs(results, changes, filename).filter(getMemFsFilter(changes, filename)));
+            }
+            else {
+                resolve(results);
+            }
+        });
+        finder.on('error', (error) => {
+            reject(error);
+        });
+    });
+}
+exports.findFiles = findFiles;
+/**
+ * Find a file by name in parent folders starting from 'startPath'.
+ *
+ * @param fileName - file name to look for
+ * @param startPath - path for start searching up
+ * @param fs - optional mem-fs-editor instance
+ * @returns - path to file name if found, otherwise undefined
+ */
+function findFileUp(fileName, startPath, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const filePath = path_1.join(startPath, fileName);
+        if (yield file_access_1.fileExists(filePath, fs)) {
+            return filePath;
+        }
+        else {
+            return path_1.dirname(startPath) !== startPath ? findFileUp(fileName, path_1.dirname(startPath), fs) : undefined;
+        }
+    });
+}
+exports.findFileUp = findFileUp;
+//# sourceMappingURL=file-search.js.map

package/dist/file/index.d.ts

@@ -0,0 +1,3 @@
+export { fileExists, readFile, readJSON } from './file-access';
+export { findFiles, findFileUp } from './file-search';
+//# sourceMappingURL=index.d.ts.map

package/dist/file/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findFileUp = exports.findFiles = exports.readJSON = exports.readFile = exports.fileExists = void 0;
+var file_access_1 = require("./file-access");
+Object.defineProperty(exports, "fileExists", { enumerable: true, get: function () { return file_access_1.fileExists; } });
+Object.defineProperty(exports, "readFile", { enumerable: true, get: function () { return file_access_1.readFile; } });
+Object.defineProperty(exports, "readJSON", { enumerable: true, get: function () { return file_access_1.readJSON; } });
+var file_search_1 = require("./file-search");
+Object.defineProperty(exports, "findFiles", { enumerable: true, get: function () { return file_search_1.findFiles; } });
+Object.defineProperty(exports, "findFileUp", { enumerable: true, get: function () { return file_search_1.findFileUp; } });
+//# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { FileName } from './constants';
+export { findAllApps, findProjectRoot, getAppRootFromWebappPath, getCapModelAndServices, getCapProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject } from './project';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,27 @@
+"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 __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.getWebappPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.FileName = void 0;
+var constants_1 = require("./constants");
+Object.defineProperty(exports, "FileName", { enumerable: true, get: function () { return constants_1.FileName; } });
+var project_1 = require("./project");
+Object.defineProperty(exports, "findAllApps", { enumerable: true, get: function () { return project_1.findAllApps; } });
+Object.defineProperty(exports, "findProjectRoot", { enumerable: true, get: function () { return project_1.findProjectRoot; } });
+Object.defineProperty(exports, "getAppRootFromWebappPath", { enumerable: true, get: function () { return project_1.getAppRootFromWebappPath; } });
+Object.defineProperty(exports, "getCapModelAndServices", { enumerable: true, get: function () { return project_1.getCapModelAndServices; } });
+Object.defineProperty(exports, "getCapProjectType", { enumerable: true, get: function () { return project_1.getCapProjectType; } });
+Object.defineProperty(exports, "getWebappPath", { enumerable: true, get: function () { return project_1.getWebappPath; } });
+Object.defineProperty(exports, "isCapJavaProject", { enumerable: true, get: function () { return project_1.isCapJavaProject; } });
+Object.defineProperty(exports, "isCapNodeJsProject", { enumerable: true, get: function () { return project_1.isCapNodeJsProject; } });
+Object.defineProperty(exports, "loadModuleFromProject", { enumerable: true, get: function () { return project_1.loadModuleFromProject; } });
+__exportStar(require("./types"), exports);
+//# sourceMappingURL=index.js.map

package/dist/project/cap.d.ts

@@ -0,0 +1,42 @@
+import type { CapCustomPaths, CapProjectType, csn, Package } from '../types';
+/**
+ * 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
+ */
+export declare function isCapNodeJsProject(packageJson: Package): boolean;
+/**
+ * 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
+ */
+export declare function isCapJavaProject(projectRoot: string): Promise<boolean>;
+/**
+ * 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
+ */
+export declare function getCapProjectType(projectRoot: string): Promise<CapProjectType | undefined>;
+/**
+ * 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
+ */
+export declare function getCapCustomPaths(capProjectPath: string): Promise<CapCustomPaths>;
+/**
+ * Return the CAP model and all services.
+ *
+ * @param projectRoot - CAP project root where package.json resides
+ */
+export declare function getCapModelAndServices(projectRoot: string): Promise<{
+    model: csn;
+    services: {
+        name: string;
+        urlPath: string;
+    }[];
+}>;
+//# sourceMappingURL=cap.d.ts.map