Releases: mobxjs/mobx-state-tree
v7.0.0
Breaking Changes
- Validate state tree instances instead of snapshots in the
SnapshotProcessor.isoverride by @airhorns in #2182 - Fix typings for snapshot processor by @thegedge in #2198
- Improve typing of the union dispatcher function by @thegedge in #2203
- Ensure actions/volatile state also throw when overriding props. by @thegedge in #2207
- Fix tsconfig and typechecking by @thegedge in #2200
Features
Fixes
Tests
Migration
TypeScript
Most of the breaking changes in this release have to do with changes in TypeScript. So you may find that you have to make adjustments to how you're typing your models, although we hope most of these changes improve your TypeScript experience overall.
Validating Tree Instances instead of Snapshots
Introduced in #2182, when comparing for equality on whether a model .is something, we now look at the actual instance, rather than the snapshot itself. In the past, if you were expecting snapshot processors to make two different sides of an .is operation inequal, you may need to find a new way to emulate that behavior, or otherwise change your logic. We are going to take a stronger, more defined stance for when .is should evaluate to true.
This is a somewhat advanced use case, and most users should not have to make any changes.
New Error Behavior when Overriding Props
Introduced in #2207, we will now throw errors when actions and volatile state override prop names. This probably would have been a bug in your application code before, but MST will now explicitly throw when it detects this pattern. You can migrate by choosing distinct names for props, volatile state, and actions.
Full Changelog: v6.0.1...v7.0.0
Contributors
Assets 2
v7.0.0-pre.2
Breaking Changes
- Validate state tree instances instead of snapshots in the
SnapshotProcessor.isoverride by @airhorns in #2182 - Fix typings for snapshot processor by @thegedge in #2198 (we also consider this a fix)
Features
Fixes
- Fix tsconfig and typechecking by @thegedge in #2200
- Fix typings for snapshot processor by @thegedge in #2198 (for some users, this may break types if you relied on prior type assumptions)
Migration Path
For most users, migrating from v6 -> v7 will be straightforward and require no work. However, we have made a breaking change in the assumption for types.snapshoProcessor and its is method.
In v6, we validated processed snapshots in this method. But now we will only validate instances. If you upgrade to v7 and all of your TypeScript types and runtime tests are passing, no additional work necessary on your end.
If this change has broken you, it may in fact be surfacing subtle bugs or gaps in your type modeling where your codebase is considering two different types to be "the same" because they have matching SnapshotOut shapes. If you need to preserve that behavior in your codebase, you might consider writing custom logic to check for this type of equality. MST is specifically taking a stance to check against Instances and valid SnapshotIn types.
The snapshot processor typings have also changed, which may break during upgrade, but for the most part we have relaxed them to be more correct. If you relied on old workarounds, you may be able to remove custom type assertions.
Full Changelog: v6.0.1...v7.0.0-pre.2
v7.0.0-pre.1
Breaking Changes
- Validate state tree instances instead of snapshots in the
SnapshotProcessor.isoverride by @airhorns in #2182
Migration Path
For most users, migrating from v6 -> v7 will be straightforward and require no work. However, we have made a breaking change in the assumption for types.snapshoProcessor and its is method.
In v6, we validated processed snapshots in this method. But now we will only validate instances. If you upgrade to v7 and all of your TypeScript types and runtime tests are passing, no additional work necessary on your end.
If this change has broken you, it may in fact be surfacing subtle bugs or gaps in your type modeling where your codebase is considering two different types to be "the same" because they have matching SnapshotOut shapes. If you need to preserve that behavior in your codebase, you might consider writing custom logic to check for this type of equality. MST is specifically taking a stance to check against Instances and valid SnapshotIn types.
Full Changelog: v6.0.1...v7.0.0-pre.1
v6.0.1
v6.0.0
Breaking Changes
- Eliminate
NonEmptyObjectby @thegedge in #2152 - Improved typing for union types by @thegedge in #2151
- fix #1530 array clear replace should produce one patch by @BrianHung in #2073
- Feat/has env and getenv changes by @coolsoftwaretyler in #2163
Features
- Added a new feature,
hasEnv, to support #2163
Fixes
- Union types will now be fixed, but this also may break TypeScript for some users
- Array operations produce condensed patches when we can, but this may break for some users who relied on the patch generation as it was
- fix: do not mutate properties object by model constructor by @dangreen in #2176
- Fix/get members 2173 by @evinosheaforward in #2174
- fix: #2138 linter issues with fail function by @JuanJo4 in #2171
Tests
- Test: convert to bun:test for our tests, remove codecov by @coolsoftwaretyler in #2149
Docs
- Docs/update docs homepage by @coolsoftwaretyler in #2141
- docs: fix typos in docs update by @coolsoftwaretyler in #2142
- Docs: add comparison between React Context/Reducer by @coolsoftwaretyler in #2158
Docs: add recipe for mst-form-type by @sherlockwang in #2168 - docs: fix broken link by @kylemeenehan in #2165
- docs: update TypeScript tips by @coolsoftwaretyler in #2166
- docs: add recipe for auto-generated property setters by @coolsoftwaretyler in #2169
- docs: correct bun run test to bun run test:all for new contributers by @evinosheaforward in #2177
Community/Developer Changes
- Chore/use bun as a package manager and script runner by @coolsoftwaretyler in #2148
- Bump typescript from 3.9.10 to 5.3.3 by @thegedge in #2146
- chore: remove unused, unnecessary custom Omit type #2167
New Contributors
- @thegedge made their first contribution in #2146
- @sherlockwang made their first contribution in #2168
- @dangreen made their first contribution in #2176
- @evinosheaforward made their first contribution in #2174
Full Changelog: v5.4.2...v6.0.0
Migration Guide from v5 to v6
TypeScript update
Make sure you're using TypeScript 5.3.3, and you have the following compiler flags:
{
"strictNullChecks": true,
"strictFunctionTypes": true,
"noImplicitAny": true,
"noImplicitReturns": true,
"noImplicitThis": true
}Or the shorthand:
{
"strict": true,
"noImplicitReturns": true
}Removing $nonEmptyObject
We removed the $nonEmptyObject key from the ModelCreationType. For the most part, this was an internal feature that would only have shown up in TypeScript errors. There is no runtime change, but if you have any custom typings that relied on something like [$nonEmptyObject] - you should be able to eliminate those.
Union Type Changes
In the past, named enumerations had more specific type than unnamed enumerations. You may have some TypeScript errors where you were using anonymous enumerations. You can type those with the union of literal values inside the enumeration now.
import { t } from "mobx-state-tree";
/**
* In MobX-State-Tree 5.4.1, this is typed as:
* ISimpleType<"Red" | "Orange" | "Green">
*/
const namedEnum = t.enumeration("Color", ["Red", "Orange", "Green"]);
/**
* In MobX-State-Tree 5.4.1, this is typed as:
* ISimpleType<string>
*/
const anonymousEnum = t.enumeration(["Red", "Orange", "Green"]);
/**
* If you use mobx-state-tree@^6.0.0, both of these will be typed as:
* ISimpleType<"Red" | "Orange" | "Green">
*/This has also fixed #1525 and #1664
For #1525, If you had models with properties that were unions including other models, you may have done some type assertions to resolve the issue. This should no longer be necessary. In most cases, we don't expect this to show up as errors. But the inferred types have changed. Look through your codebase for unions of models in the properties of other models, and if you hit any issues, you may be able to use better typing form here on out.
The issue presented itself in #1664 when using types with different creation and instance types which were passed to unions inside of arrays. If you see more TypeScript errors aside from the other items mentioned, look for types.union that creates a union which includes Array, Map, or Model types. If you had any custom type assertions, you may no longer need those.
Array operation patch changes
When an Array type calls clear, or splices itself from index 0, the generated patch is different. We have shortened the operations to be a patch like:
op: "replace", path: "", value: []
If you use onPatch and expect any specific shape of patches from Array.clear or Array.splice, you may need to update your app logic to handle the changed patch generation.
getEnv now throws
If you call getEnv and there is no environment, it will now throw an error. Previously, it would return an empty object.
Check your codebase for getEnv calls, and guard against this error with hasEnv, which will return true if the current state tree has an environment, or false if not.
v6.0.0-pre.3
Breaking Changes
- Bump typescript from 3.9.10 to 5.3.3 by @thegedge in #2146
- Eliminate
NonEmptyObjectby @thegedge in #2152 - Improved typing for union types by @thegedge in #2151
- fix #1530 array clear replace should produce one patch by @BrianHung in #2073
- Feat/has env and getenv changes by @t49tran in #2163
Features
- We added a new feature,
hasEnv, to support #2163
Fixes
- Union types will now be fixed, but this also may break TypeScript for some users
- Array operations produce condensed patches when we can, but this may break for some users who relied on the patch generation as it was
- Fix: do not mutate properties object by model constructor: by @dangreen in #2176
- Fix
getMembersduplicating actions into views by @evinosheaforward in #2174
Tests
- Test: convert to bun:test for tests, remove codecov by @coolsoftwaretyler in #2149
Docs
- Docs/update docs homepage by @coolsoftwaretyler in #2141
- docs: fix typos in docs update by @coolsoftwaretyler in #2142
- Docs: add comparison between React Context/Reducer by @coolsoftwaretyler in #2158
- Docs: add recipe for
mst-form-typeby @sherlockwang in #2168 - Docs: fix broken link by @kylemeenehan in #2165
Community/Developer changes
- Bump typescript from 3.9.10 to 5.3.3 by @thegedge in #2146
- Chore/use bun as a package manager and script runner by @coolsoftwaretyler in #2148
Full Changelog: v5.4.1...v6.0.0-pre.3
v5.4.2
Version 5.4.2 fixes a few regressions, and comes with documentation updates. Thanks to everyone who contributed!
Breaking Changes
No breaking changes
Features
No new features
Fixes
- Fix: do not mutate properties object by model constructor: #2176
- Fix
getMembersduplicating actions into views #2174
Tests
No new tests
Docs
- Docs: add comparison between React Context/Reducer: #2158
- Docs: fix broken link: #2165
- Docs: add recipe for
mst-form-type: #2168
New Contributors
Full Changelog: v5.4.1...v5.4.2
Contributors
Assets 2
v6.0.0-pre.2
Breaking Changes
- Bump typescript from 3.9.10 to 5.3.3 by @thegedge in #2146
- Eliminate
NonEmptyObjectby @thegedge in #2152 - Improved typing for union types by @thegedge in #2151
- fix #1530 array clear replace should produce one patch by @BrianHung in #2073
- Feat/has env and getenv changes by @t49tran in #2163
Features
- We added a new feature,
hasEnv, to support #2163
Fixes
- Union types will now be fixed, but this also may break TypeScript for some users
- Array operations produce condensed patches when we can, but this may break for some users who relied on the patch generation as it was
Tests
No new test-only contributions
Docs
- Docs/update docs homepage by @coolsoftwaretyler in #2141
- docs: fix typos in docs update by @coolsoftwaretyler in #2142
- Docs: add comparison between React Context/Reducer by @coolsoftwaretyler in #2158
Community/Developer changes
- Bump typescript from 3.9.10 to 5.3.3 by @thegedge in #2146
- Chore/use bun as a package manager and script runner by @coolsoftwaretyler in #2148
What's Changed
New Contributors
Full Changelog: v5.4.1...v6.0.0-pre.2
v5.4.2-pre.1
Version 5.4.2-pre.1 is an important build for everyone to test out, because it includes some TypeScript changes that could be seen as either bug fixes or breaking changes.
RFC - should we consider these changes bug fixes (bump to 5.4.2) or breaking changes (bump to 6.0.0)
import { t } from "mobx-state-tree";
/**
* In MobX-State-Tree 5.4.1, this is typed as:
* ISimpleType<"Red" | "Orange" | "Green">
*/
const namedEnum = t.enumeration("Color", ["Red", "Orange", "Green"]);
/**
* In MobX-State-Tree 5.4.1, this is typed as:
* ISimpleType<string>
*/
const anonymousEnum = t.enumeration(["Red", "Orange", "Green"]);
/**
* If you use [email protected], both of these will be typed as:
* ISimpleType<"Red" | "Orange" | "Green">
*/CodeSandbox for version 5.4.2-pre.1
It's reasonable to call this change a "bug fix", but for projects that relied on the prior behavior, a patch version might "break" their TypeScript types, if they've typed around our existing bug.
The change comes from #2151, which also "fixes" #1525 and #1664 again, by changing types.
We have also removed NonEmptyObject. If a project had relied on that for any kind of type casting, I think that could also be seen as a breaking change.
And of course, we've moved to TypeScript 5.3.3, which shouldn't have a direct impact downstream, but we have previously only called out TS 3.0 or later. This is not strictly a breaking change, and it's technically in line with "TypeScript 3.0 or later", but it could be seen as disruptive to move so far ahead in TypeScript without ample warning in our version.
Breaking Changes
- Improved typing for union types by @thegedge in #2151 (maybe, see introduction)
- Eliminate
NonEmptyObjectby @thegedge in #2152 (maybe, see introduction) - Bump typescript from 3.9.10 to 5.3.3 by @thegedge in #2146
Features
- No new features
Fixes
Tests
- No test-only additions.
Docs
- Docs/update docs homepage by @coolsoftwaretyler in #2141
- chore: version bump to 5.4.2-pre.1 by @coolsoftwaretyler in #2159
- docs: fix typos in docs update by @coolsoftwaretyler in #2142
Community/Developer changes
- Chore/use bun as a package manager and script runner by @coolsoftwaretyler in #2148
New Contributors
Full Changelog: v5.4.1...v5.4.2-pre.1
v5.4.1
Version 5.4.1 fixes a small import bug, and updates tests and documentation. Thanks to everyone who contributed!
Breaking Changes
No breaking changes
Features
No new features
Fixes
Tests
- test: add t.number tests by @coolsoftwaretyler in #2123
- test: add tests for boolean primitive by @coolsoftwaretyler in #2124
- test: add tests for types.Date by @coolsoftwaretyler in #2125
- test: write tests for object-node class by @coolsoftwaretyler in #2127
Docs
- fix: documentation typo by @jonstuebe in #2129
- Docs: update docs to match the code for addMiddleware by @kylemeenehan in #2135
- chore: bump version, build docs, deploy docs by @coolsoftwaretyler in #2139
New Contributors
- @jonstuebe made their first contribution in #2129
Full Changelog: v5.4.0...v5.4.1
