cloud-sdk-js

Compatibility Notes

• [Generator] The interface EnityTypeForceMandatory (e.g., BusinessPartnerTypeForceMandatory) is removed.

New Functionality

• [OData] Support the usage of $count in getAll requests e.g.: Entity.requestBuilder().getAll().count().execute().

Improvements

• [OData] Add warning for deep update attempts in OData v2.
• [Generator] The transpiling after generation is done in chunks to avoid CPU overloads for high numbers of services.

Fixed Issues

• [OData] Fix parsing the Etag returned from update requests.
• [OData] Fix the entity builder so that it can set undefined/null for optional properties.

New Functionality

• [Util] Allow to mute and unmute loggers.

Improvements

• [Generator] Generator will fail, when it generates .ts files that have compilation errors.

Fixed Issues

• [OData] Fix deserialization of one to many links, where the navigation property is not wrapped in a result object.
• [OData] Fix $orderby parameter in expanded subqueries.

Improvements

• Adjust the generation of the $filter parameter in URL so that parentheses are not removed even logically they are not needed.
  For example, now $filter=((filterA and filter B) and (filterC and filter D)) will not be flattened to $filter=(filterA and filter B and filterC and filter D).

Fixed Issues

• [Generator] Remove Batch.ts from the index file when the file does not exist.

New Functionality

• Move OData v4 support from experimental to GA status.

Fixed Issues

• [Generator] Skip generation of Batch.ts for services without entities.
• [RequestBuilder] Fix serialization of "Edm.Time" fields in OData V4.

New Functionality

• Added experimental support for OData V4 enum type. Use the @sap/cloud-sdk-generator to generate the type safe client.
• Include fallback Edm.Any for previously unsupported edm types like Edm.Geography.
  Type safety and related features like URI conversion are not supported for the fallback type.

Improvements

• Log a warning in case the destination and the custom request config contain both authorization headers.
• Special characters like ' (single quotes), (space) and ä (umlaut) are encoded properly when used in the Filter.

Fixed Issues

• [Generator] Fix wrong type argument for collection types containing Edm types.

• API documentation

Fixed Issues

• Fix links in TSDoc of generated OData clients.

Compatibility Notes

• In version 1.25.0 we introduced the property _complexType on complex types. This property is removed in this version as it introduced a bug causing some generated OData clients to not be able to compile. OData clients generated using version 1.25.0 will be incompatible with future versions of the SAP Cloud SDK.
• Deprecated the generateNpmrc option of the SAP Cloud SDK generator. From now on @sap scoped packages do not need the private registry anymore.

New Functionality

• Support collections in complex types.
• Support unbound actions in OData V4. Note that all OData V4 functionality is still experimental.
• Check the latest API documentation for more details

Fixed Issues

• Fix OData client generation for complex types. See the compatibility notes above.

Documentation updates

• A guide on using of OData generator
• A guide on using OData type-safe client
• A guide on Destinations handling on SAP Cloud Platform
• A comprehensive guide on SCP Connectivity with Proxies

Pre-generated type-safe clients for S/4HANA version 1.20.0

• Find release notes for type-safe S/4HANA client libraries here.

Changelog

Find the changelog for versions prior to 1.18.0 here.

Compatibility Notes

• As the representation of complex types in the generated OData clients has changed. OData clients generated by the SAP Cloud SDK generator should be regenerated as old versions will no longer be maintained.
• OData client generator: Reduce public API of the generator.
  Only the service generation remains public.
  The old API is obsolete due to a refactoring (see below) but remains available with status deprecated.

New Functionality

• Support collection type filter functions.

Improvements

• Improve complex type handling and its representation in the generated OData clients.
• Improve collection type handling and its representation in the generated OData clients.
• OData client generator: Refactor the service generation flow and deprecate the whole previous implementation.

Fixed Issues

• Ignore enum properties in complex types to fix generation of OData v4 clients.
• Fix setting ETags, when no ETag was specified by sending no if-match header instead of if-match:false.

Known Issues

