@xmachines/docs 1.0.0-beta.33 → 1.0.0-beta.35

package/api/@xmachines/play-vue/variables/ActionProvider.md

@@ -0,0 +1,64 @@
+[Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / ActionProvider
+
+# Variable: ActionProvider
+
+```ts
+const ActionProvider: vue.DefineComponent<
+	vue.ExtractPropTypes<{
+		handlers: {
+			default: () => object;
+			type: PropType<Record<string, ActionHandler>>;
+		};
+		navigate: {
+			default: undefined;
+			type: PropType<(path) => void>;
+		};
+	}>,
+	() =>
+		| vue.VNode<
+				vue.RendererNode,
+				vue.RendererElement,
+				{
+					[key: string]: any;
+				}
+		  >[]
+		| undefined,
+	{},
+	{},
+	{},
+	vue.ComponentOptionsMixin,
+	vue.ComponentOptionsMixin,
+	{},
+	string,
+	vue.PublicProps,
+	Readonly<
+		vue.ExtractPropTypes<{
+			handlers: {
+				default: () => object;
+				type: PropType<Record<string, ActionHandler>>;
+			};
+			navigate: {
+				default: undefined;
+				type: PropType<(path) => void>;
+			};
+		}>
+	> &
+		Readonly<{}>,
+	{
+		handlers: Record<string, ActionHandler>;
+		navigate: (path) => void;
+	},
+	{},
+	{},
+	{},
+	string,
+	vue.ComponentProvideOptions,
+	true,
+	{},
+	any
+>;
+```
+
+Defined in: `@json-render/vue`
+
+Provider for action execution

package/api/@xmachines/play-vue/variables/JSONUIProvider.md

@@ -0,0 +1,96 @@
+[Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / JSONUIProvider
+
+# Variable: JSONUIProvider
+
+```ts
+const JSONUIProvider: vue.DefineComponent<vue.ExtractPropTypes<{
+  functions: {
+     default: undefined;
+     type: PropType<Record<string, ComputedFunction>>;
+  };
+  handlers: {
+     default: undefined;
+     type: PropType<Record<string, (params) => Promise<unknown> | unknown>>;
+  };
+  initialState: {
+     default: undefined;
+     type: PropType<Record<string, unknown>>;
+  };
+  navigate: {
+     default: undefined;
+     type: PropType<(path) => void>;
+  };
+  onStateChange: {
+     default: undefined;
+     type: PropType<(changes) => void>;
+  };
+  registry: {
+     required: true;
+     type: PropType<ComponentRegistry>;
+  };
+  store: {
+     default: undefined;
+     type: PropType<StateStore>;
+  };
+  validationFunctions: {
+     default: undefined;
+     type: PropType<Record<string, (value, args?) => boolean>>;
+  };
+}>, () => VNode<vue.RendererNode, vue.RendererElement, {
+[key: string]: any;
+}>, {
+}, {
+}, {
+}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+  functions: {
+     default: undefined;
+     type: PropType<Record<string, ComputedFunction>>;
+  };
+  handlers: {
+     default: undefined;
+     type: PropType<Record<string, (params) => Promise<...> | unknown>>;
+  };
+  initialState: {
+     default: undefined;
+     type: PropType<Record<string, unknown>>;
+  };
+  navigate: {
+     default: undefined;
+     type: PropType<(path) => void>;
+  };
+  onStateChange: {
+     default: undefined;
+     type: PropType<(changes) => void>;
+  };
+  registry: {
+     required: true;
+     type: PropType<ComponentRegistry>;
+  };
+  store: {
+     default: undefined;
+     type: PropType<StateStore>;
+  };
+  validationFunctions: {
+     default: undefined;
+     type: PropType<Record<string, (value, args?) => boolean>>;
+  };
+}>> & Readonly<{
+}>, {
+  functions: Record<string, ComputedFunction>;
+  handlers: Record<string, (params) => Promise<unknown> | unknown>;
+  initialState: Record<string, unknown>;
+  navigate: (path) => void;
+  onStateChange: (changes) => void;
+  store: StateStore;
+  validationFunctions: Record<string, (value, args?) => boolean>;
+}, {
+}, {
+}, {
+}, string, vue.ComponentProvideOptions, true, {
+}, any>;
+```
+
+Defined in: `@json-render/vue`
+
+Combined provider for all JSONUI contexts

package/api/@xmachines/play-vue/variables/PlayRenderer.md

@@ -6,4 +6,4 @@
 const PlayRenderer: DefineComponent<{}, {}, unknown>;
 ```
 
-Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-vue/src/vue-shim.d.ts#L3)
+Defined in: [packages/play-vue/src/vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-vue/src/vue-shim.d.ts#L3)

package/api/@xmachines/play-vue/variables/Renderer.md

@@ -0,0 +1,79 @@
+[Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / Renderer
+
+# Variable: Renderer
+
+```ts
+const Renderer: vue.DefineComponent<
+	vue.ExtractPropTypes<{
+		fallback: {
+			default: undefined;
+			type: PropType<Component>;
+		};
+		loading: {
+			default: undefined;
+			type: BooleanConstructor;
+		};
+		registry: {
+			required: true;
+			type: PropType<ComponentRegistry>;
+		};
+		spec: {
+			default: null;
+			type: PropType<Spec | null>;
+		};
+	}>,
+	() => VNode<
+		vue.RendererNode,
+		vue.RendererElement,
+		{
+			[key: string]: any;
+		}
+	> | null,
+	{},
+	{},
+	{},
+	vue.ComponentOptionsMixin,
+	vue.ComponentOptionsMixin,
+	{},
+	string,
+	vue.PublicProps,
+	Readonly<
+		vue.ExtractPropTypes<{
+			fallback: {
+				default: undefined;
+				type: PropType<Component>;
+			};
+			loading: {
+				default: undefined;
+				type: BooleanConstructor;
+			};
+			registry: {
+				required: true;
+				type: PropType<ComponentRegistry>;
+			};
+			spec: {
+				default: null;
+				type: PropType<Spec | null>;
+			};
+		}>
+	> &
+		Readonly<{}>,
+	{
+		fallback: Component;
+		loading: boolean;
+		spec: Spec | null;
+	},
+	{},
+	{},
+	{},
+	string,
+	vue.ComponentProvideOptions,
+	true,
+	{},
+	any
+>;
+```
+
+Defined in: `@json-render/vue`
+
+Main renderer component

package/api/@xmachines/play-vue/variables/StateProvider.md

@@ -0,0 +1,79 @@
+[Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / StateProvider
+
+# Variable: StateProvider
+
+```ts
+const StateProvider: vue.DefineComponent<
+	vue.ExtractPropTypes<{
+		initialState: {
+			default: undefined;
+			type: PropType<StateModel>;
+		};
+		onStateChange: {
+			default: undefined;
+			type: PropType<(changes) => void>;
+		};
+		store: {
+			default: undefined;
+			type: PropType<StateStore>;
+		};
+	}>,
+	() =>
+		| vue.VNode<
+				vue.RendererNode,
+				vue.RendererElement,
+				{
+					[key: string]: any;
+				}
+		  >[]
+		| undefined,
+	{},
+	{},
+	{},
+	vue.ComponentOptionsMixin,
+	vue.ComponentOptionsMixin,
+	{},
+	string,
+	vue.PublicProps,
+	Readonly<
+		vue.ExtractPropTypes<{
+			initialState: {
+				default: undefined;
+				type: PropType<StateModel>;
+			};
+			onStateChange: {
+				default: undefined;
+				type: PropType<(changes) => void>;
+			};
+			store: {
+				default: undefined;
+				type: PropType<StateStore>;
+			};
+		}>
+	> &
+		Readonly<{}>,
+	{
+		initialState: StateModel;
+		onStateChange: (changes) => void;
+		store: StateStore;
+	},
+	{},
+	{},
+	{},
+	string,
+	vue.ComponentProvideOptions,
+	true,
+	{},
+	any
+>;
+```
+
+Defined in: `@json-render/vue`
+
+Provider for state model context.
+
+Supports two modes:
+
+- **Controlled**: pass a `store` prop (e.g. backed by Redux / Zustand).
+- **Uncontrolled** (default): omit `store` and optionally pass
+  `initialState` / `onStateChange`.

package/api/@xmachines/play-vue/variables/ValidationProvider.md

@@ -0,0 +1,55 @@
+[Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / ValidationProvider
+
+# Variable: ValidationProvider
+
+```ts
+const ValidationProvider: vue.DefineComponent<
+	vue.ExtractPropTypes<{
+		customFunctions: {
+			default: () => object;
+			type: PropType<Record<string, ValidationFunction>>;
+		};
+	}>,
+	() =>
+		| vue.VNode<
+				vue.RendererNode,
+				vue.RendererElement,
+				{
+					[key: string]: any;
+				}
+		  >[]
+		| undefined,
+	{},
+	{},
+	{},
+	vue.ComponentOptionsMixin,
+	vue.ComponentOptionsMixin,
+	{},
+	string,
+	vue.PublicProps,
+	Readonly<
+		vue.ExtractPropTypes<{
+			customFunctions: {
+				default: () => object;
+				type: PropType<Record<string, ValidationFunction>>;
+			};
+		}>
+	> &
+		Readonly<{}>,
+	{
+		customFunctions: Record<string, ValidationFunction>;
+	},
+	{},
+	{},
+	{},
+	string,
+	vue.ComponentProvideOptions,
+	true,
+	{},
+	any
+>;
+```
+
+Defined in: `@json-render/vue`
+
+Provider for validation

package/api/@xmachines/play-vue/variables/VisibilityProvider.md

@@ -0,0 +1,40 @@
+[Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / VisibilityProvider
+
+# Variable: VisibilityProvider
+
+```ts
+const VisibilityProvider: vue.DefineComponent<
+	{},
+	() =>
+		| vue.VNode<
+				vue.RendererNode,
+				vue.RendererElement,
+				{
+					[key: string]: any;
+				}
+		  >[]
+		| undefined,
+	{},
+	{},
+	{},
+	vue.ComponentOptionsMixin,
+	vue.ComponentOptionsMixin,
+	{},
+	string,
+	vue.PublicProps,
+	Readonly<{}> & Readonly<{}>,
+	{},
+	{},
+	{},
+	{},
+	string,
+	vue.ComponentProvideOptions,
+	true,
+	{},
+	any
+>;
+```
+
+Defined in: `@json-render/vue`
+
+Provider for visibility evaluation

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

@@ -159,9 +159,9 @@ class RouteMap extends VueBaseRouteMap {
 **Constructor Parameters:**
 
 - `mappings` - Array of mapping objects with:
-  - `stateId` - State machine state ID (e.g., `'#profile'`)
-  - `routeName` - Vue Router route name (e.g., `'profile'`)
-  - `pattern` - Optional path pattern for URL resolution (e.g., `'/profile/:userId'`)
+    - `stateId` - State machine state ID (e.g., `'#profile'`)
+    - `routeName` - Vue Router route name (e.g., `'profile'`)
+    - `pattern` - Optional path pattern for URL resolution (e.g., `'/profile/:userId'`)
 
 **Methods (inherited from `VueBaseRouteMap`):**
 
@@ -628,7 +628,6 @@ For a copy, see <https://opensource.org/licenses/MIT>.
 ## Classes
 
 - [RouteMap](classes/RouteMap.md)
-- [VueBaseRouteMap](classes/VueBaseRouteMap.md)
 - [VueRouterBridge](classes/VueRouterBridge.md)
 
 ## Interfaces
@@ -648,3 +647,9 @@ For a copy, see <https://opensource.org/licenses/MIT>.
 ## Functions
 
 - [createRouteMap](functions/createRouteMap.md)
+
+## References
+
+### VueRouteMap
+
+Renames and re-exports [RouteMap](classes/RouteMap.md)

package/api/@xmachines/play-vue-router/classes/RouteMap.md

@@ -2,15 +2,45 @@
 
 # Class: RouteMap
 
-Defined in: [play-vue-router/src/route-map.ts:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-vue-router/src/route-map.ts#L10)
+Defined in: [play-router/src/base-route-map.ts:100](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/base-route-map.ts#L100)
 
-Bidirectional route mapper for Vue Router.
+Shared bidirectional route map base class.
 
-Alias for [BaseRouteMap](VueBaseRouteMap.md) from `@xmachines/play-router`.
+All framework adapters use this class as their route map — they add no logic of their
+own and inherit the full public API from here.
 
-## Extends
+**Lookup strategy:**
 
-- [`VueBaseRouteMap`](VueBaseRouteMap.md)
+- Static paths (no `:param`) → O(1) `Map` lookup
+- Dynamic paths → O(k) bucket-indexed scan using `URLPattern`, where `k` is the number
+  of routes sharing the same first path segment
+- Results are cached after the first match in an LRU cache (default 500 entries,
+  configurable via the `cacheSize` constructor option)
+
+**Pattern syntax** (`:param` / `:param?`):
+
+- `:param` — required segment, matches exactly one non-`/` segment
+- `:param?` — optional segment, matches zero or one non-`/` segment
+
+## Example
+
+```typescript
+import { RouteMap } from "@xmachines/play-router";
+
+const map = new RouteMap([
+	{ stateId: "home", path: "/" },
+	{ stateId: "profile", path: "/profile/:userId" },
+	{ stateId: "settings", path: "/settings/:section?" },
+]);
+
+map.getStateIdByPath("/"); // "home"
+map.getStateIdByPath("/profile/123"); // "profile"
+map.getStateIdByPath("/settings"); // "settings"
+map.getStateIdByPath("/unknown"); // null
+
+map.getPathByStateId("profile"); // "/profile/:userId"
+map.getPathByStateId("missing"); // null
+```
 
 ## Constructors
 
@@ -20,7 +50,7 @@ Alias for [BaseRouteMap](VueBaseRouteMap.md) from `@xmachines/play-router`.
 new RouteMap(mappings, options?): RouteMap;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L125)
+Defined in: [play-router/src/base-route-map.ts:125](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/base-route-map.ts#L125)
 
 Build a route map from an array of state ID ↔ path mappings.
 
@@ -40,10 +70,6 @@ buckets for efficient candidate selection.
 
 `RouteMap`
 
-#### Inherited from
-
-[`VueBaseRouteMap`](VueBaseRouteMap.md).[`constructor`](VueBaseRouteMap.md#constructor)
-
 ## Methods
 
 ### getPathByStateId()
@@ -52,7 +78,7 @@ buckets for efficient candidate selection.
 getPathByStateId(stateId): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L209)
+Defined in: [play-router/src/base-route-map.ts:209](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/base-route-map.ts#L209)
 
 Look up the path pattern registered for a state ID.
 
@@ -75,10 +101,6 @@ map.getPathByStateId("profile"); // "/profile/:userId"
 map.getPathByStateId("missing"); // null
 ```
 
-#### Inherited from
-
-[`VueBaseRouteMap`](VueBaseRouteMap.md).[`getPathByStateId`](VueBaseRouteMap.md#getpathbystateid)
-
 ---
 
 ### getStateIdByPath()
@@ -87,7 +109,7 @@ map.getPathByStateId("missing"); // null
 getStateIdByPath(path): string | null;
 ```
 
-Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.33/packages/play-router/src/base-route-map.ts#L174)
+Defined in: [play-router/src/base-route-map.ts:174](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.35/packages/play-router/src/base-route-map.ts#L174)
 
 Resolve a URL path to its mapped state ID.
 
@@ -113,7 +135,3 @@ The mapped state ID, or `null` if no route matches
 map.getStateIdByPath("/profile/123"); // "profile"
 map.getStateIdByPath("/unknown"); // null
 ```
-
-#### Inherited from
-
-[`VueBaseRouteMap`](VueBaseRouteMap.md).[`getStateIdByPath`](VueBaseRouteMap.md#getstateidbypath)