@sap-ux/project-access 1.38.0 → 2.0.0

package/dist/project/info.js

@@ -1,22 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProject = getProject;
-exports.getAppProgrammingLanguage = getAppProgrammingLanguage;
-exports.getAppType = getAppType;
-exports.getProjectType = getProjectType;
-exports.getMinUI5VersionFromManifest = getMinUI5VersionFromManifest;
-exports.getMinUI5VersionAsArray = getMinUI5VersionAsArray;
-exports.getMinimumUI5Version = getMinimumUI5Version;
-const node_path_1 = require("node:path");
-const constants_1 = require("../constants");
-const file_1 = require("../file");
-const cap_1 = require("./cap");
-const i18n_1 = require("./i18n/i18n");
-const search_1 = require("./search");
-const service_1 = require("./service");
-const ui5_config_1 = require("./ui5-config");
-const semver_1 = require("semver");
-const path_1 = require("../path");
+import { join, relative } from 'node:path';
+import { DirName, FileName } from '../constants.js';
+import { fileExists, findFilesByExtension, readJSON } from '../file/index.js';
+import { getCapCustomPaths, getCapProjectType } from './cap.js';
+import { getI18nPropertiesPaths } from './i18n/i18n.js';
+import { findAllApps, findFioriArtifacts } from './search.js';
+import { getMainService, getServicesAndAnnotations } from './service.js';
+import { getWebappPath } from './ui5-config.js';
+import { gte, valid } from 'semver';
+import { normalizePath } from '../path/index.js';
 /**
  * Returns the project structure for a given Fiori project.
  *
@@ -24,17 +15,17 @@ const path_1 = require("../path");
  * @param memFs - optional mem-fs-editor instance
  * @returns - project structure with project info like project type, apps, root folder
  */
