@sap-ux/project-access 1.15.4 → 1.16.0

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { FileName } from './constants';
-export { findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getMtaPath, getNodeModulesPath, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml } from './project';
+export { findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getMtaPath, getNodeModulesPath, getProjectType, 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.getNodeModulesPath = exports.getMtaPath = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.FileName = void 0;
+exports.getFilePaths = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getProjectType = exports.getNodeModulesPath = exports.getMtaPath = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppType = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = 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");
@@ -24,6 +24,7 @@ Object.defineProperty(exports, "findFioriArtifacts", { enumerable: true, get: fu
 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, "getAppProgrammingLanguage", { enumerable: true, get: function () { return project_1.getAppProgrammingLanguage; } });
+Object.defineProperty(exports, "getAppType", { enumerable: true, get: function () { return project_1.getAppType; } });
 Object.defineProperty(exports, "getCapCustomPaths", { enumerable: true, get: function () { return project_1.getCapCustomPaths; } });
 Object.defineProperty(exports, "getCapEnvironment", { enumerable: true, get: function () { return project_1.getCapEnvironment; } });
 Object.defineProperty(exports, "getCapModelAndServices", { enumerable: true, get: function () { return project_1.getCapModelAndServices; } });
@@ -33,6 +34,7 @@ Object.defineProperty(exports, "getCdsRoots", { enumerable: true, get: function
 Object.defineProperty(exports, "getCdsServices", { enumerable: true, get: function () { return project_1.getCdsServices; } });
 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, "getProjectType", { enumerable: true, get: function () { return project_1.getProjectType; } });
 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/index.d.ts

@@ -1,6 +1,6 @@
 export { getCapCustomPaths, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, isCapJavaProject, isCapNodeJsProject, getCapEnvironment, readCapServiceMetadataEdmx } from './cap';
 export { getNodeModulesPath } from './dependencies';
-export { getAppProgrammingLanguage } from './info';
+export { getAppProgrammingLanguage, getAppType, getProjectType } from './info';
 export { loadModuleFromProject } from './module-loader';
 export { findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath } from './search';
 export { getWebappPath, readUi5Yaml } from './ui5-config';

package/dist/project/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = exports.getNodeModulesPath = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapCustomPaths = void 0;
+exports.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.loadModuleFromProject = exports.getProjectType = exports.getAppType = exports.getAppProgrammingLanguage = exports.getNodeModulesPath = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = 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; } });
@@ -16,6 +16,8 @@ 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; } });
+Object.defineProperty(exports, "getAppType", { enumerable: true, get: function () { return info_1.getAppType; } });
+Object.defineProperty(exports, "getProjectType", { enumerable: true, get: function () { return info_1.getProjectType; } });
 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");

package/dist/project/info.d.ts

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { AppProgrammingLanguage } from '../types';
+import type { AppProgrammingLanguage, AppType, ProjectType } from '../types';
 /**
  * Get the used programming language of an application.
  *
@@ -8,4 +8,18 @@ import type { AppProgrammingLanguage } from '../types';
  * @returns - used language, JavaScript or TypeScript
  */
 export declare function getAppProgrammingLanguage(appRoot: string, memFs?: Editor): Promise<AppProgrammingLanguage>;
+/**
+ * Get the type of application or Fiori artifact.
+ *
+ * @param appRoot - path to application root
+ * @returns - type of application, e.g. SAP Fiori elements, SAPUI5 freestyle, SAPUI5 Extension, ... see AppType.
+ */
+export declare function getAppType(appRoot: string): Promise<AppType | undefined>;
+/**
+ * Returns the project type for a given Fiori project.
+ *
+ * @param projectRoot - root path of the project
+ * @returns - project type like Edmx, CAPJava, CAPNodejs
+ */
+export declare function getProjectType(projectRoot: string): Promise<ProjectType>;
 //# sourceMappingURL=info.d.ts.map

package/dist/project/info.js

@@ -9,11 +9,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAppProgrammingLanguage = void 0;
+exports.getProjectType = exports.getAppType = exports.getAppProgrammingLanguage = void 0;
 const path_1 = require("path");
 const constants_1 = require("../constants");
 const file_1 = require("../file");
+const cap_1 = require("./cap");
 const ui5_config_1 = require("./ui5-config");
