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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (131) hide show
  1. package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
  2. package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
  3. package/api/@xmachines/play-actor/interfaces/Routable.md +2 -2
  4. package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
  5. package/api/@xmachines/play-actor/interfaces/Viewable.md +3 -3
  6. package/api/@xmachines/play-catalog/functions/defineCatalog.md +1 -1
  7. package/api/@xmachines/play-catalog/functions/defineComponents.md +1 -1
  8. package/api/@xmachines/play-catalog/type-aliases/Catalog.md +1 -1
  9. package/api/@xmachines/play-catalog/type-aliases/ComponentsFor.md +1 -1
  10. package/api/@xmachines/play-catalog/type-aliases/InferComponentProps.md +1 -1
  11. package/api/@xmachines/play-catalog/type-aliases/NoExtraKeys.md +1 -1
  12. package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
  13. package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
  14. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
  15. package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
  16. package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +4 -4
  17. package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
  18. package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +6 -6
  19. package/api/@xmachines/play-react-router/classes/RouteMap.md +1 -1
  20. package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
  21. package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
  22. package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  23. package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
  24. package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
  25. package/api/@xmachines/play-router/classes/RouterBridgeBase.md +21 -21
  26. package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
  27. package/api/@xmachines/play-router/functions/connectRouter.md +1 -1
  28. package/api/@xmachines/play-router/functions/crawlMachine.md +1 -1
  29. package/api/@xmachines/play-router/functions/createBrowserHistory.md +1 -1
  30. package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
  31. package/api/@xmachines/play-router/functions/createRouter.md +1 -1
  32. package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
  33. package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
  34. package/api/@xmachines/play-router/functions/extractRoute.md +1 -1
  35. package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
  36. package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
  37. package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
  38. package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
  39. package/api/@xmachines/play-router/functions/routeExists.md +1 -1
  40. package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
  41. package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
  42. package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
  43. package/api/@xmachines/play-router/interfaces/BrowserHistory.md +14 -14
  44. package/api/@xmachines/play-router/interfaces/BrowserWindow.md +14 -14
  45. package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +4 -4
  46. package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
  47. package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
  48. package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
  49. package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
  50. package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
  51. package/api/@xmachines/play-router/interfaces/RouteTree.md +4 -4
  52. package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
  53. package/api/@xmachines/play-router/interfaces/StateVisit.md +4 -4
  54. package/api/@xmachines/play-router/interfaces/VanillaRouter.md +4 -4
  55. package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
  56. package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
  57. package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
  58. package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
  59. package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
  60. package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
  61. package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
  62. package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +4 -4
  63. package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
  64. package/api/@xmachines/play-solid-router/classes/RouteMap.md +1 -1
  65. package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
  66. package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
  67. package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
  68. package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  69. package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
  70. package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
  71. package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
  72. package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +1 -1
  73. package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +6 -6
  74. package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
  75. package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
  76. package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
  77. package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
  78. package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
  79. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
  80. package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
  81. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
  82. package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
  83. package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +1 -1
  84. package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +7 -7
  85. package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
  86. package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
  87. package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
  88. package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
  89. package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
  90. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
  91. package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
  92. package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +3 -3
  93. package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
  94. package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
  95. package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +5 -5
  96. package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +8 -8
  97. package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
  98. package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
  99. package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
  100. package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
  101. package/api/@xmachines/play-xstate/classes/PlayerActor.md +11 -11
  102. package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
  103. package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
  104. package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
  105. package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
  106. package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
  107. package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
  108. package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
  109. package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
  110. package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
  111. package/api/@xmachines/play-xstate/functions/mergeViewProps.md +1 -1
  112. package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
  113. package/api/@xmachines/play-xstate/functions/stateMatches.md +1 -1
  114. package/api/@xmachines/play-xstate/functions/validateComponentBinding.md +1 -1
  115. package/api/@xmachines/play-xstate/functions/validateViewProps.md +2 -2
  116. package/api/@xmachines/play-xstate/interfaces/CatalogEntry.md +3 -3
  117. package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +4 -4
  118. package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
  119. package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
  120. package/api/@xmachines/play-xstate/type-aliases/Catalog.md +1 -1
  121. package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
  122. package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
  123. package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
  124. package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
  125. package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
  126. package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
  127. package/api/@xmachines/play-xstate/type-aliases/ValidationResult.md +1 -1
  128. package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md +3 -3
  129. package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
  130. package/api/@xmachines/shared/functions/xmAliases.md +1 -1
  131. package/package.json +2 -2
