@sap-ux/adp-tooling 0.15.37 → 0.16.0

package/dist/cf/project/mta.js

@@ -0,0 +1,175 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getApprouterType = getApprouterType;
+exports.getModuleNames = getModuleNames;
+exports.getServicesForFile = getServicesForFile;
+exports.hasApprouter = hasApprouter;
+exports.getMtaServices = getMtaServices;
+exports.getResources = getResources;
+exports.readMta = readMta;
+const path = __importStar(require("node:path"));
+const i18n_1 = require("../../i18n");
+const yaml_1 = require("./yaml");
+const yaml_loader_1 = require("./yaml-loader");
+const cli_1 = require("../services/cli");
+/**
+ * Get the approuter type.
+ *
+ * @param {string} mtaProjectPath - The path to the mta project.
+ * @returns {AppRouterType} The approuter type.
+ */
+function getApprouterType(mtaProjectPath) {
+    const yamlContent = (0, yaml_loader_1.getYamlContent)(path.join(mtaProjectPath, 'mta.yaml'));
+    return (0, yaml_1.getRouterType)(yamlContent);
+}
+/**
+ * Get the module names.
+ *
+ * @param {string} mtaProjectPath - The path to the mta project.
+ * @returns {string[]} The module names.
+ */
+function getModuleNames(mtaProjectPath) {
+    const yamlContent = (0, yaml_loader_1.getYamlContent)(path.join(mtaProjectPath, 'mta.yaml'));
+    return yamlContent?.modules?.map((module) => module.name) ?? [];
+}
+/**
+ * Get the services for the file.
+ *
+ * @param {string} mtaFilePath - The path to the mta file.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {BusinessServiceResource[]} The services.
+ */
+function getServicesForFile(mtaFilePath, logger) {
+    const serviceNames = [];
+    const parsed = (0, yaml_loader_1.getYamlContent)(mtaFilePath);
+    if (parsed?.resources && Array.isArray(parsed.resources)) {
+        for (const resource of parsed.resources) {
+            const name = resource?.parameters?.['service-name'] ?? resource.name;
+            const label = resource?.parameters?.service;
+            if (name) {
+                serviceNames.push({ name, label });
+                if (!label) {
+                    logger?.log(`Service '${name}' will be ignored without 'service' parameter`);
+                }
+            }
+        }
+    }
+    return serviceNames;
+}
+/**
+ * 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.
+ */
+function hasApprouter(projectName, moduleNames) {
+    return moduleNames.some((name) => name === `${projectName.toLowerCase()}-destination-content` ||
+        name === `${projectName.toLowerCase()}-approuter`);
+}
+/**
+ * Filter services based on the business services.
+ *
+ * @param {BusinessServiceResource[]} businessServices - The business services.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<string[]>} The filtered services.
+ */
+async function filterServices(businessServices, logger) {
+    const serviceLabels = businessServices.map((service) => service.label).filter(Boolean);
+    if (serviceLabels.length === 0) {
+        throw new Error((0, i18n_1.t)('error.noBusinessServicesFound'));
+    }
+    const url = `/v3/service_offerings?names=${serviceLabels.join(',')}`;
+    const json = await (0, cli_1.requestCfApi)(url);
+    logger?.log(`Filtering services. Request to: ${url}, result: ${JSON.stringify(json)}`);
+    const businessServiceNames = new Set(businessServices.map((service) => service.label));
+    const result = [];
+    for (const resource of json?.resources ?? []) {
+        if (businessServiceNames.has(resource.name)) {
+            const sapService = resource?.['broker_catalog']?.metadata?.sapservice;
+            if (sapService && ['v2', 'v4'].includes(sapService?.odataversion ?? '')) {
+                result.push(businessServices?.find((service) => resource.name === service.label)?.name ?? '');
+            }
+            else {
+                logger?.log(`Service '${resource.name}' doesn't support V2/V4 Odata and will be ignored`);
+            }
+        }
+    }
+    if (result.length === 0) {
+        throw new Error((0, i18n_1.t)('error.noBusinessServicesFound'));
+    }
+    return result;
+}
+/**
+ * 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.
+ */
+async function getMtaServices(projectPath, logger) {
+    const services = await readMta(projectPath, logger);
+    logger?.log(`Available services defined in mta.yaml: ${JSON.stringify(services)}`);
+    return services;
+}
+/**
+ * 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.
+ */
+async function getResources(mtaFilePath, logger) {
+    const servicesList = getServicesForFile(mtaFilePath, logger);
+    const oDataFilteredServices = await filterServices(servicesList, logger);
+    return oDataFilteredServices;
+}
+/**
+ * Read the MTA file.
+ *
+ * @param {string} projectPath - The path to the project.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<string[]>} The resources.
+ */
+async function readMta(projectPath, logger) {
+    if (!projectPath) {
+        throw new Error((0, i18n_1.t)('error.mtaProjectPathMissing'));
+    }
+    const mtaFilePath = path.resolve(projectPath, 'mta.yaml');
+    const resources = await getResources(mtaFilePath, logger);
+    return resources;
+}
+//# sourceMappingURL=mta.js.map

