Welcome to @cap-js/event-broker

About this project

CDS plugin providing integration with SAP Cloud Application Event Hub (technical name: event-broker).

Table of Contents

• About this project
• Requirements
• Setup
• Support, Feedback, Contributing
• Code of Conduct
• Licensing

Requirements

See Getting Started on how to jumpstart your development and grow as you go with SAP Cloud Application Programming Model (CAP). To learn about messaging in CAP, please consult the guide on Events & Messaging.

Setup

Install the plugin via:

npm add @cap-js/event-broker

Then, set the kind of your messaging service to event-broker:

"cds": {
  "requires": {
    "messaging": {
      "kind": "event-broker"
    }
  }
}

The CloudEvents format is enforced since it is required by SAP Cloud Application Event Hub.

Authentication in the SAP Cloud Application Event Hub integration is based on the Identity Authentication service (IAS) of SAP Cloud Identity Services. If you are not using IAS-based Authentication, you will need to trigger the loading of the IAS credentials into your app's cds.env via an additional requires entry:

"cds": {
  "requires": {
    "ias": { // any name
      "vcap": {
        "label": "identity"
      }
    }
  }
}

For more information, please see SAP Cloud Application Event Hub in SAP Help Portal.

Parameters

webhookSizeLimit

To set a size limit for events accepted by the webhook, set the webhookSizeLimitparameter in the package.json file in the root folder of your app, e.g.

"cds": {
  "requires": {
    "messaging": {
      "kind": "event-broker",
      "webhookSizeLimit": "1mb"
    }
  }
}

If the parameter is not set, the global request body size limit cds.env.server.body_parser.limit is taken into account. If this parameter is not set either, the default value of 1mbis used.

Support, Feedback, Contributing

This project is open to feature requests/suggestions, bug reports etc. via GitHub 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.

Security / Disclosure

If you find any bug that may be a security problem, please follow our instructions at in our 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 at all times.

Licensing

Copyright 2024 SAP SE or an SAP affiliate company and event-broker contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.