Update orbitMVI to v12

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
org.orbit-mvi:orbit-viewmodel	4.6.1 → 12.0.0
org.orbit-mvi:orbit-core	4.6.1 → 12.0.0

---

Release Notes

orbit-mvi/orbit-mvi (org.orbit-mvi:orbit-viewmodel)

v12.0.0

Compare Source

One container host to rule them all

The headline change in this release is the unification of Orbit's container host API. Until now, external state support lived in a parallel universe of types: ContainerHost sat alongside ContainerHostWithExternalState, Container alongside ContainerWithExternalState, and each pair dragged its own set of factory functions and extensions across the core, compose, viewmodel and test modules. Choosing to separate your internal and external state meant switching to an entirely different interface hierarchy, and the duplication made every feature twice as expensive to build and document.

That split is now gone. A single OrbitContainerHost<INTERNAL_STATE, EXTERNAL_STATE, SIDE_EFFECT> interface (backed by a matching OrbitContainer) covers both cases. A host that doesn't need the separation simply uses the same type for both state parameters — OrbitContainerHost<MyState, MyState, MySideEffect> — while a host that wants to keep a rich internal model and expose a lean UI-facing state declares two different types and supplies a transform to the new orbitContainer(initialState, transformState) factory. The container() factory functions on CoroutineScope and ViewModel have been renamed to orbitContainer() to match.

We decided to add the Orbit prefix to main library types, as the historical ones were too generic and this planned unification gave us a good opportunity to fix this.

Migration should be painless: the old names survive as deprecated typealiases with ReplaceWith guidance, so existing ContainerHost<S, SE> code compiles unchanged and the IDE can rewrite it for you. The withExternalState extension is deprecated in favour of the unified factory, and in the test module test() is deprecated in favour of testWithInternalState() and testWithExternalState(), whose assertion methods now say which state they mean (awaitInternalState(), expectExternalState(), and so on). The documentation has been rewritten around the unified API.

The unified path also picked up two correctness fixes along the way. Subscribing to a container's external state flows now triggers onCreate, which previously only fired for internal state and side effect subscriptions — despite the external flows being exactly what UI consumers collect. And testWithExternalState now seeds the initial external state correctly for hosts still built with the deprecated withExternalState, where it previously resolved the wrong transform and failed with a ClassCastException.

Side effect delivery modes

Side effects have historically assumed a single observer. This release introduces a SideEffectMode setting with three delivery strategies: FAN_OUT, the default, preserves the existing channel-based behaviour where each effect goes to exactly one consumer; FAN_OUT_STRICT does the same but throws if a second consumer ever attaches, turning a silent misconfiguration into a loud one; and the experimental BROADCAST delivers every effect to all active consumers and has a cache that holds effects while no one is listening with the same lossless backpressure as fan-out.

Configuring containers globally

Orbit.configureDefaults { } lets you set default container settings once at app startup instead of repeating them at every orbitContainer() call, with per-container settings still taking precedence. Relatedly, the dispatcher settings (eventLoopDispatcher, intentLaunchingDispatcher) are now factories of type () -> CoroutineDispatcher, invoked once per container — so an expression like Dispatchers.Default.limitedParallelism(1) in the global defaults gives each container its own dispatcher view rather than one shared app-wide. If you set these directly, wrap the value in a lambda.

Operators

runOn and subIntent have graduated to stable API and no longer require opting in to @OrbitExperimental. Joining them is the new experimental awaitRunOn<T>, designed for sealed-class states: where runOn returns immediately if the current state doesn't match, awaitRunOn suspends until the state becomes the requested subtype and then runs its block — handy for logic that should kick in once a Loading state resolves to Ready. Thank you to @​rubixhacker for the proposal and implementation.

Documentation

The docs website gained a version selector generated from release tags, so the site root always serves the docs for the latest release while unreleased documentation is published under /next/.

Detailed Changes

