@xmachines/docs 1.0.0-beta.18 → 1.0.0-beta.19

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 (179) 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 +7 -2
  19. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +9 -5
  20. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  21. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -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 +6 -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 +23 -23
  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 +9 -9
  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 +103 -47
  36. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  37. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +21 -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 +1 -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 +6 -42
  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 +38 -0
  50. package/api/@xmachines/play-router/functions/isRouteReachable.md +38 -0
  51. package/api/@xmachines/play-router/functions/machineToGraph.md +19 -0
  52. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  53. package/api/@xmachines/play-router/functions/sanitizePathname.md +40 -0
  54. package/api/@xmachines/play-router/functions/validateRouteFormat.md +9 -8
  55. package/api/@xmachines/play-router/functions/validateStateExists.md +8 -8
  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 +15 -0
  61. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +17 -0
  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 +12 -12
  66. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  67. package/api/@xmachines/play-router/interfaces/RouteTree.md +7 -6
  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 +20 -0
  72. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  73. package/api/@xmachines/play-signals/README.md +8 -2
  74. package/api/@xmachines/play-signals/functions/watchSignal.md +8 -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 +1 -1
  82. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  83. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +6 -6
  84. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  85. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -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 +24 -24
  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 +16 -16
  92. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +9 -9
  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/README.md +1 -4
  99. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  100. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +23 -23
  101. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  102. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  103. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  104. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +28 -0
  105. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  106. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  107. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +9 -9
  108. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  109. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  110. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  111. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +4 -4
  112. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  113. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  114. package/api/@xmachines/play-tanstack-solid-router/README.md +1 -1
  115. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  116. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +26 -25
  117. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  118. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  119. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +9 -9
  120. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  121. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  122. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  123. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  124. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  125. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  126. package/api/@xmachines/play-vue/README.md +1 -1
  127. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  128. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  129. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  130. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  131. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  132. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  133. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  134. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  135. package/api/@xmachines/play-vue-router/README.md +2 -1
  136. package/api/@xmachines/play-vue-router/classes/RouteMap.md +7 -7
  137. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +7 -7
  138. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +27 -32
  139. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  140. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +9 -9
  141. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  142. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  143. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  144. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  145. package/api/@xmachines/play-xstate/README.md +6 -6
  146. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  147. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  148. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  149. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  150. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +36 -0
  151. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  152. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  153. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  154. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  155. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  156. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  157. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  158. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  159. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  160. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  161. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  162. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  163. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  164. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  165. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  166. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  167. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  168. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
  169. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  170. package/api/_media/play.md +447 -0
  171. package/examples/multi-router-integration.md +1 -1
  172. package/examples/routing-patterns.md +1 -1
  173. package/guides/installation.md +30 -30
  174. package/package.json +2 -2
  175. package/api/@xmachines/play-router/functions/crawlMachine.md +0 -92
  176. package/api/@xmachines/play-router/functions/extractRoute.md +0 -45
  177. package/api/@xmachines/play-router/interfaces/StateVisit.md +0 -15
  178. package/api/@xmachines/play-tanstack-react-router/variables/extractMachineRoutes.md +0 -64
  179. package/api/@xmachines/play-xstate/functions/stateMatches.md +0 -25
package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: SolidRouterBridge
4
4
 
5
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/solid-router-bridge.ts#L47)
5
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/solid-router-bridge.ts#L47)
6
6
 
7
7
  SolidJS Router integration bridge extending RouterBridgeBase
8
8
 
@@ -27,7 +27,7 @@ new SolidRouterBridge(
27
27
  routeMap): SolidRouterBridge;
