@sap-ux/app-config-writer 1.0.10 → 1.1.0

package/dist/cards-config/index.d.ts

@@ -3,14 +3,17 @@ import type { ToolsLogger } from '@sap-ux/logger';
 /**
  * Enables the card generator configuration for the given application.
  *
- * This function updates the `ui5.yaml` file to include the necessary middlewares for the card generator
+ * This function validates that the project meets the minimum UI5 version requirements,
+ * then updates the `ui5.yaml` file to include the necessary middlewares for the card generator
  * and modifies the `package.json` file to add a script for starting the card generator.
  *
  * @param {string} basePath - The path to the project root.
  * @param {string} [yamlPath] - Optional path to the `ui5.yaml` configuration file.
  * @param {ToolsLogger} [logger] - Optional logger instance for logging messages.
  * @param {Editor} [fs] - Optional `mem-fs-editor` instance for file system operations. If not provided, a new instance will be created.
+ * @param {boolean} [updatePackage] - Optional flag to update the `package.json` file. Defaults to true.
  * @returns {Promise<Editor>} A promise that resolves to the updated `mem-fs-editor` instance.
+ * @throws {Error} If minimum UI5 version requirement is not met (EDMX: ≥1.121.0, CAP: ≥1.149.0).
  */
-export declare function enableCardGeneratorConfig(basePath: string, yamlPath?: string, logger?: ToolsLogger, fs?: Editor): Promise<Editor>;
+export declare function enableCardGeneratorConfig(basePath: string, yamlPath?: string, logger?: ToolsLogger, fs?: Editor, updatePackage?: boolean): Promise<Editor>;
 //# sourceMappingURL=index.d.ts.map

package/dist/cards-config/index.js

@@ -4,6 +4,7 @@ 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';
+import { ensureMinUI5Version } from './prerequisites.js';
 const DEPENDENCY_NAME = '@sap-ux/cards-editor-middleware';
 const CARDS_GENERATOR_MIDDLEWARE = 'sap-cards-generator';
 /**
@@ -76,20 +77,27 @@ async function updatePackageJson(basePath, fs, yamlPath, logger) {
 /**
  * Enables the card generator configuration for the given application.
  *
- * This function updates the `ui5.yaml` file to include the necessary middlewares for the card generator
+ * This function validates that the project meets the minimum UI5 version requirements,
+ * then updates the `ui5.yaml` file to include the necessary middlewares for the card generator
  * and modifies the `package.json` file to add a script for starting the card generator.
  *
  * @param {string} basePath - The path to the project root.
  * @param {string} [yamlPath] - Optional path to the `ui5.yaml` configuration file.
  * @param {ToolsLogger} [logger] - Optional logger instance for logging messages.
  * @param {Editor} [fs] - Optional `mem-fs-editor` instance for file system operations. If not provided, a new instance will be created.
+ * @param {boolean} [updatePackage] - Optional flag to update the `package.json` file. Defaults to true.
  * @returns {Promise<Editor>} A promise that resolves to the updated `mem-fs-editor` instance.
+ * @throws {Error} If minimum UI5 version requirement is not met (EDMX: ≥1.121.0, CAP: ≥1.149.0).
  */
