@xmachines/docs 1.0.0-beta.24 → 1.0.0-beta.25

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 (194) hide show
  1. package/api/@xmachines/play/classes/PlayError.md +4 -4
  2. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  3. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  4. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  5. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  6. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  7. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  8. package/api/@xmachines/play-dom/classes/PlayRenderer.md +4 -4
  9. package/api/@xmachines/play-dom/functions/connectRenderer.md +1 -1
  10. package/api/@xmachines/play-dom/functions/renderSpec.md +1 -1
  11. package/api/@xmachines/play-dom/interfaces/ConnectRendererOptions.md +7 -7
  12. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +7 -7
  13. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +3 -3
  14. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  15. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  16. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  17. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  18. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  19. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  20. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  21. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  22. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  23. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  24. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  25. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  26. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  27. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  28. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +7 -7
  29. package/api/@xmachines/play-react/type-aliases/PlayActor.md +1 -1
  30. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  31. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +21 -21
  32. package/api/@xmachines/play-react-router/classes/RouteMap.md +4 -4
  33. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  34. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  35. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +6 -6
  36. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  37. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  38. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  39. package/api/@xmachines/play-router/classes/BaseRouteMap.md +6 -4
  40. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +21 -21
  41. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  42. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  43. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  44. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  45. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  46. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  47. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  48. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  49. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  50. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  51. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +1 -1
  52. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  53. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  54. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  55. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  56. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  57. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  58. package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
  59. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  60. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  61. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  62. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  63. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  64. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  65. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  66. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  67. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  68. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  69. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +6 -6
  70. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  71. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  72. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  73. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  74. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  75. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  76. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  77. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  78. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  79. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  80. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  81. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +7 -7
  82. package/api/@xmachines/play-solid/type-aliases/PlayActor.md +1 -1
  83. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  84. package/api/@xmachines/play-solid-router/classes/RouteMap.md +4 -4
  85. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +22 -22
  86. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  87. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  88. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
  89. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +6 -6
  90. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  91. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  92. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  93. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  94. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  95. package/api/@xmachines/play-svelte/README.md +91 -0
  96. package/api/@xmachines/play-svelte/functions/defineRegistry.md +52 -0
  97. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +27 -0
  98. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +27 -0
  99. package/api/@xmachines/play-svelte/interfaces/PlayRendererProps.md +22 -0
  100. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +16 -0
  101. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +7 -0
  102. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +7 -0
  103. package/api/@xmachines/play-svelte/variables/getBoundProp.md +7 -0
  104. package/api/@xmachines/play-svelte-spa-router/README.md +53 -0
  105. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +150 -0
  106. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +19 -0
  107. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +19 -0
  108. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +16 -0
  109. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +119 -0
  110. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +12 -0
  111. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +104 -0
  112. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +9 -0
  113. package/api/@xmachines/play-svelte-spa-router-demo/README.md +23 -0
  114. package/api/@xmachines/play-sveltekit-router/README.md +53 -0
  115. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +115 -0
  116. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +19 -0
  117. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +19 -0
  118. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +12 -0
  119. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +119 -0
  120. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +12 -0
  121. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +104 -0
  122. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +9 -0
  123. package/api/@xmachines/play-sveltekit-router-demo/README.md +23 -0
  124. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +4 -4
  125. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +21 -21
  126. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  127. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  128. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  129. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  130. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  131. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  132. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +6 -6
  133. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  134. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  135. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  136. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  137. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  138. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  139. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +4 -4
  140. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +22 -22
  141. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  142. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  143. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +6 -6
  144. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  145. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  146. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  147. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  148. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  149. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  150. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  151. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  152. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +5 -5
  153. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  154. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  155. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  156. package/api/@xmachines/play-vue/type-aliases/PlayActor.md +1 -1
  157. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  158. package/api/@xmachines/play-vue-router/classes/RouteMap.md +7 -7
  159. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +7 -7
  160. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +22 -22
  161. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  162. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +6 -6
  163. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  164. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +3 -3
  165. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  166. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  167. package/api/@xmachines/play-xstate/classes/PlayerActor.md +11 -11
  168. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  169. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  170. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  171. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  172. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  173. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  174. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  175. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  176. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  177. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  178. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  179. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  180. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  181. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  182. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  183. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  184. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  185. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  186. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  187. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  188. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  189. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
  190. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  191. package/api/README.md +5 -0
  192. package/api/llms.txt +3 -0
  193. package/examples/multi-router-integration.md +34 -6
  194. package/package.json +2 -2
