Skip to content

CHANGELOG.md

Latest commit

 

History

History
242 lines (169 loc) · 14.5 KB

CHANGELOG.md

File metadata and controls

242 lines (169 loc) · 14.5 KB
Raw

Next

Breaking Changes

Function removed

Function moved

Signature changed

Implementation changed

4.9.1

Fixed Issues

  • [connectivity, generator, generator-common, http-client, odata-common, odata-v2, odata-v4, openapi, openapi-generator, resilience, temporal-de-serializers] Export ./internal.js named export in package.json for compatibility. Please migrate to the new named export ./internal, the old export is deprecated and will be removed in the next major release. (e8f8134)

4.9.0

Compatibility Notes

  • [generator-common] Generated files now include a blank line between the copyright header and the file content. (118131d)
  • [openapi-generator] Fields with contentMediaType: application/json and a contentSchema will now be typed as the contentSchema type instead of string. Re-generate your client to pick up the new types. (404dc92)

New Features

  • [openapi-generator] Support contentSchema in OpenAPI 3.1 schemas: fields with contentMediaType: application/json and a contentSchema are now typed as the contentSchema type instead of string. Serialization to a JSON string is supported for multipart bodies via FormDataBuilder; non-multipart bodies are not yet handled. (404dc92)
  • [openapi-generator] OpenAPI generator now supports OAS 3.1 input. This feature is experiemental. Use with caution. (5f6fe80)

Fixed Issues

  • [connectivity] Extend OnPremise HTTP agent cache key to scope it more strongly. The cache key now includes the subaccount identity ensuring keep-alive sockets are not reused across tenants in multi-tenant technical user flows. If no stable identity context can be derived from the request, a fresh agent without keep-alive is created for each request. This matches the behavior of the previous implementation in SAP Cloud SDK v4.6.0 and lower, which did not cache agents in any case. (9f55261)
  • [generator-common] readCompilerOptions now uses the TypeScript compiler API for tsconfig parsing, fixing support for JSONC (comments, trailing commas), package-name extends (e.g. @tsconfig/node18), and circular extends chains. (88c304e)
  • [http-client] Restore proxy authorization headers for same-origin redirects when using proxy configuration. (05e9299)

4.8.0

Compatibility Notes

  • [generator, openapi-generator] Transpilation now includes inherited compiler options. (82a6d2d)
  • [generator, generator-common, openapi-generator] The project has been updated to typescript version 6. Some options are deprecated in TypeScript 6, reference the breaking changes page for more details. (b7cfc1b)

New Features

  • [connectivity, http-client] A new agentOptions property on Destination allows configuring the underlying HTTP(S) agent (e.g. keepAlive, timeout) without constructing an agent manually. (32aab37)

Fixed Issues

  • [connectivity] HTTP(S) agents are now cached per destination instead of per protocol and options, preventing unintended agent reuse across different destinations. (34da40e)
  • [connectivity] Refactor HTTP agent cache for better runtime compatibility. (a42a3a2)
  • [connectivity] Fix DestinationOrFetchOptions and HttpDestinationOrFetchOptions so the service key surfaces at the type level.
    • @sap-cloud-sdk/resilience@4.8.0
    • @sap-cloud-sdk/util@4.8.0 (24fe0c5)
  • [generator, openapi-generator] Transpilation now resolves extends inheritance in tsconfig files, merging base config options with child options taking precedence. (82a6d2d)
  • [openapi] Wrap Buffer responses in Blob when executing OpenAPI requests that return binary data. (e568017)

Improvements

  • [generator-common] Extend script target mapper to handle ES2023, ES2024, and ES2025 targets. Extend module kind mapper to handle UMD, System, ES2022, Node18, Node20, and Preserve module kinds. Extend module resolution mapping to handle Bundler. (9df742e)

4.7.0

Compatibility Notes

  • [connectivity] IAS tokens are now cached via @sap/xssec. @sap/xssec uses an LRU cache limited to 100 items, previously this cache was unbound. (9102f18)
  • [eslint-config] Replaced eslint-plugin-import with eslint-plugin-import-x. Please ensure that you have eslint-plugin-import-x installed. (9cbf19d)

