@ngrx-traits/common 12.1.0 → 12.2.0

package/async-action/async-action.trait.d.ts

@@ -3,7 +3,8 @@ import { ActionCreatorWithOptionalProps } from './async-action.model';
 /**
  * Generates the typical ngrx code need to make a async action with
  * a request, success and failure actions, plus a status property to track its progress
- * and selectors to query the status.
+ * and selectors to query the status. This trait can be added more thant once as long
+ * as the name prop is different.
  *
  * @param options - Config object for the trait factory
  * @param options.name - Name of the main request action, should be in camel case
@@ -30,10 +31,14 @@ import { ActionCreatorWithOptionalProps } from './async-action.model';
  *        'client',
  *      ),
  *    });
- * // will generate the actions and selectors
+ * //   adds following props to the state:
+ * //    createClientStatus?: 'loading' | 'success' | 'fail';
+ *
+ * // generated actions
  * traits.actions.createClient({name:'Pedro'})
  * traits.actions.createClientSuccess({id:'123'})
  * traits.actions.createClientFail();
+ * //generated selectors
  * traits.selectors.isLoadingCreateClient
  * traits.selectors.isSuccessCreateClient
  * traits.selectors.isFailCreateClient

package/bundles/ngrx-traits-common.umd.js

@@ -1,8 +1,8 @@
 (function (global, factory) {
     typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@ngrx/store'), require('@ngrx-traits/core'), require('@ngrx/entity'), require('@angular/core'), require('rxjs'), require('rxjs/operators'), require('@ngrx/effects')) :
     typeof define === 'function' && define.amd ? define('@ngrx-traits/common', ['exports', '@ngrx/store', '@ngrx-traits/core', '@ngrx/entity', '@angular/core', 'rxjs', 'rxjs/operators', '@ngrx/effects'], factory) :
-    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory((global['ngrx-traits'] = global['ngrx-traits'] || {}, global['ngrx-traits'].common = {}), global.i2, global.core, global.entity, global.ng.core, global.rxjs, global.rxjs.operators, global.i1));
-}(this, (function (exports, i2, core, entity, i0, rxjs, operators, i1) { 'use strict';
+    (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory((global["ngrx-traits"] = global["ngrx-traits"] || {}, global["ngrx-traits"].common = {}), global.i2, global.core, global.entity, global.ng.core, global.rxjs, global.rxjs.operators, global.i1));
+})(this, (function (exports, i2, core, entity, i0, rxjs, operators, i1) { 'use strict';
 
     function _interopNamespace(e) {
         if (e && e.__esModule) return e;
@@ -13,14 +13,12 @@
                     var d = Object.getOwnPropertyDescriptor(e, k);
                     Object.defineProperty(n, k, d.get ? d : {
                         enumerable: true,
-                        get: function () {
-                            return e[k];
-                        }
+                        get: function () { return e[k]; }
                     });
                 }
             });
         }
-        n['default'] = e;
+        n["default"] = e;
         return Object.freeze(n);
     }
 
@@ -30,7 +28,7 @@
 
     var loadEntitiesTraitKey = 'loadEntities';
 
-    /*! *****************************************************************************
+    /******************************************************************************
     Copyright (c) Microsoft Corporation.
 
     Permission to use, copy, modify, and/or distribute this software for any
@@ -192,7 +190,11 @@
     var __createBinding = Object.create ? (function (o, m, k, k2) {
         if (k2 === undefined)
             k2 = k;
-        Object.defineProperty(o, k2, { enumerable: true, get: function () { return m[k]; } });
+        var desc = Object.getOwnPropertyDescriptor(m, k);
+        if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+            desc = { enumerable: true, get: function () { return m[k]; } };
+        }
+        Object.defineProperty(o, k2, desc);
     }) : (function (o, m, k, k2) {
         if (k2 === undefined)
             k2 = k;
@@ -265,7 +267,7 @@
                     ar[i] = from[i];
                 }
             }
-        return to.concat(ar || from);
+        return to.concat(ar || Array.prototype.slice.call(from));
     }
     function __await(v) {
         return this instanceof __await ? (this.v = v, this) : new __await(v);
@@ -347,6 +349,11 @@
             throw new TypeError("Cannot write private member to an object whose class did not declare it");
         return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
     }
+    function __classPrivateFieldIn(state, receiver) {
+        if (receiver === null || (typeof receiver !== "object" && typeof receiver !== "function"))
+            throw new TypeError("Cannot use 'in' operator on non-object");
+        return typeof state === "function" ? receiver === state : state.has(receiver);
+    }
 
     function createLoadEntitiesInitialState(previousInitialState, allConfigs) {
         if (previousInitialState === void 0) { previousInitialState = {}; }
@@ -429,12 +436,10 @@
     }
 
     /**
-     * Generates the ngrx code needed to load a list of entities from the backend
-     * with a load[EntitiesName], load[EntitiesName]Success, load[EntitiesName]Fail actions, and selectors to query the
-     * entities like selectEntity[EntitiesName]List, selectEntity[EntitiesName]Ids, selectEntity[EntitiesName]Map, and its progress loading
-     * with isLoading[EntitiesName],isLoading[EntitiesName]Success, isLoading[EntitiesName]Fail. This trait is the base for all other traits related
-     * to a list of entities, the other will call loadEntities when needing data.
-     * @param traitConfig - Config object fot the trait factory
+     * Generates the ngrx code needed to load a list of entities from the backend. This trait is the base for all other traits related
+     * to a list of entities, the other will call loadEntities when needing data. See the example for the list of actions and selectors this generates
+     *
+     * @param traitConfig - Config object for the trait factory
      * @param traitConfig.selectId - Function that returns the id of an entity
      * @param traitConfig.sortComparer - Default sort function for to @ngrx/entity EntityAdapter
      *
@@ -453,17 +458,24 @@
      *        'todos',
      *      ),
      *    });
-     * // will generate the actions and selectors
+     *
+     * //   adds following props to the state:
+     * //    ids: string[] | number[];
+     * //    entities: Dictionary<Todo>;
+     * //    status?: 'loading' | 'success' | 'fail';
+     *
+     * // generated actions
      * traits.actions.loadTodos()
      * traits.actions.loadTodosSuccess({entities: todos})
      * traits.actions.loadTodosFail();
+     * // generated selectors
      * traits.selectors.selectTodosList
      * traits.selectors.selectTodosMap
      * traits.selectors.selectTodosIds
      * traits.selectors.selectTodosTotal
-     * traits.selectors.isLoadingTodos
-     * traits.selectors.isSuccessTodosSuccess
-     * traits.selectors.isFailTodosFail
+     * traits.selectors.isTodosLoading
+     * traits.selectors.isTodosLoadingSuccess
+     * traits.selectors.isTodosLoadingFail
      */
     function addLoadEntitiesTrait(traitConfig) {
         var adapter = entity.createEntityAdapter(traitConfig);
@@ -546,9 +558,9 @@
             }
             return FilterEffect;
         }(core.TraitEffect));
