Feature/2007/create cf deploy config writer

.changeset/honest-poets-sniff.md

@@ -0,0 +1,8 @@
+---
+'@sap-ux/cf-deploy-config-writer': patch
+'@sap-ux/project-access': patch
+'@sap-ux/ui5-config': patch
+'@sap-ux/telemetry': patch
+---
+
+add new cf deploy writer and dependencies that it requires

packages/cf-deploy-config-writer/.eslintignore

@@ -0,0 +1,3 @@
+test/test-output
+test/sample
+dist

packages/cf-deploy-config-writer/.eslintrc.js

@@ -0,0 +1,7 @@
+module.exports = {
+    extends: ['../../.eslintrc'],
+    parserOptions: {
+        project: './tsconfig.eslint.json',
+        tsconfigRootDir: __dirname
+    }
+};

packages/cf-deploy-config-writer/.gitignore

@@ -0,0 +1 @@
+./test/test-output

packages/cf-deploy-config-writer/CHANGELOG.md

@@ -0,0 +1 @@
+# @sap-ux/deploy-config-writer

packages/cf-deploy-config-writer/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.

packages/cf-deploy-config-writer/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 `generate` function to append Cloud Foundry configuration to a HTML5 project;
+```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 `addManagedRouter` to false to ommit the managed approuter configuration being appended to the mta.yaml
+  const fs = await generateAppConfig({appPath, destination: '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, destination: 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
+

packages/cf-deploy-config-writer/jest.config.js

@@ -0,0 +1,2 @@
+const config = require('../../jest.base');
+module.exports = config;

packages/cf-deploy-config-writer/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@sap-ux/cf-deploy-config-writer",
+  "description": "Add or amend Cloud Foundry and ABAP deployment configuration for SAP projects",
+  "version": "0.0.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/cf-deploy-config-writer"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Acf-deploy-config-writer"
+  },
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "author": "@SAP/ux-tools-team",
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rimraf dist coverage *.tsbuildinfo",
+    "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors",
+    "watch": "tsc --watch"
+  },
+  "files": [
+    "LICENSE",
+    "dist",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "dependencies": {
+    "@sap-ux/project-access": "workspace:*",
+    "@sap-ux/yaml": "workspace:*",
+    "@sap-ux/btp-utils": "workspace:*",
+    "@sap-ux/logger": "workspace:*",
+    "@sap-ux/ui5-config": "workspace:*",
+    "@sap/mta-lib": "1.7.4",
+    "@sap/cf-tools": "3.2.0",
+    "semver": "7.5.4",
+    "ejs": "3.1.10",
+    "i18next": "21.10.0",
+    "mem-fs": "2.1.0",
+    "mem-fs-editor": "9.4.0",
+    "hasbin": "1.2.3"
+  },
+  "devDependencies": {
+    "@types/ejs": "3.1.2",
+    "@types/mem-fs": "1.1.2",
+    "@types/mem-fs-editor": "7.0.1",
+    "@types/hasbin": "1.2.2",
+    "@types/fs-extra": "9.0.13",
+    "@types/js-yaml": "4.0.9",
+    "@types/semver": "7.5.2",
+    "memfs": "3.4.13",
+    "js-yaml": "3.14.0",
+    "fs-extra": "10.0.0"
+  },
+  "engines": {
+    "node": ">=18.x"
+  }
+}