@kryptand/ngrx-auto-entity v0.6.0-alpha.1
NgRX Auto-Entity
Automatic entities for @ngrx! Simplifying reactive state!
NOTE: NgRX Auto-Entity is currently a beta library. It is in flux as we continue to refine and enhance it's functionality, identify and eliminate bugs, optimize it's performance. If you find any errors in this documentation, or bugs within the library, please let us know!
APOLOGIES: For those using NgRx Auto-Entity, we apologize for issues with the recent v0.3.0 release! We used an npm module, uuidv4, and back in november our usage of it was working. It appears as though that library was changed fairly significantly since then, with the default import removed. That lead to issues for some people, depending on the version of uuidv4 they installed/had installed. We have dropped uuidv4 and are now using a small, fast built-in function instead in v0.3.1 and onward, which should resolve the issues. Again, we apologize for the inconvenience!
What is it?
NgRX Auto-Entity aims to provide a seamless means of dealing with standard entity actions and effects with minimal repetitive code requirements, while preserving the fundamental nature of NgRX itself. This library is not a replacement for or alternative to NgRX. It works within the standard paradigm that NgRX has set forth, making use of actions, reducers & effects like any other NgRX application.
What Auto-Entity does do is provide a set of ready-made, generic actions for handling all of the standard CRUD operations for entities, so you neither have to write nor generate any of that code yourself. Auto-Entity generates pre-fabricated facades around NgRx and the store/state, providing a cohesive, logical and simplified API into your state. Auto-Entity presents a flexible framework that you may use in its entirety for all of your entity needs, or use piecemeal as necessary in order to achieve your specific goals.
While it is not required and Auto-Entity is an entirely independent library that solely depends on Angular and NgRX, Auto-Entity manages state in a manner that is compatible with @ngrx/entity as well, in the event you wish to utilize some of the utilities from that library in your own custom reducers.
Dependencies
NgRx Auto-Entity currently depends on Angular 8+, NgRx 8+ and RxJs 6.
Installation
Install @briebug/ngrx-auto-entity from npm:
npm install @briebug/ngrx-auto-entity or yarn add @briebug/ngrx-auto-entity
If you have not already, install the required peer dependencies as well:
npm install @ngrx/{effects,store,store-devtools} or yarn add @ngrx/{effects,store,store-devtools}
Quick Start
If you want to get rolling as quickly and simply as possible, you may jump to the quick start guide. (Note: Documentation still in progress!)
Full Usage Documentation
If you wish to learn more about how Auto-Entity works, you may jump to the full usage documentation. (Note: Documentation still in progress!)
Roadmap
- Initial design of automatic actions
- Automatic service mapping & lookup
- Custom criteria
- Default effects
- Composite keys
- Get entity key support on entities
- Built-in loading indicator tracking
- Built-in saving indicator tracking
- Built-in deleting indicator tracking
- Built-in entity selection support
- Pre-fabricated facade generation
- Generated stub reducers
- Automatic correlation of related initiating and result actions
- Enhanced IEntityInfo interface with naming utilities
- Filtering of entities effects handle
- Custom transformation of data to and from the server (i.e. ISO date to Date())
- Optional data loading it not already present, with max age
- Normalization of API with NgRx 8 functional/factory function architecture
- Extended effects for loading indicator display, toasts or snackbars, etc.
- Filtering of entities meta reducer handles
- Pre-fabricated, ready-to-go, reusable entity services
Contributors
- Jesse Sanders: Evil Mastermind!
- Jon Rista: Design, Architecture & Implementation
- Kevin Schuchard: Design & Implementation
- Brian Love: Design & Implementation
- Alice Paquette: Implementation
- Patrice Paquette: Implementation
- Anthony Jones: Implementation