@xmachines/docs 7.2.0 → 7.4.0

package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteData.md

@@ -6,7 +6,7 @@
 type RouteData = Record<string, unknown>;
 ```
 
-Defined in: [packages/play-router/src/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-router/src/types.ts#L15)
+Defined in: [packages/play-router/src/types.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-router/src/types.ts#L15)
 
 The resolved extra data of a route. It reaches the consumer on the `data` field of a
 `play.route` event.

package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteDataResolver.md

@@ -6,7 +6,7 @@
 type RouteDataResolver = (args) => RouteData;
 ```
 
-Defined in: [packages/play-router/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-router/src/types.ts#L28)
+Defined in: [packages/play-router/src/types.ts:28](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-router/src/types.ts#L28)
 
 The function form of [RouteObject.data](../interfaces/RouteObject.md#property-data).
 

package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMachineConfig.md

@@ -6,7 +6,7 @@
 type RouteMachineConfig = object;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L177)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:177](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L177)
 
 The minimal structural constraint of a machine config that
 `formatPlayRouteTransitions` accepts.
@@ -32,7 +32,7 @@ original concrete type through the transform. Therefore
 context?: unknown;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L178)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:178](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L178)
 
 ---
 
@@ -42,7 +42,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:1
 on?: Record<string, unknown>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L180)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L180)
 
 ---
 
@@ -52,4 +52,4 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:1
 states?: Record<string, unknown>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:179](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L179)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:179](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L179)

package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteMetadata.md

@@ -6,6 +6,6 @@
 type RouteMetadata = string | RouteObject;
 ```
 
-Defined in: [packages/play-router/src/types.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-router/src/types.ts#L151)
+Defined in: [packages/play-router/src/types.ts:151](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-router/src/types.ts#L151)
 
 The route metadata of the `meta.route` field of a state machine.

package/api/@xmachines/play-xstate/with-routing/type-aliases/RouteStateNode.md

@@ -6,7 +6,7 @@
 type RouteStateNode = object;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
 
 The minimal structural shape of one XState state node, as
 `formatPlayRouteTransitions` reads it during its walk over the machine config.
@@ -29,7 +29,7 @@ signature without a change.
 id?: string;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L34)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L34)
 
 The optional explicit state ID, for example `"home"` or `"settings"`. It is the `#id` target of a `play.route` event.
 
@@ -41,7 +41,7 @@ The optional explicit state ID, for example `"home"` or `"settings"`. It is the
 meta?: object;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L36)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L36)
 
 The state metadata. A `meta.route` field gives the state a route.
 
@@ -64,7 +64,7 @@ generated transition, and that flag defaults to `false`.
 on?: Record<string, unknown>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L51)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L51)
 
 The event handlers of this state. The function reads them where a child asks for a
 local `play.route` handler, so that the transitions of the user survive the merge.
