@cap-js/ord 1.4.4 → 1.4.5

package/lib/build.js

@@ -87,6 +87,14 @@ module.exports = class OrdBuildPlugin extends cds.build.Plugin {
     }
 
     async build() {
+        // @cap-js/graphql registers protocols and compile targets at runtime via cds-plugin.js,
+        // but cds build rebuilds cds.env afterwards, losing both registrations.
+        // Re-apply so endpoints4() and cds.compile.to.graphql work during build.
+        if ("@cap-js/graphql" in cds.env.plugins && !cds.env.protocols?.graphql) {
+            cds.env.protocols.graphql = { path: "/graphql", impl: "@cap-js/graphql" };
+            require("@cap-js/graphql/lib/api").registerCompileTargets();
+        }
+
         try {
             const model = await this.model();
             const ordDocument = ord(model);

package/lib/constants.js

@@ -53,6 +53,7 @@ const COMPILER_TYPES = Object.freeze({
     edmx: "edmx",
     csn: "csn",
     mcp: "mcp",
+    graphql: "graphql",
 });
 
 const CONTENT_MERGE_KEY = "ordId";
@@ -117,6 +118,12 @@ const SEM_VERSION_REGEX =
 
 const MCP_CUSTOM_TYPE = "sap:mcp-server-card:v0";
 
+const EXTERNAL_DP_ORD_ID_ANNOTATION = "@cds.dp.ordId";
+
+const EXTERNAL_SERVICE_ANNOTATION = "@cds.external";
+
+const INTEGRATION_DEPENDENCY_RESOURCE_NAME = "externalDependencies";
+
 // ORD apiProtocol values
 const ORD_API_PROTOCOL = Object.freeze({
     ODATA_V4: "odata-v4",
@@ -128,18 +135,19 @@ const ORD_API_PROTOCOL = Object.freeze({
 });
 
 // Mapping from CAP protocol kind to ORD apiProtocol
-// CAP may return 'odata', 'odata-v4', 'rest', etc.
+// CAP may return 'odata', 'odata-v4', 'rest', 'graphql', etc.
 const CAP_TO_ORD_PROTOCOL_MAP = Object.freeze({
     "odata": ORD_API_PROTOCOL.ODATA_V4,
     "odata-v4": ORD_API_PROTOCOL.ODATA_V4,
     "odata-v2": ORD_API_PROTOCOL.ODATA_V2,
     "rest": ORD_API_PROTOCOL.REST,
+    "graphql": ORD_API_PROTOCOL.GRAPHQL,
 });
 
-// Protocols that ORD supports but CAP doesn't recognize (endpoints4 returns [])
+// Protocols that ORD supports but CAP may not recognize (endpoints4 returns [])
 // These need special handling in the ORD plugin
 const ORD_ONLY_PROTOCOLS = Object.freeze({
-    "ina": {
+    ina: {
         apiProtocol: ORD_API_PROTOCOL.SAP_INA,
         hasEntryPoints: false,
         hasResourceDefinitions: false,
@@ -147,8 +155,7 @@ const ORD_ONLY_PROTOCOLS = Object.freeze({
 });
 
 // Protocols that the ORD plugin cannot currently generate definitions for
-// GraphQL is supported by ORD spec, but plugin can't emit graphql-sdl yet
-const PLUGIN_UNSUPPORTED_PROTOCOLS = Object.freeze(["graphql"]);
+const PLUGIN_UNSUPPORTED_PROTOCOLS = Object.freeze([]);
 
 // CF mTLS Error Reasons
 const CF_MTLS_ERROR_REASON = Object.freeze({
@@ -189,6 +196,9 @@ module.exports = {
     DATA_PRODUCT_TYPE,
     DESCRIPTION_PREFIX,
     ENTITY_RELATIONSHIP_ANNOTATION,
+    EXTERNAL_DP_ORD_ID_ANNOTATION,
+    EXTERNAL_SERVICE_ANNOTATION,
+    INTEGRATION_DEPENDENCY_RESOURCE_NAME,
     LEVEL,
     MCP_CUSTOM_TYPE,
     OPEN_RESOURCE_DISCOVERY_VERSION,

package/lib/integrationDependency.js

@@ -0,0 +1,127 @@
+const {
+    DATA_PRODUCT_SIMPLE_ANNOTATION,
+    EXTERNAL_DP_ORD_ID_ANNOTATION,
+    EXTERNAL_SERVICE_ANNOTATION,
+    INTEGRATION_DEPENDENCY_RESOURCE_NAME,
+    ORD_RESOURCE_TYPE,
+    RESOURCE_VISIBILITY,
+} = require("./constants");
+const { readORDExtensions, _getPackageID } = require("./templates");
+
+/**
+ * Parses @cds.dp.ordId annotation to extract resource information.
+ * @param {string} ordId - e.g., "sap.sai:apiResource:Supplier:v1"
+ * @returns {Object} { namespace, resourceType, resourceName, version }
+ */
+function parseDataProductOrdId(ordId) {
+    const [namespace, resourceType, resourceName, version = "v1"] = ordId.split(":");
+    return { namespace, resourceType, resourceName, version };
+}
+
+/**
+ * Checks if a CSN definition is an external Data Product.
+ * @param {Object} definition - CSN definition object
+ * @returns {boolean}
+ */
+function isExternalDataProduct(definition) {
+    return !!(
+        definition.kind === "service" &&
+        definition[EXTERNAL_SERVICE_ANNOTATION] &&
+        definition[DATA_PRODUCT_SIMPLE_ANNOTATION] &&
+        definition[EXTERNAL_DP_ORD_ID_ANNOTATION]
+    );
+}
+
+/**
+ * Collects external services from CSN definitions.
+ * Returns a flat list of external services (one per service, no namespace grouping).
+ * @param {Object} csn - The CSN definitions object
+ * @returns {Array} Array of external service objects
+ */
+function collectExternalServices(csn) {
+    const externalServices = [];
+
+    for (const [serviceName, definition] of Object.entries(csn.definitions)) {
+        if (!isExternalDataProduct(definition)) continue;
+
+        const dpOrdId = definition[EXTERNAL_DP_ORD_ID_ANNOTATION];
+        const { resourceType, version } = parseDataProductOrdId(dpOrdId);
+
+        // Only support apiResource for now
+        if (resourceType !== "apiResource") continue;
+
+        externalServices.push({
+            serviceName,
+            ordId: dpOrdId,
+            minVersion: version.replace("v", "") + ".0.0",
+            definition,
+        });
+    }
+
+    return externalServices;
+}
+
+/**
+ * Creates a single IntegrationDependency with one aspect per external service.
+ * @param {Array} externalServices - Array of external service objects
+ * @param {Object} appConfig - The application configuration
+ * @param {Array} packageIds - The available package identifiers
+ * @returns {Object} IntegrationDependency object
+ */
+function createIntegrationDependency(externalServices, appConfig, packageIds) {
+    const packageId = _getPackageID(
+        appConfig.ordNamespace,
+        packageIds,
+        ORD_RESOURCE_TYPE.integrationDependency,
+        RESOURCE_VISIBILITY.public,
+    );
+
+    // Create one aspect per external service
+    const aspects = externalServices.map((service) => {
+        const ordExtensions = readORDExtensions(service.definition || {});
+        return {
+            title: service.serviceName,
+            mandatory: false,
+            apiResources: [{ ordId: service.ordId, minVersion: service.minVersion }],
+            ...ordExtensions, // Allow customization via @ORD.Extensions on the service
+        };
+    });
+
+    // Read IntegrationDependency level config from cdsrc
+    const integrationDepConfig = appConfig.env?.integrationDependency || {};
+
+    return {
+        ordId: `${appConfig.ordNamespace}:${ORD_RESOURCE_TYPE.integrationDependency}:${INTEGRATION_DEPENDENCY_RESOURCE_NAME}:v1`,
+        title: "External Dependencies",
+        version: "1.0.0",
+        releaseStatus: "active",
+        visibility: RESOURCE_VISIBILITY.public,
+        mandatory: false,
+        partOfPackage: packageId,
+        aspects,
+        ...integrationDepConfig, // Allow customization via cdsrc
+    };
+}
+
+/**
+ * Generates a single IntegrationDependency for all external services.
+ * @param {Object} csn - The CSN definitions object
+ * @param {Object} appConfig - The application configuration
+ * @param {Array} packageIds - The available package identifiers
+ * @returns {Array} Array containing single IntegrationDependency or empty array
+ */
+function getIntegrationDependencies(csn, appConfig, packageIds) {
+    const externalServices = collectExternalServices(csn);
+    if (externalServices.length === 0) return [];
+
+    return [createIntegrationDependency(externalServices, appConfig, packageIds)];
+}
+
+module.exports = {
+    getIntegrationDependencies,
+    // Exported for testing
+    collectExternalServices,
+    createIntegrationDependency,
+    parseDataProductOrdId,
+    isExternalDataProduct,
+};

package/lib/interopCsn.js

@@ -117,6 +117,12 @@ function map_annotations(csn) {
                 delete o[oldA];
             }
         }
+
+        // delete all @assert.unique annotations
+        let assertUniqueAnnos = Object.keys(o).filter(x => x.startsWith('@assert.unique'))
+        for (let a of assertUniqueAnnos) {
+            delete o[a]
+        }
     }
 }
 

package/lib/metaData.js

@@ -46,7 +46,7 @@ const getMetadata = async (url, model = null) => {
 
                 responseFile = openapi(csn, openapiOptions);
             } catch (error) {
-                Logger.error("OpenApi error:", error.message);
+                Logger.error(`OpenApi error for service ${serviceName} - ${error.message}`);
                 throw error;
             }
             break;
@@ -54,7 +54,7 @@ const getMetadata = async (url, model = null) => {
             try {
                 responseFile = asyncapi(csn, { ...options, ...(compileOptions?.asyncapi || {}) });
             } catch (error) {
-                Logger.error("AsyncApi error:", error.message);
+                Logger.error(`AsyncApi error for service ${serviceName} - ${error.message}`);
                 throw error;
             }
             break;
@@ -64,7 +64,7 @@ const getMetadata = async (url, model = null) => {
                 let effCsn = cdsc.for.effective(csn, opt_eff);
                 responseFile = interopCSN(effCsn);
             } catch (error) {
-                Logger.error("Csn error:", error.message);
+                Logger.error(`Csn error for service ${serviceName} - ${error.message}`);
                 throw error;
             }
             break;
@@ -72,7 +72,7 @@ const getMetadata = async (url, model = null) => {
             try {
                 responseFile = await cds.compile(csn).to["edmx"]({ ...options, ...(compileOptions?.edmx || {}) });
             } catch (error) {
-                Logger.error("Edmx error:", error.message);
+                Logger.error(`Edmx error for service ${serviceName} - ${error.message}`);
                 throw error;
             }
             break;
@@ -88,13 +88,28 @@ const getMetadata = async (url, model = null) => {
                 // Extract only the MCP content, not the ORD metadata
                 responseFile = mcpResult.mcp;
             } catch (error) {
-                Logger.error("MCP server definition error:", error.message);
+                Logger.error(`MCP server definition error - ${error.message}`);
+                throw error;
+            }
+            break;
+        case COMPILER_TYPES.graphql:
+            try {
+                const { generateSchema4 } = require("@cap-js/graphql/lib/schema");
+                const { lexicographicSortSchema, printSchema } = require("graphql");
+                const linked = cds.linked(csn);
+                const srv = new cds.ApplicationService(serviceName, linked);
+                let schema = generateSchema4({ [serviceName]: srv });
+                schema = lexicographicSortSchema(schema);
+                responseFile = printSchema(schema);
+            } catch (error) {
+                Logger.error("GraphQL SDL error:", error.message);
                 throw error;
             }
             break;
     }
     return {
-        contentType: `application/${compilerType === "edmx" ? "xml" : "json"}`,
+        contentType:
+            compilerType === "graphql" ? "text/plain" : `application/${compilerType === "edmx" ? "xml" : "json"}`,
         response: responseFile,
     };
 };

package/lib/ord-service.js

@@ -31,7 +31,8 @@ class OpenResourceDiscoveryService extends cds.ApplicationService {
             return res.status(404).send("404 Not Found");
         });
 
-        cds.app.get(`/ord/v1/:ordId?/:service?`, authMiddleware, async (req, res) => {
+        // Handler for metadata requests (oas3, edmx, csn, etc.)
+        const metadataHandler = async (req, res) => {
             try {
                 const { contentType, response } = await getMetadata(req.url);
                 return res.status(200).contentType(contentType).send(response);
@@ -39,7 +40,12 @@ class OpenResourceDiscoveryService extends cds.ApplicationService {
                 Logger.error(error, "Error while processing the resource definition document");
                 return res.status(500).send(error.message);
             }
-        });
+        };
+
+        // Use separate routes instead of optional parameters for path-to-regexp v8 compatibility
+        cds.app.get(`/ord/v1/:ordId/:service`, authMiddleware, metadataHandler);
+        cds.app.get(`/ord/v1/:ordId`, authMiddleware, metadataHandler);
+        cds.app.get(`/ord/v1`, authMiddleware, metadataHandler);
 
         return super.init();
     }

package/lib/ord.js

@@ -14,6 +14,7 @@ const {
     createMCPAPIResourceTemplate,
     _propagateORDVisibility,
 } = require("./templates");
+const { getIntegrationDependencies } = require("./integrationDependency");
 const { extendCustomORDContentIfExists } = require("./extendOrdWithCustom");
 const { getRFC3339Date } = require("./date");
 const { createAuthConfig } = require("./auth/authentication");
@@ -330,18 +331,17 @@ function _filterUnusedPackages(ordDocument) {
 
     const usedPackageIds = new Set();
 
-    ordDocument.apiResources?.forEach((api) => usedPackageIds?.add(api.partOfPackage));
-    ordDocument.eventResources?.forEach((event) => usedPackageIds?.add(event.partOfPackage));
-    ordDocument.dataProducts?.forEach((dp) => usedPackageIds?.add(dp.partOfPackage));
+    ordDocument.apiResources?.forEach((api) => usedPackageIds.add(api.partOfPackage));
+    ordDocument.eventResources?.forEach((event) => usedPackageIds.add(event.partOfPackage));
+    ordDocument.dataProducts?.forEach((dp) => usedPackageIds.add(dp.partOfPackage));
+    ordDocument.integrationDependencies?.forEach((dep) => usedPackageIds.add(dep.partOfPackage));
     ordDocument.entityTypes?.forEach((et) => {
-        if (et && et.partOfPackage) {
+        if (et?.partOfPackage) {
             usedPackageIds.add(et.partOfPackage);
         }
     });
 
-    const filteredPackages = ordDocument.packages.filter((pkg) => usedPackageIds.has(pkg.ordId));
-
-    return filteredPackages;
+    return ordDocument.packages.filter((pkg) => usedPackageIds.has(pkg.ordId));
 }
 
 module.exports = (csn) => {
@@ -375,6 +375,12 @@ module.exports = (csn) => {
             ordDocument.eventResources = eventResources;
         }
     }
+
+    const integrationDependencies = getIntegrationDependencies(linkedCsn, appConfig, packageIds);
+    if (integrationDependencies.length) {
+        ordDocument.integrationDependencies = integrationDependencies;
+    }
+
     ordDocument = extendCustomORDContentIfExists(appConfig, ordDocument);
     ordDocument.packages = _filterUnusedPackages(ordDocument);
 

package/lib/protocol-resolver.js

@@ -23,14 +23,14 @@ function _getCapEndpoints(serviceName, srvDefinition) {
  * Reads the explicit @protocol annotation from service definition.
  *
  * @param {Object} srvDefinition The service definition object.
- * @returns {string|null} Protocol name, or null if not explicitly set.
+ * @returns {string[]} Array of protocol names, or empty array if not explicitly set.
  */
 function _getExplicitProtocol(srvDefinition) {
     const protocol = srvDefinition["@protocol"];
     if (!protocol) {
-        return null;
+        return [];
     }
-    return Array.isArray(protocol) ? protocol[0] : protocol;
+    return Array.isArray(protocol) ? protocol : [protocol];
 }
 
 /**
@@ -38,7 +38,7 @@ function _getExplicitProtocol(srvDefinition) {
  *
  * Design Principles:
  * - explicit protocol is the "master switch" for all decisions
- * - Rule A: Explicit protocol + empty endpoints → don't fallback to OData
+ * - Rule A: Explicit protocol + empty endpoints → don't fall back to OData
  * - Rule B: Only fallback to OData when no explicit protocol
  * - Rule C: Never produce [null] in entryPoints
  *
@@ -62,34 +62,8 @@ function resolveApiResourceProtocol(serviceName, srvDefinition, options = {}) {
         ];
     }
 
-    const explicit = _getExplicitProtocol(srvDefinition);
-
-    // 2. Handle explicit protocol
-    if (explicit) {
-        // 2a. Check if it's an ORD-only protocol (e.g., INA)
-        if (ORD_ONLY_PROTOCOLS[explicit]) {
-            const config = ORD_ONLY_PROTOCOLS[explicit];
-            const path = config.hasEntryPoints ? cds.service.protocols.path4(srvDefinition) : null;
-            return [
-                {
-                    apiProtocol: config.apiProtocol,
-                    entryPoints: path ? [path] : [],
-                    hasResourceDefinitions: config.hasResourceDefinitions,
-                },
-            ];
-        }
-
-        // 2b. Check if it's a plugin-unsupported protocol
-        if (PLUGIN_UNSUPPORTED_PROTOCOLS.includes(explicit)) {
-            Logger.warn(
-                `Protocol '${explicit}' is supported by ORD but this plugin cannot generate its resource definitions yet.`,
-            );
-            return [];
-        }
-    }
-
-    // 3. Try to resolve from CAP endpoints
     const capEndpoints = _getCapEndpoints(serviceName, srvDefinition);
+    const ordProtocols = [];
     for (const endpoint of capEndpoints) {
         if (PLUGIN_UNSUPPORTED_PROTOCOLS.includes(endpoint.kind)) {
             Logger.warn(
@@ -100,22 +74,52 @@ function resolveApiResourceProtocol(serviceName, srvDefinition, options = {}) {
 
         const apiProtocol = CAP_TO_ORD_PROTOCOL_MAP[endpoint.kind] ?? endpoint.kind;
         if (apiProtocol) {
-            return [
-                {
-                    apiProtocol,
-                    entryPoints: endpoint.path ? [endpoint.path] : [],
-                    hasResourceDefinitions: true,
-                },
-            ];
+            ordProtocols.push({
+                apiProtocol,
+                entryPoints: endpoint.path ? [endpoint.path] : [],
+                hasResourceDefinitions: true,
+            });
         }
     }
 
-    // 4. Handle explicit protocol with no CAP endpoint (Rule A)
-    if (explicit) {
-        Logger.warn(`Unknown protocol '${explicit}' is not supported, skipping service '${serviceName}'.`);
+    const explicit = _getExplicitProtocol(srvDefinition);
+    for (const protocol of explicit) {
+        // 2. Handle explicit protocol
+        // 2a. Check if it's an ORD-only protocol (e.g., INA)
+        if (ORD_ONLY_PROTOCOLS[protocol]) {
+            const config = ORD_ONLY_PROTOCOLS[protocol];
+            const path = config.hasEntryPoints ? cds.service.protocols.path4(srvDefinition) : null;
+            ordProtocols.push({
+                apiProtocol: config.apiProtocol,
+                entryPoints: path ? [path] : [],
+                hasResourceDefinitions: config.hasResourceDefinitions,
+            });
+            continue;
+        }
+
+        // 2b. Check if it's a plugin-unsupported protocol
+        if (PLUGIN_UNSUPPORTED_PROTOCOLS.includes(protocol)) {
+            Logger.warn(
+                `Protocol '${protocol}' is supported by ORD but this plugin cannot generate its resource definitions yet.`,
+            );
+            continue;
+        }
+
+        // 4. Handle explicit protocol with no CAP endpoint (Rule A)
+        if (!ordProtocols.some((p) => p.apiProtocol === protocol) && !CAP_TO_ORD_PROTOCOL_MAP[protocol]) {
+            Logger.warn(`Unknown protocol '${protocol}' is not supported, and skipped for service '${serviceName}'.`);
+        }
+    }
+
+    // no protocol found via CAP endpoints, but explicit protocol(s) defined → Rule A: don't fall back to OData, return empty array
+    if (ordProtocols.length === 0 && explicit.length > 0) {
         return [];
     }
 
+    if (ordProtocols.length > 0) {
+        return ordProtocols;
+    }
+
     // 5. No explicit protocol and no CAP endpoint - fallback to OData (Rule B)
     const path = cds.service.protocols.path4(srvDefinition);
     return [

package/lib/templates.js

@@ -348,6 +348,18 @@ const createAPIResourceTemplate = (serviceName, serviceDefinition, appConfig, pa
                 resourceDefinitions = [
                     _getResourceDefinition("openapi-v3", "json", ordId, serviceName, "oas3.json", accessStrategies),
                 ];
+            } else if (apiProtocol === ORD_API_PROTOCOL.GRAPHQL) {
+                // GraphQL only has GraphQL SDL
+                resourceDefinitions = [
+                    {
+                        type: "graphql-sdl",
+                        mediaType: "text/plain",
+                        url: `/ord/v1/${ordId}/${serviceName}.graphql`,
+                        accessStrategies: ensureAccessStrategies(accessStrategies, {
+                            resourceName: `${serviceName} (graphql-sdl)`,
+                        }),
+                    },
+                ];
             } else {
                 // OData and others have both OpenAPI and EDMX
                 resourceDefinitions = [
@@ -699,6 +711,7 @@ module.exports = {
     createAPIResourceTemplate,
     createEventResourceTemplate,
     createMCPAPIResourceTemplate,
+    readORDExtensions,
     _getPackageID,
     _getEntityTypeMappings,
     _getExposedEntityTypes,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cap-js/ord",
-    "version": "1.4.4",
+    "version": "1.4.5",
     "description": "CAP Plugin for generating ORD document.",
     "repository": "cap-js/ord",
     "author": "SAP SE (https://www.sap.com)",
@@ -28,13 +28,14 @@
         "cds:version": "cds v -i"
     },
     "devDependencies": {
-        "eslint": "^9.2.0",
+        "@cap-js/graphql": "^0.14.0",
+        "@cap-js/sqlite": "^2",
+        "@sap/cds-dk": ">=8.9.5",
+        "eslint": "^10.0.0",
         "express": "^4",
         "jest": "^30.0.0",
         "prettier": "3.8.1",
-        "supertest": "^7.0.0",
-        "@cap-js/sqlite": "^2",
-        "@sap/cds-dk": ">=8.9.5"
+        "supertest": "^7.0.0"
     },
     "peerDependencies": {
         "@sap/cds": ">=8.9.4"
@@ -50,7 +51,7 @@
         "node": ">=18 <23"
     },
     "overrides": {
-        "@sap/cds-compiler": "6.6.2"
+        "@sap/cds-compiler": "6.7.3"
     },
     "cds": {
         "requires": {