@cap-js/ord 1.5.0 → 1.6.0

package/cds-plugin.js

@@ -4,17 +4,7 @@ if (cds.cli.command === "build") {
     cds.build?.register?.("ord", require("./lib/build"));
 }
 
-function _lazyRegisterCompileTarget() {
-    const ord = require("./lib/index").ord;
-    Object.defineProperty(this, "ord", { ord });
-    return ord;
-}
-
-const registerORDCompileTarget = () => {
-    Object.defineProperty(cds.compile.to, "ord", {
-        get: _lazyRegisterCompileTarget,
-        configurable: true,
-    });
-};
-
-registerORDCompileTarget();
+Object.defineProperty(cds.compile.to, "ord", {
+    configurable: true,
+    get: () => (model) => require("./lib/index").ord(model, []),
+});

package/lib/auth/mtls-endpoint-service.js

@@ -5,7 +5,7 @@
  * from external configuration endpoints and merge with static configuration.
  */
 
-/* global AbortController */
+/* global AbortController */ // eslint-disable-line no-redeclare
 
 const { HTTP_CONFIG } = require("../constants");
 

package/lib/build.js

@@ -6,6 +6,7 @@ const cliProgress = require("cli-progress");
 
 const os = require("os");
 const { ord } = require("./index");
+const registerCompileTargets = require("./common/register-compile-targets");
 const { BUILD_DEFAULT_PATH, ORD_DOCUMENT_FILE_NAME } = require("./constants");
 
 module.exports = class OrdBuildPlugin extends cds.build.Plugin {
@@ -16,13 +17,7 @@ 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 afterward, 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();
-        }
+        registerCompileTargets();
 
         return this.model()
             .then((model) => ({ model, document: ord(model) }))

package/lib/common/register-compile-targets.js

@@ -0,0 +1,31 @@
+const cds = require("@sap/cds");
+const Logger = require("../logger");
+
+const PROTOCOL_PROVIDERS = Object.freeze({
+    ["@cap-js/mcp"]: "mcp",
+    ["@cap-js/graphql"]: "graphql",
+});
+
+module.exports = () => {
+    // Plugins like @cap-js/mcp and @cap-js/graphql register protocols and compile targets
+    // at runtime via cds-plugin.js, but cds build rebuilds cds.env afterward, losing both
+    // registrations. Re-apply so that compilation works accordingly during build and runtime.
+
+    Object.keys(cds.env.plugins || {})
+        .filter((plugin) => plugin !== "@cap-js/ord")
+        .forEach((plugin) => {
+            try {
+                const protocol = PROTOCOL_PROVIDERS[plugin];
+
+                require(`${plugin}/lib/api`)?.registerCompileTargets?.();
+                cds.env.protocols = {
+                    ...cds.env.protocols,
+                    ...(!protocol || cds.env.protocols?.[protocol]
+                        ? {}
+                        : { [protocol]: { path: `/${protocol}`, impl: plugin } }),
+                };
+            } catch (error) {
+                Logger.warn(`Failed to register compile targets for ${plugin}: ${error}`);
+            }
+        });
+};

package/lib/{extendOrdWithCustom.js → extend-ord-with-custom.js}

@@ -62,13 +62,7 @@ function getCustomORDContent(appConfig) {
     return require(pathToCustomORDContent);
 }
 
-function extendCustomORDContentIfExists(appConfig, ordContent) {
-    const customORDContent = getCustomORDContent(appConfig);
-    return customORDContent
-        ? compareAndHandleCustomORDContentWithExistingContent(ordContent, customORDContent)
-        : ordContent;
-}
-
 module.exports = {
-    extendCustomORDContentIfExists,
+    getCustomORDContent,
+    compareAndHandleCustomORDContentWithExistingContent,
 };

package/lib/index.js

@@ -7,5 +7,5 @@
  */
 module.exports = {
     ord: require("./ord.js"),
-    getMetadata: require("./metaData.js"),
+    getMetadata: require("./meta-data.js"),
 };

package/lib/{interopCsn.js → interop-csn.js}

