xstate 4.28.1 → 4.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +139 -91
- package/README.md +5 -5
- package/dist/xstate.js +1 -1
- package/dist/xstate.web.js +2 -2
- package/es/Actor.d.ts +1 -2
- package/es/Machine.d.ts +5 -4
- package/es/State.d.ts +13 -11
- package/es/StateNode.d.ts +22 -17
- package/es/StateNode.js +7 -7
- package/es/actions.d.ts +3 -4
- package/es/behaviors.d.ts +1 -1
- package/es/devTools.d.ts +3 -4
- package/es/each.d.ts +1 -1
- package/es/index.d.ts +3 -2
- package/es/index.js +1 -1
- package/es/interpreter.d.ts +37 -26
- package/es/model.d.ts +2 -2
- package/es/model.types.d.ts +8 -9
- package/es/schema.d.ts +1 -0
- package/es/schema.js +2 -1
- package/es/scxml.d.ts +2 -2
- package/es/stateUtils.d.ts +6 -5
- package/es/typegenTypes.d.ts +121 -0
- package/es/types.d.ts +105 -55
- package/es/utils.d.ts +1 -1
- package/es/utils.js +1 -1
- package/lib/Actor.d.ts +1 -2
- package/lib/Machine.d.ts +5 -4
- package/lib/State.d.ts +13 -11
- package/lib/StateNode.d.ts +22 -17
- package/lib/StateNode.js +7 -7
- package/lib/actions.d.ts +3 -4
- package/lib/behaviors.d.ts +1 -1
- package/lib/devTools.d.ts +3 -4
- package/lib/each.d.ts +1 -1
- package/lib/index.d.ts +3 -2
- package/lib/index.js +1 -0
- package/lib/interpreter.d.ts +37 -26
- package/lib/model.d.ts +2 -2
- package/lib/model.types.d.ts +8 -9
- package/lib/schema.d.ts +1 -0
- package/lib/schema.js +2 -0
- package/lib/scxml.d.ts +2 -2
- package/lib/stateUtils.d.ts +6 -5
- package/lib/typegenTypes.d.ts +121 -0
- package/lib/typegenTypes.js +2 -0
- package/lib/types.d.ts +105 -55
- package/lib/utils.d.ts +1 -1
- package/lib/utils.js +1 -1
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,53 @@
|
|
|
1
1
|
# xstate
|
|
2
2
|
|
|
3
|
+
## 4.29.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [#2674](https://github.com/statelyai/xstate/pull/2674) [`1cd26811c`](https://github.com/statelyai/xstate/commit/1cd26811cea441366a082b0f77c7a6ffb135dc38) Thanks [@Andarist](https://github.com/Andarist)! - Using `config.schema` becomes the preferred way of "declaring" TypeScript generics with this release:
|
|
8
|
+
|
|
9
|
+
```js
|
|
10
|
+
createMachine({
|
|
11
|
+
schema: {
|
|
12
|
+
context: {} as { count: number },
|
|
13
|
+
events: {} as { type: 'INC' } | { type: 'DEC' }
|
|
14
|
+
}
|
|
15
|
+
})
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
This allows us to leverage the inference algorithm better and unlocks some exciting possibilities for using XState in a more type-strict manner.
|
|
19
|
+
|
|
20
|
+
* [#2674](https://github.com/statelyai/xstate/pull/2674) [`1cd26811c`](https://github.com/statelyai/xstate/commit/1cd26811cea441366a082b0f77c7a6ffb135dc38) Thanks [@Andarist](https://github.com/Andarist), [@mattpocock](https://github.com/mattpocock)! - Added the ability to tighten TS declarations of machine with generated metadata. This opens several exciting doors to being able to use typegen seamlessly with XState to provide an amazing typing experience.
|
|
21
|
+
|
|
22
|
+
With the [VS Code extension](https://marketplace.visualstudio.com/items?itemName=statelyai.stately-vscode), you can specify a new attribute called `tsTypes: {}` in your machine definition:
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
const machine = createMachine({
|
|
26
|
+
tsTypes: {}
|
|
27
|
+
});
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
The extension will automatically add a type assertion to this property, which allows for type-safe access to a lot of XState's API's.
|
|
31
|
+
|
|
32
|
+
⚠️ This feature is in beta. Actions/services/guards/delays might currently get incorrectly annotated if they are called "in response" to always transitions or raised events. We are working on fixing this, both in XState and in the typegen.
|
|
33
|
+
|
|
34
|
+
### Patch Changes
|
|
35
|
+
|
|
36
|
+
* [#2962](https://github.com/statelyai/xstate/pull/2962) [`32520650b`](https://github.com/statelyai/xstate/commit/32520650b7d6b43e416b896054033432aaede5d5) Thanks [@mattpocock](https://github.com/mattpocock)! - Added `t()`, which can be used to provide types for `schema` attributes in machine configs:
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
import { t, createMachine } from 'xstate';
|
|
40
|
+
|
|
41
|
+
const machine = createMachine({
|
|
42
|
+
schema: {
|
|
43
|
+
context: t<{ value: number }>(),
|
|
44
|
+
events: t<{ type: 'EVENT_1' } | { type: 'EVENT_2' }>()
|
|
45
|
+
}
|
|
46
|
+
});
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
- [#2957](https://github.com/statelyai/xstate/pull/2957) [`8550ddda7`](https://github.com/statelyai/xstate/commit/8550ddda73e2ad291e19173d7fa8d13e3336fbb9) Thanks [@davidkpiano](https://github.com/davidkpiano)! - The repository links have been updated from `github.com/davidkpiano` to `github.com/statelyai`.
|
|
50
|
+
|
|
3
51
|
## 4.28.1
|
|
4
52
|
|
|
5
53
|
### Patch Changes
|
|
@@ -18,7 +66,7 @@
|
|
|
18
66
|
|
|
19
67
|
### Patch Changes
|
|
20
68
|
|
|
21
|
-
- [#2864](https://github.com/statelyai/xstate/pull/2864) [`4252ee212`](https://github.com/statelyai/xstate/commit/4252ee212e59fd074707b933c101662d47938849) Thanks [@davidkpiano](https://github.com/
|
|
69
|
+
- [#2864](https://github.com/statelyai/xstate/pull/2864) [`4252ee212`](https://github.com/statelyai/xstate/commit/4252ee212e59fd074707b933c101662d47938849) Thanks [@davidkpiano](https://github.com/statelyai)! - Generated IDs for invocations that do not provide an `id` are now based on the state ID to avoid collisions:
|
|
22
70
|
|
|
23
71
|
```js
|
|
24
72
|
createMachine({
|
|
@@ -60,7 +108,7 @@
|
|
|
60
108
|
|
|
61
109
|
### Minor Changes
|
|
62
110
|
|
|
63
|
-
- [#2800](https://github.com/statelyai/xstate/pull/2800) [`759a90155`](https://github.com/statelyai/xstate/commit/759a9015512bbf532d7044afe6a889c04dc7edf6) Thanks [@davidkpiano](https://github.com/
|
|
111
|
+
- [#2800](https://github.com/statelyai/xstate/pull/2800) [`759a90155`](https://github.com/statelyai/xstate/commit/759a9015512bbf532d7044afe6a889c04dc7edf6) Thanks [@davidkpiano](https://github.com/statelyai)! - The `sendTo(actorRef, event)` action creator has been introduced. It allows you to specify the recipient actor ref of an event first, so that the event can be strongly typed against the events allowed to be received by the actor ref:
|
|
64
112
|
|
|
65
113
|
```ts
|
|
66
114
|
// ...
|
|
@@ -73,7 +121,7 @@
|
|
|
73
121
|
|
|
74
122
|
### Patch Changes
|
|
75
123
|
|
|
76
|
-
- [#2804](https://github.com/statelyai/xstate/pull/2804) [`f3caecf5a`](https://github.com/statelyai/xstate/commit/f3caecf5ad384cfe2a843c26333aaa46a77ece68) Thanks [@davidkpiano](https://github.com/
|
|
124
|
+
- [#2804](https://github.com/statelyai/xstate/pull/2804) [`f3caecf5a`](https://github.com/statelyai/xstate/commit/f3caecf5ad384cfe2a843c26333aaa46a77ece68) Thanks [@davidkpiano](https://github.com/statelyai)! - The `state.can(...)` method no longer unnecessarily executes `assign()` actions and instead determines if a given event will change the state by reading transition data before evaluating actions.
|
|
77
125
|
|
|
78
126
|
* [#2856](https://github.com/statelyai/xstate/pull/2856) [`49c2e9094`](https://github.com/statelyai/xstate/commit/49c2e90945d369e2dfb2e4fc376b3f46714dce09) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with stopped children sometimes starting their own child actors. This could happen when the child was stopped synchronously (for example by its parent) when transitioning to an invoking state.
|
|
79
127
|
|
|
@@ -85,13 +133,13 @@
|
|
|
85
133
|
|
|
86
134
|
- [#2819](https://github.com/statelyai/xstate/pull/2819) [`0d51d33cd`](https://github.com/statelyai/xstate/commit/0d51d33cd6dc6ab876a5554788300282d03fa5d1) Thanks [@simonihmig](https://github.com/simonihmig)! - Support `globalThis` in `getGlobal()` for better compatibility
|
|
87
135
|
|
|
88
|
-
* [#2828](https://github.com/statelyai/xstate/pull/2828) [`c0ef3e8`](https://github.com/statelyai/xstate/commit/c0ef3e882c688e6beefb196a3293ec71b65625e3) Thanks [@davidkpiano](https://github.com/
|
|
136
|
+
* [#2828](https://github.com/statelyai/xstate/pull/2828) [`c0ef3e8`](https://github.com/statelyai/xstate/commit/c0ef3e882c688e6beefb196a3293ec71b65625e3) Thanks [@davidkpiano](https://github.com/statelyai)! - XState is now compatible with TypeScript version 4.5.
|
|
89
137
|
|
|
90
138
|
## 4.26.0
|
|
91
139
|
|
|
92
140
|
### Minor Changes
|
|
93
141
|
|
|
94
|
-
- [#2672](https://github.com/statelyai/xstate/pull/2672) [`8e1d05d`](https://github.com/statelyai/xstate/commit/8e1d05dcafab0d1c8a63b07694b3f208850b0b4b) Thanks [@davidkpiano](https://github.com/
|
|
142
|
+
- [#2672](https://github.com/statelyai/xstate/pull/2672) [`8e1d05d`](https://github.com/statelyai/xstate/commit/8e1d05dcafab0d1c8a63b07694b3f208850b0b4b) Thanks [@davidkpiano](https://github.com/statelyai)! - The `description` property is a new top-level property for state nodes and transitions, that lets you provide text descriptions:
|
|
95
143
|
|
|
96
144
|
```ts
|
|
97
145
|
const machine = createMachine({
|
|
@@ -121,7 +169,7 @@
|
|
|
121
169
|
|
|
122
170
|
### Patch Changes
|
|
123
171
|
|
|
124
|
-
- [#2738](https://github.com/statelyai/xstate/pull/2738) [`942fd90e0`](https://github.com/statelyai/xstate/commit/942fd90e0c7a942564dd9c2ffebb93d6c86698df) Thanks [@michelsciortino](https://github.com/michelsciortino)! - The `tags` property was missing from state's definitions. This is used when converting a state to a JSON string. Since this is how we serialize states within [`@xstate/inspect`](https://github.com/
|
|
172
|
+
- [#2738](https://github.com/statelyai/xstate/pull/2738) [`942fd90e0`](https://github.com/statelyai/xstate/commit/942fd90e0c7a942564dd9c2ffebb93d6c86698df) Thanks [@michelsciortino](https://github.com/michelsciortino)! - The `tags` property was missing from state's definitions. This is used when converting a state to a JSON string. Since this is how we serialize states within [`@xstate/inspect`](https://github.com/statelyai/xstate/tree/main/packages/xstate-inspect) this has caused inspected machines to miss the `tags` information.
|
|
125
173
|
|
|
126
174
|
* [#2740](https://github.com/statelyai/xstate/pull/2740) [`707cb981f`](https://github.com/statelyai/xstate/commit/707cb981fdb8a5c75cacb7e9bfa5c7e5a1cc1c88) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with tags being missed on a service state after starting that service using a state value, like this:
|
|
127
175
|
|
|
@@ -130,7 +178,7 @@
|
|
|
130
178
|
service.state.hasTag('foo'); // this should now return a correct result
|
|
131
179
|
```
|
|
132
180
|
|
|
133
|
-
- [#2691](https://github.com/statelyai/xstate/pull/2691) [`a72806035`](https://github.com/statelyai/xstate/commit/a728060353c9cb9bdb0cd37aacf793498a8750c8) Thanks [@davidkpiano](https://github.com/
|
|
181
|
+
- [#2691](https://github.com/statelyai/xstate/pull/2691) [`a72806035`](https://github.com/statelyai/xstate/commit/a728060353c9cb9bdb0cd37aacf793498a8750c8) Thanks [@davidkpiano](https://github.com/statelyai)! - Meta data can now be specified for `invoke` configs in the `invoke.meta` property:
|
|
134
182
|
|
|
135
183
|
```js
|
|
136
184
|
const machine = createMachine({
|
|
@@ -203,7 +251,7 @@
|
|
|
203
251
|
|
|
204
252
|
### Minor Changes
|
|
205
253
|
|
|
206
|
-
- [#2546](https://github.com/statelyai/xstate/pull/2546) [`a4cfce18c`](https://github.com/statelyai/xstate/commit/a4cfce18c0c179faef15adf25a75b08903064e28) Thanks [@davidkpiano](https://github.com/
|
|
254
|
+
- [#2546](https://github.com/statelyai/xstate/pull/2546) [`a4cfce18c`](https://github.com/statelyai/xstate/commit/a4cfce18c0c179faef15adf25a75b08903064e28) Thanks [@davidkpiano](https://github.com/statelyai)! - You can now know if an event will cause a state change by using the new `state.can(event)` method, which will return `true` if an interpreted machine will "change" the state when sent the `event`, or `false` otherwise:
|
|
207
255
|
|
|
208
256
|
```js
|
|
209
257
|
const machine = createMachine({
|
|
@@ -244,7 +292,7 @@
|
|
|
244
292
|
|
|
245
293
|
### Patch Changes
|
|
246
294
|
|
|
247
|
-
- [#2632](https://github.com/statelyai/xstate/pull/2632) [`f8cf5dfe0`](https://github.com/statelyai/xstate/commit/f8cf5dfe0bf20c8545208ed7b1ade619933004f9) Thanks [@davidkpiano](https://github.com/
|
|
295
|
+
- [#2632](https://github.com/statelyai/xstate/pull/2632) [`f8cf5dfe0`](https://github.com/statelyai/xstate/commit/f8cf5dfe0bf20c8545208ed7b1ade619933004f9) Thanks [@davidkpiano](https://github.com/statelyai)! - A regression was fixed where actions were being typed as `never` if events were specified in `createModel(...)` but not actions:
|
|
248
296
|
|
|
249
297
|
```ts
|
|
250
298
|
const model = createModel(
|
|
@@ -265,7 +313,7 @@
|
|
|
265
313
|
|
|
266
314
|
### Patch Changes
|
|
267
315
|
|
|
268
|
-
- [#2606](https://github.com/statelyai/xstate/pull/2606) [`01e5d7984`](https://github.com/statelyai/xstate/commit/01e5d7984a5441a6980eacdb06d42c2a9398bdff) Thanks [@davidkpiano](https://github.com/
|
|
316
|
+
- [#2606](https://github.com/statelyai/xstate/pull/2606) [`01e5d7984`](https://github.com/statelyai/xstate/commit/01e5d7984a5441a6980eacdb06d42c2a9398bdff) Thanks [@davidkpiano](https://github.com/statelyai)! - The following utility types were previously returning `never` in some unexpected cases, and are now working as expected:
|
|
269
317
|
|
|
270
318
|
- `ContextFrom<T>`
|
|
271
319
|
- `EventFrom<T>`
|
|
@@ -304,9 +352,9 @@
|
|
|
304
352
|
type Interpreter = InterpreterFrom<ReturnType<typeof machine>>;
|
|
305
353
|
```
|
|
306
354
|
|
|
307
|
-
* [`413a4578`](https://github.com/statelyai/xstate/commit/413a4578cded21beffff822d1485a3725457b768) [#2491](https://github.com/statelyai/xstate/pull/2491) Thanks [@davidkpiano](https://github.com/
|
|
355
|
+
* [`413a4578`](https://github.com/statelyai/xstate/commit/413a4578cded21beffff822d1485a3725457b768) [#2491](https://github.com/statelyai/xstate/pull/2491) Thanks [@davidkpiano](https://github.com/statelyai)! - The custom `.toString()` method on action objects is now removed which improves performance in larger applications (see [#2488](https://github.com/statelyai/xstate/discussions/2488) for more context).
|
|
308
356
|
|
|
309
|
-
- [`5e1223cd`](https://github.com/statelyai/xstate/commit/5e1223cd58485045b192677753946df2c00eddf7) [#2422](https://github.com/statelyai/xstate/pull/2422) Thanks [@davidkpiano](https://github.com/
|
|
357
|
+
- [`5e1223cd`](https://github.com/statelyai/xstate/commit/5e1223cd58485045b192677753946df2c00eddf7) [#2422](https://github.com/statelyai/xstate/pull/2422) Thanks [@davidkpiano](https://github.com/statelyai)! - The `context` property has been removed from `StateNodeConfig`, as it has never been allowed, nor has it ever done anything. The previous typing was unsafe and allowed `context` to be specified on nested state nodes:
|
|
310
358
|
|
|
311
359
|
```ts
|
|
312
360
|
createMachine({
|
|
@@ -324,7 +372,7 @@
|
|
|
324
372
|
});
|
|
325
373
|
```
|
|
326
374
|
|
|
327
|
-
* [`5b70c2ff`](https://github.com/statelyai/xstate/commit/5b70c2ff21cc5d8c6cf1c13b6eb7bb12611a9835) [#2508](https://github.com/statelyai/xstate/pull/2508) Thanks [@davidkpiano](https://github.com/
|
|
375
|
+
* [`5b70c2ff`](https://github.com/statelyai/xstate/commit/5b70c2ff21cc5d8c6cf1c13b6eb7bb12611a9835) [#2508](https://github.com/statelyai/xstate/pull/2508) Thanks [@davidkpiano](https://github.com/statelyai)! - A race condition occurred when a child service is immediately stopped and the parent service tried to remove it from its undefined state (during its own initialization). This has been fixed, and the race condition no longer occurs. See [this issue](https://github.com/statelyai/xstate/issues/2507) for details.
|
|
328
376
|
|
|
329
377
|
- [`5a9500d1`](https://github.com/statelyai/xstate/commit/5a9500d1cde9bf2300a85bc81529da83f2d08361) [#2522](https://github.com/statelyai/xstate/pull/2522) Thanks [@farskid](https://github.com/farskid), [@Andarist](https://github.com/Andarist)! - Adjusted TS type definitions of the `withContext` and `withConfig` methods so that they accept "lazy context" now.
|
|
330
378
|
|
|
@@ -357,7 +405,7 @@
|
|
|
357
405
|
|
|
358
406
|
### Minor Changes
|
|
359
407
|
|
|
360
|
-
- [`7dc7ceb8`](https://github.com/statelyai/xstate/commit/7dc7ceb8707569b48ceb35069125763a701a0a58) [#2379](https://github.com/statelyai/xstate/pull/2379) Thanks [@davidkpiano](https://github.com/
|
|
408
|
+
- [`7dc7ceb8`](https://github.com/statelyai/xstate/commit/7dc7ceb8707569b48ceb35069125763a701a0a58) [#2379](https://github.com/statelyai/xstate/pull/2379) Thanks [@davidkpiano](https://github.com/statelyai)! - There is a new `.preserveActionOrder` (default: `false`) setting in the machine configuration that preserves the order of actions when set to `true`. Normally, actions are executed in order _except_ for `assign(...)` actions, which are prioritized and executed first. When `.preserveActionOrder` is set to `true`, `assign(...)` actions will _not_ be prioritized, and will instead run in order. As a result, actions will capture the **intermediate `context` values** instead of the resulting `context` value from all `assign(...)` actions.
|
|
361
409
|
|
|
362
410
|
```ts
|
|
363
411
|
// With `.preserveActionOrder: true`
|
|
@@ -391,7 +439,7 @@
|
|
|
391
439
|
|
|
392
440
|
- [`4e305372`](https://github.com/statelyai/xstate/commit/4e30537266eb082ccd85f050c9372358247b4167) [#2361](https://github.com/statelyai/xstate/pull/2361) Thanks [@woutermont](https://github.com/woutermont)! - Add type for `Symbol.observable` to the `Interpreter` to improve the compatibility with RxJS.
|
|
393
441
|
|
|
394
|
-
* [`1def6cf6`](https://github.com/statelyai/xstate/commit/1def6cf6109867a87b4323ee83d20a9ee0c49d7b) [#2374](https://github.com/statelyai/xstate/pull/2374) Thanks [@davidkpiano](https://github.com/
|
|
442
|
+
* [`1def6cf6`](https://github.com/statelyai/xstate/commit/1def6cf6109867a87b4323ee83d20a9ee0c49d7b) [#2374](https://github.com/statelyai/xstate/pull/2374) Thanks [@davidkpiano](https://github.com/statelyai)! - Existing actors can now be identified in `spawn(...)` calls by providing an `id`. This allows them to be referenced by string:
|
|
395
443
|
|
|
396
444
|
```ts
|
|
397
445
|
const machine = createMachine({
|
|
@@ -406,7 +454,7 @@
|
|
|
406
454
|
});
|
|
407
455
|
```
|
|
408
456
|
|
|
409
|
-
- [`da6861e3`](https://github.com/statelyai/xstate/commit/da6861e34a2b28bf6eeaa7c04a2d4cf9a90f93f1) [#2391](https://github.com/statelyai/xstate/pull/2391) Thanks [@davidkpiano](https://github.com/
|
|
457
|
+
- [`da6861e3`](https://github.com/statelyai/xstate/commit/da6861e34a2b28bf6eeaa7c04a2d4cf9a90f93f1) [#2391](https://github.com/statelyai/xstate/pull/2391) Thanks [@davidkpiano](https://github.com/statelyai)! - There are two new helper types for extracting `context` and `event` types:
|
|
410
458
|
|
|
411
459
|
- `ContextFrom<T>` which extracts the `context` from any type that uses context
|
|
412
460
|
- `EventFrom<T>` which extracts the `event` type (which extends `EventObject`) from any type which uses events
|
|
@@ -415,7 +463,7 @@
|
|
|
415
463
|
|
|
416
464
|
### Minor Changes
|
|
417
465
|
|
|
418
|
-
- [`1b32aa0d`](https://github.com/statelyai/xstate/commit/1b32aa0d3a0eca11ffcb7ec9d710eb8828107aa0) [#2356](https://github.com/statelyai/xstate/pull/2356) Thanks [@davidkpiano](https://github.com/
|
|
466
|
+
- [`1b32aa0d`](https://github.com/statelyai/xstate/commit/1b32aa0d3a0eca11ffcb7ec9d710eb8828107aa0) [#2356](https://github.com/statelyai/xstate/pull/2356) Thanks [@davidkpiano](https://github.com/statelyai)! - The model created from `createModel(...)` now provides a `.createMachine(...)` method that does not require passing any generic type parameters:
|
|
419
467
|
|
|
420
468
|
```diff
|
|
421
469
|
const model = createModel(/* ... */);
|
|
@@ -424,7 +472,7 @@
|
|
|
424
472
|
+const machine = model.createMachine(/* ... */);
|
|
425
473
|
```
|
|
426
474
|
|
|
427
|
-
* [`432b60f7`](https://github.com/statelyai/xstate/commit/432b60f7bcbcee9510e0d86311abbfd75b1a674e) [#2280](https://github.com/statelyai/xstate/pull/2280) Thanks [@davidkpiano](https://github.com/
|
|
475
|
+
* [`432b60f7`](https://github.com/statelyai/xstate/commit/432b60f7bcbcee9510e0d86311abbfd75b1a674e) [#2280](https://github.com/statelyai/xstate/pull/2280) Thanks [@davidkpiano](https://github.com/statelyai)! - Actors can now be invoked/spawned from reducers using the `fromReducer(...)` behavior creator:
|
|
428
476
|
|
|
429
477
|
```ts
|
|
430
478
|
import { fromReducer } from 'xstate/lib/behaviors';
|
|
@@ -457,7 +505,7 @@
|
|
|
457
505
|
});
|
|
458
506
|
```
|
|
459
507
|
|
|
460
|
-
- [`f9bcea2c`](https://github.com/
|
|
508
|
+
- [`f9bcea2c`](https://github.com/statelyai/xstate/commit/f9bcea2ce909ac59fcb165b352a7b51a8b29a56d) [#2366](https://github.com/statelyai/xstate/pull/2366) Thanks [@davidkpiano](https://github.com/statelyai)! - Actors can now be spawned directly in the initial `machine.context` using lazy initialization, avoiding the need for intermediate states and unsafe typings for immediately spawned actors:
|
|
461
509
|
|
|
462
510
|
```ts
|
|
463
511
|
const machine = createMachine<{ ref: ActorRef<SomeEvent> }>({
|
|
@@ -472,13 +520,13 @@
|
|
|
472
520
|
|
|
473
521
|
### Patch Changes
|
|
474
522
|
|
|
475
|
-
- [`1ef29e83`](https://github.com/
|
|
523
|
+
- [`1ef29e83`](https://github.com/statelyai/xstate/commit/1ef29e83e14331083279d50fd3a8907eb63793eb) [#2343](https://github.com/statelyai/xstate/pull/2343) Thanks [@davidkpiano](https://github.com/statelyai)! - Eventless ("always") transitions will no longer be ignored if an event is sent to a machine in a state that does not have any enabled transitions for that event.
|
|
476
524
|
|
|
477
525
|
## 4.20.1
|
|
478
526
|
|
|
479
527
|
### Patch Changes
|
|
480
528
|
|
|
481
|
-
- [`99bc5fb9`](https://github.com/
|
|
529
|
+
- [`99bc5fb9`](https://github.com/statelyai/xstate/commit/99bc5fb9d1d7be35f4c767dcbbf5287755b306d0) [#2275](https://github.com/statelyai/xstate/pull/2275) Thanks [@davidkpiano](https://github.com/statelyai)! - The `SpawnedActorRef` TypeScript interface has been deprecated in favor of a unified `ActorRef` interface, which contains the following:
|
|
482
530
|
|
|
483
531
|
```ts
|
|
484
532
|
interface ActorRef<TEvent extends EventObject, TEmitted = any>
|
|
@@ -503,7 +551,7 @@
|
|
|
503
551
|
}
|
|
504
552
|
```
|
|
505
553
|
|
|
506
|
-
* [`38e6a5e9`](https://github.com/
|
|
554
|
+
* [`38e6a5e9`](https://github.com/statelyai/xstate/commit/38e6a5e98a1dd54b4f2ef96942180ec0add88f2b) [#2334](https://github.com/statelyai/xstate/pull/2334) Thanks [@davidkpiano](https://github.com/statelyai)! - When using a model type in `createMachine<typeof someModel>(...)`, TypeScript will no longer compile machines that are missing the `context` property in the machine configuration:
|
|
507
555
|
|
|
508
556
|
```ts
|
|
509
557
|
const machine = createMachine<typeof someModel>({
|
|
@@ -516,7 +564,7 @@
|
|
|
516
564
|
});
|
|
517
565
|
```
|
|
518
566
|
|
|
519
|
-
- [`5f790ba5`](https://github.com/
|
|
567
|
+
- [`5f790ba5`](https://github.com/statelyai/xstate/commit/5f790ba5478cb733a59e3b0603e8976c11bcdd04) [#2320](https://github.com/statelyai/xstate/pull/2320) Thanks [@davidkpiano](https://github.com/statelyai)! - The typing for `InvokeCallback` have been improved for better event constraints when using the `sendBack` parameter of invoked callbacks:
|
|
520
568
|
|
|
521
569
|
```ts
|
|
522
570
|
invoke: () => (sendBack, receive) => {
|
|
@@ -525,7 +573,7 @@
|
|
|
525
573
|
};
|
|
526
574
|
```
|
|
527
575
|
|
|
528
|
-
* [`2de3ec3e`](https://github.com/
|
|
576
|
+
* [`2de3ec3e`](https://github.com/statelyai/xstate/commit/2de3ec3e994e0deb5a142aeac15e1eddeb18d1e1) [#2272](https://github.com/statelyai/xstate/pull/2272) Thanks [@davidkpiano](https://github.com/statelyai)! - The `state.meta` value is now calculated directly from `state.configuration`. This is most useful when starting a service from a persisted state:
|
|
529
577
|
|
|
530
578
|
```ts
|
|
531
579
|
const machine = createMachine({
|
|
@@ -562,7 +610,7 @@
|
|
|
562
610
|
|
|
563
611
|
### Minor Changes
|
|
564
612
|
|
|
565
|
-
- [`28059b9f`](https://github.com/
|
|
613
|
+
- [`28059b9f`](https://github.com/statelyai/xstate/commit/28059b9f09926d683d80b7d816f5b703c0667a9f) [#2197](https://github.com/statelyai/xstate/pull/2197) Thanks [@davidkpiano](https://github.com/statelyai)! - All spawned and invoked actors now have a `.getSnapshot()` method, which allows you to retrieve the latest value emitted from that actor. That value may be `undefined` if no value has been emitted yet.
|
|
566
614
|
|
|
567
615
|
```js
|
|
568
616
|
const machine = createMachine({
|
|
@@ -593,31 +641,31 @@
|
|
|
593
641
|
|
|
594
642
|
### Patch Changes
|
|
595
643
|
|
|
596
|
-
- [`4ef03465`](https://github.com/
|
|
644
|
+
- [`4ef03465`](https://github.com/statelyai/xstate/commit/4ef03465869e27dc878ec600661c9253d90f74f0) [#2240](https://github.com/statelyai/xstate/pull/2240) Thanks [@VanTanev](https://github.com/VanTanev)! - Preserve StateMachine type when .withConfig() and .withContext() modifiers are used on a machine.
|
|
597
645
|
|
|
598
646
|
## 4.19.2
|
|
599
647
|
|
|
600
648
|
### Patch Changes
|
|
601
649
|
|
|
602
|
-
- [`18789aa9`](https://github.com/
|
|
650
|
+
- [`18789aa9`](https://github.com/statelyai/xstate/commit/18789aa94669e48b71e2ae22e524d9bbe9dbfc63) [#2107](https://github.com/statelyai/xstate/pull/2107) Thanks [@woutermont](https://github.com/woutermont)! - This update restricts invoked `Subscribable`s to `EventObject`s,
|
|
603
651
|
so that type inference can be done on which `Subscribable`s are
|
|
604
652
|
allowed to be invoked. Existing `MachineConfig`s that invoke
|
|
605
653
|
`Subscribable<any>`s that are not `Subscribable<EventObject>`s
|
|
606
654
|
should be updated accordingly.
|
|
607
655
|
|
|
608
|
-
* [`38dcec1d`](https://github.com/
|
|
656
|
+
* [`38dcec1d`](https://github.com/statelyai/xstate/commit/38dcec1dad60c62cf8c47c88736651483276ff87) [#2149](https://github.com/statelyai/xstate/pull/2149) Thanks [@davidkpiano](https://github.com/statelyai)! - Invocations and entry actions for _combinatorial_ machines (machines with only a single root state) now behave predictably and will not re-execute upon targetless transitions.
|
|
609
657
|
|
|
610
658
|
## 4.19.1
|
|
611
659
|
|
|
612
660
|
### Patch Changes
|
|
613
661
|
|
|
614
|
-
- [`64ab1150`](https://github.com/
|
|
662
|
+
- [`64ab1150`](https://github.com/statelyai/xstate/commit/64ab1150e0a383202f4af1d586b28e081009c929) [#2173](https://github.com/statelyai/xstate/pull/2173) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with tags not being set correctly after sending an event to a machine that didn't result in selecting any transitions.
|
|
615
663
|
|
|
616
664
|
## 4.19.0
|
|
617
665
|
|
|
618
666
|
### Minor Changes
|
|
619
667
|
|
|
620
|
-
- [`4f2f626d`](https://github.com/
|
|
668
|
+
- [`4f2f626d`](https://github.com/statelyai/xstate/commit/4f2f626dc84f45bb18ded6dd9aad3b6f6a2190b1) [#2143](https://github.com/statelyai/xstate/pull/2143) Thanks [@davidkpiano](https://github.com/statelyai)! - Tags can now be added to state node configs under the `.tags` property:
|
|
621
669
|
|
|
622
670
|
```js
|
|
623
671
|
const machine = createMachine({
|
|
@@ -645,15 +693,15 @@
|
|
|
645
693
|
|
|
646
694
|
### Patch Changes
|
|
647
695
|
|
|
648
|
-
- [`a61d01ce`](https://github.com/
|
|
696
|
+
- [`a61d01ce`](https://github.com/statelyai/xstate/commit/a61d01cefab5734adf9bfb167291f5b0ba712684) [#2125](https://github.com/statelyai/xstate/pull/2125) Thanks [@VanTanev](https://github.com/VanTanev)! - In callback invokes, the types of `callback` and `onReceive` are properly scoped to the machine TEvent.
|
|
649
697
|
|
|
650
698
|
## 4.18.0
|
|
651
699
|
|
|
652
700
|
### Minor Changes
|
|
653
701
|
|
|
654
|
-
- [`d0939ec6`](https://github.com/
|
|
702
|
+
- [`d0939ec6`](https://github.com/statelyai/xstate/commit/d0939ec60161c34b053cecdaeb277606b5982375) [#2046](https://github.com/statelyai/xstate/pull/2046) Thanks [@SimeonC](https://github.com/SimeonC)! - Allow machines to communicate with the inspector even in production builds.
|
|
655
703
|
|
|
656
|
-
* [`e37fffef`](https://github.com/
|
|
704
|
+
* [`e37fffef`](https://github.com/statelyai/xstate/commit/e37fffefb742f45765945c02727edfbd5e2f9d47) [#2079](https://github.com/statelyai/xstate/pull/2079) Thanks [@davidkpiano](https://github.com/statelyai)! - There is now support for "combinatorial machines" (state machines that only have one state):
|
|
657
705
|
|
|
658
706
|
```js
|
|
659
707
|
const testMachine = createMachine({
|
|
@@ -670,19 +718,19 @@
|
|
|
670
718
|
|
|
671
719
|
### Patch Changes
|
|
672
720
|
|
|
673
|
-
- [`6a9247d4`](https://github.com/
|
|
721
|
+
- [`6a9247d4`](https://github.com/statelyai/xstate/commit/6a9247d4d3a39e6c8c4724d3368a13fcdef10907) [#2102](https://github.com/statelyai/xstate/pull/2102) Thanks [@VanTanev](https://github.com/VanTanev)! - Provide a convenience type for getting the `Interpreter` type based on the `StateMachine` type by transferring all generic parameters onto it. It can be used like this: `InterpreterFrom<typeof machine>`
|
|
674
722
|
|
|
675
723
|
## 4.17.1
|
|
676
724
|
|
|
677
725
|
### Patch Changes
|
|
678
726
|
|
|
679
|
-
- [`33302814`](https://github.com/
|
|
727
|
+
- [`33302814`](https://github.com/statelyai/xstate/commit/33302814c38587d0044afd2ae61a4ff4779416c6) [#2041](https://github.com/statelyai/xstate/pull/2041) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with creatorless models not being correctly matched by `createMachine`'s overload responsible for using model-induced types.
|
|
680
728
|
|
|
681
729
|
## 4.17.0
|
|
682
730
|
|
|
683
731
|
### Minor Changes
|
|
684
732
|
|
|
685
|
-
- [`7763db8d`](https://github.com/
|
|
733
|
+
- [`7763db8d`](https://github.com/statelyai/xstate/commit/7763db8d3615321d03839b2bd31c9b118ddee50c) [#1977](https://github.com/statelyai/xstate/pull/1977) Thanks [@davidkpiano](https://github.com/statelyai)! - The `schema` property has been introduced to the machine config passed into `createMachine(machineConfig)`, which allows you to provide metadata for the following:
|
|
686
734
|
|
|
687
735
|
- Context
|
|
688
736
|
- Events
|
|
@@ -734,7 +782,7 @@
|
|
|
734
782
|
});
|
|
735
783
|
```
|
|
736
784
|
|
|
737
|
-
* [`5febfe83`](https://github.com/
|
|
785
|
+
* [`5febfe83`](https://github.com/statelyai/xstate/commit/5febfe83a7e5e866c0a4523ea4f86a966af7c50f) [#1955](https://github.com/statelyai/xstate/pull/1955) Thanks [@davidkpiano](https://github.com/statelyai)! - Event creators can now be modeled inside of the 2nd argument of `createModel()`, and types for both `context` and `events` will be inferred properly in `createMachine()` when given the `typeof model` as the first generic parameter.
|
|
738
786
|
|
|
739
787
|
```ts
|
|
740
788
|
import { createModel } from 'xstate/lib/model';
|
|
@@ -782,25 +830,25 @@
|
|
|
782
830
|
|
|
783
831
|
### Patch Changes
|
|
784
832
|
|
|
785
|
-
- [`4194ffe8`](https://github.com/
|
|
833
|
+
- [`4194ffe8`](https://github.com/statelyai/xstate/commit/4194ffe84cfe7910e2c183701e36bc5cac5c9bcc) [#1710](https://github.com/statelyai/xstate/pull/1710) Thanks [@davidkpiano](https://github.com/statelyai)! - Stopping an already stopped interpreter will no longer crash. See [#1697](https://github.com/statelyai/xstate/issues/1697) for details.
|
|
786
834
|
|
|
787
835
|
## 4.16.1
|
|
788
836
|
|
|
789
837
|
### Patch Changes
|
|
790
838
|
|
|
791
|
-
- [`af6b7c70`](https://github.com/
|
|
839
|
+
- [`af6b7c70`](https://github.com/statelyai/xstate/commit/af6b7c70015db29d84f79dfd29ea0dc221b8f3e6) [#1865](https://github.com/statelyai/xstate/pull/1865) Thanks [@Andarist](https://github.com/Andarist)! - Improved `.matches(value)` inference for typestates containing union types as values.
|
|
792
840
|
|
|
793
841
|
## 4.16.0
|
|
794
842
|
|
|
795
843
|
### Minor Changes
|
|
796
844
|
|
|
797
|
-
- [`d2e328f8`](https://github.com/
|
|
845
|
+
- [`d2e328f8`](https://github.com/statelyai/xstate/commit/d2e328f8efad7e8d3500d39976d1153a26e835a3) [#1439](https://github.com/statelyai/xstate/pull/1439) Thanks [@davidkpiano](https://github.com/statelyai)! - An opt-in `createModel()` helper has been introduced to make it easier to work with typed `context` and events.
|
|
798
846
|
|
|
799
847
|
- `createModel(initialContext)` creates a `model` object
|
|
800
848
|
- `model.initialContext` returns the `initialContext`
|
|
801
849
|
- `model.assign(assigner, event?)` creates an `assign` action that is properly scoped to the `event` in TypeScript
|
|
802
850
|
|
|
803
|
-
See https://github.com/
|
|
851
|
+
See https://github.com/statelyai/xstate/pull/1439 for more details.
|
|
804
852
|
|
|
805
853
|
```js
|
|
806
854
|
import { createMachine } from 'xstate';
|
|
@@ -843,31 +891,31 @@
|
|
|
843
891
|
|
|
844
892
|
### Patch Changes
|
|
845
893
|
|
|
846
|
-
- [`0cb8df9b`](https://github.com/
|
|
894
|
+
- [`0cb8df9b`](https://github.com/statelyai/xstate/commit/0cb8df9b6c8cd01ada82afe967bf1015e24e75d9) [#1816](https://github.com/statelyai/xstate/pull/1816) Thanks [@Andarist](https://github.com/Andarist)! - `machine.resolveState(state)` calls should resolve to the correct value of `.done` property now.
|
|
847
895
|
|
|
848
896
|
## 4.15.3
|
|
849
897
|
|
|
850
898
|
### Patch Changes
|
|
851
899
|
|
|
852
|
-
- [`63ba888e`](https://github.com/
|
|
900
|
+
- [`63ba888e`](https://github.com/statelyai/xstate/commit/63ba888e19bd2b72f9aad2c9cd36cde297e0ffe5) [#1770](https://github.com/statelyai/xstate/pull/1770) Thanks [@davidkpiano](https://github.com/statelyai)! - Instead of referencing `window` directly, XState now internally calls a `getGlobal()` function that will resolve to the proper `globalThis` value in all environments. This affects the dev tools code only.
|
|
853
901
|
|
|
854
902
|
## 4.15.2
|
|
855
903
|
|
|
856
904
|
### Patch Changes
|
|
857
905
|
|
|
858
|
-
- [`497c543d`](https://github.com/
|
|
906
|
+
- [`497c543d`](https://github.com/statelyai/xstate/commit/497c543d2980ea1a277b30b340a7bcd3dd0b3cb6) [#1766](https://github.com/statelyai/xstate/pull/1766) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with events received from callback actors not having the appropriate `_event.origin` set.
|
|
859
907
|
|
|
860
908
|
## 4.15.1
|
|
861
909
|
|
|
862
910
|
### Patch Changes
|
|
863
911
|
|
|
864
|
-
- [`8a8cfa32`](https://github.com/
|
|
912
|
+
- [`8a8cfa32`](https://github.com/statelyai/xstate/commit/8a8cfa32d99aedf11f4af93ba56fa9ba68925c74) [#1704](https://github.com/statelyai/xstate/pull/1704) Thanks [@blimmer](https://github.com/blimmer)! - The default `clock` methods (`setTimeout` and `clearTimeout`) are now invoked properly with the global context preserved for those invocations which matter for some JS environments. More details can be found in the corresponding issue: [#1703](https://github.com/statelyai/xstate/issues/1703).
|
|
865
913
|
|
|
866
914
|
## 4.15.0
|
|
867
915
|
|
|
868
916
|
### Minor Changes
|
|
869
917
|
|
|
870
|
-
- [`6596d0ba`](https://github.com/
|
|
918
|
+
- [`6596d0ba`](https://github.com/statelyai/xstate/commit/6596d0ba163341fc43d214b48115536cb4815b68) [#1622](https://github.com/statelyai/xstate/pull/1622) Thanks [@davidkpiano](https://github.com/statelyai)! - Spawned/invoked actors and interpreters are now typed as extending `ActorRef` (e.g., `SpawnedActorRef`) rather than `Actor` or `Interpreter`. This unification of types should make it more straightforward to provide actor types:
|
|
871
919
|
|
|
872
920
|
```diff
|
|
873
921
|
import {
|
|
@@ -904,19 +952,19 @@
|
|
|
904
952
|
|
|
905
953
|
### Patch Changes
|
|
906
954
|
|
|
907
|
-
- [`75a91b07`](https://github.com/
|
|
955
|
+
- [`75a91b07`](https://github.com/statelyai/xstate/commit/75a91b078a10a86f13edc9eec3ac1d6246607002) [#1692](https://github.com/statelyai/xstate/pull/1692) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with history state entering a wrong state if the most recent visit in its parent has been caused by a transient transition.
|
|
908
956
|
|
|
909
957
|
## 4.14.1
|
|
910
958
|
|
|
911
959
|
### Patch Changes
|
|
912
960
|
|
|
913
|
-
- [`02c76350`](https://github.com/
|
|
961
|
+
- [`02c76350`](https://github.com/statelyai/xstate/commit/02c763504da0808eeb281587981a5baf8ba884a1) [#1656](https://github.com/statelyai/xstate/pull/1656) Thanks [@Andarist](https://github.com/Andarist)! - Exit actions will now be properly called when a service gets canceled by calling its `stop` method.
|
|
914
962
|
|
|
915
963
|
## 4.14.0
|
|
916
964
|
|
|
917
965
|
### Minor Changes
|
|
918
966
|
|
|
919
|
-
- [`119db8fb`](https://github.com/
|
|
967
|
+
- [`119db8fb`](https://github.com/statelyai/xstate/commit/119db8fbccd08f899e1275a502d8c4c51b5a130e) [#1577](https://github.com/statelyai/xstate/pull/1577) Thanks [@davidkpiano](https://github.com/statelyai)! - Expressions can now be used in the `stop()` action creator:
|
|
920
968
|
|
|
921
969
|
```js
|
|
922
970
|
// ...
|
|
@@ -925,27 +973,27 @@
|
|
|
925
973
|
|
|
926
974
|
### Patch Changes
|
|
927
975
|
|
|
928
|
-
- [`8c78e120`](https://github.com/
|
|
976
|
+
- [`8c78e120`](https://github.com/statelyai/xstate/commit/8c78e1205a729d933e30db01cd4260d82352a9be) [#1570](https://github.com/statelyai/xstate/pull/1570) Thanks [@davidkpiano](https://github.com/statelyai)! - The return type of `spawn(machine)` will now be `Actor<State<TContext, TEvent>, TEvent>`, which is a supertype of `Interpreter<...>`.
|
|
929
977
|
|
|
930
|
-
* [`602687c2`](https://github.com/
|
|
978
|
+
* [`602687c2`](https://github.com/statelyai/xstate/commit/602687c235c56cca552c2d5a9d78adf224f522d8) [#1566](https://github.com/statelyai/xstate/pull/1566) Thanks [@davidkpiano](https://github.com/statelyai)! - Exit actions will now be properly called when an invoked machine reaches its final state. See [#1109](https://github.com/statelyai/xstate/issues/1109) for more details.
|
|
931
979
|
|
|
932
|
-
- [`6e44d02a`](https://github.com/
|
|
980
|
+
- [`6e44d02a`](https://github.com/statelyai/xstate/commit/6e44d02ad03af4041046120dd6c975e3b5b3772a) [#1553](https://github.com/statelyai/xstate/pull/1553) Thanks [@davidkpiano](https://github.com/statelyai)! - The `state.children` property now properly shows all spawned and invoked actors. See [#795](https://github.com/statelyai/xstate/issues/795) for more details.
|
|
933
981
|
|
|
934
|
-
* [`72b0880e`](https://github.com/
|
|
982
|
+
* [`72b0880e`](https://github.com/statelyai/xstate/commit/72b0880e6444ae009adca72088872bb5c0760ce3) [#1504](https://github.com/statelyai/xstate/pull/1504) Thanks [@Andarist](https://github.com/Andarist)! - Added `status` property on the `Interpreter` - this can be used to differentiate not started, running and stopped interpreters. This property is best compared to values on the new `InterpreterStatus` export.
|
|
935
983
|
|
|
936
984
|
## 4.13.0
|
|
937
985
|
|
|
938
986
|
### Minor Changes
|
|
939
987
|
|
|
940
|
-
- [`f51614df`](https://github.com/
|
|
988
|
+
- [`f51614df`](https://github.com/statelyai/xstate/commit/f51614dff760cfe4511c0bc7cca3d022157c104c) [#1409](https://github.com/statelyai/xstate/pull/1409) Thanks [@jirutka](https://github.com/jirutka)! - Fix type `ExtractStateValue` so that it generates a type actually describing a `State.value`
|
|
941
989
|
|
|
942
990
|
### Patch Changes
|
|
943
991
|
|
|
944
|
-
- [`b1684ead`](https://github.com/
|
|
992
|
+
- [`b1684ead`](https://github.com/statelyai/xstate/commit/b1684eadb1f859db5c733b8d403afc825c294948) [#1402](https://github.com/statelyai/xstate/pull/1402) Thanks [@Andarist](https://github.com/Andarist)! - Improved TypeScript type-checking performance a little bit by using distributive conditional type within `TransitionsConfigArray` declarations instead of a mapped type. Kudos to [@amcasey](https://github.com/amcasey), some discussion around this can be found [here](https://github.com/microsoft/TypeScript/issues/39826#issuecomment-675790689)
|
|
945
993
|
|
|
946
|
-
* [`ad3026d4`](https://github.com/
|
|
994
|
+
* [`ad3026d4`](https://github.com/statelyai/xstate/commit/ad3026d4309e9a1c719e09fd8c15cdfefce22055) [#1407](https://github.com/statelyai/xstate/pull/1407) Thanks [@tomenden](https://github.com/tomenden)! - Fixed an issue with not being able to run XState in Web Workers due to assuming that `window` or `global` object is available in the executing environment, but none of those are actually available in the Web Workers context.
|
|
947
995
|
|
|
948
|
-
- [`4e949ec8`](https://github.com/
|
|
996
|
+
- [`4e949ec8`](https://github.com/statelyai/xstate/commit/4e949ec856349062352562c825beb0654e528f81) [#1401](https://github.com/statelyai/xstate/pull/1401) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with spawned actors being spawned multiple times when they got spawned in an initial state of a child machine that is invoked in the initial state of a parent machine.
|
|
949
997
|
|
|
950
998
|
<details>
|
|
951
999
|
<summary>
|
|
@@ -989,9 +1037,9 @@
|
|
|
989
1037
|
|
|
990
1038
|
### Minor Changes
|
|
991
1039
|
|
|
992
|
-
- [`b72e29dd`](https://github.com/
|
|
1040
|
+
- [`b72e29dd`](https://github.com/statelyai/xstate/commit/b72e29dd728b4c1be4bdeaec93909b4e307db5cf) [#1354](https://github.com/statelyai/xstate/pull/1354) Thanks [@davidkpiano](https://github.com/statelyai)! - The `Action` type was simplified, and as a result, you should see better TypeScript performance.
|
|
993
1041
|
|
|
994
|
-
* [`4dbabfe7`](https://github.com/
|
|
1042
|
+
* [`4dbabfe7`](https://github.com/statelyai/xstate/commit/4dbabfe7d5ba154e852b4d460a2434c6fc955726) [#1320](https://github.com/statelyai/xstate/pull/1320) Thanks [@davidkpiano](https://github.com/statelyai)! - The `invoke.src` property now accepts an object that describes the invoke source with its `type` and other related metadata. This can be read from the `services` option in the `meta.src` argument:
|
|
995
1043
|
|
|
996
1044
|
```js
|
|
997
1045
|
const machine = createMachine(
|
|
@@ -1023,13 +1071,13 @@
|
|
|
1023
1071
|
|
|
1024
1072
|
Specifying a string for `invoke.src` will continue to work the same; e.g., if `src: 'search'` was specified, this would be the same as `src: { type: 'search' }`.
|
|
1025
1073
|
|
|
1026
|
-
- [`8662e543`](https://github.com/
|
|
1074
|
+
- [`8662e543`](https://github.com/statelyai/xstate/commit/8662e543393de7e2f8a6d92ff847043781d10f4d) [#1317](https://github.com/statelyai/xstate/pull/1317) Thanks [@Andarist](https://github.com/Andarist)! - All `TTypestate` type parameters default to `{ value: any; context: TContext }` now and the parametrized type is passed correctly between various types which results in more accurate types involving typestates.
|
|
1027
1075
|
|
|
1028
1076
|
### Patch Changes
|
|
1029
1077
|
|
|
1030
|
-
- [`3ab3f25e`](https://github.com/
|
|
1078
|
+
- [`3ab3f25e`](https://github.com/statelyai/xstate/commit/3ab3f25ea297e4d770eef512e9583475c943845d) [#1285](https://github.com/statelyai/xstate/pull/1285) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with initial state of invoked machines being read without custom data passed to them which could lead to a crash when evaluating transient transitions for the initial state.
|
|
1031
1079
|
|
|
1032
|
-
* [`a7da1451`](https://github.com/
|
|
1080
|
+
* [`a7da1451`](https://github.com/statelyai/xstate/commit/a7da14510fd1645ad041836b567771edb5b90827) [#1290](https://github.com/statelyai/xstate/pull/1290) Thanks [@davidkpiano](https://github.com/statelyai)! - The "Attempted to spawn an Actor [...] outside of a service. This will have no effect." warnings are now silenced for "lazily spawned" actors, which are actors that aren't immediately active until the function that creates them are called:
|
|
1033
1081
|
|
|
1034
1082
|
```js
|
|
1035
1083
|
// ⚠️ "active" actor - will warn
|
|
@@ -1044,19 +1092,19 @@
|
|
|
1044
1092
|
|
|
1045
1093
|
It is recommended that all `spawn(...)`-ed actors are lazy, to avoid accidentally initializing them e.g., when reading `machine.initialState` or calculating otherwise pure transitions. In V5, this will be enforced.
|
|
1046
1094
|
|
|
1047
|
-
- [`c1f3d260`](https://github.com/
|
|
1095
|
+
- [`c1f3d260`](https://github.com/statelyai/xstate/commit/c1f3d26069ee70343f8045a48411e02a68f98cbd) [#1317](https://github.com/statelyai/xstate/pull/1317) Thanks [@Andarist](https://github.com/Andarist)! - Fixed a type returned by a `raise` action - it's now `RaiseAction<TEvent> | SendAction<TContext, AnyEventObject, TEvent>` instead of `RaiseAction<TEvent> | SendAction<TContext, TEvent, TEvent>`. This makes it comaptible in a broader range of scenarios.
|
|
1048
1096
|
|
|
1049
|
-
* [`8270d5a7`](https://github.com/
|
|
1097
|
+
* [`8270d5a7`](https://github.com/statelyai/xstate/commit/8270d5a76c71add3a5109e069bd85716b230b5d4) [#1372](https://github.com/statelyai/xstate/pull/1372) Thanks [@christianchown](https://github.com/christianchown)! - Narrowed the `ServiceConfig` type definition to use a specific event type to prevent compilation errors on strictly-typed `MachineOptions`.
|
|
1050
1098
|
|
|
1051
|
-
- [`01e3e2dc`](https://github.com/
|
|
1099
|
+
- [`01e3e2dc`](https://github.com/statelyai/xstate/commit/01e3e2dcead63dce3eef5ab745395584efbf05fa) [#1320](https://github.com/statelyai/xstate/pull/1320) Thanks [@davidkpiano](https://github.com/statelyai)! - The JSON definition for `stateNode.invoke` objects will no longer include the `onDone` and `onError` transitions, since those transitions are already merged into the `transitions` array. This solves the issue of reviving a serialized machine from JSON, where before, the `onDone` and `onError` transitions for invocations were wrongly duplicated.
|
|
1052
1100
|
|
|
1053
1101
|
## 4.11.0
|
|
1054
1102
|
|
|
1055
1103
|
### Minor Changes
|
|
1056
1104
|
|
|
1057
|
-
- [`36ed8d0a`](https://github.com/
|
|
1105
|
+
- [`36ed8d0a`](https://github.com/statelyai/xstate/commit/36ed8d0a3adf5b7fd187b0abe198220398e8b056) [#1262](https://github.com/statelyai/xstate/pull/1262) Thanks [@Andarist](https://github.com/Andarist)! - Improved type inference for `InvokeConfig['data']`. This has required renaming `data` property on `StateNode` instances to `doneData`. This property was never meant to be a part of the public API, so we don't consider this to be a breaking change.
|
|
1058
1106
|
|
|
1059
|
-
* [`2c75ab82`](https://github.com/
|
|
1107
|
+
* [`2c75ab82`](https://github.com/statelyai/xstate/commit/2c75ab822e49cb1a23c1e14eb7bd04548ab143eb) [#1219](https://github.com/statelyai/xstate/pull/1219) Thanks [@davidkpiano](https://github.com/statelyai)! - The resolved value of the `invoke.data` property is now available in the "invoke meta" object, which is passed as the 3rd argument to the service creator in `options.services`. This will work for all types of invoked services now, including promises, observables, and callbacks.
|
|
1060
1108
|
|
|
1061
1109
|
```js
|
|
1062
1110
|
const machine = createMachine({
|
|
@@ -1089,7 +1137,7 @@
|
|
|
1089
1137
|
}
|
|
1090
1138
|
```
|
|
1091
1139
|
|
|
1092
|
-
- [`a6c78ae9`](https://github.com/
|
|
1140
|
+
- [`a6c78ae9`](https://github.com/statelyai/xstate/commit/a6c78ae960acba36b61a41a5d154ea59908010b0) [#1249](https://github.com/statelyai/xstate/pull/1249) Thanks [@davidkpiano](https://github.com/statelyai)! - New property introduced for eventless (transient) transitions: **`always`**, which indicates a transition that is always taken when in that state. Empty string transition configs for [transient transitions](https://xstate.js.org/docs/guides/transitions.html#transient-transitions) are deprecated in favor of `always`:
|
|
1093
1141
|
|
|
1094
1142
|
```diff
|
|
1095
1143
|
// ...
|
|
@@ -1115,45 +1163,45 @@
|
|
|
1115
1163
|
|
|
1116
1164
|
### Patch Changes
|
|
1117
1165
|
|
|
1118
|
-
- [`36ed8d0a`](https://github.com/
|
|
1166
|
+
- [`36ed8d0a`](https://github.com/statelyai/xstate/commit/36ed8d0a3adf5b7fd187b0abe198220398e8b056) [#1262](https://github.com/statelyai/xstate/pull/1262) Thanks [@Andarist](https://github.com/Andarist)! - `StateMachine<any, any, any>` is no longer a part of the `InvokeConfig` type, but rather it creates a union with `InvokeConfig` in places where it is needed. This change shouldn't affect consumers' code.
|
|
1119
1167
|
|
|
1120
1168
|
## 4.10.0
|
|
1121
1169
|
|
|
1122
1170
|
### Minor Changes
|
|
1123
1171
|
|
|
1124
|
-
- [`0133954`](https://github.com/
|
|
1172
|
+
- [`0133954`](https://github.com/statelyai/xstate/commit/013395463b955e950ab24cb4be51faf524b0de6e) [#1178](https://github.com/statelyai/xstate/pull/1178) Thanks [@davidkpiano](https://github.com/statelyai)! - The types for the `send()` and `sendParent()` action creators have been changed to fix the issue of only being able to send events that the machine can receive. In reality, a machine can and should send events to other actors that it might not be able to receive itself. See [#711](https://github.com/statelyai/xstate/issues/711) for more information.
|
|
1125
1173
|
|
|
1126
|
-
* [`a1f1239`](https://github.com/
|
|
1174
|
+
* [`a1f1239`](https://github.com/statelyai/xstate/commit/a1f1239e20e05e338ed994d031e7ef6f2f09ad68) [#1189](https://github.com/statelyai/xstate/pull/1189) Thanks [@davidkpiano](https://github.com/statelyai)! - Previously, `state.matches(...)` was problematic because it was casting `state` to `never` if it didn't match the state value. This is now fixed by making the `Typestate` resolution more granular.
|
|
1127
1175
|
|
|
1128
|
-
- [`dbc6a16`](https://github.com/
|
|
1176
|
+
- [`dbc6a16`](https://github.com/statelyai/xstate/commit/dbc6a161c068a3e12dd12452b68a66fe3f4fb8eb) [#1183](https://github.com/statelyai/xstate/pull/1183) Thanks [@davidkpiano](https://github.com/statelyai)! - Actions from a restored state provided as a custom initial state to `interpret(machine).start(initialState)` are now executed properly. See #1174 for more information.
|
|
1129
1177
|
|
|
1130
1178
|
### Patch Changes
|
|
1131
1179
|
|
|
1132
|
-
- [`a10d604`](https://github.com/
|
|
1180
|
+
- [`a10d604`](https://github.com/statelyai/xstate/commit/a10d604a6afcf39048b02be5436acdd197f16c2b) [#1176](https://github.com/statelyai/xstate/pull/1176) Thanks [@itfarrier](https://github.com/itfarrier)! - Fix passing state schema into State generic
|
|
1133
1181
|
|
|
1134
|
-
* [`326db72`](https://github.com/
|
|
1182
|
+
* [`326db72`](https://github.com/statelyai/xstate/commit/326db725e50f7678af162626c6c7491e4364ec07) [#1185](https://github.com/statelyai/xstate/pull/1185) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with invoked service not being correctly started if other service got stopped in a subsequent microstep (in response to raised or null event).
|
|
1135
1183
|
|
|
1136
|
-
- [`c3a496e`](https://github.com/
|
|
1184
|
+
- [`c3a496e`](https://github.com/statelyai/xstate/commit/c3a496e1f92ec27db0643fd1ddc32d683db4e751) [#1160](https://github.com/statelyai/xstate/pull/1160) Thanks [@davidkpiano](https://github.com/statelyai)! - Delayed transitions defined using `after` were previously causing a circular dependency when the machine was converted using `.toJSON()`. This has now been fixed.
|
|
1137
1185
|
|
|
1138
|
-
* [`e16e48e`](https://github.com/
|
|
1186
|
+
* [`e16e48e`](https://github.com/statelyai/xstate/commit/e16e48e05e6243a3eacca58a13d3e663cd641f55) [#1153](https://github.com/statelyai/xstate/pull/1153) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with `choose` and `pure` not being able to use actions defined in options.
|
|
1139
1187
|
|
|
1140
|
-
- [`d496ecb`](https://github.com/
|
|
1188
|
+
- [`d496ecb`](https://github.com/statelyai/xstate/commit/d496ecb11b26011f2382d1ce6c4433284a7b3e9b) [#1165](https://github.com/statelyai/xstate/pull/1165) Thanks [@davidkpiano](https://github.com/statelyai)! - XState will now warn if you define an `.onDone` transition on the root node. Root nodes which are "done" represent the machine being in its final state, and can no longer accept any events. This has been reported as confusing in [#1111](https://github.com/statelyai/xstate/issues/1111).
|
|
1141
1189
|
|
|
1142
1190
|
## 4.9.1
|
|
1143
1191
|
|
|
1144
1192
|
### Patch Changes
|
|
1145
1193
|
|
|
1146
|
-
- [`8a97785`](https://github.com/
|
|
1194
|
+
- [`8a97785`](https://github.com/statelyai/xstate/commit/8a97785055faaeb1b36040dd4dc04e3b90fa9ec2) [#1137](https://github.com/statelyai/xstate/pull/1137) Thanks [@davidkpiano](https://github.com/statelyai)! - Added docs for the `choose()` and `pure()` action creators, as well as exporting the `pure()` action creator in the `actions` object.
|
|
1147
1195
|
|
|
1148
|
-
* [`e65dee9`](https://github.com/
|
|
1196
|
+
* [`e65dee9`](https://github.com/statelyai/xstate/commit/e65dee928fea60df1e9f83c82fed8102dfed0000) [#1131](https://github.com/statelyai/xstate/pull/1131) Thanks [@wKovacs64](https://github.com/wKovacs64)! - Include the new `choose` action in the `actions` export from the `xstate` core package. This was missed in v4.9.0.
|
|
1149
1197
|
|
|
1150
1198
|
## 4.9.0
|
|
1151
1199
|
|
|
1152
1200
|
### Minor Changes
|
|
1153
1201
|
|
|
1154
|
-
- [`f3ff150`](https://github.com/
|
|
1202
|
+
- [`f3ff150`](https://github.com/statelyai/xstate/commit/f3ff150f7c50f402704d25cdc053b76836e447e3) [#1103](https://github.com/statelyai/xstate/pull/1103) Thanks [@davidkpiano](https://github.com/statelyai)! - Simplify the `TransitionConfigArray` and `TransitionConfigMap` types in order to fix excessively deep type instantiation TypeScript reports. This addresses [#1015](https://github.com/statelyai/xstate/issues/1015).
|
|
1155
1203
|
|
|
1156
|
-
* [`6c47b66`](https://github.com/
|
|
1204
|
+
* [`6c47b66`](https://github.com/statelyai/xstate/commit/6c47b66c3289ff161dc96d9b246873f55c9e18f2) [#1076](https://github.com/statelyai/xstate/pull/1076) Thanks [@Andarist](https://github.com/Andarist)! - Added support for conditional actions. It's possible now to have actions executed based on conditions using following:
|
|
1157
1205
|
|
|
1158
1206
|
```js
|
|
1159
1207
|
entry: [
|
|
@@ -1172,45 +1220,45 @@
|
|
|
1172
1220
|
|
|
1173
1221
|
### Patch Changes
|
|
1174
1222
|
|
|
1175
|
-
- [`1a129f0`](https://github.com/
|
|
1223
|
+
- [`1a129f0`](https://github.com/statelyai/xstate/commit/1a129f0f35995981c160d756a570df76396bfdbd) [#1073](https://github.com/statelyai/xstate/pull/1073) Thanks [@Andarist](https://github.com/Andarist)! - Cleanup internal structures upon receiving termination events from spawned actors.
|
|
1176
1224
|
|
|
1177
|
-
* [`e88aa18`](https://github.com/
|
|
1225
|
+
* [`e88aa18`](https://github.com/statelyai/xstate/commit/e88aa18431629e1061b74dfd4a961b910e274e0b) [#1085](https://github.com/statelyai/xstate/pull/1085) Thanks [@Andarist](https://github.com/Andarist)! - Fixed an issue with data expressions of root's final nodes being called twice.
|
|
1178
1226
|
|
|
1179
|
-
- [`88b17b2`](https://github.com/
|
|
1227
|
+
- [`88b17b2`](https://github.com/statelyai/xstate/commit/88b17b2476ff9a0fbe810df9d00db32c2241cd6e) [#1090](https://github.com/statelyai/xstate/pull/1090) Thanks [@rjdestigter](https://github.com/rjdestigter)! - This change carries forward the typestate type information encoded in the arguments of the following functions and assures that the return type also has the same typestate type information:
|
|
1180
1228
|
|
|
1181
1229
|
- Cloned state machine returned by `.withConfig`.
|
|
1182
1230
|
- `.state` getter defined for services.
|
|
1183
1231
|
- `start` method of services.
|
|
1184
1232
|
|
|
1185
|
-
* [`d5f622f`](https://github.com/
|
|
1233
|
+
* [`d5f622f`](https://github.com/statelyai/xstate/commit/d5f622f68f4065a2615b5a4a1caae6b508b4840e) [#1069](https://github.com/statelyai/xstate/pull/1069) Thanks [@davidkpiano](https://github.com/statelyai)! - Loosened event type for `SendAction<TContext, AnyEventObject>`
|
|
1186
1234
|
|
|
1187
1235
|
## 4.8.0
|
|
1188
1236
|
|
|
1189
1237
|
### Minor Changes
|
|
1190
1238
|
|
|
1191
|
-
- [`55aa589`](https://github.com/
|
|
1239
|
+
- [`55aa589`](https://github.com/statelyai/xstate/commit/55aa589648a9afbd153e8b8e74cbf2e0ebf573fb) [#960](https://github.com/statelyai/xstate/pull/960) Thanks [@davidkpiano](https://github.com/statelyai)! - The machine can now be safely JSON-serialized, using `JSON.stringify(machine)`. The shape of this serialization is defined in `machine.schema.json` and reflected in `machine.definition`.
|
|
1192
1240
|
|
|
1193
1241
|
Note that `onEntry` and `onExit` have been deprecated in the definition in favor of `entry` and `exit`.
|
|
1194
1242
|
|
|
1195
1243
|
### Patch Changes
|
|
1196
1244
|
|
|
1197
|
-
- [`1ae31c1`](https://github.com/
|
|
1245
|
+
- [`1ae31c1`](https://github.com/statelyai/xstate/commit/1ae31c17dc81fb63e699b4b9bf1cf4ead023001d) [#1023](https://github.com/statelyai/xstate/pull/1023) Thanks [@Andarist](https://github.com/Andarist)! - Fixed memory leak - `State` objects had been retained in closures.
|
|
1198
1246
|
|
|
1199
1247
|
## 4.7.8
|
|
1200
1248
|
|
|
1201
1249
|
### Patch Changes
|
|
1202
1250
|
|
|
1203
|
-
- [`520580b`](https://github.com/
|
|
1251
|
+
- [`520580b`](https://github.com/statelyai/xstate/commit/520580b4af597f7c83c329757ae972278c2d4494) [#967](https://github.com/statelyai/xstate/pull/967) Thanks [@andrewgordstewart](https://github.com/andrewgordstewart)! - Add context & event types to InvokeConfig
|
|
1204
1252
|
|
|
1205
1253
|
## 4.7.7
|
|
1206
1254
|
|
|
1207
1255
|
### Patch Changes
|
|
1208
1256
|
|
|
1209
|
-
- [`c8db035`](https://github.com/
|
|
1257
|
+
- [`c8db035`](https://github.com/statelyai/xstate/commit/c8db035b90a7ab4a557359d493d3dd7973dacbdd) [#936](https://github.com/statelyai/xstate/pull/936) Thanks [@davidkpiano](https://github.com/statelyai)! - The `escalate()` action can now take in an expression, which will be evaluated against the `context`, `event`, and `meta` to return the error data.
|
|
1210
1258
|
|
|
1211
|
-
* [`2a3fea1`](https://github.com/
|
|
1259
|
+
* [`2a3fea1`](https://github.com/statelyai/xstate/commit/2a3fea18dcd5be18880ad64007d44947cc327d0d) [#952](https://github.com/statelyai/xstate/pull/952) Thanks [@davidkpiano](https://github.com/statelyai)! - The typings for the raise() action have been fixed to allow any event to be raised. This typed behavior will be refined in version 5, to limit raised events to those that the machine accepts.
|
|
1212
1260
|
|
|
1213
|
-
- [`f86d419`](https://github.com/
|
|
1261
|
+
- [`f86d419`](https://github.com/statelyai/xstate/commit/f86d41979ed108e2ac4df63299fc16f798da69f7) [#957](https://github.com/statelyai/xstate/pull/957) Thanks [@Andarist](https://github.com/Andarist)! - Fixed memory leak - each created service has been registered in internal map but it was never removed from it. Registration has been moved to a point where Interpreter is being started and it's deregistered when it is being stopped.
|
|
1214
1262
|
|
|
1215
1263
|
## 4.7.6
|
|
1216
1264
|
|