fix(overmind): new approach to serializing using symbol

Author: christianalfoni

packages/node_modules/overmind/src/Devtools.ts

@@ -1,4 +1,4 @@
-import { IS_JSON } from './utils'
+import { SERIALIZE } from './utils'
 
 export type Message = {
   type: string
@@ -82,7 +82,7 @@ export class Devtools {
           return value
         }
 
-        if (value && value[IS_JSON] && value.constructor.name !== 'Object') {
+        if (value && value[SERIALIZE]) {
           return {
             __CLASS__: true,
             name: value.constructor.name,

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

@@ -1,11 +1,12 @@
-import { EventType, IAction, Overmind, createOvermindMock, rehydrate } from './'
+import { EventType, IAction, Overmind, SERIALIZE, createOvermindMock, rehydrate } from './'
 import { namespaced } from './config'
 
 function toJSON(obj) {
   return JSON.parse(JSON.stringify(obj))
 }
 
 class StateValue {
+  [SERIALIZE]
   value = 'foo'
   toJSON() {
     return {
@@ -57,7 +58,7 @@ function createDefaultOvermind() {
   }
   const rehydrateAction: Action<any> = ({ state }, newState) => {
     rehydrate(state, newState, {
-      value: (json) => StateValue.fromJSON(json)
+      value: StateValue.fromJSON
     })
   }
   const actions = {

packages/node_modules/overmind/src/index.ts

@@ -25,6 +25,7 @@ import {
   ResolveActions,
   ResolveState,
   SSRMode,
+  Serializable,
   TestMode
 } from './internalTypes'
 import {
@@ -66,9 +67,9 @@ import {
 
 export * from './types'
 
-export { createOperator, createMutationOperator, ResolveState, ResolveActions }
+export { createOperator, createMutationOperator, ResolveState, ResolveActions, Serializable, }
 
-export { MODE_DEFAULT, MODE_TEST, MODE_SSR } from './utils'
+export { MODE_DEFAULT, MODE_TEST, MODE_SSR, SERIALIZE } from './utils'
 
 /** This type can be overwriten by app developers if they want to avoid
  * typing and then they can import `Action`,  `Operation` etc. directly from

packages/node_modules/overmind/src/internalTypes.ts

@@ -6,6 +6,7 @@ import {
 } from 'proxy-state-tree'
 
 import { IAction, IOperator, IState } from './types'
+import { SERIALIZE } from './utils'
 
 export type SubType<Base, Condition> = Pick<
   Base,
@@ -16,13 +17,17 @@ export type NestedPartial<T> = T extends Function
   ? T
   : Partial<{ [P in keyof T]: NestedPartial<T[P]> }>
 
+export interface Serializable {
+  [SERIALIZE]: boolean
+}
+
 export type RehydrateClasses<T extends IState> = Pick<{
-  [P in keyof T]: T[P] extends { toJSON: () => infer U } ? (data: U) => T[P] :
-      T[P] extends Array<{ toJSON: () => infer U }> ? (data: U) => T[P][keyof T[P]] :
-      T[P] extends { [key: string]: { toJSON: () => infer U } } ? (data: U) => T[P][keyof T[P]] :
+  [P in keyof T]: T[P] extends Serializable ? (data: any) => T[P] :
+      T[P] extends Array<Serializable> ? (data: any) => T[P][keyof T[P]] :
+      T[P] extends { [key: string]: Serializable } ? (data: any) => T[P][keyof T[P]] :
       T[P] extends IState ? RehydrateClasses<T[P]> :
       never
-},{ [Key in keyof T]: T[Key] extends { toJSON: () => any } | Array<{ toJSON: () => any }> | { [key: string]: { toJSON: () => any } } ? Key : never }[keyof T]>
+},{ [Key in keyof T]: T[Key] extends Serializable | Array<Serializable> | { [key: string]: Serializable } ? Key : never }[keyof T]>
 
 export type Options = {
   name?: string

packages/node_modules/overmind/src/utils.ts

@@ -13,7 +13,7 @@ export const EXECUTION = Symbol('execution')
 export const MODE_DEFAULT = Symbol('MODE_DEFAULT')
 export const MODE_TEST = Symbol('MODE_TEST')
 export const MODE_SSR = Symbol('MODE_SSR')
-export const IS_JSON = Symbol('IS_JSON')
+export const SERIALIZE = Symbol('SERIALIZE')
 
 export class MockedEventEmitter {
   emit() {}
@@ -23,10 +23,8 @@ export class MockedEventEmitter {
   addListener() {}
 }
 
-export const json = (obj: any) => {
-  const result = deepCopy(obj && obj[IS_PROXY] ? obj[VALUE] : obj)
-  result[IS_JSON] = obj
-  return result
+export const json = <T>(obj: T): T => {
+  return deepCopy(obj && obj[IS_PROXY] ? obj[VALUE] : obj)
 }
 
 

packages/overmind-website/src/overmind/actions.ts

@@ -6,6 +6,7 @@ import {
   filter,
   mutate,
   pipe,
+  rehydrate,
 } from 'overmind'
 
 import { GuideParams, Page, RouteContext, VideoParams } from './types'
@@ -123,3 +124,15 @@ export const changeQuery: Operator<string> = pipe(
 export const viewHelpGotIt: Action = ({ state }) => {
   state.showViewHelp = false
 }
+
+export const test: Action = ({ state }) => {
+  rehydrate(
+    state,
+    {
+      user: {
+        name: 'Bob',
+      },
+    },
+    {}
+  )
+}

packages/overmind-website/src/overmind/state.ts

@@ -1,4 +1,4 @@
-import { Derive } from 'overmind'
+import { Derive, SERIALIZE } from 'overmind'
 
 import {
   Api,
@@ -37,11 +37,11 @@ type State = {
 }
 
 class User {
+  [SERIALIZE]
   name = 'Bob'
-  toJSON() {
-    return {
-      name: 'ARNE',
-    }
+  toJSON() {}
+  static fromJSON(json) {
+    return Object.assign(new User(), json)
   }
 }