@xmachines/docs 6.1.0 → 7.1.0

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 (810) hide show
  1. package/README.md +4 -4
  2. package/api/@xmachines/core/README.md +7 -2
  3. package/api/@xmachines/core/cache/functions/createLruCache.md +7 -7
  4. package/api/@xmachines/core/cache/interfaces/KeyValueCache.md +6 -6
  5. package/api/@xmachines/core/errors/classes/BaseError.md +15 -23
  6. package/api/@xmachines/core/errors/classes/DisposeConflictError.md +11 -11
  7. package/api/@xmachines/core/utils/functions/asDisposable.md +9 -9
  8. package/api/@xmachines/core/utils/functions/createNullRecord.md +4 -4
  9. package/api/@xmachines/core/utils/functions/createWarnOnce.md +1 -1
  10. package/api/@xmachines/core/utils/functions/describeValue.md +1 -1
  11. package/api/@xmachines/core/utils/functions/isError.md +1 -1
  12. package/api/@xmachines/core/utils/functions/isThenable.md +4 -4
  13. package/api/@xmachines/core/utils/functions/releaseQuietly.md +1 -1
  14. package/api/@xmachines/core/utils/functions/rethrowLater.md +1 -1
  15. package/api/@xmachines/core/utils/functions/safeString.md +1 -1
  16. package/api/@xmachines/core/utils/functions/shallowEqualExcept.md +1 -1
  17. package/api/@xmachines/core/utils/type-aliases/DisposeKey.md +1 -1
  18. package/api/@xmachines/core/utils/type-aliases/DisposeMember.md +1 -1
  19. package/api/@xmachines/core/utils/variables/DISPOSE.md +1 -1
  20. package/api/@xmachines/play/README.md +10 -5
  21. package/api/@xmachines/play/errors/classes/NonNullableError.md +11 -11
  22. package/api/@xmachines/play/errors/classes/PlayError.md +12 -11
  23. package/api/@xmachines/play/index/functions/assertNonNullable.md +4 -4
  24. package/api/@xmachines/play/index/type-aliases/PlayEvent.md +9 -9
  25. package/api/@xmachines/play-actor/README.md +12 -2
  26. package/api/@xmachines/play-actor/interfaces/ActorEvent.md +4 -4
  27. package/api/@xmachines/play-actor/interfaces/PlayActor.md +9 -9
  28. package/api/@xmachines/play-atom/README.md +16 -4
  29. package/api/@xmachines/play-atom/functions/watchAtom.md +4 -4
  30. package/api/@xmachines/play-atom/interfaces/AsyncAtomOptions.md +4 -4
  31. package/api/@xmachines/play-atom/interfaces/Atom.md +9 -9
  32. package/api/@xmachines/play-atom/interfaces/AtomObserver.md +9 -9
  33. package/api/@xmachines/play-atom/interfaces/AtomOptions.md +7 -7
  34. package/api/@xmachines/play-atom/interfaces/AtomSubscription.md +2 -2
  35. package/api/@xmachines/play-atom/interfaces/BaseAtom.md +7 -7
  36. package/api/@xmachines/play-atom/interfaces/CreateAtom.md +9 -9
  37. package/api/@xmachines/play-atom/interfaces/Readable.md +7 -7
  38. package/api/@xmachines/play-atom/interfaces/ReadonlyAtom.md +7 -7
  39. package/api/@xmachines/play-atom/type-aliases/AnyAtom.md +1 -1
  40. package/api/@xmachines/play-atom/type-aliases/AsyncAtomState.md +5 -5
  41. package/api/@xmachines/play-atom/variables/createAsyncAtom.md +4 -4
  42. package/api/@xmachines/play-atom/variables/createAtom.md +1 -1
  43. package/api/@xmachines/play-atom/variables/createWritableAtom.md +4 -4
  44. package/api/@xmachines/play-dom/README.md +131 -48
  45. package/api/@xmachines/play-dom/classes/PlayRenderer.md +12 -12
  46. package/api/@xmachines/play-dom/functions/createPlayUI.md +5 -5
  47. package/api/@xmachines/play-dom/functions/createRenderer.md +4 -4
  48. package/api/@xmachines/play-dom/functions/defineRegistry.md +3 -3
  49. package/api/@xmachines/play-dom/functions/renderSpec.md +3 -2
  50. package/api/@xmachines/play-dom/interfaces/ComponentContext.md +13 -13
  51. package/api/@xmachines/play-dom/interfaces/CreatePlayUIOptions.md +17 -15
  52. package/api/@xmachines/play-dom/interfaces/DomRenderContext.md +26 -20
  53. package/api/@xmachines/play-dom/interfaces/MountOptions.md +5 -5
  54. package/api/@xmachines/play-dom/interfaces/PassOptions.md +14 -0
  55. package/api/@xmachines/play-dom/interfaces/PlayDomOptions.md +18 -17
  56. package/api/@xmachines/play-dom/interfaces/RenderErrorInfo.md +16 -0
  57. package/api/@xmachines/play-dom/interfaces/RenderSpecOptions.md +17 -15
  58. package/api/@xmachines/play-dom/interfaces/UIProviderOptions.md +9 -8
  59. package/api/@xmachines/play-dom/interfaces/ValidationRegistry.md +14 -11
  60. package/api/@xmachines/play-dom/type-aliases/ActionFn.md +4 -4
  61. package/api/@xmachines/play-dom/type-aliases/Actions.md +3 -3
  62. package/api/@xmachines/play-dom/type-aliases/BaseComponentProps.md +4 -4
  63. package/api/@xmachines/play-dom/type-aliases/CatalogHasActions.md +3 -3
  64. package/api/@xmachines/play-dom/type-aliases/ComponentFn.md +4 -4
  65. package/api/@xmachines/play-dom/type-aliases/ComponentRegistry.md +3 -3
  66. package/api/@xmachines/play-dom/type-aliases/ConfirmHandler.md +9 -10
  67. package/api/@xmachines/play-dom/type-aliases/DefineRegistryOptions.md +10 -9
  68. package/api/@xmachines/play-dom/type-aliases/MountFn.md +1 -1
  69. package/api/@xmachines/play-dom/type-aliases/OnRenderError.md +27 -0
  70. package/api/@xmachines/play-dom/type-aliases/RenderErrorKind.md +21 -0
  71. package/api/@xmachines/play-dom-router/README.md +41 -5
  72. package/api/@xmachines/play-dom-router/classes/DomRouterBridge.md +7 -7
  73. package/api/@xmachines/play-dom-router/classes/RouteMap.md +5 -5
  74. package/api/@xmachines/play-dom-router/functions/connectRouter.md +1 -1
  75. package/api/@xmachines/play-dom-router/functions/createBrowserHistory.md +1 -1
  76. package/api/@xmachines/play-dom-router/functions/createRouter.md +1 -1
  77. package/api/@xmachines/play-dom-router/interfaces/BasePathOptions.md +5 -5
  78. package/api/@xmachines/play-dom-router/interfaces/BrowserHistory.md +16 -16
  79. package/api/@xmachines/play-dom-router/interfaces/BrowserWindow.md +16 -16
  80. package/api/@xmachines/play-dom-router/interfaces/ConnectRouterOptions.md +10 -10
  81. package/api/@xmachines/play-dom-router/interfaces/PlayRouteEvent.md +9 -9
  82. package/api/@xmachines/play-dom-router/interfaces/RoutableActor.md +6 -6
  83. package/api/@xmachines/play-dom-router/interfaces/RouteLookupContract.md +3 -3
  84. package/api/@xmachines/play-dom-router/interfaces/RouteMapOptions.md +6 -6
  85. package/api/@xmachines/play-dom-router/interfaces/RouteMapping.md +5 -5
  86. package/api/@xmachines/play-dom-router/interfaces/RouterBridge.md +3 -3
  87. package/api/@xmachines/play-dom-router/interfaces/RouterConnection.md +8 -8
  88. package/api/@xmachines/play-dom-router/interfaces/VanillaRouter.md +6 -6
  89. package/api/@xmachines/play-pattern/README.md +1 -1
  90. package/api/@xmachines/play-pattern/functions/buildPath.md +2 -2
  91. package/api/@xmachines/play-pattern/functions/createLruCache.md +7 -7
  92. package/api/@xmachines/play-pattern/functions/getIndexKey.md +1 -1
  93. package/api/@xmachines/play-pattern/functions/isDotSegment.md +1 -1
  94. package/api/@xmachines/play-pattern/functions/parsePattern.md +1 -1
  95. package/api/@xmachines/play-pattern/interfaces/GroupPart.md +6 -6
  96. package/api/@xmachines/play-pattern/interfaces/KeyValueCache.md +6 -6
  97. package/api/@xmachines/play-pattern/interfaces/LiteralPart.md +5 -5
  98. package/api/@xmachines/play-pattern/interfaces/ParamPart.md +9 -9
  99. package/api/@xmachines/play-pattern/interfaces/ParseOptions.md +4 -4
  100. package/api/@xmachines/play-pattern/interfaces/ParsedPattern.md +14 -14
  101. package/api/@xmachines/play-pattern/interfaces/PatternParam.md +6 -6
  102. package/api/@xmachines/play-pattern/type-aliases/PathBuildResult.md +1 -1
  103. package/api/@xmachines/play-pattern/type-aliases/PathParams.md +1 -1
  104. package/api/@xmachines/play-pattern/type-aliases/PatternModifier.md +1 -1
  105. package/api/@xmachines/play-pattern/type-aliases/PatternPart.md +1 -1
  106. package/api/@xmachines/play-react/README.md +57 -18
  107. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +36 -75
  108. package/api/@xmachines/play-react/functions/defineRegistry.md +4 -4
  109. package/api/@xmachines/play-react/functions/useActor.md +1 -1
  110. package/api/@xmachines/play-react/functions/useAtomEffect.md +2 -2
  111. package/api/@xmachines/play-react/functions/useBoundProp.md +3 -3
  112. package/api/@xmachines/play-react/functions/usePlayView.md +1 -1
  113. package/api/@xmachines/play-react/interfaces/ActionProviderProps.md +5 -5
  114. package/api/@xmachines/play-react/interfaces/ActorProviderProps.md +11 -11
  115. package/api/@xmachines/play-react/interfaces/ComponentContext.md +4 -4
  116. package/api/@xmachines/play-react/interfaces/DefineRegistryResult.md +15 -0
  117. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +8 -8
  118. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +6 -6
  119. package/api/@xmachines/play-react/interfaces/PlayUIProviderProps.md +15 -14
  120. package/api/@xmachines/play-react/interfaces/RenderErrorInfo.md +16 -0
  121. package/api/@xmachines/play-react/interfaces/RendererProps.md +7 -7
  122. package/api/@xmachines/play-react/interfaces/ViewContextValue.md +7 -7
  123. package/api/@xmachines/play-react/type-aliases/AnyPlayActor.md +1 -1
  124. package/api/@xmachines/play-react/type-aliases/ComponentFn.md +4 -4
  125. package/api/@xmachines/play-react/type-aliases/OnRenderError.md +27 -0
  126. package/api/@xmachines/play-react/type-aliases/RenderErrorKind.md +21 -0
  127. package/api/@xmachines/play-react/variables/ActorProvider.md +14 -4
  128. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  129. package/api/@xmachines/play-react/variables/PlayUIProvider.md +1 -1
  130. package/api/@xmachines/play-react-router/README.md +27 -6
  131. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +7 -7
  132. package/api/@xmachines/play-react-router/classes/RouteMap.md +5 -5
  133. package/api/@xmachines/play-react-router/functions/createPlayRouterProvider.md +5 -5
  134. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  135. package/api/@xmachines/play-react-router/interfaces/PlayRouteEvent.md +9 -9
  136. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +14 -14
  137. package/api/@xmachines/play-react-router/interfaces/RoutableActor.md +6 -6
  138. package/api/@xmachines/play-react-router/interfaces/RouteMapOptions.md +6 -6
  139. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +5 -5
  140. package/api/@xmachines/play-react-router/interfaces/RouterBridge.md +3 -3
  141. package/api/@xmachines/play-react-router/type-aliases/PlayRouterBridgeConstructor.md +6 -6
  142. package/api/@xmachines/play-react-router/type-aliases/PlayRouterProviderBaseProps.md +5 -5
  143. package/api/@xmachines/play-react-router/variables/PlayRouterProvider.md +4 -4
  144. package/api/@xmachines/play-router/README.md +73 -16
  145. package/api/@xmachines/play-router/errors/classes/DuplicateBridgeError.md +11 -11
  146. package/api/@xmachines/play-router/errors/classes/DuplicateRoutePathError.md +12 -12
  147. package/api/@xmachines/play-router/errors/classes/EmptyRoutePathError.md +12 -12
  148. package/api/@xmachines/play-router/errors/classes/InvalidBasePathError.md +12 -12
  149. package/api/@xmachines/play-router/errors/classes/InvalidRoutePatternError.md +12 -12
  150. package/api/@xmachines/play-router/errors/classes/InvalidStateIdError.md +12 -12
  151. package/api/@xmachines/play-router/errors/classes/MissingBasePathParamError.md +13 -13
  152. package/api/@xmachines/play-router/errors/classes/RouterSyncError.md +11 -11
  153. package/api/@xmachines/play-router/errors/classes/UnknownStateTypeError.md +13 -13
  154. package/api/@xmachines/play-router/index/classes/RouteMap.md +5 -5
  155. package/api/@xmachines/play-router/index/classes/RouterBridgeBase.md +14 -14
  156. package/api/@xmachines/play-router/index/functions/buildPlayRouteEvent.md +1 -1
  157. package/api/@xmachines/play-router/index/functions/buildRouteTree.md +4 -4
  158. package/api/@xmachines/play-router/index/functions/cleanFrameworkParams.md +1 -1
  159. package/api/@xmachines/play-router/index/functions/createLruCache.md +7 -7
  160. package/api/@xmachines/play-router/index/functions/createRouteMapFromTree.md +1 -1
  161. package/api/@xmachines/play-router/index/functions/createRouterConnection.md +1 -1
  162. package/api/@xmachines/play-router/index/functions/detectDuplicateRoutes.md +1 -1
  163. package/api/@xmachines/play-router/index/functions/extractQuery.md +1 -1
  164. package/api/@xmachines/play-router/index/functions/extractRouteParams.md +1 -1
  165. package/api/@xmachines/play-router/index/functions/findRouteById.md +1 -1
  166. package/api/@xmachines/play-router/index/functions/findRouteByPath.md +1 -1
  167. package/api/@xmachines/play-router/index/functions/isMountableBridge.md +1 -1
  168. package/api/@xmachines/play-router/index/functions/joinBasePath.md +1 -1
  169. package/api/@xmachines/play-router/index/functions/mountKey.md +1 -1
  170. package/api/@xmachines/play-router/index/functions/normalizeBasePath.md +1 -1
  171. package/api/@xmachines/play-router/index/functions/openProviderBridge.md +9 -9
  172. package/api/@xmachines/play-router/index/functions/parsePattern.md +1 -1
  173. package/api/@xmachines/play-router/index/functions/pickOwnParams.md +6 -6
  174. package/api/@xmachines/play-router/index/functions/repointProviderBridge.md +1 -1
  175. package/api/@xmachines/play-router/index/functions/resolveBasePath.md +1 -1
  176. package/api/@xmachines/play-router/index/functions/resolveFrameworkParams.md +1 -1
  177. package/api/@xmachines/play-router/index/functions/sanitizePathname.md +1 -1
  178. package/api/@xmachines/play-router/index/functions/splitLocation.md +1 -1
  179. package/api/@xmachines/play-router/index/functions/stripBasePath.md +1 -1
  180. package/api/@xmachines/play-router/index/functions/validateRouteFormat.md +1 -1
  181. package/api/@xmachines/play-router/index/functions/validateStateExists.md +1 -1
  182. package/api/@xmachines/play-router/index/interfaces/BasePathOptions.md +5 -5
  183. package/api/@xmachines/play-router/index/interfaces/BuildPlayRouteEventOptions.md +6 -6
  184. package/api/@xmachines/play-router/index/interfaces/CompileOptions.md +5 -5
  185. package/api/@xmachines/play-router/index/interfaces/FrameworkParamsSource.md +9 -9
  186. package/api/@xmachines/play-router/index/interfaces/KeyValueCache.md +6 -6
  187. package/api/@xmachines/play-router/index/interfaces/LocationLike.md +5 -5
  188. package/api/@xmachines/play-router/index/interfaces/MountableRouterBridge.md +8 -8
  189. package/api/@xmachines/play-router/index/interfaces/OpenProviderBridgeArgs.md +14 -14
  190. package/api/@xmachines/play-router/index/interfaces/ParseOptions.md +4 -4
  191. package/api/@xmachines/play-router/index/interfaces/ParsedPattern.md +14 -14
  192. package/api/@xmachines/play-router/index/interfaces/PlayRouteEvent.md +9 -9
  193. package/api/@xmachines/play-router/index/interfaces/PlayRouterProviderBaseProps.md +16 -16
  194. package/api/@xmachines/play-router/index/interfaces/ResolvedBasePath.md +5 -5
  195. package/api/@xmachines/play-router/index/interfaces/ResolvedRoutePath.md +5 -5
  196. package/api/@xmachines/play-router/index/interfaces/Routable.md +5 -5
  197. package/api/@xmachines/play-router/index/interfaces/RoutableActor.md +6 -6
  198. package/api/@xmachines/play-router/index/interfaces/RouteInfo.md +10 -10
  199. package/api/@xmachines/play-router/index/interfaces/RouteMapOptions.md +6 -6
  200. package/api/@xmachines/play-router/index/interfaces/RouteMapping.md +5 -5
  201. package/api/@xmachines/play-router/index/interfaces/RouteMatch.md +5 -5
  202. package/api/@xmachines/play-router/index/interfaces/RouteNode.md +12 -12
  203. package/api/@xmachines/play-router/index/interfaces/RouteObject.md +7 -7
  204. package/api/@xmachines/play-router/index/interfaces/RouteTree.md +10 -10
  205. package/api/@xmachines/play-router/index/interfaces/RouteWatcherHandle.md +3 -3
  206. package/api/@xmachines/play-router/index/interfaces/RouterBridge.md +3 -3
  207. package/api/@xmachines/play-router/index/interfaces/RouterBridgeOptions.md +10 -9
  208. package/api/@xmachines/play-router/index/interfaces/RouterConnection.md +8 -8
  209. package/api/@xmachines/play-router/index/interfaces/SplitLocation.md +7 -7
  210. package/api/@xmachines/play-router/index/interfaces/WindowLike.md +3 -3
  211. package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md +6 -6
  212. package/api/@xmachines/play-router/index/type-aliases/RouteData.md +1 -1
  213. package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md +1 -1
  214. package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md +1 -1
  215. package/api/@xmachines/play-router/index/type-aliases/URLPatternLike.md +3 -3
  216. package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md +1 -1
  217. package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md +1 -1
  218. package/api/@xmachines/play-router/xstate/functions/createRouteMap.md +1 -1
  219. package/api/@xmachines/play-router/xstate/functions/extractMachineRoutes.md +1 -1
  220. package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md +1 -1
  221. package/api/@xmachines/play-router/xstate/functions/getRoutableRoutes.md +1 -1
  222. package/api/@xmachines/play-router/xstate/functions/getRouteMappings.md +1 -1
  223. package/api/@xmachines/play-router/xstate/functions/getTransitionReachableRoutes.md +1 -1
  224. package/api/@xmachines/play-router/xstate/functions/isRouteReachable.md +1 -1
  225. package/api/@xmachines/play-router/xstate/functions/machineToGraph.md +1 -1
  226. package/api/@xmachines/play-router/xstate/functions/routeExists.md +1 -1
  227. package/api/@xmachines/play-router/xstate/interfaces/MachineEdgeData.md +5 -5
  228. package/api/@xmachines/play-router/xstate/interfaces/MachineNodeData.md +7 -7
  229. package/api/@xmachines/play-router/xstate/type-aliases/MachineGraph.md +1 -1
  230. package/api/@xmachines/play-solid/README.md +35 -11
  231. package/api/@xmachines/play-solid/functions/defineRegistry.md +3 -3
  232. package/api/@xmachines/play-solid/functions/useActor.md +1 -1
  233. package/api/@xmachines/play-solid/functions/useBoundProp.md +11 -8
  234. package/api/@xmachines/play-solid/functions/useFieldValidation.md +6 -4
  235. package/api/@xmachines/play-solid/functions/usePlayView.md +1 -1
  236. package/api/@xmachines/play-solid/functions/useStateBinding.md +8 -6
  237. package/api/@xmachines/play-solid/functions/useStateValue.md +8 -6
  238. package/api/@xmachines/play-solid/interfaces/ActorProviderProps.md +10 -10
  239. package/api/@xmachines/play-solid/interfaces/ComponentContext.md +4 -4
  240. package/api/@xmachines/play-solid/interfaces/PlayUIProviderProps.md +15 -14
  241. package/api/@xmachines/play-solid/interfaces/RenderErrorInfo.md +16 -0
  242. package/api/@xmachines/play-solid/interfaces/RendererProps.md +7 -7
  243. package/api/@xmachines/play-solid/interfaces/ViewContextValue.md +7 -7
  244. package/api/@xmachines/play-solid/type-aliases/AnyPlayActor.md +1 -1
  245. package/api/@xmachines/play-solid/type-aliases/ComponentFn.md +4 -4
  246. package/api/@xmachines/play-solid/type-aliases/OnRenderError.md +27 -0
  247. package/api/@xmachines/play-solid/type-aliases/RenderErrorKind.md +21 -0
  248. package/api/@xmachines/play-solid/variables/ActorContext.md +1 -1
  249. package/api/@xmachines/play-solid/variables/ActorProvider.md +17 -3
  250. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  251. package/api/@xmachines/play-solid/variables/PlayUIProvider.md +1 -1
  252. package/api/@xmachines/play-solid-router/README.md +22 -6
  253. package/api/@xmachines/play-solid-router/classes/RouteMap.md +5 -5
  254. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  255. package/api/@xmachines/play-solid-router/functions/createPlayRouterProvider.md +5 -5
  256. package/api/@xmachines/play-solid-router/interfaces/PlayActor.md +9 -9
  257. package/api/@xmachines/play-solid-router/interfaces/PlayRouteEvent.md +9 -9
  258. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +14 -14
  259. package/api/@xmachines/play-solid-router/interfaces/RoutableActor.md +6 -6
  260. package/api/@xmachines/play-solid-router/interfaces/RouteMapOptions.md +6 -6
  261. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +5 -5
  262. package/api/@xmachines/play-solid-router/interfaces/RouterBridge.md +3 -3
  263. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterBridgeConstructor.md +6 -6
  264. package/api/@xmachines/play-solid-router/type-aliases/PlayRouterProviderBaseProps.md +5 -5
  265. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  266. package/api/@xmachines/play-solid-router/variables/PlayRouterProvider.md +4 -4
  267. package/api/@xmachines/play-svelte/README.md +18 -10
  268. package/api/@xmachines/play-svelte/functions/defineRegistry.md +6 -7
  269. package/api/@xmachines/play-svelte/functions/getActorContext.md +1 -1
  270. package/api/@xmachines/play-svelte/functions/getPlayViewContext.md +1 -1
  271. package/api/@xmachines/play-svelte/functions/setActorContext.md +1 -1
  272. package/api/@xmachines/play-svelte/interfaces/ActorProviderProps.md +12 -12
  273. package/api/@xmachines/play-svelte/interfaces/BaseComponentProps.md +13 -13
  274. package/api/@xmachines/play-svelte/interfaces/ComponentContext.md +14 -14
  275. package/api/@xmachines/play-svelte/interfaces/DefineRegistryOptions.md +11 -11
  276. package/api/@xmachines/play-svelte/interfaces/DefineRegistryResult.md +15 -0
  277. package/api/@xmachines/play-svelte/interfaces/PlayUIProviderProps.md +14 -14
  278. package/api/@xmachines/play-svelte/interfaces/RenderErrorInfo.md +16 -0
  279. package/api/@xmachines/play-svelte/interfaces/ViewContextValue.md +7 -7
  280. package/api/@xmachines/play-svelte/type-aliases/ActionFn.md +4 -4
  281. package/api/@xmachines/play-svelte/type-aliases/Actions.md +3 -3
  282. package/api/@xmachines/play-svelte/type-aliases/AnyPlayActor.md +1 -1
  283. package/api/@xmachines/play-svelte/type-aliases/ComponentFn.md +4 -4
  284. package/api/@xmachines/play-svelte/type-aliases/OnRenderError.md +27 -0
  285. package/api/@xmachines/play-svelte/type-aliases/RenderErrorKind.md +21 -0
  286. package/api/@xmachines/play-svelte-spa-router/README.md +9 -5
  287. package/api/@xmachines/play-svelte-spa-router/classes/RouteMap.md +5 -5
  288. package/api/@xmachines/play-svelte-spa-router/classes/SvelteSpaRouterBridge.md +8 -8
  289. package/api/@xmachines/play-svelte-spa-router/functions/connectRouter.md +1 -1
  290. package/api/@xmachines/play-svelte-spa-router/interfaces/BasePathOptions.md +5 -5
  291. package/api/@xmachines/play-svelte-spa-router/interfaces/ConnectRouterOptions.md +10 -10
  292. package/api/@xmachines/play-svelte-spa-router/interfaces/PlayRouteEvent.md +9 -9
  293. package/api/@xmachines/play-svelte-spa-router/interfaces/RoutableActor.md +6 -6
  294. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapOptions.md +6 -6
  295. package/api/@xmachines/play-svelte-spa-router/interfaces/RouteMapping.md +5 -5
  296. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterBridge.md +3 -3
  297. package/api/@xmachines/play-svelte-spa-router/interfaces/RouterConnection.md +8 -8
  298. package/api/@xmachines/play-svelte-spa-router/interfaces/WindowLike.md +3 -3
  299. package/api/@xmachines/play-sveltekit-router/README.md +65 -13
  300. package/api/@xmachines/play-sveltekit-router/classes/RouteMap.md +5 -5
  301. package/api/@xmachines/play-sveltekit-router/classes/SvelteKitRouterBridge.md +29 -19
  302. package/api/@xmachines/play-sveltekit-router/functions/connectRouter.md +1 -1
  303. package/api/@xmachines/play-sveltekit-router/interfaces/BasePathOptions.md +5 -5
  304. package/api/@xmachines/play-sveltekit-router/interfaces/ConnectRouterOptions.md +13 -16
  305. package/api/@xmachines/play-sveltekit-router/interfaces/LocationLike.md +5 -5
  306. package/api/@xmachines/play-sveltekit-router/interfaces/PlayRouteEvent.md +9 -9
  307. package/api/@xmachines/play-sveltekit-router/interfaces/RoutableActor.md +6 -6
  308. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapOptions.md +6 -6
  309. package/api/@xmachines/play-sveltekit-router/interfaces/RouteMapping.md +5 -5
  310. package/api/@xmachines/play-sveltekit-router/interfaces/RouterBridge.md +3 -3
  311. package/api/@xmachines/play-sveltekit-router/interfaces/RouterConnection.md +8 -8
  312. package/api/@xmachines/play-sveltekit-router/interfaces/SvelteKitRouterBridgeOptions.md +25 -0
  313. package/api/@xmachines/play-sveltekit-router/type-aliases/ShallowNavigation.md +21 -0
  314. package/api/@xmachines/play-tanstack-react-router/README.md +34 -16
  315. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +5 -5
  316. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +7 -7
  317. package/api/@xmachines/play-tanstack-react-router/functions/createPlayRouterProvider.md +5 -5
  318. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  319. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouteEvent.md +9 -9
  320. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +14 -14
  321. package/api/@xmachines/play-tanstack-react-router/interfaces/RoutableActor.md +6 -6
  322. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapOptions.md +6 -6
  323. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +5 -5
  324. package/api/@xmachines/play-tanstack-react-router/interfaces/RouterBridge.md +3 -3
  325. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterBridgeConstructor.md +6 -6
  326. package/api/@xmachines/play-tanstack-react-router/type-aliases/PlayRouterProviderBaseProps.md +5 -5
  327. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  328. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +9 -9
  329. package/api/@xmachines/play-tanstack-react-router/variables/PlayRouterProvider.md +4 -4
  330. package/api/@xmachines/play-tanstack-router/README.md +5 -3
  331. package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md +7 -7
  332. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouteMapLike.md +3 -3
  333. package/api/@xmachines/play-tanstack-router/type-aliases/TanStackRouterLike.md +9 -9
  334. package/api/@xmachines/play-tanstack-solid-router/README.md +45 -11
  335. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +5 -5
  336. package/api/@xmachines/play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md +7 -7
  337. package/api/@xmachines/play-tanstack-solid-router/functions/createPlayRouterProvider.md +5 -5
  338. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouteEvent.md +9 -9
  339. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +14 -14
  340. package/api/@xmachines/play-tanstack-solid-router/interfaces/RoutableActor.md +6 -6
  341. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapOptions.md +6 -6
  342. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +5 -5
  343. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouterBridge.md +3 -3
  344. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterBridgeConstructor.md +6 -6
  345. package/api/@xmachines/play-tanstack-solid-router/type-aliases/PlayRouterProviderBaseProps.md +5 -5
  346. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  347. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +9 -9
  348. package/api/@xmachines/play-tanstack-solid-router/variables/PlayRouterProvider.md +4 -4
  349. package/api/@xmachines/play-url/README.md +1 -1
  350. package/api/@xmachines/play-url/errors/classes/InvalidBasePathError.md +12 -12
  351. package/api/@xmachines/play-url/errors/classes/InvalidRoutePatternError.md +12 -12
  352. package/api/@xmachines/play-url/errors/classes/MissingBasePathParamError.md +13 -13
  353. package/api/@xmachines/play-url/index/functions/buildPath.md +2 -2
  354. package/api/@xmachines/play-url/index/functions/cleanFrameworkParams.md +1 -1
  355. package/api/@xmachines/play-url/index/functions/createLruCache.md +7 -7
  356. package/api/@xmachines/play-url/index/functions/getCandidates.md +4 -4
  357. package/api/@xmachines/play-url/index/functions/getCompiledPattern.md +5 -5
  358. package/api/@xmachines/play-url/index/functions/getIndexKey.md +1 -1
  359. package/api/@xmachines/play-url/index/functions/holdsUnsubstitutedParam.md +1 -1
  360. package/api/@xmachines/play-url/index/functions/isDotSegment.md +1 -1
  361. package/api/@xmachines/play-url/index/functions/joinBasePath.md +1 -1
  362. package/api/@xmachines/play-url/index/functions/normalizeBasePath.md +1 -1
  363. package/api/@xmachines/play-url/index/functions/parsePattern.md +1 -1
  364. package/api/@xmachines/play-url/index/functions/pickOwnParams.md +6 -6
  365. package/api/@xmachines/play-url/index/functions/resolveBasePath.md +1 -1
  366. package/api/@xmachines/play-url/index/functions/resolveFrameworkParams.md +1 -1
  367. package/api/@xmachines/play-url/index/functions/sanitizePathname.md +1 -1
  368. package/api/@xmachines/play-url/index/functions/splitLocation.md +1 -1
  369. package/api/@xmachines/play-url/index/functions/stripBasePath.md +1 -1
  370. package/api/@xmachines/play-url/index/interfaces/BasePathOptions.md +5 -5
  371. package/api/@xmachines/play-url/index/interfaces/CompileOptions.md +5 -5
  372. package/api/@xmachines/play-url/index/interfaces/FrameworkParamsSource.md +9 -9
  373. package/api/@xmachines/play-url/index/interfaces/GroupPart.md +6 -6
  374. package/api/@xmachines/play-url/index/interfaces/KeyValueCache.md +6 -6
  375. package/api/@xmachines/play-url/index/interfaces/LiteralPart.md +5 -5
  376. package/api/@xmachines/play-url/index/interfaces/ParamPart.md +9 -9
  377. package/api/@xmachines/play-url/index/interfaces/ParseOptions.md +4 -4
  378. package/api/@xmachines/play-url/index/interfaces/ParsedPattern.md +14 -14
  379. package/api/@xmachines/play-url/index/interfaces/PatternParam.md +6 -6
  380. package/api/@xmachines/play-url/index/interfaces/ResolvedBasePath.md +5 -5
  381. package/api/@xmachines/play-url/index/interfaces/SplitLocation.md +7 -7
  382. package/api/@xmachines/play-url/index/type-aliases/PathBuildResult.md +1 -1
  383. package/api/@xmachines/play-url/index/type-aliases/PathParams.md +1 -1
  384. package/api/@xmachines/play-url/index/type-aliases/PatternModifier.md +1 -1
  385. package/api/@xmachines/play-url/index/type-aliases/PatternPart.md +1 -1
  386. package/api/@xmachines/play-url/index/type-aliases/URLPatternCtor.md +2 -2
  387. package/api/@xmachines/play-url/index/type-aliases/URLPatternLike.md +3 -3
  388. package/api/@xmachines/play-url/index/variables/NO_BASE_PATH.md +1 -1
  389. package/api/@xmachines/play-url/index/variables/URLPattern.md +1 -1
  390. package/api/@xmachines/play-view/README.md +45 -19
  391. package/api/@xmachines/play-view/errors/README.md +1 -0
  392. package/api/@xmachines/play-view/errors/classes/InvalidViewOutletError.md +13 -13
  393. package/api/@xmachines/play-view/errors/classes/ReadOnlyContextError.md +12 -12
  394. package/api/@xmachines/play-view/errors/classes/ViewElementKeyCollisionError.md +181 -0
  395. package/api/@xmachines/play-view/index/README.md +10 -4
  396. package/api/@xmachines/play-view/index/functions/attachRenderErrorHandler.md +13 -12
  397. package/api/@xmachines/play-view/index/functions/bindStoreHandlers.md +34 -0
  398. package/api/@xmachines/play-view/index/functions/composePlayState.md +1 -1
  399. package/api/@xmachines/play-view/index/functions/composeViews.md +8 -2
  400. package/api/@xmachines/play-view/index/functions/createActorProxy.md +39 -0
  401. package/api/@xmachines/play-view/index/functions/createRenderErrorBinding.md +35 -0
  402. package/api/@xmachines/play-view/index/functions/createReportGuard.md +1 -1
  403. package/api/@xmachines/play-view/index/functions/createViewSession.md +29 -0
  404. package/api/@xmachines/play-view/index/functions/createViewStoreLifecycle.md +1 -1
  405. package/api/@xmachines/play-view/index/functions/forwardRenderError.md +45 -0
  406. package/api/@xmachines/play-view/index/functions/guardContextWrites.md +1 -1
  407. package/api/@xmachines/play-view/index/functions/refreshContextSubtree.md +1 -1
  408. package/api/@xmachines/play-view/index/functions/reuseComposedState.md +1 -1
  409. package/api/@xmachines/play-view/index/functions/toAtomState.md +1 -1
  410. package/api/@xmachines/play-view/index/functions/typedSpec.md +1 -1
  411. package/api/@xmachines/play-view/index/interfaces/BaseActorProviderProps.md +12 -12
  412. package/api/@xmachines/play-view/index/interfaces/BaseViewContextValue.md +10 -10
  413. package/api/@xmachines/play-view/index/interfaces/ComposedView.md +7 -7
  414. package/api/@xmachines/play-view/index/interfaces/HandlerFactory.md +19 -0
  415. package/api/@xmachines/play-view/index/interfaces/PlaySpec.md +8 -8
  416. package/api/@xmachines/play-view/index/interfaces/ReportGuard.md +5 -5
  417. package/api/@xmachines/play-view/index/interfaces/ReportGuardMessages.md +5 -5
  418. package/api/@xmachines/play-view/index/interfaces/ResolveViewStoreOptions.md +4 -4
  419. package/api/@xmachines/play-view/index/interfaces/ViewMeta.md +7 -7
  420. package/api/@xmachines/play-view/index/interfaces/ViewOutlet.md +5 -5
  421. package/api/@xmachines/play-view/index/interfaces/ViewSession.md +155 -0
  422. package/api/@xmachines/play-view/index/interfaces/ViewSessionOptions.md +12 -0
  423. package/api/@xmachines/play-view/index/interfaces/ViewSessionSnapshot.md +23 -0
  424. package/api/@xmachines/play-view/index/interfaces/ViewStoreLifecycle.md +22 -3
  425. package/api/@xmachines/play-view/index/interfaces/ViewStoreResolution.md +7 -6
  426. package/api/@xmachines/play-view/index/interfaces/ViewTree.md +6 -6
  427. package/api/@xmachines/play-view/index/interfaces/ViewTreeChild.md +5 -5
  428. package/api/@xmachines/play-view/index/interfaces/Viewable.md +4 -4
  429. package/api/@xmachines/play-view/index/type-aliases/StateUpdater.md +21 -0
  430. package/api/@xmachines/play-view/index/type-aliases/ViewActor.md +5 -5
  431. package/api/@xmachines/play-view/index/variables/CONTEXT_STATE_KEY.md +1 -1
  432. package/api/@xmachines/play-vue/README.md +20 -15
  433. package/api/@xmachines/play-vue/functions/defineRegistry.md +4 -4
  434. package/api/@xmachines/play-vue/functions/useActor.md +1 -1
  435. package/api/@xmachines/play-vue/functions/useBoundProp.md +13 -7
  436. package/api/@xmachines/play-vue/functions/useFieldValidation.md +12 -5
  437. package/api/@xmachines/play-vue/functions/usePlayView.md +1 -1
  438. package/api/@xmachines/play-vue/interfaces/ActorProviderProps.md +8 -8
  439. package/api/@xmachines/play-vue/interfaces/ComponentContext.md +4 -4
  440. package/api/@xmachines/play-vue/interfaces/PlayUIProviderProps.md +11 -11
  441. package/api/@xmachines/play-vue/interfaces/RenderErrorInfo.md +16 -0
  442. package/api/@xmachines/play-vue/interfaces/RendererProps.md +7 -7
  443. package/api/@xmachines/play-vue/interfaces/ViewContextValue.md +7 -7
  444. package/api/@xmachines/play-vue/type-aliases/AnyPlayActor.md +1 -1
  445. package/api/@xmachines/play-vue/type-aliases/ComponentEntry.md +5 -5
  446. package/api/@xmachines/play-vue/type-aliases/ComponentFn.md +4 -4
  447. package/api/@xmachines/play-vue/type-aliases/ComponentsMap.md +4 -4
  448. package/api/@xmachines/play-vue/type-aliases/DefineRegistryOptions.md +9 -9
  449. package/api/@xmachines/play-vue/type-aliases/OnRenderError.md +27 -0
  450. package/api/@xmachines/play-vue/type-aliases/RenderErrorKind.md +21 -0
  451. package/api/@xmachines/play-vue/variables/ActionProvider.md +35 -54
  452. package/api/@xmachines/play-vue/variables/PlayRenderer.md +4 -2
  453. package/api/@xmachines/play-vue/variables/Renderer.md +61 -78
  454. package/api/@xmachines/play-vue/variables/StateProvider.md +44 -63
  455. package/api/@xmachines/play-vue/variables/ValidationProvider.md +26 -45
  456. package/api/@xmachines/play-vue/variables/VisibilityProvider.md +17 -30
  457. package/api/@xmachines/play-vue-router/README.md +19 -12
  458. package/api/@xmachines/play-vue-router/errors/classes/VueRouterNavigationError.md +11 -11
  459. package/api/@xmachines/play-vue-router/errors/classes/VueRouterSendError.md +11 -11
  460. package/api/@xmachines/play-vue-router/index/classes/RouteMap.md +5 -5
  461. package/api/@xmachines/play-vue-router/index/classes/VueRouterBridge.md +7 -7
  462. package/api/@xmachines/play-vue-router/index/interfaces/PlayRouteEvent.md +9 -9
  463. package/api/@xmachines/play-vue-router/index/interfaces/RoutableActor.md +6 -6
  464. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapOptions.md +6 -6
  465. package/api/@xmachines/play-vue-router/index/interfaces/RouteMapping.md +5 -5
  466. package/api/@xmachines/play-vue-router/index/interfaces/RouterBridge.md +3 -3
  467. package/api/@xmachines/play-vue-router/index/variables/PlayRouterProvider.md +90 -105
  468. package/api/@xmachines/play-xstate/README.md +64 -12
  469. package/api/@xmachines/play-xstate/errors/classes/ActorThrewNonErrorError.md +11 -11
  470. package/api/@xmachines/play-xstate/errors/classes/InvalidEventError.md +12 -12
  471. package/api/@xmachines/play-xstate/errors/classes/InvalidMachineError.md +11 -11
  472. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteHandlerError.md +13 -13
  473. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteMetadataError.md +13 -13
  474. package/api/@xmachines/play-xstate/errors/classes/InvalidRouteParamError.md +14 -14
  475. package/api/@xmachines/play-xstate/errors/classes/MissingRouteParamError.md +13 -13
  476. package/api/@xmachines/play-xstate/errors/classes/MissingStateIdError.md +13 -13
  477. package/api/@xmachines/play-xstate/index/classes/PlayerActor.md +44 -68
  478. package/api/@xmachines/play-xstate/index/functions/compose.md +22 -22
  479. package/api/@xmachines/play-xstate/index/functions/definePlayer.md +9 -9
  480. package/api/@xmachines/play-xstate/index/interfaces/PlayerConfig.md +10 -10
  481. package/api/@xmachines/play-xstate/index/interfaces/PlayerFactoryResumeOptions.md +7 -7
  482. package/api/@xmachines/play-xstate/index/interfaces/PlayerOptions.md +12 -12
  483. package/api/@xmachines/play-xstate/index/type-aliases/Capability.md +5 -5
  484. package/api/@xmachines/play-xstate/index/type-aliases/PlayerConstructor.md +6 -6
  485. package/api/@xmachines/play-xstate/index/type-aliases/PlayerFactory.md +5 -5
  486. package/api/@xmachines/play-xstate/with-routing/functions/buildRouteUrl.md +2 -2
  487. package/api/@xmachines/play-xstate/with-routing/functions/deriveRoute.md +1 -1
  488. package/api/@xmachines/play-xstate/with-routing/functions/formatPlayRouteTransitions.md +4 -4
  489. package/api/@xmachines/play-xstate/with-routing/functions/isAbsoluteRoute.md +1 -1
  490. package/api/@xmachines/play-xstate/with-routing/functions/withRouting.md +4 -4
  491. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteContext.md +7 -7
  492. package/api/@xmachines/play-xstate/with-routing/interfaces/RouteObject.md +7 -7
  493. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md +1 -1
  494. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md +1 -1
  495. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md +7 -7
  496. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md +1 -1
  497. package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md +10 -10
  498. package/api/@xmachines/play-xstate/with-view/functions/withView.md +4 -4
  499. package/api/@xmachines/shared/README.md +4 -3
  500. package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md +2 -2
  501. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutput.md +1 -1
  502. package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutputFile.md +1 -1
  503. package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md +1 -1
  504. package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md +4 -4
  505. package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md +1 -1
  506. package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md +4 -4
  507. package/api/@xmachines/shared/vite-aliases/functions/xmTestTarget.md +2 -2
  508. package/api/@xmachines/shared/vite-aliases/type-aliases/XmTestTarget.md +1 -1
  509. package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md +2 -2
  510. package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md +1 -1
  511. package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md +6 -6
  512. package/contributing/architecture.md +88 -53
  513. package/contributing/configuration.md +44 -62
  514. package/contributing/deployment.md +131 -161
  515. package/contributing/development.md +33 -8
  516. package/contributing/migrating-to-play-atom.md +10 -4
  517. package/contributing/testing.md +67 -34
  518. package/examples/@xmachines/play-dom-gallery-demo/README.md +127 -0
  519. package/examples/@xmachines/play-dom-gallery-demo/functions/createConfirmDialog.md +33 -0
  520. package/examples/@xmachines/play-dom-gallery-demo/functions/createDebugPanel.md +31 -0
  521. package/examples/@xmachines/play-dom-gallery-demo/functions/initApp.md +22 -0
  522. package/examples/@xmachines/play-dom-gallery-demo/functions/initShell.md +33 -0
  523. package/examples/@xmachines/play-dom-gallery-demo/interfaces/GalleryMachineEntry.md +13 -0
  524. package/examples/@xmachines/play-dom-gallery-demo/interfaces/GalleryRuntime.md +14 -0
  525. package/examples/@xmachines/play-dom-gallery-demo/interfaces/ShellOptions.md +18 -0
  526. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/AuthCatalog.md +9 -0
  527. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/DonutCatalog.md +9 -0
  528. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/FetchCatalog.md +9 -0
  529. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/FlightCatalog.md +9 -0
  530. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/GalleryActor.md +20 -0
  531. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/GallerySlug.md +18 -0
  532. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/KitCatalog.md +16 -0
  533. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/StopwatchCatalog.md +9 -0
  534. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TemperatureCatalog.md +9 -0
  535. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TicTacToeCatalog.md +9 -0
  536. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TodoMvcCatalog.md +9 -0
  537. package/examples/@xmachines/play-dom-gallery-demo/type-aliases/TriviaCatalog.md +9 -0
  538. package/examples/@xmachines/play-dom-gallery-demo/variables/Button.md +12 -0
  539. package/examples/@xmachines/play-dom-gallery-demo/variables/Field.md +30 -0
  540. package/examples/@xmachines/play-dom-gallery-demo/variables/Page.md +16 -0
  541. package/examples/@xmachines/play-dom-gallery-demo/variables/Panel.md +15 -0
  542. package/examples/@xmachines/play-dom-gallery-demo/variables/Text.md +15 -0
  543. package/examples/@xmachines/play-dom-gallery-demo/variables/authCatalog.md +126 -0
  544. package/examples/@xmachines/play-dom-gallery-demo/variables/demoComponents.md +21 -0
  545. package/examples/@xmachines/play-dom-gallery-demo/variables/donutCatalog.md +135 -0
  546. package/examples/@xmachines/play-dom-gallery-demo/variables/fetchCatalog.md +119 -0
  547. package/examples/@xmachines/play-dom-gallery-demo/variables/flightCatalog.md +146 -0
  548. package/examples/@xmachines/play-dom-gallery-demo/variables/galleryMachines.md +11 -0
  549. package/examples/@xmachines/play-dom-gallery-demo/variables/stopwatchCatalog.md +119 -0
  550. package/examples/@xmachines/play-dom-gallery-demo/variables/temperatureCatalog.md +122 -0
  551. package/examples/@xmachines/play-dom-gallery-demo/variables/ticTacToeCatalog.md +119 -0
  552. package/examples/@xmachines/{play-dom-demo/variables/authCatalog.md → play-dom-gallery-demo/variables/todoMvcCatalog.md} +36 -82
  553. package/examples/@xmachines/play-dom-gallery-demo/variables/triviaCatalog.md +129 -0
  554. package/examples/@xmachines/play-dom-router-demo/README.md +41 -33
  555. package/examples/@xmachines/play-dom-router-donut-demo/README.md +78 -0
  556. package/examples/@xmachines/play-dom-router-flight-demo/README.md +76 -0
  557. package/examples/@xmachines/play-dom-router-todomvc-demo/README.md +76 -0
  558. package/examples/@xmachines/play-dom-router-trivia-demo/README.md +76 -0
  559. package/examples/@xmachines/play-react-gallery-demo/README.md +123 -0
  560. package/examples/@xmachines/play-react-gallery-demo/functions/App.md +13 -0
  561. package/examples/@xmachines/play-react-gallery-demo/interfaces/GalleryMachineEntry.md +13 -0
  562. package/examples/@xmachines/play-react-gallery-demo/interfaces/GalleryRuntime.md +14 -0
  563. package/examples/@xmachines/play-react-gallery-demo/type-aliases/AuthCatalog.md +9 -0
  564. package/examples/@xmachines/play-react-gallery-demo/type-aliases/DonutCatalog.md +9 -0
  565. package/examples/@xmachines/play-react-gallery-demo/type-aliases/FetchCatalog.md +9 -0
  566. package/examples/@xmachines/play-react-gallery-demo/type-aliases/FlightCatalog.md +9 -0
  567. package/examples/@xmachines/play-react-gallery-demo/type-aliases/GalleryActor.md +20 -0
  568. package/examples/@xmachines/play-react-gallery-demo/type-aliases/GallerySlug.md +18 -0
  569. package/examples/@xmachines/play-react-gallery-demo/type-aliases/KitCatalog.md +16 -0
  570. package/examples/@xmachines/play-react-gallery-demo/type-aliases/StopwatchCatalog.md +9 -0
  571. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TemperatureCatalog.md +9 -0
  572. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TicTacToeCatalog.md +9 -0
  573. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TodoMvcCatalog.md +9 -0
  574. package/examples/@xmachines/play-react-gallery-demo/type-aliases/TriviaCatalog.md +9 -0
  575. package/examples/@xmachines/play-react-gallery-demo/variables/Button.md +12 -0
  576. package/examples/@xmachines/play-react-gallery-demo/variables/DebugPanel.md +21 -0
  577. package/examples/@xmachines/play-react-gallery-demo/variables/Field.md +24 -0
  578. package/examples/@xmachines/play-react-gallery-demo/variables/Page.md +14 -0
  579. package/examples/@xmachines/play-react-gallery-demo/variables/Panel.md +15 -0
  580. package/examples/@xmachines/play-react-gallery-demo/variables/Shell.md +26 -0
  581. package/examples/@xmachines/play-react-gallery-demo/variables/Text.md +15 -0
  582. package/examples/@xmachines/play-react-gallery-demo/variables/authCatalog.md +126 -0
  583. package/examples/@xmachines/play-react-gallery-demo/variables/demoComponents.md +21 -0
  584. package/examples/@xmachines/play-react-gallery-demo/variables/donutCatalog.md +135 -0
  585. package/examples/@xmachines/play-react-gallery-demo/variables/fetchCatalog.md +119 -0
  586. package/examples/@xmachines/play-react-gallery-demo/variables/flightCatalog.md +146 -0
  587. package/examples/@xmachines/play-react-gallery-demo/variables/galleryMachines.md +11 -0
  588. package/examples/@xmachines/play-react-gallery-demo/variables/stopwatchCatalog.md +119 -0
  589. package/examples/@xmachines/play-react-gallery-demo/variables/temperatureCatalog.md +122 -0
  590. package/examples/@xmachines/play-react-gallery-demo/variables/ticTacToeCatalog.md +119 -0
  591. package/examples/@xmachines/{play-vue-demo/variables/authCatalog.md → play-react-gallery-demo/variables/todoMvcCatalog.md} +36 -82
  592. package/examples/@xmachines/play-react-gallery-demo/variables/triviaCatalog.md +129 -0
  593. package/examples/@xmachines/play-react-router-demo/README.md +21 -9
  594. package/examples/@xmachines/play-react-router-donut-demo/README.md +85 -0
  595. package/examples/@xmachines/play-react-router-flight-demo/README.md +74 -0
  596. package/examples/@xmachines/play-react-router-todomvc-demo/README.md +74 -0
  597. package/examples/@xmachines/play-react-router-trivia-demo/README.md +74 -0
  598. package/examples/@xmachines/play-solid-gallery-demo/README.md +123 -0
  599. package/examples/@xmachines/play-solid-gallery-demo/functions/App.md +13 -0
  600. package/examples/@xmachines/play-solid-gallery-demo/interfaces/GalleryMachineEntry.md +13 -0
  601. package/examples/@xmachines/play-solid-gallery-demo/interfaces/GalleryRuntime.md +14 -0
  602. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/AuthCatalog.md +9 -0
  603. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/DonutCatalog.md +9 -0
  604. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/FetchCatalog.md +9 -0
  605. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/FlightCatalog.md +9 -0
  606. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/GalleryActor.md +20 -0
  607. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/GallerySlug.md +18 -0
  608. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/KitCatalog.md +16 -0
  609. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/StopwatchCatalog.md +9 -0
  610. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TemperatureCatalog.md +9 -0
  611. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TicTacToeCatalog.md +9 -0
  612. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TodoMvcCatalog.md +9 -0
  613. package/examples/@xmachines/play-solid-gallery-demo/type-aliases/TriviaCatalog.md +9 -0
  614. package/examples/@xmachines/play-solid-gallery-demo/variables/Button.md +11 -0
  615. package/examples/@xmachines/play-solid-gallery-demo/variables/DebugPanel.md +22 -0
  616. package/examples/@xmachines/play-solid-gallery-demo/variables/Field.md +11 -0
  617. package/examples/@xmachines/play-solid-gallery-demo/variables/Page.md +11 -0
  618. package/examples/@xmachines/play-solid-gallery-demo/variables/Panel.md +11 -0
  619. package/examples/@xmachines/play-solid-gallery-demo/variables/Shell.md +26 -0
  620. package/examples/@xmachines/play-solid-gallery-demo/variables/Text.md +11 -0
  621. package/examples/@xmachines/play-solid-gallery-demo/variables/authCatalog.md +126 -0
  622. package/examples/@xmachines/play-solid-gallery-demo/variables/demoComponents.md +21 -0
  623. package/examples/@xmachines/play-solid-gallery-demo/variables/donutCatalog.md +135 -0
  624. package/examples/@xmachines/play-solid-gallery-demo/variables/fetchCatalog.md +119 -0
  625. package/examples/@xmachines/play-solid-gallery-demo/variables/flightCatalog.md +146 -0
  626. package/examples/@xmachines/play-solid-gallery-demo/variables/galleryMachines.md +11 -0
  627. package/examples/@xmachines/play-solid-gallery-demo/variables/stopwatchCatalog.md +119 -0
  628. package/examples/@xmachines/play-solid-gallery-demo/variables/temperatureCatalog.md +122 -0
  629. package/examples/@xmachines/play-solid-gallery-demo/variables/ticTacToeCatalog.md +119 -0
  630. package/examples/@xmachines/{play-react-demo/variables/authCatalog.md → play-solid-gallery-demo/variables/todoMvcCatalog.md} +36 -82
  631. package/examples/@xmachines/play-solid-gallery-demo/variables/triviaCatalog.md +129 -0
  632. package/examples/@xmachines/play-solid-router-demo/README.md +17 -9
  633. package/examples/@xmachines/play-solid-router-donut-demo/README.md +86 -0
  634. package/examples/@xmachines/play-solid-router-flight-demo/README.md +75 -0
  635. package/examples/@xmachines/play-solid-router-todomvc-demo/README.md +75 -0
  636. package/examples/@xmachines/play-solid-router-trivia-demo/README.md +75 -0
  637. package/examples/@xmachines/play-svelte-gallery-demo/README.md +130 -0
  638. package/examples/@xmachines/play-svelte-gallery-demo/interfaces/GalleryMachineEntry.md +13 -0
  639. package/examples/@xmachines/play-svelte-gallery-demo/interfaces/GalleryRuntime.md +14 -0
  640. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/App.md +9 -0
  641. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/AuthCatalog.md +9 -0
  642. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/DonutCatalog.md +9 -0
  643. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/FetchCatalog.md +9 -0
  644. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/FlightCatalog.md +9 -0
  645. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/GalleryActor.md +20 -0
  646. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/GallerySlug.md +18 -0
  647. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/KitCatalog.md +16 -0
  648. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/StopwatchCatalog.md +9 -0
  649. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TemperatureCatalog.md +9 -0
  650. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TicTacToeCatalog.md +9 -0
  651. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TodoMvcCatalog.md +9 -0
  652. package/examples/@xmachines/play-svelte-gallery-demo/type-aliases/TriviaCatalog.md +9 -0
  653. package/examples/@xmachines/play-svelte-gallery-demo/variables/App.md +9 -0
  654. package/examples/@xmachines/play-svelte-gallery-demo/variables/authCatalog.md +126 -0
  655. package/examples/@xmachines/play-svelte-gallery-demo/variables/demoComponents.md +21 -0
  656. package/examples/@xmachines/play-svelte-gallery-demo/variables/donutCatalog.md +135 -0
  657. package/examples/@xmachines/play-svelte-gallery-demo/variables/fetchCatalog.md +119 -0
  658. package/examples/@xmachines/play-svelte-gallery-demo/variables/flightCatalog.md +146 -0
  659. package/examples/@xmachines/play-svelte-gallery-demo/variables/galleryMachines.md +11 -0
  660. package/examples/@xmachines/play-svelte-gallery-demo/variables/stopwatchCatalog.md +119 -0
  661. package/examples/@xmachines/play-svelte-gallery-demo/variables/temperatureCatalog.md +122 -0
  662. package/examples/@xmachines/play-svelte-gallery-demo/variables/ticTacToeCatalog.md +119 -0
  663. package/examples/@xmachines/{play-solid-demo/variables/authCatalog.md → play-svelte-gallery-demo/variables/todoMvcCatalog.md} +36 -82
  664. package/examples/@xmachines/play-svelte-gallery-demo/variables/triviaCatalog.md +129 -0
  665. package/examples/@xmachines/play-svelte-spa-router-demo/README.md +9 -9
  666. package/examples/@xmachines/play-svelte-spa-router-donut-demo/README.md +77 -0
  667. package/examples/@xmachines/play-svelte-spa-router-flight-demo/README.md +76 -0
  668. package/examples/@xmachines/play-svelte-spa-router-todomvc-demo/README.md +76 -0
  669. package/examples/@xmachines/play-svelte-spa-router-trivia-demo/README.md +76 -0
  670. package/examples/@xmachines/play-sveltekit-router-demo/README.md +9 -9
  671. package/examples/@xmachines/play-sveltekit-router-donut-demo/README.md +103 -0
  672. package/examples/@xmachines/play-sveltekit-router-flight-demo/README.md +86 -0
  673. package/examples/@xmachines/play-sveltekit-router-todomvc-demo/README.md +86 -0
  674. package/examples/@xmachines/play-sveltekit-router-trivia-demo/README.md +86 -0
  675. package/examples/@xmachines/play-tanstack-react-router-demo/README.md +22 -16
  676. package/examples/@xmachines/play-tanstack-react-router-donut-demo/README.md +78 -0
  677. package/examples/@xmachines/play-tanstack-react-router-flight-demo/README.md +74 -0
  678. package/examples/@xmachines/play-tanstack-react-router-todomvc-demo/README.md +74 -0
  679. package/examples/@xmachines/play-tanstack-react-router-trivia-demo/README.md +74 -0
  680. package/examples/@xmachines/play-tanstack-solid-router-demo/README.md +25 -17
  681. package/examples/@xmachines/play-tanstack-solid-router-donut-demo/README.md +91 -0
  682. package/examples/@xmachines/play-tanstack-solid-router-flight-demo/README.md +80 -0
  683. package/examples/@xmachines/play-tanstack-solid-router-todomvc-demo/README.md +80 -0
  684. package/examples/@xmachines/play-tanstack-solid-router-trivia-demo/README.md +80 -0
  685. package/examples/@xmachines/play-vue-gallery-demo/README.md +120 -0
  686. package/examples/@xmachines/play-vue-gallery-demo/interfaces/GalleryMachineEntry.md +13 -0
  687. package/examples/@xmachines/play-vue-gallery-demo/interfaces/GalleryRuntime.md +14 -0
  688. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/AuthCatalog.md +9 -0
  689. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/DonutCatalog.md +9 -0
  690. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/FetchCatalog.md +9 -0
  691. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/FlightCatalog.md +9 -0
  692. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/GalleryActor.md +20 -0
  693. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/GallerySlug.md +18 -0
  694. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/KitCatalog.md +16 -0
  695. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/StopwatchCatalog.md +9 -0
  696. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TemperatureCatalog.md +9 -0
  697. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TicTacToeCatalog.md +9 -0
  698. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TodoMvcCatalog.md +9 -0
  699. package/examples/@xmachines/play-vue-gallery-demo/type-aliases/TriviaCatalog.md +9 -0
  700. package/examples/@xmachines/play-vue-gallery-demo/variables/App.md +11 -0
  701. package/examples/@xmachines/play-vue-gallery-demo/variables/authCatalog.md +126 -0
  702. package/examples/@xmachines/play-vue-gallery-demo/variables/demoComponents.md +11 -0
  703. package/examples/@xmachines/play-vue-gallery-demo/variables/donutCatalog.md +135 -0
  704. package/examples/@xmachines/play-vue-gallery-demo/variables/fetchCatalog.md +119 -0
  705. package/examples/@xmachines/play-vue-gallery-demo/variables/flightCatalog.md +146 -0
  706. package/examples/@xmachines/play-vue-gallery-demo/variables/galleryMachines.md +11 -0
  707. package/examples/@xmachines/play-vue-gallery-demo/variables/stopwatchCatalog.md +119 -0
  708. package/examples/@xmachines/play-vue-gallery-demo/variables/temperatureCatalog.md +122 -0
  709. package/examples/@xmachines/play-vue-gallery-demo/variables/ticTacToeCatalog.md +119 -0
  710. package/examples/@xmachines/play-vue-gallery-demo/variables/todoMvcCatalog.md +151 -0
  711. package/examples/@xmachines/play-vue-gallery-demo/variables/triviaCatalog.md +129 -0
  712. package/examples/@xmachines/play-vue-router-demo/README.md +17 -11
  713. package/examples/@xmachines/play-vue-router-donut-demo/README.md +78 -0
  714. package/examples/@xmachines/play-vue-router-flight-demo/README.md +76 -0
  715. package/examples/@xmachines/play-vue-router-todomvc-demo/README.md +76 -0
  716. package/examples/@xmachines/play-vue-router-trivia-demo/README.md +76 -0
  717. package/examples/README.md +44 -6
  718. package/examples/form-validation.md +17 -13
  719. package/examples/multi-router-integration.md +268 -147
  720. package/examples/routing-patterns.md +46 -9
  721. package/examples/traffic-light.md +6 -2
  722. package/examples/xstate-example-ports.md +106 -0
  723. package/guides/actor-model.md +37 -19
  724. package/guides/atoms.md +48 -8
  725. package/guides/getting-started.md +66 -14
  726. package/guides/inspector.md +74 -14
  727. package/guides/routing.md +4 -1
  728. package/guides/state-machines.md +35 -13
  729. package/guides/views.md +34 -14
  730. package/package.json +6 -6
  731. package/rfc/play.md +31 -13
  732. package/api/@xmachines/play-view/index/functions/createFailureLatch.md +0 -20
  733. package/api/@xmachines/play-view/index/functions/sameViewInputs.md +0 -25
  734. package/api/@xmachines/play-view/index/interfaces/FailureLatch.md +0 -60
  735. package/api/@xmachines/play-view/index/interfaces/ViewInputs.md +0 -19
  736. package/examples/@xmachines/play-dom-demo/README.md +0 -162
  737. package/examples/@xmachines/play-dom-demo/functions/createAuthActionHandlers.md +0 -35
  738. package/examples/@xmachines/play-dom-demo/functions/createConfirmDialog.md +0 -27
  739. package/examples/@xmachines/play-dom-demo/functions/createNavBar.md +0 -24
  740. package/examples/@xmachines/play-dom-demo/functions/initShell.md +0 -25
  741. package/examples/@xmachines/play-dom-demo/type-aliases/AuthCatalog.md +0 -9
  742. package/examples/@xmachines/play-dom-demo/variables/About.md +0 -12
  743. package/examples/@xmachines/play-dom-demo/variables/Button.md +0 -12
  744. package/examples/@xmachines/play-dom-demo/variables/Contact.md +0 -12
  745. package/examples/@xmachines/play-dom-demo/variables/Dashboard.md +0 -13
  746. package/examples/@xmachines/play-dom-demo/variables/Field.md +0 -19
  747. package/examples/@xmachines/play-dom-demo/variables/Home.md +0 -13
  748. package/examples/@xmachines/play-dom-demo/variables/Login.md +0 -13
  749. package/examples/@xmachines/play-dom-demo/variables/NavBarView.md +0 -16
  750. package/examples/@xmachines/play-dom-demo/variables/Navigation.md +0 -13
  751. package/examples/@xmachines/play-dom-demo/variables/Overview.md +0 -13
  752. package/examples/@xmachines/play-dom-demo/variables/Panel.md +0 -14
  753. package/examples/@xmachines/play-dom-demo/variables/Profile.md +0 -13
  754. package/examples/@xmachines/play-dom-demo/variables/Settings.md +0 -13
  755. package/examples/@xmachines/play-dom-demo/variables/Stats.md +0 -13
  756. package/examples/@xmachines/play-dom-demo/variables/demoComponents.md +0 -30
  757. package/examples/@xmachines/play-react-demo/README.md +0 -163
  758. package/examples/@xmachines/play-react-demo/functions/createAuthActionHandlers.md +0 -35
  759. package/examples/@xmachines/play-react-demo/type-aliases/AuthCatalog.md +0 -9
  760. package/examples/@xmachines/play-react-demo/variables/About.md +0 -14
  761. package/examples/@xmachines/play-react-demo/variables/Button.md +0 -12
  762. package/examples/@xmachines/play-react-demo/variables/Contact.md +0 -14
  763. package/examples/@xmachines/play-react-demo/variables/Dashboard.md +0 -15
  764. package/examples/@xmachines/play-react-demo/variables/DebugPanel.md +0 -16
  765. package/examples/@xmachines/play-react-demo/variables/Field.md +0 -18
  766. package/examples/@xmachines/play-react-demo/variables/Home.md +0 -14
  767. package/examples/@xmachines/play-react-demo/variables/Login.md +0 -16
  768. package/examples/@xmachines/play-react-demo/variables/NavBar.md +0 -16
  769. package/examples/@xmachines/play-react-demo/variables/NavBarView.md +0 -15
  770. package/examples/@xmachines/play-react-demo/variables/Navigation.md +0 -14
  771. package/examples/@xmachines/play-react-demo/variables/Overview.md +0 -14
  772. package/examples/@xmachines/play-react-demo/variables/Panel.md +0 -15
  773. package/examples/@xmachines/play-react-demo/variables/Profile.md +0 -14
  774. package/examples/@xmachines/play-react-demo/variables/Settings.md +0 -14
  775. package/examples/@xmachines/play-react-demo/variables/Shell.md +0 -19
  776. package/examples/@xmachines/play-react-demo/variables/Stats.md +0 -14
  777. package/examples/@xmachines/play-react-demo/variables/demoComponents.md +0 -30
  778. package/examples/@xmachines/play-solid-demo/README.md +0 -163
  779. package/examples/@xmachines/play-solid-demo/functions/createAuthActionHandlers.md +0 -35
  780. package/examples/@xmachines/play-solid-demo/type-aliases/AuthCatalog.md +0 -9
  781. package/examples/@xmachines/play-solid-demo/variables/About.md +0 -9
  782. package/examples/@xmachines/play-solid-demo/variables/Button.md +0 -11
  783. package/examples/@xmachines/play-solid-demo/variables/Contact.md +0 -9
  784. package/examples/@xmachines/play-solid-demo/variables/Dashboard.md +0 -9
  785. package/examples/@xmachines/play-solid-demo/variables/DebugPanel.md +0 -17
  786. package/examples/@xmachines/play-solid-demo/variables/Field.md +0 -11
  787. package/examples/@xmachines/play-solid-demo/variables/Home.md +0 -9
  788. package/examples/@xmachines/play-solid-demo/variables/Login.md +0 -9
  789. package/examples/@xmachines/play-solid-demo/variables/NavBar.md +0 -11
  790. package/examples/@xmachines/play-solid-demo/variables/NavBarView.md +0 -15
  791. package/examples/@xmachines/play-solid-demo/variables/Navigation.md +0 -9
  792. package/examples/@xmachines/play-solid-demo/variables/Overview.md +0 -9
  793. package/examples/@xmachines/play-solid-demo/variables/Panel.md +0 -11
  794. package/examples/@xmachines/play-solid-demo/variables/Profile.md +0 -9
  795. package/examples/@xmachines/play-solid-demo/variables/Settings.md +0 -9
  796. package/examples/@xmachines/play-solid-demo/variables/Shell.md +0 -18
  797. package/examples/@xmachines/play-solid-demo/variables/Stats.md +0 -9
  798. package/examples/@xmachines/play-solid-demo/variables/demoComponents.md +0 -30
  799. package/examples/@xmachines/play-svelte-demo/README.md +0 -137
  800. package/examples/@xmachines/play-svelte-demo/functions/createAuthActionHandlers.md +0 -35
  801. package/examples/@xmachines/play-svelte-demo/type-aliases/App.md +0 -9
  802. package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md +0 -9
  803. package/examples/@xmachines/play-svelte-demo/variables/App.md +0 -9
  804. package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md +0 -197
  805. package/examples/@xmachines/play-svelte-demo/variables/demoComponents.md +0 -30
  806. package/examples/@xmachines/play-vue-demo/README.md +0 -159
  807. package/examples/@xmachines/play-vue-demo/functions/createAuthActionHandlers.md +0 -35
  808. package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md +0 -9
  809. package/examples/@xmachines/play-vue-demo/variables/App.md +0 -9
  810. package/examples/@xmachines/play-vue-demo/variables/demoComponents.md +0 -11
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterBridge
4
4
 