• Unify ContainerHost and ContainerHostWithExternalState by @​Rosomack in #​320
• Update docs for unified OrbitContainerHost API by @​Rosomack in #​321
• docs: add caution about suspend functions in reduce block by @​a0100019 in #​329
• Add broadcast side effect mode for multi-consumer support by @​Rosomack in #​322
• Add a strict fan out mode that errors on multiple consumers by @​mattmook in #​330
• Trigger onCreate when subscribing to external state flows by @​Rosomack in #​334
• Add global default container settings by @​Rosomack in #​336
• Add awaitRunOn for sealed class states by @​rubixhacker in #​325
• Fix broadcast side effect re-firing on re-subscription by @​Rosomack in #​335
• Make dispatcher settings per-container factories by @​Rosomack in #​337
• Document awaitRunOn and stabilise runOn/subIntent by @​Rosomack in #​338
• Fix testWithExternalState initial state seeding for deprecated withExternalState hosts by @​Rosomack in #​339
• Add docs version selector generated from release tags by @​Rosomack in #​340
• Fix ContainerLifecycleTest compilation after dispatcher factory change by @​Rosomack in #​342

New Contributors

• @​a0100019 made their first contribution in #​329
• @​rubixhacker made their first contribution in #​325

Full Changelog: orbit-mvi/orbit-mvi@11.0.0...12.0.0-3-SNAPSHOT

v11.0.0: Orbit internal/external state support

Compare Source

We added a new ContainerHostWithExternalState to support mapping internal ContainerHost states into something more easily consumed by UIs :)

What's Changed

• Add BCV to the project by @​Rosomack in #​290
• Add missing targets to viewmodel and compose by @​mattmook in #​292
• Add icon for IDEA to see by @​Goooler in #​295
• Improve build performance by @​mattmook in #​298
• Add error handling and some tests to the CMP example by @​mattmook in #​296
• Add Container with internal and external states by @​mattmook in #​294

New Contributors

• @​Goooler made their first contribution in #​295

Full Changelog: orbit-mvi/orbit-mvi@10.0.0...11.0.0-SNAPSHOT

v10.0.0

Compare Source

New features

• Support for all Kotlin Multiplatform platforms.
• ViewModel Multiplatform and Compose Multiplatform support, with a new Compose Multiplatform sample app.
• expectStateOn to better support sealed class state testing

API changes

orbit-core

• [Breaking] blockingIntent is now an extension function.

orbit-compose

• [Breaking] Removed deprecated collectState from ContainerHostExtensionsKt

orbit-test

• Initial state is now automatically asserted in tests, deprecating expectInitialState(). TestSettings.autoCheckInitialState can be used to override this behaviour.
• expectStateOn added.

orbit-viewmodel

• Added kotlinx serializable for savedstatehandle support

What's Changed

• Update to latest dependencies by @​mattmook in #​237
• Add extended platform support by @​mattmook in #​238
• ViewModel multiplatform and Compose multiplatform support by @​mattmook in #​239
• Update README.md by @​mattmook in #​249
• Replace AtomicFu with Kotlin standard library implementation by @​mattmook in #​251
• Auto check initial state in tests by @​mattmook in #​250
• Fix broken Container Settings links by @​mattmook in #​252
• Add expectStateOn test function by @​mattmook in #​258
• Ensure transitive dependencies we expose directly are exported by @​mattmook in #​259
• Update documentation for multiplatform by @​mattmook in #​260
• Create plugin to retrieve latest release from github by @​mattmook in #​262
• Bump image-size from 1.2.0 to 1.2.1 in /website by @​dependabot in #​264
• Bump @​babel/runtime from 7.19.0 to 7.27.0 in /website by @​dependabot in #​265
• Bump serialize-javascript from 6.0.0 to 6.0.2 in /website by @​dependabot in #​266
• Bump cross-spawn from 7.0.3 to 7.0.6 in /website by @​dependabot in #​267
• Bump micromatch from 4.0.5 to 4.0.8 in /website by @​dependabot in #​270
• Bump express from 4.18.1 to 4.21.2 in /website by @​dependabot in #​268
• Bump http-proxy-middleware from 2.0.6 to 2.0.7 in /website by @​dependabot in #​269
• Bump braces from 3.0.2 to 3.0.3 in /website by @​dependabot in #​271
• Bump follow-redirects from 1.15.1 to 1.15.9 in /website by @​dependabot in #​272
• Bump estree-util-value-to-estree from 3.3.2 to 3.3.3 in /website by @​dependabot in #​275
• Bump http-proxy-middleware from 2.0.7 to 2.0.9 in /website by @​dependabot in #​276
• Update to latest dependencies inc Kotlin 2.1.21 by @​mattmook in #​279
• Fix tag build deployment by @​mattmook in #​278
• Ensure runTest correctly wraps tests by @​mattmook in #​274
• Compose multiplatform sample by @​mattmook in #​253
• Remove runBlocking from RealContainer by @​mattmook in #​263
• Example of Compose TextField state hoisting by @​mattmook in #​283
• Enable js support by @​mattmook in #​282
• Add compose multiplatform web target to sample app by @​mattmook in #​287
• Update README for v10.0.0 release. by @​mattmook in #​261
• Enable jacoco coverage for multiplatform by @​mattmook in #​288
• Documentation and dependency updates by @​mattmook in #​289

