@sap-ux/adp-tooling 0.15.37 → 0.16.0

package/dist/cf/app/discovery.d.ts

@@ -0,0 +1,19 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { CfConfig, CFApp, CfCredentials } from '../../types';
+/**
+ * Get the app host ids.
+ *
+ * @param {CfCredentials[]} credentials - The credentials.
+ * @returns {string[]} The app host ids.
+ */
+export declare function getAppHostIds(credentials: CfCredentials[]): string[];
+/**
+ * Discover apps from FDC API based on credentials.
+ *
+ * @param {CfCredentials[]} credentials - The credentials containing app host IDs
+ * @param {CfConfig} cfConfig - The CF configuration
+ * @param {ToolsLogger} logger - The logger
+ * @returns {Promise<CFApp[]>} The discovered apps
+ */
+export declare function getCfApps(credentials: CfCredentials[], cfConfig: CfConfig, logger: ToolsLogger): Promise<CFApp[]>;
+//# sourceMappingURL=discovery.d.ts.map

package/dist/cf/app/discovery.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppHostIds = getAppHostIds;
+exports.getCfApps = getCfApps;
+const i18n_1 = require("../../i18n");
+const api_1 = require("../services/api");
+/**
+ * Get the app host ids.
+ *
+ * @param {CfCredentials[]} credentials - The credentials.
+ * @returns {string[]} The app host ids.
+ */
+function getAppHostIds(credentials) {
+    const appHostIds = [];
+    for (const credential of credentials) {
+        const appHostId = credential['html5-apps-repo']?.app_host_id;
+        if (appHostId) {
+            // There might be multiple appHostIds separated by comma
+            const ids = appHostId.split(',').map((item) => item.trim());
+            appHostIds.push(...ids);
+        }
+    }
+    return [...new Set(appHostIds)];
+}
+/**
+ * Discover apps from FDC API based on credentials.
+ *
+ * @param {CfCredentials[]} credentials - The credentials containing app host IDs
+ * @param {CfConfig} cfConfig - The CF configuration
+ * @param {ToolsLogger} logger - The logger
+ * @returns {Promise<CFApp[]>} The discovered apps
+ */
+async function getCfApps(credentials, cfConfig, logger) {
+    const appHostIds = getAppHostIds(credentials);
+    logger?.log(`App Host Ids: ${JSON.stringify(appHostIds)}`);
+    // Validate appHostIds array length (max 100 as per API specification)
+    if (appHostIds.length > 100) {
+        throw new Error((0, i18n_1.t)('error.tooManyAppHostIds', { appHostIdsLength: appHostIds.length }));
+    }
+    return (0, api_1.getFDCApps)(appHostIds, cfConfig, logger);
+}
+//# sourceMappingURL=discovery.js.map

package/dist/cf/app/html5-repo.d.ts

@@ -0,0 +1,36 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { HTML5Content, ServiceKeys, Uaa, CfAppParams } from '../../types';
+/**
+ * Get the OAuth token from HTML5 repository.
+ *
+ * @param {Uaa} uaa UAA credentials
+ * @returns {Promise<string>} OAuth token
+ */
+export declare function getToken(uaa: Uaa): Promise<string>;
+/**
+ * Download zip from HTML5 repository.
+ *
+ * @param {string} token - HTML5 reposiotry token.
+ * @param {string} appHostId - appHostId where content is stored.
+ * @param {string} uri - URL with parameters.
+ * @returns {Promise<Buffer>} File buffer content.
+ */
+export declare function downloadZip(token: string, appHostId: string, uri: string): Promise<Buffer>;
+/**
+ * Get HTML5 repo credentials.
+ *
+ * @param {string} spaceGuid space guid
+ * @param {ToolsLogger} logger logger to log messages
+ * @returns {Promise<ServiceKeys>} credentials json object
+ */
+export declare function getHtml5RepoCredentials(spaceGuid: string, logger: ToolsLogger): Promise<ServiceKeys>;
+/**
+ * Download base app manifest.json and xs-app.json from HTML5 repository.
+ *
+ * @param {string} spaceGuid current space guid
+ * @param {CfAppParams} parameters appName, appVersion, appHostId
+ * @param {ToolsLogger} logger logger to log messages
+ * @returns {Promise<AdmZip.IZipEntry[]>} manifest.json and xs-app.json
+ */
+export declare function downloadAppContent(spaceGuid: string, parameters: CfAppParams, logger: ToolsLogger): Promise<HTML5Content>;
+//# sourceMappingURL=html5-repo.d.ts.map

package/dist/cf/app/html5-repo.js