package/dist/cf/project/yaml-loader.d.ts

@@ -0,0 +1,24 @@
+import type { MtaYaml } from '../../types';
+/**
+ * Parses the MTA file.
+ *
+ * @param {string} filePath - The file to parse.
+ * @returns {MtaYaml} The parsed YAML content.
+ */
+export declare function getYamlContent<T = MtaYaml>(filePath: string): T;
+/**
+ * Gets the project name from YAML content.
+ *
+ * @param {MtaYaml} yamlContent - The YAML content.
+ * @returns {string | null} The project name or null if not found.
+ */
+export declare function getProjectName(yamlContent: MtaYaml): string | null;
+/**
+ * Gets the project name for XS security from YAML content.
+ *
+ * @param {MtaYaml} yamlContent - The YAML content.
+ * @param {string} timestamp - The timestamp to append.
+ * @returns {string | null} The project name for XS security or null if not available.
+ */
+export declare function getProjectNameForXsSecurity(yamlContent: MtaYaml, timestamp: string): string | undefined;
+//# sourceMappingURL=yaml-loader.d.ts.map

package/dist/cf/project/yaml-loader.js

@@ -0,0 +1,54 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getYamlContent = getYamlContent;
+exports.getProjectName = getProjectName;
+exports.getProjectNameForXsSecurity = getProjectNameForXsSecurity;
+const node_fs_1 = __importDefault(require("node:fs"));
+const js_yaml_1 = __importDefault(require("js-yaml"));
+/**
+ * Parses the MTA file.
+ *
+ * @param {string} filePath - The file to parse.
+ * @returns {MtaYaml} The parsed YAML content.
+ */
+function getYamlContent(filePath) {
+    if (!node_fs_1.default.existsSync(filePath)) {
+        throw new Error(`Could not find file ${filePath}`);
+    }
+    const content = node_fs_1.default.readFileSync(filePath, 'utf-8');
+    let parsed;
+    try {
+        parsed = js_yaml_1.default.load(content);
+        return parsed;
+    }
+    catch (e) {
+        throw new Error(`Error parsing file ${filePath}: ${e.message}`);
+    }
+}
+/**
+ * Gets the project name from YAML content.
+ *
+ * @param {MtaYaml} yamlContent - The YAML content.
+ * @returns {string | null} The project name or null if not found.
+ */
+function getProjectName(yamlContent) {
+    return yamlContent?.ID || null;
+}
+/**
+ * Gets the project name for XS security from YAML content.
+ *
+ * @param {MtaYaml} yamlContent - The YAML content.
+ * @param {string} timestamp - The timestamp to append.
+ * @returns {string | null} The project name for XS security or null if not available.
+ */
+function getProjectNameForXsSecurity(yamlContent, timestamp) {
+    const projectName = getProjectName(yamlContent);
+    if (!projectName || !timestamp) {
+        return undefined;
+    }
+    return `${projectName.toLowerCase().replaceAll('.', '_')}_${timestamp}`;
+}
+//# sourceMappingURL=yaml-loader.js.map

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

@@ -0,0 +1,51 @@
+import type { Editor } from 'mem-fs-editor';
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { AppParamsExtended, MtaYaml } from '../../types';
+import { AppRouterType } from '../../types';
+interface AdjustMtaYamlParams {
+    projectPath: string;
+    moduleName: string;
+    appRouterType: AppRouterType;
+    businessSolutionName: string;
+    businessService: string;
+    spaceGuid: string;
+}
+/**
+ * Checks if the selected path is a MTA project.
+ *
+ * @param {string} selectedPath - The selected path.
+ * @returns {boolean} True if the selected path is a MTA project, false otherwise.
+ */
+export declare function isMtaProject(selectedPath: string): boolean;
+/**
+ * Gets the SAP Cloud Service.
+ *
+ * @param {MtaYaml} yamlContent - The YAML content.
+ * @returns {string} The SAP Cloud Service.
+ */
+export declare function getSAPCloudService(yamlContent: MtaYaml): string;
+/**
+ * Gets the router type.
+ *
+ * @param {MtaYaml} yamlContent - The YAML content.
+ * @returns {AppRouterType} The router type.
+ */
+export declare function getRouterType(yamlContent: MtaYaml): AppRouterType;
+/**
+ * Gets the app params from the UI5 YAML file.
+ *
+ * @param {string} projectPath - The project path.
+ * @returns {AppParamsExtended} The app params.
+ */
+export declare function getAppParamsFromUI5Yaml(projectPath: string): AppParamsExtended;
+/**
+ * Adjusts the MTA YAML.
+ *
+ * @param {AdjustMtaYamlParams} params - The parameters.
+ * @param {Editor} memFs - The mem-fs editor instance.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<void>} The promise.
+ */
+export declare function adjustMtaYaml({ projectPath, moduleName, appRouterType, businessSolutionName, businessService, spaceGuid }: AdjustMtaYamlParams, memFs: Editor, logger?: ToolsLogger): Promise<void>;
+export {};
+//# sourceMappingURL=yaml.d.ts.map