docs(website): update website to latest API changes

christianalfoni · christianalfoni · commit fb9f4452f3b0 · 2018-10-16T21:56:49.000+02:00
diff --git a/packages/overmind-website/examples/api/action_attempt.ts b/packages/overmind-website/examples/api/action_attempt.ts
@@ -6,8 +6,8 @@ export default (ts) =>
           code: `
 import { Operation } from 'overmind'
 
-export const getItems: Operation.Attempt<Promise<Items>> = ({ effects }) =>
-  effects.http.get('/items')
+export const getItems: Operation.Attempt<any, Promise<Items>> = ({ http }) =>
+  http.get('/items')
   `,
         },
         {
@@ -32,8 +32,8 @@ export const doThis: Action = action =>
         {
           fileName: 'app/operations.js',
           code: `
-export const getItems = ({ effects }) =>
-  effects.http.get('/items')
+export const getItems = ({ http }) =>
+  http.get('/items')
   `,
         },
         {
diff --git a/packages/overmind-website/examples/api/action_filter.ts b/packages/overmind-website/examples/api/action_filter.ts
@@ -6,8 +6,8 @@ export default (ts) =>
           code: `
 import { Operation } from 'overmind'
 
-export const isOnline: Operation.Filter = ({ effects }) =>
-  effects.connection.isOnline()
+export const isOnline: Operation.Filter = ({ connection }) =>
+  connection.isOnline()
 
 export const isGreatherThan2: Operation.Filter<string> = ({ value }) =>
   value.length > 2
@@ -29,8 +29,8 @@ export const doThis: Action<string> = action =>
         {
           fileName: 'app/operations.js',
           code: `
-export const isOnline = ({ effects }) =>
-  effects.connection.isOnline()
+export const isOnline = ({ connection }) =>
+  connection.isOnline()
 
 export const isGreaterThan2 = ({ value }) =>
   value.length > 2
diff --git a/packages/overmind-website/examples/api/action_map.ts b/packages/overmind-website/examples/api/action_map.ts
@@ -7,7 +7,7 @@ export default (ts) =>
 import { Operation } from 'overmind'
 
 export const getUser: Operation.Map<string, Promise<User>> =
-  ({ effects, value: id }) => effects.http.get(\`/users/\${id}\`)
+  ({ http, value: id }) => http.get(\`/users/\${id}\`)
 
 export const trim: Operation.Map<string, string> =
   ({ value }) => value.trim()
@@ -29,7 +29,7 @@ export const doThis: Action<string> = action =>
         {
           fileName: 'app/operations.js',
           code: `
-export const getUser = ({ effects, value: id }) =>
+export const getUser = ({ http, value: id }) =>
   http.get(\`/users/\${id}\`)
 
 export const trim = (_, value) =>
diff --git a/packages/overmind-website/examples/api/action_mutation.ts b/packages/overmind-website/examples/api/action_mutation.ts
@@ -4,12 +4,12 @@ export default (ts) =>
         {
           fileName: 'app/mutations.ts',
           code: `
-import { Mutate } from 'overmind'
+import { Operation } from 'overmind'
 
-export const setLoading: Mutate = ({ state }) =>
+export const setLoading: Operation.Mutate = ({ state }) =>
   state.isLoading = true
 
-export const setInputValue: Mutate<string> = ({ state, value }) =>
+export const setInputValue: Operation.Mutate<string> = ({ state, value }) =>
   state.inputValue = value
     `,
         },
diff --git a/packages/overmind-website/examples/api/action_run.ts b/packages/overmind-website/examples/api/action_run.ts
@@ -6,8 +6,8 @@ export default (ts) =>
           code: `
 import { Operation } from 'overmind'
 
-export const trackSubmitForm: Operation.Run = ({ state, effects }) =>
-  effects.track.interaction('login', Boolean(state.user))
+export const trackSubmitForm: Operation.Run = ({ state, track }) =>
+  track.interaction('login', Boolean(state.user))
     `,
         },
         {
@@ -35,8 +35,8 @@ export const login: Action = (action) =>
         {
           fileName: 'app/operations.js',
           code: `
-export const trackSubmitForm = ({ effects }) =>
-  effects.track.interaction('submitForm')    
+export const trackSubmitForm = ({ track }) =>
+  track.interaction('submitForm')    
     `,
         },
         {
diff --git a/packages/overmind-website/examples/api/action_when.ts b/packages/overmind-website/examples/api/action_when.ts
@@ -6,8 +6,8 @@ export default (ts) =>
           code: `
 import { Operation } from 'overmind'
 
-export const hasToken: Operation.When = ({ effects }) =>
-  Boolean(effects.localStorage.get('token'))
+export const hasToken: Operation.When = ({ localStorage }) =>
+  Boolean(localStorage.get('token'))
   `,
         },
         {
@@ -32,8 +32,8 @@ export const doThis: Action = action =>
         {
           fileName: 'app/operations.js',
           code: `
-export const hasToken = ({ effects }) =>
-  Boolean(effects.localStorage.get('token'))
+export const hasToken = ({ localStorage }) =>
+  Boolean(localStorage.get('token'))
   `,
         },
         {
diff --git a/packages/overmind-website/examples/api/modules.ts b/packages/overmind-website/examples/api/modules.ts
@@ -4,7 +4,7 @@ export default (ts, view) =>
         {
           fileName: 'app.ts',
           code: `
-import App, { modules } from 'overmind'
+import Overmind, { TApp, modules } from 'overmind'
 import createConnect, { TConnect } from 'overmind-${view}'
 import * as moduleA from './moduleA'
 import * as moduleB from './moduleB'
@@ -20,11 +20,9 @@ const config = modules({
 })
 
 declare module 'overmind' {
-  interface IState extends TState<typeof config> {}
-  interface IEffects extends TEffects<typeof config> {}
+  interface App extends TApp<typeof config> {}
 }
 
-
 const app = new App(config)
 
 export type Connect = TConnect<typeof app>
diff --git a/packages/overmind-website/examples/guide/creatingactions/mutations.ts b/packages/overmind-website/examples/guide/creatingactions/mutations.ts
@@ -4,15 +4,15 @@ export default (ts) =>
         {
           fileName: 'app/mutations.js',
           code: `
-import { Mutate } from 'overmind'
+import { Operation } from 'overmind'
 
-export const setValue: Mutate = ({ state }) =>
+export const setValue: Operation.Mutate = ({ state }) =>
   state.value = 'foo'
 
-export const setValueFromAction: Mutate<string> = ({ state, value }) =>
+export const setValueFromAction: Operation.Mutate<string> = ({ state, value }) =>
   state.value2 = value
 
-export const setValueFromState: Mutate = ({ state }) =>
+export const setValueFromState: Operation.Mutate = ({ state }) =>
   state.value3 = state.value
   `,
         },
diff --git a/packages/overmind-website/examples/guide/getstarted/mutations.ts b/packages/overmind-website/examples/guide/getstarted/mutations.ts
@@ -18,16 +18,16 @@ export let posts: Post[] = []
         {
           fileName: 'app/mutations.ts',
           code: `
-import { Mutate } from 'overmind'
+import { Operation } from 'overmind'
 import { Post } from './state'
 
-export const setLoadingPosts: Mutate = ({ state }) =>
+export const setLoadingPosts: Operation.Mutate = ({ state }) =>
   state.isLoadingPosts = true
 
-export const unsetLoadingPosts: Mutate = ({ state }) =>
+export const unsetLoadingPosts: Operation.Mutate = ({ state }) =>
   state.isLoadingPosts = false
 
-export const setPosts: Mutate<Post[]> = ({ state, value: posts }) =>
+export const setPosts: Operation.Mutate<Post[]> = ({ state, value: posts }) =>
   state.posts = posts
   `,
         },
diff --git a/packages/overmind-website/examples/templates.ts b/packages/overmind-website/examples/templates.ts
@@ -2,16 +2,15 @@ const getVersion = () => (location.host.split('.')[0] === 'next' ? '@next' : '')
 
 export const tsAppIndex = (view, config) => {
   return `
-import App from 'overmind'
+import Overmind, { TApp } from 'overmind'
 import createConnect, { TConnect } from 'overmind-${view}'
 ${config.trim()}
 
 declare module 'overmind' {
-  interface IState extends TState<typeof config> {}
-  interface IEffects extends TEffects<typeof config> {}
+  interface App extends TApp<typeof config> {}
 }
 
-const app = new App(config)
+const app = new Overmind(config)
 
 export type Connect = TConnect<typeof app>
 
diff --git a/packages/overmind-website/guides/beginner/01_getstarted.md b/packages/overmind-website/guides/beginner/01_getstarted.md
@@ -44,23 +44,23 @@ h(Example, { name: "guide/getstarted/actions" })
 
 As you can see we have not really written any logic yet, we are just describing what we want to happen. This is what we call **declarative** code and is a concept in programming used to manage complexity. In this application it might seem unnecessary, but it is very important to manage complexity as your application grows.
 
-## Mutations
+## Operations
+
+All logic you write for your app is considered an operation. These operation functions have different signatures based on the **operator** that consumes it in an action. The most important operation is the mutation operation.
 
 ```marksy
 h(Example, { name: "guide/getstarted/mutations" })
 ```
 
 Functions used with the **mutate** operator are passed the current state of the application and the current value of the action. These functions are the only functions allowed to change the state of your application. This restriction combined with being just a simple function gives you several benefits as you will see when diving deeper into Overmind.
 
-## Operations
-
-All logic that is not related to changing the state of the application is considered an operation. These functions have different signatures based on the **operator** that consumes it in an action. In this example we are using the **map** operator which expects a function. This function is just like the mutation function above, but it will also receives all the **effects** configured for your application.
+Other operations like **map** has a very similar signature, though it will also receive all the **effects** configured for your application.
 
 ```marksy
 h(Example, { name: "guide/getstarted/operations" })
 ```
 
-By default the **effects** contain the state of the application, but here, we also want to extend it with a **jsonPlaceholder** api. Let us look at effects.
+We want to add an effect to our application called **jsonPlaceholder** api, which we can use with the **map** operation to grab some data.
 
 ## Effects
 
