@sap-ux/adp-tooling 0.15.38 → 0.16.1

package/dist/cf/services/api.js

@@ -0,0 +1,291 @@
+"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;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBusinessServiceKeys = getBusinessServiceKeys;
+exports.getFDCRequestArguments = getFDCRequestArguments;
+exports.getFDCApps = getFDCApps;
+exports.createService = createService;
+exports.createServices = createServices;
+exports.getServiceInstanceKeys = getServiceInstanceKeys;
+const fs = __importStar(require("node:fs"));
+const axios_1 = __importDefault(require("axios"));
+const path = __importStar(require("node:path"));
+const CFToolsCli = require("@sap/cf-tools/out/src/cli");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const i18n_1 = require("../../i18n");
+const project_1 = require("../project");
+const cli_1 = require("./cli");
+const PARAM_MAP = new Map([
+    ['spaceGuids', 'space_guids'],
+    ['planNames', 'service_plan_names'],
+    ['names', 'names']
+]);
+/**
+ * Get the business service keys.
+ *
+ * @param {string} businessService - The business service.
+ * @param {CfConfig} config - The CF config.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<ServiceKeys | null>} The service keys.
+ */
+async function getBusinessServiceKeys(businessService, config, logger) {
+    const serviceKeys = await getServiceInstanceKeys({
+        spaceGuids: [config.space.GUID],
+        names: [businessService]
+    }, logger);
+    logger?.log(`Available service key instance : ${JSON.stringify(serviceKeys?.serviceInstance)}`);
+    return serviceKeys;
+}
+/**
+ * Get the FDC request arguments.
+ *
+ * @param {CfConfig} cfConfig - The CF config.
+ * @returns {RequestArguments} The request arguments.
+ */
+function getFDCRequestArguments(cfConfig) {
+    const fdcUrl = 'https://ui5-flexibility-design-and-configuration.';
+    const cfApiEndpoint = `https://api.cf.${cfConfig.url}`;
+    const endpointParts = /https:\/\/api\.cf(?:\.([^-.]*)(-\d+)?(\.hana\.ondemand\.com)|(.*))/.exec(cfApiEndpoint);
+    const options = {
+        withCredentials: true,
+        headers: {
+            'Content-Type': 'application/json'
+        }
+    };
+    let url;
+    if (endpointParts?.[3]) {
+        // Public cloud - use mTLS enabled domain with "cert" prefix
+        const region = endpointParts[1];
+        url = `${fdcUrl}cert.cfapps.${region}.hana.ondemand.com`;
+    }
+    else if (endpointParts?.[4]?.endsWith('.cn')) {
+        // China has a special URL pattern
+        const parts = endpointParts[4].split('.');
+        parts.splice(2, 0, 'apps');
+        url = `${fdcUrl}sapui5flex${parts.join('.')}`;
+    }
+    else {
+        url = `${fdcUrl}sapui5flex.cfapps${endpointParts?.[4]}`;
+    }
+    // Add authorization token for non-BAS environments or private cloud
+    // For BAS environments with mTLS, the certificate authentication is handled automatically
+    if (!(0, btp_utils_1.isAppStudio)() || !endpointParts?.[3]) {
+        options.headers['Authorization'] = `Bearer ${cfConfig.token}`;
+    }
+    return {
+        url: url,
+        options
+    };
+}
+/**
+ * Get the FDC apps.
+ *
+ * @param {string[]} appHostIds - The app host ids.
+ * @param {CfConfig} cfConfig - The CF config.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<FDCResponse>} The FDC apps.
+ */
+async function getFDCApps(appHostIds, cfConfig, logger) {
+    const requestArguments = getFDCRequestArguments(cfConfig);
+    logger?.log(`App Hosts: ${JSON.stringify(appHostIds)}, request arguments: ${JSON.stringify(requestArguments)}`);
+    const appHostIdParams = appHostIds.map((id) => `appHostId=${encodeURIComponent(id)}`).join('&');
+    const url = `${requestArguments.url}/api/business-service/discovery?${appHostIdParams}`;
+    try {
+        const response = await axios_1.default.get(url, requestArguments.options);
+        if (response.status === 200) {
+            logger?.log(`Retrieved FDC apps with request url: ${JSON.stringify(response.data)}`);
+            return response.data.results;
+        }
+        else {
+            throw new Error((0, i18n_1.t)('error.failedToConnectToFDCService', { status: response.status }));
+        }
+    }
+    catch (error) {
+        logger?.error(`Getting FDC apps failed. Request url: ${url}. ${error}`);
+        throw new Error((0, i18n_1.t)('error.failedToGetFDCApps', { error: error.message }));
+    }
+}
+/**
+ * Creates a service.
+ *
+ * @param {string} spaceGuid - The space GUID.
+ * @param {string} plan - The plan.
+ * @param {string} serviceInstanceName - The service instance name.
+ * @param {string[]} tags - The tags.
+ * @param {string} [serviceName] - The service name.
+ * @param {object} [security] - Security configuration.
+ * @param {string | null} security.filePath - The security file path.
+ * @param {string} [security.xsappname] - The XS app name.
+ * @param {ToolsLogger} [logger] - The logger.
+ */
+async function createService(spaceGuid, plan, serviceInstanceName, tags, serviceName, security, logger) {
+    try {
+        const { filePath, xsappname } = security ?? {};
+        if (!serviceName) {
+            const json = await (0, cli_1.requestCfApi)(`/v3/service_offerings?per_page=1000&space_guids=${spaceGuid}`);
+            const serviceOffering = json?.resources?.find((resource) => resource.tags && tags.every((tag) => resource.tags?.includes(tag)));
+            serviceName = serviceOffering?.name;
+        }
+        logger?.log(`Creating service instance '${serviceInstanceName}' of service '${serviceName}' with '${plan}' plan`);
+        const commandParameters = ['create-service', serviceName ?? '', plan, serviceInstanceName];
+        if (filePath) {
+            let xsSecurity = null;
+            try {
+                const filePath = path.resolve(__dirname, '../../../templates/cf/xs-security.json');
+                const xsContent = fs.readFileSync(filePath, 'utf-8');
+                xsSecurity = JSON.parse(xsContent);
+                xsSecurity.xsappname = xsappname;
+            }
+            catch (err) {
+                logger?.error(`Failed to parse xs-security.json file: ${err}`);
+                throw new Error((0, i18n_1.t)('error.xsSecurityJsonCouldNotBeParsed'));
+            }
+            commandParameters.push('-c', JSON.stringify(xsSecurity));
+        }
+        await CFToolsCli.Cli.execute(commandParameters);
+        logger?.log(`Service instance '${serviceInstanceName}' created successfully`);
+    }
+    catch (e) {
+        logger?.error(e);
+        throw new Error((0, i18n_1.t)('error.failedToCreateServiceInstance', { serviceInstanceName, error: e.message }));
+    }
+}
+/**
+ * Creates the services.
+ *
+ * @param {string} projectPath - The project path.
+ * @param {MtaYaml} yamlContent - The YAML content.
+ * @param {string[]} initialServices - The initial services.
+ * @param {string} timestamp - The timestamp.
+ * @param {string} spaceGuid - The space GUID.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<void>} The promise.
+ */
+async function createServices(projectPath, yamlContent, initialServices, timestamp, spaceGuid, logger) {
+    const excludeServices = new Set([...initialServices, 'portal', 'html5-apps-repo']);
+    const xsSecurityPath = path.join(projectPath, 'xs-security.json');
+    const xsSecurityProjectName = (0, project_1.getProjectNameForXsSecurity)(yamlContent, timestamp);
+    for (const resource of yamlContent.resources ?? []) {
+        if (!excludeServices.has(resource?.parameters?.service ?? '')) {
+            if (resource?.parameters?.service === 'xsuaa') {
+                await createService(spaceGuid, resource.parameters['service-plan'] ?? '', resource.parameters['service-name'] ?? '', [], resource.parameters.service, { filePath: xsSecurityPath, xsappname: xsSecurityProjectName }, logger);
+            }
+            else {
+                await createService(spaceGuid, resource.parameters['service-plan'] ?? '', resource.parameters['service-name'] ?? '', [], resource.parameters.service, { filePath: null, xsappname: xsSecurityProjectName }, logger);
+            }
+        }
+    }
+}
+/**
+ * Gets the service instance keys.
+ *
+ * @param {GetServiceInstanceParams} serviceInstanceQuery - The service instance query.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<ServiceKeys | null>} The service instance keys.
+ */
+async function getServiceInstanceKeys(serviceInstanceQuery, logger) {
+    try {
+        const serviceInstances = await getServiceInstance(serviceInstanceQuery);
+        if (serviceInstances?.length > 0) {
+            // We can use any instance in the list to connect to HTML5 Repo
+            logger?.log(`Use '${serviceInstances[0].name}' HTML5 Repo instance`);
+            return {
+                credentials: await getOrCreateServiceKeys(serviceInstances[0], logger),
+                serviceInstance: serviceInstances[0]
+            };
+        }
+        return null;
+    }
+    catch (e) {
+        const errorMessage = (0, i18n_1.t)('error.failedToGetServiceInstanceKeys', { error: e.message });
+        logger?.error(errorMessage);
+        throw new Error(errorMessage);
+    }
+}
+/**
+ * Gets the service instance.
+ *
+ * @param {GetServiceInstanceParams} params - The service instance parameters.
+ * @returns {Promise<ServiceInstance[]>} The service instance.
+ */
+async function getServiceInstance(params) {
+    const parameters = Object.entries(params)
+        .filter(([_, value]) => value?.length > 0)
+        .map(([key, value]) => `${PARAM_MAP.get(key)}=${value.join(',')}`);
+    const uriParameters = parameters.length > 0 ? `?${parameters.join('&')}` : '';
+    const uri = `/v3/service_instances` + uriParameters;
+    try {
+        const json = await (0, cli_1.requestCfApi)(uri);
+        if (!json?.resources || !Array.isArray(json.resources)) {
+            throw new Error((0, i18n_1.t)('error.noValidJsonForServiceInstance'));
+        }
+        return json.resources.map((service) => ({
+            name: service.name,
+            guid: service.guid
+        }));
+    }
+    catch (e) {
+        throw new Error((0, i18n_1.t)('error.failedToGetServiceInstance', { uriParameters, error: e.message }));
+    }
+}
+/**
+ * Gets the service instance keys.
+ *
+ * @param {ServiceInstance} serviceInstance - The service instance.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<ServiceKeys | null>} The service instance keys.
+ */
+async function getOrCreateServiceKeys(serviceInstance, logger) {
+    const serviceInstanceName = serviceInstance.name;
+    try {
+        const credentials = await (0, cli_1.getServiceKeys)(serviceInstance.guid);
+        if (credentials?.length > 0) {
+            return credentials;
+        }
+        else {
+            const serviceKeyName = serviceInstanceName + '_key';
+            logger?.log(`Creating service key '${serviceKeyName}' for service instance '${serviceInstanceName}'`);
+            await (0, cli_1.createServiceKey)(serviceInstanceName, serviceKeyName);
+            return (0, cli_1.getServiceKeys)(serviceInstance.guid);
+        }
+    }
+    catch (e) {
+        throw new Error((0, i18n_1.t)('error.failedToGetOrCreateServiceKeys', { serviceInstanceName, error: e.message }));
+    }
+}
+//# sourceMappingURL=api.js.map

