statelyai · Andarist · Sep 12, 2023 · Sep 12, 2023 · Sep 12, 2023 · Sep 12, 2023
diff --git a/.changeset/lazy-panthers-agree.md b/.changeset/lazy-panthers-agree.md
@@ -0,0 +1,5 @@
+---
+'xstate': major
+---
+
+All events automatically generated by XState will now be prefixed by `xstate.`. Naming scheme changed slightly as well, for example `done.invoke.*` events became `xstate.done.actor.*` events.
diff --git a/docs/fr/guides/actors.md b/docs/fr/guides/actors.md
@@ -202,7 +202,7 @@ const someMachine = createMachine({
 
 ## Spawning Promises
 
-Just like [invoking promises](./communication.md#invoking-promises), promises can be spawned as actors. The event sent back to the machine will be a `'done.invoke.<ID>'` action with the promise response as the `data` property in the payload:
+Just like [invoking promises](./communication.md#invoking-promises), promises can be spawned as actors. The event sent back to the machine will be a `'xstate.done.actor.<ID>'` action with the promise response as the `data` property in the payload:
 
 ```js {11}
 // Returns a promise

diff --git a/docs/fr/guides/communication.md b/docs/fr/guides/communication.md
@@ -114,11 +114,11 @@ const userMachine = createMachine({
 });
 ```
 
-The resolved data is placed into a `'done.invoke.<id>'` event, under the `data` property, e.g.:
+The resolved data is placed into a `'xstate.done.actor.<id>'` event, under the `data` property, e.g.:
 
 ```js
 {
-  type: 'done.invoke.getUser',
+  type: 'xstate.done.actor.getUser',
   data: {
     name: 'David',
     location: 'Florida'
@@ -128,7 +128,7 @@ The resolved data is placed into a `'done.invoke.<id>'` event, under the `data`
 
 ### Promise Rejection
 
-If a Promise rejects, the `onError` transition will be taken with a `{ type: 'error.platform' }` event. The error data is available on the event's `data` property:
+If a Promise rejects, the `onError` transition will be taken with a `{ type: 'xstate.error.actor' }` event. The error data is available on the event's `data` property:
 
 ```js
 const search = (context, event) =>
@@ -165,7 +165,7 @@ const searchMachine = createMachine({
           actions: assign({
             errorMessage: (context, event) => {
               // event is:
-              // { type: 'error.platform', data: 'No query specified' }
+              // { type: 'xstate.error.actor', data: 'No query specified' }
               return event.data;
             }
           })
@@ -429,7 +429,7 @@ The `data` _replaces_ the default `context` defined on the machine; it is not me
 
 ### Done Data
 
-When a child machine reaches its top-level [final state](./final.md), it can send data in the "done" event (e.g., `{ type: 'done.invoke.someId', data: ... }`). This "done data" is specified on the final state's `data` property:
+When a child machine reaches its top-level [final state](./final.md), it can send data in the "done" event (e.g., `{ type: 'xstate.done.actor.someId', data: ... }`). This "done data" is specified on the final state's `data` property:
 
 ```js
 const secretMachine = createMachine({
@@ -469,7 +469,7 @@ const parentMachine = createMachine({
           actions: assign({
             revealedSecret: (context, event) => {
               // event is:
-              // { type: 'done.invoke.secret', data: { secret: '42' } }
+              // { type: 'xstate.done.actor.secret', data: { secret: '42' } }
               return event.data.secret;
             }
           })

diff --git a/docs/fr/tutorials/reddit.md b/docs/fr/tutorials/reddit.md
@@ -158,7 +158,7 @@ const redditMachine = createMachine({
 
 Notice how we moved the `invoke` config to the `'loading'` state. This is useful because if we want to change the app logic in the future to have some sort of `'paused'` or `'canceled'` child state, the invoked promise will automatically be "canceled" since it's no longer in the `'loading'` state where it was invoked.
 
-When the promise resolves, a special `'done.invoke.<invoke ID>'` event will be sent to the machine, containing the resolved data as `event.data`. For convenience, XState maps the `onDone` property within the `invoke` object to this special event. You can assign the resolved data to `context.posts`:
+When the promise resolves, a special `'xstate.done.actor.<invoke ID>'` event will be sent to the machine, containing the resolved data as `event.data`. For convenience, XState maps the `onDone` property within the `invoke` object to this special event. You can assign the resolved data to `context.posts`:
 
 ```js {18-20}
 const redditMachine = createMachine({

diff --git a/docs/guides/actors.md b/docs/guides/actors.md
@@ -206,7 +206,7 @@ const someMachine = createMachine({
 
 ## Spawning Promises
 
-Just like [invoking promises](./communication.md#invoking-promises), promises can be spawned as actors. The event sent back to the machine will be a `'done.invoke.<ID>'` action with the promise response as the `data` property in the payload:
+Just like [invoking promises](./communication.md#invoking-promises), promises can be spawned as actors. The event sent back to the machine will be a `'xstate.done.actor.<ID>'` action with the promise response as the `data` property in the payload:
 
 ```js {11}
 // Returns a promise

diff --git a/docs/guides/communication.md b/docs/guides/communication.md
@@ -118,11 +118,11 @@ const userMachine = createMachine({
 });
 ```
 
-The resolved data is placed into a `'done.invoke.<id>'` event, under the `data` property, e.g.:
+The resolved data is placed into a `'xstate.done.actor.<id>'` event, under the `data` property, e.g.:
 
 ```js
 {
-  type: 'done.invoke.getUser',
+  type: 'xstate.done.actor.getUser',
   data: {
     name: 'David',
     location: 'Florida'
@@ -132,7 +132,7 @@ The resolved data is placed into a `'done.invoke.<id>'` event, under the `data`
 
 ### Promise Rejection
 
-If a Promise rejects, the `onError` transition will be taken with a `{ type: 'error.platform' }` event. The error data is available on the event's `data` property:
+If a Promise rejects, the `onError` transition will be taken with a `{ type: 'xstate.error.actor' }` event. The error data is available on the event's `data` property:
 
 ```js
 const search = (context, event) =>
@@ -169,7 +169,7 @@ const searchMachine = createMachine({
           actions: assign({
             errorMessage: (context, event) => {
               // event is:
-              // { type: 'error.platform', data: 'No query specified' }
+              // { type: 'xstate.error.actor', data: 'No query specified' }
               return event.data;
             }
           })
@@ -433,7 +433,7 @@ The `data` _replaces_ the default `context` defined on the machine; it is not me
 
 ### Done Data
 
-When a child machine reaches its top-level [final state](./final.md), it can send data in the "done" event (e.g., `{ type: 'done.invoke.someId', data: ... }`). This "done data" is specified on the final state's `data` property:
+When a child machine reaches its top-level [final state](./final.md), it can send data in the "done" event (e.g., `{ type: 'xstate.done.actor.someId', data: ... }`). This "done data" is specified on the final state's `data` property:
 
 ```js
 const secretMachine = createMachine({
@@ -473,7 +473,7 @@ const parentMachine = createMachine({
           actions: assign({
             revealedSecret: (context, event) => {
               // event is:
-              // { type: 'done.invoke.secret', data: { secret: '42' } }
+              // { type: 'xstate.done.actor.secret', data: { secret: '42' } }
               return event.data.secret;
             }
           })

diff --git a/docs/tutorials/reddit.md b/docs/tutorials/reddit.md
@@ -158,7 +158,7 @@ const redditMachine = createMachine({
 
 Notice how we moved the `invoke` config to the `'loading'` state. This is useful because if we want to change the app logic in the future to have some sort of `'paused'` or `'canceled'` child state, the invoked promise will automatically be "canceled" since it's no longer in the `'loading'` state where it was invoked.
 
-When the promise resolves, a special `'done.invoke.<invoke ID>'` event will be sent to the machine, containing the resolved data as `event.data`. For convenience, XState maps the `onDone` property within the `invoke` object to this special event. You can assign the resolved data to `context.posts`:
+When the promise resolves, a special `'xstate.done.actor.<invoke ID>'` event will be sent to the machine, containing the resolved data as `event.data`. For convenience, XState maps the `onDone` property within the `invoke` object to this special event. You can assign the resolved data to `context.posts`:
 
 ```js {18-20}
 const redditMachine = createMachine({

diff --git a/docs/zh/guides/actors.md b/docs/zh/guides/actors.md
@@ -202,7 +202,7 @@ const someMachine = createMachine({
 
 ## 创建 Promises
 
-就像 [invoking promises](./communication.md#invoking-promises) 一样，promise 可以作为 演员 生成。 发送回状态机的事件将是一个 `'done.invoke.<ID>'` 操作，promise 响应作为有效负载中的 `data` 属性：
+就像 [invoking promises](./communication.md#invoking-promises) 一样，promise 可以作为 演员 生成。 发送回状态机的事件将是一个 `'xstate.done.actor.<ID>'` 操作，promise 响应作为有效负载中的 `data` 属性：
 
 ```js {11}
 // Returns a promise

diff --git a/docs/zh/guides/communication.md b/docs/zh/guides/communication.md
@@ -114,11 +114,11 @@ const userMachine = createMachine({
 });
 ```
 
-解析后的数据被放置在一个 `'done.invoke.<id>'` 事件中，在 `data` 属性下，例如：
+解析后的数据被放置在一个 `'xstate.done.actor.<id>'` 事件中，在 `data` 属性下，例如：
 
 ```js
 {
-  type: 'done.invoke.getUser',
+  type: 'xstate.done.actor.getUser',
   data: {
     name: 'David',
     location: 'Florida'
@@ -128,7 +128,7 @@ const userMachine = createMachine({
 
 ### Promise Rejection
 
-如果 Promise 拒绝，则将使用 `{ type: 'error.platform' }` 事件进行 `onError` 转换。 错误数据在事件的 `data` 属性中可用：
+如果 Promise 拒绝，则将使用 `{ type: 'xstate.error.actor' }` 事件进行 `onError` 转换。 错误数据在事件的 `data` 属性中可用：
 
 ```js
 const search = (context, event) =>
@@ -165,7 +165,7 @@ const searchMachine = createMachine({
           actions: assign({
             errorMessage: (context, event) => {
               // event is:
-              // { type: 'error.platform', data: 'No query specified' }
+              // { type: 'xstate.error.actor', data: 'No query specified' }
               return event.data;
             }
           })
@@ -428,7 +428,7 @@ data: (context, event) => ({
 
 ### 完成数据
 
-当子状态机到达其顶级[最终状态](./final.md)时，它可以在“done”事件中发送数据（例如，`{ type: 'done.invoke.someId', data: .. .}`）。 这个“完成的数据”是在最终状态的`data`属性上指定的：
+当子状态机到达其顶级[最终状态](./final.md)时，它可以在“done”事件中发送数据（例如，`{ type: 'xstate.done.actor.someId', data: .. .}`）。 这个“完成的数据”是在最终状态的`data`属性上指定的：
 
 ```js
 const secretMachine = createMachine({
@@ -468,7 +468,7 @@ const parentMachine = createMachine({
           actions: assign({
             revealedSecret: (context, event) => {
               // event is:
-              // { type: 'done.invoke.secret', data: { secret: '42' } }
+              // { type: 'xstate.done.actor.secret', data: { secret: '42' } }
               return event.data.secret;
             }
           })

diff --git a/docs/zh/tutorials/reddit.md b/docs/zh/tutorials/reddit.md
@@ -158,7 +158,7 @@ const redditMachine = createMachine({
 
 Notice how we moved the `invoke` config to the `'loading'` state. This is useful because if we want to change the app logic in the future to have some sort of `'paused'` or `'canceled'` child state, the invoked promise will automatically be "canceled" since it's no longer in the `'loading'` state where it was invoked.
 
-When the promise resolves, a special `'done.invoke.<invoke ID>'` event will be sent to the machine, containing the resolved data as `event.data`. For convenience, XState maps the `onDone` property within the `invoke` object to this special event. You can assign the resolved data to `context.posts`:
+When the promise resolves, a special `'xstate.done.actor.<invoke ID>'` event will be sent to the machine, containing the resolved data as `event.data`. For convenience, XState maps the `onDone` property within the `invoke` object to this special event. You can assign the resolved data to `context.posts`:
 
 ```js {18-20}
 const redditMachine = createMachine({

diff --git a/packages/core/src/StateMachine.ts b/packages/core/src/StateMachine.ts
@@ -47,7 +47,7 @@ import type {
   Equals,
   TODO
 } from './types.ts';
-import { isErrorEvent, resolveReferencedActor } from './utils.ts';
+import { isErrorActorEvent, resolveReferencedActor } from './utils.ts';
 
 export const STATE_IDENTIFIER = '#';
 export const WILDCARD = '*';
@@ -245,7 +245,7 @@ export class StateMachine<
   ): State<TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> {
     // TODO: handle error events in a better way
     if (
-      isErrorEvent(event) &&
+      isErrorActorEvent(event) &&
       !state.nextEvents.some((nextEvent) => nextEvent === event.type)
     ) {
       return cloneState(state, {

diff --git a/packages/core/src/StateNode.ts b/packages/core/src/StateNode.ts
@@ -132,7 +132,7 @@ export class StateNode<
    */
   public meta?: any;
   /**
-   * The output data sent with the "done.state._id_" event if this is a final state node.
+   * The output data sent with the "xstate.done.state._id_" event if this is a final state node.
    */
   public output?: Mapper<TContext, TEvent, any>;
 

diff --git a/packages/core/src/actions/invoke.ts b/packages/core/src/actions/invoke.ts
@@ -1,6 +1,6 @@
 import isDevelopment from '#is-development';
 import { cloneState } from '../State.ts';
-import { createErrorPlatformEvent } from '../eventUtils.ts';
+import { createErrorActorEvent } from '../eventUtils.ts';
 import { ActorStatus, createActor } from '../interpreter.ts';
 import {
   ActionArgs,
@@ -89,7 +89,7 @@ function execute(
     try {
       actorRef.start?.();
     } catch (err) {
-      (actorContext.self as AnyActor).send(createErrorPlatformEvent(id, err));
+      (actorContext.self as AnyActor).send(createErrorActorEvent(id, err));
       return;
     }
   });

diff --git a/packages/core/src/actions/send.ts b/packages/core/src/actions/send.ts
@@ -1,5 +1,5 @@
 import isDevelopment from '#is-development';
-import { createErrorPlatformEvent } from '../eventUtils.ts';
+import { createErrorActorEvent } from '../eventUtils.ts';
 import {
   ActionArgs,
   ActorRef,
@@ -125,7 +125,7 @@ function execute(
   actorContext.defer(() => {
     to.send(
       event.type === XSTATE_ERROR
-        ? createErrorPlatformEvent(actorContext.self.id, (event as any).data)
+        ? createErrorActorEvent(actorContext.self.id, (event as any).data)
         : event
     );
   });

diff --git a/packages/core/src/actors/callback.ts b/packages/core/src/actors/callback.ts
@@ -8,10 +8,7 @@ import {
   TODO
 } from '../types';
 import { isPromiseLike } from '../utils';
-import {
-  createDoneInvokeEvent,
-  createErrorPlatformEvent
-} from '../eventUtils.ts';
+import { createDoneActorEvent, createErrorActorEvent } from '../eventUtils.ts';
 import { XSTATE_INIT, XSTATE_STOP } from '../constants.ts';
 
 export interface CallbackInternalState<
@@ -99,12 +96,12 @@ export function fromCallback<TEvent extends EventObject, TInput>(
         if (isPromiseLike(state.dispose)) {
           state.dispose.then(
             (resolved) => {
-              self._parent?.send(createDoneInvokeEvent(id, resolved));
+              self._parent?.send(createDoneActorEvent(id, resolved));
               state.canceled = true;
             },
             (errorData) => {
               state.canceled = true;
-              self._parent?.send(createErrorPlatformEvent(id, errorData));
+              self._parent?.send(createErrorActorEvent(id, errorData));
             }
           );
         }

diff --git a/packages/core/src/constants.ts b/packages/core/src/constants.ts
@@ -3,7 +3,6 @@ export const TARGETLESS_KEY = '';
 export const NULL_EVENT = '';
 export const STATE_IDENTIFIER = '#';
 export const WILDCARD = '*';
-export const ERROR_EXECUTION = 'error.execution'; // TODO: replace with `xstate.error.*`
 export const XSTATE_INIT = 'xstate.init';
 export const XSTATE_ERROR = 'xstate.error';
 export const XSTATE_STOP = 'xstate.stop';
diff --git a/packages/core/src/eventUtils.ts b/packages/core/src/eventUtils.ts
@@ -1,9 +1,5 @@
 import { XSTATE_INIT } from './constants.ts';
-import {
-  DoneInvokeEventObject,
-  DoneStateEventObject,
-  ErrorPlatformEvent
-} from './types.ts';
+import { DoneActorEvent, DoneStateEvent, ErrorActorEvent } from './types.ts';
 
 /**
  * Returns an event that represents an implicit event that
@@ -27,9 +23,9 @@ export function createAfterEvent(delayRef: number | string, id?: string) {
 export function createDoneStateEvent(
   id: string,
   output?: unknown
-): DoneStateEventObject {
+): DoneStateEvent {
   return {
-    type: `done.state.${id}`,
+    type: `xstate.done.state.${id}`,
     output
   };
 }
@@ -43,21 +39,21 @@ export function createDoneStateEvent(
  * @param invokeId The invoked service ID
  * @param output The data to pass into the event
  */
-export function createDoneInvokeEvent(
+export function createDoneActorEvent(
   invokeId: string,
   output?: unknown
-): DoneInvokeEventObject {
+): DoneActorEvent {
   return {
-    type: `done.invoke.${invokeId}`,
+    type: `xstate.done.actor.${invokeId}`,
     output
   };
 }
 
-export function createErrorPlatformEvent(
+export function createErrorActorEvent(
   id: string,
   data?: unknown
-): ErrorPlatformEvent {
-  return { type: `error.platform.${id}`, data };
+): ErrorActorEvent {
+  return { type: `xstate.error.actor.${id}`, data };
 }
 
 export function createInitEvent(input: unknown) {