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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (171) 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-react/README.md +21 -1
  19. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  20. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  21. package/api/@xmachines/play-react/functions/useSignalEffect.md +8 -1
  22. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  23. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  24. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -6
  25. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  26. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  27. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +34 -21
  28. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  29. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  30. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  31. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  32. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  33. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  34. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
  35. package/api/@xmachines/play-router/README.md +18 -1
  36. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  37. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +34 -21
  38. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  39. package/api/@xmachines/play-router/functions/connectRouter.md +1 -1
  40. package/api/@xmachines/play-router/functions/createBrowserHistory.md +6 -1
  41. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  42. package/api/@xmachines/play-router/functions/createRouter.md +1 -1
  43. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  44. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  45. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  46. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  47. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  48. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  49. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  50. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  51. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  52. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  53. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  54. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  55. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  56. package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
  57. package/api/@xmachines/play-router/interfaces/BrowserHistory.md +14 -14
  58. package/api/@xmachines/play-router/interfaces/BrowserWindow.md +14 -14
  59. package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +4 -4
  60. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  61. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  62. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +7 -7
  63. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  64. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  65. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  66. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  67. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  68. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  69. package/api/@xmachines/play-router/interfaces/RouterBridge.md +4 -4
  70. package/api/@xmachines/play-router/interfaces/VanillaRouter.md +4 -4
  71. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  72. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  73. package/api/@xmachines/play-signals/README.md +2 -2
  74. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  75. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  76. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  77. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  78. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  79. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  80. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  81. package/api/@xmachines/play-solid/README.md +21 -1
  82. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  83. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -6
  84. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  85. package/api/@xmachines/play-solid/variables/PlayRenderer.md +7 -1
  86. package/api/@xmachines/play-solid-router/README.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 +35 -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 +4 -4
  92. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  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 +4 -4
  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 +34 -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 +7 -7
  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 +4 -4
  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/README.md +1 -1
  114. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  115. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +35 -22
  116. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  117. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  118. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  119. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  120. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  121. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  122. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  123. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  124. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  125. package/api/@xmachines/play-vue/README.md +21 -1
  126. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  127. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  128. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  129. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  130. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  131. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  132. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  133. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  134. package/api/@xmachines/play-vue-router/README.md +1 -1
  135. package/api/@xmachines/play-vue-router/classes/RouteMap.md +7 -7
  136. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +7 -7
  137. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +35 -22
  138. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  139. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
  140. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  141. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  142. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  143. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  144. package/api/@xmachines/play-xstate/README.md +14 -2
  145. package/api/@xmachines/play-xstate/classes/PlayerActor.md +14 -14
  146. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  147. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  148. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  149. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  150. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  151. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  152. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  153. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  154. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  155. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  156. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  157. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  158. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  159. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  160. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  161. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  162. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  163. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  164. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  165. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  166. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  167. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
  168. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  169. package/api/{_media → rfc}/play.md +1 -1
  170. package/package.json +2 -2
  171. package/rfc/play.md +1 -1
@@ -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.20/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.22/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.20/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.22/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:210](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/base-route-map.ts#L210)
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)
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.20/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.22/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.20/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.22/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.20/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.22/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:175](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/base-route-map.ts#L175)
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)
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.20/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.22/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.20/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.22/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:210](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/base-route-map.ts#L210)
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)
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.20/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.22/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.20/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.22/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.20/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.22/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:175](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/base-route-map.ts#L175)
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)
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.20/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.22/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.20/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.22/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:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L97) |
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:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L85) |
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:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L84) |
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:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L87) |
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:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L86) |
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:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L98) |
64
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L100) |
65
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L99) |
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:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L88) |
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.22/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.22/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.22/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.22/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.22/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.22/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.22/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.22/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.22/packages/play-router/src/router-bridge-base.ts#L93) |
67
67
 
68
68
  ## Methods
69
69
 
@@ -73,13 +73,22 @@ onUnmounted(() => bridge.disconnect());
73
73
  connect(): void;
74
74
  ```
75
75
 
76
- Defined in: [play-router/src/router-bridge-base.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L116)
76
+ 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)
77
77
 
78
78
  Connect the router bridge to the Actor.
79
79
 
80
80
  Sets up the TC39 Signal watcher for actor → router direction and
81
81
  starts watching router changes (framework-specific).
82
82
 
83
+ Ordering here is part of the bridge contract:
84
+
85
+ - `lastSyncedPath` is seeded in the constructor from `actor.currentRoute`
86
+ - the actor watcher is installed before adapter router subscriptions
87
+ - initial sync then resolves deep-link vs restore using `actor.initialRoute`
88
+
89
+ Adapters that need custom initial-sync behavior should override
90
+ `getInitialRouterPath()` rather than reordering `connect()` steps.
91
+
83
92
  #### Returns
84
93
 
85
94
  `void`
@@ -96,7 +105,7 @@ starts watching router changes (framework-specific).
96
105
  disconnect(): void;
97
106
  ```