package/dist/cf/services/cli.d.ts

@@ -0,0 +1,31 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { CfCredentials } from '../../types';
+/**
+ * Checks if Cloud Foundry is installed.
+ *
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<boolean>} True if CF is installed, false otherwise.
+ */
+export declare function isCfInstalled(logger: ToolsLogger): Promise<boolean>;
+/**
+ * Gets the service instance credentials.
+ *
+ * @param {string} serviceInstanceGuid - The service instance GUID.
+ * @returns {Promise<CfCredentials[]>} The service instance credentials.
+ */
+export declare function getServiceKeys(serviceInstanceGuid: string): Promise<CfCredentials[]>;
+/**
+ * Creates a service key.
+ *
+ * @param {string} serviceInstanceName - The service instance name.
+ * @param {string} serviceKeyName - The service key name.
+ */
+export declare function createServiceKey(serviceInstanceName: string, serviceKeyName: string): Promise<void>;
+/**
+ * Request CF API.
+ *
+ * @param {string} url - The URL.
+ * @returns {Promise<T>} The response.
+ */
+export declare function requestCfApi<T = unknown>(url: string): Promise<T>;
+//# sourceMappingURL=cli.d.ts.map

package/dist/cf/services/cli.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCfInstalled = isCfInstalled;
+exports.getServiceKeys = getServiceKeys;
+exports.createServiceKey = createServiceKey;
+exports.requestCfApi = requestCfApi;
+const CFLocal = require("@sap/cf-tools/out/src/cf-local");
+const CFToolsCli = require("@sap/cf-tools/out/src/cli");
+const types_1 = require("@sap/cf-tools/out/src/types");
+const i18n_1 = require("../../i18n");
+const ENV = { env: { 'CF_COLOR': 'false' } };
+/**
+ * Checks if Cloud Foundry is installed.
+ *
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<boolean>} True if CF is installed, false otherwise.
+ */
+async function isCfInstalled(logger) {
+    try {
+        const response = await CFToolsCli.Cli.execute(['version'], ENV);
+        if (response.exitCode !== 0) {
+            throw new Error(response.stderr);
+        }
+        return true;
+    }
+    catch (e) {
+        logger.error((0, i18n_1.t)('error.cfNotInstalled', { error: e.message }));
+        return false;
+    }
+}
+/**
+ * Gets the service instance credentials.
+ *
+ * @param {string} serviceInstanceGuid - The service instance GUID.
+ * @returns {Promise<CfCredentials[]>} The service instance credentials.
+ */
+async function getServiceKeys(serviceInstanceGuid) {
+    try {
+        return await CFLocal.cfGetInstanceCredentials({
+            filters: [
+                {
+                    value: serviceInstanceGuid,
+                    // key: eFilters.service_instance_guid
+                    key: types_1.eFilters.service_instance_guid
+                }
+            ]
+        });
+    }
+    catch (e) {
+        throw new Error((0, i18n_1.t)('error.cfGetInstanceCredentialsFailed', { serviceInstanceGuid, error: e.message }));
+    }
+}
+/**
+ * Creates a service key.
+ *
+ * @param {string} serviceInstanceName - The service instance name.
+ * @param {string} serviceKeyName - The service key name.
+ */
+async function createServiceKey(serviceInstanceName, serviceKeyName) {
+    try {
+        const cliResult = await CFToolsCli.Cli.execute(['create-service-key', serviceInstanceName, serviceKeyName], ENV);
+        if (cliResult.exitCode !== 0) {
+            throw new Error(cliResult.stderr);
+        }
+    }
+    catch (e) {
+        throw new Error((0, i18n_1.t)('error.createServiceKeyFailed', { serviceInstanceName, error: e.message }));
+    }
+}
+/**
+ * Request CF API.
+ *
+ * @param {string} url - The URL.
+ * @returns {Promise<T>} The response.
+ */
+async function requestCfApi(url) {
+    try {
+        const response = await CFToolsCli.Cli.execute(['curl', url], ENV);
+        if (response.exitCode === 0) {
+            try {
+                return JSON.parse(response.stdout);
+            }
+            catch (e) {
+                throw new Error((0, i18n_1.t)('error.failedToParseCFAPIResponse', { error: e.message }));
+            }
+        }
+        throw new Error(response.stderr);
+    }
+    catch (e) {
+        throw new Error((0, i18n_1.t)('error.failedToRequestCFAPI', { error: e.message }));
+    }
+}
+//# sourceMappingURL=cli.js.map

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

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

