@sap-ux/app-config-writer 1.1.1 → 1.1.2

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

@@ -0,0 +1,17 @@
+import type { Editor } from 'mem-fs-editor';
+import type { ToolsLogger } from '@sap-ux/logger';
+/**
+ * Writes the `start-cards-generator-<appFolderName>` script to the CAP root `package.json`.
+ * Uses `cds watch --open "<appId><cardGeneratorPath><intent>"` so the app is opened
+ * via the CDS development server rather than a standalone UI5 tooling server.
+ *
+ * @param capRoot - path to the CAP project root
+ * @param appId - sap.app.id from the app's manifest.json (used as the URL prefix)
+ * @param appFolderName - basename of the app folder (used as the script name suffix)
+ * @param basePath - path to the UI5 app root (where ui5.yaml lives)
+ * @param fs - mem-fs-editor instance
+ * @param yamlPath - optional path to the ui5*.yaml file
+ * @param logger - optional logger
+ */
+export declare function updateCapRootPackageJsonForCards(capRoot: string, appId: string, appFolderName: string, basePath: string, fs: Editor, yamlPath?: string, logger?: ToolsLogger): Promise<void>;
+//# sourceMappingURL=cap.d.ts.map

package/dist/cards-config/cap.js

@@ -0,0 +1,31 @@
+import { basename, join } from 'node:path';
+import { FileName, readUi5Yaml } from '@sap-ux/project-access';
+import { getPreviewMiddleware, getIntentFromPreviewConfig } from '../common/utils.js';
+import { writeCdsWatchScript } from '../common/cap-utils.js';
+/**
+ * Writes the `start-cards-generator-<appFolderName>` script to the CAP root `package.json`.
+ * Uses `cds watch --open "<appId><cardGeneratorPath><intent>"` so the app is opened
+ * via the CDS development server rather than a standalone UI5 tooling server.
+ *
+ * @param capRoot - path to the CAP project root
+ * @param appId - sap.app.id from the app's manifest.json (used as the URL prefix)
+ * @param appFolderName - basename of the app folder (used as the script name suffix)
+ * @param basePath - path to the UI5 app root (where ui5.yaml lives)
+ * @param fs - mem-fs-editor instance
+ * @param yamlPath - optional path to the ui5*.yaml file
+ * @param logger - optional logger
+ */
+export async function updateCapRootPackageJsonForCards(capRoot, appId, appFolderName, basePath, fs, yamlPath, logger) {
+    const capRootPackageJsonPath = join(capRoot, FileName.Package);
+    if (!fs.exists(capRootPackageJsonPath)) {
+        throw new Error(`package.json not found at CAP root: ${capRoot}`);
+    }
+    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';
+    writeCdsWatchScript(capRoot, `start-cards-generator-${appFolderName}`, `${appId}${cardGeneratorPath}${intent}`, fs, logger);
+}
+//# sourceMappingURL=cap.js.map

package/dist/cards-config/index.js

@@ -1,10 +1,11 @@
 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 { getPreviewMiddleware, getIntentFromPreviewConfig, getCLIForPreview, readManifest } from '../common/utils.js';
+import { FileName, readUi5Yaml, getProjectType, findCapProjectRoot } from '@sap-ux/project-access';
 import { updateMiddlewaresForPreview } from '../common/ui5-yaml.js';
 import { ensureMinUI5Version } from './prerequisites.js';
