@briebug/ngrx-auto-entity

Automatic Entity State and Facades for NgRx. Simplifying reactive state!

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
5913Aug 4, 2021Jun 11, 2018Minified + gzip package size for @briebug/ngrx-auto-entity in KB

Readme

CircleCI Issues Version Downloads Downloads

NgRX Auto-Entity

Automatic entities for @ngrx! Simplifying reactive state!

Announcing: ANGULAR 12 is now supported! NgRx Auto-Entity has been updated to support the latest versions of Angular, as well as NgRx through version 12. With this update, we have also dropped support for Angular 8, meaning the supported versions of angular are 9-12.

NOTE: Angular 13 support is being researched. Starting with Ng 13, all View Engine support will be dropped from the platform completely. One of our goals with Auto-Entity has been to support older versions of angular as long as possible, given the often slower upgrade times for many companies. With Ng 13 putting the burden on library developers to support Ivy, that forces groups like ourselves to build our library to target specific instruction sets. That will increase the challenge of supporting older versions of Angular. As such, we are actively looking for ways to deal with that scenario, and hope to be prepared when the time comes.

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!

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 actions, selectors, effects & a core metareducer for handling all of the standard CRUD functionality for entities, so you neither have to write nor generate any of that code yourself. Auto-Entity supports implementing applications with recommended best practices, including good action hygiene. Auto-Entity also generates pre-fabricated facades around NgRx and the store/state, providing a cohesive, logical and simplified API into your state for those who prefer facades. 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 9+, NgRx 9+ and RxJs 6.

Deps-AngularCore Deps-AngularCommon Deps-NgRxStore Deps-RxJs

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
  • Dynamically generated per-entity actions
  • Dynamically generated per-entity selectors
  • 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
  • Dynamic generate-only-on-use design
  • 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

Follow-BB Follow-BB Follow-BB Follow-BB

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.