@@ -0,0 +1,137 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getToken = getToken;
+exports.downloadZip = downloadZip;
+exports.getHtml5RepoCredentials = getHtml5RepoCredentials;
+exports.downloadAppContent = downloadAppContent;
+const axios_1 = __importDefault(require("axios"));
+const adm_zip_1 = __importDefault(require("adm-zip"));
+const i18n_1 = require("../../i18n");
+const api_1 = require("../services/api");
+const HTML5_APPS_REPO_RUNTIME = 'html5-apps-repo-runtime';
+/**
+ * Get the OAuth token from HTML5 repository.
+ *
+ * @param {Uaa} uaa UAA credentials
+ * @returns {Promise<string>} OAuth token
+ */
+async function getToken(uaa) {
+    const auth = Buffer.from(`${uaa.clientid}:${uaa.clientsecret}`);
+    const options = {
+        headers: {
+            'Content-Type': 'application/json',
+            'Authorization': 'Basic ' + auth.toString('base64')
+        }
+    };
+    const uri = `${uaa.url}/oauth/token?grant_type=client_credentials`;
+    try {
+        const response = await axios_1.default.get(uri, options);
+        return response.data['access_token'];
+    }
+    catch (e) {
+        throw new Error((0, i18n_1.t)('error.failedToGetAuthKey', { error: e.message }));
+    }
+}
+/**
+ * Download zip from HTML5 repository.
+ *
+ * @param {string} token - HTML5 reposiotry token.
+ * @param {string} appHostId - appHostId where content is stored.
+ * @param {string} uri - URL with parameters.
+ * @returns {Promise<Buffer>} File buffer content.
+ */
+async function downloadZip(token, appHostId, uri) {
+    try {
+        const response = await axios_1.default.get(uri, {
+            responseType: 'arraybuffer',
+            headers: {
+                'Content-Type': 'application/json',
+                'Authorization': 'Bearer ' + token,
+                'x-app-host-id': appHostId
+            }
+        });
+        return response.data;
+    }
+    catch (e) {
+        throw new Error((0, i18n_1.t)('error.failedToDownloadZipFromHtml5Repo', { error: e.message }));
+    }
+}
+/**
+ * Get HTML5 repo credentials.
+ *
+ * @param {string} spaceGuid space guid
+ * @param {ToolsLogger} logger logger to log messages
+ * @returns {Promise<ServiceKeys>} credentials json object
+ */
+async function getHtml5RepoCredentials(spaceGuid, logger) {
+    try {
+        let serviceKeys = await (0, api_1.getServiceInstanceKeys)({
+            spaceGuids: [spaceGuid],
+            planNames: ['app-runtime'],
+            names: [HTML5_APPS_REPO_RUNTIME]
+        }, logger);
+        if (!serviceKeys?.credentials?.length) {
+            await (0, api_1.createService)(spaceGuid, 'app-runtime', HTML5_APPS_REPO_RUNTIME, ['html5-apps-repo-rt'], undefined, undefined, logger);
+            serviceKeys = await (0, api_1.getServiceInstanceKeys)({ names: [HTML5_APPS_REPO_RUNTIME] }, logger);
+            if (!serviceKeys?.credentials?.length) {
+                logger.debug((0, i18n_1.t)('error.noUaaCredentialsFoundForHtml5Repo'));
+                throw new Error((0, i18n_1.t)('error.cannotFindHtml5RepoRuntime'));
+            }
+        }
+        return serviceKeys;
+    }
+    catch (e) {
+        throw new Error((0, i18n_1.t)('error.failedToGetCredentialsFromHtml5Repo', { error: e.message }));
+    }
+}
+/**
+ * Download base app manifest.json and xs-app.json from HTML5 repository.
+ *
+ * @param {string} spaceGuid current space guid
+ * @param {CfAppParams} parameters appName, appVersion, appHostId
+ * @param {ToolsLogger} logger logger to log messages
+ * @returns {Promise<AdmZip.IZipEntry[]>} manifest.json and xs-app.json
+ */
+async function downloadAppContent(spaceGuid, parameters, logger) {
+    const { appHostId, appName, appVersion } = parameters;
+    const appNameVersion = `${appName}-${appVersion}`;
+    try {
+        const htmlRepoCredentials = await getHtml5RepoCredentials(spaceGuid, logger);
+        const token = await getToken(htmlRepoCredentials?.credentials[0]?.uaa);
+        const uri = `${htmlRepoCredentials?.credentials[0]?.uri}/applications/content/${appNameVersion}?pathSuffixFilter=manifest.json,xs-app.json`;
+        const zip = await downloadZip(token, appHostId, uri);
+        let admZip;
+        try {
+            admZip = new adm_zip_1.default(zip);
+        }
+        catch (e) {
+            throw new Error((0, i18n_1.t)('error.failedToParseZipContent', { error: e.message }));
+        }
+        if (!admZip?.getEntries?.().length) {
+            throw new Error((0, i18n_1.t)('error.noZipContentParsed'));
+        }
+        const zipEntry = admZip.getEntries().find((zipEntry) => zipEntry.entryName === 'manifest.json');
+        if (!zipEntry) {
+            throw new Error((0, i18n_1.t)('error.failedToFindManifestJsonInHtml5Repo'));
+        }
+        try {
+            const manifest = JSON.parse(zipEntry.getData().toString('utf8'));
+            return {
+                entries: admZip.getEntries(),
+                serviceInstanceGuid: htmlRepoCredentials.serviceInstance.guid,
+                manifest: manifest
+            };
+        }
+        catch (e) {
+            throw new Error((0, i18n_1.t)('error.failedToParseManifestJson', { error: e.message }));
+        }
+    }
+    catch (e) {
+        logger.error(e);
+        throw new Error((0, i18n_1.t)('error.failedToDownloadAppContent', { spaceGuid, appName, appHostId, error: e.message }));
+    }
+}
+//# sourceMappingURL=html5-repo.js.map

