feat(overmind): expose addMutationListener and rename existing to addFlushListener

BREAKING CHANGE:
addMutationListener is now addFlushListener

Author: christianalfoni

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

@@ -75,7 +75,7 @@ export const createConnect = <A extends Overmind<any>>(overmind: A) => () => {
         name: this.constructor.name || '',
         paths: Array.from(paths),
       })
-      this.__listener = overmind.addMutationListener(paths, (flushId) => {
+      this.__listener = overmind.addFlushListener(paths, (flushId) => {
         this.__shouldUpdatePaths = true
         if (this.cdr) {
           this.cdr.markForCheck()

packages/node_modules/overmind-components/src/Component.ts

@@ -70,28 +70,25 @@ export class Component {
         children: this.children.length === 1 ? this.children[0] : this.children,
       }) || new Null()
     const paths = app.clearTrackState(trackId)
-    this.mutationListener = app.addMutationListener(
-      paths,
-      (flushId, isAsync) => {
-        app.eventHub.emitAsync('component:update', {
-          componentId: this.componentId,
-          componentInstanceId: this.componentInstanceId,
-          name: this.name,
-          flushId,
-          paths: Array.from(paths),
-        })
-
-        if (isAsync && !this.asyncRender) {
-          this.asyncRender = requestAnimationFrame(() => {
-            this.asyncRender = null
-            this.reconcile(this, true)
-          })
-        } else if (!isAsync) {
-          cancelAnimationFrame(this.asyncRender)
+    this.mutationListener = app.addFlushListener(paths, (flushId, isAsync) => {
+      app.eventHub.emitAsync('component:update', {
+        componentId: this.componentId,
+        componentInstanceId: this.componentInstanceId,
+        name: this.name,
+        flushId,
+        paths: Array.from(paths),
+      })
+
+      if (isAsync && !this.asyncRender) {
+        this.asyncRender = requestAnimationFrame(() => {
+          this.asyncRender = null
           this.reconcile(this, true)
-        }
+        })
+      } else if (!isAsync) {
+        cancelAnimationFrame(this.asyncRender)
+        this.reconcile(this, true)
       }
-    )
+    })
     app.eventHub.emitAsync('component:add', {
       componentId: this.componentId,
       componentInstanceId: this.componentInstanceId,

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

@@ -71,7 +71,7 @@ export const createHook = <A extends Overmind<Configuration>>(overmind: A) => {
         const thisComponentInstanceId = componentInstanceId++
         setOvermindState({
           componentInstanceId: thisComponentInstanceId,
-          listener: overmind.addMutationListener(paths, (flushId) => {
+          listener: overmind.addFlushListener(paths, (flushId) => {
             overmind.eventHub.emitAsync(EventType.COMPONENT_UPDATE, {
               componentId: component.__componentId,
               componentInstanceId: thisComponentInstanceId,
@@ -165,7 +165,7 @@ export const createConnect = <A extends Overmind<Configuration>>(
             name: Component.name || '',
             paths: Array.from(paths),
           })
-          this.__mutationListener = overmind.addMutationListener(
+          this.__mutationListener = overmind.addFlushListener(
             paths,
             (flushId) => {
               if (this.__isUnmounting) {
@@ -239,7 +239,7 @@ export const createConnect = <A extends Overmind<Configuration>>(
             name: Component.name || '',
             paths: Array.from(paths),
           })
-          this.__mutationListener = overmind.addMutationListener(
+          this.__mutationListener = overmind.addFlushListener(
             paths,
             (flushId) => {
               if (this.__isUnmounting) {

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

@@ -76,7 +76,7 @@ export const createConnect = <A extends Overmind<any>>(overmind: A) => <
       name: componentOptions.name || this.name || '',
       paths: Array.from(paths),
     })
-    this.__proxyStateTreeListener = overmind.addMutationListener(
+    this.__proxyStateTreeListener = overmind.addFlushListener(
       paths,
       (flushId) => {
         overmind.eventHub.emitAsync(EventType.COMPONENT_UPDATE, {

packages/node_modules/overmind/src/derived.test.ts

@@ -72,7 +72,7 @@ describe('Derived', () => {
       app.state.upperFoo
       return app.clearTrackState(trackId)
     }
-    app.addMutationListener(render(), () => {
+    app.addFlushListener(render(), () => {
       renderCount++
     })
     app.actions.changeFoo()

packages/node_modules/overmind/src/index.ts

@@ -463,9 +463,12 @@ export class Overmind<Config extends Configuration> implements Configuration {
   clearTrackState(id: number, cb?: () => void) {
     return this.proxyStateTree.clearPathsTracking(id, cb)
   }
-  addMutationListener(paths, cb) {
+  addFlushListener(paths, cb) {
     return this.proxyStateTree.addFlushListener(paths, cb)
   }
+  addMutationListener(cb) {
+    return this.proxyStateTree.addMutationListener(cb)
+  }
   createReactionFactory(prefix: string) {
     const reactions: Reaction[] = []
     const instance = this