@sap-ux/app-config-writer 0.5.50 → 0.5.52

package/dist/{variants-config → common}/ui5-yaml.d.ts

@@ -28,5 +28,5 @@ export declare function createPreviewMiddlewareConfig(fs: Editor, basePath: stri
  * @param yamlPath - path to the ui5*.yaml file passed by cli
  * @param logger - logger
  */
-export declare function updateMiddlewares(fs: Editor, basePath: string, yamlPath?: string, logger?: ToolsLogger): Promise<void>;
+export declare function updateMiddlewaresForPreview(fs: Editor, basePath: string, yamlPath?: string, logger?: ToolsLogger): Promise<void>;
 //# sourceMappingURL=ui5-yaml.d.ts.map

package/dist/{variants-config → common}/ui5-yaml.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getEnhancedReloadMiddleware = getEnhancedReloadMiddleware;
 exports.createPreviewMiddlewareConfig = createPreviewMiddlewareConfig;
-exports.updateMiddlewares = updateMiddlewares;
+exports.updateMiddlewaresForPreview = updateMiddlewaresForPreview;
 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 utils_1 = require("../common/utils");
 /**
  * Gets the reload middleware form the provided yamlConfig.
  * The middleware can either be named 'fiori-tools-appreload' or 'reload-middleware'.
@@ -52,7 +52,7 @@ function createPreviewMiddlewareConfig(fs, basePath) {
  * @param yamlPath - path to the ui5*.yaml file passed by cli
  * @param logger - logger
  */
-async function updateMiddlewares(fs, basePath, yamlPath, logger) {
+async function updateMiddlewaresForPreview(fs, basePath, yamlPath, logger) {
     const ui5YamlFile = yamlPath ? (0, 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);

package/dist/common/utils.d.ts

@@ -0,0 +1,41 @@
+import type { CustomMiddleware, UI5Config } from '@sap-ux/ui5-config';
+import type { PreviewConfigOptions, FioriToolsDeprecatedPreviewConfig } from '../types';
+import type { Editor } from 'mem-fs-editor';
+/**
+ * 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
+ */
+export declare function isFioriToolsDeprecatedPreviewConfig(configuration: PreviewConfigOptions | undefined): configuration is FioriToolsDeprecatedPreviewConfig;
+/**
+ * Gets the preview middleware form the yamlConfig or provided path.
+ * The middleware can either be named 'fiori-tools-preview' or 'preview-middleware'.
+ *
+ * @param yamlConfig - the yaml configuration to use; if not provided, the file will be read with the provided basePath and filename
+ * @param basePath - path to project root, where ui5.yaml is located
+ * @param filename - name of the ui5 yaml file to read from basePath; default is 'ui5.yaml'
+ * @param fs - the memfs editor instance
+ * @returns preview middleware configuration if found
+ * Rejects if neither yamlConfig nor basePath is provided or if the file can't be read
+ */
+export declare function getPreviewMiddleware(yamlConfig?: UI5Config, basePath?: string, filename?: string, fs?: Editor): Promise<CustomMiddleware<PreviewConfigOptions> | undefined>;
+/**
+ * Returns the intent of the preview middleware configuration from the ui5.yaml file, if given.
+ *
+ * @param previewMiddlewareConfig - configuration of the preview middleware
+ * @returns - preview intent or undefined
+ */
+export declare function getIntentFromPreviewConfig(previewMiddlewareConfig: PreviewConfigOptions | undefined): string | undefined;
+/**
+ * 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'.
+ * If the preview middleware is used, the serve command will be 'ui5 serve'.
+ *
+ * @param basePath - path to project root, where ui5.yaml is located
+ * @param yamlFileName - name of the ui5 yaml file to read from basePath; default is 'ui5.yaml'
+ * @param fs - the memfs editor instance
+ * @returns - preview serve or undefined
+ */
+export declare function getCLIForPreview(basePath: string, yamlFileName: string, fs: Editor): Promise<string | undefined>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/common/utils.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isFioriToolsDeprecatedPreviewConfig = isFioriToolsDeprecatedPreviewConfig;
+exports.getPreviewMiddleware = getPreviewMiddleware;
+exports.getIntentFromPreviewConfig = getIntentFromPreviewConfig;
+exports.getCLIForPreview = getCLIForPreview;
+const project_access_1 = require("@sap-ux/project-access");
+const types_1 = require("../types");
+/**
+ * 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) {
+    return configuration?.component !== undefined;
+}
+/**
+ * Gets the preview middleware form the yamlConfig or provided path.
+ * The middleware can either be named 'fiori-tools-preview' or 'preview-middleware'.
+ *
+ * @param yamlConfig - the yaml configuration to use; if not provided, the file will be read with the provided basePath and filename
+ * @param basePath - path to project root, where ui5.yaml is located
+ * @param filename - name of the ui5 yaml file to read from basePath; default is 'ui5.yaml'
+ * @param fs - the memfs editor instance
+ * @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) {
+    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));
+}
+/**
+ * Returns the intent of the preview middleware configuration from the ui5.yaml file, if given.
+ *
+ * @param previewMiddlewareConfig - configuration of the preview middleware
+ * @returns - preview intent or undefined
+ */
+function getIntentFromPreviewConfig(previewMiddlewareConfig) {
+    if (isFioriToolsDeprecatedPreviewConfig(previewMiddlewareConfig)) {
+        return undefined;
+    }
+    const intent = previewMiddlewareConfig?.flp?.intent;
+    return intent ? `#${intent.object}-${intent.action}` : undefined;
+}
+/**
+ * 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'.
+ * If the preview middleware is used, the serve command will be 'ui5 serve'.
+ *
+ * @param basePath - path to project root, where ui5.yaml is located
+ * @param yamlFileName - name of the ui5 yaml file to read from basePath; default is 'ui5.yaml'
+ * @param fs - the memfs editor instance
+ * @returns - preview serve or undefined
+ */
+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';
+}
+//# sourceMappingURL=utils.js.map

package/dist/preview-config/ui5-yaml.js

@@ -12,10 +12,10 @@ exports.updateDefaultTestConfig = updateDefaultTestConfig;
 exports.getScriptsFromPackageJson = getScriptsFromPackageJson;
 exports.updatePreviewMiddlewareConfigs = updatePreviewMiddlewareConfigs;
 const path_1 = require("path");
-const ui5_yaml_1 = require("../variants-config/ui5-yaml");
+const ui5_yaml_1 = require("../common/ui5-yaml");
 const package_json_1 = require("./package-json");
 const project_access_1 = require("@sap-ux/project-access");
-const utils_1 = require("../variants-config/utils");
+const utils_1 = require("../common/utils");
 const preview_files_1 = require("./preview-files");
 const DEFAULT_FLP_PATH = '/test/flp.html';
 const DEFAULT_INTENT = {

package/dist/variants-config/generateVariantsConfig.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateVariantsConfig = generateVariantsConfig;
 const mem_fs_editor_1 = require("mem-fs-editor");
 const mem_fs_1 = require("mem-fs");
-const ui5_yaml_1 = require("./ui5-yaml");
+const ui5_yaml_1 = require("../common/ui5-yaml");
 const package_json_1 = require("./package-json");
 /**
  * Add variants configuration to an app or project.
@@ -18,7 +18,7 @@ async function generateVariantsConfig(basePath, yamlPath, logger, fs) {
     if (!fs) {
         fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     }
-    await (0, ui5_yaml_1.updateMiddlewares)(fs, basePath, yamlPath, logger);
+    await (0, ui5_yaml_1.updateMiddlewaresForPreview)(fs, basePath, yamlPath, logger);
     await (0, package_json_1.addVariantsManagementScript)(fs, basePath, yamlPath, logger);
     return fs;
 }

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.addVariantsManagementScript = addVariantsManagementScript;
 const path_1 = require("path");
 const utils_1 = require("./utils");
+const utils_2 = require("../common/utils");
 const project_access_1 = require("@sap-ux/project-access");
 const ERROR_MSG = `Script 'start-variants-management' cannot be written to package.json.`;
 /**
@@ -25,8 +26,8 @@ async function addVariantsManagementScript(fs, basePath, yamlPath, logger) {
         logger?.warn(`File 'package.json' does not contain a script section. Script section added.`);
         packageJson.scripts = {};
     }
-    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);
+    const url = await (0, utils_1.getRTAUrl)(basePath, (0, utils_1.getRTAUrlParameters)(packageJson), ui5YamlFileName, fs);
+    const serveCommand = await (0, utils_2.getCLIForPreview)(basePath, ui5YamlFileName, fs);
     if (!url) {
         throw new Error(`${ERROR_MSG} No RTA editor specified in ui5.yaml.`);
     }

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

@@ -1,44 +1,12 @@
 import type { Package } from '@sap-ux/project-access';
-import type { CustomMiddleware, UI5Config } from '@sap-ux/ui5-config';
-import type { PreviewConfigOptions, FioriToolsDeprecatedPreviewConfig } from '../types';
 import type { Editor } from 'mem-fs-editor';
-/**
- * Gets the preview middleware form the yamlConfig or provided path.
- * The middleware can either be named 'fiori-tools-preview' or 'preview-middleware'.
- *
- * @param yamlConfig - the yaml configuration to use; if not provided, the file will be read with the provided basePath and filename
- * @param basePath - path to project root, where ui5.yaml is located
- * @param filename - name of the ui5 yaml file to read from basePath; default is 'ui5.yaml'
- * @param fs - the memfs editor instance
- * @returns preview middleware configuration if found
- * Rejects if neither yamlConfig nor basePath is provided or if the file can't be read
- */
-export declare function getPreviewMiddleware(yamlConfig?: UI5Config, basePath?: string, filename?: string, fs?: Editor): Promise<CustomMiddleware<PreviewConfigOptions> | undefined>;
-/**
- * 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
- */
-export declare function isFioriToolsDeprecatedPreviewConfig(configuration: PreviewConfigOptions | undefined): configuration is FioriToolsDeprecatedPreviewConfig;
 /**
  * Get the url parameters needed for the UI5 run time adaptation.
  *
  @param packageJson - package.json file
  * @returns enhanced url parameters
  */
-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'.
- * If the preview middleware is used, the serve command will be 'ui5 serve'.
- *
- * @param basePath - path to project root, where ui5.yaml is located
- * @param yamlFileName - name of the ui5 yaml file to read from basePath; default is 'ui5.yaml'
- * @param fs - the memfs editor instance
- * @returns - preview serve or undefined
- */
-export declare function getRTAServe(basePath: string, yamlFileName: string, fs: Editor): Promise<string | undefined>;
+export declare function getRTAUrlParameters(packageJson: Package): string;
 /**
  * Returns the url for variants management in RTA mode.
  * The url consist of a specified mount point and intent given from the ui5.yaml file as well as parameters for the RTA mode.

package/dist/variants-config/utils.js

@@ -1,49 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPreviewMiddleware = getPreviewMiddleware;
-exports.isFioriToolsDeprecatedPreviewConfig = isFioriToolsDeprecatedPreviewConfig;
-exports.getRtaUrlParameters = getRtaUrlParameters;
-exports.getRTAServe = getRTAServe;
+exports.getRTAUrlParameters = getRTAUrlParameters;
 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'.
- *
- * @param yamlConfig - the yaml configuration to use; if not provided, the file will be read with the provided basePath and filename
- * @param basePath - path to project root, where ui5.yaml is located
- * @param filename - name of the ui5 yaml file to read from basePath; default is 'ui5.yaml'
- * @param fs - the memfs editor instance
- * @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) {
-    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));
-}
-/**
- * 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) {
-    return configuration?.component !== undefined;
-}
+const utils_1 = require("../common/utils");
 /**
  * Get the url parameters needed for the UI5 run time adaptation.
  *
  @param packageJson - package.json file
  * @returns enhanced url parameters
  */
-function getRtaUrlParameters(packageJson) {
+function getRTAUrlParameters(packageJson) {
     const getDependencyVersion = (packageJson, dependencyName) => {
         return packageJson?.devDependencies?.[dependencyName] ?? packageJson?.dependencies?.[dependencyName];
     };
@@ -67,8 +36,9 @@ function getRtaUrlParameters(packageJson) {
  * @returns - RTA mount point or undefined
  */
 function getRTAMountPoint(previewMiddlewareConfig) {
-    if (!isFioriToolsDeprecatedPreviewConfig(previewMiddlewareConfig) && previewMiddlewareConfig?.rta?.editors) {
-        const editors = previewMiddlewareConfig.rta.editors;
+    if (!(0, utils_1.isFioriToolsDeprecatedPreviewConfig)(previewMiddlewareConfig) && previewMiddlewareConfig?.rta?.editors) {
+        // check if deprecated RTA config is used
+        const editors = previewMiddlewareConfig.rta.editors ?? previewMiddlewareConfig?.editors?.rta?.endpoints; //NOSONAR
         for (const editor of editors) {
             if (!('developerMode' in editor)) {
                 return editor.path;
@@ -77,33 +47,6 @@ function getRTAMountPoint(previewMiddlewareConfig) {
     }
     return undefined;
 }
-/**
- * Returns the intent of the preview middleware configuration from the ui5.yaml file, if given.
- *
- * @param previewMiddlewareConfig - configuration of the preview middleware
- * @returns - preview intent or undefined
- */
-function getRTAIntent(previewMiddlewareConfig) {
-    if (isFioriToolsDeprecatedPreviewConfig(previewMiddlewareConfig)) {
-        return undefined;
-    }
-    const intent = previewMiddlewareConfig?.flp?.intent;
-    return intent ? `#${intent.object}-${intent.action}` : undefined;
-}
-/**
- * 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'.
- * If the preview middleware is used, the serve command will be 'ui5 serve'.
- *
- * @param basePath - path to project root, where ui5.yaml is located
- * @param yamlFileName - name of the ui5 yaml file to read from basePath; default is 'ui5.yaml'
- * @param fs - the memfs editor instance
- * @returns - preview serve or undefined
- */
-async function getRTAServe(basePath, yamlFileName, fs) {
-    const previewMiddleware = await getPreviewMiddleware(undefined, basePath, yamlFileName, fs);
-    return previewMiddleware?.name === types_1.MiddlewareConfigs.PreviewMiddleware ? 'ui5 serve' : 'fiori run';
-}
 /**
  * Returns the url for variants management in RTA mode.
  * The url consist of a specified mount point and intent given from the ui5.yaml file as well as parameters for the RTA mode.
@@ -117,7 +60,7 @@ async function getRTAServe(basePath, yamlFileName, fs) {
 async function getRTAUrl(basePath, query, yamlFileName, fs) {
     let previewMiddleware;
     try {
-        previewMiddleware = await getPreviewMiddleware(undefined, basePath, yamlFileName, fs);
+        previewMiddleware = await (0, utils_1.getPreviewMiddleware)(undefined, basePath, yamlFileName, fs);
     }
     catch (error) {
         throw new Error(`No ${yamlFileName} file found. ${error}`);
@@ -127,9 +70,9 @@ async function getRTAUrl(basePath, query, yamlFileName, fs) {
         return undefined;
     }
     const mountPoint = getRTAMountPoint(previewMiddleware?.configuration) ?? '/preview.html';
-    const intent = getRTAIntent(previewMiddleware?.configuration) ?? '#app-preview';
+    const intent = (0, utils_1.getIntentFromPreviewConfig)(previewMiddleware?.configuration) ?? '#app-preview';
     const queryString = query ? '?' + query : '';
-    return isFioriToolsDeprecatedPreviewConfig(previewMiddleware?.configuration)
+    return (0, utils_1.isFioriToolsDeprecatedPreviewConfig)(previewMiddleware?.configuration)
         ? `${mountPoint}${queryString}#preview-app`
         : `${mountPoint}${queryString}${intent}`;
 }

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.50",
+  "version": "0.5.52",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -27,7 +27,7 @@
     "mem-fs-editor": "9.4.0",
     "prompts": "2.4.2",
     "semver": "7.6.3",
-    "@sap-ux/axios-extension": "1.20.1",
+    "@sap-ux/axios-extension": "1.20.2",
     "@sap-ux/btp-utils": "1.0.3",
     "@sap-ux/logger": "0.6.0",
     "@sap-ux/project-access": "1.29.21",
@@ -42,7 +42,7 @@
     "@types/semver": "7.5.8",
     "axios": "1.8.2",
     "nock": "13.4.0",
-    "@sap-ux/preview-middleware": "0.19.32"
+    "@sap-ux/preview-middleware": "0.19.37"
   },
   "engines": {
     "node": ">=18.x"