@sap-ux/cf-deploy-config-writer 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,84 @@
+# @sap-ux/cf-deploy-config-writer
+
+Add or amend Cloud Foundry deployment configuration to SAP projects.
+
+## Prerequisites
+* For CAP Projects a CDS binary is required, for more information refer to the [CDS Tool](https://www.npmjs.com/package/@sap/cds)
+* For HTML5 Projects an MTA binary is required, for more information refer to the [MTA Tool](https://www.npmjs.com/package/mta), this is required to support the [mta-lib](https://www.npmjs.com/package/@sap/mta-lib) library which handles the flows for interacting with the `mta.yaml` configuration. 
+
+## Installation
+Npm
+`npm install --save @sap-ux/cf-deploy-config-writer`
+
+Yarn
+`yarn add @sap-ux/cf-deploy-config-writer`
+
+Pnpm
+`pnpm add @sap-ux/cf-deploy-config-writer`
+
+## Usage
+Calling the MtaConfig library to add routing modules, HTML5 apps, destinations, and mta extension configurations to an existing MTA configuration file. Dependent on the [MTA Tool](https://www.npmjs.com/package/mta) for exploring and validating the changes being made.
+```Typescript
+import { MtaConfig } from '@sap-ux/cf-deploy-config-writer';
+// Create a new instance of MtaConfig
+const mtaConfig = await MtaConfig.newInstance('path/to/mta.yaml');
+// Carry out some operations...
+// 1. Add routing modules and also add managed approuter configuration
+await mtaConfig.addRoutingModules(true);
+// 2. Add new HTML5 app
+await mtaConfig.addApp('myui5app', './');
+// 3. Append a destination instance to the destination service, required by consumers of CAP services (e.g. approuter, destinations)
+await mtaConfig.appendInstanceBasedDestination('mynewdestination');
+// 4. Append mta extension configuration
+await mtaConfig.addMtaExtensionConfig('mynewdestination', 'https://my-service-url.base', {
+  key: 'ApiKey',
+  value: `${apiHubKey}`
+});
+// 5. Save changes
+await mtaConfig.save();
+```
+
+Calling the `generateAppConfig` function to append Cloud Foundry configuration to a HTML5 application;
+```Typescript
+import { generateAppConfig, DefaultMTADestination } from '@sap-ux/cf-deploy-config-writer'
+import { join } from 'path';
+
+const exampleWriter = async () => {
+  const appPath = join(__dirname, 'testapp');
+  // Append managed approuter configuration, toggle `cfAddManagedAppRouter` to false to ommit the managed approuter configuration being appended to the mta.yaml
+  const fs = await generateAppConfig({appPath, destinationName: 'SAPBTPDestination'}); 
+  // For CAP flows, set the destination to DefaultMTADestination to create a destination service instance between the HTML5 and CAP Project
+  const fs = await generateAppConfig({appPath, addManagedAppRouter: true, destinationName: DefaultMTADestination});
+  return new Promise((resolve) => {
+      fs.commit(resolve); // When using with Yeoman it handle the fs commit.
+  });
+}
+// Calling the function
+await exampleWriter();
+```
+
+Calling the `generateBaseConfig` function to generate a `new` Cloud Foundry configuration, supporting managed | standalone configurations;
+```Typescript
+import { generateBaseConfig, RouterModuleType } from '@sap-ux/cf-deploy-config-writer'
+import { join } from 'path';
+
+const exampleWriter = async () => {
+  const mtaPath = join(__dirname, 'testapp');
+  // Generate a managed approuter configuration, toggle the routerType to Standard for a standalone configuration
+  const fs = await generateBaseConfig({ mtaId: 'myapp', routerType: RouterModuleType.Managed, mtaPath });
+  return new Promise((resolve) => {
+      fs.commit(resolve); // When using with Yeoman it handle the fs commit.
+  });
+}
+// Calling the function
+await exampleWriter();
+```
+
+## Keywords
+SAP Fiori elements
+SAP UI5
+SAP Deployment
+Cloud Foundry
+MTA
+Multi-Target Application
+

package/dist/cf-writer/app-config.d.ts

@@ -0,0 +1,21 @@
+import { type Editor } from 'mem-fs-editor';
+import { type Logger } from '@sap-ux/logger';
+import { type CFConfig, type CFAppConfig } from '../types';
+/**
+ * Add a managed approuter configuration to an existing HTML5 application.
+ *
+ * @param cfAppConfig writer configuration
+ * @param fs an optional reference to a mem-fs editor
+ * @param logger optional logger instance
+ * @returns file system reference
+ */
+export declare function generateAppConfig(cfAppConfig: CFAppConfig, fs?: Editor, logger?: Logger): Promise<Editor>;
+/**
+ * Generate UI5 deploy config.
+ *
+ * @param cfConfig - the deploy config
+ * @param fs reference to a mem-fs editor
+ * @returns the deploy config
+ */
+export declare function generateUI5DeployConfig(cfConfig: CFConfig, fs: Editor): Promise<void>;
+//# sourceMappingURL=app-config.d.ts.map

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

@@ -0,0 +1,368 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateAppConfig = generateAppConfig;
+exports.generateUI5DeployConfig = generateUI5DeployConfig;
+const path_1 = require("path");
+const child_process_1 = require("child_process");
+const mem_fs_1 = require("mem-fs");
+const mem_fs_editor_1 = require("mem-fs-editor");
+const hasbin_1 = require("hasbin");
+const ui5_config_1 = require("@sap-ux/ui5-config");
+const project_access_1 = require("@sap-ux/project-access");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const constants_1 = require("../constants");
+const utils_1 = require("../utils");
+const mta_config_1 = require("../mta-config");
+const logger_helper_1 = __importDefault(require("../logger-helper"));
+const i18n_1 = require("../i18n");
+/**
+ * Add a managed approuter configuration to an existing HTML5 application.
+ *
+ * @param cfAppConfig writer configuration
+ * @param fs an optional reference to a mem-fs editor
+ * @param logger optional logger instance
+ * @returns file system reference
+ */
+async function generateAppConfig(cfAppConfig, fs, logger) {
+    if (!fs) {
+        fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
+    }
+    if (logger) {
+        logger_helper_1.default.logger = logger;
+    }
+    validateMtaConfig();
+    await generateDeployConfig(cfAppConfig, fs);
+    return fs;
+}
+/**
+ * Validate the conditions to allow deployment configuration to be added.
+ *
+ */
+function validateMtaConfig() {
+    // CF writer is dependent on the mta-lib library, which in turn relies on the mta executable being installed and available in the path
+    if (!(0, hasbin_1.sync)(constants_1.MTAExecutable)) {
+        throw new Error(constants_1.MTABinNotFound);
+    }
+}
+/**
+ * Returns the updated configuration for the given HTML5 app, after reading all the required files.
+ *
+ * @param cfAppConfig writer configuration
+ * @param fs reference to a mem-fs editor
+ * @returns updated writer configuration
+ */
+async function getUpdatedConfig(cfAppConfig, fs) {
+    const isLCAP = cfAppConfig.lcapMode ?? false;
+    const { rootPath, isCap, mtaId, mtaPath, hasRoot, capRoot } = await getProjectProperties(cfAppConfig);
+    const { serviceHost, destination } = await processUI5Config(cfAppConfig.appPath, fs);
+    const { servicePath, firstServicePathSegment, appId } = await processManifest(cfAppConfig.appPath, fs);
+    const { isFullUrlDest, destinationAuthType } = await (0, utils_1.getDestinationProperties)(cfAppConfig.destinationName ?? destination);
+    const config = {
+        appPath: cfAppConfig.appPath.replace(/\/$/, ''),
+        destinationName: cfAppConfig.destinationName ?? destination,
+        addManagedAppRouter: cfAppConfig.addManagedAppRouter ?? true,
+        lcapMode: !isCap ? false : isLCAP, // Restricting local changes is only applicable for CAP flows
+        isMtaRoot: hasRoot ?? false,
+        serviceHost: cfAppConfig.serviceHost ?? serviceHost,
+        rootPath: rootPath.replace(/\/$/, ''),
+        mtaId,
+        mtaPath,
+        destinationAuthType,
+        isCap,
+        servicePath,
+        firstServicePathSegment,
+        appId,
+        capRoot,
+        isFullUrlDest
+    };
+    logger_helper_1.default.logger?.debug(`CF Config loaded: ${JSON.stringify(config, null, 2)}`);
+    return config;
+}
+/**
+ * Get project properties.
+ *
+ * @param config writer configuration
+ * @returns project properties
+ */
+async function getProjectProperties(config) {
+    let isCap = false;
+    let rootPath;
+    let mtaPath;
+    let mtaId;
+    const foundMtaPath = await (0, project_access_1.getMtaPath)(config.appPath);
+    if (foundMtaPath) {
+        mtaPath = (0, path_1.dirname)(foundMtaPath.mtaPath);
+        mtaId = await (0, mta_config_1.getMtaId)(mtaPath);
+    }
+    const hasRoot = foundMtaPath?.hasRoot ?? false;
+    const capRoot = (await (0, project_access_1.findCapProjectRoot)(config.appPath)) ?? undefined;
+    if (capRoot) {
+        // CDS executable is required for CAP projects as the mta.yaml file is generated by the cds deploy command
+        if (!(0, hasbin_1.sync)(constants_1.CDSExecutable)) {
+            throw new Error(constants_1.CDSBinNotFound);
+        }
+        isCap = true;
+        rootPath = capRoot;
+    }
+    else {
+        rootPath = mtaPath ?? config.appPath;
+    }
+    return { rootPath, isCap, mtaId, mtaPath, hasRoot, capRoot };
+}
+/**
+ * Reads the ui5.yaml file and returns the service base, firstServicePathSegment and destination if found.
+ *
+ * @param appPath path to the application
+ * @param fs reference to a mem-fs editor
+ * @returns serviceBase, firstServicePathSegment and destination properties
+ */
+async function processUI5Config(appPath, fs) {
+    let destination;
+    let serviceHost;
+    let firstServicePathSegment;
+    try {
+        const ui5YamlConfig = await (0, project_access_1.readUi5Yaml)(appPath, project_access_1.FileName.Ui5Yaml, fs);
+        const toolsConfig = ui5YamlConfig.findCustomMiddleware('fiori-tools-proxy');
+        if (toolsConfig?.configuration?.backend?.length === 1) {
+            destination = toolsConfig?.configuration?.backend[0].destination;
+            serviceHost = toolsConfig?.configuration?.backend[0].url;
+            firstServicePathSegment = toolsConfig?.configuration?.backend[0].path;
+        }
+    }
+    catch (error) {
+        logger_helper_1.default.logger?.debug((0, i18n_1.t)('debug.ui5YamlDoesNotExist'));
+    }
+    return { destination, serviceHost, firstServicePathSegment };
+}
+/**
+ * Reads the manifest.json file and returns the service path, firstServicePathSegment and appId if found.
+ *
+ * @param appPath path to the application
+ * @param fs reference to a mem-fs editor
+ * @returns servicePath, firstServicePathSegment and appId properties
+ */
+async function processManifest(appPath, fs) {
+    const manifest = await (0, utils_1.readManifest)((0, path_1.join)(appPath, 'webapp/manifest.json'), fs);
+    const appId = manifest?.['sap.app']?.id ? (0, mta_config_1.toMtaModuleName)(manifest?.['sap.app']?.id) : undefined;
+    const servicePath = manifest?.['sap.app']?.dataSources?.mainService?.uri;
+    const firstServicePathSegment = servicePath?.substring(0, servicePath?.indexOf('/', 1));
+    return { servicePath, firstServicePathSegment, appId };
+}
+/**
+ *
+ * @param cfAppConfig writer configuration
+ * @param fs reference to a mem-fs editor
+ */
+async function generateDeployConfig(cfAppConfig, fs) {
+    const cfConfig = await getUpdatedConfig(cfAppConfig, fs);
+    // Generate MTA Config, LCAP will generate the mta.yaml on the fly so we dont care about it!
+    if (!cfConfig.lcapMode) {
+        createMTAConfig(cfConfig);
+        await generateSupportingConfig(cfConfig, fs);
+        await updateMtaConfig(cfConfig);
+    }
+    // Generate HTML5 config
+    await appendCloudFoundryConfigurations(cfConfig, fs);
+    await updateManifest(cfConfig, fs);
+    await updateHTML5AppPackage(cfConfig, fs);
+    await updateRootPackage(cfConfig, fs);
+}
+/**
+ * Creates the MTA configuration file.
+ *
+ * @param cfConfig writer configuration
+ */
+function createMTAConfig(cfConfig) {
+    if (!cfConfig.mtaId) {
+        if (cfConfig.isCap) {
+            const result = (0, child_process_1.spawnSync)(constants_1.CDSExecutable, constants_1.CDSAddMtaParams, {
+                cwd: cfConfig.rootPath
+            });
+            if (result.error) {
+                throw new Error(constants_1.CDSBinNotFound);
+            }
+        }
+        else {
+            (0, mta_config_1.createMTA)({ mtaId: cfConfig.appId, mtaPath: cfConfig.mtaPath ?? cfConfig.rootPath });
+        }
+        cfConfig.mtaId = cfConfig.appId;
+        cfConfig.mtaPath = cfConfig.rootPath;
+    }
+}
+/**
+ * Generate CF specific configurations to support deployment and undeployment.
+ *
+ * @param config writer configuration
+ * @param fs reference to a mem-fs editor
+ */
+async function generateSupportingConfig(config, fs) {
+    const mtaId = config.mtaId ?? (await (0, mta_config_1.getMtaId)(config.rootPath));
+    // Add specific MTA ID configurations
+    const mtaConfig = { mtaId: mtaId ?? config.appId, mtaPath: config.rootPath };
+    if (mtaId && !fs.exists((0, path_1.join)(config.rootPath, 'package.json'))) {
+        (0, utils_1.addRootPackage)(mtaConfig, fs);
+    }
+    if (config.addManagedAppRouter && !fs.exists((0, path_1.join)(config.rootPath, constants_1.XSSecurityFile))) {
+        (0, utils_1.addXSSecurityConfig)(mtaConfig, fs);
+    }
+    // Be a good developer and add a .gitignore if missing from the existing project root
+    if (!fs.exists((0, path_1.join)(config.rootPath, '.gitignore'))) {
+        (0, utils_1.addGitIgnore)(config.rootPath, fs);
+    }
+}
+/**
+ * Updates the MTA configuration file.
+ *
+ * @param cfConfig writer configuration
+ */
+async function updateMtaConfig(cfConfig) {
+    const mtaInstance = await (0, mta_config_1.getMtaConfig)(cfConfig.rootPath);
+    if (mtaInstance) {
+        await mtaInstance.addRoutingModules(cfConfig.addManagedAppRouter);
+        const appModule = cfConfig.appId;
+        const appRelativePath = (0, utils_1.toPosixPath)((0, path_1.relative)(cfConfig.rootPath, cfConfig.appPath));
+        await mtaInstance.addApp(appModule, appRelativePath ?? '.');
+        await (0, mta_config_1.addMtaDeployParameters)(mtaInstance);
+        if ((cfConfig.destinationName && cfConfig.isCap) || cfConfig.destinationName === constants_1.DefaultMTADestination) {
+            // If the destination instance identifier is passed, create a destination instance
+            cfConfig.destinationName =
+                cfConfig.destinationName === constants_1.DefaultMTADestination
+                    ? mtaInstance.getFormattedPrefix(constants_1.ResourceMTADestination)
+                    : cfConfig.destinationName;
+            await mtaInstance.appendInstanceBasedDestination(cfConfig.destinationName);
+            // This is required where a managed or standalone router hasnt been added yet to mta.yaml
+            if (!mtaInstance.hasManagedXsuaaResource()) {
+                cfConfig.destinationAuthType = btp_utils_1.Authentication.NO_AUTHENTICATION;
+            }
+        }
+        await saveMta(cfConfig, mtaInstance);
+        cfConfig.cloudServiceName = mtaInstance.cloudServiceName;
+    }
+}
+/**
+ * Apply changes to mta.yaml.
+ *
+ * @param cfConfig writer configuration
+ * @param mtaInstance MTA configuration instance
+ */
+async function saveMta(cfConfig, mtaInstance) {
+    if (await mtaInstance.save()) {
+        // 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 }));
+            }
+        }
+    }
+}
+/**
+ * Appends the Cloud Foundry specific configurations to the project.
+ *
+ * @param cfConfig writer configuration
+ * @param fs reference to a mem-fs editor
+ */
+async function appendCloudFoundryConfigurations(cfConfig, fs) {
+    // When data source is none in app generator, it is not required to provide destination
+    if (cfConfig.destinationName && cfConfig.destinationName !== constants_1.EmptyDestination) {
+        fs.copyTpl((0, utils_1.getTemplatePath)('app/xs-app-destination.json'), (0, path_1.join)(cfConfig.appPath, constants_1.XSAppFile), {
+            destination: cfConfig.destinationName,
+            servicePathSegment: `${cfConfig.firstServicePathSegment}${cfConfig.isFullUrlDest ? '/.*' : ''}`, // For service URL's, pull out everything after the last slash
+            targetPath: `${cfConfig.isFullUrlDest ? '' : cfConfig.firstServicePathSegment}/$1`, // Pull group 1 from the regex
+            authentication: cfConfig.destinationAuthType === constants_1.NoAuthType ? 'none' : 'xsuaa'
+        });
+    }
+    else {
+        fs.copyTpl((0, utils_1.getTemplatePath)('app/xs-app-no-destination.json'), (0, path_1.join)(cfConfig.appPath, constants_1.XSAppFile));
+    }
+    await generateUI5DeployConfig(cfConfig, fs);
+}
+/**
+ * Updates the manifest.json file with the cloud service name.
+ *
+ * @param cfConfig writer configuration
+ * @param fs reference to a mem-fs editor
+ */
+async function updateManifest(cfConfig, fs) {
+    const manifest = await (0, utils_1.readManifest)((0, path_1.join)(cfConfig.appPath, 'webapp/manifest.json'), fs);
+    if (manifest && cfConfig.cloudServiceName) {
+        const sapCloud = {
+            ...(manifest['sap.cloud'] || {}),
+            public: true,
+            service: cfConfig.cloudServiceName
+        };
+        fs.extendJSON((0, path_1.join)(cfConfig.appPath, 'webapp/manifest.json'), {
+            'sap.cloud': sapCloud
+        });
+    }
+}
+/**
+ * Updates the package.json file with the necessary scripts and dependencies.
+ *
+ * @param cfConfig writer configuration
+ * @param fs reference to a mem-fs editor
+ */
+async function updateHTML5AppPackage(cfConfig, fs) {
+    let deployArgs = [];
+    if (fs.exists((0, path_1.join)(cfConfig.appPath, constants_1.MTAFileExtension))) {
+        deployArgs = ['-e', constants_1.MTAFileExtension];
+    }
+    await (0, project_access_1.updatePackageScript)(cfConfig.appPath, 'build:cf', constants_1.UI5DeployBuildScript, fs);
+    await (0, project_access_1.updatePackageScript)(cfConfig.appPath, 'build:mta', constants_1.MTABuildScript, fs);
+    await (0, project_access_1.updatePackageScript)(cfConfig.appPath, 'deploy', (0, constants_1.appDeployMTAScript)(deployArgs), fs);
+    await (0, project_access_1.updatePackageScript)(cfConfig.appPath, 'undeploy', (0, constants_1.undeployMTAScript)(cfConfig.mtaId ?? cfConfig.appId), fs);
+    await (0, utils_1.addCommonPackageDependencies)(cfConfig.appPath, 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, 'package.json'));
+    // Append mta scripts only if mta.yaml is a different level to the HTML5 app
+    if (cfConfig.isMtaRoot && packageExists) {
+        let deployArgs = [];
+        if (fs.exists((0, path_1.join)(cfConfig.rootPath, constants_1.MTAFileExtension))) {
+            deployArgs = ['-e', constants_1.MTAFileExtension];
+        }
+        [
+            { 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) }
+        ].forEach(async (script) => {
+            await (0, project_access_1.updatePackageScript)(cfConfig.rootPath, script.name, script.run, fs);
+        });
+        await (0, utils_1.addCommonPackageDependencies)(cfConfig.rootPath, fs);
+    }
+}
+/**
+ * Generate UI5 deploy config.
+ *
+ * @param cfConfig - the deploy config
+ * @param fs reference to a mem-fs editor
+ * @returns the deploy config
+ */
+async function generateUI5DeployConfig(cfConfig, fs) {
+    const ui5BaseConfig = await (0, project_access_1.readUi5Yaml)(cfConfig.appPath, project_access_1.FileName.Ui5Yaml, fs);
+    const addTranspileTask = !!ui5BaseConfig.findCustomMiddleware('ui5-tooling-transpile-task');
+    const addModulesTask = !!ui5BaseConfig.findCustomMiddleware('ui5-tooling-modules-task');
+    const baseUi5Doc = ui5BaseConfig.removeConfig('server');
+    const ui5DeployConfig = await ui5_config_1.UI5Config.newInstance(baseUi5Doc.toString());
+    ui5DeployConfig.addComment({
+        comment: ' yaml-language-server: $schema=https://sap.github.io/ui5-tooling/schema/ui5.yaml.json',
+        location: 'beginning'
+    });
+    ui5DeployConfig.addCloudFoundryDeployTask(cfConfig.appId, addModulesTask, addTranspileTask);
+    fs.write((0, path_1.join)(cfConfig.appPath, project_access_1.FileName.UI5DeployYaml), ui5DeployConfig.toString());
+}
+//# sourceMappingURL=app-config.js.map