@xmachines/docs 1.0.0-beta.52 → 1.0.0-beta.54

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 (442) hide show
  1. package/README.md +1 -1
  2. package/api/@xmachines/play/classes/NonNullableError.md +7 -7
  3. package/api/@xmachines/play/classes/PlayError.md +7 -7
  4. package/api/@xmachines/play/functions/assertNonNullable.md +1 -1
  5. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  6. package/api/@xmachines/play-actor/README.md +2 -0
  7. package/api/@xmachines/play-actor/classes/AbstractActor.md +14 -14
  8. package/api/@xmachines/play-actor/functions/attachRenderErrorHandler.md +40 -0
  9. package/api/@xmachines/play-actor/functions/toAtomState.md +33 -0
  10. package/api/@xmachines/play-actor/functions/typedSpec.md +1 -1
  11. package/api/@xmachines/play-actor/interfaces/BaseActorProviderProps.md +5 -5
  12. package/api/@xmachines/play-actor/interfaces/BaseViewContextValue.md +5 -5
  13. package/api/@xmachines/play-actor/interfaces/PlaySpec.md +2 -2
  14. package/api/@xmachines/play-actor/interfaces/Routable.md +3 -3
  15. package/api/@xmachines/play-actor/interfaces/Viewable.md +2 -2
  16. package/api/@xmachines/play-dom/README.md +2 -0
  17. package/api/@xmachines/play-dom/classes/PlayRenderer.md +28 -4
  18. package/api/@xmachines/play-dom/functions/createPlayUI.md +1 -1
  19. package/api/@xmachines/play-dom/functions/createRenderer.md +1 -1
  20. package/api/@xmachines/play-dom/functions/defineRegistry.md +1 -1
  21. package/api/@xmachines/play-dom/functions/renderSpec.md +12 -30
  22. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +7 -7
  23. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +7 -6
  24. package/api/@xmachines/play-dom/interfaces/DefineRegistryResult.md +4 -4
  25. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +16 -15
  26. package/api/@xmachines/play-dom/interfaces/EventHandle.md +4 -4
  27. package/api/@xmachines/play-dom/interfaces/MountOptions.md +3 -3
  28. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +9 -8
  29. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +28 -0
  30. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +6 -5
  31. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +1 -1
  32. package/api/@xmachines/play-dom/type-aliases/Actions.md +1 -1
  33. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +7 -7
  34. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +1 -1
  35. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +1 -1
  36. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +1 -1
  37. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +44 -0
  38. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +2 -2
  39. package/api/@xmachines/play-dom/type-aliases/DomComponentRenderer.md +1 -1
  40. package/api/@xmachines/play-dom/type-aliases/DomRegistry.md +1 -1
  41. package/api/@xmachines/play-dom/type-aliases/DomSchema.md +1 -1
  42. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  43. package/api/@xmachines/play-dom/type-aliases/RenderErrorHandler.md +1 -1
  44. package/api/@xmachines/play-dom/type-aliases/SetState.md +1 -1
  45. package/api/@xmachines/play-dom/variables/schema.md +1 -1
  46. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  47. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  48. package/api/@xmachines/play-dom-router/functions/createRouteMap.md +1 -1
  49. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  50. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +14 -14
  51. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +14 -14
  52. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +4 -4
  53. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +16 -6
  54. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +4 -4
  55. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +7 -3
  56. package/api/@xmachines/play-dom-router/interfaces/RouteMap.md +16 -4
  57. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +2 -2
  58. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +3 -3
  59. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +6 -6
  60. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +4 -4
  61. package/api/@xmachines/play-react/README.md +6 -6
  62. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +18 -18
  63. package/api/@xmachines/play-react/functions/ActionProvider.md +1 -1
  64. package/api/@xmachines/play-react/functions/JSONUIProvider.md +1 -1
  65. package/api/@xmachines/play-react/functions/Renderer.md +1 -1
  66. package/api/@xmachines/play-react/functions/StateProvider.md +1 -1
  67. package/api/@xmachines/play-react/functions/ValidationProvider.md +1 -1
  68. package/api/@xmachines/play-react/functions/VisibilityProvider.md +1 -1
  69. package/api/@xmachines/play-react/functions/defineRegistry.md +1 -1
  70. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  71. package/api/@xmachines/play-react/functions/useBoundProp.md +1 -1
  72. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  73. package/api/@xmachines/play-react/functions/useSignalEffect.md +28 -26
  74. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +1 -1
  75. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +8 -8
  76. package/api/@xmachines/play-react/interfaces/ComponentContext.md +1 -1
  77. package/api/@xmachines/play-react/interfaces/JSONUIProviderProps.md +1 -1
  78. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  79. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  80. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +8 -8
  81. package/api/@xmachines/play-react/interfaces/RendererProps.md +1 -1
  82. package/api/@xmachines/play-react/interfaces/StateProviderProps.md +1 -1
  83. package/api/@xmachines/play-react/interfaces/ValidationProviderProps.md +1 -1
  84. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +5 -5
  85. package/api/@xmachines/play-react/interfaces/VisibilityProviderProps.md +1 -1
  86. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  87. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +1 -1
  88. package/api/@xmachines/play-react/type-aliases/RenderErrorHandler.md +1 -1
  89. package/api/@xmachines/play-react/variables/ActorProvider.md +1 -1
  90. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  91. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  92. package/api/@xmachines/play-react-router/README.md +10 -1
  93. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +45 -32
  94. package/api/@xmachines/play-react-router/classes/RouteMap.md +17 -5
  95. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +45 -0
  96. package/api/@xmachines/play-react-router/functions/createRouteMap.md +1 -1
  97. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +2 -2
  98. package/api/@xmachines/play-react-router/interfaces/PlayActor.md +7 -7
  99. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +16 -6
  100. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
  101. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +17 -7
  102. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +2 -2
  103. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  104. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +6 -6
  105. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
  106. package/api/@xmachines/play-react-router/{functions → variables}/PlayRouterProvider.md +6 -6
  107. package/api/@xmachines/play-router/README.md +6 -8
  108. package/api/@xmachines/play-router/classes/RouteMap.md +17 -5
  109. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +50 -37
  110. package/api/@xmachines/play-router/functions/buildPlayRouteEvent.md +1 -1
  111. package/api/@xmachines/play-router/functions/buildRouteTree.md +11 -1
  112. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  113. package/api/@xmachines/play-router/functions/createRouteMapFromTree.md +2 -2
  114. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +13 -6
  115. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  116. package/api/@xmachines/play-router/functions/extractQuery.md +1 -1
  117. package/api/@xmachines/play-router/functions/extractRouteParams.md +9 -1
  118. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  119. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  120. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  121. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  122. package/api/@xmachines/play-router/functions/getTransitionReachableRoutes.md +7 -2
  123. package/api/@xmachines/play-router/functions/isRouteReachable.md +1 -1
  124. package/api/@xmachines/play-router/functions/machineToGraph.md +1 -1
  125. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  126. package/api/@xmachines/play-router/functions/sanitizePathname.md +1 -1
  127. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  128. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  129. package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md +4 -4
  130. package/api/@xmachines/play-router/interfaces/LocationLike.md +3 -3
  131. package/api/@xmachines/play-router/interfaces/MachineEdgeData.md +3 -3
  132. package/api/@xmachines/play-router/interfaces/MachineNodeData.md +5 -5
  133. package/api/@xmachines/play-router/interfaces/PlayActor.md +7 -7
  134. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +16 -6
  135. package/api/@xmachines/play-router/interfaces/RoutableActor.md +4 -4
  136. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  137. package/api/@xmachines/play-router/interfaces/RouteMapOptions.md +2 -2
  138. package/api/@xmachines/play-router/interfaces/RouteMapping.md +3 -3
  139. package/api/@xmachines/play-router/interfaces/RouteMatch.md +3 -3
  140. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  141. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  142. package/api/@xmachines/play-router/interfaces/RouteTree.md +5 -5
  143. package/api/@xmachines/play-router/interfaces/RouteWatcherHandle.md +3 -3
  144. package/api/@xmachines/play-router/interfaces/RouterBridge.md +6 -6
  145. package/api/@xmachines/play-router/interfaces/WindowLike.md +3 -3
  146. package/api/@xmachines/play-router/type-aliases/MachineGraph.md +1 -1
  147. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  148. package/api/@xmachines/play-signals/functions/watchSignal.md +1 -1
  149. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +4 -2
  150. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  151. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +4 -2
  152. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  153. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  154. package/api/@xmachines/play-signals/namespaces/Signal/classes/Computed.md +3 -3
  155. package/api/@xmachines/play-signals/namespaces/Signal/classes/State.md +4 -4
  156. package/api/@xmachines/play-signals/namespaces/Signal/interfaces/Options.md +1 -1
  157. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/classes/Watcher.md +5 -5
  158. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/currentComputed.md +1 -1
  159. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSinks.md +1 -1
  160. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/hasSources.md +1 -1
  161. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSinks.md +1 -1
  162. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/introspectSources.md +1 -1
  163. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/functions/untrack.md +1 -1
  164. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/unwatched.md +1 -1
  165. package/api/@xmachines/play-signals/namespaces/Signal/namespaces/subtle/variables/watched.md +1 -1
  166. package/api/@xmachines/play-signals/namespaces/Signal/variables/isComputed.md +1 -1
  167. package/api/@xmachines/play-signals/namespaces/Signal/variables/isState.md +1 -1
  168. package/api/@xmachines/play-signals/namespaces/Signal/variables/isWatcher.md +1 -1
  169. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  170. package/api/@xmachines/play-solid/functions/ActionProvider.md +1 -1
  171. package/api/@xmachines/play-solid/functions/JSONUIProvider.md +1 -1
  172. package/api/@xmachines/play-solid/functions/Renderer.md +1 -1
  173. package/api/@xmachines/play-solid/functions/StateProvider.md +1 -1
  174. package/api/@xmachines/play-solid/functions/ValidationProvider.md +1 -1
  175. package/api/@xmachines/play-solid/functions/VisibilityProvider.md +1 -1
  176. package/api/@xmachines/play-solid/functions/defineRegistry.md +1 -1
  177. package/api/@xmachines/play-solid/functions/useAction.md +1 -1
  178. package/api/@xmachines/play-solid/functions/useActions.md +1 -1
  179. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  180. package/api/@xmachines/play-solid/functions/useBoundProp.md +1 -1
  181. package/api/@xmachines/play-solid/functions/useFieldValidation.md +1 -1
  182. package/api/@xmachines/play-solid/functions/useIsVisible.md +1 -1
  183. package/api/@xmachines/play-solid/functions/useOptionalValidation.md +1 -1
  184. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  185. package/api/@xmachines/play-solid/functions/useStateBinding.md +1 -1
  186. package/api/@xmachines/play-solid/functions/useStateStore.md +1 -1
  187. package/api/@xmachines/play-solid/functions/useStateValue.md +1 -1
  188. package/api/@xmachines/play-solid/functions/useVisibility.md +1 -1
  189. package/api/@xmachines/play-solid/interfaces/ActionProviderProps.md +1 -1
  190. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +8 -8
  191. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +1 -1
  192. package/api/@xmachines/play-solid/interfaces/DefineRegistryResult.md +1 -1
  193. package/api/@xmachines/play-solid/interfaces/JSONUIProviderProps.md +1 -1
  194. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +8 -8
  195. package/api/@xmachines/play-solid/interfaces/RendererProps.md +1 -1
  196. package/api/@xmachines/play-solid/interfaces/StateProviderProps.md +1 -1
  197. package/api/@xmachines/play-solid/interfaces/ValidationProviderProps.md +1 -1
  198. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +5 -5
  199. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  200. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +1 -1
  201. package/api/@xmachines/play-solid/type-aliases/ComponentRegistry.md +1 -1
  202. package/api/@xmachines/play-solid/type-aliases/RenderErrorHandler.md +1 -1
  203. package/api/@xmachines/play-solid/type-aliases/SetState.md +1 -1
  204. package/api/@xmachines/play-solid/type-aliases/VisibilityProviderProps.md +1 -1
  205. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  206. package/api/@xmachines/play-solid/variables/ActorProvider.md +1 -1
  207. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  208. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  209. package/api/@xmachines/play-solid-router/README.md +7 -1
  210. package/api/@xmachines/play-solid-router/classes/RouteMap.md +17 -5
  211. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +40 -33
  212. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +44 -0
  213. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  214. package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +13 -13
  215. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +7 -7
  216. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +16 -6
  217. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderBaseProps.md +30 -0
  218. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +17 -7
  219. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +2 -2
  220. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  221. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +6 -6
  222. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +34 -0
  223. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  224. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  225. package/api/@xmachines/play-solid-router/{functions → variables}/PlayRouterProvider.md +6 -6
  226. package/api/@xmachines/play-svelte/functions/defineRegistry.md +1 -1
  227. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  228. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  229. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  230. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +8 -8
  231. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +1 -1
  232. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +1 -1
  233. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +6 -6
  234. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +11 -11
  235. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +5 -5
  236. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +1 -1
  237. package/api/@xmachines/play-svelte/type-aliases/Actions.md +1 -1
  238. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  239. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +1 -1
  240. package/api/@xmachines/play-svelte/type-aliases/PlayRenderer.md +1 -1
  241. package/api/@xmachines/play-svelte/type-aliases/SetState.md +1 -1
  242. package/api/@xmachines/play-svelte/variables/PlayRenderer.md +1 -1
  243. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +17 -5
  244. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  245. package/api/@xmachines/play-svelte-spa-router/functions/createRouteMap.md +1 -1
  246. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +6 -6
  247. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +16 -6
  248. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +2 -2
  249. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +3 -3
  250. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +6 -6
  251. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  252. package/api/@xmachines/play-svelte-spa-router/type-aliases/RoutableActor.md +1 -1
  253. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +17 -5
  254. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  255. package/api/@xmachines/play-sveltekit-router/functions/createRouteMap.md +1 -1
  256. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +4 -4
  257. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +3 -3
  258. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +16 -6
  259. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +2 -2
  260. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +3 -3
  261. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +6 -6
  262. package/api/@xmachines/play-sveltekit-router/type-aliases/RoutableActor.md +1 -1
  263. package/api/@xmachines/play-tanstack-react-router/README.md +7 -1
  264. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +17 -5
  265. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +69 -52
  266. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +45 -0
  267. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMap.md +1 -1
  268. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +2 -2
  269. package/api/@xmachines/play-tanstack-react-router/functions/extractMachineRoutes.md +1 -1
  270. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayActor.md +7 -7
  271. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +16 -6
  272. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderBaseProps.md +32 -0
  273. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +17 -7
  274. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +2 -2
  275. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  276. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  277. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +6 -6
  278. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
  279. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  280. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +12 -4
  281. package/api/@xmachines/play-tanstack-react-router/{functions → variables}/PlayRouterProvider.md +8 -6
  282. package/api/@xmachines/play-tanstack-router/README.md +58 -0
  283. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +511 -0
  284. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +57 -0
  285. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +100 -0
  286. package/api/@xmachines/play-tanstack-solid-router/README.md +7 -1
  287. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +17 -5
  288. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +106 -79
  289. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +44 -0
  290. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  291. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayActor.md +7 -7
  292. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +16 -6
  293. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderBaseProps.md +31 -0
  294. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +15 -7
  295. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +2 -2
  296. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  297. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +6 -6
  298. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +30 -0
  299. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  300. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  301. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +30 -7
  302. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +33 -0
  303. package/api/@xmachines/play-vue/functions/defineRegistry.md +1 -1
  304. package/api/@xmachines/play-vue/functions/getPlayViewContext.md +1 -1
  305. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  306. package/api/@xmachines/play-vue/functions/useBoundProp.md +1 -1
  307. package/api/@xmachines/play-vue/interfaces/ActionProviderProps.md +1 -1
  308. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +5 -5
  309. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +1 -1
  310. package/api/@xmachines/play-vue/interfaces/DefineRegistryResult.md +1 -1
  311. package/api/@xmachines/play-vue/interfaces/JSONUIProviderProps.md +1 -1
  312. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +8 -8
  313. package/api/@xmachines/play-vue/interfaces/RendererProps.md +1 -1
  314. package/api/@xmachines/play-vue/interfaces/StateProviderProps.md +1 -1
  315. package/api/@xmachines/play-vue/interfaces/ValidationProviderProps.md +1 -1
  316. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +5 -5
  317. package/api/@xmachines/play-vue/interfaces/VisibilityProviderProps.md +1 -1
  318. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  319. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +1 -1
  320. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +1 -1
  321. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +1 -1
  322. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +2 -2
  323. package/api/@xmachines/play-vue/type-aliases/RenderErrorHandler.md +1 -1
  324. package/api/@xmachines/play-vue/variables/ActionProvider.md +1 -1
  325. package/api/@xmachines/play-vue/variables/JSONUIProvider.md +1 -1
  326. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  327. package/api/@xmachines/play-vue/variables/Renderer.md +1 -1
  328. package/api/@xmachines/play-vue/variables/StateProvider.md +1 -1
  329. package/api/@xmachines/play-vue/variables/ValidationProvider.md +1 -1
  330. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +1 -1
  331. package/api/@xmachines/play-vue-router/classes/RouteMap.md +17 -5
  332. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +74 -63
  333. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  334. package/api/@xmachines/play-vue-router/interfaces/PlayActor.md +7 -7
  335. package/api/@xmachines/play-vue-router/interfaces/PlayRouteEvent.md +16 -6
  336. package/api/@xmachines/play-vue-router/interfaces/RouteMapOptions.md +2 -2
  337. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +3 -3
  338. package/api/@xmachines/play-vue-router/interfaces/RouterBridge.md +6 -6
  339. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  340. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +3 -3
  341. package/api/@xmachines/play-xstate/classes/PlayerActor.md +72 -169
  342. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  343. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  344. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  345. package/api/@xmachines/play-xstate/functions/contextFieldMatches.md +1 -1
  346. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  347. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  348. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  349. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  350. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  351. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  352. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  353. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +3 -3
  354. package/api/@xmachines/play-xstate/interfaces/PlayerFactoryResumeOptions.md +2 -2
  355. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +6 -6
  356. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  357. package/api/@xmachines/play-xstate/interfaces/RouteObject.md +2 -2
  358. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  359. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  360. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  361. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  362. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  363. package/api/@xmachines/play-xstate/type-aliases/RouteMetadata.md +1 -1
  364. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  365. package/api/@xmachines/shared/vite-aliases/README.md +1 -0
  366. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +7 -3
  367. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  368. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +1 -1
  369. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +6 -5
  370. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +33 -0
  371. package/api/@xmachines/shared/vitest/README.md +5 -0
  372. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +42 -0
  373. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  374. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +16 -0
  375. package/api/README.md +1 -0
  376. package/api/llms.txt +4 -3
  377. package/contributing/architecture.md +74 -74
  378. package/contributing/configuration.md +2 -17
  379. package/contributing/deployment.md +8 -8
  380. package/contributing/development.md +2 -2
  381. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +1 -1
  382. package/examples/@xmachines/play-dom-demo/functions/initShell.md +1 -1
  383. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +1 -1
  384. package/examples/@xmachines/play-dom-demo/variables/About.md +1 -1
  385. package/examples/@xmachines/play-dom-demo/variables/Contact.md +1 -1
  386. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +1 -1
  387. package/examples/@xmachines/play-dom-demo/variables/Home.md +1 -1
  388. package/examples/@xmachines/play-dom-demo/variables/Login.md +1 -1
  389. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +1 -1
  390. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +1 -1
  391. package/examples/@xmachines/play-dom-demo/variables/Overview.md +1 -1
  392. package/examples/@xmachines/play-dom-demo/variables/Profile.md +1 -1
  393. package/examples/@xmachines/play-dom-demo/variables/Settings.md +1 -1
  394. package/examples/@xmachines/play-dom-demo/variables/Stats.md +1 -1
  395. package/examples/@xmachines/play-dom-demo/variables/authCatalog.md +1 -1
  396. package/examples/@xmachines/play-react-demo/functions/App.md +1 -1
  397. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +1 -1
  398. package/examples/@xmachines/play-react-demo/variables/About.md +1 -1
  399. package/examples/@xmachines/play-react-demo/variables/Contact.md +1 -1
  400. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +1 -1
  401. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +1 -1
  402. package/examples/@xmachines/play-react-demo/variables/Home.md +1 -1
  403. package/examples/@xmachines/play-react-demo/variables/Login.md +1 -1
  404. package/examples/@xmachines/play-react-demo/variables/NavBar.md +1 -1
  405. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +1 -1
  406. package/examples/@xmachines/play-react-demo/variables/Navigation.md +1 -1
  407. package/examples/@xmachines/play-react-demo/variables/Overview.md +1 -1
  408. package/examples/@xmachines/play-react-demo/variables/Profile.md +1 -1
  409. package/examples/@xmachines/play-react-demo/variables/Settings.md +1 -1
  410. package/examples/@xmachines/play-react-demo/variables/Shell.md +1 -1
  411. package/examples/@xmachines/play-react-demo/variables/Stats.md +1 -1
  412. package/examples/@xmachines/play-react-demo/variables/authCatalog.md +1 -1
  413. package/examples/@xmachines/play-solid-demo/functions/App.md +1 -1
  414. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +1 -1
  415. package/examples/@xmachines/play-solid-demo/variables/About.md +1 -1
  416. package/examples/@xmachines/play-solid-demo/variables/Contact.md +1 -1
  417. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +1 -1
  418. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +1 -1
  419. package/examples/@xmachines/play-solid-demo/variables/Home.md +1 -1
  420. package/examples/@xmachines/play-solid-demo/variables/Login.md +1 -1
  421. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +1 -1
  422. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +1 -1
  423. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +1 -1
  424. package/examples/@xmachines/play-solid-demo/variables/Overview.md +1 -1
  425. package/examples/@xmachines/play-solid-demo/variables/Profile.md +1 -1
  426. package/examples/@xmachines/play-solid-demo/variables/Settings.md +1 -1
  427. package/examples/@xmachines/play-solid-demo/variables/Shell.md +1 -1
  428. package/examples/@xmachines/play-solid-demo/variables/Stats.md +1 -1
  429. package/examples/@xmachines/play-solid-demo/variables/authCatalog.md +1 -1
  430. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +1 -1
  431. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +1 -1
  432. package/examples/@xmachines/play-svelte-demo/variables/App.md +1 -1
  433. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +1 -1
  434. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +1 -1
  435. package/examples/@xmachines/play-vue-demo/variables/App.md +1 -1
  436. package/examples/@xmachines/play-vue-demo/variables/authCatalog.md +1 -1
  437. package/guides/README.md +6 -44
  438. package/guides/getting-started.md +37 -37
  439. package/package.json +6 -3
  440. package/api/@xmachines/play-router/functions/createRouteMatcher.md +0 -53
  441. package/api/@xmachines/play-router/interfaces/RouteMatcher.md +0 -56
  442. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +0 -33