-        FilterEffect.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: FilterEffect, deps: null, target: i0__namespace.ɵɵFactoryTarget.Injectable });
-        FilterEffect.ɵprov = i0__namespace.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: FilterEffect });
-        i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: FilterEffect, decorators: [{
+        FilterEffect.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: FilterEffect, deps: null, target: i0__namespace.ɵɵFactoryTarget.Injectable });
+        FilterEffect.ɵprov = i0__namespace.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: FilterEffect });
+        i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: FilterEffect, decorators: [{
                     type: i0.Injectable
                 }] });
         return [FilterEffect];
@@ -609,7 +621,7 @@
      * // The following trait config
      *
      * export interface TestState
-     * extends EntityAndStatusState<Todo>,FilterState<TodoFilter>{}
+     * extends LoadEntitiesState<Todo>, FilterEntitiesState<TodoFilter>{}
      *
      *    const traits = createEntityFeatureFactory(
      *      addLoadEntitiesTrait<Todo>(),
@@ -625,8 +637,13 @@
      *        'todos',
      *      ),
      *    });
-     * // will generate  the following actions and selectors, plus the ones generated by other traits
+     *
+     * //   adds following props to the state:
+     * //    filters?: TodoFilter;
+     *
+     * // generated actions
      * traits.actions.filterTodos()
