@ngdux/form 1.1.0 → 1.2.0

package/README.md

@@ -1,12 +1,19 @@
 # @ngdux/form
 
-The @ngdux/form gives yo a full state to make easy to create, load, save and delete a resource.
+The @ngdux/form gives you a full state to simplify how to create, load, save and delete a resource.
+It was created to reduce the ngrx/store boilerplate code
+
+## Installation
+
+npm install @ngdux/form
 
 Example:
 
-## Option 1
+## Option 1 - Full state
 
-### Full state
+https://github.com/allanartuso/ngdux/tree/master/libs/demo/data-access/properties/src/lib/%2Bstate/property
+
+### State
 
 ```
 import { User, Error } from '.../models';
@@ -20,7 +27,23 @@ export const {
 } = createFormState<User, Error>(USER_FEATURE_KEY);
 ```
 
-## Option 2
+### Facade
+
+```
+import { Injectable } from '@angular/core';
+import { AbstractFormFacade } from '@ngdux/form';
+import { Store } from '@ngrx/store';
+import { userActions, userSelectors } from './user.state';
+
+@Injectable()
+export class UserFacade extends AbstractFormFacade<User, Error> {
+  constructor(store: Store) {
+    super(store, userActions, userSelectors);
+  }
+}
+```
+
+## Option 2 - Separated creators for actions, reducer and selectors
 
 ### Actions
 
@@ -28,7 +51,7 @@ export const {
 import { createFormActions } from '@ngdux/form';
 import { User, Error } from '.../models';
 
-export const formActions = createFormActions<User, Error>('User');
+export const userActions = createFormActions<User, Error>('User');
 ```
 
 ### Reducer
@@ -57,7 +80,82 @@ import { USER_FEATURE_KEY } from './user.reducer';
 
 const getState = createFeatureSelector<FormState<User, Error>>(USER_FEATURE_KEY);
 
-export const formSelectors = createFormSelectors(getState);
+export const userSelectors = createFormSelectors(getState);
+```
+
+### Facade
+
+```
+import { Injectable } from '@angular/core';
+import { AbstractFormFacade } from '@ngdux/form';
+import { Store } from '@ngrx/store';
+import { userActions } from './user.actions';
+import { userSelectors } from './user.selectors';
+
+@Injectable()
+export class UserFacade extends AbstractFormFacade<User, Error> {
+  constructor(store: Store) {
+    super(store, userActions, userSelectors);
+  }
+}
+```
+
+## Option 3 - Dynamic feature key
+
+https://github.com/allanartuso/ngdux/blob/master/libs/demo/data-access/users/src/lib/%2Bstate/user/user-state.service.ts
+
+### Reducer manager service
+
+```
+import { Injectable } from '@angular/core';
+import { User, Error } from '.../models';
+import { AbstractFormReducerManager } from '@ngdux/form';
+
+@Injectable()
+export class UserReducerManager extends AbstractFormReducerManager<User, Error> {}
+```
+
+### Facade
+
+```
+import { Injectable } from '@angular/core';
+import { AbstractFormFacade } from '@ngdux/form';
+import { Store } from '@ngrx/store';
+import { UserReducerManager } from './user-state.service';
+
+@Injectable()
+export class UserFacade extends AbstractFormFacade<User, Error> {
+  constructor(store: Store, userReducerManager: UserReducerManager) {
+    super(store, userReducerManager.actions, userReducerManager.selectors);
+  }
+}
+
+```
+
+### Module
+
+```
+import { ModuleWithProviders, NgModule } from '@angular/core';
+import { FORM_FEATURE_KEY } from '@ngdux/form';
+import { UserReducerManager } from './+state/user/user-state.service';
+import { UserFacade } from './+state/user/user.facade';
+
+@NgModule({
+  providers: [
+    UserReducerManager,
+    UserFacade
+  ]
+})
+export class UserModule {
+  static config(formFeatureKey: string): ModuleWithProviders<UserModule> {
+    return {
+      ngModule: UserModule,
+      providers: [
+        { provide: FORM_FEATURE_KEY, useValue: formFeatureKey  },
+      ]
+    };
+  }
+}
 ```
 
 ## Effects

package/package.json

@@ -1,12 +1,41 @@
 {
   "name": "@ngdux/form",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "repository": {
     "type": "git",
     "url": "git@github.com:allanartuso/ngdux.git",
     "directory": "/libs/ngdux/util/store/form"
   },
   "homepage": "https://github.com/allanartuso/ngdux/tree/master/libs/ngdux/util/store/form#readme",
+  "peerDependencies": {
+    "@ngdux/data-model-common": "^1.0.0",
+    "@angular/core": "^15.0.0",
+    "@ngdux/store-common": "^1.0.0"
+  },
+  "default": {
+    "name": "@ngdux/form",
+    "version": "1.1.1",
+    "repository": {
+      "type": "git",
+      "url": "git@github.com:allanartuso/ngdux.git",
+      "directory": "/libs/ngdux/util/store/form"
+    },
+    "homepage": "https://github.com/allanartuso/ngdux/tree/master/libs/ngdux/util/store/form#readme",
+    "default": {
+      "name": "@ngdux/form",
+      "repository": {
+        "type": "git",
+        "url": "git@github.com:allanartuso/ngdux.git",
+        "directory": "/libs/ngdux/util/store/form"
+      },
+      "homepage": "https://github.com/allanartuso/ngdux/tree/master/libs/ngdux/util/store/form#readme"
+    },
+    "peerDependencies": {
+      "@ngdux/data-model-common": "^1.0.0",
+      "@angular/core": "^15.0.0",
+      "@ngdux/store-common": "^1.0.0"
+    }
+  },
   "module": "fesm2015/ngdux-form.mjs",
   "es2020": "fesm2020/ngdux-form.mjs",
   "esm2020": "esm2020/ngdux-form.mjs",
@@ -29,10 +58,5 @@
   "sideEffects": false,
   "dependencies": {
     "tslib": "^2.3.0"
-  },
-  "peerDependencies": {
-    "@ngdux/data-model-common": "1.1.0",
-    "@angular/core": "15.2.9",
-    "@ngdux/store-common": "1.1.0"
   }
-}
+}