@xmachines/docs 1.0.0-beta.27 → 1.0.0-beta.29

package/examples/@xmachines/play-react-demo/README.md

@@ -0,0 +1,173 @@
+[Documentation](../../README.md) / @xmachines/play-react-demo
+
+# React Demo
+
+React renderer demo for `@xmachines/play-react` — actor + `PlayRenderer` without a router.
+
+## What This Demonstrates
+
+- Shared auth machine reused without framework-specific business logic
+- `PlayRenderer` rendering actor-projected views with a typed `defineRegistry` catalog
+- Auth machine states drive view switching via `auth.login` / `auth.logout` events only — no `play.route` routing
+- Canonical TC39 Signals lifecycle surfaced through React's rendering model
+- Non-browser invariant tests plus browser renderer coverage
+
+## Running the Demo
+
+From the repository root:
+
+```bash
+npm install
+npm run dev -w @xmachines/play-react-demo
+```
+
+Then open `http://localhost:5173`.
+
+## Step-by-Step Code Flow
+
+Use this order to understand the implementation:
+
+1. `src/main.tsx` mounts `<App />` inside `<StrictMode>`.
+2. `src/App.tsx` creates the actor via `definePlayer({ machine: authMachine })` inside `useMemo` so it is started once per mounted app.
+3. `defineRegistry(authCatalog, { components, actions })` builds the typed component registry from the shared catalog.
+4. `<PlayRenderer actor={actor} registry={registry} actions={...} />` observes actor view signals and renders the current component.
+5. A `useEffect` cleanup calls `actor.stop()` on unmount.
+6. Browser tests in `test/browser/` validate startup and interaction behavior.
+
+```tsx
+// src/main.tsx (shape)
+createRoot(document.getElementById("root")!).render(
+	<StrictMode>
+		<App />
+	</StrictMode>,
+);
+```
+
+```tsx
+// src/App.tsx (shape)
+const createPlayer = definePlayer({ machine: authMachine });
+
+const { registry } = defineRegistry(authCatalog, {
+	components: {
+		Home,
+		About,
+		Contact,
+		Login,
+		Dashboard,
+		Overview,
+		Stats,
+		Profile,
+		Settings,
+		Navigation,
+	},
+	actions: { login: async () => {}, logout: async () => {} },
+});
+
+export function App() {
+	const actor = useMemo((): DemoActor => {
+		const a = createPlayer();
+		a.start();
+		return a;
+	}, []);
+
+	useEffect(
+		() => () => {
+			actor.stop();
+		},
+		[actor],
+	);
+
+	return (
+		<div className="demo-app" data-demo-shell>
+			<main className="demo-content" data-demo-content>
+				<PlayRenderer
+					actor={actor}
+					registry={registry}
+					actions={{ login: "auth.login", logout: "auth.logout" }}
+				/>
+			</main>
+			<DebugPanel actor={actor} />
+		</div>
+	);
+}
+```
+
+## Key Files
+
+- `src/main.tsx` - React entry point that mounts `<App />` inside `StrictMode`
+- `src/App.tsx` - actor lifecycle, registry construction, and `PlayRenderer` composition
+- `src/components/` - demo view components bound to catalog component keys (Home, Login, Dashboard, Profile, etc.)
+- `test/library-pattern.test.ts` - architecture boundary and invariant assertions
+- `test/browser/renderer-demo.browser.test.tsx` - browser-mode renderer coverage
+
+## State Machine & Architecture Details
+
+The demo utilizes XMachines architectural invariants:
+
+1. **Actor Authority:** View components dispatch `auth.login` and `auth.logout` events to the actor. The actor evaluates guards and transitions — React never decides which view to render.
+2. **Passive Infrastructure:** `PlayRenderer` observes `actor.currentView` signals only. It holds no business state and makes no routing decisions.
+3. **Signal-Only Reactivity:** The bridge leverages React's rendering model to react precisely when actor signals update, without polluting the component tree with `useState` or `useEffect` for business logic.
+
+## Watcher Lifecycle and Cleanup Contract
+
+This demo follows the canonical watcher lifecycle used across all `@xmachines` framework adapters:
+
+1. `notify`
+2. `queueMicrotask`
+3. `getPending()`
+4. Read actor signals and project React render state
+5. Re-arm with `watch()`/`watch(...signals)`
+
+Watcher notifications are one-shot. Cleanup is explicit: `actor.stop()` is called on component unmount via `useEffect`, and `PlayRenderer` handles internal watcher teardown natively.
+
+## Adapter Boundaries
+
+`PlayRenderer` and `defineRegistry` stay passive infrastructure. Business validity remains actor-owned. The registry maps catalog component keys to React component implementations — the actor owns which key is active. The demo intentionally omits URL routing to isolate the renderer contract.
+
+## Available Scripts
+
+These commands are defined in `package.json`:
+
+| Command                                              | Description                      |
+| ---------------------------------------------------- | -------------------------------- |
+| `npm run dev -w @xmachines/play-react-demo`          | Start Vite dev server            |
+| `npm run build -w @xmachines/play-react-demo`        | Build production bundle          |
+| `npm run preview -w @xmachines/play-react-demo`      | Preview built bundle             |
+| `npm run test -w @xmachines/play-react-demo`         | Run Vitest test suite            |
+| `npm run test:browser -w @xmachines/play-react-demo` | Run browser-focused Vitest suite |
+
+## Verification
+
+Use these checks to validate README claims against the current demo implementation:
+
+```bash
+npm run test -w @xmachines/play-react-demo
+npm run test:browser -w @xmachines/play-react-demo
+```
+
+Expected result: library-pattern invariant tests pass and the browser renderer suite completes.
+
+## Learn More
+
+- [React package README](../../README.md)
+- [React Router demo README](../../../play-react-router/examples/demo/README.md)
+
+## Variables
+
+- [About](variables/About.md)
+- [Contact](variables/Contact.md)
+- [Dashboard](variables/Dashboard.md)
+- [Home](variables/Home.md)
+- [Login](variables/Login.md)
+- [Navigation](variables/Navigation.md)
+- [Overview](variables/Overview.md)
+- [Profile](variables/Profile.md)
+- [Settings](variables/Settings.md)
+- [Stats](variables/Stats.md)
+
+## Functions
+
+- [App](functions/App.md)
+- [DebugPanel](functions/DebugPanel.md)
+- [HeaderNav](functions/HeaderNav.md)
+- [Shell](functions/Shell.md)

