@sap-ux/app-config-writer 0.5.23 → 0.5.25

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { getSmartLinksTargetFromPrompt } from './prompt';
+export { getSmartLinksTargetFromPrompt, simulatePrompt, includeTestRunnersPrompt } from './prompt';
 export { generateSmartLinksConfig } from './smartlinks-config';
 export { generateInboundNavigationConfig, readManifest } from './navigation-config';
 export { generateVariantsConfig } from './variants-config';

package/dist/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertToVirtualPreview = exports.generateVariantsConfig = exports.readManifest = exports.generateInboundNavigationConfig = exports.generateSmartLinksConfig = exports.getSmartLinksTargetFromPrompt = void 0;
+exports.convertToVirtualPreview = exports.generateVariantsConfig = exports.readManifest = exports.generateInboundNavigationConfig = exports.generateSmartLinksConfig = exports.includeTestRunnersPrompt = exports.simulatePrompt = exports.getSmartLinksTargetFromPrompt = void 0;
 var prompt_1 = require("./prompt");
 Object.defineProperty(exports, "getSmartLinksTargetFromPrompt", { enumerable: true, get: function () { return prompt_1.getSmartLinksTargetFromPrompt; } });
+Object.defineProperty(exports, "simulatePrompt", { enumerable: true, get: function () { return prompt_1.simulatePrompt; } });
+Object.defineProperty(exports, "includeTestRunnersPrompt", { enumerable: true, get: function () { return prompt_1.includeTestRunnersPrompt; } });
 var smartlinks_config_1 = require("./smartlinks-config");
 Object.defineProperty(exports, "generateSmartLinksConfig", { enumerable: true, get: function () { return smartlinks_config_1.generateSmartLinksConfig; } });
 var navigation_config_1 = require("./navigation-config");

package/dist/preview-config/index.js

