@xmachines/docs 1.0.0-beta.11 → 1.0.0-beta.13

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 (140) hide show
  1. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  2. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  3. package/api/@xmachines/play-actor/interfaces/Routable.md +2 -2
  4. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  5. package/api/@xmachines/play-actor/interfaces/Viewable.md +10 -3
  6. package/api/@xmachines/play-catalog/functions/defineCatalog.md +1 -1
  7. package/api/@xmachines/play-catalog/functions/defineComponents.md +1 -1
  8. package/api/@xmachines/play-catalog/type-aliases/Catalog.md +1 -1
  9. package/api/@xmachines/play-catalog/type-aliases/ComponentsFor.md +1 -1
  10. package/api/@xmachines/play-catalog/type-aliases/InferComponentProps.md +1 -1
  11. package/api/@xmachines/play-catalog/type-aliases/NoExtraKeys.md +1 -1
  12. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  13. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  14. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  15. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  16. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +4 -4
  17. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  18. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +6 -6
  19. package/api/@xmachines/play-react-router/classes/RouteMap.md +1 -1
  20. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  21. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  22. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  23. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  24. package/api/@xmachines/play-react-router-demo/README.md +30 -20
  25. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  26. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +21 -21
  27. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  28. package/api/@xmachines/play-router/functions/connectRouter.md +1 -1
  29. package/api/@xmachines/play-router/functions/crawlMachine.md +1 -1
  30. package/api/@xmachines/play-router/functions/createBrowserHistory.md +1 -1
  31. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  32. package/api/@xmachines/play-router/functions/createRouter.md +1 -1
  33. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  34. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  35. package/api/@xmachines/play-router/functions/extractRoute.md +1 -1
  36. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  37. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  38. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  39. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  40. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  41. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  42. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  43. package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
  44. package/api/@xmachines/play-router/interfaces/BrowserHistory.md +14 -14
  45. package/api/@xmachines/play-router/interfaces/BrowserWindow.md +14 -14
  46. package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +4 -4
  47. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  48. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  49. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  50. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  51. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  52. package/api/@xmachines/play-router/interfaces/RouteTree.md +4 -4
  53. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  54. package/api/@xmachines/play-router/interfaces/StateVisit.md +4 -4
  55. package/api/@xmachines/play-router/interfaces/VanillaRouter.md +4 -4
  56. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  57. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  58. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  59. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  60. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  61. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  62. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  63. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +4 -4
  64. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  65. package/api/@xmachines/play-solid-router/classes/RouteMap.md +1 -1
  66. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  67. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  68. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  69. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  70. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  71. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  72. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  73. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  74. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +1 -1
  75. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +6 -6
  76. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  77. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  78. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  79. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  80. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  81. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  82. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  83. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  84. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  85. package/api/@xmachines/play-tanstack-react-router-demo/README.md +15 -5
  86. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +1 -1
  87. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +7 -7
  88. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  89. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  90. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  91. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  92. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  93. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  94. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  95. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +3 -3
  96. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  97. package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
  98. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +5 -5
  99. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +8 -8
  100. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  101. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  102. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  103. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  104. package/api/@xmachines/play-xstate/classes/PlayerActor.md +11 -11
  105. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  106. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  107. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  108. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  109. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  110. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  111. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  112. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  113. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  114. package/api/@xmachines/play-xstate/functions/mergeViewProps.md +1 -1
  115. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  116. package/api/@xmachines/play-xstate/functions/stateMatches.md +1 -1
  117. package/api/@xmachines/play-xstate/functions/validateComponentBinding.md +1 -1
  118. package/api/@xmachines/play-xstate/functions/validateViewProps.md +2 -2
  119. package/api/@xmachines/play-xstate/interfaces/CatalogEntry.md +3 -3
  120. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +4 -4
  121. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
  122. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  123. package/api/@xmachines/play-xstate/type-aliases/Catalog.md +1 -1
  124. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  125. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  126. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  127. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  128. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  129. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  130. package/api/@xmachines/play-xstate/type-aliases/ValidationResult.md +1 -1
  131. package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md +3 -3
  132. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
  133. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  134. package/api/README.md +29 -1
  135. package/api/llms.txt +66 -23
  136. package/examples/README.md +3 -3
  137. package/examples/multi-router-integration.md +6 -6
  138. package/examples/routing-patterns.md +2 -2
  139. package/guides/README.md +9 -10
  140. package/package.json +2 -2
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMap
4
4
 