package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: SolidRouterBridge
4
4
 
5
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/solid-router-bridge.ts#L47)
5
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/solid-router-bridge.ts#L47)
6
6
 
7
7
  SolidJS Router integration bridge extending RouterBridgeBase
8
8
 
@@ -27,7 +27,7 @@ new SolidRouterBridge(
27
27
  routeMap): SolidRouterBridge;
28
28
  ```
29
29
 
30
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/solid-router-bridge.ts#L61)
30
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/solid-router-bridge.ts#L61)
31
31
 
32
32
  Create a SolidJS Router bridge
33
33
 
@@ -57,15 +57,15 @@ Create a SolidJS Router bridge
57
57
 
58
58
  | Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
59
59
  | --------------------------------------------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
60
- | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../interfaces/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [packages/play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L102) |
61
- | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [packages/play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L90) |
62
- | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [packages/play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L89) |
63
- | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [packages/play-router/src/router-bridge-base.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L92) |
64
- | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [packages/play-router/src/router-bridge-base.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L91) |
65
- | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [packages/play-router/src/router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L103) |
66
- | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L105) |
67
- | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L104) |
68
- | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [packages/play-router/src/router-bridge-base.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L93) |
60
+ | <a id="property-actor"></a> `actor` | `readonly` | [`AbstractActor`](../interfaces/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Routable`](../../play-actor/interfaces/Routable.md) | `undefined` | A `Routable` actor exposing `currentRoute` and `send`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor) | [packages/play-router/src/router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L102) |
61
+ | <a id="property-hasconnectedonce"></a> `hasConnectedOnce` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce) | [packages/play-router/src/router-bridge-base.ts:90](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L90) |
62
+ | <a id="property-isconnected"></a> `isConnected` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected) | [packages/play-router/src/router-bridge-base.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L89) |
63
+ | <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean` | `false` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | [packages/play-router/src/router-bridge-base.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L92) |
64
+ | <a id="property-lastsyncedpath"></a> `lastSyncedPath` | `protected` | `string` \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath) | [packages/play-router/src/router-bridge-base.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L91) |
65
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | `object` | `undefined` | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap()` or an equivalent. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap) | [packages/play-router/src/router-bridge-base.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L103) |
66
+ | `routeMap.getPathByStateId` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:105](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L105) |
67
+ | `routeMap.getStateIdByPath` | `public` | `string` \| `null` \| `undefined` | `undefined` | - | - | [packages/play-router/src/router-bridge-base.ts:104](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L104) |
68
+ | <a id="property-routewatcher"></a> `routeWatcher` | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | `null` | - | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher) | [packages/play-router/src/router-bridge-base.ts:93](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L93) |
69
69
 
70
70
  ## Methods
71
71
 
@@ -75,7 +75,7 @@ Create a SolidJS Router bridge
75
75
  connect(): void;
76
76
  ```
77
77
 
78
- Defined in: [packages/play-router/src/router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L129)
78
+ Defined in: [packages/play-router/src/router-bridge-base.ts:129](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L129)
79
79
 
80
80
  Connect the router bridge to the Actor.
81
81
 
@@ -107,7 +107,7 @@ Adapters that need custom initial-sync behavior should override
107
107
  disconnect(): void;
108
108
  ```
109
109
 
110
- Defined in: [packages/play-router/src/router-bridge-base.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L197)
110
+ Defined in: [packages/play-router/src/router-bridge-base.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L197)
111
111
 
112
112
  Disconnect the router bridge from the Actor.
113
113
 
@@ -129,7 +129,7 @@ Stops signal watching and unregisters framework-specific router listener.
129
129
  dispose(): void;
130
130
  ```
131
131
 
132
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/solid-router-bridge.ts#L127)
132
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:127](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/solid-router-bridge.ts#L127)
133
133
 
134
134
  Dispose the bridge (alias for disconnect).
135
135
 
@@ -151,7 +151,7 @@ onCleanup(() => bridge.dispose());
151
151
  protected extractParams(pathname, stateId): Record<string, string>;
152
152
  ```
153
153
 
154
- Defined in: [packages/play-router/src/router-bridge-base.ts:300](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L300)
154
+ Defined in: [packages/play-router/src/router-bridge-base.ts:300](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L300)
155
155
 