Full Changelog: orbit-mvi/orbit-mvi@9.0.0...10.0.0

v9.0.0

Compare Source

What's Changed

• Upgrade deprecated build actions by @​mattmook in #​226
• Pull syntax functions down into the relevant classes instead of relyi… by @​Rosomack in #​225
• Fix build error by @​Rosomack in #​227

Full Changelog: orbit-mvi/orbit-mvi@8.0.0...9.0.0

Breaking changes

Syntax extension functions have been pulled up to reduce internal complexity and open up new functionality, such as reified types on runOn.

Migration guide

API	Pre-9.0.0	9.0.0	Action to take
class SimpleSyntax	org.orbitmvi.orbit.syntax.simple.SimpleSyntax	Renamed to org.orbitmvi.orbit.syntax.Syntax	Search and replace imports and usages
class SimpleContext	org.orbitmvi.orbit.syntax.simple.SimpleContext	Renamed to org.orbitmvi.orbit.syntax.IntentContext	Search and replace imports and usages
extension function ContainerHost.intent	org.orbitmvi.orbit.syntax.simple.intent	Moved into ContainerHost interface	Remove import
extension function ContainerHost.blockingIntent	org.orbitmvi.orbit.syntax.simple.blockingIntent	Moved into ContainerHost interface	Remove import
extension function ContainerHost.subIntent	org.orbitmvi.orbit.syntax.simple.subIntent	Moved into ContainerHost interface	Remove import
extension function SimpleSyntax.postSideEffect	org.orbitmvi.orbit.syntax.simple.postSideEffect	Moved into Syntax class	Remove import
extension function SimpleSyntax.reduce	org.orbitmvi.orbit.syntax.simple.reduce	Moved into Syntax class	Remove import
extension function SimpleSyntax.repeatOnSubscription	org.orbitmvi.orbit.syntax.simple.repeatOnSubscription	Moved into Syntax class	Remove import
extension function SimpleSyntax.runOn	org.orbitmvi.orbit.syntax.simple.runOn	Moved into Syntax class	Remove import
extension function SimpleSyntax.runOn	runOn(ExampleState.Ready::class)	Uses reified type parameter now runOn<ExampleState.Ready>	Search and replace

v8.0.0

Compare Source

What's Changed

• Remove old test framework by @​mattmook in #​218
• Removed dead code by @​Rosomack in #​220
• Refactor test names, get rid of runblocking by @​Rosomack in #​221

Breaking changes

The old testing framework has been deprecated for a long while. The time has come to prune it from the library.

In case your project is still using old style tests, use https://github.com/orbit-mvi/orbit-mvi/tree/7.2.0 until your tests are migrated to the new test style.

Alternatively, you can copy the testing classes from https://github.com/orbit-mvi/orbit-mvi/tree/7.2.0 into your project to unlock the upgrade to 8.0.0 and beyond. Please note no support will be provided for the old testing framework.

Full Changelog: orbit-mvi/orbit-mvi@7.2.0...8.0.0

v7.2.0

Compare Source

What's Changed

• Update to latest dependencies by @​mattmook in #​217
• Fix state is not saved to SavedStateHandle by @​ycuwq in #​216

Full Changelog: orbit-mvi/orbit-mvi@7.1.0...7.2.0

v7.1.1

Compare Source

What's Changed

• Fix state is not saved to SavedStateHandle by @​ycuwq #​216

New Contributors

• @​ycuwq made their first contribution in #​216

Full Changelog: orbit-mvi/orbit-mvi@7.1.0...7.1.1

v7.1.0

Compare Source

What's Changed

