@cap-js/ord 1.6.0 → 1.8.0

package/lib/templates.js

@@ -1,4 +1,3 @@
-const { hasSAPPolicyLevel } = require("./utils");
 const defaults = require("./defaults");
 const _ = require("lodash");
 const {
@@ -33,11 +32,11 @@ function unflatten(flattedObject) {
     return result;
 }
 
-function readORDExtensions(model) {
+function readORDExtensions(model, prefix = ORD_EXTENSIONS_PREFIX) {
     const ordExtensions = {};
     for (const key in model) {
-        if (key.startsWith(ORD_EXTENSIONS_PREFIX)) {
-            const ordKey = key.replace(ORD_EXTENSIONS_PREFIX, "");
+        if (key.startsWith(prefix)) {
+            const ordKey = key.replace(prefix, "");
             ordExtensions[ordKey] = model[key];
         }
     }
@@ -64,9 +63,9 @@ const createEntityTypeMappingsItemTemplate = (entity) => {
         const ordIdParts = entity[ENTITY_RELATIONSHIP_ANNOTATION].split(":");
         const namespace = ordIdParts[0];
         const entityName = ordIdParts[1];
-        const version = ordIdParts[2] || "v1";
+        const version = entity[`${ORD_EXTENSIONS_PREFIX}version`] || ordIdParts[2]?.substring(1) || "1";
         results.push({
-            ordId: `${namespace}:entityType:${entityName}:${version}`,
+            ordId: `${namespace}:entityType:${entityName}:v${version.split(".")[0]}`,
             entityName,
             ...entity,
         });
@@ -75,15 +74,23 @@ const createEntityTypeMappingsItemTemplate = (entity) => {
     return results;
 };
 
-function _getGroupID(serviceDefinition, groupTypeId = defaults.groupTypeId, appConfig) {
-    return `${groupTypeId}:${appConfig.ordNamespace}:${_getGroupNameWithNestedNamespace(serviceDefinition, appConfig)}`;
+function _getGroupID(appConfig, srvDefinition) {
+    return `${defaults.groupTypeId}:${appConfig.ordNamespace}:${_getCleanServiceName(srvDefinition.name, 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);
     }
@@ -115,7 +122,7 @@ function _getTitleFromServiceName(srv) {
  */
 function _getEntityVersion(entity) {
     const entityVersion = entity.ordId.split(":").pop();
-    const version = entityVersion.replace("v", "") + ".0.0"; // TODO: version can be stated/overwritten by annotation
+    const version = entityVersion.replace("v", "") + ".0.0";
     if (!SEM_VERSION_REGEX.test(version)) {
         Logger.warn("Entity version", version, "is not a valid semantic version.");
     }
@@ -155,31 +162,24 @@ function _getResourceDefinition(resourceType, mediaType, ordId, serviceName, fil
 /**
  * This is a template function to create group object of a service for groups array in ORD doc.
  *
- * @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} srvDefinition The definition of the service
+ * @param {object} appConfig - The application configuration.
  * @returns {Object} A group object.
  */
-const createGroupsTemplateForService = (serviceName, serviceDefinition, appConfig) => {
-    const ordExtensions = readORDExtensions(serviceDefinition);
-
-    if (!serviceDefinition) {
-        Logger.warn("Unable to find service definition:", serviceName);
-        return undefined;
-    }
+const createGroupsTemplateForService = (srvDefinition, appConfig) => {
+    const ordExtensions = readORDExtensions(srvDefinition);
+    const visibility = _handleVisibility(ordExtensions, srvDefinition, appConfig.env?.defaultVisibility);
 
-    const visibility = _handleVisibility(ordExtensions, serviceDefinition, appConfig.env?.defaultVisibility);
     if (visibility === RESOURCE_VISIBILITY.private) {
         // If the visibility of the service is private, do not create a group
-        Logger.info("Skipping group creation for private service:", serviceName);
+        Logger.info("Skipping group creation for private service:", srvDefinition.name);
         return undefined;
     }
 
-    const groupId = _getGroupID(serviceDefinition, defaults.groupTypeId, appConfig);
     return {
-        groupId: groupId,
+        groupId: _getGroupID(appConfig, srvDefinition),
         groupTypeId: defaults.groupTypeId,
-        title: ordExtensions.title ?? _getTitleFromServiceName(serviceName),
+        title: ordExtensions.title ?? _getTitleFromServiceName(srvDefinition.name),
     };
 };
 
@@ -197,7 +197,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 [];
     }
@@ -214,7 +214,7 @@ const createEntityTypeTemplate = (appConfig, packageIds, entity) => {
     return {
         ordId: entity.ordId,
         localId: entity.entityName,
-        title: entity["@title"] ?? entity["@Common.Label"] ?? entity.entityName,
+        title: entity["@title"] ?? entity["@Common.Label"] ?? entity["@EndUserText.label"] ?? entity.entityName,
         shortDescription: SHORT_DESCRIPTION_PREFIX + entity.entityName,
         description: DESCRIPTION_PREFIX + entity.entityName,
         version: _getEntityVersion(entity),
@@ -273,26 +273,24 @@ function _handleVisibility(ordExtensions, definition, defaultVisibility = RESOUR
  * This is a template function to create API Resource object for API Resource Array.
  * Properties of an API resource can be overwritten by the ORD extensions. Example: visibility.
  * Ensures proper visibility compliance by checking associated EntityTypes.
- * @param {string} serviceName The name of the service.
- * @param {object} serviceDefinition The definition of the service
+ * @param {object} srvDefinition The definition of the service
  * @param {object} appConfig - The application configuration.
  * @param {Array} packageIds - The available package identifiers.
  * @param {Array} accessStrategies The array of accessStrategies objects
  * @returns {Array} An array of objects for the API Resources.
  */
-const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, packageIds, accessStrategies) => {
-    const ordExtensions = readORDExtensions(serviceDefinition);
-    const visibility = _handleVisibility(ordExtensions, serviceDefinition, appConfig.env?.defaultVisibility);
+const createAPIResourceTemplate = (srvDefinition, appConfig, packageIds, accessStrategies) => {
+    const ordExtensions = readORDExtensions(srvDefinition);
+    const visibility = _handleVisibility(ordExtensions, srvDefinition, appConfig.env?.defaultVisibility);
     const packageId = _getPackageID(appConfig.ordNamespace, packageIds, ORD_RESOURCE_TYPE.api, visibility);
-
-    const protocolResults = resolveApiResourceProtocol(serviceName, serviceDefinition, {
+    const protocolResults = resolveApiResourceProtocol(srvDefinition, {
         isPrimaryDataProduct: isPrimaryDataProductService,
     });
     const apiResources = [];
 
     // If no protocols were generated, skip this service
     if (protocolResults.length === 0) {
-        Logger.info(`No supported protocols for service '${serviceName}', skipping API resource generation.`);
+        Logger.info(`No supported protocols for service '${srvDefinition.name}', skipping API resource generation.`);
         return apiResources;
     }
 
@@ -301,31 +299,26 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
         version,
         semanticVersion,
         extracted = null;
-    if (isPrimaryDataProductService(serviceDefinition)) {
-        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);
-            version = extracted.version;
-            semanticVersion = extracted.semanticVersion;
-        } else {
-            // Invalid pattern - use current behavior
-            cleanServiceName = _getGroupNameWithNestedNamespace(serviceDefinition, appConfig);
-            version = "v1";
-            semanticVersion = "1.0.0";
-        }
+    if (isPrimaryDataProductService(srvDefinition)) {
+        extracted = _extractVersionFromServiceName(srvDefinition.name);
+
+        cleanServiceName = _getCleanServiceName(extracted?.cleanName || srvDefinition.name, appConfig);
+        semanticVersion = ordExtensions.version || extracted?.semanticVersion || "1.0.0";
+        version = `v${semanticVersion.split(".")[0]}`;
     } else {
         // Non-data product - use current behavior
-        cleanServiceName = _getGroupNameWithNestedNamespace(serviceDefinition, appConfig);
-        version = "v1";
-        semanticVersion = "1.0.0";
+        cleanServiceName = _getCleanServiceName(srvDefinition.name, appConfig);
+        semanticVersion = ordExtensions.version || "1.0.0";
+        version = `v${semanticVersion.split(".")[0]}`;
     }
 
-    const ordId = `${appConfig.ordNamespace}:apiResource:${cleanServiceName}:${version}`;
-
-    protocolResults.forEach((protocolResult) => {
+    protocolResults.forEach((protocolResult, index) => {
         const { apiProtocol, entryPoints, hasResourceDefinitions } = protocolResult;
+        const protocolExtensions = readORDExtensions(srvDefinition, `@protocol('${apiProtocol}').ORD.Extensions.`);
+        const ordId =
+            protocolExtensions.ordId ||
+            ordExtensions.ordId ||
+            `${appConfig.ordNamespace}:apiResource:${cleanServiceName}${index === 0 ? "" : `-${apiProtocol}`}:${version}`;
 
         // Build resource definitions based on protocol
         let resourceDefinitions = [];
@@ -337,7 +330,7 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
                         "sap-csn-interop-effective-v1",
                         "json",
                         ordId,
-                        serviceName,
+                        srvDefinition.name,
                         "csn.json",
                         accessStrategies,
                     ),
@@ -345,11 +338,25 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
             } else if (apiProtocol === ORD_API_PROTOCOL.REST) {
                 // REST only has OpenAPI, no EDMX
                 resourceDefinitions = [
-                    _getResourceDefinition("openapi-v3", "json", ordId, serviceName, "oas3.json", accessStrategies),
+                    _getResourceDefinition(
+                        "openapi-v3",
+                        "json",
+                        ordId,
+                        srvDefinition.name,
+                        "oas3.json",
+                        accessStrategies,
+                    ),
                 ];
             } 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,
+                        srvDefinition.name,
+                        "mcp.json",
+                        accessStrategies,
+                    ),
                 ];
             } else if (apiProtocol === ORD_API_PROTOCOL.GRAPHQL) {
                 // GraphQL only has GraphQL SDL
@@ -357,34 +364,49 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
                     {
                         type: "graphql-sdl",
                         mediaType: "text/plain",
-                        url: `/ord/v1/${ordId}/${serviceName}.graphql`,
+                        url: `/ord/v1/${ordId}/${srvDefinition.name}.graphql`,
                         accessStrategies: ensureAccessStrategies(accessStrategies, {
-                            resourceName: `${serviceName} (graphql-sdl)`,
+                            resourceName: `${srvDefinition.name} (graphql-sdl)`,
                         }),
                     },
                 ];
+            } else if (apiProtocol === ORD_API_PROTOCOL.ODATA_V2) {
+                // openapi-v3 is not supported for OData V2, only EDMX
+                resourceDefinitions = [
+                    _getResourceDefinition("edmx", "xml", ordId, srvDefinition.name, "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),
+                    _getResourceDefinition(
+                        "openapi-v3",
+                        "json",
+                        ordId,
+                        srvDefinition.name,
+                        "oas3.json",
+                        accessStrategies,
+                    ),
+                    _getResourceDefinition("edmx", "xml", ordId, srvDefinition.name, "edmx", accessStrategies),
                 ];
             }
         }
 
-        const entityTypeMappings = _getEntityTypeMappings(serviceDefinition);
-        const exposedEntityTypes = _getExposedEntityTypes(serviceDefinition);
+        const exposedEntityTypes = _getExposedEntityTypes(srvDefinition);
 
         let obj = {
             ordId,
-            title: serviceDefinition["@title"] ?? serviceDefinition["@Common.Label"] ?? serviceName,
-            shortDescription: SHORT_DESCRIPTION_PREFIX + serviceName,
-            description: serviceDefinition["@Core.Description"] ?? DESCRIPTION_PREFIX + serviceName,
+            title:
+                srvDefinition["@title"] ??
+                srvDefinition["@Common.Label"] ??
+                srvDefinition["@EndUserText.label"] ??
+                srvDefinition.name,
+            shortDescription: SHORT_DESCRIPTION_PREFIX + srvDefinition.name,
+            description: srvDefinition["@Core.Description"] ?? DESCRIPTION_PREFIX + srvDefinition.name,
             version: semanticVersion,
             lastUpdate: appConfig.lastUpdate,
             visibility,
             partOfPackage: packageId,
-            partOfGroups: [_getGroupID(serviceDefinition, defaults.groupTypeId, appConfig)],
+            partOfGroups: [_getGroupID(appConfig, srvDefinition)],
             releaseStatus: "active",
             apiProtocol,
             resourceDefinitions,
@@ -392,13 +414,13 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
             extensible: {
                 supported: "no",
             },
-            ...(entityTypeMappings ? { entityTypeMappings } : {}),
             ...(exposedEntityTypes ? { exposedEntityTypes } : []),
             ...ordExtensions,
+            ...protocolExtensions,
         };
 
         // Special handling for data product services
-        if (isPrimaryDataProductService(serviceDefinition)) {
+        if (isPrimaryDataProductService(srvDefinition)) {
             obj.direction = "outbound";
             if (extracted) {
                 // Overwrite partOfGroups
@@ -420,43 +442,49 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
  * Properties of an event resource can be overwritten by the ORD extensions. Example: visibility.
  * Ensures proper visibility compliance by checking associated EntityTypes.
  *
- * @param {string} serviceName The name of the service.
- * @param {object} serviceDefinition The definition of the service
+ * @param {object} srvDefinition The definition of the service
  * @param {object} appConfig - The application configuration.
  * @param {Array} packageIds - The available package identifiers.
  * @param {Array} accessStrategies The array of accessStrategies objects
  * @returns {Array} An single-item array of objects for the Event Resources.
  */
-const createEventResourceTemplate = (serviceName, serviceDefinition, appConfig, packageIds, accessStrategies) => {
-    const ordExtensions = readORDExtensions(serviceDefinition);
-    const visibility = _handleVisibility(ordExtensions, serviceDefinition, appConfig.env?.defaultVisibility);
+const createEventResourceTemplate = (srvDefinition, appConfig, packageIds, accessStrategies) => {
+    const ordExtensions = readORDExtensions(srvDefinition);
+    const visibility = _handleVisibility(ordExtensions, srvDefinition, appConfig.env?.defaultVisibility);
+    const version = ordExtensions.version || "1.0.0";
     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 exposedEntityTypes = _getExposedEntityTypes(serviceDefinition);
+    const ordId = `${appConfig.ordNamespace}:eventResource:${_getCleanServiceName(srvDefinition.name, appConfig)}:v${version.split(".")[0]}`;
+    const exposedEntityTypes = _getExposedEntityTypes(srvDefinition);
 
     let obj = {
         ordId,
         title:
-            serviceDefinition["@title"] ??
-            serviceDefinition["@Common.Label"] ??
+            srvDefinition["@title"] ??
+            srvDefinition["@Common.Label"] ??
+            srvDefinition["@EndUserText.label"] ??
             `ODM ${appConfig.appName.replace(/[^a-zA-Z0-9]/g, "")} Events`,
-        shortDescription: `${serviceName} event resource`,
+        shortDescription: `${srvDefinition.name} event resource`,
         description:
-            serviceDefinition["@description"] ??
-            serviceDefinition["@Core.Description"] ??
+            srvDefinition["@description"] ??
+            srvDefinition["@Core.Description"] ??
             "CAP Event resource describing events / messages.",
-        version: "1.0.0",
+        version: version,
         lastUpdate: appConfig.lastUpdate,
         releaseStatus: "active",
         partOfPackage: packageId,
-        partOfGroups: [_getGroupID(serviceDefinition, defaults.groupTypeId, appConfig)],
+        partOfGroups: [_getGroupID(appConfig, srvDefinition)],
         visibility,
         resourceDefinitions: [
-            _getResourceDefinition("asyncapi-v2", "json", ordId, serviceName, "asyncapi2.json", accessStrategies),
+            _getResourceDefinition(
+                "asyncapi-v2",
+                "json",
+                ordId,
+                srvDefinition.name,
+                "asyncapi2.json",
+                accessStrategies,
+            ),
         ],
         extensible: { supported: "no" },
-        ...(entityTypeMappings ? { entityTypeMappings } : {}),
         ...(exposedEntityTypes ? { exposedEntityTypes } : []),
         ...ordExtensions,
     };
@@ -473,28 +501,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;
@@ -504,14 +510,13 @@ function _getExposedEntityTypes(definitionObj) {
         return _.uniqBy(entityData, CONTENT_MERGE_KEY);
     });
     const exposedEntityTypes = _.uniqBy(entities, CONTENT_MERGE_KEY)
-        .filter((entity) => entity !== undefined)
-        .map(({ ordId }) => ({
-            ordId,
+        .filter((entity) => !!entity)
+        .map((entity) => ({
+            ordId: entity.isODMMapping ? entity.ordId : entity[`${ORD_EXTENSIONS_PREFIX}ordId`] || entity.ordId,
         }));
+
     if (exposedEntityTypes.length > 0) {
         return exposedEntityTypes;
-    } else {
-        return;
     }
 }
 
@@ -564,7 +569,6 @@ function _extractVersionFromServiceName(serviceName) {
 
     return {
         cleanName: serviceName.replace(versionPattern, ""),
-        version: `v${versionNumber}`,
         semanticVersion: `${versionNumber}.0.0`,
     };
 }
@@ -614,7 +618,6 @@ module.exports = {
     createEventResourceTemplate,
     readORDExtensions,
     _getPackageID,
-    _getEntityTypeMappings,
     _getExposedEntityTypes,
     _propagateORDVisibility,
     _handleVisibility,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cap-js/ord",
-    "version": "1.6.0",
+    "version": "1.8.0",
     "description": "CAP Plugin for generating ORD document.",
     "repository": "cap-js/ord",
     "author": "SAP SE (https://www.sap.com)",
@@ -25,14 +25,15 @@
         "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",
         "@cap-js/sqlite": "^2",
         "@sap/cds-dk": ">=8.9.5",
         "eslint": "^10.0.0",
-        "express": "^4",
+        "express": "^5.0.0",
         "jest": "^30.0.0",
         "prettier": "3.8.3",
         "supertest": "^7.0.0"
@@ -52,7 +53,7 @@
         "node": ">=20 <25"
     },
     "overrides": {
-        "@sap/cds-compiler": "6.9.0"
+        "@sap/cds-compiler": "6.9.2"
     },
     "cds": {
         "requires": {

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,
-};