+     * // generated selectors
      * traits.selectors.selectTodosFilter()
      */
     function addFilterEntitiesTrait(_a) {
@@ -794,7 +811,7 @@
         }); }))), __read(core.insertIf(allActions.removeEntities, function () { return i2.on(allActions.removeEntities, function (state, _b) {
             var keys = _b.keys;
             return addToCacheTotal(state, -keys.length);
-        }); }))), __read(core.insertIf(filterRemote && allActions.filterEntities, function () { return i2.on(allActions.filterEntities, function (state) { return recalculateTotal(state); }); }))), __read(core.insertIf(allActions.removeAllEntities, function () { return i2.on(allActions.removeAllEntities, function (state) { return clearPagesCache(state); }); }))));
+        }); }))), __read(core.insertIf(allActions.storeEntitiesFilter, function () { return i2.on(allActions.storeEntitiesFilter, function (state) { return recalculateTotal(state); }); }))), __read(core.insertIf(allActions.removeAllEntities, function () { return i2.on(allActions.removeAllEntities, function (state) { return clearPagesCache(state); }); }))));
     }
 
     function createPaginationTraitEffects(allActions, allSelectors) {
@@ -844,9 +861,9 @@
             }
             return PaginationEffect;
         }(core.TraitEffect));
-        PaginationEffect.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: PaginationEffect, deps: null, target: i0__namespace.ɵɵFactoryTarget.Injectable });
-        PaginationEffect.ɵprov = i0__namespace.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: PaginationEffect });
-        i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: PaginationEffect, decorators: [{
+        PaginationEffect.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: PaginationEffect, deps: null, target: i0__namespace.ɵɵFactoryTarget.Injectable });
+        PaginationEffect.ɵprov = i0__namespace.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: PaginationEffect });
+        i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: PaginationEffect, decorators: [{
                     type: i0.Injectable
                 }] });
         return [PaginationEffect];
@@ -884,11 +901,11 @@
      * - 'grow': Similar to partial that the backend returns partial result, but in this case the cache grows,
      * after each loadEntities the cache is appended to the previous cache, this mode is ideal for infinite scrolls,
      * where you will only call loadNextPage.
-     * To make the pagination experience smoother the loadEntities to get new pages is done when the current page is change to
-     * the last cached page.
+     * To make the pagination experience smoother the loadEntities action is fired when the current page is equal
+     * to the last cached page, so while the user is reading the page more pages are being loading in the background.
      * @param config
      * @param config.cacheType - Default to 'partial', change the cache mode
-     * @param config.pageSize - Default to 20, number of entities on  each page
+     * @param config.pageSize - Default to 10, number of entities on  each page
      * @param config.currentPage - Default to 0, starting page
      * @param config.pagesToCache - Default to 3, used in partial and grow cache mode, is the number of
      * extra pages kept in cache to avoid calling the backend on each page
@@ -908,7 +925,22 @@
      *        'todos',
      *      ),
      *    });
-     * // will generate  the following actions and selectors, plus the ones generated by other traits
+     *
+     * //   adds following props to the state:
+     * //    pagination: {
+     * //       currentPage: number;
+     * //       requestPage: number;
+     * //       pageSize: number;
+     * //       total?: number;
+     * //       pagesToCache: number;
+     * //       cache: {
+     * //         type: 'full' | 'partial' | 'grow';
+     * //         start: number;
+     * //         end: number;
+     * //       }
+     * //     }
+     *
+     * // generated actions
      * traits.actions.loadTodosPage({index})
      * traits.actions.loadTodosPageSuccess()
      * traits.actions.loadTodosPageFail()
@@ -917,19 +949,18 @@
      * traits.actions.loadTodosFirstPage()
      * traits.actions.loadTodosLastPage()
      * traits.actions.clearTodosPagesCache()
-     *
-     * // page param is optional and defaults to current page
-     * traits.selectors.isTodosPageInCache({page})
-     * traits.selectors.selectPageTodosList({page})
-     * traits.selectors.isLoadingTodosPage({page})
-     * // prefer isLoadingTodosPage over isLoadingTodos which will return true even
-     * // if the page loading is not the current one
-     * traits.selectors.selectTodosPage({page})
+     * // generated selectors
+     * traits.selectors.isTodosPageInCache()
+     * traits.selectors.selectPageTodosList()
+     * traits.selectors.isLoadingTodosPage()
+     * // use isLoadingTodosPage over isLoadingTodos (which will return true even
+     * // if the page loading is not the current one)
+     * traits.selectors.selectTodosPage()
      * traits.selectors.selectTodosPagedRequest()// use in effects to get paging parameter
      * traits.selectors.selectTodosPageInfo()
      */
     function addEntitiesPaginationTrait(_a) {
-        var _b = _a === void 0 ? {} : _a, _c = _b.cacheType, cacheType = _c === void 0 ? 'partial' : _c, _d = _b.pageSize, pageSize = _d === void 0 ? 20 : _d, _e = _b.currentPage, currentPage = _e === void 0 ? 0 : _e, _f = _b.pagesToCache, pagesToCache = _f === void 0 ? 3 : _f;
+        var _b = _a === void 0 ? {} : _a, _c = _b.cacheType, cacheType = _c === void 0 ? 'partial' : _c, _d = _b.pageSize, pageSize = _d === void 0 ? 10 : _d, _e = _b.currentPage, currentPage = _e === void 0 ? 0 : _e, _f = _b.pagesToCache, pagesToCache = _f === void 0 ? 3 : _f;
         return core.createTraitFactory({
             key: entitiesPaginationTraitKey,
             depends: [loadEntitiesTraitKey],
@@ -1116,13 +1147,17 @@
      *        'todos',
      *      ),
      *    });