-async function getProject(root, memFs) {
-    if (!(await (0, file_1.fileExists)((0, node_path_1.join)(root, constants_1.FileName.Package), memFs))) {
+export async function getProject(root, memFs) {
+    if (!(await fileExists(join(root, FileName.Package), memFs))) {
         throw new Error(`The project root folder '${root}' is not a Fiori project. No 'package.json' found.`);
     }
-    const capProjectType = await (0, cap_1.getCapProjectType)(root);
+    const capProjectType = await getCapProjectType(root);
     const projectType = capProjectType ?? 'EDMXBackend';
-    const capCustomPaths = projectType === 'EDMXBackend' ? undefined : await (0, cap_1.getCapCustomPaths)(root);
+    const capCustomPaths = projectType === 'EDMXBackend' ? undefined : await getCapCustomPaths(root);
     const appFolders = await getAppFolders(root, memFs);
     const apps = await getApps(root, appFolders, memFs);
     return {
-        root: (0, path_1.normalizePath)(root),
+        root: normalizePath(root),
         projectType,
         apps,
         capCustomPaths
@@ -50,8 +41,8 @@ async function getProject(root, memFs) {
  * @returns - array of operating specific application folders
  */
 async function getAppFolders(root, memFs) {
-    const apps = await (0, search_1.findAllApps)([root], memFs);
-    return apps.length > 0 ? apps.map((app) => (0, node_path_1.relative)(root, app.appRoot)) : [''];
+    const apps = await findAllApps([root], memFs);
+    return apps.length > 0 ? apps.map((app) => relative(root, app.appRoot)) : [''];
 }
 /**
  * Get the application structure for each application in the project.
@@ -80,18 +71,18 @@ async function getApps(root, appFolders, memFs) {
  * @returns - application structure with application info like manifest, changes, main service, services, annotations
  */
 async function getApplicationStructure(root, appFolder, memFs) {
-    const appRoot = (0, node_path_1.join)(root, appFolder);
-    const absoluteWebappPath = await (0, ui5_config_1.getWebappPath)(appRoot, memFs);
+    const appRoot = join(root, appFolder);
+    const absoluteWebappPath = await getWebappPath(appRoot, memFs);
     const appType = (await getAppType(appRoot, memFs));
-    const manifest = (0, node_path_1.join)(absoluteWebappPath, constants_1.FileName.Manifest);
-    if (!(await (0, file_1.fileExists)(manifest, memFs))) {
+    const manifest = join(absoluteWebappPath, FileName.Manifest);
+    if (!(await fileExists(manifest, memFs))) {
         return undefined;
     }
-    const manifestObject = await (0, file_1.readJSON)(manifest, memFs);
-    const changes = (0, node_path_1.join)(absoluteWebappPath, constants_1.DirName.Changes);
-    const i18n = await (0, i18n_1.getI18nPropertiesPaths)(manifest, manifestObject, memFs);
-    const mainService = (0, service_1.getMainService)(manifestObject);
-    const services = await (0, service_1.getServicesAndAnnotations)(manifest, manifestObject, memFs);
+    const manifestObject = await readJSON(manifest, memFs);
+    const changes = join(absoluteWebappPath, DirName.Changes);
+    const i18n = await getI18nPropertiesPaths(manifest, manifestObject, memFs);
+    const mainService = getMainService(manifestObject);
+    const services = await getServicesAndAnnotations(manifest, manifestObject, memFs);
     return {
         appRoot,
         appType,
@@ -109,17 +100,17 @@ async function getApplicationStructure(root, appFolder, memFs) {
  * @param [memFs] - optional mem-fs editor instance
  * @returns - used language, JavaScript or TypeScript
  */
-async function getAppProgrammingLanguage(appRoot, memFs) {
+export async function getAppProgrammingLanguage(appRoot, memFs) {
     const ignoreFolders = ['node_modules', '.git'];
     let appLanguage = '';
     try {
-        const webappPath = await (0, ui5_config_1.getWebappPath)(appRoot, memFs);
-        if (await (0, file_1.fileExists)(webappPath, memFs)) {
-            if ((await (0, file_1.fileExists)((0, node_path_1.join)(appRoot, constants_1.FileName.Tsconfig), memFs)) &&
-                (await (0, file_1.findFilesByExtension)('.ts', webappPath, ignoreFolders, memFs)).length > 0) {
+        const webappPath = await getWebappPath(appRoot, memFs);
+        if (await fileExists(webappPath, memFs)) {
+            if ((await fileExists(join(appRoot, FileName.Tsconfig), memFs)) &&
+                (await findFilesByExtension('.ts', webappPath, ignoreFolders, memFs)).length > 0) {
                 appLanguage = 'TypeScript';
             }
-            else if ((await (0, file_1.findFilesByExtension)('.js', webappPath, ignoreFolders, memFs)).length > 0) {
+            else if ((await findFilesByExtension('.js', webappPath, ignoreFolders, memFs)).length > 0) {
                 appLanguage = 'JavaScript';
             }
         }
@@ -136,10 +127,10 @@ async function getAppProgrammingLanguage(appRoot, memFs) {
  * @param memFs - optional mem-fs-editor instance
  * @returns - type of application, e.g. SAP Fiori elements, SAPUI5 freestyle, SAPUI5 Extension, ... see AppType.
  */
-async function getAppType(appRoot, memFs) {
+export async function getAppType(appRoot, memFs) {
     let appType;
     try {
-        const artifacts = await (0, search_1.findFioriArtifacts)({
+        const artifacts = await findFioriArtifacts({
             wsFolders: [appRoot],
             artifacts: ['adaptations', 'applications', 'extensions', 'libraries'],
             memFs
@@ -177,9 +168,9 @@ async function getAppType(appRoot, memFs) {
  */
 async function getApplicationType(application, memFs) {
     let appType;
-    const rootPackageJsonPath = (0, node_path_1.join)(application.projectRoot, constants_1.FileName.Package);
-    const packageJson = (await (0, file_1.fileExists)(rootPackageJsonPath, memFs))
-        ? await (0, file_1.readJSON)(rootPackageJsonPath, memFs)
+    const rootPackageJsonPath = join(application.projectRoot, FileName.Package);
+    const packageJson = (await fileExists(rootPackageJsonPath, memFs))
+        ? await readJSON(rootPackageJsonPath, memFs)
         : null;
     if (application.projectRoot === application.appRoot) {
         appType = packageJson?.sapux ? 'SAP Fiori elements' : 'SAPUI5 freestyle';
@@ -187,7 +178,7 @@ async function getApplicationType(application, memFs) {
     else if (packageJson) {
         appType =
             Array.isArray(packageJson.sapux) &&
-                packageJson.sapux.find((relAppPath) => (0, node_path_1.join)(application.projectRoot, ...relAppPath.split(/[/\\]/)) === application.appRoot)
+                packageJson.sapux.find((relAppPath) => join(application.projectRoot, ...relAppPath.split(/[/\\]/)) === application.appRoot)
                 ? 'SAP Fiori elements'
                 : 'SAPUI5 freestyle';
     }
@@ -202,8 +193,8 @@ async function getApplicationType(application, memFs) {
  * @param projectRoot - root path of the project
  * @returns - project type like Edmx, CAPJava, CAPNodejs
  */
-async function getProjectType(projectRoot) {
-    const capType = await (0, cap_1.getCapProjectType)(projectRoot);
+export async function getProjectType(projectRoot) {
+    const capType = await getCapProjectType(projectRoot);
     if (capType === undefined) {
         return 'EDMXBackend';
     }
@@ -215,7 +206,7 @@ async function getProjectType(projectRoot) {
  * @param manifest - manifest object
  * @returns minUI5Version, if present
  */
-function getMinUI5VersionFromManifest(manifest) {
+export function getMinUI5VersionFromManifest(manifest) {
     const dependencies = manifest['sap.ui5']?.dependencies;
     if (dependencies) {
         return dependencies.minUI5Version;
@@ -229,13 +220,13 @@ function getMinUI5VersionFromManifest(manifest) {
  * @param noValidation - disables the semver validation
  * @returns minUI5Version, as an array of strings
  */
-function getMinUI5VersionAsArray(manifest, noValidation = false) {
+export function getMinUI5VersionAsArray(manifest, noValidation = false) {
     const result = [];
     const minUI5Version = getMinUI5VersionFromManifest(manifest);
     if (minUI5Version) {
         const minUI5VersionArray = Array.isArray(minUI5Version) ? minUI5Version : [minUI5Version];
         minUI5VersionArray.forEach((version) => {
-            if (noValidation || (0, semver_1.valid)(version)) {
+            if (noValidation || valid(version)) {
                 result.push(version);
             }
         });
@@ -249,12 +240,12 @@ function getMinUI5VersionAsArray(manifest, noValidation = false) {
  * @param manifest - manifest object
  * @returns the minimum version as string
  */
-function getMinimumUI5Version(manifest) {
+export function getMinimumUI5Version(manifest) {
     let result;
     const validVersionsArray = getMinUI5VersionAsArray(manifest);
     if (validVersionsArray.length > 0) {
         validVersionsArray.forEach((version) => {
-            if (!result || (0, semver_1.gte)(result, version)) {
+            if (!result || gte(result, version)) {
                 result = version;
             }
         });

package/dist/project/module-loader.js

@@ -1,48 +1,11 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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 () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getModulePath = getModulePath;
-exports.loadModuleFromProject = loadModuleFromProject;
-exports.getModule = getModule;
-exports.deleteModule = deleteModule;
-const node_fs_1 = require("node:fs");
-const promises_1 = require("node:fs/promises");
-const node_path_1 = require("node:path");
-const dependencies_1 = require("./dependencies");
-const constants_1 = require("../constants");
-const command_1 = require("../command");
+import { existsSync } from 'node:fs';
+import { mkdir, rm } from 'node:fs/promises';
+import { join } from 'node:path';
+import { createRequire } from 'node:module';
+import { getNodeModulesPath } from './dependencies.js';
+import { FileName, moduleCacheRoot } from '../constants.js';
+import { execNpmCommand } from '../command/index.js';
+const require = createRequire(import.meta.url);
 /**
  * Get the module path from project or app. Throws error if module is not installed.
  *
@@ -50,8 +13,8 @@ const command_1 = require("../command");
  * @param moduleName - name of the node module.
  * @returns - path to module.
  */
-async function getModulePath(projectRoot, moduleName) {
-    if (!(0, dependencies_1.getNodeModulesPath)(projectRoot, moduleName)) {
+export async function getModulePath(projectRoot, moduleName) {
+    if (!getNodeModulesPath(projectRoot, moduleName)) {
         throw Error('Path to module not found.');
     }
     return require.resolve(moduleName, { paths: [projectRoot] });
@@ -69,11 +32,11 @@ async function getModulePath(projectRoot, moduleName) {
  * @param moduleName - name of the node module.
  * @returns - loaded module.
  */
-async function loadModuleFromProject(projectRoot, moduleName) {
+export async function loadModuleFromProject(projectRoot, moduleName) {
     let module;
     try {
         const modulePath = await getModulePath(projectRoot, moduleName);
-        module = (await Promise.resolve(`${modulePath}`).then(s => __importStar(require(s))));
+        module = (await import(modulePath));
     }
     catch (error) {
         throw Error(`Module '${moduleName}' not installed in project '${projectRoot}'.\n${error.toString()}`);
@@ -89,17 +52,17 @@ async function loadModuleFromProject(projectRoot, moduleName) {
  * @param options.logger - optional logger instance
  * @returns - module
  */
-async function getModule(module, version, options) {
+export async function getModule(module, version, options) {
     const logger = options?.logger;
-    const moduleDirectory = (0, node_path_1.join)(constants_1.moduleCacheRoot, module, version);
-    const modulePackagePath = (0, node_path_1.join)(moduleDirectory, constants_1.FileName.Package);
+    const moduleDirectory = join(moduleCacheRoot, module, version);
+    const modulePackagePath = join(moduleDirectory, FileName.Package);
     const installCommand = ['install', '--prefix', moduleDirectory, `${module}@${version}`];
-    if (!(0, node_fs_1.existsSync)(modulePackagePath)) {
-        if ((0, node_fs_1.existsSync)(moduleDirectory)) {
-            await (0, promises_1.rm)(moduleDirectory, { recursive: true });
+    if (!existsSync(modulePackagePath)) {
+        if (existsSync(moduleDirectory)) {
+            await rm(moduleDirectory, { recursive: true });
         }
-        await (0, promises_1.mkdir)(moduleDirectory, { recursive: true });
-        await (0, command_1.execNpmCommand)(installCommand, {
+        await mkdir(moduleDirectory, { recursive: true });
+        await execNpmCommand(installCommand, {
             cwd: moduleDirectory,
             logger
         });
@@ -110,11 +73,11 @@ async function getModule(module, version, options) {
     }
     catch (e) {
         logger?.error(`Failed to load module: ${module}. Attempting to fix installation.`);
-        const modulePackageLockPath = (0, node_path_1.join)(moduleDirectory, constants_1.FileName.PackageLock);
+        const modulePackageLockPath = join(moduleDirectory, FileName.PackageLock);
         // If 'package-lock.json' file exists then use 'npm ci', otherwise try reinstall
-        const command = (0, node_fs_1.existsSync)(modulePackageLockPath) ? ['ci'] : installCommand;
+        const command = existsSync(modulePackageLockPath) ? ['ci'] : installCommand;
         // Run reinstall only if the first attempt fails
-        await (0, command_1.execNpmCommand)(command, {
+        await execNpmCommand(command, {
             cwd: moduleDirectory,
             logger
         });
@@ -129,10 +92,10 @@ async function getModule(module, version, options) {
  * @param module - name of the module
  * @param version - version of the module
  */
-async function deleteModule(module, version) {
-    const moduleDirectory = (0, node_path_1.join)(constants_1.moduleCacheRoot, module, version);
-    if ((0, node_fs_1.existsSync)(moduleDirectory)) {
-        await (0, promises_1.rm)(moduleDirectory, { recursive: true });
+export async function deleteModule(module, version) {
+    const moduleDirectory = join(moduleCacheRoot, module, version);
+    if (existsSync(moduleDirectory)) {
+        await rm(moduleDirectory, { recursive: true });
     }
 }
 //# sourceMappingURL=module-loader.js.map

package/dist/project/mta.d.ts

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { MtaPath } from '../types/mta';
+import type { MtaPath } from '../types/mta/index.js';
 /**
  * Searches `projectPath` and parent folders.
  * If mta.yaml file is inside projectPath, this is a special type of MTA project

package/dist/project/mta.js

@@ -1,9 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMtaPath = getMtaPath;
-const file_search_1 = require("../file/file-search");
-const constants_1 = require("../constants");
-const node_path_1 = require("node:path");
+import { findFileUp } from '../file/file-search.js';
+import { FileName } from '../constants.js';
+import { dirname } from 'node:path';
 /**
  * Searches `projectPath` and parent folders.
  * If mta.yaml file is inside projectPath, this is a special type of MTA project
@@ -15,13 +12,13 @@ const node_path_1 = require("node:path");
  * @param fs - optional mem-fs-editor instance
  * @returns - MtaPath
  */
-async function getMtaPath(projectPath, fs) {
-    const mtaPath = await (0, file_search_1.findFileUp)(constants_1.FileName.MtaYaml, projectPath, fs);
+export async function getMtaPath(projectPath, fs) {
+    const mtaPath = await findFileUp(FileName.MtaYaml, projectPath, fs);
     if (!mtaPath) {
         return undefined;
     }
     else {
-        const mtaFolderPath = (0, node_path_1.dirname)(mtaPath);
+        const mtaFolderPath = dirname(mtaPath);
         return {
             mtaPath,
             hasRoot: mtaFolderPath !== projectPath

package/dist/project/script.js

@@ -1,14 +1,7 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updatePackageScript = updatePackageScript;
-exports.hasUI5CliV3 = hasUI5CliV3;
-const node_path_1 = require("node:path");
-const constants_1 = require("../constants");
-const file_1 = require("../file");
-const semver_1 = __importDefault(require("semver"));
+import { join } from 'node:path';
+import { FileName } from '../constants.js';
+import { readJSON, updatePackageJSON } from '../file/index.js';
+import semVer from 'semver';
 /**
  * Updates the package.json with a new script.
  *
@@ -17,14 +10,14 @@ const semver_1 = __importDefault(require("semver"));
  * @param script - the script content
  * @param fs - optional memfs editor instance
  */
-async function updatePackageScript(basePath, scriptName, script, fs) {
-    const filePath = (0, node_path_1.join)(basePath, constants_1.FileName.Package);
-    const packageJson = await (0, file_1.readJSON)(filePath, fs);
+export async function updatePackageScript(basePath, scriptName, script, fs) {
+    const filePath = join(basePath, FileName.Package);
+    const packageJson = await readJSON(filePath, fs);
     if (!packageJson.scripts) {
         packageJson.scripts = {};
     }
     packageJson.scripts[scriptName] = script;
-    await (0, file_1.updatePackageJSON)(filePath, packageJson, fs);
+    await updatePackageJSON(filePath, packageJson, fs);
 }
 /**
  * Check if dev dependencies contains @ui5/cli version greater than 2.
@@ -32,10 +25,10 @@ async function updatePackageScript(basePath, scriptName, script, fs) {
  * @param devDependencies dev dependencies from package.json
  * @returns boolean
  */
-function hasUI5CliV3(devDependencies) {
+export function hasUI5CliV3(devDependencies) {
     let isV3 = false;
-    const ui5CliSemver = semver_1.default.coerce(devDependencies['@ui5/cli']);
-    if (ui5CliSemver && semver_1.default.gte(ui5CliSemver, '3.0.0')) {
+    const ui5CliSemver = semVer.coerce(devDependencies['@ui5/cli']);
+    if (ui5CliSemver && semVer.gte(ui5CliSemver, '3.0.0')) {
         isV3 = true;
     }
     return isV3;

package/dist/project/search.d.ts

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import type { AllAppResults, CapProjectType, FioriArtifactTypes, FoundFioriArtifacts, WorkspaceFolder } from '../types';
+import type { AllAppResults, CapProjectType, FioriArtifactTypes, FoundFioriArtifacts, WorkspaceFolder } from '../types/index.js';
 /**
  * Type that is used locally only to keep list of found files with cache of the
  * content in order to avoid multiple file reads. It also caches result of call