@xmachines/play-xstate 2.0.0-alpha.1 → 2.1.0

package/dist/routing/schemas.d.ts

@@ -1,99 +0,0 @@
-import type { PlayRouteEvent } from "@xmachines/play-router";
-import type { PlaySpec } from "@xmachines/play-actor";
-import type { RouteMetadata } from "./types.js";
-/**
- * Event schema for the `play.route` navigation event, for use in an XState v6
- * `schemas.events` map.
- *
- * XState v6 declares machine events as a map of event type to payload schema
- * (payloads exclude the `type` field). Every Play machine handles `play.route`,
- * so this constant is the single source of truth for its payload shape —
- * declare it instead of re-deriving the payload shape per machine. The payload
- * is authored explicitly (not `Omit<PlayRouteEvent, "type">`): `Omit` over
- * PlayRouteEvent's index signature collapses the named props and would erase
- * all payload checking.
- *
- * @example
- * ```typescript
- * import { setup } from "xstate";
- * import {
- *   emptyEventSchema,
- *   playMetaSchema,
- *   playRouteEventSchema,
- * } from "@xmachines/play-xstate";
- *
- * const authSetup = setup({
- *   schemas: {
- *     events: {
- *       "play.route": playRouteEventSchema,
- *       "auth.logout": emptyEventSchema,
- *     },
- *     meta: playMetaSchema,
- *   },
- * });
- * ```
- *
- * @see {@link playMetaSchema} for the companion state-meta schema
- */
-/**
- * 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.
- *
- * @example
- * ```typescript
- * type SavePayload = WithOptional<{ id: string }, { draft: boolean }>;
- * // accepts { id } and { id, draft } — and survives InferEvents' Required<>
- * ```
- */
-export type WithOptional<TBase, TExtra> = TBase | (TBase & TExtra);
-/**
- * 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.
- */
-export type PlayRoutePayload = WithOptional<WithOptional<WithOptional<{
-    to: PlayRouteEvent["to"];
-}, {
-    params: Record<string, string>;
-}>, {
-    query: Record<string, string>;
-}>, {
-    match: unknown;
-}>;
-export declare const playRouteEventSchema: import("xstate").TypeSchema<PlayRoutePayload>;
-/**
- * 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
- * {@link RouteMetadata}); `view` is a Play view {@link PlaySpec}.
- *
- * @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 {@link playRouteEventSchema} for the companion `play.route` event schema
- */
-export declare const playMetaSchema: import("xstate").TypeSchema<{
-    route?: RouteMetadata;
-    view?: PlaySpec;
-}>;
-//# sourceMappingURL=schemas.d.ts.map

package/dist/routing/schemas.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../../src/routing/schemas.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,YAAY,CAAC,KAAK,EAAE,MAAM,IAAI,KAAK,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,CAAC;AAEnE;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,YAAY,CAC1C,YAAY,CACX,YAAY,CAAC;IAAE,EAAE,EAAE,cAAc,CAAC,IAAI,CAAC,CAAA;CAAE,EAAE;IAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CAAC,EAC9E;IAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CACjC,EACD;IAAE,KAAK,EAAE,OAAO,CAAA;CAAE,CAClB,CAAC;AAEF,eAAO,MAAM,oBAAoB,+CAA4B,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,cAAc;YAAmB,aAAa;WAAS,QAAQ;EAAK,CAAC"}

package/dist/routing/schemas.js

@@ -1,30 +0,0 @@
-import { types } from "xstate";
-export const playRouteEventSchema = types();
-/**
- * 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
- * {@link RouteMetadata}); `view` is a Play view {@link PlaySpec}.
- *
- * @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 {@link playRouteEventSchema} for the companion `play.route` event schema
- */
-export const playMetaSchema = types();
-//# sourceMappingURL=schemas.js.map

package/dist/routing/schemas.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../src/routing/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAqE/B,MAAM,CAAC,MAAM,oBAAoB,GAAG,KAAK,EAAoB,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAA8C,CAAC"}

package/dist/schemas.d.ts

@@ -1,28 +0,0 @@
-/**
- * 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 {@link playRouteEventSchema} and {@link playMetaSchema} for the routing
- *   schema constants
- */
-export declare const emptyEventSchema: import("xstate").TypeSchema<Record<string, never>>;
-//# sourceMappingURL=schemas.d.ts.map

package/dist/schemas.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemas.d.ts","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,gBAAgB,oDAAiC,CAAC"}

package/dist/schemas.js

@@ -1,29 +0,0 @@
-import { types } from "xstate";
-/**
- * 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 {@link playRouteEventSchema} and {@link playMetaSchema} for the routing
- *   schema constants
- */
-export const emptyEventSchema = types();
-//# sourceMappingURL=schemas.js.map

package/dist/schemas.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../src/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,QAAQ,CAAC;AAE/B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAyB,CAAC"}