feat: entity decorator

+ Add @entity decorator for models + Implement required modelName option + Implement optional pluralName option + Implement optional uriName option + Implement optional comparer function option + Implement effect exclusion feature + Add sorted$ facade stream and selectAllSorted selector * Fix prod build issue with modelName in @entity decorator * Improve robustness of all selectors when state is falsy + Added test-app for simpler app than demo to test library features with Issue #70 #58 #81
briebug · Jan 11, 2020 · 6006712 · 6006712
1 parent cd19510
commit 6006712
Show file tree

Hide file tree

Showing 75 changed files with 1,311 additions and 236 deletions.
diff --git a/angular.json b/angular.json
@@ -116,6 +116,119 @@
           }
         }
       }
+    },
+    "test-app": {
+      "projectType": "application",
+      "schematics": {},
+      "root": "projects/test-app",
+      "sourceRoot": "projects/test-app/src",
+      "prefix": "app",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:browser",
+          "options": {
+            "outputPath": "dist/test-app",
+            "index": "projects/test-app/src/index.html",
+            "main": "projects/test-app/src/main.ts",
+            "polyfills": "projects/test-app/src/polyfills.ts",
+            "tsConfig": "projects/test-app/tsconfig.app.json",
+            "aot": false,
+            "assets": [
+              "projects/test-app/src/favicon.ico",
+              "projects/test-app/src/assets"
+            ],
+            "styles": [
+              "projects/test-app/src/styles.css"
+            ],
+            "scripts": []
+          },
+          "configurations": {
+            "production": {
+              "fileReplacements": [
+                {
+                  "replace": "projects/test-app/src/environments/environment.ts",
+                  "with": "projects/test-app/src/environments/environment.prod.ts"
+                }
+              ],
+              "optimization": true,
+              "outputHashing": "all",
+              "sourceMap": false,
+              "extractCss": true,
+              "namedChunks": false,
+              "aot": true,
+              "extractLicenses": true,
+              "vendorChunk": false,
+              "buildOptimizer": true,
+              "budgets": [
+                {
+                  "type": "initial",
+                  "maximumWarning": "2mb",
+                  "maximumError": "5mb"
+                }
+              ]
+            }
+          }
+        },
+        "serve": {
+          "builder": "@angular-devkit/build-angular:dev-server",
+          "options": {
+            "browserTarget": "test-app:build"
+          },
+          "configurations": {
+            "production": {
+              "browserTarget": "test-app:build:production"
+            }
+          }
+        },
+        "extract-i18n": {
+          "builder": "@angular-devkit/build-angular:extract-i18n",
+          "options": {
+            "browserTarget": "test-app:build"
+          }
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "main": "projects/test-app/src/test.ts",
+            "polyfills": "projects/test-app/src/polyfills.ts",
+            "tsConfig": "projects/test-app/tsconfig.spec.json",
+            "karmaConfig": "projects/test-app/karma.conf.js",
+            "assets": [
+              "projects/test-app/src/favicon.ico",
+              "projects/test-app/src/assets"
+            ],
+            "styles": [
+              "projects/test-app/src/styles.css"
+            ],
+            "scripts": []
+          }
+        },
+        "lint": {
+          "builder": "@angular-devkit/build-angular:tslint",
+          "options": {
+            "tsConfig": [
+              "projects/test-app/tsconfig.app.json",
+              "projects/test-app/tsconfig.spec.json",
+              "projects/test-app/e2e/tsconfig.json"
+            ],
+            "exclude": [
+              "**/node_modules/**"
+            ]
+          }
+        },
+        "e2e": {
+          "builder": "@angular-devkit/build-angular:protractor",
+          "options": {
+            "protractorConfig": "projects/test-app/e2e/protractor.conf.js",
+            "devServerTarget": "test-app:serve"
+          },
+          "configurations": {
+            "production": {
+              "devServerTarget": "test-app:serve:production"
+            }
+          }
+        }
+      }
     }
   },
   "defaultProject": "ngrx-auto-entity-app"

diff --git a/package.json b/package.json
@@ -5,7 +5,12 @@
     "ng": "ng",
     "start": "concurrently --prefix-colors white.bgBlue,white.bgRed --names angular,json-server --kill-others \"npm run serve-proxy\" \"npm run json-server\"",
     "serve": "ng serve --source-map --vendorSourceMap",