28
28
  ```
29
29
 
30
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/solid-router-bridge.ts#L61)
30
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/solid-router-bridge.ts#L61)
31
31
 
32
32
  Create a SolidJS Router bridge
33
33
 
@@ -55,17 +55,17 @@ Create a SolidJS Router bridge
55
55
 
56
56
  ## Properties
57
57
 
58
- | Property | Modifier | Type | Description | Inherited from | Defined in |
59
- | --------------------------------------------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
60
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../interfaces/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | packages/play-router/dist/router-bridge-base.d.ts:73 |
61
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | packages/play-router/dist/router-bridge-base.d.ts:79 |
62
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | packages/play-router/dist/router-bridge-base.d.ts:78 |
63
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | packages/play-router/dist/router-bridge-base.d.ts:81 |
64
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | packages/play-router/dist/router-bridge-base.d.ts:80 |
65
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | 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) | packages/play-router/dist/router-bridge-base.d.ts:74 |
66
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | - | - | packages/play-router/dist/router-bridge-base.d.ts:76 |
67
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | - | - | packages/play-router/dist/router-bridge-base.d.ts:75 |
68
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | packages/play-router/dist/router-bridge-base.d.ts:82 |
58
+ | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
59
+ | --------------------------------------------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
60
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../interfaces/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) | [packages/play-router/src/router-bridge-base.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L97) |
61
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [packages/play-router/src/router-bridge-base.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L85) |
62
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [packages/play-router/src/router-bridge-base.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L84) |
63
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [packages/play-router/src/router-bridge-base.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L87) |
64
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [packages/play-router/src/router-bridge-base.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L86) |
65
+ | <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) | [packages/play-router/src/router-bridge-base.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L98) |
66
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L100) |
67
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L99) |
68
+ | <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) | [packages/play-router/src/router-bridge-base.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L88) |
69
69
 
70
70
  ## Methods
71
71
 
@@ -75,7 +75,7 @@ Create a SolidJS Router bridge
75
75
  connect(): void;
76
76
  ```
77
77
 
78
- Defined in: packages/play-router/dist/router-bridge-base.d.ts:99
78
+ Defined in: [packages/play-router/src/router-bridge-base.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L116)
79
79
 
80
80
  Connect the router bridge to the Actor.
81
81
 
@@ -98,7 +98,7 @@ starts watching router changes (framework-specific).
98
98
  disconnect(): void;
99
99
  ```
100
100
 
101
- Defined in: packages/play-router/dist/router-bridge-base.d.ts:105
101
+ Defined in: [packages/play-router/src/router-bridge-base.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L184)
102
102
 
103
103
  Disconnect the router bridge from the Actor.
104
104
 
@@ -120,7 +120,7 @@ Stops signal watching and unregisters framework-specific router listener.
120
120
  dispose(): void;
121
121
  ```
122
122
 
123
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/solid-router-bridge.ts#L127)
123
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/solid-router-bridge.ts#L127)
124
124
 
125
125
  Dispose the bridge (alias for disconnect).
126
126
 
@@ -142,7 +142,7 @@ onCleanup(() => bridge.dispose());
142
142
  protected extractParams(pathname, stateId): Record<string, string>;
143
143
  ```
144
144
 
145
- Defined in: packages/play-router/dist/router-bridge-base.d.ts:132
145
+ Defined in: [packages/play-router/src/router-bridge-base.ts:283](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L283)
146
146
 
147
147
  Extract path parameters from URL using the URLPattern API.
148
148
 
@@ -176,7 +176,7 @@ Extracted path parameters, or empty object if URLPattern is unavailable or no ma
176
176
  protected extractQuery(search): Record<string, string>;
177
177
  ```
178
178
 
179
- Defined in: packages/play-router/dist/router-bridge-base.d.ts:139
179
+ Defined in: [packages/play-router/src/router-bridge-base.ts:310](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L310)
180
180
 
181
181
  Extract query parameters from URL search string.
182
182
 
@@ -204,7 +204,7 @@ Extracted query parameters or empty object
204
204
  protected getInitialRouterPath(): string | null;
205
205
  ```
206
206
 
207
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/solid-router-bridge.ts#L84)
207
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/solid-router-bridge.ts#L84)
208
208
 
209
209
  Get the current router pathname for initial URL -> actor sync on connect.
210
210
 
@@ -224,7 +224,7 @@ Get the current router pathname for initial URL -> actor sync on connect.
224
224
  protected navigateRouter(path): void;
225
225
  ```
226
226
 
227
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/solid-router-bridge.ts#L77)
227
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/solid-router-bridge.ts#L77)
228
228
 
229
229
  Navigate SolidJS Router to the given path.
230
230
 
@@ -250,7 +250,7 @@ Navigate SolidJS Router to the given path.
250
250
  protected syncActorFromRouter(pathname, search?): void;
251
251
  ```
252
252
 
253
- Defined in: packages/play-router/dist/router-bridge-base.d.ts:119
253
+ Defined in: [packages/play-router/src/router-bridge-base.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L231)
254
254
 
255
255
  Sync actor state when router location changes.
256
256
 
@@ -280,7 +280,7 @@ Prevents circular updates via isProcessingNavigation flag.
280
280
  protected syncRouterFromActor(route): void;
281
281
  ```
282
282
 
283
- Defined in: packages/play-router/dist/router-bridge-base.d.ts:112
283
+ Defined in: [packages/play-router/src/router-bridge-base.ts:211](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L211)
284
284
 
285
285
  Sync router location when actor route signal changes.
286
286
 
