@ngrx-traits/common 12.0.0-beta.3 → 12.1.0

package/README.md

@@ -1,6 +1,6 @@
 # NGRX-Traits
 
-NGRX Traits is a set of factory functions that dynamically generate actions, effects, reducers needed for common functionality like loading a list of entities, filtering, pagination, sorting. They can be mix and match, so you only use what you need, and you can create your own to for example reuse some business logic across your app.
+NGRX Traits is a library to help you compose and reuse a set ngrx actions, selectors, effects and reducers across your app.
 
 # Features
 
@@ -8,7 +8,7 @@ NGRX Traits is a set of factory functions that dynamically generate actions, eff
 - ✅ Easily mix with your own actions, selectors, reducers, and effects
 - ✅ Create your own traits, to easily reuse business logic
 - ✅ Transform any trait config from a global store to a local store bound to a components lifecycle
-- ✅ Trait to load and cache entities list
+- ✅ Trait to load entities list
 - ✅ Trait to filter remote and locally entities list
 - ✅ Trait to sort remote and locally entities list
 - ✅ Trait to paginate entities list
@@ -16,9 +16,11 @@ NGRX Traits is a set of factory functions that dynamically generate actions, eff
 - ✅ Trait to add crud operations to an entities list
 - ✅ Trait to load single entities
 - ✅ Trait to reduce boilerplate needed when calling backend apis
+- ✅ Trait to set a value in the store
+- ✅ Caching
 
 # Installation and Usage
 
-`npm install ngrx-traits-core`
+`npm i @ngrx-traits/{core,common} --save`
 
-For more documentation go to our [github page](https://github.com/gabrielguerrero/ngrx-traits-core)
+For more documentation go to our [github page](https://github.com/gabrielguerrero/ngrx-traits)

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

@@ -615,7 +615,7 @@
      *      addLoadEntitiesTrait<Todo>(),
      *      //addFilterEntitiesTrait<Todo,TodoFilter>() // no params uses remote filtering
      *      addFilterEntitiesTrait<Todo,TodoFilter>({filterFn: (filter, entity) => // local filtering
-     *          filter?.content && entity.content?.includes(filter?.content) || false})
+     *          !filter.content || !!entity.content?.includes(filter.content.toLowerCase())
      *          // or use the following function to switch between remote search and local
      *          // depending on which properties have changed in the filter
      *          // isRemoteFilter: (previous, current) => previous?.someRemoteParam !== current?.someRemoteParam,
@@ -887,7 +887,7 @@
      * 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.
      * @param config
-     * @param config.cacheType - Default to 'full', change the cache mode
+     * @param config.cacheType - Default to 'partial', change the cache mode
      * @param config.pageSize - Default to 20, 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
@@ -929,7 +929,7 @@
      * traits.selectors.selectTodosPageInfo()
      */
     function addEntitiesPaginationTrait(_a) {
-        var _b = _a === void 0 ? {} : _a, _c = _b.cacheType, cacheType = _c === void 0 ? 'full' : _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 ? 20 : _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],