mobx-keystone 2.0.0 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # Change Log
 
+## 2.2.0
+
+- Now requires TypeScript 5.4 or newer (the types use the built-in `NoInfer`).
+- Faster TypeScript type-checking of models and runtime types: the snapshot, model data and `types.object` type mappings now create far fewer type instantiations (about 35% fewer in a typical model-heavy project), with no change to the resulting types. `tProp` defaults, `fromSnapshot(type, snapshot)`, `getSnapshot(type, value)` and `applySnapshot` no longer infer their type parameter from the data / snapshot argument, which makes those calls much cheaper to type-check (e.g. about 40% fewer instantiations for a typed `fromSnapshot` call). The `@model` decorator also no longer computes the creation data type of the decorated class. A typed `fromSnapshot(type, snapshot)` call now also accepts the output snapshot type of `type` (which must always round-trip, as with `applySnapshot` and the untyped `fromSnapshot(snapshot)`), so round trips such as `fromSnapshot(M, getSnapshot(m))` no longer compare the output and input snapshot types (about 65% cheaper to type-check).
+- Smaller and faster declaration (`.d.ts`) emit for exported model classes: the types of `idProp` and `tProp` properties (`TypedModelIdProp`, `TypedMaybeOptionalModelProp`, `TypedOptionalModelProp`) and `CodecFromEncoded` are now exported, so emitted declarations reference them by name instead of expanding them inline.
+- Fixed the types of `tProp` codec props (e.g. `tProp(types.dateAsTimestamp)`) after `.withSetter()`, `.withSnapshotProcessor()` or `.withTransform()`: `$` and snapshots now use the encoded type (e.g. `number`) instead of the runtime type (e.g. `Date`). The new `ModelPropWithSetter`, `ModelPropWithSnapshotProcessor` and `ModelPropWithTransform` types describe the props these modifiers return.
+- Fixed `applySnapshot` throwing when the snapshot adds an object under a key named like an `Object.prototype` member (e.g. `toString` or `constructor`).
+- Fixed `Draft`'s `isDirty` not being cached and `commit` / `reset` not running as MobX actions with MobX 6.
+- `fromSnapshot` (and `cloneTreeValue` for plain objects / arrays) now reports a clear error when the snapshot contains tree nodes, instead of a generic "unsupported snapshot".
+- Fixed `ArraySet` set operations (`union`, `intersection`, `isSubsetOf`, etc.) throwing on runtimes without the native ES2025 `Set` methods.
+
+## 2.1.0
+
+- [BREAKING CHANGE] `UndoStore` keeps undo/redo events as frozen data, making recording ~4x faster and undo/redo ~3x faster:
+  - Snapshots and patches store events as `{ $frozen: true, data: event }`. Older snapshots still load, but earlier versions cannot load newer ones.
+  - Events passed when creating an `UndoStore` must be wrapped with `frozen(event)`.
+  - `undoQueue` / `redoQueue` events are plain objects, and attached states are no longer copied.
+- Performance on large trees: operations that used to rescan or rebuild state for the whole tree now only update what changed (e.g. at 16,000 items, from milliseconds to microseconds):
+  - array splices (`shift`, `unshift`, `splice`, `detach`);
+  - `rootRef` / `resolveId` and `getRefsResolvingTo`;
+  - structural `applyPatches` / `applySnapshot`, which also makes undo/redo no longer quadratic when the `UndoStore` is inside the tracked tree;
+  - `getSnapshot` / `onSnapshot` after splices and key changes;
+  - `onChildAttachedTo`;
+  - runtime type checking of large arrays, records and `ObjectMap`s, and of key changes in deep trees;
+  - transactions, which no longer build patches to roll back.
+- Tree nodes use ~30% less memory and are ~15% faster to create. Models without MobX decorators no longer get a MobX observable administration, so `isObservableObject(model)` is now `false` for them.
+- Rejected tree changes (e.g. assigning a `Map`, a node that already has a parent, or the same node twice) now leave the tree unchanged instead of half-changed.
+- Inserting an array item at its own index (e.g. `arr.unshift(arr[0])`) now throws instead of putting the same node in the array twice.
+- `applySnapshot` / `applyPatches` now undo their changes when they throw partway.
+- Fixed `transactionMiddleware` / `@transaction` not fully restoring the state when the failed action detached, changed and reattached a model.
+- Fixed `applySnapshot` / `applyPatches` not reusing a model whose id had changed.
+- Fixed `onAttachedToRootStore` not being called for models inside a plain tree node attached to a root store.
+
 ## 2.0.0
 
 - [BREAKING CHANGE] Preserve repeated property names and array indexes in type-check error paths when validating an attached subtree. Paths supplied to `TypeCheckError` and `TypeCheckErrorFailure` are now consistently treated as relative to the checked value; manually supplied rooted paths are no longer detected automatically.

package/README.md

@@ -136,7 +136,7 @@ This library requires a modern JavaScript environment with support for:
 
 In practice, this covers current browsers and Node.js releases, but not Internet Explorer.
 
-TypeScript 5.0 or newer is recommended so you can use standard decorators. Legacy decorators remain supported by `mobx-keystone`; see the [installation guide](https://mobx-keystone.js.org/installation) for the required compiler configuration and the MobX 7 compatibility note.
+When using TypeScript, version 5.4 or newer is required. Legacy decorators remain supported by `mobx-keystone`; see the [installation guide](https://mobx-keystone.js.org/installation) for the required compiler configuration and the MobX 7 compatibility note.
 
 ## Installation