Add model.createMachine(...)

statelyai · Jun 28, 2021 · d5e5a71 · d5e5a71
1 parent 99cc26a
commit d5e5a71
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 5 deletions.
diff --git a/packages/core/src/Machine.ts b/packages/core/src/Machine.ts
@@ -11,6 +11,9 @@ import {
 import { StateNode } from './StateNode';
 import { Model, ModelContextFrom, ModelEventsFrom } from './model';
 
+/**
+ * @deprecated Use `createMachine(...)` instead.
+ */
 export function Machine<
   TContext = any,
   TEvent extends EventObject = AnyEventObject

diff --git a/packages/core/src/model.ts b/packages/core/src/model.ts
@@ -1,10 +1,14 @@
 import { assign } from './actions';
+import { createMachine } from './Machine';
 import type {
   AssignAction,
   Assigner,
   PropertyAssigner,
   ExtractEvent,
-  EventObject
+  EventObject,
+  MachineConfig,
+  StateMachine,
+  MachineOptions
 } from './types';
 import { mapValues } from './utils';
 
@@ -28,6 +32,10 @@ export interface Model<
   ) => AssignAction<TContext, ExtractEvent<TEvent, TEventType>>;
   events: Prop<TModelCreators, 'events'>;
   reset: () => AssignAction<TContext, any>;
+  createMachine: (
+    config: MachineConfig<TContext, any, TEvent> & { context: TContext },
+    implementations?: Partial<MachineOptions<TContext, TEvent>>
+  ) => StateMachine<TContext, any, TEvent, any>;
 }
 
 export type ModelContextFrom<
@@ -107,7 +115,8 @@ export function createModel(initialContext: object, creators?): unknown {
           type: eventType
         }))
       : undefined) as any,
-    reset: () => assign(initialContext)
+    reset: () => assign(initialContext),
+    createMachine
   };
 
   return model;

diff --git a/packages/core/test/model.test.ts b/packages/core/test/model.test.ts
@@ -162,7 +162,7 @@ describe('createModel', () => {
       'updateName'
     );
 
-    const machine = createMachine<typeof userModel>({
+    const machine = userModel.createMachine({
       context: userModel.initialContext,
       initial: 'active',
       states: {
@@ -203,7 +203,7 @@ describe('createModel', () => {
   it('should typecheck `createMachine` for model without creators', () => {
     const toggleModel = createModel({ count: 0 });
 
-    const machine = createMachine<typeof toggleModel>({
+    const machine = toggleModel.createMachine({
       id: 'machine',
       initial: 'inactive',
       // using context here is crucial to validate that it can be assigned to the inferred TContext
@@ -225,7 +225,7 @@ describe('createModel', () => {
     const toggleModel = createModel({ count: 0 });
 
     // @ts-expect-error
-    const m = createMachine<typeof toggleModel>({
+    const m = toggleModel.createMachine({
       id: 'machine',
       initial: 'inactive',
       // missing context: