@sap-ux/cap-config-writer 0.10.26 → 0.11.0

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

@@ -1,6 +1,7 @@
 import type { Editor } from 'mem-fs-editor';
 /**
  * Enable workspace and cds-plugin-ui5 for given CAP project.
+ * If the minimum required version for @sap/cds is not met, it will update to the minimum required for cds-plugin-ui5.
  *
  * @param basePath - root path of the CAP project, where package.json is located
  * @param [fs] - optional: the memfs editor instance

package/dist/cap-config/index.js

@@ -7,6 +7,7 @@ const mem_fs_editor_1 = require("mem-fs-editor");
 const package_json_1 = require("./package-json");
 /**
  * Enable workspace and cds-plugin-ui5 for given CAP project.
+ * If the minimum required version for @sap/cds is not met, it will update to the minimum required for cds-plugin-ui5.
  *
  * @param basePath - root path of the CAP project, where package.json is located
  * @param [fs] - optional: the memfs editor instance

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

@@ -39,7 +39,16 @@ export interface CapProjectSettings {
     packageName: string;
     appId: string;
     sapux?: boolean;
+    /**
+     * @deprecated
+     * Indicates if NPM workspaces will be enabled.
+     * If cds-ui5-plugin is added or `enableCdsUi5Plugin` is true then npm workspaces is enabled.
+     */
     enableNPMWorkspaces?: boolean;
+    /**
+     * Indicates if the CDS UI5 plugin will be added.
+     * If true, npm workspaces will also be automatically enabled.
+     */
     enableCdsUi5Plugin?: boolean;
     enableTypescript?: boolean;
 }

package/dist/cap-writer/package-json.d.ts

@@ -1,6 +1,5 @@
-import type { Editor } from 'mem-fs-editor';
 import type { CapServiceCdsInfo } from '../cap-config/types';
-import type { Logger } from '@sap-ux/logger';
+import type { Editor } from 'mem-fs-editor';
 /**
  * Retrieves the CDS watch script for the CAP app.
  *
@@ -22,11 +21,10 @@ export declare function getCDSWatchScript(projectName: string, appId?: string):
  * @param {boolean} sapux - Whether to add the app name to the sapux array.
  * @param {CapServiceCdsInfo} capService - The CAP service instance.
  * @param {string} appId - The application's ID, including its namespace and the module name.
- * @param {Logger} [log] - The logger instance for logging warnings.
- * @param {boolean} [enableNPMWorkspaces] - Whether to enable npm workspaces.
+ * @param {boolean} addCdsUi5Plugin - whether to add the cds ui5 plugin.
  * @returns {Promise<void>} A Promise that resolves once the root package.json is updated.
  */
-export declare function updateRootPackageJson(fs: Editor, projectName: string, sapux: boolean, capService: CapServiceCdsInfo, appId: string, log?: Logger, enableNPMWorkspaces?: boolean): Promise<void>;
+export declare function updateRootPackageJson(fs: Editor, projectName: string, sapux: boolean, capService: CapServiceCdsInfo, appId: string, addCdsUi5Plugin?: boolean): Promise<void>;
 /**
  * Updates the package.json file of a CAP project app by removing the sapux property
  * and start scripts, as well as the 'int-test' script.

package/dist/cap-writer/package-json.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCDSWatchScript = getCDSWatchScript;
 exports.updateRootPackageJson = updateRootPackageJson;
 exports.updateAppPackageJson = updateAppPackageJson;
+const fs_1 = require("fs");
 const project_access_1 = require("@sap-ux/project-access");
 const path_1 = require("path");
 const cap_config_1 = require("../cap-config");
@@ -34,28 +35,63 @@ function getCDSWatchScript(projectName, appId) {
 function updatePackageJsonWithScripts(fs, packageJsonPath, scripts) {
     fs.extendJSON(packageJsonPath, { scripts });
 }
+/**
+ * Returns updated watch scripts for the package.json.
+ *
+ * @param fs - the file system editor
+ * @param projectPath - the path to the cap project
+ * @param appsPath - the path to the apps directory
+ * @param packageJson - the package.json object
+ * @returns - the watch scripts for existing applications
+ */
+async function updateExistingWatchScripts(fs, projectPath, appsPath, packageJson) {
+    const cdsScripts = {};
+    if (!packageJson?.scripts) {
+        return cdsScripts;
+    }
+    for (const script in packageJson.scripts) {
+        if (script.startsWith('watch-') && packageJson?.scripts?.[script]?.includes('/webapp/')) {
+            const appName = script.split('-')[1];
+            const appPath = (0, path_1.join)(projectPath, appsPath, appName);
+            if ((0, fs_1.existsSync)(appPath)) {
+                const manifestPath = (0, path_1.join)(await (0, project_access_1.getWebappPath)(appPath), project_access_1.FileName.Manifest);
+                const manifest = fs.readJSON(manifestPath);
+                const appId = manifest['sap.app']?.id;
+                if (appId) {
+                    Object.assign(cdsScripts, getCDSWatchScript(appName, appId));
+                }
+            }
+        }
+    }
+    return cdsScripts;
+}
 /**
  * Updates the scripts in the package json file for a CAP project.
  *
  * @param {Editor} fs - The file system editor.
- * @param {string} packageJsonPath - The path to the package.json file.
- * @param {string} projectName - The project's name, which is the module name.
- * @param {string} appId - The application's ID, including its namespace and the module name.
- * @param {boolean} [enableNPMWorkspaces] - Whether to enable npm workspaces.
+ * @param {Package} packageJson - The package.json object to be updated.
+ * @param project - project details.
+ * @param {string} project.projectPath - the path to the CAP project.
+ * @param {string} project.projectName - the project name.
+ * @param {string} project.appsPath - the path to the apps directory in the cap project
+ * @param {string} project.appId - The application's ID, including its namespace and the module name.
+ * @param {boolean} addCdsUi5Plugin - whether to add cds ui5 plugin.
  * @returns {Promise<void>} A Promise that resolves once the scripts are updated.
  */