@@ -77,6 +77,6 @@ local `play.route` handler, so that the transitions of the user survive the merg
 states?: Record<string, RouteStateNode>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L46)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:46](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-xstate/src/routing/format-play-route-transitions.ts#L46)
 
 The nested child states. The function walks them for each further route declaration.

package/api/@xmachines/play-xstate/with-view/functions/withView.md

@@ -6,7 +6,7 @@
 function withView<TMachine>(Base): PlayerConstructor<TMachine, Viewable>;
 ```
 
-Defined in: [packages/play-xstate/src/with-view.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/play-xstate/src/with-view.ts#L61)
+Defined in: [packages/play-xstate/src/with-view.ts:61](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/play-xstate/src/with-view.ts#L61)
 
 Adds the view capability to an actor class.
 

package/api/@xmachines/runtime-wasi/README.md

@@ -0,0 +1,100 @@
+[API](../../README.md) / @xmachines/runtime-wasi
+
+# @xmachines/runtime-wasi
+
+The WASI 0.2 component of the xmachines-rs runtime, with its WIT package and the JSON Schemas of its JSON text.
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Version](https://img.shields.io/badge/version-1.2.0-blue)](https://www.npmjs.com/package/@xmachines/runtime-wasi)
+
+The component (`wasm32-wasip2`) runs XState v6 machine definitions. The host gives it the guards, the actions, the delays and the expressions. It is the build of the crate [`xmachines-runtime-wasi`](https://docs.rs/xmachines-runtime-wasi) of [xmachines-rs](https://gitlab.com/xmachin-es/xmachines-rs). The package also holds the WIT package `xmachines:runtime` of the component, and the JSON Schemas of the JSON text that the component passes.
+
+xmachines-rs is an independent runtime. It is not an official Stately package.
+
+## Installation
+
+```bash
+pnpm add @xmachines/runtime-wasi
+```
+
+## Usage
+
+The package gives each file as a URL. Node's `fs`, the bindings of Wasmtime and jco take a file URL, and a bundler resolves `new URL(…, import.meta.url)` as an asset:
+
+```ts norun
+import { component, schemas, wit } from "@xmachines/runtime-wasi";
+import { readFile } from "node:fs/promises";
+
+const bytes = await readFile(component); // the component, of the world xmachines:runtime/runtime
+const source = await readFile(wit, "utf8"); // the WIT package xmachines:runtime
+const snapshot = new URL("snapshot.schema.json", schemas);
+```
+
+The package also exports each file by its path: `@xmachines/runtime-wasi/xmachines_runtime_wasi.wasm` and `@xmachines/runtime-wasi/wit/…`.
+
+## Contract
+
+The world `xmachines:runtime/runtime` exports `actors` and the `actor` resource: `start` and `restore`, `send`, `send-to`, `advance`, `next-deadline`, `snapshot`, `persist`, the emitted events and logs, `pending-effects`, `resolve-effect` and `stop`. It imports `implementations`: `guard`, `action`, `delay`, `expr`, `context-expr` and `evaluate`.
+
+Values cross as JSON text. A JSON Schema (draft 2020-12) of `wit/schemas/` specifies each string, and the `$id` of each schema is its published place in xmachines-rs. The [README of the crate](https://docs.rs/xmachines-runtime-wasi) and the [guide to the WASI components](https://gitlab.com/xmachin-es/xmachines-rs/-/blob/main/crates/xmachines-docs/guides/wasi.md) give the rest.
+
+## The runtime that the package ships
+
+Git holds no file of the runtime. The `package.json` of the package pins it, under `xmachines.runtime`:
+
+```json
+{
+	"xmachines": {
+		"runtime": {
+			"version": "1.1.0",
+			"sha256": {
+				"wit/runtime.wit": "7c546c3b…",
+				"xmachines_runtime_wasi.wasm": "1387f1cf…"
+			}
+		}
+	}
+}
+```
+
+- `version` is the release of the xmachines-rs runtime, the tag `runtime-v<version>` of xmachines-rs.
+- `sha256` holds the SHA-256 of each file that the package ships, by its path below `dist/`: the component, and each file of the WIT package.
+
+Each release of xmachines-rs uploads two files to the generic package registry of its project, at the version of the release:
+
+- `xmachines_runtime_wasi.wasm`, the component.
+- `wit.tar.gz`, the WIT package and its JSON Schemas, which unpacks to `wit/`.
+
+The build of the package (`pnpm --filter @xmachines/runtime-wasi run build`, or the root `pnpm run build`) downloads the two files of the pinned version, unpacks the archive, and compares each file with its SHA-256 in the pin. A file that is missing, extra or changed fails the build, and the build then writes nothing. The files go into `dist/`, which git ignores. A file that `dist/` holds already, and that matches the pin, stays, so a second build downloads nothing. The tests of the package do the same before they run.
+
+The download and the check are `scripts/fetch-runtime-wasi.mjs` and `scripts/lib/runtime-wasi.mjs`, at the root of the repository.
+
+## How a bump arrives
+
+The tag pipeline of a release of xmachines-rs triggers a pipeline of xmachines-js on `main`. The trigger gives two variables: `RUNTIME_VERSION`, as `1.2.0`, and `RUNTIME_RELEASE_TYPE`, which is `major`, `minor` or `patch`. That pipeline runs one job, `runtime-wasi-bump`:
+
+1. It downloads the files of the version, and computes the SHA-256 of each file.
+2. It writes the new pin into `package.json`.
+3. It commits the pin on the branch `runtime-wasi/runtime-<version>`. The type of the release gives the type of the commit:
+    - `major`: `feat(runtime-wasi)!: the xmachines-rs runtime <version>`, with a `BREAKING CHANGE:` footer.
+    - `minor`: `feat(runtime-wasi): the xmachines-rs runtime <version>`.
+    - `patch`: `fix(runtime-wasi): the xmachines-rs runtime <version>`.
+4. It pushes the branch, with the push options that open its merge request into `main`.
+
+A branch that exists already, or a pin of the version already, ends the job with success, and the job changes nothing. The merge request runs the pipeline of every change, and its merge releases the `runtime` train.
+
+## Versions
+
+The package is the `runtime` train of xmachines-js, and the train has its own version, by its tags `runtime-v<version>`. The version of the package therefore is not the version of the runtime that it ships: `xmachines.runtime.version` of its `package.json` is. The bump of a major release of the runtime is a major release of the package, the bump of a minor release is a minor release, and the bump of a patch is a patch. The WIT package has a version of its own, which its file names.
+
+The files of the package, as URLs that a host loads them by: the WASI component of the
+xmachines-rs runtime, its WIT package, and the JSON Schemas of the JSON text that the component
+passes. Node's `fs`, the bindings of Wasmtime and jco take a file URL, and a bundler resolves
+`new URL(…, import.meta.url)` as an asset.
+
+The build puts the files into `dist/`, beside this module. Each URL names `../dist/`, so it
+resolves to the same file from `src/` (the `source` condition) and from `dist/`.
+
+## Variables
+
+- [component](variables/component.md)
+- [schemas](variables/schemas.md)
+- [wit](variables/wit.md)

package/api/@xmachines/runtime-wasi/variables/component.md

@@ -0,0 +1,11 @@
+[API](../../../README.md) / [@xmachines/runtime-wasi](../README.md) / component
+
+# Variable: component
+
+```ts
+const component: URL;
+```
+
+Defined in: [index.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/runtime-wasi/src/index.ts#L17)
+
+The WASI 0.2 component (`wasm32-wasip2`), of the world `xmachines:runtime/runtime`.

package/api/@xmachines/runtime-wasi/variables/schemas.md

@@ -0,0 +1,11 @@
+[API](../../../README.md) / [@xmachines/runtime-wasi](../README.md) / schemas
+
+# Variable: schemas
+
+```ts
+const schemas: URL;
+```
+
+Defined in: [index.ts:26](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/runtime-wasi/src/index.ts#L26)
+
+The folder of the JSON Schemas (draft 2020-12) of the JSON text that the WIT names, with a `/` at its end.

package/api/@xmachines/runtime-wasi/variables/wit.md

@@ -0,0 +1,11 @@
+[API](../../../README.md) / [@xmachines/runtime-wasi](../README.md) / wit
+
+# Variable: wit
+
+```ts
+const wit: URL;
+```
+
+Defined in: [index.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/runtime-wasi/src/index.ts#L23)
+
+The WIT package `xmachines:runtime`, of the world that the component exports and imports.

package/api/@xmachines/shared/vite-aliases/functions/xmAliases.md

@@ -6,7 +6,7 @@
 function xmAliases(importMetaUrl, target?): Record<string, string>;
 ```
 
-Defined in: [vite-aliases.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L311)
+Defined in: [vite-aliases.ts:311](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vite-aliases.ts#L311)
 
 Vite resolve.alias entries for all @xmachines/* workspace packages.
 

package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutput.md

@@ -6,7 +6,7 @@
 function xmBuildOutput(importMetaUrl): Plugin;
 ```
 
-Defined in: [vite-aliases.ts:407](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L407)
+Defined in: [vite-aliases.ts:407](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vite-aliases.ts#L407)
 
 The Vite plugin of the dist run: it moves each `src/` file of a published package to its
 counterpart in `dist/`.

package/api/@xmachines/shared/vite-aliases/functions/xmBuildOutputFile.md

@@ -6,7 +6,7 @@
 function xmBuildOutputFile(packageDir, sourceFile): string;
 ```
 
-Defined in: [vite-aliases.ts:378](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L378)
+Defined in: [vite-aliases.ts:378](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vite-aliases.ts#L378)
 
 The file in `dist/` that the build writes for one source file of a package.
 

package/api/@xmachines/shared/vite-aliases/functions/xmCacheDir.md

@@ -6,7 +6,7 @@
 function xmCacheDir(importMetaUrl, name): string;
 ```
 
-Defined in: [vite-aliases.ts:514](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L514)
+Defined in: [vite-aliases.ts:514](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vite-aliases.ts#L514)
 
 Returns the shared Vite `cacheDir` for this workspace package.
 

package/api/@xmachines/shared/vite-aliases/functions/xmOptimizeDeps.md

@@ -6,7 +6,7 @@
 function xmOptimizeDeps(include?): DepOptimizationOptions;
 ```
 
-Defined in: [vite-aliases.ts:467](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L467)
+Defined in: [vite-aliases.ts:467](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vite-aliases.ts#L467)
 
 Returns the standard Vite `optimizeDeps` config for browser test projects.
 

package/api/@xmachines/shared/vite-aliases/functions/xmResolve.md

@@ -6,7 +6,7 @@
 function xmResolve(importMetaUrl, extra?): ResolveOptions & object;
 ```
 
-Defined in: [vite-aliases.ts:352](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L352)
+Defined in: [vite-aliases.ts:352](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vite-aliases.ts#L352)
 
 Full Vite `resolve` config for @xmachines/* workspace packages.
 

package/api/@xmachines/shared/vite-aliases/functions/xmSvelteRunes.md

@@ -6,7 +6,7 @@
 function xmSvelteRunes(): object;
 ```
 
-Defined in: [vite-aliases.ts:493](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L493)
+Defined in: [vite-aliases.ts:493](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vite-aliases.ts#L493)
 
 Svelte plugin options that enforce runes mode for workspace sources only.
 
@@ -35,4 +35,4 @@ one and change the other.
 
 | Name                      | Type                                                    | Defined in                                                                                                                       |
 | ------------------------- | ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
-| `dynamicCompileOptions()` | (`data`) => \| \{ `runes`: `boolean`; \} \| `undefined` | [vite-aliases.ts:494](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L494) |
+| `dynamicCompileOptions()` | (`data`) => \| \{ `runes`: `boolean`; \} \| `undefined` | [vite-aliases.ts:494](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vite-aliases.ts#L494) |

package/api/@xmachines/shared/vite-aliases/functions/xmTestTarget.md

@@ -6,7 +6,7 @@
 function xmTestTarget(env?): XmTestTarget;
 ```
 
-Defined in: [vite-aliases.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L25)
+Defined in: [vite-aliases.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vite-aliases.ts#L25)
 
 Reads the test target from the `XM_TEST_TARGET` environment variable.
 

package/api/@xmachines/shared/vite-aliases/type-aliases/XmTestTarget.md

@@ -6,7 +6,7 @@
 type XmTestTarget = "source" | "dist";
 ```
 
-Defined in: [vite-aliases.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vite-aliases.ts#L13)
+Defined in: [vite-aliases.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vite-aliases.ts#L13)
 
 The code that a test run loads for each published `@xmachines/*` package.
 

package/api/@xmachines/shared/vitest/functions/defineXmBrowserConfig.md

@@ -6,7 +6,7 @@
 function defineXmBrowserConfig(importMetaUrl, overrides, options?): UserConfig;
 ```
 
-Defined in: [vitest.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vitest.ts#L230)
+Defined in: [vitest.ts:230](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vitest.ts#L230)
 
 Create a Vitest browser-mode config with XMachines workspace defaults.
 

package/api/@xmachines/shared/vitest/functions/defineXmVitestConfig.md

@@ -6,7 +6,7 @@
 function defineXmVitestConfig(importMetaUrl, overrides): UserConfig;
 ```
 
-Defined in: [vitest.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vitest.ts#L76)
+Defined in: [vitest.ts:76](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vitest.ts#L76)
 
 Create a Vitest config with XMachines workspace defaults.
 

package/api/@xmachines/shared/vitest/interfaces/XmBrowserConfigOptions.md

@@ -2,7 +2,7 @@
 
 # Interface: XmBrowserConfigOptions
 
-Defined in: [vitest.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vitest.ts#L180)
+Defined in: [vitest.ts:180](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vitest.ts#L180)
 
 Options for [defineXmBrowserConfig](../functions/defineXmBrowserConfig.md) that live outside the plain
 Vitest config overrides.
@@ -11,6 +11,6 @@ Vitest config overrides.
 
 | Property                                           | Type                                     | Description                                                                                                                                                                                                                                                                                                                 | Defined in                                                                                                           |
 | -------------------------------------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
-| <a id="property-base"></a> `base?`                 | `UserConfig`                             | Base Vite config to layer the browser test config on top of (typically a demo's `vite.config.ts`). When set, the base is expected to provide its own `resolve`/`plugins`, so the `cacheDir` and `resolve` defaults are not applied — mirroring the previous `mergeConfig(viteConfig, ...)` pattern in demo browser configs. | [vitest.ts:188](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vitest.ts#L188) |
-| <a id="property-optimizedeps"></a> `optimizeDeps?` | `string`[]                               | Extra package specifiers to pre-bundle via `xmOptimizeDeps` (e.g. `["@xmachines/json-render-vue", "@xmachines/json-render-vue/schema"]`). Ignored when `overrides.optimizeDeps` is set, which then replaces the default `xmOptimizeDeps()` wholesale.                                                                       | [vitest.ts:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vitest.ts#L195) |
-| <a id="property-resolve"></a> `resolve?`           | `Partial`\<`ResolveOptions` & `object`\> | Extra resolve options forwarded to `xmResolve` (e.g. `conditions` or additional `alias` entries). Not applied when `base` is set — the base config owns `resolve` in that layout.                                                                                                                                           | [vitest.ts:201](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.2.0/packages/shared/config/vitest.ts#L201) |
+| <a id="property-base"></a> `base?`                 | `UserConfig`                             | Base Vite config to layer the browser test config on top of (typically a demo's `vite.config.ts`). When set, the base is expected to provide its own `resolve`/`plugins`, so the `cacheDir` and `resolve` defaults are not applied — mirroring the previous `mergeConfig(viteConfig, ...)` pattern in demo browser configs. | [vitest.ts:188](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vitest.ts#L188) |
+| <a id="property-optimizedeps"></a> `optimizeDeps?` | `string`[]                               | Extra package specifiers to pre-bundle via `xmOptimizeDeps` (e.g. `["@xmachines/json-render-vue", "@xmachines/json-render-vue/schema"]`). Ignored when `overrides.optimizeDeps` is set, which then replaces the default `xmOptimizeDeps()` wholesale.                                                                       | [vitest.ts:195](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vitest.ts#L195) |
+| <a id="property-resolve"></a> `resolve?`           | `Partial`\<`ResolveOptions` & `object`\> | Extra resolve options forwarded to `xmResolve` (e.g. `conditions` or additional `alias` entries). Not applied when `base` is set — the base config owns `resolve` in that layout.                                                                                                                                           | [vitest.ts:201](https://gitlab.com/xmachin-es/xmachines-js/-/blob/docs-v7.4.0/packages/shared/config/vitest.ts#L201) |

package/api/README.md

@@ -25,4 +25,5 @@
 - [@xmachines/play-vue](@xmachines/play-vue/README.md)
 - [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md)
 - [@xmachines/play-xstate](@xmachines/play-xstate/README.md)
+- [@xmachines/runtime-wasi](@xmachines/runtime-wasi/README.md)
 - [@xmachines/shared](@xmachines/shared/README.md)

package/api/trains.json

@@ -25,6 +25,59 @@
       "@xmachines/play-vue-router",
       "@xmachines/play-xstate"
     ],
+    "runtime": ["@xmachines/runtime-wasi"],
     "docs": ["@xmachines/docs"]
+  },
+  "examples": {
+    "core": [],
+    "play": [
+      "@xmachines/play-dom-gallery-demo",
+      "@xmachines/play-dom-router-demo",
+      "@xmachines/play-dom-router-donut-demo",
+      "@xmachines/play-dom-router-flight-demo",
+      "@xmachines/play-dom-router-todomvc-demo",
+      "@xmachines/play-dom-router-trivia-demo",
+      "@xmachines/play-react-gallery-demo",
+      "@xmachines/play-react-router-demo",
+      "@xmachines/play-react-router-donut-demo",
+      "@xmachines/play-react-router-flight-demo",
+      "@xmachines/play-react-router-todomvc-demo",
+      "@xmachines/play-react-router-trivia-demo",
+      "@xmachines/play-solid-gallery-demo",
+      "@xmachines/play-solid-router-demo",
+      "@xmachines/play-solid-router-donut-demo",
+      "@xmachines/play-solid-router-flight-demo",
+      "@xmachines/play-solid-router-todomvc-demo",
+      "@xmachines/play-solid-router-trivia-demo",
+      "@xmachines/play-svelte-gallery-demo",
+      "@xmachines/play-svelte-spa-router-demo",
+      "@xmachines/play-svelte-spa-router-donut-demo",
+      "@xmachines/play-svelte-spa-router-flight-demo",
+      "@xmachines/play-svelte-spa-router-todomvc-demo",
+      "@xmachines/play-svelte-spa-router-trivia-demo",
+      "@xmachines/play-sveltekit-router-demo",
+      "@xmachines/play-sveltekit-router-donut-demo",
+      "@xmachines/play-sveltekit-router-flight-demo",
+      "@xmachines/play-sveltekit-router-todomvc-demo",
+      "@xmachines/play-sveltekit-router-trivia-demo",
+      "@xmachines/play-tanstack-react-router-demo",
+      "@xmachines/play-tanstack-react-router-donut-demo",
+      "@xmachines/play-tanstack-react-router-flight-demo",
+      "@xmachines/play-tanstack-react-router-todomvc-demo",
+      "@xmachines/play-tanstack-react-router-trivia-demo",
+      "@xmachines/play-tanstack-solid-router-demo",
+      "@xmachines/play-tanstack-solid-router-donut-demo",
+      "@xmachines/play-tanstack-solid-router-flight-demo",
+      "@xmachines/play-tanstack-solid-router-todomvc-demo",
+      "@xmachines/play-tanstack-solid-router-trivia-demo",
+      "@xmachines/play-vue-gallery-demo",
+      "@xmachines/play-vue-router-demo",
+      "@xmachines/play-vue-router-donut-demo",
+      "@xmachines/play-vue-router-flight-demo",
+      "@xmachines/play-vue-router-todomvc-demo",
+      "@xmachines/play-vue-router-trivia-demo"
+    ],
+    "runtime": [],
+    "docs": []
   }
 }

package/contributing/configuration.md

@@ -20,6 +20,15 @@ The dev container currently defines no workspace-specific environment variables;
 
 **Defined in:** the `test:dist` and `test:browser:dist` scripts of the root `package.json`. **Read by:** `xmTestTarget` of [`@xmachines/shared/vite-aliases`](../api/@xmachines/shared/README.md), which every config helper of that package calls. Do not set it by hand: run `pnpm run test:dist`. See [testing.md](testing.md#tests-on-the-build-output).
 
+### Runtime Bump Variables
+
+| Variable               | Required | Default | Description                                                                             |
+| ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------- |
+| `RUNTIME_VERSION`      | Yes      | —       | The release of the xmachines-rs runtime that the bump pins, as `1.2.0`.                 |
+| `RUNTIME_RELEASE_TYPE` | Yes      | —       | The type of that release: `major`, `minor` or `patch`. It gives the type of the commit. |
+
+**Defined in:** the trigger of the tag pipeline of xmachines-rs, which starts a pipeline of this project on `main`. **Read by:** the `runtime-wasi-bump` job (`scripts/bump-runtime-wasi.mjs`). A pipeline of the source `pipeline` with `RUNTIME_VERSION` runs that job alone. See the [README of `@xmachines/runtime-wasi`](../api/@xmachines/runtime-wasi/README.md#how-a-bump-arrives).
+
 ---
 
 ## Configuration Files
@@ -406,9 +415,11 @@ Defines the trains, the release branches, and the plugins of each run: the run o
 | `alpha` | `alpha`   | `alpha`     |
 | `pre`   | `pre`     | `pre`       |
 
-`GITLAB_TOKEN`, which the release needs (`CI_JOB_TOKEN` can push neither the release commit nor the tag, and creates no GitLab release), is a _protected_ group variable: it reaches only protected branches and protected tags. Every release branch is protected, `main` and the prerelease branches alike, and so are the tags of the trains, `core-v*`, `play-v*` and `docs-v*`. A release branch added to this table has to be protected too, or its release fails in verify-conditions with `EGITNOPERMISSION`.
+`GITLAB_TOKEN`, which the release needs (`CI_JOB_TOKEN` can push neither the release commit nor the tag, and creates no GitLab release), is a _protected_ group variable: it reaches only protected branches and protected tags. Every release branch is protected, `main` and the prerelease branches alike, and so are the tags of the trains, `core-v*`, `play-v*`, `runtime-v*` and `docs-v*`. A release branch added to this table has to be protected too, or its release fails in verify-conditions with `EGITNOPERMISSION`.
+
+**Trains:** `core` (`packages/core`), `play` (`packages/play`, `packages/play-*`), `runtime` (`packages/runtime-wasi`) and `docs` (`packages/docs`, with every file of `core`, `play` and `runtime` counting for it too). The build files of the root and `packages/shared` count for every train.
 
-**Trains:** `core` (`packages/core`), `play` (`packages/play`, `packages/play-*`) and `docs` (`packages/docs`, with every file of `core` and `play` counting for it too). The build files of the root and `packages/shared` count for every train.
+**Ecosystems:** `@wtf/semantic-release-npm/ecosystem`, the ecosystem of npm, by which the trains read the packages of each `package.json` git tracks: which train holds each, and what each depends on. It is the `./ecosystem` of the npm plugin, which the trains plugin finds beside the plugin in the global install of semantic-release, so `semrel-required-plugins.txt` names the plugin alone.
 
 **Tag format:** `<train>-v${version}`, as `play-v7.1.0`.
 
@@ -428,7 +439,7 @@ Defines the trains, the release branches, and the plugins of each run: the run o
 
 5. `@semantic-release/git` — commits the changelog, the READMEs of the train, and of `docs` the generated docs (`api/`, `examples/@xmachines/` and the demo lists of `examples/README.md`), then pushes the commit and the tag
 
-**Plugin order of a tag's run:** the notes generator on the train; `@wtf/semantic-release-trains-publish`, which packs, smoke-tests and publishes the train's packages and packs its demos; `@semantic-release/gitlab`, the GitLab release with the tarballs. [deployment.md](deployment.md) states the whole sequence and the reason.
+**Plugin order of a tag's run:** the notes generator on the train; `@wtf/semantic-release-npm`, which packs, smoke-tests and publishes the train's packages and packs its demos; `@semantic-release/gitlab`, the GitLab release with the tarballs. [deployment.md](deployment.md) states the whole sequence and the reason.
 
 ---