@sap-ux/app-config-writer 0.7.5 → 1.0.0

package/dist/cards-config/index.js

@@ -1,12 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.enableCardGeneratorConfig = enableCardGeneratorConfig;
-const node_path_1 = require("node:path");
-const mem_fs_1 = require("mem-fs");
-const mem_fs_editor_1 = require("mem-fs-editor");
-const utils_1 = require("../common/utils");
-const project_access_1 = require("@sap-ux/project-access");
-const ui5_yaml_1 = require("../common/ui5-yaml");
+import { join, basename } from 'node:path';
+import { create as createStorage } from 'mem-fs';
+import { create } from 'mem-fs-editor';
+import { getPreviewMiddleware, getIntentFromPreviewConfig, getCLIForPreview } from '../common/utils.js';
+import { FileName, readUi5Yaml } from '@sap-ux/project-access';
+import { updateMiddlewaresForPreview } from '../common/ui5-yaml.js';
 const DEPENDENCY_NAME = '@sap-ux/cards-editor-middleware';
 const CARDS_GENERATOR_MIDDLEWARE = 'sap-cards-generator';
 /**
@@ -20,8 +17,8 @@ const CARDS_GENERATOR_MIDDLEWARE = 'sap-cards-generator';
  * @returns {Promise<void>} A promise that resolves when the `ui5.yaml` file has been successfully updated.
  */
 async function updateMiddlewareConfigWithGeneratorPath(fs, basePath, yamlPath, logger) {
-    const ui5YamlFile = yamlPath ? (0, node_path_1.basename)(yamlPath) : project_access_1.FileName.Ui5Yaml;
-    const ui5YamlConfig = await (0, project_access_1.readUi5Yaml)(basePath, ui5YamlFile, fs);
+    const ui5YamlFile = yamlPath ? basename(yamlPath) : FileName.Ui5Yaml;
+    const ui5YamlConfig = await readUi5Yaml(basePath, ui5YamlFile, fs);
     if (ui5YamlConfig.findCustomMiddleware(CARDS_GENERATOR_MIDDLEWARE)) {
         try {
             ui5YamlConfig.removeCustomMiddleware(CARDS_GENERATOR_MIDDLEWARE);
@@ -31,7 +28,7 @@ async function updateMiddlewareConfigWithGeneratorPath(fs, basePath, yamlPath, l
             logger?.warn(`Failed to remove '${CARDS_GENERATOR_MIDDLEWARE}' middleware: ${error.message}`);
         }
     }
-    const previewMiddleware = await (0, utils_1.getPreviewMiddleware)(ui5YamlConfig, basePath, yamlPath, fs);
+    const previewMiddleware = await getPreviewMiddleware(ui5YamlConfig, basePath, yamlPath, fs);
     if (previewMiddleware) {
         previewMiddleware.configuration ??= {};
         const middlewareConfig = previewMiddleware.configuration;
@@ -41,7 +38,7 @@ async function updateMiddlewareConfigWithGeneratorPath(fs, basePath, yamlPath, l
             path: cardGeneratorPath
         };
         ui5YamlConfig.updateCustomMiddleware(previewMiddleware);
-        fs.write((0, node_path_1.join)(basePath, ui5YamlFile), ui5YamlConfig.toString());
+        fs.write(join(basePath, ui5YamlFile), ui5YamlConfig.toString());
         logger?.debug(`Updated preview middleware in ${ui5YamlFile}.`);
     }
 }
@@ -56,18 +53,18 @@ async function updateMiddlewareConfigWithGeneratorPath(fs, basePath, yamlPath, l
  * @returns {Promise<void>} A promise that resolves when the `package.json` file has been successfully updated.
  */
 async function updatePackageJson(basePath, fs, yamlPath, logger) {
-    const packageJsonPath = (0, node_path_1.join)(basePath, 'package.json');
+    const packageJsonPath = join(basePath, 'package.json');
     if (!fs.exists(packageJsonPath)) {
         throw new Error('package.json not found');
     }
     const packageJson = (fs.readJSON(packageJsonPath) ?? {});
-    const ui5YamlFile = yamlPath ? (0, node_path_1.basename)(yamlPath) : project_access_1.FileName.Ui5Yaml;
-    const ui5YamlConfig = await (0, project_access_1.readUi5Yaml)(basePath, ui5YamlFile, fs);
-    const previewMiddleware = await (0, utils_1.getPreviewMiddleware)(ui5YamlConfig, basePath, ui5YamlFile, fs);
-    const intent = (0, utils_1.getIntentFromPreviewConfig)(previewMiddleware?.configuration) ?? '#app-preview';
+    const ui5YamlFile = yamlPath ? basename(yamlPath) : FileName.Ui5Yaml;
+    const ui5YamlConfig = await readUi5Yaml(basePath, ui5YamlFile, fs);
+    const previewMiddleware = await getPreviewMiddleware(ui5YamlConfig, basePath, ui5YamlFile, fs);
+    const intent = getIntentFromPreviewConfig(previewMiddleware?.configuration) ?? '#app-preview';
     const cardGeneratorPath = previewMiddleware?.configuration?.editors?.cardGenerator?.path ??
         '/test/flpCardGeneratorSandbox.html';
-    const cliForPreview = await (0, utils_1.getCLIForPreview)(basePath, ui5YamlFile, fs);
+    const cliForPreview = await getCLIForPreview(basePath, ui5YamlFile, fs);
     packageJson.scripts ??= {};
     packageJson.scripts['start-cards-generator'] = `${cliForPreview} --open "${cardGeneratorPath}${intent}"`;
     if (packageJson.devDependencies?.[DEPENDENCY_NAME]) {
@@ -88,9 +85,9 @@ async function updatePackageJson(basePath, fs, yamlPath, logger) {
  * @param {Editor} [fs] - Optional `mem-fs-editor` instance for file system operations. If not provided, a new instance will be created.
  * @returns {Promise<Editor>} A promise that resolves to the updated `mem-fs-editor` instance.
  */
-async function enableCardGeneratorConfig(basePath, yamlPath, logger, fs) {
-    fs = fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
-    await (0, ui5_yaml_1.updateMiddlewaresForPreview)(fs, basePath, yamlPath, logger);
+export async function enableCardGeneratorConfig(basePath, yamlPath, logger, fs) {
+    fs = fs ?? create(createStorage());
+    await updateMiddlewaresForPreview(fs, basePath, yamlPath, logger);
     await updateMiddlewareConfigWithGeneratorPath(fs, basePath, yamlPath, logger);
     await updatePackageJson(basePath, fs, yamlPath, logger);
     return fs;

package/dist/common/package-json.js

@@ -1,17 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getScriptsFromPackageJson = getScriptsFromPackageJson;
-exports.extractUrlDetails = extractUrlDetails;
-exports.isValidPreviewScript = isValidPreviewScript;
-exports.getRunScriptForYamlConfig = getRunScriptForYamlConfig;
-exports.extractYamlConfigFileName = extractYamlConfigFileName;
-exports.isTestPath = isTestPath;
-exports.isFlpPath = isFlpPath;
-exports.getTestPathForUi5TestRunner = getTestPathForUi5TestRunner;
-exports.isLowerThanMinimalVersion = isLowerThanMinimalVersion;
-const node_path_1 = require("node:path");
-const project_access_1 = require("@sap-ux/project-access");
-const semver_1 = require("semver");
+import { join } from 'node:path';
+import { FileName } from '@sap-ux/project-access';
+import { satisfies, valid, validRange, outside } from 'semver';
 /**
  * Map of scripts from the package.json file.
  */
@@ -24,8 +13,8 @@ const scriptsFromPackageJson = new Map();
  * @param basePath - base path to be used for the conversion
  * @returns the scripts from the package.json file
  */
-function getScriptsFromPackageJson(fs, basePath) {
-    const packageJsonPath = (0, node_path_1.join)(basePath, 'package.json');
+export function getScriptsFromPackageJson(fs, basePath) {
+    const packageJsonPath = join(basePath, 'package.json');
     const packageJson = fs.readJSON(packageJsonPath);
     scriptsFromPackageJson.clear();
     Object.entries(packageJson?.scripts ?? {}).forEach(([scriptName, scriptContent]) => {
@@ -41,7 +30,7 @@ function getScriptsFromPackageJson(fs, basePath) {
  * @param script - the content of the script
  * @returns the URL details
  */
-function extractUrlDetails(script) {
+export function extractUrlDetails(script) {
     //extract the URL from the 'open' command of the script
     let url = / (?:--open|-o|--o) (\S*)/.exec(script)?.[1] ?? undefined;
     //delete double or single quotes from the URL
@@ -77,7 +66,7 @@ function extractUrlDetails(script) {
  * @param convertTests - indicator if test suite and test runner should be included in the conversion (default: false)
  * @returns indicator if the script is valid
  */
-function isValidPreviewScript(script, convertTests = false) {
+export function isValidPreviewScript(script, convertTests = false) {
     const isValidScriptName = script.name != 'start-variants-management' &&
         script.name != 'start-control-property-editor' &&
         script.name != 'start-cards-generator';
@@ -96,8 +85,8 @@ function isValidPreviewScript(script, convertTests = false) {
  * @param basePath - path to project root, where package.json is
  * @returns the run script or undefined
  */
-function getRunScriptForYamlConfig(yamlConfigName, fs, basePath) {
-    const packageJsonPath = (0, node_path_1.join)(basePath, 'package.json');
+export function getRunScriptForYamlConfig(yamlConfigName, fs, basePath) {
+    const packageJsonPath = join(basePath, 'package.json');
     const packageJson = fs.readJSON(packageJsonPath);
     if (!packageJson) {
         return undefined;
@@ -119,8 +108,8 @@ function getRunScriptForYamlConfig(yamlConfigName, fs, basePath) {
  * @param script - the content of the script from the package.json file
  * @returns the UI5 yaml configuration file name or 'ui5.yaml' as default
  */
-function extractYamlConfigFileName(script) {
-    return / (?:--config|-c) (\S*)/.exec(script)?.[1] ?? project_access_1.FileName.Ui5Yaml;
+export function extractYamlConfigFileName(script) {
+    return / (?:--config|-c) (\S*)/.exec(script)?.[1] ?? FileName.Ui5Yaml;
 }
 /**
  * Check if the path is a test path.
@@ -131,7 +120,7 @@ function extractYamlConfigFileName(script) {
  * @param configuration - the preview configuration
  * @returns indicator if the path is a test path
  */
-function isTestPath(script, configuration) {
+export function isTestPath(script, configuration) {
     const { path } = extractUrlDetails(script.value);
     if (!path) {
         return !!getTestPathForUi5TestRunner(script.name);
@@ -148,7 +137,7 @@ function isTestPath(script, configuration) {
  * @param configuration - the preview configuration
  * @returns indicator if the path is an FLP path
  */
-function isFlpPath(script, configuration) {
+export function isFlpPath(script, configuration) {
     const { path } = extractUrlDetails(script.value);
     if (!path) {
         return false;
@@ -173,7 +162,7 @@ function isFlpPath(script, configuration) {
  * @param scriptName - the name of the script from the package.json file
  * @returns the related test path
  */
-function getTestPathForUi5TestRunner(scriptName) {
+export function getTestPathForUi5TestRunner(scriptName) {
     const TEST_RUNNER_COMMAND = 'ui5-test-runner';
     const extractUrl = (script) => {
         return / (?:--url|-u|--testsuite) (\S*)/.exec(script)?.[1] ?? undefined;
@@ -207,7 +196,7 @@ function getTestPathForUi5TestRunner(scriptName) {
  * @param mandatory - (default true) if the existence of the dependency is mandatory
  * @returns indicator if the version is lower than the minimal version
  */
-function isLowerThanMinimalVersion(packageJson, dependencyName, minVersionInfo, mandatory = true) {
+export function isLowerThanMinimalVersion(packageJson, dependencyName, minVersionInfo, mandatory = true) {
     let versionInfo = packageJson?.devDependencies?.[dependencyName] ?? packageJson?.dependencies?.[dependencyName];
     if (!versionInfo) {
         // In case no dependency is found we assume the minimal version is not met depending on the mandatory flag
@@ -217,14 +206,14 @@ function isLowerThanMinimalVersion(packageJson, dependencyName, minVersionInfo,
         // In case of 'latest' we know the minimal version is met
         return false;
     }
-    if ((0, semver_1.validRange)(versionInfo)) {
+    if (validRange(versionInfo)) {
         // In case of a valid range the minimal version must not be outside the range in high direction
-        return (0, semver_1.outside)(minVersionInfo, versionInfo, '>');
+        return outside(minVersionInfo, versionInfo, '>');
     }
-    if ((0, semver_1.valid)(versionInfo)) {
+    if (valid(versionInfo)) {
         // In case of a valid version we add a prefix to make it a range
         versionInfo = `<=${versionInfo}`;
     }
-    return !(0, semver_1.satisfies)(minVersionInfo, versionInfo);
+    return !satisfies(minVersionInfo, versionInfo);
 }
 //# sourceMappingURL=package-json.js.map

package/dist/common/ui5-yaml.d.ts

@@ -1,9 +1,9 @@
 import type { Editor } from 'mem-fs-editor';
 import type { ToolsLogger } from '@sap-ux/logger';
-import type { PreviewConfigOptions } from '../types';
+import type { PreviewConfigOptions } from '../types/index.js';
 import type { CustomMiddleware, FioriAppReloadConfig, UI5Config } from '@sap-ux/ui5-config';
 import { type DefaultFlpPath, type MiddlewareConfig as PreviewConfig, type TestConfig, type RtaConfig } from '@sap-ux/preview-middleware';
-import { type Script } from './package-json';
+import { type Script } from './package-json.js';
 type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType[number];
 type PreviewTestConfig = ArrayElement<Required<PreviewConfig>['test']>;
 export declare const DEFAULT_FLP_PATH: DefaultFlpPath;

package/dist/common/ui5-yaml.js

@@ -1,25 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEST_CONFIG_DEFAULTS = exports.DEFAULT_FLP_PATH = void 0;
-exports.sanitizeRtaConfig = sanitizeRtaConfig;
-exports.getEnhancedReloadMiddleware = getEnhancedReloadMiddleware;
-exports.createPreviewMiddlewareConfig = createPreviewMiddlewareConfig;
-exports.updateMiddlewaresForPreview = updateMiddlewaresForPreview;
-exports.sanitizePreviewMiddleware = sanitizePreviewMiddleware;
-exports.updatePreviewMiddlewareConfig = updatePreviewMiddlewareConfig;
-exports.updateTestConfig = updateTestConfig;
-exports.sanitizeTestScript = sanitizeTestScript;
-const node_path_1 = require("node:path");
-const types_1 = require("../types");
-const project_access_1 = require("@sap-ux/project-access");
-const utils_1 = require("./utils");
-const package_json_1 = require("./package-json");
+import { basename, join } from 'node:path';
+import { MiddlewareConfigs } from '../types/index.js';
+import { FileName, readUi5Yaml, getWebappPath } from '@sap-ux/project-access';
+import { getPreviewMiddleware, isFioriToolsDeprecatedPreviewConfig, deleteFiles } from './utils.js';
+import { getRunScriptForYamlConfig, getTestPathForUi5TestRunner, extractUrlDetails, isTestPath, isFlpPath } from './package-json.js';
 const DEFAULT_INTENT = {
     object: 'app',
     action: 'preview'
 };
-exports.DEFAULT_FLP_PATH = '/test/flp.html';
-exports.TEST_CONFIG_DEFAULTS = {
+export const DEFAULT_FLP_PATH = '/test/flp.html';
+export const TEST_CONFIG_DEFAULTS = {
     qunit: {
         path: '/test/unitTests.qunit.html',
         framework: 'QUnit'
@@ -41,7 +30,7 @@ exports.TEST_CONFIG_DEFAULTS = {
  * @returns sanitized RTA configuration
  */
 //prettier-ignore
-function sanitizeRtaConfig(deprecatedRtaConfig, logger) {
+export function sanitizeRtaConfig(deprecatedRtaConfig, logger) {
     let rtaConfig;
     if (deprecatedRtaConfig) {
         const { editors, ...rta } = deprecatedRtaConfig;
@@ -58,9 +47,9 @@ function sanitizeRtaConfig(deprecatedRtaConfig, logger) {
  * @param yamlConfig - the yaml configuration to use
  * @returns reload middleware configuration if found or undefined
  */
-async function getEnhancedReloadMiddleware(yamlConfig) {
-    const reloadMiddleware = yamlConfig.findCustomMiddleware(types_1.MiddlewareConfigs.FioriToolsAppreload) ??
-        yamlConfig.findCustomMiddleware(types_1.MiddlewareConfigs.ReloadMiddleware);
+export async function getEnhancedReloadMiddleware(yamlConfig) {
+    const reloadMiddleware = yamlConfig.findCustomMiddleware(MiddlewareConfigs.FioriToolsAppreload) ??
+        yamlConfig.findCustomMiddleware(MiddlewareConfigs.ReloadMiddleware);
     if (!reloadMiddleware) {
         return undefined;
     }
@@ -76,13 +65,13 @@ async function getEnhancedReloadMiddleware(yamlConfig) {
  * @param basePath - path to project root, where package.json and ui5.yaml is
  * @returns 'fiori-tools-preview' or 'preview-middleware' configuration
  */
-function createPreviewMiddlewareConfig(fs, basePath) {
-    const packageJsonPath = (0, node_path_1.join)(basePath, 'package.json');
+export function createPreviewMiddlewareConfig(fs, basePath) {
+    const packageJsonPath = join(basePath, 'package.json');
     const packageJson = fs.readJSON(packageJsonPath);
     return {
         name: packageJson?.devDependencies?.['@sap/ux-ui5-tooling']
-            ? types_1.MiddlewareConfigs.FioriToolsPreview
-            : types_1.MiddlewareConfigs.PreviewMiddleware,
+            ? MiddlewareConfigs.FioriToolsPreview
+            : MiddlewareConfigs.PreviewMiddleware,
         afterMiddleware: 'compression'
     };
 }
@@ -95,16 +84,16 @@ function createPreviewMiddlewareConfig(fs, basePath) {
  * @param yamlPath - path to the ui5*.yaml file passed by cli
  * @param logger - logger
  */
-async function updateMiddlewaresForPreview(fs, basePath, yamlPath, logger) {
-    const ui5YamlFile = yamlPath ? (0, node_path_1.basename)(yamlPath) : project_access_1.FileName.Ui5Yaml;
-    const ui5YamlConfig = await (0, project_access_1.readUi5Yaml)(basePath, ui5YamlFile, fs);
-    let previewMiddleware = await (0, utils_1.getPreviewMiddleware)(ui5YamlConfig);
+export async function updateMiddlewaresForPreview(fs, basePath, yamlPath, logger) {
+    const ui5YamlFile = yamlPath ? basename(yamlPath) : FileName.Ui5Yaml;
+    const ui5YamlConfig = await readUi5Yaml(basePath, ui5YamlFile, fs);
+    let previewMiddleware = await getPreviewMiddleware(ui5YamlConfig);
     if (!previewMiddleware) {
         logger?.warn(`No preview middleware found in ${ui5YamlFile}. Preview middleware will be added.`);
         previewMiddleware = createPreviewMiddlewareConfig(fs, basePath);
     }
     else {
-        const script = (0, package_json_1.getRunScriptForYamlConfig)(ui5YamlFile, fs, basePath);
+        const script = getRunScriptForYamlConfig(ui5YamlFile, fs, basePath);
         if (script) {
             previewMiddleware = await updatePreviewMiddlewareConfig(previewMiddleware, script, basePath, fs, logger);
         }
@@ -120,7 +109,7 @@ async function updateMiddlewaresForPreview(fs, basePath, yamlPath, logger) {
         logger?.debug(`Updated reload middleware in ${ui5YamlFile}.`);
     }
     ui5YamlConfig.updateCustomMiddleware(previewMiddleware);
-    fs.write((0, node_path_1.join)(basePath, ui5YamlFile), ui5YamlConfig.toString());
+    fs.write(join(basePath, ui5YamlFile), ui5YamlConfig.toString());
     logger?.debug(`Updated preview middleware in ${ui5YamlFile}.`);
 }
 /**
@@ -135,7 +124,7 @@ async function updateMiddlewaresForPreview(fs, basePath, yamlPath, logger) {
  * @param logger - logger to report info to the user
  * @returns the sanitized preview middleware
  */
-function sanitizePreviewMiddleware(previewMiddleware, logger) {
+export function sanitizePreviewMiddleware(previewMiddleware, logger) {
     if (!previewMiddleware.configuration) {
         return previewMiddleware;
     }
@@ -146,7 +135,7 @@ function sanitizePreviewMiddleware(previewMiddleware, logger) {
         previewMiddleware.configuration.editors ??= {};
         previewMiddleware.configuration.editors.rta = rtaConfig;
     }
-    if (!(0, utils_1.isFioriToolsDeprecatedPreviewConfig)(previewMiddleware.configuration)) {
+    if (!isFioriToolsDeprecatedPreviewConfig(previewMiddleware.configuration)) {
         return previewMiddleware;
     }
     const ui5Theme = previewMiddleware.configuration.ui5Theme;
@@ -172,16 +161,16 @@ function sanitizePreviewMiddleware(previewMiddleware, logger) {
  * @param logger logger to report info to the user
  * @returns the preview middleware configuration
  */
-async function updatePreviewMiddlewareConfig(previewMiddleware, script, basePath, fs, logger) {
-    const { path, intent } = (0, package_json_1.extractUrlDetails)(script.value);
+export async function updatePreviewMiddlewareConfig(previewMiddleware, script, basePath, fs, logger) {
+    const { path, intent } = extractUrlDetails(script.value);
     const defaultIntent = `${DEFAULT_INTENT.object}-${DEFAULT_INTENT.action}`;
     const newMiddlewareConfig = sanitizePreviewMiddleware(previewMiddleware, logger);
     //copy of configuration to avoid ending up with an empty configuration object in some cases
     const configuration = { ...newMiddlewareConfig.configuration };
     let writeConfig = false;
-    if ((0, package_json_1.isFlpPath)(script, configuration)) {
+    if (isFlpPath(script, configuration)) {
         //adjust path but respect defaults
-        if (!path?.includes(exports.DEFAULT_FLP_PATH)) {
+        if (!path?.includes(DEFAULT_FLP_PATH)) {
             configuration.flp = configuration.flp ?? {};
             configuration.flp.path = path;
             writeConfig = true;
@@ -196,12 +185,12 @@ async function updatePreviewMiddlewareConfig(previewMiddleware, script, basePath
             writeConfig = true;
         }
     }
-    else if (path && (0, package_json_1.isTestPath)(script, configuration)) {
+    else if (path && isTestPath(script, configuration)) {
         configuration.test = await updateTestConfig(configuration.test, path, basePath, fs, logger);
         writeConfig = true;
     }
     else if (!path) {
-        const ui5TestRunnerPath = (0, package_json_1.getTestPathForUi5TestRunner)(script.name);
+        const ui5TestRunnerPath = getTestPathForUi5TestRunner(script.name);
         if (ui5TestRunnerPath) {
             configuration.test = await updateTestConfig(configuration.test, ui5TestRunnerPath, basePath, fs);
             writeConfig = true;
@@ -222,7 +211,7 @@ async function updatePreviewMiddlewareConfig(previewMiddleware, script, basePath
  * @param logger logger to report info to the user
  * @returns the updated test configuration
  */
-async function updateTestConfig(testConfiguration, path, basePath, fs, logger) {
+export async function updateTestConfig(testConfiguration, path, basePath, fs, logger) {
     const hasTestsuite = (config) => {
         return config?.some((test) => test.framework === 'Testsuite') ?? false;
     };
@@ -240,7 +229,7 @@ async function updateTestConfig(testConfiguration, path, basePath, fs, logger) {
     if (!framework) {
         return testConfiguration;
     }
-    const defaultPath = exports.TEST_CONFIG_DEFAULTS[framework.toLowerCase()].path;
+    const defaultPath = TEST_CONFIG_DEFAULTS[framework.toLowerCase()].path;
     const testConfig = testConfiguration.find((test) => test.framework === framework);
     if (testConfig) {
         testConfig.path = path;
@@ -274,9 +263,9 @@ async function updateTestConfig(testConfiguration, path, basePath, fs, logger) {
  * @param newConfig - the new test configuration
  * @param logger logger to report info to the user
  */
-async function sanitizeTestScript(fs, basePath, path, newConfig, logger) {
-    const jsTestScriptPath = (0, node_path_1.join)(await (0, project_access_1.getWebappPath)(basePath), path.replace('.html', '.js'));
-    const tsTestScriptPath = (0, node_path_1.join)(await (0, project_access_1.getWebappPath)(basePath), path.replace('.html', '.ts'));
+export async function sanitizeTestScript(fs, basePath, path, newConfig, logger) {
+    const jsTestScriptPath = join(await getWebappPath(basePath), path.replace('.html', '.js'));
+    const tsTestScriptPath = join(await getWebappPath(basePath), path.replace('.html', '.ts'));
     const testScriptPath = fs.exists(jsTestScriptPath) ? jsTestScriptPath : tsTestScriptPath;
     if (fs.exists(testScriptPath)) {
         const file = fs.read(testScriptPath);
@@ -284,11 +273,11 @@ async function sanitizeTestScript(fs, basePath, path, newConfig, logger) {
         if (usesJourneyRunner) {
             const filePathRenamed = testScriptPath.replace(/(\.([jt])s)$/, '.custom$1');
             fs.move(testScriptPath, filePathRenamed);
-            newConfig.pattern = `/test/**/${(0, node_path_1.basename)(filePathRenamed)}`;
-            logger?.info(`Renamed '${(0, node_path_1.basename)(testScriptPath)}' to '${(0, node_path_1.basename)(filePathRenamed)}'. This file creates the JourneyRunner for OPA5 tests. As the handling of journey runners is not part of the virtual OPA5 test runner endpoint, this file has been renamed and added to the respective UI5 YAML configuration.`);
+            newConfig.pattern = `/test/**/${basename(filePathRenamed)}`;
+            logger?.info(`Renamed '${basename(testScriptPath)}' to '${basename(filePathRenamed)}'. This file creates the JourneyRunner for OPA5 tests. As the handling of journey runners is not part of the virtual OPA5 test runner endpoint, this file has been renamed and added to the respective UI5 YAML configuration.`);
         }
         else {
-            await (0, utils_1.deleteFiles)(fs, [testScriptPath]);
+            await deleteFiles(fs, [testScriptPath]);
         }
     }
 }

package/dist/common/utils.d.ts

@@ -1,5 +1,5 @@
 import type { CustomMiddleware, UI5Config } from '@sap-ux/ui5-config';
-import type { PreviewConfigOptions, FioriToolsDeprecatedPreviewConfig } from '../types';
+import type { PreviewConfigOptions, FioriToolsDeprecatedPreviewConfig } from '../types/index.js';
 import type { Editor } from 'mem-fs-editor';
 import type { ToolsLogger } from '@sap-ux/logger';
 /**

package/dist/common/utils.js

@@ -1,20 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFioriToolsDeprecatedPreviewConfig = isFioriToolsDeprecatedPreviewConfig;
-exports.getPreviewMiddleware = getPreviewMiddleware;
-exports.getIntentFromPreviewConfig = getIntentFromPreviewConfig;
-exports.getCLIForPreview = getCLIForPreview;
-exports.deleteFiles = deleteFiles;
-const project_access_1 = require("@sap-ux/project-access");
-const types_1 = require("../types");
-const node_path_1 = require("node:path");
+import { FileName, readUi5Yaml } from '@sap-ux/project-access';
+import { MiddlewareConfigs } from '../types/index.js';
+import { basename } from 'node:path';
 /**
  * Type guard to check if the given configuration is a deprecated preview middleware configuration.
  *
  * @param configuration preview middleware configuration
  * @returns true, if a preview middleware configuration is deprecated
  */
-function isFioriToolsDeprecatedPreviewConfig(configuration) {
+export function isFioriToolsDeprecatedPreviewConfig(configuration) {
     return configuration?.component !== undefined;
 }
 /**
@@ -28,13 +21,13 @@ function isFioriToolsDeprecatedPreviewConfig(configuration) {
  * @returns preview middleware configuration if found
  * Rejects if neither yamlConfig nor basePath is provided or if the file can't be read
  */
-async function getPreviewMiddleware(yamlConfig, basePath, filename = project_access_1.FileName.Ui5Yaml, fs) {
+export async function getPreviewMiddleware(yamlConfig, basePath, filename = FileName.Ui5Yaml, fs) {
     if (!basePath && !yamlConfig) {
         throw new Error('Either base path or yaml config must be provided.');
     }
-    yamlConfig = yamlConfig ?? (await (0, project_access_1.readUi5Yaml)(basePath, filename, fs));
-    return (yamlConfig.findCustomMiddleware(types_1.MiddlewareConfigs.FioriToolsPreview) ??
-        yamlConfig.findCustomMiddleware(types_1.MiddlewareConfigs.PreviewMiddleware));
+    yamlConfig = yamlConfig ?? (await readUi5Yaml(basePath, filename, fs));
+    return (yamlConfig.findCustomMiddleware(MiddlewareConfigs.FioriToolsPreview) ??
+        yamlConfig.findCustomMiddleware(MiddlewareConfigs.PreviewMiddleware));
 }
 /**
  * Returns the intent of the preview middleware configuration from the ui5.yaml file, if given.
@@ -42,7 +35,7 @@ async function getPreviewMiddleware(yamlConfig, basePath, filename = project_acc
  * @param previewMiddlewareConfig - configuration of the preview middleware
  * @returns - preview intent or undefined
  */
-function getIntentFromPreviewConfig(previewMiddlewareConfig) {
+export function getIntentFromPreviewConfig(previewMiddlewareConfig) {
     if (isFioriToolsDeprecatedPreviewConfig(previewMiddlewareConfig)) {
         return undefined;
     }
@@ -59,9 +52,9 @@ function getIntentFromPreviewConfig(previewMiddlewareConfig) {
  * @param fs - the memfs editor instance
  * @returns - preview serve or undefined
  */
-async function getCLIForPreview(basePath, yamlFileName, fs) {
+export async function getCLIForPreview(basePath, yamlFileName, fs) {
     const previewMiddleware = await getPreviewMiddleware(undefined, basePath, yamlFileName, fs);
-    return previewMiddleware?.name === types_1.MiddlewareConfigs.PreviewMiddleware ? 'ui5 serve' : 'fiori run';
+    return previewMiddleware?.name === MiddlewareConfigs.PreviewMiddleware ? 'ui5 serve' : 'fiori run';
 }
 /**
  * Deletes the given file.
@@ -70,11 +63,11 @@ async function getCLIForPreview(basePath, yamlFileName, fs) {
  * @param files - files to be deleted
  * @param logger logger to report info to the user
  */
-async function deleteFiles(fs, files, logger) {
+export async function deleteFiles(fs, files, logger) {
     files.forEach((path) => {
         if (fs.exists(path)) {
             fs.delete(path);
-            logger?.info(`Deleted the '${(0, node_path_1.basename)(path)}' file. This file is no longer needed for the virtual endpoints.`);
+            logger?.info(`Deleted the '${basename(path)}' file. This file is no longer needed for the virtual endpoints.`);
         }
     });
 }

package/dist/eslint-config/add.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateEslintConfig = generateEslintConfig;
-const mem_fs_1 = require("mem-fs");
-const mem_fs_editor_1 = require("mem-fs-editor");
-const project_access_1 = require("@sap-ux/project-access");
-const node_path_1 = require("node:path");
-const ui5_application_writer_1 = require("@sap-ux/ui5-application-writer");
+import { create as createStorage } from 'mem-fs';
+import { create } from 'mem-fs-editor';
+import { hasDependency, FileName } from '@sap-ux/project-access';
+import { join } from 'node:path';
+import { addEslintFeature } from '@sap-ux/ui5-application-writer';
 /**
  * Adds eslint configuration to the project.
  *
@@ -19,8 +16,8 @@ const ui5_application_writer_1 = require("@sap-ux/ui5-application-writer");
  * @param options.config - the name of the SAP Fiori tools eslint plugin config to be used
  * @returns file system reference
  */
-async function generateEslintConfig(basePath, options) {
-    const fs = options.fs ?? (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+export async function generateEslintConfig(basePath, options) {
+    const fs = options.fs ?? create(createStorage());
     const logger = options.logger;
     if (!(await checkPrerequisites(basePath, fs, logger))) {
         throw new Error('The prerequisites are not met. For more information, see the log messages above.');
@@ -37,17 +34,17 @@ async function generateEslintConfig(basePath, options) {
  * @returns true if the prerequisites are met, false otherwise
  */
 async function checkPrerequisites(basePath, fs, logger) {
-    const packageJsonPath = (0, node_path_1.join)(basePath, project_access_1.FileName.Package);
+    const packageJsonPath = join(basePath, FileName.Package);
     const packageJson = fs.readJSON(packageJsonPath);
     if (!packageJson) {
         logger?.error(`No package.json found at path '${packageJsonPath}'`);
         return false;
     }
-    if ((0, project_access_1.hasDependency)(packageJson, 'eslint')) {
+    if (hasDependency(packageJson, 'eslint')) {
         logger?.error(`EsLint already exists in this project. Found 'eslint' dependency in package.json at path '${packageJsonPath}'`);
         return false;
     }
-    const eslintConfigFilePath = (0, node_path_1.join)(basePath, 'eslint.config.mjs');
+    const eslintConfigFilePath = join(basePath, 'eslint.config.mjs');
     if (fs.exists(eslintConfigFilePath)) {
         logger?.error(`An ESLint configuration file already exists at path '${eslintConfigFilePath}'`);
         return false;
@@ -62,12 +59,12 @@ async function checkPrerequisites(basePath, fs, logger) {
  * @param config - the name of the SAP Fiori tools eslint plugin config to be used
  */
 async function addEslintConfig(basePath, fs, config = 'recommended') {
-    await (0, ui5_application_writer_1.addEslintFeature)(basePath, fs);
+    await addEslintFeature(basePath, fs);
     if (config === 'recommended-for-s4hana') {
-        const eslintConfigPath = (0, node_path_1.join)(basePath, 'eslint.config.mjs');
+        const eslintConfigPath = join(basePath, 'eslint.config.mjs');
         let eslintConfigContent = fs.read(eslintConfigPath);
         eslintConfigContent = eslintConfigContent.replace('...fioriTools.configs.recommended', "...fioriTools.configs['recommended-for-s4hana']");
-        await fs.write((0, node_path_1.join)(basePath, 'eslint.config.mjs'), eslintConfigContent);
+        await fs.write(join(basePath, 'eslint.config.mjs'), eslintConfigContent);
     }
 }
 //# sourceMappingURL=add.js.map