Merge pull request #1103 from davidkpiano/davidkpiano/ts-3.8

davidkpiano · web-flow · commit 7f5f7adc8c2a · 2020-04-04T12:45:26.000-04:00
Upgrade TS to 3.8.3 and simplify transition config types
diff --git a/.changeset/curvy-planets-serve.md b/.changeset/curvy-planets-serve.md
@@ -0,0 +1,5 @@
+---
+'xstate': minor
+---
+
+Simplify the `TransitionConfigArray` and `TransitionConfigMap` types In order to fix excessively deep type instantiation TypeScript reports. This addresses [#1015](https://github.com/davidkpiano/xstate/issues/1015).
diff --git a/package.json b/package.json
@@ -65,7 +65,7 @@
     "ts-jest": "^24.1.9",
     "tslint": "^5.11.0",
     "typedoc": "^0.15.2",
-    "typescript": "^3.7.5",
+    "typescript": "^3.8.3",
     "vuepress": "^1.2.0",
     "vuepress-plugin-export": "^0.2.0",
     "webpack-dev-middleware": "^3.6.0"
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -66,7 +66,7 @@
     "rxjs": "^6.5.1",
     "ts-jest": "^24.1.9",
     "tslib": "^1.10.0",
-    "typescript": "^3.7.5",
+    "typescript": "^3.8.3",
     "xml-js": "^1.6.11"
   }
 }
diff --git a/packages/core/src/interpreter.ts b/packages/core/src/interpreter.ts
@@ -778,7 +778,7 @@ export class Interpreter<
           this.parent.send({
             type: 'xstate.error',
             data: err
-          });
+          } as EventObject);
         }
 
         throw err;
diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -321,32 +321,40 @@ export type StatesDefinition<
   >;
 };
 
-export type TransitionConfigTargetShortcut<
+export type TransitionConfigTarget<TContext, TEvent extends EventObject> =
+  | string
+  | undefined
+  | StateNode<TContext, any, TEvent>;
+
+export type TransitionConfigOrTarget<
   TContext,
   TEvent extends EventObject
-> = string | undefined | StateNode<TContext, any, TEvent>;
+> = SingleOrArray<
+  TransitionConfigTarget<TContext, TEvent> | TransitionConfig<TContext, TEvent>
+>;
 
 type TransitionsConfigMap<TContext, TEvent extends EventObject> = {
-  [K in TEvent['type'] | NullEvent['type'] | '*']?: SingleOrArray<
-    | TransitionConfigTargetShortcut<TContext, TEvent>
-    | (TransitionConfig<
-        TContext,
-        K extends TEvent['type'] ? Extract<TEvent, { type: K }> : EventObject
-      > & {
-        event?: undefined;
-      })
+  [K in TEvent['type']]?: TransitionConfigOrTarget<
+    TContext,
+    TEvent extends { type: K } ? TEvent : never
   >;
+} & {
+  ''?: TransitionConfigOrTarget<TContext, TEvent>;
+} & {
+  '*'?: TransitionConfigOrTarget<TContext, TEvent>;
 };
 
 type TransitionsConfigArray<TContext, TEvent extends EventObject> = Array<
-  {
-    [K in TEvent['type'] | NullEvent['type'] | '*']: TransitionConfig<
-      TContext,
-      K extends TEvent['type'] ? Extract<TEvent, { type: K }> : EventObject
-    > & {
-      event: K;
-    };
-  }[TEvent['type'] | NullEvent['type'] | '*']
+  | {
+      [K in TEvent['type']]: TransitionConfig<
+        TContext,
+        TEvent extends { type: K } ? TEvent : never
+      > & {
+        event: K;
+      };
+    }[TEvent['type']]
+  | (TransitionConfig<TContext, TEvent> & { event: '' })
+  | (TransitionConfig<TContext, TEvent> & { event: '*' })
 >;
 
 export type TransitionsConfig<TContext, TEvent extends EventObject> =
@@ -905,7 +913,7 @@ export interface PureAction<TContext, TEvent extends EventObject>
 export interface ChooseAction<TContext, TEvent extends EventObject>
   extends ActionObject<TContext, TEvent> {
   type: ActionTypes.Choose;
-  conds: ChooseConditon<TContext, TEvent>[];
+  conds: Array<ChooseConditon<TContext, TEvent>>;
 }
 
 export interface TransitionDefinition<TContext, TEvent extends EventObject>
