Add a passthrough schema property to machines (#4688)

* Add a passthrough `schema` property to machines * juggle types * Add quick test + changeset --------- Co-authored-by: David Khourshid <[email protected]>
statelyai · Jan 24, 2024 · 14902e1 · 14902e1
1 parent cc5c67e
commit 14902e1
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 23 deletions.
diff --git a/.changeset/four-readers-rescue.md b/.changeset/four-readers-rescue.md
@@ -0,0 +1,5 @@
+---
+'xstate': minor
+---
+
+The `schemas` property in `setup(...)` is now passed through to the resulting machine. This property is meant to be used with future developer tooling, and is typed as `unknown` for now.
diff --git a/packages/core/src/StateMachine.ts b/packages/core/src/StateMachine.ts
@@ -87,6 +87,8 @@ export class StateMachine<
    */
   public version?: string;
 
+  public schemas: unknown;
+
   public implementations: MachineImplementationsSimplified<TContext, TEvent>;
 
   /** @internal */
@@ -117,7 +119,9 @@ export class StateMachine<
       any,
       TOutput,
       any
-    >,
+    > & {
+      schemas?: unknown;
+    },
     implementations?: MachineImplementationsSimplified<TContext, TEvent>
   ) {
     this.id = config.id || '(machine)';
@@ -128,6 +132,7 @@ export class StateMachine<
       guards: implementations?.guards ?? {}
     };
     this.version = this.config.version;
+    this.schemas = this.config.schemas;
 
     this.transition = this.transition.bind(this);
     this.getInitialSnapshot = this.getInitialSnapshot.bind(this);

diff --git a/packages/core/src/createMachine.ts b/packages/core/src/createMachine.ts
@@ -12,6 +12,7 @@ import {
   IsNever,
   MachineConfig,
   MachineContext,
+  MachineTypes,
   NonReducibleUnknown,
   ParameterizedObject,
   Prop,
@@ -68,10 +69,10 @@ type ToStateValue<TTestValue extends string | TestValue> =
  * Creates a state machine (statechart) with the given configuration.
  *
  * The state machine represents the pure logic of a state machine actor.
- * 
+ *
  * @param config The state machine configuration.
  * @param options DEPRECATED: use `setup({ ... })` or `machine.provide({ ... })` to provide machine implementations instead.
- * 
+ *
  * @example
   ```ts
   import { createMachine } from 'xstate';
@@ -119,7 +120,21 @@ export function createMachine<
   // we should be able to remove this when we start inferring TConfig, with it we'll always have an inference candidate
   TTypesMeta extends TypegenConstraint = TypegenDisabled
 >(
-  config: MachineConfig<
+  config: {
+    types?: MachineTypes<
+      TContext,
+      TEvent,
+      TActor,
+      TAction,
+      TGuard,
+      TDelay,
+      TTag,
+      TInput,
+      TOutput,
+      TTypesMeta
+    >;
+    schemas?: unknown;
+  } & MachineConfig<
     TContext,
     TEvent,
     TActor,

diff --git a/packages/core/src/setup.ts b/packages/core/src/setup.ts
@@ -115,11 +115,13 @@ export function setup<
   TOutput extends NonReducibleUnknown,
   TChildrenMap extends Record<string, string> = never
 >({
+  schemas,
   actors,
   actions,
   guards,
   delays
 }: {
+  schemas?: unknown;
   types?: SetupTypes<TContext, TEvent, TChildrenMap, TTag, TInput, TOutput>;
   actors?: {
     [K in keyof TActors]: TActors[K];
@@ -204,11 +206,14 @@ export function setup<
 } {
   return {
     createMachine: (config) =>
-      (createMachine as any)(config, {
-        actors,
-        actions,
-        guards,
-        delays
-      })
+      (createMachine as any)(
+        { ...config, schemas },
+        {
+          actors,
+          actions,
+          guards,
+          delays
+        }
+      )
   };
 }
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -1363,18 +1363,6 @@ export type MachineConfig<
    * The machine's own version.
    */
   version?: string;
-  types?: MachineTypes<
-    TContext,
-    TEvent,
-    TActor,
-    TAction,
-    TGuard,
-    TDelay,
-    TTag,
-    TInput,
-    TOutput,
-    TTypesMeta
-  >;
   // TODO: make it conditionally required
   output?: Mapper<TContext, DoneStateEvent, TOutput, TEvent> | TOutput;
 }) &

diff --git a/packages/core/test/machine.test.ts b/packages/core/test/machine.test.ts
@@ -1,4 +1,4 @@
-import { createActor, createMachine, assign } from '../src/index.ts';
+import { createActor, createMachine, assign, setup } from '../src/index.ts';
 
 const pedestrianStates = {
   initial: 'walk',
@@ -392,6 +392,18 @@ describe('machine', () => {
       expect(actorRef.getSnapshot().context.value).toEqual(43);
     });
   });
+
+  it('should pass through schemas', () => {
+    const machine = setup({
+      schemas: {
+        context: { count: { type: 'number' } }
+      }
+    }).createMachine({});
+
+    expect(machine.schemas).toEqual({
+      context: { count: { type: 'number' } }
+    });
+  });
 });
 
 describe('StateNode', () => {