@cap-js/ord 1.3.8 → 1.3.10

package/lib/build.js

@@ -10,7 +10,9 @@ module.exports = class OrdBuildPlugin extends cds_dk.build.Plugin {
     static taskDefaults = { src: cds.env.folders.srv };
 
     init() {
-        this.task.dest = path.join(cds.root, BUILD_DEFAULT_PATH);
+        if (this.task.dest === undefined) {
+            this.task.dest = path.join(cds.root, BUILD_DEFAULT_PATH);
+        }
     }
 
     async _writeResourcesFiles(resObj, model, promises) {

package/lib/constants.js

@@ -44,6 +44,8 @@ const CONTENT_MERGE_KEY = "ordId";
 
 const DATA_PRODUCT_ANNOTATION = "@DataIntegration.dataProduct.type";
 
+const DATA_PRODUCT_SIMPLE_ANNOTATION = "@data.product";
+
 const DATA_PRODUCT_TYPE = Object.freeze({
     primary: "primary",
 });
@@ -106,6 +108,7 @@ module.exports = {
     COMPILER_TYPES,
     CONTENT_MERGE_KEY,
     DATA_PRODUCT_ANNOTATION,
+    DATA_PRODUCT_SIMPLE_ANNOTATION,
     DATA_PRODUCT_TYPE,
     DESCRIPTION_PREFIX,
     ENTITY_RELATIONSHIP_ANNOTATION,

package/lib/defaults.js

@@ -12,6 +12,26 @@ const packageTypes = [
     { tag: "-dataProduct", type: "Data Products" },
 ];
 
+const stringTypeCheck = (value) => typeof value === "string";
+const arrayTypeCheck = (value) => Array.isArray(value);
+
+// see ref: https://pages.github.tools.sap/CentralEngineering/open-resource-discovery-specification/spec-v1/interfaces/document#package
+const packageTypeChecks = {
+    policyLevels: arrayTypeCheck,
+    packageLinks: arrayTypeCheck,
+    links: arrayTypeCheck,
+    licenseType: stringTypeCheck,
+    supportInfo: stringTypeCheck,
+    vendor: stringTypeCheck,
+    countries: arrayTypeCheck,
+    lineOfBusiness: arrayTypeCheck,
+    industry: arrayTypeCheck,
+    runtimeRestriction: stringTypeCheck,
+    tags: arrayTypeCheck,
+    labels: arrayTypeCheck,
+    documentationLabels: arrayTypeCheck,
+};
+
 const regexWithRemoval = (name) => {
     return name?.replace(/[^a-zA-Z0-9]/g, "");
 };
@@ -36,6 +56,22 @@ const generateUniquePackageOrdId = (ordNamespace, name, tag, visibility) => {
     return `${ordNamespace}:package:${regexWithRemoval(name)}${tag}${visibilitySuffix}:v1`;
 };
 
+const mapEnvPackageInfo = (packageConfig) => {
+    if (!packageConfig) {
+        return { vendor: undefined };
+    }
+
+    const filteredEnv = {};
+    for (const key in packageConfig) {
+        const value = packageConfig[key];
+        const checkFunction = packageTypeChecks[key];
+        if (value && checkFunction && checkFunction(value)) {
+            filteredEnv[key] = value;
+        }
+    }
+    return filteredEnv;
+};
+
 /**
  * Module containing default configuration for ORD Document.
  * @module defaults
@@ -58,7 +94,7 @@ module.exports = {
         const name = appConfig.appName;
         const ordNamespace = appConfig.ordNamespace;
         const productsOrdId = appConfig.existingProductORDId || appConfig.products?.[0]?.ordId;
-        const vendor = appConfig.env?.packages?.[0]?.vendor;
+        const { vendor, ...envValues } = mapEnvPackageInfo(appConfig?.env?.packages?.[0]);
         if (hasSAPPolicyLevel(appConfig.policyLevels)) {
             return _.uniqBy(
                 packageTypes.flatMap(({ tag, type }) =>
@@ -69,6 +105,7 @@ module.exports = {
                         version: "1.0.0",
                         ...(productsOrdId && { partOfProducts: [productsOrdId || defaultProductOrdId(name)] }),
                         vendor: vendor || "customer:vendor:Customer:",
+                        ...envValues,
                     })),
                 ),
                 "ordId",
@@ -82,6 +119,7 @@ module.exports = {
                     version: "1.0.0",
                     ...(productsOrdId && { partOfProducts: [productsOrdId || defaultProductOrdId(name)] }),
                     vendor: vendor || "customer:vendor:Customer:",
+                    ...envValues,
                 },
             ];
         }

package/lib/templates.js

@@ -5,6 +5,7 @@ const _ = require("lodash");
 const {
     AUTHENTICATION_TYPE,
     DATA_PRODUCT_ANNOTATION,
+    DATA_PRODUCT_SIMPLE_ANNOTATION,
     DATA_PRODUCT_TYPE,
     DESCRIPTION_PREFIX,
     ENTITY_RELATIONSHIP_ANNOTATION,
@@ -189,6 +190,13 @@ const createGroupsTemplateForService = (serviceName, serviceDefinition, appConfi
         return undefined;
     }
 
+    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.debug("Skipping group creation for private service:", serviceName);
+        return undefined;
+    }
+
     const groupId = _getGroupID(serviceDefinition, defaults.groupTypeId, appConfig);
     return {
         groupId: groupId,
@@ -257,7 +265,13 @@ function _handleVisibility(ordExtensions, definition, defaultVisibility = RESOUR
     let visibility;
     //check for supported custom visibility value in defaultVisibility variable
     if (!ALLOWED_VISIBILITY.includes(defaultVisibility)) {
-        Logger.warn("Default visibility", defaultVisibility, "is not supported. Using", RESOURCE_VISIBILITY.public, "as fallback.");
+        Logger.warn(
+            "Default visibility",
+            defaultVisibility,
+            "is not supported. Using",
+            RESOURCE_VISIBILITY.public,
+            "as fallback.",
+        );
         defaultVisibility = RESOURCE_VISIBILITY.public;
     }
     // Determine visibility
@@ -295,7 +309,34 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
 
     const paths = _generatePaths(serviceName, serviceDefinition);
     const apiResources = [];
-    const ordId = `${appConfig.ordNamespace}:apiResource:${_getGroupNameWithNestedNamespace(serviceDefinition, appConfig)}:v1`;
+
+    // Handle version suffix extraction for primary data product services
+    let cleanServiceName,
+        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";
+        }
+    } else {
+        // Non-data product - use current behavior
+        cleanServiceName = _getGroupNameWithNestedNamespace(serviceDefinition, appConfig);
+        version = "v1";
+        semanticVersion = "1.0.0";
+    }
+
+    const ordId = `${appConfig.ordNamespace}:apiResource:${cleanServiceName}:${version}`;
 
     paths.forEach((generatedPath) => {
         let resourceDefinitions = [
@@ -317,7 +358,7 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
             title: serviceDefinition["@title"] ?? serviceDefinition["@Common.Label"] ?? serviceName,
             shortDescription: SHORT_DESCRIPTION_PREFIX + serviceName,
             description: serviceDefinition["@Core.Description"] ?? DESCRIPTION_PREFIX + serviceName,
-            version: "1.0.0",
+            version: semanticVersion,
             lastUpdate: appConfig.lastUpdate,
             visibility,
             partOfPackage: packageId,
@@ -339,6 +380,10 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
             obj.direction = "outbound";
             obj.implementationStandard = "sap.dp:data-subscription-api:v1";
             obj.entryPoints = [];
+            if (extracted) {
+                // Overwrite partOfGroups
+                obj.partOfGroups = [`${defaults.groupTypeId}:${appConfig.ordNamespace}:${cleanServiceName}`];
+            }
             obj.resourceDefinitions = [
                 _getResourceDefinition(
                     "sap-csn-interop-effective-v1",
@@ -412,7 +457,10 @@ const createEventResourceTemplate = (serviceName, serviceDefinition, appConfig,
 };
 
 function isPrimaryDataProductService(serviceDefinition) {
-    return serviceDefinition[DATA_PRODUCT_ANNOTATION] === DATA_PRODUCT_TYPE.primary;
+    return (
+        serviceDefinition[DATA_PRODUCT_ANNOTATION] === DATA_PRODUCT_TYPE.primary ||
+        !!serviceDefinition[DATA_PRODUCT_SIMPLE_ANNOTATION]
+    );
 }
 
 function _getEntityTypeMappings(definitionObj) {
@@ -483,6 +531,32 @@ function _flattenEntityGraph(currentEntity, processedEntities = []) {
     return [currentEntity, ...assertionsTodo.flatMap((entity) => _flattenEntityGraph(entity, processedEntities))];
 }
 
+/**
+ * Extracts version suffix from service name for data product services.
+ * Only accepts pattern: .v<number> (e.g., .v0, .v1, .v2, .v10)
+ * Rejects patterns like: .v1.1, .v1.0, .version1, .beta
+ *
+ * @param {string} serviceName The full service name
+ * @returns {Object|null} Object with cleanName, version, and semanticVersion, or null if invalid pattern
+ */
+function _extractVersionFromServiceName(serviceName) {
+    // Only match pattern: .v<number> (where number is 1 or more digits)
+    const versionPattern = /\.v(\d+)$/;
+    const match = serviceName.match(versionPattern);
+
+    if (!match) {
+        return null; // No valid version suffix found
+    }
+
+    const versionNumber = parseInt(match[1], 10);
+
+    return {
+        cleanName: serviceName.replace(versionPattern, ""),
+        version: `v${versionNumber}`,
+        semanticVersion: `${versionNumber}.0.0`,
+    };
+}
+
 function _getPackageID(namespace, packageIds, resourceType, visibility = RESOURCE_VISIBILITY.public) {
     if (!packageIds) return;
 
@@ -531,4 +605,5 @@ module.exports = {
     _getExposedEntityTypes,
     _propagateORDVisibility,
     _handleVisibility,
+    isPrimaryDataProductService,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cap-js/ord",
-    "version": "1.3.8",
+    "version": "1.3.10",
     "description": "CAP Plugin for generating ORD document.",
     "repository": "cap-js/ord",
     "author": "SAP SE (https://www.sap.com)",
@@ -25,8 +25,8 @@
     },
     "devDependencies": {
         "eslint": "^9.2.0",
-        "jest": "^29.7.0",
-        "prettier": "3.5.3"
+        "jest": "^30.0.0",
+        "prettier": "3.6.2"
     },
     "peerDependencies": {
         "@sap/cds": ">=8.9.4",