@cap-js/ord 1.5.0 → 1.7.0

package/lib/templates.js

@@ -1,4 +1,3 @@
-const { hasSAPPolicyLevel } = require("./utils");
 const defaults = require("./defaults");
 const _ = require("lodash");
 const {
@@ -76,14 +75,22 @@ const createEntityTypeMappingsItemTemplate = (entity) => {
 };
 
 function _getGroupID(serviceDefinition, groupTypeId = defaults.groupTypeId, appConfig) {
-    return `${groupTypeId}:${appConfig.ordNamespace}:${_getGroupNameWithNestedNamespace(serviceDefinition, appConfig)}`;
+    return `${groupTypeId}:${appConfig.ordNamespace}:${_getCleanServiceName(serviceDefinition, appConfig)}`;
 }
 
-function _getGroupNameWithNestedNamespace({ name }, appConfig) {
-    if (!name.startsWith(appConfig.ordNamespace)) {
-        return name;
+function _startsWithNamespace(name, namespace) {
+    if (!name.startsWith(namespace)) return false;
+    const rest = name.substring(namespace.length);
+    return rest === "" || rest.startsWith(".");
+}
+
+function _getCleanServiceName({ name }, appConfig) {
+    let sortedName = name;
+    if (appConfig.internalNamespace && _startsWithNamespace(name, appConfig.internalNamespace)) {
+        sortedName = name.substring(appConfig.internalNamespace.length);
+    } else if (_startsWithNamespace(name, appConfig.ordNamespace)) {
+        sortedName = name.substring(appConfig.ordNamespace.length);
     }
-    let sortedName = name.substring(appConfig.ordNamespace.length);
     if (sortedName.startsWith(".")) {
         sortedName = sortedName.substring(1);
     }
@@ -157,7 +164,7 @@ function _getResourceDefinition(resourceType, mediaType, ordId, serviceName, fil
  *
  * @param {string} serviceName The name of the service.
  * @param {object} serviceDefinition The definition of the service
- * @param {Set} groupIds A set of group ids.
+ * @param {object} appConfig - The application configuration.
  * @returns {Object} A group object.
  */
 const createGroupsTemplateForService = (serviceName, serviceDefinition, appConfig) => {
@@ -197,7 +204,7 @@ const createEntityTypeTemplate = (appConfig, packageIds, entity) => {
         // ODM mappings are not created as entity types, they are only used in entityTypeMappings
         return [];
     }
-    if (hasSAPPolicyLevel(appConfig.policyLevels)) {
+    if (appConfig.hasSAPPolicyLevel) {
         // If SAP policy level is present, don't create entity type, they must be in the central repository
         return [];
     }
@@ -305,19 +312,19 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
         extracted = _extractVersionFromServiceName(serviceDefinition.name);
         if (extracted) {
             // Create a temporary service definition with the clean name for namespace processing
-            const cleanServiceDefinition = { ...serviceDefinition, name: extracted.cleanName };
-            cleanServiceName = _getGroupNameWithNestedNamespace(cleanServiceDefinition, appConfig);
+            const versionExtractedServiceDefinition = { ...serviceDefinition, name: extracted.cleanName };
+            cleanServiceName = _getCleanServiceName(versionExtractedServiceDefinition, appConfig);
             version = extracted.version;
             semanticVersion = extracted.semanticVersion;
         } else {
             // Invalid pattern - use current behavior
-            cleanServiceName = _getGroupNameWithNestedNamespace(serviceDefinition, appConfig);
+            cleanServiceName = _getCleanServiceName(serviceDefinition, appConfig);
             version = "v1";
             semanticVersion = "1.0.0";
         }
     } else {
         // Non-data product - use current behavior
-        cleanServiceName = _getGroupNameWithNestedNamespace(serviceDefinition, appConfig);
+        cleanServiceName = _getCleanServiceName(serviceDefinition, appConfig);
         version = "v1";
         semanticVersion = "1.0.0";
     }
@@ -349,7 +356,14 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
                 ];
             } else if (apiProtocol === ORD_API_PROTOCOL.MCP) {
                 resourceDefinitions = [
-                    _getResourceDefinition(MCP_RESOURCE_DEFINITION_TYPE, "json", ordId, serviceName, "mcp.json", accessStrategies),
+                    _getResourceDefinition(
+                        MCP_RESOURCE_DEFINITION_TYPE,
+                        "json",
+                        ordId,
+                        serviceName,
+                        "mcp.json",
+                        accessStrategies,
+                    ),
                 ];
             } else if (apiProtocol === ORD_API_PROTOCOL.GRAPHQL) {
                 // GraphQL only has GraphQL SDL
@@ -363,8 +377,13 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
                         }),
                     },
                 ];
+            } else if (apiProtocol === ORD_API_PROTOCOL.ODATA_V2) {
+                // openapi-v3 is not supported for OData V2, only EDMX
+                resourceDefinitions = [
+                    _getResourceDefinition("edmx", "xml", ordId, serviceName, "edmx", accessStrategies),
+                ];
             } else {
-                // OData and others have both OpenAPI and EDMX
+                // odata-v4 and others have both OpenAPI and EDMX
                 resourceDefinitions = [
                     _getResourceDefinition("openapi-v3", "json", ordId, serviceName, "oas3.json", accessStrategies),
                     _getResourceDefinition("edmx", "xml", ordId, serviceName, "edmx", accessStrategies),
@@ -372,7 +391,6 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
             }
         }
 
