@xmachines/docs 3.0.0 → 4.0.0

package/api/@xmachines/play-router/index/interfaces/RouteTree.md

@@ -0,0 +1,27 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteTree
+
+# Interface: RouteTree\<TGraph\>
+
+Defined in: [packages/play-router/src/types.ts:218](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L218)
+
+The complete route tree, with its lookup maps
+
+It gives you the map between a state ID and a URL path, in both directions:
+
+- byStateId: it maps each state ID to its route node, for the target of a play.route event
+- byPath: it maps each URL path to its route node, for the browser navigation
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| -------------- | ------------ |
+| `TGraph`       | `unknown`    |
+
+## Properties
+
+| Property                                    | Type                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | Defined in                                                                                                                               |
+| ------------------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-bypath"></a> `byPath`       | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | The map from a complete path to its route node. It gives you the state ID of a URL path, for the target of a play.route event                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [packages/play-router/src/types.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L230) |
+| <a id="property-bystateid"></a> `byStateId` | `Map`\<`string`, [`RouteNode`](RouteNode.md)\> | The map from a state ID to its route node. It gives you the URL path of a state ID, for the update of the browser URL                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | [packages/play-router/src/types.ts:225](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L225) |
+| <a id="property-graph"></a> `graph?`        | `TGraph`                                       | The graph of the state machine, for an advanced query. `TGraph` carries its type, and this package names none: a route tree is a map from a path to a state, and the graph of a MACHINE belongs to the package that reads a machine. `extractMachineRoutes` of `@xmachines/play-router/xstate` answers `RouteTree<MachineGraph>`, so a consumer of that function loses no type. **Example** `import { getSuccessors, hasPath } from "@statelyai/graph"; // `tree`comes from`extractMachineRoutes`of`@xmachines/play-router/xstate` const successors = getSuccessors(tree.graph!, "myMachine.home");` | [packages/play-router/src/types.ts:246](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L246) |
+| <a id="property-root"></a> `root`           | [`RouteNode`](RouteNode.md)                    | The root node of the routes                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | [packages/play-router/src/types.ts:220](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L220) |

package/api/@xmachines/play-router/{interfaces → index/interfaces}/RouteWatcherHandle.md

@@ -1,8 +1,8 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteWatcherHandle
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteWatcherHandle
 
 # Interface: RouteWatcherHandle
 