98
107
 
99
- Defined in: [play-router/src/router-bridge-base.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L184)
108
+ 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)
100
109
 
101
110
  Disconnect the router bridge from the Actor.
102
111
 
@@ -118,7 +127,7 @@ Stops signal watching and unregisters framework-specific router listener.
118
127
  dispose(): void;
119
128
  ```
120
129
 
121
- Defined in: [play-vue-router/src/vue-router-bridge.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-vue-router/src/vue-router-bridge.ts#L277)
130
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/vue-router-bridge.ts#L280)
122
131
 
123
132
  Cleanup alias for component lifecycle integration.
124
133
 
@@ -140,7 +149,7 @@ onUnmounted(() => bridge.dispose());
140
149
  protected extractParams(pathname, stateId): Record<string, string>;
141
150
  ```
142
151
 
143
- Defined in: [play-router/src/router-bridge-base.ts:283](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L283)
152
+ 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)
144
153
 
145
154
  Extract path parameters from URL using the URLPattern API.
146
155
 
@@ -174,7 +183,7 @@ Extracted path parameters, or empty object if URLPattern is unavailable or no ma
174
183
  protected extractQuery(search): Record<string, string>;
175
184
  ```
176
185
 
177
- Defined in: [play-router/src/router-bridge-base.ts:310](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L310)
186
+ 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)
178
187
 
179
188
  Extract query parameters from URL search string.
180
189
 
@@ -202,7 +211,7 @@ Extracted query parameters or empty object
202
211
  protected getInitialRouterPath(): string | null;
203
212
  ```
204
213
 
205
- Defined in: [play-vue-router/src/vue-router-bridge.ts:265](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-vue-router/src/vue-router-bridge.ts#L265)
214
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:268](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/vue-router-bridge.ts#L268)
206
215
 
207
216
  Return the current Vue Router URL for initial sync.
208
217
 
@@ -227,7 +236,7 @@ bridge pushes actor's route to the router).
227
236
  protected navigateRouter(path): void;
228
237
  ```
229
238
 
230
- Defined in: [play-vue-router/src/vue-router-bridge.ts:155](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/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.22/packages/play-vue-router/src/vue-router-bridge.ts#L155)
231
240
 
232
241
  Navigate Vue Router to the given path/stateId.
233
242
 
@@ -257,7 +266,7 @@ Navigation errors are thrown as [VueRouterNavigationError](#).
257
266
  protected syncActorFromRouter(pathname, search?): void;
258
267
  ```
259
268
 
260
- Defined in: [play-router/src/router-bridge-base.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L231)
269
+ 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)
261
270
 
262
271
  Sync actor state when router location changes.
263
272
 
@@ -287,13 +296,17 @@ Prevents circular updates via isProcessingNavigation flag.
287
296
  protected syncRouterFromActor(route): void;
288
297
  ```
289
298
 
290
- Defined in: [play-router/src/router-bridge-base.ts:211](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-router/src/router-bridge-base.ts#L211)
299
+ 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)
291
300
 
292
301
  Sync router location when actor route signal changes.
293
302
 
294
303
  Calls navigateRouter() for framework-specific navigation.
295
304
  Prevents circular updates via isProcessingNavigation flag.
296
305
 
306
+ `lastSyncedPath` is updated before `navigateRouter()` and the processing flag is
307
+ released in a microtask so synchronous router callbacks triggered by navigation are
308
+ suppressed as circular echoes.
309
+
297
310
  #### Parameters
298
311
 
299
312
  | Parameter | Type |
@@ -316,7 +329,7 @@ Prevents circular updates via isProcessingNavigation flag.
316
329
  protected unwatchRouterChanges(): void;
317
330
  ```
318
331
 
