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

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 (206) hide show
  1. package/api/@xmachines/play/README.md +1 -1
  2. package/api/@xmachines/play/classes/PlayError.md +4 -4
  3. package/api/@xmachines/play/type-aliases/PlayEvent.md +3 -3
  4. package/api/@xmachines/play-actor/README.md +2 -2
  5. package/api/@xmachines/play-actor/classes/AbstractActor.md +4 -4
  6. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  7. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  8. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  9. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  10. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  11. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  12. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  13. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  14. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  15. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  16. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  17. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  18. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  19. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  20. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  21. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  22. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  23. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  24. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  25. package/api/@xmachines/play-react/README.md +1 -1
  26. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  27. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  28. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  29. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  30. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  31. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -7
  32. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  33. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  34. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +21 -21
  35. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  36. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  37. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  38. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  39. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  40. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  41. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
  42. package/api/@xmachines/play-router/README.md +1 -1
  43. package/api/@xmachines/play-router/classes/BaseRouteMap.md +6 -4
  44. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +21 -21
  45. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  46. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  47. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  48. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  49. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  50. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  51. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  52. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  53. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  54. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  55. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  56. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  57. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  58. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  59. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  60. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  61. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  62. package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
  63. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  64. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  65. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  66. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +7 -7
  67. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  68. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  69. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  70. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  71. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  72. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  73. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +6 -6
  74. package/api/@xmachines/play-router/interfaces/RouterBridge.md +4 -4
  75. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  76. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  77. package/api/@xmachines/play-signals/README.md +2 -2
  78. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  79. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  80. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  81. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  82. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  83. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  84. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  85. package/api/@xmachines/play-solid/README.md +1 -1
  86. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  87. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -7
  88. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  89. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  90. package/api/@xmachines/play-solid-router/README.md +1 -1
  91. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  92. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +22 -22
  93. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  94. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  95. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +4 -4
  96. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  97. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  98. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  99. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +4 -4
  100. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  101. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  102. package/api/@xmachines/play-svelte/README.md +91 -0
  103. package/api/@xmachines/play-svelte/functions/defineRegistry.md +52 -0
  104. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +27 -0
  105. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +27 -0
  106. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +22 -0
  107. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +16 -0
  108. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +7 -0
  109. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +7 -0
  110. package/api/@xmachines/play-svelte/variables/getBoundProp.md +7 -0
  111. package/api/@xmachines/play-svelte-spa-router/README.md +53 -0
  112. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +150 -0
  113. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +19 -0
  114. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +19 -0
  115. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +16 -0
  116. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +119 -0
  117. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +12 -0
  118. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +104 -0
  119. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +9 -0
  120. package/api/@xmachines/play-svelte-spa-router-demo/README.md +23 -0
  121. package/api/@xmachines/play-sveltekit-router/README.md +53 -0
  122. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +115 -0
  123. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +19 -0
  124. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +19 -0
  125. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +12 -0
  126. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +119 -0
  127. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +12 -0
  128. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +104 -0
  129. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +9 -0
  130. package/api/@xmachines/play-sveltekit-router-demo/README.md +23 -0
  131. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  132. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +21 -21
  133. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  134. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  135. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  136. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  137. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  138. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  139. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  140. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  141. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  142. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  143. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +4 -4
  144. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  145. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  146. package/api/@xmachines/play-tanstack-solid-router/README.md +1 -1
  147. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  148. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +22 -22
  149. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  150. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  151. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  152. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  153. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  154. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  155. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  156. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  157. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  158. package/api/@xmachines/play-vue/README.md +1 -1
  159. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  160. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  161. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  162. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  163. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  164. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  165. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  166. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  167. package/api/@xmachines/play-vue-router/README.md +1 -1
  168. package/api/@xmachines/play-vue-router/classes/RouteMap.md +7 -7
  169. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +7 -7
  170. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +22 -22
  171. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  172. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
  173. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  174. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  175. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  176. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  177. package/api/@xmachines/play-xstate/README.md +1 -1
  178. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  179. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  180. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  181. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  182. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  183. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  184. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  185. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  186. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  187. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  188. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  189. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  190. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  191. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  192. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  193. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  194. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  195. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  196. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  197. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  198. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  199. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  200. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
  201. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  202. package/api/README.md +5 -0
  203. package/api/llms.txt +3 -0
  204. package/examples/multi-router-integration.md +34 -6
  205. package/package.json +2 -2
  206. package/api/rfc/play.md +0 -447
@@ -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.23/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.25/packages/play-router/src/types.ts#L264)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -44,7 +44,7 @@ class TanStackRouterBridge implements RouterBridge {
44
44
 
45
45
  ## See
46
46
 
47
- [Play RFC](../../../rfc/play.md) - Invariant INV-04
47
+ [Play RFC](../../../../rfc/play.md) - Invariant INV-04
48
48
 
49
49
  ## Methods
50
50
 
@@ -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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/packages/play-tanstack-solid-router/src/solid-router-bridge.ts#L28)
68
68
 
69
69
  #### Parameters
70
70
 