package/dist/cf/services/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("./api"), exports);
+__exportStar(require("./cli"), exports);
+//# sourceMappingURL=index.js.map

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

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

package/dist/cf/utils/index.js

@@ -0,0 +1,18 @@
+"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("./validation"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cf/utils/validation.d.ts

@@ -0,0 +1,37 @@
+import type AdmZip from 'adm-zip';
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { Manifest } from '@sap-ux/project-access';
+import type { CfCredentials, XsApp } from '../../types';
+/**
+ * Validate the smart template application.
+ *
+ * @param {Manifest} manifest - The manifest.
+ * @returns {Promise<void>} The messages.
+ */
+export declare function validateSmartTemplateApplication(manifest: Manifest): Promise<void>;
+/**
+ * Generic function to extract and parse JSON from zip entries.
+ *
+ * @param {AdmZip.IZipEntry[]} zipEntries - The zip entries.
+ * @param {string} fileName - The file name to find (e.g., 'manifest.json', 'xs-app.json').
+ * @param {string} errorKey - The i18n error key for parsing failures.
+ * @returns {T | undefined} The parsed JSON object.
+ */
+export declare function extractJsonFromZip<T>(zipEntries: AdmZip.IZipEntry[], fileName: string, errorKey: string): T | undefined;
+/**
+ * Extract the xs-app.json from the zip entries.
+ *
+ * @param {AdmZip.IZipEntry[]} zipEntries - The zip entries.
+ * @returns {XsApp | undefined} The xs-app.json.
+ */
+export declare function extractXSApp(zipEntries: AdmZip.IZipEntry[]): XsApp | undefined;
+/**
+ * Validate the OData endpoints, data sources and routes.
+ *
+ * @param {AdmZip.IZipEntry[]} zipEntries - The zip entries.
+ * @param {CfCredentials[]} credentials - The credentials.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<string[]>} The messages.
+ */
+export declare function validateODataEndpoints(zipEntries: AdmZip.IZipEntry[], credentials: CfCredentials[], logger: ToolsLogger): Promise<void>;
+//# sourceMappingURL=validation.d.ts.map

