@cap-js/ord 1.3.7 → 1.3.9

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/index.js

@@ -4,4 +4,5 @@ module.exports = {
     ord: require("./ord.js"),
     Logger: require("./logger.js"),
     constants: require("./constants.js"),
+    authentication: require("./authentication.js"),
 };

package/lib/{ord-service.mjs → ord-service.js}

@@ -1,7 +1,7 @@
-import cds from "@sap/cds";
-import { ord, getMetadata, defaults, authentication, logger } from "./es-module.mjs";
+const cds = require("@sap/cds");
+const { ord, getMetadata, defaults, authentication, Logger } = require("./index.js");
 
-export class OpenResourceDiscoveryService extends cds.ApplicationService {
+class OpenResourceDiscoveryService extends cds.ApplicationService {
     init() {
         cds.app.get(`${this.path}`, cds.middlewares.before, (_, res) => {
             return res.status(200).send(defaults.baseTemplate);
@@ -22,7 +22,7 @@ export class OpenResourceDiscoveryService extends cds.ApplicationService {
                 const { contentType, response } = await getMetadata(req.url);
                 return res.status(200).contentType(contentType).send(response);
             } catch (error) {
-                logger.Logger.error(error, "Error while processing the resource definition document");
+                Logger.error(error, "Error while processing the resource definition document");
                 return res.status(500).send(error.message);
             }
         });
@@ -30,3 +30,5 @@ export class OpenResourceDiscoveryService extends cds.ApplicationService {
         return super.init();
     }
 }
+
+module.exports = { OpenResourceDiscoveryService };

package/lib/templates.js

@@ -189,6 +189,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 +264,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

package/package.json

@@ -1,13 +1,14 @@
 {
     "name": "@cap-js/ord",
-    "version": "1.3.7",
+    "version": "1.3.9",
     "description": "CAP Plugin for generating ORD document.",
     "repository": "cap-js/ord",
     "author": "SAP SE (https://www.sap.com)",
     "homepage": "https://cap.cloud.sap/",
     "license": "Apache-2.0",
     "workspaces": [
-        "xmpl"
+        "xmpl",
+        "xmpl_java"
     ],
     "main": "cds-plugin.js",
     "files": [
@@ -23,7 +24,7 @@
         "cds:version": "cds v -i"
     },
     "devDependencies": {
-        "eslint": "^8",
+        "eslint": "^9.2.0",
         "jest": "^29.7.0",
         "prettier": "3.5.3"
     },

package/lib/es-module.mjs

@@ -1,6 +0,0 @@
-// matches commonjs.js to es-module so that we can use the same code in cap services
-export { default as defaults } from "./defaults.js";
-export { default as getMetadata } from "./metaData.js";
-export { default as ord } from "./ord.js";
-export { default as authentication } from "./authentication.js";
-export { default as logger } from "./logger.js";