@sap-ux/cf-deploy-config-writer 0.1.11 → 0.1.14

package/dist/cf-writer/app-config.js

@@ -160,7 +160,9 @@ async function generateDeployConfig(cfAppConfig, fs) {
     await appendCloudFoundryConfigurations(config, fs);
     await updateManifest(config, fs);
     await updateHTML5AppPackage(config, fs);
-    await updateRootPackage(config, fs);
+    if (config.isMtaRoot) {
+        await (0, utils_1.updateRootPackage)({ mtaId: config.mtaId ?? config.appId, rootPath: config.rootPath }, fs);
+    }
 }
 /**
  * Creates the MTA configuration file.
@@ -242,28 +244,25 @@ function cleanupStandaloneRoutes({ rootPath, appId }, mtaInstance, fs) {
  * @param mtaInstance MTA configuration instance
  */
 async function saveMta(cfConfig, mtaInstance) {
-    let isMtaSaved = false;
     try {
-        isMtaSaved = await mtaInstance.save();
+        // Cleanup any temp files, not required to handle the exception as the mta.yaml will have been appended already with required changes.
+        await mtaInstance.save();
+        logger_helper_1.default.logger?.debug((0, i18n_1.t)('debug.mtaSaved'));
     }
     catch (error) {
         logger_helper_1.default.logger?.debug((0, i18n_1.t)('debug.mtaSavedFailed', { error }));
-        isMtaSaved = await mtaInstance.save();
     }
-    if (isMtaSaved) {
-        // Add mtaext if required for API Hub Enterprise connectivity
-        if (cfConfig.apiHubConfig?.apiHubType === "API_HUB_ENTERPRISE" /* ApiHubType.apiHubEnterprise */) {
-            try {
-                await mtaInstance.addMtaExtensionConfig(cfConfig.destinationName, cfConfig.serviceHost, {
-                    key: 'ApiKey',
-                    value: cfConfig.apiHubConfig.apiHubKey
-                });
-            }
-            catch (error) {
-                logger_helper_1.default.logger?.error((0, i18n_1.t)('error.mtaExtensionFailed', { error }));
-            }
+    // Add mtaext if required for API Hub Enterprise connectivity
+    if (cfConfig.apiHubConfig?.apiHubType === "API_HUB_ENTERPRISE" /* ApiHubType.apiHubEnterprise */) {
+        try {
+            await mtaInstance.addMtaExtensionConfig(cfConfig.destinationName, cfConfig.serviceHost, {
+                key: 'ApiKey',
+                value: cfConfig.apiHubConfig.apiHubKey
+            });
+        }
+        catch (error) {
+            logger_helper_1.default.logger?.error((0, i18n_1.t)('error.mtaExtensionFailed', { error }));
         }
-        logger_helper_1.default.logger?.debug((0, i18n_1.t)('debug.mtaSaved'));
     }
 }
 /**
@@ -329,31 +328,6 @@ async function updateHTML5AppPackage(cfConfig, fs) {
         await (0, project_access_1.addPackageDevDependency)(cfConfig.appPath, constants_1.MbtPackage, constants_1.MbtPackageVersion, fs);
     }
 }
-/**
- * Update the root package.json with scripts to deploy the MTA.
- *
- * @param cfConfig writer configuration
- * @param fs reference to a mem-fs editor
- */
-async function updateRootPackage(cfConfig, fs) {
-    const packageExists = fs.exists((0, path_1.join)(cfConfig.rootPath, project_access_1.FileName.Package));
-    // Append mta scripts only if mta.yaml is at a different level to the HTML5 app
-    if (cfConfig.isMtaRoot && packageExists) {
-        await (0, project_access_1.addPackageDevDependency)(cfConfig.rootPath, constants_1.Rimraf, constants_1.RimrafVersion, fs);
-        await (0, project_access_1.addPackageDevDependency)(cfConfig.rootPath, constants_1.MbtPackage, constants_1.MbtPackageVersion, fs);
-        let deployArgs = [];
-        if (fs.exists((0, path_1.join)(cfConfig.rootPath, constants_1.MTAFileExtension))) {
-            deployArgs = ['-e', constants_1.MTAFileExtension];
-        }
-        for (const script of [
-            { name: 'undeploy', run: (0, constants_1.undeployMTAScript)(cfConfig.mtaId ?? cfConfig.appId) },
-            { name: 'build', run: `${constants_1.MTABuildScript} --mtar archive` },
-            { name: 'deploy', run: (0, constants_1.rootDeployMTAScript)(deployArgs) }
-        ]) {
-            await (0, project_access_1.updatePackageScript)(cfConfig.rootPath, script.name, script.run, fs);
-        }
-    }
-}
 /**
  * Generate UI5 deploy config.
  *

package/dist/cf-writer/cap-config.js

@@ -32,8 +32,7 @@ async function generateCAPConfig(config, fs, logger) {
     const cdsOptionalParams = [constants_1.CDSXSUAAService, constants_1.CDSDestinationService, constants_1.CDSHTML5RepoService];
     (0, mta_config_1.createCAPMTA)(config.mtaPath, cdsOptionalParams);
     await (0, utils_1.addRoutingConfig)(config, fs);
-    (0, utils_1.addSupportingConfig)(config, fs);
-    logger_helper_1.default.logger?.debug(`CF CAP Config ${JSON.stringify(config, null, 2)}`);
+    await (0, utils_1.updateRootPackage)({ mtaId: config.mtaId, rootPath: config.mtaPath }, fs);
     return fs;
 }
 /**

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export * from './mta-config';
 export * from './cf-writer';
 export { DefaultMTADestination } from './constants';
-export { CFBaseConfig, CFAppConfig, RouterModuleType, ApiHubConfig, ApiHubType } from './types';
+export { CFBaseConfig, CFAppConfig, CAPConfig, RouterModuleType, ApiHubConfig, ApiHubType } from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/mta-config/index.js

@@ -155,6 +155,7 @@ function createCAPMTA(cwd, options) {
     if (result?.error) {
         throw new Error(`Something went wrong installing node modules! ${result.error}`);
     }
+    logger_helper_1.default.logger?.debug((0, i18n_1.t)('debug.capMtaCreated'));
 }
 /**
  * Validate the writer configuration to ensure all required parameters are present.

package/dist/translations/cf-deploy-config-writer.i18n.json

@@ -3,12 +3,13 @@
         "logError": "{{method}} error found {{ error }}",
         "mtaLoaded": "MTA {{ type }} loaded",
         "ui5YamlDoesNotExist": "File ui5.yaml does not exist in the project",
+        "capMtaCreated": "CAP MTA Configuration created",
         "mtaCreated": "MTA Configuration created {{mtaPath}}.",
         "mtaSaved": "MTA Configuration has been saved.",
         "mtaSavedFailed": "MTA saved failed with error {{- error }}"
     },
     "error": {
-        "unableToLoadMTA": "Unable to load mta.yaml configuration {{ mtaDir }}, error thrown {{ error }}.",
+        "unableToLoadMTA": "Unable to load mta.yaml configuration {{- mtaDir }}, error thrown {{- error }}.",
         "updatingMTAExtensionFailed": "Unable to add mta extension configuration to file: {{mtaExtFilePath}}.",
         "cannotFindBinary": "Cannot find the \"{{bin}}\" executable. Please add it to the path or use \"npm i -g {{- pkg}}\" to install it.",
         "mtaExtensionFailed": "Unable to create or update the mta extension file for Api Hub Enterprise destination configuration: {{error}}.",

package/dist/types/index.d.ts

@@ -10,10 +10,11 @@ export type MTADestinationType = Destination & {
     ServiceKeyName: string;
     'sap.cloud.service': string;
 };
-export declare enum RouterModuleType {
-    Standard = "standard",
-    Managed = "managed"
-}
+export declare const RouterModuleType: {
+    readonly Standard: "standard";
+    readonly Managed: "managed";
+};
+export type RouterModuleType = (typeof RouterModuleType)[keyof typeof RouterModuleType];
 export interface MTABaseConfig {
     mtaId: string;
     mtaPath: string;

package/dist/types/index.js

@@ -6,9 +6,8 @@ var CloudFoundryServiceType;
     CloudFoundryServiceType["Existing"] = "org.cloudfoundry.existing-service";
     CloudFoundryServiceType["Managed"] = "org.cloudfoundry.managed-service";
 })(CloudFoundryServiceType || (exports.CloudFoundryServiceType = CloudFoundryServiceType = {}));
-var RouterModuleType;
-(function (RouterModuleType) {
-    RouterModuleType["Standard"] = "standard";
-    RouterModuleType["Managed"] = "managed";
-})(RouterModuleType || (exports.RouterModuleType = RouterModuleType = {}));
+exports.RouterModuleType = {
+    Standard: 'standard',
+    Managed: 'managed'
+};
 //# sourceMappingURL=index.js.map

package/dist/utils.d.ts

@@ -114,4 +114,16 @@ export declare function addRoutingConfig(config: CFBaseConfig, fs: Editor): Prom
  * @param config writer configuration
  */
 export declare function setMtaDefaults(config: CFBaseConfig): void;
+/**
+ * Update the root package.json with scripts to deploy the MTA.
+ *
+ * @param {object} Options
+ * @param {string} Options.mtaId - MTA ID to be written to package.json
+ * @param {string} Options.rootPath - MTA project path
+ * @param fs
+ */
+export declare function updateRootPackage({ mtaId, rootPath }: {
+    mtaId: string;
+    rootPath: string;
+}, fs: Editor): Promise<void>;
 //# sourceMappingURL=utils.d.ts.map

package/dist/utils.js

@@ -18,6 +18,7 @@ exports.generateSupportingConfig = generateSupportingConfig;
 exports.addSupportingConfig = addSupportingConfig;
 exports.addRoutingConfig = addRoutingConfig;
 exports.setMtaDefaults = setMtaDefaults;
+exports.updateRootPackage = updateRootPackage;
 const path_1 = require("path");
 const semver_1 = require("semver");
 const btp_utils_1 = require("@sap-ux/btp-utils");
@@ -248,4 +249,31 @@ function setMtaDefaults(config) {
     config.addConnectivityService ||= false;
     config.mtaId = toMtaModuleName(config.mtaId);
 }
+/**
+ * Update the root package.json with scripts to deploy the MTA.
+ *
+ * @param {object} Options
+ * @param {string} Options.mtaId - MTA ID to be written to package.json
+ * @param {string} Options.rootPath - MTA project path
+ * @param fs
+ */
+async function updateRootPackage({ mtaId, rootPath }, fs) {
+    const packageExists = fs.exists((0, path_1.join)(rootPath, project_access_1.FileName.Package));
+    // Append mta scripts only if mta.yaml is at a different level to the HTML5 app
+    if (packageExists) {
+        await (0, project_access_1.addPackageDevDependency)(rootPath, constants_1.Rimraf, constants_1.RimrafVersion, fs);
+        await (0, project_access_1.addPackageDevDependency)(rootPath, constants_1.MbtPackage, constants_1.MbtPackageVersion, fs);
+        let deployArgs = [];
+        if (fs.exists((0, path_1.join)(rootPath, constants_1.MTAFileExtension))) {
+            deployArgs = ['-e', constants_1.MTAFileExtension];
+        }
+        for (const script of [
+            { name: 'undeploy', run: (0, constants_1.undeployMTAScript)(mtaId) },
+            { name: 'build', run: `${constants_1.MTABuildScript} --mtar archive` },
+            { name: 'deploy', run: (0, constants_1.rootDeployMTAScript)(deployArgs) }
+        ]) {
+            await (0, project_access_1.updatePackageScript)(rootPath, script.name, script.run, fs);
+        }
+    }
+}
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sap-ux/cf-deploy-config-writer",
   "description": "Add or amend Cloud Foundry and ABAP deployment configuration for SAP projects",
-  "version": "0.1.11",
+  "version": "0.1.14",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -29,7 +29,7 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "hasbin": "1.2.3",
-    "@sap-ux/project-access": "1.29.8",
+    "@sap-ux/project-access": "1.29.9",
     "@sap-ux/yaml": "0.16.0",
     "@sap-ux/btp-utils": "1.0.1",
     "@sap-ux/logger": "0.6.0",