5
- Defined in: [create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/create-route-map.ts#L27)
5
+ Defined in: [create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-route-map.ts#L27)
6
6
 
7
7
  Bidirectional route resolution interface returned by `createRouteMap()`.
8
8
 
@@ -23,7 +23,7 @@ events into `play.route` actor events.
23
23
  resolve(path): object;
24
24
  ```
25
25
 
26
- Defined in: [create-route-map.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/create-route-map.ts#L44)
26
+ Defined in: [create-route-map.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-route-map.ts#L44)
27
27
 
28
28
  Resolve a URL path to a state ID and params.
29
29
 
@@ -52,5 +52,5 @@ if (to) {
52
52
 
53
53
  | Name | Type | Defined in |
54
54
  | -------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
55
- | `params` | `Record`\<`string`, `string`\> | [create-route-map.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/create-route-map.ts#L46) |
56
- | `to` | `string` \| `null` | [create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/create-route-map.ts#L45) |
55
+ | `params` | `Record`\<`string`, `string`\> | [create-route-map.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-route-map.ts#L46) |
56
+ | `to` | `string` \| `null` | [create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-route-map.ts#L45) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteNode
4
4
 
5
- Defined in: [types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L63)
5
+ Defined in: [types.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L63)
6
6
 
7
7
  Node in the route tree representing a single route
8
8
 
@@ -10,12 +10,12 @@ Node in the route tree representing a single route
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ----------------------------------------- | --------------------- | ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-children"></a> `children` | `RouteNode`[] | Child routes | [types.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L80) |
14
- | <a id="property-fullpath"></a> `fullPath` | `string` | Full resolved path from root | [types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L69) |
15
- | <a id="property-id"></a> `id` | `string` | Unique identifier (state ID) | [types.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L65) |
16
- | <a id="property-metadata"></a> `metadata` | `unknown` | Original meta.route metadata | [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L84) |
17
- | <a id="property-parent"></a> `parent` | `RouteNode` \| `null` | Parent route (null for root) | [types.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L82) |
18
- | <a id="property-path"></a> `path` | `string` | Route path segment (relative or absolute) | [types.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L67) |
19
- | <a id="property-pattern"></a> `pattern?` | `string` | Route pattern with parameters (e.g., /profile/:userId) if path contains params | [types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L71) |
20
- | <a id="property-routable"></a> `routable` | `boolean` | Whether this state is routable (has meta.route) States with meta.route can receive play.route events | [types.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L78) |
21
- | <a id="property-stateid"></a> `stateId` | `string` | XState state ID this route maps to | [types.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L73) |
13
+ | <a id="property-children"></a> `children` | `RouteNode`[] | Child routes | [types.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L80) |
14
+ | <a id="property-fullpath"></a> `fullPath` | `string` | Full resolved path from root | [types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L69) |
15
+ | <a id="property-id"></a> `id` | `string` | Unique identifier (state ID) | [types.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L65) |
16
+ | <a id="property-metadata"></a> `metadata` | `unknown` | Original meta.route metadata | [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L84) |
17
+ | <a id="property-parent"></a> `parent` | `RouteNode` \| `null` | Parent route (null for root) | [types.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L82) |
18
+ | <a id="property-path"></a> `path` | `string` | Route path segment (relative or absolute) | [types.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L67) |
19
+ | <a id="property-pattern"></a> `pattern?` | `string` | Route pattern with parameters (e.g., /profile/:userId) if path contains params | [types.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L71) |
20
+ | <a id="property-routable"></a> `routable` | `boolean` | Whether this state is routable (has meta.route) States with meta.route can receive play.route events | [types.ts:78](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L78) |
21
+ | <a id="property-stateid"></a> `stateId` | `string` | XState state ID this route maps to | [types.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L73) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteObject
4
4
 
5
- Defined in: [types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L13)
5
+ Defined in: [types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L13)
6
6
 
7
7
  Route object with additional metadata.
8
8
 
@@ -18,4 +18,4 @@ Additional route metadata (title, breadcrumb, etc.)
18
18
 
19
19
  | Property | Type | Description | Defined in |
20
20
  | --------------------------------- | -------- | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
21
- | <a id="property-path"></a> `path` | `string` | Route path template (e.g., '/user/:id') | [types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L15) |
21
+ | <a id="property-path"></a> `path` | `string` | Route path template (e.g., '/user/:id') | [types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L15) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteTree
4
4
 
5
- Defined in: [types.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L94)
5
+ Defined in: [types.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L94)
6
6
 
7
7
  Complete route tree with lookup maps
8
8
 
@@ -15,6 +15,6 @@ Provides bidirectional mapping between state IDs and URL paths:
15
15
 
16
16
  | Property | Type | Description | Defined in |
17
17
  | ------------------------------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
18
- | <a id="property-bypath"></a> `byPath` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | Map full path -> route node Used to look up state ID from URL path for play.route event targeting | [types.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L106) |
19
- | <a id="property-bystateid"></a> `byStateId` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | Map state ID -> route node Used to look up URL path from state ID for browser URL sync | [types.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L101) |
20
- | <a id="property-root"></a> `root` | [`RouteNode`](RouteNode.md) | Root route node | [types.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L96) |
18
+ | <a id="property-bypath"></a> `byPath` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | Map full path -> route node Used to look up state ID from URL path for play.route event targeting | [types.ts:106](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L106) |
19
+ | <a id="property-bystateid"></a> `byStateId` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | Map state ID -> route node Used to look up URL path from state ID for browser URL sync | [types.ts:101](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L101) |
20
+ | <a id="property-root"></a> `root` | [`RouteNode`](RouteNode.md) | Root route node | [types.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L96) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L238)
5
+ Defined in: [types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L238)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [types.ts:254](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L254)
57
+ Defined in: [types.ts:254](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L254)
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: [types.ts:270](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L270)
86
+ Defined in: [types.ts:270](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L270)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: StateVisit
4
4
 
5
- Defined in: [types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L28)
5
+ Defined in: [types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L28)
6
6
 
7
7
  Represents a visit to a state node during graph crawling
8
8
 
@@ -10,6 +10,6 @@ Represents a visit to a state node during graph crawling
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-node"></a> `node` | [`StateNode`](https://www.jsdocs.io/package/xstate#StateNode) | The state node being visited | [types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L30) |
14
- | <a id="property-parent"></a> `parent` | \| [`StateNode`](https://www.jsdocs.io/package/xstate#StateNode)\<[`MachineContext`](https://www.jsdocs.io/package/xstate#MachineContext), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> \| `null` | Parent state node (null for root) | [types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L34) |
15
- | <a id="property-path"></a> `path` | `string`[] | Path from root to this state (e.g., ['dashboard', 'overview']) | [types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L32) |
13
+ | <a id="property-node"></a> `node` | [`StateNode`](https://www.jsdocs.io/package/xstate#StateNode) | The state node being visited | [types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L30) |
14
+ | <a id="property-parent"></a> `parent` | \| [`StateNode`](https://www.jsdocs.io/package/xstate#StateNode)\<[`MachineContext`](https://www.jsdocs.io/package/xstate#MachineContext), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> \| `null` | Parent state node (null for root) | [types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L34) |
15
+ | <a id="property-path"></a> `path` | `string`[] | Path from root to this state (e.g., ['dashboard', 'overview']) | [types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L32) |
@@ -2,14 +2,14 @@
2
2
 
3
3
  # Interface: VanillaRouter
4
4
 
5
- Defined in: [create-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/create-router.ts#L4)
5
+ Defined in: [create-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-router.ts#L4)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ------------------------------------------- | ---------- | ------------------------------------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-history"></a> `history` | `readonly` | [`BrowserHistory`](BrowserHistory.md) | History instance | [create-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/create-router.ts#L8) |
12
- | <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](RouteTree.md) | Route tree (for structure reference) | [create-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/create-router.ts#L13) |
11
+ | <a id="property-history"></a> `history` | `readonly` | [`BrowserHistory`](BrowserHistory.md) | History instance | [create-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-router.ts#L8) |
12
+ | <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](RouteTree.md) | Route tree (for structure reference) | [create-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-router.ts#L13) |
13
13
 
14
14
  ## Methods
15
15
 
@@ -19,7 +19,7 @@ Defined in: [create-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/bl
19
19
  destroy(): void;
20
20
  ```
21
21
 
22
- Defined in: [create-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/create-router.ts#L18)
22
+ Defined in: [create-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/create-router.ts#L18)
23
23
 
24
24
  Cleanup
25
25
 
@@ -6,6 +6,6 @@
6
6
  type RouteMetadata = string | RouteObject;
7
7
  ```
8
8
 
9
- Defined in: [types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-router/src/types.ts#L23)
9
+ Defined in: [types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-router/src/types.ts#L23)
10
10
 
11
11
  Route metadata from state machine `meta.route` field.
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ComputedOptions\<T\>
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L84)
5
+ Defined in: [packages/play-signals/src/types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L84)
6
6
 
7
7
  Options for creating Signal.Computed
8
8
 
@@ -31,4 +31,4 @@ const options: ComputedOptions<string> = {
31
31
 
32
32
  | Property | Type | Description | Defined in |
33
33
  | -------------------------------------- | ----------------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34
- | <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for memoization | [packages/play-signals/src/types.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L88) |
34
+ | <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for memoization | [packages/play-signals/src/types.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L88) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SignalComputed\<T\>
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L111)
5
+ Defined in: [packages/play-signals/src/types.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L111)
6
6
 
7
7
  Lazily-evaluated, memoized computed signal
8
8
 
@@ -38,7 +38,7 @@ console.log(doubled.get()); // 10 (memoized, not recomputed)
38
38
  get(): T;
39
39
  ```
40
40
 
41
- Defined in: [packages/play-signals/src/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L117)
41
+ Defined in: [packages/play-signals/src/types.ts:117](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L117)
42
42
 
43
43
  Read computed value (recalculates only if dependencies changed)
44
44
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SignalOptions\<T\>
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L26)
5
+ Defined in: [packages/play-signals/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L26)
6
6
 
7
7
  Options for creating Signal.State
8
8
 
@@ -32,4 +32,4 @@ const count = new Signal.State(0, options);
32
32
 
33
33
  | Property | Type | Description | Defined in |
34
34
  | -------------------------------------- | ----------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
35
- | <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for determining if value changed | [packages/play-signals/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L33) |
35
+ | <a id="property-equals"></a> `equals?` | (`a`, `b`) => `boolean` | Custom equality function for determining if value changed | [packages/play-signals/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L33) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SignalState\<T\>
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L53)
5
+ Defined in: [packages/play-signals/src/types.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L53)
6
6
 
7
7
  Writable state signal holding a single reactive value
8
8
 
@@ -35,7 +35,7 @@ console.log(name.get()); // 'Bob'
35
35
  get(): T;
36
36
  ```
37
37
 
38
- Defined in: [packages/play-signals/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L59)
38
+ Defined in: [packages/play-signals/src/types.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L59)
39
39
 
40
40
  Read current value and track as dependency
41
41
 
@@ -53,7 +53,7 @@ Current value of the signal
53
53
  set(value): void;
54
54
  ```
55
55
 
56
- Defined in: [packages/play-signals/src/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L66)
56
+ Defined in: [packages/play-signals/src/types.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L66)
57
57
 
58
58
  Write new value and notify watchers if changed
59
59
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: SignalWatcher
4
4
 
5
- Defined in: [packages/play-signals/src/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L167)
5
+ Defined in: [packages/play-signals/src/types.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L167)
6
6
 
7
7
  Watcher for observing signal changes and scheduling effects
8
8
 
@@ -40,7 +40,7 @@ getPending(): (
40
40
  | SignalComputed<unknown>)[];
41
41
  ```
42
42
 
43
- Defined in: [packages/play-signals/src/types.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L187)
43
+ Defined in: [packages/play-signals/src/types.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L187)
44
44
 
45
45
  Get signals that changed since last check
46
46
 
@@ -60,7 +60,7 @@ Array of signals that have pending updates
60
60
  unwatch(signal): void;
61
61
  ```
62
62
 
63
- Defined in: [packages/play-signals/src/types.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L180)
63
+ Defined in: [packages/play-signals/src/types.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L180)
64
64
 
65
65
  Stop watching a signal
66
66
 
@@ -82,7 +82,7 @@ Stop watching a signal
82
82
  watch(signal): void;
83
83
  ```
84
84
 
85
- Defined in: [packages/play-signals/src/types.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L173)
85
+ Defined in: [packages/play-signals/src/types.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L173)
86
86
 
87
87
  Start watching a signal for changes
88
88
 
@@ -6,7 +6,7 @@
6
6
  type WatcherNotify = () => void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-signals/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-signals/src/types.ts#L139)
9
+ Defined in: [packages/play-signals/src/types.ts:139](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-signals/src/types.ts#L139)
10
10
 
11
11
  Notification callback for Signal.subtle.Watcher
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRendererProps
4
4
 
5
- Defined in: [types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid/src/types.ts#L20)
5
+ Defined in: [types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid/src/types.ts#L20)
6
6
 
7
7
  Props for PlayRenderer component
8
8
 
@@ -10,6 +10,6 @@ Props for PlayRenderer component
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid/src/types.ts#L22) |
14
- | <a id="property-components"></a> `components` | `Record`\<`string`, `ValidComponent`\> | Map of component names to SolidJS components | [types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid/src/types.ts#L25) |
15
- | <a id="property-fallback"></a> `fallback?` | `any` | Optional element shown when currentView is null | [types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid/src/types.ts#L28) |
13
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid/src/types.ts#L22) |
14
+ | <a id="property-components"></a> `components` | `Record`\<`string`, `ValidComponent`\> | Map of component names to SolidJS components | [types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid/src/types.ts#L25) |
15
+ | <a id="property-fallback"></a> `fallback?` | `any` | Optional element shown when currentView is null | [types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid/src/types.ts#L28) |
@@ -6,7 +6,7 @@
6
6
  const PlayRenderer: Component<PlayRendererProps>;
7
7
  ```
8
8
 
9
- Defined in: [PlayRenderer.tsx:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid/src/PlayRenderer.tsx#L66)
9
+ Defined in: [PlayRenderer.tsx:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid/src/PlayRenderer.tsx#L66)
10
10
 
11
11
  Main renderer component that subscribes to actor signals and renders UI
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [packages/play-solid-router/src/route-map.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/route-map.ts#L26)
5
+ Defined in: [packages/play-solid-router/src/route-map.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/route-map.ts#L26)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -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/8aa0643f9736fab0deae2851a2d403008d4412ed/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/dc729bb39810dbc25648ddd9203782369c467996/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:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/solid-router-bridge.ts#L59)
30
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/solid-router-bridge.ts#L59)
31
31
 
32
32
  Create a SolidJS Router bridge
33
33
 
@@ -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:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/solid-router-bridge.ts#L123)
123
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/solid-router-bridge.ts#L123)
124
124
 
125
125
  Dispose the bridge (alias for disconnect).
126
126
 
@@ -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:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/solid-router-bridge.ts#L82)
207
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/solid-router-bridge.ts#L82)
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:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/solid-router-bridge.ts#L75)
227
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/solid-router-bridge.ts#L75)
228
228
 
229
229
  Navigate SolidJS Router to the given path.
230
230
 
@@ -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:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/solid-router-bridge.ts#L111)
312
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/solid-router-bridge.ts#L111)
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:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/solid-router-bridge.ts#L92)
334
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/solid-router-bridge.ts#L92)
335
335
 
336
336
  Subscribe to SolidJS Router location changes using createEffect.
337
337
 
@@ -6,7 +6,7 @@
6
6
  function PlayRouterProvider(props): any;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/play-router-provider.tsx#L21)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/play-router-provider.tsx#L21)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -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/8aa0643f9736fab0deae2851a2d403008d4412ed/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/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/create-route-map.ts#L27)
10
10
 
11
11
  Create a RouteMap from an XState machine
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Interface: AbstractActor\<TLogic\>
4
4
 
5
- Defined in: packages/play-actor/dist/abstract-actor.d.ts:173
5
+ Defined in: packages/play-actor/dist/abstract-actor.d.ts:181
6
6
 
7
7
  Abstract base class for Play Architecture actors.
8
8
 
@@ -82,7 +82,7 @@ class PlayerActor extends AbstractActor<AnyActorLogic> implements Routable, View
82
82
  | <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` | node_modules/xstate/dist/declarations/src/createActor.d.ts:34 |
83
83
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | node_modules/xstate/dist/declarations/src/createActor.d.ts:38 |
84
84
  | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | node_modules/xstate/dist/declarations/src/createActor.d.ts:42 |
85
- | <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:193 |
85
+ | <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:201 |
86
86
  | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | node_modules/xstate/dist/declarations/src/createActor.d.ts:40 |
87
87
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | node_modules/xstate/dist/declarations/src/createActor.d.ts:36 |
88
88
 
@@ -220,7 +220,7 @@ Actor.on;
220
220
  abstract send(event): void;
221
221
  ```
222
222
 
223
- Defined in: packages/play-actor/dist/abstract-actor.d.ts:216
223
+ Defined in: packages/play-actor/dist/abstract-actor.d.ts:224
224
224
 
225
225
  Send event to Actor
226
226
 
@@ -2,13 +2,13 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps
4
4
 
5
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/play-router-provider.tsx#L14)
5
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/play-router-provider.tsx#L14)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Type | Defined in |
10
10
  | ----------------------------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-actor"></a> `actor` | [`RoutableActor`](../type-aliases/RoutableActor.md) | [packages/play-solid-router/src/play-router-provider.tsx:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/play-router-provider.tsx#L15) |
12
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | [packages/play-solid-router/src/play-router-provider.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/play-router-provider.tsx#L18) |
13
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | [packages/play-solid-router/src/play-router-provider.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/play-router-provider.tsx#L16) |
14
- | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | [packages/play-solid-router/src/play-router-provider.tsx:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/play-router-provider.tsx#L17) |
11
+ | <a id="property-actor"></a> `actor` | [`RoutableActor`](../type-aliases/RoutableActor.md) | [packages/play-solid-router/src/play-router-provider.tsx:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/play-router-provider.tsx#L15) |
12
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | [packages/play-solid-router/src/play-router-provider.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/play-router-provider.tsx#L18) |
13
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | [packages/play-solid-router/src/play-router-provider.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/play-router-provider.tsx#L16) |
14
+ | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | [packages/play-solid-router/src/play-router-provider.tsx:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/play-router-provider.tsx#L17) |
@@ -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/8aa0643f9736fab0deae2851a2d403008d4412ed/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/dc729bb39810dbc25648ddd9203782369c467996/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/8aa0643f9736fab0deae2851a2d403008d4412ed/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/8aa0643f9736fab0deae2851a2d403008d4412ed/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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/types.ts#L13) |
@@ -6,4 +6,4 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/play-router-provider.tsx#L7)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/play-router-provider.tsx#L7)
@@ -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:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/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/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/play-router-provider.tsx#L8)
10
10
 
11
11
  ## Properties
12
12
 
@@ -16,7 +16,7 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:8](https://
16
16
  location: object;
17
17
  ```
18
18
 
19
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/play-router-provider.tsx#L10)
19
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/play-router-provider.tsx#L10)
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:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/play-router-provider.tsx#L9)
41
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/play-router-provider.tsx#L9)
42
42
 
43
43
  ---
44
44
 
@@ -48,4 +48,4 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:9](https://
48
48
  params: Record<string, string | undefined>;
49
49
  ```
50
50
 
51
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/8aa0643f9736fab0deae2851a2d403008d4412ed/packages/play-solid-router/src/play-router-provider.tsx#L11)
51
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-solid-router/src/play-router-provider.tsx#L11)