@sap-ux/project-access 1.10.2 → 1.11.1

package/dist/constants.d.ts

@@ -3,6 +3,7 @@ export declare const FileName: {
     readonly ExtConfigJson: ".extconfig.json";
     readonly Manifest: "manifest.json";
     readonly ManifestAppDescrVar: "manifest.appdescr_variant";
+    readonly MtaYaml: "mta.yaml";
     readonly Package: "package.json";
     readonly Tsconfig: "tsconfig.json";
     readonly Ui5Yaml: "ui5.yaml";

package/dist/constants.js

@@ -6,6 +6,7 @@ exports.FileName = {
     ExtConfigJson: '.extconfig.json',
     Manifest: 'manifest.json',
     ManifestAppDescrVar: 'manifest.appdescr_variant',
+    MtaYaml: 'mta.yaml',
     Package: 'package.json',
     Tsconfig: 'tsconfig.json',
     Ui5Yaml: 'ui5.yaml',

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { FileName } from './constants';
-export { findAllApps, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml } from './project';
+export { findAllApps, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getMtaPath, getNodeModulesPath, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml } from './project';
 export { getFilePaths } from './file';
 export * from './types';
 //# 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.getFilePaths = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findAllApps = exports.FileName = void 0;
+exports.getFilePaths = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getNodeModulesPath = exports.getMtaPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = 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");
@@ -27,6 +27,8 @@ Object.defineProperty(exports, "getCapCustomPaths", { enumerable: true, get: fun
 Object.defineProperty(exports, "getCapEnvironment", { enumerable: true, get: function () { return project_1.getCapEnvironment; } });
 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, "getMtaPath", { enumerable: true, get: function () { return project_1.getMtaPath; } });
+Object.defineProperty(exports, "getNodeModulesPath", { enumerable: true, get: function () { return project_1.getNodeModulesPath; } });
 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; } });

package/dist/project/dependencies.d.ts

@@ -7,4 +7,14 @@ import type { Package } from '../types';
  * @returns - true: has dependency; false: no dependency
  */
 export declare const hasDependency: (packageJson: Package, dependency: string) => boolean;
+/**
+ * Returns path to folder that hosts 'node_modules' used by project.
+ * Optionally, a module name can be passed to check for. This is
+ * useful to check if a module is hoisted in a mono repository.
+ *
+ * @param projectRoot - absolute path to root of the project/app.
+ * @param [module] -  optional module name to find in node_modules
+ * @returns - parent path of node_modules used by project or undefined if node module path was not found
+ */
+export declare function getNodeModulesPath(projectRoot: string, module?: string): string | undefined;
 //# sourceMappingURL=dependencies.d.ts.map

package/dist/project/dependencies.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasDependency = void 0;
+exports.getNodeModulesPath = exports.hasDependency = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const constants_1 = require("../constants");
 /**
  * Helper to check for dependency/devDependency.
  *
@@ -10,4 +13,34 @@ exports.hasDependency = void 0;
  */
 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;
+/**
+ * Returns path to folder that hosts 'node_modules' used by project.
+ * Optionally, a module name can be passed to check for. This is
+ * useful to check if a module is hoisted in a mono repository.
+ *
+ * @param projectRoot - absolute path to root of the project/app.
+ * @param [module] -  optional module name to find in node_modules
+ * @returns - parent path of node_modules used by project or undefined if node module path was not found
+ */
+function getNodeModulesPath(projectRoot, module) {
+    if (!(0, path_1.isAbsolute)(projectRoot)) {
+        return undefined;
+    }
+    const { root } = (0, path_1.parse)(projectRoot);
+    let currentDir = projectRoot;
+    let modulesPath;
+    while (currentDir !== root) {
+        let checkPath = (0, path_1.join)(currentDir, 'node_modules');
+        if (module) {
+            checkPath = (0, path_1.join)(checkPath, module, constants_1.FileName.Package);
+        }
+        if ((0, fs_1.existsSync)(checkPath)) {
+            modulesPath = currentDir;
+            break;
+        }
+        currentDir = (0, path_1.dirname)(currentDir);
+    }
+    return modulesPath;
+}
+exports.getNodeModulesPath = getNodeModulesPath;
 //# sourceMappingURL=dependencies.js.map

package/dist/project/index.d.ts

@@ -1,6 +1,8 @@
 export { getCapCustomPaths, getCapModelAndServices, getCapProjectType, isCapJavaProject, isCapNodeJsProject, getCapEnvironment, readCapServiceMetadataEdmx } from './cap';
+export { getNodeModulesPath } from './dependencies';
 export { getAppProgrammingLanguage } from './info';
 export { loadModuleFromProject } from './module-loader';
 export { findAllApps, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath } from './search';
 export { getWebappPath, readUi5Yaml } from './ui5-config';
+export { getMtaPath } from './mta';
 //# sourceMappingURL=index.d.ts.map