package/dist/cf/app/index.d.ts

@@ -0,0 +1,3 @@
+export * from './discovery';
+export * from './html5-repo';
+//# sourceMappingURL=index.d.ts.map

package/dist/cf/app/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./discovery"), exports);
+__exportStar(require("./html5-repo"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cf/core/auth.d.ts

@@ -0,0 +1,18 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { CfConfig } from '../../types';
+/**
+ * Check if the external login is enabled.
+ *
+ * @param {any} vscode - The vscode instance.
+ * @returns {Promise<boolean>} Whether the external login is enabled.
+ */
+export declare function isExternalLoginEnabled(vscode: any): Promise<boolean>;
+/**
+ * Check if the user is logged in Cloud Foundry.
+ *
+ * @param {CfConfig} cfConfig - The CF config.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<boolean>} Whether the user is logged in.
+ */
+export declare function isLoggedInCf(cfConfig: CfConfig, logger: ToolsLogger): Promise<boolean>;
+//# sourceMappingURL=auth.d.ts.map

package/dist/cf/core/auth.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isExternalLoginEnabled = isExternalLoginEnabled;
+exports.isLoggedInCf = isLoggedInCf;
+const CFLocal = require("@sap/cf-tools/out/src/cf-local");
+/**
+ * Check if the external login is enabled.
+ *
+ * @param {any} vscode - The vscode instance.
+ * @returns {Promise<boolean>} Whether the external login is enabled.
+ */
+async function isExternalLoginEnabled(vscode) {
+    const commands = await vscode.commands.getCommands();
+    return commands?.includes('cf.login');
+}
+/**
+ * Check if the user is logged in Cloud Foundry.
+ *
+ * @param {CfConfig} cfConfig - The CF config.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<boolean>} Whether the user is logged in.
+ */
+async function isLoggedInCf(cfConfig, logger) {
+    if (!cfConfig) {
+        logger?.error('CF config is not provided');
+        return false;
+    }
+    try {
+        const orgs = (await CFLocal.cfGetAvailableOrgs());
+        logger?.log(`Available organizations: ${JSON.stringify(orgs)}`);
+        return true;
+    }
+    catch (e) {
+        logger?.error(`Error occurred while trying to check if it is logged in: ${e?.message}`);
+    }
+    return false;
+}
+//# sourceMappingURL=auth.js.map

package/dist/cf/core/config.d.ts

@@ -0,0 +1,10 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { CfConfig } from '../../types';
+/**
+ * Load the CF configuration.
+ *
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {CfConfig} The CF configuration.
+ */
+export declare function loadCfConfig(logger: ToolsLogger): CfConfig;
+//# sourceMappingURL=config.d.ts.map

package/dist/cf/core/config.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadCfConfig = loadCfConfig;
+const node_os_1 = __importDefault(require("node:os"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_path_1 = __importDefault(require("node:path"));
+/**
+ * Get the home directory.
+ *
+ * @returns {string} The home directory.
+ */
+function getHomedir() {
+    let homedir = node_os_1.default.homedir();
+    const homeDrive = process.env?.['HOMEDRIVE'];
+    const homePath = process.env?.['HOMEPATH'];
+    if (process.platform === 'win32' && typeof homeDrive === 'string' && typeof homePath === 'string') {
+        homedir = node_path_1.default.join(homeDrive, homePath);
+    }
+    return homedir;
+}
+/**
+ * Load the CF configuration.
+ *
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {CfConfig} The CF configuration.
+ */
+function loadCfConfig(logger) {
+    let cfHome = process.env['CF_HOME'];
+    if (!cfHome) {
+        cfHome = node_path_1.default.join(getHomedir(), '.cf');
+    }
+    const configFileLocation = node_path_1.default.join(cfHome, 'config.json');
+    let config = {};
+    try {
+        const configAsString = node_fs_1.default.readFileSync(configFileLocation, 'utf-8');
+        config = JSON.parse(configAsString);
+    }
+    catch (e) {
+        logger?.error('Cannot receive token from config.json');
+    }
+    const result = {};
+    if (config) {
+        if (config.Target) {
+            const apiCfIndex = config.Target.indexOf('api.cf.');
+            result.url = config.Target.substring(apiCfIndex + 'api.cf.'.length);
+        }
+        if (config.AccessToken) {
+            result.token = config.AccessToken.substring('bearer '.length);
+        }
+        if (config.OrganizationFields) {
+            result.org = {
+                Name: config.OrganizationFields.Name,
+                GUID: config.OrganizationFields.GUID
+            };
+        }
+        if (config.SpaceFields) {
+            result.space = {
+                Name: config.SpaceFields.Name,
+                GUID: config.SpaceFields.GUID
+            };
+        }
+    }
+    return result;
+}
+//# sourceMappingURL=config.js.map

package/dist/cf/core/index.d.ts

@@ -0,0 +1,3 @@
+export * from './auth';
+export * from './config';
+//# sourceMappingURL=index.d.ts.map

package/dist/cf/core/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./auth"), exports);
+__exportStar(require("./config"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cf/index.d.ts

@@ -0,0 +1,6 @@
+export * from './project';
+export * from './app';
+export * from './core';
+export * from './services';
+export * from './utils';
+//# sourceMappingURL=index.d.ts.map

package/dist/cf/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./project"), exports);
+__exportStar(require("./app"), exports);
+__exportStar(require("./core"), exports);
+__exportStar(require("./services"), exports);
+__exportStar(require("./utils"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cf/project/index.d.ts

@@ -0,0 +1,4 @@
+export * from './yaml';
+export * from './yaml-loader';
+export * from './mta';
+//# sourceMappingURL=index.d.ts.map

package/dist/cf/project/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./yaml"), exports);
+__exportStar(require("./yaml-loader"), exports);
+__exportStar(require("./mta"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cf/project/mta.d.ts

@@ -0,0 +1,57 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { BusinessServiceResource, AppRouterType } from '../../types';
+/**
+ * Get the approuter type.
+ *
+ * @param {string} mtaProjectPath - The path to the mta project.
+ * @returns {AppRouterType} The approuter type.
+ */
+export declare function getApprouterType(mtaProjectPath: string): AppRouterType;
+/**
+ * Get the module names.
+ *
+ * @param {string} mtaProjectPath - The path to the mta project.
+ * @returns {string[]} The module names.
+ */
+export declare function getModuleNames(mtaProjectPath: string): string[];
+/**
+ * Get the services for the file.
+ *
+ * @param {string} mtaFilePath - The path to the mta file.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {BusinessServiceResource[]} The services.
+ */
+export declare function getServicesForFile(mtaFilePath: string, logger: ToolsLogger): BusinessServiceResource[];
+/**
+ * Check if the project has an approuter.
+ *
+ * @param {string} projectName - The project name.
+ * @param {string[]} moduleNames - The module names.
+ * @returns {boolean} Whether the project has an approuter.
+ */
+export declare function hasApprouter(projectName: string, moduleNames: string[]): boolean;
+/**
+ * Get the services for the MTA project.
+ *
+ * @param {string} projectPath - The path to the project.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<string[]>} The services.
+ */
+export declare function getMtaServices(projectPath: string, logger: ToolsLogger): Promise<string[]>;
+/**
+ * Get the resources for the MTA file.
+ *
+ * @param {string} mtaFilePath - The path to the mta file.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<string[]>} The resources.
+ */
+export declare function getResources(mtaFilePath: string, logger: ToolsLogger): Promise<string[]>;
+/**
+ * Read the MTA file.
+ *
+ * @param {string} projectPath - The path to the project.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<string[]>} The resources.
+ */
+export declare function readMta(projectPath: string, logger: ToolsLogger): Promise<string[]>;
+//# sourceMappingURL=mta.d.ts.map