5
- Defined in: [play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L436)
5
+ Defined in: [play-router/src/types.ts:436](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L436)
6
6
 
7
7
  The RouterBridge interface of a runtime infrastructure adapter
8
8
 
@@ -54,7 +54,7 @@ class MyRouterBridge implements RouterBridge {
54
54
  connect(): void | Promise<void>;
55
55
  ```
56
56
 
57
- Defined in: [play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L453)
57
+ Defined in: [play-router/src/types.ts:453](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L453)
58
58
 
59
59
  Connects the router bridge to the Actor
60
60
 
@@ -84,7 +84,7 @@ await bridge.connect();
84
84
  disconnect(): void | Promise<void>;
85
85
  ```
86
86
 
87
- Defined in: [play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L469)
87
+ Defined in: [play-router/src/types.ts:469](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L469)
88
88
 
89
89
  Disconnects the router bridge from the Actor
90
90
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: RouterConnection()
4
4
 
5
- Defined in: [play-router/src/provider-lifecycle.ts:291](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L291)
5
+ Defined in: [play-router/src/provider-lifecycle.ts:291](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L291)
6
6
 
7
7
  What `connectRouter` of an adapter returns.
8
8
 
@@ -21,7 +21,7 @@ stale.
21
21
  RouterConnection(): void;
22
22
  ```
23
23
 
24
- Defined in: [play-router/src/provider-lifecycle.ts:293](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L293)
24
+ Defined in: [play-router/src/provider-lifecycle.ts:293](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L293)
25
25
 
26
26
  Stops the synchronization. The same call as [RouterConnection.disconnect](#disconnect).
27
27
 
@@ -31,10 +31,10 @@ Stops the synchronization. The same call as [RouterConnection.disconnect](#disco
31
31
 
32
32
  ## Properties
33
33
 
34
- | Property | Modifier | Type | Description | Defined in |
35
- | ----------------------------------------------------- | ---------- | -------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
36
- | <a id="property-basepath"></a> `basePath` | `readonly` | `string` | The resolved prefix of the mount, or `""` when the machine owns the whole router. | [play-router/src/provider-lifecycle.ts:309](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L309) |
37
- | <a id="property-basepathparams"></a> `basePathParams` | `readonly` | `Readonly`\<`Record`\<`string`, `string`\>\> | The values of the `:param` segments of the mount. They travel in no event. | [play-router/src/provider-lifecycle.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L311) |
34
+ | Property | Modifier | Type | Description | Defined in |
35
+ | ----------------------------------------------------- | ---------- | -------------------------------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
36
+ | <a id="property-basepath"></a> `basePath` | `readonly` | `string` | The resolved prefix of the mount, or `""` when the machine owns the whole router. | [play-router/src/provider-lifecycle.ts:309](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L309) |
37
+ | <a id="property-basepathparams"></a> `basePathParams` | `readonly` | `Readonly`\<`Record`\<`string`, `string`\>\> | The values of the `:param` segments of the mount. They travel in no event. | [play-router/src/provider-lifecycle.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L311) |
38
38
 
39
39
  ## Methods
40
40
 
@@ -44,7 +44,7 @@ Stops the synchronization. The same call as [RouterConnection.disconnect](#disco
44
44
  disconnect(): void;
45
45
  ```
46
46
 
47
- Defined in: [play-router/src/provider-lifecycle.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L307)
47
+ Defined in: [play-router/src/provider-lifecycle.ts:307](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L307)
48
48
 
49
49
  Stops the synchronization. It is idempotent.
50
50
 
@@ -70,7 +70,7 @@ A scope can own the connection: the connection is its own release, so
70
70
  setBasePath(basePath?, basePathParams?): void;
71
71
  ```
72
72
 
73
- Defined in: [play-router/src/provider-lifecycle.ts:313](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/provider-lifecycle.ts#L313)
73
+ Defined in: [play-router/src/provider-lifecycle.ts:313](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/provider-lifecycle.ts#L313)
74
74
 
75
75
  Moves the mount of the live bridge, with no teardown.
76
76
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: WindowLike
4
4
 
5
- Defined in: [play-router/src/types.ts:537](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L537)
5
+ Defined in: [play-router/src/types.ts:537](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L537)
6
6
 
7
7
  The minimal window interface of an adapter that subscribes to a DOM event, for
8
8
  example to `hashchange`. You can inject it for SSR and for a test: give a mock in
@@ -30,7 +30,7 @@ connectRouter({ actor, routeMap, window: mockWin });
30
30
  addEventListener(type, listener): void;
31
31
  ```
32
32
 
33
- Defined in: [play-router/src/types.ts:538](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L538)
33
+ Defined in: [play-router/src/types.ts:538](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L538)
34
34
 
35
35
  #### Parameters
36
36
 
@@ -51,7 +51,7 @@ Defined in: [play-router/src/types.ts:538](https://gitlab.com/xmachin-es/xmachin
51
51
  removeEventListener(type, listener): void;
52
52
  ```
53
53
 
54
- Defined in: [play-router/src/types.ts:539](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L539)
54
+ Defined in: [play-router/src/types.ts:539](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L539)
55
55
 
56
56
  #### Parameters
57
57
 
@@ -4,7 +4,7 @@
4
4
 
5
5
  SvelteKit router adapter for the XMachines Universal Player Architecture. It keeps the state machine routes of a `RoutableActor` and the browser URL in step, in both directions, through the `$app/navigation` module of SvelteKit.
6
6
 
7
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-6.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-sveltekit-router)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-7.1.0-blue)](https://www.npmjs.com/package/@xmachines/play-sveltekit-router)
8
8
 
9
9
  ## Installation
10
10
 
@@ -20,20 +20,23 @@ pnpm add @xmachines/play-sveltekit-router @xmachines/play-router @xmachines/core
20
20
  pnpm add @sveltejs/kit svelte
21
21
  ```
22
22
 
23
- | Peer dependency | Required version |
24
- | --------------- | ---------------- |
25
- | `@sveltejs/kit` | `^2.0.0` |
26
- | `svelte` | `^5.0.0` |
23
+ | Peer dependency | Required version |
24
+ | --------------- | --------------------- |
25
+ | `@sveltejs/kit` | `^2.12.0 \|\| ^3.0.0` |
26
+ | `svelte` | `^5.0.0` |
27
27
 
28
28
  ## Quick Start
29
29
 
30
30
  ```typescript
31
31
  import { onDestroy } from "svelte";
32
+ import { page } from "$app/state";
32
33
  import { connectRouter } from "@xmachines/play-sveltekit-router";
33
34
  import { createRouteMap } from "@xmachines/play-router/xstate";
34
35
  import { definePlayer, compose, PlayerActor } from "@xmachines/play-xstate";
35
36
  import { withRouting } from "@xmachines/play-xstate/routing";
36
- import { myMachine } from "./machine.js";
37
+ import type { AnyStateMachine } from "xstate";
38
+
39
+ declare const myMachine: AnyStateMachine; // your machine, with `meta.route` on its routable states
37
40
 
38
41
  // 1. Create the actor — `connectRouter` needs the routing capability
39
42
  const createPlayer = definePlayer({ machine: myMachine, actor: compose(PlayerActor, withRouting) });
@@ -43,8 +46,14 @@ actor.start();
43
46
  // 2. Build a bidirectional route map from the machine definition
44
47
  const routeMap = createRouteMap(myMachine);
45
48
 
46
- // 3. Connect the router — returns a cleanup function
47
- const disconnect = connectRouter({ actor, routeMap });
49
+ // 3. Connect the router — returns a cleanup function. The server has no
50
+ // `globalThis.location`, so give it the URL of the request. Without it, the
51
+ // server renders the initial route of the actor and not the requested page.
52
+ const disconnect = connectRouter({
53
+ actor,
54
+ routeMap,
55
+ location: globalThis.location ?? { pathname: page.url.pathname, search: page.url.search },
56
+ });
48
57
 
49
58
  // 4. Clean up when the component is destroyed
50
59
  onDestroy(() => disconnect());
@@ -52,7 +61,7 @@ onDestroy(() => disconnect());
52
61
 
53
62
  The bridge works in both directions:
54
63
 
55
- - **URL → actor:** the bridge converts each SvelteKit `afterNavigate` event into a `play.route` event, then sends it to the actor.
64
+ - **URL → actor:** the bridge converts each SvelteKit `afterNavigate` event into a `play.route` event, then sends it to the actor. With `shallow: "sync"`, it converts each URL that the browser shows, the shallow URLs too. See [Shallow navigation](#shallow-navigation).
56
65
  - **Actor → URL:** the bridge writes each change of the actor `currentRoute` atom to the browser URL with `goto()`.
57
66
 
58
67
  ## Usage
@@ -63,9 +72,14 @@ This function is the primary integration point. It creates a `SvelteKitRouterBri
63
72
 
64
73
  ```typescript
65
74
  import { onDestroy } from "svelte";
66
- import { connectRouter } from "@xmachines/play-sveltekit-router";
75
+ import { connectRouter, type RoutableActor } from "@xmachines/play-sveltekit-router";
67
76
  import { createRouteMap } from "@xmachines/play-router/xstate";
77
+ import type { AnyStateMachine } from "xstate";
78
+
68
79
  // machine and actor as in the Quick Start above
80
+ declare const machine: AnyStateMachine;
81
+ declare const actor: RoutableActor;
82
+
69
83
  const routeMap = createRouteMap(machine);
70
84
 
71
85
  // In a Svelte component or SvelteKit layout
@@ -89,15 +103,48 @@ onDestroy(() => disconnect());
89
103
  | `actor` | `RoutableActor` | Yes | The XMachines actor that the bridge keeps in step with the router |
90
104
  | `routeMap` | `RouteMap` | Yes | The bidirectional map between the state IDs and the URL paths |
91
105
  | `location` | `LocationLike \| null` | No | The location stub for the initial URL reads. The default is `globalThis.location`. Give a mock in a test, or a stub in an SSR environment. |
106
+ | `shallow` | `"ignore" \| "sync"` | No | What the bridge does with a shallow navigation. The default is `"ignore"`. See [Shallow navigation](#shallow-navigation). |
107
+
108
+ ### Shallow navigation
109
+
110
+ A shallow navigation changes the URL and loads no page: `goto(url, { shallow: true })` in SvelteKit 3, `pushState` and `replaceState`, and a back or forward step between shallow entries. A modal that has its own URL is the usual case.
111
+
112
+ - `shallow: "ignore"` (the default): the machine keeps its route. The bridge watches `afterNavigate`.
113
+ - `shallow: "sync"`: the machine follows each URL that the browser shows, the shallow URLs too, back and forward included. The bridge watches `page` of `$app/state`.
114
+
115
+ `afterNavigate` cannot serve `"sync"`. SvelteKit 3 calls it for a shallow `goto`, but it calls it for no back or forward step between shallow entries. SvelteKit 2 calls it for no shallow navigation.
116
+
117
+ ```typescript
118
+ import { onDestroy } from "svelte";
119
+ import { connectRouter, type RoutableActor } from "@xmachines/play-sveltekit-router";
120
+ import { createRouteMap } from "@xmachines/play-router/xstate";
121
+ import type { AnyStateMachine } from "xstate";
122
+
123
+ // machine and actor as in the Quick Start above
124
+ declare const machine: AnyStateMachine;
125
+ declare const actor: RoutableActor;
126
+
127
+ const disconnect = connectRouter({ actor, routeMap: createRouteMap(machine), shallow: "sync" });
128
+ onDestroy(() => disconnect());
129
+ ```
130
+
131
+ Give each shallow URL a route in the machine. For a URL that the machine does not know, the bridge navigates back to the route of the machine, and that navigation loads the page.
132
+
133
+ On SvelteKit 2, give `pushState` and `replaceState` a NEW state object on each call. SvelteKit 2 changes only `page.state` for a shallow navigation, and the bridge sees the change of that object. A call with the state object that the page holds already, such as `replaceState(url, page.state)`, changes the URL and nothing that the bridge can observe, so the machine keeps its route. SvelteKit 3 has no such limit.
92
134
 
93
135
  ### `SvelteKitRouterBridge` — low-level class
94
136
 
95
137
  This class extends `RouterBridgeBase` from [`@xmachines/play-router`](../play-router/README.md). Use it directly when you need more control over the connection lifecycle.
96
138
 
97
139
  ```typescript
98
- import { SvelteKitRouterBridge } from "@xmachines/play-sveltekit-router";
140
+ import { SvelteKitRouterBridge, type RoutableActor } from "@xmachines/play-sveltekit-router";
99
141
  import { createRouteMap } from "@xmachines/play-router/xstate";
142
+ import type { AnyStateMachine } from "xstate";
143
+
100
144
  // machine and actor as in the Quick Start above
145
+ declare const machine: AnyStateMachine;
146
+ declare const actor: RoutableActor;
147
+
101
148
  const routeMap = createRouteMap(machine);
102
149
  const bridge = new SvelteKitRouterBridge(actor, routeMap, location);
103
150
  bridge.connect();
@@ -108,8 +155,8 @@ bridge.disconnect();
108
155
 
109
156
  **SvelteKit integration details:**
110
157
 
111
- - `navigateRouter` → `goto(path, { noScroll: true, keepFocus: true })`
112
- - `watchRouterChanges` → registers an `afterNavigate` callback through an indirection cell, which prevents a direct capture of `this`
158
+ - `navigateRouter` → `goto(path, { reset: false })` on SvelteKit 3, and `goto(path, { noScroll: true, keepFocus: true })` on SvelteKit 2. The bridge reads `VERSION` of `@sveltejs/kit` to choose the options. Both keep the scroll position and the focused element. On the server, the bridge calls no `goto`: SvelteKit has none there
159
+ - `watchRouterChanges` → registers an `afterNavigate` callback through an indirection cell, which prevents a direct capture of `this`. The callback ignores a shallow navigation (`goto(url, { shallow: true })`), because the URL changes and no page loads
113
160
  - `unwatchRouterChanges` → sets the indirection cell to null, which releases the bridge reference before the component unmounts (SvelteKit has no API to cancel `afterNavigate`)
114
161
 
115
162
  ### `createRouteMap(machine)` — from `@xmachines/play-router/xstate`
@@ -195,6 +242,11 @@ MIT — see [LICENSE](../../../LICENSE).
195
242
  - [RouteMapping](interfaces/RouteMapping.md)
196
243
  - [RouterBridge](interfaces/RouterBridge.md)
197
244
  - [RouterConnection](interfaces/RouterConnection.md)
245
+ - [SvelteKitRouterBridgeOptions](interfaces/SvelteKitRouterBridgeOptions.md)
246
+
247
+ ## Type Aliases
248
+
249
+ - [ShallowNavigation](type-aliases/ShallowNavigation.md)
198
250
 
199
251
  ## Functions
200
252
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Class: RouteMap
4
4
 
5
- Defined in: [play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L176)
5
+ Defined in: [play-router/src/base-route-map.ts:176](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L176)
6
6
 
7
7
  The shared base class of the route map for both directions.
8
8
 
@@ -64,7 +64,7 @@ map.getPathByStateId("missing"); // null
64
64
  new RouteMap(mappings, options?): RouteMap;
65
65
  ```
66
66
 
67
- Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L209)
67
+ Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L209)
68
68
 
69
69
  Builds a route map from an array of the mappings between a state ID and a path.
70
70
 
@@ -78,7 +78,7 @@ candidates is therefore efficient.
78
78
  | Parameter | Type | Description |
79
79
  | ---------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
80
80
  | `mappings` | [`RouteMapping`](../interfaces/RouteMapping.md)[] | The array of the `{ stateId, path }` entries. The order gives the priority when more than one pattern can match the same path. |
81
- | `options` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md) | See [RouteMapOptions](../interfaces/RouteMapOptions.md). A map holds TWO caches, so no option is named `cache`: each one names the cache that it carries. |
81
+ | `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md) | See [RouteMapOptions](../interfaces/RouteMapOptions.md). A map holds TWO caches, so no option is named `cache`: each one names the cache that it carries. |
82
82
 
83
83
  #### Returns
84
84
 
@@ -92,7 +92,7 @@ candidates is therefore efficient.
92
92
  getPathByStateId(stateId): string | null;
93
93
  ```
94
94
 
95
- Defined in: [play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L322)
95
+ Defined in: [play-router/src/base-route-map.ts:322](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L322)
96
96
 
97
97
  Returns the path pattern of a state ID.
98
98
 
@@ -128,7 +128,7 @@ map.getPathByStateId("missing"); // null
128
128
  getStateIdByPath(path): string | null;
129
129
  ```
130
130
 
131
- Defined in: [play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/base-route-map.ts#L277)
131
+ Defined in: [play-router/src/base-route-map.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/base-route-map.ts#L277)
132
132
 
133
133
  Resolves a URL path to its state ID.
134
134
 
@@ -2,16 +2,20 @@
2
2
 
3
3
  # Class: SvelteKitRouterBridge
4
4
 
5
- Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L41)
5
+ Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L89)
6
6
 
7
7
  The SvelteKit router bridge — it connects the SvelteKit navigation to RouterBridgeBase.
8
8
 
9
9
  It implements the three abstract methods:
10
10
 
11
- - `navigateRouter` → `goto(path, { noScroll: true, keepFocus: true })`
12
- - `watchRouterChanges` → an `afterNavigate()` subscription through an indirection cell
11
+ - `navigateRouter` → `goto(path, { reset: false })` on SvelteKit 3, and
12
+ `goto(path, { noScroll: true, keepFocus: true })` on SvelteKit 2
13
+ - `watchRouterChanges` → an `afterNavigate()` subscription through an indirection cell,
14
+ which ignores a shallow navigation. With `shallow: "sync"`, a watch of `page` of
15
+ `$app/state` instead, which sees each shallow change too
13
16
  - `unwatchRouterChanges` → it sets the cell to null. This releases the bridge
14
- reference of the registered closure before the component unmounts
17
+ reference of the registered closure before the component unmounts. With
18
+ `shallow: "sync"`, it ends the watch
15
19
 
16
20
  It overrides two optional hooks:
17
21
 
@@ -37,9 +41,15 @@ The bidirectional route map.
37
41
 
38
42
  **loc**
39
43
 
40
- The location-like object for the initial URL reads. The default
41
- is `globalThis.location`. Give a mock in a test, or a stub in an SSR
42
- environment.
44
+ The location-like object for the initial URL reads, and for each
45
+ read of `shallow: "sync"`. The default is `globalThis.location`. Give a mock in a
46
+ test, or a stub in an SSR environment.
47
+
48
+ ## Param
49
+
50
+ **options**
51
+
52
+ The options of the base class, and `shallow`.
43
53
 
44
54
  ## Extends
45
55
 
@@ -58,16 +68,16 @@ new SvelteKitRouterBridge(
58
68
  ): SvelteKitRouterBridge;
59
69
  ```
60
70
 
61
- Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L58)
71
+ Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:111](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L111)
62
72
 
63
73
  #### Parameters
64
74
 
65
- | Parameter | Type |
66
- | ---------- | ---------------------------------------------------------------------------------- |
67
- | `actor` | [`RoutableActor`](../interfaces/RoutableActor.md) |
68
- | `routeMap` | [`RouteMap`](RouteMap.md) |
69
- | `loc` | [`LocationLike`](../interfaces/LocationLike.md) \| `null` |
70
- | `options?` | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md) |
75
+ | Parameter | Type |
76
+ | ---------- | ------------------------------------------------------------------------------- |
77
+ | `actor` | [`RoutableActor`](../interfaces/RoutableActor.md) |
78
+ | `routeMap` | [`RouteMap`](RouteMap.md) |
79
+ | `loc?` | [`LocationLike`](../interfaces/LocationLike.md) \| `null` |
80
+ | `options?` | [`SvelteKitRouterBridgeOptions`](../interfaces/SvelteKitRouterBridgeOptions.md) |
71
81
 
72
82
  #### Returns
73
83
 
@@ -87,7 +97,7 @@ Defined in: [play-sveltekit-router/src/sveltekit-router-bridge.ts:58](https://gi
87
97
  get basePath(): string;
88
98
  ```
89
99
 
90
- Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L282)
100
+ Defined in: [play-router/src/router-bridge-base.ts:282](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L282)
91
101
 