@@ -309,7 +309,7 @@ Prevents circular updates via isProcessingNavigation flag.
309
309
  protected unwatchRouterChanges(): void;
310
310
  ```
311
311
 
312
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/solid-router-bridge.ts#L114)
312
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/solid-router-bridge.ts#L114)
313
313
 
314
314
  Stop watching SolidJS Router changes.
315
315
 
@@ -331,7 +331,7 @@ Solid auto-cleans createEffect subscriptions when component unmounts.
331
331
  protected watchRouterChanges(): void;
332
332
  ```
333
333
 
334
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/solid-router-bridge.ts#L94)
334
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/solid-router-bridge.ts#L94)
335
335
 
336
336
  Subscribe to SolidJS Router location changes using createEffect.
337
337
 
package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function PlayRouterProvider<TActor>(props): any;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/play-router-provider.tsx#L24)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/play-router-provider.tsx#L24)
10
10
 
11
11
  ## Type Parameters
12
12
 
package/api/@xmachines/play-solid-router/functions/createRouteMap.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/create-route-map.ts#L27)
9
+ Defined in: [packages/play-solid-router/src/create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/create-route-map.ts#L27)
10
10
 
11
11
  Create a RouteMap from an XState machine
12
12
 
package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Interface: AbstractActor\<TLogic, TEvent\>
4
4
 
5
- Defined in: packages/play-actor/dist/abstract-actor.d.ts:225
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-actor/src/abstract-actor.ts#L231)
6
6
 
7
7
  Abstract base class for Play Architecture actors.
8
8
 
@@ -56,7 +56,7 @@ class PlayerActor extends AbstractActor<AnyActorLogic, EventFromLogic<TMachine>>
56
56
 
57
57
  ## See
58
58
 
59
- - [RFC Play v1 Section 5.3](https://gitlab.com/xmachin-es/rfc/-/blob/main/src/play-v1.md#53-actor-protocol)
59
+ - [Play RFC](../../../_media/play.md)
60
60
  - [Routable](../../play-actor/interfaces/Routable.md) for routing capability
61
61
  - [Viewable](../../play-actor/interfaces/Viewable.md) for view rendering capability
62
62
 
@@ -73,19 +73,19 @@ class PlayerActor extends AbstractActor<AnyActorLogic, EventFromLogic<TMachine>>
73
73
 
74
74
  ## Properties
75
75
 
76
- | Property | Modifier | Type | Description | Inherited from | Defined in |
77
- | ------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ------------------------------------------------ |
78
- | <a id="property-_parent"></a> `_parent?` | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef) | - | `Actor._parent` | - |
79
- | <a id="property-clock"></a> `clock` | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock) | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions. | `Actor.clock` | - |
80
- | <a id="property-id"></a> `id` | `public` | `string` | The unique identifier for this actor relative to its parent. | `Actor.id` | - |
81
- | <a id="property-logic"></a> `logic` | `public` | `TLogic` | - | `Actor.logic` | - |
82
- | <a id="property-options"></a> `options` | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\> | - | `Actor.options` | - |
83
- | <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | - | `Actor.ref` | - |
84
- | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
85
- | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | - |
86
- | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Typed as `Signal.State<unknown>` at the abstract level; concrete implementations narrow this to the actual snapshot type (e.g., `Signal.State<AnyMachineSnapshot>` in `@xmachines/play-xstate`'s `PlayerActor`). Infrastructure observes this signal to react to state changes without directly coupling to the Actor's internal state machine implementation. **Example** `// Infrastructure observes state signal const watcher = new Signal.subtle.Watcher(() => { console.log('Actor state changed:', actor.state.get()); }); watcher.watch(actor.state);` | - | packages/play-actor/dist/abstract-actor.d.ts:245 |
87
- | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | - |
88
- | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
76
+ | Property | Modifier | Type | Description | Inherited from | Defined in |
77
+ | ------------------------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
78
+ | <a id="property-_parent"></a> `_parent?` | `public` | [`AnyActorRef`](https://www.jsdocs.io/package/xstate#AnyActorRef) | - | `Actor._parent` | - |
79
+ | <a id="property-clock"></a> `clock` | `public` | [`Clock`](https://www.jsdocs.io/package/xstate#Clock) | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions. | `Actor.clock` | - |
80
+ | <a id="property-id"></a> `id` | `public` | `string` | The unique identifier for this actor relative to its parent. | `Actor.id` | - |
81
+ | <a id="property-logic"></a> `logic` | `public` | `TLogic` | - | `Actor.logic` | - |
82
+ | <a id="property-options"></a> `options` | `public` | `Readonly`\<[`ActorOptions`](https://www.jsdocs.io/package/xstate#ActorOptions)\<`TLogic`\>\> | - | `Actor.options` | - |
83
+ | <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | - | `Actor.ref` | - |
84
+ | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
85
+ | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | - |
86
+ | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Typed as `Signal.State<unknown>` at the abstract level; concrete implementations narrow this to the actual snapshot type (e.g., `Signal.State<AnyMachineSnapshot>` in `@xmachines/play-xstate`'s `PlayerActor`). Infrastructure observes this signal to react to state changes without directly coupling to the Actor's internal state machine implementation. **Example** `// Infrastructure observes state signal const watcher = new Signal.subtle.Watcher(() => { console.log('Actor state changed:', actor.state.get()); }); watcher.watch(actor.state);` | - | [packages/play-actor/src/abstract-actor.ts:254](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-actor/src/abstract-actor.ts#L254) |
87
+ | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | - |
88
+ | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
89
89
 
90
90
  ## Methods
91
91
 
@@ -244,7 +244,7 @@ Actor.select;
244
244
  abstract send(event): void;
245
245
  ```
246
246
 
247
- Defined in: packages/play-actor/dist/abstract-actor.d.ts:268
247
+ Defined in: [packages/play-actor/src/abstract-actor.ts:278](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-actor/src/abstract-actor.ts#L278)
248
248
 
249
249
  Send event to Actor
250
250
 
package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: packages/play-router/dist/types.d.ts:182
5
+ Defined in: [packages/play-router/src/types.ts:216](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/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
- [RFC Play v1](https://gitlab.com/xmachin-es/rfc/-/blob/main/src/play-v1.md)
97
+ [Play RFC](../../../_media/play.md)
98
98
 
99
99
  ## Remarks
100
100
 
@@ -110,10 +110,10 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
110
110
 
111
111
  ## Properties
112
112
 
113
- | Property | Modifier | Type | Defined in |
114
- | -------------------------------------- | ---------- | ------------------------------ | ---------------------------------------- |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | packages/play-router/dist/types.d.ts:187 |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | packages/play-router/dist/types.d.ts:185 |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | packages/play-router/dist/types.d.ts:186 |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | packages/play-router/dist/types.d.ts:184 |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | packages/play-router/dist/types.d.ts:183 |
113
+ | Property | Modifier | Type | Defined in |
114
+ | -------------------------------------- | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [packages/play-router/src/types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L221) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L219) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L220) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [packages/play-router/src/types.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L218) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [packages/play-router/src/types.ts:217](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L217) |
package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps\<TActor\>
4
4
 
5
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/play-router-provider.tsx#L16)
5
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/play-router-provider.tsx#L16)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -14,7 +14,7 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:16](https:/
14
14
 
15
15
  | Property | Type | Description | Defined in |
16
16
  | ----------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
17
- | <a id="property-actor"></a> `actor` | `TActor` | - | [packages/play-solid-router/src/play-router-provider.tsx:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/play-router-provider.tsx#L17) |
18
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [packages/play-solid-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/play-router-provider.tsx#L21) |
19
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/play-router-provider.tsx#L18) |
20
- | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/play-router-provider.tsx#L19) |
17
+ | <a id="property-actor"></a> `actor` | `TActor` | - | [packages/play-solid-router/src/play-router-provider.tsx:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/play-router-provider.tsx#L17) |
18
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [packages/play-solid-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/play-router-provider.tsx#L21) |
19
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/play-router-provider.tsx#L18) |
20
+ | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/play-router-provider.tsx#L19) |
package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [packages/play-solid-router/src/types.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/types.ts#L8)
5
+ Defined in: [packages/play-solid-router/src/types.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/types.ts#L8)
6
6
 
7
7
  Mapping between state ID and URL path for SolidJS Router
8
8
 
@@ -10,5 +10,5 @@ Mapping between state ID and URL path for SolidJS Router
10
10
 
11
11
  | Property | Modifier | Type | Description | Defined in |
12
12
  | --------------------------------------- | ---------- | -------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-path"></a> `path` | `readonly` | `string` | SolidJS Router path pattern **Example** `'/', '/profile/:userId', '/settings/:section?'` | [packages/play-solid-router/src/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/types.ts#L19) |
14
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID with # prefix **Example** `'#home', '#profile'` | [packages/play-solid-router/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/types.ts#L13) |
13
+ | <a id="property-path"></a> `path` | `readonly` | `string` | SolidJS Router path pattern **Example** `'/', '/profile/:userId', '/settings/:section?'` | [packages/play-solid-router/src/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/types.ts#L19) |
14
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID with # prefix **Example** `'#home', '#profile'` | [packages/play-solid-router/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/types.ts#L13) |
package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: packages/play-router/dist/types.d.ts:229
5
+ Defined in: [packages/play-router/src/types.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/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
- [RFC Play v1 - Invariant INV-04](https://gitlab.com/xmachin-es/rfc/-/blob/main/src/play-v1.md)
47
+ [Play RFC](../../../_media/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: packages/play-router/dist/types.d.ts:245
57
+ Defined in: [packages/play-router/src/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/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: packages/play-router/dist/types.d.ts:260
86
+ Defined in: [packages/play-router/src/types.ts:296](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L296)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md CHANGED
@@ -6,6 +6,6 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/play-router-provider.tsx#L8)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/play-router-provider.tsx#L8)
10
10
 
11
11
  Minimum actor shape accepted by PlayRouterProvider.
package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type SolidRouterHooks = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/play-router-provider.tsx#L10)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/play-router-provider.tsx#L10)
10
10
 
11
11
  ## Properties
12
12
 
@@ -16,7 +16,7 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:10](https:/
16
16
  location: object;
17
17
  ```
18
18
 
19
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/play-router-provider.tsx#L12)
19
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/play-router-provider.tsx#L12)
20
20
 
21
21
  #### pathname
22
22
 
@@ -38,7 +38,7 @@ search: string;
38
38
  navigate: ((path) => void) | ((path, ...args) => unknown);
39
39
  ```
40
40
 
41
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/play-router-provider.tsx#L11)
41
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/play-router-provider.tsx#L11)
42
42
 
43
43
  ---
44
44
 
@@ -48,4 +48,4 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:11](https:/
48
48
  params: Record<string, string | undefined>;
49
49
  ```
50
50
 
51
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-solid-router/src/play-router-provider.tsx#L13)
51
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-solid-router/src/play-router-provider.tsx#L13)
package/api/@xmachines/play-tanstack-react-router/README.md CHANGED
@@ -209,14 +209,11 @@ Synchronizes browser URL with actor state through passive infrastructure.
209
209
  - [TanStackRouterInstance](type-aliases/TanStackRouterInstance.md)
210
210
  - [TanStackRouterLike](type-aliases/TanStackRouterLike.md)
211
211
 
212
- ## Variables
213
-
214
- - [extractMachineRoutes](variables/extractMachineRoutes.md)
215
-
216
212
  ## Functions
217
213
 
218
214
  - [createRouteMap](functions/createRouteMap.md)
219
215
  - [createRouteMapFromTree](functions/createRouteMapFromTree.md)
216
+ - [extractMachineRoutes](functions/extractMachineRoutes.md)
220
217
  - [extractParams](functions/extractParams.md)
221
218
  - [extractQueryParams](functions/extractQueryParams.md)
222
219
  - [PlayRouterProvider](functions/PlayRouterProvider.md)
package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-tanstack-react-router/src/route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.18/packages/play-tanstack-react-router/src/route-map.ts#L54)
5
+ Defined in: [play-tanstack-react-router/src/route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-tanstack-react-router/src/route-map.ts#L54)
6
6
 
7
7
  Bidirectional route mapper for TanStack React Router.
8
8
 
@@ -40,7 +40,7 @@ routeMap.getPathByStateId("home"); // "/"
40
40
  new RouteMap(mappings): RouteMap;
41
41
  ```
42
42
 
43
- Defined in: play-router/dist/base-route-map.d.ts:82
43
+ Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/base-route-map.ts#L125)
44
44
 
45
45
  Build a route map from an array of state ID ↔ path mappings.
46
46
 
@@ -70,7 +70,7 @@ buckets for efficient candidate selection.
70
70
  getPathByStateId(stateId): string | null;
71
71
  ```
72
72
 
73
- Defined in: play-router/dist/base-route-map.d.ts:112
73
+ Defined in: [play-router/src/base-route-map.ts:210](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/base-route-map.ts#L210)
74
74
 
75
75
  Look up the path pattern registered for a state ID.
76
76
 
@@ -105,7 +105,7 @@ map.getPathByStateId("missing"); // null
105
105
  getStateIdByPath(path): string | null;
106
106
  ```
107
107
 
108
- Defined in: play-router/dist/base-route-map.d.ts:99
108
+ Defined in: [play-router/src/base-route-map.ts:175](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/base-route-map.ts#L175)
109
109
 
110
110
  Resolve a URL path to its mapped state ID.
111
111