package/examples/@xmachines/play-react-demo/functions/App.md

@@ -0,0 +1,13 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / App
+
+# Function: App()
+
+```ts
+function App(): Element;
+```
+
+Defined in: [App.tsx:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/App.tsx#L54)
+
+## Returns
+
+`Element`

package/examples/@xmachines/play-react-demo/functions/DebugPanel.md

@@ -0,0 +1,20 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / DebugPanel
+
+# Function: DebugPanel()
+
+```ts
+function DebugPanel(__namedParameters): Element;
+```
+
+Defined in: [components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/DebugPanel.tsx#L5)
+
+## Parameters
+
+| Parameter                 | Type                                                                             |
+| ------------------------- | -------------------------------------------------------------------------------- |
+| `__namedParameters`       | \{ `actor`: [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md); \} |
+| `__namedParameters.actor` | [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md)                 |
+
+## Returns
+
+`Element`

package/examples/@xmachines/play-react-demo/functions/HeaderNav.md

@@ -0,0 +1,20 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / HeaderNav
+
+# Function: HeaderNav()
+
+```ts
+function HeaderNav(__namedParameters): Element;
+```
+
+Defined in: [components/HeaderNav.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/HeaderNav.tsx#L13)
+
+## Parameters
+
+| Parameter                 | Type                                                                             |
+| ------------------------- | -------------------------------------------------------------------------------- |
+| `__namedParameters`       | \{ `actor`: [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md); \} |
+| `__namedParameters.actor` | [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md)                 |
+
+## Returns
+
+`Element`

package/examples/@xmachines/play-react-demo/functions/Shell.md

@@ -0,0 +1,22 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Shell
+
+# Function: Shell()
+
+```ts
+function Shell(__namedParameters): Element;
+```
+
+Defined in: [components/Shell.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Shell.tsx#L14)
+
+## Parameters
+
+| Parameter                    | Type                                                                                                                                    | Description                                                                      |
+| ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| `__namedParameters`          | \{ `actor`: [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md); `registry`: `ComponentRegistry`; `router?`: `unknown`; \} | -                                                                                |
+| `__namedParameters.actor`    | [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md)                                                                        | -                                                                                |
+| `__namedParameters.registry` | `ComponentRegistry`                                                                                                                     | -                                                                                |
+| `__namedParameters.router?`  | `unknown`                                                                                                                               | Bridged router instance — accepted for prop parity with router demos but unused. |
+
+## Returns
+
+`Element`

package/examples/@xmachines/play-react-demo/variables/About.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / About
+
+# Variable: About
+
+```ts
+const About: ComponentFn<AuthCatalog, "About">;
+```
+
+Defined in: [components/About.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/About.tsx#L11)

package/examples/@xmachines/play-react-demo/variables/Contact.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Contact
+
+# Variable: Contact
+
+```ts
+const Contact: ComponentFn<AuthCatalog, "Contact">;
+```
+
+Defined in: [components/Contact.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Contact.tsx#L11)

package/examples/@xmachines/play-react-demo/variables/Dashboard.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Dashboard
+
+# Variable: Dashboard
+
+```ts
+const Dashboard: ComponentFn<AuthCatalog, "Dashboard">;
+```
+
+Defined in: [components/Dashboard.tsx:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Dashboard.tsx#L15)

package/examples/@xmachines/play-react-demo/variables/Home.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Home
+
+# Variable: Home
+
+```ts
+const Home: ComponentFn<AuthCatalog, "Home">;
+```
+
+Defined in: [components/Home.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Home.tsx#L11)

package/examples/@xmachines/play-react-demo/variables/Login.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Login
+
+# Variable: Login
+
+```ts
+const Login: ComponentFn<AuthCatalog, "Login">;
+```
+
+Defined in: [components/Login.tsx:16](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Login.tsx#L16)

package/examples/@xmachines/play-react-demo/variables/Navigation.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Navigation
+
+# Variable: Navigation
+
+```ts
+const Navigation: ComponentFn<AuthCatalog, "Navigation">;
+```
+
+Defined in: [components/Navigation.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Navigation.tsx#L11)

package/examples/@xmachines/play-react-demo/variables/Overview.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Overview
+
+# Variable: Overview
+
+```ts
+const Overview: ComponentFn<AuthCatalog, "Overview">;
+```
+
+Defined in: [components/Overview.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Overview.tsx#L11)

package/examples/@xmachines/play-react-demo/variables/Profile.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Profile
+
+# Variable: Profile
+
+```ts
+const Profile: ComponentFn<AuthCatalog, "Profile">;
+```
+
+Defined in: [components/Profile.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Profile.tsx#L14)

package/examples/@xmachines/play-react-demo/variables/Settings.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Settings
+
+# Variable: Settings
+
+```ts
+const Settings: ComponentFn<AuthCatalog, "Settings">;
+```
+
+Defined in: [components/Settings.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Settings.tsx#L14)

package/examples/@xmachines/play-react-demo/variables/Stats.md

@@ -0,0 +1,9 @@
+[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Stats
+
+# Variable: Stats
+
+```ts
+const Stats: ComponentFn<AuthCatalog, "Stats">;
+```
+
+Defined in: [components/Stats.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-react/examples/demo/src/components/Stats.tsx#L11)

package/{api → examples}/@xmachines/play-react-router-demo/README.md

@@ -18,7 +18,7 @@ From the repository root:
 
 ```bash
 npm install
-npm run dev -w packages/play-react-router/examples/demo
+npm run dev -w @xmachines/play-react-router-demo
 ```
 
 Then open `http://localhost:5173`.
@@ -122,26 +122,26 @@ Watcher notifications are one-shot. Cleanup is explicit: bridge/provider teardow
 
 These commands are defined in `package.json`:
 
-| Command                                                            | Description                      |
-| ------------------------------------------------------------------ | -------------------------------- |
-| `npm run dev -w packages/play-react-router/examples/demo`          | Start Vite dev server            |
-| `npm run build -w packages/play-react-router/examples/demo`        | Build production bundle          |
-| `npm run preview -w packages/play-react-router/examples/demo`      | Preview built bundle             |
-| `npm run test -w packages/play-react-router/examples/demo`         | Run Vitest test suite            |
-| `npm run test:browser -w packages/play-react-router/examples/demo` | Run browser-focused Vitest suite |
+| Command                                                     | Description                      |
+| ----------------------------------------------------------- | -------------------------------- |
+| `npm run dev -w @xmachines/play-react-router-demo`          | Start Vite dev server            |
+| `npm run build -w @xmachines/play-react-router-demo`        | Build production bundle          |
+| `npm run preview -w @xmachines/play-react-router-demo`      | Preview built bundle             |
+| `npm run test -w @xmachines/play-react-router-demo`         | Run Vitest test suite            |
+| `npm run test:browser -w @xmachines/play-react-router-demo` | Run browser-focused Vitest suite |
 
 ## Verification
 
 Use these checks to validate README claims against the current demo implementation:
 
 ```bash
-npm run test -w packages/play-react-router/examples/demo
-npm run test:browser -w packages/play-react-router/examples/demo
+npm run test -w @xmachines/play-react-router-demo
+npm run test:browser -w @xmachines/play-react-router-demo
 ```
 
 Expected result: tests pass for startup and auth-flow browser scenarios.
 
 ## Learn More
 
-- [React Router package README](../play-react-router/README.md)
-- [React package README](../play-react/README.md)
+- [React Router package README](../../README.md)
+- [React package README](../../../play-react/README.md)

package/examples/@xmachines/play-router-shared/README.md

@@ -0,0 +1,111 @@
+[Documentation](../../README.md) / @xmachines/play-router-shared
+
+# play-router Shared Demo Package
+
+Shared routing test fixtures for `@xmachines` router adapter demos — route extraction, route map resolution, and portable browser test helpers.
+
+## What This Demonstrates
+
+- `extractMachineRoutes` correctly extracts public, protected, and nested routes from `authMachine`
+- `createRouteMap` resolves concrete URLs to actor state IDs and URL params
+- `play.route` events drive the actor to the correct routed states
+- Portable `defineSharedDemoBrowserSuite` browser test helper consumed by all router demos
+
+## Running the Demo
+
+This is a shared fixture package — it has no standalone dev server. Run its tests from the repository root:
+
+```bash
+npm install
+npm run test -w @xmachines/play-router-shared
+```
+
+## Step-by-Step Code Flow
+
+Use this order to understand the package structure:
+
+1. `test/auth-machine-routing.test.ts` imports `authMachine` from `@xmachines/play-actor-shared` and verifies route extraction, route map resolution, param preservation, and `play.route`-driven actor transitions.
+2. `test/demo-browser-suite.ts` exports `defineSharedDemoBrowserSuite` — a comprehensive browser test helper that covers the full auth flow: home → about → contact → login → dashboard → settings → profile → logout.
+3. Router adapter demos import `defineSharedDemoBrowserSuite` (aliased as `defineRouterDemoBrowserSuite`) to mount their app and run the canonical flow against the shared test assertions.
+
+```ts
+// test/auth-machine-routing.test.ts (shape)
+const tree = extractMachineRoutes(authMachine);
+const routeMap = createRouteMap(extractMachineRoutes(authMachine));
+
+// URL → state ID
+expect(routeMap.resolve("/").to).toBe("#home");
+expect(routeMap.resolve("/dashboard/overview").to).toBe("#dashboard-overview");
+
+// URL → params
+expect(routeMap.resolve("/profile/alice")?.params).toEqual({ username: "alice" });
+
+// play.route events drive actor state
+actor.send({ type: "play.route", to: "#about" });
+expect(snapshot.matches("about")).toBe(true);
+```
+
+```ts
+// test/demo-browser-suite.ts (shape)
+export function defineSharedDemoBrowserSuite({ mountApp }) {
+	test("shared demo flow covers public, auth, protected, and logout routes", async () => {
+		const cleanup = await mountApp();
+		// Navigates: home → about → contact → login → dashboard → settings → profile → logout
+		// Validates: URL sync, view rendering, params, back/forward, and guard redirection
+		await cleanup?.();
+	});
+}
+
+export const defineRouterDemoBrowserSuite = defineSharedDemoBrowserSuite;
+```
+
+## Key Files
+
+- `test/auth-machine-routing.test.ts` - route extraction, route map resolution, param inheritance, and `play.route`-driven actor transitions
+- `test/demo-browser-suite.ts` - `defineSharedDemoBrowserSuite` / `defineRouterDemoBrowserSuite` portable browser test helper covering the full auth flow
+- `test/env.d.ts` - Vitest browser environment type declarations
+
+## State Machine & Architecture Details
+
+The routing tests verify XMachines architectural invariants at the routing layer:
+
+1. **Actor Authority:** `play.route` events are the only mechanism for URL-driven state transitions. The test suite verifies that actors respond correctly to these events and apply guards (e.g. protected routes redirect to login when unauthenticated).
+2. **Passive Infrastructure:** `createRouteMap` is a pure lookup structure — it maps URLs to state IDs and params but executes no business logic. The actor decides whether a resolved route is reachable from its current state.
+3. **Signal-Only Reactivity:** Route resolution is synchronous and deterministic. The browser test suite validates that URL changes produce the correct `[data-page]` DOM state, confirming that the signal-driven render loop completed.
+
+## Watcher Lifecycle and Cleanup Contract
+
+The shared test fixtures exercise teardown contracts by calling `cleanup()` at the end of each test. Each router adapter demo's `mountApp` implementation must return a cleanup function that calls `disconnectRouter()` and `actor.stop()` to satisfy this contract.
+
+## Adapter Boundaries
+
+This package has no framework imports — it only depends on `@xmachines/play-actor-shared`, `@xmachines/play-router`, and `xstate`. It defines the routing contract that all concrete router adapters must satisfy. The `defineRouterDemoBrowserSuite` export is the single source of truth for browser-level routing assertions across all adapter demos.
+
+## Available Scripts
+
+These commands are defined in `package.json`:
+
+| Command                                         | Description           |
+| ----------------------------------------------- | --------------------- |
+| `npm run test -w @xmachines/play-router-shared` | Run Vitest test suite |
+
+## Verification
+
+Use these checks to validate the shared routing invariants:
+
+```bash
+npm run test -w @xmachines/play-router-shared
+```
+
+Expected result: route extraction, URL-to-state resolution, param inheritance, and `play.route`-driven actor transition tests all pass.
+
+## Learn More
+
+- [play-router package README](../../README.md)
+- [play-actor shared README](../../../play-actor/examples/shared/README.md)
+
+## Modules
+
+- [test/auth-machine-routing.test.ts](test/auth-machine-routing.test.ts/README.md)
+- [test/demo-browser-suite.ts](test/demo-browser-suite.ts/README.md)
+- [test/env.d.ts](test/env.d.ts/README.md)

package/examples/@xmachines/play-router-shared/test/auth-machine-routing.test.ts/README.md

@@ -0,0 +1,3 @@
+[Documentation](../../../../README.md) / [@xmachines/play-router-shared](../../README.md) / test/auth-machine-routing.test.ts
+
+# test/auth-machine-routing.test.ts

package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/README.md

@@ -0,0 +1,11 @@
+[Documentation](../../../../README.md) / [@xmachines/play-router-shared](../../README.md) / test/demo-browser-suite.ts
+
+# test/demo-browser-suite.ts
+
+## Variables
+
+- [defineRouterDemoBrowserSuite](variables/defineRouterDemoBrowserSuite.md)
+
+## Functions
+
+- [defineSharedDemoBrowserSuite](functions/defineSharedDemoBrowserSuite.md)

package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/functions/defineSharedDemoBrowserSuite.md

@@ -0,0 +1,19 @@
+[Documentation](../../../../../README.md) / [@xmachines/play-router-shared](../../../README.md) / [test/demo-browser-suite.ts](../README.md) / defineSharedDemoBrowserSuite
+
+# Function: defineSharedDemoBrowserSuite()
+
+```ts
+function defineSharedDemoBrowserSuite(__namedParameters): void;
+```
+
+Defined in: [packages/play-router/examples/shared/test/demo-browser-suite.ts:75](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/examples/shared/test/demo-browser-suite.ts#L75)
+
+## Parameters
+
+| Parameter           | Type                      |
+| ------------------- | ------------------------- |
+| `__namedParameters` | `DemoBrowserSuiteOptions` |
+
+## Returns
+
+`void`

package/examples/@xmachines/play-router-shared/test/demo-browser-suite.ts/variables/defineRouterDemoBrowserSuite.md

@@ -0,0 +1,19 @@
+[Documentation](../../../../../README.md) / [@xmachines/play-router-shared](../../../README.md) / [test/demo-browser-suite.ts](../README.md) / defineRouterDemoBrowserSuite
+
+# Variable: defineRouterDemoBrowserSuite
+
+```ts
+const defineRouterDemoBrowserSuite: (__namedParameters) => void = defineSharedDemoBrowserSuite;
+```
+
+Defined in: [packages/play-router/examples/shared/test/demo-browser-suite.ts:234](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.29/packages/play-router/examples/shared/test/demo-browser-suite.ts#L234)
+
+## Parameters
+
+| Parameter           | Type                      |
+| ------------------- | ------------------------- |
+| `__namedParameters` | `DemoBrowserSuiteOptions` |
+
+## Returns
+
+`void`

package/examples/@xmachines/play-router-shared/test/env.d.ts/README.md

@@ -0,0 +1,8 @@
+[Documentation](../../../../README.md) / [@xmachines/play-router-shared](../../README.md) / test/env.d.ts
+
+# test/env.d.ts
+
+## Interfaces
+
+- [ImportMeta](interfaces/ImportMeta.md)
+- [ImportMetaEnv](interfaces/ImportMetaEnv.md)

package/examples/@xmachines/play-router-shared/test/env.d.ts/interfaces/ImportMeta.md

@@ -0,0 +1,63 @@
+[Documentation](../../../../../README.md) / [@xmachines/play-router-shared](../../../README.md) / [test/env.d.ts](../README.md) / ImportMeta
+
+# Interface: ImportMeta
+
+Defined in: `typescript`
+
+The type of `import.meta`.
+
+If you need to declare that a given property exists on `import.meta`,
+this type may be augmented via interface merging.
+
+## Properties
+
+| Property                                  | Modifier   | Type                                | Defined in |
+| ----------------------------------------- | ---------- | ----------------------------------- | ---------- |
+| <a id="property-dirname"></a> `dirname`   | `public`   | `string`                            | -          |
+| <a id="property-env"></a> `env`           | `readonly` | [`ImportMetaEnv`](ImportMetaEnv.md) | -          |
+| <a id="property-filename"></a> `filename` | `public`   | `string`                            | -          |
+| <a id="property-glob"></a> `glob`         | `public`   | `ImportGlobFunction`                | -          |
+| <a id="property-hot"></a> `hot?`          | `readonly` | `ViteHotContext`                    | -          |
+| <a id="property-main"></a> `main`         | `public`   | `boolean`                           | -          |
+| <a id="property-url"></a> `url`           | `public`   | `string`                            | -          |
+
+## Methods
+
+### resolve()
+
+#### Call Signature
+
+```ts
+resolve(specifier): string;
+```
+
+Defined in: `typescript`
+
+##### Parameters
+
+| Parameter   | Type     |
+| ----------- | -------- |
+| `specifier` | `string` |
+
+##### Returns
+
+`string`
+
+#### Call Signature
+
+```ts
+resolve(specifier, parent?): string;
+```
+
+Defined in: `@types/node`
+
+##### Parameters
+
+| Parameter   | Type              |
+| ----------- | ----------------- |
+| `specifier` | `string`          |
+| `parent?`   | `string` \| `URL` |
+
+##### Returns
+
+`string`