@xmachines/docs 1.0.0-beta.9 → 1.0.0

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

@@ -0,0 +1,105 @@
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / JSONUIProvider
+
+# Variable: JSONUIProvider
+
+```ts
+const JSONUIProvider: vue.DefineComponent<vue.ExtractPropTypes<{
+  directives: {
+     default: undefined;
+     type: PropType<DirectiveDefinition[]>;
+  };
+  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<{
+  directives: {
+     default: undefined;
+     type: PropType<DirectiveDefinition[]>;
+  };
+  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<{
+}>, {
+  directives: DirectiveDefinition<zod.ZodType<unknown, unknown, zod_v4_core.$ZodTypeInternals<unknown, unknown>>>[];
+  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: `@xmachines/json-render-vue`
+
+Combined provider for all JSONUI contexts

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

@@ -1,4 +1,4 @@
-[Documentation](../../../README.md) / [@xmachines/play-vue](../README.md) / PlayRenderer
+[API](../../../README.md) / [@xmachines/play-vue](../README.md) / PlayRenderer
 
 # Variable: PlayRenderer
 
@@ -6,4 +6,4 @@
 const PlayRenderer: DefineComponent<{}, {}, unknown>;
 ```
 
-Defined in: [vue-shim.d.ts:3](https://gitlab.com/xmachin-es/xmachines-js/-/blob/00a28432ed57807112288436d1ae4387d9f06919/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/packages/play-vue/src/vue-shim.d.ts#L3)

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

@@ -0,0 +1,88 @@
+[API](../../../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;
+		};
+		onRenderError: {
+			default: undefined;
+			type: PropType<RenderErrorHandler>;
+		};
+		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;
+			};
+			onRenderError: {
+				default: undefined;
+				type: PropType<RenderErrorHandler>;
+			};
+			registry: {
+				required: true;
+				type: PropType<ComponentRegistry>;
+			};
+			spec: {
+				default: null;
+				type: PropType<Spec | null>;
+			};
+		}>
+	> &
+		Readonly<{}>,
+	{
+		fallback: Component;
+		loading: boolean;
+		onRenderError: RenderErrorHandler;
+		spec: Spec | null;
+	},
+	{},
+	{},
+	{},
+	string,
+	vue.ComponentProvideOptions,
+	true,
+	{},
+	any
+>;
+```
+
+Defined in: `@xmachines/json-render-vue`
+
+Main renderer component

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

@@ -0,0 +1,79 @@
+[API](../../../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: `@xmachines/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 @@
+[API](../../../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: `@xmachines/json-render-vue`
+
+Provider for validation

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

@@ -0,0 +1,40 @@
+[API](../../../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: `@xmachines/json-render-vue`
+
+Provider for visibility evaluation