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

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 (180) 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 +1 -1
  19. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  20. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  21. package/api/@xmachines/play-react/functions/useSignalEffect.md +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 +21 -21
  28. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  29. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  30. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  31. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +7 -7
  32. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  33. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  34. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +4 -4
  35. package/api/@xmachines/play-router/README.md +1 -1
  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 +1 -1
  45. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  46. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  47. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  48. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  49. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  50. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  51. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  52. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  53. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  54. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  55. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  56. package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
  57. package/api/@xmachines/play-router/interfaces/BrowserHistory.md +14 -14
  58. package/api/@xmachines/play-router/interfaces/BrowserWindow.md +14 -14
  59. package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +4 -4
  60. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  61. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  62. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +7 -7
  63. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  64. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  65. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  66. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  67. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  68. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  69. package/api/@xmachines/play-router/interfaces/RouterBridge.md +4 -4
  70. package/api/@xmachines/play-router/interfaces/VanillaRouter.md +4 -4
  71. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  72. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  73. package/api/@xmachines/play-signals/README.md +2 -2
  74. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  75. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  76. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  77. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  78. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  79. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  80. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  81. package/api/@xmachines/play-solid/README.md +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 +22 -22
  89. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  90. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  91. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +4 -4
  92. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +7 -7
  93. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  94. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  95. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +4 -4
  96. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  97. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  98. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  99. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +21 -21
  100. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  101. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  102. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  103. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  104. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  105. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  106. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +7 -7
  107. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  108. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  109. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  110. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +4 -4
  111. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  112. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  113. package/api/@xmachines/play-tanstack-solid-router/README.md +1 -1
  114. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  115. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +22 -22
  116. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  117. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  118. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +7 -7
  119. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  120. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  121. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +4 -4
  122. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  123. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  124. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  125. package/api/@xmachines/play-vue/README.md +1 -1
  126. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  127. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  128. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  129. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  130. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  131. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  132. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  133. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  134. package/api/@xmachines/play-vue-router/README.md +1 -1
  135. package/api/@xmachines/play-vue-router/classes/RouteMap.md +7 -7
  136. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +7 -7
  137. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +22 -22
  138. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  139. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +7 -7
  140. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  141. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +4 -4
  142. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  143. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  144. package/api/@xmachines/play-xstate/README.md +1 -1
  145. package/api/@xmachines/play-xstate/classes/PlayerActor.md +12 -12
  146. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  147. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  148. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  149. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  150. package/api/@xmachines/play-xstate/functions/definePlayer.md +2 -2
  151. package/api/@xmachines/play-xstate/functions/deriveRoute.md +2 -2
  152. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  153. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  154. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  155. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  156. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  157. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  158. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  159. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  160. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  161. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  162. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  163. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  164. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  165. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  166. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  167. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
  168. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  169. package/package.json +5 -3
  170. package/rfc/broker.md +100 -0
  171. package/rfc/browser.md +44 -0
  172. package/rfc/cli.md +118 -0
  173. package/rfc/git.md +61 -0
  174. package/rfc/mcp.md +43 -0
  175. package/rfc/node.md +36 -0
  176. package/rfc/play.md +447 -0
  177. package/rfc/rest.md +102 -0
  178. package/rfc/run.md +159 -0
  179. package/rfc/streams.md +168 -0
  180. /package/api/{_media → rfc}/play.md +0 -0
package/api/@xmachines/play-router/classes/RouterBridgeBase.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Class: RouterBridgeBase
4
4
 
5
- Defined in: [router-bridge-base.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L82)
5
+ Defined in: [router-bridge-base.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L82)
6
6
 
7
7
  Abstract base class for all `@xmachines` router adapter bridges.
8
8
 
@@ -30,7 +30,7 @@ between frameworks.
30
30
  new RouterBridgeBase(actor, routeMap): RouterBridgeBase;