-async function updateScripts(fs, packageJsonPath, projectName, appId, enableNPMWorkspaces) {
-    const hasNPMworkspaces = await (0, project_access_1.checkCdsUi5PluginEnabled)((0, path_1.dirname)(packageJsonPath), fs);
-    let cdsScript;
+async function updateScripts(fs, packageJson, { projectPath, projectName, appsPath, appId }, addCdsUi5Plugin) {
+    let cdsScripts = {};
     // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
-    if (enableNPMWorkspaces || hasNPMworkspaces) {
-        // If the project uses npm workspaces (and specifically cds-plugin-ui5 ) then the project is served using the appId
-        cdsScript = getCDSWatchScript(projectName, appId);
+    if (addCdsUi5Plugin) {
+        // If the project has the cds-plugin-ui5 then the project is served using the appId
+        // Update existing watch scripts if they exist
+        Object.assign(cdsScripts, await updateExistingWatchScripts(fs, projectPath, appsPath, packageJson));
+        // Add the watch script for the new app
+        Object.assign(cdsScripts, getCDSWatchScript(projectName, appId));
     }
     else {
-        cdsScript = getCDSWatchScript(projectName);
+        cdsScripts = getCDSWatchScript(projectName);
     }
-    updatePackageJsonWithScripts(fs, packageJsonPath, cdsScript);
+    updatePackageJsonWithScripts(fs, (0, path_1.join)(projectPath, 'package.json'), cdsScripts);
 }
 /**
  * Updates the root package.json file of CAP projects with the following changes:
@@ -67,22 +103,22 @@ async function updateScripts(fs, packageJsonPath, projectName, appId, enableNPMW
  * @param {boolean} sapux - Whether to add the app name to the sapux array.
  * @param {CapServiceCdsInfo} capService - The CAP service instance.
  * @param {string} appId - The application's ID, including its namespace and the module name.
- * @param {Logger} [log] - The logger instance for logging warnings.
- * @param {boolean} [enableNPMWorkspaces] - Whether to enable npm workspaces.
+ * @param {boolean} addCdsUi5Plugin - whether to add the cds ui5 plugin.
  * @returns {Promise<void>} A Promise that resolves once the root package.json is updated.
  */
-async function updateRootPackageJson(fs, projectName, sapux, capService, appId, log, enableNPMWorkspaces) {
+async function updateRootPackageJson(fs, projectName, sapux, capService, appId, addCdsUi5Plugin) {
     const packageJsonPath = (0, path_1.join)(capService.projectPath, 'package.json');
     const packageJson = (fs.readJSON(packageJsonPath) ?? {});
     const capNodeType = 'Node.js';
-    if (enableNPMWorkspaces && packageJson) {
-        await (0, cap_config_1.enableCdsUi5Plugin)(capService.projectPath, fs);
-    }
+    const appsPath = (await (0, project_access_1.getCapCustomPaths)(capService.projectPath)).app;
     if (capService?.capType === capNodeType) {
-        await updateScripts(fs, packageJsonPath, projectName, appId, enableNPMWorkspaces);
+        if (addCdsUi5Plugin) {
+            await (0, cap_config_1.enableCdsUi5Plugin)(capService.projectPath, fs);
+        }
+        await updateScripts(fs, packageJson, { projectPath: capService.projectPath, projectName, appsPath, appId }, addCdsUi5Plugin);
     }
     if (sapux) {
-        const dirPath = (0, path_1.join)(capService.appPath ?? (await (0, project_access_1.getCapCustomPaths)(capService.projectPath)).app, projectName);
+        const dirPath = (0, path_1.join)(capService.appPath ?? appsPath, projectName);
         // Converts a directory path to a POSIX-style path.
         const capProjectPath = (0, path_1.normalize)(dirPath).split(/[\\/]/g).join(path_1.posix.sep);
         const sapuxExt = Array.isArray(packageJson?.sapux) ? [...packageJson.sapux, capProjectPath] : [capProjectPath];

package/dist/cap-writer/updates.d.ts

@@ -12,9 +12,8 @@ import type { Logger } from '@sap-ux/logger';
  * @param {string} capProjectSettings.packageName - The name of the package.
  * @param {string} capProjectSettings.appId - The application's ID, including its namespace and the module name.
  * @param {boolean} capProjectSettings.sapux - Indicates if SAP UX is enabled.
- * @param {boolean} capProjectSettings.enableNPMWorkspaces - Indicates if NPM workspaces are enabled.
- * @param {boolean} capProjectSettings.enableCdsUi5Plugin - Indicates if the CDS UI5 plugin is enabled.
- * @param {boolean} [capProjectSettings.enableTypescript] - Indicates if TypeScript is enabled.
+ * @param {boolean} capProjectSettings.enableCdsUi5Plugin - Indicates if cds ui5 plugin should be added (default is true).  The cds ui5 plugin will only be added if the minimum cds version that supports it is present.
+ * @param {boolean} capProjectSettings.enableTypescript - Indicates if TypeScript is enabled.
  * @param {Logger} [log] - logger for logging information.
  * @returns {Promise<void>} A promise that resolves when the updates are applied.
  */

package/dist/cap-writer/updates.js

@@ -17,16 +17,15 @@ const path_1 = require("path");
  * @param {string} capProjectSettings.packageName - The name of the package.
  * @param {string} capProjectSettings.appId - The application's ID, including its namespace and the module name.
  * @param {boolean} capProjectSettings.sapux - Indicates if SAP UX is enabled.
- * @param {boolean} capProjectSettings.enableNPMWorkspaces - Indicates if NPM workspaces are enabled.
- * @param {boolean} capProjectSettings.enableCdsUi5Plugin - Indicates if the CDS UI5 plugin is enabled.
- * @param {boolean} [capProjectSettings.enableTypescript] - Indicates if TypeScript is enabled.
+ * @param {boolean} capProjectSettings.enableCdsUi5Plugin - Indicates if cds ui5 plugin should be added (default is true).  The cds ui5 plugin will only be added if the minimum cds version that supports it is present.
+ * @param {boolean} capProjectSettings.enableTypescript - Indicates if TypeScript is enabled.
  * @param {Logger} [log] - logger for logging information.
  * @returns {Promise<void>} A promise that resolves when the updates are applied.
  */
 async function applyCAPUpdates(fs, capService, capProjectSettings, log) {
-    const { appRoot, packageName, appId, sapux = false, enableNPMWorkspaces = false, enableCdsUi5Plugin = false, enableTypescript = false } = capProjectSettings;
+    const { appRoot, packageName, appId, sapux = false, enableCdsUi5Plugin = true, enableTypescript = false } = capProjectSettings;
     // update root package.json
-    await (0, package_json_1.updateRootPackageJson)(fs, packageName, sapux, capService, appId, log, enableNPMWorkspaces);
+    await (0, package_json_1.updateRootPackageJson)(fs, packageName, sapux, capService, appId, enableCdsUi5Plugin);
     if (capService.capType === 'Java') {
         const capProjectPath = capService.projectPath;
         const capCustomPaths = (0, fiori_generator_shared_1.getCapFolderPathsSync)(capProjectPath);
@@ -45,8 +44,8 @@ async function applyCAPUpdates(fs, capService, capProjectSettings, log) {
         // update tsconfig.json if TypeScript is enabled
         (0, tsconfig_and_yaml_1.updateTsConfig)(fs, appRoot);
     }
-    if (enableCdsUi5Plugin || enableNPMWorkspaces) {
-        // update app package.json if CDS UI5 plugin is enabled or NPM workspaces are enabled
+    if (capService.capType === 'Node.js' && enableCdsUi5Plugin) {
+        // update app package.json if CDS UI5 plugin is enabled
         (0, package_json_1.updateAppPackageJson)(fs, appRoot);
     }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/cap-config-writer",
   "description": "Add or update configuration for SAP CAP projects",
-  "version": "0.10.26",
+  "version": "0.11.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -25,9 +25,9 @@
     "semver": "7.5.4",
     "xml-js": "1.6.11",
     "@sap-ux/logger": "0.7.0",
-    "@sap-ux/project-access": "1.30.11",
+    "@sap-ux/project-access": "1.30.12",
     "@sap-ux/yaml": "0.17.0",
-    "@sap-ux/fiori-generator-shared": "0.13.8"
+    "@sap-ux/fiori-generator-shared": "0.13.9"
   },
   "devDependencies": {
     "@types/mem-fs": "1.1.2",