@xmachines/docs 3.0.0 → 5.0.0

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/resolveFrameworkParams.md

@@ -1,51 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / resolveFrameworkParams
-
-# Function: resolveFrameworkParams()
-
-```ts
-function resolveFrameworkParams(__namedParameters): Record<string, string>;
-```
-
-Defined in: [play-router/src/framework-params.ts:298](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/framework-params.ts#L298)
-
-Decides which params describe the route of the machine.
-
-The three branches, in the order that they apply:
-
-- **The pattern declares no name** — a static path, a bare `*` wildcard, or an
-  unknown stateId. The answer is `{}`. The params of the framework must NOT travel
-  here: under a catch-all they hold the splat of the host, and that value would reach
-  the actor as a param of the machine. This branch also reaches no URLPattern, which
-  matters: the extraction needs the constructor even for a pattern with no parameter,
-  so a delegation would throw on a runtime without the API.
-- **The bridge sits under a mount** — the framework matched a route of the HOST by
-  construction, because the machine owns the suffix of the path only. Its params
-  therefore describe this pattern never, whatever they are named, and a name that
-  happens to collide carries the value of the host. Read the params of the machine
-  from its own pattern instead.
-- **The framework covers every REQUIRED name** — it matched the machine route. Keep
-  its parse, together with its decoding. An optional `:name?` that the framework
-  reports not is covered too: a segment that did not match has no value. A gap in a
-  required name falls back, because keeping it would drop a name the route declares.
-- **The path IS the bare form of the pattern** — every optional segment is absent, so
-  `{}` is the complete answer. The branch reads the path and trusts the framework with
-  nothing, which is what makes it safe under a catch-all of the host, and it calls
-  URLPattern for a location that needs none.
-
-None of this decides whether the APPLICATION needs a URLPattern polyfill. A `RouteMap`
-that holds one parameterized route compiles it in the CONSTRUCTOR, and it throws a
-`URLPatternUnavailableError` there when the runtime has no URLPattern. The polyfill
-question is therefore settled at startup: only a route map of static paths alone
-escapes it. What these branches decide is whether a NAVIGATION calls URLPattern again.
-
-## Parameters
-
-| Parameter           | Type                                                              |
-| ------------------- | ----------------------------------------------------------------- |
-| `__namedParameters` | [`FrameworkParamsSource`](../interfaces/FrameworkParamsSource.md) |
-
-## Returns
-
-`Record`\<`string`, `string`\>
-
-The path parameters of the machine route, or `{}`.

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/functions/sanitizePathname.md

@@ -1,42 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / sanitizePathname
-
-# Function: sanitizePathname()
-
-```ts
-function sanitizePathname(pathname): string | null;
-```
-
-Defined in: [play-router/src/router-sync.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/router-sync.ts#L74)
-
-Normalizes a pathname before a lookup in the route map.
-
-The function removes a query fragment and a hash fragment, it joins each duplicate
-slash into one, and it refuses a path of an improbable length, because such a path
-must never enter the route resolution.
-
-It returns `null` for a path of more than 2048 characters, which is malformed or
-hostile input. An adapter that passes around
-`RouterBridgeBase.syncActorFromRouter()`, for example `VueRouterBridge`, must call
-this function itself, and it must return at once on a `null` value. That adapter
-then gives the same guarantee of the defense in depth as the shared base class.
-
-## Parameters
-
-| Parameter  | Type     | Description                                              |
-| ---------- | -------- | -------------------------------------------------------- |
-| `pathname` | `string` | The raw path string of a navigation event of the router. |
-
-## Returns
-
-`string` \| `null`
-
-The normalized path string, or `null` when the path is malformed or too long.
-
-## Example
-
-```typescript
-import { sanitizePathname } from "@xmachines/play-router";
-
-const clean = sanitizePathname(to.path);
-if (clean === null) return; // refuse a malformed path
-```

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/FrameworkParamsSource.md

@@ -1,47 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / FrameworkParamsSource
-
-# Interface: FrameworkParamsSource
-
-Defined in: [play-router/src/framework-params.ts:247](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/framework-params.ts#L247)
-
-What [resolveFrameworkParams](../functions/resolveFrameworkParams.md) needs from the bridge that calls it.
-
-## Properties
-
-| Property                                   | Type                              | Description                                                                                                                                                                                                                             | Defined in                                                                                                                                            |
-| ------------------------------------------ | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-basepath"></a> `basePath`  | `string`                          | The resolved prefix of the mount. `""` means that the machine owns the router.                                                                                                                                                          | [play-router/src/framework-params.ts:251](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/framework-params.ts#L251) |
-| <a id="property-pathname"></a> `pathname?` | `string`                          | The machine-side path of the location, with the mount prefix already removed. The field is OPTIONAL, so a caller that was written before it keeps its behaviour: the one branch that reads it falls back without it, exactly as it did. | [play-router/src/framework-params.ts:258](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/framework-params.ts#L258) |
-| <a id="property-pattern"></a> `pattern`    | `string` \| `null` \| `undefined` | The route pattern of the match, from `routeMap.getPathByStateId`.                                                                                                                                                                       | [play-router/src/framework-params.ts:249](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/framework-params.ts#L249) |
-
-## Methods
-
-### fallback()
-
-```ts
-fallback(): Record<string, string>;
-```
-
-Defined in: [play-router/src/framework-params.ts:262](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/framework-params.ts#L262)
-
-The URLPattern extraction of the base class, read lazily.
-
-#### Returns
-
-`Record`\<`string`, `string`\>
-
----
-
-### frameworkParams()
-
-```ts
-frameworkParams(): Record<string, string>;
-```
-
-Defined in: [play-router/src/framework-params.ts:260](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/framework-params.ts#L260)
-
-The params of the framework router, read lazily and cleaned of empty values.
-
-#### Returns
-
-`Record`\<`string`, `string`\>

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/OpenProviderBridgeArgs.md

@@ -1,28 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / OpenProviderBridgeArgs
-
-# Interface: OpenProviderBridgeArgs\<TRouter, TActor\>
-
-Defined in: [play-router/src/provider-lifecycle.ts:163](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L163)
-
-What [openProviderBridge](../functions/openProviderBridge.md) needs to build and connect a bridge.
-
-## Extends
-
-- [`BasePathOptions`](BasePathOptions.md)
-
-## Type Parameters
-
-| Type Parameter                                 |
-| ---------------------------------------------- |
-| `TRouter`                                      |
-| `TActor` _extends_ [`PlayActor`](PlayActor.md) |
-
-## Properties
-
-| Property                                               | Modifier   | Type                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | Inherited from                                                                                         | Defined in                                                                                                                                                |
-| ------------------------------------------------------ | ---------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                    | `public`   | `TActor`                                   | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                      | [play-router/src/provider-lifecycle.ts:165](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L165) |
-| <a id="property-basepath"></a> `basePath?`             | `readonly` | `string`                                   | The URL prefix that the routes of the machine hang off, for example `"/admin"` or `"/:machineId/play"`. A `:param` segment is a declarative convenience, so that a host keeps ONE string that mirrors its own route config. Every `:param` must have a value in [BasePathOptions.basePathParams](BasePathOptions.md#property-basepathparams), because the bridge writes a real URL. An optional segment (`:param?`) and a wildcard (`*`) are therefore refused: neither of them resolves to one concrete prefix. An absent value, `""`, and `"/"` all mean "no prefix", which is the behaviour of every release before this option existed.                                                 | [`BasePathOptions`](BasePathOptions.md).[`basePath`](BasePathOptions.md#property-basepath)             | [play-router/src/base-path.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/base-path.ts#L58)                     |
-| <a id="property-basepathparams"></a> `basePathParams?` | `readonly` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [BasePathOptions.basePath](BasePathOptions.md#property-basepath). These values belong to the HOST, which wrote the prefix and resolved them, so they travel in NO `play.route` event: the machine is authoritative over its own params, and `event.params` holds what the pattern of the machine declares, and nothing else. A param of the host that shares a name with one of the machine can therefore shadow it never. A host reads them back from `bridge.basePathParams`, where they cannot go stale. A machine that needs the identity of its host takes it through the `input` of the actor, where that identity decides WHICH machine runs. | [`BasePathOptions`](BasePathOptions.md).[`basePathParams`](BasePathOptions.md#property-basepathparams) | [play-router/src/base-path.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/base-path.ts#L72)                     |
-| <a id="property-routemap"></a> `routeMap`              | `public`   | [`RouteMap`](../classes/RouteMap.md)       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                      | [play-router/src/provider-lifecycle.ts:166](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L166) |
-| <a id="property-router"></a> `router`                  | `public`   | `TRouter`                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | -                                                                                                      | [play-router/src/provider-lifecycle.ts:164](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L164) |

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/PlayRouterProviderBaseProps.md

@@ -1,33 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-router](../README.md) / PlayRouterProviderBaseProps
-
-# Interface: PlayRouterProviderBaseProps\<TRouter, TActor, TNode\>
-
-Defined in: [play-router/src/provider-lifecycle.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L36)
-
-The props that every `PlayRouterProvider` of a framework shares.
-
-`TNode` is what the framework renders: `ReactNode` for React, `JSX.Element` for
-Solid. It is the ONLY thing in these props that a framework decides, which is why
-they live here and not in an adapter.
-
-An adapter re-exports a two-parameter alias of this type, with `TRouter` bound to
-the type of its router instance and `TNode` bound to its own node type.
-
-## Type Parameters
-
-| Type Parameter                                 |
-| ---------------------------------------------- |
-| `TRouter`                                      |
-| `TActor` _extends_ [`PlayActor`](PlayActor.md) |
-| `TNode`                                        |
-
-## Properties
-
-| Property                                               | Type                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | Defined in                                                                                                                                              |
-| ------------------------------------------------------ | ------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`                    | `TActor`                                   | The actor to keep in step with the router. It must be a stable reference: give the same actor instance on every render. An actor in the JSX, or a new actor on each render, makes the bridge disconnect and connect again each time.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | [play-router/src/provider-lifecycle.ts:42](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L42) |
-| <a id="property-basepath"></a> `basePath?`             | `string`                                   | Mounts the routes of the machine under a URL prefix that the host owns, so that the routes of the host and the routes of the machine share one router. `actor`, `router`, and `routeMap` each need a stable reference. This prop needs none, and it rebuilds the bridge never: a change moves the live bridge with `setBasePath()`, so a host route that renders again with a new prefix keeps the actor, the route map, and its cache. The prefix says WHERE an actor is mounted, and never WHICH actor is mounted. An actor never changes identity, so a prefix segment that IDENTIFIES the actor gives a different `actor` prop instead, and THAT rebuilds the bridge — which is correct, because one actor takes one bridge. A location outside the prefix belongs completely to the host: the bridge sends no event there, and it corrects no URL there. Every `:param` needs a value. An unresolved one throws a `MissingBasePathParamError` out of the mount effect, because the bridge writes no URL without it. Render this component only after the host holds the value, which a route loader or a `useParams()` call does already. | [play-router/src/provider-lifecycle.ts:80](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L80) |
-| <a id="property-basepathparams"></a> `basePathParams?` | `Record`\<`string`, `string` \| `number`\> | The values of the `:param` segments of [PlayRouterProviderBaseProps.basePath](#property-basepath), for example `{ machineId }` for `basePath="/:machineId/play"`. An inline object literal is correct here: the provider compares this prop by value, and a move to the same prefix does nothing.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              | [play-router/src/provider-lifecycle.ts:89](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L89) |
-| <a id="property-renderer"></a> `renderer`              | (`actor`, `router`) => `TNode`             | The renderer callback receives the same concrete actor type as the prop.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | [play-router/src/provider-lifecycle.ts:91](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L91) |
-| <a id="property-routemap"></a> `routeMap`              | [`RouteMap`](../classes/RouteMap.md)       | The route map of both directions, for the lookup between a state ID and a URL path. **It must be a stable reference.** The provider builds the bridge again on each change of the identity of `routeMap`. A value in the JSX, for example `createRouteMapFromTree(routeTree)`, makes a new object on every render, and the bridge therefore connects again on every render. Hold the value with `useMemo`: `const routeMap = useMemo(() => createRouteMapFromTree(routeTree), [routeTree]);`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | [play-router/src/provider-lifecycle.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L57) |
-| <a id="property-router"></a> `router`                  | `TRouter`                                  | The router instance that the bridge keeps in step with the actor. It must be a stable reference.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | [play-router/src/provider-lifecycle.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v3.0.0/packages/play-router/src/provider-lifecycle.ts#L44) |