@xmachines/docs 1.0.0-beta.52 → 1.0.0-beta.54

package/api/@xmachines/play-tanstack-router/classes/TanStackRouterBridgeBase.md

@@ -0,0 +1,511 @@
+[API](../../../README.md) / [@xmachines/play-tanstack-router](../README.md) / TanStackRouterBridgeBase
+
+# Class: TanStackRouterBridgeBase
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:102](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L102)
+
+Shared TanStack Router adapter implementing RouterBridge protocol via RouterBridgeBase
+
+## Remarks
+
+Extends RouterBridgeBase to handle all common lifecycle and sync logic; adds
+the TanStack-specific navigation and subscription methods shared by the React
+and Solid adapters.
+
+Subscribes to router.history (not router.subscribe("onBeforeLoad")) so that
+back/forward browser navigation (popstate events) are also captured. The
+router.subscribe("onBeforeLoad") approach only works when TanStack's
+Transitioner component is mounted (i.e. inside a full <RouterProvider>).
+Since this bridge is used without <RouterProvider>, we must subscribe to
+the underlying history object directly — which is exactly what Transitioner
+does internally: `router.history.subscribe(router.load)`.
+
+Architectural Invariants:
+
+- INV-02 (Passive Infrastructure): Router reflects actor state, never decides
+- Actor validates all navigation via guards before URL changes
+
+The class is concrete — it can be instantiated directly. The framework
+packages re-export or subclass it purely to bind the public adapter name
+(and, for Solid, to add the `dispose()` alias).
+
+## Example
+
+```typescript
+const bridge = new TanStackRouterBridgeBase(router, actor, routeMap);
+bridge.connect();
+return () => bridge.disconnect();
+```
+
+## Extends
+
+- [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md)
+
+## Extended by
+
+- [`TanStackSolidRouterBridge`](../../play-tanstack-solid-router/classes/TanStackSolidRouterBridge.md)
+
+## Constructors
+
+### Constructor
+
+```ts
+new TanStackRouterBridgeBase(
+   router,
+   actor,
+   routeMap): TanStackRouterBridgeBase;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:112](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L112)
+
+Create a TanStack Router bridge
+
+#### Parameters
+
+| Parameter  | Type                                                                 | Description                                       |
+| ---------- | -------------------------------------------------------------------- | ------------------------------------------------- |
+| `router`   | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md)        | TanStack Router instance (from `createRouter`)    |
+| `actor`    | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md) | XMachines actor instance                          |
+| `routeMap` | [`TanStackRouteMapLike`](../type-aliases/TanStackRouteMapLike.md)    | Bidirectional mapping between state IDs and paths |
+
+#### Returns
+
+`TanStackRouterBridgeBase`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`constructor`](../../play-router/classes/RouterBridgeBase.md#constructor)
+
+## Properties
+
+| Property                                                              | Modifier    | Type                                                                                    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | Inherited from                                                                                                                                                                | Defined in                                                                                                                                                                                            |
+| --------------------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| <a id="property-actor"></a> `actor`                                   | `readonly`  | [`RoutableActor`](../../play-dom-router/interfaces/RoutableActor.md)                    | A `RoutableActor` exposing `currentRoute`, `initialRoute`, and `send`.                                                                                                                                                                                                                                                                                                                                                                                                                                 | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`actor`](../../play-router/classes/RouterBridgeBase.md#property-actor)                                   | play-router/dist/router-bridge-base.d.ts:73                                                                                                                                                           |
+| <a id="property-hasconnectedonce"></a> `hasConnectedOnce`             | `protected` | `boolean`                                                                               | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`hasConnectedOnce`](../../play-router/classes/RouterBridgeBase.md#property-hasconnectedonce)             | play-router/dist/router-bridge-base.d.ts:79                                                                                                                                                           |
+| <a id="property-isconnected"></a> `isConnected`                       | `protected` | `boolean`                                                                               | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isConnected`](../../play-router/classes/RouterBridgeBase.md#property-isconnected)                       | play-router/dist/router-bridge-base.d.ts:78                                                                                                                                                           |
+| <a id="property-isprocessingnavigation"></a> `isProcessingNavigation` | `protected` | `boolean`                                                                               | Guards `syncActorFromRouter` against re-entrant calls triggered by the actor's own guard redirects (router→actor send → signal fires → actor→router push → another syncActorFromRouter before the first one returns). NOT used for actor→router echo suppression — that is handled exclusively by `lastSyncedPath`, which is updated before `navigateRouter()` is called so any router callback for the same path short-circuits at the `sanitized === lastSyncedPath` check in `syncActorFromRouter`. | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`isProcessingNavigation`](../../play-router/classes/RouterBridgeBase.md#property-isprocessingnavigation) | play-router/dist/router-bridge-base.d.ts:91                                                                                                                                                           |
+| <a id="property-lastsyncedpath"></a> `lastSyncedPath`                 | `protected` | `string` \| `null`                                                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`lastSyncedPath`](../../play-router/classes/RouterBridgeBase.md#property-lastsyncedpath)                 | play-router/dist/router-bridge-base.d.ts:80                                                                                                                                                           |
+| <a id="property-routemap"></a> `routeMap`                             | `readonly`  | `object`                                                                                | Bidirectional route map for `stateId ↔ path` resolution. Provide `getStateIdByPath` and `getPathByStateId`. Framework adapters typically wrap the result of `createRouteMap(machine)` or an equivalent. `getPathByStateId` may be keyed on either the `"#stateId"` or the bare `"stateId"` form — both forms are tried automatically by the bridge, so custom implementations (e.g. plain test objects) need only handle one.                                                                          | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeMap`](../../play-router/classes/RouterBridgeBase.md#property-routemap)                             | play-router/dist/router-bridge-base.d.ts:74                                                                                                                                                           |
+| `routeMap.getPathByStateId`                                           | `public`    | `string` \| `null` \| `undefined`                                                       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | -                                                                                                                                                                             | play-router/dist/router-bridge-base.d.ts:76                                                                                                                                                           |
+| `routeMap.getStateIdByPath`                                           | `public`    | `string` \| `null` \| `undefined`                                                       | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | -                                                                                                                                                                             | play-router/dist/router-bridge-base.d.ts:75                                                                                                                                                           |
+| <a id="property-router"></a> `router`                                 | `readonly`  | [`TanStackRouterLike`](../type-aliases/TanStackRouterLike.md)                           | TanStack Router instance (from `createRouter`)                                                                                                                                                                                                                                                                                                                                                                                                                                                         | -                                                                                                                                                                             | [play-tanstack-router/src/tanstack-router-bridge-base.ts:113](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L113) |
+| <a id="property-routewatcher"></a> `routeWatcher`                     | `protected` | \| [`RouteWatcherHandle`](../../play-router/interfaces/RouteWatcherHandle.md) \| `null` | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | [`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`routeWatcher`](../../play-router/classes/RouterBridgeBase.md#property-routewatcher)                     | play-router/dist/router-bridge-base.d.ts:92                                                                                                                                                           |
+
+## Methods
+
+### connect()
+
+```ts
+connect(): void;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:120
+
+Connect the router bridge to the Actor.
+
+Sets up the TC39 Signal watcher for actor → router direction and
+starts watching router changes (framework-specific).
+
+Ordering here is part of the bridge contract:
+
+- `lastSyncedPath` is seeded in the constructor from `actor.currentRoute`
+- the actor watcher is installed before adapter router subscriptions
+- initial sync then resolves deep-link vs restore using `actor.initialRoute`
+
+Adapters that need custom initial-sync behavior should override
+`getInitialRouterPath()` rather than reordering `connect()` steps.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`connect`](../../play-router/classes/RouterBridgeBase.md#connect)
+
+---
+
+### disconnect()
+
+```ts
+disconnect(): void;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:126
+
+Disconnect the router bridge from the Actor.
+
+Stops signal watching and unregisters framework-specific router listener.
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`disconnect`](../../play-router/classes/RouterBridgeBase.md#disconnect)
+
+---
+
+### extractParams()
+
+```ts
+protected extractParams(pathname, stateId): Record<string, string>;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:192
+
+Extract path parameters from URL using the URLPattern API.
+
+Accesses `globalThis.URLPattern` at runtime — no polyfill is imported by this
+library. If `URLPattern` is unavailable and the matched route has parameterized
+segments, a `URLPatternUnavailableError` is thrown — callers must provide a polyfill
+for environments without native URLPattern support (Node.js < 24, older browsers).
+
+#### Parameters
+
+| Parameter  | Type     | Description                                           |
+| ---------- | -------- | ----------------------------------------------------- |
+| `pathname` | `string` | The actual URL path (e.g., '/profile/john')           |
+| `stateId`  | `string` | The matched state ID for looking up the route pattern |
+
+#### Returns
+
+`Record`\<`string`, `string`\>
+
+Extracted path parameters, or empty object if no match
+
+#### Throws
+
+When URLPattern is absent and the route is parameterized
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractParams`](../../play-router/classes/RouterBridgeBase.md#extractparams)
+
+---
+
+### extractQuery()
+
+```ts
+protected extractQuery(search): Record<string, string>;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:232
+
+Extract query parameters from URL search string.
+
+#### Parameters
+
+| Parameter | Type     | Description                                      |
+| --------- | -------- | ------------------------------------------------ |
+| `search`  | `string` | URL search string (e.g., '?tab=security&page=1') |
+
+#### Returns
+
+`Record`\<`string`, `string`\>
+
+Extracted query parameters or empty object
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`extractQuery`](../../play-router/classes/RouterBridgeBase.md#extractquery)
+
+---
+
+### getInitialRouterPath()
+
+```ts
+protected getInitialRouterPath(): string | null;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:153](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L153)
+
+Read the router's current pathname for initial sync.
+
+Called once in connect() to handle cold-load / deep-link scenarios where
+the URL differs from the actor's initial state (e.g. user pastes /dashboard
+while logged out — the actor must be redirected to /login before rendering).
+
+Uses `router.history.location.pathname` — reflects `window.location` immediately,
+before the router has been loaded or a `<RouterProvider>` mounted.
+`router.state.location` is only populated after `router.load()` which may not
+have run yet when the bridge first connects in a component effect.
+
+The base class `connect()` uses `actor.initialRoute` to distinguish:
+
+- **Deep-link:** router URL differs from machine's initial route → router wins.
+- **Restore:** router at machine's initial route, actor at a different restored
+  route → actor wins, bridge pushes actor's restored route to the router.
+
+#### Returns
+
+`string` \| `null`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`getInitialRouterPath`](../../play-router/classes/RouterBridgeBase.md#getinitialrouterpath)
+
+---
+
+### getInitialRouterSearch()
+
+```ts
+protected getInitialRouterSearch(): string | undefined;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:169](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L169)
+
+Return the initial URL search string for query-param forwarding on `connect()`.
+
+Reads `router.history.location.search` — the same source used by
+`getInitialRouterPath()`, which reflects `window.location` immediately before
+`router.load()` or `<RouterProvider>` mounts. An empty string returns `undefined`
+so `syncActorFromRouter` produces `query: {}` rather than parsing an empty string.
+
+#### Returns
+
+`string` \| `undefined`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`getInitialRouterSearch`](../../play-router/classes/RouterBridgeBase.md#getinitialroutersearch)
+
+---
+
+### navigateRouter()
+
+```ts
+protected navigateRouter(path): void;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:131](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L131)
+
+Navigate TanStack Router to the given path.
+
+Calls `router.load()` (fire-and-forget) after `navigate` so TanStack re-runs
+route matching and loaders — `navigate` alone does not when no
+`<RouterProvider>` (Transitioner) is mounted.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `path`    | `string` |
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`navigateRouter`](../../play-router/classes/RouterBridgeBase.md#navigaterouter)
+
+---
+
+### resolveNavigationPath()
+
+```ts
+protected resolveNavigationPath(route): string | null;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:211
+
+Resolve an actor route value to a concrete URL path for navigation.
+
+Bridges that receive raw `actor.currentRoute` values in `navigateRouter`
+can call this to normalize stateIds (with or without `#` prefix) to paths.
+Returns `null` when navigation is not possible:
+
+- unknown stateId with no route map entry
+- parameterized or wildcard pattern (e.g. `/profile/:id`, `/docs/*`) — no
+  concrete values available to build a real URL
+- non-path string that isn't a known stateId
+
+StateId lookups try both the `"#stateId"` and bare `"stateId"` forms
+automatically (via `lookupPathByStateId`), so custom route maps keyed on
+only one form still resolve.
+
+#### Parameters
+
+| Parameter | Type     | Description                                                    |
+| --------- | -------- | -------------------------------------------------------------- |
+| `route`   | `string` | Raw actor route value (stateId, `#`-stateId, or concrete path) |
+
+#### Returns
+
+`string` \| `null`
+
+Concrete URL path, or `null` if navigation should be skipped
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`resolveNavigationPath`](../../play-router/classes/RouterBridgeBase.md#resolvenavigationpath)
+
+---
+
+### sanitizePath()
+
+```ts
+protected sanitizePath(pathname): string | null;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:259
+
+Sanitize and validate a raw URL pathname received from the router.
+
+Applies the path-length cap (2048 chars), strips query strings and fragments
+that may have been included in the pathname segment, and normalises
+consecutive slashes.
+
+Implementations that bypass `syncActorFromRouter()` (e.g. when using
+framework-native reactive watchers that receive pre-parsed route objects)
+MUST call this method before passing the path to any route-map lookup.
+`syncActorFromRouter()` calls this internally, so bridges that delegate
+to it do not need to call `sanitizePath` themselves.
+
+#### Parameters
+
+| Parameter  | Type     | Description                                 |
+| ---------- | -------- | ------------------------------------------- |
+| `pathname` | `string` | Raw URL pathname from the framework router. |
+
+#### Returns
+
+`string` \| `null`
+
+Sanitized pathname, or `null` if the path is invalid / too long.
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`sanitizePath`](../../play-router/classes/RouterBridgeBase.md#sanitizepath)
+
+---
+
+### syncActorFromRouter()
+
+```ts
+protected syncActorFromRouter(pathname, search?): void;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:178
+
+Sync actor state when router location changes.
+
+**Known path:** sends a `play.route` event to the actor with the matched
+stateId, params, and query. Prevents circular updates via the
+`isProcessingNavigation` flag.
+
+**Unknown/unmapped path:** does NOT send a `play.route` event (actor state
+is unchanged). Instead, actively corrects the browser URL by calling
+`navigateRouter(actor.currentRoute.get())` — keeping the URL in sync with
+actor state even when the user types an invalid path into the address bar
+or pushes one programmatically mid-session. `lastSyncedPath` is set to the
+resolved concrete path before calling `navigateRouter` so the router's own
+callback for that navigation short-circuits the echo-suppression guard and
+sends no spurious event.
+
+#### Parameters
+
+| Parameter  | Type     |
+| ---------- | -------- |
+| `pathname` | `string` |
+| `search?`  | `string` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncActorFromRouter`](../../play-router/classes/RouterBridgeBase.md#syncactorfromrouter)
+
+---
+
+### syncRouterFromActor()
+
+```ts
+protected syncRouterFromActor(route): void;
+```
+
+Defined in: play-router/dist/router-bridge-base.d.ts:146
+
+Sync router location when actor route signal changes.
+
+Resolves the actor route to a concrete URL path and calls navigateRouter()
+for framework-specific navigation. When the route cannot be resolved
+(unknown stateId, parameterized pattern with no concrete values) the push
+is skipped entirely — `navigateRouter` is never called with a raw stateId
+or pattern.
+
+Echo suppression — preventing the router's own callback from re-driving the
+actor — is handled entirely by `lastSyncedPath`: it is set to the resolved
+path before `navigateRouter()` is called, so any `syncActorFromRouter`
+invocation for the same path short-circuits at the
+`sanitized === lastSyncedPath` check and sends no event regardless of
+whether the callback fires synchronously or asynchronously.
+
+`isProcessingNavigation` is NOT set here — it is only used inside
+`syncActorFromRouter` to guard against re-entrant guard-redirect loops.
+
+#### Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| `route`   | `unknown` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`syncRouterFromActor`](../../play-router/classes/RouterBridgeBase.md#syncrouterfromactor)
+
+---
+
+### unwatchRouterChanges()
+
+```ts
+protected unwatchRouterChanges(): void;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:196](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L196)
+
+Stop watching TanStack Router changes.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`unwatchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#unwatchrouterchanges)
+
+---
+
+### watchRouterChanges()
+
+```ts
+protected watchRouterChanges(): void;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:184](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L184)
+
+Subscribe to ALL navigation events via router.history.
+
+router.history.subscribe fires for PUSH, POP, BACK, FORWARD, REPLACE, and GO —
+covering both link clicks and browser back/forward button presses.
+
+The subscriber callback receives { location, action } where location is the
+new history location with pathname and search already updated. It calls
+`router.load()` (fire-and-forget) so TanStack re-runs matching/loaders for the
+new location, mirroring what Transitioner does when `<RouterProvider>` is mounted.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`RouterBridgeBase`](../../play-router/classes/RouterBridgeBase.md).[`watchRouterChanges`](../../play-router/classes/RouterBridgeBase.md#watchrouterchanges)

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

@@ -0,0 +1,57 @@
+[API](../../../README.md) / [@xmachines/play-tanstack-router](../README.md) / TanStackRouteMapLike
+
+# Type Alias: TanStackRouteMapLike
+
+```ts
+type TanStackRouteMapLike = object;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L66)
+
+Narrow route-map surface required by `TanStackRouterBridgeBase`.
+`RouteMap` from `@xmachines/play-router` satisfies it (null returns are
+adapted to undefined internally).
+
+`getPathByStateId` may receive the stateId in either `"#stateId"` or bare
+`"stateId"` form — the bridge tries both forms automatically, so custom
+implementations keyed on a single form still resolve.
+
+## Methods
+
+### getPathByStateId()
+
+```ts
+getPathByStateId(id): string | null | undefined;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L68)
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `id`      | `string` |
+
+#### Returns
+
+`string` \| `null` \| `undefined`
+
+---
+
+### getStateIdByPath()
+
+```ts
+getStateIdByPath(path): string | null | undefined;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L67)
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `path`    | `string` |
+
+#### Returns
+
+`string` \| `null` \| `undefined`

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

@@ -0,0 +1,100 @@
+[API](../../../README.md) / [@xmachines/play-tanstack-router](../README.md) / TanStackRouterLike
+
+# Type Alias: TanStackRouterLike
+
+```ts
+type TanStackRouterLike = object;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L36)
+
+Structural (type-only) interface for the TanStack Router surface used by
+`TanStackRouterBridgeBase`. Both `@tanstack/react-router` and
+`@tanstack/solid-router` instances satisfy it.
+
+## Properties
+
+### history
+
+```ts
+history: object;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L44)
+
+#### location
+
+```ts
+location: object;
+```
+
+Current location — populated from `window.location` when `createRouter()` runs,
+before `router.load()`. Always available in the browser.
+`router.state.location` is only populated after `router.load()` and may be stale.
+
+##### location.pathname
+
+```ts
+pathname: string;
+```
+
+##### location.search?
+
+```ts
+optional search?: string;
+```
+
+#### subscribe()
+
+```ts
+subscribe(handler): () => void;
+```
+
+##### Parameters
+
+| Parameter | Type                |
+| --------- | ------------------- |
+| `handler` | (`event`) => `void` |
+
+##### Returns
+
+() => `void`
+
+## Methods
+
+### load()?
+
+```ts
+optional load(): void | Promise<void>;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:43](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L43)
+
+Re-runs TanStack route matching and loaders for the current location.
+Optional: the bridge calls it (fire-and-forget) after every navigation so
+matching/loaders stay in sync even without a mounted `<RouterProvider>`.
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+---
+
+### navigate()
+
+```ts
+navigate(args): void;
+```
+
+Defined in: [play-tanstack-router/src/tanstack-router-bridge-base.ts:37](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.54/packages/play-tanstack-router/src/tanstack-router-bridge-base.ts#L37)
+
+#### Parameters
+
+| Parameter | Type                  |
+| --------- | --------------------- |
+| `args`    | \{ `to`: `string`; \} |
+| `args.to` | `string`              |
+
+#### Returns
+
+`void`