npm - @xmachines/docs - Versions diffs - 5.0.1 → 5.0.2 - Mend

@xmachines/docs 5.0.1 → 5.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (519) hide show

package/examples/@xmachines/play-svelte-demo/functions/createAuthActionHandlers.md CHANGED Viewed

@@ -6,7 +6,7 @@
 function createAuthActionHandlers(actor): object;
 ```
-Defined in: [packages/play-actor/examples/shared/src/actions.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L48)
+Defined in: [packages/play-actor/examples/shared/src/actions.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L48)
 Build the demo action handler map for one actor.
@@ -25,11 +25,11 @@ framework's `defineRegistry` accepts; spread the result into its `actions`.
 | Name             | Type                                                    | Defined in                                                                                                                                                               |
 | ---------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `addTask()`      | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L65) |
-| `completeTask()` | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L72) |
-| `login()`        | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L50) |
-| `logout()`       | () => `Promise`\<`void`\>                               | [packages/play-actor/examples/shared/src/actions.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L54) |
-| `removeTask()`   | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L81) |
-| `resetForm()`    | (`params`, `setState`) => `Promise`\<`void`\>           | [packages/play-actor/examples/shared/src/actions.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L99) |
-| `route()`        | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L55) |
-| `submitForm()`   | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L92) |
+| `addTask()`      | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L65) |
+| `completeTask()` | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L72) |
+| `login()`        | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L50) |
+| `logout()`       | () => `Promise`\<`void`\>                               | [packages/play-actor/examples/shared/src/actions.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L54) |
+| `removeTask()`   | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L81) |
+| `resetForm()`    | (`params`, `setState`) => `Promise`\<`void`\>           | [packages/play-actor/examples/shared/src/actions.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L99) |
+| `route()`        | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L55) |
+| `submitForm()`   | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L92) |

package/examples/@xmachines/play-svelte-demo/type-aliases/AuthCatalog.md CHANGED Viewed

@@ -6,4 +6,4 @@
 type AuthCatalog = typeof authCatalog;
 ```
-Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/catalog.ts#L6)
+Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/catalog.ts#L6)

package/examples/@xmachines/play-svelte-demo/variables/authCatalog.md CHANGED Viewed

@@ -281,4 +281,4 @@ const authCatalog: Catalog<
 >;
 ```
-Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/catalog.ts#L5)
+Defined in: [packages/play-svelte/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/catalog.ts#L5)

package/examples/@xmachines/play-svelte-demo/variables/demoComponents.md CHANGED Viewed

@@ -6,7 +6,7 @@
 const demoComponents: object;
 ```
-Defined in: [packages/play-svelte/examples/demo/src/components/demo-components.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L20)
+Defined in: [packages/play-svelte/examples/demo/src/components/demo-components.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L20)
 demoComponents — the full catalog component map, shared with the router demos.
@@ -14,17 +14,17 @@ demoComponents — the full catalog component map, shared with the router demos.
 | Name                                          | Type                  | Default value | Defined in                                                                                                                                                                                                   |
 | --------------------------------------------- | --------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| <a id="property-about"></a> `About`           | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L22) |
