@sap-ux/cf-deploy-config-writer 0.4.4 → 1.0.0

package/dist/mta-config/template-renderer.js

@@ -1,9 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderTemplateToDisk = renderTemplateToDisk;
-const node_fs_1 = require("node:fs");
-const ejs_1 = require("ejs");
-const utils_1 = require("../utils");
+import { readFileSync, writeFileSync } from 'node:fs';
+import { render } from 'ejs';
+import { getTemplatePath } from '../utils.js';
 /**
  * Render an EJS template directly to disk.
  * Intentionally bypasses mem-fs — mta-lib and other consumers require the file to be
@@ -13,8 +10,8 @@ const utils_1 = require("../utils");
  * @param outputPath Absolute path where the rendered file will be written
  * @param data Template data object passed to EJS
  */
-function renderTemplateToDisk(templateName, outputPath, data) {
-    const template = (0, node_fs_1.readFileSync)((0, utils_1.getTemplatePath)(templateName), 'utf-8');
-    (0, node_fs_1.writeFileSync)(outputPath, (0, ejs_1.render)(template, data));
+export function renderTemplateToDisk(templateName, outputPath, data) {
+    const template = readFileSync(getTemplatePath(templateName), 'utf-8');
+    writeFileSync(outputPath, render(template, data));
 }
 //# sourceMappingURL=template-renderer.js.map

package/dist/mta-config/wait-for-mta.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitForMtaFile = waitForMtaFile;
-const node_fs_1 = require("node:fs");
-const node_path_1 = require("node:path");
-const mta_lib_1 = require("@sap/mta-lib");
-const project_access_1 = require("@sap-ux/project-access");
-const i18n_1 = require("../i18n");
+import { existsSync } from 'node:fs';
+import { join } from 'node:path';
+import { Mta } from '@sap/mta-lib';
+import { FileName } from '@sap-ux/project-access';
+import { t } from '../i18n.js';
 /**
  * Waits until mta.yaml exists on disk and is readable by mta-lib.
  * Replaces hardcoded setTimeout delays used to work around mta-lib requiring
@@ -15,14 +12,14 @@ const i18n_1 = require("../i18n");
  * @param options Polling configuration
  * @throws {Error} If the file is not ready within maxWaitMs
  */
-async function waitForMtaFile(mtaPath, options = {}) {
+export async function waitForMtaFile(mtaPath, options = {}) {
     const { maxWaitMs = 5000, pollIntervalMs = 100 } = options;
-    const mtaFilePath = (0, node_path_1.join)(mtaPath, project_access_1.FileName.MtaYaml);
+    const mtaFilePath = join(mtaPath, FileName.MtaYaml);
     const deadline = Date.now() + maxWaitMs;
     while (Date.now() < deadline) {
-        if ((0, node_fs_1.existsSync)(mtaFilePath)) {
+        if (existsSync(mtaFilePath)) {
             try {
-                const mta = new mta_lib_1.Mta(mtaPath, false);
+                const mta = new Mta(mtaPath, false);
                 const id = await mta.getMtaID();
                 if (id) {
                     return;
@@ -34,6 +31,6 @@ async function waitForMtaFile(mtaPath, options = {}) {
         }
         await new Promise((resolve) => setTimeout(resolve, pollIntervalMs));
     }
-    throw new Error((0, i18n_1.t)('error.mtaFileNotReady', { mtaPath }));
+    throw new Error(t('error.mtaFileNotReady', { mtaPath }));
 }
 //# sourceMappingURL=wait-for-mta.js.map

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 import type { Destination, Authentication } from '@sap-ux/btp-utils';
-import { type CDSDestinationService, type CDSHTML5RepoService, type HTML5RepoHost, type ManagedAppFront, type ManagedDestination, type ManagedXSUAA, type CDSXSUAAService } from '../constants';
+import { type CDSDestinationService, type CDSHTML5RepoService, type HTML5RepoHost, type ManagedAppFront, type ManagedDestination, type ManagedXSUAA, type CDSXSUAAService } from '../constants.js';
 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 {

package/dist/types/index.js

@@ -1,14 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RouterModuleType = exports.CloudFoundryServiceType = void 0;
-var CloudFoundryServiceType;
+export var CloudFoundryServiceType;
 (function (CloudFoundryServiceType) {
     CloudFoundryServiceType["Existing"] = "org.cloudfoundry.existing-service";
     CloudFoundryServiceType["Managed"] = "org.cloudfoundry.managed-service";
-})(CloudFoundryServiceType || (exports.CloudFoundryServiceType = CloudFoundryServiceType = {}));
-exports.RouterModuleType = {
+})(CloudFoundryServiceType || (CloudFoundryServiceType = {}));
+export const RouterModuleType = {
     Standard: 'standard',
     Managed: 'managed',
     AppFront: 'appFront'
 };
+export var ApiHubType;
+(function (ApiHubType) {
+    ApiHubType["apiHub"] = "API_HUB";
+    ApiHubType["apiHubEnterprise"] = "API_HUB_ENTERPRISE";
+})(ApiHubType || (ApiHubType = {}));
 //# sourceMappingURL=index.js.map

package/dist/utils.d.ts

@@ -1,7 +1,7 @@
 import type { Editor } from 'mem-fs-editor';
 import { type Authentication, type Destinations } from '@sap-ux/btp-utils';
 import { type Manifest } from '@sap-ux/project-access';
-import { type MTABaseConfig, type CFBaseConfig, type CFAppConfig } from './types';
+import { type MTABaseConfig, type CFBaseConfig, type CFAppConfig } from './types/index.js';
 /**
  * Read manifest file for processing.
  *

package/dist/utils.js

@@ -1,29 +1,10 @@
-"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;
-exports.generateSupportingConfig = generateSupportingConfig;
-exports.setMtaDefaults = setMtaDefaults;
-exports.updateRootPackage = updateRootPackage;
-exports.enforceValidRouterConfig = enforceValidRouterConfig;
-exports.alignCdsVersions = alignCdsVersions;
-exports.runCommand = runCommand;
-exports.fileExists = fileExists;
-const node_path_1 = require("node:path");
-const semver_1 = require("semver");
-const nodejs_utils_1 = require("@sap-ux/nodejs-utils");
-const btp_utils_1 = require("@sap-ux/btp-utils");
-const project_access_1 = require("@sap-ux/project-access");
-const constants_1 = require("./constants");
+import { dirname, join, normalize, posix } from 'node:path';
+import { coerce, satisfies } from 'semver';
+import { CommandRunner } from '@sap-ux/nodejs-utils';
+import { isAppStudio, listDestinations, isFullUrlDestination } from '@sap-ux/btp-utils';
+import { addPackageDevDependency, FileName, updatePackageScript } from '@sap-ux/project-access';
+import { MTAVersion, UI5Package, UI5PackageVersion, UI5TaskZipperPackage, UI5TaskZipperPackageVersion, rootDeployMTAScript, undeployMTAScript, Rimraf, RimrafVersion, MbtPackageVersion, MbtPackage, MTABuildScript, CDSDKPackage, CDSPackage, MAX_MTA_PREFIX_LENGTH } from './constants.js';
+import { fileURLToPath } from 'node:url';
 /**
  * Read manifest file for processing.
  *
@@ -32,7 +13,7 @@ const constants_1 = require("./constants");
  * @returns Manifest object
  * @throws {Error} If the manifest file cannot be read or parsed as valid JSON
  */
-function readManifest(manifestPath, fs) {
+export function readManifest(manifestPath, fs) {
     return fs.readJSON(manifestPath);
 }
 /**
@@ -42,8 +23,8 @@ function readManifest(manifestPath, fs) {
  * @param relativeTemplatePath The path of the required template relative to the ./templates folder
  * @returns The path of the template specified or templates root folder
  */
-function getTemplatePath(relativeTemplatePath) {
-    return (0, node_path_1.join)(__dirname, '../templates', relativeTemplatePath);
+export function getTemplatePath(relativeTemplatePath) {
+    return join(dirname(fileURLToPath(import.meta.url)), '../templates', relativeTemplatePath);
 }
 /**
  * Convert an app name to an MTA module name that is suitable for CF deployment.
@@ -53,7 +34,7 @@ function getTemplatePath(relativeTemplatePath) {
  * @param id Name of the app, like `sap.ux.app`
  * @returns Name that's acceptable in an mta.yaml (special characters removed)
  */
-function toMtaModuleName(id) {
+export function toMtaModuleName(id) {
     // Remove special characters not allowed in MTA module names
     // Keep: alphanumeric, underscore, hyphen, and dot
     // Remove: all other special characters including backticks, currency symbols, brackets, operators, etc.
@@ -66,8 +47,8 @@ function toMtaModuleName(id) {
  * @param dirPath Path to the directory
  * @returns Path to the directory with consistent separators
  */
-function toPosixPath(dirPath) {
-    return (0, node_path_1.normalize)(dirPath).split(/[\\/]/g).join(node_path_1.posix.sep);
+export function toPosixPath(dirPath) {
+    return normalize(dirPath).split(/[\\/]/g).join(posix.sep);
 }
 /**
  * Get the destination properties, based on the destination value.
@@ -80,13 +61,13 @@ function toPosixPath(dirPath) {
  * @returns {boolean} destinationIsFullUrl - True if destination uses full URL format
  * @returns {Authentication | undefined} destinationAuthentication - Authentication type configured for the destination
  */
-async function getDestinationProperties(destination, cache = {}) {
+export async function getDestinationProperties(destination, cache = {}) {
     let destinationIsFullUrl = false;
     let destinationAuthentication;
-    if ((0, btp_utils_1.isAppStudio)() && destination) {
+    if (isAppStudio() && destination) {
         const destinations = await getBTPDestinations(cache);
         if (destinations[destination]) {
-            destinationIsFullUrl = (0, btp_utils_1.isFullUrlDestination)(destinations[destination]);
+            destinationIsFullUrl = isFullUrlDestination(destinations[destination]);
             destinationAuthentication = destinations[destination].Authentication;
         }
     }
@@ -100,8 +81,8 @@ async function getDestinationProperties(destination, cache = {}) {
  * @param cache.list
  * @returns Destinations list
  */
-async function getBTPDestinations(cache = {}) {
-    cache.list ??= await (0, btp_utils_1.listDestinations)({ stripS4HCApiHosts: true });
+export async function getBTPDestinations(cache = {}) {
+    cache.list ??= await listDestinations({ stripS4HCApiHosts: true });
     return cache.list;
 }
 /**
@@ -111,9 +92,9 @@ async function getBTPDestinations(cache = {}) {
  * @returns True if the version is valid
  * @throws {Error} If the MTA version is invalid or below minimum required version (0.0.1)
  */
-function validateVersion(mtaVersion) {
-    const version = (0, semver_1.coerce)(mtaVersion);
-    if ((mtaVersion && !version) || (version && !(0, semver_1.satisfies)(version, `>=${constants_1.MTAVersion}`))) {
+export function validateVersion(mtaVersion) {
+    const version = coerce(mtaVersion);
+    if ((mtaVersion && !version) || (version && !satisfies(version, `>=${MTAVersion}`))) {
         throw new Error('Invalid MTA version specified. Please use version 0.0.1 or higher.');
     }
     return true;
@@ -127,9 +108,9 @@ function validateVersion(mtaVersion) {
  * @param fs Reference to a mem-fs editor
  * @param addTenant If true, append tenant configuration to the xs-security.json file (default: true)
  */
-function addXSSecurityConfig({ mtaPath, mtaId }, fs, addTenant = true) {
-    fs.copyTpl(getTemplatePath(`common/${project_access_1.FileName.XSSecurityJson}`), (0, node_path_1.join)(mtaPath, project_access_1.FileName.XSSecurityJson), {
-        id: mtaId.slice(0, constants_1.MAX_MTA_PREFIX_LENGTH),
+export function addXSSecurityConfig({ mtaPath, mtaId }, fs, addTenant = true) {
+    fs.copyTpl(getTemplatePath(`common/${FileName.XSSecurityJson}`), join(mtaPath, FileName.XSSecurityJson), {
+        id: mtaId.slice(0, MAX_MTA_PREFIX_LENGTH),
         addTenant
     });
 }
@@ -139,8 +120,8 @@ function addXSSecurityConfig({ mtaPath, mtaId }, fs, addTenant = true) {
  * @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, node_path_1.join)(targetPath, project_access_1.FileName.DotGitIgnore), {});
+export function addGitIgnore(targetPath, fs) {
+    fs.copyTpl(getTemplatePath('gitignore.tmpl'), join(targetPath, FileName.DotGitIgnore), {});
 }
 /**
  * Appends server package.json to the project folder.
@@ -150,8 +131,8 @@ function addGitIgnore(targetPath, fs) {
  * @param config.mtaId MTA ID used in package.json
  * @param fs Reference to a mem-fs editor
  */
-function addRootPackage({ mtaPath, mtaId }, fs) {
-    fs.copyTpl(getTemplatePath(project_access_1.FileName.Package), (0, node_path_1.join)(mtaPath, project_access_1.FileName.Package), {
+export function addRootPackage({ mtaPath, mtaId }, fs) {
+    fs.copyTpl(getTemplatePath(FileName.Package), join(mtaPath, FileName.Package), {
         mtaId
     });
 }
@@ -161,9 +142,9 @@ function addRootPackage({ mtaPath, mtaId }, fs) {
  * @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.UI5TaskZipperPackage, constants_1.UI5TaskZipperPackageVersion, fs);
-    await (0, project_access_1.addPackageDevDependency)(targetPath, constants_1.UI5Package, constants_1.UI5PackageVersion, fs);
+export async function addCommonPackageDependencies(targetPath, fs) {
+    await addPackageDevDependency(targetPath, UI5TaskZipperPackage, UI5TaskZipperPackageVersion, fs);
+    await addPackageDevDependency(targetPath, UI5Package, UI5PackageVersion, fs);
 }
 /**
  * Generate CF specific configurations to support deployment and undeployment.
@@ -172,15 +153,15 @@ async function addCommonPackageDependencies(targetPath, fs) {
  * @param fs Reference to a mem-fs editor
  * @param addTenant If true, append tenant configuration to the xs-security.json file (default: true)
  */
-async function generateSupportingConfig(config, fs, addTenant = true) {
-    if (config.mtaId && !fs.exists((0, node_path_1.join)(config.mtaPath, 'package.json'))) {
+export async function generateSupportingConfig(config, fs, addTenant = true) {
+    if (config.mtaId && !fs.exists(join(config.mtaPath, 'package.json'))) {
         addRootPackage(config, fs);
     }
-    if (config.mtaId && !fs.exists((0, node_path_1.join)(config.mtaPath, project_access_1.FileName.XSSecurityJson))) {
+    if (config.mtaId && !fs.exists(join(config.mtaPath, FileName.XSSecurityJson))) {
         addXSSecurityConfig(config, fs, addTenant);
     }
     // Be a good citizen and add a .gitignore if missing from the existing project root
-    if (!fs.exists((0, node_path_1.join)(config.mtaPath, '.gitignore'))) {
+    if (!fs.exists(join(config.mtaPath, '.gitignore'))) {
         addGitIgnore(config.mtaPath, fs);
     }
 }
@@ -189,7 +170,7 @@ async function generateSupportingConfig(config, fs, addTenant = true) {
  *
  * @param config Writer configuration to be updated with default values
  */
-function setMtaDefaults(config) {
+export function setMtaDefaults(config) {
     config.mtaPath = config.mtaPath.replace(/\/$/, '');
     config.addConnectivityService ??= false;
     config.mtaId = toMtaModuleName(config.mtaId);
@@ -203,24 +184,24 @@ function setMtaDefaults(config) {
  * @param options.rootPath MTA project path
  * @param fs Reference to a mem-fs editor
  */
-async function updateRootPackage({ mtaId, rootPath }, fs) {
-    const packageExists = fileExists(fs, (0, node_path_1.join)(rootPath, project_access_1.FileName.Package));
+export async function updateRootPackage({ mtaId, rootPath }, fs) {
+    const packageExists = fileExists(fs, join(rootPath, FileName.Package));
     // Append package.json only if mta.yaml is at a different level to the HTML5 app
     if (packageExists) {
         // Align CDS versions if missing otherwise mta.yaml before-all scripts will fail
         await alignCdsVersions(rootPath, fs);
-        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);
+        await addPackageDevDependency(rootPath, Rimraf, RimrafVersion, fs);
+        await addPackageDevDependency(rootPath, MbtPackage, MbtPackageVersion, fs);
         let deployArgs = [];
-        if (fs?.exists((0, node_path_1.join)(rootPath, project_access_1.FileName.MtaExtYaml))) {
-            deployArgs = ['-e', project_access_1.FileName.MtaExtYaml];
+        if (fs?.exists(join(rootPath, FileName.MtaExtYaml))) {
+            deployArgs = ['-e', FileName.MtaExtYaml];
         }
         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) }
+            { name: 'undeploy', run: undeployMTAScript(mtaId) },
+            { name: 'build', run: `${MTABuildScript} --mtar archive` },
+            { name: 'deploy', run: rootDeployMTAScript(deployArgs) }
         ]) {
-            await (0, project_access_1.updatePackageScript)(rootPath, script.name, script.run, fs);
+            await updatePackageScript(rootPath, script.name, script.run, fs);
         }
     }
 }
@@ -229,7 +210,7 @@ async function updateRootPackage({ mtaId, rootPath }, fs) {
  *
  * @param config The current router configuration
  */
-function enforceValidRouterConfig(config) {
+export function enforceValidRouterConfig(config) {
     const { addManagedAppRouter, addAppFrontendRouter } = config;
     if (addManagedAppRouter) {
         config.addAppFrontendRouter = false;
@@ -249,13 +230,13 @@ function enforceValidRouterConfig(config) {
  * @param rootPath Path to the project folder
  * @param fs Reference to a mem-fs editor
  */
-async function alignCdsVersions(rootPath, fs) {
-    const filePath = (0, node_path_1.join)(rootPath, project_access_1.FileName.Package);
+export async function alignCdsVersions(rootPath, fs) {
+    const filePath = join(rootPath, FileName.Package);
     const packageJson = (fs.readJSON(filePath) ?? {});
-    const cdsDKDevDepVersion = (0, semver_1.coerce)(packageJson?.devDependencies?.[constants_1.CDSDKPackage]);
-    const cdsDepVersion = packageJson?.dependencies?.[constants_1.CDSPackage];
+    const cdsDKDevDepVersion = coerce(packageJson?.devDependencies?.[CDSDKPackage]);
+    const cdsDepVersion = packageJson?.dependencies?.[CDSPackage];
     if (!cdsDKDevDepVersion && cdsDepVersion) {
-        await (0, project_access_1.addPackageDevDependency)(rootPath, constants_1.CDSDKPackage, cdsDepVersion, fs);
+        await addPackageDevDependency(rootPath, CDSDKPackage, cdsDepVersion, fs);
     }
 }
 /**
@@ -270,8 +251,8 @@ async function alignCdsVersions(rootPath, fs) {
  * // Execute npm install in the project directory
  * await runCommand('/path/to/project', 'npm', ['install'], 'Failed to install dependencies');
  */
-async function runCommand(cwd, cmd, args, errorMsg) {
-    const commandRunner = new nodejs_utils_1.CommandRunner();
+export async function runCommand(cwd, cmd, args, errorMsg) {
+    const commandRunner = new CommandRunner();
     try {
         await commandRunner.run(cmd, args, { cwd });
     }
@@ -287,7 +268,7 @@ async function runCommand(cwd, cmd, args, errorMsg) {
  * @param filePath Path to the file
  * @returns True if the file exists, false otherwise
  */
-function fileExists(fs, filePath) {
+export function fileExists(fs, filePath) {
     return fs.exists(filePath);
 }
 //# 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.4.4",
+  "version": "1.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/SAP/open-ux-tools.git",
@@ -10,6 +10,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Acf-deploy-config-writer"
   },
+  "type": "module",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "author": "@SAP/ux-tools-team",
@@ -29,14 +30,15 @@
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "hasbin": "1.2.3",
-    "@sap-ux/project-access": "1.38.1",
-    "@sap-ux/yaml": "0.18.0",
-    "@sap-ux/btp-utils": "1.2.1",
-    "@sap-ux/logger": "0.9.0",
-    "@sap-ux/ui5-config": "0.31.1",
-    "@sap-ux/nodejs-utils": "0.3.2"
+    "@sap-ux/project-access": "2.0.0",
+    "@sap-ux/yaml": "1.0.0",
+    "@sap-ux/btp-utils": "2.0.0",
+    "@sap-ux/logger": "1.0.0",
+    "@sap-ux/ui5-config": "1.0.0",
+    "@sap-ux/nodejs-utils": "1.0.0"
   },
   "devDependencies": {
+    "@jest/globals": "30.3.0",
     "@types/ejs": "3.1.5",
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
@@ -61,7 +63,7 @@
     "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
     "lint": "eslint",
     "lint:fix": "eslint --fix",
-    "test": "jest --runInBand --ci --forceExit --detectOpenHandles --colors",
+    "test": "cross-env NODE_OPTIONS='--experimental-vm-modules' jest --runInBand --ci --forceExit --detectOpenHandles --colors",
     "watch": "tsc --watch"
   }
 }