@xmachines/docs 4.0.0 → 5.0.1

package/examples/@xmachines/play-react-demo/variables/Dashboard.md

@@ -6,7 +6,7 @@
 const Dashboard: ComponentFn<AuthCatalog, "Dashboard">;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/components/Dashboard.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/components/Dashboard.tsx#L12)
+Defined in: [packages/play-react/examples/demo/src/components/Dashboard.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/Dashboard.tsx#L12)
 
 Dashboard — Protected authenticated home
 

package/examples/@xmachines/play-react-demo/variables/DebugPanel.md

@@ -5,11 +5,12 @@
 ```ts
 const DebugPanel: FC<{
 	actor: AuthActor;
+	inspector: DemoInspector;
 }>;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/components/DebugPanel.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/components/DebugPanel.tsx#L11)
+Defined in: [packages/play-react/examples/demo/src/components/DebugPanel.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/DebugPanel.tsx#L12)
 
 DebugPanel — Live debug footer. Observes actor.state and actor.currentRoute
-via useSignalEffect and displays current state value, can-logout status,
-and active route.
+via useAtomEffect and displays current state value, can-logout status,
+and active route, plus the button that opens the Stately inspector window.

package/examples/@xmachines/play-react-demo/variables/Field.md

@@ -0,0 +1,18 @@
+[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Field
+
+# Variable: Field
+
+```ts
+const Field: ComponentFn<AuthCatalog, "Field">;
+```
+
+Defined in: [packages/play-react/examples/demo/src/components/Field.tsx:15](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/Field.tsx#L15)
+
+Field — labelled input with two-way $bindState binding and declarative
+validation checks.
+
+Registration happens by rendering: useFieldValidation registers the bound
+state path with the ValidationProvider so the `validateForm` built-in sees
+it. The error DISPLAY deliberately reads `props.formErrors` — the result
+object validateForm wrote to state — rather than the local hook, so every
+renderer (DOM included) surfaces errors at the same moment: after submit.

package/examples/@xmachines/play-react-demo/variables/Home.md

@@ -6,7 +6,7 @@
 const Home: ComponentFn<AuthCatalog, "Home">;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/components/Home.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/components/Home.tsx#L10)
+Defined in: [packages/play-react/examples/demo/src/components/Home.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/Home.tsx#L10)
 
 Home - Public landing page component
 

package/examples/@xmachines/play-react-demo/variables/Login.md

@@ -6,7 +6,7 @@
 const Login: ComponentFn<AuthCatalog, "Login">;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/components/Login.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/components/Login.tsx#L14)
+Defined in: [packages/play-react/examples/demo/src/components/Login.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/Login.tsx#L14)
 
 Login — Authentication form
 

package/examples/@xmachines/play-react-demo/variables/NavBar.md

@@ -8,7 +8,7 @@ const NavBar: FC<{
 }>;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/components/NavBar.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/components/NavBar.tsx#L12)
+Defined in: [packages/play-react/examples/demo/src/components/NavBar.tsx:12](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/NavBar.tsx#L12)
 
 NavBar — App-shell navigation component.
 

package/examples/@xmachines/play-react-demo/variables/NavBarView.md

@@ -6,7 +6,7 @@
 const NavBarView: ComponentFn<AuthCatalog, "NavBar">;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/components/NavBarView.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/components/NavBarView.tsx#L11)
+Defined in: [packages/play-react/examples/demo/src/components/NavBarView.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/NavBarView.tsx#L11)
 
 NavBarView — Catalog-typed NavBar for use in defineRegistry components map.
 

package/examples/@xmachines/play-react-demo/variables/Navigation.md

@@ -6,7 +6,7 @@
 const Navigation: ComponentFn<AuthCatalog, "Navigation">;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/components/Navigation.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/components/Navigation.tsx#L10)
+Defined in: [packages/play-react/examples/demo/src/components/Navigation.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/Navigation.tsx#L10)
 
 Navigation - Status display component
 

package/examples/@xmachines/play-react-demo/variables/Overview.md

@@ -6,7 +6,7 @@
 const Overview: ComponentFn<AuthCatalog, "Overview">;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/components/Overview.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/components/Overview.tsx#L10)
+Defined in: [packages/play-react/examples/demo/src/components/Overview.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/Overview.tsx#L10)
 
 Overview - Dashboard overview child route component
 

package/examples/@xmachines/play-react-demo/variables/Panel.md

@@ -0,0 +1,15 @@
+[Examples](../../../README.md) / [@xmachines/play-react-demo](../README.md) / Panel
+
+# Variable: Panel
+
+```ts
+const Panel: ComponentFn<AuthCatalog, "Panel">;
+```
+
+Defined in: [packages/play-react/examples/demo/src/components/Panel.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/Panel.tsx#L11)
+
+Panel — generic container leaf for the 0.20 showcase.
+
+Renders an optional title and note, then its spec `children` — which is how
+repeat containers work: the element renders ONCE and its children render per
+item, so a Panel is both the list shell and the row.

package/examples/@xmachines/play-react-demo/variables/Profile.md

@@ -6,7 +6,7 @@
 const Profile: ComponentFn<AuthCatalog, "Profile">;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/components/Profile.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/components/Profile.tsx#L11)
+Defined in: [packages/play-react/examples/demo/src/components/Profile.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/Profile.tsx#L11)
 
 Profile — Protected user profile page
 

package/examples/@xmachines/play-react-demo/variables/Settings.md

@@ -6,7 +6,7 @@
 const Settings: ComponentFn<AuthCatalog, "Settings">;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/components/Settings.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/components/Settings.tsx#L11)
+Defined in: [packages/play-react/examples/demo/src/components/Settings.tsx:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/Settings.tsx#L11)
 
 Settings — Protected settings page
 

package/examples/@xmachines/play-react-demo/variables/Shell.md

@@ -5,12 +5,13 @@
 ```ts
 const Shell: FC<{
 	actor: AuthActor;
+	inspector: DemoInspector;
 	registryResult: DefineRegistryResult;
 	router?: unknown;
 }>;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/components/Shell.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/components/Shell.tsx#L14)
+Defined in: [packages/play-react/examples/demo/src/components/Shell.tsx:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/Shell.tsx#L14)
 
 Demo Shell layout component.
 

package/examples/@xmachines/play-react-demo/variables/Stats.md

@@ -6,7 +6,7 @@
 const Stats: ComponentFn<AuthCatalog, "Stats">;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/components/Stats.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/components/Stats.tsx#L10)
+Defined in: [packages/play-react/examples/demo/src/components/Stats.tsx:10](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/components/Stats.tsx#L10)
 
 Stats - Dashboard stats child route component
 

package/examples/@xmachines/play-react-demo/variables/authCatalog.md

@@ -3,170 +3,195 @@
 # Variable: authCatalog
 
 ```ts
-const authCatalog: Catalog<
-	{
-		catalog: SchemaType<
-			"object",
-			{
-				actions: SchemaType<
-					"map",
-					{
-						description: SchemaType<"string", unknown>;
-						params: SchemaType<"zod", unknown>;
-					}
-				>;
-				components: SchemaType<
-					"map",
-					{
-						description: SchemaType<"string", unknown>;
-						example: SchemaType<"any", unknown>;
-						props: SchemaType<"zod", unknown>;
-						slots: SchemaType<"array", SchemaType<"string", unknown>>;
-					}
-				>;
-			}
-		>;
-		spec: SchemaType<
-			"object",
-			{
-				elements: SchemaType<
-					"record",
-					SchemaType<
-						"object",
-						{
-							children: SchemaType<"array", SchemaType<"string", unknown>>;
-							props: SchemaType<"propsOf", string>;
-							type: SchemaType<"ref", string>;
-							visible: SchemaType<"any", unknown>;
-						}
-					>
-				>;
-				root: SchemaType<"string", unknown>;
-			}
-		>;
-	},
-	{
-		actions: {
-			login: {
-				description: "Login with username";
-				params: ZodObject<
-					{
-						username: ZodString;
-					},
-					$strip
-				>;
-			};
-			logout: {
-				description: "Logout and return to home";
-			};
-			route: {
-				description: "Navigate to a route by path (e.g. '#home', '#login', '#dashboard')";
-				params: ZodObject<
-					{
-						params: ZodOptional<ZodRecord<ZodString, ZodString>>;
-						to: ZodString;
-					},
-					$strip
-				>;
-			};
-		};
-		components: {
-			About: {
-				props: ZodObject<
-					{
-						title: ZodString;
-					},
-					$strip
-				>;
-			};
-			Contact: {
-				props: ZodObject<
-					{
-						title: ZodString;
-					},
-					$strip
-				>;
-			};
-			Dashboard: {
-				props: ZodObject<
-					{
-						username: ZodString;
-						welcome: ZodBoolean;
-					},
-					$strip
-				>;
-			};
-			Home: {
-				props: ZodObject<
-					{
-						title: ZodString;
-					},
-					$strip
-				>;
-			};
-			Login: {
-				props: ZodObject<
-					{
-						title: ZodString;
-						username: ZodOptional<ZodString>;
-					},
-					$strip
-				>;
-			};
-			NavBar: {
-				props: ZodObject<
-					{
-						isAuthenticated: ZodBoolean;
-						username: ZodNullable<ZodString>;
-					},
-					$strip
-				>;
-			};
-			Navigation: {
-				props: ZodObject<
-					{
-						currentPath: ZodString;
-						isAuthenticated: ZodBoolean;
-					},
-					$strip
-				>;
-			};
-			Overview: {
-				props: ZodObject<
-					{
-						title: ZodString;
-					},
-					$strip
-				>;
-			};
-			Profile: {
-				props: ZodObject<
-					{
-						username: ZodString;
-					},
-					$strip
-				>;
-			};
-			Settings: {
-				props: ZodObject<
-					{
-						section: ZodOptional<ZodString>;
-						username: ZodString;
-					},
-					$strip
-				>;
-			};
-			Stats: {
-				props: ZodObject<
-					{
-						title: ZodString;
-					},
-					$strip
-				>;
-			};
-		};
-	}
->;
+const authCatalog: Catalog<{
+  catalog: SchemaType<"object", {
+     actions: SchemaType<"map", {
+        description: SchemaType<"string", unknown>;
+        params: SchemaType<"zod", unknown>;
+     }>;
+     components: SchemaType<"map", {
+        description: SchemaType<"string", unknown>;
+        example: SchemaType<"any", unknown>;
+        props: SchemaType<"zod", unknown>;
+        slots: SchemaType<"array", SchemaType<"string", unknown>>;
+     }>;
+  }>;
+  spec: SchemaType<"object", {
+     elements: SchemaType<"record", SchemaType<"object", {
+        children: SchemaType<"array", SchemaType<"string", unknown>>;
+        props: SchemaType<"propsOf", string>;
+        repeat: {
+           inner?: unknown;
+           kind: "any";
+           optional: true;
+        };
+        slots: {
+           inner?: SchemaType<"array", SchemaType<..., ...>>;
+           kind: "record";
+           optional: true;
+        };
+        type: SchemaType<"ref", string>;
+        visible: {
+           inner?: unknown;
+           kind: "any";
+           optional: true;
+        };
+     }>>;
+     root: SchemaType<"string", unknown>;
+  }>;
+}, {
+  actions: {
+     addTask: {
+        description: "Add a task (sends task.add to the machine)";
+        params: ZodObject<{
+           title: ZodString;
+        }, $strip>;
+     };
+     completeTask: {
+        description: "Mark a task done (sends task.complete to the machine)";
+        params: ZodObject<{
+           id: ZodString;
+        }, $strip>;
+     };
+     login: {
+        description: "Login with username";
+        params: ZodObject<{
+           username: ZodString;
+        }, $strip>;
+     };
+     logout: {
+        description: "Logout and return to home";
+     };
+     removeTask: {
+        description: "Remove a task (sends task.remove to the machine)";
+        params: ZodObject<{
+           id: ZodString;
+        }, $strip>;
+     };
+     resetForm: {
+        description: "Reset a demo form to its defaults (confirm-gated in the spec)";
+        params: ZodObject<{
+           form: ZodString;
+        }, $strip>;
+     };
+     route: {
+        description: "Navigate to a route by path (e.g. '#home', '#login', '#dashboard')";
+        params: ZodObject<{
+           params: ZodOptional<ZodRecord<ZodString, ZodString>>;
+           to: ZodString;
+        }, $strip>;
+     };
+     submitForm: {
+        description: "Submit a demo form; rejects when the form did not pass validation";
+        params: ZodObject<{
+           form: ZodString;
+           valid: ZodOptional<ZodNullable<ZodBoolean>>;
+        }, $strip>;
+     };
+  };
+  components: {
+     About: {
+        props: ZodObject<{
+           title: ZodString;
+        }, $strip>;
+     };
+     Button: {
+        props: ZodObject<{
+           disabled: ZodOptional<ZodBoolean>;
+           label: ZodString;
+           testId: ZodOptional<ZodString>;
+           variant: ZodOptional<ZodEnum<{
+              danger: "danger";
+              primary: "primary";
+              secondary: "secondary";
+           }>>;
+        }, $strip>;
+     };
+     Contact: {
+        props: ZodObject<{
+           title: ZodString;
+        }, $strip>;
+     };
+     Dashboard: {
+        props: ZodObject<{
+           username: ZodString;
+           welcome: ZodBoolean;
+        }, $strip>;
+     };
+     Field: {
+        props: ZodObject<{
+           checks: ZodOptional<ZodArray<ZodCustom<ValidationCheck, ValidationCheck>>>;
+           formErrors: ZodOptional<ZodRecord<ZodString, ZodArray<ZodString>>>;
+           inputType: ZodOptional<ZodEnum<{
+              email: "email";
+              text: "text";
+              textarea: "textarea";
+           }>>;
+           label: ZodString;
+           placeholder: ZodOptional<ZodString>;
+           testId: ZodOptional<ZodString>;
+           value: ZodOptional<ZodString>;
+        }, $strip>;
+     };
+     Home: {
+        props: ZodObject<{
+           title: ZodString;
+        }, $strip>;
+     };
+     Login: {
+        props: ZodObject<{
+           title: ZodString;
+           username: ZodOptional<ZodString>;
+        }, $strip>;
+     };
+     NavBar: {
+        props: ZodObject<{
+           isAuthenticated: ZodBoolean;
+           username: ZodNullable<ZodString>;
+        }, $strip>;
+     };
+     Navigation: {
+        props: ZodObject<{
+           currentPath: ZodString;
+           isAuthenticated: ZodBoolean;
+        }, $strip>;
+     };
+     Overview: {
+        props: ZodObject<{
+           title: ZodString;
+        }, $strip>;
+     };
+     Panel: {
+        props: ZodObject<{
+           note: ZodOptional<ZodUnion<readonly [ZodString, ZodNumber, ZodBoolean, ZodNull]>>;
+           testId: ZodOptional<ZodString>;
+           title: ZodOptional<ZodUnion<readonly [ZodString, ZodNumber]>>;
+           tone: ZodOptional<ZodEnum<{
+              danger: "danger";
+              default: "default";
+              muted: "muted";
+              success: "success";
+           }>>;
+        }, $strip>;
+     };
+     Profile: {
+        props: ZodObject<{
+           username: ZodString;
+        }, $strip>;
+     };
+     Settings: {
+        props: ZodObject<{
+           section: ZodOptional<ZodString>;
+           username: ZodString;
+        }, $strip>;
+     };
+     Stats: {
+        props: ZodObject<{
+           title: ZodString;
+        }, $strip>;
+     };
+  };
+}>;
 ```
 
-Defined in: [packages/play-react/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.56/packages/play-react/examples/demo/src/catalog.ts#L5)
+Defined in: [packages/play-react/examples/demo/src/catalog.ts:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v5.0.1/packages/play-react/examples/demo/src/catalog.ts#L5)