+import { updateCapRootPackageJsonForCards } from './cap.js';
 const DEPENDENCY_NAME = '@sap-ux/cards-editor-middleware';
 const CARDS_GENERATOR_MIDDLEWARE = 'sap-cards-generator';
 /**
@@ -93,10 +94,30 @@ export async function enableCardGeneratorConfig(basePath, yamlPath, logger, fs,
     fs = fs ?? create(createStorage());
     // asserts minimum UI5 version requirement before proceeding
     await ensureMinUI5Version(basePath, fs);
+    const capRoot = await findCapProjectRoot(basePath, false, fs);
+    const projectType = await getProjectType(capRoot ?? basePath);
+    if (projectType === 'CAPJava') {
+        throw new Error('The cards-editor command is not supported for CAP Java projects.');
+    }
+    if (projectType === 'CAPNodejs' && !capRoot) {
+        throw new Error(`Could not find CAP project root for path '${basePath}'.`);
+    }
     await updateMiddlewaresForPreview(fs, basePath, yamlPath, logger);
     await updateMiddlewareConfigWithGeneratorPath(fs, basePath, yamlPath, logger);
     if (updatePackage) {
-        await updatePackageJson(basePath, fs, yamlPath, logger);
+        if (projectType === 'CAPNodejs') {
+            const { manifest } = await readManifest(basePath, fs);
+            const appId = manifest['sap.app']?.id;
+            if (!appId) {
+                throw new Error(`The 'sap.app.id' property is missing in the manifest.json file.`);
+            }
+            // capRoot is non-null here: the early guard above throws.
+            // TypeScript cannot narrow across the intervening `if (updatePackage)` boundary, so the cast is required.
+            await updateCapRootPackageJsonForCards(capRoot, appId, basename(basePath), basePath, fs, yamlPath, logger);
+        }
+        else {
+            await updatePackageJson(basePath, fs, yamlPath, logger);
+        }
     }
     return fs;
 }

package/dist/common/cap-utils.d.ts

@@ -0,0 +1,13 @@
+import type { Editor } from 'mem-fs-editor';
+import type { ToolsLogger } from '@sap-ux/logger';
+/**
+ * Writes a `cds watch` script to the CAP root `package.json`.
+ *
+ * @param capRoot - path to the CAP project root
+ * @param scriptKey - key of the script to write (e.g. 'start-cards-generator-my_app')
+ * @param openPath - the path to open, relative to the CDS server root (e.g. 'ns.myapp/test/...')
+ * @param fs - mem-fs-editor instance
+ * @param logger - optional logger
+ */
+export declare function writeCdsWatchScript(capRoot: string, scriptKey: string, openPath: string, fs: Editor, logger?: ToolsLogger): void;
+//# sourceMappingURL=cap-utils.d.ts.map

package/dist/common/cap-utils.js

@@ -0,0 +1,23 @@
+import { join } from 'node:path';
+import { FileName } from '@sap-ux/project-access';
+/**
+ * Writes a `cds watch` script to the CAP root `package.json`.
+ *
+ * @param capRoot - path to the CAP project root
+ * @param scriptKey - key of the script to write (e.g. 'start-cards-generator-my_app')
+ * @param openPath - the path to open, relative to the CDS server root (e.g. 'ns.myapp/test/...')
+ * @param fs - mem-fs-editor instance
+ * @param logger - optional logger
+ */
+export function writeCdsWatchScript(capRoot, scriptKey, openPath, fs, logger) {
+    const packageJsonPath = join(capRoot, FileName.Package);
+    if (!fs.exists(packageJsonPath)) {
+        throw new Error(`package.json not found at CAP root: ${capRoot}`);
+    }
+    const packageJson = (fs.readJSON(packageJsonPath) ?? {});
+    packageJson.scripts ??= {};
+    packageJson.scripts[scriptKey] = `cds watch --open "${openPath}"`;
+    fs.writeJSON(packageJsonPath, packageJson);
+    logger?.debug(`Script '${scriptKey}' written to CAP root package.json.`);
+}
+//# sourceMappingURL=cap-utils.js.map

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

@@ -0,0 +1,17 @@
+import type { Editor } from 'mem-fs-editor';
+import type { ToolsLogger } from '@sap-ux/logger';
+/**
+ * Writes the `start-variants-management-<appFolderName>` script to the CAP root `package.json`.
+ * Uses `cds watch --open "<appId><rtaPath>"` so the app is opened via the CDS development
+ * server rather than a standalone UI5 tooling server.
+ *
+ * @param capRoot - path to the CAP project root
+ * @param appId - sap.app.id from the app's manifest.json (used as the URL prefix)
+ * @param appFolderName - basename of the app folder (used as the script name suffix)
+ * @param basePath - path to the UI5 app root (where ui5.yaml and the app package.json live)
+ * @param fs - mem-fs-editor instance
+ * @param yamlPath - optional path to the ui5*.yaml file
+ * @param logger - optional logger
+ */
+export declare function updateCapRootPackageJsonForVariants(capRoot: string, appId: string, appFolderName: string, basePath: string, fs: Editor, yamlPath?: string, logger?: ToolsLogger): Promise<void>;
+//# sourceMappingURL=cap.d.ts.map

package/dist/variants-config/cap.js

