refactor(overmind): simplify types, rename effects to context

BREAKING CHANGES:
the 'effects' field is now 'context'

Author: gaspard

packages/demos/react-typescript-todomvc/src/app/actions.ts

@@ -1,12 +1,13 @@
 import * as React from 'react'
-import { Action } from 'overmind'
-import { Todo } from './state'
-import * as operations from './operations'
+
+import { Action } from './'
 import * as mutations from './mutations'
+import * as operations from './operations'
+import { Todo } from './state'
 
 type ChangeEvent = React.ChangeEvent<HTMLInputElement>
 
-export const changeNewTodoTitle: Action<ChangeEvent> = (action) =>
+export const changeNewTodoTitle: Action<ChangeEvent, string> = (action) =>
   action.map(operations.getEventValue).mutate(mutations.setNewTodoTitle)
 
 export const addTodo: Action<React.FormEvent> = (action) =>

…ct-typescript-todomvc/src/app/effects.ts …ct-typescript-todomvc/src/app/context.tspackages/demos/react-typescript-todomvc/src/app/effects.ts renamed to packages/demos/react-typescript-todomvc/src/app/context.ts packages/demos/react-typescript-todomvc/src/app/effects.ts renamed to packages/demos/react-typescript-todomvc/src/app/context.ts

@@ -1,24 +1,55 @@
-import App from 'overmind'
+import App, {
+  TAction,
+  TApp,
+  TContext,
+  TDerive,
+  TMutate,
+  TReaction,
+} from 'overmind'
 import createConnect, { TConnect } from 'overmind-react'
-import * as effects from './effects'
+
 import * as actions from './actions'
+import * as context from './context'
 import * as state from './state'
 
 const config = {
-  effects,
+  context,
   actions,
   state,
 }
 
-declare module 'overmind' {
-  interface IState extends TState<typeof config> {}
-  interface IEffects extends TEffects<typeof config> {}
-}
-
 const app = new App(config)
 
 export type Connect = TConnect<typeof app>
 
 export const connect = createConnect(app)
 
+type IApp = TApp<typeof config>
+
 export default app
+
+// ==== The following types are copied from overmind documentation ====
+
+export type Action<Value = void, ReturnValue = Value> = TAction<
+  IApp,
+  Value,
+  ReturnValue
+>
+
+export type Mutate<Value = any> = TMutate<IApp, Value>
+
+export type Context<Value> = TContext<IApp, Value>
+
+// Operations
+export type Map<Value, ReturnValue = Value> = (
+  ctx: Context<Value>
+) => ReturnValue
+export type Filter<Value = any> = (ctx: Context<Value>) => boolean
+export type When<Value = any> = (ctx: Context<Value>) => boolean
+export type Run<Value = any> = (ctx: Context<Value>) => void
+export type Fork<Value = any> = (ctx: Context<Value>) => string
+export type Attempt<Value, ReturnValue> = (ctx: Context<Value>) => ReturnValue
+
+export type Derive<Value> = TDerive<IApp, Value>
+
+export type Reaction = TReaction<IApp>

packages/demos/react-typescript-todomvc/src/app/index.ts

@@ -1,4 +1,4 @@
-import { Mutate } from 'overmind'
+import { Mutate } from './'
 import { Todo } from './state'
 
 let nextTodoId = 0

packages/demos/react-typescript-todomvc/src/app/mutations.ts

@@ -1,11 +1,9 @@
-import { Operation } from 'overmind'
+import { Map, Run } from './'
 
 type ChangeEvent = React.ChangeEvent<HTMLInputElement>
 
-export const getEventValue: Operation.Map<ChangeEvent, string> = ({
-  value: event,
-}) => event.currentTarget.value
+export const getEventValue: Map<ChangeEvent, string> = ({ value: event }) =>
+  event.currentTarget.value
 
-export const preventEventDefault: Operation.Run<React.FormEvent> = ({
-  value: event,
-}) => event.preventDefault()
+export const preventEventDefault: Run<React.FormEvent> = ({ value: event }) =>
+  event.preventDefault()

