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

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

@@ -0,0 +1,25 @@
+{
+    "debug": {
+        "logError": "{{method}} error found {{ error }}",
+        "mtaLoaded": "MTA {{ type }} loaded",
+        "ui5YamlDoesNotExist": "File ui5.yaml does not exist in the project"
+    },
+    "error": {
+        "unableToLoadMTA": "Unable to load mta.yaml configuration",
+        "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}}",
+        "serviceKeyFailed": "Failed to fetch service key",
+        "missingMtaParameters": "Missing required parameters, MTA path, MTA ID or router type is missing",
+        "invalidMtaIdWithChars": "The MTA ID can only contain letters, numbers, dashes, periods, underscores",
+        "invalidMtaId": "The MTA ID must start with a letter or underscore and be less than 128 characters long",
+        "missingABAPServiceBindingDetails": "Missing ABAP service details for direct service binding",
+        "mtaAlreadyExists": "A folder with same name already exists in the target directory"
+    },
+    "info": {
+        "existingMTAExtensionNotFound": "Cannot find a valid existing mta extension file, a new one will be created",
+        "existingDestinationNotFound": "A destination service resource cannot be found in the mta.yaml. An mta extension destination instance cannot be added",
+        "mtaExtensionCreated": "Created file: {{mtaExtFile}} to extend mta module {{appMtaId}} with destination configuration",
+        "mtaExtensionUpdated": "Updated file: {{mtaExtFile}} with module destination configuration"
+    }
+}

package/dist/types/index.d.ts