31
31
  ```
32
32
 
33
- Defined in: [router-bridge-base.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L96)
33
+ Defined in: [router-bridge-base.ts:96](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L96)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -49,15 +49,15 @@ Defined in: [router-bridge-base.ts:96](https://gitlab.com/xmachin-es/xmachines-j
49
49
 
50
50
  | Property | Modifier | Type | Default value | Description | Defined in |
51
51
  | --------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
52
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [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) |
53
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [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) |
54
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [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) |
55
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [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) |
56
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [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) |
57
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [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) |
58
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [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) |
59
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [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) |
60
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | [`RouteWatcherHandle`](../interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [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) |
52
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [router-bridge-base.ts:97](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L97) |
53
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L85) |
54
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L84) |
55
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L87) |
56
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [router-bridge-base.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L86) |
57
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [router-bridge-base.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L98) |
58
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [router-bridge-base.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L100) |
59
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [router-bridge-base.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L99) |
60
+ | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | [`RouteWatcherHandle`](../interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [router-bridge-base.ts:88](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L88) |
61
61
 
62
62
  ## Methods
63
63
 
@@ -67,7 +67,7 @@ Defined in: [router-bridge-base.ts:96](https://gitlab.com/xmachin-es/xmachines-j
67
67
  connect(): void;
68
68
  ```
69
69
 
70
- Defined in: [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)
70
+ Defined in: [router-bridge-base.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L116)
71
71
 
72
72
  Connect the router bridge to the Actor.
73
73
 
@@ -90,7 +90,7 @@ starts watching router changes (framework-specific).
90
90
  disconnect(): void;
91
91
  ```
92
92
 
93
- Defined in: [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)
93
+ Defined in: [router-bridge-base.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L184)
94
94
 
95
95
  Disconnect the router bridge from the Actor.
96
96
 
@@ -112,7 +112,7 @@ Stops signal watching and unregisters framework-specific router listener.
112
112
  protected extractParams(pathname, stateId): Record<string, string>;
113
113
  ```
114
114
 
115
- Defined in: [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)
115
+ Defined in: [router-bridge-base.ts:283](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L283)
116
116
 
117
117
  Extract path parameters from URL using the URLPattern API.
118
118
 
@@ -142,7 +142,7 @@ Extracted path parameters, or empty object if URLPattern is unavailable or no ma
142
142
  protected extractQuery(search): Record<string, string>;
143
143
  ```
144
144
 
145
- Defined in: [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)
145
+ Defined in: [router-bridge-base.ts:310](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L310)
146
146
 
147
147
  Extract query parameters from URL search string.
148
148
 
@@ -166,7 +166,7 @@ Extracted query parameters or empty object
166
166
  protected getInitialRouterPath(): string | null | undefined;
167
167
  ```
168
168
 
169
- Defined in: [router-bridge-base.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L357)
169
+ Defined in: [router-bridge-base.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L357)
170
170
 
171
171
  Return the router's current pathname at connect() time.
172
172
 
@@ -198,7 +198,7 @@ bridges that have not yet implemented this hook.
198
198
  abstract protected navigateRouter(path): void;
199
199
  ```
200
200
 
201
- Defined in: [router-bridge-base.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L322)
201
+ Defined in: [router-bridge-base.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L322)
202
202
 
203
203
  Navigate the framework router to the given path.
204
204
 
@@ -223,7 +223,7 @@ Must trigger the framework router's navigation (e.g., router.navigate(path)).
223
223
  protected syncActorFromRouter(pathname, search?): void;
224
224
  ```
225
225
 
226
- Defined in: [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)
226
+ Defined in: [router-bridge-base.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L231)
227
227
 
228
228
  Sync actor state when router location changes.
229
229
 
@@ -249,7 +249,7 @@ Prevents circular updates via isProcessingNavigation flag.
249
249
  protected syncRouterFromActor(route): void;
250
250
  ```
251
251
 
252
- Defined in: [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)
252
+ Defined in: [router-bridge-base.ts:211](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L211)
253
253
 
254
254
  Sync router location when actor route signal changes.
255
255
 
@@ -274,7 +274,7 @@ Prevents circular updates via isProcessingNavigation flag.
274
274
  abstract protected unwatchRouterChanges(): void;
275
275
  ```
276
276
 
277
- Defined in: [router-bridge-base.ts:337](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L337)
277
+ Defined in: [router-bridge-base.ts:337](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L337)
278
278
 
279
279
  Stop watching for router location changes.
280
280
 
@@ -292,7 +292,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
292
292
  abstract protected watchRouterChanges(): void;
293
293
  ```
294
294
 
295
- Defined in: [router-bridge-base.ts:330](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-bridge-base.ts#L330)
295
+ Defined in: [router-bridge-base.ts:330](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-bridge-base.ts#L330)
296
296
 
297
297
  Start watching for router location changes.
298
298
 
package/api/@xmachines/play-router/functions/buildRouteTree.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function buildRouteTree(routes): RouteTree;
7
7
  ```
