@sap-ux/cap-config-writer 0.4.1 → 0.5.1

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

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

package/dist/cap-writer/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updatePomXml = exports.updateStaticLocationsInApplicationYaml = exports.updateTsConfig = exports.updateRootPackageJson = exports.updateAppPackageJson = void 0;
+exports.getAppLaunchText = 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; } });
@@ -9,4 +9,6 @@ Object.defineProperty(exports, "updateTsConfig", { enumerable: true, get: functi
 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; } });
+var utils_1 = require("./utils");
+Object.defineProperty(exports, "getAppLaunchText", { enumerable: true, get: function () { return utils_1.getAppLaunchText; } });
 //# sourceMappingURL=index.js.map

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

@@ -0,0 +1,11 @@
+import type { CapRuntime } from '@sap-ux/odata-service-inquirer';
+/**
+ * Generates a launch text for the launching of applications.
+ *
+ * @param capType The type of CAP runtime used in the application will be provided for CAP applications.
+ * @param projectName The project's name, which is the module name.
+ * @param appId 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 The launch text for the application.
+ */
+export declare function getAppLaunchText(capType: CapRuntime, projectName: string, appId?: string): string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/cap-writer/utils.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppLaunchText = void 0;
+const i18n_1 = require("../i18n");
+/**
+ * Returns the url to the specified cap app as served by `cds serve` or `cds watch`.
+ *
+ * @param capType The type of CAP runtime used in the application (e.g., 'Java' or 'Node.js').
+ * @param projectName The project's name, which is the module name.
+ * @param appId 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 The URL for launching the project.
+ */
+function getCapUrl(capType, projectName, appId) {
+    const projectPath = appId !== null && appId !== void 0 ? appId : projectName + '/webapp';
+    if (capType === 'Java') {
+        // For Java projects
+        return `http://localhost:8080/${projectName}/webapp/index.html`;
+    }
+    else {
+        // For Node.js projects or when capType is undefined
+        return `http://localhost:4004/${projectPath}/index.html`;
+    }
+}
+/**
+ * Generates a launch text for the launching of applications.
+ *
+ * @param capType The type of CAP runtime used in the application will be provided for CAP applications.
+ * @param projectName The project's name, which is the module name.
+ * @param appId 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 The launch text for the application.
+ */
+function getAppLaunchText(capType, projectName, appId) {
+    // Determine the Maven command if the project is a Java project
+    const mvnCommand = capType === 'Java' ? ' (```mvn spring-boot:run```)' : '';
+    const capUrl = getCapUrl(capType, projectName, appId);
+    // Return launch text
+    return `${(0, i18n_1.t)('launchCapText', { mvnCommand, capUrl })}`;
+}
+exports.getAppLaunchText = getAppLaunchText;
+//# sourceMappingURL=utils.js.map

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

@@ -8,5 +8,6 @@
     },
     "error": {
         "updateApplicationYaml": "Error occured while updating application yaml {{ error }}"
-    }
+    },
+    "launchCapText": "In order to launch the generated app, simply start your CAP project{{mvnCommand}} and navigate to the following location in your browser:\n\n{{- capUrl}}"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/cap-config-writer",
   "description": "Add or update configuration for SAP CAP projects",
-  "version": "0.4.1",
+  "version": "0.5.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -26,7 +26,7 @@
     "xml-js": "1.6.11",
     "@sap-ux/logger": "0.5.1",
     "@sap-ux/project-access": "1.22.2",
-    "@sap-ux/odata-service-inquirer": "0.3.4",
+    "@sap-ux/odata-service-inquirer": "0.3.5",
     "@sap-ux/yaml": "0.15.1"
   },
   "devDependencies": {