-     * // will generate  the following actions and selectors, plus the ones generated by other traits
+     *
+     * //   adds following props to the state:
+     * //    selectedIds: Dictionary<boolean>;
+     *
+     * // generated actions
      * traits.actions.selectTodos({id})
      * traits.actions.deselectTodos({id})
      * traits.actions.toggleSectTodos({id})
      * traits.actions.toggleSelectAllTodos()
      * traits.actions.clearTodosSelection()
-     *
+     * //generated selectors
      * traits.selectors.isAllTodosSelected()
      * traits.selectors.selectTodosIdsSelectedMap()
      * traits.selectors.selectTodosIdsSelectedList()
@@ -1247,11 +1282,15 @@
      *        'todos',
      *      ),
      *    });
-     * // will generate  the following actions and selectors, plus the ones generated by other traits
+     *
+     * //   adds following props to the state:
+     * //     selectedId?: number | string;
+     *
+     * // generated actions
      * traits.actions.selectTodo({id})
      * traits.actions.deselectTodo()
      * traits.actions.toggleSelectTodo({id})
-     *
+     * //generated selectors
      * traits.selectors.selectTodoIdSelected()
      * traits.selectors.selectTodoSelected()
      */
@@ -1534,13 +1573,17 @@
      *        'todos',
      *      ),
      *    });
-     * // will generate  the following actions and selectors, plus the ones generated by other traits
+     *
+     * //   adds following props to the state:
+     * //    changes: Change<Todo>[];
+     *
+     * // generated actions
      * traits.actions.addTodos(entity1,entity2...)
      * traits.actions.updateTodos({id: id1, changes:{prop1}},{id: id2, changes:{prop2}} ...)
      * traits.actions.upsertTodos(entity1,entity2...)
      * traits.actions.removeAllTodos()
      * traits.actions.clearTodosChanges()
-     *
+     * // generated selectors
      * traits.selectors.selectTodosChangesList()
      * traits.selectors.selectFilteredTodosChangesList()
      * traits.selectors.selectAllFilteredChanges()
@@ -1594,6 +1637,8 @@
         return value;
     }
     /**
+     * @internal
+     * @ignore
      * Gets a sorted copy of the data array based on the state of the Sort.
      * @param data The array of data that should be sorted.
      * @param sort The connected MatSort that holds the current sort state.
@@ -1703,9 +1748,9 @@
             }
             return SortEffect;
         }(core.TraitEffect));
-        SortEffect.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: SortEffect, deps: null, target: i0__namespace.ɵɵFactoryTarget.Injectable });
-        SortEffect.ɵprov = i0__namespace.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: SortEffect });
-        i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: SortEffect, decorators: [{
+        SortEffect.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: SortEffect, deps: null, target: i0__namespace.ɵɵFactoryTarget.Injectable });
+        SortEffect.ɵprov = i0__namespace.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: SortEffect });
+        i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: SortEffect, decorators: [{
                     type: i0.Injectable
                 }] });
         return remote ? [SortEffect] : [];
@@ -1721,8 +1766,8 @@
     /**
      * Generates ngrx code to sort locally or remotely a list of entities
      * @param config
-     * @param config.defaultSort - Required, Default entity prop for the sort
-     * @param config.remote - Optional field, default to false, when true disables local
+     * @param config.defaultSort - Required field, Default entity prop for the sort
+     * @param config.remote - Required field, default to false, when true disables local
      * sorting and every sort action call will now trigger a loadEntities action and the backend
      * should sort the data, use selectSort in the effect that call backend to get the requested sort,
      * when false all sorting is done in memory when the sort action is fired
@@ -1743,14 +1788,20 @@
      *        'todos',
      *      ),
      *    });
-     * // will generate  the following actions and selectors, plus the ones generated by other traits
+     * //   adds following props to the state:
+     * //      sort: {
+     * //        current: Sort<Todo>;
+     * //        default: Sort<Todo>;
+     * //      }
+     *
+     * // generated actions
      * traits.actions.sortTodos({active:'id', direction:'desc'})
      * traits.actions.resetTodosSort()
-     *
+     * //generated selectors
      * traits.selectors.selectTodosSort()
      */
     function addSortEntitiesTrait(_a) {
-        var _b = _a.remote, remote = _b === void 0 ? false : _b, defaultSort = _a.defaultSort;
+        var remote = _a.remote, defaultSort = _a.defaultSort;
         return core.createTraitFactory({
             key: sortTraitKey,
             depends: [loadEntitiesTraitKey],
@@ -1800,7 +1851,7 @@
      *        'todos',
      *      ),
      *    });