+const search_1 = require("./search");
 /**
  * Get the used programming language of an application.
  *
@@ -44,4 +46,84 @@ function getAppProgrammingLanguage(appRoot, memFs) {
     });
 }
 exports.getAppProgrammingLanguage = getAppProgrammingLanguage;
+/**
+ * Get the type of application or Fiori artifact.
+ *
+ * @param appRoot - path to application root
+ * @returns - type of application, e.g. SAP Fiori elements, SAPUI5 freestyle, SAPUI5 Extension, ... see AppType.
+ */
+function getAppType(appRoot) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+    return __awaiter(this, void 0, void 0, function* () {
+        let appType;
+        try {
+            const artifacts = yield (0, search_1.findFioriArtifacts)({
+                wsFolders: [appRoot],
+                artifacts: ['adaptations', 'applications', 'extensions', 'libraries']
+            });
+            if (((_b = (_a = artifacts.applications) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) +
+                ((_d = (_c = artifacts.adaptations) === null || _c === void 0 ? void 0 : _c.length) !== null && _d !== void 0 ? _d : 0) +
+                ((_f = (_e = artifacts.extensions) === null || _e === void 0 ? void 0 : _e.length) !== null && _f !== void 0 ? _f : 0) +
+                ((_h = (_g = artifacts.libraries) === null || _g === void 0 ? void 0 : _g.length) !== null && _h !== void 0 ? _h : 0) ===
+                1) {
+                if (((_j = artifacts.applications) === null || _j === void 0 ? void 0 : _j.length) === 1) {
+                    appType = yield getApplicationType(artifacts.applications[0]);
+                }
+                else if (((_k = artifacts.adaptations) === null || _k === void 0 ? void 0 : _k.length) === 1) {
+                    appType = 'Fiori Adaptation';
+                }
+                else if (((_l = artifacts.extensions) === null || _l === void 0 ? void 0 : _l.length) === 1) {
+                    appType = 'SAPUI5 Extension';
+                }
+                else if (((_m = artifacts.libraries) === null || _m === void 0 ? void 0 : _m.length) === 1) {
+                    appType = 'Fiori Reuse';
+                }
+            }
+        }
+        catch (_o) {
+            // If error occurs we can't determine the type and return undefined
+        }
+        return appType;
+    });
+}
+exports.getAppType = getAppType;
+/**
+ * Get the application type from search results.
+ *
+ * @param application - application from findFioriArtifacts() results
+ * @returns - type of application: 'SAP Fiori elements' or 'SAPUI5 freestyle'
+ */
+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));
+        if (application.projectRoot === application.appRoot) {
+            appType = packageJson.sapux ? 'SAP Fiori elements' : 'SAPUI5 freestyle';
+        }
+        else {
+            appType =
+                Array.isArray(packageJson.sapux) &&
+                    packageJson.sapux.find((relAppPath) => (0, path_1.join)(application.projectRoot, ...relAppPath.split(/[/\\]/)) === application.appRoot)
+                    ? 'SAP Fiori elements'
+                    : 'SAPUI5 freestyle';
+        }
+        return appType;
+    });
+}
+/**
+ * Returns the project type for a given Fiori project.
+ *
+ * @param projectRoot - root path of the project
+ * @returns - project type like Edmx, CAPJava, CAPNodejs
+ */
+function getProjectType(projectRoot) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const capType = yield (0, cap_1.getCapProjectType)(projectRoot);
+        if (capType === undefined) {
+            return 'EDMXBackend';
+        }
+        return capType;
+    });
+}
+exports.getProjectType = getProjectType;
 //# sourceMappingURL=info.js.map

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

@@ -11,9 +11,9 @@ export declare function getWebappPath(projectRoot: string, memFs?: Editor): Prom
 /**
  * Checks if UI5 config yaml file exists and returns its content.
  *
- * @param basePath - path to project root
+ * @param projectRoot - path to project root
  * @param fileName - name of yaml file to be read
  * @returns {UI5Config} UI5 config file in yaml format
  */
-export declare function readUi5Yaml(basePath: string, fileName: string): Promise<UI5Config>;
+export declare function readUi5Yaml(projectRoot: string, fileName: string): Promise<UI5Config>;
 //# sourceMappingURL=ui5-config.d.ts.map

package/dist/project/ui5-config.js

@@ -41,18 +41,18 @@ exports.getWebappPath = getWebappPath;
 /**
  * Checks if UI5 config yaml file exists and returns its content.
  *
- * @param basePath - path to project root
+ * @param projectRoot - path to project root
  * @param fileName - name of yaml file to be read
  * @returns {UI5Config} UI5 config file in yaml format
  */
-function readUi5Yaml(basePath, fileName) {
+function readUi5Yaml(projectRoot, fileName) {
     return __awaiter(this, void 0, void 0, function* () {
-        const ui5YamlPath = (0, path_1.join)(basePath, fileName);
+        const ui5YamlPath = (0, path_1.join)(projectRoot, fileName);
         if (yield (0, file_1.fileExists)(ui5YamlPath)) {
             const yamlString = yield (0, file_1.readFile)(ui5YamlPath);
             return yield ui5_config_1.UI5Config.newInstance(yamlString);
         }
-        throw Error(`File '${fileName}' not found in project '${basePath}'`);
+        throw Error(`File '${fileName}' not found in project '${projectRoot}'`);
     });
 }
 exports.readUi5Yaml = readUi5Yaml;

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

@@ -1,2 +1,5 @@
+import type { CapProjectType } from '../cap';
 export type AppProgrammingLanguage = 'JavaScript' | 'TypeScript' | '';
+export type ProjectType = 'EDMXBackend' | CapProjectType;
+export type AppType = 'SAP Fiori elements' | 'SAPUI5 freestyle' | 'SAPUI5 Extension' | 'Fiori Reuse' | 'Fiori Adaptation';
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.15.4",
+  "version": "1.16.0",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",
@@ -32,7 +32,7 @@
   "devDependencies": {
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
-    "@ui5/manifest": "1.59.0",
+    "@ui5/manifest": "1.61.0",
     "vscode-uri": "3.0.7"
   },
   "scripts": {