{"id":14986101,"url":"https://github.com/briebug/ngrx-auto-entity","last_synced_at":"2025-04-10T00:18:44.317Z","repository":{"id":33153946,"uuid":"136968540","full_name":"briebug/ngrx-auto-entity","owner":"briebug","description":"NgRx Auto-Entity: Simplifying Reactive State","archived":false,"fork":false,"pushed_at":"2024-09-15T18:08:42.000Z","size":4713,"stargazers_count":67,"open_issues_count":11,"forks_count":12,"subscribers_count":13,"default_branch":"develop","last_synced_at":"2025-04-10T00:18:26.812Z","etag":null,"topics":["angular","automation","entity","facade","ngrx","ngrx-auto-entity","ngrxae","reducer","reducers"],"latest_commit_sha":null,"homepage":"https://briebug.gitbook.io/ngrx-auto-entity/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/briebug.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-11T18:58:40.000Z","updated_at":"2024-11-29T08:53:34.000Z","dependencies_parsed_at":"2024-06-19T20:02:24.648Z","dependency_job_id":"1680fd53-f66b-4c7d-b8a2-3a830c3daa89","html_url":"https://github.com/briebug/ngrx-auto-entity","commit_stats":{"total_commits":236,"total_committers":15,"mean_commits":"15.733333333333333","dds":"0.40254237288135597","last_synced_commit":"e615fca01fba6fe08d389f864b1abfa93095f707"},"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/briebug%2Fngrx-auto-entity","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/briebug%2Fngrx-auto-entity/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/briebug%2Fngrx-auto-entity/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/briebug%2Fngrx-auto-entity/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/briebug","download_url":"https://codeload.github.com/briebug/ngrx-auto-entity/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248131318,"owners_count":21052820,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","automation","entity","facade","ngrx","ngrx-auto-entity","ngrxae","reducer","reducers"],"created_at":"2024-09-24T14:12:19.673Z","updated_at":"2025-04-10T00:18:44.292Z","avatar_url":"https://github.com/briebug.png","language":"TypeScript","readme":"[![CircleCI](https://img.shields.io/circleci/build/github/briebug/ngrx-auto-entity/develop.svg)](https://circleci.com/gh/briebug/ngrx-auto-entity)\n[![Issues](https://img.shields.io/github/issues/briebug/ngrx-auto-entity.svg)](https://github.com/briebug/ngrx-auto-entity/issues)\n![Version](https://img.shields.io/npm/v/@briebug/ngrx-auto-entity.svg)\n![Downloads](https://img.shields.io/npm/dm/@briebug/ngrx-auto-entity.svg)\n[![Downloads](https://img.shields.io/npm/dt/@briebug/ngrx-auto-entity.svg)](https://www.npmjs.com/package/@briebug/ngrx-auto-entity)\n\n\n\n# NgRX Auto-Entity\n\nAutomatic entities for [@ngrx](https://github.com/ngrx/platform)! Simplifying reactive state!\n\n**Announcing: ANGULAR 12 is now supported! NgRx Auto-Entity has been updated to support the latest\nversions of Angular, as well as NgRx through version 12. With this update, we have also dropped\nsupport for Angular 8, meaning the supported versions of angular are 9-12.**\n\n**NOTE: Angular 13 support is being researched. Starting with Ng 13, all View Engine support will\nbe dropped from the platform completely. One of our goals with Auto-Entity has been to support\nolder versions of angular as long as possible, given the often slower upgrade times for many \ncompanies. With Ng 13 putting the burden on library developers to support Ivy, that forces\ngroups like ourselves to build our library to target specific instruction sets. That will\nincrease the challenge of supporting older versions of Angular. As such, we are actively looking\nfor ways to deal with that scenario, and hope to be prepared when the time comes.**\n\n**NOTE: NgRX Auto-Entity is currently a _beta_ library. It is in flux as we continue to refine and\nenhance it's functionality, identify and eliminate bugs, optimize it's performance. If you\nfind any errors in this documentation, or bugs within the library, please let us know!**\n\n## What is it?\n\nNgRX Auto-Entity aims to provide a seamless means of dealing with standard entity actions and\neffects with minimal repetitive code requirements, while preserving the fundamental nature of\nNgRX itself. This library is not a replacement for or alternative to NgRX. It works within the\nstandard paradigm that NgRX has set forth, making use of actions, reducers \u0026 effects like any\nother NgRX application.\n\nWhat Auto-Entity does do is provide a set of ready-made actions, selectors, effects \u0026 a core\nmetareducer for handling all of the standard CRUD functionality for entities, so you neither\nhave to write nor generate any of that code yourself. Auto-Entity supports implementing applications\nwith recommended best practices, including good action hygiene. Auto-Entity also generates \n**pre-fabricated facades** around NgRx and the store/state, providing a cohesive, logical and\nsimplified API into your state for those who prefer facades. Auto-Entity presents a flexible\nframework that you may use in its entirety for all of your entity needs, or use piecemeal as \nnecessary in order to achieve your specific goals.\n\nWhile it is not required and Auto-Entity is an entirely independent library that solely depends\non Angular and NgRX, Auto-Entity manages state in a manner that is compatible with @ngrx/entity\nas well, in the event you wish to utilize some of the utilities from that library in your own\ncustom reducers.\n\n# Dependencies\n\nNgRx Auto-Entity currently depends on Angular 9+, NgRx 9+ and RxJs 6. \n\n\n[![Deps-AngularCore](https://img.shields.io/badge/@angular/core-%5E9.x-blue.svg)](https://github.com/angular/angular)\n[![Deps-AngularCommon](https://img.shields.io/badge/@angular/common-%5E9.x-blue.svg)](https://github.com/angular/angular)\n[![Deps-NgRxStore](https://img.shields.io/badge/@ngrx/store-%5E9.x-blue.svg)](https://github.com/ngrx/platform)\n[![Deps-RxJs](https://img.shields.io/badge/rxjs-%5E6.x-blue.svg)](https://github.com/reactivex/rxjs)\n\n# Installation\n\nInstall @briebug/ngrx-auto-entity from npm:\n\n`npm install @briebug/ngrx-auto-entity` or `yarn add @briebug/ngrx-auto-entity`\n\nIf you have not already, install the required peer dependencies as well:\n\n`npm install @ngrx/{effects,store,store-devtools}` or `yarn add @ngrx/{effects,store,store-devtools}`\n\n## Quick Start\n\nIf you want to get rolling as quickly and simply as possible, you may jump to the\n[quick start guide](https://briebug.gitbook.io/ngrx-auto-entity/getting-started/quick-start).\n(Note: Documentation still in progress!)\n\n## Full Usage Documentation\n\nIf you wish to learn more about how Auto-Entity works, you may jump to the\n[full usage documentation](https://briebug.gitbook.io/ngrx-auto-entity/advanced/usage).\n(Note: Documentation still in progress!)\n\n# Roadmap\n\n- [x] Initial design of automatic actions\n- [x] Automatic service mapping \u0026 lookup\n- [x] Custom criteria\n- [x] Default effects\n- [x] Composite keys\n- [x] Get entity key support on entities\n- [x] Built-in loading indicator tracking\n- [x] Built-in saving indicator tracking\n- [x] Built-in deleting indicator tracking\n- [x] Built-in entity selection support\n- [x] Dynamically generated per-entity actions\n- [x] Dynamically generated per-entity selectors\n- [x] Pre-fabricated facade generation\n- [x] Generated stub reducers\n- [x] Automatic correlation of related initiating and result actions\n- [x] Enhanced IEntityInfo interface with naming utilities\n- [x] Filtering of entities effects handle\n- [x] Custom transformation of data to and from the server (i.e. ISO date to Date())\n- [x] Optional data loading it not already present, with max age\n- [x] Normalization of API with NgRx 8 functional/factory function architecture\n- [ ] Dynamic generate-only-on-use design\n- [ ] Extended effects for loading indicator display, toasts or snackbars, etc.\n- [ ] Filtering of entities meta reducer handles\n- [ ] Pre-fabricated, ready-to-go, reusable entity services\n\n# Contributors\n\n[![Follow-BB](https://img.shields.io/twitter/follow/briebugsoftware.svg?style=flat)](https://twitter.com/briebugsoftware)\n[![Follow-BB](https://img.shields.io/twitter/follow/jonristadev.svg?style=flat)](https://twitter.com/JonRistaDev)\n[![Follow-BB](https://img.shields.io/twitter/follow/kevinschuchard.svg?style=flat)](https://twitter.com/kevinschuchard)\n[![Follow-BB](https://img.shields.io/twitter/follow/anthonyjones519.svg?style=flat)](https://twitter.com/anthonyjones519)\n\n- [Jesse Sanders](https://github.com/jessesanders): Evil Mastermind!\n- [Jon Rista](https://github.com/jrista): Design, Architecture \u0026 Implementation\n- [Kevin Schuchard](https://github.com/schuchard): Design \u0026 Implementation\n- [Brian Love](https://github.com/blove): Design \u0026 Implementation\n- [Jesse Wells](https://github.com/Wells-Codes): Implementation\n- [Alice Paquette](https://github.com/paquettealice): Implementation \n- [Patrice Paquette](https://github.com/patpaquette): Implementation\n- [Anthony Jones](https://github.com/anthonymjones): Implementation\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbriebug%2Fngrx-auto-entity","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbriebug%2Fngrx-auto-entity","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbriebug%2Fngrx-auto-entity/lists"}