@xmachines/docs 1.0.0-beta.25 → 1.0.0-beta.26

package/api/@xmachines/play-xstate/type-aliases/GuardArray.md

@@ -6,7 +6,7 @@
 type GuardArray<TContext, TEvent> = Guard<TContext, TEvent>[] | string[];
 ```
 
-Defined in: [packages/play-xstate/src/guards/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-xstate/src/guards/types.ts#L23)
+Defined in: [packages/play-xstate/src/guards/types.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/guards/types.ts#L23)
 
 Array of guard predicates or guard names
 

package/api/@xmachines/play-xstate/type-aliases/PlayerFactory.md

@@ -6,7 +6,7 @@
 type PlayerFactory<TMachine> = (input?, options?) => PlayerActor<TMachine>;
 ```
 
-Defined in: [packages/play-xstate/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-xstate/src/types.ts#L57)
+Defined in: [packages/play-xstate/src/types.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/types.ts#L57)
 
 Factory function returned by definePlayer()
 

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

@@ -6,7 +6,7 @@
 type RouteMachineConfig = object;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-xstate/src/routing/format-play-route-transitions.ts#L52)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/format-play-route-transitions.ts#L48)
 
 Minimal structural constraint for machine configs accepted by
 `formatPlayRouteTransitions`.
@@ -32,7 +32,7 @@ through the transform, so the return value remains directly usable by
 optional context?: unknown;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-xstate/src/routing/format-play-route-transitions.ts#L53)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/format-play-route-transitions.ts#L49)
 
 ---
 
@@ -42,7 +42,7 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:5
 optional on?: Record<string, unknown>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-xstate/src/routing/format-play-route-transitions.ts#L55)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/format-play-route-transitions.ts#L51)
 
 ---
 
@@ -52,4 +52,4 @@ Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:5
 optional states?: Record<string, unknown>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-xstate/src/routing/format-play-route-transitions.ts#L54)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/format-play-route-transitions.ts#L50)

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

@@ -6,7 +6,7 @@
 type RouteStateNode = object;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:21](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-xstate/src/routing/format-play-route-transitions.ts#L21)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/format-play-route-transitions.ts#L13)
 
 Minimal structural shape of a single XState state node as read by
 `formatPlayRouteTransitions` when crawling the machine config.
@@ -29,7 +29,7 @@ the index signature.
 optional id?: string;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:23](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-xstate/src/routing/format-play-route-transitions.ts#L23)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/format-play-route-transitions.ts#L15)
 
 Optional explicit state ID (e.g. `"home"`, `"settings"`). Used as the `#id` target in `play.route` events.
 
@@ -41,7 +41,7 @@ Optional explicit state ID (e.g. `"home"`, `"settings"`). Used as the `#id` targ
 optional meta?: object;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:25](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-xstate/src/routing/format-play-route-transitions.ts#L25)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:17](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/format-play-route-transitions.ts#L17)
 
 State metadata — `meta.route` marks the state as routable.
 
@@ -61,6 +61,6 @@ URL path template (e.g. `"/profile/:username"`, `"/settings/:section?"`).
 optional states?: Record<string, RouteStateNode>;
 ```
 
-Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:30](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/play-xstate/src/routing/format-play-route-transitions.ts#L30)
+Defined in: [packages/play-xstate/src/routing/format-play-route-transitions.ts:22](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/play-xstate/src/routing/format-play-route-transitions.ts#L22)
 
 Nested child states, recursively crawled for additional route declarations.

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

@@ -6,7 +6,7 @@
 function defineXmVitestConfig(importMetaUrl, overrides): object;
 ```
 
-Defined in: [src/index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/shared/src/index.ts#L10)
+Defined in: [src/index.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/shared/src/index.ts#L10)
 
 Create a Vitest config with XMachines workspace defaults.
 
@@ -26,4 +26,4 @@ render it under `@xmachines/shared` instead of nested module pages.
 
 | Name   | Type  | Defined in                                                                                                                   |
 | ------ | ----- | ---------------------------------------------------------------------------------------------------------------------------- |
-| `test` | `any` | [config/vitest.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/shared/config/vitest.ts#L82) |
+| `test` | `any` | [config/vitest.ts:82](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/shared/config/vitest.ts#L82) |

package/api/@xmachines/shared/functions/xmAliases.md

@@ -6,7 +6,7 @@
 function xmAliases(importMetaUrl): Record<string, string>;
 ```
 
-Defined in: [src/index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.25/packages/shared/src/index.ts#L20)
+Defined in: [src/index.ts:20](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.26/packages/shared/src/index.ts#L20)
 
 Build Vite/Vitest alias entries for all `@xmachines/*` workspace packages.
 

package/api/README.md

@@ -7,8 +7,8 @@ Generated API documentation for the XMachines JavaScript/TypeScript packages.
 - For actor contracts, start with [@xmachines/play-actor](@xmachines/play-actor/README.md).
 - For player creation from XState machines, start with [@xmachines/play-xstate](@xmachines/play-xstate/README.md).
 - For route extraction and shared URL synchronization logic, start with [@xmachines/play-router](@xmachines/play-router/README.md).
-- For rendering, choose one of [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), or [@xmachines/play-vue](@xmachines/play-vue/README.md).
-- For framework router integration, choose the matching adapter package such as [@xmachines/play-react-router](@xmachines/play-react-router/README.md) or [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md).
+- For rendering, choose one of [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), [@xmachines/play-svelte](@xmachines/play-svelte/README.md), or [@xmachines/play-vue](@xmachines/play-vue/README.md).
+- For framework router integration, choose the matching adapter package such as [@xmachines/play-react-router](@xmachines/play-react-router/README.md), [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md), [@xmachines/play-sveltekit-router](@xmachines/play-sveltekit-router/README.md), or [@xmachines/play-svelte-spa-router](@xmachines/play-svelte-spa-router/README.md).
 
 ## Key Concepts
 
@@ -19,8 +19,8 @@ Generated API documentation for the XMachines JavaScript/TypeScript packages.
 ## Package Roles
 
 - `Core runtime`: [@xmachines/play](@xmachines/play/README.md), [@xmachines/play-actor](@xmachines/play-actor/README.md), [@xmachines/play-signals](@xmachines/play-signals/README.md), [@xmachines/play-router](@xmachines/play-router/README.md), and [@xmachines/play-xstate](@xmachines/play-xstate/README.md)
-- `Rendering`: [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), and [@xmachines/play-vue](@xmachines/play-vue/README.md)
-- `Router adapters`: [@xmachines/play-react-router](@xmachines/play-react-router/README.md), [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md), [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md), and [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md)
+- `Rendering`: [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), [@xmachines/play-svelte](@xmachines/play-svelte/README.md), and [@xmachines/play-vue](@xmachines/play-vue/README.md)
+- `Router adapters`: [@xmachines/play-react-router](@xmachines/play-react-router/README.md), [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md), [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md), [@xmachines/play-tanstack-solid-router](@xmachines/play-tanstack-solid-router/README.md), [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md), [@xmachines/play-sveltekit-router](@xmachines/play-sveltekit-router/README.md), and [@xmachines/play-svelte-spa-router](@xmachines/play-svelte-spa-router/README.md)
 - `Shared tooling`: [@xmachines/shared](@xmachines/shared/README.md)
 
 ## Notes

package/api/llms.txt

@@ -12,14 +12,14 @@
 - Understanding actor contracts: read [@xmachines/play-actor](@xmachines/play-actor/README.md) for [Viewable](@xmachines/play-actor/interfaces/Viewable.md) and [Routable](@xmachines/play-actor/interfaces/Routable.md).
 - [Viewable](@xmachines/play-actor/interfaces/Viewable.md) is the rendering contract: actors expose `currentView` plus a component catalog so rendering packages can resolve UI without owning application state.
 - [Routable](@xmachines/play-actor/interfaces/Routable.md) is the routing contract: actors expose `currentRoute` plus route-oriented event handling, while adapters translate browser or router changes into actor events.
-- Rendering actor-driven UI: use [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), or [@xmachines/play-vue](@xmachines/play-vue/README.md).
+- Rendering actor-driven UI: use [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), [@xmachines/play-svelte](@xmachines/play-svelte/README.md), or [@xmachines/play-vue](@xmachines/play-vue/README.md).
 - Synchronizing URLs with actor state: use [@xmachines/play-router](@xmachines/play-router/README.md) plus a framework-specific router adapter.
 
 ## Package Roles
 
 - `Core runtime`: [@xmachines/play](@xmachines/play/README.md), [@xmachines/play-actor](@xmachines/play-actor/README.md), [@xmachines/play-signals](@xmachines/play-signals/README.md), [@xmachines/play-router](@xmachines/play-router/README.md), and [@xmachines/play-xstate](@xmachines/play-xstate/README.md). Catalog and component registry are provided by `@json-render/core` and the framework rendering packages.
-- `Rendering`: [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), and [@xmachines/play-vue](@xmachines/play-vue/README.md).
-- `Router adapters`: [@xmachines/play-react-router](@xmachines/play-react-router/README.md), [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md), [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md), [@xmachines/play-tanstack-solid-router](@xmachines/play-tanstack-solid-router/README.md), and [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md), all built on top of [Routable](@xmachines/play-actor/interfaces/Routable.md) actors and shared route metadata.
+- `Rendering`: [@xmachines/play-react](@xmachines/play-react/README.md), [@xmachines/play-solid](@xmachines/play-solid/README.md), [@xmachines/play-svelte](@xmachines/play-svelte/README.md), and [@xmachines/play-vue](@xmachines/play-vue/README.md).
+- `Router adapters`: [@xmachines/play-react-router](@xmachines/play-react-router/README.md), [@xmachines/play-tanstack-react-router](@xmachines/play-tanstack-react-router/README.md), [@xmachines/play-solid-router](@xmachines/play-solid-router/README.md), [@xmachines/play-tanstack-solid-router](@xmachines/play-tanstack-solid-router/README.md), [@xmachines/play-vue-router](@xmachines/play-vue-router/README.md), [@xmachines/play-sveltekit-router](@xmachines/play-sveltekit-router/README.md), and [@xmachines/play-svelte-spa-router](@xmachines/play-svelte-spa-router/README.md), all built on top of [Routable](@xmachines/play-actor/interfaces/Routable.md) actors and shared route metadata.
 - `Shared tooling`: [@xmachines/shared](@xmachines/shared/README.md) for shared config and workspace-level support files.
 
 ## API

package/examples/README.md

@@ -40,6 +40,11 @@ Complete working applications demonstrating actor-authoritative routing, shared
 
 - **[Vue Router Demo](../api/@xmachines/play-vue-router-demo/README.md)** - Vue Composition API integration with the same shared auth and routing patterns
 
+### Svelte Integrations
+
+- **[SvelteKit Router Demo](../api/@xmachines/play-sveltekit-router-demo/README.md)** - SvelteKit-style routing with `afterNavigate`/`goto` and Svelte 5 runes
+- **[Svelte SPA Router Demo](../api/@xmachines/play-svelte-spa-router-demo/README.md)** - Hash-based SPA routing using `svelte-spa-router` with the same actor-authoritative flow
+
 ### Solid Integrations
 
 - **[Solid Router Demo](../api/@xmachines/play-solid-router-demo/README.md)** - Solid fine-grained reactivity with `@solidjs/router` and provider-based routing

package/examples/routing-patterns.md

@@ -62,7 +62,8 @@ const authMachine = setup({
 		context: {} as {
 			isAuthenticated: boolean;
 			userId: string;
-			routeParams: Record<string, string>;
+			params: Record<string, string>;
+			query: Record<string, string>;
 		},
 		events: {} as
 			| { type: "play.route"; to: string; params?: Record<string, string> }
@@ -73,7 +74,8 @@ const authMachine = setup({
 	context: {
 		isAuthenticated: false,
 		userId: "",
-		routeParams: {},
+		params: {},
+		query: {},
 	},
 	states: {
 		login: {
@@ -99,7 +101,7 @@ const authMachine = setup({
 				route: "/profile/:userId",
 				view: {
 					component: "ProfileView",
-					userId: (ctx) => ctx.routeParams.userId || ctx.userId,
+					userId: (ctx) => ctx.params.userId || ctx.userId,
 				},
 			},
 			always: [
@@ -113,7 +115,7 @@ const authMachine = setup({
 				"play.route": {
 					actions: ({ context, event }) => {
 						if (event.params?.userId) {
-							context.routeParams = { userId: event.params.userId };
+							context.params = { userId: event.params.userId };
 						}
 					},
 				},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xmachines/docs",
-  "version": "1.0.0-beta.25",
+  "version": "1.0.0-beta.26",
   "description": "Documentation for XMachines",
   "keywords": [
     "documentation",
@@ -48,7 +48,7 @@
     "typedoc": "typedoc"
   },
   "devDependencies": {
-    "@xmachines/shared": "1.0.0-beta.25",
+    "@xmachines/shared": "1.0.0-beta.26",
     "oxfmt": "^0.43.0",
     "oxlint": "^1.57.0",
     "typedoc": "^0.28.18",

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

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

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

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