xstate 6.0.0-alpha.43 → 6.0.0-alpha.44

package/dist/declarations/src/schema.types.d.ts

@@ -7,6 +7,8 @@ export interface StandardSchemaV1<Input = unknown, Output = Input> {
 export type SetupStateSchemas = {
     context?: StandardSchemaV1;
     input?: StandardSchemaV1;
+    /** The output emitted when this state node completes. */
+    output?: StandardSchemaV1;
 };
 /** A type-only Standard Schema produced by {@link types}. */
 export interface TypeSchema<T> extends StandardSchemaV1<T, T> {

package/dist/declarations/src/setup.d.ts

@@ -140,7 +140,7 @@ export type SetupSchemas = {
     tags?: StandardSchemaV1;
     children?: Record<string, StandardSchemaV1>;
 };
-/** State schema with optional schemas.input and nested states */
+/** State schema with optional input/output schemas and nested states */
 export interface SetupStateSchema {
     schemas?: SetupStateSchemas;
     states?: Record<string, SetupStateSchema>;
@@ -236,6 +236,11 @@ type ValidateSetupDelayReferences<TConfig, TSetupDelays extends string> = string
 type StateInput<TStateSchema extends SetupStateSchema> = TStateSchema['schemas'] extends {
     input: infer TInputSchema;
 } ? TInputSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TInputSchema> : undefined : undefined;
+/** Extracts the completion output type from a state schema. */
+type StateOutput<TStateSchema extends SetupStateSchema, TFallback> = TStateSchema['schemas'] extends {
+    output: infer TOutputSchema;
+} ? TOutputSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TOutputSchema> : TFallback : TFallback;
+type StateCompletionOutput<TStateSchema extends SetupStateSchema> = StateOutput<TStateSchema, unknown>;
 type StateContext<TStateSchema extends SetupStateSchema, TFallbackContext extends MachineContext> = TStateSchema['schemas'] extends {
     context: infer TContextSchema;
 } ? TContextSchema extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TContextSchema> & MachineContext & RootContextMarker<TFallbackContext> : RootContext<TFallbackContext> : RootContext<TFallbackContext>;
@@ -262,6 +267,9 @@ type SetupStateSchemaToStateSchema<TSetupSchema extends SetupStateSchema> = {
     contextSchema: TSetupSchema['schemas'] extends {
         context: infer TContextSchema;
     } ? TContextSchema extends StandardSchemaV1 ? TContextSchema : undefined : undefined;
+    outputSchema: TSetupSchema['schemas'] extends {
+        output: infer TOutputSchema;
+    } ? TOutputSchema extends StandardSchemaV1 ? TOutputSchema : undefined : undefined;
     states: TSetupSchema['states'] extends Record<string, SetupStateSchema> ? {
         [K in keyof TSetupSchema['states'] & string]: SetupStateSchemaToStateSchema<TSetupSchema['states'][K]>;
     } : undefined;
@@ -286,11 +294,17 @@ type StateSchemaContextSchema<TConfig extends StateSchema, TSetup extends StateS
 } ? TContextSchema extends StandardSchemaV1 ? TContextSchema : undefined : TConfig extends {
     contextSchema: infer TContextSchema;
 } ? TContextSchema extends StandardSchemaV1 ? TContextSchema : undefined : undefined;
+type StateSchemaOutputSchema<TConfig extends StateSchema, TSetup extends StateSchema> = TSetup extends {
+    outputSchema: infer TOutputSchema;
+} ? TOutputSchema extends StandardSchemaV1 ? TOutputSchema : undefined : TConfig extends {
+    outputSchema: infer TOutputSchema;
+} ? TOutputSchema extends StandardSchemaV1 ? TOutputSchema : undefined : undefined;
 type StateSchemaChild<TSetup extends StateSchema, K extends string> = TSetup extends {
     states: infer TStates;
 } ? K extends keyof TStates ? Cast<TStates[K], StateSchema> : EmptyStateSchema : EmptyStateSchema;
 type MergeStateSchema<TConfig extends StateSchema, TSetup extends StateSchema> = Omit<TConfig, 'contextSchema' | 'input' | 'states'> & {
     contextSchema: StateSchemaContextSchema<TConfig, TSetup>;
+    outputSchema: StateSchemaOutputSchema<TConfig, TSetup>;
     input: StateSchemaInput<TConfig, TSetup>;
     states: TConfig extends {
         states: infer TStates;
@@ -321,7 +335,7 @@ type StatesWithInput<TRootStateSchemas extends Record<string, SetupStateSchema>,
     [K in TStateKeys]?: StateNodeConfigWithNestedInput<StateSchemasWithKeys<TRootStateSchemas, TStateKeys>, K extends keyof TStateSchemas ? TStateSchemas[K] : {}, TContext, TContextShape, TEvent, TChildren, TDelays, TTag, TOutput, TEmitted, TMeta, TActionMap, TActorMap, TGuardMap, TDelayMap, TSystemRegistry>;
 };
 /** State node config that recursively applies typed input for nested states */
-type StateNodeConfigWithNestedInput<TSiblingStateSchemas extends Record<string, SetupStateSchema>, TStateSchema extends SetupStateSchema, TContext extends MachineContext, TContextShape, TEvent extends EventObject, TChildren extends Record<string, AnyActorRef | undefined>, TDelays extends string, TTag extends string, TOutput, TEmitted extends EventObject, TMeta extends MetaObject, TActionMap extends Sources['actions'], TActorMap extends Sources['actors'], TGuardMap extends Sources['guards'], TDelayMap extends Sources['delays'], TSystemRegistry extends SystemRegistry> = WithNestedStates<Omit<Next_StateNodeConfig<StateContext<TStateSchema, TContext>, TEvent, TDelays, TTag, TOutput, TEmitted, TMeta, TChildren, TActionMap, TActorMap, TGuardMap, TDelayMap, StateInput<TStateSchema>, Record<string, unknown>, TSystemRegistry>, 'on' | 'always' | 'initial' | 'invoke' | 'onDone' | 'onError' | 'onTimeout' | 'after'> & {
+type StateNodeConfigWithNestedInput<TSiblingStateSchemas extends Record<string, SetupStateSchema>, TStateSchema extends SetupStateSchema, TContext extends MachineContext, TContextShape, TEvent extends EventObject, TChildren extends Record<string, AnyActorRef | undefined>, TDelays extends string, TTag extends string, TOutput, TEmitted extends EventObject, TMeta extends MetaObject, TActionMap extends Sources['actions'], TActorMap extends Sources['actors'], TGuardMap extends Sources['guards'], TDelayMap extends Sources['delays'], TSystemRegistry extends SystemRegistry> = WithNestedStates<Omit<Next_StateNodeConfig<StateContext<TStateSchema, TContext>, TEvent, TDelays, TTag, StateOutput<TStateSchema, TOutput>, TEmitted, TMeta, TChildren, TActionMap, TActorMap, TGuardMap, TDelayMap, StateInput<TStateSchema>, Record<string, unknown>, TSystemRegistry, StateCompletionOutput<TStateSchema>>, 'on' | 'always' | 'initial' | 'invoke' | 'onDone' | 'onError' | 'onTimeout' | 'after'> & {
     initial?: TStateSchema['states'] extends Record<string, SetupStateSchema> ? SetupStateKey<TStateSchema['states']> | (string & {}) | InitialTransitionWithInput<TStateSchema['states'], StateContext<TStateSchema, TContext>, TEvent> : string | {
         target: string;
         input?: Record<string, unknown>;
@@ -329,7 +343,7 @@ type StateNodeConfigWithNestedInput<TSiblingStateSchemas extends Record<string,
     on?: StateTransitions<TSiblingStateSchemas, StateContext<TStateSchema, TContext>, StateContextShape<TStateSchema, TContextShape>, TEvent, TEmitted, TChildren, TMeta, TActionMap, TActorMap, TGuardMap, TDelayMap, TSystemRegistry, StateInput<TStateSchema>>;
     always?: StateTransitionConfigOrTarget<TSiblingStateSchemas, StateContext<TStateSchema, TContext>, StateContextShape<TStateSchema, TContextShape>, TEvent, TEvent, TEmitted, TChildren, TMeta, TActionMap, TActorMap, TGuardMap, TDelayMap, TSystemRegistry, StateInput<TStateSchema>>;
     invoke?: SingleOrArray<SetupInvokeConfig<TSiblingStateSchemas, StateContext<TStateSchema, TContext>, StateContextShape<TStateSchema, TContextShape>, TEvent, TEmitted, TChildren, TMeta, TActionMap, TActorMap, TGuardMap, TDelayMap, TSystemRegistry>>;
-    onDone?: StateTransitionConfigOrTarget<TSiblingStateSchemas, StateContext<TStateSchema, TContext>, StateContextShape<TStateSchema, TContextShape>, DoneStateEvent, TEvent, TEmitted, TChildren, TMeta, TActionMap, TActorMap, TGuardMap, TDelayMap, TSystemRegistry, StateInput<TStateSchema>>;
+    onDone?: StateTransitionConfigOrTarget<TSiblingStateSchemas, StateContext<TStateSchema, TContext>, StateContextShape<TStateSchema, TContextShape>, DoneStateEvent<StateCompletionOutput<TStateSchema>>, TEvent, TEmitted, TChildren, TMeta, TActionMap, TActorMap, TGuardMap, TDelayMap, TSystemRegistry, StateInput<TStateSchema>>;
     onError?: StateTransitionConfigOrTarget<TSiblingStateSchemas, StateContext<TStateSchema, TContext>, StateContextShape<TStateSchema, TContextShape>, ErrorEvent, TEvent, TEmitted, TChildren, TMeta, TActionMap, TActorMap, TGuardMap, TDelayMap, TSystemRegistry, StateInput<TStateSchema>>;
     onTimeout?: StateTransitionConfigOrTarget<TSiblingStateSchemas, StateContext<TStateSchema, TContext>, StateContextShape<TStateSchema, TContextShape>, TimeoutEvent, TEvent, TEmitted, TChildren, TMeta, TActionMap, TActorMap, TGuardMap, TDelayMap, TSystemRegistry, StateInput<TStateSchema>>;
     after?: {

package/dist/declarations/src/types.d.ts

@@ -1003,6 +1003,7 @@ export type StateSchema = {
     route?: unknown;
     states?: Record<string, StateSchema>;
     contextSchema?: StandardSchemaV1;
+    outputSchema?: StandardSchemaV1;
     input?: unknown;
     type?: unknown;
     history?: unknown;

package/dist/declarations/src/types.v6.d.ts

@@ -388,7 +388,7 @@ interface Next_RegularStateNodeConfig<TContext extends MachineContext, TEvent ex
      * This is equivalent to defining a `[done(id)]` transition on this state
      * node's `on` property.
      */
-    onDone?: Next_TransitionConfigOrTarget<TContext, DoneStateEvent, TEvent, TEmitted, TActionMap, TActorMap, TGuardMap, TDelayMap, TMeta>;
+    onDone?: Next_TransitionConfigOrTarget<TContext, DoneStateEvent<TChildOutput>, TEvent, TEmitted, TActionMap, TActorMap, TGuardMap, TDelayMap, TMeta>;
     /**
      * The transition to take when an `xstate.error.*` event is raised while this
      * state node or one of its descendants is active.

package/dist/xstate.cjs.js

@@ -2248,7 +2248,7 @@ function isTypeSchema(value) {
 
 // eslint-disable-next-line @typescript-eslint/no-namespace
 
-/** State schema with optional schemas.input and nested states */
+/** State schema with optional input/output schemas and nested states */
 
 /**
  * The sibling state schemas of a dotted path: the children of the path's
@@ -2274,6 +2274,8 @@ function isTypeSchema(value) {
 
 /** Extracts input type from a state schema */
 
+/** Extracts the completion output type from a state schema. */
+
 /**
  * Converts SetupStateSchema to StateSchema with input types included. This
  * allows getInputs() to be strongly typed.

package/dist/xstate.development.cjs.js

@@ -2248,7 +2248,7 @@ function isTypeSchema(value) {
 
 // eslint-disable-next-line @typescript-eslint/no-namespace
 
-/** State schema with optional schemas.input and nested states */
+/** State schema with optional input/output schemas and nested states */
 
 /**
  * The sibling state schemas of a dotted path: the children of the path's
@@ -2274,6 +2274,8 @@ function isTypeSchema(value) {
 
 /** Extracts input type from a state schema */
 
+/** Extracts the completion output type from a state schema. */
+
 /**
  * Converts SetupStateSchema to StateSchema with input types included. This
  * allows getInputs() to be strongly typed.

package/dist/xstate.development.esm.js

@@ -2246,7 +2246,7 @@ function isTypeSchema(value) {
 
 // eslint-disable-next-line @typescript-eslint/no-namespace
 
-/** State schema with optional schemas.input and nested states */
+/** State schema with optional input/output schemas and nested states */
 
 /**
  * The sibling state schemas of a dotted path: the children of the path's
@@ -2272,6 +2272,8 @@ function isTypeSchema(value) {
 
 /** Extracts input type from a state schema */
 
+/** Extracts the completion output type from a state schema. */
+
 /**
  * Converts SetupStateSchema to StateSchema with input types included. This
  * allows getInputs() to be strongly typed.

package/dist/xstate.esm.js

@@ -2246,7 +2246,7 @@ function isTypeSchema(value) {
 
 // eslint-disable-next-line @typescript-eslint/no-namespace
 
-/** State schema with optional schemas.input and nested states */
+/** State schema with optional input/output schemas and nested states */
 
 /**
  * The sibling state schemas of a dotted path: the children of the path's
@@ -2272,6 +2272,8 @@ function isTypeSchema(value) {
 
 /** Extracts input type from a state schema */
 
+/** Extracts the completion output type from a state schema. */
+
 /**
  * Converts SetupStateSchema to StateSchema with input types included. This
  * allows getInputs() to be strongly typed.