diff --git a/packages/core/src/utils.ts b/packages/core/src/utils.ts
@@ -17,7 +17,7 @@ import {
   StateLike,
   EventData,
   TransitionConfig,
-  TransitionConfigTargetShortcut,
+  TransitionConfigTarget,
   NullEvent,
   SingleOrArray,
   Guard,
@@ -584,7 +584,7 @@ export function toTransitionConfigArray<TContext, TEvent extends EventObject>(
   event: TEvent['type'] | NullEvent['type'] | '*',
   configLike: SingleOrArray<
     | TransitionConfig<TContext, TEvent>
-    | TransitionConfigTargetShortcut<TContext, TEvent>
+    | TransitionConfigTarget<TContext, TEvent>
   >
 ): Array<
   TransitionConfig<TContext, TEvent> & {
diff --git a/packages/core/test/actionCreators.test.ts b/packages/core/test/actionCreators.test.ts
@@ -111,7 +111,10 @@ describe('action creators', () => {
       const resolvedAction = actions.resolveSend(
         action,
         { delay: 100 },
-        toSCXMLEvent({ type: 'EVENT', value: 50 })
+        toSCXMLEvent({ type: 'EVENT', value: 50 } as {
+          type: 'EVENT';
+          value: number;
+        })
       );
 
       expect(resolvedAction.delay).toEqual(150);
diff --git a/packages/xstate-analytics/package.json b/packages/xstate-analytics/package.json
@@ -41,7 +41,7 @@
     "jest": "^24.8.0",
     "lerna-alias": "3.0.3-0",
     "ts-jest": "^24.1.9",
-    "typescript": "^3.7.5",
+    "typescript": "^3.8.3",
     "xstate": "*"
   },
   "dependencies": {}
diff --git a/packages/xstate-fsm/package.json b/packages/xstate-fsm/package.json
@@ -51,6 +51,6 @@
     "rollup-plugin-terser": "^5.1.2",
     "rollup-plugin-typescript2": "^0.25.2",
     "ts-jest": "^24.1.9",
-    "typescript": "^3.7.5"
+    "typescript": "^3.8.3"
   }
 }
diff --git a/packages/xstate-graph/package.json b/packages/xstate-graph/package.json
@@ -43,7 +43,7 @@
     "jest": "^24.8.0",
     "lerna-alias": "3.0.3-0",
     "ts-jest": "^24.1.9",
-    "typescript": "^3.7.5",
+    "typescript": "^3.8.3",
     "xstate": "*"
   },
   "dependencies": {}
diff --git a/packages/xstate-graph/test/graph.test.ts b/packages/xstate-graph/test/graph.test.ts
@@ -56,7 +56,9 @@ describe('@xstate/graph', () => {
     }
   });
 
-  type CondMachineCtx = { id: string };
+  interface CondMachineCtx {
+    id: string;
+  }
   type CondMachineEvents = { type: 'EVENT'; id: string } | { type: 'STATE' };
 
   const condMachine = Machine<CondMachineCtx, CondMachineEvents>({
diff --git a/packages/xstate-immer/package.json b/packages/xstate-immer/package.json
@@ -44,7 +44,7 @@
   "devDependencies": {
     "immer": "^5.0.0",
     "lerna-alias": "3.0.3-0",
-    "typescript": "^3.7.5",
+    "typescript": "^3.8.3",
     "xstate": "*"
   }
 }
diff --git a/packages/xstate-react/package.json b/packages/xstate-react/package.json
@@ -68,7 +68,7 @@
     "react": "^16.12.0",
     "react-dom": "^16.12.0",
     "ts-jest": "^24.1.9",
-    "typescript": "^3.7.5",
+    "typescript": "^3.8.3",
     "xstate": "*"
   }
 }
diff --git a/packages/xstate-scxml/package.json b/packages/xstate-scxml/package.json
@@ -42,6 +42,6 @@
     "jest": "^24.8.0",
     "lerna-alias": "3.0.3-0",
     "ts-jest": "^24.1.9",
-    "typescript": "^3.7.5"
+    "typescript": "^3.8.3"
   }
 }
diff --git a/packages/xstate-test/package.json b/packages/xstate-test/package.json
@@ -55,7 +55,7 @@
     "puppeteer": "^1.19.0",
     "strip-ansi": "^5.2.0",
     "ts-jest": "^24.1.9",
-    "typescript": "^3.7.5",
+    "typescript": "^3.8.3",
     "xstate": "*"
   },
   "dependencies": {
diff --git a/packages/xstate-viz/example/package.json b/packages/xstate-viz/example/package.json
@@ -16,6 +16,6 @@
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.4",
     "parcel": "^1.12.3",
-    "typescript": "^3.7.5"
+    "typescript": "^3.8.3"
   }
 }
