changelog.md

0.9.5

• Asynchronous actions are now a first class concept in mobx-state-tree. See the docs

0.9.4

• Introduced types.null and types.undefined
• Introduced types.enumeration(name?, options)

0.9.3

• Fix note that a snapshot is compatible when assigning a type to an optional version of itself
• Fix error when deleting a non existing item from a map #255
• Now all required TypeScript interfaces are exported in the main mobx-state-tree package #256

0.9.2

Introduced the concept of reverse patches, see #231

• Introduced the revertPatch operation, that takes a patch or list of patches, and reverse applies it to the target.
• onPatch now takes a second argument, includeOldValue, defaulting to false, which, if set to true, includes in the patch any value that is being overwritten as result of the patch. Setting this option to true produces patches that can be used with revertPatch
• patchRecorder now introduces additional fields / methods to be able to reverse apply changes: patchRecorder.cleanPatches, patchRecorder.undo

0.9.1

• Applying a snapshot or patches will now emit an action as well. The name of the emitted action will be @APPLY_PATCHESresp @APPLY_SNAPSHOT. See #107
• Fixed issue where same Date instance could'nt be used two times in the same state tree #229
• Fixed issue with reapplying snapshots to Date field resulting in snapshot typecheck error#233
• Declaring types.maybe(types.frozen) will now result into an error #224
• Added support for Mobx observable arrays in type checks #221 (from alessioscalici)

0.9.0

• BREAKING Removed applyPatches and applyActions. Use applyPatch resp. applyAction, as both will now also accept an array as argument
• BREAKING unprotect and protect can only be applied at root nodes to avoid confusing scenarios Fixed #180
• Fixed #141, actions / views are no longer wrapped in dynamically generated functions for a better debugging experience
• Small improvements to typings, fixed compilation issues with TypeScript 2.4.1.
• Fixed issues where compose couldn't overwrite getters. #209, by @homura
• Fixed CDN links in readme
• Added TodoMVC to the examples section

0.8.2

• Fixed issue in rollup module bundle

0.8.1

• Fixed issue in release script, rendering 0.8.0 useless

0.8.0

• BREAKING Dropped types.extend in favor of types.compose. See #192
• Introduced the lifecycle hooks preProcessSnapshot and postProcessSnapshot. See #203 / #100
• Use rollup as bundler #196

0.7.3

• Introduced the concept of volatile / local state in models. See #168, or docs
• Fixed issue with types.map() with types.identifier(types.number) #191 reported by @boatkorachal
• Fixed issue with reconciler that affected types.map when node already existed at that key reported by @boatkorachal #191

0.7.2

• Fixed cannot read property resolve of undefined thanks to @cpunion for reporting, now value of dead nodes will be undefined. #186
• Fixed [LateType] is not defined thanks to @amir-arad for reporting, when using late as model property type #187
• Fixed Object.freeze can only be called on Object thanks to @ds300 for reporting, when using MST on a ReactNative environment #189
• Now the entire codebase is prettier! :D #187

0.7.1

• Fixed array.remove not working

0.7.0

The type system and internal administration has been refactoring, making the internals both simpler and more flexible. Things like references and identifiers are now first class types, making them much better composable. #152

• BREAKING References with a predefined lookup path are no longer supported. Instead of that, identifiers are now looked up in the entire tree. For that reasons identifiers now have to be unique in the entire tree, per type.
• BREAKING resolve is renamed to resolvePath
• Introduced resolveIdentifier(type, tree, identifier) to find objects by identifier
• BREAKING types.reference is by default non-nullable. For nullable identifiers, use types.maybe(types.reference(X))
• Many, many improvements. Related open issues will be updated.
• BREAKING isMST is renamed to isStateTreeNode

0.6.3

• Fixed issue with array/maps of union types @abruzzihraig #151
• Make types.extend support computed attributes @cpunion #169
• Fixed issue with map of primitive types and applySnapshot @pioh #155
• Better type declarations for union, up to 10 supported types

0.6.2

• Fixed issue where arrays where not properly serialized as action argument

0.6.1

• Improved reporting of Type.is(), now it returns a fine grained report of why the provided value is not applicable.

[mobx-state-tree] Error while converting [{}] to AnonymousModel[]:
at path "/name" snapshot undefined is not assignable to type: string.
at path "/quantity" snapshot undefined is not assignable to type: number.

