[core] Fix type issues with emitted events (#4932)

* Fix emitted event types * Changeset * Update packages/xstate-solid/src/fromActorRef.ts Co-authored-by: Christopher Hiller <boneskull@boneskull.com> * Fix type import * Update packages/core/test/emit.test.ts Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com> * Update packages/core/src/actors/index.ts Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com> * Move test --------- Co-authored-by: Christopher Hiller <boneskull@boneskull.com> Co-authored-by: Mateusz Burzyński <mateuszburzynski@gmail.com>
statelyai · Jun 11, 2024 · 71a7f86 · 71a7f86
1 parent 206e457
commit 71a7f86
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 15 deletions.
diff --git a/.changeset/nervous-chicken-eat.md b/.changeset/nervous-chicken-eat.md
@@ -0,0 +1,5 @@
+---
+'xstate': patch
+---
+
+Actors with emitted events should no longer cause type issues: https://github.com/statelyai/xstate/issues/4931
diff --git a/packages/core/src/actors/index.ts b/packages/core/src/actors/index.ts
@@ -27,6 +27,7 @@ const emptyLogic = fromTransition((_) => undefined, undefined);
 
 export function createEmptyActor(): ActorRef<
  Snapshot<undefined>,
+ AnyEventObject,
  AnyEventObject
 > {
  return createActor(emptyLogic);

diff --git a/packages/core/src/createActor.ts b/packages/core/src/createActor.ts
@@ -71,7 +71,8 @@ const defaultOptions = {
  * An Actor is a running process that can receive events, send events and change its behavior based on the events it receives, which can cause effects outside of the actor. When you run a state machine, it becomes an actor.
  */
 export class Actor<TLogic extends AnyActorLogic>
- implements ActorRef<SnapshotFrom<TLogic>, EventFromLogic<TLogic>>
+ implements
+ ActorRef<SnapshotFrom<TLogic>, EventFromLogic<TLogic>, EmittedFrom<TLogic>>
 {
  /**
  * The current internal state of the actor.
@@ -106,7 +107,11 @@ export class Actor<TLogic extends AnyActorLogic>
  public _parent?: AnyActorRef;
  /** @internal */
  public _syncSnapshot?: boolean;
- public ref: ActorRef<SnapshotFrom<TLogic>, EventFromLogic<TLogic>>;
+ public ref: ActorRef<
+ SnapshotFrom<TLogic>,
+ EventFromLogic<TLogic>,
+ EmittedFrom<TLogic>
+ >;
  // TODO: add typings for system
  private _actorScope: ActorScope<
  SnapshotFrom<TLogic>,

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -121,7 +121,8 @@ export interface UnifiedArg<
  unknown,
  TODO // TMeta
  >,
- TEvent
+ TEvent,
+ AnyEventObject
  >;
  system: AnyActorSystem;
 }
@@ -169,7 +170,7 @@ export type OutputFrom<T> = T extends ActorLogic<
  infer _TEmitted
 >
  ? (TSnapshot & { status: 'done' })['output']
- : T extends ActorRef<infer TSnapshot, infer _TEvent>
+ : T extends ActorRef<infer TSnapshot, infer _TEvent, infer _TEmitted>
  ? (TSnapshot & { status: 'done' })['output']
  : never;
 
@@ -1521,7 +1522,8 @@ export type ContextFactory<
  unknown,
  TODO // TMeta
  >,
- TEvent
+ TEvent,
+ AnyEventObject
  >;
 }) => TContext;
 
@@ -1827,7 +1829,8 @@ export type Mapper<
  unknown,
  TODO // TMeta
  >,
- TEvent
+ TEvent,
+ AnyEventObject
  >;
 }) => TResult;
 
@@ -2181,7 +2184,7 @@ export interface ActorRef<
  ) => Subscription;
 }
 
-export type AnyActorRef = ActorRef<any, any>;
+export type AnyActorRef = ActorRef<any, any, any>;
 
 export type ActorLogicFrom<T> = ReturnTypeOrValue<T> extends infer R
  ? R extends StateMachine<
@@ -2232,7 +2235,8 @@ export type ActorRefFrom<T> = ReturnTypeOrValue<T> extends infer R
  TOutput,
  TMeta
  >,
- TEvent
+ TEvent,
+ TEmitted
  >
  : R extends Promise<infer U>
  ? ActorRefFrom<PromiseActorLogic<U>>
@@ -2243,7 +2247,7 @@ export type ActorRefFrom<T> = ReturnTypeOrValue<T> extends infer R
  infer _TSystem,
  infer TEmitted
  >
- ? ActorRef<TSnapshot, TEvent>
+ ? ActorRef<TSnapshot, TEvent, TEmitted>
  : never
  : never;
 
@@ -2341,7 +2345,7 @@ export interface ActorScope<
  TSystem extends AnyActorSystem = AnyActorSystem,
  TEmitted extends EventObject = EventObject
 > {
- self: ActorRef<TSnapshot, TEvent>;
+ self: ActorRef<TSnapshot, TEvent, TEmitted>;
  id: string;
  sessionId: string;
  logger: (...args: any[]) => void;
@@ -2469,7 +2473,7 @@ export type UnknownActorLogic = ActorLogic<
 >;
 
 export type SnapshotFrom<T> = ReturnTypeOrValue<T> extends infer R
- ? R extends ActorRef<infer TSnapshot, infer _>
+ ? R extends ActorRef<infer TSnapshot, infer _, infer __>
  ? TSnapshot
  : R extends Actor<infer TLogic>
  ? SnapshotFrom<TLogic>
@@ -2541,7 +2545,7 @@ type ResolveEventType<T> = ReturnTypeOrValue<T> extends infer R
  infer _TMeta
  >
  ? TEvent
- : R extends ActorRef<infer _, infer TEvent>
+ : R extends ActorRef<infer _TSnapshot, infer TEvent, infer _TEmitted>
  ? TEvent
  : never
  : never;

diff --git a/packages/core/test/types.test.ts b/packages/core/test/types.test.ts
@@ -18,7 +18,8 @@ import {
  sendTo,
  spawnChild,
  stateIn,
- setup
+ setup,
+ toPromise
 } from '../src/index';
 
 function noop(_x: unknown) {
@@ -4553,3 +4554,16 @@ describe('snapshot methods', () => {
  snapshot.toJSON();
  });
 });
+
+// https://github.com/statelyai/xstate/issues/4931
+it('fromPromise should not have issues with actors with emitted types', () => {
+ const machine = setup({
+ types: {
+ emitted: {} as { type: 'FOO' }
+ }
+ }).createMachine({});
+
+ const actor = createActor(machine).start();
+
+ toPromise(actor);
+});
diff --git a/packages/xstate-solid/src/fromActorRef.ts b/packages/xstate-solid/src/fromActorRef.ts
@@ -1,10 +1,10 @@
 import { Accessor, createEffect, createMemo, onCleanup } from 'solid-js';
-import { ActorRef, SnapshotFrom } from 'xstate';
+import { AnyActorRef, SnapshotFrom } from 'xstate';
 import { createImmutable } from './createImmutable.ts';
 
 const noop = () => {};
 
-export function fromActorRef<TActor extends ActorRef<any, any> | undefined>(
+export function fromActorRef<TActor extends AnyActorRef | undefined>(
  actorRef: Accessor<TActor> | TActor
 ): Accessor<
  | SnapshotFrom<NonNullable<TActor>>