@@ -28,10 +28,6 @@ async function convertToVirtualPreview(basePath, options) {
     if (!(await (0, prerequisites_1.checkPrerequisites)(basePath, fs, convertTests, logger))) {
         throw Error('The prerequisites are not met. For more information, see the log messages above.');
     }
-    if (!(await (0, prerequisites_1.getExplicitApprovalToAdjustFiles)())) {
-        logger?.error('You have not approved the conversion. The conversion has been aborted.');
-        return fs;
-    }
     await (0, ui5_yaml_1.updatePreviewMiddlewareConfigs)(fs, basePath, convertTests, logger);
     await (0, preview_files_1.renameDefaultSandboxes)(fs, basePath, logger);
     if (convertTests) {

package/dist/preview-config/prerequisites.d.ts

@@ -13,10 +13,4 @@ import type { ToolsLogger } from '@sap-ux/logger';
  * @returns indicator if the prerequisites are met
  */
 export declare function checkPrerequisites(basePath: string, fs: Editor, convertTests?: boolean, logger?: ToolsLogger): Promise<boolean>;
-/**
- * Get the explicit approval form the user to do the conversion.
- *
- * @returns Explicit user approval to do the conversion.
- */
-export declare function getExplicitApprovalToAdjustFiles(): Promise<boolean>;
 //# sourceMappingURL=prerequisites.d.ts.map

package/dist/preview-config/prerequisites.js

@@ -1,9 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkPrerequisites = checkPrerequisites;
-exports.getExplicitApprovalToAdjustFiles = getExplicitApprovalToAdjustFiles;
 const path_1 = require("path");
-const prompts_1 = require("prompts");
 const semver_1 = require("semver");
 /**
  * Check if the version of the given package is lower than the minimal version.
@@ -75,18 +73,4 @@ async function checkPrerequisites(basePath, fs, convertTests = false, logger) {
     }
     return prerequisitesMet;
 }
-/**
- * Get the explicit approval form the user to do the conversion.
- *
- * @returns Explicit user approval to do the conversion.
- */
-async function getExplicitApprovalToAdjustFiles() {
-    const question = {
-        type: 'confirm',
-        name: 'approval',
-        initial: false,
-        message: 'The converter will rename the HTML files and delete the JS and TS files used for the existing preview functionality and configure virtual endpoints instead. Do you want to proceed with the conversion?'
-    };
-    return Boolean((await (0, prompts_1.prompt)([question])).approval);
-}
 //# sourceMappingURL=prerequisites.js.map

package/dist/prompt/index.d.ts

@@ -1,2 +1,3 @@
 export { getSmartLinksTargetFromPrompt, promptUserPass } from './smartlinks-config';
+export * from './preview-config';
 //# sourceMappingURL=index.d.ts.map

package/dist/prompt/index.js

@@ -1,7 +1,22 @@
 "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 __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.promptUserPass = exports.getSmartLinksTargetFromPrompt = void 0;
 var smartlinks_config_1 = require("./smartlinks-config");
 Object.defineProperty(exports, "getSmartLinksTargetFromPrompt", { enumerable: true, get: function () { return smartlinks_config_1.getSmartLinksTargetFromPrompt; } });
 Object.defineProperty(exports, "promptUserPass", { enumerable: true, get: function () { return smartlinks_config_1.promptUserPass; } });
+__exportStar(require("./preview-config"), exports);
 //# sourceMappingURL=index.js.map

package/dist/prompt/preview-config.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Prompt if the conversion should be done in simulation.
+ *
+ * @returns Indicator if the conversion should be simulated.
+ */
+export declare function simulatePrompt(): Promise<boolean>;
+/**
+ * Prompt if the conversion should include the test runners.
+ *
+ * @returns Indicator if the conversion should include test runners.
+ */
+export declare function includeTestRunnersPrompt(): Promise<boolean>;
+//# sourceMappingURL=preview-config.d.ts.map

package/dist/prompt/preview-config.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.simulatePrompt = simulatePrompt;
+exports.includeTestRunnersPrompt = includeTestRunnersPrompt;
+const prompts_1 = require("prompts");
+/**
+ * Prompt if the conversion should be done in simulation.
+ *
+ * @returns Indicator if the conversion should be simulated.
+ */
+async function simulatePrompt() {
+    const PROMPT_NAME = 'simulate';
+    const question = {
+        type: 'confirm',
+        name: PROMPT_NAME,
+        initial: true,
+        message: `The converter renames the local HTML files, deletes the JavaScript and TypeScript files used for the existing preview functionality, and configures virtual endpoints instead.
+Do you want to simulate the conversion?`
+    };
+    const answer = (await (0, prompts_1.prompt)([question]));
+    return (answer.simulate ?? (await Promise.reject(new Error('An error has occurred. The conversion has been canceled.')))); //in case of doubt, reject
+}
+/**
+ * Prompt if the conversion should include the test runners.
+ *
+ * @returns Indicator if the conversion should include test runners.
+ */
+async function includeTestRunnersPrompt() {
+    const PROMPT_NAME = 'includeTests';
+    const question = {
+        type: 'confirm',
+        name: PROMPT_NAME,
+        initial: false,
+        message: 'Do you want to convert the test runners?'
+    };
+    const answer = (await (0, prompts_1.prompt)([question]));
+    return (answer.includeTests ??
+        (await Promise.reject(new Error('An error has occurred. The conversion has been canceled.')))); //in case of doubt, reject
+}
+//# sourceMappingURL=preview-config.js.map

package/dist/variants-config/package-json.js

@@ -25,12 +25,7 @@ async function addVariantsManagementScript(fs, basePath, yamlPath, logger) {
         logger?.warn(`File 'package.json' does not contain a script section. Script section added.`);
         packageJson.scripts = {};
     }
-    const urlParameters = {};
-    const sapClient = (0, utils_1.getSapClientFromPackageJson)(packageJson.scripts);
-    if (sapClient) {
-        urlParameters['sap-client'] = sapClient;
-    }
-    const url = await (0, utils_1.getRTAUrl)(basePath, (0, utils_1.enhanceUrlParametersWithRta)(packageJson, urlParameters), ui5YamlFileName, fs);
+    const url = await (0, utils_1.getRTAUrl)(basePath, (0, utils_1.getRtaUrlParameters)(packageJson), ui5YamlFileName, fs);
     const serveCommand = await (0, utils_1.getRTAServe)(basePath, ui5YamlFileName, fs);
     if (!url) {
         throw new Error(`${ERROR_MSG} No RTA editor specified in ui5.yaml.`);

package/dist/variants-config/utils.d.ts

@@ -22,28 +22,12 @@ export declare function getPreviewMiddleware(yamlConfig?: UI5Config, basePath?:
  */
 export declare function isFioriToolsDeprecatedPreviewConfig(configuration: PreviewConfigOptions | undefined): configuration is FioriToolsDeprecatedPreviewConfig;
 /**
- * Extracts sap client string from existing scripts in package.json.
- *
- * @param scripts - script section of the package.json
- * @returns sap client
- */
-export declare function getSapClientFromPackageJson(scripts: Package['scripts']): string | undefined;
-/**
- * Extracts the version of the given dependency from the given package.json file.
- *
- * @param packageJson - package.json file
- * @param dependencyName - name of the (dev-)dependency
- * @returns version of the dependency as an array of numbers
- */
-export declare function getDependencyVersion(packageJson: Package, dependencyName: string): number[] | undefined;
-/**
- * Enhances the given url parameters with the ones needed for the UI5 run time adaptation.
+ * Get the url parameters needed for the UI5 run time adaptation.
  *
  @param packageJson - package.json file
- * @param existingParams - parameters to be enhanced
  * @returns enhanced url parameters
  */
-export declare function enhanceUrlParametersWithRta(packageJson: Package, existingParams?: Record<string, string>): string;
+export declare function getRtaUrlParameters(packageJson: Package): string;
 /**
  * Returns the serve command for the preview middleware configuration of the ui5.yaml file, if given.
  * If the fiori-tools-preview middleware is used, then the serve command will be 'fiori run'.

package/dist/variants-config/utils.js

@@ -2,14 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPreviewMiddleware = getPreviewMiddleware;
 exports.isFioriToolsDeprecatedPreviewConfig = isFioriToolsDeprecatedPreviewConfig;
-exports.getSapClientFromPackageJson = getSapClientFromPackageJson;
-exports.getDependencyVersion = getDependencyVersion;
-exports.enhanceUrlParametersWithRta = enhanceUrlParametersWithRta;
+exports.getRtaUrlParameters = getRtaUrlParameters;
 exports.getRTAServe = getRTAServe;
 exports.getRTAUrl = getRTAUrl;
 const project_access_1 = require("@sap-ux/project-access");
 const types_1 = require("../types");
 const querystring_1 = require("querystring");
+const semver_1 = require("semver");
 /**
  * Gets the preview middleware form the yamlConfig or provided path.
  * The middleware can either be named 'fiori-tools-preview' or 'preview-middleware'.
@@ -39,68 +38,27 @@ function isFioriToolsDeprecatedPreviewConfig(configuration) {
     return configuration?.component !== undefined;
 }
 /**
- * Extracts sap client string from existing scripts in package.json.
- *
- * @param scripts - script section of the package.json
- * @returns sap client
- */
-function getSapClientFromPackageJson(scripts) {
-    for (const value of Object.values(scripts)) {
-        const match = value?.match(/sap-client=(\d{3})/);
-        if (match) {
-            return match[1];
-        }
-    }
-    return undefined;
-}
-/**
- * Extracts the version of the given dependency from the given package.json file.
- *
- * @param packageJson - package.json file
- * @param dependencyName - name of the (dev-)dependency
- * @returns version of the dependency as an array of numbers
- */
-function getDependencyVersion(packageJson, dependencyName) {
-    return (packageJson?.devDependencies?.[dependencyName] ?? packageJson?.dependencies?.[dependencyName])
-        ?.split('.')
-        .map((versionPart) => parseInt(versionPart, 10));
-}
-/**
- * Checks if the given version is less than the given major, minor and patch version.
- *
- * @param version - version to be checked
- * @param major - major version to be compared with
- * @param minor - minor version to be compared with
- * @param patch - patch version to be compared with
- * @returns true, if the given version is less than the given major, minor and patch version
- */
-function isVersionLessThan(version, major, minor, patch) {
-    if (!version) {
-        return undefined;
-    }
-    const [vMajor, vMinor, vPatch] = version;
-    return vMajor < major || (vMajor === major && (vMinor < minor || (vMinor === minor && vPatch < patch)));
-}
-/**
- * Enhances the given url parameters with the ones needed for the UI5 run time adaptation.
+ * Get the url parameters needed for the UI5 run time adaptation.
  *
  @param packageJson - package.json file
- * @param existingParams - parameters to be enhanced
  * @returns enhanced url parameters
  */
-function enhanceUrlParametersWithRta(packageJson, existingParams = {}) {
+function getRtaUrlParameters(packageJson) {
+    const getDependencyVersion = (packageJson, dependencyName) => {
+        return packageJson?.devDependencies?.[dependencyName] ?? packageJson?.dependencies?.[dependencyName];
+    };
     const parameters = {};
     const previewMiddlewareVersion = getDependencyVersion(packageJson, '@sap-ux/preview-middleware');
     const uxUi5ToolingVersion = getDependencyVersion(packageJson, '@sap/ux-ui5-tooling');
-    if (isVersionLessThan(previewMiddlewareVersion, 0, 16, 89) ??
-        isVersionLessThan(uxUi5ToolingVersion, 1, 15, 4) ??
-        true) {
+    if ((previewMiddlewareVersion && (0, semver_1.satisfies)(previewMiddlewareVersion, '<0.16.89')) ??
+        (uxUi5ToolingVersion && (0, semver_1.satisfies)(uxUi5ToolingVersion, '<1.15.4')) ??
+        (!previewMiddlewareVersion && !uxUi5ToolingVersion)) {
         parameters['fiori-tools-rta-mode'] = 'true';
         parameters['sap-ui-rta-skip-flex-validation'] = 'true';
         parameters['sap-ui-xx-condense-changes'] = 'true';
         parameters['sap-ui-xx-viewCache'] = 'false';
     }
-    return (0, querystring_1.stringify)(Object.assign(parameters, existingParams));
+    return (0, querystring_1.stringify)(parameters);
 }
 /**
  * Returns the RTA mount point of the preview middleware configuration from the ui5.yaml file, if given.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/app-config-writer",
   "description": "Add or update configuration for SAP Fiori tools application",
-  "version": "0.5.23",
+  "version": "0.5.25",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -42,7 +42,7 @@
     "@types/semver": "7.5.8",
     "axios": "1.7.4",
     "nock": "13.4.0",
-    "@sap-ux/preview-middleware": "0.17.14"
+    "@sap-ux/preview-middleware": "0.17.16"
   },
   "engines": {
     "node": ">=18.x"