319
- Defined in: [play-vue-router/src/vue-router-bridge.ts:252](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-vue-router/src/vue-router-bridge.ts#L252)
332
+ Defined in: [play-vue-router/src/vue-router-bridge.ts:255](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/vue-router-bridge.ts#L255)
320
333
 
321
334
  Unsubscribe from Vue Router afterEach guard.
322
335
 
@@ -336,7 +349,7 @@ Unsubscribe from Vue Router afterEach guard.
336
349
  protected watchRouterChanges(): void;
337
350
  ```
338
351
 
339
- Defined in: [play-vue-router/src/vue-router-bridge.ts:186](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/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.22/packages/play-vue-router/src/vue-router-bridge.ts#L186)
340
353
 
341
354
  Start watching for router location changes.
342
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.20/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.22/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.20/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.22/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](../../../_media/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.20/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.20/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.20/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.20/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.20/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.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) |
@@ -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.20/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.22/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.20/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.20/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.20/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.22/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.22/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.22/packages/play-vue-router/src/types.ts#L12) |
@@ -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.20/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.22/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](../../../_media/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.20/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.22/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.20/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.22/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-vue-router/src/play-router-provider.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-vue-router/src/play-router-provider.ts#L10)
9
+ Defined in: [play-vue-router/src/play-router-provider.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/play-router-provider.ts#L10)
10
10
 
11
11
  Minimum actor shape accepted by PlayRouterProvider.
@@ -64,7 +64,7 @@ const PlayRouterProvider: DefineComponent<
64
64
  >;
65
65
  ```
66
66
 
67
- Defined in: [play-vue-router/src/play-router-provider.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.20/packages/play-vue-router/src/play-router-provider.ts#L19)
67
+ Defined in: [play-vue-router/src/play-router-provider.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.22/packages/play-vue-router/src/play-router-provider.ts#L19)
68
68
 
69
69
  PlayRouterProvider — Vue convenience wrapper for VueRouterBridge.
70
70
 
@@ -10,7 +10,7 @@ Transform declarative state machines into live actors with TC39 Signals and para
10
10
 
11
11
  `@xmachines/play-xstate` provides `definePlayer()`, the primary API for binding XState v5 state machines to the Play Architecture actor base. It enables business logic to control routing and state through guard-enforced transitions, signal lifecycle management, and XState DevTools compatibility.
12
12
 
13
- Per [Play RFC](../../_media/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 guards decide navigation validity
16
16
  - **Strict Separation (INV-02):** Zero React/framework imports in business logic
@@ -169,6 +169,10 @@ const restoredActor = createPlayer(undefined, { snapshot });
169
169
  restoredActor.start();
170
170
  ```
171
171
 
172
+ `restoredActor.initialRoute` still reflects the machine's default initial route, not the
173
+ restored snapshot route. Router bridges rely on that invariant to distinguish a deep-link
174
+ from a restored session during `connect()`.
175
+
172
176
  ### PlayerActor
173
177
 
174
178
  Concrete actor implementing Play signal protocol:
@@ -179,6 +183,14 @@ Concrete actor implementing Play signal protocol:
179
183
  - `currentRoute: Signal.Computed<string | null>` — Derived URL from the current state's `meta.route` and `context.routeParams`. Returns `null` when no route metadata is present or a required route parameter is missing from context.
180
184
  - `currentView: Signal.State<ViewMetadata | null>` — Current view spec (updated on every state transition). The spec is automatically enriched with `context.routeParams` (URL params) and any `contextProps`-allowlisted context fields before being emitted (see [Prop Enrichment from Routing and Context](#prop-enrichment-from-routing-and-context)).
181
185
 
186
+ **Lifecycle ordering:**
187
+
188
+ - `state` and `currentRoute` update synchronously from the active XState snapshot.
189
+ - `currentView` is then validated and cached from that same snapshot.
190
+ - `onStateChange` runs after those signals are current.
191
+ - `onTransition` runs after `send()` completes, with both previous and next snapshots.
192
+ - `onStart` runs after the initial active snapshot has been published.
193
+
182
194
  **Methods:**
183
195
 
184
196
  - `start()` — Start the actor (must call after creation)
@@ -256,7 +268,7 @@ const machine = setup({
256
268
 
257
269
  - `hasContext(path: string)` - Check if context property is truthy
258
270
  - `eventMatches(type: string)` - Check event type
259
- - `contextFieldMatches(fieldPath: string, expectedValue: unknown)` - Check context field with proper equality (no substring false-matches; use this instead of the removed `stateMatches`)
271
+ - `contextFieldMatches(fieldPath: string, expectedValue: unknown)` - Check context field with strict structural equality
260
272
  - `composeGuards(guards: Array)` - AND composition
261
273
  - `composeGuardsOr(guards: Array)` - OR composition
262
274
  - `negateGuard(guard)` - NOT composition