@xmachines/docs 1.0.0-beta.11 → 1.0.0-beta.13
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.
- package/api/@xmachines/play/type-aliases/PlayEvent.md +2 -2
- package/api/@xmachines/play-actor/classes/AbstractActor.md +3 -3
- package/api/@xmachines/play-actor/interfaces/Routable.md +2 -2
- package/api/@xmachines/play-actor/interfaces/ViewMetadata.md +3 -3
- package/api/@xmachines/play-actor/interfaces/Viewable.md +10 -3
- package/api/@xmachines/play-catalog/functions/defineCatalog.md +1 -1
- package/api/@xmachines/play-catalog/functions/defineComponents.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/Catalog.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/ComponentsFor.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/InferComponentProps.md +1 -1
- package/api/@xmachines/play-catalog/type-aliases/NoExtraKeys.md +1 -1
- package/api/@xmachines/play-react/classes/PlayErrorBoundary.md +5 -5
- package/api/@xmachines/play-react/functions/useSignalEffect.md +1 -1
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryProps.md +4 -4
- package/api/@xmachines/play-react/interfaces/PlayErrorBoundaryState.md +3 -3
- package/api/@xmachines/play-react/interfaces/PlayRendererProps.md +4 -4
- package/api/@xmachines/play-react/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-react-router/classes/ReactRouterBridge.md +6 -6
- package/api/@xmachines/play-react-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-react-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-react-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-react-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-react-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-react-router-demo/README.md +30 -20
- package/api/@xmachines/play-router/classes/BaseRouteMap.md +4 -4
- package/api/@xmachines/play-router/classes/RouterBridgeBase.md +21 -21
- package/api/@xmachines/play-router/functions/buildRouteTree.md +1 -1
- package/api/@xmachines/play-router/functions/connectRouter.md +1 -1
- package/api/@xmachines/play-router/functions/crawlMachine.md +1 -1
- package/api/@xmachines/play-router/functions/createBrowserHistory.md +1 -1
- package/api/@xmachines/play-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-router/functions/createRouter.md +1 -1
- package/api/@xmachines/play-router/functions/detectDuplicateRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/extractMachineRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/extractRoute.md +1 -1
- package/api/@xmachines/play-router/functions/findRouteById.md +1 -1
- package/api/@xmachines/play-router/functions/findRouteByPath.md +1 -1
- package/api/@xmachines/play-router/functions/getNavigableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/getRoutableRoutes.md +1 -1
- package/api/@xmachines/play-router/functions/routeExists.md +1 -1
- package/api/@xmachines/play-router/functions/validateRouteFormat.md +1 -1
- package/api/@xmachines/play-router/functions/validateStateExists.md +1 -1
- package/api/@xmachines/play-router/interfaces/BaseRouteMapping.md +3 -3
- package/api/@xmachines/play-router/interfaces/BrowserHistory.md +14 -14
- package/api/@xmachines/play-router/interfaces/BrowserWindow.md +14 -14
- package/api/@xmachines/play-router/interfaces/ConnectRouterOptions.md +4 -4
- package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md +6 -6
- package/api/@xmachines/play-router/interfaces/RouteInfo.md +8 -8
- package/api/@xmachines/play-router/interfaces/RouteMap.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouteNode.md +10 -10
- package/api/@xmachines/play-router/interfaces/RouteObject.md +2 -2
- package/api/@xmachines/play-router/interfaces/RouteTree.md +4 -4
- package/api/@xmachines/play-router/interfaces/RouterBridge.md +3 -3
- package/api/@xmachines/play-router/interfaces/StateVisit.md +4 -4
- package/api/@xmachines/play-router/interfaces/VanillaRouter.md +4 -4
- package/api/@xmachines/play-router/type-aliases/RouteMetadata.md +1 -1
- package/api/@xmachines/play-signals/interfaces/ComputedOptions.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalComputed.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalOptions.md +2 -2
- package/api/@xmachines/play-signals/interfaces/SignalState.md +3 -3
- package/api/@xmachines/play-signals/interfaces/SignalWatcher.md +4 -4
- package/api/@xmachines/play-signals/type-aliases/WatcherNotify.md +1 -1
- package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md +4 -4
- package/api/@xmachines/play-solid/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-solid-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-solid-router/classes/SolidRouterBridge.md +7 -7
- package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-solid-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-solid-router/interfaces/AbstractActor.md +3 -3
- package/api/@xmachines/play-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-solid-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-solid-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-solid-router/type-aliases/SolidRouterHooks.md +4 -4
- package/api/@xmachines/play-tanstack-react-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/classes/TanStackReactRouterBridge.md +6 -6
- package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/createRouteMapFromTree.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/interfaces/RouteNavigateEvent.md +3 -3
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-react-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-tanstack-react-router-demo/README.md +15 -5
- package/api/@xmachines/play-tanstack-solid-router/classes/RouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/classes/SolidRouterBridge.md +7 -7
- package/api/@xmachines/play-tanstack-solid-router/functions/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/interfaces/PlayRouterProviderProps.md +5 -5
- package/api/@xmachines/play-tanstack-solid-router/interfaces/RouteMapping.md +3 -3
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterInstance.md +1 -1
- package/api/@xmachines/play-tanstack-solid-router/type-aliases/TanStackRouterLike.md +4 -4
- package/api/@xmachines/play-vue/interfaces/PlayRendererProps.md +3 -3
- package/api/@xmachines/play-vue/variables/PlayRenderer.md +1 -1
- package/api/@xmachines/play-vue-router/classes/RouteMap.md +5 -5
- package/api/@xmachines/play-vue-router/classes/VueBaseRouteMap.md +5 -5
- package/api/@xmachines/play-vue-router/classes/VueRouterBridge.md +8 -8
- package/api/@xmachines/play-vue-router/functions/createRouteMap.md +1 -1
- package/api/@xmachines/play-vue-router/interfaces/RouteMapping.md +4 -4
- package/api/@xmachines/play-vue-router/type-aliases/RoutableActor.md +1 -1
- package/api/@xmachines/play-vue-router/variables/PlayRouterProvider.md +1 -1
- package/api/@xmachines/play-xstate/classes/PlayerActor.md +11 -11
- package/api/@xmachines/play-xstate/functions/buildRouteUrl.md +1 -1
- package/api/@xmachines/play-xstate/functions/composeGuards.md +1 -1
- package/api/@xmachines/play-xstate/functions/composeGuardsOr.md +1 -1
- package/api/@xmachines/play-xstate/functions/definePlayer.md +1 -1
- package/api/@xmachines/play-xstate/functions/deriveRoute.md +1 -1
- package/api/@xmachines/play-xstate/functions/eventMatches.md +1 -1
- package/api/@xmachines/play-xstate/functions/formatPlayRouteTransitions.md +1 -1
- package/api/@xmachines/play-xstate/functions/hasContext.md +1 -1
- package/api/@xmachines/play-xstate/functions/isAbsoluteRoute.md +1 -1
- package/api/@xmachines/play-xstate/functions/mergeViewProps.md +1 -1
- package/api/@xmachines/play-xstate/functions/negateGuard.md +1 -1
- package/api/@xmachines/play-xstate/functions/stateMatches.md +1 -1
- package/api/@xmachines/play-xstate/functions/validateComponentBinding.md +1 -1
- package/api/@xmachines/play-xstate/functions/validateViewProps.md +2 -2
- package/api/@xmachines/play-xstate/interfaces/CatalogEntry.md +3 -3
- package/api/@xmachines/play-xstate/interfaces/PlayerConfig.md +4 -4
- package/api/@xmachines/play-xstate/interfaces/PlayerOptions.md +7 -7
- package/api/@xmachines/play-xstate/interfaces/RouteContext.md +5 -5
- package/api/@xmachines/play-xstate/type-aliases/Catalog.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/ComposedGuard.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/Guard.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/GuardArray.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/RouteMachineConfig.md +4 -4
- package/api/@xmachines/play-xstate/type-aliases/RouteStateNode.md +4 -4
- package/api/@xmachines/play-xstate/type-aliases/ValidationResult.md +1 -1
- package/api/@xmachines/play-xstate/type-aliases/ViewMergeContext.md +3 -3
- package/api/@xmachines/shared/functions/defineXmVitestConfig.md +2 -2
- package/api/@xmachines/shared/functions/xmAliases.md +1 -1
- package/api/README.md +29 -1
- package/api/llms.txt +66 -23
- package/examples/README.md +3 -3
- package/examples/multi-router-integration.md +6 -6
- package/examples/routing-patterns.md +2 -2
- package/guides/README.md +9 -10
- package/package.json +2 -2
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type RouteMachineConfig = object;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-xstate/src/routing/format-play-route-transitions.ts#L29)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:2
|
|
|
22
22
|
optional context?: unknown;
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
25
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
|
|
26
26
|
|
|
27
27
|
---
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:3
|
|
|
32
32
|
optional on?: Record<string, unknown>;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
35
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-xstate/src/routing/format-play-route-transitions.ts#L32)
|
|
36
36
|
|
|
37
37
|
---
|
|
38
38
|
|
|
@@ -42,4 +42,4 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:3
|
|
|
42
42
|
optional states?: Record<string, unknown>;
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
45
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-xstate/src/routing/format-play-route-transitions.ts#L31)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
type RouteStateNode = object;
|
|
7
7
|
```
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
9
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-xstate/src/routing/format-play-route-transitions.ts#L13)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:1
|
|
|
22
22
|
optional id?: string;
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
25
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-xstate/src/routing/format-play-route-transitions.ts#L14)
|
|
26
26
|
|
|
27
27
|
---
|
|
28
28
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:1
|
|
|
32
32
|
optional meta?: object;
|
|
33
33
|
```
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
35
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-xstate/src/routing/format-play-route-transitions.ts#L15)
|
|
36
36
|
|
|
37
37
|
#### route?
|
|
38
38
|
|
|
@@ -48,4 +48,4 @@ optional route?: string;
|
|
|
48
48
|
optional states?: Record<string, RouteStateNode>;
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
51
|
+
Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-xstate/src/routing/format-play-route-transitions.ts#L18)
|
|
@@ -14,4 +14,4 @@ type ValidationResult =
|
|
|
14
14
|
};
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/play-xstate/src/catalog/validate-props.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/
|
|
17
|
+
Defined in: [packages/play-xstate/src/catalog/validate-props.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/play-xstate/src/catalog/validate-props.ts#L11)
|
|
@@ -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/
|
|
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)
|
|
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/
|
|
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)
|
|
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/
|
|
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)
|
|
@@ -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/
|
|
9
|
+
Defined in: [src/index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/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/
|
|
29
|
+
| `test` | `any` | [config/vitest.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/shared/config/vitest.ts#L82) |
|
|
@@ -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/
|
|
9
|
+
Defined in: [src/index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/dc729bb39810dbc25648ddd9203782369c467996/packages/shared/src/index.ts#L20)
|
|
10
10
|
|
|
11
11
|
Build Vite/Vitest alias entries for all `@xmachines/*` workspace packages.
|
|
12
12
|
|
package/api/README.md
CHANGED
|
@@ -1,4 +1,32 @@
|
|
|
1
|
-
#
|
|
1
|
+
# XMachines API Reference
|
|
2
|
+
|
|
3
|
+
Generated API documentation for the XMachines JavaScript/TypeScript packages.
|
|
4
|
+
|
|
5
|
+
## Start Here
|
|
6
|
+
|
|
7
|
+
- For actor contracts, start with [@xmachines/play-actor](@xmachines/play-actor/README.md).
|
|
8
|
+
- For player creation from XState machines, start with [@xmachines/play-xstate](@xmachines/play-xstate/README.md).
|
|
9
|
+
- For route extraction and shared URL synchronization logic, start with [@xmachines/play-router](@xmachines/play-router/README.md).
|
|
10
|
+
- For rendering, choose one of [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), or [@xmachines/play-vue](@xmachines/play-vue/README.md).
|
|
11
|
+
- For framework router integration, choose the matching adapter package such as [@xmachines/play-react-router](@xmachines/play-react-router/README.md) or [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md).
|
|
12
|
+
|
|
13
|
+
## Key Concepts
|
|
14
|
+
|
|
15
|
+
- [Viewable](@xmachines/play-actor/interfaces/Viewable.md) actors expose `currentView` and a component catalog for renderer packages.
|
|
16
|
+
- [Routable](@xmachines/play-actor/interfaces/Routable.md) actors expose `currentRoute` and route-oriented events for router adapters.
|
|
17
|
+
- Router adapters are passive infrastructure: they synchronize URLs with actor state but do not own business rules.
|
|
18
|
+
|
|
19
|
+
## Package Roles
|
|
20
|
+
|
|
21
|
+
- `Core runtime`: [@xmachines/play](@xmachines/play/README.md), [@xmachines/play-actor](@xmachines/play-actor/README.md), [@xmachines/play-catalog](@xmachines/play-catalog/README.md), [@xmachines/play-signals](@xmachines/play-signals/README.md), [@xmachines/play-router](@xmachines/play-router/README.md), and [@xmachines/play-xstate](@xmachines/play-xstate/README.md)
|
|
22
|
+
- `Rendering`: [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), and [@xmachines/play-vue](@xmachines/play-vue/README.md)
|
|
23
|
+
- `Router adapters`: [@xmachines/play-react-router](@xmachines/play-react-router/README.md), [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md), [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md), and [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md)
|
|
24
|
+
- `Shared tooling`: [@xmachines/shared](@xmachines/shared/README.md)
|
|
25
|
+
|
|
26
|
+
## Notes
|
|
27
|
+
|
|
28
|
+
- Demo packages are included in the generated package index below, but most implementation questions should start with the core runtime and adapter packages above.
|
|
29
|
+
- A useful reading order is usually: [@xmachines/play-actor](@xmachines/play-actor/README.md) -> [@xmachines/play-xstate](@xmachines/play-xstate/README.md) -> [@xmachines/play-router](@xmachines/play-router/README.md) -> framework renderer/adapter.
|
|
2
30
|
|
|
3
31
|
## Packages
|
|
4
32
|
|
package/api/llms.txt
CHANGED
|
@@ -1,26 +1,69 @@
|
|
|
1
|
-
#
|
|
1
|
+
# XMachines JavaScript/TypeScript API Docs
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> Stream-first, deterministic state machine runtime, rendering, and router adapter packages for JavaScript and TypeScript.
|
|
4
|
+
|
|
5
|
+
- Core actor, routing, rendering, and catalog packages
|
|
6
|
+
- Framework adapters for React, Solid, Vue, and router integrations
|
|
7
|
+
- Generated API reference tuned for package discovery and implementation guidance
|
|
8
|
+
|
|
9
|
+
## Start Here
|
|
10
|
+
|
|
11
|
+
- Defining players from machines: start with [@xmachines/play-xstate](@xmachines/play-xstate/README.md).
|
|
12
|
+
- Understanding actor contracts: read [@xmachines/play-actor](@xmachines/play-actor/README.md) for [Viewable](@xmachines/play-actor/interfaces/Viewable.md) and [Routable](@xmachines/play-actor/interfaces/Routable.md).
|
|
13
|
+
- [Viewable](@xmachines/play-actor/interfaces/Viewable.md) is the rendering contract: actors expose `currentView` plus a component catalog so rendering packages can resolve UI without owning application state.
|
|
14
|
+
- [Routable](@xmachines/play-actor/interfaces/Routable.md) is the routing contract: actors expose `currentRoute` plus route-oriented event handling, while adapters translate browser or router changes into actor events.
|
|
15
|
+
- Rendering actor-driven UI: use [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), or [@xmachines/play-vue](@xmachines/play-vue/README.md).
|
|
16
|
+
- Synchronizing URLs with actor state: use [@xmachines/play-router](@xmachines/play-router/README.md) plus a framework-specific router adapter.
|
|
17
|
+
|
|
18
|
+
## Package Roles
|
|
19
|
+
|
|
20
|
+
- `Core runtime`: [@xmachines/play](@xmachines/play/README.md), [@xmachines/play-actor](@xmachines/play-actor/README.md), [@xmachines/play-catalog](@xmachines/play-catalog/README.md), [@xmachines/play-signals](@xmachines/play-signals/README.md), [@xmachines/play-router](@xmachines/play-router/README.md), and [@xmachines/play-xstate](@xmachines/play-xstate/README.md).
|
|
21
|
+
- `Rendering`: [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), and [@xmachines/play-vue](@xmachines/play-vue/README.md).
|
|
22
|
+
- `Router adapters`: [@xmachines/play-react-router](@xmachines/play-react-router/README.md), [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md), [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md), [@xmachines/play-tanstack-solid-router](@xmachines/play-tanstack-solid-router/README.md), and [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md), all built on top of [Routable](@xmachines/play-actor/interfaces/Routable.md) actors and shared route metadata.
|
|
23
|
+
- `Shared tooling`: [@xmachines/shared](@xmachines/shared/README.md) for shared config and workspace-level support files.
|
|
4
24
|
|
|
5
25
|
## API
|
|
6
|
-
- [@xmachines/play](@xmachines/play/README.md):
|
|
7
|
-
- [@xmachines/play-actor](@xmachines/play-actor/README.md):
|
|
8
|
-
- [@xmachines/play-catalog](@xmachines/play-catalog/README.md):
|
|
9
|
-
- [@xmachines/play-
|
|
10
|
-
- [@xmachines/play-
|
|
11
|
-
- [@xmachines/play-
|
|
12
|
-
- [@xmachines/play-
|
|
13
|
-
- [@xmachines/play-
|
|
14
|
-
- [@xmachines/play-
|
|
15
|
-
- [@xmachines/play-
|
|
16
|
-
- [@xmachines/play-
|
|
17
|
-
- [@xmachines/play-solid-router
|
|
18
|
-
- [@xmachines/play-tanstack-
|
|
19
|
-
- [@xmachines/play-
|
|
20
|
-
- [@xmachines/
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
-
|
|
25
|
-
- [@xmachines/play-xstate](@xmachines/play-xstate/README.md)
|
|
26
|
-
- [
|
|
26
|
+
- [@xmachines/play](@xmachines/play/README.md): Core Play types and runtime contracts
|
|
27
|
+
- [@xmachines/play-actor](@xmachines/play-actor/README.md): Abstract actor base class plus Routable and Viewable capabilities
|
|
28
|
+
- [@xmachines/play-catalog](@xmachines/play-catalog/README.md): Catalog schemas and typed component registration
|
|
29
|
+
- [@xmachines/play-signals](@xmachines/play-signals/README.md): Signal primitives used by Play actors and adapters
|
|
30
|
+
- [@xmachines/play-router](@xmachines/play-router/README.md): Route extraction, route maps, and shared routing infrastructure
|
|
31
|
+
- [@xmachines/play-xstate](@xmachines/play-xstate/README.md): XState-backed player and actor integration
|
|
32
|
+
- [@xmachines/play-react](@xmachines/play-react/README.md): React renderer for Viewable actors
|
|
33
|
+
- [@xmachines/play-solid](@xmachines/play-solid/README.md): Solid renderer for Viewable actors
|
|
34
|
+
- [@xmachines/play-vue](@xmachines/play-vue/README.md): Vue renderer for Viewable actors
|
|
35
|
+
- [@xmachines/play-react-router](@xmachines/play-react-router/README.md): React Router bridge and provider for actor-driven navigation
|
|
36
|
+
- [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md): TanStack React Router bridge and provider
|
|
37
|
+
- [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md): Solid Router bridge and provider
|
|
38
|
+
- [@xmachines/play-tanstack-solid-router](@xmachines/play-tanstack-solid-router/README.md): TanStack Solid Router bridge and provider
|
|
39
|
+
- [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md): Vue Router bridge and provider
|
|
40
|
+
- [@xmachines/shared](@xmachines/shared/README.md): Shared TypeScript, oxlint, and formatting configuration
|
|
41
|
+
|
|
42
|
+
## Notes For LLMs
|
|
43
|
+
|
|
44
|
+
- Prefer the core packages before the demo apps; demos are intentionally excluded from this file.
|
|
45
|
+
- For implementation questions, usually read in this order: [@xmachines/play-actor](@xmachines/play-actor/README.md) -> [@xmachines/play-xstate](@xmachines/play-xstate/README.md) -> [@xmachines/play-router](@xmachines/play-router/README.md) -> framework renderer/adapter.
|
|
46
|
+
- [Routable](@xmachines/play-actor/interfaces/Routable.md) is the key abstraction for URL synchronization: router adapters observe and update actor route state but do not own navigation policy.
|
|
47
|
+
- Router adapter packages are passive infrastructure; business logic stays in the actor and machine layers.
|
|
48
|
+
- Rendering packages consume the [Viewable](@xmachines/play-actor/interfaces/Viewable.md) contract and component catalogs rather than owning application state.
|
|
49
|
+
|
|
50
|
+
## Quick Reference
|
|
51
|
+
|
|
52
|
+
```javascript
|
|
53
|
+
import { definePlayer } from '@xmachines/play-xstate';
|
|
54
|
+
import { extractMachineRoutes } from '@xmachines/play-router';
|
|
55
|
+
|
|
56
|
+
// Define a player from a machine and catalog
|
|
57
|
+
const createPlayer = definePlayer({ machine, catalog });
|
|
58
|
+
const actor = createPlayer();
|
|
59
|
+
actor.start();
|
|
60
|
+
|
|
61
|
+
// `Viewable` actors expose renderable view metadata
|
|
62
|
+
const currentView = actor.currentView.get();
|
|
63
|
+
|
|
64
|
+
// `Routable` actors expose route state for adapters to observe
|
|
65
|
+
const currentRoute = actor.currentRoute.get();
|
|
66
|
+
|
|
67
|
+
// Extract route metadata for a framework adapter
|
|
68
|
+
const routeTree = extractMachineRoutes(machine);
|
|
69
|
+
```
|
package/examples/README.md
CHANGED
|
@@ -27,9 +27,9 @@ See complete working implementations demonstrating all architectural invariants:
|
|
|
27
27
|
|
|
28
28
|
Complete working applications demonstrating all 5 architectural invariants:
|
|
29
29
|
|
|
30
|
-
- **[React + TanStack Router Demo](
|
|
31
|
-
- **[Vue Router Demo](
|
|
32
|
-
- **[SolidJS Router Demo](
|
|
30
|
+
- **[React + TanStack Router Demo](../api/@xmachines/play-tanstack-react-router-demo/README.md)** - Canonical reference implementation showing all 5 invariants, comprehensive routing, authentication guards, and browser tests
|
|
31
|
+
- **[Vue Router Demo](../api/@xmachines/play-vue-router-demo/README.md)** - Vue Composition API integration with same auth patterns
|
|
32
|
+
- **[SolidJS Router Demo](../api/@xmachines/play-solid-router-demo/README.md)** - Solid signals integration demonstrating framework independence
|
|
33
33
|
|
|
34
34
|
## Running Examples
|
|
35
35
|
|
|
@@ -265,13 +265,13 @@ All three modes preserve the 5 architectural invariants:
|
|
|
265
265
|
|
|
266
266
|
- **[Routing Patterns](./routing-patterns.md)** - Learn play.route events with parameters
|
|
267
267
|
- **[Integration Example](./src/integration-example.ts)** - Complete authentication flow
|
|
268
|
-
- **[React + TanStack Router Demo](
|
|
269
|
-
- **[Vue Router Demo](
|
|
270
|
-
- **[SolidJS Router Demo](
|
|
268
|
+
- **[React + TanStack Router Demo](../api/@xmachines/play-tanstack-react-router-demo/README.md)** - Production example using TanStack mode
|
|
269
|
+
- **[Vue Router Demo](../api/@xmachines/play-vue-router-demo/README.md)** - Vue Composition API integration
|
|
270
|
+
- **[SolidJS Router Demo](../api/@xmachines/play-solid-router-demo/README.md)** - Solid signals integration
|
|
271
271
|
|
|
272
272
|
## Learn More
|
|
273
273
|
|
|
274
|
-
- [play-tanstack-router README](
|
|
275
|
-
- [play-react README](
|
|
276
|
-
- [play-router README](
|
|
274
|
+
- [play-tanstack-router README](../api/@xmachines/play-tanstack-react-router/README.md) - TanStack integration details
|
|
275
|
+
- [play-react README](../api/@xmachines/play-react/README.md) - React renderer documentation
|
|
276
|
+
- [play-router README](../api/@xmachines/play-router/README.md) - Framework-agnostic routing
|
|
277
277
|
- [RFC Play v1](https://gitlab.com/xmachin-es/rfc/-/blob/main/src/play-v1.md) - Complete specification
|
|
@@ -251,10 +251,10 @@ This demonstrates **Actor Authority (INV-01)** — the state machine controls na
|
|
|
251
251
|
|
|
252
252
|
- **[Multi-Router Integration](./multi-router-integration.md)** - Learn about renderer prop pattern
|
|
253
253
|
- **[Integration Example](./src/integration-example.ts)** - See complete authentication flow with all patterns
|
|
254
|
-
- **[React + TanStack Router Demo](
|
|
254
|
+
- **[React + TanStack Router Demo](../api/@xmachines/play-tanstack-react-router-demo/README.md)** - Production example with all 5 architectural invariants
|
|
255
255
|
|
|
256
256
|
## Learn More
|
|
257
257
|
|
|
258
258
|
- [XState Routes Documentation](https://stately.ai/docs/routes) - Official Stately routing patterns
|
|
259
259
|
- [RFC Play v1](https://gitlab.com/xmachin-es/rfc/-/blob/main/src/play-v1.md) - Complete architectural specification
|
|
260
|
-
- [play-router README](
|
|
260
|
+
- [play-router README](../api/@xmachines/play-router/README.md) - Route extraction and tree building
|
package/guides/README.md
CHANGED
|
@@ -4,25 +4,24 @@ Entry points for current XMachines Play architecture and package documentation.
|
|
|
4
4
|
|
|
5
5
|
## Start Here
|
|
6
6
|
|
|
7
|
-
- [Root README](../../README.md) - Monorepo overview and architecture invariants
|
|
8
7
|
- [Examples Index](../examples/README.md) - Runnable and conceptual usage patterns
|
|
9
8
|
|
|
10
9
|
## Router Adapter Guides
|
|
11
10
|
|
|
12
11
|
Use these READMEs for the current RouterBridge-first integrations:
|
|
13
12
|
|
|
14
|
-
- [@xmachines/play-router](
|
|
15
|
-
- [@xmachines/play-tanstack-react-router](
|
|
16
|
-
- [@xmachines/play-react-router](
|
|
17
|
-
- [@xmachines/play-tanstack-solid-router](
|
|
18
|
-
- [@xmachines/play-solid-router](
|
|
19
|
-
- [@xmachines/play-vue-router](
|
|
13
|
+
- [@xmachines/play-router](../api/@xmachines/play-router/README.md) - Route extraction, route maps, and `RouterBridgeBase`
|
|
14
|
+
- [@xmachines/play-tanstack-react-router](../api/@xmachines/play-tanstack-react-router/README.md) - TanStack React adapter
|
|
15
|
+
- [@xmachines/play-react-router](../api/@xmachines/play-react-router/README.md) - `react-router` v7 data-router adapter
|
|
16
|
+
- [@xmachines/play-tanstack-solid-router](../api/@xmachines/play-tanstack-solid-router/README.md) - TanStack Solid adapter
|
|
17
|
+
- [@xmachines/play-solid-router](../api/@xmachines/play-solid-router/README.md) - SolidJS Router adapter
|
|
18
|
+
- [@xmachines/play-vue-router](../api/@xmachines/play-vue-router/README.md) - Vue Router adapter
|
|
20
19
|
|
|
21
20
|
## Core Runtime Guides
|
|
22
21
|
|
|
23
|
-
- [@xmachines/play-xstate](
|
|
24
|
-
- [@xmachines/play-react](
|
|
25
|
-
- [@xmachines/play-catalog](
|
|
22
|
+
- [@xmachines/play-xstate](../api/@xmachines/play-xstate/README.md) - `definePlayer`, routing transitions, and actor lifecycle
|
|
23
|
+
- [@xmachines/play-react](../api/@xmachines/play-react/README.md) - React rendering from actor-driven view state
|
|
24
|
+
- [@xmachines/play-catalog](../api/@xmachines/play-catalog/README.md) - Catalog and schema contracts
|
|
26
25
|
|
|
27
26
|
## API Reference
|
|
28
27
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@xmachines/docs",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.13",
|
|
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.
|
|
49
|
+
"@xmachines/shared": "1.0.0-beta.13",
|
|
50
50
|
"typedoc": "^0.28.17",
|
|
51
51
|
"typedoc-plugin-llms-txt": "^0.1.2",
|
|
52
52
|
"typedoc-plugin-markdown": "^4.11.0"
|