@cap-js/ord 1.3.2 → 1.3.4

package/lib/defaults.js

@@ -1,4 +1,5 @@
 const { OPEN_RESOURCE_DISCOVERY_VERSION, SHORT_DESCRIPTION_PREFIX, RESOURCE_VISIBILITY } = require("./constants");
+const { hasSAPPolicyLevel } = require("./utils");
 const { getAuthConfig } = require("./authentication");
 const _ = require("lodash");
 
@@ -35,15 +36,6 @@ const generateUniquePackageOrdId = (ordNamespace, name, tag, visibility) => {
     return `${ordNamespace}:package:${regexWithRemoval(name)}${tag}${visibilitySuffix}:v1`;
 };
 
-/**
- * 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 containing default configuration for ORD Document.
  * @module defaults
@@ -58,16 +50,16 @@ module.exports = {
             ordId: defaultProductOrdId(name),
             title: nameWithSpaces(name),
             shortDescription: SHORT_DESCRIPTION_PREFIX + nameWithSpaces(name),
-            vendor: "customer:vendor:customer:",
+            vendor: "customer:vendor:Customer:",
         },
     ],
     groupTypeId: "sap.cds:service",
-    packages: function getPackageData(appConfig, policyLevels) {
+    packages: function getPackageData(appConfig) {
         const name = appConfig.appName;
         const ordNamespace = appConfig.ordNamespace;
         const productsOrdId = appConfig.existingProductORDId || appConfig.products?.[0]?.ordId;
         const vendor = appConfig.env?.packages?.[0]?.vendor;
-        if (hasSAPPolicyLevel(policyLevels)) {
+        if (hasSAPPolicyLevel(appConfig.policyLevels)) {
             return _.uniqBy(
                 packageTypes.flatMap(({ tag, type }) =>
                     Object.values(RESOURCE_VISIBILITY).map((visibility) => ({

package/lib/ord.js

@@ -34,14 +34,15 @@ const initializeAppConfig = (csn) => {
 
     _validateNamespaces(ordNamespace, eventApplicationNamespace);
 
-    const { serviceNames, apiResourceNames, apiEndpoints, eventNames, entityTypeTargets } = _triageCsnDefinitions(csn);
+    const { serviceNames, apiResourceNames, apiEndpoints, eventServiceNames, entityTypeTargets } =
+        _triageCsnDefinitions(csn);
 
     return {
         env: cds.env["ord"],
         lastUpdate,
         appName,
         apiEndpoints: Array.from(apiEndpoints),
-        eventNames,
+        eventServiceNames,
         serviceNames,
         apiResourceNames,
         entityTypeTargets: _.uniqBy(entityTypeTargets, CONTENT_MERGE_KEY),
@@ -77,9 +78,12 @@ function _validateNamespaces(ordNamespace, eventApplicationNamespace) {
 function _triageCsnDefinitions(csn) {
     const pendingApiResourceNames = [];
     const apiEndpoints = new Set();
-    const pendingEventNames = [];
+    const pendingEventServiceNames = new Set();
     const entityTypeTargets = [];
     const pendingServiceNames = [];
+    const serviceNames = Object.keys(csn.definitions).filter(
+        (key) => csn.definitions[key].kind === CDS_ELEMENT_KIND.service,
+    );
 
     for (const definitionKey of Object.keys(csn.definitions)) {
         const definitionObj = csn.definitions[definitionKey];
@@ -103,8 +107,8 @@ function _triageCsnDefinitions(csn) {
                 break;
             }
             case CDS_ELEMENT_KIND.event: {
-                const event = _handleEvent(definitionKey);
-                if (event) pendingEventNames.push(event);
+                const event = _handleEvent(serviceNames, definitionKey);
+                if (event) pendingEventServiceNames.add(event);
                 break;
             }
             case CDS_ELEMENT_KIND.action:
@@ -120,7 +124,7 @@ function _triageCsnDefinitions(csn) {
         serviceNames: pendingServiceNames,
         apiResourceNames: pendingApiResourceNames,
         apiEndpoints: Array.from(apiEndpoints),
-        eventNames: pendingEventNames,
+        eventServiceNames: [...pendingEventServiceNames],
         entityTypeTargets,
     };
 }
@@ -156,8 +160,12 @@ function _handleEntity(key, keyDefinition) {
     return null;
 }
 
-function _handleEvent(key) {
-    return key;
+function _handleEvent(serviceNames, key) {
+    for (const serviceName of serviceNames) {
+        if (key.startsWith(serviceName + ".")) {
+            return serviceName;
+        }
+    }
 }
 
 function _handleActionOrFunction(key) {
@@ -177,14 +185,14 @@ const _getGroups = (csn, appConfig) => {
         .filter((resource) => !!resource);
 };
 
-const _getPackages = (policyLevels, appConfig) => {
-    return defaults.packages(appConfig, policyLevels);
+const _getPackages = (appConfig) => {
+    return defaults.packages(appConfig);
 };
 
 const _getEntityTypes = (appConfig, packageIds) => {
     if (!appConfig.entityTypeTargets?.length) return [];
 
-    return appConfig.entityTypeTargets.map((entity) => createEntityTypeTemplate(appConfig, packageIds, entity));
+    return appConfig.entityTypeTargets.flatMap((entity) => createEntityTypeTemplate(appConfig, packageIds, entity));
 };
 
 const _getAPIResources = (csn, appConfig, packageIds, accessStrategies) => {
@@ -200,7 +208,7 @@ const _getAPIResources = (csn, appConfig, packageIds, accessStrategies) => {
 };
 
 const _getEventResources = (csn, appConfig, packageIds, accessStrategies) => {
-    return appConfig.serviceNames.flatMap((serviceName) =>
+    return appConfig.eventServiceNames.flatMap((serviceName) =>
         createEventResourceTemplate(serviceName, csn.definitions[serviceName], appConfig, packageIds, accessStrategies),
     );
 };
@@ -230,10 +238,11 @@ const _getProducts = (appConfig) => {
 };
 
 function createDefaultORDDocument(linkedCsn, appConfig) {
+    appConfig.policyLevels = _getPolicyLevels(appConfig);
     let ordDocument = {
         $schema: "https://open-resource-discovery.github.io/specification/spec-v1/interfaces/Document.schema.json",
         openResourceDiscovery: _getOpenResourceDiscovery(appConfig),
-        policyLevels: _getPolicyLevels(appConfig),
+        policyLevels: appConfig.policyLevels,
         description: _getDescription(appConfig),
         consumptionBundles: _getConsumptionBundles(appConfig),
     };
@@ -248,7 +257,7 @@ function createDefaultORDDocument(linkedCsn, appConfig) {
         ordDocument.products = [_getProducts(appConfig)[0]];
     }
 
-    ordDocument.packages = _getPackages(ordDocument.policyLevels, appConfig);
+    ordDocument.packages = _getPackages(appConfig);
 
     return ordDocument;
 }
@@ -295,7 +304,7 @@ module.exports = (csn) => {
             ordDocument.apiResources = apiResources;
         }
     }
-    if (appConfig.eventNames.length) {
+    if (appConfig.eventServiceNames.length) {
         const eventResources = _getEventResources(linkedCsn, appConfig, packageIds, accessStrategies);
         if (eventResources.length) {
             ordDocument.eventResources = eventResources;

package/lib/templates.js

@@ -1,4 +1,5 @@
 const cds = require("@sap/cds");
+const { hasSAPPolicyLevel } = require("./utils");
 const defaults = require("./defaults");
 const _ = require("lodash");
 const {
@@ -80,6 +81,7 @@ const createEntityTypeMappingsItemTemplate = (entity) => {
         return {
             ordId: `sap.odm:entityType:${entity[ORD_ODM_ENTITY_NAME_ANNOTATION]}:v1`,
             entityName: entity[ORD_ODM_ENTITY_NAME_ANNOTATION],
+            isODMMapping: true,
             ...entity,
         };
     } else if (entity[ENTITY_RELATIONSHIP_ANNOTATION]) {
@@ -95,8 +97,19 @@ const createEntityTypeMappingsItemTemplate = (entity) => {
     }
 };
 
-function _getGroupID(fullyQualifiedName, groupTypeId = defaults.groupTypeId, appConfig) {
-    return `${groupTypeId}:${appConfig.ordNamespace}:${fullyQualifiedName}`;
+function _getGroupID(serviceDefinition, groupTypeId = defaults.groupTypeId, appConfig) {
+    return `${groupTypeId}:${appConfig.ordNamespace}:${_getGroupNameWithNestedNamespace(serviceDefinition, appConfig)}`;
+}
+
+function _getGroupNameWithNestedNamespace({ name }, appConfig) {
+    if (!name.startsWith(appConfig.ordNamespace)) {
+        return name;
+    }
+    let sortedName = name.substring(appConfig.ordNamespace.length);
+    if (sortedName.startsWith(".")) {
+        sortedName = sortedName.substring(1);
+    }
+    return sortedName;
 }
 
 /**
@@ -174,7 +187,7 @@ const createGroupsTemplateForService = (serviceName, serviceDefinition, appConfi
         return undefined;
     }
 
-    const groupId = _getGroupID(serviceName, defaults.groupTypeId, appConfig);
+    const groupId = _getGroupID(serviceDefinition, defaults.groupTypeId, appConfig);
     return {
         groupId: groupId,
         groupTypeId: defaults.groupTypeId,
@@ -192,11 +205,20 @@ const createGroupsTemplateForService = (serviceName, serviceDefinition, appConfi
  * @returns { object } An object for the EntityType.
  */
 const createEntityTypeTemplate = (appConfig, packageIds, entity) => {
+    if (entity.isODMMapping) {
+        // ODM mappings are not created as entity types, they are only used in entityTypeMappings
+        return [];
+    }
+    if (hasSAPPolicyLevel(appConfig.policyLevels)) {
+        // If SAP policy level is present, don't create entity type, they must be in the central repository
+        return [];
+    }
+
     const ordExtensions = readORDExtensions(entity);
     const visibility = ordExtensions.visibility || RESOURCE_VISIBILITY.public;
 
     if (visibility === RESOURCE_VISIBILITY.private) {
-        return null;
+        return [];
     }
 
     const packageId = _getPackageID(appConfig.ordNamespace, packageIds, ORD_RESOURCE_TYPE.entityType, visibility);
@@ -220,7 +242,9 @@ const createEntityTypeTemplate = (appConfig, packageIds, entity) => {
 
 function _handleVisibility(ordExtensions, definition) {
     let visibility;
-    if (ordExtensions.visibility) {
+    if (isPrimaryDataProductService(definition)) {
+        visibility = RESOURCE_VISIBILITY.internal;
+    } else if (ordExtensions.visibility) {
         visibility = ordExtensions.visibility;
     } else if (definition[ORD_EXTENSIONS_PREFIX + "visibility"]) {
         visibility = definition[ORD_EXTENSIONS_PREFIX + "visibility"];
@@ -248,7 +272,7 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
 
     const paths = _generatePaths(serviceName, serviceDefinition);
     const apiResources = [];
-    const ordId = `${appConfig.ordNamespace}:apiResource:${serviceName}:v1`;
+    const ordId = `${appConfig.ordNamespace}:apiResource:${_getGroupNameWithNestedNamespace(serviceDefinition, appConfig)}:v1`;
 
     paths.forEach((generatedPath) => {
         let resourceDefinitions = [
@@ -273,7 +297,7 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
             lastUpdate: appConfig.lastUpdate,
             visibility,
             partOfPackage: packageId,
-            partOfGroups: [_getGroupID(serviceName, defaults.groupTypeId, appConfig)],
+            partOfGroups: [_getGroupID(serviceDefinition, defaults.groupTypeId, appConfig)],
             releaseStatus: "active",
             apiProtocol: generatedPath.kind === "odata" ? "odata-v4" : generatedPath.kind,
             resourceDefinitions: resourceDefinitions,
@@ -285,9 +309,8 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
             ...ordExtensions,
         };
 
-        if (serviceDefinition[DATA_PRODUCT_ANNOTATION] === DATA_PRODUCT_TYPE.primary) {
+        if (isPrimaryDataProductService(serviceDefinition)) {
             obj.apiProtocol = "rest";
-            obj.visibility = RESOURCE_VISIBILITY.internal;
             obj.direction = "outbound";
             obj.implementationStandard = "sap.dp:data-subscription-api:v1";
             obj.entryPoints = [];
@@ -301,8 +324,6 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
                     accessStrategies,
                 ),
             ];
-
-            apiResources.push(obj);
         }
 
         if (obj.visibility !== RESOURCE_VISIBILITY.private) {
@@ -330,7 +351,7 @@ const createEventResourceTemplate = (serviceName, serviceDefinition, appConfig,
     const ordExtensions = readORDExtensions(serviceDefinition);
     const visibility = _handleVisibility(ordExtensions, serviceDefinition);
     const packageId = _getPackageID(appConfig.ordNamespace, packageIds, ORD_RESOURCE_TYPE.event, visibility);
-    const ordId = `${appConfig.ordNamespace}:eventResource:${serviceName}:v1`;
+    const ordId = `${appConfig.ordNamespace}:eventResource:${_getGroupNameWithNestedNamespace(serviceDefinition, appConfig)}:v1`;
     const entityTypeMappings = _getEntityTypeMappings(serviceDefinition);
 
     let obj = {
@@ -348,7 +369,7 @@ const createEventResourceTemplate = (serviceName, serviceDefinition, appConfig,
         lastUpdate: appConfig.lastUpdate,
         releaseStatus: "active",
         partOfPackage: packageId,
-        partOfGroups: [_getGroupID(serviceName, defaults.groupTypeId, appConfig)],
+        partOfGroups: [_getGroupID(serviceDefinition, defaults.groupTypeId, appConfig)],
         visibility,
         resourceDefinitions: [
             _getResourceDefinition("asyncapi-v2", "json", ordId, serviceName, "asyncapi2.json", accessStrategies),
@@ -363,13 +384,18 @@ const createEventResourceTemplate = (serviceName, serviceDefinition, appConfig,
         : [];
 };
 
+function isPrimaryDataProductService(serviceDefinition) {
+    return serviceDefinition[DATA_PRODUCT_ANNOTATION] === DATA_PRODUCT_TYPE.primary;
+}
+
 function _getEntityTypeMappings(definitionObj) {
     if (!definitionObj.entities) {
         return;
     }
-    const entities = Object.values(definitionObj.entities)
-        .flatMap((entity) => _flattenEntityGraph(entity))
-        .map(createEntityTypeMappingsItemTemplate);
+    const entities = Object.values(definitionObj.entities).flatMap((entity) => {
+        const entityData = _flattenEntityGraph(entity).map(createEntityTypeMappingsItemTemplate);
+        return _.uniqBy(entityData, CONTENT_MERGE_KEY);
+    });
     const entityTypeTargets = _.uniqBy(entities, CONTENT_MERGE_KEY)
         .filter((entity) => entity !== undefined)
         .map(({ ordId }) => ({
@@ -396,8 +422,15 @@ function _flattenEntityGraph(currentEntity, processedEntities = []) {
         if (processedEntities.includes(target)) {
             return;
         }
-        processedEntities = [...processedEntities, target];
         assertionsTodo.push(entity);
+
+        /*
+        the next line operates on heap memory so that the same entity is not processed again
+        heap memory is used so that the check is the same in:
+        a > b > c > b scenario (runs first)
+        a > d > c > ... scenario (runs later and does not process c again)
+        */
+        processedEntities.push(target);
     });
 
     return [currentEntity, ...assertionsTodo.flatMap((entity) => _flattenEntityGraph(entity, processedEntities))];

package/lib/utils.js

@@ -0,0 +1,12 @@
+/**
+ * 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,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cap-js/ord",
-    "version": "1.3.2",
+    "version": "1.3.4",
     "description": "CAP Plugin for generating ORD document.",
     "repository": "cap-js/ord",
     "author": "SAP SE (https://www.sap.com)",