-     * // will generate  the following actions, plus the ones generated by other traits
+     * // generated actions
      * traits.actions.resetTodosState()
      */
     function addResetEntitiesStateTrait(traitConfig) {
@@ -1820,38 +1871,42 @@
             },
             effects: function (_b) {
                 var allActions = _b.allActions;
-                var _a;
-                var ResetEffect = /** @class */ (function (_super) {
-                    __extends(ResetEffect, _super);
-                    //TODO: not sure why Im forced to override this constructor
-                    // or test wont pass, strangely doesnt happen in other files
-                    // with similar case like pagination.effects.ts
-                    function ResetEffect(actions$, store) {
-                        var _this = this;
-                        var _a;
-                        _this = _super.call(this, actions$, store) || this;
-                        _this.externalReset$ = ((_a = traitConfig === null || traitConfig === void 0 ? void 0 : traitConfig.resetOn) === null || _a === void 0 ? void 0 : _a.length) &&
-                            i1.createEffect(function () {
-                                return _this.actions$.pipe(i1.ofType.apply(void 0, __spreadArray([], __read(traitConfig === null || traitConfig === void 0 ? void 0 : traitConfig.resetOn))), operators.mapTo(allActions.resetEntitiesState()));
-                            });
-                        return _this;
-                    }
-                    return ResetEffect;
-                }(core.TraitEffect));
-                ResetEffect.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: ResetEffect, deps: [{ token: i1__namespace.Actions }, { token: i2__namespace.Store }], target: i0__namespace.ɵɵFactoryTarget.Injectable });
-                ResetEffect.ɵprov = i0__namespace.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: ResetEffect });
-                i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.1.2", ngImport: i0__namespace, type: ResetEffect, decorators: [{
-                            type: i0.Injectable
-                        }], ctorParameters: function () { return [{ type: i1__namespace.Actions }, { type: i2__namespace.Store }]; } });
-                return ((_a = traitConfig === null || traitConfig === void 0 ? void 0 : traitConfig.resetOn) === null || _a === void 0 ? void 0 : _a.length) ? [ResetEffect] : [];
+                return createResetTraitEffect(allActions, traitConfig);
             },
         });
     }
