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

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 (131) hide show
  1. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  2. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  3. package/api/@xmachines/play-actor/interfaces/Routable.md +2 -2
  4. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  5. package/api/@xmachines/play-actor/interfaces/Viewable.md +3 -3
  6. package/api/@xmachines/play-catalog/functions/defineCatalog.md +1 -1
  7. package/api/@xmachines/play-catalog/functions/defineComponents.md +1 -1
  8. package/api/@xmachines/play-catalog/type-aliases/Catalog.md +1 -1
  9. package/api/@xmachines/play-catalog/type-aliases/ComponentsFor.md +1 -1
  10. package/api/@xmachines/play-catalog/type-aliases/InferComponentProps.md +1 -1
  11. package/api/@xmachines/play-catalog/type-aliases/NoExtraKeys.md +1 -1
  12. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  13. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  14. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  15. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  16. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +4 -4
  17. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  18. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +6 -6
  19. package/api/@xmachines/play-react-router/classes/RouteMap.md +1 -1
  20. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  21. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  22. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  23. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  24. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  25. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +21 -21
  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 +3 -3
  43. package/api/@xmachines/play-router/interfaces/BrowserHistory.md +14 -14
  44. package/api/@xmachines/play-router/interfaces/BrowserWindow.md +14 -14
  45. package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +4 -4
  46. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  47. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  48. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  49. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  50. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  51. package/api/@xmachines/play-router/interfaces/RouteTree.md +4 -4
  52. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  53. package/api/@xmachines/play-router/interfaces/StateVisit.md +4 -4
  54. package/api/@xmachines/play-router/interfaces/VanillaRouter.md +4 -4
  55. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  56. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  57. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  58. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  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/type-aliases/WatcherNotify.md +1 -1
  62. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +4 -4
  63. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  64. package/api/@xmachines/play-solid-router/classes/RouteMap.md +1 -1
  65. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  66. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  67. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  68. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  69. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  70. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  71. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  72. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +1 -1
  73. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +6 -6
  74. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  75. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  76. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  77. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  78. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  79. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  80. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  81. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  82. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  83. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +1 -1
  84. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +7 -7
  85. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  86. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  87. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  88. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  89. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  90. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  91. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  92. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +3 -3
  93. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  94. package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
  95. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +5 -5
  96. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +8 -8
  97. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  98. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  99. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  100. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  101. package/api/@xmachines/play-xstate/classes/PlayerActor.md +11 -11
  102. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  103. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  104. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  105. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  106. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  107. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  108. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  109. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  110. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  111. package/api/@xmachines/play-xstate/functions/mergeViewProps.md +1 -1
  112. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  113. package/api/@xmachines/play-xstate/functions/stateMatches.md +1 -1
  114. package/api/@xmachines/play-xstate/functions/validateComponentBinding.md +1 -1
  115. package/api/@xmachines/play-xstate/functions/validateViewProps.md +2 -2
  116. package/api/@xmachines/play-xstate/interfaces/CatalogEntry.md +3 -3
  117. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +4 -4
  118. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
  119. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  120. package/api/@xmachines/play-xstate/type-aliases/Catalog.md +1 -1
  121. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  122. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  123. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  124. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  125. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  126. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  127. package/api/@xmachines/play-xstate/type-aliases/ValidationResult.md +1 -1
  128. package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md +3 -3
  129. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
  130. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  131. package/package.json +2 -2