package/dist/cf/utils/validation.js

@@ -0,0 +1,134 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateSmartTemplateApplication = validateSmartTemplateApplication;
+exports.extractJsonFromZip = extractJsonFromZip;
+exports.extractXSApp = extractXSApp;
+exports.validateODataEndpoints = validateODataEndpoints;
+const i18n_1 = require("../../i18n");
+const manifest_1 = require("../../source/manifest");
+/**
+ * Normalize the xs-app route regex.
+ *
+ * @param {string} value - The value.
+ * @returns {RegExp} The normalized route regex.
+ */
+function normalizeRouteRegex(value) {
+    return new RegExp(value.replace('^/', '^(/)*').replace('/(.*)$', '(/)*(.*)$'));
+}
+/**
+ * Validate the smart template application.
+ *
+ * @param {Manifest} manifest - The manifest.
+ * @returns {Promise<void>} The messages.
+ */
+async function validateSmartTemplateApplication(manifest) {
+    const appType = (0, manifest_1.getApplicationType)(manifest);
+    if (!(0, manifest_1.isSupportedAppTypeForAdp)(appType)) {
+        throw new Error((0, i18n_1.t)('error.adpDoesNotSupportSelectedApplication'));
+    }
+    if (manifest['sap.ui5'] && manifest['sap.ui5'].flexEnabled === false) {
+        throw new Error((0, i18n_1.t)('error.appDoesNotSupportFlexibility'));
+    }
+}
+/**
+ * Generic function to extract and parse JSON from zip entries.
+ *
+ * @param {AdmZip.IZipEntry[]} zipEntries - The zip entries.
+ * @param {string} fileName - The file name to find (e.g., 'manifest.json', 'xs-app.json').
+ * @param {string} errorKey - The i18n error key for parsing failures.
+ * @returns {T | undefined} The parsed JSON object.
+ */
+function extractJsonFromZip(zipEntries, fileName, errorKey) {
+    const entry = zipEntries.find((item) => item.entryName.endsWith(fileName));
+    try {
+        return JSON.parse(entry?.getData().toString('utf8') ?? '');
+    }
+    catch (e) {
+        throw new Error((0, i18n_1.t)(errorKey, { error: e.message }));
+    }
+}
+/**
+ * Extract the xs-app.json from the zip entries.
+ *
+ * @param {AdmZip.IZipEntry[]} zipEntries - The zip entries.
+ * @returns {XsApp | undefined} The xs-app.json.
+ */
+function extractXSApp(zipEntries) {
+    return extractJsonFromZip(zipEntries, 'xs-app.json', 'error.failedToParseXsAppJson');
+}
+/**
+ * Extract the manifest.json from the zip entries.
+ *
+ * @param {AdmZip.IZipEntry[]} zipEntries - The zip entries.
+ * @returns {Manifest | undefined} The manifest.
+ */
+function extractManifest(zipEntries) {
+    return extractJsonFromZip(zipEntries, 'manifest.json', 'error.failedToParseManifestJson');
+}
+/**
+ * Match the routes and data sources.
+ *
+ * @param {Record<string, ManifestNamespace.DataSource>} dataSources - The data sources from manifest.json.
+ * @param {XsAppRoute[]} routes - The routes from xs-app.json.
+ * @param {string[]} serviceKeyEndpoints - The service key endpoints.
+ * @returns {string[]} The messages.
+ */
+function matchRoutesAndDatasources(dataSources, routes, serviceKeyEndpoints) {
+    const messages = [];
+    for (const route of routes) {
+        if (route.endpoint && !serviceKeyEndpoints.includes(route.endpoint)) {
+            messages.push(`Route endpoint '${route.endpoint}' doesn't match a corresponding OData endpoint`);
+        }
+    }
+    for (const dataSourceName of Object.keys(dataSources ?? {})) {
+        if (!routes.some((route) => dataSources?.[dataSourceName].uri?.match(normalizeRouteRegex(route.source)))) {
+            messages.push(`Data source '${dataSourceName}' doesn't match a corresponding route in xs-app.json routes`);
+        }
+    }
+    return messages;
+}
+/**
+ * Validate the OData endpoints, data sources and routes.
+ *
+ * @param {AdmZip.IZipEntry[]} zipEntries - The zip entries.
+ * @param {CfCredentials[]} credentials - The credentials.
+ * @param {ToolsLogger} logger - The logger.
+ * @returns {Promise<string[]>} The messages.
+ */
+async function validateODataEndpoints(zipEntries, credentials, logger) {
+    const messages = [];
+    let xsApp;
+    try {
+        xsApp = extractXSApp(zipEntries);
+        logger?.log(`ODATA endpoints: ${JSON.stringify(xsApp)}`);
+    }
+    catch (error) {
+        messages.push(error);
+    }
+    let manifest;
+    try {
+        manifest = extractManifest(zipEntries);
+        logger?.log(`Extracted manifest: ${JSON.stringify(manifest)}`);
+    }
+    catch (error) {
+        messages.push(error);
+    }
+    const dataSources = manifest?.['sap.app']?.dataSources;
+    const routes = xsApp?.routes;
+    if (dataSources && routes) {
+        const serviceKeyEndpoints = [].concat(...credentials.map((item) => (item.endpoints ? Object.keys(item.endpoints) : [])));
+        messages.push(...matchRoutesAndDatasources(dataSources, routes, serviceKeyEndpoints));
+    }
+    else if (routes && !dataSources) {
+        messages.push("Base app manifest.json doesn't contain data sources specified in xs-app.json");
+    }
+    else if (!routes && dataSources) {
+        messages.push("Base app xs-app.json doesn't contain data sources routes specified in manifest.json");
+    }
+    if (messages.length > 0) {
+        const errorMessages = messages.join('\n');
+        logger?.error(`OData endpoints validation failed:\n${errorMessages}`);
+        throw new Error((0, i18n_1.t)('error.oDataEndpointsValidationFailed'));
+    }
+}
+//# sourceMappingURL=validation.js.map