New Features

  • [connectivity] Add createDestinationFromIasService() convenience function to build IAS-backed destinations. This function aims to offer more convenience for obtaining IAS-backed destinations outside SAP BTP-environments. (9102f18)
  • [connectivity] Add getIasToken() convenience function to fetch IAS token. This function aims to offer more convenience for obtaining IAS tokens outside SAP BTP-environments. (9102f18)

Fixed Issues

  • [connectivity] Avoid caching JWT if forwardAuthToken is set to true.
    • @sap-cloud-sdk/resilience@4.7.0
    • @sap-cloud-sdk/util@4.7.0 (df84426)
  • [http-client] Warn when the CSRF token fetch URL has a different host than the request URL, as sensitive headers would be forwarded to the cross-host endpoint. (67e1c53)

Improvements

  • [connectivity, http-client] Cache custom http and https agents and enable the keep-alive option by default. (d54ba5a)
  • [connectivity, http-client] Use node's global http/https agent unless a custom agent is required by the destination configuration. (d54ba5a)

4.6.0

Compatibility Notes

  • [util] Deprecate unixEOL and webEOL. Use '\n' or '\r\n' respectively. (a6c8ff6)

Fixed Issues

  • [connectivity] Destinations with authentication type "SAMLAssertion" are no longer cached, even if caching is enabled. (see #6396) (0800e7a)
  • [connectivity] Support TrustStoreLocation for OAuth2ClientCredentials destinations. (8637346)
  • [connectivity] Extend isDestinationFetchOptions to check service property. (259d8ad)
  • [http-client] Improve handling of missing zlib-module in the compress() middleware and lazy-load it only when needed. To compress requests in the browser, ensure that a suitable polyfill is provided. (7ea34ce)

4.5.1

Fixed Issues

  • [eslint-config] Correct formatting in ESLint flat-config (330230c)

4.5.0

Compatibility Notes

  • [connectivity] Update @sap/xssec to version 4.12.2 with changed XSUAA URL behavior. When fetching XSUAA tokens with zone ID (multi-tenant scenarios), xssec now uses the base domain without a tenant subdomain prefix. (02d1302)

New Features

  • [openapi, openapi-generator] Support request bodies with content type "multipart/form-data". (3b95c42)
  • [openapi-generator] Allow OpenAPI version 3.1. style "type": "null" schemas. OpenAPI version 3.1. support is limited. (007541a)

Improvements

  • [connectivity] Allow passing a service binding directly through DestinationFromServiceBindingOptions instead of looking it up by name. (962cdcb)
  • [http-client] Add signal property to CustomRequestConfig and HttpRequestConfigBase type definition to document AbortSignal support for cancelling HTTP requests. (cbed72f)
  • [http-client] Add request compression middleware. Use the compress() middleware to compress HTTP request payloads using gzip, brotli, deflate, or zstd algorithms. Supports multiple compression modes: auto (size-based), passthrough (pre-compressed), or forced compression. (f5715de)

4.4.0

New Features

  • [connectivity] Support IAS (App-to-App) authentication. Use transformServiceBindingToDestination() function or getDestinationFromServiceBinding() function to create a destination targeting an IAS application. (d444438)

4.3.1

Improvements

  • [eslint-config] Open the peer dependency range of the eslint module to include version 8 and 9. Version 9 can now be used without the potentially unsafe npm flag --legacy-peer-deps. (6431463)

4.3.0

New Features

  • [connectivity] Support certificates in JKS format for ClientCertificateAuthentication. (ab96aff)

4.2.0

New Features

  • [generator, generator-common] Introduce option generateESM in OData generator to generate ESM compatible code. (c73c7fa)

Fixed Issues

  • [openapi] Fix missing type: module in generated package.json when --generateESM option is enabled. (e09754a)
  • [openapi-generator] Improve the handling of arrays of enums (f17ca59)

4.1.2

Fixed Issues

  • [connectivity, http-client, openapi, resilience, util] Update axios to 1.12.2 to fix vulnerability to DoS attack. Refer here for more details. (011b841)

4.1.1

Fixed Issues

  • [connectivity, http-client, openapi, resilience, util] Update axios to 1.11.0 to use non-vulnerable version of form-data. (b502b40)

4.1.0

Compatibility Notes

  • [connectivity] The getDestinationFromDestinationService() function no longer verifies the incoming XSUAA JWT against the application's bound XSUAA instance. Consequently, the cacheVerificationKeys option is now deprecated and has no effect. (3c19ffa)

Improvements

  • [connectivity] Remove dependency on XSUAA service binding while retrieving destinations using getDestinationFromDestinationService() and getAllDestinationsFromDestinationService() functions. (3c19ffa)

4.0.2

Fixed Issues

  • [connectivity] Remove destination cache in getDestinationFromServiceBinding() function to let cached destinations retrieved in getDestinationFromDestinationService() function be added with the proxyConfiguration property.
    • @sap-cloud-sdk/resilience@4.0.2
    • @sap-cloud-sdk/util@4.0.2 (4a187d6)

4.0.1

Fixed Issues

  • [eslint-config] Downgrade @stylistic/eslint-plugin to v3 as v4 is EMS-only. (97ad0ad)

4.0.0

Improvements

  • [connectivity] Enable destination caching by default when retrieving destinations via the destination service. Change affects behavior of getDestination() method, getAllDestinationsFromDestinationService() method, generated client's execute() method and generic HTTP requests execution using executeHttpRequest(). (d69325a)
  • [generator, odata-common, odata-v4] Support precision handling during serialization of Edm.DateTimeOffset fields in OData v4. (ab6ca60)

Compatibility Notes

  • [connectivity] The following deprecated content has been removed from the package:
    • The behaviour of getAgentConfig() function is changed to be asynchronous. The temporary asynchronous function getAgentConfigAsync() has been removed.
    • The destinationForServiceBinding() function has been removed. Use getDestinationFromServiceBinding() instead.
    • The PartialDestinationFetchOptions type has been removed. Use either ServiceBindingTransformOptions or getDestinationFromServiceBinding() function.
    • The serviceToken() function no longer takes xsuaaCredentials as part of the options parameter.
    • The parseDestination() function is no longer a public API.
    • The DestinationForServiceBindingOptions interface has been renamed to DestinationFromServiceBindingOptions. (7d92a1b)
  • [connectivity] Disable iasToXsuaaTokenExchange by default if not defined. (25c9dd8)
  • [odata-common] The following deprecated content has been removed from the package:
    • The FunctionImportParameters type has been removed. Use OperationParameters instead.
    • The ODataFunctionImportRequestConfig constant has been removed. Use ODataFunctionRequestConfig instead.
    • The FunctionImportParameter constant has been removed. Use OperationParameter instead.
    • The ActionFunctionImportRequestBuilderBase constant has been removed. Use OperationRequestBuilderBase instead. (7d92a1b)
  • [odata-v2] The following deprecated content has been removed from the package:
    • The ODataFunctionImportRequestConfig constant has been removed. Use ODataFunctionRequestConfig instead.
    • The FunctionImportRequestBuilder constant has been removed. Use OperationRequestBuilder instead. (7d92a1b)
  • [odata-v4] The following deprecated content has been removed from the package:
    • The ODataFunctionImportRequestConfig constant has been removed. Use ODataFunctionRequestConfig instead.
    • The ActionImportParameter class has been removed. Use OperationParameter instead.
    • The ActionImportParameters type has been removed. Use OperationParameters instead.
    • The FunctionImportRequestBuilder class has been removed. Use OperationRequestBuilder instead.
    • The BoundFunctionImportRequestBuilder class has been removed. Use OperationRequestBuilder instead.
    • The BoundActionImportRequestBuilder class has been removed. Use OperationRequestBuilder instead.
    • The ODataActionImportRequestConfig constant has been removed. Use ODataActionRequestConfig instead.
    • The ODataBoundActionImportRequestConfig class has been removed. Use ODataBoundActionRequestConfig instead.
    • The OdataBoundFunctionImportRequestConfig constant has been removed. Use ODataBoundFunctionRequestConfig instead.
    • The ActionImportRequestBuilder class has been removed. Use OperationRequestBuilder instead. (7d92a1b)
  • [resilience] The following deprecated content has been removed from the package:
    • The circuitBreakerHttp constant has been removed. Use circuitBreaker instead. (7d92a1b)
  • [util] The following deprecated content has been removed from the package:
    • The assoc constant has been removed. There is no replacement. (7d92a1b)