wip ngrx

Author: Peter Smith

libs/ddd/src/schematics/domain/index.ts

@@ -1,11 +1,11 @@
-import { 
-  chain, 
-  externalSchematic, 
-  Rule, 
-  apply, 
-  url, 
-  template, 
-  move, 
+import {
+  chain,
+  externalSchematic,
+  Rule,
+  apply,
+  url,
+  template,
+  move,
   mergeWith,
   noop,
 } from '@angular-devkit/schematics';
@@ -14,13 +14,18 @@ import { strings } from '@angular-devkit/core';
 import { DomainOptions } from './schema';
 import { addDomainToLintingRules } from '../utils/update-linting-rules';
 
-export default function(options: DomainOptions): Rule {
+export default function (options: DomainOptions): Rule {
   const libFolder = strings.dasherize(options.name);
 
-  const templateSource = apply(url('./files'), [
-    template({}),
-    move(`libs/${libFolder}/domain/src/lib`)
-  ]);
+  const templateSource = options.ngrx
+    ? apply(url('./ngrx-files'), [
+        template({}),
+        move(`libs/${libFolder}/domain/src/lib`),
+      ])
+    : apply(url('./files'), [
+        template({}),
+        move(`libs/${libFolder}/domain/src/lib`),
+      ]);
 
   return chain([
     externalSchematic('@nrwl/angular', 'lib', {
@@ -34,12 +39,12 @@ export default function(options: DomainOptions): Rule {
     }),
     addDomainToLintingRules(options.name),
     mergeWith(templateSource),
-    (!options.addApp) ? 
-      noop() : 
-      externalSchematic('@nrwl/angular', 'app', {
-        name: options.name,
-        tags: `domain:${options.name},type:app`,
-        style: 'scss',
-      }),
+    !options.addApp
+      ? noop()
+      : externalSchematic('@nrwl/angular', 'app', {
+          name: options.name,
+          tags: `domain:${options.name},type:app`,
+          style: 'scss',
+        }),
   ]);
 }

libs/ddd/src/schematics/domain/ngrx-files/+state/__fileName__.actions.ts__tmpl__

@@ -0,0 +1,20 @@
+import { createAction, props } from '@ngrx/store';
+import { <%= className %> } from '../entities/<%= fileName %>';
+
+export const load<%= className %> = createAction(
+  '[<%= className %>] Load <%= className %>'
+);
+
+export const load<%= className %>Success = createAction(
+  '[<%= className %>] Load <%= className %> Success',
+  props<{ <%= propertyName %>: <%= className %>[] }>()
+);
+
+export const load<%= className %>Failure = createAction(
+  '[<%= className %>] Load <%= className %> Failure',
+  props<{ error: any }>()
+);
+
+/**
+ * TODO: reconcile: className, fileName, propertyName may be referencing pluralized name and we may want a singular. especially for imports. 
+ */

libs/ddd/src/schematics/domain/ngrx-files/+state/__fileName__.effects.ts__tmpl__

@@ -0,0 +1,26 @@
+import { Injectable } from '@angular/core';
+import { createEffect, Actions, ofType } from '@ngrx/effects';
+import { catchError, map, switchMap } from 'rxjs/operators';
+import { of } from 'rxjs';
+import * as <%= className %>Actions from './<%= fileName %>.actions';
+
+@Injectable()
+export class <%= className %>Effects {
+  load<%= className %>$ = createEffect(() => this.actions$.pipe(
+  ofType(<%= className %>Actions.load<%= className %>),
+  switchMap((action)) =>
+    this.backend.load().pipe(
+      map((<%= propertyName %>) =>
+        <%= className =>Actions.load<%= className %>Success({ <%= propertyName => })
+      ),
+      catchError((error) =>
+        of(<%= className =>Actions.load<%= className %>Failure({ error }))
+      )
+    )
+  );
+
+ constructor(
+   private actions$: Actions,
+   private backend: <%= className %>DataService
+  ) { }
+}

libs/ddd/src/schematics/domain/ngrx-files/+state/__fileName__.facade.ts__tmpl__

@@ -0,0 +1,20 @@
+import { Injectable } from '@angular/core';
+
+import { select, Store, Action } from '@ngrx/store';
+
+import * as from<%= className %> from './<%= fileName %>.reducer';
+import * as <%= className %>Selectors from './<%= fileName %>.selectors';
+
+@Injectable()
+export class <%= className %>Facade {
+
+  loaded$ = this.store.pipe(select(<%= className %>Selectors.get<%= className %>Loaded));
+  all<%= className %>$ = this.store.pipe(select(<%= className %>Selectors.getAll<%= className %>));
+  selected<%= className %>$ = this.store.pipe(select(<%= className %>Selectors.getSelected));
+
+  constructor(private store: Store<from<%= className %>.<%= className %>PartialState>) { }
+
+  dispatch(action: Action) {
+    this.store.dispatch(action);
+  }
+}

libs/ddd/src/schematics/domain/ngrx-files/+state/__fileName__.reducer.ts__tmpl__

@@ -0,0 +1,41 @@
+import { createReducer, on, Action } from '@ngrx/store';
+import { EntityState, EntityAdapter, createEntityAdapter } from '@ngrx/entity';
+
+import * as <%= className %>Actions from './<%= fileName %>.actions';
+import { <%= className %>Entity } from './<%= fileName %>.models';
+
+export const <%= className.toUpperCase() %>_FEATURE_KEY = '<%= propertyName %>';
+
+export interface State extends EntityState<<%= className %>Entity> {
+  selectedId ?: string | number;          // which <%= className %> record has been selected
+  loaded      : boolean;                  // has the <%= className %> list been loaded
+  error      ?: string | null;            // last known error (if any)
+}
+
+export interface <%= className %>PartialState {
+  readonly [<%= className.toUpperCase() %>_FEATURE_KEY]: State;
+}
+
+export const <%= propertyName %>Adapter: EntityAdapter<<%= className %>Entity> = createEntityAdapter<<%= className %>Entity>();
+
+export const initialState: State = <%= propertyName %>Adapter.getInitialState({
+  // set initial required properties
+  loaded : false
+});
+
+const <%= propertyName %>Reducer = createReducer(
+  initialState,
+  on(<%= className %>Actions.load<%= className %>,
+    state => ({ ...state, loaded: false, error: null })
+  ),
+  on(<%= className %>Actions.load<%= className %>Success,
+    (state, { <%= propertyName %> }) => <%= propertyName %>Adapter.upsertMany(<%= propertyName %>, { ...state, loaded: true })
+  ),
+  on(<%= className %>Actions.load<%= className %>Failure,
+    (state, { error }) => ({ ...state, error })
+  ),
+);
+
+export function reducer(state: State | undefined, action: Action) {
+  return <%= propertyName %>Reducer(state, action);
+}

libs/ddd/src/schematics/domain/ngrx-files/+state/__fileName__.selectors.ts__tmpl__

@@ -0,0 +1,38 @@
+import { createFeatureSelector, createSelector } from '@ngrx/store';
+import { <%= className.toUpperCase() %>_FEATURE_KEY, State, <%= className %>PartialState, <%= propertyName %>Adapter } from './<%= fileName %>.reducer';
+
+// Lookup the '<%= className %>' feature state managed by NgRx
+export const get<%= className %>State = createFeatureSelector<<%= className %>PartialState, State>(<%= propertyName.toUpperCase() %>_FEATURE_KEY);
+
+const { selectAll, selectEntities } = <%= propertyName %>Adapter.getSelectors();
+
+export const get<%= className %>Loaded = createSelector(
+  get<%= className %>State,
+  (state: State) => state.loaded
+);
+
+export const get<%= className %>Error = createSelector(
+  get<%= className %>State,
+  (state: State) => state.error
+);
+
+export const getAll<%= className %> = createSelector(
+  get<%= className %>State,
+  (state: State) => selectAll(state)
+);
+
+export const get<%= className %>Entities = createSelector(
+  get<%= className %>State,
+  (state: State) => selectEntities(state)
+);
+
+export const getSelectedId = createSelector(
+  get<%= className %>State,
+  (state: State) => state.selectedId
+);
+
+export const getSelected = createSelector(
+  get<%= className %>Entities,
+  getSelectedId,
+  (entities, selectedId) => selectedId && entities[selectedId]
+);

libs/ddd/src/schematics/domain/ngrx-files/application/.gitkeep

@@ -20,13 +20,15 @@
     },
     "type": {
       "type": "string",
-      "enum": [
-        "internal",
-        "buildable",
-        "publishable"
-      ],
+      "enum": ["internal", "buildable", "publishable"],
       "description": "A type to determine if and how to build the library.",
       "default": "buildable"
+    },
+    "ngrx": {
+      "type": "boolean",
+      "default": false,
+      "description": "Add ngrx for the domain",
+      "x-prompt": "Would you like to add NgRx to your domain?"
     }
   },
   "required": ["name"]