@cap-js/ord 1.2.0 → 1.3.1

package/lib/defaults.js

@@ -1,68 +1,97 @@
-const { OPEN_RESOURCE_DISCOVERY_VERSION } = require("./constants");
+const { OPEN_RESOURCE_DISCOVERY_VERSION, SHORT_DESCRIPTION_PREFIX, RESOURCE_VISIBILITY } = require("./constants");
+const { getAuthConfig } = require("./authentication");
+const _ = require("lodash");
+
+const packageTypes = [
+    { tag: "-api", type: "APIs" },
+    { tag: "-event", type: "Events" },
+    { tag: "-consumptionBundle", type: "Consumption Bundles" },
+    { tag: "-integrationDependency", type: "Integration Dependencies" },
+    { tag: "-entityType", type: "Entity Types" },
+    { tag: "-dataProduct", type: "Data Products" },
+];
 
 const regexWithRemoval = (name) => {
-    if (name) {
-        return name.replace(/[^a-zA-Z0-9]/g, "");
-    }
+    return name?.replace(/[^a-zA-Z0-9]/g, "");
 };
 
 const nameWithDot = (name) => {
-    return (
-        regexWithRemoval(name.charAt(0)) +
-        name.slice(1, name.length).replace(/[^a-zA-Z0-9]/g, ".")
-    );
+    return regexWithRemoval(name.charAt(0)) + name.slice(1, name.length).replace(/[^a-zA-Z0-9]/g, ".");
 };
 
 const nameWithSpaces = (name) => {
-    return (
-        regexWithRemoval(name.charAt(0)) +
-        name.slice(1, name.length).replace(/[^a-zA-Z0-9]/g, " ")
-    );
+    return regexWithRemoval(name.charAt(0)) + name.slice(1, name.length).replace(/[^a-zA-Z0-9]/g, " ");
 };
 
 const defaultProductOrdId = (name) => `customer:product:${nameWithDot(name)}:`;
 
