@sap-ux/project-access 1.8.3 → 1.9.0

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

@@ -48,7 +48,7 @@ export declare function findFilesByExtension(extension: string, root: string, ex
 export declare function findFileUp(fileName: string, startPath: string, fs?: Editor): Promise<string | undefined>;
 /**
  * @description Returns a flat list of all file paths under a directory tree,
- * recursing through all subdirectories
+ * recursing through all subdirectories.
  * @param {string} dir - the directory to walk
  * @returns {string[]} - array of file path strings
  * @throws if an error occurs reading a file path

package/dist/file/file-search.js

@@ -134,7 +134,7 @@ function findFileUp(fileName, startPath, fs) {
 exports.findFileUp = findFileUp;
 /**
  * @description Returns a flat list of all file paths under a directory tree,
- * recursing through all subdirectories
+ * recursing through all subdirectories.
  * @param {string} dir - the directory to walk
  * @returns {string[]} - array of file path strings
  * @throws if an error occurs reading a file path

package/dist/project/cap.d.ts

@@ -35,6 +35,7 @@ export declare function getCapCustomPaths(capProjectPath: string): Promise<CapCu
  * Return the CAP model and all services.
  *
  * @param projectRoot - CAP project root where package.json resides
+ * @returns {*}  {Promise<{ model: csn; services: ServiceInfo[] }>} - CAP Model and Services
  */
 export declare function getCapModelAndServices(projectRoot: string): Promise<{
     model: csn;
@@ -47,5 +48,22 @@ export declare function getCapModelAndServices(projectRoot: string): Promise<{
  * @returns - environment config for CAP project
  */
 export declare function getCapEnvironment(capProjectPath: string): Promise<CdsEnvironment>;
+/**
+ * Get absolute path to a resource.
+ *
+ * @param projectRoot - project root of a CAP project
+ * @param relativeUri - relative resource path.
+ * @returns {string} - absolute path.
+ */
+export declare const toAbsoluteUri: (projectRoot: string, relativeUri: string) => string;
+/**
+ * Converts to referenced uri to be used in using statements.
+ *
+ * @param projectRoot - project root of a CAP project
+ * @param relativeUriFrom - relative uri of from directory
+ * @param relativeUriTo - relative uri of to directory
+ * @returns {Promise<string>} - reference uri
+ */
+export declare const toReferenceUri: (projectRoot: string, relativeUriFrom: string, relativeUriTo: string) => Promise<string>;
 export {};
 //# sourceMappingURL=cap.d.ts.map

package/dist/project/cap.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCapEnvironment = exports.getCapModelAndServices = exports.getCapCustomPaths = exports.getCapProjectType = exports.isCapJavaProject = exports.isCapNodeJsProject = void 0;
+exports.toReferenceUri = exports.toAbsoluteUri = exports.getCapEnvironment = 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");
@@ -95,6 +95,7 @@ exports.getCapCustomPaths = getCapCustomPaths;
  * Return the CAP model and all services.
  *
  * @param projectRoot - CAP project root where package.json resides
+ * @returns {*}  {Promise<{ model: csn; services: ServiceInfo[] }>} - CAP Model and Services
  */
 function getCapModelAndServices(projectRoot) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -128,4 +129,103 @@ function getCapEnvironment(capProjectPath) {
     });
 }
 exports.getCapEnvironment = getCapEnvironment;
+/**
+ * Get absolute path to a resource.
+ *
+ * @param projectRoot - project root of a CAP project
+ * @param relativeUri - relative resource path.
+ * @returns {string} - absolute path.
+ */
+const toAbsoluteUri = (projectRoot, relativeUri) => (0, path_1.join)(projectRoot, relativeUri);
+exports.toAbsoluteUri = toAbsoluteUri;
+/**
+ * Converts to referenced uri to be used in using statements.
+ *
+ * @param projectRoot - project root of a CAP project
+ * @param relativeUriFrom - relative uri of from directory
+ * @param relativeUriTo - relative uri of to directory
+ * @returns {Promise<string>} - reference uri
+ */
+const toReferenceUri = (projectRoot, relativeUriFrom, relativeUriTo) => __awaiter(void 0, void 0, void 0, function* () {
+    let relativeUri = '';
+    const indexNodeModules = relativeUriTo.lastIndexOf('node_modules');
+    if (indexNodeModules >= 0) {
+        // extract module name from fileUri - e.g. '@sap/cds/common' from '../../node_modules/@sap/cds/common.cds'
+        const indexLastDot = relativeUriTo.lastIndexOf('.');
+        if (indexLastDot > indexNodeModules + 13) {
+            relativeUri = relativeUriTo.slice(indexNodeModules + 13, indexLastDot);
+        }
+        else {
+            relativeUri = relativeUriTo.slice(indexNodeModules + 13);
+        }
+    }
+    else if (relativeUriTo.startsWith('../') || relativeUriTo.startsWith('..\\')) {
+        // file outside current project (e.g. mono repo)
+        const result = yield getPackageNameInFolder(projectRoot, relativeUriTo);
+        if (result.packageName) {
+            relativeUri = result.packageName + relativeUriTo.slice(result.packageFolder.length);
+        }
+    }
+    if (!relativeUri) {
+        // build relative path
+        const fromDir = (0, path_1.dirname)((0, exports.toAbsoluteUri)(projectRoot, relativeUriFrom));
+        relativeUri = (0, path_1.relative)(fromDir, (0, exports.toAbsoluteUri)(projectRoot, relativeUriTo));
+        if (!relativeUri.startsWith('.')) {
+            relativeUri = './' + relativeUri;
+        }
+    }
+    // remove file extension
+    const fileExtension = relativeUri.lastIndexOf('.') > 0 ? relativeUri.slice(relativeUri.lastIndexOf('.') + 1) : '';
+    if (['CDS', 'JSON'].includes(fileExtension.toUpperCase())) {
+        relativeUri = relativeUri.slice(0, relativeUri.length - fileExtension.length - 1);
+    }
+    // always use '/' instead of platform specific separator
+    return relativeUri.split(path_1.sep).join('/');
+});
+exports.toReferenceUri = toReferenceUri;
+/**
+ * Gets package name from the folder.
+ *
+ * @param baseUri - base uri of the cap project
+ * @param relativeUri - relative uri to the resource folder
+ * @returns {Promise<{ packageName: string; packageFolder: string }>} - package name and folder
+ */
+function getPackageNameInFolder(baseUri, relativeUri) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const refUriParts = relativeUri.split(path_1.sep);
+        const result = { packageName: '', packageFolder: relativeUri };
+        for (let i = refUriParts.length - 1; i >= 0 && !result.packageName; i--) {
+            const currentFolder = refUriParts.slice(0, i).join(path_1.sep);
+            result.packageName = yield readPackageNameForFolder(baseUri, currentFolder);
+            if (result.packageName) {
+                result.packageFolder = currentFolder;
+            }
+        }
+        return result;
+    });
+}
+/**
+ * Reads package name from package json of the folder.
+ *
+ * @param baseUri - base uri of the cap project
+ * @param relativeUri - relative uri to the resource folder
+ * @returns {Promise<string>} - package name
+ */
+function readPackageNameForFolder(baseUri, relativeUri) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let packageName = '';
+        try {
+            const path = (0, path_1.normalize)(baseUri + '/' + relativeUri + '/' + 'package.json');
+            const content = yield (0, file_1.readFile)(path);
+            if (content) {
+                const parsed = JSON.parse(content);
+                packageName = parsed.name;
+            }
+        }
+        catch (e) {
+            packageName = '';
+        }
+        return packageName;
+    });
+}
 //# sourceMappingURL=cap.js.map

