To consume the SAP Cloud Integration APIs, you must install the SAP Cloud SDK and utilize the generated clients. It is necessary to properly configure tsconfig when using Typescript, which can be challenging as it may not always be compatible with your project.
Additionally, these files begin to appear in every project, leading to unnecessary boilerplate in many repositories within SAP projects.
Now you can simply run npm install ts-sap-cloud-odata-api-v2-client and start using the generated clients immediately without any stress.
Read more: https://sap.github.io/cloud-sdk/docs/js/getting-started
Process followed: https://sap.github.io/cloud-sdk/docs/js/features/odata/generate-client
Do not use the npm-package in a production environment as it is still in beta. The APIs and features covered have not changed in about two years, making them very stable.
The intention here is not to centralize all SAP CPI clients and maintain them into a micro-node module.
Regarding the npm package, you do not need to use it if it does not suit your needs. You can use the files in this repository as examples and copy the entire repository to your versioning system if you wish to make changes and tweaks. Any pull requests attempting to modify the generated code will not be accepted.
It's just a code that can be used as quick start, example and to be copied.
Use it wisely and do not rely on maintenance, just fork or clone it. So you can clone, open the project in any IDE and start playing with the sap-cloud-sdk-generator models.
This code was created with the help of the SAP Cloud SDK, there's no custom code or layers added to it. It's exactly the same output of using sap-cloud-sdk and generating clients from the odata package.
The benefits of this package depends on the use case, right now I'm using it to, so pay attention to the Disclaimer section above.
- Automate the ingestion of logs from OData into DataLog automatically.
- Write xslts in external IDEs like VSCode using unit tests for mappings, them using the api in CD pipeline to push these artifacts to low environment IFlows well tested and covered.
- Make it possible to create Pipeline for CI/CD that runs e2e automated and assert odata logs and also keep the IFlows external parameters commited using GitOps approach.
- Internaly, it's easy to apply security scans and fixes in a centralized generated code them a distribuided approach across all teams. If you don't scan generated code for issues you may ignore this item.
Clients were generated for the following APIs in Cloud Integration:
| Name | Version | Generated |
|---|---|---|
| IntegrationContent | 1.0.0 | Yes |
| LogFiles | 1.0.0 | Yes |
| MessageProcessingLogs | 1.0.0 | Yes |
| MessageStore | 1.0.0 | Yes |
| PartnerDirectory | 1.0.0 | Yes |
| SecurityContent | 1.0.0 | Yes |
npm i ts-sap-cloud-odata-api-v2-clientnpm i @sap-cloud-sdk/connectivity #required
npm i @sap-cloud-sdk/odata-v2 #optionalNow you can simply use the generated clients in your code. The entire interface was kept from the SDK, and you can refer to the documentation to learn more.
Each client is isolated in a module that can be imported using 'ts-sap-cloud-odata-api-v2-client/{APINAME}'.
This is necessary to avoid conflicts with other modules as they are all generated separately.
Example*
import { registerDestination } from '@sap-cloud-sdk/connectivity'
import { messageProcessingLogs, MessageProcessingLogsType } from "ts-sap-cloud-odata-api-v2-client/MessageProcessingLogsClient";
async function example(name: string, url: string) {
await registerDestination(
{
name: name, // choose name
url: url // add url to your tenant
},
);
const basePath = "/api/v1" // change if needed
const requestBuilder = messageProcessingLogs<MessageProcessingLogsType>().messageProcessingLogsApi.requestBuilder().getAll()
const getAll = requestBuilder.setBasePath(basePath).addCustomHeaders({ 'authorization': `Bearer ...` })
return getAll.execute({ destinationName: name })
}This library is still in beta. Please report any bugs or feature requests to the GitHub issue tracker.
Please use the version 1.4.x or above. This library is compiled to es6 with commonjs to increase compatibility.
Give a ⭐️ if this project helped you!
If you would like to ask about features, other API clients, report bugs, or seek help, please feel free to create an issue in the GitHub repository. Github Issues
This README was generated with ❤️ by readme-md-generator