@cap-js/ord 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/LICENSES/Apache-2.0.txt

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,66 @@
+[![REUSE status](https://api.reuse.software/badge/github.com/cap-js/ord)](https://api.reuse.software/info/github.com/cap-js/cds-plugin-for-ord)
+
+# CDS Plugin for ORD
+
+## About this project
+
+This plugin enables generation of ORD document for CAP based applications. When you adopt ORD, your application gains a single entry point, known as the Service Provider Interface. This interface allows you to discover and gather relevant information or metadata. You can use this information to construct a static metadata catalog or to perform a detailed runtime inspection of your actual system landscapes.
+
+Open Resource Discovery [(ORD)](https://sap.github.io/open-resource-discovery/) is a protocol that enables applications and services to self-describe their available resources and capabilities. It's not only useful for describing static documentation, but it also accurately reflects tenant-specific configurations and extensions at runtime. Typically, ORD is used to describe APIs and Events, but it also supports higher-level concepts like Entity Types (Business Objects) and Data Products (beta).
+
+## Requirements and Setup
+
+### Installation
+
+```sh
+npm install @cap-js/ord
+```
+
+### Usage
+
+#### Programmatic API
+
+```js
+const cds = require('@sap/cds')
+```
+
+```js
+const csn = await cds.load(cds.env.folders.srv)
+const ord = cds.compile.to.ord(csn)
+```
+
+#### Command Line
+
+```sh
+cds compile <path to srv folder> --to ord [-o] [destinationFilePath]
+```
+
+<img width="1300" alt="Sample Application Demo" style="border-radius:0.5rem;" src="./asset/etc/ordCLI.png">
+
+#### ORD Endpoints
+
+1) Run `cds watch` in the application's root.
+2) Check the following relative paths for ORD information - `/.well-known/open-resource-discovery` , `/open-resource-discovery/v1/documents/1`.
+
+
+<img width="1300" alt="Sample Application Demo" style="border-radius:0.5rem;" src="./asset/etc/ordEndpoint.gif">
+
+### Customizing ORD Document
+
+You can find more information, such as how to customize the ORD Document, in this [document](ord.md).
+
+
+## Support, Feedback, Contributing
+
+This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/ord/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
+
+## Security / Disclosure
+If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/cap-js/ord/issues/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
+
+## Code of Conduct
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/cap-js/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
+
+## Licensing
+
+Copyright 2024 SAP SE or an SAP affiliate company and cds-plugin-for-ord contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/<your-project>).

package/data/well-known.json

@@ -0,0 +1,14 @@
+{
+    "openResourceDiscoveryV1": {
+        "documents": [
+            {
+                "url": "/open-resource-discovery/v1/documents/1",
+                "accessStrategies": [
+                    {
+                        "type": "open"
+                    }
+                ]
+            }
+        ]
+    }
+}

package/lib/defaults.js

@@ -0,0 +1,75 @@
+
+const regexWithRemoval = (name) => {
+  return name.replace(/[^a-zA-Z0-9]/g,'');
+}
+const regexWithUnderScore = (name) => {
+  return regexWithRemoval(name.charAt(0)) + name.slice(1, name.length).replace(/[^a-zA-Z0-9]/g,'_');
+}
+
+/**
+ * Module containing default configuration for ORD Document.
+ * @module defaults
+ */
+module.exports = {
+  openResourceDiscovery: "1.9",
+  policyLevel: "none",
+  description: "this is an application description",
+  products: (name) => [
+    { 
+      ordId: `customer:product:${regexWithUnderScore(name)}:`,
+      title: `ORD App Title for ${regexWithRemoval(name)}`,
+      shortDescription: " shortDescription for products",
+      vendor: "customer:vendor:SAPCustomer:",
+    },
+  ],
+  groupTypeId: "sap.cds:service", 
+  packages: function getPackageData (name, policyLevel,capNamespace) {
+    function createPackage(name, tag) {
+      return {
+        ordId: `${regexWithRemoval(name)}:package:${capNamespace}${tag}`,
+        title: `sample title for ${regexWithRemoval(name)}`,
+        shortDescription: "Here is the shortDescription for packages",
+        description: "Here is the description for packages",
+        version: "1.0.0",
+        partOfProducts: [`customer:product:${regexWithUnderScore(name)}:`],
+        vendor: "customer:vendor:SAP:"
+      };
+    }
+    
+    if(policyLevel.split(':')[0].toLowerCase() === 'sap') {
+        return [createPackage(name, "-api:v1"), createPackage(name, "-event:v1")];
+    }
+    else {
+        return [createPackage(name, ":v1")];
+    }
+  },
+  consumptionBundles: (name) => [
+    {
+      ordId: `${regexWithRemoval(name)}:consumptionBundle:unknown:v1`,
+      version: "1.0.0",
+      title: "Unprotected resources",
+      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",
+    },
+  ],
+ 
+    apiResources: [],
+    eventResources: [],
+    entityTypes: [],
+    baseTemplate : {
+        openResourceDiscoveryV1: {
+            documents: [
+                {
+                    url: "/open-resource-discovery/v1/documents/1",
+                    accessStrategies: [
+                        {
+                            type: "open",
+                        },
+                    ],
+                },
+            ],
+        },
+    }
+}

