@xmachines/docs 2.0.0-alpha.1 → 2.1.0

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

@@ -1,30 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / PlayRoutePayload
-
-# Type Alias: PlayRoutePayload
-
-```ts
-type PlayRoutePayload = WithOptional<
-	WithOptional<
-		WithOptional<
-			{
-				to: PlayRouteEvent["to"];
-			},
-			{
-				params: Record<string, string>;
-			}
-		>,
-		{
-			query: Record<string, string>;
-		}
-	>,
-	{
-		match: unknown;
-	}
->;
-```
-
-Defined in: [packages/play-xstate/src/routing/schemas.ts:62](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/schemas.ts#L62)
-
-The `play.route` event payload as machines receive it: `to` required;
-`params`/`query`/`match` encoded as optional-by-union so they stay omittable
-through XState v6's `Required<>` event inference.

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

@@ -1,33 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / SetupLike
-
-# Type Alias: SetupLike
-
-```ts
-type SetupLike = object;
-```
-
-Defined in: [packages/play-xstate/src/routing/create-routed-machine.ts:11](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/create-routed-machine.ts#L11)
-
-Structural constraint for `setup(...)` return values: anything exposing a
-`createMachine` function. Kept structural (rather than importing XState's
-`SetupReturn`) so the wrapper stays agnostic to that type's many generics.
-
-## Properties
-
-### createMachine
-
-```ts
-createMachine: (...args) => unknown;
-```
-
-Defined in: [packages/play-xstate/src/routing/create-routed-machine.ts:14](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/create-routed-machine.ts#L14)
-
-#### Parameters
-
-| Parameter | Type      |
-| --------- | --------- |
-| ...`args` | `never`[] |
-
-#### Returns
-
-`unknown`

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

@@ -1,31 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / WithOptional
-
-# Type Alias: WithOptional\<TBase, TExtra\>
-
-```ts
-type WithOptional<TBase, TExtra> = TBase | (TBase & TExtra);
-```
-
-Defined in: [packages/play-xstate/src/routing/schemas.ts:55](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/schemas.ts#L55)
-
-Adds `TExtra` as an optional-by-union extension of `TBase`.
-
-XState v6's `InferEvents` wraps every event payload in `Required<>` (to
-undo Zod-style optional inference), which would make `?`-marked fields
-mandatory on every send. Encoding optionality as a union sidesteps that:
-`Required<>` distributes over the members, each of which is already fully
-required. Use it for your own event payload schemas with optional fields.
-
-## Type Parameters
-
-| Type Parameter |
-| -------------- |
-| `TBase`        |
-| `TExtra`       |
-
-## Example
-
-```typescript
-type SavePayload = WithOptional<{ id: string }, { draft: boolean }>;
-// accepts { id } and { id, draft } — and survives InferEvents' Required<>
-```

package/api/@xmachines/play-xstate/variables/emptyEventSchema.md

@@ -1,37 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / emptyEventSchema
-
-# Variable: emptyEventSchema
-
-```ts
-const emptyEventSchema: TypeSchema<Record<string, never>>;
-```
-
-Defined in: [packages/play-xstate/src/schemas.ts:29](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/schemas.ts#L29)
-
-Event schema for a payload-less event, for use in an XState v6
-`schemas.events` map.
-
-Most Play machines carry events with no payload (`auth.logout`, `timer`,
-…) — declare them with this constant instead of re-spelling
-`types<Record<string, never>>()` per event.
-
-## Example
-
-```typescript
-import { setup } from "xstate";
-import { emptyEventSchema, playRouteEventSchema } from "@xmachines/play-xstate";
-
-setup({
-	schemas: {
-		events: {
-			"play.route": playRouteEventSchema,
-			"auth.logout": emptyEventSchema,
-		},
-	},
-});
-```
-
-## See
-
-[playRouteEventSchema](playRouteEventSchema.md) and [playMetaSchema](playMetaSchema.md) for the routing
-schema constants

package/api/@xmachines/play-xstate/variables/playMetaSchema.md

@@ -1,40 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / playMetaSchema
-
-# Variable: playMetaSchema
-
-```ts
-const playMetaSchema: TypeSchema<{
-	route?: RouteMetadata;
-	view?: PlaySpec;
-}>;
-```
-
-Defined in: [packages/play-xstate/src/routing/schemas.ts:98](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/schemas.ts#L98)
-
-State meta schema for Play's routing/view metadata, for use as an XState v6
-`schemas.meta` declaration.
-
-XState v6 types state `meta` as `never` unless a meta schema is declared, so
-every machine that carries `meta.route` templates or `meta.view` specs needs
-this schema. `route` accepts both the string template form
-(`"/profile/:username"`) and the object form (`{ path, title }` — see
-[RouteMetadata](../type-aliases/RouteMetadata.md)); `view` is a Play view [PlaySpec](../../play-actor/interfaces/PlaySpec.md).
-
-## Example
-
-```typescript
-import { createMachine } from "xstate";
-import { playMetaSchema } from "@xmachines/play-xstate";
-
-const machine = createMachine({
-	schemas: { meta: playMetaSchema },
-	initial: "home",
-	states: {
-		home: { id: "home", meta: { route: "/" } },
-	},
-});
-```
-
-## See
-
-[playRouteEventSchema](playRouteEventSchema.md) for the companion `play.route` event schema

package/api/@xmachines/play-xstate/variables/playRouteEventSchema.md

@@ -1,9 +0,0 @@
-[API](../../../README.md) / [@xmachines/play-xstate](../README.md) / playRouteEventSchema
-
-# Variable: playRouteEventSchema
-
-```ts
-const playRouteEventSchema: TypeSchema<PlayRoutePayload>;
-```
-
-Defined in: [packages/play-xstate/src/routing/schemas.ts:70](https://gitlab.com/xmachin-es/xmachines-js/-/blob/v2.0.0-alpha.1/packages/play-xstate/src/routing/schemas.ts#L70)