• Fixed support for types.reference in combination with types.late, by @robinfehr

0.6.0

• BREAKING types.withDefault has been renamed to types.optional
• BREAKING Array and map types can no longer be left out of snapshots by default. Use optional to make them optional in the snapshot
• BREAKING Literals no longer have a default value by default (use optional + literal instead)
• BREAKING Disabled inlining type.model definitions as introduced in 0.5.1; to many subtle issues
• Improved identifier support, they are no properly propageted through utility types like maybe, union etc
• Fixed issue where fields where not referted back to default when a partial snapshot was provided
• Fixed #122: types.identifier now also accepts a subtype to override the default string type; e.g. types.identifier(types.number)

0.5.1

• Introduced support for lazy evaluating values in withDefault, useful to generate UUID's, timestamps or non-primitive default values
• It is now possible to define something like Removed in 0.6.0

const Box = types.model({
    point: {
        x: 10,
        y: 10
    }
}

Where the type of point property is inferred to point: types.withDefault(types.model({ x: 10, y: 10}), () => ({ x: 10, y: 10 }))

0.5.0

• ** BREAKING ** protection is now enabled by default (#101)
• ** BREAKING ** it is no longer possible to read values from a dead object. Except through getSnapshot or clone (#102)
• ** BREAKING ** types.recursive has been removed in favor of types.late
• Introduced unprotect, to disable protection mode for a certain instance. Useful in afterCreate hooks
• Introduced types.late. Usage: types.late(() => typeDefinition). Can be used for circular / recursive type definitions, even across files. See test/circular(1|2).ts for an example (#74)

0.4.0

BREAKING types.model no requires 2 parameters to define a model. The first parameter defines the properties, derived values and view functions. The second argment is used to define the actions. For example:

const Todo = types.model("Todo", {
    done: types.boolean,
    toggle() {
        this.done = !this.done
    }
})

Now should be defined as:

const Todo = types.model(
    "Todo",
    {
        done: types.boolean,
    },
    {
        toggle() {
            this.done = !this.done
        }
    }
)

It is still possible to define functions on the first object. However, those functions are not considered to be actions, but views. They are not allowed to modify values, but instead should produce a new value themselves.

0.3.3

• Introduced lifecycle hooks afterCreate, afterAttach, beforeDetach, beforeDestroy, implements #76
• Introduced the convenience method addDisposer(this, cb) that can be used to easily destruct reactions etc. which are set up in afterCreate. See #76

0.3.2

• Fix: actions where not bound automatically
• Improved and simplified the reconciliation mechanism, fixed many edge cases
• Improved the reference mechanism, fixed many edge cases
• Improved performance

0.3.1

• (re) introduced the concept of environments, which can be passed as second argument to .create, and picked up using getEnv

0.3.0

• Removed primitive type, use a more specific type instead
• Improved typescript typings of snapshots
• Added depth parameter to getParent and hasParent
• Separated the concepts of middleware and serializable actions. It is now possible to intercept, modify actions etc through addMiddleWare. onAction now uses middleware, if it is used, all parameters of actions should be serializable!

0.2.2

• Introduced the concept of livelyness; if nodes are removed from the the tree because they are replaced by some other value, they will be marked as "died". This should help to early signal when people hold on to references that are not part of the tree anymore. To explicitly remove an node from a tree, with the intent to spawn a new state tree from it, use detach.
• Introduced the convenience method destroy to remove a model from it's parent and mark it as dead.
• Introduced the concept of protected trees. If a tree is protected using protect, it can only be modified through action, and not by mutating it directly anymore.

0.2.1

• Introduced .Type and .SnapshotType to be used with TypeScript to get the type for a model

0.2.0

• Renamed createFactory to types.model (breaking!)
• Renamed composeFactory to types.extend (breaking!)
• Actions should now be declared as name(params) { body }, instead of name: action(function (params) { body}) (breaking!)
• Models are no longer constructed by invoking the factory as function, but by calling factory.create (breaking!)
• Introduced identifier
• Introduced / improved reference
• Greatly improved typescript support, type inference etc. However there are still limitations as the full typesystem of MST cannot be expressed in TypeScript. Especially concerning the type of snapshots and the possibility to use snapshots as first class value.