package/lib/index.js

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

package/lib/metaData.js

@@ -0,0 +1,45 @@
+const cds = require('@sap/cds/lib');
+const { compile : openapi } = require('@cap-js/openapi')
+const { compile : asyncapi } = require('@cap-js/asyncapi');
+
+/**
+ * Retrieves the compiled meta data for the specific service or event according to its compiled type
+ * @param {string} data 
+ * @returns {string, JSON|XML} contentType, response 
+ */
+module.exports = async (data) => {
+    const parts = data?.split("/").pop().replace(/\.json$/, '').split(".");
+    const compilerType = parts.pop();
+    const serviceName = parts.join(".");
+    const csn = cds.services[serviceName].model;
+
+    let responseFile; 
+    const options = { service: serviceName, as: 'str', messages: [] }
+    if (compilerType === "oas3") {
+        try {
+            responseFile = openapi(csn, options);
+        } catch (error) {
+            console.error("OpenApi error:", error.message);
+            throw error;
+        }
+    } else if (compilerType === "asyncapi2") {
+        try {
+            responseFile = asyncapi(csn, options);
+        } catch (error) {
+            console.error("AsyncApi error:", error.message);
+            throw error;
+        }
+    } else if (compilerType === "edmx") {
+        try {
+            responseFile = await cds.compile(csn).to["edmx"](options);
+        } catch (error) {
+            console.error("Edmx error:", error.message);
+            throw error;
+        }
+    }
+
+    return {
+        contentType: `application/${compilerType === "edmx" ? "xml" : "json"}`,
+        response: responseFile
+    };
+}

package/lib/ord.js

