@xmachines/docs 1.0.0-beta.21 → 1.0.0-beta.22

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.
Files changed (165) hide show
  1. package/api/@xmachines/play/classes/PlayError.md +4 -4
  2. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  3. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  4. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  5. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  6. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  7. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  8. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  9. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  10. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  11. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  12. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  13. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  14. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  15. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  16. package/api/@xmachines/play-react/README.md +20 -0
  17. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  18. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  19. package/api/@xmachines/play-react/functions/useSignalEffect.md +8 -1
  20. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  21. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  22. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -6
  23. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  24. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  25. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +34 -21
  26. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  27. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  28. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  29. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  30. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  31. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  32. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  33. package/api/@xmachines/play-router/README.md +17 -0
  34. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  35. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +34 -21
  36. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  37. package/api/@xmachines/play-router/functions/connectRouter.md +1 -1
  38. package/api/@xmachines/play-router/functions/createBrowserHistory.md +6 -1
  39. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  40. package/api/@xmachines/play-router/functions/createRouter.md +1 -1
  41. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  42. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  43. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  44. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  45. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  46. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  47. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  48. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  49. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  50. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  51. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  52. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  53. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  54. package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
  55. package/api/@xmachines/play-router/interfaces/BrowserHistory.md +14 -14
  56. package/api/@xmachines/play-router/interfaces/BrowserWindow.md +14 -14
  57. package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +4 -4
  58. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  59. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  60. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  61. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  62. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  63. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  64. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  65. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  66. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  67. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  68. package/api/@xmachines/play-router/interfaces/VanillaRouter.md +4 -4
  69. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  70. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  71. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  72. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  73. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  74. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  75. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  76. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  77. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  78. package/api/@xmachines/play-solid/README.md +20 -0
  79. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  80. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -6
  81. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  82. package/api/@xmachines/play-solid/variables/PlayRenderer.md +7 -1
  83. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  84. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +35 -22
  85. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  86. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  87. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  88. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  89. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  90. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  91. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  92. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  93. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  94. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  95. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +34 -21
  96. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  97. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  98. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  99. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  100. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  101. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  102. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  103. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  104. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  105. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  106. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  107. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  108. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  109. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  110. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +35 -22
  111. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  112. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  113. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  114. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  115. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  116. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  117. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  118. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  119. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  120. package/api/@xmachines/play-vue/README.md +20 -0
  121. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  122. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  123. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  124. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  125. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  126. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  127. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  128. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  129. package/api/@xmachines/play-vue-router/classes/RouteMap.md +7 -7
  130. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +7 -7
  131. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +35 -22
  132. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  133. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  134. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  135. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  136. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  137. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  138. package/api/@xmachines/play-xstate/README.md +13 -1
  139. package/api/@xmachines/play-xstate/classes/PlayerActor.md +13 -13
  140. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  141. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  142. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  143. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  144. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  145. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  146. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  147. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  148. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  149. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  150. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  151. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  152. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  153. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  154. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  155. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  156. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  157. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  158. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  159. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  160. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  161. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
  162. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  163. package/api/rfc/play.md +1 -1
  164. package/package.json +2 -2
  165. package/rfc/play.md +1 -1
@@ -6,7 +6,7 @@
6
6
  function definePlayer<TMachine>(config): PlayerFactory<TMachine>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/define-player.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/define-player.ts#L61)
