SAP Cloud SDK for JavaScript

The @sap-cloud-sdk/generator-common package provides shared utility functions used by both the OData client generator and the OpenAPI client generator within the SAP Cloud SDK.

Warning: The APIs in this package are considered internal. They are subject to change in newer versions without notice. Use them with caution if you are building custom generator extensions.

The @sap-cloud-sdk/eslint-config package provides a shareable ESLint configuration used by the SAP Cloud SDK. It is designed to maintain code quality and consistency.

Key features include:

• Extends eslint:recommended.
• Extends @typescript-eslint/recommended.
• Integrates eslint-config-prettier to prevent formatting conflicts when using Prettier.

The @sap-cloud-sdk/http-client package provides generic HTTP client functionality enhanced with SAP infrastructure capabilities. It sits on top of a standard HTTP client to automate connectivity tasks, including:

• Destination lookup: Resolving service destinations configured in the SAP BTP environment.
• SAP S/4HANA On-premise connectivity: Managing connections to on-premise systems.
• Web proxies: Handling proxy configurations for outbound requests.

The SAP Cloud SDK for JavaScript uses a custom, TypeScript-based OpenAPI generator to create API clients. This replaces the previous dependency on the Java-based @openapitools/openapi-generator-cli.

Key benefits of this approach include:

• No Java Runtime Required: Users do not need a JRE installed to generate clients.
• Smaller Package Size: The project no longer needs to bundle a ~24MB .jar file.
• Faster Generation: Generation is significantly faster (approximately 3.5s compared to 15s for the Java-based version).
• Improved API Design: The custom generator allows for better handling of unique names and API file structures without requiring manual wrappers or workarounds.

The SAP Cloud SDK handles OData V4 Enum types by using a specialized EnumField class instead of a generic EdmTypeField. This approach ensures type safety when building filters, preventing developers from passing arbitrary strings or numbers that do not correspond to the defined enum entries.

Key Characteristics

• Type Safety: When building filters (e.g., using .equal()), the SDK restricts inputs to the valid members of the specific enum type.
• Underlying Types: The SDK parses metadata to capture the enum name, underlying type (e.g., Edm.Int32, Edm.Int64), keys, and values.
• Implementation Detail: For Edm.Int64 underlying types, the SDK uses bignumber.js or string to avoid precision loss associated with the standard JavaScript number type.

In version 3.24.0, the @sap-cloud-sdk/connectivity and @sap-cloud-sdk/resilience packages introduced ResilienceOptions and a resilience() function. The resilience() function returns an array of middlewares that can be applied to requests to improve stability. Additionally, a retry option was added to DestinationFetchOption to handle unstable token exchanges performed by the destination service.

// Concept: Using resilience middlewares (introduced in 3.24.0)
// The resilience() function returns an array of middlewares based on ResilienceOptions
const middlewares = resilience(resilienceOptions);

The @sap-cloud-sdk/odata-common package contains shared internal functionality for OData clients but is not intended for direct use.

To interact with OData services, you should use the specific versioned packages:

• For OData V2 services: Use @sap-cloud-sdk/odata-v2
• For OData V4 services: Use @sap-cloud-sdk/odata-v4

The generator does not perform camel case renaming on properties or query parameters. It preserves the exact names provided in the OpenAPI specification.

Implications for Developers:

• Fidelity: This avoids collisions and complexity when dealing with allOf or overlapping property names (e.g., some_property vs some-property).
• TypeScript Usage: Generated interfaces and types will use the original casing from the spec. While this may look unconventional in JavaScript/TypeScript (e.g., using snake_case or kebab-case keys), it ensures that request/response bodies and query parameters match the underlying API specification exactly.