Permalink
Find file Copy path
666 lines (466 sloc) 48.4 KB

7.0.0 (2018-12-20)

Features

  • Effects: add OnInitEffects interface to dispatch an action on initialization (e921cd9)
  • RouterStore: make the router store key selector generic (a30a514), closes #1457
  • schematics: add project flag support to specify apps or libs (#1477) (af39fd2), closes #1455

Reverts

  • Effects: dispatch init feature effects action on init #1305 (e9cc9ae)

7.0.0-beta.1 (2018-12-04)

Features

  • effects: add OnIdentifyEffects interface to register multiple effect instances (#1448) (b553ce7)
  • store-devtools: catch and log redux devtools errors (#1450) (4ed16cd)

7.0.0-beta.0 (2018-11-03)

Bug Fixes

  • docs-infra: ARIA roles used must conform to valid values (8a4b2de)
  • docs-infra: elements must have sufficient color contrast (c5dfaef)
  • docs-infra: html element must have a lang attribute (32256de)
  • docs-infra: Images must have alternate text (8241f99)
  • docs-infra: notification must have sufficient color contrast (ac24cc3)
  • example: close side nav when escape key is pressed (#1244) (b3fc5dd), closes #1172
  • router-store: Added new imports to index.ts, codestyle (293f960)
  • router-store: allow compilation with strictFunctionTypes (#1385) (0e38673), closes #1344
  • router-store: Avoiding @ngrx/effects dependency inside tests (11d3b9f)
  • router-store: handle internal navigation error, dispatch cancel/error action with previous state (#1294) (5300e7d)
  • schematics: correct spec description in reducer template (#1269) (b7ab4f8)
  • schematics: fix effects code generated by schematics:feature (#1357) (458e2b4)
  • store: add typing to allow props with store.select (#1387) (a9e7cbd)
  • store: memoize selector arguments (#1393) (7cc9702), closes #1389
  • store: remove deprecation from Store.select (#1382) (626784e)

Code Refactoring

Features

  • effects: add smarter type inference for ofType operator. (#1183) (8d56a6f)
  • effects: add support for effects of different instances of same class (#1249) (518e561), closes #1246
  • effects: dispatch feature effects action on init (#1305) (15a4b58), closes #683
  • entity: add support for predicate to removeMany (#900) (d7daa2f)
  • entity: add support for predicate to updateMany (#907) (4e4c50f)
  • example: add logout confirmation (#1287) (ba8d300), closes #1271
  • router-store: Add custom serializer to config object (5c814a9), closes #1262
  • router-store: Add support for serializers with injected values (959cfac)
  • router-store: config option to dispatch ROUTER_NAVIGATION later (fe71ffb), closes #1263
  • router-store: New router Actions ROUTER_REQUEST and ROUTER_NAVIGATED (9f731c3), closes #1010 #1263
  • router-store: serialize routeConfig inside the default serializer (#1384) (18a16d4)
  • router-store: update stateKey definition to take a string or selector (4ad9a94), closes #1300
  • store: add testing package (#1027) (ab56aac), closes #915
  • store: dispatch one update action when features are added or removed (#1240) (0b90f91)
  • Store: export SelectorWithProps and MemoizedSelectorWithProps (#1341) (df8fc60)
  • store-devtools: add support for persist, lock, pause (#955) (93fcf56), closes #853 #919
  • store-devtools: use different action when recomputing state history (#1353) (1448a0e), closes #1255
  • StoreDevtools: implement actionsBlacklist/Whitelist & predicate (#970) (7ee46d2), closes #938
  • update angular dependencies to V7 (e6048bd), closes #1340

BREAKING CHANGES

  • router-store: The default router serializer now returns a null value for routeConfig when routeConfig doesn't exist on the ActivatedRouteSnapshot instead of an empty object.

BEFORE:

{
  "routeConfig": {}
}

AFTER:

{
  "routeConfig": null
}
  • effects: Removes .ofType method on Actions. Instead use the provided 'ofType' rxjs operator.

BEFORE:

this.actions.ofType('INCREMENT')

AFTER:

import { ofType } from '@ngrx/store';
...
this.action.pipe(ofType('INCREMENT'))
  • RouterStore: Normalize router store actions to be consistent with the other modules

BEFORE:

  • ROUTER_REQUEST
  • ROUTER_NAVIGATION
  • ROUTER_CANCEL
  • ROUTER_ERROR
  • ROUTER_NAVIGATED

AFTER

  • @ngrx/router-store/request
  • @ngrx/router-store/navigation
  • @ngrx/router-store/cancel
  • @ngrx/router-store/error
  • @ngrx/router-store/navigated
  • router-store: StoreRouterConfigFunction is removed. It is no longer possible to pass a function returning a StoreRouterConfig to StoreRouterConnectingModule.forRoot

If you still need this, pass a provider like this: { provide: ROUTER_CONFIG, useFactory: _createRouterConfig // you function }

  • routerstore: The default state key is changed from routerReducer to router
  • store: BEFORE:
{type: '@ngrx/store/update-reducers', feature: 'feature1'}
{type: '@ngrx/store/update-reducers', feature: 'feature2'}

AFTER:

{type: '@ngrx/store/update-reducers', features: ['feature1',
'feature2']}

6.1.0 (2018-08-02)

Bug Fixes

  • effects: Add deprecation notice for ofType instance operator (830c8fa)
  • Effects: Added defaults for ng-add schematic (9d36016)
  • example: adjust styles to display spinner correctly (#1203) (4a0b580)
  • example: remove custom router state serializer (#1129) (389cd78)
  • schematics: correct a type of action class generated (#1140) (bbb7e8c)
  • schematics: exclude environment imports for libraries (#1213) (541de02), closes #1205 #1197
  • schematics: Remove peer dependencies on Angular DevKit (#1222) (fd3da16), closes #1206
  • Schematics: correct resolution of environments path for module (#1094) (d24ed10), closes #1090
  • store: Add deprecation notice for select instance operator (232ca7a)
  • store: Compare results in addition to arguments change in memoizer (#1175) (99e1313)
  • Store: bootstrap store with partial initial state (#1163) (11bd465), closes #906 #909
  • Store: Fix import bug with ng-add and added defaults (ff7dc72)

Features

  • effects: stringify action when reporting as invalid (#1219) (73d32eb)
  • entity: log a warning message when selectId returns undefined in dev mode (#1169) (8f05f1f), closes #1133
  • Entity: expose Dictionary as part of the public API (#1118) (2a267b6), closes #865
  • schematics: display provided path when displaying an error (#1208) (91cc6ed), closes #1200
  • schematics: use ofType operator function instead of Actions#ofType (#1154) (cb58ff1)
  • store: add an overload to createFeatureSelector to provide better type checking (#1171) (03db76f), closes #1136
  • store: provide props to createSelector projector function (#1210) (b1f9b34)
  • Store: createSelector allow props in selector (53832a1)
  • Store: createSelector with only a props selector (35a4848)
  • StoreDevtools: Add ng-add support (be28d8d)
  • StoreDevtools: Allow custom serializer options (#1121) (55a0488)

Performance Improvements

  • Effects: remove path filters in ng-add (5318913)
  • Schematics: remove path filters in effects schematics (6d3f5a1)
  • Schematics: remove path filters in reducer schematics (055f6ef)
  • Schematics: remove path filters in store schematics (762cf2e)
  • Store: remove path filters in ng-add (ec6adb5)
  • StoreDevtools: remove path filters in ng-add (3ba463f)

6.0.1 (2018-05-23)

6.0.0 (2018-05-23)

Bug Fixes

  • Schematics: remove ts extension when importing reducer in container (#1061) (d1ed9e5), closes #1056
  • Schematics: Update parsed path logic to split path and name (a1e9530), closes #1064
  • Store: Resolve environment path when generating a new store (#1071) (599cfb6)

Features

  • implement ng add for store and effects packages (db94db7)

6.0.0-beta.3 (2018-05-12)

Bug Fixes

6.0.0-beta.2 (2018-05-11)

Bug Fixes

  • Update minimum node version to 8.9.0 (#989) (0baaad8)
  • build: Fix UMD global names (#1005) (413efd4), closes #1004
  • RouterStore: Reset dispatch-tracking booleans after navigation end (#968) (48305aa)
  • Schematics: Add check for app/lib to project helper function (5942885)
  • Schematics: Add smart default to blueprint schemas (cdd247e)
  • Schematics: Remove aliases for state and stateInterface options (f4520a2)
  • Schematics: Update upsert actions for entity blueprint (#1042) (0d1d309), closes #1039
  • Schematics: Upgrade schematics to new CLI structure (b99d9ff)
  • Store: Fix type annotations for select methods (#953) (4d74bd2)
  • StoreDevtools: Refresh devtools when extension is started (#1017) (c6e33d9), closes #508

Features

BREAKING CHANGES

  • Schematics: The action blueprint has been updated to be less generic, with associated reducer and effects updated for the feature blueprint

BEFORE:

export enum UserActionTypes { UserAction = '[User] Action' }

export class User implements Action { readonly type = UserActionTypes.UserAction; }

export type UserActions = User;

AFTER:

export enum UserActionTypes { LoadUsers = '[User] Load Users' }

export class LoadUsers implements Action { readonly type = UserActionTypes.LoadUsers; }

export type UserActions = LoadUsers;

  • Schematics: Aliases for state and stateInterface were removed due to conflicts with component aliases without reasonable alternatives.
  • Schematics: Minimum dependency for @ngrx/schematics has changed:

@angular-devkit/core: ^0.5.0 @angular-devkit/schematics: ^0.5.0

6.0.0-beta.1 (2018-04-02)

Bug Fixes

  • Declare global NgRx packages for UMD bundles (#952) (ba2139d), closes #949

6.0.0-beta.0 (2018-03-31)

Bug Fixes

  • Add support for Angular 6 and RxJS 6 (d1286d2)
  • Entity: Change EntityAdapter upsertOne/upsertMany to accept an entity (a0f45ff)
  • RouterStore: Allow strict mode with router reducer (#903) (f17a032)
  • RouterStore: change the default serializer to work around cycles in RouterStateSnapshot (7917a27)
  • RouterStore: Replace RouterStateSnapshot with SerializedRouterStateSnapshot (bd415a1)
  • StoreDevtools: pass timestamp to actions (df2411f)
  • StoreDevtools: report errors to ErrorHandler instead of console (32df3f0)

Features

BREAKING CHANGES

  • StoreDevtools: Errors in reducers are no longer hidden from ErrorHandler by StoreDevtools

BEFORE:

Errors in reducers are caught by StoreDevtools and logged to the console

AFTER:

Errors in reducers are reported to ErrorHandler

  • Schematcis: NgRx Schematics now has a minimum version dependency on @angular-devkit/core and @angular-devkit/schematics of v0.4.0.
  • RouterStore: Default router state is serialized to a shape that removes cycles

BEFORE:

Full RouterStateSnapshot is returned

AFTER:

Router state snapshot is returned as a SerializedRouterStateSnapshot with cyclical dependencies removed

  • Entity: The signature of the upsertOne/upsertMany functions in the EntityAdapter has been changed to accept a fully qualified entity instead of an update object that implements the Update interface.

    Before:

    entityAdapter.upsertOne({
      id: 'Entity ID',
      changes: { id: 'Entity ID', name: 'Entity Name' },
    }, state);
    

    After:

    entityAdapter.upsertOne({
      id: 'Entity ID',
      name: 'Entity Name',
    }, state);
    
  • NgRx now has a minimum version requirement on Angular 6 and RxJS 6.

5.2.0 (2018-03-07)

Bug Fixes

  • Schematics: Correct usage of upsert actions for entity blueprint (#821) (1ffb5a9)
  • Store: only default to initialValue when store value is undefined (#886) (51a1547)
  • StoreDevtools: Fix bug when exporting/importing state history (#855) (a5dcdb1)
  • StoreDevtools: Recompute state history when reducers are updated (#844) (10debcc)

Features

  • Entity: Add 'selectId' and 'sortComparer' to state adapter (#889) (69a62f2)
  • Store: Added feature name to Update Reducers action (730361e)

5.1.0 (2018-02-13)

Bug Fixes

  • Devtools: Ensure Store is loaded eagerly (#801) (ecf1ebf), closes #624 #741
  • Effects: Make ofType operator strictFunctionTypes safe (#789) (c8560e4), closes #753
  • Entity: Avoid for..in iteration in sorted state adapter (#805) (4192645)
  • Entity: Do not add Array.prototype properties to store (#782) (d537758), closes #781
  • Entity: Properly iterate over array in upsert (#802) (779d689)
  • Schematics: Add store import to container blueprint (#763) (a140fa9), closes #760
  • Schematics: Remove extra braces from constructor for container blueprint (#791) (945bf40), closes #778
  • Schematics: Use correct paths for nested and grouped feature blueprint (#756) (c219770)
  • StoreDevtools: Add internal support for ActionSanitizer and StateSanitizer (#795) (a7de2a6)
  • StoreDevtools: Do not send full liftedState for application actions (#790) (c11504f)

Features

  • Entity: Add upsertOne and upsertMany functions to entity adapters (#780) (f871540), closes #421
  • Schematics: Add group option to entity blueprint (#792) (0429276), closes #779
  • Schematics: Add upsert methods to entity blueprint (#809) (7acdc79), closes #592

5.0.1 (2018-01-25)

Bug Fixes

  • Effects: Provide instance from actions to ofType lettable operator (#751) (33d48e7), closes #739

5.0.0 (2018-01-22)

Bug Fixes

  • Effects: Ensure Store modules are loaded eagerly (#658) (0a3398d), closes #642
  • Effects: Remove toPayload utility function (#738) (b390ef5)
  • Entity: updateOne/updateMany should not change ids state on existing entity (#581) (b989e4b), closes #571
  • RouterStore: Fix usage of config object if provided (#575) (4125914)
  • RouterStore: Match RouterAction type parameters (#562) (980a653)
  • Schematics: Add group folder after feature name folder (#737) (317fb94)
  • Schematics: Add handling of flat option to entity blueprint (fb8d2c6)
  • Schematics: Distinguish between root and feature effect arrays when registering (#718) (95ff6c8)
  • Schematics: Don't add state import if not provided (#697) (e5c2aed)
  • Schematics: Make variable naming consistent for entity blueprint (#716) (765b15a)
  • Store: Compose provided metareducers for a feature reducer (#704) (1454620), closes #701
  • StoreDevtools: Only recompute current state when reducers are updated (#570) (247ae1a), closes #229 #487
  • typo: update login error to use correct css font color property (41723fc)

Features

  • Effects: Add lettable ofType operator (d5e1814)
  • ErrorHandler: Use the Angular ErrorHandler for reporting errors (#667) (8f297d1), closes #626
  • material: Upgrade @angular/material to v 2.0.0-beta.12 (#482) (aedf20e), closes #448
  • Schematics: Add alias for container, store and action blueprints (#685) (dc64ac9)
  • Schematics: Add alias for reducer blueprint (#684) (ea98fb7)
  • Schematics: Add effect to registered effects array (#717) (f1082fe)
  • Schematics: Add option to group feature blueprints in respective folders (#736) (b82c35d)
  • Schematics: Introduce @ngrx/schematics (#631) (1837dba), closes #53
  • Store: Add lettable select operator (77eed24)
  • Store: Add support for generating custom createSelector functions (#734) (cb0d185), closes #478 #724
  • StoreDevtools: Add option to configure extension in log-only mode (#712) (1ecd658), closes #643 #374
  • StoreDevtools: Add support for custom instance name (#517) (00be3d1), closes #463
  • StoreDevtools: Add support for extension sanitizers (#544) (6ed92b0), closes #494
  • StoreDevtools: Add support for jumping to a specific action (#703) (b9f6442), closes #681

BREAKING CHANGES

  • Effects: The utility function toPayload, deprecated in @ngrx/effects v4.0, has been removed.

    Before:

    import { toPayload } from '@ngrx/effects';
    
    actions$.ofType('SOME_ACTION').map(toPayload);

    After:

    actions$
      .ofType('SOME_ACTION')
      .map((action: SomeActionWithPayload) => action.payload);
  • ErrorHandler: The ErrorReporter has been replaced with ErrorHandler from angular/core.

BEFORE:

Errors were reported to the ngrx/effects ErrorReporter. The ErrorReporter would log to the console by default.

AFTER:

Errors are now reported to the @angular/core ErrorHandler.

  • Store: Updates minimum version of RxJS dependency.

BEFORE:

Minimum peer dependency of RxJS ^5.0.0

AFTER:

Minimum peer dependency of RxJS ^5.5.0

  • Effects: Updates minimum version of RxJS dependency.

BEFORE:

Minimum peer dependency of RxJS ^5.0.0

AFTER:

Minimum peer dependency of RxJS ^5.5.0

4.1.1 (2017-11-07)

Bug Fixes

Features

  • Codegen: Add base code and build for @ngrx/codegen (#534) (2a22211)
  • RouterStore: Add configurable option for router reducer name (#417) (ab7de5c), closes #410

4.1.0 (2017-10-19)

Bug Fixes

  • Build: Fix build with space in path (#331) (257fc9d)
  • combineSelectors: Remove default parameter from function signature for Closure (ae7d5e1)
  • decorator: add ExportDecoratedItems jsdoc for g3 (#456) (2b0e0cf)
  • Effects: Simplify decorator handling for Closure compatibility (ad30d40)
  • Entity: Change type for EntityState to interface (#454) (d5640ec), closes #458
  • Example: Add missing import for catch operator (#409) (193e8b3)
  • RouterStore: Fix cancelled navigation with async guard (fixes #354) (#355) (920c0ba), closes #201
  • RouterStore: Stringify error from navigation error event (#357) (0528d2d), closes #356
  • Store: Fix typing for feature to accept InjectionToken (#375) (38b2f95)
  • Store: Refactor parameter initialization in combineReducers for Closure (5c60cba)
  • Store: Set initial value for state action pair to object (#480) (100a8ef), closes #477

Features

  • createSelector: Expose projector function on selectors to improve testability (56cb21f), closes #290
  • Effects: Add getEffectsMetadata() helper for verifying metadata (628b865), closes #491
  • Effects: Add root effects init action (#473) (838ba17), closes #246
  • Entity: Add default selectId function for EntityAdapter (#405) (2afb792)
  • Entity: Add support for string or number type for ID (#441) (46d6f2f)
  • Entity: Enable creating entity selectors without composing a state selector (#490) (aae4064)
  • Entity: Rename 'sort' to 'sortComparer' (274554b), closes #370
  • Store: createSelector with an array of selectors (#340) (2f6a035), closes #192

4.0.5 (2017-08-18)

Bug Fixes

  • Effects: Do not complete effects if one source errors or completes (#297) (54747cf), closes #232
  • Entity: Return a referentially equal state if state did not change (fbd6a66)
  • Entity: Simplify target index finder for sorted entities (335d255)

4.0.4 (2017-08-17)

Bug Fixes

  • Effects: Use factory provide for console (#288) (bf7f70c), closes #276
  • RouterStore: Add generic type to RouterReducerState (#292) (6da3ec5), closes #289
  • RouterStore: Only serialize snapshot in preactivation hook (#287) (bbb7c99), closes #286

4.0.3 (2017-08-16)

Bug Fixes

  • Effects: Deprecate toPayload utility function (#266) (1cbb2c9)
  • Effects: Ensure StoreModule is loaded before effects (#230) (065d33e), closes #184 #219
  • Effects: Export EffectsNotification interface (#231) (2b1a076)
  • Store: Add type signature for metareducer (#270) (57633d2), closes #264 #170
  • Store: Set initial state for feature modules (#235) (4aec80c), closes #206 #233
  • Store: Update usage of compose for reducer factory (#252) (683013c), closes #247
  • Store: Use existing reducers when providing reducers without an InjectionToken (#254) (c409252), closes #250 #116
  • Store: Use injector to get reducers provided via InjectionTokens (#259) (bd968fa), closes #189

Features

4.0.2 (2017-08-02)

Bug Fixes

  • createSelector: memoize projector function (#228) (e2f1e57), closes #226
  • docs: update angular-cli variable (eeb7d5d)
  • Docs: update effects description (#164) (c77b2d9)
  • Effects: Wrap testing source in an Actions observable (#121) (bfdb83b), closes #117
  • RouterStore: Add support for cancellation with CanLoad guard (#223) (2c006e8), closes #213
  • Store: Remove auto-memoization of selector functions (90899f7), closes #118

Features

  • Effects: Add generic type to the "ofType" operator (55c13b2)
  • Platform: Introduce @ngrx/entity (#207) (9bdfd70)
  • Store: Add injection token option for feature modules (#153) (7f77693), closes #116 #141 #147
  • Store: Added initial state function support for features. Added more tests (#85) (5e5d7dd)

4.0.1 (2017-07-18)

Bug Fixes

  • effects: allow downleveled annotations (#98) (875b326), closes #93
  • effects: make correct export path for testing module (#96) (a5aad22), closes #94

4.0.0 (2017-07-18)

Bug Fixes

  • build: Fixed deployment of latest master as commit (#18) (5d0ecf9)
  • build: Get tests running for each project (c4a1054)
  • build: Limit concurrency for lerna bootstrap (7e7a7d8)
  • Devtools: Removed SHOULD_INSTRUMENT token used to eagerly inject providers (#57) (b90df34)
  • Effects: Start child effects after running root effects (#43) (931adb1)
  • Effects: Use Actions generic type for the return of the ofType operator (d176a11)
  • Example: Fix Book State interface parent (#90) (6982952)
  • example-app: Suppress StoreDevtoolsConfig compiler warning (8804156)
  • omit: Strengthen the type checking of the omit utility function (3982038)
  • router-store: NavigationCancel and NavigationError creates a cycle when used with routerReducer (a085730), closes #68
  • Store: Exported initial state tokens (#65) (4b27b6d)
  • Store: pass all required arguments to projector (#74) (9b82b3a)
  • Store: Remove parameter destructuring for strict mode (#33) (#77) (c9d6a45)
  • Store: Removed readonly from type (#72) (68274c9)
  • StoreDevtools: Type InjectionToken for AOT compilation (e21d688)

Code Refactoring

  • Effects: Simplified AP, added better error reporting and effects stream control (015107f)

Features

  • build: Updated build pipeline for modules (68bd9df)
  • Effects: Ensure effects are only subscribed to once (089abdc)
  • Effects: Introduce new Effects testing module (#70) (7dbb571)
  • router-store: Added action types (#47) (1f67cb3), closes #44
  • store: Add 'createSelector' and 'createFeatureSelector' utils (#10) (41758b1)
  • Store: Allow initial state function for AoT compatibility (#59) (1a166ec), closes #51
  • Store: Allow parent modules to provide reducers with tokens (#36) (069b12f), closes #34
  • Store: Simplify API for adding meta-reducers (#87) (d2295c7)

BREAKING CHANGES

  • Effects: Effects API for registering effects has been updated to allow for multiple classes to be provided.

BEFORE:

@NgModule({
  imports: [EffectsModule.run(SourceA), EffectsModule.run(SourceB)],
})
export class AppModule {}

AFTER:

@NgModule({
  imports: [EffectsModule.forRoot([SourceA, SourceB, SourceC])],
})
export class AppModule {}

@NgModule({
  imports: [
    EffectsModule.forFeature([FeatureSourceA, FeatureSourceB, FeatureSourceC]),
  ],
})
export class SomeFeatureModule {}