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

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 (171) 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-dom-router/README.md +152 -0
  17. package/api/@xmachines/{play-router → play-dom-router}/functions/connectRouter.md +8 -4
  18. package/api/@xmachines/{play-router → play-dom-router}/functions/createBrowserHistory.md +2 -2
  19. package/api/@xmachines/{play-router → play-dom-router}/functions/createRouter.md +12 -34
  20. package/api/@xmachines/{play-router → play-dom-router}/interfaces/BrowserHistory.md +17 -17
  21. package/api/@xmachines/{play-router → play-dom-router}/interfaces/BrowserWindow.md +17 -17
  22. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +15 -0
  23. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +28 -0
  24. package/api/@xmachines/{play-router-demo → play-dom-router-demo}/README.md +20 -16
  25. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  26. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  27. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  28. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  29. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  30. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -7
  31. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  32. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  33. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +21 -21
  34. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  35. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  36. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  37. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  38. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  39. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  40. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  41. package/api/@xmachines/play-router/README.md +7 -12
  42. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  43. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +21 -21
  44. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +32 -0
  45. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  46. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  47. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  48. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  49. package/api/@xmachines/play-router/functions/extractQuery.md +22 -0
  50. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  51. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  52. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  53. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  54. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  55. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  56. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  57. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  58. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  59. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  60. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  61. package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
  62. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +13 -0
  63. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  64. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  65. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  66. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  67. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  68. package/api/@xmachines/play-router/interfaces/RouteMatch.md +12 -0
  69. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  70. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  71. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  72. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  73. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  74. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  75. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  76. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  77. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  78. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  79. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  80. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  81. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  82. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  83. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  84. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -7
  85. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  86. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  87. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  88. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +22 -22
  89. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  90. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  91. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  92. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  93. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  94. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  95. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  96. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  97. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  98. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  99. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +21 -21
  100. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  101. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  102. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  103. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  104. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  105. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  106. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  107. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  108. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  109. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  110. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  111. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  112. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  113. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  114. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +22 -22
  115. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  116. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  117. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  118. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  119. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  120. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  121. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  122. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  123. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  124. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  125. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  126. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  127. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  128. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  129. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  130. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  131. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  132. package/api/@xmachines/play-vue-router/classes/RouteMap.md +7 -7
  133. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +7 -7
  134. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +22 -22
  135. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  136. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  137. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  138. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  139. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  140. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  141. package/api/@xmachines/play-xstate/classes/PlayerActor.md +11 -11
  142. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  143. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  144. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  145. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  146. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  147. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  148. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  149. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  150. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  151. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  152. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  153. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  154. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  155. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  156. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  157. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  158. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  159. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  160. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  161. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  162. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  163. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
  164. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  165. package/api/README.md +2 -1
  166. package/api/llms.txt +1 -0
  167. package/examples/README.md +1 -1
  168. package/examples/multi-router-integration.md +36 -26
  169. package/package.json +4 -2
  170. package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +0 -13
  171. package/api/@xmachines/play-router/interfaces/VanillaRouter.md +0 -28
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: SolidRouterBridge
4
4
 
5
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L44)
5
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L44)
6
6
 
7
7
  TanStack Solid Router integration bridge extending RouterBridgeBase
8
8
 
@@ -25,7 +25,7 @@ new SolidRouterBridge(
25
25
  routeMap): SolidRouterBridge;
26
26
  ```
27
27
 
28
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L54)
28
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L54)
29
29
 
30
30
  Create a TanStack Solid Router bridge
31
31
 
@@ -49,15 +49,15 @@ Create a TanStack Solid Router bridge
49
49
 
50
50
  | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
51
51
  | --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
52
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L102) |
53
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L90) |
54
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L89) |
55
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L92) |
56
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L91) |
57
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L103) |
58
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L105) |
59
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L104) |
60
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L93) |
52
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L102) |
53
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L90) |
54
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L89) |
55
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [play-router/src/router-bridge-base.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L92) |
56
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [play-router/src/router-bridge-base.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L91) |
57
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [play-router/src/router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L103) |
58
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L105) |
59
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L104) |
60
+ | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [play-router/src/router-bridge-base.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L93) |
61
61
 
62
62
  ## Methods
63
63
 
@@ -67,7 +67,7 @@ Create a TanStack Solid Router bridge
67
67
  connect(): void;
68
68
  ```
69
69
 
70
- Defined in: [play-router/src/router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L129)
70
+ Defined in: [play-router/src/router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L129)
71
71
 
72
72
  Connect the router bridge to the Actor.
73
73
 