-Defined in: [play-router/src/router-bridge-base.ts:79](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/router-bridge-base.ts#L79)
+Defined in: [packages/play-router/src/router-bridge-base.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/router-bridge-base.ts#L80)
 
 The narrow interface of the TC39 Signal watcher. `RouterBridgeBase` uses it to
 observe each change of `actor.currentRoute`.
@@ -24,7 +24,7 @@ it and manages it internally.
 unwatch(): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:83](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/router-bridge-base.ts#L83)
+Defined in: [packages/play-router/src/router-bridge-base.ts:84](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/router-bridge-base.ts#L84)
 
 Stops the observation and frees the watcher.
 
@@ -40,15 +40,15 @@ Stops the observation and frees the watcher.
 watch(signal): void;
 ```
 
-Defined in: [play-router/src/router-bridge-base.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/router-bridge-base.ts#L81)
+Defined in: [packages/play-router/src/router-bridge-base.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/router-bridge-base.ts#L82)
 
 Arms the watcher on the given signal.
 
 #### Parameters
 
-| Parameter | Type                                                                                         |
-| --------- | -------------------------------------------------------------------------------------------- |
-| `signal`  | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> |
+| Parameter | Type                                                                                            |
+| --------- | ----------------------------------------------------------------------------------------------- |
+| `signal`  | [`Computed`](../../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> |
 
 #### Returns
 

package/api/@xmachines/play-router/{interfaces → index/interfaces}/RouterBridge.md

@@ -1,8 +1,8 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouterBridge
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouterBridge
 
 # Interface: RouterBridge
 
-Defined in: [play-router/src/types.ts:359](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L359)
+Defined in: [packages/play-router/src/types.ts:438](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L438)
 
 The RouterBridge interface of a runtime infrastructure adapter
 
@@ -46,7 +46,7 @@ class MyRouterBridge implements RouterBridge {
 
 ## See
 
-[Play RFC](../../../../rfc/play.md) - invariant INV-04
+[Play RFC](../../../../../rfc/play.md) - invariant INV-04
 
 ## Extended by
 
@@ -60,7 +60,7 @@ class MyRouterBridge implements RouterBridge {
 connect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:376](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L376)
+Defined in: [packages/play-router/src/types.ts:455](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L455)
 
 Connects the router bridge to the Actor
 
@@ -90,7 +90,7 @@ await bridge.connect();
 disconnect(): void | Promise<void>;
 ```
 
-Defined in: [play-router/src/types.ts:392](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L392)
+Defined in: [packages/play-router/src/types.ts:471](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L471)
 
 Disconnects the router bridge from the Actor
 

package/api/@xmachines/play-router/{interfaces → index/interfaces}/RouterConnection.md

@@ -1,8 +1,8 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouterConnection
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouterConnection
 
 # Interface: RouterConnection()
 
-Defined in: [play-router/src/provider-lifecycle.ts:265](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L265)
+Defined in: [packages/play-router/src/provider-lifecycle.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L275)
 
 What `connectRouter` of an adapter returns.
 
@@ -21,7 +21,7 @@ stale.
 RouterConnection(): void;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:267](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L267)
+Defined in: [packages/play-router/src/provider-lifecycle.ts:277](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L277)
 
 Stops the synchronization. The same call as [RouterConnection.disconnect](#disconnect).
 
@@ -31,10 +31,10 @@ Stops the synchronization. The same call as [RouterConnection.disconnect](#disco
 
 ## Properties
 
-| Property                                              | Modifier   | Type                                         | Description                                                                       | Defined in                                                                                                                                                |
-| ----------------------------------------------------- | ---------- | -------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <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:288](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L288) |
-| <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:290](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L290) |
+| Property                                              | Modifier   | Type                                         | Description                                                                       | Defined in                                                                                                                                                         |
+| ----------------------------------------------------- | ---------- | -------------------------------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| <a id="property-basepath"></a> `basePath`             | `readonly` | `string`                                     | The resolved prefix of the mount, or `""` when the machine owns the whole router. | [packages/play-router/src/provider-lifecycle.ts:298](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L298) |
+| <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.        | [packages/play-router/src/provider-lifecycle.ts:300](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L300) |
 
 ## Methods
 
@@ -44,7 +44,7 @@ Stops the synchronization. The same call as [RouterConnection.disconnect](#disco
 dispose: void;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:286](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L286)
+Defined in: [packages/play-router/src/provider-lifecycle.ts:296](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L296)
 
 Stops the synchronization when the scope of a `using` declaration ends.
 
@@ -73,7 +73,7 @@ The release is [RouterConnection.disconnect](#disconnect), which is idempotent.
 disconnect(): void;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:269](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L269)
+Defined in: [packages/play-router/src/provider-lifecycle.ts:279](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L279)
 
 Stops the synchronization.
 
@@ -89,7 +89,7 @@ Stops the synchronization.
 setBasePath(basePath?, basePathParams?): void;
 ```
 
-Defined in: [play-router/src/provider-lifecycle.ts:292](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L292)
+Defined in: [packages/play-router/src/provider-lifecycle.ts:302](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L302)
 
 Moves the mount of the live bridge, with no teardown.
 

package/api/@xmachines/play-router/{interfaces → index/interfaces}/WindowLike.md

@@ -1,8 +1,8 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / WindowLike
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / WindowLike
 
 # Interface: WindowLike
 
-Defined in: [play-router/src/types.ts:460](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L460)
+Defined in: [packages/play-router/src/types.ts:539](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L539)
 
 The minimal window interface of an adapter that subscribes to a DOM event, for
 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 });
 addEventListener(type, listener): void;
 ```
 
-Defined in: [play-router/src/types.ts:461](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L461)
+Defined in: [packages/play-router/src/types.ts:540](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L540)
 
 #### Parameters
 
@@ -51,7 +51,7 @@ Defined in: [play-router/src/types.ts:461](https://gitlab.com/xmachin-es/xmachin
 removeEventListener(type, listener): void;
 ```
 
-Defined in: [play-router/src/types.ts:462](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L462)
+Defined in: [packages/play-router/src/types.ts:541](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L541)
 
 #### Parameters
 

package/api/@xmachines/play-router/index/type-aliases/PlayRouterBridgeConstructor.md

@@ -0,0 +1,46 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / PlayRouterBridgeConstructor
+
+# Type Alias: PlayRouterBridgeConstructor\<TRouter, TActor\>
+
+```ts
+type PlayRouterBridgeConstructor<TRouter, TActor> = (
+	router,
+	actor,
+	routeMap,
+	options?,
+) => RouterBridge;
+```
+
+Defined in: [packages/play-router/src/provider-lifecycle.ts:107](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/provider-lifecycle.ts#L107)
+
+The constructor shape that a bridge class must satisfy for a provider factory: `(router, actor, routeMap, options?) → RouterBridge`.
+
+`TActor` carries the actor type of the caller through to the constructor, so the spec
+type of that actor reaches the bridge whole. A bridge that reads no spec binds nothing
+and receives the default.
+
+The return type is `RouterBridge`, the published contract of a bridge, so a
+consumer bridge of its own keeps compiling. Every bridge on `RouterBridgeBase` also
+satisfies `MountableRouterBridge`, and the provider finds that mount API at run
+time: a bridge without it ignores `basePath`, exactly as it did before the option
+existed.
+
+## Type Parameters
+
+| Type Parameter                                                       | Default type                                      |
+| -------------------------------------------------------------------- | ------------------------------------------------- |
+| `TRouter`                                                            | -                                                 |
+| `TActor` _extends_ [`RoutableActor`](../interfaces/RoutableActor.md) | [`RoutableActor`](../interfaces/RoutableActor.md) |
+
+## Parameters
+
+| Parameter  | Type                                                  |
+| ---------- | ----------------------------------------------------- |
+| `router`   | `TRouter`                                             |
+| `actor`    | `TActor`                                              |
+| `routeMap` | [`RouteMap`](../classes/RouteMap.md)                  |
+| `options?` | [`BasePathOptions`](../interfaces/BasePathOptions.md) |
+
+## Returns
+
+[`RouterBridge`](../interfaces/RouterBridge.md)

package/api/@xmachines/play-router/index/type-aliases/RouteData.md

@@ -0,0 +1,12 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteData
+
+# Type Alias: RouteData
+
+```ts
+type RouteData = Record<string, unknown>;
+```
+
+Defined in: [packages/play-router/src/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L15)
+
+The resolved extra data of a route. It reaches the consumer on the `data` field of a
+`play.route` event.

package/api/@xmachines/play-router/index/type-aliases/RouteDataResolver.md

@@ -0,0 +1,31 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteDataResolver
+
+# Type Alias: RouteDataResolver
+
+```ts
+type RouteDataResolver = (args) => RouteData;
+```
+
+Defined in: [packages/play-router/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L28)
+
+The function form of [RouteObject.data](../interfaces/RouteObject.md#property-data).
+
+The signature mirrors `WithDynamicParams` of XState: the resolver reads the context
+of the machine and the event that asks for the route, and it returns the data.
+
+The resolver reads every field of the event, and `event.data` among them: that field
+carries what the SENDER of the event supplied, and the resolver decides how it
+combines with what the state declares. The `data` that the resolver RETURNS goes to
+`context.data`, and it does not go back onto the event.
+
+## Parameters
+
+| Parameter      | Type                                                                                      |
+| -------------- | ----------------------------------------------------------------------------------------- |
+| `args`         | \{ `context`: `unknown`; `event`: [`PlayRouteEvent`](../interfaces/PlayRouteEvent.md); \} |
+| `args.context` | `unknown`                                                                                 |
+| `args.event`   | [`PlayRouteEvent`](../interfaces/PlayRouteEvent.md)                                       |
+
+## Returns
+
+[`RouteData`](RouteData.md)

package/api/@xmachines/play-router/index/type-aliases/RouteMetadata.md

@@ -0,0 +1,11 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / RouteMetadata
+
+# Type Alias: RouteMetadata
+
+```ts
+type RouteMetadata = string | RouteObject;
+```
+
+Defined in: [packages/play-router/src/types.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/types.ts#L151)
+
+The route metadata of the `meta.route` field of a state machine.

package/api/@xmachines/{play-xstate → play-router/index}/variables/DISPOSE.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / DISPOSE
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / DISPOSE
 
 # Variable: DISPOSE
 
@@ -6,7 +6,7 @@
 const DISPOSE: DisposeKey;
 ```
 
-Defined in: [packages/play/src/disposable.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play/src/disposable.ts#L94)
+Defined in: [packages/play/src/disposable.ts:94](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play/src/disposable.ts#L94)
 
 The key that a release is stored under.
 
@@ -25,7 +25,7 @@ The type assertion states what the fallback IS. `Symbol.for` returns a plain `sy
 TypeScript declares `Symbol.dispose` as a `unique symbol`, and no expression produces
 a `unique symbol` other than the declaration itself.
 
-This binding resolves ONE time, when the module evaluates. [asCleanup](../../play/functions/asCleanup.md) therefore
+This binding resolves ONE time, when the module evaluates. [asCleanup](../../../play/index/functions/asCleanup.md) therefore
 reads `Symbol.dispose` again at each call and stores the release under both keys, so a
 polyfill that installs the well-known symbol after this module evaluates still finds
 the release. A class or an object literal that writes `[DISPOSE]()` has no such second

package/api/@xmachines/play-router/index/variables/NO_BASE_PATH.md

@@ -0,0 +1,18 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / NO\_BASE\_PATH
+
+# Variable: NO\_BASE\_PATH
+
+```ts
+const NO_BASE_PATH: ResolvedBasePath;
+```
+
+Defined in: [packages/play-url/src/base-path.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-url/src/base-path.ts#L102)
+
+The base path of a bridge that has no `basePath` option.
+
+The object is FROZEN, and both levels of it: [resolveBasePath](../functions/resolveBasePath.md) returns this
+exact instance for every bridge with no mount, and
+`RouterBridgeBase.basePathParams` hands its `params` to the caller.
+`Readonly<Record<string, string>>` is gone at run time, so without the freeze one
+write in consumer code would leak that key into every other unmounted bridge in
+the process.

package/api/@xmachines/play-router/index/variables/ROOT_NODE_ID.md

@@ -0,0 +1,18 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [index](../README.md) / ROOT\_NODE\_ID
+
+# Variable: ROOT\_NODE\_ID
+
+```ts
+const ROOT_NODE_ID: "__root__" = "__root__";
+```
+
+Defined in: [packages/play-router/src/build-tree.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/build-tree.ts#L14)
+
+The ID and the state ID of the synthetic root node of every `RouteTree`.
+
+`buildRouteTree` always makes this node, and no state of a machine declares it. It
+gives the tree one parent for each absolute route, and it holds `routable: false`.
+
+A consumer that walks a tree must SKIP this node. `createRouteMapFromTree` skips it,
+and `getRoutableRoutes` of `@xmachines/play-router/xstate` skips it. A walk that keeps
+it maps the path `/` to a state that the machine does not hold.

package/api/@xmachines/play-router/xstate/README.md

@@ -0,0 +1,53 @@
+[API](../../../README.md) / [@xmachines/play-router](../README.md) / xstate
+
+# xstate
+
+`@xmachines/play-router/xstate` - the routes of an XState machine
+
+A route of XMachines is a fact about a STATE. This entry point reads that fact out of an
+XState v5 machine: it walks the machine, collects each `meta.route`, builds the route
+tree, and answers the questions that the tree can be asked — which routes are reachable,
+which are navigable from a state, and which path maps to which state id.
+
+The MAIN entry point holds what happens AFTERWARDS: the route map, the match of a
+location, the bridge, and the provider lifecycle. It names no machine, and it reads this
+module never. `xstate` is therefore an OPTIONAL peer of this package, and a bundler drops
+`@statelyai/graph` for a consumer that imports this entry point nowhere.
+
+This is the same shape as `@xmachines/play-xstate/routing` and
+`@xmachines/play-xstate/view`: an optional capability behind its own entry point, with
+its own dependency.
+
+## Example
+
+```typescript
+import { createRouteMap } from "@xmachines/play-router/xstate";
+import { connectRouter } from "@xmachines/play-dom-router";
+
+const routeMap = createRouteMap(myMachine);
+```
+
+## See
+
+[Routing guide](../../../../guides/routing.md)
+
+## Interfaces
+
+- [MachineEdgeData](interfaces/MachineEdgeData.md)
+- [MachineNodeData](interfaces/MachineNodeData.md)
+
+## Type Aliases
+
+- [MachineGraph](type-aliases/MachineGraph.md)
+
+## Functions
+
+- [createRouteMap](functions/createRouteMap.md)
+- [extractMachineRoutes](functions/extractMachineRoutes.md)
+- [getNavigableRoutes](functions/getNavigableRoutes.md)
+- [getRoutableRoutes](functions/getRoutableRoutes.md)
+- [getRouteMappings](functions/getRouteMappings.md)
+- [getTransitionReachableRoutes](functions/getTransitionReachableRoutes.md)
+- [isRouteReachable](functions/isRouteReachable.md)
+- [machineToGraph](functions/machineToGraph.md)
+- [routeExists](functions/routeExists.md)

package/api/@xmachines/play-router/{functions → xstate/functions}/createRouteMap.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / createRouteMap
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [xstate](../README.md) / createRouteMap
 
 # Function: createRouteMap()
 
@@ -6,12 +6,14 @@
 function createRouteMap(machine, options?): RouteMap;
 ```
 
-Defined in: [play-router/src/create-route-map.ts:47](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/create-route-map.ts#L47)
+Defined in: [packages/play-router/src/xstate/create-route-map.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/xstate/create-route-map.ts#L32)
 
 Creates a `RouteMap` from an XState state machine.
 
 The function reads every state with a route, which means each state with a
-`meta.route` field. It then builds the lookup structure between a path and a
+`meta.route` field. It keeps the routable states alone, and it drops the synthetic
+root of the tree. `createRouteMapFromTree` of the main entry point drops the same
+node, and the two functions therefore answer the same map for the same machine. It then builds the lookup structure between a path and a
 stateId, for both directions. A subclass of `RouterBridgeBase` uses the map: it
 converts each change of the browser URL into a `play.route` actor event, and each
 actor route into a URL.
@@ -21,18 +23,18 @@ actor route into a URL.
 | Parameter  | Type                                                                      | Description                                                                                                                     |
 | ---------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
 | `machine`  | [`AnyStateMachine`](https://www.jsdocs.io/package/xstate#AnyStateMachine) | The XState v5 state machine, with a `meta.route` annotation on each state with a route.                                         |
-| `options?` | [`RouteMapOptions`](../interfaces/RouteMapOptions.md)                     | The optional configuration. Give `{ cacheSize }` to change the default size of the LRU cache of the parameterized path lookups. |
+| `options?` | [`RouteMapOptions`](../../index/interfaces/RouteMapOptions.md)            | The optional configuration. Give `{ cacheSize }` to change the default size of the LRU cache of the parameterized path lookups. |
 
 ## Returns
 
-[`RouteMap`](../classes/RouteMap.md)
+[`RouteMap`](../../index/classes/RouteMap.md)
 
 A `RouteMap` for each adapter on `RouterBridgeBase`.
 
 ## Example
 
 ```typescript
-import { createRouteMap } from "@xmachines/play-router";
+import { createRouteMap } from "@xmachines/play-router/xstate";
 import { connectRouter } from "@xmachines/play-dom-router";
 
 const routeMap = createRouteMap(myMachine);

package/api/@xmachines/play-router/{functions → xstate/functions}/extractMachineRoutes.md

@@ -1,12 +1,12 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / extractMachineRoutes
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [xstate](../README.md) / extractMachineRoutes
 
 # Function: extractMachineRoutes()
 
 ```ts
-function extractMachineRoutes(machine): RouteTree;
+function extractMachineRoutes(machine): RouteTree<MachineGraph>;
 ```
 
-Defined in: [play-router/src/extract-routes.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/extract-routes.ts#L92)
+Defined in: [packages/play-router/src/xstate/extract-routes.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/xstate/extract-routes.ts#L98)
 
 Reads the complete route tree from the graph of a state machine
 
@@ -24,6 +24,6 @@ needs the transitions.
 
 ## Returns
 
-[`RouteTree`](../interfaces/RouteTree.md)
+[`RouteTree`](../../index/interfaces/RouteTree.md)\<[`MachineGraph`](../type-aliases/MachineGraph.md)\>
 
 The route tree, with its root, its byStateId map, its byPath map, and its graph

package/api/@xmachines/play-router/xstate/functions/getNavigableRoutes.md

@@ -0,0 +1,35 @@
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [xstate](../README.md) / getNavigableRoutes
+
+# Function: getNavigableRoutes()
+
+```ts
+function getNavigableRoutes(tree, stateId): RouteNode[];
+```
+
+Defined in: [packages/play-router/src/xstate/query.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/xstate/query.ts#L56)
+
+Returns every route of a navigation from the given state
+
+The function returns the child routes of the state. A later version also returns
+the sibling routes of a transition.
+
+## Parameters
+
+| Parameter | Type                                                                                                    | Description                                 |
+| --------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
+| `tree`    | [`RouteTree`](../../index/interfaces/RouteTree.md)\<[`MachineGraph`](../type-aliases/MachineGraph.md)\> | The route tree, from extractMachineRoutes() |
+| `stateId` | `string`                                                                                                | The ID of the current state                 |
+
+## Returns
+
+[`RouteNode`](../../index/interfaces/RouteNode.md)[]
+
+The array of the route nodes that the state can reach
+
+## Example
+
+```typescript
+const tree = extractMachineRoutes(machine);
+const routes = getNavigableRoutes(tree, "dashboard");
+// [{ id: 'overview', path: '/overview', ... }, { id: 'settings', ... }]
+```

package/api/@xmachines/play-router/{functions → xstate/functions}/getRoutableRoutes.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / getRoutableRoutes
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [xstate](../README.md) / getRoutableRoutes
 
 # Function: getRoutableRoutes()
 
@@ -6,7 +6,7 @@
 function getRoutableRoutes(tree): RouteNode[];
 ```
 
-Defined in: [play-router/src/query.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/query.ts#L113)
+Defined in: [packages/play-router/src/xstate/query.ts:121](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/xstate/query.ts#L121)
 
 Returns every route of the tree that has a route, in one flat array
 
@@ -16,13 +16,13 @@ configuration in a framework adapter dynamically.
 
 ## Parameters
 
-| Parameter | Type                                      | Description                                 |
-| --------- | ----------------------------------------- | ------------------------------------------- |
-| `tree`    | [`RouteTree`](../interfaces/RouteTree.md) | The route tree, from extractMachineRoutes() |
+| Parameter | Type                                               | Description                                 |
+| --------- | -------------------------------------------------- | ------------------------------------------- |
+| `tree`    | [`RouteTree`](../../index/interfaces/RouteTree.md) | The route tree, from extractMachineRoutes() |
 
 ## Returns
 
-[`RouteNode`](../interfaces/RouteNode.md)[]
+[`RouteNode`](../../index/interfaces/RouteNode.md)[]
 
 The array of the route nodes with a route, with their path and their stateId
 

package/api/@xmachines/play-router/{functions → xstate/functions}/getRouteMappings.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / getRouteMappings
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [xstate](../README.md) / getRouteMappings
 
 # Function: getRouteMappings()
 
@@ -6,7 +6,7 @@
 function getRouteMappings(tree, options?): RouteMapping[];
 ```
 
-Defined in: [play-router/src/query.ts:250](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/query.ts#L250)
+Defined in: [packages/play-router/src/xstate/query.ts:258](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/xstate/query.ts#L258)
 
 Returns the `{ stateId, path }` entries that a host router needs, so that it can
 register the routes of a machine under a base path, and remove them again later.
@@ -30,14 +30,14 @@ those are the params that the route of the host must match.
 
 ## Parameters
 
-| Parameter  | Type                                                  | Description                                                                                                                                                                                                                                                                                              |
-| ---------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `tree`     | [`RouteTree`](../interfaces/RouteTree.md)             | The route tree of extractMachineRoutes()                                                                                                                                                                                                                                                                 |
-| `options?` | [`BasePathOptions`](../interfaces/BasePathOptions.md) | The optional `{ basePath, basePathParams }`, the same option as the bridge takes. Each `stateId` comes from the route tree, so it carries NO `#` prefix. A host that keys its route table on the target of a `play.route` event adds the `#` itself, because the event always carries the prefixed form. |
+| Parameter  | Type                                                           | Description                                                                                                                                                                                                                                                                                              |
+| ---------- | -------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `tree`     | [`RouteTree`](../../index/interfaces/RouteTree.md)             | The route tree of extractMachineRoutes()                                                                                                                                                                                                                                                                 |
+| `options?` | [`BasePathOptions`](../../index/interfaces/BasePathOptions.md) | The optional `{ basePath, basePathParams }`, the same option as the bridge takes. Each `stateId` comes from the route tree, so it carries NO `#` prefix. A host that keys its route table on the target of a `play.route` event adds the `#` itself, because the event always carries the prefixed form. |
 
 ## Returns
 
-[`RouteMapping`](../interfaces/RouteMapping.md)[]
+[`RouteMapping`](../../index/interfaces/RouteMapping.md)[]
 
 One entry for each state with a route, in the order of the route tree.
 

package/api/@xmachines/play-router/{functions → xstate/functions}/getTransitionReachableRoutes.md

@@ -1,4 +1,4 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / getTransitionReachableRoutes
+[API](../../../../README.md) / [@xmachines/play-router](../../README.md) / [xstate](../README.md) / getTransitionReachableRoutes
 
 # Function: getTransitionReachableRoutes()
 
@@ -6,7 +6,7 @@
 function getTransitionReachableRoutes(graph, stateId): string[];
 ```
 
-Defined in: [play-router/src/query.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/query.ts#L165)
+Defined in: [packages/play-router/src/xstate/query.ts:173](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v4.0.0/packages/play-router/src/xstate/query.ts#L173)
 
 Returns the routes that a transition from the current state can reach