• The internal deserialization and serialization of Edm.TimeOfDay representations is not lossless for corner cases where the fractional seconds contain trailing zeros. As a sideeffect 12:12:12.0 can potentially be transformed to 12:12:12 when performing a GET and PATCH / PUT request subsequently.
• OData v4 edm types that are unknown to the SAP Cloud SDK are ignored, such that properties and parameters of those types are missing.

Compatibility Notes

• Experimental fractionalSeconds were removed from the Time representation and merged with seconds instead.

New Functionality

• Support OData v4 specific parsing of Edm types in the generator.
• Add a static representation for durations on entity classes / namespaces.

Improvements

• Reduce the number of circular dependencies within the SDK Core.

Fixed Issues

• Fix type error due to a breaking change from winston version 3.3.2 -> 3.3.3 see here for details.
• Fix serialization error for number values 'INF','-INF' and 'NaN'.

Compatibility Notes

• Importing filter functions directly is deprecated, import using filterFunctions instead.
• OData client generator: Remove the hidden generator option changelogFile. Use the new more general options additionalFiles instead.

New Functionality

• Support all string, number and date related filter functions. Import filterFunctions and use in a filter, e. g. .filter(filterFunctions.startsWith(BusinessPartner.FIRST_NAME).equals(true)).
• Add the option --additionalFiles <GlobToFiles> to the generator. If specified, all files matching the glob will be copied to each generated service directory.

Compatibility Notes

• The properties isMulti of the typeVdmFunctionImportReturnType and isMultiLink as well as multiplicity of VdmNavigationProperty were deprecated and replaced by isCollection.
• The interface VdmServiceMetadata now also contains a property oDataVersion that is mandatory.
• Due to a fix in the generator regarding the name clash it is possible that the order of suffixes could change.
  If you regenerate a VDM with a name clash Entity_1 and Entity_2 could be swapped.

New Functionality

• Add experimental support for OData v4 to the generator.

Fixed Issues

• Fix the generator so that the builder function for nested complex types is correctly typed.
• Fix the generator so that entity names ending with the word Type do not lead to name clashes anymore.

Fixed Issues

• Fix missing validation of URL used for obtaining the JWT verification key.

Fixed Issues

• Fix the core dependency version when generating aggregated packages.

Compatibility Notes

• New generated OData clients yield more narrow types on the _keys, _keyFields and _allFields properties, that differ from older generated clients. Old clients are still supported but will be deprecated soon.
• Internal directory structure has changed. This is a breaking change for users that reference internal modules directly.

New Functionality

• Added experimental support for OData v4. All functionality related to OData v4 is subject to change.

Improvements

• OData client generator: Narrow the types of the generated properties _keys, _keyFields and _allFields to the correct types.

Fixed Issues

• Fix the OData client generator to avoid a compilation error when a complex type only contains complex types.
• Fix the dependency versions in the aggregator package generated by the OData client generator.

Fixed Issues

• Fix the OData client generator to also parse definitions of OpenAPI files with version higher than 3.

Compatibility Notes

• When executing and building requests with the generic http-client custom request configurations now take precedence over configurations resulting from the given destination. This applies to all http-client related functions: buildHttpRequest, addDestinationToRequestConfig, execute and executeHttpRequest.

New Functionality

• Support setting log levels for all loggers globally. Use setGlobalLogLevel('debug') for this. Log levels set individually still take precedence.

Improvements

• Increase the information shown on VDM generation and parallelize the file creation process.

Fixed Issues

• Fix logging of error messages that were logged as undefined before.
• Fix serialization of EDM type Int64 to return a string instead of an instance of BigNumber.
• Fix JWT verification to use the url stored in the JKU field of the token's header to fetch the verification key.

New Functionality

• Allow setting additional query parameters for OData queries, using withCustomQueryParameters().

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

• Introduce validation for destinations retrieved from environment variable or destination service.
• Allow configuring the destinations environment variable with the same property keys as known from the destination service on SAP Cloud Platform, e.g. now URL is considered valid in addition to previously only url.

Fixed Issues

• Fix ordering for complex properties including nested complex properties.
• Fix the generator crashing for services containing function imports without a return type.
• Fix the destination processing so that the user can set PrincipalPropagation as authentication scheme for on-premises connectivity.