@@ -15,7 +15,7 @@ Bridges TC39 Signal-driven actors to Vue's reactivity. Business logic stays in t
15
15
  - Routes action names from spec elements to `actor.send()` via the `actions` prop
16
16
  - Manages per-view UI state in an `@xstate/store` atom (automatic or caller-supplied)
17
17
 
18
- Per [Play RFC](../../rfc/play.md):
18
+ Per [Play RFC](../../../rfc/play.md):
19
19
 
20
20
  - **Actor Authority (INV-01):** Guards in the machine decide all state transitions
21
21
  - **Passive Infrastructure (INV-04):** Vue observes signals and dispatches events — never decides
@@ -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.23/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.25/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.23/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.25/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.23/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.25/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.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) |
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.25/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.25/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.25/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/packages/play-vue/src/vue-shim.d.ts#L3)
@@ -10,7 +10,7 @@ Bidirectional sync between Vue Router and XMachines state machines with Composit
10
10
 
11
11
  `@xmachines/play-vue-router` enables Vue.js applications to use XMachines state machines as the source of truth for routing logic. Your state machine controls navigation through Vue Router's reactive primitives.
12
12
 
13
- Per [Play RFC](../../rfc/play.md), this package implements:
13
+ Per [Play RFC](../../../rfc/play.md), this package implements:
14
14
 
15
15
  - **Actor Authority (INV-01):** State machine validates navigation, router reflects decisions
16
16
  - **Passive Infrastructure (INV-04):** Router observes `actor.currentRoute` signal
@@ -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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/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.23/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.25/packages/play-router/src/base-route-map.ts#L167)
173
173
 
174
174
  Resolve a URL path to its mapped state ID.
175
175
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: VueRouterBridge
4
4
 
5
- Defined in: [play-vue-router/src/vue-router-bridge.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-router-bridge.ts#L47)
5
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-vue-router/src/vue-router-bridge.ts#L47)
6
6
 
7
7
  @xmachines/play-vue-router - Vue Router 4.x adapter for XMachines Play
8
8
 
@@ -23,7 +23,7 @@ new VueRouterBridge(
23
23
  vueRouteMap): VueRouterBridge;
24
24
  ```
25
25
 
26
- Defined in: [play-vue-router/src/vue-router-bridge.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-router-bridge.ts#L137)
26
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:137](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-vue-router/src/vue-router-bridge.ts#L137)
27
27
 
28
28
  Create a Vue Router bridge
29
29
 
@@ -55,15 +55,15 @@ onUnmounted(() => bridge.disconnect());
55
55
 
56
56
  | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
57
57
  | --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
58
- | <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) |
59
- | <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) |
60
- | <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) |
61
- | <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) |
62
- | <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) |
63
- | <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) |
64
- | `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) |
65
- | `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) |
66
- | <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) |
58
+ | <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.25/packages/play-router/src/router-bridge-base.ts#L102) |
59
+ | <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.25/packages/play-router/src/router-bridge-base.ts#L90) |
60
+ | <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.25/packages/play-router/src/router-bridge-base.ts#L89) |
61
+ | <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.25/packages/play-router/src/router-bridge-base.ts#L92) |
62
+ | <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.25/packages/play-router/src/router-bridge-base.ts#L91) |
63
+ | <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.25/packages/play-router/src/router-bridge-base.ts#L103) |
64
+ | `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.25/packages/play-router/src/router-bridge-base.ts#L105) |
65
+ | `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.25/packages/play-router/src/router-bridge-base.ts#L104) |
66
+ | <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.25/packages/play-router/src/router-bridge-base.ts#L93) |
67
67
 
68
68
  ## Methods
69
69
 
@@ -73,7 +73,7 @@ onUnmounted(() => bridge.disconnect());
73
73
  connect(): void;
74
74
  ```
75
75
 
76
- 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)
76
+ Defined in: [play-router/src/router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L129)
77
77
 
78
78
  Connect the router bridge to the Actor.
79
79
 
@@ -105,7 +105,7 @@ Adapters that need custom initial-sync behavior should override
105
105
  disconnect(): void;
106
106
  ```
107
107
 
108
- 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)
108
+ Defined in: [play-router/src/router-bridge-base.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L197)
109
109
 
110
110
  Disconnect the router bridge from the Actor.
111
111
 
@@ -127,7 +127,7 @@ Stops signal watching and unregisters framework-specific router listener.
127
127
  dispose(): void;
128
128
  ```
129
129
 
130
- Defined in: [play-vue-router/src/vue-router-bridge.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-router-bridge.ts#L280)
130
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-vue-router/src/vue-router-bridge.ts#L280)
131
131
 
132
132
  Cleanup alias for component lifecycle integration.
133
133
 
@@ -149,7 +149,7 @@ onUnmounted(() => bridge.dispose());
149
149
  protected extractParams(pathname, stateId): Record<string, string>;
150
150
  ```
151
151
 
152
- 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)
152
+ Defined in: [play-router/src/router-bridge-base.ts:300](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L300)
153
153
 
154
154
  Extract path parameters from URL using the URLPattern API.
155
155
 
@@ -183,7 +183,7 @@ Extracted path parameters, or empty object if URLPattern is unavailable or no ma
183
183
  protected extractQuery(search): Record<string, string>;
184
184
  ```
185
185
 
186
- 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)
186
+ Defined in: [play-router/src/router-bridge-base.ts:321](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L321)
187
187
 
