@xmachines/docs 3.0.0 → 4.0.0

package/api/@xmachines/play-react-router/interfaces/PlayActor.md

@@ -1,70 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-react-router](../README.md) / PlayActor
-
-# Interface: PlayActor
-
-Defined in: [play-router/src/types.ts:313](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L313)
-
-The complete actor shape of the `PlayRouterProvider` component of each framework
-adapter: `play-solid-router`, `play-vue-router`, `play-react-router`, and each
-adapter on the shared framework router bridge bases.
-
-The shape extends `RoutableActor` with `currentView`, because the provider renders
-the current view spec and also keeps the routes in step. It therefore needs both
-capabilities.
-
-- Use `RoutableActor` when you need the routing alone, for example in a
-  `RouterBridgeBase` subclass, or in `connectRouter`.
-- Use `PlayActor` when the component also renders the current view spec, for
-  example for the renderer callback parameter of `PlayRouterProvider`, and in
-  `PlayRenderer`.
-
-Every `AbstractActor` subclass that implements both `Routable` and `Viewable`
-satisfies this interface structurally.
-
-## Example
-
-```typescript
-import type { PlayActor } from "@xmachines/play-router";
-
-function MyRouterProvider({ actor }: { actor: PlayActor }) {
-	// it reads actor.currentRoute for the routing, and actor.currentView for the render
-}
-```
-
-## Extends
-
-- [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md)
-
-## Properties
-
-| Property                                          | Modifier   | Type                                                                                                                                | Description                                                                                                                                                                                                                              | Inherited from                                                                                                                                                 | Defined in                                                                                                                      |
-| ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\>                                        | The TC39 Signal of the current URL path of the actor, or of its state ID.                                                                                                                                                                | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`currentRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-currentroute) | [play-router/src/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L275) |
-| <a id="property-currentview"></a> `currentView`   | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | The TC39 Signal of the current view spec of the actor, or `null` when no view is active.                                                                                                                                                 | -                                                                                                                                                              | [play-router/src/types.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L315) |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                                                                  | The route of the initial state of the machine. The constructor fixes it. A router bridge compares it with the browser URL. It therefore separates a deep link, where the router wins, from a restore of a session, where the actor wins. | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`initialRoute`](../../play-dom-router/interfaces/RoutableActor.md#property-initialroute) | [play-router/src/types.ts:281](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L281) |
-
-## Methods
-
-### send()
-
-```ts
-send(event): void;
-```
-
-Defined in: [play-router/src/types.ts:283](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L283)
-
-Sends a route navigation event to the actor.
-
-#### Parameters
-
-| Parameter | Type                                  |
-| --------- | ------------------------------------- |
-| `event`   | [`PlayRouteEvent`](PlayRouteEvent.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md).[`send`](../../play-dom-router/interfaces/RoutableActor.md#send)

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

@@ -1,35 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / getNavigableRoutes
-
-# Function: getNavigableRoutes()
-
-```ts
-function getNavigableRoutes(tree, stateId): RouteNode[];
-```
-
-Defined in: [play-router/src/query.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/query.ts#L48)
-
-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`](../interfaces/RouteTree.md) | The route tree, from extractMachineRoutes() |
-| `stateId` | `string`                                  | The ID of the current state                 |
-
-## Returns
-
-[`RouteNode`](../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/getPatternParamNames.md

@@ -1,24 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / getPatternParamNames
-
-# Function: getPatternParamNames()
-
-```ts
-function getPatternParamNames(pattern): string[];
-```
-
-Defined in: [play-router/src/framework-params.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/framework-params.ts#L27)
-
-Reads the names of every `:param` of a route pattern of the route map.
-
-## Parameters
-
-| Parameter | Type     | Description                                      |
-| --------- | -------- | ------------------------------------------------ |
-| `pattern` | `string` | A route pattern, for example `/profile/:userId`. |
-
-## Returns
-
-`string`[]
-
-The names, in the order that the pattern declares them. A fresh array, because
-`readPatternParams` caches the one it holds.

package/api/@xmachines/play-router/functions/getRequiredPatternParamNames.md

@@ -1,36 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / getRequiredPatternParamNames
-
-# Function: getRequiredPatternParamNames()
-
-```ts
-function getRequiredPatternParamNames(pattern): string[];
-```
-
-Defined in: [play-router/src/framework-params.ts:85](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/framework-params.ts#L85)
-
-The names of every param the pattern REQUIRES, so `:name?` is left out.
-
-An optional segment that did not match has no value, and a framework reports none.
-That is a complete answer and not a partial one, so a MIXED pattern such as
-`/profile/:userId/:tab?` keeps the parse of the framework when only `:tab` is absent.
-A caller that counted that absence as a gap would fall back to the URLPattern
-extraction, which THROWS on a runtime with no URLPattern — for a route the framework
-had already answered.
-
-A pattern whose params are ALL optional reports nothing at all, which reads the same
-as "the framework matched another route", so [pickOwnParams](pickOwnParams.md) falls back for it.
-[resolveFrameworkParams](resolveFrameworkParams.md) settles that case from the PATH instead, and it needs
-no URLPattern to do it.
-
-## Parameters
-
-| Parameter | Type     | Description                                            |
-| --------- | -------- | ------------------------------------------------------ |
-| `pattern` | `string` | A route pattern, for example `/profile/:userId/:tab?`. |
-
-## Returns
-
-`string`[]
-
-The required names, in the order that the pattern declares them. A fresh
-array, because `readPatternParams` caches the one it holds.

package/api/@xmachines/play-router/functions/routeExists.md

@@ -1,26 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / routeExists
-
-# Function: routeExists()
-
-```ts
-function routeExists(tree, path): boolean;
-```
-
-Defined in: [play-router/src/query.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/query.ts#L135)
-
-Tells you if a route path is in the tree
-
-The function tests if the path has a state with a `meta.route` field.
-
-## Parameters
-
-| Parameter | Type                                      | Description                                                |
-| --------- | ----------------------------------------- | ---------------------------------------------------------- |
-| `tree`    | [`RouteTree`](../interfaces/RouteTree.md) | The route tree, from extractMachineRoutes()                |
-| `path`    | `string`                                  | The complete route path, for example '/dashboard/settings' |
-
-## Returns
-
-`boolean`
-
-true when the tree holds the path. In every other case, false

package/api/@xmachines/play-router/interfaces/BuildPlayRouteEventOptions.md

@@ -1,13 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / BuildPlayRouteEventOptions
-
-# Interface: BuildPlayRouteEventOptions
-
-Defined in: [play-router/src/router-sync.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/router-sync.ts#L17)
-
-## Properties
-
-| Property                                  | Type                                                   | Defined in                                                                                                                                |
-| ----------------------------------------- | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-match"></a> `match`       | (`sanitizedPathname`) => [`RouteMatch`](RouteMatch.md) | [play-router/src/router-sync.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/router-sync.ts#L20) |
-| <a id="property-pathname"></a> `pathname` | `string`                                               | [play-router/src/router-sync.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/router-sync.ts#L18) |
-| <a id="property-search"></a> `search?`    | `string`                                               | [play-router/src/router-sync.ts:19](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/router-sync.ts#L19) |

package/api/@xmachines/play-router/interfaces/MachineEdgeData.md

@@ -1,15 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / MachineEdgeData
-
-# Interface: MachineEdgeData
-
-Defined in: [play-router/src/types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L25)
-
-The data on each edge of the graph that represents the machine.
-It holds the event of the transition and the information of its guard.
-
-## Properties
-
-| Property                                         | Type     | Description                                                                                      | Defined in                                                                                                                    |
-| ------------------------------------------------ | -------- | ------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-eventtype"></a> `eventType`      | `string` | The event type that starts this transition                                                       | [play-router/src/types.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L27) |
-| <a id="property-guardtype"></a> ~~`guardType?`~~ | `string` | The guard as a string, when a guard is present **Deprecated** Will be removed in the next major. | [play-router/src/types.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L33) |

package/api/@xmachines/play-router/interfaces/MachineNodeData.md

@@ -1,17 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / MachineNodeData
-
-# Interface: MachineNodeData
-
-Defined in: [play-router/src/types.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L10)
-
-The data on each node of the graph that represents the machine.
-It holds the state metadata that the route extraction and the queries need.
-
-## Properties
-
-| Property                                | Type                                                                   | Description                                                | Defined in                                                                                                                    |
-| --------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-meta"></a> `meta?`      | `Record`\<`string`, `unknown`\>                                        | The original meta object of the state                      | [play-router/src/types.ts:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L16) |
-| <a id="property-route"></a> `route?`    | `string`                                                               | The route path of meta.route, in its string form           | [play-router/src/types.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L18) |
-| <a id="property-stateid"></a> `stateId` | `string`                                                               | The XState state ID, for example "test.dashboard.overview" | [play-router/src/types.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L12) |
-| <a id="property-type"></a> `type`       | `"atomic"` \| `"compound"` \| `"parallel"` \| `"final"` \| `"history"` | The state type of XState                                   | [play-router/src/types.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L14) |

package/api/@xmachines/play-router/interfaces/PlayActor.md

@@ -1,70 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / PlayActor
-
-# Interface: PlayActor
-
-Defined in: [play-router/src/types.ts:313](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L313)
-
-The complete actor shape of the `PlayRouterProvider` component of each framework
-adapter: `play-solid-router`, `play-vue-router`, `play-react-router`, and each
-adapter on the shared framework router bridge bases.
-
-The shape extends `RoutableActor` with `currentView`, because the provider renders
-the current view spec and also keeps the routes in step. It therefore needs both
-capabilities.
-
-- Use `RoutableActor` when you need the routing alone, for example in a
-  `RouterBridgeBase` subclass, or in `connectRouter`.
-- Use `PlayActor` when the component also renders the current view spec, for
-  example for the renderer callback parameter of `PlayRouterProvider`, and in
-  `PlayRenderer`.
-
-Every `AbstractActor` subclass that implements both `Routable` and `Viewable`
-satisfies this interface structurally.
-
-## Example
-
-```typescript
-import type { PlayActor } from "@xmachines/play-router";
-
-function MyRouterProvider({ actor }: { actor: PlayActor }) {
-	// it reads actor.currentRoute for the routing, and actor.currentView for the render
-}
-```
-
-## Extends
-
-- [`RoutableActor`](RoutableActor.md)
-
-## Properties
-
-| Property                                          | Modifier   | Type                                                                                                                                | Description                                                                                                                                                                                                                              | Inherited from                                                                               | Defined in                                                                                                                      |
-| ------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\>                                        | The TC39 Signal of the current URL path of the actor, or of its state ID.                                                                                                                                                                | [`RoutableActor`](RoutableActor.md).[`currentRoute`](RoutableActor.md#property-currentroute) | [play-router/src/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L275) |
-| <a id="property-currentview"></a> `currentView`   | `readonly` | [`State`](../../play-signals/namespaces/Signal/classes/State.md)\<[`PlaySpec`](../../play-actor/interfaces/PlaySpec.md) \| `null`\> | The TC39 Signal of the current view spec of the actor, or `null` when no view is active.                                                                                                                                                 | -                                                                                            | [play-router/src/types.ts:315](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L315) |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                                                                  | The route of the initial state of the machine. The constructor fixes it. A router bridge compares it with the browser URL. It therefore separates a deep link, where the router wins, from a restore of a session, where the actor wins. | [`RoutableActor`](RoutableActor.md).[`initialRoute`](RoutableActor.md#property-initialroute) | [play-router/src/types.ts:281](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L281) |
-
-## Methods
-
-### send()
-
-```ts
-send(event): void;
-```
-
-Defined in: [play-router/src/types.ts:283](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L283)
-
-Sends a route navigation event to the actor.
-
-#### Parameters
-
-| Parameter | Type                                  |
-| --------- | ------------------------------------- |
-| `event`   | [`PlayRouteEvent`](PlayRouteEvent.md) |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`RoutableActor`](RoutableActor.md).[`send`](RoutableActor.md#send)

package/api/@xmachines/play-router/interfaces/PlayRouteEvent.md

@@ -1,135 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / PlayRouteEvent
-
-# Interface: PlayRouteEvent
-
-Defined in: [play-router/src/types.ts:238](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L238)
-
-The routing event, with its parameters and its query
-
-This is the one routing event of the complete Play architecture. It supports a
-navigation that knows the parameters, for example `/profile/:userId`, for a dynamic
-route segment.
-
-**Architectural context:** the event implements **Passive Infrastructure
-(INV-04)**, because it holds the navigation intent of the user, and the Actor then
-evaluates that intent with its guards. The infrastructure makes a request with a
-`play.route` event, and the Actor decides with a transition of its state machine.
-
-**The flow of a browser navigation:**
-
-1. The browser fires `popstate`
-2. The router adapter resolves the URL to a route target
-3. The adapter sends a `PlayRouteEvent` to the Actor
-4. The Actor checks the transition with the guards of its state machine
-
-## Param
-
-**type**
-
-The discriminator of the event. It is always "play.route"
-
-## Param
-
-**to**
-
-The target state ID, with a # prefix, for example '#home' or '#profile'
-
-## Param
-
-**params**
-
-The route parameters of the path only, from the URL path, for
-example `{ userId: '123' }` of `/profile/123`. The `query` field holds the query
-parameters separately.
-
-## Param
-
-**query**
-
-The query parameters only. They stay separate from the params of the path
-
-## Param
-
-**match**
-
-The complete match result of URLPattern, for the debug work and for
-the observability. It is optional
-
-## Examples
-
-The base event and the routing event together
-
-```typescript
-import type { PlayEvent } from "@xmachines/play";
-import type { PlayRouteEvent } from "@xmachines/play-router";
-
-type AppEvent = PlayEvent | PlayRouteEvent;
-```
-
-A basic navigation to a route
-
-```typescript
-import type { PlayRouteEvent } from "@xmachines/play-router";
-
-const event: PlayRouteEvent = {
-	type: "play.route",
-	to: "#home",
-};
-actor.send(event);
-```
-
-A navigation with route parameters
-
-```typescript
-import type { PlayRouteEvent } from "@xmachines/play-router";
-
-const event: PlayRouteEvent = {
-	type: "play.route",
-	to: "#profile",
-	params: { userId: "123" },
-};
-actor.send(event);
-// It resolves to the route /profile/123
-```
-
-A navigation with query parameters
-
-```typescript
-import type { PlayRouteEvent } from "@xmachines/play-router";
-
-const event: PlayRouteEvent = {
-	type: "play.route",
-	to: "#settings",
-	params: { section: "profile" }, // a route parameter of the path only
-	query: { tab: "security" }, // the query only
-};
-actor.send(event);
-// It resolves to the route /settings/profile?tab=security
-```
-
-## See
-
-[Play RFC](../../../../rfc/play.md)
-
-## Remarks
-
-Use `play.route` when you need a navigation that knows the parameters, with the
-`route: {}` config pattern on the nodes of your state machine. The `match` field
-gives you the complete URLPatternResult, for an advanced use such as a debug or an
-analysis of the pattern.
-
-## Indexable
-
-```ts
-[key: string]: unknown
-```
-
-## Properties
-
-| Property                               | Modifier   | Type                           | Defined in                                                                                                                      |
-| -------------------------------------- | ---------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-match"></a> `match?`   | `readonly` | `unknown`                      | [play-router/src/types.ts:243](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L243) |
-| <a id="property-params"></a> `params?` | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:241](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L241) |
-| <a id="property-query"></a> `query?`   | `readonly` | `Record`\<`string`, `string`\> | [play-router/src/types.ts:242](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L242) |
-| <a id="property-to"></a> `to`          | `readonly` | `string`                       | [play-router/src/types.ts:240](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L240) |
-| <a id="property-type"></a> `type`      | `readonly` | `"play.route"`                 | [play-router/src/types.ts:239](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L239) |

package/api/@xmachines/play-router/interfaces/RoutableActor.md

@@ -1,65 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RoutableActor
-
-# Interface: RoutableActor
-
-Defined in: [play-router/src/types.ts:273](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L273)
-
-The minimal actor interface that `RouterBridgeBase` and every framework router
-adapter require.
-
-This interface, and not `AbstractActor<AnyActorLogic> & Routable`, gives
-`RouterBridgeBase.actor.send` the type that accepts a `PlayRouteEvent` directly.
-It therefore removes the unsafe cast `(actor.send as (e: PlayRouteEvent) => void)`,
-which the weaker `EventObject` constraint of the actor type needed before.
-
-Every `AbstractActor` subclass satisfies this interface structurally, for two
-reasons:
-
-- `AbstractActor` implements `send(event: TEvent): void`, and `TEvent` accepts each
-  `EventObject`. Therefore it always accepts a `PlayRouteEvent`, which is a subtype.
-- `Routable` gives `currentRoute` and `initialRoute`.
-
-## Example
-
-```typescript
-import type { RoutableActor } from "@xmachines/play-router";
-
-class MyBridge extends RouterBridgeBase {
-	constructor(actor: RoutableActor, routeMap: RouteMap) {
-		super(actor, routeMap);
-	}
-}
-```
-
-## Extended by
-
-- [`PlayActor`](PlayActor.md)
-
-## Properties
-
-| Property                                          | Modifier   | Type                                                                                         | Description                                                                                                                                                                                                                              | Defined in                                                                                                                      |
-| ------------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-currentroute"></a> `currentRoute` | `readonly` | [`Computed`](../../play-signals/namespaces/Signal/classes/Computed.md)\<`string` \| `null`\> | The TC39 Signal of the current URL path of the actor, or of its state ID.                                                                                                                                                                | [play-router/src/types.ts:275](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L275) |
-| <a id="property-initialroute"></a> `initialRoute` | `readonly` | `string` \| `null`                                                                           | The route of the initial state of the machine. The constructor fixes it. A router bridge compares it with the browser URL. It therefore separates a deep link, where the router wins, from a restore of a session, where the actor wins. | [play-router/src/types.ts:281](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L281) |
-
-## Methods
-
-### send()
-
-```ts
-send(event): void;
-```
-
-Defined in: [play-router/src/types.ts:283](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L283)
-
-Sends a route navigation event to the actor.
-
-#### Parameters
-
-| Parameter | Type                                  |
-| --------- | ------------------------------------- |
-| `event`   | [`PlayRouteEvent`](PlayRouteEvent.md) |
-
-#### Returns
-
-`void`

package/api/@xmachines/play-router/interfaces/RouteMatch.md

@@ -1,12 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMatch
-
-# Interface: RouteMatch
-
-Defined in: [play-router/src/router-sync.ts:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/router-sync.ts#L12)
-
-## Properties
-
-| Property                               | Type                              | Defined in                                                                                                                                |
-| -------------------------------------- | --------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-params"></a> `params?` | `Record`\<`string`, `string`\>    | [play-router/src/router-sync.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/router-sync.ts#L14) |
-| <a id="property-to"></a> `to`          | `string` \| `null` \| `undefined` | [play-router/src/router-sync.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/router-sync.ts#L13) |

package/api/@xmachines/play-router/interfaces/RouteObject.md

@@ -1,21 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteObject
-
-# Interface: RouteObject
-
-Defined in: [play-router/src/types.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L46)
-
-A route object, with more metadata.
-
-## Indexable
-
-```ts
-[key: string]: unknown
-```
-
-The additional metadata of the route: a title, a breadcrumb, and so on
-
-## Properties
-
-| Property                          | Type     | Description                                             | Defined in                                                                                                                    |
-| --------------------------------- | -------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-path"></a> `path` | `string` | The template of the route path, for example '/user/:id' | [play-router/src/types.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L48) |

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

@@ -1,21 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / RouteTree
-
-# Interface: RouteTree
-
-Defined in: [play-router/src/types.ts:123](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L123)
-
-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
-
-## 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                                                                                                                                                                                                                                                                       | [play-router/src/types.ts:135](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L135) |
-| <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                                                                                                                                                                                                                                                                               | [play-router/src/types.ts:130](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L130) |
-| <a id="property-graph"></a> `graph?`        | `Graph`\<[`MachineNodeData`](MachineNodeData.md), [`MachineEdgeData`](MachineEdgeData.md), `any`, `any`\> | The graph of the state machine, for an advanced query. extractMachineRoutes() fills it. Use it for a query of the hierarchy, for a test of the reachability, and for a navigation that knows the transitions, through the algorithms of @statelyai/graph. **Example** `import { getSuccessors, hasPath } from "@statelyai/graph"; const successors = getSuccessors(tree.graph!, "myMachine.home");` | [play-router/src/types.ts:148](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L148) |
-| <a id="property-root"></a> `root`           | [`RouteNode`](RouteNode.md)                                                                               | The root node of the routes                                                                                                                                                                                                                                                                                                                                                                         | [play-router/src/types.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/types.ts#L125) |

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

@@ -1,13 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / BaseRouteMapping
-
-# ~~Type Alias: BaseRouteMapping~~
-
-```ts
-type BaseRouteMapping = RouteMapping;
-```
-
-Defined in: [play-router/src/index.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/index.ts#L103)
-
-## Deprecated
-
-Use [RouteMapping](../interfaces/RouteMapping.md). Will be removed in the next major.

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

@@ -1,36 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / PlayRouterBridgeConstructor
-
-# Type Alias: PlayRouterBridgeConstructor\<TRouter\>
-
-```ts
-type PlayRouterBridgeConstructor<TRouter> = (router, actor, routeMap, options?) => RouterBridge;
-```
-
-Defined in: [play-router/src/provider-lifecycle.ts:103](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L103)
-
-The constructor shape that a bridge class must satisfy for a provider factory: `(router, actor, routeMap, options?) → RouterBridge`.
-
-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 |
-| -------------- |
-| `TRouter`      |
-
-## Parameters
-
-| Parameter  | Type                                                  |
-| ---------- | ----------------------------------------------------- |
-| `router`   | `TRouter`                                             |
-| `actor`    | [`PlayActor`](../interfaces/PlayActor.md)             |
-| `routeMap` | [`RouteMap`](../classes/RouteMap.md)                  |
-| `options?` | [`BasePathOptions`](../interfaces/BasePathOptions.md) |
-
-## Returns
-
-[`RouterBridge`](../interfaces/RouterBridge.md)