xstate 6.0.0-alpha.8 → 6.0.0-alpha.9

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

@@ -1,8 +1,14 @@
 import { MachineSnapshot } from "./State.js";
 import { StateNode } from "./StateNode.js";
 import { AnyActorSystem } from "./system.js";
-import type { ActorLogic, ActorLogicTransitionResult, ActorScope, AnyActor, AnyActorRef, AnyActorScope, AnyTransitionDefinition, Equals, EventDescriptor, EventObject, ExecutableActionObjectFromLogic, HistoryValue, MachineContext, MetaObject, Snapshot, StateValue, StateSchema, SnapshotStatus } from "./types.js";
+import type { ActorLogic, ActorLogicTransitionResult, ActorScope, AnyActor, AnyActorLogic, AnyActorRef, AnyActorScope, AnyTransitionDefinition, Equals, EventDescriptor, EmittedFrom, EventObject, EventFromLogic, ExecutableActionObjectFromLogic, HistoryValue, InputFrom, IsAny, MachineContext, MetaObject, OutputFrom, Snapshot, SnapshotFrom, StateValue, StateSchema, SnapshotStatus } from "./types.js";
 import { AnyMachineSchemas, Implementations, Next_MachineConfig, MachineOptions } from "./types.v6.js";
+type CompatibleProvidedActorSource<TExpected extends AnyActorLogic, TActual extends AnyActorLogic> = IsAny<TActual> extends true ? TActual : [OutputFrom<TActual>] extends [OutputFrom<TExpected>] ? [Omit<SnapshotFrom<TActual>, 'input'>] extends [
+    Omit<SnapshotFrom<TExpected>, 'input'>
+] ? [InputFrom<TExpected>] extends [InputFrom<TActual>] ? [EventFromLogic<TExpected>] extends [EventFromLogic<TActual>] ? [EmittedFrom<TActual>] extends [EmittedFrom<TExpected>] ? TActual : never : never : never : never : never;
+type ProvidedActorSources<TExpectedActorMap extends Implementations['actorSources'], TProvidedActorMap extends Partial<Record<keyof TExpectedActorMap & string, AnyActorLogic>>> = {
+    [K in keyof TProvidedActorMap]: K extends keyof TExpectedActorMap ? TProvidedActorMap[K] extends AnyActorLogic ? CompatibleProvidedActorSource<TExpectedActorMap[K], TProvidedActorMap[K]> : never : never;
+};
 export declare class StateMachine<TContext extends MachineContext, TEvent extends EventObject, TChildren extends Record<string, AnyActorRef | undefined>, TStateValue extends StateValue, TTag extends string, TInput, TOutput, TEmitted extends EventObject, TMeta extends MetaObject, TConfig extends StateSchema, TActionMap extends Implementations['actions'], TActorMap extends Implementations['actorSources'], TGuardMap extends Implementations['guards'], TDelayMap extends Implementations['delays']> implements ActorLogic<MachineSnapshot<TContext, TEvent, TChildren, TStateValue, TTag, TOutput, TMeta, TConfig>, TEvent, TInput, AnyActorSystem, TEmitted> {
     /** The raw config used to create the machine. */
     config: Next_MachineConfig<any, any, any, any, any, any, any, any, any, any, any> & {
@@ -33,9 +39,9 @@ export declare class StateMachine<TContext extends MachineContext, TEvent extend
      *   `delays`) to recursively merge with the existing options.
      * @returns A new `StateMachine` instance with the provided implementations.
      */
-    provide(implementations: {
+    provide<const TProvidedActorMap extends Partial<Record<keyof TActorMap & string, AnyActorLogic>> = {}>(implementations: {
         actions?: Partial<TActionMap>;
-        actorSources?: Partial<TActorMap>;
+        actorSources?: TProvidedActorMap & ProvidedActorSources<TActorMap, TProvidedActorMap>;
         guards?: Partial<TGuardMap>;
         delays?: Partial<TDelayMap>;
     }): StateMachine<TContext, TEvent, TChildren, TStateValue, TTag, TInput, TOutput, TEmitted, TMeta, TConfig, TActionMap, TActorMap, TGuardMap, TDelayMap>;
@@ -78,3 +84,4 @@ export declare class StateMachine<TContext extends MachineContext, TEvent extend
     getPersistedSnapshot(snapshot: MachineSnapshot<TContext, TEvent, TChildren, TStateValue, TTag, TOutput, TMeta, TConfig>, options?: unknown): Snapshot<unknown>;
     restoreSnapshot(snapshot: Snapshot<unknown>, _actorScope: ActorScope<MachineSnapshot<TContext, TEvent, TChildren, TStateValue, TTag, TOutput, TMeta, TConfig>, TEvent, AnyActorSystem, TEmitted>): MachineSnapshot<TContext, TEvent, TChildren, TStateValue, TTag, TOutput, TMeta, TConfig>;
 }
+export {};

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

@@ -8,6 +8,7 @@ export { machineConfigToJSON, serializeMachine, type CodeExpression, type Unseri
 export { mapState } from "./mapState.js";
 export { types, isTypeSchema, type StandardSchemaV1, type TypeSchema } from "./schema.types.js";
 export { createSystem, setup } from "./setup.js";
+export type { AnySetupConfig, SetupConfig, SetupReturn, SetupReturnFromConfig, SetupSchemas, SetupStateSchema, SetupStateSchemas } from "./setup.js";
 export { getInitialSnapshot, getNextSnapshot } from "./getNextSnapshot.js";
 export type { InspectionEvent, ActorInspectionEvent, TransitionInspectionEvent, ActionRecord, SentRecord } from "./inspection.js";
 export { SimulatedClock } from "./SimulatedClock.js";

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

@@ -5,7 +5,7 @@ import { AnyActorRef, AnyActorLogic, ActorRefFromLogic, AnyStateNode, EventObjec
 import { AnyActorSystem } from "./system.js";
 import { InspectionEvent } from "./inspection.js";
 import { DelayMapFromNames, InferChildren, Implementations, InferOutput, InferEvents, Next_MachineConfig, Next_StateNodeConfig, WithDefault } from "./types.v6.js";
-type SetupConfig<TSchemas extends SetupSchemas, TStates extends Record<string, SetupStateSchema>, TActionMap extends Implementations['actions'], TActorMap extends Implementations['actorSources'], TGuardMap extends Implementations['guards'], TDelayMap extends Implementations['delays']> = {
+export type SetupConfig<TSchemas extends SetupSchemas, TStates extends Record<string, SetupStateSchema>, TActionMap extends Implementations['actions'], TActorMap extends Implementations['actorSources'], TGuardMap extends Implementations['guards'], TDelayMap extends Implementations['delays']> = {
     schemas?: TSchemas;
     states?: TStates;
     actions?: TActionMap;
@@ -13,6 +13,7 @@ type SetupConfig<TSchemas extends SetupSchemas, TStates extends Record<string, S
     guards?: TGuardMap;
     delays?: TDelayMap;
 };
+export type AnySetupConfig = SetupConfig<SetupSchemas, Record<string, SetupStateSchema>, Implementations['actions'], Implementations['actorSources'], Implementations['guards'], Implementations['delays']>;
 type SystemConfig<TSystemRegistry extends SystemRegistry> = {
     registry?: TSystemRegistry;
 };
@@ -49,11 +50,11 @@ type ValidateRegistryKeys<TConfig, TSystemRegistry extends SystemRegistry, TActo
         [K in keyof TStates]: TStates[K] & ValidateRegistryKeys<TStates[K], TSystemRegistry, TActorMap>;
     };
 } : unknown);
-type SetupStateSchemas = {
+export type SetupStateSchemas = {
     context?: StandardSchemaV1;
     input?: StandardSchemaV1;
 };
-type SetupSchemas = {
+export type SetupSchemas = {
     context?: StandardSchemaV1;
     events?: Record<string, StandardSchemaV1>;
     emitted?: Record<string, StandardSchemaV1>;
@@ -64,7 +65,7 @@ type SetupSchemas = {
     children?: Record<string, StandardSchemaV1>;
 };
 /** State schema with optional schemas.input and nested states */
-interface SetupStateSchema {
+export interface SetupStateSchema {
     schemas?: SetupStateSchemas;
     states?: Record<string, SetupStateSchema>;
 }
@@ -300,7 +301,7 @@ type InitialTransitionWithInput<TStateSchemas extends Record<string, SetupStateS
     };
 }[keyof TStateSchemas & string];
 /** Return type of setup() */
-interface SetupReturn<TStates extends Record<string, SetupStateSchema> = Record<string, SetupStateSchema>, TSchemas extends SetupSchemas = {}, TSetupActionMap extends Implementations['actions'] = {}, TSetupActorMap extends Implementations['actorSources'] = {}, TSetupGuardMap extends Implementations['guards'] = {}, TSetupDelayMap extends Implementations['delays'] = {}, TSetupDelays extends string = Extract<keyof TSetupDelayMap, string>, TSystemRegistry extends SystemRegistry = SystemRegistry> {
+export interface SetupReturn<TStates extends Record<string, SetupStateSchema> = Record<string, SetupStateSchema>, TSchemas extends SetupSchemas = {}, TSetupActionMap extends Implementations['actions'] = {}, TSetupActorMap extends Implementations['actorSources'] = {}, TSetupGuardMap extends Implementations['guards'] = {}, TSetupDelayMap extends Implementations['delays'] = {}, TSetupDelays extends string = Extract<keyof TSetupDelayMap, string>, TSystemRegistry extends SystemRegistry = SystemRegistry> {
     /** Extends the setup configuration */
     extend<const TExtendSchemas extends SetupSchemas = {}, const TExtendStates extends Record<string, SetupStateSchema> = {}, TExtendActionMap extends Implementations['actions'] = {}, TExtendActorMap extends Implementations['actorSources'] = {}, TExtendGuardMap extends Implementations['guards'] = {}, TExtendDelayMap extends Implementations['delays'] = {}>(config: SetupConfig<TExtendSchemas, TExtendStates, TExtendActionMap, TExtendActorMap, TExtendGuardMap, TExtendDelayMap>): SetupReturn<MergeImplementationMaps<TStates, TExtendStates>, MergeImplementationMaps<TSchemas, TExtendSchemas>, MergeImplementationMaps<TSetupActionMap, TExtendActionMap>, MergeImplementationMaps<TSetupActorMap, TExtendActorMap>, MergeImplementationMaps<TSetupGuardMap, TExtendGuardMap>, MergeImplementationMaps<TSetupDelayMap, TExtendDelayMap>, TSetupDelays | Extract<keyof TExtendDelayMap, string>, TSystemRegistry>;
     /** Creates a state machine with the setup configuration */
@@ -330,6 +331,25 @@ interface SetupReturn<TStates extends Record<string, SetupStateSchema> = Record<
     /** State input schemas from setup config */
     states: TStates;
 }
+type SetupConfigSchemas<TConfig> = TConfig extends {
+    schemas?: infer TSchemas;
+} ? TSchemas extends SetupSchemas ? TSchemas : {} : {};
+type SetupConfigStates<TConfig> = TConfig extends {
+    states?: infer TStates;
+} ? TStates extends Record<string, SetupStateSchema> ? TStates : Record<string, SetupStateSchema> : Record<string, SetupStateSchema>;
+type SetupConfigActions<TConfig> = TConfig extends {
+    actions?: infer TActions;
+} ? TActions extends Implementations['actions'] ? TActions : {} : {};
+type SetupConfigActorSources<TConfig> = TConfig extends {
+    actorSources?: infer TActorSources;
+} ? TActorSources extends Implementations['actorSources'] ? TActorSources : {} : {};
+type SetupConfigGuards<TConfig> = TConfig extends {
+    guards?: infer TGuards;
+} ? TGuards extends Implementations['guards'] ? TGuards : {} : {};
+type SetupConfigDelays<TConfig> = TConfig extends {
+    delays?: infer TDelays;
+} ? TDelays extends Implementations['delays'] ? TDelays : {} : {};
+export type SetupReturnFromConfig<TConfig extends AnySetupConfig> = SetupReturn<SetupConfigStates<TConfig>, SetupConfigSchemas<TConfig>, SetupConfigActions<TConfig>, SetupConfigActorSources<TConfig>, SetupConfigGuards<TConfig>, SetupConfigDelays<TConfig>>;
 /**
  * Sets up a state machine with state input schemas and other configuration.
  *
@@ -366,7 +386,9 @@ interface SetupReturn<TStates extends Record<string, SetupStateSchema> = Record<
  * });
  * ```
  */
-export declare function setup<const TSchemas extends SetupSchemas = {}, const TStates extends Record<string, SetupStateSchema> = Record<string, SetupStateSchema>, TActionMap extends Implementations['actions'] = {}, TActorMap extends Implementations['actorSources'] = {}, TGuardMap extends Implementations['guards'] = {}, TDelayMap extends Implementations['delays'] = {}>(config?: SetupConfig<TSchemas, TStates, TActionMap, TActorMap, TGuardMap, TDelayMap>): SetupReturn<TStates, TSchemas, TActionMap, TActorMap, TGuardMap, TDelayMap>;
+export declare function setup(): SetupReturn;
+export declare function setup<const TSchemas extends SetupSchemas = {}, const TStates extends Record<string, SetupStateSchema> = Record<string, SetupStateSchema>, TActionMap extends Implementations['actions'] = {}, TActorMap extends Implementations['actorSources'] = {}, TGuardMap extends Implementations['guards'] = {}, TDelayMap extends Implementations['delays'] = {}>(config: SetupConfig<TSchemas, TStates, TActionMap, TActorMap, TGuardMap, TDelayMap>): SetupReturn<TStates, TSchemas, TActionMap, TActorMap, TGuardMap, TDelayMap>;
+export declare function setup<const TConfig extends AnySetupConfig>(config: TConfig): SetupReturnFromConfig<TConfig>;
 type SystemBuilder<TSystemRegistry extends SystemRegistry> = {
     createActor<TLogic extends AnyActorLogic>(logic: TLogic, options?: Omit<ActorOptions<TLogic>, 'registryKey'> & {
         registryKey?: RegistryKeyForLogic<TLogic, TSystemRegistry>;

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

@@ -1,6 +1,6 @@
 import { StandardSchemaV1 } from "./schema.types.js";
 import { MachineSnapshot } from "./State.js";
-import { Action, ActorLogic, ActorRef, ActorRefFromLogic, ActorSelf, AnyActorLogic, AnyActorRef, Compute, DoneActorEvent, DoNotInfer, EventDescriptor, EventObject, ExtractEvent, InitialContext, InputFrom, IsNever, MetaObject, NonReducibleUnknown, SingleOrArray, SnapshotEvent, StateValue, TODO, TransitionConfigFunction, Values, AnyStateNode, SystemRegistry } from "./types.js";
+import { Action, ActorLogic, ActorRef, ActorRefFromLogic, ActorSelf, AnyActorLogic, AnyActorRef, Compute, DoneActorEvent, DoNotInfer, EventDescriptor, EventObject, ExtractEvent, InitialContext, InputFrom, IsNever, MetaObject, NonReducibleUnknown, OutputFrom, SingleOrArray, SnapshotEvent, StateValue, TODO, TransitionConfigFunction, Values, AnyStateNode, SystemRegistry } from "./types.js";
 import { MachineContext, Mapper } from "./types.js";
 import { LowInfer } from "./types.js";
 import { DoneStateEvent } from "./types.js";
@@ -13,6 +13,10 @@ export type InferOutput<T extends StandardSchemaV1, U> = Compute<StandardSchemaV
 export type InferEvents<TEventSchemaMap extends Record<string, StandardSchemaV1>> = Values<{
     [K in keyof TEventSchemaMap & string]: StandardSchemaV1.InferOutput<TEventSchemaMap[K]> extends infer O ? unknown extends O ? O & {
         type: K;
+    } : string extends keyof O ? [O[string]] extends [never] ? {
+        type: K;
+    } : Required<O> & {
+        type: K;
     } : Required<O> & {
         type: K;
     } : never;
@@ -142,16 +146,21 @@ export type Next_InvokeConfig<TContext extends MachineContext, TEvent extends Ev
     src: string | AnyActorLogic | ((args: InvokeSrcArgs<TContext, TEvent, TActorMap>) => string | AnyActorLogic);
     input?: ((args: InvokeInputArgs<TContext, TEvent, TEmitted, TChildren>) => unknown) | NonReducibleUnknown;
 } : {
-    [K in keyof TActorMap & string]: Next_InvokeConfigBase<TContext, TEvent, TEmitted, TChildren, TActionMap, TActorMap, TGuardMap, TDelayMap, TMeta, TSystemRegistry> & {
-        src: K | TActorMap[K] | ((args: InvokeSrcArgs<TContext, TEvent, TActorMap>) => K | TActorMap[K]);
+    [K in keyof TActorMap & string]: Next_InvokeConfigBase<TContext, TEvent, TEmitted, TChildren, TActionMap, TActorMap, TGuardMap, TDelayMap, TMeta, TSystemRegistry, DoneActorEvent<OutputFrom<TActorMap[K]>>> & {
         id?: ChildIdForLogic<TActorMap[K], TChildren>;
         input?: ((args: InvokeInputArgs<TContext, TEvent, TEmitted, TChildren>) => InputFrom<TActorMap[K]>) | InputFrom<TActorMap[K]>;
-    };
+    } & ({
+        src: K;
+    } | {
+        src: TActorMap[K];
+    } | {
+        src: (args: InvokeSrcArgs<TContext, TEvent, TActorMap>) => K | TActorMap[K];
+    });
 }[keyof TActorMap & string] | InlineInvokeConfig<TContext, TEvent, TEmitted, TChildren, TActionMap, TActorMap, TGuardMap, TDelayMap, TMeta, TSystemRegistry>;
-interface Next_InvokeConfigBase<TContext extends MachineContext, TEvent extends EventObject, TEmitted extends EventObject, _TChildren extends Record<string, AnyActorRef | undefined>, TActionMap extends Implementations['actions'], TActorMap extends Implementations['actorSources'], TGuardMap extends Implementations['guards'], TDelayMap extends Implementations['delays'], TMeta extends MetaObject, TSystemRegistry extends SystemRegistry> {
+interface Next_InvokeConfigBase<TContext extends MachineContext, TEvent extends EventObject, TEmitted extends EventObject, _TChildren extends Record<string, AnyActorRef | undefined>, TActionMap extends Implementations['actions'], TActorMap extends Implementations['actorSources'], TGuardMap extends Implementations['guards'], TDelayMap extends Implementations['delays'], TMeta extends MetaObject, TSystemRegistry extends SystemRegistry, TDoneEvent extends EventObject = [keyof TActorMap & string] extends [never] ? DoneActorEvent<any> : DoneActorEvent<OutputFrom<TActorMap[keyof TActorMap & string]>>> {
     id?: string;
     registryKey?: keyof TSystemRegistry & string;
-    onDone?: Next_TransitionConfigOrTarget<TContext, DoneActorEvent<any>, TEvent, TEmitted, TActionMap, TActorMap, TGuardMap, TDelayMap, TMeta>;
+    onDone?: Next_TransitionConfigOrTarget<TContext, TDoneEvent, TEvent, TEmitted, TActionMap, TActorMap, TGuardMap, TDelayMap, TMeta>;
     onError?: Next_TransitionConfigOrTarget<TContext, ErrorEvent, TEvent, TEmitted, TActionMap, TActorMap, TGuardMap, TDelayMap, TMeta>;
     onSnapshot?: Next_TransitionConfigOrTarget<TContext, SnapshotEvent<any>, TEvent, TEmitted, TActionMap, TActorMap, TGuardMap, TDelayMap, TMeta>;
     /**