@@ -0,0 +1,202 @@
+const path = require("path");
+const cds = require("@sap/cds");
+const { exists } = cds.utils;
+const defaults = require("./defaults");
+const {
+    fCreateAPIResourceTemplate,
+    fCreateEventResourceTemplate,
+    fCreateGroupsTemplateForService,
+    fCreateGroupsTemplateForEvent,
+    fCreateEntityTypeTemplate
+} = require('./templates');
+
+/**
+ * Initializes global object based on package.json and CSN object.
+ * @param {Object} csn object
+ * @returns {Object} An object containing global variables.
+ */
+const fInitializeGlobal = (csn) => {
+    let packagejsonPath = path.join(cds.root,'package.json')
+    let packageJson;
+    if (exists(packagejsonPath)) {
+        packageJson = require(packagejsonPath);
+    } else {
+        throw new Error(`package.json not found in the project root directory`);
+    }
+    const appName = packageJson.name.replace(/^[@]/, "").replace(/[@/]/g, "-");
+    const aModelKeys = Object.keys(csn.definitions);
+    const aEvents = [];
+    const aServices = [];
+    const aODMEntity = [];
+    
+    const capNamespace = csn.namespace;
+     // namespace variable value if present in cdsrc.json take it there or else from package.json
+    //if cdsrc.json does not have applicationNamespace, then use just the namespace
+    const namespace = cds.env["ord"]?.namespace || `customer.${appName}`;
+    const applicationNamespace = cds.env?.export?.asyncapi?.applicationNamespace;
+    
+    if (applicationNamespace && fGetNamespaceComponents(namespace) !== fGetNamespaceComponents(applicationNamespace)) {
+        console.warn('ORD and AsyncAPI namespaces should be the same.');
+    }
+
+    const fEventFilter = (keyDefinition) => keyDefinition.kind === "event";
+    const fServicesFilter = (keyDefinition) => keyDefinition.kind === "service" && !keyDefinition['@cds.external'];
+    const fODMEntityFilter = (key, keyDefinition) => {
+        return keyDefinition.kind === "entity"
+            && key.includes(capNamespace)
+            && !key.includes(".texts")
+            && keyDefinition["@ODM.entityName"];
+    }
+
+    aModelKeys.forEach((key) => {
+        const keyDefinition = csn.definitions[key];
+        if(fServicesFilter(keyDefinition)){
+            aServices.push(key);
+        } else if(fODMEntityFilter(key, keyDefinition)) {
+            aODMEntity.push(fCreateEntityTypeTemplate(keyDefinition));
+        } else if(fEventFilter(keyDefinition)){
+            aEvents.push(key);
+        }
+    });
+
+
+    return {
+        env: cds.env["ord"],
+        capNamespace,
+        appName,
+        aEvents,
+        aServices,
+        aODMEntity,
+        namespace,
+        applicationNamespace
+    }
+}
+
+/**
+ * Retrieves first two components of the namespace.
+ * @param {string} namespace
+ * @returns {string} The first two components of the namespace.
+ */
+const fGetNamespaceComponents = (namespace) => namespace.split('.').slice(0, 2).join('.');
+
+/**
+ * Retrieves the policy level.
+ * Hierarchy to check data: cdsrc.json > defaults
+ * @returns {string} The policy level.
+ */
+const fGetPolicyLevel = (global) => global.env?.policyLevel || defaults.policyLevel;
+
+/**
+ * Retrieves the root level ORD document description.
+ * Hierarchy to check data: cdsrc.json > defaults
+ * @returns {string} The ORD document description.
+ */
+const fGetDescription = (global) => global.env?.description || defaults.description;
+
+/**
+ * Retrieves the products.
+ * Hierarchy to check data: cdsrc.json > defaults
+ * @returns {Array<object>} The products array.
+ * if global.namespace is defined in cdsrc.json, then use it, else use the appName from package.json
+ */
+const fGetProducts = (global) => global.env?.products || defaults.products(global.namespace);
+
+/**
+ * Retrieves the groups that services belongs to.
+ * Gets list of groups from CDS runtime object.
+ * @param {Object} csn object 
+ * @returns {Array<object>} The groups array.
+ */
+const fGetGroups = (csn, global) => {
+    // storing the group ids in a set to avoid duplicates
+    let groupIds = new Set();
+
+    let serviceGroups = global.aServices
+            .map((srv) => fCreateGroupsTemplateForService(srv, csn.definitions[srv], groupIds))
+            .filter((resource) => resource !== null && resource !== undefined);
+    let eventGroups = global.aEvents
+            .map((event) => fCreateGroupsTemplateForEvent(event, csn.definitions[event], groupIds))
+            .filter((resource) => resource !== null && resource !== undefined);
+
+    return [...serviceGroups, ...eventGroups];
+};
+
+/**
+ * Retrieves the packages.
+ * Hierarchy to check data: cdsrc.json > defaults
+ * @returns {Array<object>} The packages array.
+ */
+const fGetPackages = (policyLevel,global) => global.env?.packages || (global.aEvents.length) ? defaults.packages(global.namespace,policyLevel,global.capNamespace) : defaults.packages(global.namespace,policyLevel,global.capNamespace).slice(0, 1)
+
+/**
+ * Retrieves the consumption bundles.
+ * Hierarchy to check data: cdsrc.json > defaults
+ * @returns {Array<object>} The consumption bundles array.
+ */
+const fGetConsumptionBundles = (global) => global.env?.consumptionBundles || (global.aEvents.length) ? defaults.consumptionBundles(global.capNamespace) : defaults.consumptionBundles(global.capNamespace).slice(0,1)
+
+/**
+ * Retrieves the API Resources
+ * Gets list of services from CSN object
+ * @param {Object} csn object
+ * @returns {Array<object>} The API Resources array.
+ */
+const fGetAPIResources = (csn, global,packageIds) => {
+  const apiResources = [];
+  global.aServices.forEach((srv) => {
+    fCreateAPIResourceTemplate(srv, csn.definitions[srv], global,packageIds)?.forEach(
+      (resource) => {
+        if (resource !== null && resource !== undefined) {
+          apiResources.push(resource);
+        }
+      }
+    );
+  });
+  return apiResources;
+};
+
+/**
+ * Retrieves the Event Resources
+ * Gets list of event from CSN object
+ * @param {Object} csn object
+ * @returns {Array<object>} The Event Resources array.
+ */
+const fGetEventResources = (csn, global,packageIds) => global.aEvents.map((srv) => fCreateEventResourceTemplate(srv, csn.definitions[srv], global, packageIds)).filter((resource) => resource !== null && resource !== undefined);
+
+module.exports = (csn) => {
+    const linkedCsn = cds.linked(csn);
+    Object.assign(global, fInitializeGlobal(linkedCsn));
+    const validateSystemNamespace = new RegExp(`^${global.applicationNamespace}\\.[^.]+\\..+$`);
+    if (global.namespace === undefined && !validateSystemNamespace.test(global.namespace)) {
+        let error = new Error(`Namespace is not defined in cdsrc.json or it is not in the format of ${global.applicationNamespace}.<appName>.<service>`);
+        console.error('Namespace error:', error.message);
+        throw error;
+    }
+
+    let oReturn = {openResourceDiscovery: "1.9",
+        policyLevel: fGetPolicyLevel(global),
+        description: fGetDescription(global),
+        products: fGetProducts(global),
+        groups: fGetGroups(linkedCsn, global),
+    };
+    if(fGetAPIResources(linkedCsn, global).length > 0 && (fGetEventResources(linkedCsn, global).length>0)){
+        oReturn.packages = fGetPackages(oReturn.policyLevel, global);
+    }
+
+    // check if oReturn.packages is defined and extract the ordId from the packages and store in a set
+    let packageIds = new Set();
+    if(oReturn.packages){
+        oReturn.packages.forEach((pkg) => {
+            packageIds.add(pkg.ordId);
+        });
+    }
+    oReturn = {
+        ...oReturn,
+        consumptionBundles: fGetConsumptionBundles(global),
+        apiResources: fGetAPIResources(linkedCsn, global,packageIds),
+    };
+    if(fGetEventResources(linkedCsn, global,packageIds).length > 0) {
+        oReturn.eventResources= fGetEventResources(linkedCsn, global,packageIds);
+    }
+    return oReturn;
+}

