Merge pull request #3545 from with-heart/pure-action-type-strings

allow action `type` strings in `pure` return array
statelyai · Dec 3, 2022 · b9995f0 · b9995f0
2 parents fb4786b + 4a5aa27
commit b9995f0
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 3 deletions.
diff --git a/.changeset/seven-ducks-look.md b/.changeset/seven-ducks-look.md
@@ -0,0 +1,24 @@
+---
+'xstate': patch
+---
+
+pr: #3545
+author: @with-heart
+
+Updated `pure` action types to allow action `type` strings to be returned in the array.
+
+```ts
+const machine = createMachine(
+  {
+    entry: ['doStuff']
+  },
+  {
+    actions: {
+      doStuff: pure(() => ['someAction']),
+      someAction: () => console.log('executed by doStuff')
+    }
+  }
+);
+```
+
+Returning action `type` strings were already handled by `xstate` and the types now correctly reflect that.
diff --git a/packages/core/src/actions.ts b/packages/core/src/actions.ts
@@ -543,7 +543,11 @@ export function pure<TContext, TEvent extends EventObject>(
   getActions: (
     context: TContext,
     event: TEvent
-  ) => SingleOrArray<ActionObject<TContext, TEvent>> | undefined
+  ) =>
+    | SingleOrArray<
+        ActionObject<TContext, TEvent> | ActionObject<TContext, TEvent>['type']
+      >
+    | undefined
 ): PureAction<TContext, TEvent> {
   return {
     type: ActionTypes.Pure,

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -1376,7 +1376,11 @@ export interface PureAction<TContext, TEvent extends EventObject>
   get: (
     context: TContext,
     event: TEvent
-  ) => SingleOrArray<ActionObject<TContext, TEvent>> | undefined;
+  ) =>
+    | SingleOrArray<
+        ActionObject<TContext, TEvent> | ActionObject<TContext, TEvent>['type']
+      >
+    | undefined;
 }
 
 export interface ChooseAction<TContext, TEvent extends EventObject>

diff --git a/packages/core/test/actions.test.ts b/packages/core/test/actions.test.ts
@@ -1861,7 +1861,8 @@ describe('purely defined actions', () => {
   type Events =
     | { type: 'SINGLE'; id: number }
     | { type: 'NONE'; id: number }
-    | { type: 'EACH' };
+    | { type: 'EACH' }
+    | { type: 'AS_STRINGS' };
 
   const dynamicMachine = Machine<Ctx, Events>({
     id: 'dynamic',
@@ -1902,6 +1903,9 @@ describe('purely defined actions', () => {
                 index
               }))
             )
+          },
+          AS_STRINGS: {
+            actions: pure<any, any>(() => ['SOME_ACTION'])
           }
         }
       }
@@ -1956,6 +1960,15 @@ describe('purely defined actions', () => {
       }
     ]);
   });
+
+  it('should allow for purely defined action type strings', () => {
+    const nextState = dynamicMachine.transition(
+      dynamicMachine.initialState,
+      'AS_STRINGS'
+    );
+
+    expect(nextState.actions).toEqual([{ type: 'SOME_ACTION' }]);
+  });
 });
 
 describe('forwardTo()', () => {