-        const entityTypeMappings = _getEntityTypeMappings(serviceDefinition);
         const exposedEntityTypes = _getExposedEntityTypes(serviceDefinition);
 
         let obj = {
@@ -392,7 +410,6 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
             extensible: {
                 supported: "no",
             },
-            ...(entityTypeMappings ? { entityTypeMappings } : {}),
             ...(exposedEntityTypes ? { exposedEntityTypes } : []),
             ...ordExtensions,
         };
@@ -431,8 +448,7 @@ const createEventResourceTemplate = (serviceName, serviceDefinition, appConfig,
     const ordExtensions = readORDExtensions(serviceDefinition);
     const visibility = _handleVisibility(ordExtensions, serviceDefinition, appConfig.env?.defaultVisibility);
     const packageId = _getPackageID(appConfig.ordNamespace, packageIds, ORD_RESOURCE_TYPE.event, visibility);
-    const ordId = `${appConfig.ordNamespace}:eventResource:${_getGroupNameWithNestedNamespace(serviceDefinition, appConfig)}:v1`;
-    const entityTypeMappings = _getEntityTypeMappings(serviceDefinition);
+    const ordId = `${appConfig.ordNamespace}:eventResource:${_getCleanServiceName(serviceDefinition, appConfig)}:v1`;
     const exposedEntityTypes = _getExposedEntityTypes(serviceDefinition);
 
     let obj = {
@@ -456,7 +472,6 @@ const createEventResourceTemplate = (serviceName, serviceDefinition, appConfig,
             _getResourceDefinition("asyncapi-v2", "json", ordId, serviceName, "asyncapi2.json", accessStrategies),
         ],
         extensible: { supported: "no" },
-        ...(entityTypeMappings ? { entityTypeMappings } : {}),
         ...(exposedEntityTypes ? { exposedEntityTypes } : []),
         ...ordExtensions,
     };
@@ -473,28 +488,6 @@ function isPrimaryDataProductService(serviceDefinition) {
     );
 }
 
