@sap-ux/app-config-writer 0.6.10 → 0.6.11

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

@@ -2,12 +2,20 @@ import type { Editor } from 'mem-fs-editor';
 import type { ToolsLogger } from '@sap-ux/logger';
 import type { PreviewConfigOptions } from '../types';
 import type { CustomMiddleware, FioriAppReloadConfig, UI5Config } from '@sap-ux/ui5-config';
-import { type DefaultFlpPath, type MiddlewareConfig as PreviewConfig, type TestConfig } from '@sap-ux/preview-middleware';
+import { type DefaultFlpPath, type MiddlewareConfig as PreviewConfig, type TestConfig, type RtaConfig } from '@sap-ux/preview-middleware';
 import { type Script } from './package-json';
 type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType[number];
 type PreviewTestConfig = ArrayElement<Required<PreviewConfig>['test']>;
 export declare const DEFAULT_FLP_PATH: DefaultFlpPath;
 export declare const TEST_CONFIG_DEFAULTS: Record<string, Readonly<Required<PreviewTestConfig>>>;
+/**
+ * Sanitize the deprecated RTA configuration.
+ *
+ * @param deprecatedRtaConfig deprecated RTA configuration
+ * @param logger logger instance
+ * @returns sanitized RTA configuration
+ */
+export declare function sanitizeRtaConfig(deprecatedRtaConfig: PreviewConfig['rta'], logger?: ToolsLogger): RtaConfig | undefined;
 /**
  * Gets the reload middleware form the provided yamlConfig.
  * The middleware can either be named 'fiori-tools-appreload' or 'reload-middleware'.
@@ -44,9 +52,10 @@ export declare function updateMiddlewaresForPreview(fs: Editor, basePath: string
  * - no longer used property 'component' will be removed.
  *
  * @param previewMiddleware - the preview middleware
+ * @param logger - logger to report info to the user
  * @returns the sanitized preview middleware
  */
-export declare function sanitizePreviewMiddleware(previewMiddleware: CustomMiddleware<PreviewConfigOptions>): CustomMiddleware<PreviewConfig | undefined>;
+export declare function sanitizePreviewMiddleware(previewMiddleware: CustomMiddleware<PreviewConfigOptions>, logger?: ToolsLogger): CustomMiddleware<PreviewConfig | undefined>;
 /**
  * Creates a preview middleware configuration.
  *

package/dist/common/ui5-yaml.js

@@ -1,6 +1,7 @@
 "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;
@@ -12,7 +13,6 @@ const path_1 = require("path");
 const types_1 = require("../types");
 const project_access_1 = require("@sap-ux/project-access");
 const utils_1 = require("./utils");
-const preview_middleware_1 = require("@sap-ux/preview-middleware");
 const package_json_1 = require("./package-json");
 const DEFAULT_INTENT = {
     object: 'app',
@@ -33,6 +33,23 @@ exports.TEST_CONFIG_DEFAULTS = {
         framework: 'Testsuite'
     }
 };
+/**
+ * Sanitize the deprecated RTA configuration.
+ *
+ * @param deprecatedRtaConfig deprecated RTA configuration
+ * @param logger logger instance
+ * @returns sanitized RTA configuration
+ */
+//prettier-ignore
+function sanitizeRtaConfig(deprecatedRtaConfig, logger) {
+    let rtaConfig;
+    if (deprecatedRtaConfig) {
+        const { editors, ...rta } = deprecatedRtaConfig;
+        rtaConfig = { ...rta, endpoints: [...editors] };
+        logger?.warn(`The configuration option 'rta' is deprecated and has been adjusted to 'editors.rta'.`);
+    }
+    return rtaConfig;
+}
 /**
  * Gets the reload middleware form the provided yamlConfig.
  * The middleware can either be named 'fiori-tools-appreload' or 'reload-middleware'.
@@ -115,15 +132,16 @@ async function updateMiddlewaresForPreview(fs, basePath, yamlPath, logger) {
  * - no longer used property 'component' will be removed.
  *
  * @param previewMiddleware - the preview middleware
+ * @param logger - logger to report info to the user
  * @returns the sanitized preview middleware
  */
-function sanitizePreviewMiddleware(previewMiddleware) {
+function sanitizePreviewMiddleware(previewMiddleware, logger) {
     if (!previewMiddleware.configuration) {
         return previewMiddleware;
     }
     //if we find the deprecated 'rta.editors' config, we will sanitize it
     if ('rta' in previewMiddleware.configuration) {
-        const rtaConfig = (0, preview_middleware_1.sanitizeRtaConfig)(previewMiddleware.configuration.rta); //NOSONAR
+        const rtaConfig = sanitizeRtaConfig(previewMiddleware.configuration.rta, logger); //NOSONAR
         delete previewMiddleware.configuration.rta; //NOSONAR
         previewMiddleware.configuration.editors ??= {};
         previewMiddleware.configuration.editors.rta = rtaConfig;
@@ -157,7 +175,7 @@ function sanitizePreviewMiddleware(previewMiddleware) {
 async function updatePreviewMiddlewareConfig(previewMiddleware, script, basePath, fs, logger) {
     const { path, intent } = (0, package_json_1.extractUrlDetails)(script.value);
     const defaultIntent = `${DEFAULT_INTENT.object}-${DEFAULT_INTENT.action}`;
-    const newMiddlewareConfig = sanitizePreviewMiddleware(previewMiddleware);
+    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;

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.6.10",
+  "version": "0.6.11",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -31,8 +31,8 @@
     "@sap-ux/btp-utils": "1.1.0",
     "@sap-ux/logger": "0.7.0",
     "@sap-ux/project-access": "1.30.2",
-    "@sap-ux/store": "1.1.0",
-    "@sap-ux/ui5-config": "0.28.2"
+    "@sap-ux/ui5-config": "0.28.2",
+    "@sap-ux/store": "1.1.0"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
@@ -42,7 +42,7 @@
     "@types/semver": "7.5.8",
     "axios": "1.8.2",
     "nock": "13.4.0",
-    "@sap-ux/preview-middleware": "0.20.29"
+    "@sap-ux/preview-middleware": "0.20.37"
   },
   "engines": {
     "node": ">=20.x"