@ngdux/list 1.1.0 → 1.1.1

package/README.md

@@ -1,12 +1,19 @@
 # @ngdux/list
 
-The @ngdux/list gives yo a full state to make easy to load, save and delete resources. It gives also support to paging, filtering and sorting.
+The @ngdux/list uses ngrx/store to give you a full state to make easy to load, save and delete resources. It gives also support to paging, filtering and sorting.
+It was created to reduce the ngrx/store boilerplate code
+
+## Installation
+
+npm install @ngdux/list
 
 Example:
 
-## Option 1
+## Option 1 - Full state
 
-### Full state
+https://github.com/allanartuso/ngdux/tree/master/libs/demo/data-access/properties/src/lib/%2Bstate/properties
+
+### State
 
 ```
 import { UserDto } from '@demo/demo/data-model/users';
@@ -22,7 +29,24 @@ export const {
 } = createListState<UserDto, ErrorDto>(USERS_FEATURE_KEY);
 ```
 
-## Option 2
+### Facade
+
+```
+import { Injectable } from '@angular/core';
+import { AbstractListFacade } from '@ngdux/list';
+import { Store } from '@ngrx/store';
+import { usersActions, usersSelectors } from './users.state';
+import { User, Error } from './models';
+
+@Injectable()
+export class UsersFacade extends AbstractListFacade<User, Error> {
+  constructor(store: Store) {
+    super(store, usersActions, usersSelectors);
+  }
+}
+```
+
+## Option 2 - Separated creators for actions, reducer and selectors
 
 ### Actions
 
@@ -30,7 +54,7 @@ export const {
 import { createListActions } from '@ngdux/list';
 import { User, Error } from './models';
 
-export const listActions = createListActions<User, Error>('Users');
+export const usersActions = createListActions<User, Error>('Users');
 ```
 
 ### Reducer
@@ -39,12 +63,12 @@ export const listActions = createListActions<User, Error>('Users');
 import { createListEntityAdapter, createListReducer, ListState } from '@ngdux/list';
 import { Action } from '@ngrx/store';
 import { User, Error } from './models';
-import { listActions } from './users.actions';
+import { usersActions } from './users.actions';
 
 export const USERS_FEATURE_KEY = 'users';
 export const entityAdapter = createListEntityAdapter<User>();
 
-const reducer = createListReducer<User, Error>(entityAdapter, listActions);
+const reducer = createListReducer<User, Error>(entityAdapter, usersActions);
 
 export function usersReducer(state: ListState<User, Error>, action: Action): ListState<User, Error> {
   return reducer(state, action);
@@ -61,7 +85,82 @@ import { entityAdapter, USERS_FEATURE_KEY } from './users.reducer';
 
 const getState = createFeatureSelector<ListState<User, Error>>(USERS_FEATURE_KEY);
 
-export const listSelectors = createListSelectors(entityAdapter, getState);
+export const usersSelectors = createListSelectors(entityAdapter, getState);
+```
+
+### Facade
+
+```
+import { Injectable } from '@angular/core';
+import { AbstractListFacade } from '@ngdux/list';
+import { Store } from '@ngrx/store';
+import { usersActions } from './users.actions';
+import { usersSelectors } from './users.selectors';
+
+@Injectable()
+export class UsersFacade extends AbstractListFacade<User, Error> {
+  constructor(store: Store) {
+    super(store, userActions, usersSelectors);
+  }
+}
+```
+
+## Option 3 - Dynamic feature key
+
+https://github.com/allanartuso/ngdux/tree/master/libs/demo/data-access/users/src/lib/%2Bstate/users
+
+### Reducer manager service
+
+```
+import { Injectable } from '@angular/core';
+import { User, Error } from '.../models';
+import { AbstractListReducerManager } from '@ngdux/list';
+
+@Injectable()
+export class UsersReducerManager extends AbstractListReducerManager<User, Error> {}
+```
+
+### Facade
+
+```
+import { Injectable } from '@angular/core';
+import { AbstractListFacade } from '@ngdux/list';
+import { Store } from '@ngrx/store';
+import { UsersReducerManager } from './users-state.service';
+
+@Injectable()
+export class UsersFacade extends AbstractListFacade<User, Error> {
+  constructor(store: Store, usersReducerManager: UsersReducerManager) {
+    super(store, usersReducerManager.actions, usersReducerManager.selectors);
+  }
+}
+
+```
+
+### Module
+
+```
+import { ModuleWithProviders, NgModule } from '@angular/core';
+import { LIST_FEATURE_KEY } from '@ngdux/list';
+import { UsersReducerManager } from './+state/users/users-state.service';
+import { UsersFacade } from './+state/users/users.facade';
+
+@NgModule({
+  providers: [
+    UsersReducerManager,
+    UsersFacade
+  ]
+})
+export class UsersModule {
+  static config(listFeatureKey: string): ModuleWithProviders<UsersModule> {
+    return {
+      ngModule: UsersModule,
+      providers: [
+        { provide: LIST_FEATURE_KEY, useValue: listFeatureKey  },
+      ]
+    };
+  }
+}
 ```
 
 ## Effects
@@ -73,8 +172,8 @@ import { AbstractListEffects } from '@ngdux/list';
 import { Actions } from '@ngrx/effects';
 import { Store } from '@ngrx/store';
 import { UserService } from '../../services/user.service';
-import { listActions } from './users.actions';
-import { listSelectors } from './users.selectors';
+import { usersActions } from './users.actions';
+import { usersSelectors } from './users.selectors';
 import { User, Error } from './models';
 
 @Injectable()
@@ -91,7 +190,7 @@ export class UsersEffects extends AbstractListEffects<User, Error> {
     usersService: UserService,
     notificationService: NotificationService
   ) {
-    super(actions$, store, usersService, listActions, listSelectors, notificationService);
+    super(actions$, store, usersService, usersActions, usersSelectors, notificationService);
   }
 }
 ```

package/package.json

@@ -1,12 +1,22 @@
 {
   "name": "@ngdux/list",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "repository": {
     "type": "git",
     "url": "git@github.com:allanartuso/ngdux.git",
     "directory": "/libs/ngdux/util/store/list"
   },
   "homepage": "https://github.com/allanartuso/ngdux/tree/master/libs/ngdux/util/store/list#readme",
+  "default": {
+    "name": "@ngdux/list",
+    "version": "1.1.0",
+    "repository": {
+      "type": "git",
+      "url": "git@github.com:allanartuso/ngdux.git",
+      "directory": "/libs/ngdux/util/store/list"
+    },
+    "homepage": "https://github.com/allanartuso/ngdux/tree/master/libs/ngdux/util/store/list#readme"
+  },
   "module": "fesm2015/ngdux-list.mjs",
   "es2020": "fesm2020/ngdux-list.mjs",
   "esm2020": "esm2020/ngdux-list.mjs",
@@ -31,9 +41,9 @@
     "tslib": "^2.3.0"
   },
   "peerDependencies": {
-    "@ngdux/data-model-common": "1.1.0",
+    "@ngdux/data-model-common": "1.1.1",
     "@angular/core": "15.2.9",
-    "@ngdux/store-common": "1.1.0",
+    "@ngdux/store-common": "1.1.1",
     "@ngrx/entity": "15.3.0"
   }
 }