Fixed an issue with raise return type

statelyai · Jul 18, 2020 · c1f3d26 · c1f3d26
1 parent 8662e54
commit c1f3d26
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/.changeset/gentle-vans-visit.md b/.changeset/gentle-vans-visit.md
@@ -0,0 +1,5 @@
+---
+'xstate': patch
+---
+
+Fixed a type returned by a `raise` action - it's now `RaiseAction<TEvent> | SendAction<TContext, AnyEventObject, TEvent>` instead of `RaiseAction<TEvent> | SendAction<TContext, TEvent, TEvent>`. This makes it comaptible in a broader range of scenarios.
diff --git a/packages/core/src/actions.ts b/packages/core/src/actions.ts
@@ -159,7 +159,7 @@ export function toActivityDefinition<TContext, TEvent extends EventObject>(
  */
 export function raise<TContext, TEvent extends EventObject>(
   event: Event<TEvent>
-): RaiseAction<TEvent> | SendAction<TContext, TEvent, TEvent> {
+): RaiseAction<TEvent> | SendAction<TContext, AnyEventObject, TEvent> {
   if (!isString(event)) {
     return send(event, { to: SpecialTargets.Internal });
   }

diff --git a/packages/core/test/types.test.ts b/packages/core/test/types.test.ts
@@ -213,12 +213,13 @@ describe('Raise events', () => {
     }
 
     type GreetingEvent =
-      | { type: 'DECIDE' }
+      | { type: 'DECIDE'; aloha?: boolean }
       | { type: 'MORNING' }
       | { type: 'LUNCH_TIME' }
       | { type: 'AFTERNOON' }
       | { type: 'EVENING' }
-      | { type: 'NIGHT' };
+      | { type: 'NIGHT' }
+      | { type: 'ALOHA' };
 
     interface GreetingContext {
       hour: number;
@@ -238,12 +239,24 @@ describe('Raise events', () => {
         pending: {
           on: {
             DECIDE: [
+              {
+                actions: raise<GreetingContext, { type: 'ALOHA' }>({
+                  type: 'ALOHA'
+                }),
+                cond: (_ctx, ev) => !!ev.aloha
+              },
               {
                 actions: raise<GreetingContext, { type: 'MORNING' }>({
                   type: 'MORNING'
                 }),
                 cond: (ctx) => ctx.hour < 12
               },
+              {
+                actions: raise<GreetingContext, GreetingEvent>({
+                  type: 'AFTERNOON'
+                }),
+                cond: (ctx) => ctx.hour < 18
+              },
               {
                 actions: raise({ type: 'EVENING' }),
                 cond: (ctx) => ctx.hour < 22