-function _getEntityTypeMappings(definitionObj) {
-    if (!definitionObj.entities) {
-        return;
-    }
-    const entities = Object.values(definitionObj.entities).flatMap((entity) => {
-        const entityData = _flattenEntityGraph(entity)
-            .flatMap(createEntityTypeMappingsItemTemplate) // now returns arrays
-            .filter(Boolean);
-        return _.uniqBy(entityData, CONTENT_MERGE_KEY);
-    });
-    const entityTypeTargets = _.uniqBy(entities, CONTENT_MERGE_KEY)
-        .filter((entity) => entity !== undefined)
-        .map(({ ordId }) => ({
-            ordId,
-        }));
-    if (entityTypeTargets.length > 0) {
-        return [{ entityTypeTargets }];
-    } else {
-        return;
-    }
-}
-
 function _getExposedEntityTypes(definitionObj) {
     if (!definitionObj.entities) {
         return;
@@ -508,10 +501,9 @@ function _getExposedEntityTypes(definitionObj) {
         .map(({ ordId }) => ({
             ordId,
         }));
+
     if (exposedEntityTypes.length > 0) {
         return exposedEntityTypes;
-    } else {
-        return;
     }
 }
 
@@ -614,7 +606,6 @@ module.exports = {
     createEventResourceTemplate,
     readORDExtensions,
     _getPackageID,
-    _getEntityTypeMappings,
     _getExposedEntityTypes,
     _propagateORDVisibility,
     _handleVisibility,

package/lib/threads/compile.js

@@ -1,6 +1,9 @@
 const { workerData } = require("piscina");
 
-const compileMetadata = require("../metaData");
+const compileMetadata = require("../meta-data");
+const registerCompileTargets = require("../common/register-compile-targets");
+
+registerCompileTargets(); // Worker threads skip cds-plugin.js — re-register compile targets
 
 module.exports = ({ url }) => {
     // JSON round-trip: CDS compiler output may contain Generator objects

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cap-js/ord",
-    "version": "1.5.0",
+    "version": "1.7.0",
     "description": "CAP Plugin for generating ORD document.",
     "repository": "cap-js/ord",
     "author": "SAP SE (https://www.sap.com)",
@@ -25,7 +25,8 @@
         "test:integration:mtls": "jest __tests__/integration/mtls-auth.test.js --testPathIgnorePatterns=/node_modules/ --forceExit",
         "test:integration:build": "jest __tests__/integration/cds-build.test.js --testPathIgnorePatterns=/node_modules/ --forceExit",
         "update-snapshot": "jest --ci --updateSnapshot",
-        "cds:version": "cds v -i"
+        "cds:version": "cds v -i",
+        "test:all": "npm run test && npm run test:integration:basic && npm run test:integration:mtls && npm run test:integration:build"
     },
     "devDependencies": {
         "@cap-js/graphql": "^0.14.0",
@@ -34,7 +35,7 @@
         "eslint": "^10.0.0",
         "express": "^4",
         "jest": "^30.0.0",
-        "prettier": "3.8.1",
+        "prettier": "3.8.3",
         "supertest": "^7.0.0"
     },
     "peerDependencies": {
@@ -49,18 +50,23 @@
         "piscina": "^5.1.4"
     },
     "engines": {
-        "node": ">=18 <23"
+        "node": ">=20 <25"
     },
     "overrides": {
-        "@sap/cds-compiler": "6.7.3"
+        "@sap/cds-compiler": "6.9.2"
     },
     "cds": {
         "requires": {
             "SAP ORD Service": {
-                "model": "@cap-js/ord/lib/ord-service"
+                "model": "@cap-js/ord/lib/services/ord-service"
             },
             "[java]": {
                 "SAP ORD Service": false
+            },
+            "[mtx-sidecar]": {
+                "SAP ORD Service": {
+                    "model": "@cap-js/ord/lib/services/mtx-ord-provider-service"
+                }
             }
         }
     }

package/lib/metaData.js

@@ -1,108 +0,0 @@
-const cds = require("@sap/cds/lib");
-const { compile: openapi } = require("@cap-js/openapi");
-const { compile: asyncapi } = require("@cap-js/asyncapi");
-const { COMPILER_TYPES, OPENAPI_SERVERS_ANNOTATION } = require("./constants");
-const Logger = require("./logger");
-const { interopCSN } = require("./interopCsn.js");
-const cdsc = require("@sap/cds-compiler/lib/main");
-
-/**
- * Read @OpenAPI.servers annotation from service definition
- * @param {object} csn - The CSN model
- * @param {string} serviceName - The service name
- * @returns {string|undefined} - JSON string of servers array or undefined
- */
-const _getServersFromAnnotation = (csn, serviceName) => {
-    const servers = csn?.definitions?.[serviceName]?.[OPENAPI_SERVERS_ANNOTATION];
-    const isValidServers = Array.isArray(servers) && servers.length > 0;
-    return isValidServers ? JSON.stringify(servers) : undefined;
-};
-
-const getMetadata = async (url, model = null) => {
-    const parts = url
-        ?.split("/")
-        .pop()
-        .replace(/\.json$/, "")
-        .split(".");
-    const compilerType = parts.pop();
-    const serviceName = parts.join(".");
-    const csn = model || cds.services[serviceName]?.model;
-    const compileOptions = cds.env["ord"]?.compileOptions || {};
-
-    let responseFile;
-    const options = { service: serviceName, as: "str", messages: [] };
-    switch (compilerType) {
-        case COMPILER_TYPES.oas3:
-            try {
-                // Check for service-level @OpenAPI.servers annotation
-                const serversFromAnnotation = _getServersFromAnnotation(csn, serviceName);
-                const openapiOptions = { ...options, ...(compileOptions?.openapi || {}) };
-
-                // Service-level annotation takes precedence over global config
-                if (serversFromAnnotation) {
-                    openapiOptions["openapi:servers"] = serversFromAnnotation;
-                }
-
-                responseFile = openapi(csn, openapiOptions);
-            } catch (error) {
-                Logger.error(`OpenApi error for service ${serviceName} - ${error.message}`);
-                throw error;
-            }
-            break;
-        case COMPILER_TYPES.asyncapi2:
-            try {
-                responseFile = asyncapi(csn, { ...options, ...(compileOptions?.asyncapi || {}) });
-            } catch (error) {
-                Logger.error(`AsyncApi error for service ${serviceName} - ${error.message}`);
-                throw error;
-            }
-            break;
-        case COMPILER_TYPES.csn:
-            try {
-                const opt_eff = { beta: { effectiveCsn: true }, effectiveServiceName: serviceName };
-                let effCsn = cdsc.for.effective(csn, opt_eff);
-                responseFile = interopCSN(effCsn);
-            } catch (error) {
-                Logger.error(`Csn error for service ${serviceName} - ${error.message}`);
-                throw error;
-            }
-            break;
-        case COMPILER_TYPES.edmx:
-            try {
-                responseFile = await cds.compile(csn).to["edmx"]({ ...options, ...(compileOptions?.edmx || {}) });
-            } catch (error) {
-                Logger.error(`Edmx error for service ${serviceName} - ${error.message}`);
-                throw error;
-            }
-            break;
-        case COMPILER_TYPES.mcp:
-            try {
-                responseFile = await cds.compile(csn).to["mcp"]({ ...options, ...(compileOptions?.mcp || {}) });
-            } catch (error) {
-                Logger.error("MCP error:", error.message);
-                throw error;
-            }
-            break;
-        case COMPILER_TYPES.graphql:
-            try {
-                const { generateSchema4 } = require("@cap-js/graphql/lib/schema");
-                const { lexicographicSortSchema, printSchema } = require("graphql");
-                const linked = cds.linked(csn);
-                const srv = new cds.ApplicationService(serviceName, linked);
-                let schema = generateSchema4({ [serviceName]: srv });
-                schema = lexicographicSortSchema(schema);
-                responseFile = printSchema(schema);
-            } catch (error) {
-                Logger.error("GraphQL SDL error:", error.message);
-                throw error;
-            }
-            break;
-    }
-    return {
-        contentType:
-            compilerType === "graphql" ? "text/plain" : `application/${compilerType === "edmx" ? "xml" : "json"}`,
-        response: responseFile,
-    };
-};
-
-module.exports = getMetadata;

package/lib/ord-service.js

@@ -1,54 +0,0 @@
-const cds = require("@sap/cds");
-const ord = require("./ord.js");
-const compileMetadata = require("./metaData.js");
-const defaults = require("./defaults.js");
-const { createAuthConfig, createAuthMiddleware } = require("./auth/authentication.js");
-const Logger = require("./logger.js");
-
-class OpenResourceDiscoveryService extends cds.ApplicationService {
-    async init() {
-        // Initialize authentication configuration from .cdsrc.json or environment variables
-        // CF mTLS validator is lazily initialized on first mTLS request
-        const authConfig = createAuthConfig();
-        if (authConfig.error) {
-            throw new Error(`Authentication initialization failed: ${authConfig.error}`);
-        }
-
-        // Create authentication middleware
-        const authMiddleware = createAuthMiddleware(authConfig);
-
-        cds.app.get(`${this.path}`, (_, res) => {
-            return res.status(200).send(defaults.baseTemplate(authConfig));
-        });
-
-        cds.app.get(`/ord/v1/documents/ord-document`, authMiddleware, async (_, res) => {
-            const csn = cds.context?.model || cds.model;
-            const data = ord(csn);
-            return res.status(200).send(data);
-        });
-
-        cds.app.get(`/ord/v1/documents/:id`, authMiddleware, async (_, res) => {
-            return res.status(404).send("404 Not Found");
-        });
-
-        // Handler for metadata requests (oas3, edmx, csn, etc.)
-        const metadataHandler = async (req, res) => {
-            try {
-                const { contentType, response } = await compileMetadata(req.url);
-                return res.status(200).contentType(contentType).send(response);
-            } catch (error) {
-                Logger.error(error, "Error while processing the resource definition document");
-                return res.status(500).send(error.message);
-            }
-        };
-
-        // Use separate routes instead of optional parameters for path-to-regexp v8 compatibility
-        cds.app.get(`/ord/v1/:ordId/:service`, authMiddleware, metadataHandler);
-        cds.app.get(`/ord/v1/:ordId`, authMiddleware, metadataHandler);
-        cds.app.get(`/ord/v1`, authMiddleware, metadataHandler);
-
-        return super.init();
-    }
-}
-
-module.exports = { OpenResourceDiscoveryService };

package/lib/utils.js

@@ -1,12 +0,0 @@
-/**
- * Checks if at least one policy level in the array is SAP.
- *
- * @param {string[]} policyLevels - Array of policy levels.
- */
-function hasSAPPolicyLevel(policyLevels) {
-    return policyLevels.some((policyLevel) => policyLevel.split(":")[0].toLowerCase() === "sap");
-}
-
-module.exports = {
-    hasSAPPolicyLevel,
-};