Angular SDK migration guide
Upgrading to the new SDK libraries
The Angular SDK node packages have been updated to support Workspaces, introduced in FlowX.AI v5.0. All container apps that want to use the new SDKs should update to the latest package versions and implement the required workspace configuration.Remove old packages and install new FlowX.AI v5.0 packages
- Remove old FlowX.AI SDK libraries (if upgrading from earlier versions):
- Install new FlowX.AI v5.0 packages:
<version>
with the correct version corresponding to your FlowX.AI v5.0 platform version. Check: Release Notes → v5.0 → Deployment guidelines → Component versions.Verify Angular dependencies
- Ensure your Angular version is compatible:
- Verify system requirements:
- Node.js: v20.9.0 or higher
- npm: v10.1.0 or higher
- Angular: ~19
Update flx-process-renderer configuration
- Run through all the migration steps in the New SDK API changes section below.
SDK API changes
In the Angular SDK, the<flx-process-renderer>
component has a new mandatory parameter: workspaceId
.
Name | Description | Type | Requirement |
---|---|---|---|
workspaceId | Workspace identifier that contains the project and process to be started | string | Mandatory |
<flx-process-renderer>
component:
Task management component changes
The task management component now also requires workspace context:React SDK migration guide
Upgrading to the new SDK libraries
The React SDK node packages have been updated to support Workspaces, introduced in FlowX.AI v5.0. All container apps that want to use the new SDKs should update to the latest package versions and implement the required workspace configuration.Remove old packages and install new FlowX.AI v5.0 packages
- Remove old FlowX.AI SDK libraries:
- Install new FlowX.AI v5.0 packages:
<version>
with the correct version corresponding to your FlowX.AI v5.0 platform version. Check: Release Notes → v5.0 → Deployment guidelines → Component versions.Update React dependencies (if needed)
- Ensure your React version is compatible:
- Verify Node.js version compatibility:
- Node.js: v18.16.9 or higher
- npm: v10.8.0 or higher
Update FlxProcessRenderer configuration
- Run through all the migration steps in the New SDK API changes section below.
New SDK API changes
In the React SDK, the<FlxProcessRenderer>
component has a new mandatory parameter: workspaceId
.
Name | Description | Type | Requirement |
---|---|---|---|
workspaceId | Workspace identifier that contains the project and process to be started | string | Mandatory |
<FlxProcessRenderer>
component:
Task management component changes
The task management component now also requires workspace context:Android SDK migration guide
System requirements
System requirements:- minSdk = 26
- compileSdk = 35
- Android Gradle Plugin 8.11.0
- Gradle 8.14.2
- Kotlin 2.2.0
Library dependencies
Impactful dependencies:- Android Core KTX 1.16.0
- Android Activity Compose 1.10.1
- Compose BOM 2025.06.01
- Compose Navigation 2.9.1
- Android Lifecycle 2.9.1
- Accompanist Permissions 0.37.3
- Kotlin Coroutines 1.10.2
- Android DataStore 1.1.7
- Android Preference 1.2.1
- Android Security 1.1.0-beta01
- OkHttp BOM 4.12.0
- Retrofit 2.12.0
- Moshi 1.15.2
- Coil BOM 3.2.0
- Android Core Library Desugaring 2.1.5
- Android Annotation 1.9.1
- Google Protobuf 4.31.1
- Mozilla Rhino 1.8.0
- JetBrains Markdown 0.7.3
- CommonMark 0.25.0
It is highly recommended that the container projects to be aligned with these versions in order to avoid any compatibility issues.
New SDK Migration Guide
To successfully build and run your project with the updated SDK, please follow these sequential steps within your container project:Update dependency coordinates
Increase the `compileSdk` version to `35`
Recommendation: Upgrade JVM compatibility to Java 17
Update the `Android Gradle plugin` version to at least `8.10.0`
Update `Gradle` version to at least `8.11.1`
Update `Kotlin` version to at least `2.2.0`
Apply the `Compose Compiler Gradle plugin`
Enable core library desugaring
Ensure your `android.app.Application` extending class implements the `FlowxOwner` interface
Rename `FlowxSdkApi` class to `Flowx` and update imports accordingly
FlowxSdkApi.getInstance()
must be replaced with Flowx.getInstance()
.Update the `Flowx.getInstance().init()` method parameters
Detailed step-by-step changes
Detailed step-by-step changes
Rename the `SdkConfig` class to `Config` and update imports accordingly
config
parameter is no longer a data class
. It is now an interface
.Remove the `enableLog` flag from the configuration parameters
FxLogger
interface may be provided during initialization when logging functionality is requiredRemove the `accessTokenProvider` parameter from the initialization parameters (if previously used)
Flowx.getInstance().setAccessToken(accessToken: String?)
method with the appropriate argumentRefer to the following steps for detailed information about the authentication process migration
Update main imports for `Custom` provided UI components (if used explicitly)
Update `Analytics` related imports
Update `NewProcessStartedHandler` related imports (if used explicitly)
Update the method for providing access tokens
setAccessTokenProvider
method on the SDK instance has been replaced with setAccessToken
.setAccessTokenProvider
must be replaced with calls to setAccessToken
:`closeModalFunc` is now scoped to the `CloseModalProcessScope`
CloseModalProcessConfirmAlert
, the closeModalFunc
lambda passed as a parameter when starting (i.e. Flowx.getInstance.startProcess(...)
) or continuing (i.e. Flowx.getInstance.continueProcess(...)
) is now scoped to the CloseModalProcessScope
interface, which allows that.Update custom components implementation
- The
CustomComposable
class has been renamed toCustomComponent
. - All deprecated properties, methods, and interfaces have been removed. Support for the Android classical View system has been completely discontinued.
- The
provideCustomComposableComponent()
method withinCustomComponentsProvider
has been replaced withfun provideCustomComponent(): CustomComponent?
. - The
CustomComposableComponent
class has been removed. - The provided @Composable function passed to the
composable
property of theCustomComponent
interface can now only exist and be called within the context of aCustomComponentScope
receiver.
CustomComponentScope
receiver (i.e., they can now be called only from within a custom component implementation).CustomComponentScope
are now called through the actual scope itself, rather than relying on Flowx.getInstance()
, since they are no longer visible on the SDK instance.- The
CustomComponentAction
is no longer adata class
as before. It is now aninterface
.
The exposed data has been reduced to the maximum required for executing the action:
- When querying for an enumeration by calling the
CustomComponentScope.getEnumeration(...)
method, the returned type has changed fromList<FxEnumerationItem>
toFxEnumeration
Update custom stepper header implementation
- The
ComposableStepperHeader
class has been renamed toCustomStepperHeader
. - The
CustomStepperHeaderData
class has been moved under theCustomStepperHeader
and renamed toData
. - The
provideCustomComposableStepperHeader()
method withinCustomStepperProvider
has been replaced withfun provideCustomStepperHeader(): CustomStepperHeader?
. - The
CustomComposableStepperHeader
class has been removed.
Remove usage of the undocumented `updateConfig(config: SdkConfig)` function
changeEnvironment
method available on the SDK instance.iOS SDK migration guide
SDK API changes
Start process
The start process API require aworkspaceId
.
Setup theme
The setup theme API requires aworkspaceId
.