8
8
 
9
- Defined in: [build-tree.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/build-tree.ts#L13)
9
+ Defined in: [build-tree.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/build-tree.ts#L13)
10
10
 
11
11
  Build hierarchical route tree from flat route list
12
12
 
package/api/@xmachines/play-router/functions/connectRouter.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): () => void;
7
7
  ```
8
8
 
9
- Defined in: [connect-router.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/connect-router.ts#L59)
9
+ Defined in: [connect-router.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/connect-router.ts#L59)
10
10
 
11
11
  Connect vanilla router to actor (pure browser integration).
12
12
 
package/api/@xmachines/play-router/functions/createBrowserHistory.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createBrowserHistory(options): BrowserHistory;
7
7
  ```
8
8
 
9
- Defined in: [create-browser-history.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L115)
9
+ Defined in: [create-browser-history.ts:115](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L115)
10
10
 
11
11
  Create browser history that wraps window.history
12
12
 
package/api/@xmachines/play-router/functions/createRouteMap.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(routeTree): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [create-route-map.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-route-map.ts#L121)
9
+ Defined in: [create-route-map.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-route-map.ts#L121)
10
10
 
11
11
  Create a RouteMap from a RouteTree for efficient path lookups.
12
12
 
package/api/@xmachines/play-router/functions/createRouter.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouter(options): VanillaRouter;
7
7
  ```
8
8
 
9
- Defined in: [create-router.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-router.ts#L73)
9
+ Defined in: [create-router.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-router.ts#L73)
10
10
 
11
11
  Create vanilla router for framework-agnostic routing.
12
12
 
package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function detectDuplicateRoutes(routes): void;
7
7
  ```
8
8
 
9
- Defined in: [validate-routes.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/validate-routes.ts#L51)
9
+ Defined in: [validate-routes.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/validate-routes.ts#L51)
10
10
 
11
11
  Detect duplicate route paths
12
12
 
package/api/@xmachines/play-router/functions/extractMachineRoutes.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function extractMachineRoutes(machine): RouteTree;
7
7
  ```
8
8
 
9
- Defined in: [extract-routes.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/extract-routes.ts#L93)
9
+ Defined in: [extract-routes.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/extract-routes.ts#L93)
10
10
 
11
11
  Extract complete route tree from state machine graph
12
12
 
package/api/@xmachines/play-router/functions/findRouteById.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function findRouteById(tree, id): RouteNode | undefined;
7
7
  ```
8
8
 
9
- Defined in: [find-route.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/find-route.ts#L91)
9
+ Defined in: [find-route.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/find-route.ts#L91)
10
10
 
11
11
  Find route node by state ID
12
12
 
package/api/@xmachines/play-router/functions/findRouteByPath.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function findRouteByPath(tree, path): RouteNode | undefined;
7
7
  ```
8
8
 
9
- Defined in: [find-route.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/find-route.ts#L116)
9
+ Defined in: [find-route.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/find-route.ts#L116)
10
10
 
11
11
  Find route node by URL path
12
12
 
package/api/@xmachines/play-router/functions/getNavigableRoutes.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function getNavigableRoutes(tree, stateId): RouteNode[];
7
7
  ```
8
8
 
9
- Defined in: [query.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/query.ts#L22)
9
+ Defined in: [query.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/query.ts#L22)
10
10
 
11
11
  Get all routes navigable from given state
12
12
 
package/api/@xmachines/play-router/functions/getRoutableRoutes.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function getRoutableRoutes(tree): RouteNode[];
7
7
  ```
8
8
 
9
- Defined in: [query.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/query.ts#L67)
9
+ Defined in: [query.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/query.ts#L67)
10
10
 
11
11
  Get all routable routes from tree as flat array
12
12
 
package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function getTransitionReachableRoutes(graph, stateId): string[];
7
7
  ```
8
8
 
9
- Defined in: [query.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/query.ts#L113)
9
+ Defined in: [query.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/query.ts#L113)
10
10
 
11
11
  Get routes reachable via transitions from current state
12
12
 
package/api/@xmachines/play-router/functions/isRouteReachable.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function isRouteReachable(graph, fromStateId, toStateId): boolean;
7
7
  ```
8
8
 
9
- Defined in: [query.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/query.ts#L149)
9
+ Defined in: [query.ts:149](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/query.ts#L149)
10
10
 
11
11
  Check if a route is reachable from current state via transitions
12
12
 
package/api/@xmachines/play-router/functions/machineToGraph.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function machineToGraph(machine): MachineGraph;
7
7
  ```
8
8
 
9
- Defined in: [machine-to-graph.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/machine-to-graph.ts#L70)
9
+ Defined in: [machine-to-graph.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/machine-to-graph.ts#L70)
10
10
 
11
11
  ## Parameters
12
12
 
package/api/@xmachines/play-router/functions/routeExists.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function routeExists(tree, path): boolean;
7
7
  ```
8
8
 
9
- Defined in: [query.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/query.ts#L89)
9
+ Defined in: [query.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/query.ts#L89)
10
10
 
11
11
  Validate route path exists in tree
12
12
 
package/api/@xmachines/play-router/functions/sanitizePathname.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function sanitizePathname(pathname): string | null;
7
7
  ```
8
8
 
9
- Defined in: [router-sync.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/router-sync.ts#L63)
9
+ Defined in: [router-sync.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/router-sync.ts#L63)
10
10
 
11
11
  Normalize a pathname before route-map lookup.
12
12
 
package/api/@xmachines/play-router/functions/validateRouteFormat.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function validateRouteFormat(routePath, stateId): void;
7
7
  ```
8
8
 
9
- Defined in: [validate-routes.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/validate-routes.ts#L14)
9
+ Defined in: [validate-routes.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/validate-routes.ts#L14)
10
10
 
11
11
  Validate route path format
12
12
 
package/api/@xmachines/play-router/functions/validateStateExists.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function validateStateExists(stateId, stateIds): void;
7
7
  ```
8
8
 
9
- Defined in: [validate-routes.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/validate-routes.ts#L32)
9
+ Defined in: [validate-routes.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/validate-routes.ts#L32)
10
10
 
11
11
  Validate state exists in state ID set
12
12
 
package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BaseRouteMapping
4
4
 
5
- Defined in: [base-route-map.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/base-route-map.ts#L64)
5
+ Defined in: [base-route-map.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/base-route-map.ts#L64)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: BaseRouteMapping = { stateId: "settings", path: "/setting
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [base-route-map.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/base-route-map.ts#L68) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [base-route-map.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/base-route-map.ts#L66) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [base-route-map.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/base-route-map.ts#L68) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [base-route-map.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/base-route-map.ts#L66) |
package/api/@xmachines/play-router/interfaces/BrowserHistory.md CHANGED
@@ -2,17 +2,17 @@
2
2
 
3
3
  # Interface: BrowserHistory
4
4
 
5
- Defined in: [create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L1)
5
+ Defined in: [create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L1)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Modifier | Type | Description | Defined in |
10
10
  | ----------------------------------------- | ---------- | --------- | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L5) |
12
- | `location.hash` | `public` | `string` | - | [create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L8) |
13
- | `location.pathname` | `public` | `string` | - | [create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L6) |
14
- | `location.search` | `public` | `string` | - | [create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L7) |
15
- | `location.state` | `public` | `unknown` | - | [create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L9) |
11
+ | <a id="property-location"></a> `location` | `readonly` | `object` | Get current location state | [create-browser-history.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L5) |
12
+ | `location.hash` | `public` | `string` | - | [create-browser-history.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L8) |
13
+ | `location.pathname` | `public` | `string` | - | [create-browser-history.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L6) |
14
+ | `location.search` | `public` | `string` | - | [create-browser-history.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L7) |
15
+ | `location.state` | `public` | `unknown` | - | [create-browser-history.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L9) |
16
16
 
17
17
  ## Methods
18
18
 
@@ -22,7 +22,7 @@ Defined in: [create-browser-history.ts:1](https://gitlab.com/xmachin-es/xmachine
22
22
  back(): void;
23
23
  ```
24
24
 
25
- Defined in: [create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L26)
25
+ Defined in: [create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L26)
26
26
 
27
27
  #### Returns
28
28
 
@@ -36,7 +36,7 @@ Defined in: [create-browser-history.ts:26](https://gitlab.com/xmachin-es/xmachin
36
36
  createHref(path): string;
37
37
  ```
38
38
 
39
- Defined in: [create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L38)
39
+ Defined in: [create-browser-history.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L38)
40
40
 
41
41
  Create href from path
42
42
 
@@ -58,7 +58,7 @@ Create href from path
58
58
  destroy(): void;
59
59
  ```
60
60
 
61
- Defined in: [create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L47)
61
+ Defined in: [create-browser-history.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L47)
62
62
 
63
63
  Cleanup.
64
64
 
@@ -78,7 +78,7 @@ wrapper is destroyed.
78
78
  forward(): void;
79
79
  ```
80
80
 
81
- Defined in: [create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L27)
81
+ Defined in: [create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L27)
82
82
 
83
83
  #### Returns
84
84
 
@@ -92,7 +92,7 @@ Defined in: [create-browser-history.ts:27](https://gitlab.com/xmachin-es/xmachin
92
92
  go(delta): void;
93
93
  ```
94
94
 
95
- Defined in: [create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L25)
95
+ Defined in: [create-browser-history.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L25)
96
96
 
97
97
  Go back/forward
98
98
 
@@ -114,7 +114,7 @@ Go back/forward
114
114
  push(path, state?): void;
115
115
  ```
116
116
 
117
- Defined in: [create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L15)
117
+ Defined in: [create-browser-history.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L15)
118
118
 
119
119
  Push new URL to history
120
120
 
@@ -137,7 +137,7 @@ Push new URL to history
137
137
  replace(path, state?): void;
138
138
  ```
139
139
 
140
- Defined in: [create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L20)
140
+ Defined in: [create-browser-history.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L20)
141
141
 
142
142
  Replace current URL in history
143
143
 
@@ -160,7 +160,7 @@ Replace current URL in history
160
160
  subscribe(listener): () => void;
161
161
  ```
162
162
 
163
- Defined in: [create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L33)
163
+ Defined in: [create-browser-history.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L33)
164
164
 
165
165
  Subscribe to history changes
166
166
  Returns unsubscribe function
package/api/@xmachines/play-router/interfaces/BrowserWindow.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BrowserWindow
4
4
 
5
- Defined in: [create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L59)
5
+ Defined in: [create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L59)
6
6
 
7
7
  Minimal window interface for createBrowserHistory
8
8
 
@@ -14,17 +14,17 @@ Avoids coupling to `Window & typeof globalThis` which varies across environments
14
14
 
15
15
  | Property | Modifier | Type | Defined in |
16
16
  | ----------------------------------------- | ---------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
17
- | <a id="property-history"></a> `history` | `public` | `object` | [create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L60) |
18
- | `history.state` | `readonly` | `unknown` | [create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L61) |
19
- | `history.back` | `public` | `void` | [create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L65) |
20
- | `history.forward` | `public` | `void` | [create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L66) |
21
- | `history.go` | `public` | `void` | [create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L64) |
22
- | `history.pushState` | `public` | `void` | [create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L62) |
23
- | `history.replaceState` | `public` | `void` | [create-browser-history.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L63) |
24
- | <a id="property-location"></a> `location` | `public` | `object` | [create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L68) |
25
- | `location.hash` | `readonly` | `string` | [create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L71) |
26
- | `location.pathname` | `readonly` | `string` | [create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L69) |
27
- | `location.search` | `readonly` | `string` | [create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L70) |
17
+ | <a id="property-history"></a> `history` | `public` | `object` | [create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L60) |
18
+ | `history.state` | `readonly` | `unknown` | [create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L61) |
19
+ | `history.back` | `public` | `void` | [create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L65) |
20
+ | `history.forward` | `public` | `void` | [create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L66) |
21
+ | `history.go` | `public` | `void` | [create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L64) |
22
+ | `history.pushState` | `public` | `void` | [create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L62) |
23
+ | `history.replaceState` | `public` | `void` | [create-browser-history.ts:63](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L63) |
24
+ | <a id="property-location"></a> `location` | `public` | `object` | [create-browser-history.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L68) |
25
+ | `location.hash` | `readonly` | `string` | [create-browser-history.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L71) |
26
+ | `location.pathname` | `readonly` | `string` | [create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L69) |
27
+ | `location.search` | `readonly` | `string` | [create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L70) |
28
28
 
29
29
  ## Methods
30
30
 
@@ -34,7 +34,7 @@ Avoids coupling to `Window & typeof globalThis` which varies across environments
34
34
  addEventListener(type, listener): void;
35
35
  ```
36
36
 
37
- Defined in: [create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L73)
37
+ Defined in: [create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L73)
38
38
 
39
39
  #### Parameters
40
40
 
@@ -55,7 +55,7 @@ Defined in: [create-browser-history.ts:73](https://gitlab.com/xmachin-es/xmachin
55
55
  removeEventListener(type, listener): void;
56
56
  ```
57
57
 
58
- Defined in: [create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/create-browser-history.ts#L74)
58
+ Defined in: [create-browser-history.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/create-browser-history.ts#L74)
59
59
 
60
60
  #### Parameters
61
61
 
package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md CHANGED
@@ -2,12 +2,12 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/connect-router.ts#L8)
5
+ Defined in: [connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/connect-router.ts#L8)
6
6
 
7
7
  ## Properties
8
8
 
9
9
  | Property | Type | Defined in |
10
10
  | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | [connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/connect-router.ts#L9) |
12
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](RouteMap.md) | [connect-router.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/connect-router.ts#L11) |
13
- | <a id="property-router"></a> `router` | [`VanillaRouter`](VanillaRouter.md) | [connect-router.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/connect-router.ts#L10) |
11
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | [connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/connect-router.ts#L9) |
12
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](RouteMap.md) | [connect-router.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/connect-router.ts#L11) |
13
+ | <a id="property-router"></a> `router` | [`VanillaRouter`](VanillaRouter.md) | [connect-router.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/connect-router.ts#L10) |
package/api/@xmachines/play-router/interfaces/MachineEdgeData.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: MachineEdgeData
4
4
 
5
- Defined in: [types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L22)
5
+ Defined in: [types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/types.ts#L22)
6
6
 
7
7
  Data attached to each edge in the machine graph representation.
8
8
  Captures transition event and guard information.
@@ -11,5 +11,5 @@ Captures transition event and guard information.
11
11
 
12
12
  | Property | Type | Description | Defined in |
13
13
  | -------------------------------------------- | -------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
14
- | <a id="property-eventtype"></a> `eventType` | `string` | The event type that triggers this transition | [types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L24) |
15
- | <a id="property-guardtype"></a> `guardType?` | `string` | String representation of guard (if any) | [types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L26) |
14
+ | <a id="property-eventtype"></a> `eventType` | `string` | The event type that triggers this transition | [types.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/types.ts#L24) |
15
+ | <a id="property-guardtype"></a> `guardType?` | `string` | String representation of guard (if any) | [types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/types.ts#L26) |
package/api/@xmachines/play-router/interfaces/MachineNodeData.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: MachineNodeData
4
4
 
5
- Defined in: [types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L7)
5
+ Defined in: [types.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/types.ts#L7)
6
6
 
7
7
  Data attached to each node in the machine graph representation.
8
8
  Captures the essential state metadata needed for route extraction and queries.
@@ -11,7 +11,7 @@ Captures the essential state metadata needed for route extraction and queries.
11
11
 
12
12
  | Property | Type | Description | Defined in |
13
13
  | --------------------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
14
- | <a id="property-meta"></a> `meta?` | `Record`\<`string`, `unknown`\> | Original state meta object | [types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L13) |
15
- | <a id="property-route"></a> `route?` | `string` | Extracted route path from meta.route (string form) | [types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L15) |
16
- | <a id="property-stateid"></a> `stateId` | `string` | XState state ID (e.g., "test.dashboard.overview") | [types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L9) |
17
- | <a id="property-type"></a> `type` | `"atomic"` \| `"compound"` \| `"parallel"` \| `"final"` \| `"history"` | State type from XState | [types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.19/packages/play-router/src/types.ts#L11) |
14
+ | <a id="property-meta"></a> `meta?` | `Record`\<`string`, `unknown`\> | Original state meta object | [types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/types.ts#L13) |
15
+ | <a id="property-route"></a> `route?` | `string` | Extracted route path from meta.route (string form) | [types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/types.ts#L15) |
16
+ | <a id="property-stateid"></a> `stateId` | `string` | XState state ID (e.g., "test.dashboard.overview") | [types.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/types.ts#L9) |
17
+ | <a id="property-type"></a> `type` | `"atomic"` \| `"compound"` \| `"parallel"` \| `"final"` \| `"history"` | State type from XState | [types.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.21/packages/play-router/src/types.ts#L11) |