-export async function enableCardGeneratorConfig(basePath, yamlPath, logger, fs) {
+export async function enableCardGeneratorConfig(basePath, yamlPath, logger, fs, updatePackage = true) {
     fs = fs ?? create(createStorage());
+    // asserts minimum UI5 version requirement before proceeding
+    await ensureMinUI5Version(basePath, fs);
     await updateMiddlewaresForPreview(fs, basePath, yamlPath, logger);
     await updateMiddlewareConfigWithGeneratorPath(fs, basePath, yamlPath, logger);
-    await updatePackageJson(basePath, fs, yamlPath, logger);
+    if (updatePackage) {
+        await updatePackageJson(basePath, fs, yamlPath, logger);
+    }
     return fs;
 }
 //# sourceMappingURL=index.js.map

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

@@ -0,0 +1,12 @@
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Ensures the minimum UI5 version requirement for card generator is met.
+ * - For EDMX projects: UI5 version 1.121.0 or higher is required.
+ * - For CAP projects: UI5 version 1.149.0 or higher is required.
+ *
+ * @param basePath - base path to be used for the check
+ * @param fs - file system reference
+ * @throws {Error} if the minimum UI5 version requirement is not met
+ */
+export declare function ensureMinUI5Version(basePath: string, fs: Editor): Promise<void>;
+//# sourceMappingURL=prerequisites.d.ts.map

package/dist/cards-config/prerequisites.js

@@ -0,0 +1,26 @@
+import { getMinimumUI5Version, getProjectType, findProjectRoot } from '@sap-ux/project-access';
+import { gte } from 'semver';
+import { readManifest } from '../common/utils.js';
+const MIN_UI5_VERSION_EDMX = '1.121.0';
+const MIN_UI5_VERSION_CAP = '1.149.0';
+/**
+ * Ensures the minimum UI5 version requirement for card generator is met.
+ * - For EDMX projects: UI5 version 1.121.0 or higher is required.
+ * - For CAP projects: UI5 version 1.149.0 or higher is required.
+ *
+ * @param basePath - base path to be used for the check
+ * @param fs - file system reference
+ * @throws {Error} if the minimum UI5 version requirement is not met
+ */
+export async function ensureMinUI5Version(basePath, fs) {
+    const { manifest } = await readManifest(basePath, fs);
+    const minUI5Version = getMinimumUI5Version(manifest);
+    const projectRoot = await findProjectRoot(basePath, true, true, fs);
+    const isEdmx = (await getProjectType(projectRoot)) === 'EDMXBackend';
+    const featureVersion = isEdmx ? MIN_UI5_VERSION_EDMX : MIN_UI5_VERSION_CAP;
+    // No or invalid sap.ui5.minUi5Version property value will lead to the check being passed
+    if (minUI5Version && !gte(minUI5Version, featureVersion)) {
+        throw new Error(`The card generator is only supported for projects with a minimum SAPUI5 version of ${featureVersion} or higher. The detected minimum SAPUI5 version is ${minUI5Version}. Update the sap.ui5.minUI5Version property in the manifest.json file and ensure the SAPUI5 version used is ${featureVersion} or higher.`);
+    }
+}
+//# sourceMappingURL=prerequisites.js.map

package/dist/common/utils.d.ts

@@ -1,3 +1,4 @@
+import { type Manifest } from '@sap-ux/project-access';
 import type { CustomMiddleware, UI5Config } from '@sap-ux/ui5-config';
 import type { PreviewConfigOptions, FioriToolsDeprecatedPreviewConfig } from '../types/index.js';
 import type { Editor } from 'mem-fs-editor';
@@ -47,4 +48,16 @@ export declare function getCLIForPreview(basePath: string, yamlFileName: string,
  * @param logger logger to report info to the user
  */
 export declare function deleteFiles(fs: Editor, files: string[], logger?: ToolsLogger): Promise<void>;
+/**
+ * Reads the manifest.json file from the application path.
+ *
+ * @param appPath - path to the application root
+ * @param fs - file system reference
+ * @returns object containing the parsed manifest and its file path
+ * @throws {Error} if manifest.json is not found or sap.app section is missing
+ */
+export declare function readManifest(appPath: string, fs: Editor): Promise<{
+    manifest: Manifest;
+    manifestPath: string;
+}>;
 //# sourceMappingURL=utils.d.ts.map

package/dist/common/utils.js

@@ -1,6 +1,6 @@
-import { FileName, readUi5Yaml } from '@sap-ux/project-access';
+import { FileName, readUi5Yaml, getWebappPath } from '@sap-ux/project-access';
 import { MiddlewareConfigs } from '../types/index.js';
-import { basename } from 'node:path';
+import { basename, join } from 'node:path';
 /**
  * Type guard to check if the given configuration is a deprecated preview middleware configuration.
  *
@@ -71,4 +71,26 @@ export async function deleteFiles(fs, files, logger) {
         }
     });
 }
+/**
+ * Reads the manifest.json file from the application path.
+ *
+ * @param appPath - path to the application root
+ * @param fs - file system reference
+ * @returns object containing the parsed manifest and its file path
+ * @throws {Error} if manifest.json is not found or sap.app section is missing
+ */
+export async function readManifest(appPath, fs) {
+    const manifestPath = join(await getWebappPath(appPath, fs), FileName.Manifest);
+    const manifest = fs.readJSON(manifestPath);
+    if (!manifest) {
+        throw new Error(`The \`manifest.json\` file was not found at path: ${manifestPath}. Check the file exists.`);
+    }
+    if (!manifest['sap.app']) {
+        throw new Error(`The \`manifest.json\` file is missing the \`sap.app\` required section.`);
+    }
+    return {
+        manifest,
+        manifestPath
+    };
+}
 //# sourceMappingURL=utils.js.map

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 export { getSmartLinksTargetFromPrompt, simulatePrompt, includeTestRunnersPrompt } from './prompt/index.js';
 export { generateSmartLinksConfig } from './smartlinks-config/index.js';
 export { generateEslintConfig, convertEslintConfig } from './eslint-config/index.js';
-export { generateInboundNavigationConfig, readManifest } from './navigation-config/index.js';
+export { generateInboundNavigationConfig } from './navigation-config/index.js';
+export { readManifest } from './common/utils.js';
 export { generateVariantsConfig } from './variants-config/index.js';
 export { convertToVirtualPreview } from './preview-config/index.js';
 export { enableCardGeneratorConfig } from './cards-config/index.js';

package/dist/index.js

@@ -1,7 +1,8 @@
 export { getSmartLinksTargetFromPrompt, simulatePrompt, includeTestRunnersPrompt } from './prompt/index.js';
 export { generateSmartLinksConfig } from './smartlinks-config/index.js';
 export { generateEslintConfig, convertEslintConfig } from './eslint-config/index.js';
-export { generateInboundNavigationConfig, readManifest } from './navigation-config/index.js';
+export { generateInboundNavigationConfig } from './navigation-config/index.js';
+export { readManifest } from './common/utils.js';
 export { generateVariantsConfig } from './variants-config/index.js';
 export { convertToVirtualPreview } from './preview-config/index.js';
 export { enableCardGeneratorConfig } from './cards-config/index.js';

package/dist/navigation-config/index.d.ts

@@ -1,4 +1,4 @@
-import type { Manifest, ManifestNamespace } from '@sap-ux/project-access';
+import type { ManifestNamespace } from '@sap-ux/project-access';
 import type { Editor } from 'mem-fs-editor';
 /**
  * Adds a basic inbound navigation configuration to the application manifest.
@@ -14,16 +14,4 @@ import type { Editor } from 'mem-fs-editor';
  * @returns file system reference
  */
 export declare function generateInboundNavigationConfig(appRootPath: string, { semanticObject, action, title, subTitle }: ManifestNamespace.Inbound[string], overwrite?: boolean, fs?: Editor): Promise<Editor>;
-/**
- * Validates the basic manifest structure and existence required for inbound navigation addition.
- *
- * @param appPath path to the application
- * @param fs Editor instance
- * @throws an error specifiying the validation failure
- * @returns the manifest object and manifest path
- */
-export declare function readManifest(appPath: string, fs: Editor): Promise<{
-    manifest: Manifest;
-    manifestPath: string;
-}>;
 //# sourceMappingURL=index.d.ts.map

package/dist/navigation-config/index.js

@@ -1,9 +1,8 @@
-import { FileName, getWebappPath } from '@sap-ux/project-access';
 import { create as createStorage } from 'mem-fs';
 import { create } from 'mem-fs-editor';
 import { mergeObjects } from '@sap-ux/ui5-config';
-import { join } from 'node:path';
 import { NAV_CONFIG_NS, t } from '../i18n.js';
+import { readManifest } from '../common/utils.js';
 /**
  * Adds a basic inbound navigation configuration to the application manifest.
  *
@@ -44,26 +43,4 @@ export async function generateInboundNavigationConfig(appRootPath, { semanticObj
     fs.extendJSON(manifestPath, { 'sap.app': Object.assign(manifest['sap.app'], { crossNavigation }) });
     return fs;
 }
-/**
- * Validates the basic manifest structure and existence required for inbound navigation addition.
- *
- * @param appPath path to the application
- * @param fs Editor instance
- * @throws an error specifiying the validation failure
- * @returns the manifest object and manifest path
- */
-export async function readManifest(appPath, fs) {
-    const manifestPath = join(await getWebappPath(appPath, fs), FileName.Manifest);
-    const manifest = fs.readJSON(manifestPath);
-    if (!manifest) {
-        throw Error(t('error.manifestNotFound', { path: manifestPath, ns: NAV_CONFIG_NS }));
-    }
-    if (!manifest['sap.app']) {
-        throw Error(t('error.sapAppNotDefined', { ns: NAV_CONFIG_NS }));
-    }
-    return {
-        manifest,
-        manifestPath
-    };
-}
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/app-config-writer",
   "description": "Add or update configuration for SAP Fiori tools application",
-  "version": "1.0.10",
+  "version": "1.1.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -13,6 +13,16 @@
   },
   "license": "Apache-2.0",
   "main": "dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./cards-config": {
+      "types": "./dist/cards-config/index.d.ts",
+      "default": "./dist/cards-config/index.js"
+    }
+  },
   "files": [
     "LICENSE",
     "dist",
@@ -29,8 +39,8 @@
     "prompts": "2.4.2",
     "semver": "7.7.4",
     "cross-spawn": "7.0.6",
-    "@sap-ux/axios-extension": "2.0.3",
     "@sap-ux/ui5-application-writer": "2.0.4",
+    "@sap-ux/axios-extension": "2.0.3",
     "@sap-ux/btp-utils": "2.0.2",
     "@sap-ux/logger": "1.0.1",
     "@sap-ux/project-access": "2.1.2",
@@ -47,7 +57,7 @@
     "@types/cross-spawn": "6.0.6",
     "axios": "1.16.0",
     "nock": "14.0.11",
-    "@sap-ux/preview-middleware": "1.0.17"
+    "@sap-ux/preview-middleware": "1.0.26"
   },
   "engines": {
     "node": ">=22.x"