npm package: @myrtille/mutate
Description: An immutable (with immer mutations) one-way state manager without reducers.
Latest version: 0.8.4

# @myrtille/mutate
> An immutable (with immer mutations) one-way state manager without reducers

[![npm](https://img.shields.io/npm/v/@myrtille/mutate.svg)](https://www.npmjs.com/package/@myrtille/mutate) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/@myrtille/mutate.svg)](https://bundlephobia.com/result?p=@myrtille/mutate@latest) [![CircleCI](https://img.shields.io/circleci/build/github/fabienjuif/myrtille.svg)](https://app.circleci.com/pipelines/github/fabienjuif/myrtille?branch=master) [![Coveralls github](https://img.shields.io/coveralls/github/fabienjuif/myrtille.svg)](https://coveralls.io/github/fabienjuif/myrtille)

# Features
- 🔄 One-way state manager: your store is the single source of truth
- 💎 Immutable but feels mutable
- ⛏️ Hackable
- 💡 Based on events (actions)
- 📖 Compatible with redux-devtools

# Inspirations
 - https://github.com/rakunteam/k-ramel
 - https://github.com/jamiebuilds/bey

# The goal
The goal is to have a simple state manager, without being strictely related to single view library (like React or Vue).
The Redux pattern, having a one-way state management, is a good pattern but Redux suffers from boilerplate, and once you add middleware you don't have clear separation of concerns.
Myrtille tries to fix these drawbacks by using [immer](https://github.com/immerjs/immer) under the hood and by merging "reducers" and "reactions" into one place: listeners.

We also want to make sure your UI component tree is optimized and only refreshes when needed, that's why you can give a `path` to subscribers, you can make sure your component tree will be refreshed only when this path updates.

One of the last goals that Myrtille aims at is to let the developper doing whatever he wants with this library, that's why the store is always given and usable inside your callbacks, hack-it!

# Installation
- `npm install --save @myrtille/mutate`
- `yarn add @myrtille/mutate`
- `pnpm install --save @myrtille/mutate`

# Packages

| package name | description | size |
|--|--|--|
| `@myrtille/core` | base package, contains the createStore **without** the `mutate` function | ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@myrtille/core.svg) | 
| `@myrtille/mutate` | contains the createStore **WITH** the `mutate` function, powered by immer | ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@myrtille/mutate.svg) | 
| `@myrtille/react` | React.js bindings (works with core or mutate) | ![npm bundle size](https://img.shields.io/bundlephobia/minzip/@myrtille/react.svg) | 

# API
- `createStore(initialState: Object) -> Store`
  * create a store with the given initial state
  * eg: `const store = createStore({ todos: [] })`
- `Store.setState(newState: Object) -> void`
  * set state to the given one and triggers listeners
- `Store.getState() -> State`
  * get the current state
- `Store.mutate((state: State) -> void): void` (only available with `@myrtille/mutate` version)
  * register a mutation, the `currentState` given in callback HAVE TO be mutated, it is [myrtille](https://github.com/fabienjuif/myrtille) (via [immer](https://github.com/immerjs/immer)) that makes sure this is done in an immutable way!
  * eg: `store.mutate(state => { state.todos.push({ id: 2, label: 'new' }) })`
- `Store.dispatch(action: String | Object) -> void`
  * dispatch an action that listeners can register on. If the action is a string, the `action` is created by [myrtille](https://github.com/fabienjuif/myrtille) to follow the standard rule: `{ type: $yourString }`
  * eg: `store.dispatch('FETCH_TODOS')`
  * eg: `store.dispatch({ type: 'ADD_TODO', payload: { id: 2, label: 'new' }})`
- `Store.addListener(action: String | Action | Function, reaction: Function((store: Store, action: Action) -> void) | void) -> Function`
  * add a listener to the store, a listener **listen** to an action, when this `action` is dispatched, the registered `reaction` (which is a callback) is called.
  * you can set your `reaction` at first argument, in which it will be called for every actions dispatched.
  * you can play with the store in the given reaction (dispatch new action, register mutations, etc.)
  * calling the returned function will remove your reaction
  * eg: [take a look at listeners examples](#listeners-examples)
- `Store.subscribe(path: String | Function, callback: Function(store: Store, oldState: State, action: Action) | void) -> Function`
  * subcribe to state mutations at given `path`. The registered `callback` is called whenever the store was mutated at given `path`.
  * you can set your `callback` at first argument, in which it will be called for every dispatch (even if there is no mutation)
  * if you set path to `''` (empty string),  the callback will be called only for root mutations
  * you can play with the store in the given callback (dispatch new action, register mutations, etc.) but prefer using listeners and dispatching actions.
  * calling the returned function will unsubscribe your callback
- `Store.contexts: Object`
  * used to retrieve some informations from your callbacks given to `addListener` and `subscribe`
  * eg: `store.contexts.firebase = require('firebase/app')`

# Listeners examples
**Async and mutation**
- Listen to an action that looks like `{ type: 'FETCH_TODOS' }`
- Fetch todos
- Set todos in store
```js
const store = createStore({ todos: [] })
store.subscribe((store) => { console.log('new state!', store.getState()) })

// the listener to focus on
store.addListener('FETCH_TODOS', async (store) => {
  const todos = await (await fetch('https://my-api/todos')).json()
  store.mutate(state => {
    state.todos = todos
  })
})

// dispatch the listened action
store.dispatch('FETCH_TODOS')
```

**retrieve action informations**
- Listen to `ADD_TODO` action (that can be dispatched by a click from the UI)
- Add a new todo with information given in the action's payload
```js
const store = createStore({ todos: [] })
store.subscribe((store) => { console.log('new state!', store.getState()) })

// the listener to focus on
store.addListener('ADD_TODO', (store, action) => {
  store.mutate(state => {
    state.todos.push(action.payload)
  })
})

// dispatch the listened action
store.dispatch({ type: 'ADD_TODO', payload: { id: 2, label: 'new' } })
```

**dispatch in a listener**
- Listen to `@@ui/CLEAR_TODOS` (that can be dispatched by a click from the UI)
- React by calling `CLEAR_TODOS` if todos are not already empty
```js
const store = createStore({ todos: [{ id: 1, label: 'finish the documentation' }] })
store.addListener((store, oldState, action) => { console.log('new action is dispatched!', action) })
store.addListener('CLEAR_TODOS', store => { store.mutate(state => { state.todos = [] }) })

// the listener to focus on
store.addListener({ type: '@@ui/CLEAR_TODOS' }, store => {
  if (store.getState().todos && store.getState().todos.length > 0) {
    store.dispatch('CLEAR_TODOS')
  }
})

// dispatch the listened action
store.dispatch('@@ui/CLEAR_TODOS')
```

# Bindings
## React <img width=30 src="https://upload.wikimedia.org/wikipedia/commons/thumb/a/a7/React-icon.svg/640px-React-icon.svg.png" />
Please look at [this documentation](https://github.com/fabienjuif/myrtille/tree/master/packages/react)