156
156
  Extract path parameters from URL using the URLPattern API.
157
157
 
@@ -185,7 +185,7 @@ Extracted path parameters, or empty object if URLPattern is unavailable or no ma
185
185
  protected extractQuery(search): Record<string, string>;
186
186
  ```
187
187
 
188
- Defined in: [packages/play-router/src/router-bridge-base.ts:321](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L321)
188
+ Defined in: [packages/play-router/src/router-bridge-base.ts:321](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L321)
189
189
 
190
190
  Extract query parameters from URL search string.
191
191
 
@@ -213,7 +213,7 @@ Extracted query parameters or empty object
213
213
  protected getInitialRouterPath(): string | null;
214
214
  ```
215
215
 
216
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/solid-router-bridge.ts#L84)
216
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/solid-router-bridge.ts#L84)
217
217
 
218
218
  Get the current router pathname for initial URL -> actor sync on connect.
219
219
 
@@ -233,7 +233,7 @@ Get the current router pathname for initial URL -> actor sync on connect.
233
233
  protected navigateRouter(path): void;
234
234
  ```
235
235
 
236
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/solid-router-bridge.ts#L77)
236
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:77](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/solid-router-bridge.ts#L77)
237
237
 
238
238
  Navigate SolidJS Router to the given path.
239
239
 
@@ -259,7 +259,7 @@ Navigate SolidJS Router to the given path.
259
259
  protected syncActorFromRouter(pathname, search?): void;
260
260
  ```
261
261
 
262
- Defined in: [packages/play-router/src/router-bridge-base.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L248)
262
+ Defined in: [packages/play-router/src/router-bridge-base.ts:248](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L248)
263
263
 
264
264
  Sync actor state when router location changes.
265
265
 
@@ -289,7 +289,7 @@ Prevents circular updates via isProcessingNavigation flag.
289
289
  protected syncRouterFromActor(route): void;
290
290
  ```
291
291
 
292
- Defined in: [packages/play-router/src/router-bridge-base.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/router-bridge-base.ts#L228)
292
+ Defined in: [packages/play-router/src/router-bridge-base.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/router-bridge-base.ts#L228)
293
293
 
294
294
  Sync router location when actor route signal changes.
295
295
 
@@ -322,7 +322,7 @@ suppressed as circular echoes.
322
322
  protected unwatchRouterChanges(): void;
323
323
  ```
324
324
 