9
+ Defined in: [packages/play-xstate/src/define-player.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/define-player.ts#L61)
10
10
 
11
11
  Create a player factory from an XState machine
12
12
 
@@ -6,7 +6,7 @@
6
6
  function deriveRoute(stateMeta): string | null;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/derive-route.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/derive-route.ts#L90)
9
+ Defined in: [packages/play-xstate/src/routing/derive-route.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/derive-route.ts#L90)
10
10
 
11
11
  Derive route from XState state metadata
12
12
 
@@ -6,7 +6,7 @@
6
6
  function eventMatches<TEvent>(eventType): Guard<unknown, TEvent>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/helpers.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/guards/helpers.ts#L49)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/guards/helpers.ts#L49)
10
10
 
11
11
  Check if event type matches expected type
12
12
 
@@ -6,7 +6,7 @@
6
6
  function formatPlayRouteTransitions<T>(machineConfig): T;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L88)
9
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/format-play-route-transitions.ts#L88)
10
10
 
11
11
  Formats play.route transitions from declarative route configs
12
12
 
@@ -6,7 +6,7 @@
6
6
  function hasContext<TContext>(path): Guard<TContext, PlayEvent>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/helpers.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/guards/helpers.ts#L23)
9
+ Defined in: [packages/play-xstate/src/guards/helpers.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/guards/helpers.ts#L23)
10
10
 
11
11
  Check if context has a truthy value at path
12
12
 
@@ -6,7 +6,7 @@
6
6
  function isAbsoluteRoute(path): boolean;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/derive-route.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/derive-route.ts#L150)
9
+ Defined in: [packages/play-xstate/src/routing/derive-route.ts:150](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/derive-route.ts#L150)
10
10
 
11
11
  Check if route path is absolute
12
12
 
@@ -6,7 +6,7 @@
6
6
  function negateGuard<TContext, TEvent>(guard): ComposedGuard;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/compose.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/guards/compose.ts#L203)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:203](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/guards/compose.ts#L203)
10
10
 
11
11
  Negate a guard using XState's not() helper
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayerConfig\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/types.ts#L7)
5
+ Defined in: [packages/play-xstate/src/types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/types.ts#L7)
6
6
 
7
7
  Configuration for definePlayer()
8
8
 
@@ -16,5 +16,5 @@ Configuration for definePlayer()
16
16
 
17
17
  | Property | Type | Description | Defined in |
18
18
  | ---------------------------------------- | ------------------------------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | <a id="property-machine"></a> `machine` | `TMachine` | XState v5 state machine | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/types.ts#L9) |
20
- | <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | Lifecycle hooks and configuration | [packages/play-xstate/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/types.ts#L12) |
19
+ | <a id="property-machine"></a> `machine` | `TMachine` | XState v5 state machine | [packages/play-xstate/src/types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/types.ts#L9) |
20
+ | <a id="property-options"></a> `options?` | [`PlayerOptions`](PlayerOptions.md)\<`TMachine`\> | Lifecycle hooks and configuration | [packages/play-xstate/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/types.ts#L12) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayerFactoryResumeOptions\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/types.ts#L47)
5
+ Defined in: [packages/play-xstate/src/types.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/types.ts#L47)
6
6
 
7
7
  Optional restore arguments for the player factory.
8
8
 
@@ -19,4 +19,4 @@ Mirrors XState's createActor options bag while preserving the existing
19
19
 
20
20
  | Property | Type | Description | Defined in |
21
21
  | ------------------------------------------ | --------------------------------------------------------------------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
22
- | <a id="property-snapshot"></a> `snapshot?` | [`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\> | Persisted XState snapshot used to restore actor state. | [packages/play-xstate/src/types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/types.ts#L49) |
22
+ | <a id="property-snapshot"></a> `snapshot?` | [`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TMachine`\> | Persisted XState snapshot used to restore actor state. | [packages/play-xstate/src/types.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/types.ts#L49) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayerOptions\<TMachine\>
4
4
 
5
- Defined in: [packages/play-xstate/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/types.ts#L20)
5
+ Defined in: [packages/play-xstate/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/types.ts#L20)
6
6
 
7
7
  Player lifecycle hooks
8
8
 
@@ -18,8 +18,8 @@ Per CONTEXT.md: Rich set of hooks for observability
18
18
 
19
19
  | Property | Type | Description | Defined in |
20
20
  | ---------------------------------------------------- | --------------------------------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
21
- | <a id="property-onerror"></a> `onError?` | (`actor`, `error`) => `void` | Called on actor errors | [packages/play-xstate/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/types.ts#L38) |
22
- | <a id="property-onstart"></a> `onStart?` | (`actor`) => `void` | Called when actor starts | [packages/play-xstate/src/types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/types.ts#L22) |
23
- | <a id="property-onstatechange"></a> `onStateChange?` | (`actor`, `state`) => `void` | Called when state signal changes | [packages/play-xstate/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/types.ts#L35) |
24
- | <a id="property-onstop"></a> `onStop?` | (`actor`) => `void` | Called when actor stops | [packages/play-xstate/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/types.ts#L25) |
25
- | <a id="property-ontransition"></a> `onTransition?` | (`actor`, `prevState`, `nextState`) => `void` | Called on every state transition | [packages/play-xstate/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/types.ts#L28) |
21
+ | <a id="property-onerror"></a> `onError?` | (`actor`, `error`) => `void` | Called on actor errors | [packages/play-xstate/src/types.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/types.ts#L38) |
22
+ | <a id="property-onstart"></a> `onStart?` | (`actor`) => `void` | Called when actor starts | [packages/play-xstate/src/types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/types.ts#L22) |
23
+ | <a id="property-onstatechange"></a> `onStateChange?` | (`actor`, `state`) => `void` | Called when state signal changes | [packages/play-xstate/src/types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/types.ts#L35) |
24
+ | <a id="property-onstop"></a> `onStop?` | (`actor`) => `void` | Called when actor stops | [packages/play-xstate/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/types.ts#L25) |
25
+ | <a id="property-ontransition"></a> `onTransition?` | (`actor`, `prevState`, `nextState`) => `void` | Called on every state transition | [packages/play-xstate/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/types.ts#L28) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteContext
4
4
 
5
- Defined in: [packages/play-xstate/src/routing/types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/types.ts#L11)
5
+ Defined in: [packages/play-xstate/src/routing/types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/types.ts#L11)
6
6
 
7
7
  Route build context from machine context
8
8
 
@@ -16,7 +16,7 @@ Route build context from machine context
16
16
 
17
17
  | Property | Type | Description | Defined in |
18
18
  | ------------------------------------------------ | ------------------------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
19
- | <a id="property-basepath"></a> `basePath?` | `string` | Base path for relative routes | [packages/play-xstate/src/routing/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/types.ts#L13) |
20
- | <a id="property-hash"></a> `hash?` | `string` | Hash fragment | [packages/play-xstate/src/routing/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/types.ts#L19) |
21
- | <a id="property-query"></a> `query?` | `Record`\<`string`, `unknown`\> | Query parameters | [packages/play-xstate/src/routing/types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/types.ts#L17) |
22
- | <a id="property-routeparams"></a> `routeParams?` | `Record`\<`string`, `unknown`\> | Route parameters to substitute | [packages/play-xstate/src/routing/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/types.ts#L15) |
19
+ | <a id="property-basepath"></a> `basePath?` | `string` | Base path for relative routes | [packages/play-xstate/src/routing/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/types.ts#L13) |
20
+ | <a id="property-hash"></a> `hash?` | `string` | Hash fragment | [packages/play-xstate/src/routing/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/types.ts#L19) |
21
+ | <a id="property-query"></a> `query?` | `Record`\<`string`, `unknown`\> | Query parameters | [packages/play-xstate/src/routing/types.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/types.ts#L17) |
22
+ | <a id="property-routeparams"></a> `routeParams?` | `Record`\<`string`, `unknown`\> | Route parameters to substitute | [packages/play-xstate/src/routing/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/types.ts#L15) |
@@ -6,7 +6,7 @@
6
6
  type ComposedGuard = GuardPredicate<MachineContext, EventObject, unknown, ParameterizedObject>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/compose.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/guards/compose.ts#L14)
9
+ Defined in: [packages/play-xstate/src/guards/compose.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/guards/compose.ts#L14)
10
10
 
11
11
  Narrowest public return type for guard composition helpers.
12
12
 
@@ -6,7 +6,7 @@
6
6
  type Guard<TContext, TEvent> = (args) => boolean;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/guards/types.ts#L13)
9
+ Defined in: [packages/play-xstate/src/guards/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/guards/types.ts#L13)
10
10
 
11
11
  Standard XState guard function signature
12
12
 
@@ -6,7 +6,7 @@
6
6
  type GuardArray<TContext, TEvent> = Guard<TContext, TEvent>[] | string[];
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/guards/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/guards/types.ts#L23)
9
+ Defined in: [packages/play-xstate/src/guards/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/guards/types.ts#L23)
10
10
 
11
11
  Array of guard predicates or guard names
12
12
 
@@ -6,7 +6,7 @@
6
6
  type PlayerFactory<TMachine> = (input?, options?) => PlayerActor<TMachine>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/types.ts#L57)
9
+ Defined in: [packages/play-xstate/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/types.ts#L57)
10
10
 
11
11
  Factory function returned by definePlayer()
12
12
 
@@ -6,7 +6,7 @@
6
6
  type RouteMachineConfig = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L52)
9
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/format-play-route-transitions.ts#L52)
10
10
 
11
11
  Minimal structural constraint for machine configs accepted by
12
12
  `formatPlayRouteTransitions`.
@@ -32,7 +32,7 @@ through the transform, so the return value remains directly usable by
32
32
  optional context?: unknown;
33
33
  ```
34
34
 
35
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L53)
35
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/format-play-route-transitions.ts#L53)
36
36
 
37
37
  ---
38
38
 
@@ -42,7 +42,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:5
42
42
  optional on?: Record<string, unknown>;
43
43
  ```
44
44
 
45
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L55)
45
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/format-play-route-transitions.ts#L55)
46
46
 
47
47
  ---
48
48
 
@@ -52,4 +52,4 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:5
52
52
  optional states?: Record<string, unknown>;
53
53
  ```
54
54
 
55
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L54)
55
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/format-play-route-transitions.ts#L54)
@@ -6,7 +6,7 @@
6
6
  type RouteStateNode = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L21)
9
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/format-play-route-transitions.ts#L21)
10
10
 
11
11
  Minimal structural shape of a single XState state node as read by
12
12
  `formatPlayRouteTransitions` when crawling the machine config.
@@ -29,7 +29,7 @@ the index signature.
29
29
  optional id?: string;
30
30
  ```
31
31
 
32
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L23)
32
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/format-play-route-transitions.ts#L23)
33
33
 
34
34
  Optional explicit state ID (e.g. `"home"`, `"settings"`). Used as the `#id` target in `play.route` events.
35
35
 
@@ -41,7 +41,7 @@ Optional explicit state ID (e.g. `"home"`, `"settings"`). Used as the `#id` targ
41
41
  optional meta?: object;
42
42
  ```
43
43
 
44
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L25)
44
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/format-play-route-transitions.ts#L25)
45
45
 
46
46
  State metadata — `meta.route` marks the state as routable.
47
47
 
@@ -61,6 +61,6 @@ URL path template (e.g. `"/profile/:username"`, `"/settings/:section?"`).
61
61
  optional states?: Record<string, RouteStateNode>;
62
62
  ```
63
63
 
64
- Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
64
+ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
65
65
 
66
66
  Nested child states, recursively crawled for additional route declarations.
@@ -6,7 +6,7 @@
6
6
  function defineXmVitestConfig(importMetaUrl, overrides): object;
7
7
  ```
8
8
 
9
- Defined in: [src/index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/shared/src/index.ts#L10)
9
+ Defined in: [src/index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/shared/src/index.ts#L10)
10
10
 
11
11
  Create a Vitest config with XMachines workspace defaults.
12
12
 
@@ -26,4 +26,4 @@ render it under `@xmachines/shared` instead of nested module pages.
26
26
 
27
27
  | Name | Type | Defined in |
28
28
  | ------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- |
29
- | `test` | `any` | [config/vitest.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/shared/config/vitest.ts#L82) |
29
+ | `test` | `any` | [config/vitest.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/shared/config/vitest.ts#L82) |
@@ -6,7 +6,7 @@
6
6
  function xmAliases(importMetaUrl): Record<string, string>;
7
7
  ```
8
8
 
9
- Defined in: [src/index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/shared/src/index.ts#L20)
9
+ Defined in: [src/index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/shared/src/index.ts#L20)
10
10
 
11
11
  Build Vite/Vitest alias entries for all `@xmachines/*` workspace packages.
12
12
 
package/api/rfc/play.md CHANGED
@@ -199,7 +199,7 @@ Wraps XState v5 to satisfy the `AbstractActor` contract. Provides the primary AP
199
199
 
200
200
  **Utility Exports:**
201
201
 
202
- - Guard combinators: `composeGuards`, `composeGuardsOr`, `negateGuard`, `hasContext`, `eventMatches`, `stateMatches`
202
+ - Guard combinators: `composeGuards`, `composeGuardsOr`, `negateGuard`, `hasContext`, `eventMatches`, `contextFieldMatches`
203
203
  - Route derivation: `deriveRoute`, `isAbsoluteRoute`, `buildRouteUrl`, `formatPlayRouteTransitions`
204
204
 
205
205
  **Responsibilities:**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xmachines/docs",
3
- "version": "1.0.0-beta.21",
3
+ "version": "1.0.0-beta.22",
4
4
  "description": "Documentation for XMachines",
5
5
  "keywords": [
6
6
  "documentation",
@@ -48,7 +48,7 @@
48
48
  "typedoc": "typedoc"
49
49
  },
50
50
  "devDependencies": {
51
- "@xmachines/shared": "1.0.0-beta.21",
51
+ "@xmachines/shared": "1.0.0-beta.22",
52
52
  "typedoc": "^0.28.18",
53
53
  "typedoc-plugin-llms-txt": "^0.1.2",
54
54
  "typedoc-plugin-markdown": "^4.11.0"
package/rfc/play.md CHANGED
@@ -199,7 +199,7 @@ Wraps XState v5 to satisfy the `AbstractActor` contract. Provides the primary AP
199
199
 
200
200
  **Utility Exports:**
201
201
 
202
- - Guard combinators: `composeGuards`, `composeGuardsOr`, `negateGuard`, `hasContext`, `eventMatches`, `stateMatches`
202
+ - Guard combinators: `composeGuards`, `composeGuardsOr`, `negateGuard`, `hasContext`, `eventMatches`, `contextFieldMatches`
203
203
  - Route derivation: `deriveRoute`, `isAbsoluteRoute`, `buildRouteUrl`, `formatPlayRouteTransitions`
204
204
 
205
205
  **Responsibilities:**