package/api/@xmachines/play/type-aliases/PlayEvent.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type PlayEvent<TPayload> = object & TPayload;
7
7
  ```
8
8
 
9
- Defined in: [types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play/src/types.ts#L69)
9
+ Defined in: [types.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play/src/types.ts#L69)
10
10
 
11
11
  Generic event type for Play Architecture
12
12
 
@@ -34,7 +34,7 @@ Robot, and other state machine libraries.
34
34
 
35
35
  | Name | Type | Defined in |
36
36
  | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
37
- | `type` | `string` | [types.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play/src/types.ts#L70) |
37
+ | `type` | `string` | [types.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play/src/types.ts#L70) |
38
38
 
39
39
  ## Type Parameters
40
40
 
package/api/@xmachines/play-actor/classes/AbstractActor.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Class: AbstractActor\<TLogic\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-actor/src/abstract-actor.ts#L187)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:187](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-actor/src/abstract-actor.ts#L187)
6
6
 
7
7
  Abstract base class for Play Architecture actors.
8
8
 
@@ -116,7 +116,7 @@ Actor<TLogic>.constructor
116
116
  | <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | - | `Actor.ref` | node_modules/xstate/dist/declarations/src/createActor.d.ts:34 |
117
117
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | node_modules/xstate/dist/declarations/src/createActor.d.ts:38 |
118
118
  | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | node_modules/xstate/dist/declarations/src/createActor.d.ts:42 |
119
- | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Typed as `Signal.State<unknown>` at the abstract level; concrete implementations narrow this to the actual snapshot type (e.g., `Signal.State<AnyMachineSnapshot>` in `@xmachines/play-xstate`'s `PlayerActor`). Infrastructure observes this signal to react to state changes without directly coupling to the Actor's internal state machine implementation. **Example** `// Infrastructure observes state signal const watcher = new Signal.subtle.Watcher(() => { console.log('Actor state changed:', actor.state.get()); }); watcher.watch(actor.state);` | - | [packages/play-actor/src/abstract-actor.ts:207](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-actor/src/abstract-actor.ts#L207) |
119
+ | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Typed as `Signal.State<unknown>` at the abstract level; concrete implementations narrow this to the actual snapshot type (e.g., `Signal.State<AnyMachineSnapshot>` in `@xmachines/play-xstate`'s `PlayerActor`). Infrastructure observes this signal to react to state changes without directly coupling to the Actor's internal state machine implementation. **Example** `// Infrastructure observes state signal const watcher = new Signal.subtle.Watcher(() => { console.log('Actor state changed:', actor.state.get()); }); watcher.watch(actor.state);` | - | [packages/play-actor/src/abstract-actor.ts:207](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-actor/src/abstract-actor.ts#L207) |
120
120
  | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | node_modules/xstate/dist/declarations/src/createActor.d.ts:40 |
121
121
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | node_modules/xstate/dist/declarations/src/createActor.d.ts:36 |
122
122
 
@@ -254,7 +254,7 @@ Actor.on;
254
254
  abstract send(event): void;
255
255
  ```
256
256
 
257
- Defined in: [packages/play-actor/src/abstract-actor.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-actor/src/abstract-actor.ts#L231)
257
+ Defined in: [packages/play-actor/src/abstract-actor.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-actor/src/abstract-actor.ts#L231)
258
258
 
259
259
  Send event to Actor
260
260
 
package/api/@xmachines/play-actor/interfaces/Routable.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: Routable
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-actor/src/abstract-actor.ts#L41)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-actor/src/abstract-actor.ts#L41)
6
6
 
7
7
  Optional capability: Routing support
8
8
 
@@ -26,4 +26,4 @@ function connectRouter<T extends AbstractActor & Routable>(actor: T) {
26
26
 
27
27
  | Property | Modifier | Type | Description | Defined in |
28
28
  | ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
29
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | Current route signal Computed signal derived from state machine. Infrastructure observes to sync browser URL. Invariant: Passive Infrastructure - Infrastructure reflects route, never decides. **Example** `const watcher = new Signal.subtle.Watcher(() => { const route = actor.currentRoute.get(); console.log('Route changed:', route); }); watcher.watch(actor.currentRoute);` | [packages/play-actor/src/abstract-actor.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-actor/src/abstract-actor.ts#L58) |
29
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | Current route signal Computed signal derived from state machine. Infrastructure observes to sync browser URL. Invariant: Passive Infrastructure - Infrastructure reflects route, never decides. **Example** `const watcher = new Signal.subtle.Watcher(() => { const route = actor.currentRoute.get(); console.log('Route changed:', route); }); watcher.watch(actor.currentRoute);` | [packages/play-actor/src/abstract-actor.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-actor/src/abstract-actor.ts#L58) |
package/api/@xmachines/play-actor/interfaces/ViewMetadata.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ViewMetadata
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-actor/src/abstract-actor.ts#L87)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:87](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-actor/src/abstract-actor.ts#L87)
6
6
 
7
7
  View metadata for rendering
8
8
 
@@ -13,5 +13,5 @@ Used by PlayRenderer to dynamically render UI based on actor state.
13
13
 
14
14
  | Property | Type | Description | Defined in |
15
15
  | ------------------------------------------- | ------------------------------- | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
16
- | <a id="property-component"></a> `component` | `string` | Name of the component to render from the catalog | [packages/play-actor/src/abstract-actor.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-actor/src/abstract-actor.ts#L89) |
17
- | <a id="property-props"></a> `props` | `Record`\<`string`, `unknown`\> | Props to pass to the component | [packages/play-actor/src/abstract-actor.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-actor/src/abstract-actor.ts#L91) |
16
+ | <a id="property-component"></a> `component` | `string` | Name of the component to render from the catalog | [packages/play-actor/src/abstract-actor.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-actor/src/abstract-actor.ts#L89) |
17
+ | <a id="property-props"></a> `props` | `Record`\<`string`, `unknown`\> | Props to pass to the component | [packages/play-actor/src/abstract-actor.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-actor/src/abstract-actor.ts#L91) |
package/api/@xmachines/play-actor/interfaces/Viewable.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: Viewable
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-actor/src/abstract-actor.ts#L102)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-actor/src/abstract-actor.ts#L102)
6
6
 
7
7
  Actor capability for exposing renderable view state.
8
8
 
@@ -15,5 +15,5 @@ framework adapter.
15
15
 
16
16
  | Property | Modifier | Type | Description | Defined in |
17
17
  | ----------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
18
- | <a id="property-catalog"></a> `catalog` | `readonly` | `Record`\<`string`, `unknown`\> | Component catalog for view resolution Maps component names to actual component implementations. Used by renderers to resolve view.component to actual UI components. | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-actor/src/abstract-actor.ts#L127) |
19
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](ViewMetadata.md) \| `null`\> | Current view signal State signal containing UI structure schema from meta.view. Infrastructure renders view. Invariant: Logic-Driven UI - View structure is defined by business logic, not JSX. **Example** `const watcher = new Signal.subtle.Watcher(() => { const view = actor.currentView.get(); console.log('View changed:', view); }); watcher.watch(actor.currentView);` | [packages/play-actor/src/abstract-actor.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-actor/src/abstract-actor.ts#L119) |
18
+ | <a id="property-catalog"></a> `catalog` | `readonly` | `Record`\<`string`, `unknown`\> | Component catalog for view resolution Maps component names to actual component implementations. Used by renderers to resolve view.component to actual UI components. | [packages/play-actor/src/abstract-actor.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-actor/src/abstract-actor.ts#L127) |
19
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`ViewMetadata`](ViewMetadata.md) \| `null`\> | Current view signal State signal containing UI structure schema from meta.view. Infrastructure renders view. Invariant: Logic-Driven UI - View structure is defined by business logic, not JSX. **Example** `const watcher = new Signal.subtle.Watcher(() => { const view = actor.currentView.get(); console.log('View changed:', view); }); watcher.watch(actor.currentView);` | [packages/play-actor/src/abstract-actor.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-actor/src/abstract-actor.ts#L119) |
package/api/@xmachines/play-catalog/functions/defineCatalog.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function defineCatalog<TCatalog>(schemas): TCatalog;
7
7
  ```
8
8
 
9
- Defined in: [define-catalog.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-catalog/src/define-catalog.ts#L74)
9
+ Defined in: [define-catalog.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-catalog/src/define-catalog.ts#L74)
10
10
 
11
11
  Define component catalog with Zod schemas for type-safe UI projection
12
12
 
package/api/@xmachines/play-catalog/functions/defineComponents.md CHANGED
@@ -9,7 +9,7 @@ function defineComponents<TCatalog, TComponents>(
9
9
  ): NoExtraKeys<TComponents, TCatalog>;
10
10
  ```
11
11
 
12
- Defined in: [define-components.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-catalog/src/define-components.ts#L116)
12
+ Defined in: [define-components.ts:116](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-catalog/src/define-components.ts#L116)
13
13
 
14
14
  Define components matching catalog schema with compile-time validation
15
15
 
package/api/@xmachines/play-catalog/type-aliases/Catalog.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type Catalog<TCatalog> = TCatalog;
7
7
  ```
8
8
 
9
- Defined in: [types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-catalog/src/types.ts#L35)
9
+ Defined in: [types.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-catalog/src/types.ts#L35)
10
10
 
11
11
  Component catalog mapping component names to Zod prop schemas
12
12
 
package/api/@xmachines/play-catalog/type-aliases/ComponentsFor.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type ComponentsFor<TCatalog> = { [K in keyof TCatalog]: unknown };
7
7
  ```
8
8
 
9
- Defined in: [define-components.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-catalog/src/define-components.ts#L10)
9
+ Defined in: [define-components.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-catalog/src/define-components.ts#L10)
10
10
 
11
11
  Component map type enforcing catalog keys
12
12
 
package/api/@xmachines/play-catalog/type-aliases/InferComponentProps.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type InferComponentProps<TCatalog, TKey> = z.infer<TCatalog[TKey]>;
7
7
  ```
8
8
 
9
- Defined in: [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-catalog/src/types.ts#L84)
9
+ Defined in: [types.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-catalog/src/types.ts#L84)
10
10
 
11
11
  Infer component prop types from catalog entry
12
12
 
package/api/@xmachines/play-catalog/type-aliases/NoExtraKeys.md CHANGED
@@ -7,7 +7,7 @@ type NoExtraKeys<TComponents, TCatalog> = TComponents &
7
7
  Record<Exclude<keyof TComponents, keyof TCatalog>, never>;
8
8
  ```
9
9
 
10
- Defined in: [define-components.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-catalog/src/define-components.ts#L14)
10
+ Defined in: [define-components.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-catalog/src/define-components.ts#L14)
11
11
 
12
12
  ## Type Parameters
13
13
 
package/api/@xmachines/play-react/classes/PlayErrorBoundary.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: PlayErrorBoundary
4
4
 
5
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-react/src/PlayErrorBoundary.tsx#L49)
5
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L49)
6
6
 
7
7
  React class component error boundary for catching catalog component render errors.
8
8
 
@@ -32,7 +32,7 @@ Per CONS-14: Class component pattern works with all React versions (18 and 19).
32
32
  new PlayErrorBoundary(props): PlayErrorBoundary;
33
33
  ```
34
34
 
35
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-react/src/PlayErrorBoundary.tsx#L53)
35
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L53)
36
36
 
37
37
  #### Parameters
38
38
 
@@ -71,7 +71,7 @@ React.Component<
71
71
  componentDidCatch(error, info): void;
72
72
  ```
73
73
 
74
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-react/src/PlayErrorBoundary.tsx#L62)
74
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L62)
75
75
 
76
76
  Catches exceptions generated in descendant components. Unhandled exceptions will cause
77
77
  the entire component tree to unmount.
@@ -371,7 +371,7 @@ React.Component.getSnapshotBeforeUpdate;
371
371
  render(): ReactNode;
372
372
  ```
373
373
 
374
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-react/src/PlayErrorBoundary.tsx#L67)
374
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L67)
375
375
 
376
376
  #### Returns
377
377
 
@@ -600,7 +600,7 @@ React.Component.UNSAFE_componentWillUpdate;
600
600
  static getDerivedStateFromError(error): PlayErrorBoundaryState;
601
601
  ```
602
602
 
603
- Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-react/src/PlayErrorBoundary.tsx#L58)
603
+ Defined in: [packages/play-react/src/PlayErrorBoundary.tsx:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L58)
604
604
 
605
605
  #### Parameters
606
606
 
package/api/@xmachines/play-react/functions/useSignalEffect.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function useSignalEffect(callback): void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-react/src/useSignalEffect.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-react/src/useSignalEffect.ts#L65)
9
+ Defined in: [packages/play-react/src/useSignalEffect.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/useSignalEffect.ts#L65)
10
10
 
11
11
  React hook that subscribes to signal changes and runs effect callback
12
12
 
package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md CHANGED
@@ -2,7 +2,7 @@
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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L14)
6
6
 
7
7
  Props for PlayErrorBoundary
8
8
 
@@ -10,6 +10,6 @@ Props for PlayErrorBoundary
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/packages/play-react/src/PlayErrorBoundary.tsx#L20) |
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) |
package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md CHANGED
@@ -2,7 +2,7 @@
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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/PlayErrorBoundary.tsx#L28)
6
6
 
7
7
  Internal state shape for PlayErrorBoundary
8
8
 
@@ -10,5 +10,5 @@ Internal state shape for PlayErrorBoundary
10
10
 
11
11
  | Property | Type | Defined in |
12
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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/packages/play-react/src/PlayErrorBoundary.tsx#L29) |
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) |
package/api/@xmachines/play-react/interfaces/PlayRendererProps.md CHANGED
@@ -2,7 +2,7 @@
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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react/src/types.ts#L18)
6
6
 
7
7
  Props for PlayRenderer component
8
8
 
@@ -10,6 +10,6 @@ Props for PlayRenderer component
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [packages/play-react/src/types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/packages/play-react/src/types.ts#L26) |
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) |
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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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,7 +25,7 @@ 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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/react-router-bridge.ts#L31)
29
29
 
30
30
  #### Parameters
31
31
 
@@ -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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/play-router-provider.tsx#L10)
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)\> & [`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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/packages/play-react-router/src/play-router-provider.tsx#L12) |
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) |
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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-react-router/src/route-map.ts#L22)
6
6
 
7
7
  Mapping between state machine state ID and router path.
8
8
 
@@ -13,5 +13,5 @@ Fields are `readonly` — entries are immutable once passed to `RouteMap`.
13
13
 
14
14
  | Property | Modifier | Type | Description | Defined in |
15
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/dc729bb39810dbc25648ddd9203782369c467996/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/dc729bb39810dbc25648ddd9203782369c467996/packages/play-react-router/src/route-map.ts#L24) |
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) |
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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/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/dc729bb39810dbc25648ddd9203782369c467996/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/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-router/src/base-route-map.ts#L130)
118
118
 
119
119
  Resolve a URL path to its mapped state ID.
120
120