@@ -99,7 +99,7 @@ Adapters that need custom initial-sync behavior should override
99
99
  disconnect(): void;
100
100
  ```
101
101
 
102
- Defined in: [play-router/src/router-bridge-base.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L197)
102
+ Defined in: [play-router/src/router-bridge-base.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L197)
103
103
 
104
104
  Disconnect the router bridge from the Actor.
105
105
 
@@ -121,7 +121,7 @@ Stops signal watching and unregisters framework-specific router listener.
121
121
  dispose(): void;
122
122
  ```
123
123
 
124
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L117)
124
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L117)
125
125
 
126
126
  Dispose the bridge (alias for disconnect).
127
127
 
@@ -137,7 +137,7 @@ Dispose the bridge (alias for disconnect).
137
137
  protected extractParams(pathname, stateId): Record<string, string>;
138
138
  ```
139
139
 
140
- Defined in: [play-router/src/router-bridge-base.ts:300](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L300)
140
+ Defined in: [play-router/src/router-bridge-base.ts:300](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L300)
141
141
 
142
142
  Extract path parameters from URL using the URLPattern API.
143
143
 
@@ -171,7 +171,7 @@ Extracted path parameters, or empty object if URLPattern is unavailable or no ma
171
171
  protected extractQuery(search): Record<string, string>;
172
172
  ```
173
173
 
174
- Defined in: [play-router/src/router-bridge-base.ts:321](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L321)
174
+ Defined in: [play-router/src/router-bridge-base.ts:321](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L321)
175
175
 
176
176
  Extract query parameters from URL search string.
177
177
 
@@ -199,7 +199,7 @@ Extracted query parameters or empty object
199
199
  protected getInitialRouterPath(): string | null;
200
200
  ```
201
201
 
202
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L79)
202
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L79)
203
203
 
204
204
  Get the router's current path at connect() time for initial sync.
205
205
 
@@ -223,7 +223,7 @@ when the user cold-loads on a deep-link URL.
223
223
  protected navigateRouter(path): void;
224
224
  ```
225
225
 
226
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L68)
226
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L68)
227
227
 
228
228
  Navigate TanStack Solid Router to the given path.
229
229
 
@@ -249,7 +249,7 @@ Navigate TanStack Solid Router to the given path.
249
249
  protected syncActorFromRouter(pathname, search?): void;
250
250
  ```
251
251
 
252
- Defined in: [play-router/src/router-bridge-base.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L248)
252
+ Defined in: [play-router/src/router-bridge-base.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L248)
253
253
 
254
254
  Sync actor state when router location changes.
255
255
 
@@ -279,7 +279,7 @@ Prevents circular updates via isProcessingNavigation flag.
279
279
  protected syncRouterFromActor(route): void;
280
280
  ```
281
281
 
282
- Defined in: [play-router/src/router-bridge-base.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/router-bridge-base.ts#L228)
282
+ Defined in: [play-router/src/router-bridge-base.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/router-bridge-base.ts#L228)
283
283
 
284
284
  Sync router location when actor route signal changes.
285
285
 
@@ -312,7 +312,7 @@ suppressed as circular echoes.
312
312
  protected unwatchRouterChanges(): void;
313
313
  ```
314
314
 
315
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L109)
315
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:109](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L109)
316
316
 
317
317
  Stop watching TanStack Router changes.
318
318
 
@@ -332,7 +332,7 @@ Stop watching TanStack Router changes.
332
332
  protected watchRouterChanges(): void;
333
333
  ```
334
334
 
335
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L98)
335
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L98)
336
336
 
337
337
  Subscribe to ALL navigation events via router.history.
338
338
 
@@ -6,7 +6,7 @@
6
6
  function PlayRouterProvider<TActor>(props): any;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L19)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L19)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/create-route-map.ts#L27)
