@xmachines/docs 1.0.0-beta.28 → 1.0.0-beta.30

package/api/@xmachines/play-actor-shared/type-aliases/AuthEvents.md

@@ -1,17 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / AuthEvents
-
-# Type Alias: AuthEvents
-
-```ts
-type AuthEvents =
-	| PlayRouteEvent
-	| {
-			type: "auth.login";
-			username: string;
-	  }
-	| {
-			type: "auth.logout";
-	  };
-```
-
-Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:36](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L36)

package/api/@xmachines/play-actor-shared/type-aliases/AuthInput.md

@@ -1,9 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / AuthInput
-
-# Type Alias: AuthInput
-
-```ts
-type AuthInput = Partial<AuthContext> | undefined;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:34](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L34)

package/api/@xmachines/play-actor-shared/type-aliases/AuthSnapshot.md

@@ -1,11 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / AuthSnapshot
-
-# Type Alias: AuthSnapshot
-
-```ts
-type AuthSnapshot = SnapshotFrom<typeof authMachine>;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:273](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L273)
-
-Snapshot type for the auth machine — use for typed `matches()` calls.

package/api/@xmachines/play-actor-shared/type-aliases/CatalogProps.md

@@ -1,187 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / CatalogProps
-
-# Type Alias: CatalogProps
-
-```ts
-type CatalogProps = object;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:48](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L48)
-
-## Properties
-
-### About
-
-```ts
-About: object;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:50](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L50)
-
-#### title
-
-```ts
-title: string;
-```
-
----
-
-### Contact
-
-```ts
-Contact: object;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:51](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L51)
-
-#### title
-
-```ts
-title: string;
-```
-
----
-
-### Dashboard
-
-```ts
-Dashboard: object;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:53](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L53)
-
-#### username
-
-```ts
-username: string;
-```
-
-#### welcome
-
-```ts
-welcome: boolean;
-```
-
----
-
-### Home
-
-```ts
-Home: object;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L49)
-
-#### title
-
-```ts
-title: string;
-```
-
----
-
-### Login
-
-```ts
-Login: object;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:52](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L52)
-
-#### title
-
-```ts
-title: string;
-```
-
----
-
-### Navigation
-
-```ts
-Navigation: object;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:56](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L56)
-
-#### currentPath
-
-```ts
-currentPath: string;
-```
-
-#### isAuthenticated
-
-```ts
-isAuthenticated: boolean;
-```
-
----
-
-### Overview
-
-```ts
-Overview: object;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:57](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L57)
-
-#### title
-
-```ts
-title: string;
-```
-
----
-
-### Profile
-
-```ts
-Profile: object;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:54](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L54)
-
-#### username
-
-```ts
-username: string;
-```
-
----
-
-### Settings
-
-```ts
-Settings: object;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L55)
-
-#### section?
-
-```ts
-optional section?: string;
-```
-
-#### username
-
-```ts
-username: string;
-```
-
----
-
-### Stats
-
-```ts
-Stats: object;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:58](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L58)
-
-#### title
-
-```ts
-title: string;
-```

package/api/@xmachines/play-actor-shared/type-aliases/InferProps.md

@@ -1,17 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / InferProps
-
-# Type Alias: InferProps\<K\>
-
-```ts
-type InferProps<K> = CatalogProps[K];
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:74](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L74)
-
-Infer props for a named component from the catalog type
-
-## Type Parameters
-
-| Type Parameter                                        |
-| ----------------------------------------------------- |
-| `K` _extends_ keyof [`CatalogProps`](CatalogProps.md) |

package/api/@xmachines/play-actor-shared/variables/authCatalog.md

@@ -1,173 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / authCatalog
-
-# 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: string;
-				params: ZodObject<
-					{
-						username: ZodString;
-					},
-					$strip
-				>;
-			};
-			logout: {
-				description: string;
-			};
-			routeDashboard: {
-				description: string;
-			};
-			routeHome: {
-				description: string;
-			};
-			routeLogin: {
-				description: string;
-			};
-			routeOverview: {
-				description: string;
-			};
-			routeProfile: {
-				description: string;
-			};
-			routeSettings: {
-				description: string;
-			};
-			routeStats: {
-				description: string;
-			};
-		};
-		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;
-					},
-					$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
-				>;
-			};
-		};
-	}
->;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/catalog.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/catalog.ts#L14)

package/api/@xmachines/play-actor-shared/variables/authMachine.md