@@ -73,7 +73,7 @@ function remove_localized_assoc(csn) {
     // - name is "localized"
     // - type is "cds.Association"
     // - target name is source name + ".texts"
-    // - there is an ON condition 
+    // - there is an ON condition
     for (let n1 in csn.definitions) {
         let def = csn.definitions[n1];
         if (def.kind === "entity")
@@ -141,7 +141,7 @@ function add_meta_info(csn) {
     for (let k in csn.meta) {
         if (!["flavor", "document", "features"].includes(k) && !k.startsWith("__")) {
             delete csn.meta[k];
-        } 
+        }
     }
     csn.meta.flavor = "effective";
 
@@ -165,5 +165,5 @@ function add_meta_info(csn) {
 }
 
 module.exports = {
-    interopCSN,
+    interopCSN
 };

package/lib/meta-data.js

@@ -0,0 +1,90 @@
+const path = require("path");
+const cds = require("@sap/cds/lib");
+const assert = require("node:assert");
+const cdsc = require("@sap/cds-compiler/lib/main");
+const { compile: openapi } = require("@cap-js/openapi");
+const { compile: asyncapi } = require("@cap-js/asyncapi");
+
+const Logger = require("./logger");
+const { interopCSN } = require("./interop-csn.js");
+const { COMPILER_TYPES, OPENAPI_SERVERS_ANNOTATION } = require("./constants");
+
+function extractServiceName(url) {
+    return path.basename(url, ".json").split(".").slice(0, -1).join(".");
+}
+
+function extractCompilerType(url) {
+    return path.basename(url, ".json").split(".").pop();
+}
+
+const compilers = Object.freeze({
+    [COMPILER_TYPES.csn]: function (csn, options) {
+        return {
+            contentType: "application/json",
+            response: interopCSN(
+                cdsc.for.effective(csn, { beta: { effectiveCsn: true }, effectiveServiceName: options.service }),
+            ),
+        };
+    },
+    [COMPILER_TYPES.mcp]: async function (csn, options) {
+        return {
+            contentType: "application/json",
+            response: cds.compile(csn).to["mcp"]({ ...options, ...(cds.env.ord?.compileOptions?.mcp || {}) }),
+        };
+    },
+    [COMPILER_TYPES.oas3]: function (csn, options) {
+        // Check for service-level @OpenAPI.servers annotation
+        const servers = csn?.definitions?.[options.service]?.[OPENAPI_SERVERS_ANNOTATION];
+        const openapiOptions = { ...options, ...(cds.env?.ord?.compileOptions?.openapi || {}) };
+
+        // Service-level annotation takes precedence over global config
+        if (Array.isArray(servers) && servers.length) {
+            openapiOptions["openapi:servers"] = JSON.stringify(servers);
+        }
+
+        return {
+            contentType: "application/json",
+            response: openapi(csn, openapiOptions),
+        };
+    },
+    [COMPILER_TYPES.edmx]: function (csn, options) {
+        return {
+            contentType: "application/xml",
+            response: cds
+                .compile(csn)
+                .to["edmx"]({ ...options, ...(cds.env?.ord?.compileOptions?.edmx || {}) }),
+        };
+    },
+    [COMPILER_TYPES.graphql]: function (csn, options) {
+        const { generateSchema4 } = require("@cap-js/graphql/lib/schema");
+        const { printSchema, lexicographicSortSchema } = require("graphql");
+        const srv = new cds.ApplicationService(options.service, cds.linked(csn));
+
+        return {
+            contentType: "text/plain",
+            response: printSchema(lexicographicSortSchema(generateSchema4({ [options.service]: srv }))),
+        };
+    },
+    [COMPILER_TYPES.asyncapi2]: function (csn, options) {
+        return {
+            contentType: "application/json",
+            response: asyncapi(csn, { ...options, ...(cds.env?.ord?.compileOptions?.asyncapi || {}) }),
+        };
+    },
+});
+
+module.exports = async (url, model = null) => {
+    const name = extractServiceName(url);
+    const type = extractCompilerType(url);
+    const csn = model || cds.services[name]?.model;
+    const options = { service: name, as: "str", messages: [] };
+
+    assert(Object.hasOwn(compilers, type), `Unsupported format: ${type}`);
+
+    try {
+        return await compilers[type](csn, options);
+    } catch(error) {
+        Logger.error(`Compilation failed for service ${name} (compiler: ${type}) - ${error.message}`);
+        throw error;
+    }
+};

package/lib/ord.js

@@ -13,8 +13,11 @@ const {
     createGroupsTemplateForService,
     _propagateORDVisibility,
 } = require("./templates");
-const { getIntegrationDependencies } = require("./integrationDependency");
-const { extendCustomORDContentIfExists } = require("./extendOrdWithCustom");
+const { getIntegrationDependencies } = require("./integration-dependency");
+const {
+    getCustomORDContent,
+    compareAndHandleCustomORDContentWithExistingContent,
+} = require("./extend-ord-with-custom");
 const { getRFC3339Date } = require("./date");
 const { createAuthConfig } = require("./auth/authentication");
 
@@ -321,7 +324,7 @@ function _filterUnusedPackages(ordDocument) {
     return ordDocument.packages.filter((pkg) => usedPackageIds.has(pkg.ordId));
 }
 
-module.exports = (csn) => {
+module.exports = (csn, extensions = []) => {
     const linkedCsn = _propagateORDVisibility(cds.linked(csn));
     const appConfig = initializeAppConfig(linkedCsn);
 
@@ -358,7 +361,12 @@ module.exports = (csn) => {
         ordDocument.integrationDependencies = integrationDependencies;
     }
 
-    ordDocument = extendCustomORDContentIfExists(appConfig, ordDocument);
+    [...(extensions || []), getCustomORDContent(appConfig)]
+        .filter((extension) => !!extension)
+        .forEach((extension) => {
+            ordDocument = compareAndHandleCustomORDContentWithExistingContent(ordDocument, extension);
+        });
+
     ordDocument.packages = _filterUnusedPackages(ordDocument);
 
     return ordDocument;

package/lib/services/mtx-ord-provider-service.cds

@@ -0,0 +1,21 @@
+@protocol: 'rest'
+@requires: [ 'internal-user' ]
+@path: '/-/cds/ord-provider-service'
+@impl:'@cap-js/ord/lib/services/mtx-ord-provider-service.js'
+service cds.xt.ord.MtxOrdProviderService {
+
+  action getOrdDocument(
+    tenant    : String,
+    @cds.validate: false
+    toggles   : array of String,
+    for       : String enum { nodejs; java; },
+  ) returns {};
+
+  action getOrdResourceDefinition(
+    tenant    : String,
+    @cds.validate: false
+    toggles   : array of String,
+    for       : String enum { nodejs; java; },
+    resource  : String,
+  ) returns LargeString;
+}

package/lib/services/mtx-ord-provider-service.js

@@ -0,0 +1,39 @@
+const cds = require("@sap/cds/lib");
+const { ord, getMetadata } = require("@cap-js/ord/lib");
+
+module.exports = class MtxOrdProviderService extends cds.ApplicationService {
+    init() {
+        this.on("getOrdDocument", async (req) => {
+            req._?.res?.set("Content-Type", "application/json");
+
+            return ord(
+                await (
+                    await cds.connect.to("cds.xt.ModelProviderService")
+                ).getCsn({
+                    for: req.data.for,
+                    tenant: req.data.tenant,
+                    toggles: req.data.toggles,
+                }),
+            );
+        });
+
+        this.on("getOrdResourceDefinition", async (req) => {
+            const { response, contentType } = await getMetadata(
+                req.data.resource,
+                await (
+                    await cds.connect.to("cds.xt.ModelProviderService")
+                ).getCsn({
+                    for: req.data.for,
+                    tenant: req.data.tenant,
+                    toggles: req.data.toggles,
+                }),
+            );
+
+            req._?.res?.set("Content-Type", contentType);
+
+            return response;
+        });
+
+        return super.init();
+    }
+};

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

@@ -1,12 +1,21 @@
 const cds = require("@sap/cds");
-const ord = require("./ord.js");
-const compileMetadata = require("./metaData.js");
-const defaults = require("./defaults.js");
-const { createAuthConfig, createAuthMiddleware } = require("./auth/authentication.js");
-const Logger = require("./logger.js");
+
+const ord = require("../ord.js");
+const Logger = require("../logger.js");
+const defaults = require("../defaults.js");
+const compileMetadata = require("../meta-data.js");
+const { createAuthConfig, createAuthMiddleware } = require("../auth/authentication.js");
 
 class OpenResourceDiscoveryService extends cds.ApplicationService {
     async init() {
+        this.extensions = {};
+
+        cds.on("ord.extension.publish", ({ id, data }) => {
+            Logger.info(`Registering extension with id ${id}...`);
+
+            this.extensions[id] = data;
+        });
+
         // Initialize authentication configuration from .cdsrc.json or environment variables
         // CF mTLS validator is lazily initialized on first mTLS request
         const authConfig = createAuthConfig();
@@ -23,7 +32,7 @@ class OpenResourceDiscoveryService extends cds.ApplicationService {
 
         cds.app.get(`/ord/v1/documents/ord-document`, authMiddleware, async (_, res) => {
             const csn = cds.context?.model || cds.model;
-            const data = ord(csn);
+            const data = ord(csn, Array.from(Object.values(this.extensions)));
             return res.status(200).send(data);
         });
 

package/lib/threads/compile.js

@@ -1,6 +1,9 @@
 const { workerData } = require("piscina");
 
-const compileMetadata = require("../metaData");
+const compileMetadata = require("../meta-data");
+const registerCompileTargets = require("../common/register-compile-targets");
+
+registerCompileTargets(); // Worker threads skip cds-plugin.js — re-register compile targets
 
 module.exports = ({ url }) => {
     // JSON round-trip: CDS compiler output may contain Generator objects

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cap-js/ord",
-    "version": "1.5.0",
+    "version": "1.6.0",
     "description": "CAP Plugin for generating ORD document.",
     "repository": "cap-js/ord",
     "author": "SAP SE (https://www.sap.com)",
@@ -34,7 +34,7 @@
         "eslint": "^10.0.0",
         "express": "^4",
         "jest": "^30.0.0",
-        "prettier": "3.8.1",
+        "prettier": "3.8.3",
         "supertest": "^7.0.0"
     },
     "peerDependencies": {
@@ -49,18 +49,23 @@
         "piscina": "^5.1.4"
     },
     "engines": {
-        "node": ">=18 <23"
+        "node": ">=20 <25"
     },
     "overrides": {
-        "@sap/cds-compiler": "6.7.3"
+        "@sap/cds-compiler": "6.9.0"
     },
     "cds": {
         "requires": {
             "SAP ORD Service": {
-                "model": "@cap-js/ord/lib/ord-service"
+                "model": "@cap-js/ord/lib/services/ord-service"
             },
             "[java]": {
                 "SAP ORD Service": false
+            },
+            "[mtx-sidecar]": {
+                "SAP ORD Service": {
+                    "model": "@cap-js/ord/lib/services/mtx-ord-provider-service"
+                }
             }
         }
     }

package/lib/metaData.js

@@ -1,108 +0,0 @@
-const cds = require("@sap/cds/lib");
-const { compile: openapi } = require("@cap-js/openapi");
-const { compile: asyncapi } = require("@cap-js/asyncapi");
-const { COMPILER_TYPES, OPENAPI_SERVERS_ANNOTATION } = require("./constants");
-const Logger = require("./logger");
-const { interopCSN } = require("./interopCsn.js");
-const cdsc = require("@sap/cds-compiler/lib/main");
-
-/**
- * Read @OpenAPI.servers annotation from service definition
- * @param {object} csn - The CSN model
- * @param {string} serviceName - The service name
- * @returns {string|undefined} - JSON string of servers array or undefined
- */
-const _getServersFromAnnotation = (csn, serviceName) => {
-    const servers = csn?.definitions?.[serviceName]?.[OPENAPI_SERVERS_ANNOTATION];
-    const isValidServers = Array.isArray(servers) && servers.length > 0;
-    return isValidServers ? JSON.stringify(servers) : undefined;
-};
-
-const getMetadata = async (url, model = null) => {
-    const parts = url
-        ?.split("/")
-        .pop()
-        .replace(/\.json$/, "")
-        .split(".");
-    const compilerType = parts.pop();
-    const serviceName = parts.join(".");
-    const csn = model || cds.services[serviceName]?.model;
-    const compileOptions = cds.env["ord"]?.compileOptions || {};
-
-    let responseFile;
-    const options = { service: serviceName, as: "str", messages: [] };
-    switch (compilerType) {
-        case COMPILER_TYPES.oas3:
-            try {
-                // Check for service-level @OpenAPI.servers annotation
-                const serversFromAnnotation = _getServersFromAnnotation(csn, serviceName);
-                const openapiOptions = { ...options, ...(compileOptions?.openapi || {}) };
-
-                // Service-level annotation takes precedence over global config
-                if (serversFromAnnotation) {
-                    openapiOptions["openapi:servers"] = serversFromAnnotation;
-                }
-
-                responseFile = openapi(csn, openapiOptions);
-            } catch (error) {
-                Logger.error(`OpenApi error for service ${serviceName} - ${error.message}`);
-                throw error;
-            }
-            break;
-        case COMPILER_TYPES.asyncapi2:
-            try {
-                responseFile = asyncapi(csn, { ...options, ...(compileOptions?.asyncapi || {}) });
-            } catch (error) {
-                Logger.error(`AsyncApi error for service ${serviceName} - ${error.message}`);
-                throw error;
-            }
-            break;
-        case COMPILER_TYPES.csn:
-            try {
-                const opt_eff = { beta: { effectiveCsn: true }, effectiveServiceName: serviceName };
-                let effCsn = cdsc.for.effective(csn, opt_eff);
-                responseFile = interopCSN(effCsn);
-            } catch (error) {
-                Logger.error(`Csn error for service ${serviceName} - ${error.message}`);
-                throw error;
-            }
-            break;
-        case COMPILER_TYPES.edmx:
-            try {
-                responseFile = await cds.compile(csn).to["edmx"]({ ...options, ...(compileOptions?.edmx || {}) });
-            } catch (error) {
-                Logger.error(`Edmx error for service ${serviceName} - ${error.message}`);
-                throw error;
-            }
-            break;
-        case COMPILER_TYPES.mcp:
-            try {
-                responseFile = await cds.compile(csn).to["mcp"]({ ...options, ...(compileOptions?.mcp || {}) });
-            } catch (error) {
-                Logger.error("MCP 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:
-            compilerType === "graphql" ? "text/plain" : `application/${compilerType === "edmx" ? "xml" : "json"}`,
-        response: responseFile,
-    };
-};
-
-module.exports = getMetadata;