package/lib/plugin.js

@@ -0,0 +1,33 @@
+const { ord, getMetadata, defaults } = require("./");
+const cds = require("@sap/cds");
+
+cds.on("bootstrap", (app) => {
+  app.use("/.well-known/open-resource-discovery", async (req, res) => {
+    if (req.url === "/") {
+      res.status(200).send(defaults.baseTemplate);
+    } else {
+      try {
+        const { contentType, response } = await getMetadata(req.url);
+        res.status(200).contentType(contentType).send(response);
+      } catch (error) {
+        console.log(error);
+        console.log('Error while generating metadata');
+        res.status(500).send(error.message);
+      }
+    }
+  });
+
+  app.get("/open-resource-discovery/v1/documents/1", async (req, res) => {
+    try {
+      const csn = await cds.load(cds.env.folders.srv);
+      const data = ord(csn);
+      return res.status(200).send(data);
+    } catch (error) {
+      console.log(error);
+      console.log('Error while creating ORD document');
+      return res.status(500).send(error.message);
+    }
+  });
+});
+
+module.exports = cds.server;

package/lib/templates.js

@@ -0,0 +1,354 @@
+const defaults = require("./defaults");
+const cds = require("@sap/cds");
+const fReplaceSpecialCharacters = (namespace) => {
+  return namespace.replace(/customer\.(.+)/, (match, group1) => 'customer.' + group1.replace(/[^a-zA-Z0-9]/g, ''))
+}
+
+/**
+ * Reads the ORD (Open Resource Discovery) annotation from a given service definition object and returns them as an object.
+ *
+ * @param {Object} srv The service definition object.
+ * @returns {Object} An object containing ORD annotation.
+ */
+const fReadORDExtensions = (srv) =>
+  Object.entries(srv)
+    .filter(([key]) => key.startsWith("@ORD.Extensions."))
+    .reduce(
+      (ordExtensions, [key, value]) => ({
+        ...ordExtensions,
+        [key.slice("@ORD.Extensions.".length)]: value,
+      }),
+      {}
+    );
+
+/**
+ * Reads the service definition and returns an array of entryPoint paths.
+ *
+ * @param {string} srv The service definition name.
+ * @param {Object} srvDefinition The service definition object.
+ * @returns {Array} An array containing paths and it's kind.
+ */
+
+const fGeneratePaths = (srv, srvDefinition) => {
+  const srvObj = { name: srv, definition: srvDefinition };
+  const protocols = cds.service.protocols;
+
+  const paths = protocols.endpoints4(srvObj);
+
+  //TODO: check graphql replication in paths object and re-visit logic
+  //removing instances of graphql protocol from paths
+  for (var index = paths.length - 1; index >= 0; index--) {
+    if (paths[index].kind === "graphql") {
+      console.warn("Graphql protocol is not supported.");
+      paths.splice(index, 1);
+    }
+  }
+
+  //putting default as odata in case no supported protcol is there
+  if (paths.length === 0) {
+    srvDefinition["@odata"] = true;
+    paths.push({ kind: "odata", path: protocols.path4(srvDefinition) });
+  }
+
+  return paths;
+};
+
+/**
+ * This is a template function to create Entity Type object for Entity Type Array.
+ *
+ * @param {string} entity The name of the entity.
+ * @returns {Object} An object for the entity type.
+ */
+const fCreateEntityTypeTemplate = (entity) => ({
+  ordId: `sap.odm:entityType:${entity["@ODM.entityName"]}:v1`,
+});
+
+/**
+ * This is a template function to form the group id.
+ * 
+ * @param {string} fullyQualifiedName The fully qualified name of the service or event.
+ * @param {string} groupTypeId The group type id.
+ * @returns {string} a group id.
+ */
+function _getGroupID(fullyQualifiedName, groupTypeId = defaults.groupTypeId, isService = true) {
+    if (isService) {
+        return `${groupTypeId}:${fReplaceSpecialCharacters(global.namespace)}:${fullyQualifiedName}`;
+    } else {
+        return `${groupTypeId}:${fReplaceSpecialCharacters(global.namespace)}:` +
+                `${fullyQualifiedName.slice(0, fullyQualifiedName.lastIndexOf("."))}`;
+    }
+}
+
+
+/**
+ * This is a function to resolve the title of the service group.
+ * 
+ * @param {string} srv The name of the service.
+ * @returns {string} The title of the service group.
+ */
+function _getTitleFromServiceName(srv) {
+    let serviceName = srv.substring(srv.lastIndexOf(".") + 1);
+    let index = serviceName.indexOf("Service");
+    if (index >= 0) {
+        return `${serviceName.substring(0, index)} Service Title`;
+    } else {
+        return `${serviceName} Service Title`;
+    }
+}
+
+
+/**
+ * This is a template function to create group object of a service for groups array in ORD doc.
+ * 
+ * @param {string} srv The name of the service.
+ * @param {object} srvDefinition The definition of the service
+ * @param {Set} groupIds A set of group ids.
+ * @returns {Object} A group object.
+ */
+const fCreateGroupsTemplateForService = (srv, srvDefinition, groupIds) => {
+    const ordExtensions = fReadORDExtensions(srvDefinition);
+
+    let fullyQualifiedServiceName = srv;
+    if(!srv.includes(global.capNamespace)){
+      fullyQualifiedServiceName = global.capNamespace + "." + srv;
+    }
+
+    if (checkEntityFunctionAction(srvDefinition, global).length > 0) {
+      let groupId = _getGroupID(fullyQualifiedServiceName, defaults.groupTypeId);
+      if (groupIds.has(groupId)) {
+          return null;
+      } else {
+          groupIds.add(groupId);
+          return {
+              groupId: groupId,
+              groupTypeId: `${defaults.groupTypeId}`,
+              title: ordExtensions.title ?? _getTitleFromServiceName(srv)
+          };
+      }
+    }
+}
+
+/**
+ * 
+ * @param {string} event The name of the event. 
+ * @returns {string} The title of the event group.
+ */
+function _getEventTitle(event) {
+    let serviceName = event.substring(0, event.lastIndexOf("."));
+    return _getTitleFromServiceName(serviceName);
+}
+
+/**
+ * This is a template function to create group object of an event for groups array in ORD doc.
+ * 
+ * @param {string} event The name of the event.
+ * @param {object} eventDefinition The definition of the event.
+ * @param {Set} groupIds A set of group ids.
+ * @returns {Object} A group object.
+ */
+const fCreateGroupsTemplateForEvent = (event, eventDefinition, groupIds) => {
+    const ordExtensions = fReadORDExtensions(eventDefinition);
+
+    let fullyQualifiedEventName = event;
+    if(!event.includes(global.capNamespace)){
+      fullyQualifiedEventName = global.capNamespace + "." + event;
+    }
+
+    let groupId = _getGroupID(fullyQualifiedEventName, defaults.groupTypeId, global, false);
+    if (groupIds.has(groupId)) {
+        return null;
+    } else {
+        groupIds.add(groupId);
+        return {
+            groupId: groupId,
+            groupTypeId: `${defaults.groupTypeId}`,
+            title: ordExtensions.title ?? _getEventTitle(event)
+        };
+    }
+}
+
+/**
+ * This is a template function to create API Resource object for API Resource Array.
+ *
+ * @param {string} srv The name of the service.
+ * @param {object} srvDefinition The definition of the service
+ * @returns {Array} An array of objects for the API Resources.
+ */
+const fCreateAPIResourceTemplate = (srv, srvDefinition, global,packageIds) => {
+  const ordExtensions = fReadORDExtensions(srvDefinition);
+  const paths = fGeneratePaths(srv, srvDefinition);
+  const apiResources = [];
+
+  let srvName = srv;
+  if (!srvName.includes(global.capNamespace)) {
+    srvName = global.capNamespace + "." + srv;
+  }
+
+  if (checkEntityFunctionAction(srvDefinition, global).length > 0) {
+    paths.forEach((generatedPath) => {
+      let resourceDefinitions = [
+        {
+          type: "openapi-v3",
+          mediaType: "application/json",
+          url: `/.well-known/open-resource-discovery/v1/api-metadata/${srv}.oas3.json`,
+          accessStrategies: [{ type: "open" }],
+        },
+      ];
+
+      if (generatedPath.kind !== "rest") {
+        //edmx resource definition is not generated in case of 'rest' protocol
+        resourceDefinitions.push({
+          type: "edmx",
+          mediaType: "application/xml",
+          url: `/.well-known/open-resource-discovery/v1/api-metadata/${srv}.edmx`,
+          accessStrategies: [{ type: "open" }],
+        });
+      }
+
+      let obj = {
+        ordId: `${fReplaceSpecialCharacters(global.namespace)}:apiResource:${srvName}:v1`,
+        title:
+          ordExtensions.title ??
+          srvDefinition["@title"] ??
+          srvDefinition["@Common.Label"] ??
+          `The service is for ${srv}`,
+        shortDescription:
+          ordExtensions.shortDescription ??
+          `Here we have the shortDescription for ${srv}`,
+        description:
+          ordExtensions.description ??
+          srvDefinition["@Core.Description"] ??
+          `Here we have the description for ${srv}`,
+        version: ordExtensions.version ?? "1.0.0",
+        visibility: ordExtensions.visibility ?? "public",
+        partOfPackage: _getPackageID(global.capNamespace,packageIds,'api'),
+        partOfGroups: [_getGroupID(srvName, defaults.groupTypeId, global)],
+        releaseStatus: ordExtensions.active ?? "active",
+        partOfConsumptionBundles: [
+          {
+            ordId: `${fReplaceSpecialCharacters(global.namespace)}:consumptionBundle:noAuth:v1`,
+          },
+        ],
+        apiProtocol:
+          generatedPath.kind === "odata" ? "odata-v4" : generatedPath.kind,
+        resourceDefinitions: resourceDefinitions,
+        entryPoints: [generatedPath.path],
+        extensible: {
+          supported: ordExtensions["extensible.supported"] ?? "no",
+        },
+        entityTypeMappings: [{ entityTypeTargets: global.aODMEntity }],
+      };
+
+      apiResources.push(obj);
+    });
+  }
+  if (apiResources.length > 0) return apiResources;
+};
+
+/**
+ * This is a template function to create Event Resource object for Event Resource Array.
+ *
+ * @param {string} srv The name of the event.
+ * @param {object} srvDefinition The definition of the event.
+ * @returns {Object} An object for the Event Resource.
+ */
+const fCreateEventResourceTemplate = (srv, srvDefinition, global,packageIds) => {
+  const ordExtensions = fReadORDExtensions(srvDefinition);
+  let srvName = srv;
+  if(!srvName.includes(global.capNamespace)){
+    srvName = global.capNamespace + "." + srv;
+  }
+  return {
+    ordId: `${fReplaceSpecialCharacters(global.namespace)}:eventResource:${srvName}:v1`,
+    title:  ordExtensions.title ?? srvDefinition['@title'] ?? srvDefinition['@Common.Label'] ?? `ODM ${global.appName.replace(/[^a-zA-Z0-9]/g, '')} Events`,
+    shortDescription: ordExtensions.shortDescription ?? "Example ODM Event",
+    description:  ordExtensions.description ?? 
+                  srvDefinition['@description'] ?? srvDefinition['@Core.Description'] ??
+                  `This is an example event catalog that contains only a partial ODM ${global.appName} V1 event`,
+    version:  ordExtensions.version ?? "1.0.0",
+    releaseStatus:  ordExtensions.releaseStatus ?? "beta",
+    partOfPackage: _getPackageID(global.capNamespace,packageIds,'event'),
+    partOfGroups: [_getGroupID(srvName, defaults.groupTypeId, global, false)],
+    visibility: ordExtensions.visibility ?? "public",
+    resourceDefinitions: [
+      {
+        type: "asyncapi-v2",
+        mediaType: "application/json",
+        url: `/.well-known/open-resource-discovery/v1/api-metadata/${srvDefinition._service.name}.asyncapi2.json`,
+        accessStrategies: [
+          {
+            type: "open",
+          },
+        ],
+      },
+    ],
+    extensible: { supported: ordExtensions["extensible.supported"] ?? "no" },
+  };
+};
+
+
+/**
+ * This is a function to check whether entity is a function or action.
+ * @param {object} srvDefinition The definition of the event.
+ * @returns {Object} An object for the Event Resource.
+ */
+function checkEntityFunctionAction(srvDefinition, global) {
+  if (srvDefinition.entities) {
+    return srvDefinition.entities.map((entity) => {
+      return {
+        type: "entity",
+        name: entity.name,
+        entityType: entity.name,
+        entitySet: entity.name,
+        entityTypeMapping: `${global.namespace}:entityType:${entity.name}:v1`,
+        entitySetMapping: `${global.namespace}:entitySet:${entity.name}:v1`,
+      };
+    });
+  } else if (srvDefinition.actions) {
+    return srvDefinition.actions.map((action) => {
+      return {
+        type: "action",
+        name: action.name,
+        actionType: action.name,
+        actionMapping: `${global.namespace}:action:${action.name}:v1`,
+      };
+    });
+  } else if (srvDefinition.functions) {
+    return srvDefinition.functions.map((func) => {
+      return {
+        type: "function",
+        name: func.name,
+        functionType: func.name,
+        functionMapping: `${global.namespace}:function:${func.name}:v1`,
+      };
+    });
+  }
+}
+
+/**
+ * This is a function to get the corresponding package ordId mapped to the service.
+ */
+
+function _getPackageID(capNamespace, packageIds, apiOrEvent) {
+  if (packageIds instanceof Set) {
+    const packageArray = Array.from(packageIds);
+    
+    if (apiOrEvent === "api") {
+      const apiPackage = packageArray.find(pkg => pkg.includes("-api"));
+      if (apiPackage) return apiPackage;
+    } else if (apiOrEvent === "event") {
+      const eventPackage = packageArray.find(pkg => pkg.includes("-event"));
+      if (eventPackage) return eventPackage;
+    }
+    
+    return packageArray.find(pkg => pkg.includes(capNamespace));
+  }
+}
+
+module.exports = {
+  fCreateEntityTypeTemplate,
+  fCreateGroupsTemplateForService,
+  fCreateGroupsTemplateForEvent,
+  fCreateAPIResourceTemplate,
+  fCreateEventResourceTemplate,
+};

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@cap-js/ord",
+  "version": "1.0.0",
+  "description": "CAP Tool for generating ORD information",
+  "repository": "cap-js/ord",
+  "author": "SAP SE (https://www.sap.com)",
+  "homepage": "https://cap.cloud.sap/",
+  "license": "SEE LICENSE IN LICENSE",
+  "main": "./cds-plugin.js",
+  "files": [
+    "lib",
+    "data",
+    "LICENSES"
+  ],
+  "scripts": {
+    "lint": "npx eslint ."
+  },
+  "devDependencies": {
+    "eslint": "^8"
+  },
+  "peerDependencies": {
+    "@sap/cds": ">=7.6",
+    "@cap-js/asyncapi": "^1.0.0",
+    "@cap-js/openapi": "^1.0.2"
+  }
+}