@xmachines/docs 1.0.0-beta.14 → 1.0.0-beta.16

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 (152) hide show
  1. package/api/@xmachines/play/type-aliases/PlayEvent.md +4 -4
  2. package/api/@xmachines/play-actor/classes/AbstractActor.md +50 -39
  3. package/api/@xmachines/play-actor/interfaces/Routable.md +4 -4
  4. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +5 -5
  5. package/api/@xmachines/play-actor/interfaces/Viewable.md +5 -5
  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 +12 -38
  13. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  14. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +6 -6
  15. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +5 -5
  16. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +6 -6
  17. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  18. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  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 +7 -7
  23. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +5 -5
  24. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  25. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +34 -28
  26. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  27. package/api/@xmachines/play-router/functions/connectRouter.md +1 -1
  28. package/api/@xmachines/play-router/functions/crawlMachine.md +1 -1
  29. package/api/@xmachines/play-router/functions/createBrowserHistory.md +1 -1
  30. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  31. package/api/@xmachines/play-router/functions/createRouter.md +1 -1
  32. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  33. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  34. package/api/@xmachines/play-router/functions/extractRoute.md +1 -1
  35. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  36. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  37. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  38. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  39. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  40. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  41. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  42. package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +5 -5
  43. package/api/@xmachines/play-router/interfaces/BrowserHistory.md +16 -16
  44. package/api/@xmachines/play-router/interfaces/BrowserWindow.md +16 -16
  45. package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +6 -6
  46. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +8 -8
  47. package/api/@xmachines/play-router/interfaces/RouteInfo.md +10 -10
  48. package/api/@xmachines/play-router/interfaces/RouteMap.md +6 -6
  49. package/api/@xmachines/play-router/interfaces/RouteNode.md +12 -12
  50. package/api/@xmachines/play-router/interfaces/RouteObject.md +4 -4
  51. package/api/@xmachines/play-router/interfaces/RouteTree.md +6 -6
  52. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  53. package/api/@xmachines/play-router/interfaces/StateVisit.md +6 -6
  54. package/api/@xmachines/play-router/interfaces/VanillaRouter.md +6 -6
  55. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  56. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +4 -4
  57. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  58. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +4 -4
  59. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  60. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  61. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -9
  62. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +3 -11
  63. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +5 -7
  64. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +3 -13
  65. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +0 -2
  66. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +0 -2
  67. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +0 -2
  68. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +0 -2
  69. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +0 -2
  70. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +0 -2
  71. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +0 -2
  72. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +0 -2
  73. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +0 -2
  74. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +0 -2
  75. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +0 -2
  76. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  77. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +6 -6
  78. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  79. package/api/@xmachines/play-solid-router/classes/RouteMap.md +1 -1
  80. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  81. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  82. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  83. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +48 -35
  84. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  85. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +5 -5
  86. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  87. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  88. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +1 -1
  89. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +6 -6
  90. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  91. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  92. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  93. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  94. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +7 -7
  95. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +5 -5
  96. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +5 -5
  97. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  98. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  99. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +1 -1
  100. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +7 -7
  101. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  102. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  103. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +7 -7
  104. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +5 -5
  105. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  106. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  107. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  108. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  109. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  110. package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
  111. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +5 -5
  112. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +11 -11
  113. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  114. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +6 -6
  115. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  116. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  117. package/api/@xmachines/play-xstate/README.md +19 -1
  118. package/api/@xmachines/play-xstate/classes/PlayerActor.md +65 -46
  119. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  120. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  121. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  122. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  123. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  124. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  125. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  126. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  127. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  128. package/api/@xmachines/play-xstate/functions/mergeViewProps.md +1 -1
  129. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  130. package/api/@xmachines/play-xstate/functions/stateMatches.md +1 -1
  131. package/api/@xmachines/play-xstate/functions/validateComponentBinding.md +1 -1
  132. package/api/@xmachines/play-xstate/functions/validateViewProps.md +2 -2
  133. package/api/@xmachines/play-xstate/interfaces/CatalogEntry.md +5 -5
  134. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +6 -6
  135. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +22 -0
  136. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +9 -9
  137. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +7 -7
  138. package/api/@xmachines/play-xstate/type-aliases/Catalog.md +1 -1
  139. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  140. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  141. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  142. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +6 -5
  143. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  144. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  145. package/api/@xmachines/play-xstate/type-aliases/ValidationResult.md +1 -1
  146. package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md +3 -3
  147. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +4 -4
  148. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  149. package/examples/README.md +20 -6
  150. package/examples/multi-router-integration.md +2 -5
  151. package/examples/routing-patterns.md +2 -3
  152. package/package.json +3 -3