9
+ Defined in: [play-tanstack-solid-router/src/create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/create-route-map.ts#L27)
10
10
 
11
11
  Create a RouteMap from an XState machine
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [play-router/src/types.ts:216](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/types.ts#L216)
5
+ Defined in: [play-router/src/types.ts:216](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/types.ts#L216)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
112
 
113
113
  | Property | Modifier | Type | Defined in |
114
114
  | -------------------------------------- | ---------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/types.ts#L221) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/types.ts#L219) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/types.ts#L220) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/types.ts#L218) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:217](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/types.ts#L217) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [play-router/src/types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/types.ts#L221) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/types.ts#L219) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/types.ts#L220) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [play-router/src/types.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/types.ts#L218) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [play-router/src/types.ts:217](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/types.ts#L217) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps\<TActor\>
4
4
 
5
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L11)
5
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L11)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -14,7 +14,7 @@ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:11](https:/
14
14
 
15
15
  | Property | Type | Description | Defined in |
16
16
  | ----------------------------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-actor"></a> `actor` | `TActor` | - | [play-tanstack-solid-router/src/play-router-provider.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L12) |
18
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [play-tanstack-solid-router/src/play-router-provider.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L16) |
19
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | - | [play-tanstack-solid-router/src/play-router-provider.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L14) |
20
- | <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | - | [play-tanstack-solid-router/src/play-router-provider.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L13) |
17
+ | <a id="property-actor"></a> `actor` | `TActor` | - | [play-tanstack-solid-router/src/play-router-provider.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L12) |
18
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [play-tanstack-solid-router/src/play-router-provider.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L16) |
19
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | - | [play-tanstack-solid-router/src/play-router-provider.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L14) |
20
+ | <a id="property-router"></a> `router` | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md) | - | [play-tanstack-solid-router/src/play-router-provider.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L13) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-tanstack-solid-router/src/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/types.ts#L19)
5
+ Defined in: [play-tanstack-solid-router/src/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/types.ts#L19)
6
6
 
7
7
  A single state ID ↔ path mapping entry for the TanStack Solid Router adapter.
8
8
 
@@ -19,5 +19,5 @@ const mapping: RouteMapping = { stateId: "#profile", path: "/profile/:userId" };
19
19
 
20
20
  | Property | Modifier | Type | Description | Defined in |
21
21
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
22
- | <a id="property-path"></a> `path` | `readonly` | `string` | TanStack Router path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-tanstack-solid-router/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/types.ts#L23) |
23
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID (e.g., `"#home"`, `"#profile"`) | [play-tanstack-solid-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/types.ts#L21) |
22
+ | <a id="property-path"></a> `path` | `readonly` | `string` | TanStack Router path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [play-tanstack-solid-router/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/types.ts#L23) |
23
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID (e.g., `"#home"`, `"#profile"`) | [play-tanstack-solid-router/src/types.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/types.ts#L21) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/types.ts#L264)
5
+ Defined in: [play-router/src/types.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/types.ts#L264)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/types.ts#L280)
57
+ Defined in: [play-router/src/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/types.ts#L280)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [play-router/src/types.ts:296](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/types.ts#L296)
86
+ Defined in: [play-router/src/types.ts:296](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/types.ts#L296)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -6,6 +6,6 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L8)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L8)
10
10
 
11
11
  Minimum actor shape accepted by PlayRouterProvider.
@@ -6,4 +6,4 @@
6
6
  type TanStackRouterInstance = ConstructorParameters<typeof SolidRouterBridge>[0];
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L9)
9
+ Defined in: [play-tanstack-solid-router/src/play-router-provider.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/play-router-provider.tsx#L9)
@@ -6,7 +6,7 @@
6
6
  type TanStackRouterLike = object;
7
7
  ```
8
8
 
9
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L27)
9
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L27)
10
10
 
11
11
  ## Properties
12
12
 
@@ -16,7 +16,7 @@ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:27](https://g
16
16
  history: object;
17
17
  ```
18
18
 
19
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L30)
19
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L30)
20
20
 
21
21
  #### subscribe()
22
22
 
@@ -42,7 +42,7 @@ subscribe(handler): () => void;
42
42
  optional state?: object;
43
43
  ```
44
44
 
45
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L29)
45
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L29)
46
46
 
47
47
  #### location?
48
48
 
@@ -64,7 +64,7 @@ optional pathname?: string;
64
64
  navigate(args): void;
65
65
  ```
66
66
 
67
- Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L28)
67
+ Defined in: [play-tanstack-solid-router/src/solid-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L28)
68
68
 
69
69
  #### Parameters
70
70
 
@@ -6,7 +6,7 @@
6
6
  function defineRegistry<C>(catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/define-registry.ts#L114)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/define-registry.ts#L114)
10
10
 
11
11
  Create a component registry, automatically wrapping `.vue` SFCs so they work
12
12
  correctly with `@json-render/vue`'s rendering pipeline.
@@ -6,7 +6,7 @@
6
6
  function useActor(): PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/useActor.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/useActor.ts#L42)
9
+ Defined in: [packages/play-vue/src/useActor.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/useActor.ts#L42)
10
10
 
11
11
  ## Returns
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRendererProps\<TLogic\>
4
4
 
5
- Defined in: [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/types.ts#L25)
5
+ Defined in: [packages/play-vue/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/types.ts#L25)
6
6
 
7
7
  Props for PlayRenderer component
8
8
 
@@ -16,7 +16,7 @@ Props for PlayRenderer component
16
16
 
17
17
  | Property | Type | Description | Defined in |
18
18
  | ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
19
- | <a id="property-actions"></a> `actions?` | `object` | Optional map of json-render action names to XState event type strings. Values are constrained to `EventFromLogic<TLogic>["type"]` — passing a non-existent event type string is a compile error when TLogic is specified. | [packages/play-vue/src/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/types.ts#L46) |
20
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/types.ts#L27) |
21
- | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from @json-render/vue defineRegistry | [packages/play-vue/src/types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/types.ts#L30) |
22
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-vue/src/types.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/types.ts#L39) |
19
+ | <a id="property-actions"></a> `actions?` | `object` | Optional map of json-render action names to XState event type strings. Values are constrained to `EventFromLogic<TLogic>["type"]` — passing a non-existent event type string is a compile error when TLogic is specified. | [packages/play-vue/src/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/types.ts#L46) |
20
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`TLogic`, [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [packages/play-vue/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/types.ts#L27) |
21
+ | <a id="property-registry"></a> `registry` | `ComponentRegistry` | Component registry from @json-render/vue defineRegistry | [packages/play-vue/src/types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/types.ts#L30) |
22
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (e.g. from `xstateStoreStateStore` in @json-render/xstate). When provided, PlayRenderer operates in controlled mode — spec.state is ignored and this store is the single source of truth for UI state (form values, etc.). When omitted, a fresh @xstate/store atom is created internally per view transition, seeded from spec.state. | [packages/play-vue/src/types.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/types.ts#L39) |
@@ -6,7 +6,7 @@
6
6
  type ComponentEntry<C, K> = ComponentFn<C, K> | Component;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/define-registry.ts#L89)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/define-registry.ts#L89)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,7 +6,7 @@
6
6
  type ComponentsMap<C> = { [K in keyof InferCatalogComponents<C>]?: ComponentEntry<C, K> };
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/define-registry.ts#L93)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/define-registry.ts#L93)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -6,13 +6,13 @@
6
6
  type DefineRegistryOptions<C> = Parameters<typeof defineRegistryBase>[1] & object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/define-registry.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/define-registry.ts#L97)
9
+ Defined in: [packages/play-vue/src/define-registry.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/define-registry.ts#L97)
10
10
 
11
11
  ## Type Declaration
12
12
 
13
13
  | Name | Type | Defined in |
14
14
  | ------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
15
- | `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/define-registry.ts#L100) |
15
+ | `components?` | [`ComponentsMap`](ComponentsMap.md)\<`C`\> | [packages/play-vue/src/define-registry.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/define-registry.ts#L100) |
16
16
 
17
17
  ## Type Parameters
18
18
 
@@ -6,4 +6,4 @@
6
6
  type PlayActor = AbstractActor<AnyActorLogic>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/useActor.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/useActor.ts#L25)
9
+ Defined in: [packages/play-vue/src/useActor.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/useActor.ts#L25)
@@ -6,4 +6,4 @@
6
6
  const PlayRenderer: DefineComponent<{}, {}, unknown>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue/src/vue-shim.d.ts#L3)
9
+ Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue/src/vue-shim.d.ts#L3)
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-vue-router/src/route-map.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/route-map.ts#L14)
5
+ Defined in: [play-vue-router/src/route-map.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/route-map.ts#L14)
6
6
 
7
7
  VueBaseRouteMap — intermediate base class for Vue Router adapters.
8
8
 
@@ -40,7 +40,7 @@ class MyVueRouteMap extends VueBaseRouteMap {
40
40
  new RouteMap(mappings): RouteMap;
41
41
  ```
42
42
 
43
- Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/vue-base-route-map.ts#L32)
43
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-base-route-map.ts#L32)
44
44
 
45
45
  #### Parameters
46
46
 
@@ -64,7 +64,7 @@ Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xm
64
64
  getPathByStateId(stateId): string | null;
65
65
  ```
66
66
 
67
- Defined in: [play-router/src/base-route-map.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/base-route-map.ts#L202)
67
+ Defined in: [play-router/src/base-route-map.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/base-route-map.ts#L202)
68
68
 
69
69
  Look up the path pattern registered for a state ID.
70
70
 
@@ -99,7 +99,7 @@ map.getPathByStateId("missing"); // null
99
99
  getPattern(stateId): string | undefined;
100
100
  ```
101
101
 
102
- Defined in: [play-vue-router/src/vue-base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/vue-base-route-map.ts#L58)
102
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-base-route-map.ts#L58)
103
103
 
104
104
  Get the URL path pattern for a given state ID (e.g. `"/profile/:userId"`).
105
105
 
@@ -125,7 +125,7 @@ Get the URL path pattern for a given state ID (e.g. `"/profile/:userId"`).
125
125
  getRouteName(stateId): string | undefined;
126
126
  ```
127
127
 
128
- Defined in: [play-vue-router/src/vue-base-route-map.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/vue-base-route-map.ts#L48)
128
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-base-route-map.ts#L48)
129
129
 
130
130
  Get the Vue Router route name for a given state ID.
131
131
 
@@ -151,7 +151,7 @@ Get the Vue Router route name for a given state ID.
151
151
  getStateId(routeName): string | undefined;
152
152
  ```
153
153
 
154
- Defined in: [play-vue-router/src/vue-base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/vue-base-route-map.ts#L53)
154
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-base-route-map.ts#L53)
155
155
 
156
156
  Get the state ID for a given Vue Router route name.
157
157
 
@@ -177,7 +177,7 @@ Get the state ID for a given Vue Router route name.
177
177
  getStateIdByPath(path): string | null;
178
178
  ```
179
179
 
180
- Defined in: [play-router/src/base-route-map.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/base-route-map.ts#L167)
180
+ Defined in: [play-router/src/base-route-map.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/base-route-map.ts#L167)
181
181
 
182
182
  Resolve a URL path to its mapped state ID.
183
183
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: VueBaseRouteMap
4
4
 
5
- Defined in: [play-vue-router/src/vue-base-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/vue-base-route-map.ts#L28)
5
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-base-route-map.ts#L28)
6
6
 
7
7
  VueBaseRouteMap — intermediate base class for Vue Router adapters.
8
8
 
@@ -44,7 +44,7 @@ class MyVueRouteMap extends VueBaseRouteMap {
44
44
  new VueBaseRouteMap(mappings): VueBaseRouteMap;
45
45
  ```
46
46
 
47
- Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/vue-base-route-map.ts#L32)
47
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-base-route-map.ts#L32)
48
48
 
49
49
  #### Parameters
50
50
 
@@ -68,7 +68,7 @@ Defined in: [play-vue-router/src/vue-base-route-map.ts:32](https://gitlab.com/xm
68
68
  getPathByStateId(stateId): string | null;
69
69
  ```
70
70
 
71
- Defined in: [play-router/src/base-route-map.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/base-route-map.ts#L202)
71
+ Defined in: [play-router/src/base-route-map.ts:202](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/base-route-map.ts#L202)
72
72
 
73
73
  Look up the path pattern registered for a state ID.
74
74
 
@@ -103,7 +103,7 @@ map.getPathByStateId("missing"); // null
103
103
  getPattern(stateId): string | undefined;
104
104
  ```
105
105
 
106
- Defined in: [play-vue-router/src/vue-base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/vue-base-route-map.ts#L58)
106
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-base-route-map.ts#L58)
107
107
 
108
108
  Get the URL path pattern for a given state ID (e.g. `"/profile/:userId"`).
109
109
 
@@ -125,7 +125,7 @@ Get the URL path pattern for a given state ID (e.g. `"/profile/:userId"`).
125
125
  getRouteName(stateId): string | undefined;
126
126
  ```
127
127
 
128
- Defined in: [play-vue-router/src/vue-base-route-map.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/vue-base-route-map.ts#L48)
128
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-base-route-map.ts#L48)
129
129
 
130
130
  Get the Vue Router route name for a given state ID.
131
131
 
@@ -147,7 +147,7 @@ Get the Vue Router route name for a given state ID.
147
147
  getStateId(routeName): string | undefined;
148
148
  ```
149
149
 
150
- Defined in: [play-vue-router/src/vue-base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/vue-base-route-map.ts#L53)
150
+ Defined in: [play-vue-router/src/vue-base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-base-route-map.ts#L53)
151
151
 
152
152
  Get the state ID for a given Vue Router route name.
153
153
 
@@ -169,7 +169,7 @@ Get the state ID for a given Vue Router route name.
169
169
  getStateIdByPath(path): string | null;
170
170
  ```
171
171
 
172
- Defined in: [play-router/src/base-route-map.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-router/src/base-route-map.ts#L167)
172
+ Defined in: [play-router/src/base-route-map.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-router/src/base-route-map.ts#L167)
173
173
 
174
174
  Resolve a URL path to its mapped state ID.
175
175