Merge pull request #39 from statelyai/davidkpiano/xstate-5-18-1

Update XState with ActorRefLike types

.changeset/purple-rocks-know.md

@@ -0,0 +1,5 @@
+---
+"@statelyai/inspect": patch
+---
+
+Update XState to 5.18.2

package.json

@@ -8,7 +8,7 @@
     "tsup": "^8.2.4",
     "typescript": "^5.5.4",
     "vitest": "^1.6.0",
-    "xstate": "^5.17.1"
+    "xstate": "^5.18.2"
   },
   "name": "@statelyai/inspect",
   "version": "0.5.1",
@@ -36,7 +36,8 @@
     "changeset": "changeset",
     "release": "changeset publish",
     "version": "changeset version",
-    "dev": "yarn build && ./scripts/dev.sh"
+    "dev": "yarn build && ./scripts/dev.sh",
+    "typecheck": "tsc --noEmit"
   },
   "publishConfig": {
     "access": "public"

src/createInspector.ts

@@ -4,11 +4,12 @@ import {
   StatelyInspectionEvent,
   StatelySnapshotEvent,
   Adapter,
+  ActorRefLikeWithData,
 } from './types';
 import { toEventObject } from './utils';
 import { Inspector } from './types';
 import {
-  AnyActorRef,
+  ActorRefLike,
   AnyEventObject,
   InspectionEvent,
   MachineContext,
@@ -18,8 +19,8 @@ import pkg from '../package.json';
 import { idleCallback } from './idleCallback';
 import safeStringify from 'safe-stable-stringify';
 
-function getRoot(actorRef: AnyActorRef) {
-  let marker: AnyActorRef | undefined = actorRef;
+function getRoot(actorRef: ActorRefLike) {
+  let marker: ActorRefLikeWithData | undefined = actorRef;
 
   do {
     marker = marker._parent;
@@ -28,7 +29,7 @@ function getRoot(actorRef: AnyActorRef) {
   return marker;
 }
 
-function getRootId(actorRefOrId: AnyActorRef | string): string | undefined {
+function getRootId(actorRefOrId: ActorRefLike | string): string | undefined {
   const rootActorRef =
     typeof actorRefOrId === 'string'
       ? undefined
@@ -210,7 +211,7 @@ export function convertXStateEvent(
       const actorRef = inspectionEvent.actorRef;
       const logic = (actorRef as any)?.logic;
       const definitionObject = logic?.config;
-      let name = actorRef.id;
+      let name = (actorRef as any).id;
 
       // TODO: fix this in XState
       if (name === actorRef.sessionId && definitionObject) {
@@ -237,7 +238,7 @@ export function convertXStateEvent(
         createdAt: Date.now().toString(),
         id: null as any,
         rootId: inspectionEvent.rootId,
-        parentId: inspectionEvent.actorRef._parent?.sessionId,
+        parentId: (inspectionEvent.actorRef as any)._parent?.sessionId,
         sessionId: inspectionEvent.actorRef.sessionId,
         snapshot: inspectionEvent.actorRef.getSnapshot(),
       } satisfies StatelyActorEvent;

src/types.ts

@@ -1,5 +1,5 @@
 import {
-  AnyActorRef,
+  ActorRefLike,
   AnyEventObject,
   InspectionEvent,
   Observer,
@@ -63,23 +63,23 @@ export interface Inspector<TAdapter extends Adapter> {
    * Sends a snapshot inspection event. This represents the state of the actor.
    */
   snapshot(
-    actor: AnyActorRef | string,
+    actor: ActorRefLikeWithData | string,
     snapshot: InspectedSnapshot,
     info?: { event?: AnyEventObject }
   ): void;
   /**
    * Sends an event inspection event. This represents the event that was sent to the actor.
    */
   event(
-    actor: AnyActorRef | string,
+    actor: ActorRefLikeWithData | string,
     event: AnyEventObject | string,
-    info?: { source?: AnyActorRef | string }
+    info?: { source?: ActorRefLikeWithData | string }
   ): void;
   /**
    * Sends an actor registration inspection event. This represents the actor that was created.
    */
   actor(
-    actor: AnyActorRef | string,
+    actor: ActorRefLikeWithData | string,
     snapshot?: InspectedSnapshot,
     info?: {
       definition?: string;
@@ -112,3 +112,8 @@ export interface Inspector<TAdapter extends Adapter> {
    */
   inspect: Observer<InspectionEvent>;
 }
+
+export type ActorRefLikeWithData = ActorRefLike & {
+  _parent?: ActorRefLikeWithData;
+  id?: string;
+};