• Improve sealed class state support by @​Rosomack in #​214

Full Changelog: orbit-mvi/orbit-mvi@7.0.1...7.1.0

v7.0.1

Compare Source

What's Changed

• Exposed option to alter side effect buffer size

Full Changelog: orbit-mvi/orbit-mvi@7.0.0...7.0.1

v7.0.0

Compare Source

What's Changed

• Fix Detekt by @​TWiStErRob in #​199
• Update Turbine to 1.0.0 by @​chrisbanes in #​206
• Remove experimental annotations from stable APIs by @​Rosomack in #​209
• Add subintents API by @​Rosomack in #​210
• Fix repeatOnSubscription to take into account external subscribers only by @​Rosomack in #​211

New Contributors

• @​chrisbanes made their first contribution in #​206

Full Changelog: orbit-mvi/orbit-mvi@6.1.1...7.0.0

v6.1.1

Compare Source

What's Changed

• Fix compose extensions capturing lambda parameters forever by @​Rosomack in #​208

Full Changelog: orbit-mvi/orbit-mvi@6.1.0...6.1.1

v6.1.0

Compare Source

This is a maintenance release. We've made some (non-breaking) changes to the new tests API to clean it up a little.

What's Changed

• Update the docs for 6.0.0 by @​Rosomack in #​173
• Update to new Orbit Multiplatform logo by @​mattmook in #​174
• Bump semver from 5.7.1 to 5.7.2 in /website by @​dependabot in #​183
• Minor build files cleanup by @​TWiStErRob in #​178
• Add expectNoItems to OrbitTestContext by @​abyrnes in #​195
• Fix/orbit 6 issues by @​Rosomack in #​193

New Contributors

• @​TWiStErRob made their first contribution in #​178
• @​abyrnes made their first contribution in #​195

Full Changelog: orbit-mvi/orbit-mvi@6.0.0...6.1.0-SNAPSHOT

v6.0.0: New test framework stable

Compare Source

Description

New testing framework

The new testing framework has been proved in a real project, tested, cleaned up and released as Stable!

Check out the documentation here:
https://orbit-mvi.org/Test/new

The old testing framework is now deprecated and will be removed in 7.0.0, as we want to encourage the transition.

OnCreate changes

The onCreate lambda is now an intent to improve consistency and enable improved testing functionality.

Deprecated functions removed

Some variants of test livetest and container have been removed.

Functional changes

• Old testing framework deprecated - this is the last major version to support the old testing framework.
• New testing framework promoted to stable 🎉
• [BREAKING] onCreate lambda in container factory functions is now an implicit intent. This creates more consistency in the APIs and supports new test functionality.
• [BREAKING] intent now returns a coroutine Job
• New testing framework changes:
  • runOnCreate and invokeIntent now return a coroutine Job to allow us to join or cancel the job for that intent in tests.
  • [BREAKING] At the end of the test, the framework checks if all in progress intents are finished, fails otherwise.
• [BREAKING] Removed some of the deprecated test, liveTest and container functions

What's Changed

• Bump @​sideway/formula from 3.0.0 to 3.0.1 in /website by @​dependabot in #​160
• Fix kotlin-test-junit implementation by @​ycuwq in #​162
• Add intent jobs by @​Rosomack in #​165
• Add coroutine names to orbit intents by @​Rosomack in #​166
• Merge release 5.0.0 into main by @​mattmook in #​171

New Contributors

• @​ycuwq made their first contribution in #​162

Full Changelog: orbit-mvi/orbit-mvi@5.0.0...6.0.0

v5.0.0: Dependency updates

Compare Source

Notable changes:

Below are potentially breaking changes depending on your project setup:

• Kotlin version bumped to 1.8.21
• Coroutines version bumped to 1.7.1
• Java version bumped to 11

What's Changed

• Bump webpack from 5.74.0 to 5.76.1 in /website by @​dependabot in #​159
• Introduce versions catalog and update all dependencies by @​mattmook in #​161
• Update version updates branch to Kotlin 1.8.21 and other dependences by @​mattmook in #​169

Full Changelog: orbit-mvi/orbit-mvi@4.6.1...5.0.0

---

Configuration

📅 Schedule: (UTC)

• Branch creation
  • At any time (no schedule defined)
• Automerge
  • At any time (no schedule defined)

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.