@xmachines/docs 1.0.0-beta.9 → 1.1.0

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

@@ -1,69 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / BrowserWindow
-
-# Interface: BrowserWindow
-
-Defined in: [create-browser-history.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L55)
-
-Minimal window interface for createBrowserHistory
-
-Structural interface covering only the properties actually used.
-Accepts Window, JSDOM window, or any compatible test double.
-Avoids coupling to `Window & typeof globalThis` which varies across environments.
-
-## Properties
-
-| Property                                  | Modifier   | Type      | Defined in                                                                                                                                                                        |
-| ----------------------------------------- | ---------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-history"></a> `history`   | `public`   | `object`  | [create-browser-history.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L56) |
-| `history.state`                           | `readonly` | `unknown` | [create-browser-history.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L57) |
-| `history.back`                            | `public`   | `void`    | [create-browser-history.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L61) |
-| `history.forward`                         | `public`   | `void`    | [create-browser-history.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L62) |
-| `history.go`                              | `public`   | `void`    | [create-browser-history.ts:60](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L60) |
-| `history.pushState`                       | `public`   | `void`    | [create-browser-history.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L58) |
-| `history.replaceState`                    | `public`   | `void`    | [create-browser-history.ts:59](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L59) |
-| <a id="property-location"></a> `location` | `public`   | `object`  | [create-browser-history.ts:64](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L64) |
-| `location.hash`                           | `readonly` | `string`  | [create-browser-history.ts:67](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L67) |
-| `location.pathname`                       | `readonly` | `string`  | [create-browser-history.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L65) |
-| `location.search`                         | `readonly` | `string`  | [create-browser-history.ts:66](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L66) |
-
-## Methods
-
-### addEventListener()
-
-```ts
-addEventListener(type, listener): void;
-```
-
-Defined in: [create-browser-history.ts:69](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L69)
-
-#### Parameters
-
-| Parameter  | Type         |
-| ---------- | ------------ |
-| `type`     | `"popstate"` |
-| `listener` | () => `void` |
-
-#### Returns
-
-`void`
-
----
-
-### removeEventListener()
-
-```ts
-removeEventListener(type, listener): void;
-```
-
-Defined in: [create-browser-history.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-browser-history.ts#L70)
-
-#### Parameters
-
-| Parameter  | Type         |
-| ---------- | ------------ |
-| `type`     | `"popstate"` |
-| `listener` | () => `void` |
-
-#### Returns
-
-`void`

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

@@ -1,13 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / ConnectRouterOptions
-
-# Interface: ConnectRouterOptions
-
-Defined in: [connect-router.ts:7](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/connect-router.ts#L7)
-
-## Properties
-
-| Property                                  | Type                                                                                                                                    | Defined in                                                                                                                                                        |
-| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`       | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`AnyActorLogic`\> & [`Routable`](../../play-actor/interfaces/Routable.md) | [connect-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/connect-router.ts#L8)   |
-| <a id="property-routemap"></a> `routeMap` | [`RouteMap`](RouteMap.md)                                                                                                               | [connect-router.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/connect-router.ts#L10) |
-| <a id="property-router"></a> `router`     | [`VanillaRouter`](VanillaRouter.md)                                                                                                     | [connect-router.ts:9](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/connect-router.ts#L9)   |

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

@@ -1,56 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / RouteMap
-
-# Interface: RouteMap
-
-Defined in: [create-route-map.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-route-map.ts#L27)
-
-Bidirectional route resolution interface returned by `createRouteMap()`.
-
-Resolves incoming URL paths to state IDs (with `#` prefix) and extracts
-route parameters. Used by `RouterBridgeBase` to translate router navigation
-events into `play.route` actor events.
-
-## See
-
-- [createRouteMap](../functions/createRouteMap.md) for the factory function
-- [BaseRouteMap](../classes/BaseRouteMap.md) for direct state ID ↔ path lookups without params extraction
-
-## Methods
-
-### resolve()
-
-```ts
-resolve(path): object;
-```
-
-Defined in: [create-route-map.ts:44](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-route-map.ts#L44)
-
-Resolve a URL path to a state ID and params.
-
-#### Parameters
-
-| Parameter | Type     | Description                              |
-| --------- | -------- | ---------------------------------------- |
-| `path`    | `string` | URL pathname (e.g., "/settings/account") |
-
-#### Returns
-
-`object`
-
-Object with `to` (state ID with # prefix) and `params`
-
-Example:
-
-```typescript
-const { to, params } = routeMap.resolve("/settings/account");
-// { to: "#settings", params: { section: "account" } }
-
-if (to) {
-	actor.send({ type: "play.route", to, params });
-}
-```
-
-| Name     | Type                           | Defined in                                                                                                                                                            |
-| -------- | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `params` | `Record`\<`string`, `string`\> | [create-route-map.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-route-map.ts#L46) |
-| `to`     | `string` \| `null`             | [create-route-map.ts:45](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-route-map.ts#L45) |

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

@@ -1,15 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / StateVisit
-
-# Interface: StateVisit
-
-Defined in: [types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/types.ts#L28)
-
-Represents a visit to a state node during graph crawling
-
-## Properties
-
-| Property                              | Type                                                     | Description                                                    | Defined in                                                                                                                                      |
-| ------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-node"></a> `node`     | `StateNode`                                              | The state node being visited                                   | [types.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/types.ts#L30) |
-| <a id="property-parent"></a> `parent` | `StateNode`\<`MachineContext`, `EventObject`\> \| `null` | Parent state node (null for root)                              | [types.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/types.ts#L34) |
-| <a id="property-path"></a> `path`     | `string`[]                                               | Path from root to this state (e.g., ['dashboard', 'overview']) | [types.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/types.ts#L32) |

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

@@ -1,28 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-router](../README.md) / VanillaRouter
-
-# Interface: VanillaRouter
-
-Defined in: [create-router.ts:4](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-router.ts#L4)
-
-## Properties
-
-| Property                                    | Modifier   | Type                                  | Description                          | Defined in                                                                                                                                                      |
-| ------------------------------------------- | ---------- | ------------------------------------- | ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-history"></a> `history`     | `readonly` | [`BrowserHistory`](BrowserHistory.md) | History instance                     | [create-router.ts:8](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-router.ts#L8)   |
-| <a id="property-routetree"></a> `routeTree` | `readonly` | [`RouteTree`](RouteTree.md)           | Route tree (for structure reference) | [create-router.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-router.ts#L13) |
-
-## Methods
-
-### destroy()
-
-```ts
-destroy(): void;
-```
-
-Defined in: [create-router.ts:18](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-router/src/create-router.ts#L18)
-
-Cleanup
-
-#### Returns
-
-`void`

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

@@ -1,137 +0,0 @@
-[Documentation](../../README.md) / @xmachines/play-router-demo
-
-# Vanilla JavaScript Router Demo
-
-Pure JavaScript integration proving Play Architecture works without any framework.
-
-## What This Demonstrates
-
-This demo uses **no framework** - just vanilla JavaScript with the Browser History API and DOM manipulation. It proves that Play Architecture's universal abstractions work at the lowest level, making framework integrations simpler by comparison.
-
-## Key Features
-
-- **Zero Framework Dependencies**: Pure JavaScript and DOM
-- **Browser History API**: Direct integration with `window.history`
-- **Same Auth Machine**: Identical authentication logic as React/Vue/SolidJS demos
-- **Reference Implementation**: This demo serves as the visual reference for all framework demos
-
-## Running the Demo
-
-From the repository root:
-
-```bash
-npm install
-npm run dev -w packages/play-router/examples/demo
-```
-
-Visit `http://localhost:5174`.
-
-## Step-by-Step Code Flow
-
-Use this order to understand the demo implementation:
-
-1. `src/main.ts` creates the actor from the shared machine/catalog and starts it.
-2. `src/router.ts` extracts machine routes, builds browser-history routing primitives, and connects actor <-> router sync.
-3. `src/shell.ts` subscribes to actor signals and renders state-projected DOM views.
-4. Navigation and auth interactions dispatch actor events (`play.route`, `auth.login`, `auth.logout`) rather than mutating URL/state directly.
-5. Browser tests in `test/browser/` validate startup rendering and the auth route flow end-to-end.
-
-```ts
-// src/main.ts (shape)
-const actor = createActorFromSharedMachine();
-actor.start();
-
-const cleanupRouter = initRouter(actor);
-const app = document.getElementById("app");
-if (app) {
-	initShell(actor, app);
-}
-```
-
-```ts
-// src/router.ts (shape)
-const routeTree = extractMachineRoutes(machine);
-const routeMap = createRouteMap(routeTree);
-const history = createBrowserHistory();
-const router = createRouter({ history, routeMap });
-connectRouter({ actor, router, routeMap });
-```
-
-```ts
-// src/shell.ts (shape)
-actor.currentView.watch(() => {
-	renderView(actor.currentView.get());
-});
-
-loginButton.onclick = () => actor.send({ type: "auth.login", username, password });
-logoutButton.onclick = () => actor.send({ type: "auth.logout" });
-```
-
-## Key Files
-
-- `src/main.ts` - actor startup, router initialization, and shell bootstrap
-- `src/router.ts` - `createBrowserHistory`, `createRouter`, and `connectRouter` wiring
-- `src/shell.ts` - DOM rendering and reactive watcher loop for state-driven updates
-- `test/browser/startup.browser.test.ts` - startup rendering assertion for public home + login action
-- `test/browser/auth-flow.browser.test.ts` - login -> dashboard -> profile -> logout browser flow
-
-## State Machine & Architecture Details
-
-The demo utilizes XMachines architectural invariants at the lowest level:
-
-1. **Actor Authority:** Intercepting browser `popstate` events or link clicks dispatches a `play.route` event to the actor. The actor processes the request against the current state, ensuring any auth logic is correctly applied.
-2. **Passive Infrastructure:** The router simply updates `window.history` and the DOM solely renders HTML text based on what `actor.currentView.get()` yields.
-3. **Signal-Only Reactivity:** The integration registers manual `Signal.subtle.Watcher` observers that manually trigger DOM reconciliation, illustrating the underlying mechanism abstraction used by framework adapters.
-
-## Watcher Lifecycle and Cleanup Contract
-
-Even in the vanilla demo, watcher handling follows the same canonical lifecycle:
-
-1. `notify`
-2. `queueMicrotask`
-3. `getPending()`
-4. Read actor signals and project DOM state
-5. Re-arm with `watch()`/`watch(...signals)`
-
-Watcher notifications are one-shot, so re-arm is mandatory. Router/shell teardown must explicitly call cleanup (`disconnect`/`unwatch`) and not rely on GC-only behavior. In vanilla JS, this means retaining the cleanup functions and calling them during hot-module replacement or app unmount.
-
-## Adapter Boundaries
-
-`connectRouter` and browser-history wiring are passive infrastructure. Actor logic remains authoritative for route validity, and shared synchronization policy stays in `RouterBridgeBase` for framework bridges.
-
-## Why Vanilla?
-
-Vanilla JavaScript is the foundation:
-
-- **Universal Patterns**: If it works in vanilla, frameworks are just convenience layers
-- **No Magic**: Every interaction is explicit - great for learning
-- **Performance Baseline**: Shows the minimal overhead of Play Architecture
-
-This demo proves frameworks aren't required for Play Architecture to work.
-
-## Available Scripts
-
-These commands are defined in `package.json`:
-
-| Command                                                      | Description                      |
-| ------------------------------------------------------------ | -------------------------------- |
-| `npm run dev -w packages/play-router/examples/demo`          | Start Vite dev server            |
-| `npm run build -w packages/play-router/examples/demo`        | Build production bundle          |
-| `npm run preview -w packages/play-router/examples/demo`      | Preview built bundle             |
-| `npm run test -w packages/play-router/examples/demo`         | Run Vitest test suite            |
-| `npm run test:browser -w packages/play-router/examples/demo` | Run browser-focused Vitest suite |
-
-## Verification
-
-Validate the operational behavior with package-local tests:
-
-```bash
-npm run test -w packages/play-router/examples/demo
-npm run test:browser -w packages/play-router/examples/demo
-```
-
-Expected result: tests pass, including startup rendering and the full browser auth flow in `test/browser/`.
-
-## Learn More
-
-- **[Play Router Package README](../play-router/README.md)** - Router APIs and integration patterns

package/api/@xmachines/play-solid/interfaces/PlayRendererProps.md

@@ -1,15 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid](../README.md) / PlayRendererProps
-
-# Interface: PlayRendererProps
-
-Defined in: [types.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid/src/types.ts#L20)
-
-Props for PlayRenderer component
-
-## Properties
-
-| Property                                      | Type                                                                                                                                    | Description                                                           | Defined in                                                                                                                                     |
-| --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-actor"></a> `actor`           | [`AbstractActor`](../../play-actor/classes/AbstractActor.md)\<`AnyActorLogic`\> & [`Viewable`](../../play-actor/interfaces/Viewable.md) | Actor instance with currentView signal (requires Viewable capability) | [types.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid/src/types.ts#L22) |
-| <a id="property-components"></a> `components` | `Record`\<`string`, `ValidComponent`\>                                                                                                  | Map of component names to SolidJS components                          | [types.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid/src/types.ts#L25) |
-| <a id="property-fallback"></a> `fallback?`    | `any`                                                                                                                                   | Optional element shown when currentView is null                       | [types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid/src/types.ts#L28) |

package/api/@xmachines/play-solid-router/functions/PlayRouterProvider.md

@@ -1,19 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid-router](../README.md) / PlayRouterProvider
-
-# Function: PlayRouterProvider()
-
-```ts
-function PlayRouterProvider(props): any;
-```
-
-Defined in: [packages/play-solid-router/src/play-router-provider.tsx:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-solid-router/src/play-router-provider.tsx#L21)
-
-## Parameters
-
-| Parameter | Type                                                                  |
-| --------- | --------------------------------------------------------------------- |
-| `props`   | [`PlayRouterProviderProps`](../interfaces/PlayRouterProviderProps.md) |
-
-## Returns
-
-`any`

package/api/@xmachines/play-solid-router-demo/README.md

@@ -1,127 +0,0 @@
-[Documentation](../../README.md) / @xmachines/play-solid-router-demo
-
-# Solid Router Demo
-
-Solid + `@solidjs/router` demonstration of the Play architecture using provider-based router integration.
-
-## What This Demonstrates
-
-- Shared auth machine reused without framework-specific business logic
-- `PlayRouterProvider` renderer-based integration with Solid Router
-- Shell-driven rendering via `PlayRenderer` with actor-authoritative navigation
-- Canonical TC39 Signals lifecycle integration with Solid's fine-grained reactivity
-- Non-browser invariant tests plus browser E2E coverage
-
-## Running the Demo
-
-From this directory (`packages/play-solid-router/examples/demo`):
-
-```bash
-npm install
-npm run dev
-```
-
-Open `http://localhost:5173`.
-
-## Step-by-Step Code Flow
-
-Use this order to understand the implementation:
-
-1. `src/main.tsx` bootstraps the demo and mounts the `<App />` component.
-2. `src/App.tsx` wires actor lifecycle, shared machine/catalog imports, and router integration.
-3. A `routeMap` is created by extracting routes from the shared `authMachine`.
-4. `PlayRouterProvider` forwards navigation intent from `@solidjs/router` to the actor, and reflects actor-approved routes back to the URL.
-5. `Shell` (inside `src/App.tsx`) renders actor-projected views (`PlayRenderer`) and provides the shared UI shell.
-6. `test/library-pattern.test.ts` and `test/browser/` verify invariants and runtime routing behavior.
-
-```tsx
-// src/main.tsx (shape)
-render(() => <App />, document.getElementById("root")!);
-```
-
-```tsx
-// src/App.tsx (shape)
-const createPlayer = definePlayer({ machine: authMachine, catalog });
-const actor = createPlayer();
-actor.start();
-
-const routeMap = createRouteMap(authMachine);
-
-<PlayRouterProvider
-	actor={actor}
-	routeMap={routeMap}
-	router={{ navigate, location, params }}
-	renderer={(currentActor, currentRouter) => (
-		<Shell actor={currentActor} router={currentRouter} />
-	)}
-/>;
-```
-
-```tsx
-// src/components/Nav.tsx (shape)
-<button onClick={() => actor.send({ type: "auth.logout" })}>Logout</button>
-```
-
-## Key Files
-
-- `src/App.tsx` - Integration entry point wiring actor, provider, renderer, and shared machine/catalog imports.
-- `src/main.tsx` - Vite bootstrap for the Solid app.
-- `src/components/` - Demo views and controls that send events to the actor.
-- `test/library-pattern.test.ts` - Node/Vitest invariant checks for architecture boundaries.
-- `test/browser/startup.browser.test.ts` - Browser startup and mount coverage.
-- `test/browser/auth-flow.browser.test.ts` - Browser auth and routing behavior coverage.
-
-## State Machine & Architecture Details
-
-The demo utilizes XMachines architectural invariants:
-
-1. **Actor Authority:** When a user navigates to a protected route, the Solid Router updates the URL. The `PlayRouterProvider` intercepts this, translates it to a `play.route` event, and sends it to the actor. The actor evaluates guards (e.g., is the user logged in?) and transitions to the appropriate state.
-2. **Passive Infrastructure:** Solid components hold no business state. They observe `actor.currentView` to know what to render, and `actor.currentRoute` to reflect the active path.
-3. **Signal-Only Reactivity:** Instead of React-like re-renders, Solid uses `createEffect` internally within the `RouterBridge` to react precisely when signals update.
-
-## Watcher Lifecycle and Cleanup Contract
-
-This demo follows the canonical watcher lifecycle:
-
-1. `notify`
-2. `queueMicrotask`
-3. `getPending()`
-4. Read actor signals and update Solid-local render triggers
-5. Re-arm with `watch()`/`watch(...signals)`
-
-Watcher notifications are one-shot. Cleanup is explicit and lifecycle-bound: Solid teardown uses `onCleanup`, and provider/bridge teardown must call `disconnect`/`unwatch` paths rather than relying on GC-only cleanup. This is crucial to prevent memory leaks during component unmounting.
-
-## Adapter Boundaries
-
-Solid Router integration remains passive infrastructure. `RouterBridgeBase` stays the shared policy point; the Solid adapter only implements framework port behavior (calling `navigate()` and tracking `location.pathname`).
-
-## Available Scripts
-
-```bash
-npm run dev           # Start Vite dev server (default: http://localhost:5173)
-npm run build         # Build production assets
-npm run preview       # Preview production build locally
-npm run test          # Run unit/integration tests via Vitest
-npm run test:browser  # Run browser-mode tests via vitest.browser.config.ts
-```
-
-## Verification
-
-Use these checks from this directory:
-
-```bash
-npm run test
-npm run test:browser
-```
-
-Manual sanity check:
-
-1. Start the app with `npm run dev`.
-2. Open `http://localhost:5173`.
-3. Confirm login/logout transitions update both view and URL, and that accessing protected routes while logged out redirects properly.
-
-## Learn More
-
-- [Solid Router package README](../play-solid-router/README.md)
-- [TanStack Solid Router demo README](../play-tanstack-solid-router-demo/README.md)
-- [TanStack React Router demo README](../play-tanstack-react-router-demo/README.md)

package/api/@xmachines/play-tanstack-react-router/functions/PlayRouterProvider.md

@@ -1,19 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / PlayRouterProvider
-
-# Function: PlayRouterProvider()
-
-```ts
-function PlayRouterProvider(__namedParameters): Element;
-```
-
-Defined in: [play-tanstack-react-router/src/play-router-provider.tsx:38](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/play-router-provider.tsx#L38)
-
-## Parameters
-
-| Parameter           | Type                                                                  |
-| ------------------- | --------------------------------------------------------------------- |
-| `__namedParameters` | [`PlayRouterProviderProps`](../interfaces/PlayRouterProviderProps.md) |
-
-## Returns
-
-`Element`

package/api/@xmachines/play-tanstack-react-router/functions/extractParams.md

@@ -1,38 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / extractParams
-
-# Function: extractParams()
-
-```ts
-function extractParams(pathname, pattern): Record<string, string>;
-```
-
-Defined in: [play-tanstack-react-router/src/extract-params.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/extract-params.ts#L29)
-
-Extract route parameters from URL path based on route pattern using URLPattern API
-
-## Parameters
-
-| Parameter  | Type     | Description                                          |
-| ---------- | -------- | ---------------------------------------------------- |
-| `pathname` | `string` | Actual URL path (e.g., "/profile/123")               |
-| `pattern`  | `string` | Route pattern with params (e.g., "/profile/:userId") |
-
-## Returns
-
-`Record`\<`string`, `string`\>
-
-Object with extracted parameters
-
-## Example
-
-```typescript
-extractParams("/profile/123", "/profile/:userId");
-// Returns: { userId: "123" }
-
-extractParams("/api/123", "/api/:id(\\d+)");
-// Returns: { id: "123" }
-// Validates numeric constraint via URLPattern
-
-extractParams("/docs/intro", "/docs/*");
-// Returns: { "0": "intro" }
-```

package/api/@xmachines/play-tanstack-react-router/functions/extractQueryParams.md

@@ -1,33 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / extractQueryParams
-
-# Function: extractQueryParams()
-
-```ts
-function extractQueryParams(search): Record<string, string>;
-```
-
-Defined in: [play-tanstack-react-router/src/extract-params.ts:68](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/packages/play-tanstack-react-router/src/extract-params.ts#L68)
-
-Extract query parameters from search string
-
-## Parameters
-
-| Parameter | Type     | Description                                                                      |
-| --------- | -------- | -------------------------------------------------------------------------------- |
-| `search`  | `string` | Query string with or without leading ? (e.g., "?tab=settings" or "tab=settings") |
-
-## Returns
-
-`Record`\<`string`, `string`\>
-
-Object mapping query parameter names to values
-
-## Example
-
-```typescript
-extractQueryParams("?tab=settings&theme=dark");
-// Returns: { tab: "settings", theme: "dark" }
-
-extractQueryParams("q=hello%20world");
-// Returns: { q: "hello world" } (auto-decoded)
-```

package/api/@xmachines/play-tanstack-react-router/variables/extractMachineRoutes.md

@@ -1,64 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-tanstack-react-router](../README.md) / extractMachineRoutes
-
-# Variable: extractMachineRoutes
-
-```ts
-const extractMachineRoutes: (machine) => RouteTree;
-```
-
-Defined in: play-router/dist/extract-routes.d.ts:40
-
-Extract complete route tree from state machine graph
-
-Crawls machine starting from root, visits all state nodes (including nested
-and parallel), extracts meta.route metadata, validates route references,
-and builds hierarchical tree.
-
-## Parameters
-
-| Parameter | Type              | Description             |
-| --------- | ----------------- | ----------------------- |
-| `machine` | `AnyStateMachine` | XState v5 state machine |
-
-## Returns
-
-[`RouteTree`](../../play-router/interfaces/RouteTree.md)
-
-Route tree with root, byStateId map, and byPath map
-
-## Throws
-
-If route references non-existent state
-
-## Throws
-
-If route path is malformed (doesn't start with /)
-
-## Throws
-
-If parallel states define conflicting routes
-
-## Example
-
-```typescript
-import { createMachine } from "xstate";
-import { extractMachineRoutes } from "@xmachines/play-router";
-
-const machine = createMachine({
-	initial: "home",
-	states: {
-		home: { id: "home", meta: { route: "/" } },
-		dashboard: {
-			id: "dashboard",
-			meta: { route: "/dashboard" },
-			initial: "overview",
-			states: {
-				overview: { id: "overview", meta: { route: "/overview" } },
-			},
-		},
-	},
-});
-
-const tree = extractMachineRoutes(machine);
-console.log(tree.byPath.get("/dashboard/overview"));
-```