package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md CHANGED
@@ -6,7 +6,7 @@
6
6
  type ViewMergeContext = object;
7
7
  ```
8
8
 
9
- Defined in: [packages/play-xstate/src/catalog/validate-props.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-xstate/src/catalog/validate-props.ts#L5)
9
+ Defined in: [packages/play-xstate/src/catalog/validate-props.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/catalog/validate-props.ts#L5)
10
10
 
11
11
  ## Indexable
12
12
 
@@ -22,7 +22,7 @@ Defined in: [packages/play-xstate/src/catalog/validate-props.ts:5](https://gitla
22
22
  optional queryParams?: Record<string, unknown>;
23
23
  ```
24
24
 
25
- Defined in: [packages/play-xstate/src/catalog/validate-props.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-xstate/src/catalog/validate-props.ts#L7)
25
+ Defined in: [packages/play-xstate/src/catalog/validate-props.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/catalog/validate-props.ts#L7)
26
26
 
27
27
  ---
28
28
 
@@ -32,4 +32,4 @@ Defined in: [packages/play-xstate/src/catalog/validate-props.ts:7](https://gitla
32
32
  optional routeParams?: Record<string, unknown>;
33
33
  ```
34
34
 
35
- Defined in: [packages/play-xstate/src/catalog/validate-props.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-xstate/src/catalog/validate-props.ts#L6)
35
+ Defined in: [packages/play-xstate/src/catalog/validate-props.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/play-xstate/src/catalog/validate-props.ts#L6)
package/api/@xmachines/shared/functions/defineXmVitestConfig.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function defineXmVitestConfig(importMetaUrl, overrides): object;
7
7
  ```
8
8
 
9
- Defined in: [src/index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/shared/src/index.ts#L10)
9
+ Defined in: [src/index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/shared/src/index.ts#L10)
10
10
 
11
11
  Create a Vitest config with XMachines workspace defaults.
12
12
 
@@ -26,4 +26,4 @@ render it under `@xmachines/shared` instead of nested module pages.
26
26
 
27
27
  | Name | Type | Defined in |
28
28
  | ------ | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
29
- | `test` | `any` | [config/vitest.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/shared/config/vitest.ts#L82) |
29
+ | `test` | `any` | [config/vitest.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/shared/config/vitest.ts#L82) |
package/api/@xmachines/shared/functions/xmAliases.md CHANGED
@@ -6,7 +6,7 @@
6
6
  function xmAliases(importMetaUrl): Record<string, string>;
7
7
  ```
8
8
 
9
- Defined in: [src/index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/shared/src/index.ts#L20)
9
+ Defined in: [src/index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/67df663d67f8ff5bb0732ca5b4fee268c5e34b72/packages/shared/src/index.ts#L20)
10
10
 
11
11
  Build Vite/Vitest alias entries for all `@xmachines/*` workspace packages.
12
12
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xmachines/docs",
3
- "version": "1.0.0-beta.13",
3
+ "version": "1.0.0-beta.14",
4
4
  "description": "Documentation for XMachines",
5
5
  "keywords": [
6
6
  "documentation",
@@ -46,7 +46,7 @@
46
46
  "typedoc": "typedoc"
47
47
  },
48
48
  "devDependencies": {
49
- "@xmachines/shared": "1.0.0-beta.13",
49
+ "@xmachines/shared": "1.0.0-beta.14",
50
50
  "typedoc": "^0.28.17",
51
51
  "typedoc-plugin-llms-txt": "^0.1.2",
52
52
  "typedoc-plugin-markdown": "^4.11.0"