@sap-ux/cap-config-writer 0.2.39 → 0.3.0

package/README.md

@@ -21,7 +21,82 @@ const fs = await enableCdsUi5Plugin('path/to/cap-project');
 fs.commit();
 ```
 
+## API
+
+### updatePomXml
+This utility function updates the pom.xml file for Java-based CAP projects. The function reads the contents of the pom.xml file specified by pomPath, parses it, and searches for the spring-boot-maven-plugin configuration. If found, it adds certain workspace elements to it and writes back the updated pom.xml.
+
+```ts
+import { updatePomXml } from '@sap-ux/cap-config-writer';
+
+// Usage example
+const fsMock: Editor = {}; // mem-fs file editor
+const pomPath: string = 'path/to/pom.xml';
+const logger: Logger = {}; // logger instance from @sap-ux/logger
+
+updatePomXml(fsMock, pomPath, logger);
+```
+### updateTsConfig
+The function constructs the path to the tsconfig.json file based on the provided appRoot. If the file exists, it reads its contents and checks if the typeRoots property is defined in the compilerOptions. The function extends the tsconfig.json file with the modified compilerOptions.
+
+```ts
+import { updateTsConfig } from '@sap-ux/cap-config-writer';
+
+// Usage example
+const fsMock: Editor = {}; // mem-fs file editor
+const appRoot: string = 'path/to/your/app'; // The root directory of the application
+
+updateTsConfig(fsMock, appRoot);
+```
+
+### updateStaticLocationsInApplicationYaml
+The function reads the contents of the application YAML file specified by applicationYamlPath, parses it, and checks if the static resource locations are already defined. If not, it adds the custom paths specified by capCustomPathsApp to the web.resources.static-locations property.
+
+```ts
+import { updateStaticLocationsInApplicationYaml } from '@sap-ux/cap-config-writer';
+
+// Usage example
+const fsMock: Editor = {}; // mem-fs file editor
+const applicationYamlPath: string = 'path/to/application.yaml';
+const capCustomPathsApp: string = 'path/to/static/resources'; // Custom paths for CAP application
+const logger: Logger = {}; // logger instance from @sap-ux/logger
+
+await updateStaticLocationsInApplicationYaml(fsMock, applicationYamlPath, capCustomPathsApp, logger);
+```
+
+### updateRootPackageJson
+Updates the package.json file of a CAP project app based on project requirements such as enableNPMWorkspaces
+
+```ts
+import { updateRootPackageJson } from '@sap-ux/cap-config-writer';
+
+// Usage example
+const fsMock: Editor = {}; // mem-fs file editor
+const projectName: string = 'your-project-name';
+const sapux: boolean = true; // Whether to add the app name to the sapux array
+const capService: CapService = {}; // CAP service instance
+const appId: string = 'your-app-id';
+const log: Logger = {}; //// mem-fs file editor
+const enableNPMWorkspaces: boolean = true; // npm workspaces (optional)
+
+await updateRootPackageJson(fsMock, projectName, sapux, capService, appId, log, enableNPMWorkspaces);
+```
+
+### updateAppPackageJsonCAP
+The function constructs the path to the package.json file based on the provided appRoot. It then reads the contents of the package.json file and removes the sapux property, the int-test script, and any scripts starting with 'start' that are not required for the app.
+
+```ts
+import { updateAppPackageJson } from '@sap-ux/cap-config-writer';
+
+// Usage example
+const fsMock: Editor = {}; // mem-fs file editor
+const appRoot: string = 'path/to/your/app'; // The root directory of the application
+
+updateAppPackageJson(fsMock, appRoot);
+```
+
 ## Keywords
 SAP Fiori elements
 SAP CAP
+SAP CAP writer
 SAP UI5

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

@@ -1,4 +1,6 @@
 import type { Editor } from 'mem-fs-editor';
+import type { CdsVersionInfo } from '@sap-ux/project-access';
+import { minCdsVersion } from './package-json';
 export { satisfiesMinCdsVersion } from './package-json';
 import type { CdsUi5PluginInfo } from './types';
 /**
@@ -27,4 +29,15 @@ export declare function checkCdsUi5PluginEnabled(basePath: string, fs?: Editor):
  * @returns false if package.json is not found at specified path or {@link CdsUi5PluginInfo} with additional info
  */
 export declare function checkCdsUi5PluginEnabled(basePath: string, fs?: Editor, moreInfo?: boolean): Promise<boolean | CdsUi5PluginInfo>;
+/**
+ * Check if cds-plugin-ui5 is enabled on a CAP project. Checks also all prerequisites, like minimum @sap/cds version.
+ *
+ * @param basePath - root path of the CAP project, where package.json is located
+ * @param [fs] - optional: the memfs editor instance
+ * @param [moreInfo] if true return an object specifying detailed info about the cds and workspace state
+ * @param {CdsVersionInfo} [cdsVersionInfo] - If provided will be used instead of parsing the package.json file to determine the cds version.
+ * @returns false if package.json is not found at specified path or {@link CdsUi5PluginInfo} with additional info
+ */
+export declare function checkCdsUi5PluginEnabled(basePath: string, fs?: Editor, moreInfo?: boolean, cdsVersionInfo?: CdsVersionInfo): Promise<boolean | CdsUi5PluginInfo>;
+export { minCdsVersion };
 //# sourceMappingURL=index.d.ts.map

package/dist/cap-config/index.js

@@ -9,13 +9,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkCdsUi5PluginEnabled = exports.enableCdsUi5Plugin = exports.satisfiesMinCdsVersion = void 0;
+exports.minCdsVersion = exports.checkCdsUi5PluginEnabled = exports.enableCdsUi5Plugin = exports.satisfiesMinCdsVersion = void 0;
 const path_1 = require("path");
 const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const package_json_1 = require("./package-json");
+Object.defineProperty(exports, "minCdsVersion", { enumerable: true, get: function () { return package_json_1.minCdsVersion; } });
 var package_json_2 = require("./package-json");
 Object.defineProperty(exports, "satisfiesMinCdsVersion", { enumerable: true, get: function () { return package_json_2.satisfiesMinCdsVersion; } });
+const semver_1 = require("semver");
 /**
  * Enable workspace and cds-plugin-ui5 for given CAP project.
  *
@@ -40,15 +42,17 @@ function enableCdsUi5Plugin(basePath, fs) {
 }
 exports.enableCdsUi5Plugin = enableCdsUi5Plugin;
 /**
+ * Implementation of the overloaded function.
  * Check if cds-plugin-ui5 is enabled on a CAP project. Checks also all prerequisites, like minimum @sap/cds version.
  *
  * @param basePath - root path of the CAP project, where package.json is located
  * @param [fs] - optional: the memfs editor instance
  * @param [moreInfo] if true return an object specifying detailed info about the cds and workspace state
+ * @param {CdsVersionInfo} [cdsVersionInfo] - If provided will be used instead of parsing the package.json file to determine the cds version.
  * @returns false if package.json is not found at specified path or {@link CdsUi5PluginInfo} with additional info or true if
  * cds-plugin-ui5 and all prerequisites are fulfilled
  */
-function checkCdsUi5PluginEnabled(basePath, fs, moreInfo = false) {
+function checkCdsUi5PluginEnabled(basePath, fs, moreInfo, cdsVersionInfo) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!fs) {
             fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
@@ -60,7 +64,10 @@ function checkCdsUi5PluginEnabled(basePath, fs, moreInfo = false) {
         const packageJson = fs.readJSON(packageJsonPath);
         const { workspaceEnabled } = yield (0, package_json_1.getWorkspaceInfo)(basePath, packageJson);
         const cdsInfo = {
-            hasMinCdsVersion: (0, package_json_1.satisfiesMinCdsVersion)(packageJson),
+            // Below line checks if 'cdsVersionInfo' is available and contains version information.
+            // If it does, it uses that version information to determine if it satisfies the minimum CDS version required.
+            // If 'cdsVersionInfo' is not available or does not contain version information,it falls back to check the version specified in the package.json file.
+            hasMinCdsVersion: (cdsVersionInfo === null || cdsVersionInfo === void 0 ? void 0 : cdsVersionInfo.version) ? (0, semver_1.satisfies)(cdsVersionInfo === null || cdsVersionInfo === void 0 ? void 0 : cdsVersionInfo.version, `>=${package_json_1.minCdsVersion}`) : (0, package_json_1.satisfiesMinCdsVersion)(packageJson),
             isWorkspaceEnabled: workspaceEnabled,
             hasCdsUi5Plugin: (0, package_json_1.hasCdsPluginUi5)(packageJson),
             isCdsUi5PluginEnabled: false

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

@@ -1,4 +1,5 @@
 import type { Package } from '@sap-ux/project-access';
+export declare const minCdsVersion = "6.8.2";
 /**
  * Ensure a minimum version of @sap/cds in dependencies.
  *

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

@@ -9,10 +9,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasCdsPluginUi5 = exports.getWorkspaceInfo = exports.satisfiesMinCdsVersion = exports.hasMinCdsVersion = exports.addCdsPluginUi5 = exports.enableWorkspaces = exports.ensureMinCdsVersion = void 0;
+exports.hasCdsPluginUi5 = exports.getWorkspaceInfo = exports.satisfiesMinCdsVersion = exports.hasMinCdsVersion = exports.addCdsPluginUi5 = exports.enableWorkspaces = exports.ensureMinCdsVersion = exports.minCdsVersion = void 0;
 const semver_1 = require("semver");
 const project_access_1 = require("@sap-ux/project-access");
-const minCdsVersion = '6.8.2';
+exports.minCdsVersion = '6.8.2';
 const minCdsPluginUi5Version = '0.6.13';
 /**
  * Ensure a minimum version of @sap/cds in dependencies.
@@ -23,7 +23,7 @@ function ensureMinCdsVersion(packageJson) {
     var _a;
     if (!hasMinCdsVersion(packageJson)) {
         (_a = packageJson.dependencies) !== null && _a !== void 0 ? _a : (packageJson.dependencies = {});
-        packageJson.dependencies['@sap/cds'] = `^${minCdsVersion}`;
+        packageJson.dependencies['@sap/cds'] = `^${exports.minCdsVersion}`;
     }
 }
 exports.ensureMinCdsVersion = ensureMinCdsVersion;
@@ -77,7 +77,7 @@ exports.addCdsPluginUi5 = addCdsPluginUi5;
  */
 function hasMinCdsVersion(packageJson) {
     var _a, _b;
-    return (0, semver_1.gte)((_b = (0, semver_1.coerce)((_a = packageJson.dependencies) === null || _a === void 0 ? void 0 : _a['@sap/cds'])) !== null && _b !== void 0 ? _b : '0.0.0', minCdsVersion);
+    return (0, semver_1.gte)((_b = (0, semver_1.coerce)((_a = packageJson.dependencies) === null || _a === void 0 ? void 0 : _a['@sap/cds'])) !== null && _b !== void 0 ? _b : '0.0.0', exports.minCdsVersion);
 }
 exports.hasMinCdsVersion = hasMinCdsVersion;
 /**
@@ -88,7 +88,7 @@ exports.hasMinCdsVersion = hasMinCdsVersion;
  */
 function satisfiesMinCdsVersion(packageJson) {
     var _a, _b;
-    return hasMinCdsVersion(packageJson) || (0, semver_1.satisfies)(minCdsVersion, (_b = (_a = packageJson.dependencies) === null || _a === void 0 ? void 0 : _a['@sap/cds']) !== null && _b !== void 0 ? _b : '0.0.0');
+    return hasMinCdsVersion(packageJson) || (0, semver_1.satisfies)(exports.minCdsVersion, (_b = (_a = packageJson.dependencies) === null || _a === void 0 ? void 0 : _a['@sap/cds']) !== null && _b !== void 0 ? _b : '0.0.0');
 }
 exports.satisfiesMinCdsVersion = satisfiesMinCdsVersion;
 /**

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

@@ -1,3 +1,4 @@
+import type { CapService } from '@sap-ux/odata-service-inquirer';
 export type CdsUi5PluginInfo = {
     /**
      * Convienience property. The CDS UI5 plugin is considered enabled if `hasCdsUi5Plugin`, `hasMinCdsVersion`, `isWorkspaceEnabled` are all true.
@@ -16,4 +17,7 @@ export type CdsUi5PluginInfo = {
      */
     hasCdsUi5Plugin: boolean;
 };
+export interface CapServiceCdsInfo extends CapService {
+    cdsUi5PluginInfo: CdsUi5PluginInfo;
+}
 //# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1,4 @@
+export { updateAppPackageJson, updateRootPackageJson } from './package-json';
+export { updateTsConfig, updateStaticLocationsInApplicationYaml } from './tsconfig-and-yaml';
+export { updatePomXml } from './pom-xml';
+//# sourceMappingURL=index.d.ts.map

package/dist/cap-writer/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updatePomXml = exports.updateStaticLocationsInApplicationYaml = exports.updateTsConfig = exports.updateRootPackageJson = exports.updateAppPackageJson = void 0;
+var package_json_1 = require("./package-json");
+Object.defineProperty(exports, "updateAppPackageJson", { enumerable: true, get: function () { return package_json_1.updateAppPackageJson; } });
+Object.defineProperty(exports, "updateRootPackageJson", { enumerable: true, get: function () { return package_json_1.updateRootPackageJson; } });
+var tsconfig_and_yaml_1 = require("./tsconfig-and-yaml");
+Object.defineProperty(exports, "updateTsConfig", { enumerable: true, get: function () { return tsconfig_and_yaml_1.updateTsConfig; } });
+Object.defineProperty(exports, "updateStaticLocationsInApplicationYaml", { enumerable: true, get: function () { return tsconfig_and_yaml_1.updateStaticLocationsInApplicationYaml; } });
+var pom_xml_1 = require("./pom-xml");
+Object.defineProperty(exports, "updatePomXml", { enumerable: true, get: function () { return pom_xml_1.updatePomXml; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,38 @@
+import type { Editor } from 'mem-fs-editor';
+import type { CapServiceCdsInfo } from '../cap-config/types';
+import type { Logger } from '@sap-ux/logger';
+/**
+ * Retrieves the CDS watch script for the CAP app.
+ *
+ * @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.
+    If appId is provided, it will be used to open the application instead of the project name. This option is available for use with npm workspaces.
+ * @returns {{ [x: string]: string }} The CDS watch script for the CAP app.
+ */
+export declare function getCDSWatchScript(projectName: string, appId?: string): {
+    [x: string]: string;
+};
+/**
+ * Updates the root package.json file of CAP projects with the following changes:
+ * 1) Adds the app name to the sapux array in the root package.json if sapux is enabled.
+ * 2) Adds the cds watch script to the root package.json if applicable.
+ *
+ * @param {Editor} fs - The file system editor.
+ * @param {string} projectName - The project's name, which is the module name.
+ * @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.
+ * @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>;
+/**
+ * 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.
+ *
+ * @param {Editor} fs The file system editor.
+ * @param {string} appRoot The root directory of the application.
+ */
+export declare function updateAppPackageJson(fs: Editor, appRoot: string): void;
+//# sourceMappingURL=package-json.d.ts.map

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

@@ -0,0 +1,165 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateAppPackageJson = exports.updateRootPackageJson = exports.getCDSWatchScript = void 0;
+const project_access_1 = require("@sap-ux/project-access");
+const path_1 = __importStar(require("path"));
+const cap_config_1 = require("../cap-config");
+const i18n_1 = require("../i18n");
+/**
+ * Retrieves the CDS watch script for the CAP app.
+ *
+ * @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.
+    If appId is provided, it will be used to open the application instead of the project name. This option is available for use with npm workspaces.
+ * @returns {{ [x: string]: string }} The CDS watch script for the CAP app.
+ */
+function getCDSWatchScript(projectName, appId) {
+    const DisableCacheParam = 'sap-ui-xx-viewCache=false';
+    // projects by default are served base on the folder name in the app/ folder
+    const project = appId !== null && appId !== void 0 ? appId : projectName + '/webapp';
+    const watchScript = {
+        [`watch-${projectName}`]: `cds watch --open ${project}/index.html?${DisableCacheParam}${appId ? ' --livereload false' : ''}`
+    };
+    return watchScript;
+}
+exports.getCDSWatchScript = getCDSWatchScript;
+/**
+ * Updates the scripts in the package json file with the provided scripts object.
+ *
+ * @param {Editor} fs - The file system editor.
+ * @param {string} packageJsonPath - The path to the package.json file.
+ * @param {Record<string, string>} scripts - The scripts to be added or updated in the package.json file.
+ * @returns {void}
+ */
+function updatePackageJsonWithScripts(fs, packageJsonPath, scripts) {
+    fs.extendJSON(packageJsonPath, { scripts });
+}
+/**
+ * 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 {CapServiceCdsInfo} cdsUi5PluginInfo - cds Ui5 plugin info.
+ * @param {Logger} [log] - The logger instance for logging warnings.
+ * @returns {Promise<void>} A Promise that resolves once the scripts are updated.
+ */
+function updateScripts(fs, packageJsonPath, projectName, appId, enableNPMWorkspaces, cdsUi5PluginInfo, log) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const packageJson = ((_a = fs.readJSON(packageJsonPath)) !== null && _a !== void 0 ? _a : {});
+        const hasNPMworkspaces = yield (0, cap_config_1.checkCdsUi5PluginEnabled)(packageJsonPath, fs);
+        // Determine whether to add cds watch scripts for the app based on the availability of minimum CDS version information.
+        // If 'cdsUi5PluginInfo' contains version information and it satisfies the minimum required CDS version,
+        // or if 'cdsUi5PluginInfo' is not available and the version specified in 'package.json' satisfies the minimum required version,
+        // then set 'addScripts' to true. Otherwise, set it to false.
+        const addScripts = (cdsUi5PluginInfo === null || cdsUi5PluginInfo === void 0 ? void 0 : cdsUi5PluginInfo.hasMinCdsVersion) ? cdsUi5PluginInfo.hasMinCdsVersion : (0, cap_config_1.satisfiesMinCdsVersion)(packageJson);
+        let cdsScript;
+        if (addScripts) {
+            if (enableNPMWorkspaces !== null && enableNPMWorkspaces !== void 0 ? 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);
+            }
+            else
+                cdsScript = getCDSWatchScript(projectName);
+            updatePackageJsonWithScripts(fs, packageJsonPath, cdsScript);
+        }
+        else {
+            log === null || log === void 0 ? void 0 : log.warn((0, i18n_1.t)('warn.cdsDKNotInstalled', { minCdsVersion: cap_config_1.minCdsVersion }));
+        }
+    });
+}
+/**
+ * Updates the root package.json file of CAP projects with the following changes:
+ * 1) Adds the app name to the sapux array in the root package.json if sapux is enabled.
+ * 2) Adds the cds watch script to the root package.json if applicable.
+ *
+ * @param {Editor} fs - The file system editor.
+ * @param {string} projectName - The project's name, which is the module name.
+ * @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.
+ * @returns {Promise<void>} A Promise that resolves once the root package.json is updated.
+ */
+function updateRootPackageJson(fs, projectName, sapux, capService, appId, log, enableNPMWorkspaces) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const packageJsonPath = (0, path_1.join)(capService.projectPath, 'package.json');
+        const packageJson = ((_a = fs.readJSON(packageJsonPath)) !== null && _a !== void 0 ? _a : {});
+        const capNodeType = 'Node.js';
+        if (enableNPMWorkspaces && packageJson) {
+            yield (0, cap_config_1.enableCdsUi5Plugin)(capService.projectPath, fs);
+        }
+        if ((capService === null || capService === void 0 ? void 0 : capService.capType) === capNodeType) {
+            yield updateScripts(fs, packageJsonPath, projectName, appId, enableNPMWorkspaces, capService.cdsUi5PluginInfo, log);
+        }
+        if (sapux) {
+            const dirPath = (0, path_1.join)((_b = capService.appPath) !== null && _b !== void 0 ? _b : (yield (0, project_access_1.getCapCustomPaths)(capService.projectPath)).app, projectName);
+            // Converts a directory path to a POSIX-style path.
+            const capProjectPath = path_1.default.normalize(dirPath).split(/[\\/]/g).join(path_1.default.posix.sep);
+            const sapuxExt = Array.isArray(packageJson === null || packageJson === void 0 ? void 0 : packageJson.sapux) ? [...packageJson.sapux, capProjectPath] : [capProjectPath];
+            fs.extendJSON(packageJsonPath, { sapux: sapuxExt });
+        }
+    });
+}
+exports.updateRootPackageJson = updateRootPackageJson;
+/**
+ * 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.
+ *
+ * @param {Editor} fs The file system editor.
+ * @param {string} appRoot The root directory of the application.
+ */
+function updateAppPackageJson(fs, appRoot) {
+    var _a;
+    const packageJsonPath = (0, path_1.join)(appRoot, 'package.json');
+    const packageJson = ((_a = fs.readJSON(packageJsonPath)) !== null && _a !== void 0 ? _a : {});
+    delete packageJson.sapux;
+    if (packageJson === null || packageJson === void 0 ? void 0 : packageJson.scripts) {
+        delete packageJson.scripts['int-test'];
+    }
+    for (const script in packageJson.scripts) {
+        if (script.startsWith('start')) {
+            delete packageJson.scripts[script];
+        }
+    }
+    fs.writeJSON(packageJsonPath, packageJson);
+}
+exports.updateAppPackageJson = updateAppPackageJson;
+//# sourceMappingURL=package-json.js.map

package/dist/cap-writer/pom-xml.d.ts

@@ -0,0 +1,12 @@
+import type { Editor } from 'mem-fs-editor';
+import type { Logger } from '@sap-ux/logger';
+/**
+ * Updates the pom.xml file for Java-based CAP projects.
+ *
+ * @param {Editor} fs The file system editor instance.
+ * @param {string} pomPath The path to the pom.xml file.
+ * @param {Logger} [logger] The logger instance for logging errors.
+ * @returns {void}
+ */
+export declare function updatePomXml(fs: Editor, pomPath: string, logger?: Logger): void;
+//# sourceMappingURL=pom-xml.d.ts.map

package/dist/cap-writer/pom-xml.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updatePomXml = void 0;
+const xml_js_1 = require("xml-js");
+/**
+ * Checks if the specified name exists in the array of elements.
+ *
+ * @param {Element[]} data The array of elements to search.
+ * @param {string} name The name to search for.
+ * @returns {boolean} Returns true if the name exists in the array, otherwise false.
+ */
+function checkIfNameExists(data, name) {
+    return data === null || data === void 0 ? void 0 : data.some((obj) => obj.name === name);
+}
+/**
+ * Adds a workspace element to the provided data if it doesn't already exist.
+ *
+ * @param {Element} data The data to which the workspace element should be added.
+ * @returns {boolean} Returns true if the workspace element was successfully added, otherwise false.
+ */
+function addWorkspaceElement(data) {
+    if (!(data === null || data === void 0 ? void 0 : data.elements) || checkIfNameExists(data.elements, 'workingDirectory')) {
+        return false;
+    }
+    data.elements.push({ type: 'element', name: 'workingDirectory', elements: [{ type: 'text', text: '..' }] });
+    return true;
+}
+/**
+ * Reads the contents of the pom xml file and returns it as a string.
+ *
+ * @param {Editor} fs - The file system editor.
+ * @param {string} pomPath - The path to the pom.xml file.
+ * @returns {string} The contents of the pom.xml file as a string.
+ */
+function readPomXml(fs, pomPath) {
+    return fs.read(pomPath).toString();
+}
+/**
+ * Writes the provided XML structure to the pom xml file.
+ *
+ * @param {Editor} fs - The file system editor.
+ * @param {string} pomPath - The path to the pom.xml file.
+ * @param {ElementCompact} pomContentsJson - The XML structure to be written to the pom.xml file.
+ * @returns {void}
+ */
+function writePomXml(fs, pomPath, pomContentsJson) {
+    const pomXML = (0, xml_js_1.js2xml)(pomContentsJson, { compact: false, ignoreComment: false, spaces: 4 });
+    const ampersandReplace = /&gt/g; // Sanitize
+    fs.write(pomPath, pomXML.replace(ampersandReplace, '&gt'));
+}
+/**
+ * Updates the pom.xml file for Java-based CAP projects.
+ *
+ * @param {Editor} fs The file system editor instance.
+ * @param {string} pomPath The path to the pom.xml file.
+ * @param {Logger} [logger] The logger instance for logging errors.
+ * @returns {void}
+ */
+function updatePomXml(fs, pomPath, logger) {
+    var _a, _b, _c, _d, _e, _f, _g;
+    try {
+        const pomContents = readPomXml(fs, pomPath);
+        const pomContentsJson = (0, xml_js_1.xml2js)(pomContents, { compact: false, ignoreComment: false });
+        const springBootMavenPlugin = 'spring-boot-maven-plugin';
+        if (Object.keys(pomContentsJson).length === 0) {
+            return;
+        }
+        // find the spring-boot-maven-plugin in the pom.xml
+        const pomPlugin = (_g = (_f = (_e = (_d = (_c = (_b = (_a = pomContentsJson.elements
+            .filter((element) => element.name === 'project')) === null || _a === void 0 ? void 0 : _a[0].elements.filter((element) => element.name === 'build')) === null || _b === void 0 ? void 0 : _b[0].elements.filter((element) => element.name === 'plugins')) === null || _c === void 0 ? void 0 : _c[0].elements.filter((element) => element.name === 'plugin')) === null || _d === void 0 ? void 0 : _d.filter((obj) => {
+            var _a;
+            return (_a = obj === null || obj === void 0 ? void 0 : obj.elements) === null || _a === void 0 ? void 0 : _a.some((element) => {
+                var _a;
+                return element.name === 'artifactId' &&
+                    ((_a = element.elements) !== null && _a !== void 0 ? _a : []).some((element) => element.text === springBootMavenPlugin);
+            });
+        })) === null || _e === void 0 ? void 0 : _e[0].elements) === null || _f === void 0 ? void 0 : _f.filter((element) => element.name === 'configuration')) === null || _g === void 0 ? void 0 : _g[0];
+        if (pomPlugin) {
+            addWorkspaceElement(pomPlugin);
+            writePomXml(fs, pomPath, pomContentsJson);
+        }
+    }
+    catch (error) {
+        logger === null || logger === void 0 ? void 0 : logger.error(error);
+    }
+}
+exports.updatePomXml = updatePomXml;
+//# sourceMappingURL=pom-xml.js.map

package/dist/cap-writer/tsconfig-and-yaml.d.ts

@@ -0,0 +1,21 @@
+import type { Editor } from 'mem-fs-editor';
+import type { Logger } from '@sap-ux/logger';
+/**
+ * Updates the tsconfig.json file to correct the type roots when node_modules
+ * are not found in the same directory as the application.
+ *
+ * @param {Editor} fs The file system editor.
+ * @param {string} appRoot The root directory of the application.
+ */
+export declare function updateTsConfig(fs: Editor, appRoot: string): void;
+/**
+ * Updates the application YAML file by adding static resource locations if not already present.
+ *
+ * @param {Editor} fs The file system editor instance.
+ * @param {string} applicationYamlPath The path to the application YAML file.
+ * @param {string} capCustomPathsApp The custom paths for CAP application.
+ * @param {Logger} [logger] The logger instance for logging errors.
+ * @returns {void}
+ */
+export declare function updateStaticLocationsInApplicationYaml(fs: Editor, applicationYamlPath: string, capCustomPathsApp: string, logger?: Logger): Promise<void>;
+//# sourceMappingURL=tsconfig-and-yaml.d.ts.map

package/dist/cap-writer/tsconfig-and-yaml.js

@@ -0,0 +1,72 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateStaticLocationsInApplicationYaml = exports.updateTsConfig = void 0;
+const project_access_1 = require("@sap-ux/project-access");
+const yaml_1 = require("@sap-ux/yaml");
+const path_1 = require("path");
+const i18n_1 = require("../i18n");
+/**
+ * Updates the tsconfig.json file to correct the type roots when node_modules
+ * are not found in the same directory as the application.
+ *
+ * @param {Editor} fs The file system editor.
+ * @param {string} appRoot The root directory of the application.
+ */
+function updateTsConfig(fs, appRoot) {
+    const tsConfigPath = (0, path_1.join)(appRoot, project_access_1.FileName.Tsconfig);
+    if (fs.exists(tsConfigPath)) {
+        const tsConfig = fs.readJSON(tsConfigPath);
+        if (tsConfig['compilerOptions']['typeRoots']) {
+            const typeRoots = tsConfig['compilerOptions']['typeRoots'];
+            const updatedTypeRoots = typeRoots.map((entry) => {
+                return entry.replace(/\.\//g, '../../');
+            });
+            // Update the tsconfig.json file
+            fs.extendJSON(tsConfigPath, {
+                compilerOptions: {
+                    typeRoots: [...typeRoots, ...updatedTypeRoots]
+                }
+            });
+        }
+    }
+}
+exports.updateTsConfig = updateTsConfig;
+/**
+ * Updates the application YAML file by adding static resource locations if not already present.
+ *
+ * @param {Editor} fs The file system editor instance.
+ * @param {string} applicationYamlPath The path to the application YAML file.
+ * @param {string} capCustomPathsApp The custom paths for CAP application.
+ * @param {Logger} [logger] The logger instance for logging errors.
+ * @returns {void}
+ */
+function updateStaticLocationsInApplicationYaml(fs, applicationYamlPath, capCustomPathsApp, logger) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const applicationYamlDocuments = fs.read(applicationYamlPath).toString();
+            const yamlDoc = yield yaml_1.YamlDocument.newInstance(applicationYamlDocuments);
+            const stringifiedYaml = JSON.stringify(yamlDoc);
+            const parsedApplicationYamlDocuments = JSON.parse(stringifiedYaml).documents;
+            if (parsedApplicationYamlDocuments.length === 1 &&
+                parsedApplicationYamlDocuments[0].spring['web.resources.static-locations'] === undefined) {
+                const applicationYamlFirstDocument = parsedApplicationYamlDocuments[0];
+                applicationYamlFirstDocument.spring['web.resources.static-locations'] = `file:./${capCustomPathsApp}`;
+                fs.write(applicationYamlPath, (0, yaml_1.yamlDocumentToYamlString)(applicationYamlFirstDocument));
+            }
+        }
+        catch (error) {
+            logger === null || logger === void 0 ? void 0 : logger.error((0, i18n_1.t)('error.updateApplicationYaml', { error: error }));
+        }
+    });
+}
+exports.updateStaticLocationsInApplicationYaml = updateStaticLocationsInApplicationYaml;
+//# sourceMappingURL=tsconfig-and-yaml.js.map

package/dist/i18n.d.ts

@@ -0,0 +1,14 @@
+import type { TOptions } from 'i18next';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+export declare function initI18n(): Promise<void>;
+/**
+ * Helper function facading the call to i18next.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+export declare function t(key: string, options?: TOptions): string;
+//# sourceMappingURL=i18n.d.ts.map

package/dist/i18n.js

@@ -0,0 +1,52 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.t = exports.initI18n = void 0;
+const i18next_1 = __importDefault(require("i18next"));
+const cap_config_writer_i18n_json_1 = __importDefault(require("./translations/cap-config-writer.i18n.json"));
+const NS = 'cap-config-writer';
+/**
+ * Initialize i18next with the translations for this module.
+ */
+function initI18n() {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield i18next_1.default.init({
+            resources: {
+                en: {
+                    [NS]: cap_config_writer_i18n_json_1.default
+                }
+            },
+            lng: 'en',
+            fallbackLng: 'en',
+            defaultNS: NS,
+            ns: [NS]
+        });
+    });
+}
+exports.initI18n = initI18n;
+/**
+ * Helper function facading the call to i18next.
+ *
+ * @param key i18n key
+ * @param options additional options
+ * @returns {string} localized string stored for the given key
+ */
+function t(key, options) {
+    return i18next_1.default.t(key, options);
+}
+exports.t = t;
+initI18n().catch(() => {
+    // Ignore any errors since the write will still work
+});
+//# sourceMappingURL=i18n.js.map

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export { checkCdsUi5PluginEnabled, enableCdsUi5Plugin, satisfiesMinCdsVersion } from './cap-config';
-export type { CdsUi5PluginInfo } from './cap-config/types';
+export type { CdsUi5PluginInfo, CapServiceCdsInfo } from './cap-config/types';
+export * from './cap-writer';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,8 +1,23 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.satisfiesMinCdsVersion = exports.enableCdsUi5Plugin = exports.checkCdsUi5PluginEnabled = void 0;
 var cap_config_1 = require("./cap-config");
 Object.defineProperty(exports, "checkCdsUi5PluginEnabled", { enumerable: true, get: function () { return cap_config_1.checkCdsUi5PluginEnabled; } });
 Object.defineProperty(exports, "enableCdsUi5Plugin", { enumerable: true, get: function () { return cap_config_1.enableCdsUi5Plugin; } });
 Object.defineProperty(exports, "satisfiesMinCdsVersion", { enumerable: true, get: function () { return cap_config_1.satisfiesMinCdsVersion; } });
+__exportStar(require("./cap-writer"), exports);
 //# sourceMappingURL=index.js.map

package/dist/translations/cap-config-writer.i18n.json

@@ -0,0 +1,12 @@
+{
+    "info": {
+        "capServiceName": "cap service name {{ capServiceName }}.",
+        "cdsUpdateInfo": "Update cds file with projectPath: {{ projectPath }}, annotationPath: {{ annotationPath }}, capService: {{ capService }}."
+    },
+    "warn": {
+        "cdsDKNotInstalled": "minimum cds-dk {{ minCdsVersion }} version is required to add cds watch scripts"
+    },
+    "error": {
+        "updateApplicationYaml": "Error occured while updating application yaml {{ error }}"
+    }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/cap-config-writer",
   "description": "Add or update configuration for SAP CAP projects",
-  "version": "0.2.39",
+  "version": "0.3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -19,15 +19,20 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
+    "i18next": "20.6.1",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "semver": "7.5.4",
-    "@sap-ux/project-access": "1.20.4"
+    "@sap-ux/logger": "0.5.1",
+    "@sap-ux/project-access": "1.21.1",
+    "@sap-ux/odata-service-inquirer": "0.2.1",
+    "@sap-ux/yaml": "0.15.0"
   },
   "devDependencies": {
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
-    "@types/semver": "7.5.2"
+    "@types/semver": "7.5.2",
+    "xml-js": "1.6.11"
   },
   "engines": {
     "node": ">=18.x"