92
102
  The resolved URL prefix that the machine of this bridge is mounted under, or `""`
93
103
  when the machine owns the complete router.
@@ -112,7 +122,7 @@ The resolved URL prefix of the mount, or `""` when the machine owns the complete
112
122
  get basePathParams(): Readonly<Record<string, string>>;
113
123
  ```
114
124
 
115
- Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L311)
125
+ Defined in: [play-router/src/router-bridge-base.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L311)
116
126
 
117
127
  The resolved values of the `:param` segments of the mount, or `{}` for a prefix
118
128
  without a param.
@@ -163,7 +173,7 @@ mount while the machine stays on the same route, and no event goes out.
163
173
  connect(): void;
164
174
  ```
165
175
 
166
- Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L533)
176
+ Defined in: [play-router/src/router-bridge-base.ts:533](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L533)
167
177
 
168
178
  Connects the router bridge to the Actor.
169
179
 
@@ -197,7 +207,7 @@ An adapter that needs a different behavior of the first synchronization override
197
207
  disconnect(): void;
198
208
  ```
199
209
 
200
- Defined in: [play-router/src/router-bridge-base.ts:791](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L791)
210
+ Defined in: [play-router/src/router-bridge-base.ts:795](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L795)
201
211
 
202
212
  Disconnects the router bridge from the Actor.
203
213
 
@@ -220,7 +230,7 @@ framework.
220
230
  setBasePath(basePath?, basePathParams?): void;
221
231
  ```