@@ -0,0 +1,31 @@
+import { basename, join } from 'node:path';
+import { FileName } from '@sap-ux/project-access';
+import { getRTAUrl, getRTAUrlParameters } from './utils.js';
+import { writeCdsWatchScript } from '../common/cap-utils.js';
+/**
+ * Writes the `start-variants-management-<appFolderName>` script to the CAP root `package.json`.
+ * Uses `cds watch --open "<appId><rtaPath>"` so the app is opened via the CDS development
+ * server rather than a standalone UI5 tooling server.
+ *
+ * @param capRoot - path to the CAP project root
+ * @param appId - sap.app.id from the app's manifest.json (used as the URL prefix)
+ * @param appFolderName - basename of the app folder (used as the script name suffix)
+ * @param basePath - path to the UI5 app root (where ui5.yaml and the app package.json live)
+ * @param fs - mem-fs-editor instance
+ * @param yamlPath - optional path to the ui5*.yaml file
+ * @param logger - optional logger
+ */
+export async function updateCapRootPackageJsonForVariants(capRoot, appId, appFolderName, basePath, fs, yamlPath, logger) {
+    const capRootPackageJsonPath = join(capRoot, FileName.Package);
+    if (!fs.exists(capRootPackageJsonPath)) {
+        throw new Error(`package.json not found at CAP root: ${capRoot}`);
+    }
+    const appPackageJson = (fs.readJSON(join(basePath, 'package.json')) ?? {});
+    const ui5YamlFileName = yamlPath ? basename(yamlPath) : FileName.Ui5Yaml;
+    const rtaUrl = await getRTAUrl(basePath, getRTAUrlParameters(appPackageJson), ui5YamlFileName, fs);
+    if (!rtaUrl) {
+        throw new Error(`Script 'start-variants-management-${appFolderName}' cannot be written to package.json. No RTA editor specified in ui5.yaml.`);
+    }
+    writeCdsWatchScript(capRoot, `start-variants-management-${appFolderName}`, `${appId}${rtaUrl}`, fs, logger);
+}
+//# sourceMappingURL=cap.js.map

package/dist/variants-config/generateVariantsConfig.js

@@ -1,7 +1,11 @@
+import { basename } from 'node:path';
 import { create } from 'mem-fs-editor';
 import { create as createStorage } from 'mem-fs';
 import { updateMiddlewaresForPreview } from '../common/ui5-yaml.js';
 import { addVariantsManagementScript } from './package-json.js';
+import { getProjectType, findCapProjectRoot } from '@sap-ux/project-access';
+import { readManifest } from '../common/utils.js';
+import { updateCapRootPackageJsonForVariants } from './cap.js';
 /**
  * Add variants configuration to an app or project.
  *
@@ -15,8 +19,28 @@ export async function generateVariantsConfig(basePath, yamlPath, logger, fs) {
     if (!fs) {
         fs = create(createStorage());
     }
+    const capRoot = await findCapProjectRoot(basePath, false, fs);
+    const projectType = await getProjectType(capRoot ?? basePath);
+    if (projectType === 'CAPJava') {
+        throw new Error('The variants-config command is not supported for CAP Java projects.');
+    }
+    if (projectType === 'CAPNodejs' && !capRoot) {
+        throw new Error(`Could not find CAP project root for path '${basePath}'.`);
+    }
     await updateMiddlewaresForPreview(fs, basePath, yamlPath, logger);
-    await addVariantsManagementScript(fs, basePath, yamlPath, logger);
+    if (projectType === 'CAPNodejs') {
+        const { manifest } = await readManifest(basePath, fs);
+        const appId = manifest['sap.app']?.id;
+        if (!appId) {
+            throw new Error(`The 'sap.app.id' property is missing in the manifest.json file.`);
+        }
+        // capRoot is non-null here: the early guard above throws when projectType === 'CAPNodejs' && !capRoot.
+        // TypeScript cannot narrow across the intervening function call boundary, so the cast is required.
+        await updateCapRootPackageJsonForVariants(capRoot, appId, basename(basePath), basePath, fs, yamlPath, logger);
+    }
+    else {
+        await addVariantsManagementScript(fs, basePath, yamlPath, logger);
+    }
     return fs;
 }
 //# sourceMappingURL=generateVariantsConfig.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.1.1",
+  "version": "1.1.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -57,7 +57,7 @@
     "@types/cross-spawn": "6.0.6",
     "axios": "1.16.0",
     "nock": "14.0.11",
-    "@sap-ux/preview-middleware": "1.0.28"
+    "@sap-ux/preview-middleware": "1.0.29"
   },
   "engines": {
     "node": ">=22.x"