package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md CHANGED
@@ -2,14 +2,14 @@
2
2
 
3
3
  # Interface: PlayErrorBoundaryProps
4
4
 
5
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L14)
5
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayErrorBoundary.tsx#L14)
6
6
 
7
7
  Props for PlayErrorBoundary
8
8
 
9
9
  ## Properties
10
10
 
11
- | Property | Type | Description | Defined in |
12
- | ------------------------------------------ | --------------------------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-children"></a> `children` | `ReactNode` | Child components to render | [packages/play-react/src/PlayErrorBoundary.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L18) |
14
- | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Fallback UI to render when a child component throws. Defaults to null. | [packages/play-react/src/PlayErrorBoundary.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L16) |
15
- | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback — forwards errors to observability tools (Sentry, etc.) | [packages/play-react/src/PlayErrorBoundary.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
11
+ | Property | Type | Description | Defined in |
12
+ | ------------------------------------------ | --------------------------- | --------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
+ | <a id="property-children"></a> `children` | `ReactNode` | Child components to render | [packages/play-react/src/PlayErrorBoundary.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayErrorBoundary.tsx#L18) |
14
+ | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Fallback UI to render when a child component throws. Defaults to null. | [packages/play-react/src/PlayErrorBoundary.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayErrorBoundary.tsx#L16) |
15
+ | <a id="property-onerror"></a> `onError?` | (`error`, `info`) => `void` | Optional error handler callback — forwards errors to observability tools (Sentry, etc.) | [packages/play-react/src/PlayErrorBoundary.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md CHANGED
@@ -2,13 +2,13 @@
2
2
 
3
3
  # Interface: PlayErrorBoundaryState
4
4
 
5
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L28)
5
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayErrorBoundary.tsx#L28)
6
6
 
7
7
  Internal state shape for PlayErrorBoundary
8
8
 
9
9
  ## Properties
10
10
 
11
- | Property | Type | Defined in |
12
- | ----------------------------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
13
- | <a id="property-error"></a> `error` | `Error` \| `null` | [packages/play-react/src/PlayErrorBoundary.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L30) |
14
- | <a id="property-haserror"></a> `hasError` | `boolean` | [packages/play-react/src/PlayErrorBoundary.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L29) |
11
+ | Property | Type | Defined in |
12
+ | ----------------------------------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
+ | <a id="property-error"></a> `error` | `Error` \| `null` | [packages/play-react/src/PlayErrorBoundary.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayErrorBoundary.tsx#L30) |
14
+ | <a id="property-haserror"></a> `hasError` | `boolean` | [packages/play-react/src/PlayErrorBoundary.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayErrorBoundary.tsx#L29) |
package/api/@xmachines/play-react/interfaces/PlayRendererProps.md CHANGED
@@ -2,14 +2,14 @@
2
2
 
3
3
  # Interface: PlayRendererProps
4
4
 
5
- Defined in: [packages/play-react/src/types.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/types.ts#L18)
5
+ Defined in: [packages/play-react/src/types.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/types.ts#L18)
6
6
 
7
7
  Props for PlayRenderer component
8
8
 
9
9
  ## Properties
10
10
 
11
- | Property | Type | Description | Defined in |
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) | [packages/play-react/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/types.ts#L20) |
14
- | <a id="property-components"></a> `components` | `Record`\<`string`, `React.ElementType`\> | Map of component names to React components | [packages/play-react/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/types.ts#L23) |
15
- | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Optional component shown when currentView is null | [packages/play-react/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/types.ts#L26) |
11
+ | Property | Type | Description | Defined in |
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) | [packages/play-react/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/types.ts#L20) |
14
+ | <a id="property-components"></a> `components` | `Record`\<`string`, `React.ElementType`\> | Map of component names to React components | [packages/play-react/src/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/types.ts#L23) |
15
+ | <a id="property-fallback"></a> `fallback?` | `ReactNode` | Optional component shown when currentView is null | [packages/play-react/src/types.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/types.ts#L26) |
package/api/@xmachines/play-react/variables/PlayRenderer.md CHANGED
@@ -6,7 +6,7 @@
6
6
  const PlayRenderer: React.FC<PlayRendererProps>;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/PlayRenderer.tsx:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayRenderer.tsx#L61)
9
+ Defined in: [packages/play-react/src/PlayRenderer.tsx:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react/src/PlayRenderer.tsx#L61)
10
10
 
11
11
  Main renderer component that subscribes to actor signals and renders UI
12
12
 
package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: ReactRouterBridge
4
4
 
5
- Defined in: [play-react-router/src/react-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/react-router-bridge.ts#L28)
5
+ Defined in: [play-react-router/src/react-router-bridge.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/react-router-bridge.ts#L28)
6
6
 
7
7
  Abstract base class for all `@xmachines` router adapter bridges.
8
8
 
@@ -25,13 +25,13 @@ new ReactRouterBridge(
25
25
  routeMap): ReactRouterBridge;
26
26
  ```
27
27
 
28
- Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/react-router-bridge.ts#L31)
28
+ Defined in: [play-react-router/src/react-router-bridge.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/react-router-bridge.ts#L31)
29
29
 
30
30
  #### Parameters
31
31
 
32
32
  | Parameter | Type |
33
33
  | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
34
- | `router` | `Router$1` |
34
+ | `router` | `Router` |
35
35
  | `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) |
36
36
  | `routeMap` | [`RouteMap`](RouteMap.md) |
37
37
 
@@ -172,7 +172,7 @@ Extracted query parameters or empty object
172
172
  protected getInitialRouterPath(): string | null;
173
173
  ```
174
174
 
175
- Defined in: [play-react-router/src/react-router-bridge.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/react-router-bridge.ts#L49)
175
+ Defined in: [play-react-router/src/react-router-bridge.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/react-router-bridge.ts#L49)
176
176
 
177
177
  Return the router's current pathname so connect() can sync the actor to
178
178
  the URL on initial load. router.subscribe() only fires on future navigations
@@ -195,7 +195,7 @@ the page on /about would leave the actor in its default "home" state.
195
195
  protected navigateRouter(path): void;
196
196
  ```
197
197
 
198
- Defined in: [play-react-router/src/react-router-bridge.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/react-router-bridge.ts#L39)
198
+ Defined in: [play-react-router/src/react-router-bridge.ts:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/react-router-bridge.ts#L39)
199
199
 
200
200
  Navigate the framework router to the given path.
201
201
 
@@ -283,7 +283,7 @@ Prevents circular updates via isProcessingNavigation flag.
283
283
  protected unwatchRouterChanges(): void;
284
284
  ```
285
285
 
286
- Defined in: [play-react-router/src/react-router-bridge.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/react-router-bridge.ts#L59)
286
+ Defined in: [play-react-router/src/react-router-bridge.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/react-router-bridge.ts#L59)
287
287
 
288
288
  Stop watching for router location changes.
289
289
 
@@ -305,7 +305,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
305
305
  protected watchRouterChanges(): void;
306
306
  ```
307
307
 
308
- Defined in: [play-react-router/src/react-router-bridge.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/react-router-bridge.ts#L53)
308
+ Defined in: [play-react-router/src/react-router-bridge.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/react-router-bridge.ts#L53)
309
309
 
310
310
  Start watching for router location changes.
311
311
 
package/api/@xmachines/play-react-router/classes/RouteMap.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-react-router/src/route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/route-map.ts#L54)
5
+ Defined in: [play-react-router/src/route-map.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/route-map.ts#L54)
6
6
 
7
7
  Bidirectional route mapper for React Router.
8
8
 
package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function PlayRouterProvider(__namedParameters): Element;
7
7
  ```
8
8
 
9
- Defined in: [play-react-router/src/play-router-provider.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/play-router-provider.tsx#L20)
9
+ Defined in: [play-react-router/src/play-router-provider.tsx:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/play-router-provider.tsx#L20)
10
10
 
11
11
  ## Parameters
12
12
 
package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouteMapFromTree(routeTree): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [play-react-router/src/route-map.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/route-map.ts#L73)
9
+ Defined in: [play-react-router/src/route-map.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/route-map.ts#L73)
10
10
 
11
11
  Create RouteMap from RouteTree
12
12
 
package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md CHANGED
@@ -2,13 +2,13 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps
4
4
 
5
- Defined in: [play-react-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/play-router-provider.tsx#L10)
5
+ Defined in: [play-react-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/play-router-provider.tsx#L10)
6
6
 
7
7
  ## Properties
8
8
 
9
- | Property | Type | Defined in |
10
- | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) & [`Viewable`](../../play-actor/interfaces/Viewable.md) | [play-react-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/play-router-provider.tsx#L11) |
12
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode` | [play-react-router/src/play-router-provider.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/play-router-provider.tsx#L14) |
13
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | [play-react-router/src/play-router-provider.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/play-router-provider.tsx#L13) |
14
- | <a id="property-router"></a> `router` | `Router$1` | [play-react-router/src/play-router-provider.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/play-router-provider.tsx#L12) |
9
+ | Property | Type | Defined in |
10
+ | ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
11
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) & [`Viewable`](../../play-actor/interfaces/Viewable.md) | [play-react-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/play-router-provider.tsx#L11) |
12
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `ReactNode` | [play-react-router/src/play-router-provider.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/play-router-provider.tsx#L14) |
13
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | [play-react-router/src/play-router-provider.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/play-router-provider.tsx#L13) |
14
+ | <a id="property-router"></a> `router` | `Router` | [play-react-router/src/play-router-provider.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/play-router-provider.tsx#L12) |
package/api/@xmachines/play-react-router/interfaces/RouteMapping.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [play-react-router/src/route-map.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/route-map.ts#L22)
5
+ Defined in: [play-react-router/src/route-map.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/route-map.ts#L22)
6
6
 
7
7
  Mapping between state machine state ID and router path.
8
8
 
@@ -11,7 +11,7 @@ Fields are `readonly` — entries are immutable once passed to `RouteMap`.
11
11
 
12
12
  ## Properties
13
13
 
14
- | Property | Modifier | Type | Description | Defined in |
15
- | --------------------------------------- | ---------- | -------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16
- | <a id="property-path"></a> `path` | `readonly` | `string` | Router path with optional parameters (e.g., `"/settings/:section?"`) | [play-react-router/src/route-map.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/route-map.ts#L26) |
17
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State ID from state machine (e.g., `"home"`, `"settings.profile"`) | [play-react-router/src/route-map.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/route-map.ts#L24) |
14
+ | Property | Modifier | Type | Description | Defined in |
15
+ | --------------------------------------- | ---------- | -------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
16
+ | <a id="property-path"></a> `path` | `readonly` | `string` | Router path with optional parameters (e.g., `"/settings/:section?"`) | [play-react-router/src/route-map.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/route-map.ts#L26) |
17
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State ID from state machine (e.g., `"home"`, `"settings.profile"`) | [play-react-router/src/route-map.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-react-router/src/route-map.ts#L24) |
package/api/@xmachines/play-router/classes/BaseRouteMap.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: BaseRouteMap
4
4
 
5
- Defined in: [base-route-map.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/base-route-map.ts#L70)
5
+ Defined in: [base-route-map.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/base-route-map.ts#L70)
6
6
 
7
7
  Shared bidirectional route map base class.
8
8
 
@@ -57,7 +57,7 @@ map.getPathByStateId("missing"); // null
57
57
  new BaseRouteMap(mappings): BaseRouteMap;
58
58
  ```
59
59
 
60
- Defined in: [base-route-map.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/base-route-map.ts#L86)
60
+ Defined in: [base-route-map.ts:86](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/base-route-map.ts#L86)
61
61
 
62
62
  Build a route map from an array of state ID ↔ path mappings.
63
63
 
@@ -83,7 +83,7 @@ buckets for efficient candidate selection.
83
83
  getPathByStateId(stateId): string | null;
84
84
  ```
85
85
 
86
- Defined in: [base-route-map.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/base-route-map.ts#L164)
86
+ Defined in: [base-route-map.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/base-route-map.ts#L164)
87
87
 
88
88
  Look up the path pattern registered for a state ID.
89
89
 
@@ -114,7 +114,7 @@ map.getPathByStateId("missing"); // null
114
114
  getStateIdByPath(path): string | null;
115
115
  ```
116
116
 
117
- Defined in: [base-route-map.ts:130](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/base-route-map.ts#L130)
117
+ Defined in: [base-route-map.ts:130](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/base-route-map.ts#L130)
118
118
 
119
119
  Resolve a URL path to its mapped state ID.
120
120
 
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:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L56)
5
+ Defined in: [router-bridge-base.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L56)
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:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L70)
33
+ Defined in: [router-bridge-base.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L70)
34
34
 
35
35
  Constructor receives the 3 things all bridges need.
36
36
 
@@ -49,17 +49,17 @@ Constructor receives the 3 things all bridges need.
49
49
 
50
50
  ## Properties
51
51
 
52
- | Property | Modifier | Type | Default value | Description | Defined in |
53
- | --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
54
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | Actor with currentRoute signal and send method | [router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L71) |
55
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L59) |
56
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L58) |
57
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L61) |
58
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` | `""` | - | [router-bridge-base.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L60) |
59
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for stateId ↔ path resolution | [router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L72) |
60
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [router-bridge-base.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L74) |
61
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L73) |
62
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`Watcher`](../../play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md) \| `null` | `null` | - | [router-bridge-base.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L62) |
52
+ | Property | Modifier | Type | Default value | Description | Defined in |
53
+ | --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
54
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | Actor with currentRoute signal and send method | [router-bridge-base.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L71) |
55
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L59) |
56
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L58) |
57
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [router-bridge-base.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L61) |
58
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` | `""` | - | [router-bridge-base.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L60) |
59
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for stateId ↔ path resolution | [router-bridge-base.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L72) |
60
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [router-bridge-base.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L74) |
61
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | [router-bridge-base.ts:73](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L73) |
62
+ | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`Watcher`](../../play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md) \| `null` | `null` | - | [router-bridge-base.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L62) |
63
63
 
64
64
  ## Methods
65
65
 
@@ -69,7 +69,7 @@ Constructor receives the 3 things all bridges need.
69
69
  connect(): void;
70
70
  ```
71
71
 
72
- Defined in: [router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L90)
72
+ Defined in: [router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L90)
73
73
 
74
74
  Connect the router bridge to the Actor.
75
75
 
@@ -92,7 +92,7 @@ starts watching router changes (framework-specific).
92
92
  disconnect(): void;
93
93
  ```
94
94
 
95
- Defined in: [router-bridge-base.ts:140](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L140)
95
+ Defined in: [router-bridge-base.ts:147](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L147)
96
96
 
97
97
  Disconnect the router bridge from the Actor.
98
98
 
@@ -114,7 +114,7 @@ Stops signal watching and unregisters framework-specific router listener.
114
114
  protected extractParams(pathname, stateId): Record<string, string>;
115
115
  ```
116
116
 
117
- Defined in: [router-bridge-base.ts:276](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L276)
117
+ Defined in: [router-bridge-base.ts:283](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L283)
118
118
 
119
119
  Extract path parameters from URL using the URLPattern API.
120
120
 
@@ -144,7 +144,7 @@ Extracted path parameters, or empty object if URLPattern is unavailable or no ma
144
144
  protected extractQuery(search): Record<string, string>;
145
145
  ```
146
146
 
147
- Defined in: [router-bridge-base.ts:303](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L303)
147
+ Defined in: [router-bridge-base.ts:310](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L310)
148
148
 
149
149
  Extract query parameters from URL search string.
150
150
 
@@ -165,12 +165,12 @@ Extracted query parameters or empty object
165
165
  ### getInitialRouterPath()
166
166
 
167
167
  ```ts
168
- protected getInitialRouterPath(): string | null;
168
+ protected getInitialRouterPath(): string | null | undefined;
169
169
  ```
170
170
 
171
- Defined in: [router-bridge-base.ts:353](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L353)
171
+ Defined in: [router-bridge-base.ts:365](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L365)
172
172
 
173
- Return the router's current pathname at connect() time, or null if unavailable.
173
+ Return the router's current pathname at connect() time.
174
174
 
175
175
  Called once during connect() to perform the initial URL → actor sync.
176
176
  router.subscribe() only fires on _future_ navigation events; it does not
@@ -179,12 +179,18 @@ current location synchronously (e.g. `router.state.location.pathname`)
179
179
  should override this method so that deep-link / direct-URL loads drive the
180
180
  actor to the correct state instead of leaving it at its machine default.
181
181
 
182
- The default returns null (no initial router → actor sync), preserving the
183
- previous behaviour for bridges that have not yet implemented this hook.
182
+ Return semantics:
183
+
184
+ - `string` → router has a current path; base connect() will sync actor from router
185
+ - `null` → router is active but has no current path yet; base connect() will sync router from actor
186
+ - `undefined` → adapter handles initial sync itself and base connect() should stay out of the way
187
+
188
+ The default returns `undefined`, preserving the previous behaviour for
189
+ bridges that have not yet implemented this hook.
184
190
 
185
191
  #### Returns
186
192
 
187
- `string` \| `null`
193
+ `string` \| `null` \| `undefined`
188
194
 
189
195
  ---
190
196
 
@@ -194,7 +200,7 @@ previous behaviour for bridges that have not yet implemented this hook.
194
200
  abstract protected navigateRouter(path): void;
195
201
  ```
196
202
 
197
- Defined in: [router-bridge-base.ts:323](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L323)
203
+ Defined in: [router-bridge-base.ts:330](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L330)
198
204
 
199
205
  Navigate the framework router to the given path.
200
206
 
@@ -219,7 +225,7 @@ Must trigger the framework router's navigation (e.g., router.navigate(path)).
219
225
  protected syncActorFromRouter(pathname, search?): void;
220
226
  ```
221
227
 
222
- Defined in: [router-bridge-base.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L187)
228
+ Defined in: [router-bridge-base.ts:194](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L194)
223
229
 
224
230
  Sync actor state when router location changes.
225
231
 
@@ -245,7 +251,7 @@ Prevents circular updates via isProcessingNavigation flag.
245
251
  protected syncRouterFromActor(route): void;
246
252
  ```
247
253
 
248
- Defined in: [router-bridge-base.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L167)
254
+ Defined in: [router-bridge-base.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L174)
249
255
 
250
256
  Sync router location when actor route signal changes.
251
257
 
@@ -270,7 +276,7 @@ Prevents circular updates via isProcessingNavigation flag.
270
276
  abstract protected unwatchRouterChanges(): void;
271
277
  ```
272
278
 
273
- Defined in: [router-bridge-base.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L338)
279
+ Defined in: [router-bridge-base.ts:345](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L345)
274
280
 
275
281
  Stop watching for router location changes.
276
282
 
@@ -288,7 +294,7 @@ Called by disconnect(). Should clean up the framework-specific subscription.
288
294
  abstract protected watchRouterChanges(): void;
289
295
  ```
290
296
 
291
- Defined in: [router-bridge-base.ts:331](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/router-bridge-base.ts#L331)
297
+ Defined in: [router-bridge-base.ts:338](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/router-bridge-base.ts#L338)
292
298
 
293
299
  Start watching for router location changes.
294
300
 
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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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.16/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:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/connect-router.ts#L58)
9
+ Defined in: [connect-router.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/connect-router.ts#L58)
10
10
 
11
11
  Connect vanilla router to actor (pure browser integration).
12
12
 
package/api/@xmachines/play-router/functions/crawlMachine.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function crawlMachine(machine): StateVisit[];
7
7
  ```
8
8
 
9
- Defined in: [crawl-machine.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/crawl-machine.ts#L74)
9
+ Defined in: [crawl-machine.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/crawl-machine.ts#L74)
10
10
 
11
11
  Crawl state machine graph using breadth-first traversal
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:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/create-browser-history.ts#L99)
9
+ Defined in: [create-browser-history.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/create-browser-history.ts#L99)
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:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/create-route-map.ts#L120)
9
+ Defined in: [create-route-map.ts:120](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/create-route-map.ts#L120)
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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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.16/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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.16/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:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/extract-routes.ts#L45)
9
+ Defined in: [extract-routes.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/extract-routes.ts#L45)
10
10
 
11
11
  Extract complete route tree from state machine graph
12
12
 
package/api/@xmachines/play-router/functions/extractRoute.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function extractRoute(node, path, stateMap): RouteInfo | null;
7
7
  ```
8
8
 
9
- Defined in: [extract-route.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/extract-route.ts#L26)
9
+ Defined in: [extract-route.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/extract-route.ts#L26)
10
10
 
11
11
  Extract route information from state node with validation
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: [index.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/index.ts#L69)
9
+ Defined in: [index.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/index.ts#L69)
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: [index.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/index.ts#L161)
9
+ Defined in: [index.ts:161](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/index.ts#L161)
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:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/query.ts#L20)
9
+ Defined in: [query.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/query.ts#L20)
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:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/query.ts#L50)
9
+ Defined in: [query.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.16/packages/play-router/src/query.ts#L50)
10
10
 
11
11
  Get all routable routes from tree as flat array
12
12