package/dist/project/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapCustomPaths = void 0;
+exports.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = exports.getNodeModulesPath = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = 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; } });
@@ -9,6 +9,8 @@ Object.defineProperty(exports, "isCapJavaProject", { enumerable: true, get: func
 Object.defineProperty(exports, "isCapNodeJsProject", { enumerable: true, get: function () { return cap_1.isCapNodeJsProject; } });
 Object.defineProperty(exports, "getCapEnvironment", { enumerable: true, get: function () { return cap_1.getCapEnvironment; } });
 Object.defineProperty(exports, "readCapServiceMetadataEdmx", { enumerable: true, get: function () { return cap_1.readCapServiceMetadataEdmx; } });
+var dependencies_1 = require("./dependencies");
+Object.defineProperty(exports, "getNodeModulesPath", { enumerable: true, get: function () { return dependencies_1.getNodeModulesPath; } });
 var info_1 = require("./info");
 Object.defineProperty(exports, "getAppProgrammingLanguage", { enumerable: true, get: function () { return info_1.getAppProgrammingLanguage; } });
 var module_loader_1 = require("./module-loader");
@@ -21,4 +23,6 @@ Object.defineProperty(exports, "getAppRootFromWebappPath", { enumerable: true, g
 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; } });
+var mta_1 = require("./mta");
+Object.defineProperty(exports, "getMtaPath", { enumerable: true, get: function () { return mta_1.getMtaPath; } });
 //# sourceMappingURL=index.js.map

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

@@ -1,8 +1,14 @@
 /**
  * Load module from project or app. Throws error if module is not installed.
  *
+ * Note: Node's require.resolve() caches file access results in internal statCache, see:
+ * (https://github.com/nodejs/node/blob/d150316a8ecad1a9c20615ae62fcaf4f8d060dcc/lib/internal/modules/cjs/loader.js#L155)
+ * This means, if a module is not installed and require.resolve() is executed, it will never resolve, even after the
+ * module is installed later on. To prevent filling cjs loader's statCache with entries for non existing files,
+ * we check if the module exists using getNodeModulesPath() before require.resolve().
+ *
  * @param projectRoot - root path of the project/app.
- * @param moduleName - name of the npm module.
+ * @param moduleName - name of the node module.
  * @returns - loaded module.
  */
 export declare function loadModuleFromProject<T>(projectRoot: string, moduleName: string): Promise<T>;

package/dist/project/module-loader.js

@@ -33,11 +33,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadModuleFromProject = void 0;
+const dependencies_1 = require("./dependencies");
 /**
  * Load module from project or app. Throws error if module is not installed.
  *
+ * Note: Node's require.resolve() caches file access results in internal statCache, see:
+ * (https://github.com/nodejs/node/blob/d150316a8ecad1a9c20615ae62fcaf4f8d060dcc/lib/internal/modules/cjs/loader.js#L155)
+ * This means, if a module is not installed and require.resolve() is executed, it will never resolve, even after the
+ * module is installed later on. To prevent filling cjs loader's statCache with entries for non existing files,
+ * we check if the module exists using getNodeModulesPath() before require.resolve().
+ *
  * @param projectRoot - root path of the project/app.
- * @param moduleName - name of the npm module.
+ * @param moduleName - name of the node module.
  * @returns - loaded module.
  */
 function loadModuleFromProject(projectRoot, moduleName) {
@@ -45,11 +52,14 @@ function loadModuleFromProject(projectRoot, moduleName) {
         var _a;
         let module;
         try {
+            if (!(0, dependencies_1.getNodeModulesPath)(projectRoot, moduleName)) {
+                throw Error('Path to module not found.');
+            }
             const modulePath = require.resolve(moduleName, { paths: [projectRoot] });
             module = (yield (_a = modulePath, Promise.resolve().then(() => __importStar(require(_a)))));
         }
         catch (error) {
-            throw Error(`Module '${moduleName}' not installed in project '${projectRoot}'`);
+            throw Error(`Module '${moduleName}' not installed in project '${projectRoot}'.\n${error.toString()}`);
         }
         return module;
     });

package/dist/project/mta.d.ts

@@ -0,0 +1,15 @@
+import type { Editor } from 'mem-fs-editor';
+import type { MtaPath } from '../types/mta';
+/**
+ * Searches `projectPath` and parent folders.
+ * If mta.yaml file is inside projectPath, this is a special type of MTA project
+ * that created in Fiori generator (Standalone App Router). E.g. Creating a new project that doesn't have
+ * a parent root folder for MTA project, and this project itself is configured
+ * to have deploy target CF and user answered yes to "add to Managed App Router" question.
+ *
+ * @param projectPath - Fiori app root folder
+ * @param fs - optional mem-fs-editor instance
+ * @returns - MtaPath
+ */
+export declare function getMtaPath(projectPath: string, fs?: Editor): Promise<MtaPath | undefined>;
+//# sourceMappingURL=mta.d.ts.map

package/dist/project/mta.js

@@ -0,0 +1,43 @@
+"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.getMtaPath = void 0;
+const file_search_1 = require("../file/file-search");
+const constants_1 = require("../constants");
+const path_1 = require("path");
+/**
+ * Searches `projectPath` and parent folders.
+ * If mta.yaml file is inside projectPath, this is a special type of MTA project
+ * that created in Fiori generator (Standalone App Router). E.g. Creating a new project that doesn't have
+ * a parent root folder for MTA project, and this project itself is configured
+ * to have deploy target CF and user answered yes to "add to Managed App Router" question.
+ *
+ * @param projectPath - Fiori app root folder
+ * @param fs - optional mem-fs-editor instance
+ * @returns - MtaPath
+ */
+function getMtaPath(projectPath, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const mtaPath = yield (0, file_search_1.findFileUp)(constants_1.FileName.MtaYaml, projectPath, fs);
+        if (!mtaPath) {
+            return undefined;
+        }
+        else {
+            const mtaFolderPath = (0, path_1.dirname)(mtaPath);
+            return {
+                mtaPath,
+                hasRoot: mtaFolderPath !== projectPath
+            };
+        }
+    });
+}
+exports.getMtaPath = getMtaPath;
+//# sourceMappingURL=mta.js.map

package/dist/types/mta/index.d.ts

@@ -0,0 +1,5 @@
+export interface MtaPath {
+    mtaPath: string;
+    hasRoot: boolean;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/mta/index.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=index.js.map

package/package.json

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