Remove pure and choose (#4529)

* Remove `pure` and `choose`

* remove invalid comment

* Changeset

---------

Co-authored-by: David Khourshid <[email protected]>

Author: Andarist

.changeset/red-shoes-type.md

@@ -0,0 +1,37 @@
+---
+'xstate': major
+---
+
+The `pure()` and `choose()` action creators have been removed, in favor of the more flexible `enqueueActions()` action creator:
+
+```ts
+entry: [
+  // pure(() => {
+  //   return [
+  //     'action1',
+  //     'action2'
+  //   ]
+  // }),
+  enqueueActions(({ enqueue }) => {
+    enqueue('action1');
+    enqueue('action2');
+  })
+];
+```
+
+```ts
+entry: [
+  // choose([
+  //   {
+  //     guard: 'someGuard',
+  //     actions: ['action1', 'action2']
+  //   }
+  // ]),
+  enqueueActions(({ enqueue, check }) => {
+    if (check('someGuard')) {
+      enqueue('action1');
+      enqueue('action2');
+    }
+  })
+];
+```

packages/core/src/actions.ts

@@ -4,13 +4,11 @@ export {
   type AssignArgs
 } from './actions/assign.ts';
 export { cancel, type CancelAction } from './actions/cancel.ts';
-export { choose, type ChooseAction } from './actions/choose.ts';
 export {
   enqueueActions,
   type EnqueueActionsAction
 } from './actions/enqueueActions.ts';
 export { log, type LogAction } from './actions/log.ts';
-export { pure } from './actions/pure.ts';
 export { raise, type RaiseAction } from './actions/raise.ts';
 export {
   escalate,

packages/core/src/actions/choose.ts

@@ -172,7 +172,6 @@ export function enqueueActions<
   TEvent extends EventObject = TExpressionEvent,
   TActor extends ProvidedActor = ProvidedActor,
   TAction extends ParameterizedObject = ParameterizedObject,
-  // `TGuard` is only required by `choose`, if we remove `choose` then we can remove this whole type parameter
   TGuard extends ParameterizedObject = ParameterizedObject,
   TDelay extends string = string
 >(

packages/core/src/actions/enqueueActions.ts

@@ -1,7 +1,6 @@
 import { Element as XMLElement, xml2js } from 'xml-js';
 import { assign } from './actions/assign.ts';
 import { cancel } from './actions/cancel.ts';
-import { choose } from './actions/choose.ts';
 import { log } from './actions/log.ts';
 import { raise } from './actions/raise.ts';
 import { sendTo } from './actions/send.ts';
@@ -11,17 +10,16 @@ import {
   ActionFunction,
   MachineContext,
   SpecialTargets,
-  createMachine
+  createMachine,
+  enqueueActions
 } from './index.ts';
 import {
   AnyStateMachine,
   AnyStateNode,
   AnyStateNodeConfig,
-  ChooseBranch,
   DelayExpr,
   EventObject,
-  SendExpr,
-  StateNodeConfig
+  SendExpr
 } from './types.ts';
 import { mapValues } from './utils.ts';
 
@@ -133,7 +131,8 @@ const evaluateExecutableContent = <
   context: TContext,
   event: TEvent,
   _meta: any,
-  body: string
+  body: string,
+  ...extraArgs: any[]
 ) => {
   const scope = ['const _sessionid = "NOT_IMPLEMENTED";']
     .filter(Boolean)
@@ -148,7 +147,7 @@ with (context) {
 }
   `;
 
-  const fn = new Function(...args, fnBody);
+  const fn = new Function(...args, ...extraArgs, fnBody);
 
   return fn(context, { name: event.type, data: event });
 };
@@ -286,9 +285,12 @@ return ${element.attributes!.expr};
       );
     }
     case 'if': {
-      const branches: Array<ChooseBranch<MachineContext, EventObject>> = [];
+      const branches: Array<{
+        guard?: (...args: any) => any;
+        actions: any[];
+      }> = [];
 
-      let current: ChooseBranch<MachineContext, EventObject> = {
+      let current: (typeof branches)[number] = {
         guard: createGuard(element.attributes!.cond as string),
         actions: []
       };
@@ -317,7 +319,15 @@ return ${element.attributes!.expr};
       }
 
       branches.push(current);
-      return choose(branches);
+
+      return enqueueActions(({ context, event, enqueue, check, ...meta }) => {
+        for (const branch of branches) {
+          if (!branch.guard || check(branch.guard)) {
+            branch.actions.forEach(enqueue);
+            break;
+          }
+        }
+      });
     }
     default:
       throw new Error(