@@ -1,189 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / authMachine
-
-# Variable: authMachine
-
-```ts
-const authMachine: StateMachine<AuthContext, AuthEvents, {
-}, never, never, never, never,
-  | "login"
-  | "home"
-  | "about"
-  | "contact"
-  | "profile"
-  | "settings"
-  | {
-  dashboard: "overview" | "stats";
-}, string, AuthInput, NonReducibleUnknown, EventObject, MetaObject, ToStateSchema<{
-  context: (__namedParameters) => object;
-  id: string;
-  initial: string;
-  on: {
-     auth.login: {
-        actions: ActionFunction<AuthContext, AuthEvents, AuthEvents, undefined, never, never, never, never, never>;
-        guard: (__namedParameters) => boolean;
-        target: string;
-     };
-     auth.logout: {
-        actions: ActionFunction<AuthContext, AuthEvents, AuthEvents, undefined, never, never, never, never, never>;
-        guard: (__namedParameters) => boolean;
-        target: string;
-     };
-  };
-  states: {
-     about: {
-        id: string;
-        meta: {
-           route: string;
-           view: {
-              component: string;
-              spec: {
-                 elements: {
-                    root: {
-                       children: ...[];
-                       props: {
-                          title: ...;
-                       };
-                       type: string;
-                    };
-                 };
-                 root: string;
-              };
-           };
-        };
-     };
-     contact: {
-        id: string;
-        meta: {
-           route: string;
-           view: {
-              component: string;
-              spec: {
-                 elements: {
-                    root: {
-                       children: ...[];
-                       props: {
-                          title: ...;
-                       };
-                       type: string;
-                    };
-                 };
-                 root: string;
-              };
-           };
-        };
-     };
-     dashboard: {
-        always: {
-           guard: (__namedParameters) => boolean;
-           target: string;
-        };
-        id: string;
-        initial: string;
-        meta: {
-           route: string;
-        };
-        states: {
-           overview: {
-              id: string;
-              meta: {
-                 route: string;
-                 view: {
-                    component: string;
-                    spec: PlaySpec;
-                 };
-              };
-           };
-           stats: {
-              id: string;
-              meta: {
-                 route: string;
-                 view: {
-                    component: string;
-                    spec: PlaySpec;
-                 };
-              };
-           };
-        };
-     };
-     home: {
-        id: string;
-        meta: {
-           route: string;
-           view: {
-              component: string;
-              spec: {
-                 elements: {
-                    root: {
-                       children: ...[];
-                       props: {
-                          title: ...;
-                       };
-                       type: string;
-                    };
-                 };
-                 root: string;
-              };
-           };
-        };
-     };
-     login: {
-        id: string;
-        meta: {
-           route: string;
-           view: {
-              component: string;
-              spec: {
-                 elements: {
-                    root: {
-                       children: ...[];
-                       on: {
-                          submit: ...;
-                       };
-                       props: {
-                          title: ...;
-                          username: ...;
-                       };
-                       type: string;
-                    };
-                 };
-                 root: string;
-                 state: {
-                    username: string;
-                 };
-              };
-           };
-        };
-     };
-     profile: {
-        always: {
-           guard: (__namedParameters) => boolean;
-           target: string;
-        };
-        id: string;
-        meta: {
-           route: string;
-           view: {
-              component: string;
-              spec: PlaySpec;
-           };
-        };
-     };
-     settings: {
-        always: {
-           guard: (__namedParameters) => boolean;
-           target: string;
-        };
-        id: string;
-        meta: {
-           route: string;
-           view: {
-              component: string;
-              spec: PlaySpec;
-           };
-        };
-     };
-  };
-}>>;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:49](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L49)

package/api/@xmachines/play-actor-shared/variables/authSetup.md

@@ -1,22 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-actor-shared](../README.md) / authSetup
-
-# Variable: authSetup
-
-```ts
-const authSetup: SetupReturn<
-	AuthContext,
-	AuthEvents,
-	{},
-	{},
-	{},
-	{},
-	never,
-	string,
-	AuthInput,
-	NonReducibleUnknown,
-	EventObject,
-	MetaObject
->;
-```
-
-Defined in: [packages/play-actor/examples/shared/src/auth-machine.ts:41](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-actor/examples/shared/src/auth-machine.ts#L41)

package/api/@xmachines/play-dom-demo/functions/initShell.md

@@ -1,20 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-dom-demo](../README.md) / initShell
-
-# Function: initShell()
-
-```ts
-function initShell(actor, appElement): () => void;
-```
-
-Defined in: [shell.ts:32](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-dom/examples/demo/src/shell.ts#L32)
-
-## Parameters
-
-| Parameter    | Type                                                             |
-| ------------ | ---------------------------------------------------------------- |
-| `actor`      | [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md) |
-| `appElement` | `HTMLElement`                                                    |
-
-## Returns
-
-() => `void`

package/api/@xmachines/play-react-demo/functions/DebugPanel.md

@@ -1,20 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / DebugPanel
-
-# Function: DebugPanel()
-
-```ts
-function DebugPanel(__namedParameters): Element;
-```
-
-Defined in: [components/DebugPanel.tsx:5](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/DebugPanel.tsx#L5)
-
-## Parameters
-
-| Parameter                 | Type                                                                             |
-| ------------------------- | -------------------------------------------------------------------------------- |
-| `__namedParameters`       | \{ `actor`: [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md); \} |
-| `__namedParameters.actor` | [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md)                 |
-
-## Returns
-
-`Element`

package/api/@xmachines/play-react-demo/functions/HeaderNav.md

@@ -1,20 +0,0 @@
-[Documentation](../../../README.md) / [@xmachines/play-react-demo](../README.md) / HeaderNav
-
-# Function: HeaderNav()
-
-```ts
-function HeaderNav(__namedParameters): Element;
-```
-
-Defined in: [components/HeaderNav.tsx:13](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v1.0.0-beta.28/packages/play-react/examples/demo/src/components/HeaderNav.tsx#L13)
-
-## Parameters
-
-| Parameter                 | Type                                                                             |
-| ------------------------- | -------------------------------------------------------------------------------- |
-| `__namedParameters`       | \{ `actor`: [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md); \} |
-| `__namedParameters.actor` | [`AuthActor`](../../play-actor-shared/type-aliases/AuthActor.md)                 |
-
-## Returns
-
-`Element`