+    function createResetTraitEffect(allActions, traitConfig) {
+        var _a;
+        var ResetEffect = /** @class */ (function (_super) {
+            __extends(ResetEffect, _super);
+            //TODO: not sure why Im forced to override this constructor
+            // or test wont pass, strangely doesnt happen in other files
+            // with similar case like pagination.effects.ts
+            function ResetEffect(actions$, store) {
+                var _this = this;
+                var _a;
+                _this = _super.call(this, actions$, store) || this;
+                _this.externalReset$ = ((_a = traitConfig === null || traitConfig === void 0 ? void 0 : traitConfig.resetOn) === null || _a === void 0 ? void 0 : _a.length) &&
+                    i1.createEffect(function () {
+                        return _this.actions$.pipe(i1.ofType.apply(void 0, __spreadArray([], __read(traitConfig === null || traitConfig === void 0 ? void 0 : traitConfig.resetOn))), operators.mapTo(allActions.resetEntitiesState()));
+                    });
+                return _this;
+            }
+            return ResetEffect;
+        }(core.TraitEffect));
+        ResetEffect.ɵfac = i0__namespace.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: ResetEffect, deps: [{ token: i1__namespace.Actions }, { token: i2__namespace.Store }], target: i0__namespace.ɵɵFactoryTarget.Injectable });
+        ResetEffect.ɵprov = i0__namespace.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: ResetEffect });
+        i0__namespace.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "12.2.16", ngImport: i0__namespace, type: ResetEffect, decorators: [{
+                    type: i0.Injectable
+                }], ctorParameters: function () { return [{ type: i1__namespace.Actions }, { type: i2__namespace.Store }]; } });
+        return ((_a = traitConfig === null || traitConfig === void 0 ? void 0 : traitConfig.resetOn) === null || _a === void 0 ? void 0 : _a.length) ? [ResetEffect] : [];
+    }
 
     /**
      * Generates the typical ngrx code need to make a async action with
      * a request, success and failure actions, plus a status property to track its progress
-     * and selectors to query the status.
+     * and selectors to query the status. This trait can be added more thant once as long
+     * as the name prop is different.
      *
      * @param options - Config object for the trait factory
      * @param options.name - Name of the main request action, should be in camel case
@@ -1878,10 +1933,14 @@
      *        'client',
      *      ),
      *    });
-     * // will generate the actions and selectors
+     * //   adds following props to the state:
+     * //    createClientStatus?: 'loading' | 'success' | 'fail';
+     *
+     * // generated actions
      * traits.actions.createClient({name:'Pedro'})
      * traits.actions.createClientSuccess({id:'123'})
      * traits.actions.createClientFail();
+     * //generated selectors
      * traits.selectors.isLoadingCreateClient
      * traits.selectors.isSuccessCreateClient
      * traits.selectors.isFailCreateClient
@@ -1960,7 +2019,8 @@
     }
 
     /**
-     * Generates ngrx code needed to load and entity and store it in a state
+     * Generates ngrx code needed to load and entity and store it in a state. This action can be added
+     * more than once as long as the entityName para is different
      * @param entityName - Entity name, should be in camel case
      * @param options.actionProps - Optional param for the main request action,
      * use the props() function for its value, if not present action will have no params,
@@ -1984,14 +2044,19 @@
      *        >('client'),
      *    });
      *
-     * // will generate
+     * //   adds following props to the state:
+     * //    loadClientStatus?: 'loading' | 'success' | 'fail';
+     * //    client?: Client;
+     *
+     * // generated actions
      * traits.actions.loadClient({id:123});
      * traits.actions.loadClientSuccess({client: {id: '123', name: 'gabs'}});
      * traits.actions.loadClientFail();
-     * traits.selectors.selectClient
-     * traits.selectors.isLoadingLoadClient
-     * traits.selectors.isSuccessLoadClient
-     * traits.selectors.isFailLoadClient
+     * // generated selectors
+     * traits.selectors.selectClient()
+     * traits.selectors.isLoadingLoadClient()
+     * traits.selectors.isSuccessLoadClient()
+     * traits.selectors.isFailLoadClient()
      */
     function addLoadEntityTraits(_a) {
         var entityName = _a.entityName, actionProps = _a.actionProps, actionSuccessProps = _a.actionSuccessProps, actionFailProps = _a.actionFailProps;
@@ -2041,7 +2106,7 @@
      * const traits = createEntityFeatureFactory(
      * addSetEntityTraits({
      *        entityName: 'client',
-     *        actionProps: props<{ client: { id: number; name: string } }
+     *        actionProps: props<{ client: Client }
      *      }),
      * )({
      *      actionsGroupKey: 'Client',
@@ -2049,10 +2114,13 @@
      *        SetEntityState<Client, 'client'>
      *        >('client'),
      *    });
+     * //   adds following props to the state:
+     * //    client?: Client;
      *
-     * // will generate
+     * // generated actions
      * traits.actions.setClient({client: {id:123, name: 'gabs'}});
-     * traits.selectors.selectClient
+     * //generated selectors
+     * traits.selectors.selectClient()
      */
     function addSetEntityTrait(_a) {
         var entityName = _a.entityName, actionProps = _a.actionProps;
@@ -2122,5 +2190,5 @@
 
     Object.defineProperty(exports, '__esModule', { value: true });
 
-})));
+}));
 //# sourceMappingURL=ngrx-traits-common.umd.js.map