222
232
 
223
- Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/router-bridge-base.ts#L351)
233
+ Defined in: [play-router/src/router-bridge-base.ts:351](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/router-bridge-base.ts#L351)
224
234
 
225
235
  Moves the machine to a different mount point, while it stays connected.
226
236
 
@@ -6,7 +6,7 @@
6
6
  function connectRouter(options): RouterConnection;
7
7
  ```
8
8
 
9
- Defined in: [play-sveltekit-router/src/connect-router.ts:35](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-sveltekit-router/src/connect-router.ts#L35)
9
+ Defined in: [play-sveltekit-router/src/connect-router.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-sveltekit-router/src/connect-router.ts#L33)
10
10
 
11
11
  Connects the SvelteKit router to an actor.
12
12
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: BasePathOptions
4
4
 
5
- Defined in: [play-url/src/base-path.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L49)
5
+ Defined in: [play-url/src/base-path.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/base-path.ts#L49)
6
6
 
7
7
  The base-path options that every router bridge, `connectRouter` function, and
8
8
  `PlayRouterProvider` component accepts.
@@ -22,7 +22,7 @@ connectRouter({
22
22
 
23
23
  ## Properties
24
24
 
25
- | Property | Modifier | Type | Description | Defined in |
26
- | ------------------------------------------------------ | ---------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
27
- | <a id="property-basepath"></a> `basePath?` | `readonly` | `string` | The URL prefix that the routes of the machine hang off, for example `"/admin"` or `"/:machineId/play"`. A `:param` segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every `:param` must have a value in [BasePathOptions.basePathParams](#property-basepathparams), because the bridge writes a real URL. An optional segment (`:param?`) and a wildcard (`*`) are therefore refused: neither of them resolves to one concrete prefix. An absent value, `""`, and `"/"` all mean "no prefix". | [play-url/src/base-path.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L62) |
28
- | <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [BasePathOptions.basePath](#property-basepath). These values belong to the HOST, which wrote the prefix and resolved them, so they travel in NO `play.route` event: the machine is authoritative over its own params, and `event.params` holds what the pattern of the machine declares, and nothing else. A param of the host that shares a name with one of the machine can therefore shadow it never. A host reads them back from `bridge.basePathParams`, where they cannot go stale. A machine that needs the identity of its host takes it through the `input` of the actor, where that identity decides WHICH machine runs. | [play-url/src/base-path.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L76) |
25
+ | Property | Modifier | Type | Description | Defined in |
26
+ | ------------------------------------------------------ | ---------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
27
+ | <a id="property-basepath"></a> `basePath?` | `readonly` | `string` | The URL prefix that the routes of the machine hang off, for example `"/admin"` or `"/:machineId/play"`. A `:param` segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every `:param` must have a value in [BasePathOptions.basePathParams](#property-basepathparams), because the bridge writes a real URL. An optional segment (`:param?`) and a wildcard (`*`) are therefore refused: neither of them resolves to one concrete prefix. An absent value, `""`, and `"/"` all mean "no prefix". | [play-url/src/base-path.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/base-path.ts#L62) |
28
+ | <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [BasePathOptions.basePath](#property-basepath). These values belong to the HOST, which wrote the prefix and resolved them, so they travel in NO `play.route` event: the machine is authoritative over its own params, and `event.params` holds what the pattern of the machine declares, and nothing else. A param of the host that shares a name with one of the machine can therefore shadow it never. A host reads them back from `bridge.basePathParams`, where they cannot go stale. A machine that needs the identity of its host takes it through the `input` of the actor, where that identity decides WHICH machine runs. | [play-url/src/base-path.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/base-path.ts#L76) |
@@ -2,26 +2,23 @@
2
2
 
3
3
  # Interface: ConnectRouterOptions
4
4
 
5
- Defined in: [play-sveltekit-router/src/connect-router.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-sveltekit-router/src/connect-router.ts#L10)
5
+ Defined in: [play-sveltekit-router/src/connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-sveltekit-router/src/connect-router.ts#L8)
6
6
 
7
- What a bridge takes beside the actor and the route map.
8
-
9
- It is [BasePathOptions](../../play-router/index/interfaces/BasePathOptions.md) with the caches of [CompileOptions](../../play-router/index/interfaces/CompileOptions.md) added: the parse
10
- cache AND the compiled cache. A base path and a cache are two different questions, and
11
- this type joins them at the ONE place that asks both: the constructor of a bridge.
7
+ The options of [SvelteKitRouterBridge](../classes/SvelteKitRouterBridge.md).
12
8
 
13
9
  ## Extends
14
10
 
15
- - [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md)
11
+ - [`SvelteKitRouterBridgeOptions`](SvelteKitRouterBridgeOptions.md)
16
12
 
17
13
  ## Properties
18
14
 
19
- | Property | Modifier | Type | Description | Inherited from | Defined in |
20
- | ------------------------------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
21
- | <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](RoutableActor.md) | - | - | [play-sveltekit-router/src/connect-router.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-sveltekit-router/src/connect-router.ts#L11) |
22
- | <a id="property-basepath"></a> `basePath?` | `readonly` | `string` | The URL prefix that the routes of the machine hang off, for example `"/admin"` or `"/:machineId/play"`. A `:param` segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every `:param` must have a value in [BasePathOptions.basePathParams](../../play-router/index/interfaces/BasePathOptions.md#property-basepathparams), because the bridge writes a real URL. An optional segment (`:param?`) and a wildcard (`*`) are therefore refused: neither of them resolves to one concrete prefix. An absent value, `""`, and `"/"` all mean "no prefix". | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`basePath`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-basepath) | [play-url/src/base-path.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L62) |
23
- | <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [BasePathOptions.basePath](../../play-router/index/interfaces/BasePathOptions.md#property-basepath). These values belong to the HOST, which wrote the prefix and resolved them, so they travel in NO `play.route` event: the machine is authoritative over its own params, and `event.params` holds what the pattern of the machine declares, and nothing else. A param of the host that shares a name with one of the machine can therefore shadow it never. A host reads them back from `bridge.basePathParams`, where they cannot go stale. A machine that needs the identity of its host takes it through the `input` of the actor, where that identity decides WHICH machine runs. | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`basePathParams`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-basepathparams) | [play-url/src/base-path.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/base-path.ts#L76) |
24
- | <a id="property-compiledcache"></a> `compiledCache?` | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`URLPatternLike`](../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern. | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`compiledCache`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-compiledcache) | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-url/src/url-pattern-utils.ts#L119) |
25
- | <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | The location-like object for the initial URL reads. The default is `globalThis.location`. Give a mock in a test, or a stub in an SSR environment. | - | [play-sveltekit-router/src/connect-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-sveltekit-router/src/connect-router.ts#L18) |
26
- | <a id="property-patterncache"></a> `patternCache?` | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`ParsedPattern`](../../play-router/index/interfaces/ParsedPattern.md)\> | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process. | [`RouterBridgeOptions`](../../play-router/index/interfaces/RouterBridgeOptions.md).[`patternCache`](../../play-router/index/interfaces/RouterBridgeOptions.md#property-patterncache) | [play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-pattern/src/cache.ts#L41) |
27
- | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | - | [play-sveltekit-router/src/connect-router.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-sveltekit-router/src/connect-router.ts#L12) |
15
+ | Property | Modifier | Type | Description | Inherited from | Defined in |
16
+ | ------------------------------------------------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
17
+ | <a id="property-actor"></a> `actor` | `readonly` | [`RoutableActor`](RoutableActor.md) | - | - | [play-sveltekit-router/src/connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-sveltekit-router/src/connect-router.ts#L9) |
18
+ | <a id="property-basepath"></a> `basePath?` | `readonly` | `string` | The URL prefix that the routes of the machine hang off, for example `"/admin"` or `"/:machineId/play"`. A `:param` segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every `:param` must have a value in [BasePathOptions.basePathParams](../../play-router/index/interfaces/BasePathOptions.md#property-basepathparams), because the bridge writes a real URL. An optional segment (`:param?`) and a wildcard (`*`) are therefore refused: neither of them resolves to one concrete prefix. An absent value, `""`, and `"/"` all mean "no prefix". | [`SvelteKitRouterBridgeOptions`](SvelteKitRouterBridgeOptions.md).[`basePath`](SvelteKitRouterBridgeOptions.md#property-basepath) | [play-url/src/base-path.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/base-path.ts#L62) |
19
+ | <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [BasePathOptions.basePath](../../play-router/index/interfaces/BasePathOptions.md#property-basepath). These values belong to the HOST, which wrote the prefix and resolved them, so they travel in NO `play.route` event: the machine is authoritative over its own params, and `event.params` holds what the pattern of the machine declares, and nothing else. A param of the host that shares a name with one of the machine can therefore shadow it never. A host reads them back from `bridge.basePathParams`, where they cannot go stale. A machine that needs the identity of its host takes it through the `input` of the actor, where that identity decides WHICH machine runs. | [`SvelteKitRouterBridgeOptions`](SvelteKitRouterBridgeOptions.md).[`basePathParams`](SvelteKitRouterBridgeOptions.md#property-basepathparams) | [play-url/src/base-path.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/base-path.ts#L76) |
20
+ | <a id="property-compiledcache"></a> `compiledCache?` | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`URLPatternLike`](../../play-router/index/type-aliases/URLPatternLike.md)\> | The cache of the COMPILED `URLPattern`, which is what this function returns. The default is a cache that this module shares with every caller of the process. Pass one to give a tenant or a request a compilation that no other evicts, and pass `{ get: () => undefined, set: () => {} }` to compile each time. A caller that passes `patternCache` for isolation passes this one too. The compiled cache is read FIRST, so a hit on it answers before the parse runs at all — a passed parse cache alone therefore isolates nothing once another caller has compiled the same pattern. | [`SvelteKitRouterBridgeOptions`](SvelteKitRouterBridgeOptions.md).[`compiledCache`](SvelteKitRouterBridgeOptions.md#property-compiledcache) | [play-url/src/url-pattern-utils.ts:119](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-url/src/url-pattern-utils.ts#L119) |
21
+ | <a id="property-location"></a> `location?` | `readonly` | [`LocationLike`](LocationLike.md) \| `null` | The location-like object for the initial URL reads. The default is `globalThis.location`. Give a mock in a test, or a stub in an SSR environment. | - | [play-sveltekit-router/src/connect-router.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-sveltekit-router/src/connect-router.ts#L16) |
22
+ | <a id="property-patterncache"></a> `patternCache?` | `readonly` | [`KeyValueCache`](../../play-router/index/interfaces/KeyValueCache.md)\<[`ParsedPattern`](../../play-router/index/interfaces/ParsedPattern.md)\> | The cache of the PARSE of a pattern. The default is the cache that this package shares with every caller of the process. | [`SvelteKitRouterBridgeOptions`](SvelteKitRouterBridgeOptions.md).[`patternCache`](SvelteKitRouterBridgeOptions.md#property-patterncache) | [play-pattern/src/cache.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-pattern/src/cache.ts#L41) |
23
+ | <a id="property-routemap"></a> `routeMap` | `readonly` | [`RouteMap`](../classes/RouteMap.md) | - | - | [play-sveltekit-router/src/connect-router.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-sveltekit-router/src/connect-router.ts#L10) |
24
+ | <a id="property-shallow"></a> `shallow?` | `readonly` | [`ShallowNavigation`](../type-aliases/ShallowNavigation.md) | What the bridge does with a shallow navigation. The default is `"ignore"`. **See** [ShallowNavigation](../type-aliases/ShallowNavigation.md) | [`SvelteKitRouterBridgeOptions`](SvelteKitRouterBridgeOptions.md).[`shallow`](SvelteKitRouterBridgeOptions.md#property-shallow) | [play-sveltekit-router/src/sveltekit-router-bridge.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-sveltekit-router/src/sveltekit-router-bridge.ts#L47) |
@@ -2,7 +2,7 @@
2
2
 
3
3
  # Interface: LocationLike
4
4
 
5
- Defined in: [play-router/src/types.ts:557](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L557)
5
+ Defined in: [play-router/src/types.ts:557](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L557)
6
6
 
7
7
  The minimal location interface of an adapter that reads the current URL at the
8
8
  moment of `connect()`. You can inject it for SSR and for a test: give a mock in
@@ -21,7 +21,7 @@ connectRouter({ actor, routeMap, location: mockLoc });
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Modifier | Type | Defined in |
25
- | ----------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- |
26
- | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:558](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L558) |
27
- | <a id="property-search"></a> `search` | `readonly` | `string` | [play-router/src/types.ts:559](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v6.1.0/packages/play-router/src/types.ts#L559) |
24
+ | Property | Modifier | Type | Defined in |
25
+ | ----------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
26
+ | <a id="property-pathname"></a> `pathname` | `readonly` | `string` | [play-router/src/types.ts:558](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L558) |
27
+ | <a id="property-search"></a> `search` | `readonly` | `string` | [play-router/src/types.ts:559](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.1.0/packages/play-router/src/types.ts#L559) |