@sap-cloud-sdk/util
General utilities shared across the Cloud SDK packages — a dependency, not a thing to reach for on its own.
Facts
Where it sits
Who is behind it
In the atlas: maintains 137, wrote 14@SAPmaintainerArtem KovalovContributes to this
In the atlas: contributes to 6@artemkovalyovSAP Cloud SDK BotContributes to this
In the atlas: contributes to 11@bot-sdk-jsBrigittaK307Contributes to this
In the atlas: contributes to 12@BrigittaK307Britta VarwigContributes to this
In the atlas: contributes to 8@bvarwigRobert KaniaContributes to this
In the atlas: contributes to 6@cezaryrkChristian SchüringsContributes to this
In the atlas: contributes to 25@cschueringsDaniel KullmannContributes to this
In the atlas: contributes to 6@daniel-kullmannDavid KnaackContributes to this
In the atlas: contributes to 13, wrote 1@davidkna-sapDeeksha SinhaContributes to this
In the atlas: contributes to 12@deekshas8Deni DajaContributes to this
In the atlas: contributes to 6@denidaja38 contributors
Before choosing this
Conditions
LicenceSAP Developer License Agreement 3.2 CAP§ 1from DestinationsA destination used by a covered CAP application sends SAP product data to a non-SAP product rather than only addressing a remote endpoint.
- § 1 License. Productive customer applications are limited to SAP BTP or another SAP-licensed platform, and mass extraction to a non-SAP product is restricted except where solely required for SAP interoperability.
A destination is configuration, not the deciding boundary. The licence becomes material when the resulting data flow is extraction into a non-SAP product, so the target and purpose need review.
SAP Developer License Agreement 3.2 CAP →What it declares
Every artifact
- Type
- Package
- Origin
- By SAP
As a package
- Where it runs
- does not say
- Distributed through
- npm
Connections
Reaching remote systems without addresses or credentials in the code
Download
Install
npm add @sap-cloud-sdk/utilDerived from the package name. No recipe recorded; the README has the configuration.
README
quoted from SAP/cloud-sdk-js under Apache-2.0, read@sap-cloud-sdk/util
This package contains general utility functions that we reuse multiple times in the SDK. While primarily designed for internal usage, they might also be beneficial for consumers of the SDK.
Installation
$ npm install @sap-cloud-sdk/util
Usage
The util package collects useful tools that help build your SAP Business Technology Platform application. For example, the following code snippet changes the log level of the destination accessor of the SDK.
import { setLogLevel } from '@sap-cloud-sdk/util';
setLogLevel('debug', 'destination-accessor');
Support
The recommended way to get in touch with us is to create an issue on GitHub. Select the issue category Bug, Feature, or Question depending on the nature of your request. We try to provide fixes, features and answers as soon as possible.
Contribute
If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our contributing guidelines and follow the given instructions.
Links
- Official support channel
- Github
- SAP Cloud SDK Documentation
- Sample repository
- SAP Cloud SDK for AI (JavaScript)
License
The SAP Cloud SDK is released under the Apache License Version 2.0.
History
Features 1
Notes
Minor Changes
- a6c8ff6: [Compatibility Note] Deprecate
unixEOLandwebEOL. Use '\n' or '\r\n' respectively.
- a6c8ff6: [Compatibility Note] Deprecate
Fixes 1
Notes
Patch Changes
- b502b40: [Fixed Issue] Update
axiosto1.11.0to use non-vulnerable version ofform-data.
- b502b40: [Fixed Issue] Update
Breaking 1, Features 1, Fixes 1
Notes
Major Changes
- 7d92a1b: [Compatibility Note] The following deprecated content has been removed from the package:
- The
assocconstant has been removed. There is no replacement.
- The
Minor Changes
- 936a6eb: [New Functionality] Add
basePathoption in theoptions-per-service.jsonfile in the OpenAPI generator. This option prepends the base URL path to the API path parameter for every request.
Patch Changes
- 4228412: [Fixed Issue] Stringify Axios response data object in the error stack of
ErrorWithCauseclass.
- 7d92a1b: [Compatibility Note] The following deprecated content has been removed from the package:
Features 1
Notes
Minor Changes
- 4d2b49b: [New Functionality] Add support for setting log level for newly created logger using environment variable
SAP_CLOUD_SDK_LOG_LEVEL.
- 4d2b49b: [New Functionality] Add support for setting log level for newly created logger using environment variable
Breaking 4
Notes
Major Changes
- fde964e37: [Compatibility Note] By default, generation of OData clients fails if a service path cannot be determined. Either provide
servicePathvalue in theoptions-per-service.jsonor setskipValidationto true, in which case,/will be used. - fde964e37: [Compatibility Note] The function
variadicArgumentToArrayis replaced by the functiontransformVariadicArgumentToArray. - fde964e37: [Compatibility Note] Switch the compilerOptions.module to
Node16instead ofCommonJSfor better interoperability with ES modules. See the TypeScript handbook for technical details if needed. - fde964e37: [Compatibility Note] The field
loggeron the interfaceLoggerOptionswas not used and is removed from the interface.
- fde964e37: [Compatibility Note] By default, generation of OData clients fails if a service path cannot be determined. Either provide
Features 1
Notes
Minor Changes
- 4c51d3dc: [New Functionality] Add method
setGlobalTransportsto support setting custom transport globally.
- 4c51d3dc: [New Functionality] Add method
Features 1
Notes
Minor Changes
- 89f1c423: [Compatibility Note] Stop using
VCAP_SERVICESto determine the log format. UsesetLogFormatandsetGlobalLogFormatto specify the log format. By default, the log format is set tokibanaforNODE_ENV=productionandlocalotherwise.
- 89f1c423: [Compatibility Note] Stop using
Fixes 1
Notes
Patch Changes
- 0a008674: [Fixed Issue] Fix a bug in the implementation of the trim method.
Others providing
Compare all 15 on the Destinations page →- SAP Destination serviceSAP Destination serviceNamed, credentialed addresses of other systems, resolved at runtime — so an application holds no URL and no secret of its own, and the same code reaches a different system in every landscape.sap official, btpNamed, credentialed addresses of other systems resolved at runtimefrom BTP/BAIP
- SAP Private Link ServiceSAP Private Link ServiceA private network connection between a selected SAP BTP service and a selected service in an application's own account with a partner cloud provider, so the traffic between them never touches the public internet.sap official, btpPrivate network link between a BTP service and a partner cloudfrom BTP/BAIP
- com.sap.cds:cds-feature-remote-odatacom.sap.cds:cds-feature-remote-odataA CAP Java feature for consuming remote OData V2 and V4 services as Remote Services, translating CQN queries into OData requests against a destination or a service binding.sap official, capRemote Services for consuming OData V2 and V4 APIs in CAP Javafrom CAP
- com.sap.cds:cds-integration-cloud-sdkcom.sap.cds:cds-integration-cloud-sdkA CAP Java feature that integrates the SAP Cloud SDK, so features such as remote OData and enterprise messaging resolve a destination or service binding and reach a remote REST-based service.sap official, capSAP Cloud SDK integration for remote REST services in CAP Javafrom CAP
- capire/s4capire/s4A pre-built integration package for SAP S/4HANA, holding the imported service definitions a CAP project would otherwise generate for itself.sap official, capPrebuilt SAP S/4HANA integration package for CAP projectsfrom CAP
- cdsecdseResolves a destination from a CAP project's own configuration, then makes the outbound call with axios: the url, the method and the body are written at the call site.independent, capDestination resolution and axios calls from CAP configurationfrom CAP
- @sap/cds@sap/cdsThe CAP Node.js runtime, which compiles the CDS model, serves the services declared in it, answers generic requests before any handler runs, and loads every cds-plugin.sap official, capCAP Node.js runtimefrom CAP
- @sap-cloud-sdk/connectivity@sap-cloud-sdk/connectivityDestination lookup and the connectivity proxy — the package that turns a destination name into a reachable endpoint with credentials attached.sap official, capDestination lookup and connectivity proxy for the Cloud SDKfrom CAP
- @sap-cloud-sdk/http-client@sap-cloud-sdk/http-clientThe HTTP client that carries a destination's credentials, so an outbound call inherits the authentication rather than assembling it.sap official, capHTTP client carrying a destination's credentialsfrom CAP
- @sap-cloud-sdk/odata-common@sap-cloud-sdk/odata-commonThe shared machinery under the SDK's OData and OpenAPI client generators; a dependency of the generated clients rather than something written against directly.sap official, capShared machinery under the Cloud SDK's OData and OpenAPI clientsfrom CAP
- @sap-cloud-sdk/openapi@sap-cloud-sdk/openapiGenerated OpenAPI clients for the Cloud SDK, so a REST API described by a specification is called through typed functions.sap official, capGenerated OpenAPI clients for the Cloud SDKfrom CAP
- @sap-cloud-sdk/resilience@sap-cloud-sdk/resilienceTimeouts, retries and circuit breaking around a remote call, so one slow downstream system does not take the application with it.sap official, capTimeouts, retries and circuit breaking around remote callsfrom CAP
- btp-cloud-connector-setup-automationbtp-cloud-connector-setup-automationA Yeoman generator that adds the Cloud Connector system mappings for an XS Advanced system and writes the matching SAP BTP destination files.sap official, btpYeoman generator for Cloud Connector mappings and BTP destinationsfrom BTP/BAIP
- @sapmentors/cds-scp-api@sapmentors/cds-scp-apiA Node module for CAP that calls an external API through a destination instead of a hardcoded endpoint, taking its address, credentials and on-premise tunnel from the SAP Destination and Connectivity services.community org, capNode module for CAP calling external APIs through a destinationfrom CAP
Details
Sources
Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.
Compatibility and provenance
Contributors
History in the atlas
- Typed cds-plugin by placement, which defaults every candidate to that. It is not one.
- General utilities shared across the Cloud SDK packages — a dependency, not a thing to reach for on its own.
- First seen.
For your agent
- Ref
artifact:sap-cloud-sdk-util- JSON
- /artifacts/sap-cloud-sdk-util.json
- MCP
- Connecting an agent