-| <a id="property-button"></a> `Button`         | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L34) |
-| <a id="property-contact"></a> `Contact`       | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L23) |
-| <a id="property-dashboard"></a> `Dashboard`   | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L25) |
-| <a id="property-field"></a> `Field`           | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L33) |
-| <a id="property-home"></a> `Home`             | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L21) |
-| <a id="property-login"></a> `Login`           | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L24) |
-| <a id="property-navbar"></a> `NavBar`         | `LegacyComponentType` | `NavBarView`  | [packages/play-svelte/examples/demo/src/components/demo-components.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L31) |
-| <a id="property-navigation"></a> `Navigation` | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L30) |
-| <a id="property-overview"></a> `Overview`     | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L26) |
-| <a id="property-panel"></a> `Panel`           | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L32) |
-| <a id="property-profile"></a> `Profile`       | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L28) |
-| <a id="property-settings"></a> `Settings`     | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L29) |
-| <a id="property-stats"></a> `Stats`           | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-svelte/examples/demo/src/components/demo-components.ts#L27) |
+| <a id="property-about"></a> `About`           | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L22) |
+| <a id="property-button"></a> `Button`         | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L34) |
+| <a id="property-contact"></a> `Contact`       | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L23) |
+| <a id="property-dashboard"></a> `Dashboard`   | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L25) |
+| <a id="property-field"></a> `Field`           | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:33](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L33) |
+| <a id="property-home"></a> `Home`             | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L21) |
+| <a id="property-login"></a> `Login`           | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:24](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L24) |
+| <a id="property-navbar"></a> `NavBar`         | `LegacyComponentType` | `NavBarView`  | [packages/play-svelte/examples/demo/src/components/demo-components.ts:31](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L31) |
+| <a id="property-navigation"></a> `Navigation` | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L30) |
+| <a id="property-overview"></a> `Overview`     | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L26) |
+| <a id="property-panel"></a> `Panel`           | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L32) |
+| <a id="property-profile"></a> `Profile`       | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L28) |
+| <a id="property-settings"></a> `Settings`     | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L29) |
+| <a id="property-stats"></a> `Stats`           | `LegacyComponentType` | -             | [packages/play-svelte/examples/demo/src/components/demo-components.ts:27](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-svelte/examples/demo/src/components/demo-components.ts#L27) |

package/examples/@xmachines/play-svelte-spa-router-demo/README.md CHANGED Viewed

@@ -102,7 +102,7 @@ One subscription lives for the whole watch, and no caller arms a watcher again.
 ## Adapter Boundaries
-`connectRouter` (from [`@xmachines/play-svelte-spa-router`](../../../api/@xmachines/play-svelte-spa-router/README.md)) is passive infrastructure. It translates hash URL changes into `play.route` events and reflects actor-approved route changes back to the URL. Business validity remains actor-owned. The shared `Shell.svelte` from `@xmachines/play-svelte-demo` is reused to avoid duplicating view components across router demos.
+`connectRouter` (from [`@xmachines/play-svelte-spa-router`](../../../api/@xmachines/play-svelte-spa-router/README.md)) is passive infrastructure. It translates hash URL changes into `play.route` events and reflects actor-approved route changes back to the URL. Business validity remains actor-owned. The shared `Shell.svelte` from [`@xmachines/play-svelte-demo`](../play-svelte-demo/README.md) is reused to avoid duplicating view components across router demos.
 ## Available Scripts

package/examples/@xmachines/play-sveltekit-router-demo/README.md CHANGED Viewed

@@ -104,7 +104,7 @@ One subscription lives for the whole watch, and no caller arms a watcher again.
 ## Adapter Boundaries
-`connectRouter` (from [`@xmachines/play-sveltekit-router`](../../../api/@xmachines/play-sveltekit-router/README.md)) is passive infrastructure. It translates pathname URL changes into `play.route` events and reflects actor-approved route changes back to the browser pathname. Business validity remains actor-owned. The shared `Shell.svelte` from `@xmachines/play-svelte-demo` is reused to avoid duplicating view components across router demos.
+`connectRouter` (from [`@xmachines/play-sveltekit-router`](../../../api/@xmachines/play-sveltekit-router/README.md)) is passive infrastructure. It translates pathname URL changes into `play.route` events and reflects actor-approved route changes back to the browser pathname. Business validity remains actor-owned. The shared `Shell.svelte` from [`@xmachines/play-svelte-demo`](../play-svelte-demo/README.md) is reused to avoid duplicating view components across router demos.
 The `$app/navigation` module is shimmed by `src/lib/navigation.ts` using the History API, so the demo runs outside a full SvelteKit project (plain Vite dev server and production build).

package/examples/@xmachines/play-tanstack-react-router-demo/README.md CHANGED Viewed

@@ -33,7 +33,7 @@ Use this order to understand the implementation:
 2. `src/App.tsx` calls `useMemo(createAppRuntime, [])` to create the actor from the shared machine and start it once per mounted app.
 3. `src/runtime.ts` exports `inspector` (via `createDemoInspector()`), `createPlayer` (via `definePlayer`, with `options.inspect` wired to the inspector), `routeMap` (via `createRouteMap(authMachine)`), and `createRegistryResult` which binds UI components and actor event actions.
 4. `createAppRuntime()` constructs a TanStack `createRootRoute`/`createRouter` instance, then `PlayRouterProvider` bridges it to the actor and renders `Shell` via `renderer(actor, router)`.
-5. `Shell` is the shared demo layout component imported from `@xmachines/play-react-demo` (defined in `packages/play-react/examples/demo/src/components/Shell.tsx`, a workspace-only package). It renders `PlayUIProvider` + `PlayRenderer`, header/nav, and the debug panel — including the **Show Inspector** button — from actor state.
+5. `Shell` is the shared demo layout component imported from [`@xmachines/play-react-demo`](../play-react-demo/README.md) (defined in `packages/play-react/examples/demo/src/components/Shell.tsx`, a workspace-only package). It renders `PlayUIProvider` + `PlayRenderer`, header/nav, and the debug panel — including the **Show Inspector** button — from actor state.
 6. Tests in `test/` and `test/browser/` validate invariant and runtime behavior.
 ```tsx

package/examples/@xmachines/play-tanstack-solid-router-demo/README.md CHANGED Viewed

@@ -34,7 +34,7 @@ Use this order to understand the implementation:
 2. `src/runtime.ts` initializes the actor, builds the registry, and creates the route map using `createRouteMap(authMachine)`.
 3. `src/App.tsx` constructs the TanStack Router route tree from machine routes and wires `PlayRouterProvider` with the actor, router, and route map from `runtime.ts`.
 4. Router infrastructure stays passive: it forwards navigation intent to the actor via the `PlayRouterProvider` and reflects actor-approved route changes back to TanStack.
-5. `Shell` (from `@xmachines/play-solid-demo`) renders actor-projected state (`PlayRenderer`), emits actor events via the `registryResult` actions, and shows the debug panel's **Show Inspector** button.
+5. `Shell` (from [`@xmachines/play-solid-demo`](../play-solid-demo/README.md)) renders actor-projected state (`PlayRenderer`), emits actor events via the `registryResult` actions, and shows the debug panel's **Show Inspector** button.
 6. `test/library-pattern.test.ts` plus `test/browser/` verify invariants and browser routing behavior.
 ```tsx

package/examples/@xmachines/play-vue-demo/functions/createAuthActionHandlers.md CHANGED Viewed

@@ -6,7 +6,7 @@
 function createAuthActionHandlers(actor): object;
 ```
-Defined in: [packages/play-actor/examples/shared/src/actions.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L48)
+Defined in: [packages/play-actor/examples/shared/src/actions.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L48)
 Build the demo action handler map for one actor.
@@ -25,11 +25,11 @@ framework's `defineRegistry` accepts; spread the result into its `actions`.
 | Name             | Type                                                    | Defined in                                                                                                                                                               |
 | ---------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `addTask()`      | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L65) |
-| `completeTask()` | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L72) |
-| `login()`        | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L50) |
-| `logout()`       | () => `Promise`\<`void`\>                               | [packages/play-actor/examples/shared/src/actions.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L54) |
-| `removeTask()`   | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L81) |
-| `resetForm()`    | (`params`, `setState`) => `Promise`\<`void`\>           | [packages/play-actor/examples/shared/src/actions.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L99) |
-| `route()`        | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L55) |
-| `submitForm()`   | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-actor/examples/shared/src/actions.ts#L92) |
+| `addTask()`      | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:65](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L65) |
+| `completeTask()` | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:72](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L72) |
+| `login()`        | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L50) |
+| `logout()`       | () => `Promise`\<`void`\>                               | [packages/play-actor/examples/shared/src/actions.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L54) |
+| `removeTask()`   | (`params`, `_setState`, `state`) => `Promise`\<`void`\> | [packages/play-actor/examples/shared/src/actions.ts:81](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L81) |
+| `resetForm()`    | (`params`, `setState`) => `Promise`\<`void`\>           | [packages/play-actor/examples/shared/src/actions.ts:99](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L99) |
+| `route()`        | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L55) |
+| `submitForm()`   | (`params?`) => `Promise`\<`void`\>                      | [packages/play-actor/examples/shared/src/actions.ts:92](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-actor/examples/shared/src/actions.ts#L92) |

package/examples/@xmachines/play-vue-demo/type-aliases/AuthCatalog.md CHANGED Viewed

@@ -6,4 +6,4 @@
 type AuthCatalog = typeof authCatalog;
 ```
-Defined in: [packages/play-vue/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-vue/examples/demo/src/catalog.ts#L6)
+Defined in: [packages/play-vue/examples/demo/src/catalog.ts:6](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue/examples/demo/src/catalog.ts#L6)

package/examples/@xmachines/play-vue-demo/variables/App.md CHANGED Viewed

@@ -6,4 +6,4 @@
 const App: DefineComponent<{}, {}, unknown>;
 ```
-Defined in: [packages/play-vue/examples/demo/src/env.d.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-vue/examples/demo/src/env.d.ts#L5)
+Defined in: [packages/play-vue/examples/demo/src/env.d.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue/examples/demo/src/env.d.ts#L5)

package/examples/@xmachines/play-vue-demo/variables/authCatalog.md CHANGED Viewed

@@ -281,4 +281,4 @@ const authCatalog: Catalog<
 >;
 ```
-Defined in: [packages/play-vue/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-vue/examples/demo/src/catalog.ts#L5)
+Defined in: [packages/play-vue/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue/examples/demo/src/catalog.ts#L5)

package/examples/@xmachines/play-vue-demo/variables/demoComponents.md CHANGED Viewed

@@ -6,6 +6,6 @@
 const demoComponents: ComponentsMap<typeof authCatalog>;
 ```
-Defined in: [packages/play-vue/examples/demo/src/components/demo-components.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-vue/examples/demo/src/components/demo-components.ts#L22)
+Defined in: [packages/play-vue/examples/demo/src/components/demo-components.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.2/packages/play-vue/examples/demo/src/components/demo-components.ts#L22)
 demoComponents — the full catalog component map, shared with the router demos.

package/examples/form-validation.md CHANGED Viewed

@@ -288,11 +288,14 @@ actor.start();
 const disconnect = mount(actor, document.getElementById("app")!);
-// Cleanup
-window.addEventListener("beforeunload", () => {
+// Call teardown() when the app ends before the page does, for example when the component
+// that holds it unmounts. At the end of the page, do nothing: the browser frees the page.
+// A teardown on `beforeunload` also runs when the page goes into the back/forward cache,
+// and Back then shows a page that does not respond.
+function teardown(): void {
 	disconnect();
 	actor.stop();
-});
+}
 ```
 **Key points:**

package/examples/multi-router-integration.md CHANGED Viewed

@@ -300,13 +300,16 @@ const registryResult = defineRegistry(authCatalog, {
 const mount = createPlayUI(registryResult);
 const disconnectRenderer = mount(actor, document.getElementById("app")!);
-// Cleanup
-window.addEventListener("beforeunload", () => {
+// Call teardown() when the app ends before the page does, for example when the component
+// that holds it unmounts. At the end of the page, do nothing: the browser frees the page.
+// A teardown on `beforeunload` also runs when the page goes into the back/forward cache,
+// and Back then shows a page that does not respond.
+function teardown(): void {
 	disconnect();
 	router.destroy();
 	disconnectRenderer();
 	actor.stop();
-});
+}
 ```
 ### SvelteKit (`@xmachines/play-sveltekit-router`)

package/examples/routing-patterns.md CHANGED Viewed

@@ -256,11 +256,14 @@ const router = createRouter({ routeTree: authMachine, history });
 // - browser URL changes → play.route event sent to actor
 const disconnect = connectRouter({ actor, router, routeMap });
-// Cleanup on unload
-window.addEventListener("beforeunload", () => {
+// Call teardown() when the app ends before the page does, for example when the component
+// that holds it unmounts. At the end of the page, do nothing: the browser frees the page.
+// A teardown on `beforeunload` also runs when the page goes into the back/forward cache,
+// and Back then shows a page that does not respond.
+function teardown(): void {
 	disconnect();
 	router.destroy();
-});
+}
 ```
 ## React Router Setup

package/guides/getting-started.md CHANGED Viewed

@@ -457,12 +457,15 @@ actor.start();
 const disconnectRouter = connectRouter({ actor, router, routeMap });
-// Cleanup on unload
-window.addEventListener("beforeunload", () => {
+// Call teardown() when the app ends before the page does, for example when the component
+// that holds it unmounts. At the end of the page, do nothing: the browser frees the page.
+// A teardown on `beforeunload` also runs when the page goes into the back/forward cache,
+// and Back then shows a page that does not respond.
+function teardown(): void {
 	disconnectRouter();
 	router.destroy();
 	actor.stop();
-});
+}
 ```
 ---
@@ -634,7 +637,8 @@ const registryResult = defineRegistry(catalog, {
 const mount = createPlayUI(registryResult);
 const disconnect = mount(actor, document.getElementById("app")!);
-window.addEventListener("beforeunload", () => disconnect());
+// Call disconnect() when the app ends before the page does, for example when the component
+// that holds it unmounts. At the end of the page, do nothing: the browser frees the page.
 ```
 ---

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@xmachines/docs",
-  "version": "5.0.1",
+  "version": "5.0.2",
   "description": "Documentation for XMachines",
   "keywords": [
     "documentation",
@@ -50,6 +50,7 @@
     "format": "oxfmt .",
     "format:check": "oxfmt --check .",
     "typedoc": "typedoc",
+    "test:generated": "vitest run --config vitest.generated.config.ts",
     "test": "vitest run",
     "clean": "rm -rf coverage node_modules/.vite*"
   },

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

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

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

@@ -1,20 +0,0 @@
-[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/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-react/examples/demo/src/components/DebugPanel.tsx#L5)
-## Parameters
-| Parameter                 | Type                        |
-| ------------------------- | --------------------------- |
-| `__namedParameters`       | \{ `actor`: `AuthActor`; \} |
-| `__namedParameters.actor` | `AuthActor`                 |
-## Returns
-`Element`

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

@@ -1,20 +0,0 @@
-[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/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-react/examples/demo/src/components/HeaderNav.tsx#L13)
-## Parameters
-| Parameter                 | Type                        |
-| ------------------------- | --------------------------- |
-| `__namedParameters`       | \{ `actor`: `AuthActor`; \} |
-| `__namedParameters.actor` | `AuthActor`                 |
-## Returns
-`Element`

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

@@ -1,22 +0,0 @@
-[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/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-react/examples/demo/src/components/Shell.tsx#L14)
-## Parameters
-| Parameter                    | Type                                                                               | Description                                                                      |
-| ---------------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
-| `__namedParameters`          | \{ `actor`: `AuthActor`; `registry`: `ComponentRegistry`; `router?`: `unknown`; \} | -                                                                                |
-| `__namedParameters.actor`    | `AuthActor`                                                                        | -                                                                                |
-| `__namedParameters.registry` | `ComponentRegistry`                                                                | -                                                                                |
-| `__namedParameters.router?`  | `unknown`                                                                          | Bridged router instance — accepted for prop parity with router demos but unused. |
-## Returns
-`Element`

package/examples/@xmachines/play-solid-demo/functions/App.md DELETED Viewed

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

package/examples/@xmachines/play-solid-demo/functions/DebugPanel.md DELETED Viewed

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

package/examples/@xmachines/play-solid-demo/functions/HeaderNav.md DELETED Viewed

@@ -1,20 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-solid-demo](../README.md) / HeaderNav
-# Function: HeaderNav()
-```ts
-function HeaderNav(props): Element;
-```
-Defined in: [components/HeaderNav.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/c1160fb00ac900a09815213d9ed6bef8b9f03da6/packages/play-solid/examples/demo/src/components/HeaderNav.tsx#L5)
-## Parameters
-| Parameter     | Type                        |
-| ------------- | --------------------------- |
-| `props`       | \{ `actor`: `AuthActor`; \} |
-| `props.actor` | `AuthActor`                 |
-## Returns
-`Element`

package/examples/@xmachines/play-solid-demo/functions/Shell.md DELETED Viewed

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