@@ -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:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L180)
5
+ Defined in: [packages/play-actor/src/abstract-actor.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L180)
6
6
 
7
7
  Abstract base class for Play Architecture actors.
8
8
 
@@ -33,7 +33,7 @@ Infrastructure layer communication.
33
33
  | <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` | - |
34
34
  | <a id="property-sessionid"></a> `sessionId` | `public` | `string` | The globally unique process ID for this invocation. | `Actor.sessionId` | - |
35
35
  | <a id="property-src"></a> `src` | `public` | \| `string` \| [`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic) | - | `Actor.src` | - |
36
- | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | - | [packages/play-actor/src/abstract-actor.ts:190](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L190) |
36
+ | <a id="property-state"></a> `state` | `abstract` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<`unknown`\> | Reactive snapshot of current actor state. Infrastructure observes this signal to react to state changes without directly coupling to the actor's internal state machine implementation. | - | [packages/play-actor/src/abstract-actor.ts:190](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L190) |
37
37
  | <a id="property-system"></a> `system` | `public` | [`AnyActorSystem`](https://www.jsdocs.io/package/xstate#AnyActorSystem) | The system to which this actor belongs. | `Actor.system` | - |
38
38
  | <a id="property-systemid"></a> `systemId` | `public` | `string` \| `undefined` | - | `Actor.systemId` | - |
39
39
 
@@ -45,7 +45,7 @@ Infrastructure layer communication.
45
45
  observable: InteropSubscribable<SnapshotFrom<TLogic>>;
46
46
  ```
47
47
 
48
- Defined in: `xstate`
48
+ Defined in: `.pnpm`
49
49
 
50
50
  #### Returns
51
51
 
@@ -65,7 +65,7 @@ Actor.[observable]
65
65
  getPersistedSnapshot(): Snapshot<unknown>;
66
66
  ```
67
67
 
68
- Defined in: `xstate`
68
+ Defined in: `.pnpm`
69
69
 
70
70
  Obtain the internal state of the actor, which can be persisted.
71
71
 
@@ -101,7 +101,7 @@ Actor.getPersistedSnapshot;
101
101
  getSnapshot(): SnapshotFrom<TLogic>;
102
102
  ```
103
103
 
104
- Defined in: `xstate`
104
+ Defined in: `.pnpm`
105
105
 
106
106
  Read an actor’s snapshot synchronously.
107
107
 
@@ -138,7 +138,7 @@ Actor.getSnapshot;
138
138
  on<TType>(type, handler): Subscription;
139
139
  ```
140
140
 
141
- Defined in: `xstate`
141
+ Defined in: `.pnpm`
142
142
 
143
143
  #### Type Parameters
144
144
 
@@ -171,7 +171,7 @@ Actor.on;
171
171
  select<TSelected>(selector, equalityFn?): Readable<TSelected>;
172
172
  ```
173
173
 
174
- Defined in: `xstate`
174
+ Defined in: `.pnpm`
175
175
 
176
176
  #### Type Parameters
177
177
 
@@ -204,7 +204,7 @@ Actor.select;
204
204
  abstract send(event): void;
205
205
  ```
206
206
 
207
- Defined in: [packages/play-actor/src/abstract-actor.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L197)
207
+ Defined in: [packages/play-actor/src/abstract-actor.ts:197](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L197)
208
208
 
209
209
  Send event to Actor.
210
210
 
@@ -234,7 +234,7 @@ Actor.send;
234
234
  start(): this;
235
235
  ```
236
236
 
237
- Defined in: `xstate`
237
+ Defined in: `.pnpm`
238
238
 
239
239
  Starts the Actor from the initial state
240
240
 
@@ -256,7 +256,7 @@ Actor.start;
256
256
  stop(): this;
257
257
  ```
258
258
 
259
- Defined in: `xstate`
259
+ Defined in: `.pnpm`
260
260
 
261
261
  Stops the Actor and unsubscribe all listeners.
262
262
 
@@ -280,7 +280,7 @@ Actor.stop;
280
280
  subscribe(observer): Subscription;
281
281
  ```
282
282
 
283
- Defined in: `xstate`
283
+ Defined in: `.pnpm`
284
284
 
285
285
  Subscribe an observer to an actor’s snapshot values.
286
286
 
@@ -358,7 +358,7 @@ subscribe(
358
358
  completeListener?): Subscription;
359
359
  ```
360
360
 
361
- Defined in: `xstate`
361
+ Defined in: `.pnpm`
362
362
 
363
363
  Subscribe an observer to an actor’s snapshot values.
364
364
 
@@ -437,7 +437,7 @@ Actor.subscribe;
437
437
  toJSON(): object;
438
438
  ```
439
439
 
440
- Defined in: `xstate`
440
+ Defined in: `.pnpm`
441
441
 
442
442
  #### Returns
443
443
 
@@ -2,11 +2,11 @@
2
2
 
3
3
  # Interface: PlayActor
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L297)
5
+ Defined in: [packages/play-router/src/types.ts:297](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L297)
6
6
 
7
7
  Full actor shape used by `PlayRouterProvider` components across all framework
8
- adapters (`play-solid-router`, `play-tanstack-solid-router`, `play-vue-router`,
9
- `play-tanstack-react-router`, `play-react-router`).
8
+ adapters (`play-solid-router`, `play-vue-router`, `play-react-router`, and the
9
+ adapters built on the shared framework-router bridge bases).
10
10
 
11
11
  Extends `RoutableActor` with `currentView` — the provider renders the current
12
12
  view spec in addition to synchronizing routes, so it needs both capabilities.
@@ -37,9 +37,9 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
37
37
 
38
38
  | Property | Modifier | Type | Description | Inherited from | Defined in |
39
39
  | ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
40
- | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [packages/play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L261) |
41
- | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [packages/play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L299) |
42
- | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [packages/play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L267) |
40
+ | <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | TC39 Signal exposing the actor's current URL path (or state ID). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [packages/play-router/src/types.ts:261](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L261) |
41
+ | <a id="property-currentview"></a> `currentView` | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | TC39 Signal exposing the actor's current view spec, or `null` when inactive. | - | [packages/play-router/src/types.ts:299](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L299) |
42
+ | <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null` | The route derived from the machine's initial state — fixed at construction. Router bridges compare this against the browser URL to distinguish a deep-link (router wins) from a session restore (actor wins). | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [packages/play-router/src/types.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L267) |
43
43
 
44
44
  ## Methods
45
45
 
@@ -49,7 +49,7 @@ function MyRouterProvider({ actor }: { actor: PlayActor }) {
49
49
  send(event): void;
50
50
  ```
51
51
 
52
- Defined in: [packages/play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L269)
52
+ Defined in: [packages/play-router/src/types.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L269)
53
53
 
54
54
  Send a route navigation event to the actor.
55
55
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: PlayRouteEvent
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L225)
5
+ Defined in: [packages/play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L225)
6
6
 
7
7
  Enhanced routing event with parameter and query support
8
8
 
@@ -22,22 +22,32 @@ via `play.route` events, Actor decides via state machine transitions.
22
22
 
23
23
  ## Param
24
24
 
25
+ **type**
26
+
25
27
  Event discriminator (always "play.route")
26
28
 
27
29
  ## Param
28
30
 
31
+ **to**
32
+
29
33
  Target state ID with # prefix (e.g., '#home', '#profile')
30
34
 
31
35
  ## Param
32
36
 
37
+ **params**
38
+
33
39
  Path-only route parameters extracted from the URL path (e.g., `{ userId: '123' }` from `/profile/123`). Query parameters are kept separate in `query`.
34
40
 
35
41
  ## Param
36
42
 
43
+ **query**
44
+
37
45
  Query parameters only (isolated from path params)
38
46
 
39
47
  ## Param
40
48
 
49
+ **match**
50
+
41
51
  Full URLPattern match result for debugging/observability (optional)
42
52
 
43
53
  ## Examples
@@ -112,8 +122,8 @@ URLPatternResult for advanced use cases (debugging, pattern analysis).
112
122
 
113
123
  | Property | Modifier | Type | Defined in |
114
124
  | -------------------------------------- | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
115
- | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [packages/play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L230) |
116
- | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L228) |
117
- | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L229) |
118
- | <a id="property-to"></a> `to` | `readonly` | `string` | [packages/play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L227) |
119
- | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [packages/play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L226) |
125
+ | <a id="property-match"></a> `match?` | `readonly` | `unknown` | [packages/play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L230) |
126
+ | <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:228](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L228) |
127
+ | <a id="property-query"></a> `query?` | `readonly` | `Record`\<`string`, `string`\> | [packages/play-router/src/types.ts:229](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L229) |
128
+ | <a id="property-to"></a> `to` | `readonly` | `string` | [packages/play-router/src/types.ts:227](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L227) |
129
+ | <a id="property-type"></a> `type` | `readonly` | `"play.route"` | [packages/play-router/src/types.ts:226](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L226) |
@@ -0,0 +1,30 @@
1
+ [API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / PlayRouterProviderBaseProps
2
+
3
+ # Interface: PlayRouterProviderBaseProps\<TRouter, TActor\>
4
+
5
+ Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/create-play-router-provider.tsx#L37)
6
+
7
+ Props shared by every factory-created Solid `PlayRouterProvider`.
8
+
9
+ Adapter packages re-export a concrete alias with `TRouter` bound to their
10
+ router type (e.g. `SolidRouterHooks` in `@xmachines/play-solid-router`).
11
+
12
+ ## Extended by
13
+
14
+ - [`PlayRouterProviderProps`](PlayRouterProviderProps.md)
15
+
16
+ ## Type Parameters
17
+
18
+ | Type Parameter | Default type |
19
+ | ---------------------------------------------- | --------------------------- |
20
+ | `TRouter` | - |
21
+ | `TActor` _extends_ [`PlayActor`](PlayActor.md) | [`PlayActor`](PlayActor.md) |
22
+
23
+ ## Properties
24
+
25
+ | Property | Type | Description | Defined in |
26
+ | ----------------------------------------- | ------------------------------------ | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
27
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [packages/play-solid-router/src/create-play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/create-play-router-provider.tsx#L39) |
28
+ | <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/create-play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/create-play-router-provider.tsx#L45) |
29
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [packages/play-solid-router/src/create-play-router-provider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/create-play-router-provider.tsx#L43) |
30
+ | <a id="property-router"></a> `router` | `TRouter` | The router the bridge synchronizes with. | [packages/play-solid-router/src/create-play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/create-play-router-provider.tsx#L41) |
@@ -2,7 +2,17 @@
2
2
 
3
3
  # Interface: PlayRouterProviderProps\<TActor\>
4
4
 
5
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid-router/src/play-router-provider.tsx#L33)
5
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/play-router-provider.tsx#L50)
6
+
7
+ Props for the Solid Router `PlayRouterProvider`.
8
+
9
+ `router` bundles the three Solid Router hook results that drive bidirectional
10
+ sync. Obtain these from `useNavigate()`, `useLocation()`, and `useParams()`
11
+ in the parent component (they must be called inside a router context).
12
+
13
+ ## Extends
14
+
15
+ - [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md)\<[`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md), `TActor`\>
6
16
 
7
17
  ## Type Parameters
8
18
 
@@ -12,9 +22,9 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:33](https:/
12
22
 
13
23
  ## Properties
14
24
 
15
- | Property | Type | Description | Defined in |
16
- | ----------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
17
- | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with Solid Router. | [packages/play-solid-router/src/play-router-provider.tsx:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid-router/src/play-router-provider.tsx#L35) |
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:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid-router/src/play-router-provider.tsx#L45) |
19
- | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [packages/play-solid-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid-router/src/play-router-provider.tsx#L37) |
20
- | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | The three Solid Router hook results that drive bidirectional sync. Obtain these from `useNavigate()`, `useLocation()`, and `useParams()` in the parent component (they must be called inside a router context). | [packages/play-solid-router/src/play-router-provider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid-router/src/play-router-provider.tsx#L43) |
25
+ | Property | Type | Description | Inherited from | Defined in |
26
+ | ----------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
27
+ | <a id="property-actor"></a> `actor` | `TActor` | The actor to sync with the router. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`actor`](PlayRouterProviderBaseProps.md#property-actor) | [packages/play-solid-router/src/create-play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/create-play-router-provider.tsx#L39) |
28
+ | <a id="property-renderer"></a> `renderer` | (`actor`, `router`) => `any` | Renderer callback receives the same concrete actor type that was passed in. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`renderer`](PlayRouterProviderBaseProps.md#property-renderer) | [packages/play-solid-router/src/create-play-router-provider.tsx:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/create-play-router-provider.tsx#L45) |
29
+ | <a id="property-routemap"></a> `routeMap` | [`RouteMap`](../classes/RouteMap.md) | Bidirectional route map for state ID ↔ URL path lookups. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`routeMap`](PlayRouterProviderBaseProps.md#property-routemap) | [packages/play-solid-router/src/create-play-router-provider.tsx:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/create-play-router-provider.tsx#L43) |
30
+ | <a id="property-router"></a> `router` | [`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md) | The router the bridge synchronizes with. | [`PlayRouterProviderBaseProps`](PlayRouterProviderBaseProps.md).[`router`](PlayRouterProviderBaseProps.md#property-router) | [packages/play-solid-router/src/create-play-router-provider.tsx:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/create-play-router-provider.tsx#L41) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapOptions
4
4
 
5
- Defined in: [packages/play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/create-route-map.ts#L9)
5
+ Defined in: [packages/play-router/src/create-route-map.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/create-route-map.ts#L9)
6
6
 
7
7
  Options for `createRouteMap` and `createRouteMapFromTree`.
8
8
 
@@ -10,4 +10,4 @@ Options for `createRouteMap` and `createRouteMapFromTree`.
10
10
 
11
11
  | Property | Type | Description | Defined in |
12
12
  | -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [packages/play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/create-route-map.ts#L20) |
13
+ | <a id="property-cachesize"></a> `cacheSize?` | `number` | Maximum number of resolved parameterized path lookups to cache. `RouteMap.getStateIdByPath()` resolves parameterized patterns (e.g. `/profile/:userId`) via URLPattern on every call. Frequently visited paths are cached in an LRU so subsequent lookups are O(1). Increase this value for applications with large parameterized route sets or high navigation frequency. Default: `500`. | [packages/play-router/src/create-route-map.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/create-route-map.ts#L20) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouteMapping
4
4
 
5
- Defined in: [packages/play-router/src/base-route-map.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L57)
5
+ Defined in: [packages/play-router/src/base-route-map.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L51)
6
6
 
7
7
  A single state ID ↔ path mapping entry.
8
8
 
@@ -23,5 +23,5 @@ const optionalMapping: RouteMapping = { stateId: "settings", path: "/settings/:s
23
23
 
24
24
  | Property | Modifier | Type | Description | Defined in |
25
25
  | --------------------------------------- | ---------- | -------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [packages/play-router/src/base-route-map.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L61) |
27
- | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [packages/play-router/src/base-route-map.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/base-route-map.ts#L59) |
26
+ | <a id="property-path"></a> `path` | `readonly` | `string` | URL path pattern (e.g., `"/"`, `"/profile/:userId"`, `"/settings/:section?"`) | [packages/play-router/src/base-route-map.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L55) |
27
+ | <a id="property-stateid"></a> `stateId` | `readonly` | `string` | State machine state ID (e.g., `"home"`, `"#profile"`) | [packages/play-router/src/base-route-map.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/base-route-map.ts#L53) |
@@ -2,11 +2,11 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [packages/play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L341)
5
+ Defined in: [packages/play-router/src/types.ts:341](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L341)
6
6
 
7
7
  RouterBridge interface for runtime infrastructure adapters
8
8
 
9
- Defines the lifecycle connection between Infrastructure (e.g., TanStack Router) and
9
+ Defines the lifecycle connection between Infrastructure (e.g., a framework router) and
10
10
  the Actor. Infrastructure "bridges" to the Actor by observing its signals and
11
11
  managing its own lifecycle accordingly.
12
12
 
@@ -16,13 +16,13 @@ a unidirectional observation pattern. Infrastructure connects to observe Actor s
16
16
 
17
17
  ## Example
18
18
 
19
- TanStack Router bridge implementation
19
+ Framework router bridge implementation
20
20
 
21
21
  ```typescript
22
22
  import type { RouterBridge } from "@xmachines/play-router";
23
23
  import { Signal } from "@xmachines/play-signals";
24
24
 
25
- class TanStackRouterBridge implements RouterBridge {
25
+ class MyRouterBridge implements RouterBridge {
26
26
  private watcher: Signal.Watcher | null = null;
27
27
 
28
28
  async connect(): Promise<void> {
@@ -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:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L357)
57
+ Defined in: [packages/play-router/src/types.ts:357](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L357)
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:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-router/src/types.ts#L373)
86
+ Defined in: [packages/play-router/src/types.ts:373](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-router/src/types.ts#L373)
87
87
 
88
88
  Disconnect the router bridge from the Actor
89
89
 
@@ -0,0 +1,34 @@
1
+ [API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / PlayRouterBridgeConstructor
2
+
3
+ # Type Alias: PlayRouterBridgeConstructor\<TRouter\>
4
+
5
+ ```ts
6
+ type PlayRouterBridgeConstructor<TRouter> = (router, actor, routeMap) => RouterBridge;
7
+ ```
8
+
9
+ Defined in: [packages/play-solid-router/src/create-play-router-provider.tsx:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/create-play-router-provider.tsx#L25)
10
+
11
+ Constructor shape a bridge class must satisfy to be used with
12
+ `createPlayRouterProvider`: `(router, actor, routeMap) → RouterBridge`.
13
+
14
+ Bridges with a different constructor shape (e.g. `SolidRouterBridge`, which
15
+ takes the hook results as separate arguments) are adapted with a thin
16
+ subclass that repackages the `router` prop.
17
+
18
+ ## Type Parameters
19
+
20
+ | Type Parameter |
21
+ | -------------- |
22
+ | `TRouter` |
23
+
24
+ ## Parameters
25
+
26
+ | Parameter | Type |
27
+ | ---------- | ----------------------------------------- |
28
+ | `router` | `TRouter` |
29
+ | `actor` | [`PlayActor`](../interfaces/PlayActor.md) |
30
+ | `routeMap` | [`RouteMap`](../classes/RouteMap.md) |
31
+
32
+ ## Returns
33
+
34
+ [`RouterBridge`](../interfaces/RouterBridge.md)
@@ -6,7 +6,7 @@
6
6
  type RoutableActor = PlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid-router/src/play-router-provider.tsx#L9)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/play-router-provider.tsx#L19)
10
10
 
11
11
  ## Deprecated
12
12
 
@@ -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:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid-router/src/play-router-provider.tsx#L27)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/play-router-provider.tsx#L37)
10
10
 
11
11
  The three Solid Router hook results that `PlayRouterProvider` and `SolidRouterBridge`
12
12
  require. Pass these directly from your component's hook calls:
@@ -31,7 +31,7 @@ const params = useParams(); // → SolidRouterHooks.params
31
31
  location: Location;
32
32
  ```
33
33
 
34
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid-router/src/play-router-provider.tsx#L29)
34
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:39](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/play-router-provider.tsx#L39)
35
35
 
36
36
  ---
37
37
 
@@ -41,7 +41,7 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:29](https:/
41
41
  navigate: Navigator;
42
42
  ```
43
43
 
44
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid-router/src/play-router-provider.tsx#L28)
44
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/play-router-provider.tsx#L38)
45
45
 
46
46
  ---
47
47
 
@@ -51,4 +51,4 @@ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:28](https:/
51
51
  params: Params;
52
52
  ```
53
53
 
54
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid-router/src/play-router-provider.tsx#L30)
54
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:40](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/play-router-provider.tsx#L40)
@@ -1,12 +1,12 @@
1
1
  [API](../../../README.md) / [@xmachines/play-solid-router](../README.md) / PlayRouterProvider
2
2
 
3
- # Function: PlayRouterProvider()
3
+ # Variable: PlayRouterProvider
4
4
 
5
5
  ```ts
6
- function PlayRouterProvider<TActor>(props): any;
6
+ const PlayRouterProvider: <TActor>(props) => any;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-solid-router/src/play-router-provider.tsx:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-solid-router/src/play-router-provider.tsx#L76)
9
+ Defined in: [packages/play-solid-router/src/play-router-provider.tsx:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-solid-router/src/play-router-provider.tsx#L92)
10
10
 
11
11
  Connects a `PlayerActor` to Solid Router, keeping actor state and browser URL
12
12
  in sync bidirectionally.
@@ -43,9 +43,9 @@ function AppShell() {
43
43
 
44
44
  ## Parameters
45
45
 
46
- | Parameter | Type |
47
- | --------- | --------------------------------------------------------------------------------- |
48
- | `props` | [`PlayRouterProviderProps`](../interfaces/PlayRouterProviderProps.md)\<`TActor`\> |
46
+ | Parameter | Type |
47
+ | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
48
+ | `props` | [`PlayRouterProviderBaseProps`](../interfaces/PlayRouterProviderBaseProps.md)\<[`SolidRouterHooks`](../type-aliases/SolidRouterHooks.md), `TActor`\> |
49
49
 
50
50
  ## Returns
51
51
 
@@ -6,7 +6,7 @@
6
6
  function defineRegistry<C>(catalog, options): DefineRegistryResult;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/define-registry.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-svelte/src/define-registry.ts#L153)
9
+ Defined in: [packages/play-svelte/src/define-registry.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-svelte/src/define-registry.ts#L154)
10
10
 
11
11
  Create a component registry, restoring catalog-typed `params` on action handlers.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function getActorContext(): AnyPlayActor;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-svelte/src/actor-context.svelte.ts#L38)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-svelte/src/actor-context.svelte.ts#L38)
10
10
 
11
11
  Get the actor from the nearest ActorProvider ancestor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function getPlayViewContext(): ViewContextValue;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-svelte/src/actor-context.svelte.ts#L59)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-svelte/src/actor-context.svelte.ts#L59)
10
10
 
11
11
  Get the current view context from the nearest ActorProvider ancestor.
12
12
 
@@ -6,7 +6,7 @@
6
6
  function setActorContext(actor): void;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-svelte/src/actor-context.svelte.ts#L28)
9
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-svelte/src/actor-context.svelte.ts#L28)
10
10
 
11
11
  ## Parameters
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: ActorProviderProps
4
4
 
5
- Defined in: [packages/play-svelte/src/actor-context.svelte.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-svelte/src/actor-context.svelte.ts#L68)
5
+ Defined in: [packages/play-svelte/src/actor-context.svelte.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-svelte/src/actor-context.svelte.ts#L68)
6
6
 
7
7
  Framework-agnostic base props shared by every `ActorProvider` implementation
8
8
  (React, Vue, Solid, Svelte). `TRegistry` captures the framework-specific
@@ -35,10 +35,10 @@ interface ActorProviderProps extends BaseActorProviderProps<DefineRegistryResult
35
35
 
36
36
  | Property | Type | Description | Inherited from | Defined in |
37
37
  | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
38
- | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L154) |
39
- | <a id="property-children"></a> `children` | `Snippet` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-svelte/src/actor-context.svelte.ts#L71) |
40
- | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-svelte/src/actor-context.svelte.ts#L69) |
41
- | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-svelte/src/actor-context.svelte.ts#L70) |
42
- | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../../play-dom/type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L167) |
43
- | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L156) |
44
- | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.52/packages/play-actor/src/abstract-actor.ts#L162) |
38
+ | <a id="property-actor"></a> `actor` | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<[`AnyActorLogic`](https://www.jsdocs.io/package/xstate#AnyActorLogic), [`EventObject`](https://www.jsdocs.io/package/xstate#EventObject)\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability). | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`actor`](../../play-actor/interfaces/BaseActorProviderProps.md#property-actor) | [packages/play-actor/src/abstract-actor.ts:154](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L154) |
39
+ | <a id="property-children"></a> `children` | `Snippet` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:71](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-svelte/src/actor-context.svelte.ts#L71) |
40
+ | <a id="property-fallback"></a> `fallback?` | `Snippet`\<\[\]\> | - | - | [packages/play-svelte/src/actor-context.svelte.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-svelte/src/actor-context.svelte.ts#L69) |
41
+ | <a id="property-onerror"></a> `onError?` | (`error`, `reset`) => `void` | - | - | [packages/play-svelte/src/actor-context.svelte.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-svelte/src/actor-context.svelte.ts#L70) |
42
+ | <a id="property-onrendererror"></a> `onRenderError?` | [`RenderErrorHandler`](../../play-dom/type-aliases/RenderErrorHandler.md) | Called when an individual catalog component throws during render. Takes precedence over any onRenderError set via defineRegistry. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`onRenderError`](../../play-actor/interfaces/BaseActorProviderProps.md#property-onrendererror) | [packages/play-actor/src/abstract-actor.ts:167](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L167) |
43
+ | <a id="property-registryresult"></a> `registryResult` | `DefineRegistryResult` | Full result from defineRegistry() — contains the component registry and action handlers factory. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`registryResult`](../../play-actor/interfaces/BaseActorProviderProps.md#property-registryresult) | [packages/play-actor/src/abstract-actor.ts:156](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L156) |
44
+ | <a id="property-store"></a> `store?` | `StateStore` | Optional external StateStore (controlled mode). When provided, spec.state is ignored and this store is the single source of truth. When omitted, a fresh @xstate/store atom is created per view transition from spec.state. | [`BaseActorProviderProps`](../../play-actor/interfaces/BaseActorProviderProps.md).[`store`](../../play-actor/interfaces/BaseActorProviderProps.md#property-store) | [packages/play-actor/src/abstract-actor.ts:162](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-actor/src/abstract-actor.ts#L162) |