SAP Cloud SDK for JavaScript - Release Notes for versions until 1.19.0

The release notes for the latest releases are available on our GitHub repository.


These are the release notes of the SAP Cloud SDK for JavaScript / TypeScript. You may also be interested in the release notes of the SDK for Java.

Note: The SAP Cloud SDK was previously known as SAP S/4HANA Cloud SDK.

Version 1.19.0

April 9, 2020 - JSDoc API documentation for core | JSDoc API documentation for VDM | > Release blog

New Functionality

Version 1.18.1

March 26, 2020 - JSDoc API documentation for core | JSDoc API documentation for VDM | > Release blog

Compatibility Notes:
  • Due to the intoroduced validation for destination configurations, destinations of type HTTP are expected to contain a url or URL property. Note that when retrieving a destination from the destinations environment variable, all destinations are validated. This validation applies even to destinations that are not read.

Improvements

Fixed Issues

Version 1.18.0

March 12, 2020 - JSDoc API documentation for core | JSDoc API documentation for VDM | > Release blog

Compatibility Notes:
  • Some packages of the SAP Cloud SDK for JavaScript has been migrated to github.com. As a result, the packages are also renamed as shown in the below list. No breaking changes in the functionality were made. You'll need to update your package.json to use the new packages.
    • @sap/cloud-sdk-util was renamed to @sap-cloud-sdk/util
    • @sap/cloud-sdk-analytics was renamed to @sap-cloud-sdk/analytics
    • @sap/cloud-sdk-core was renamed to @sap-cloud-sdk/core
    • @sap/cloud-sdk-generator was renamed to @sap-cloud-sdk/generator
    • @sap/cloud-sdk-test-util was renamed to @sap-cloud-sdk/test-util
  • How to update your project
    • Search for the old package names in all dependencies, devDependencies, peerDependencies in your package.json.
    • Replace the old package name (e.g. @sap/cloud-sdk-core) with new one (e.g. @sap-cloud-sdk/core).
    • Use a stable version of the open source package (e.g. ^1.18.0).
    • Install your dependencies again to reflect the changes (e.g., npm i).
    • Search for your source code for uses of the old packages (e.g. require() and replace them with new names.

Improvements

Version 1.17.2

February 27, 2020 - JSDoc API documentation | > Release blog

Known Issues:
  • Using destinations with authentication type PrincipalPropagation and proxy type OnPremise (as configured in the SAP Cloud Platform cockpit) will currently throw errors. This can be worked around by setting the authentication type to NoAuthentication instead.

Improvements

Fixed Issues

Version 1.17.0

February 13, 2020 - JSDoc API documentation | > Release blog

New Functionality

Fixed Issues

Version 1.16.0

January 30, 2020 - JSDoc API documentation | > Release blog

Known Issues:
  • Making OData requests using a proxy defined in the environment variables is not possible (see fixed issues). This is resolved in SAP Cloud SDK version 1.17.0.

New Functionality

Fixed Issues

Version 1.15.1

January 16, 2020 - JSDoc API documentation | > Release blog

Fixed Issues

Version 1.15.0

December 19, 2019 - JSDoc API documentation | > Release blog

New Functionality

Fixed Issues

Version 1.14.0

December 5, 2019 - JSDoc API documentation | > Release blog

Compatibility Notes:
  • OData client generator: Rename entityConstructor, linkedEntity, fieldName properties in generated entities to _entityConstructor, _linkedEntity, _fieldName.

New Functionality

Improvements

Fixed Issues

Version 1.13.1

November 21, 2019 - JSDoc API documentation | > Release blog

Compatibility Notes:
  • Introduce new module @sap/cloud-sdk-analytics to provide insights into the SDK usage for further improving the SDK in the future.
    • To review what data is collected and enable analytics, you need to opt-in as described here.
    • No data about your projects will be collected as long as you don't opt-in. We never collect personal data.
  • Due to a change of the naming strategy for entity classes in the OData client generator, entities that were previously named using the pattern EntityType_<number> might now have a different name when regenerated.

New Functionality

Improvements

Fixed Issues

Version 1.12.0

November 7, 2019 - JSDoc API documentation | > Release blog

Compatibility Notes:
  • Due to the introduction of an SDK-specific logger, the format of log messages created by the SAP Cloud SDK has changed.

New Functionality

Improvements

Fixed Issues

Version 1.11.3

October 24, 2019 - JSDoc API documentation | > Release blog

New Functionality

Version 1.11.2

October 10, 2019 - JSDoc API documentation | > Release blog

Known Issues:
  • Please note that we have not released a new version 1.11.2 of the OData client generator (module @sap/cloud-sdk-generator) due to technical reasons. 1.10.0 remains the current version of the generator. As a consequence, the new features of the OData client mentioned below (batch and CSN files) are not yet available for custom OData clients generated by the generator.

Compatibility Notes:
  • In preparation for an upcoming change to the way how the XSUAA service supplies verification keys to applications, the SAP Cloud SDK from version 1.11.2 onwards retrieves the key from the XSUAA service instead of relying on a verification key present in the XSUAA service binding credentials.
  • Previous versions of the SDK only recognized an access token in the authorization header if "Bearer" was spelled in title case. Now, retrieveJwt does a case insensitive check for "bearer". That means, "bearer" and "Bearer" are now equally supported as correct authorization header.

New Functionality

Improvements

Fixed Issues

Version 1.10.0

September 26, 2019 - JSDoc API documentation | > Release blog

New Functionality

Version 1.9.0

September 12, 2019 - JSDoc API documentation | > Release blog

New Functionality

Improvements

Fixed Issues

Version 1.8.1

August 29, 2019 - JSDoc API documentation | > Release blog

New Functionality

Version 1.8.0

August 15, 2019 - JSDoc API documentation | > Release blog

Compatibility Notes:
  • We have increased the timeout of circuit breakers used to retrieved access tokens and destinations from 3 to 10 seconds.
  • As part of the update of the OData VDM to SAP S/4HANA Cloud 1908, the package @sap/cloud-sdk-vdm-outbound-delivery-service has been removed from the SAP API Business Hub and, as a consequence, from the SDK. Use @sap/cloud-sdk-vdm-outbound-delivery-v2-service instead.

New Functionality

Improvements

Fixed Issues

Version 1.7.0

August 1, 2019 - JSDoc API documentation | > Release blog

Compatibility Notes:
  • When executing an OData request with implicit resolution of destinations, or when using useOrFetchDestination or getDestination explicitly, service bindings represented as destinations now take precedence over querying the destination service. If you have a service binding with the same name as a destination configured in the SAP Cloud Platform cockpit, this will lead to different behavior in your application, because of the newly introduced support for service bindings. Therefore we recommend using unique names across destinations and service bindings.
  • Deprecate the misnamed interface HttpReponse. Use HttpResponse instead.

New Functionality

Improvements

Fixed Issues

Version 1.6.1

July 18, 2019 - JSDoc API documentation | > Release blog

Compatibility Notes:
  • Previously existing functions to create instances of complex types from JSON such as createTimeSheetDataFields have been deprecated in favor of explicit builder functions available from separate namespaces such as TimeSheetDataFields.build.

New Functionality

Improvements

Fixed Issues

Version 1.5.0

July 4, 2019 - JSDoc API documentation | > Release blog

New Functionality

Improvements

Fixed Issues

Version 1.4.2

June 20, 2019 - JSDoc API documentation | > Release blog

Known Issues:

Compatibility Notes:
  • The two functions getDestinations and getDestinationByName in env-destination-accessor have been deprecated in favor of getDestinationsFromEnv and getDestinationFromEnvByName to better reflect their purpose. This has no effect on functionality.

Improvements

Fixed Issues

Version 1.4.1

June 6, 2019 - JSDoc API documentation | > Release blog

Known Issues:
  • The dependency of the new module @sap/cloud-sdk-generator to fast-xml-parser is not properly defined, leading to errors such as Cannot find module 'fast-xml-parser' when calling the generator. This has been fixed in version 1.4.2.

New Functionality

Fixed Issues

Version 1.3.0

May 23, 2019 - JSDoc API documentation | > Release blog

Compatibility Notes:

New Functionality

Improvements

Fixed Issues

Version 1.2.1

May 9, 2019 - JSDoc API documentation | > Release blog

Compatibility Notes:
  • The SAP S/4HANA Cloud SDK has been renamed to SAP Cloud SDK. For now, technical artifact names on source code level remain unchanged. You do not need to change your source code or dependencies.

New Functionality

New Functionality

Fixed Issues

Version 1.1.0

April 25, 2019 - JSDoc API documentation | > Release blog

Compatibility Notes:
  • Replace getDestinationOptions for accessing destinations with getDestination and deprecate getDestinationOptions.
  • Deprecate DestinationOrigin, as it turned out to be unnecessary.

New Functionality

Improvements

Fixed Issues

Version 1.0.0

March 28, 2019 - JSDoc API documentation | > Release blog

This is the initial release of the SAP S/4HANA Cloud SDK for JavaScript.

Initial Functionality