+const generatePackageDescriptions = (name, type, visibility) => ({
+    shortDescription: `Package containing ${visibility} ${type}`,
+    description: `This package contains ${visibility} ${type} for ${nameWithSpaces(name)}.`,
+});
+
+const generateUniquePackageOrdId = (ordNamespace, name, tag, visibility) => {
+    const visibilitySuffix = visibility === RESOURCE_VISIBILITY.public ? "" : `-${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
  */
 module.exports = {
-    $schema:
-        "https://sap.github.io/open-resource-discovery/spec-v1/interfaces/Document.schema.json",
+    $schema: "https://open-resource-discovery.github.io/specification/spec-v1/interfaces/Document.schema.json",
     openResourceDiscovery: OPEN_RESOURCE_DISCOVERY_VERSION,
-    policyLevel: "none",
+    policyLevels: ["none"],
     description: "this is an application description",
     products: (name) => [
         {
             ordId: defaultProductOrdId(name),
             title: nameWithSpaces(name),
-            shortDescription: "Description for " + nameWithSpaces(name),
+            shortDescription: SHORT_DESCRIPTION_PREFIX + nameWithSpaces(name),
             vendor: "customer:vendor:customer:",
         },
     ],
     groupTypeId: "sap.cds:service",
-    packages: function getPackageData(name, policyLevel, ordNamespace) {
-        function createPackage(name, tag) {
-            return {
-                ordId: `${ordNamespace}:package:${regexWithRemoval(name
-                )}${tag}`,
-                title: nameWithSpaces(name),
-                shortDescription:
-                    "Short description for " + nameWithSpaces(name),
-                description: "Description for " + nameWithSpaces(name),
-                version: "1.0.0",
-                partOfProducts: [defaultProductOrdId(name)],
-                vendor: "customer:vendor:Customer:",
-            };
-        }
-
-        if (policyLevel.split(":")[0].toLowerCase() === "sap") {
+    packages: function getPackageData(appConfig, policyLevels) {
+        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)) {
+            return _.uniqBy(
+                packageTypes.flatMap(({ tag, type }) =>
+                    Object.values(RESOURCE_VISIBILITY).map((visibility) => ({
+                        ordId: generateUniquePackageOrdId(ordNamespace, name, tag, visibility),
+                        title: nameWithSpaces(name),
+                        ...generatePackageDescriptions(name, type, visibility),
+                        version: "1.0.0",
+                        ...(productsOrdId && { partOfProducts: [productsOrdId || defaultProductOrdId(name)] }),
+                        vendor: vendor || "customer:vendor:Customer:",
+                    })),
+                ),
+                "ordId",
+            );
+        } else {
             return [
-                createPackage(name, "-api:v1"),
-                createPackage(name, "-event:v1"),
+                {
+                    ordId: generateUniquePackageOrdId(ordNamespace, name, "", RESOURCE_VISIBILITY.public),
+                    title: nameWithSpaces(name),
+                    ...generatePackageDescriptions(name, "General", RESOURCE_VISIBILITY.public),
+                    version: "1.0.0",
+                    ...(productsOrdId && { partOfProducts: [productsOrdId || defaultProductOrdId(name)] }),
+                    vendor: vendor || "customer:vendor:Customer:",
+                },
             ];
-        } else {
-            return [createPackage(name, ":v1")];
         }
     },
     consumptionBundles: (appConfig) => [
@@ -71,8 +100,7 @@ module.exports = {
             version: "1.0.0",
             lastUpdate: appConfig.lastUpdate,
             title: "Unprotected resources",
-            shortDescription:
-                "If we have another protected API then it will be another object",
+            shortDescription: "If we have another protected API then it will be another object",
             description:
                 "This Consumption Bundle contains all resources of the reference app which are unprotected and do not require authentication",
         },
@@ -85,12 +113,8 @@ module.exports = {
         openResourceDiscoveryV1: {
             documents: [
                 {
-                    url: "/open-resource-discovery/v1/documents/1",
-                    accessStrategies: [
-                        {
-                            type: "open",
-                        },
-                    ],
+                    url: "/ord/v1/documents/ord-document",
+                    accessStrategies: getAuthConfig().accessStrategies,
                 },
             ],
         },

package/lib/es-module.mjs

@@ -0,0 +1,6 @@
+// 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";

package/lib/extendOrdWithCustom.js

@@ -9,7 +9,7 @@ function cleanNullProperties(obj) {
     for (const key in obj) {
         if (obj[key] === null) {
             delete obj[key];
-        } else if (typeof obj[key] === 'object') {
+        } else if (typeof obj[key] === "object") {
             cleanNullProperties(obj[key]);
         }
     }
@@ -33,8 +33,12 @@ function compareAndHandleCustomORDContentWithExistingContent(ordContent, customO
     const clonedOrdContent = structuredClone(ordContent);
     for (const key in customORDContent) {
         const propertyType = typeof customORDContent[key];
-        if (propertyType !== 'object' && propertyType !== 'array') {
-            Logger.warn('Found ord top level primitive ord property in customOrdFile:', key, '. Please define it in .cdsrc.json.');
+        if (propertyType !== "object" && propertyType !== "array") {
+            Logger.warn(
+                "Found ord top level primitive ord property in customOrdFile:",
+                key,
+                ". Please define it in .cdsrc.json.",
+            );
 
             continue;
         }
@@ -50,15 +54,17 @@ function compareAndHandleCustomORDContentWithExistingContent(ordContent, customO
 function getCustomORDContent(appConfig) {
     if (!appConfig.env?.customOrdContentFile) return;
     const pathToCustomORDContent = path.join(cds.root, appConfig.env?.customOrdContentFile);
-    if (fs.existsSync(pathToCustomORDContent))  {
-        Logger.error('Custom ORD content file not found at', pathToCustomORDContent);
+    if (fs.existsSync(pathToCustomORDContent)) {
+        Logger.error("Custom ORD content file not found at", pathToCustomORDContent);
         return require(pathToCustomORDContent);
     }
 }
 
 function extendCustomORDContentIfExists(appConfig, ordContent) {
     const customORDContent = getCustomORDContent(appConfig);
-    return customORDContent ? compareAndHandleCustomORDContentWithExistingContent(ordContent, customORDContent) : ordContent;
+    return customORDContent
+        ? compareAndHandleCustomORDContentWithExistingContent(ordContent, customORDContent)
+        : ordContent;
 }
 
 module.exports = {

package/lib/index.js

@@ -1,5 +1,7 @@
 module.exports = {
-  ord: require("./ord.js"),
-  getMetadata: require("./metaData.js"),
-  defaults: require("./defaults.js"),
+    defaults: require("./defaults.js"),
+    getMetadata: require("./metaData.js"),
+    ord: require("./ord.js"),
+    Logger: require("./logger.js"),
+    constants: require("./constants.js"),
 };

package/lib/logger.js

@@ -1,9 +1,15 @@
 const cds = require("@sap/cds");
 
+const _debugLevel = cds.env?.DEBUG || process.env.DEBUG;
+
+function _getLogLevel(debugLevel, logLevels) {
+    return debugLevel ? logLevels.DEBUG : logLevels.WARN;
+}
+
+const level = _getLogLevel(_debugLevel, cds.log?.levels);
+
 const Logger = cds.log("ord-plugin", {
-    level: cds.env.DEBUG || process.env.DEBUG
-        ? cds.log.levels?.DEBUG
-        : cds.log.levels?.WARN,
+    level,
 });
 
 module.exports = {

package/lib/metaData.js

@@ -1,23 +1,28 @@
-const cds = require('@sap/cds/lib');
-const { compile: openapi } = require('@cap-js/openapi')
-const { compile: asyncapi } = require('@cap-js/asyncapi');
-const { COMPILER_TYPES } = require('./constants');
-const { Logger } = require('./logger');
+const cds = require("@sap/cds/lib");
+const { compile: openapi } = require("@cap-js/openapi");
+const { compile: asyncapi } = require("@cap-js/asyncapi");
+const { COMPILER_TYPES } = require("./constants");
+const { Logger } = require("./logger");
+const cdsc = require("@sap/cds-compiler/lib/main");
 
-module.exports = async (data) => {
-    const parts = data?.split("/").pop().replace(/\.json$/, '').split(".");
+module.exports = async (url, model = null) => {
+    const parts = url
+        ?.split("/")
+        .pop()
+        .replace(/\.json$/, "")
+        .split(".");
     const compilerType = parts.pop();
     const serviceName = parts.join(".");
-    const csn = cds.services[serviceName].model;
+    const csn = model || cds.services[serviceName]?.model;
 
     let responseFile;
-    const options = { service: serviceName, as: 'str', messages: [] }
+    const options = { service: serviceName, as: "str", messages: [] };
     switch (compilerType) {
         case COMPILER_TYPES.oas3:
             try {
                 responseFile = openapi(csn, options);
             } catch (error) {
-                Logger.error('OpenApi error:', error.message);
+                Logger.error("OpenApi error:", error.message);
                 throw error;
             }
             break;
@@ -25,7 +30,16 @@ module.exports = async (data) => {
             try {
                 responseFile = asyncapi(csn, options);
             } catch (error) {
-                Logger.error('AsyncApi error:', error.message);
+                Logger.error("AsyncApi error:", error.message);
+                throw error;
+            }
+            break;
+        case COMPILER_TYPES.csn:
+            try {
+                const opt2 = { beta: { effectiveCsn: true }, effectiveServiceName: serviceName };
+                responseFile = cdsc.for.effective(csn, opt2);
+            } catch (error) {
+                Logger.error("Csn error:", error.message);
                 throw error;
             }
             break;
@@ -33,12 +47,12 @@ module.exports = async (data) => {
             try {
                 responseFile = await cds.compile(csn).to["edmx"](options);
             } catch (error) {
-                Logger.error('Edmx error:', error.message);
+                Logger.error("Edmx error:", error.message);
                 throw error;
             }
     }
     return {
         contentType: `application/${compilerType === "edmx" ? "xml" : "json"}`,
-        response: responseFile
+        response: responseFile,
     };
-}
+};

package/lib/ord-service.cds

@@ -0,0 +1,3 @@
+@rest  @path: '/.well-known/open-resource-discovery'
+@ORD.Extensions.implementationStandard: 'sap:ord-document-api:v1'
+service OpenResourceDiscoveryService {}

package/lib/ord-service.mjs

@@ -0,0 +1,32 @@
+import cds from "@sap/cds";
+import { ord, getMetadata, defaults, authentication, logger } from "./es-module.mjs";
+
+export class OpenResourceDiscoveryService extends cds.ApplicationService {
+    init() {
+        cds.app.get(`${this.path}`, cds.middlewares.before, (_, res) => {
+            return res.status(200).send(defaults.baseTemplate);
+        });
+
+        cds.app.get(`/ord/v1/documents/ord-document`, authentication.authenticate, 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`, authentication.authenticate, async (_, res) => {
+            return res.status(404).send("404 Not Found");
+        });
+
+        cds.app.get(`/ord/v1/:ordId?/:service?`, authentication.authenticate, async (req, res) => {
+            try {
+                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");
+                return res.status(500).send(error.message);
+            }
+        });
+
+        return super.init();
+    }
+}