package/dist/index.d.ts

@@ -5,12 +5,14 @@ export * from './abap';
 export * from './source';
 export * from './ui5';
 export * from './base/cf';
+export * from './cf';
 export * from './base/helper';
 export * from './base/constants';
 export * from './base/project-builder';
 export * from './base/abap/manifest-service';
 export { promptGeneratorInput, PromptDefaults } from './base/prompt';
 export * from './preview/adp-preview';
+export * from './writer/cf';
 export * from './writer/manifest';
 export * from './writer/writer-config';
 export { generate, migrate } from './writer';

package/dist/index.js

@@ -22,6 +22,7 @@ __exportStar(require("./abap"), exports);
 __exportStar(require("./source"), exports);
 __exportStar(require("./ui5"), exports);
 __exportStar(require("./base/cf"), exports);
+__exportStar(require("./cf"), exports);
 __exportStar(require("./base/helper"), exports);
 __exportStar(require("./base/constants"), exports);
 __exportStar(require("./base/project-builder"), exports);
@@ -29,6 +30,7 @@ __exportStar(require("./base/abap/manifest-service"), exports);
 var prompt_1 = require("./base/prompt");
 Object.defineProperty(exports, "promptGeneratorInput", { enumerable: true, get: function () { return prompt_1.promptGeneratorInput; } });
 __exportStar(require("./preview/adp-preview"), exports);
+__exportStar(require("./writer/cf"), exports);
 __exportStar(require("./writer/manifest"), exports);
 __exportStar(require("./writer/writer-config"), exports);
 var writer_1 = require("./writer");