-    "serve-proxy": "ng serve --source-map --vendorSourceMap --proxy-config proxy.conf.json",
+    "serve:prod": "ng serve --prod --source-map --vendorSourceMap",
+    "serve:test": "ng serve test-app --prod --source-map --vendorSourceMap",
+    "serve:test:prod": "ng serve test-app --source-map --vendorSourceMap",
+    "serve-proxy": "ng serve --prod --source-map --vendorSourceMap --proxy-config proxy.conf.json",
+    "serve-proxy:test": "ng serve test-app --source-map --vendorSourceMap --proxy-config proxy.conf.json",
+    "serve-proxy:test:prod": "ng serve test-app --prod --source-map --vendorSourceMap --proxy-config proxy.conf.json",
     "build": "ng build --prod",
     "build:watch": "ng build --prod --watch",
     "build:app": "ng build ngrx-auto-entity-app --prod",

diff --git a/projects/ngrx-auto-entity/package.json b/projects/ngrx-auto-entity/package.json
@@ -1,5 +1,5 @@
 {
-  "version": "0.3.1",
+  "version": "0.4.0",
   "name": "@briebug/ngrx-auto-entity",
   "description": "Automatic Entity State and Facades for NgRx. Simplifying reactive state!",
   "keywords": [

diff --git a/projects/ngrx-auto-entity/src/index.ts b/projects/ngrx-auto-entity/src/index.ts
@@ -99,7 +99,20 @@ export {
   Clear
 } from './lib/actions';
 
-export { Key, getKey, getKeyFromModel, getKeyNames, getKeyNamesFromModel, checkKeyName } from './lib/decorators';
+export {
+  IEffectExclusions,
+  IEffectExcept,
+  IEntityOptions,
+  Entity,
+  all,
+  extra,
+  loads,
+  curd,
+  except,
+  matching
+} from './lib/decorators/entity';
+
+export { Key, getKey, getKeyFromModel, getKeyNames, getKeyNamesFromModel, checkKeyName } from './lib/decorators/key';
 
 export { EntityOperators } from './lib/operators';
 

diff --git a/projects/ngrx-auto-entity/src/lib/actions.spec.ts b/projects/ngrx-auto-entity/src/lib/actions.spec.ts
@@ -53,7 +53,7 @@ import {
   UpdateManySuccess,
   UpdateSuccess
 } from './actions';
-import { Key } from './decorators';
+import { Key } from './decorators/key';
 
 class TestEntity {
   @Key id: number;

diff --git a/projects/ngrx-auto-entity/src/lib/actions.ts b/projects/ngrx-auto-entity/src/lib/actions.ts
@@ -3,9 +3,11 @@ import { Action } from '@ngrx/store';
 import { merge, Observable, OperatorFunction } from 'rxjs';
 import { filter } from 'rxjs/operators';
 import { pascalCase } from '../util/case';
-import { checkKeyName } from './decorators';
+import { IEntityOptions } from './decorators/entity';
+import { checkKeyName } from './decorators/key';
 import { IPageInfo, IRangeInfo, Page, Range } from './models';
 import { EntityIdentity } from './util';
+import { ENTITY_OPTS_PROP } from './decorators/entity-tokens';
 
 export enum EntityActionTypes {
   Load = '[Entity] (Generic) Load',
@@ -94,6 +96,8 @@ export enum EntityActionTypes {
  */
 export interface IEntityInfo {
   modelName: string;
+  pluralName?: string;
+  uriName?: string;
   modelType: new () => any;
 }
 
@@ -113,6 +117,7 @@ const uuid = (a?, b?) => {
   for (b = a = ''; a++ < 36; b += a * 51 & 52 ? (a ^ 15 ? 8 ^ Math.random() * (a ^ 20 ? 16 : 4) : 4).toString(16) : '-') ;
   return b;
 };
+
 // tslint:enable
 
 /**
@@ -130,10 +135,14 @@ export abstract class EntityAction<TModel> implements IEntityAction {
 
 const setInfo = (type: any): IEntityInfo => {
   const instance = new type();
-  checkKeyName(type, instance.constructor.name);
+  const opts = (type[ENTITY_OPTS_PROP] || { modelName: instance.constructor.name }) as IEntityOptions;
+  const modelName = opts.modelName;
+  checkKeyName(type, modelName);
   return {
     modelType: type,
-    modelName: instance.constructor.name
+    modelName,
+    pluralName: opts.pluralName,
+    uriName: opts.uriName
   };
 };
 

diff --git a/projects/ngrx-auto-entity/src/lib/decorators/entity-tokens.ts b/projects/ngrx-auto-entity/src/lib/decorators/entity-tokens.ts
@@ -0,0 +1 @@
+export const ENTITY_OPTS_PROP = '__nae_entity_opts';
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export const ENTITY_OPTS_PROP = '__nae_entity_opts';