package/dist/project/search.d.ts

@@ -5,6 +5,7 @@ import type { AllAppResults, FioriArtifactTypes, FoundFioriArtifacts, WorkspaceF
  * @param path path of a project file
  * @param sapuxRequired if true, only find sapux projects
  * @param silent if true, then does not throw an error but returns an empty path
+ * @returns {*}  {Promise<string>} - Project Root
  */
 export declare function findProjectRoot(path: string, sapuxRequired?: boolean, silent?: boolean): Promise<string>;
 /**

package/dist/project/search.js

@@ -69,6 +69,7 @@ function wsFoldersToRootPaths(wsFolders) {
  * @param path path of a project file
  * @param sapuxRequired if true, only find sapux projects
  * @param silent if true, then does not throw an error but returns an empty path
+ * @returns {*}  {Promise<string>} - Project Root
  */
 function findProjectRoot(path, sapuxRequired = true, silent = false) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -93,7 +94,6 @@ 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.8.3",
+  "version": "1.9.0",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",
@@ -27,7 +27,7 @@
     "findit2": "2.2.3",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
-    "@sap-ux/ui5-config": "0.18.1"
+    "@sap-ux/ui5-config": "0.18.2"
   },
   "devDependencies": {
     "@types/mem-fs": "1.1.2",
@@ -37,7 +37,7 @@
   },
   "scripts": {
     "build": "tsc --build",
-    "clean": "rimraf dist coverage *.tsbuildinfo",
+    "clean": "rimraf --glob dist coverage *.tsbuildinfo",
     "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",