packages/demos/react-typescript-todomvc/src/app/operations.ts

@@ -1,4 +1,4 @@
-import { Derive } from 'overmind'
+import { Derive } from './'
 
 export type Todo = {
   id: string

packages/demos/react-typescript-todomvc/src/app/state.ts

@@ -1,6 +1,6 @@
-import OvermindApp, { EventType } from 'overmind'
+import OvermindApp, { BaseApp, EventType } from 'overmind'
 
-export type TConnect<App extends OvermindApp<any, any>> = {
+export type TConnect<App extends BaseApp> = {
   app: {
     state: App['state']
     actions: App['actions']
@@ -14,7 +14,7 @@ export type TConnect<App extends OvermindApp<any, any>> = {
 
 let nextComponentId = 0
 
-export default <App extends OvermindApp<any, any>>(app: App) => () => {
+export default <App extends OvermindApp<any>>(app: App) => () => {
   const componentId = nextComponentId++
   let componentInstanceId = 0
 

packages/node_modules/overmind-angular/src/index.ts

@@ -1,7 +1,7 @@
-import { Action } from 'overmind'
+import { Action } from './'
 import * as mutations from './mutations'
 import * as operations from './operations'
-import { Message, Tab, GroupedComponent } from './types'
+import { GroupedComponent, Message, Tab } from './types'
 
 const handleClientMessages: Action<Message> = (action) =>
   action

packages/node_modules/overmind-devtools/src/app/actions.ts

@@ -1,5 +1,5 @@
 import * as jsonStorage from 'electron-json-storage'
-import BackendConnector from '../BackendConnector'
+import BackendConnector from 'overmind-devtools/src/BackendConnector'
 
 export const connector = new BackendConnector()
 

…les/overmind-devtools/src/app/effects.ts …les/overmind-devtools/src/app/context.tspackages/node_modules/overmind-devtools/src/app/effects.ts renamed to packages/node_modules/overmind-devtools/src/app/context.ts packages/node_modules/overmind-devtools/src/app/effects.ts renamed to packages/node_modules/overmind-devtools/src/app/context.ts

@@ -1,20 +1,23 @@
-import App from 'overmind'
+import App, {
+  TAction,
+  TApp,
+  TContext,
+  TDerive,
+  TMutate,
+  TReaction,
+} from 'overmind'
 import createConnect, { TConnect } from 'overmind-react'
-import * as effects from './effects'
+
 import * as actions from './actions'
+import * as context from './context'
 import * as state from './state'
 
 const config = {
-  effects,
+  context,
   actions,
   state,
 }
 
-declare module 'overmind' {
-  interface IState extends TState<typeof config> {}
-  interface IEffects extends TEffects<typeof config> {}
-}
-
 const app = new App(config, {
   devtools: false,
 })
@@ -24,3 +27,32 @@ export type Connect = TConnect<typeof app>
 export const connect = createConnect(app)
 
 export default app
+
+// === copy/paste
+
+type IApp = TApp<typeof config>
+export type Action<Value = void, ReturnValue = any> = TAction<
+  IApp,
+  Value,
+  ReturnValue
+>
+
+export type Mutate<Value = any> = TMutate<IApp, Value>
+
+export type Context<Value> = TContext<IApp, Value>
+
+// Operations
+export namespace Operation {
+  export type Map<Value, ReturnValue = Value> = (
+    ctx: Context<Value>
+  ) => ReturnValue
+  export type Filter<Value = any> = (ctx: Context<Value>) => boolean
+  export type When<Value = any> = (ctx: Context<Value>) => boolean
+  export type Run<Value = any> = (ctx: Context<Value>) => void
+  export type Fork<Value = any> = (ctx: Context<Value>) => string
+  export type Attempt<Value, ReturnValue> = (ctx: Context<Value>) => ReturnValue
+}
+
+export type Derive<Value> = TDerive<IApp, Value>
+
+export type Reaction = TReaction<IApp>