SPA SDKs – Lifecycle and Support

Overview

The SPA SDKs are JavaScript and TypeScript libraries maintained by Bloomreach. The SDKs include a framework-agnostic core SDK and framework-specific extensions for supported front-end frameworks:

• React
• Angular
• Vue.js

Bloomreach releases all SPA SDK artifacts together, assigning the same version number to each package in a release. Each artifact provides a JavaScript API and has the following dependencies:

1. Supported Delivery API versions
2. Supported front-end frameworks (see above)
   • For each framework-specific SDK, the compatible versions of that framework

The SPA SDK also depends on Bloomreach Content to support page management, especially for previewing unpublished content. This API is stable and not intended for direct use. Bloomreach will document this dependency only if it becomes relevant for developers.

When building a JavaScript-based front end, use the core SDK and, if needed, the extension for your chosen framework. You are responsible for upgrading your front end to use the latest SDK version. Bloomreach manages upgrades to the brX Content module (back end) and ensures that new back-end versions remain compatible with previously released SDKs.

The Delivery API provides managed content to the front end. It receives regular updates and improvements. Bloomreach applies quality control to prevent accidental introduction of breaking changes.

SPA SDK packages are published on npmjs.org. The SDK source code is mirrored to GitHub.

Support, Dependencies, and Versioning

Bloomreach maintains a single release stream for the SPA SDKs. This release stream supports both brX Content (SaaS) and Bloomreach Content (on-premise or PaaS).

For each SPA SDK release, Bloomreach documents the following in the release notes:

1. Supported major versions of the Delivery API for both brX Content and Bloomreach Content.
2. Supported front-end frameworks, including:
   • The specific framework versions validated with the SDK. The SDK does not restrict use with newer framework versions, but you are responsible for validating compatibility. If you encounter issues with a newer framework version, contact Bloomreach Support to request compatibility updates.

Bloomreach supports older major versions of the Delivery API for at least one year after a new major version is released. Bloomreach monitors usage of deprecated APIs before removing support. Support for an old Delivery API version may be removed from the SDK before or after the API is removed from the back-end service.

Bloomreach aims to support the most recent versions of each front-end framework. New SPA SDK versions are tested against the latest supported framework version. The SDK is designed to avoid unnecessary dependencies on features only available in the newest framework releases, maintaining compatibility with a broad range of framework versions.

When the SPA SDK adopts a new framework feature that introduces a breaking change, the SDK major version number is incremented. The release notes will explicitly describe the breaking change.

Similarly, if the public JavaScript API (types, methods, etc.) changes in a way that is not backward compatible, the major version number increases. The release notes will document the breaking change and any required front-end adjustments.

If you need to use an older framework version while taking advantage of new brX Content or Bloomreach Content features, you may fork the SPA SDK and modify it as needed. Bloomreach does not support custom forks and recommends migrating away from them as soon as possible.