@@ -0,0 +1,89 @@
+import type { Destination, Authentication } from '@sap-ux/btp-utils';
+export type ResourceType = 'xsuaa' | 'destination' | 'portal' | 'connectivity' | 'managed:xsuaa' | 'html5-apps-repo:app-host' | 'html5-apps-repo:app-runtime';
+export type ModuleType = 'hdb' | 'nodejs' | 'java' | 'approuter.nodejs' | 'com.sap.application.content' | 'com.sap.application.content:destination' | 'com.sap.application.content:resource' | 'html5' | 'com.sap.portal.content';
+export declare enum CloudFoundryServiceType {
+    Existing = "org.cloudfoundry.existing-service",
+    Managed = "org.cloudfoundry.managed-service"
+}
+export type MTADestinationType = Destination & {
+    ServiceInstanceName: string;
+    ServiceKeyName: string;
+    'sap.cloud.service': string;
+};
+export declare enum RouterModuleType {
+    Standard = "standard",
+    Managed = "managed"
+}
+export interface MTABaseConfig {
+    mtaId: string;
+    mtaPath: string;
+    mtaDescription?: string;
+    mtaVersion?: string;
+}
+export interface CFBaseConfig extends MTABaseConfig {
+    routerType: RouterModuleType;
+    addConnectivityService?: boolean;
+    addDestinationService?: boolean;
+    abapServiceProvider?: {
+        abapServiceName?: string;
+        abapService?: string;
+    };
+}
+export interface CFAppConfig {
+    appPath: string;
+    addManagedAppRouter?: boolean;
+    destinationName?: string;
+    apiHubConfig?: ApiHubConfig;
+    serviceHost?: string;
+    lcapMode?: boolean;
+}
+export interface CFConfig extends CFAppConfig, CFBaseConfig {
+    appId: string;
+    rootPath: string;
+    serviceHost: string;
+    capRoot?: string;
+    isCap?: boolean;
+    servicePath?: string;
+    firstServicePathSegment?: string;
+    isFullUrlDest?: boolean;
+    destinationAuthType?: Authentication;
+    cloudServiceName?: string;
+    isMtaRoot?: boolean;
+}
+export declare const enum ApiHubType {
+    apiHub = "API_HUB",
+    apiHubEnterprise = "API_HUB_ENTERPRISE"
+}
+export interface ApiHubConfig {
+    apiHubKey: string;
+    apiHubType: ApiHubType;
+}
+export interface XSAppRoute {
+    source?: string;
+    target?: string;
+    destination?: string;
+    csrfProtection?: boolean;
+    scope?: string;
+    service?: string;
+    endpoint?: string;
+    authenticationType?: string;
+    dependency?: string;
+}
+export type XSAppRouteProperties = keyof XSAppRoute;
+export interface XSAppDocument {
+    authenticationMethod?: string;
+    routes?: XSAppRoute[];
+    welcomeFile?: string;
+}
+export interface HTML5App {
+    path: string;
+    'build-parameters': {
+        builder: string;
+        'build-result': string;
+        commands: string[];
+        'supported-platforms': string[];
+    };
+    name: string;
+    type: string;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RouterModuleType = exports.CloudFoundryServiceType = void 0;
+var CloudFoundryServiceType;
+(function (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 = {}));
+//# sourceMappingURL=index.js.map

package/dist/utils.d.ts

@@ -0,0 +1,91 @@
+import { Authentication } from '@sap-ux/btp-utils';
+import { type Manifest } from '@sap-ux/project-access';
+import type { Editor } from 'mem-fs-editor';
+import type { Destinations } from '@sap-ux/btp-utils';
+import type { MTABaseConfig } from './types';
+/**
+ *  Read manifest file for processing.
+ *
+ * @param manifestPath Path to the manifest file
+ * @param fs reference to a mem-fs editor
+ * @returns Manifest object
+ */
+export declare function readManifest(manifestPath: string, fs: Editor): Promise<Manifest>;
+/**
+ * Locates template files relative to the dist folder.
+ * This helps to locate templates when this module is bundled and the dir structure is flattened, maintaining the relative paths.
+ *
+ * @param relativeTemplatePath - optional, the path of the required template relative to the ./templates folder. If not specified the root templates folder is returned.
+ * @returns the path of the template specified or templates root folder
+ */
+export declare function getTemplatePath(relativeTemplatePath?: string): string;
+/**
+ *  Convert an app name to an MTA ID that is suitable for CF deployment.
+ *
+ * @param id Name of the app, like `sap.ux.app`
+ * @returns Name that's acceptable in an mta.yaml
+ */
+export declare function toMtaModuleName(id: string): string;
+/**
+ * Return a consistent file path across different platforms.
+ *
+ * @param dirPath Path to the directory
+ * @returns Path to the directory with consistent separators
+ */
+export declare function toPosixPath(dirPath: string): string;
+/**
+ * Get the destination properties, based on the destination value.
+ *
+ * @param destination destination name
+ * @returns Destination properties, default properties returned if not found
+ */
+export declare function getDestinationProperties(destination: string | undefined): Promise<{
+    isFullUrlDest: boolean;
+    destinationAuthType: Authentication;
+}>;
+/**
+ * Retrieve the list of destinations from SAP BTP.
+ *
+ * @returns Destinations list
+ */
+export declare function getBTPDestinations(): Promise<Destinations>;
+/**
+ * Validates the MTA version passed in the config.
+ *
+ * @param mtaVersion MTA version
+ * @returns true if the version is valid
+ */
+export declare function validateVersion(mtaVersion?: string): boolean;
+/**
+ *  Append xs-security.json to project folder.
+ *
+ * @param root0 MTA base configuration
+ * @param root0.mtaPath Path to the MTA project
+ * @param root0.mtaId MTA ID
+ * @param fs reference to a mem-fs editor
+ */
+export declare function addXSSecurityConfig({ mtaPath, mtaId }: MTABaseConfig, fs: Editor): void;
+/**
+ *  Append .gitignore to project folder.
+ *
+ * @param targetPath Path to the project folder
+ * @param fs reference to a mem-fs editor
+ */
+export declare function addGitIgnore(targetPath: string, fs: Editor): void;
+/**
+ * Append server package.json to project folder.
+ *
+ * @param root0 MTA base configuration
+ * @param root0.mtaPath Path to the MTA project
+ * @param root0.mtaId MTA ID
+ * @param fs reference to a mem-fs editor
+ */
+export declare function addRootPackage({ mtaPath, mtaId }: MTABaseConfig, fs: Editor): void;
+/**
+ * Add common dependencies to the HTML5 app package.json.
+ *
+ * @param targetPath Path to the package.json file
+ * @param fs reference to a mem-fs editor
+ */
+export declare function addCommonPackageDependencies(targetPath: string, fs: Editor): Promise<void>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.js

@@ -0,0 +1,149 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readManifest = readManifest;
+exports.getTemplatePath = getTemplatePath;
+exports.toMtaModuleName = toMtaModuleName;
+exports.toPosixPath = toPosixPath;
+exports.getDestinationProperties = getDestinationProperties;
+exports.getBTPDestinations = getBTPDestinations;
+exports.validateVersion = validateVersion;
+exports.addXSSecurityConfig = addXSSecurityConfig;
+exports.addGitIgnore = addGitIgnore;
+exports.addRootPackage = addRootPackage;
+exports.addCommonPackageDependencies = addCommonPackageDependencies;
+const path_1 = require("path");
+const semver_1 = require("semver");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const project_access_1 = require("@sap-ux/project-access");
+const constants_1 = require("./constants");
+let cachedDestinationsList = {};
+/**
+ *  Read manifest file for processing.
+ *
+ * @param manifestPath Path to the manifest file
+ * @param fs reference to a mem-fs editor
+ * @returns Manifest object
+ */
+async function readManifest(manifestPath, fs) {
+    return fs.readJSON(manifestPath);
+}
+/**
+ * Locates template files relative to the dist folder.
+ * This helps to locate templates when this module is bundled and the dir structure is flattened, maintaining the relative paths.
+ *
+ * @param relativeTemplatePath - optional, the path of the required template relative to the ./templates folder. If not specified the root templates folder is returned.
+ * @returns the path of the template specified or templates root folder
+ */
+function getTemplatePath(relativeTemplatePath = '') {
+    return (0, path_1.join)(__dirname, '../templates', relativeTemplatePath);
+}
+/**
+ *  Convert an app name to an MTA ID that is suitable for CF deployment.
+ *
+ * @param id Name of the app, like `sap.ux.app`
+ * @returns Name that's acceptable in an mta.yaml
+ */
+function toMtaModuleName(id) {
+    return id.replace(/[`~!@#$%^&*()_|+\-=?;:'",.<>]/gi, '');
+}
+/**
+ * Return a consistent file path across different platforms.
+ *
+ * @param dirPath Path to the directory
+ * @returns Path to the directory with consistent separators
+ */
+function toPosixPath(dirPath) {
+    return (0, path_1.normalize)(dirPath).split(/[\\/]/g).join(path_1.posix.sep);
+}
+/**
+ * Get the destination properties, based on the destination value.
+ *
+ * @param destination destination name
+ * @returns Destination properties, default properties returned if not found
+ */
+async function getDestinationProperties(destination) {
+    const destinationProperties = {
+        isFullUrlDest: false,
+        destinationAuthType: btp_utils_1.Authentication.NO_AUTHENTICATION
+    };
+    if ((0, btp_utils_1.isAppStudio)() && destination) {
+        const destinations = await getBTPDestinations();
+        if (destinations[destination]) {
+            destinationProperties.isFullUrlDest = (0, btp_utils_1.isFullUrlDestination)(destinations[destination]);
+            destinationProperties.destinationAuthType = destinations[destination].Authentication;
+        }
+    }
+    return destinationProperties;
+}
+/**
+ * Retrieve the list of destinations from SAP BTP.
+ *
+ * @returns Destinations list
+ */
+async function getBTPDestinations() {
+    if (Object.keys(cachedDestinationsList).length === 0) {
+        cachedDestinationsList = await (0, btp_utils_1.listDestinations)();
+    }
+    return cachedDestinationsList;
+}
+/**
+ * Validates the MTA version passed in the config.
+ *
+ * @param mtaVersion MTA version
+ * @returns true if the version is valid
+ */
+function validateVersion(mtaVersion) {
+    const version = (0, semver_1.coerce)(mtaVersion);
+    if ((mtaVersion && !version) || (version && !(0, semver_1.satisfies)(version, `>=${constants_1.MTAVersion}`))) {
+        throw new Error('Invalid MTA version specified. Please use version 0.0.1 or higher.');
+    }
+    return true;
+}
+/**
+ *  Append xs-security.json to project folder.
+ *
+ * @param root0 MTA base configuration
+ * @param root0.mtaPath Path to the MTA project
+ * @param root0.mtaId MTA ID
+ * @param fs reference to a mem-fs editor
+ */
+function addXSSecurityConfig({ mtaPath, mtaId }, fs) {
+    fs.copyTpl(getTemplatePath(`common/${constants_1.XSSecurityFile}`), (0, path_1.join)(mtaPath, constants_1.XSSecurityFile), {
+        id: mtaId.slice(0, 100)
+    });
+}
+/**
+ *  Append .gitignore to project folder.
+ *
+ * @param targetPath Path to the project folder
+ * @param fs reference to a mem-fs editor
+ */
+function addGitIgnore(targetPath, fs) {
+    fs.copyTpl(getTemplatePath('gitignore.tmpl'), (0, path_1.join)(targetPath, '.gitignore'), {});
+}
+/**
+ * Append server package.json to project folder.
+ *
+ * @param root0 MTA base configuration
+ * @param root0.mtaPath Path to the MTA project
+ * @param root0.mtaId MTA ID
+ * @param fs reference to a mem-fs editor
+ */
+function addRootPackage({ mtaPath, mtaId }, fs) {
+    fs.copyTpl(getTemplatePath('package.json'), (0, path_1.join)(mtaPath, 'package.json'), {
+        mtaId: mtaId
+    });
+}
+/**
+ * Add common dependencies to the HTML5 app package.json.
+ *
+ * @param targetPath Path to the package.json file
+ * @param fs reference to a mem-fs editor
+ */
+async function addCommonPackageDependencies(targetPath, fs) {
+    await (0, project_access_1.addPackageDevDependency)(targetPath, constants_1.Rimraf, constants_1.RimrafVersion, fs);
+    await (0, project_access_1.addPackageDevDependency)(targetPath, constants_1.MbtPackage, constants_1.MbtPackageVersion, fs);
+    await (0, project_access_1.addPackageDevDependency)(targetPath, constants_1.UI5BuilderWebIdePackage, constants_1.UI5BuilderWebIdePackageVersion, fs);
+    await (0, project_access_1.addPackageDevDependency)(targetPath, constants_1.UI5TaskZipperPackage, constants_1.UI5TaskZipperPackageVersion, fs);
+}
+//# sourceMappingURL=utils.js.map

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@sap-ux/cf-deploy-config-writer",
+  "description": "Add or amend Cloud Foundry and ABAP deployment configuration for SAP projects",
+  "version": "0.0.1",
+  "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",
+  "files": [
+    "LICENSE",
+    "dist",
+    "templates",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "dependencies": {
+    "@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",
+    "@sap-ux/project-access": "1.28.5",
+    "@sap-ux/yaml": "0.16.0",
+    "@sap-ux/btp-utils": "0.15.2",
+    "@sap-ux/logger": "0.6.0",
+    "@sap-ux/ui5-config": "0.25.1"
+  },
+  "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"
+  },
+  "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"
+  }
+}

package/templates/app/mta-ext.mtaext

@@ -0,0 +1,25 @@
+## SAP UX Tools generated mtaext file
+_schema-version: "3.2"
+ID: <%- mtaExtensionId %>
+extends: <%- appMtaId %>
+version: <%- mtaVersion %>
+
+resources:
+- name: <%- destinationServiceName %>
+  parameters:
+    config:
+      init_data:
+        instance:
+          destinations:
+          - Authentication: NoAuthentication
+            Name: <%- destinationName %>
+            ProxyType: Internet
+            Type: HTTP
+            URL: <%- destinationUrl %>
+            URL.headers.<%- headerKey %>: <%- headerValue %>
+          - Authentication: NoAuthentication
+            Name: ui5
+            Type: HTTP
+            URL: https://ui5.sap.com
+            ProxyType: Internet
+          existing_destinations_policy: update

package/templates/app/mta.yaml

@@ -0,0 +1,12 @@
+_schema-version: "3.2"
+ID: <%- id %>
+description: <%- mtaDescription %>
+version: <%- mtaVersion %>
+
+parameters:
+  enable-parallel-deployments: true
+  deploy_mode: html5-repo
+
+modules: []
+
+resources: []

package/templates/app/xs-app-destination.json

@@ -0,0 +1,31 @@
+{
+  "welcomeFile": "/index.html",
+  "authenticationMethod": "route",
+  "routes": [
+    {
+      "source": "^<%- servicePathSegment %>/(.*)$",
+      "target": "<%- targetPath %>",
+      "destination": "<%- destination %>",
+      "authenticationType": "<%- authentication %>",
+      "csrfProtection": false
+    },
+    {
+      "source": "^/resources/(.*)$",
+      "target": "/resources/$1",
+      "authenticationType": "none",
+      "destination": "ui5"
+    },
+    {
+      "source": "^/test-resources/(.*)$",
+      "target": "/test-resources/$1",
+      "authenticationType": "none",
+      "destination": "ui5"
+    },
+    {
+      "source": "^(.*)$",
+      "target": "$1",
+      "service": "html5-apps-repo-rt",
+      "authenticationType": "xsuaa"
+    }
+  ]
+}

package/templates/app/xs-app-no-destination.json

@@ -0,0 +1,24 @@
+{
+  "welcomeFile": "/index.html",
+  "authenticationMethod": "route",
+  "routes": [
+    {
+      "source": "^/resources/(.*)$",
+      "target": "/resources/$1",
+      "authenticationType": "none",
+      "destination": "ui5"
+    },
+    {
+      "source": "^/test-resources/(.*)$",
+      "target": "/test-resources/$1",
+      "authenticationType": "none",
+      "destination": "ui5"
+    },
+    {
+      "source": "^(.*)$",
+      "target": "$1",
+      "service": "html5-apps-repo-rt",
+      "authenticationType": "xsuaa"
+    }
+  ]
+}

package/templates/common/xs-security.json

@@ -0,0 +1,7 @@
+{
+  "xsappname": "<%- id %>",
+  "tenant-mode": "dedicated",
+  "description": "Security profile of called application",
+  "scopes": [],
+  "role-templates": []
+}

package/templates/gitignore.tmpl

@@ -0,0 +1,10 @@
+node_modules/
+dist/
+.scp/
+.env
+Makefile*.mta
+mta_archives
+mta-*
+resources
+archive.zip
+.*_mta_build_tmp

package/templates/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "mta-project",
+  "version": "0.0.1",
+  "description": "Build and deployment scripts",
+  "scripts": {
+    "clean": "rimraf resources mta_archives mta-op*",
+    "build": "rimraf resources mta_archives && mbt build --mtar archive",
+    "deploy": "cf deploy mta_archives/archive.mtar --retries 1",
+    "undeploy": "cf undeploy <%- mtaId %> --delete-services --delete-service-keys --delete-service-brokers"
+  },
+  "devDependencies": {
+    "mbt": "^1.2.27",
+    "rimraf": "^5.0.5"
+  }
+}

package/templates/router/package.json

@@ -0,0 +1,18 @@
+{
+    "name": "app-router",
+    "private": true,
+    "description": "App router",
+    "engines": {
+        "node": ">= 16.0.0"
+    },
+    "scripts": {
+        "start": "node node_modules/@sap/approuter/approuter.js",
+        "start-local": "node node_modules/@sap/html5-repo-mock/index.js"
+    },
+    "dependencies": {
+        "@sap/approuter": "^14"
+    },
+    "devDependencies": {
+        "@sap/html5-repo-mock": "^2.1.0"
+    }
+}

package/templates/router/xs-app-abapservice.json

@@ -0,0 +1,25 @@
+{
+  "authenticationMethod": "route",
+  "routes": [
+    {
+      "source": "^/sap/(.*)$",
+      "target": "/sap/$1",
+      "service": "<%- servicekeyService %>",
+      "endpoint": "<%- servicekeyEndpoint %>",
+      "authenticationType": "xsuaa",
+      "csrfProtection": false
+    },
+    {
+      "source": "^/resources/(.*)$",
+      "target": "/resources/$1",
+      "authenticationType": "none",
+      "destination": "ui5"
+    },
+    {
+      "source": "^/test-resources/(.*)$",
+      "target": "/test-resources/$1",
+      "authenticationType": "none",
+      "destination": "ui5"
+    }
+  ]
+}

package/templates/router/xs-app-server.json

@@ -0,0 +1,17 @@
+{
+  "authenticationMethod": "route",
+  "routes": [
+    {
+      "source": "^(?:/app|/app/.*)?/resources/(.*)$",
+      "target": "/resources/$1",
+      "authenticationType": "none",
+      "destination": "ui5"
+    },
+    {
+      "source": "^(?:/app|/app/.*)?/test-resources/(.*)$",
+      "target": "/test-resources/$1",
+      "authenticationType": "none",
+      "destination": "ui5"
+    }
+  ]
+}

package/templates/router/xs-app.json

@@ -0,0 +1,18 @@
+{
+  "welcomeFile": "/<%- appName %>/",
+  "authenticationMethod": "route",
+  "routes": [
+    {
+      "source": "^/resources/(.*)$",
+      "target": "/resources/$1",
+      "authenticationType": "none",
+      "destination": "ui5"
+    },
+    {
+      "source": "^/test-resources/(.*)$",
+      "target": "/test-resources/$1",
+      "authenticationType": "none",
+      "destination": "ui5"
+    }
+  ]
+}