188
188
  Extract query parameters from URL search string.
189
189
 
@@ -211,7 +211,7 @@ Extracted query parameters or empty object
211
211
  protected getInitialRouterPath(): string | null;
212
212
  ```
213
213
 
214
- Defined in: [play-vue-router/src/vue-router-bridge.ts:268](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-router-bridge.ts#L268)
214
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:268](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-vue-router/src/vue-router-bridge.ts#L268)
215
215
 
216
216
  Return the current Vue Router URL for initial sync.
217
217
 
@@ -236,7 +236,7 @@ bridge pushes actor's route to the router).
236
236
  protected navigateRouter(path): void;
237
237
  ```
238
238
 
239
- Defined in: [play-vue-router/src/vue-router-bridge.ts:155](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-router-bridge.ts#L155)
239
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:155](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-vue-router/src/vue-router-bridge.ts#L155)
240
240
 
241
241
  Navigate Vue Router to the given path/stateId.
242
242
 
@@ -266,7 +266,7 @@ Navigation errors are thrown as [VueRouterNavigationError](#).
266
266
  protected syncActorFromRouter(pathname, search?): void;
267
267
  ```
268
268
 
269
- 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)
269
+ Defined in: [play-router/src/router-bridge-base.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L248)
270
270
 
271
271
  Sync actor state when router location changes.
272
272
 
@@ -296,7 +296,7 @@ Prevents circular updates via isProcessingNavigation flag.
296
296
  protected syncRouterFromActor(route): void;
297
297
  ```
298
298
 
299
- 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)
299
+ Defined in: [play-router/src/router-bridge-base.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L228)
300
300
 
301
301
  Sync router location when actor route signal changes.
302
302
 
@@ -329,7 +329,7 @@ suppressed as circular echoes.
329
329
  protected unwatchRouterChanges(): void;
330
330
  ```
331
331
 
332
- Defined in: [play-vue-router/src/vue-router-bridge.ts:255](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-router-bridge.ts#L255)
332
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:255](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-vue-router/src/vue-router-bridge.ts#L255)
333
333
 
334
334
  Unsubscribe from Vue Router afterEach guard.
335
335
 
@@ -349,7 +349,7 @@ Unsubscribe from Vue Router afterEach guard.
349
349
  protected watchRouterChanges(): void;
350
350
  ```
351
351
 
352
- Defined in: [play-vue-router/src/vue-router-bridge.ts:186](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/vue-router-bridge.ts#L186)
352
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:186](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-vue-router/src/vue-router-bridge.ts#L186)
353
353
 
354
354
  Start watching for router location changes.
355
355
 
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-vue-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/create-route-map.ts#L9)
9
+ Defined in: [play-vue-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-vue-router/src/create-route-map.ts#L9)
10
10
 
11
11
  ## Parameters
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.23/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.25/packages/play-router/src/types.ts#L216)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -94,7 +94,7 @@ actor.send(event);
94
94
 
95
95
  ## See
96
96
 
97
- [Play RFC](../../../rfc/play.md)
97
+ [Play RFC](../../../../rfc/play.md)
98
98
 
99
99
  ## Remarks
100
100
 
@@ -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.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) |
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.25/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.25/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.25/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.25/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.25/packages/play-router/src/types.ts#L217) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-vue-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/types.ts#L10)
5
+ Defined in: [play-vue-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-vue-router/src/types.ts#L10)
6
6
 
7
7
  Mapping configuration between XMachines state IDs and Vue Router route names
8
8
 
@@ -10,6 +10,6 @@ Mapping configuration between XMachines state IDs and Vue Router route names
10
10
 
11
11
  | Property | Modifier | Type | Description | Defined in |
12
12
  | ------------------------------------------- | ---------- | -------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-pattern"></a> `pattern?` | `readonly` | `string` | Optional URL pattern for debugging | [play-vue-router/src/types.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/types.ts#L16) |
14
- | <a id="property-routename"></a> `routeName` | `readonly` | `string` | Vue Router route name | [play-vue-router/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/types.ts#L14) |
15
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID (e.g., '#home', '#profile') | [play-vue-router/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.23/packages/play-vue-router/src/types.ts#L12) |
13
+ | <a id="property-pattern"></a> `pattern?` | `readonly` | `string` | Optional URL pattern for debugging | [play-vue-router/src/types.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-vue-router/src/types.ts#L16) |
14
+ | <a id="property-routename"></a> `routeName` | `readonly` | `string` | Vue Router route name | [play-vue-router/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-vue-router/src/types.ts#L14) |
15
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID (e.g., '#home', '#profile') | [play-vue-router/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-vue-router/src/types.ts#L12) |