diff --git a/packages/xstate-viz/package.json b/packages/xstate-viz/package.json
@@ -35,7 +35,7 @@
     "react-dom": "^16.12.0",
     "tsdx": "^0.11.0",
     "tslib": "^1.10.0",
-    "typescript": "^3.7.5"
+    "typescript": "^3.8.3"
   },
   "dependencies": {
     "immer": "^5.0.0",
diff --git a/packages/xstate-vue/package.json b/packages/xstate-vue/package.json
@@ -67,7 +67,7 @@
     "rollup-plugin-terser": "^5.1.2",
     "rollup-plugin-typescript2": "^0.25.2",
     "ts-jest": "^24.1.9",
-    "typescript": "^3.7.5",
+    "typescript": "^3.8.3",
     "vue": "^2.6.10",
     "vue-jest": "^3.0.5",
     "xstate": "*"
diff --git a/patches/@changesets+assemble-release-plan+0.3.0.patch b/patches/@changesets+assemble-release-plan+0.3.0.patch
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@`
`66`	`66`	`"rxjs": "^6.5.1",`
`67`	`67`	`"ts-jest": "^24.1.9",`
`68`	`68`	`"tslib": "^1.10.0",`
`69`		`- "typescript": "^3.7.5",`
	`69`	`+ "typescript": "^3.8.3",`
`70`	`70`	`"xml-js": "^1.6.11"`
`71`	`71`	`}`
`72`	`72`	`}`
Original file line number	Diff line number	Diff line change
`@@ -778,7 +778,7 @@ export class Interpreter<`
`778`	`778`	`this.parent.send({`
`779`	`779`	`type: 'xstate.error',`
`780`	`780`	`data: err`
`781`		`- });`
	`781`	`+ } as EventObject);`
`782`	`782`	`}`
`783`	`783`
`784`	`784`	`throw err;`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,6 @@`
`51`	`51`	`"rollup-plugin-terser": "^5.1.2",`
`52`	`52`	`"rollup-plugin-typescript2": "^0.25.2",`
`53`	`53`	`"ts-jest": "^24.1.9",`
`54`		`- "typescript": "^3.7.5"`
	`54`	`+ "typescript": "^3.8.3"`
`55`	`55`	`}`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,9 @@ describe('@xstate/graph', () => {`
`56`	`56`	`}`
`57`	`57`	`});`
`58`	`58`
`59`		`- type CondMachineCtx = { id: string };`
	`59`	`+ interface CondMachineCtx {`
	`60`	`+ id: string;`
	`61`	`+ }`
`60`	`62`	`type CondMachineEvents = { type: 'EVENT'; id: string } \| { type: 'STATE' };`
`61`	`63`
`62`	`64`	`const condMachine = Machine<CondMachineCtx, CondMachineEvents>({`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@`
`44`	`44`	`"devDependencies": {`
`45`	`45`	`"immer": "^5.0.0",`
`46`	`46`	`"lerna-alias": "3.0.3-0",`
`47`		`- "typescript": "^3.7.5",`
	`47`	`+ "typescript": "^3.8.3",`
`48`	`48`	`"xstate": "*"`
`49`	`49`	`}`
`50`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@`
`68`	`68`	`"react": "^16.12.0",`
`69`	`69`	`"react-dom": "^16.12.0",`
`70`	`70`	`"ts-jest": "^24.1.9",`
`71`		`- "typescript": "^3.7.5",`
	`71`	`+ "typescript": "^3.8.3",`
`72`	`72`	`"xstate": "*"`
`73`	`73`	`}`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,6 @@`
`42`	`42`	`"jest": "^24.8.0",`
`43`	`43`	`"lerna-alias": "3.0.3-0",`
`44`	`44`	`"ts-jest": "^24.1.9",`
`45`		`- "typescript": "^3.7.5"`
	`45`	`+ "typescript": "^3.8.3"`
`46`	`46`	`}`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,6 @@`
`16`	`16`	`"@types/react": "^16.9.11",`
`17`	`17`	`"@types/react-dom": "^16.9.4",`
`18`	`18`	`"parcel": "^1.12.3",`
`19`		`- "typescript": "^3.7.5"`
	`19`	`+ "typescript": "^3.8.3"`
`20`	`20`	`}`
`21`	`21`	`}`