Merge branch 'main' into docs-showcase-addition

.changeset-xstate-test-alpha/.flat-melons-tan.md

@@ -0,0 +1,9 @@
+---
+'@xstate/test': patch
+---
+
+author: @Silverwolf90
+pr: #3380
+commit: cec8587
+
+Narrow down the `event` type passed to `EventExecutor` from the corresponding key of the `events` object

.changeset-xstate-test-alpha/.flat-trees-suffer.md

@@ -0,0 +1,9 @@
+---
+'@xstate/test': patch
+---
+
+author: @Andarist
+pr: #3367
+commit: b8cf8cfdc
+
+Fixed `getShortestPathsTo` issue that caused candidate paths to be incorrectly removed while deduplicating generated paths.

.changeset-xstate-test-alpha/.good-countries-allow.md

@@ -0,0 +1,5 @@
+---
+'@xstate/test': minor
+---
+
+Improved test output by removing id from description

.changeset-xstate-test-alpha/.mighty-terms-shake.md

@@ -0,0 +1,10 @@
+---
+'@xstate/graph': patch
+'@xstate/test': patch
+---
+
+The `serializeState()` path traversal option now provides 3 arguments to the function passed in:
+
+1. `state` - the current state
+2. `event` - the event that caused traversal to this state
+3. `prevState` 🆕 - the state before the current state (may be `undefined`)

.changeset-xstate-test-alpha/config.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": ["@changesets/changelog-github", { "repo": "statelyai/xstate" }],
+  "commit": false,
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "ignore": ["@xstate/analytics", "@xstate/scxml"],
+  "___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
+    "onlyUpdatePeerDependentsWhenOutOfRange": true,
+    "useCalculatedVersionForSnapshots": true
+  }
+}

.changeset-xstate-test-alpha/curly-windows-burn.md

@@ -0,0 +1,8 @@
+---
+'@xstate/graph': major
+---
+
+pr: #3036
+author: @davidkpiano
+
+Renamed `getAdjacencyMap` to `getValueAdjacencyMap`.

.changeset-xstate-test-alpha/curly-windows-learn.md

@@ -0,0 +1,10 @@
+---
+'@xstate/graph': major
+---
+
+pr: #3036
+author: @davidkpiano
+
+Changed `getSimplePaths` to `getSimplePlans`, and `getShortestPaths` to `getShortestPlans`. Both of these functions can be passed a machine, and return `StatePlan[]`.
+
+Added functions `traverseSimplePlans`, `traverseShortestPlans`,`traverseShortestPlansFromTo`, `traverseSimplePlansTo` and `traverseSimplePlansFromTo`, which can be passed a `Behavior` and return `StatePlan[]`.

.changeset-xstate-test-alpha/great-lions-buy.md

@@ -0,0 +1,12 @@
+---
+'@xstate/test': major
+---
+
+pr: #3036
+
+author: @mattpocock
+author: @davidkpiano
+
+Substantially simplified how paths and plans work in `TestModel`. Changed `getShortestPlans` and `getSimplePlans` to `getShortestPaths` and `getSimplePaths`. These functions now return an array of paths, instead of an array of plans which contain paths.
+
+Also added `getPaths`, which defaults to `getShortestPaths`. This can be passed a `pathGenerator` to customize how paths are generated.

.changeset-xstate-test-alpha/lazy-turtles-brand.md

@@ -0,0 +1,37 @@
+---
+'@xstate/test': major
+---
+
+pr: #3036
+author: @mattpocock
+
+Moved event cases out of `events`, and into their own attribute called `eventCases`:
+
+```ts
+const model = createTestModel(machine, {
+  eventCases: {
+    CHOOSE_CURRENCY: [
+      {
+        currency: 'GBP'
+      },
+      {
+        currency: 'USD'
+      }
+    ]
+  }
+});
+
+model.getPaths().forEach((path) => {
+  it(path.description, async () => {
+    await path.test({
+      events: {
+        CHOOSE_CURRENCY: ({ event }) => {
+          console.log(event.currency);
+        }
+      }
+    });
+  });
+});
+```
+
+`eventCases` will also now always produce a new path, instead of only creating a path for the first case which matches.

.changeset-xstate-test-alpha/lazy-turtles-bread.md

@@ -0,0 +1,8 @@
+---
+'@xstate/test': major
+---
+
+pr: #3036
+author: @davidkpiano
+
+Removed `.testCoverage()`, and instead made `getPlans`, `getShortestPlans` and `getSimplePlans` cover all states and transitions enabled by event cases by default.

.changeset-xstate-test-alpha/lazy-turtles-grand.md

@@ -0,0 +1,10 @@
+---
+'@xstate/test': major
+---
+
+pr: #3036
+author: @davidkpiano
+
+Added validation on `createTestModel` to ensure that you don't include invalid machine configuration in your test machine. Invalid machine configs include `invoke`, `after`, and any actions with a `delay`.
+
+Added `createTestMachine`, which provides a slimmed-down API for creating machines which removes these types from the config type signature.

.changeset-xstate-test-alpha/lazy-turtles-grate.md

@@ -0,0 +1,47 @@
+---
+'@xstate/test': major
+---
+
+pr: #3036
+author: @davidkpiano
+
+`getShortestPaths()` and `getPaths()` will now traverse all _transitions_ by default, not just all events.
+
+Take this machine:
+
+```ts
+const machine = createTestMachine({
+  initial: 'toggledOn',
+  states: {
+    toggledOn: {
+      on: {
+        TOGGLE: 'toggledOff'
+      }
+    },
+    toggledOff: {
+      on: {
+        TOGGLE: 'toggledOn'
+      }
+    }
+  }
+});
+```
+
+In `@xstate/test` version 0.x, this would run this path by default:
+
+```txt
+toggledOn -> TOGGLE -> toggledOff
+```
+
+This is because it satisfies two conditions:
+
+1. Covers all states
+2. Covers all events
+
+But this a complete test - it doesn't test if going from `toggledOff` to `toggledOn` works.
+
+Now, we seek to cover all transitions by default. So the path would be:
+
+```txt
+toggledOn -> TOGGLE -> toggledOff -> TOGGLE -> toggledOn
+```

.changeset-xstate-test-alpha/lazy-turtles-great.md

@@ -0,0 +1,9 @@
+---
+'@xstate/test': minor
+---
+
+pr: #3036
+author: @mattpocock
+author: @davidkpiano
+
+Added `path.testSync(...)` to allow for testing paths in sync-only environments, such as Cypress.

.changeset-xstate-test-alpha/lazy-turtles-mate.md

@@ -0,0 +1,29 @@
+---
+'@xstate/test': major
+---
+
+pr: #3036
+author: @mattpocock
+author: @davidkpiano
+
+Moved `events` from `createTestModel` to `path.test`.
+
+Old:
+
+```ts
+const model = createTestModel(machine, {
+  events: {}
+});
+```
+
+New:
+
+```ts
+const paths = model.getPaths().forEach((path) => {
+  path.test({
+    events: {}
+  });
+});
+```
+
+This allows for easier usage of per-test mocks and per-test context.

.changeset-xstate-test-alpha/lazy-turtles-trade.md

@@ -0,0 +1,22 @@
+---
+'@xstate/test': major
+---
+
+pr: #3036
+author: @mattpocock
+author: @davidkpiano
+
+Added `states` to `path.test()`:
+
+```ts
+const paths = model.getPaths().forEach((path) => {
+  path.test({
+    states: {
+      myState: () => {},
+      'myState.deep': () => {}
+    }
+  });
+});
+```
+
+This allows you to define your tests outside of your machine, keeping the machine itself easy to read.

.changeset-xstate-test-alpha/ninety-paws-roll.md

@@ -0,0 +1,5 @@
+---
+'@xstate/graph': patch
+---
+
+Fixed an internal import to not import from `xstate/src`

.changeset-xstate-test-alpha/plenty-insects-visit.md

@@ -0,0 +1,22 @@
+---
+'@xstate/graph': patch
+'@xstate/test': patch
+---
+
+author: @davidkpiano
+pr: #3864
+commit: 59f3a8e
+
+Event cases are now specified as an array of event objects, instead of an object with event types as keys and event object payloads as values:
+
+```diff
+const shortestPaths = getShortestPaths(someMachine, {
+- eventCases: {
+-   click: [{ x: 10, y: 10 }, { x: 20, y: 20 }]
+- }
++ events: [
++   { type: 'click', x: 10, y: 10 },
++   { type: 'click', x: 20, y: 20 }
++ ]
+});
+```

.changeset-xstate-test-alpha/pre.json

@@ -0,0 +1,32 @@
+{
+  "mode": "pre",
+  "tag": "alpha",
+  "initialVersions": {
+    "xstate": "4.32.1",
+    "@xstate/analytics": "0.0.1",
+    "@xstate/fsm": "2.0.0",
+    "@xstate/graph": "2.0.0-alpha.0",
+    "@xstate/immer": "0.3.1",
+    "@xstate/inspect": "0.7.0",
+    "@xstate/react": "3.0.0",
+    "@xstate/scxml": "0.2.1",
+    "@xstate/svelte": "2.0.0",
+    "@xstate/test": "1.0.0-alpha.0",
+    "@xstate/vue": "2.0.0",
+    "@xstate/solid": "0.1.3"
+  },
+  "changesets": [
+    "curly-windows-burn",
+    "curly-windows-learn",
+    "great-lions-buy",
+    "lazy-turtles-brand",
+    "lazy-turtles-bread",
+    "lazy-turtles-grand",
+    "lazy-turtles-grate",
+    "lazy-turtles-great",
+    "lazy-turtles-mate",
+    "lazy-turtles-trade",
+    "ninety-paws-roll",
+    "plenty-insects-visit"
+  ]
+}