npm package: @ngix/store
Description: [IxJS](https://github.com/ReactiveX/IxJS) augmented state management for Angular applications, inspired by Redux and built upon [@ngrx](https://github.com/ngrx/platform).
Author: Patrick Martin
Latest version: 1.1.0

# @ngix/store

[IxJS](https://github.com/ReactiveX/IxJS) augmented state management for Angular applications, inspired by Redux and built upon [@ngrx](https://github.com/ngrx/platform).

`@ngix/store` is an attempt to implement an even more functional approach to `@ngrx`. This library is not a replacement for `@ngrx`, but rather a companion library.

Core tenents:

- Play happily and seemlessly with `@ngrx`.
- Less Action and Reducer boilerplate.
- One agnostic reducer. Anonymous actions.
- Keep all store logic in one place. One file.
- Lively data with optimistic updates.
- Stay small and simple.
- Functions, functions, functions.


### Installation

Install @ngix/store (and dependencies) from npm:

`npm i -S @ngix/store @ngix/lens @reactivex/ix-ts`

To import [`@reactivex/ix-ts`](https://www.npmjs.com/package/@reactivex/ix-ts) like it's the `ix` module, add the following to the `tsconfig.json` file:

```json
{
  "compilerOptions": {
    /* ... */
    "paths": {
      "ix/*": ["../node_modules/@reactivex/ix-ts/*"]
    }
  }
}
```

Note: It's probably safer to just stick with `@reactivex/ix-ts` despite it's long name.


### Documentation

See the Wiki for detailed documentation.


### Example Usage

This is the simple example from `@ngrx/store` reworked to use `@ngix/store`.

First, setup of the reducer is omitted since `@ngix/store` has one agnostic recuder.

Second, very much like the original example, register the state container within your application, use the `IxStoreModule.forRoot()`.

```ts
import { BrowserModule } from "@angular/platform-browser";
import { NgModule } from "@angular/core";

import { IxStoreModule } from "@ngix/store";

import { AppComponent } from "./app.component";

@NgModule({
  declarations: [ AppComponent ],
  imports: [
    BrowserModule,
    IxStoreModule.forRoot({ counter: 0 }),
  ],
  bootstrap: [ AppComponent ]
})
export class AppModule {}
```

Finally, inject the `IxStore` service into your components and services. Use `store.view(Lens)` to _focus_ on slice(s) of state. Here you see another fundemental difference between `@ngrx/store` and `@ngix/store`: instead of your logic being off in a reducer where you send potentially stale state, you compose functions and dispatch them to be lazily evaluated in the IxReducer with the latest state.

```ts
import { Component, ChangeDetectionStrategy } from "@angular/core";
import { Observable } from "rxjs/Observable";

import { IterableX } from "ix/iterable";
import { map } from "ix/iterable/map";

import { IxStore, ixAction, IxAction, ix } from "@ngix/store";
import { lens } from "@ngix/lens";

export interface AppState {
  counter: number;
}

const lmap = ix.lift<number>(map);
const INCREMENT = lmap(i => i + 1);
const DECREMENT = lmap(i => i - 1);
const RESET = ix.constant(0);
const cl = lens.lens("counter");
const ca = ixAction(counterLens);

@Component({
  selector: "app-root",
  template: `
    <button (click)="increment()">Increment</button>
    <div>Current Count: {{ counter | async }}</div>
    <button (click)="decrement()">Decrement</button>
    <button (click)="reset()">Reset Counter</button>
  `,
  changeDetection: ChangeDetectionStrategy.OnPush,
})
export class AppComponent {

  public counter: Observable<number>;

  public constructor(private store: IxStore<AppState>) {
    this.counter = this.store.view(cl);
  }

  public increment () {
    this.store.dispatchIx(ca("INCREMENT", INCREMENT));
  }

  public decrement () {
    this.store.dispatchIx(ca("DECREMENT", DECREMENT));
  }

  public reset () {
    this.store.dispatchIx(ca("RESET", RESET));
  }
}
```


### Todo List Demo Application

Here is the [Github repo](https://github.com/patrimart/ngix-demo-todo) with the Todo List demo.

It is an Angular CLI app. After `npm install`, start it with `ng serve`. This assumes that you have
`@angular/cli` installed globally.


### Library Todos

- Add unit tests with 90+% coverage.
- Test `IxStoreModule.forFeature()` with lazy loading.
- Describe more `@ngix` idiomatic patterns.


---

## License ##

The MIT License (MIT)

Copyright (c) Patrick Martin

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.