325
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/solid-router-bridge.ts#L114)
325
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:114](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/solid-router-bridge.ts#L114)
326
326
 
327
327
  Stop watching SolidJS Router changes.
328
328
 
@@ -344,7 +344,7 @@ Solid auto-cleans createEffect subscriptions when component unmounts.
344
344
  protected watchRouterChanges(): void;
345
345
  ```
346
346
 
347
- Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/solid-router-bridge.ts#L94)
347
+ Defined in: [packages/play-solid-router/src/solid-router-bridge.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/solid-router-bridge.ts#L94)
348
348
 
349
349
  Subscribe to SolidJS Router location changes using createEffect.
350
350
 
package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function PlayRouterProvider<TActor>(props): any;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/play-router-provider.tsx#L24)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/play-router-provider.tsx#L24)
10
10
 
11
11
  ## Type Parameters
12
12
 
package/api/@xmachines/play-solid-router/functions/createRouteMap.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function createRouteMap(machine): RouteMap;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/create-route-map.ts#L27)
9
+ Defined in: [packages/play-solid-router/src/create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/create-route-map.ts#L27)
10
10
 
11
11
  Create a RouteMap from an XState machine
12
12
 
package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Abstract Interface: AbstractActor\<TLogic, TEvent\>
4
4
 
5
- Defined in: [packages/play-actor/src/abstract-actor.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-actor/src/abstract-actor.ts#L231)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:231](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-actor/src/abstract-actor.ts#L231)
6
6
 
7
7
  Abstract base class for Play Architecture actors.
8
8
 
@@ -83,7 +83,7 @@ class PlayerActor extends AbstractActor<AnyActorLogic, EventFromLogic<TMachine>>
83
83
  | <a id="property-ref"></a> `ref` | `public` | [`ActorRef`](https://www.jsdocs.io/package/xstate#ActorRef)\<[`SnapshotFrom`](https://www.jsdocs.io/package/xstate#SnapshotFrom)\<`TLogic`\>, [`EventFromLogic`](https://www.jsdocs.io/package/xstate#EventFromLogic)\<`TLogic`\>, [`EmittedFrom`](https://www.jsdocs.io/package/xstate#EmittedFrom)\<`TLogic`\>\> | - | `Actor.ref` | - |
84
84
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
85
85
  | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | - |
86
- | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Typed as `Signal.State<unknown>` at the abstract level; concrete implementations narrow this to the actual snapshot type (e.g., `Signal.State<AnyMachineSnapshot>` in `@xmachines/play-xstate`'s `PlayerActor`). Infrastructure observes this signal to react to state changes without directly coupling to the Actor's internal state machine implementation. **Example** `// Infrastructure observes state signal const watcher = new Signal.subtle.Watcher(() => { console.log('Actor state changed:', actor.state.get()); }); watcher.watch(actor.state);` | - | [packages/play-actor/src/abstract-actor.ts:254](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-actor/src/abstract-actor.ts#L254) |
86
+ | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Typed as `Signal.State<unknown>` at the abstract level; concrete implementations narrow this to the actual snapshot type (e.g., `Signal.State<AnyMachineSnapshot>` in `@xmachines/play-xstate`'s `PlayerActor`). Infrastructure observes this signal to react to state changes without directly coupling to the Actor's internal state machine implementation. **Example** `// Infrastructure observes state signal const watcher = new Signal.subtle.Watcher(() => { console.log('Actor state changed:', actor.state.get()); }); watcher.watch(actor.state);` | - | [packages/play-actor/src/abstract-actor.ts:254](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-actor/src/abstract-actor.ts#L254) |
87
87
  | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | - |
88
88
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
89
89
 
@@ -244,7 +244,7 @@ Actor.select;
244
244
  abstract send(event): void;
245
245
  ```
246
246
 
247
- Defined in: [packages/play-actor/src/abstract-actor.ts:278](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-actor/src/abstract-actor.ts#L278)
247
+ Defined in: [packages/play-actor/src/abstract-actor.ts:278](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-actor/src/abstract-actor.ts#L278)
248
248
 
249
249
  Send event to Actor
250
250
 
package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:216](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L216)
5
+ Defined in: [packages/play-router/src/types.ts:216](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L216)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -112,8 +112,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
112
 
113
113
  | Property | Modifier | Type | Defined in |
114
114
  | -------------------------------------- | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [packages/play-router/src/types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L221) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L219) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L220) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [packages/play-router/src/types.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L218) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [packages/play-router/src/types.ts:217](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L217) |
115
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [packages/play-router/src/types.ts:221](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L221) |
116
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:219](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L219) |
117
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L220) |
118
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [packages/play-router/src/types.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L218) |
119
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [packages/play-router/src/types.ts:217](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L217) |
package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps\<TActor\>
4
4
 
5
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/play-router-provider.tsx#L16)
5
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/play-router-provider.tsx#L16)
6
6
 
7
7
  ## Type Parameters
8
8
 
@@ -14,7 +14,7 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:16](https:/
14
14
 
15
15
  | Property | Type | Description | Defined in |
16
16
  | ----------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
17
- | <a id="property-actor"></a> `actor` | `TActor` | - | [packages/play-solid-router/src/play-router-provider.tsx:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/play-router-provider.tsx#L17) |
18
- | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [packages/play-solid-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/play-router-provider.tsx#L21) |
19
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/play-router-provider.tsx#L18) |
20
- | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/play-router-provider.tsx#L19) |
17
+ | <a id="property-actor"></a> `actor` | `TActor` | - | [packages/play-solid-router/src/play-router-provider.tsx:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/play-router-provider.tsx#L17) |
18
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [packages/play-solid-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/play-router-provider.tsx#L21) |
19
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/play-router-provider.tsx#L18) |
20
+ | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | - | [packages/play-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/play-router-provider.tsx#L19) |
package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [packages/play-solid-router/src/types.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/types.ts#L8)
5
+ Defined in: [packages/play-solid-router/src/types.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/types.ts#L8)
6
6
 
7
7
  Mapping between state ID and URL path for SolidJS Router
8
8
 
@@ -10,5 +10,5 @@ Mapping between state ID and URL path for SolidJS Router
10
10
 
11
11
  | Property | Modifier | Type | Description | Defined in |
12
12
  | --------------------------------------- | ---------- | -------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-path"></a> `path` | `readonly` | `string` | SolidJS Router path pattern **Example** `'/', '/profile/:userId', '/settings/:section?'` | [packages/play-solid-router/src/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/types.ts#L19) |
14
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID with # prefix **Example** `'#home', '#profile'` | [packages/play-solid-router/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/types.ts#L13) |
13
+ | <a id="property-path"></a> `path` | `readonly` | `string` | SolidJS Router path pattern **Example** `'/', '/profile/:userId', '/settings/:section?'` | [packages/play-solid-router/src/types.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/types.ts#L19) |
14
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | XMachines state ID with # prefix **Example** `'#home', '#profile'` | [packages/play-solid-router/src/types.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/types.ts#L13) |
package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L264)
5
+ Defined in: [packages/play-router/src/types.ts:264](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L264)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
@@ -54,7 +54,7 @@ class TanStackRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [packages/play-router/src/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L280)
57
+ Defined in: [packages/play-router/src/types.ts:280](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L280)
58
58
 
59
59
  Connect the router bridge to the Actor
60
60
 
@@ -83,7 +83,7 @@ await bridge.connect();
83
83
  disconnect(): void | Promise<void>;
84
84
  ```
85
85
 
86
- Defined in: [packages/play-router/src/types.ts:296](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-router/src/types.ts#L296)
86
+ Defined in: [packages/play-router/src/types.ts:296](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-router/src/types.ts#L296)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md CHANGED
@@ -6,6 +6,6 @@
6
6
  type RoutableActor = AbstractActor<AnyActorLogic> & Routable & Viewable;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/play-router-provider.tsx#L8)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/play-router-provider.tsx#L8)
10
10
 
11
11
  Minimum actor shape accepted by PlayRouterProvider.
package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type SolidRouterHooks = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/play-router-provider.tsx#L10)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/play-router-provider.tsx#L10)
10
10
 
11
11
  ## Properties
12
12
 
@@ -16,7 +16,7 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:10](https:/
16
16
  location: object;
17
17
  ```
18
18
 
19
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/play-router-provider.tsx#L12)
19
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/play-router-provider.tsx#L12)
20
20
 
21
21
  #### pathname
22
22
 
@@ -38,7 +38,7 @@ search: string;
38
38
  navigate: ((path) => void) | ((path, ...args) => unknown);
39
39
  ```
40
40
 
41
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/play-router-provider.tsx#L11)
41
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/play-router-provider.tsx#L11)
42
42
 
43
43
  ---
44
44
 
@@ -48,4 +48,4 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:11](https:/
48
48
  params: Record<string, string | undefined>;
49
49
  ```
50
50
 
51
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.24/packages/play-solid-router/src/play-router-provider.tsx#L13)
51
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-solid-router/src/play-router-provider.tsx#L13)
package/api/@xmachines/play-svelte/README.md ADDED
@@ -0,0 +1,91 @@
1
+ [Documentation](../../README.md) / @xmachines/play-svelte
2
+
3
+ # @xmachines/play-svelte
4
+
5
+ Play-branded Svelte 5 renderer for XMachines Play.
6
+
7
+ ## Overview
8
+
9
+ `@xmachines/play-svelte` is the first-class Svelte entrypoint for Play apps:
10
+
11
+ - `PlayRenderer` observes `actor.currentView` with Play signals
12
+ - UI state is bridged through `@xstate/store` and `@json-render/xstate`
13
+ - Svelte authors still get the underlying json-render helpers they need
14
+
15
+ ## Install
16
+
17
+ ```bash
18
+ npm install @xmachines/play-svelte
19
+ ```
20
+
21
+ ## Quick start
22
+
23
+ ```svelte
24
+ <script lang="ts">
25
+ import { PlayRenderer, defineRegistry } from "@xmachines/play-svelte";
26
+ import { defineCatalog, schema } from "@json-render/core";
27
+ import { z } from "zod";
28
+ import Login from "./Login.svelte";
29
+
30
+ const catalog = defineCatalog(schema, {
31
+ components: {
32
+ Login: {
33
+ props: z.object({ title: z.string() }),
34
+ description: "Login screen",
35
+ },
36
+ },
37
+ });
38
+
39
+ const { registry } = defineRegistry(catalog, { components: { Login } });
40
+ </script>
41
+
42
+ <PlayRenderer actor={actor} {registry} />
43
+ ```
44
+
45
+ ## Re-exports
46
+
47
+ This package re-exports from `@json-render/svelte`:
48
+
49
+ - `defineRegistry` — wire Svelte components into the Play catalog
50
+ - `getBoundProp` — two-way reactive binding helper for form inputs
51
+
52
+ Types: `BaseComponentProps`, `ComponentFn`, `ComponentContext`
53
+
54
+ For anything else (`schema`, `Renderer`, `JsonUIProvider`, context helpers), import from `@json-render/svelte` directly.
55
+
56
+ ## PlayRenderer behavior
57
+
58
+ - `PlayRenderer` watches `actor.currentView` and rerenders when the active view changes.
59
+ - `actions={{ login: "auth.login" }}` maps json-render action names to actor event types.
60
+ - If you do not pass a `store`, `PlayRenderer` creates an internal `@xstate/store` atom from `view.spec.state`.
61
+ - If you do pass a `store`, that external store wins and no internal store is created for the view.
62
+
63
+ @xmachines/play-svelte - Svelte renderer for XMachines Play architecture
64
+
65
+ Provides a thin Svelte rendering layer that passively observes actor signals
66
+ and renders UI components via @json-render/svelte. Svelte reactivity is only
67
+ used to trigger re-renders — signals are the source of truth.
68
+
69
+ Re-exports `defineRegistry`, `getBoundProp`, `BaseComponentProps`, and
70
+ `ComponentFn` from `@json-render/svelte` so consumers import everything
71
+ from `@xmachines/play-svelte` rather than `@json-render/svelte` directly.
72
+
73
+ ## Interfaces
74
+
75
+ - [BaseComponentProps](interfaces/BaseComponentProps.md)
76
+ - [ComponentContext](interfaces/ComponentContext.md)
77
+ - [PlayRendererProps](interfaces/PlayRendererProps.md)
78
+
79
+ ## Type Aliases
80
+
81
+ - [ComponentFn](type-aliases/ComponentFn.md)
82
+ - [PlayRenderer](type-aliases/PlayRenderer.md)
83
+
84
+ ## Variables
85
+
86
+ - [getBoundProp](variables/getBoundProp.md)
87
+ - [PlayRenderer](variables/PlayRenderer.md)
88
+
89
+ ## Functions
90
+
91
+ - [defineRegistry](functions/defineRegistry.md)
package/api/@xmachines/play-svelte/functions/defineRegistry.md ADDED
@@ -0,0 +1,52 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / defineRegistry
2
+
3
+ # Function: defineRegistry()
4
+
5
+ ```ts
6
+ function defineRegistry<C, TComponents>(_catalog, options): DefineRegistryResult;
7
+ ```
8
+
9
+ Create a registry from a catalog with Svelte components and/or actions.
10
+
11
+ Components must accept `BaseComponentProps` as their props interface.
12
+
13
+ ## Type Parameters
14
+
15
+ | Type Parameter |
16
+ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | `C` _extends_ `Catalog`\<`SchemaDefinition`\<`SchemaType`\<`string`, `unknown`\>, `SchemaType`\<`string`, `unknown`\>\>, `unknown`\> |
18
+ | `TComponents` _extends_ `Record`\<`string`, `Component`\<[`BaseComponentProps`](../interfaces/BaseComponentProps.md)\<`any`\>, \{ \}, `string`\>\> |
19
+
20
+ ## Parameters
21
+
22
+ | Parameter | Type | Description |
23
+ | --------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------ |
24
+ | `_catalog` | `C` | - |
25
+ | `options` | \{ `actions?`: `Record`\<`string`, `DefineRegistryActionFn`\>; `components?`: `TComponents`; \} | - |
26
+ | `options.actions?` | `Record`\<`string`, `DefineRegistryActionFn`\> | Action handlers |
27
+ | `options.components?` | `TComponents` | Svelte components that accept BaseComponentProps |
28
+
29
+ ## Returns
30
+
31
+ `DefineRegistryResult`
32
+
33
+ ## Example
34
+
35
+ ```ts
36
+ import { defineRegistry } from "@json-render/svelte";
37
+ import Card from "./components/Card.svelte";
38
+ import Button from "./components/Button.svelte";
39
+ import { myCatalog } from "./catalog";
40
+
41
+ const { registry, handlers } = defineRegistry(myCatalog, {
42
+ components: {
43
+ Card,
44
+ Button,
45
+ },
46
+ actions: {
47
+ submit: async (params, setState) => {
48
+ // handle action
49
+ },
50
+ },
51
+ });
52
+ ```
package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md ADDED
@@ -0,0 +1,27 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / BaseComponentProps
2
+
3
+ # Interface: BaseComponentProps\<P\>
4
+
5
+ Catalog-agnostic base type for component render function arguments.
6
+ Use this when building reusable component libraries.
7
+
8
+ ## Extended by
9
+
10
+ - [`ComponentContext`](ComponentContext.md)
11
+
12
+ ## Type Parameters
13
+
14
+ | Type Parameter | Default type |
15
+ | -------------- | ------------------------------- |
16
+ | `P` | `Record`\<`string`, `unknown`\> |
17
+
18
+ ## Properties
19
+
20
+ | Property | Type | Description | Defined in |
21
+ | ------------------------------------------ | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | ---------- |
22
+ | <a id="property-bindings"></a> `bindings?` | `Record`\<`string`, `string`\> | Two-way binding paths resolved from `$bindState` / `$bindItem` expressions. Maps prop name → absolute state path for write-back. | - |
23
+ | <a id="property-children"></a> `children?` | `Snippet`\<\[\]\> | - | - |
24
+ | <a id="property-emit"></a> `emit` | (`event`) => `void` | Simple event emitter (shorthand). Fires the event and returns void. | - |
25
+ | <a id="property-loading"></a> `loading?` | `boolean` | - | - |
26
+ | <a id="property-on"></a> `on` | (`event`) => `EventHandle` | Get an event handle with metadata. Use when you need shouldPreventDefault or bound checks. | - |
27
+ | <a id="property-props"></a> `props` | `P` | - | - |
package/api/@xmachines/play-svelte/interfaces/ComponentContext.md ADDED
@@ -0,0 +1,27 @@
1
+ [Documentation](../../../README.md) / [@xmachines/play-svelte](../README.md) / ComponentContext
2
+
3
+ # Interface: ComponentContext\<C, K\>
4
+
5
+ Context passed to component render functions
6
+
7
+ ## Extends
8
+
9
+ - [`BaseComponentProps`](BaseComponentProps.md)\<`InferComponentProps`\<`C`, `K`\>\>
10
+
11
+ ## Type Parameters
12
+
13
+ | Type Parameter |
14
+ | --------------------------------------------------- |
15
+ | `C` _extends_ `Catalog` |
16
+ | `K` _extends_ keyof `InferCatalogComponents`\<`C`\> |
17
+
18
+ ## Properties
19
+
20
+ | Property | Type | Description | Inherited from | Defined in |
21
+ | ------------------------------------------ | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | ---------- |
22
+ | <a id="property-bindings"></a> `bindings?` | `Record`\<`string`, `string`\> | Two-way binding paths resolved from `$bindState` / `$bindItem` expressions. Maps prop name → absolute state path for write-back. | [`BaseComponentProps`](BaseComponentProps.md).[`bindings`](BaseComponentProps.md#property-bindings) | - |
23
+ | <a id="property-children"></a> `children?` | `Snippet`\<\[\]\> | - | [`BaseComponentProps`](BaseComponentProps.md).[`children`](BaseComponentProps.md#property-children) | - |
24
+ | <a id="property-emit"></a> `emit` | (`event`) => `void` | Simple event emitter (shorthand). Fires the event and returns void. | [`BaseComponentProps`](BaseComponentProps.md).[`emit`](BaseComponentProps.md#property-emit) | - |
25
+ | <a id="property-loading"></a> `loading?` | `boolean` | - | [`BaseComponentProps`](BaseComponentProps.md).[`loading`](BaseComponentProps.md#property-loading) | - |
26
+ | <a id="property-on"></a> `on` | (`event`) => `EventHandle` | Get an event handle with metadata. Use when you need shouldPreventDefault or bound checks. | [`BaseComponentProps`](BaseComponentProps.md).[`on`](BaseComponentProps.md#property-on) | - |
27
+ | <a id="property-props"></a> `props` | `InferComponentProps` | - | [`BaseComponentProps`](BaseComponentProps.md).[`props`](BaseComponentProps.md#property-props) | - |