@ngrx/router-store - npm Package Versions

19.0.0-rc.0 (2024-12-10)

Bug Fixes

• eslint-plugin: support ESM modudule syntax (.mjs) (e2f35c8)
• signals: create deep signals for custom class instances (#4614) (4d34dc4), closes #4604

Features

• eslint-plugin: add new rule require-super-ondestroy (#4611) (2ac4372), closes #4505
• signals: add signalMethod (#4597) (bdd1d3e), closes #4581
• signals: add withProps base feature (#4607) (e626082)
• signals: add migration for withProps (#4612) (5f803d0), closes #4608
• store: enable dispatching actions on signal changes (#4600) (2528d39), closes #4537

BREAKING CHANGES

• signals: - The computed property in SignalStoreFeatureResult type is renamed to props.

• The EntityComputed and NamedEntityComputed types in the entities plugin are renamed to EntityProps and NamedEntityProps.

BEFORE:

import { computed, Signal } from '@angular/core';
import { signalStoreFeature, SignalStoreFeature, type, withComputed } from '@ngrx/signals';
import { EntityComputed } from '@ngrx/signals/entities';

export function withTotalEntities<Entity>(): SignalStoreFeature<{ state: {}; computed: EntityComputed<Entity>; methods: {} }, { state: {}; computed: { total: Signal<number> }; methods: {} }> {
  return signalStoreFeature(
    { computed: type<EntityComputed<Entity>>() },
    withComputed(({ entities }) => ({
      total: computed(() => entities().length),
    }))
  );
}

AFTER:

import { computed, Signal } from '@angular/core';
import { signalStoreFeature, SignalStoreFeature, type, withComputed } from '@ngrx/signals';
import { EntityProps } from '@ngrx/signals/entities';

export function withTotalEntities<Entity>(): SignalStoreFeature<{ state: {}; props: EntityProps<Entity>; methods: {} }, { state: {}; props: { total: Signal<number> }; methods: {} }> {
  return signalStoreFeature(
    { props: type<EntityProps<Entity>>() },
    withComputed(({ entities }) => ({
      total: computed(() => entities().length),
    }))
  );
}

<a name="19.0.0-beta.0""></a>

19.0.0-rc.0 (2024-12-10)

Bug Fixes

• eslint-plugin: support ESM modudule syntax (.mjs) (e2f35c8)
• signals: create deep signals for custom class instances (#4614) (4d34dc4), closes #4604

Features

• eslint-plugin: add new rule require-super-ondestroy (#4611) (2ac4372), closes #4505
• signals: add signalMethod (#4597) (bdd1d3e), closes #4581
• signals: add withProps base feature (#4607) (e626082)
• signals: add migration for withProps (#4612) (5f803d0), closes #4608
• store: enable dispatching actions on signal changes (#4600) (2528d39), closes #4537

BREAKING CHANGES

• signals: - The computed property in SignalStoreFeatureResult type is renamed to props.

• The EntityComputed and NamedEntityComputed types in the entities plugin are renamed to EntityProps and NamedEntityProps.

BEFORE:

import { computed, Signal } from '@angular/core';
import { signalStoreFeature, SignalStoreFeature, type, withComputed } from '@ngrx/signals';
import { EntityComputed } from '@ngrx/signals/entities';

export function withTotalEntities<Entity>(): SignalStoreFeature<{ state: {}; computed: EntityComputed<Entity>; methods: {} }, { state: {}; computed: { total: Signal<number> }; methods: {} }> {
  return signalStoreFeature(
    { computed: type<EntityComputed<Entity>>() },
    withComputed(({ entities }) => ({
      total: computed(() => entities().length),
    }))
  );
}

AFTER:

import { computed, Signal } from '@angular/core';
import { signalStoreFeature, SignalStoreFeature, type, withComputed } from '@ngrx/signals';
import { EntityProps } from '@ngrx/signals/entities';

export function withTotalEntities<Entity>(): SignalStoreFeature<{ state: {}; props: EntityProps<Entity>; methods: {} }, { state: {}; props: { total: Signal<number> }; methods: {} }> {
  return signalStoreFeature(
    { props: type<EntityProps<Entity>>() },
    withComputed(({ entities }) => ({
      total: computed(() => entities().length),
    }))
  );
}

<a name="19.0.0-beta.0""></a>

19.0.0-beta.0" (2024-11-20)

Features

• schematics: change standalone default to true for components (#4569) (c7d0ce6)
• signals: rename rxMethod.unsubscribe to destroy (#4584) (57ad5c5)
• signals: throw error in dev mode on state mutation (#4526) (7a84209)

BREAKING CHANGES

• signals: The signalState/signalStore state object is frozen in development mode. If a mutable change occurs to the state object, an error will be thrown.

BEFORE:

const userState = signalState(initialState);
patchState(userState, (state) => {
  state.user.firstName = 'mutable change'; // mutable change which went through
  return state;
});

AFTER:

const userState = signalState(initialState);
patchState(userState, (state) => {
  state.user.firstName = 'mutable change'; // throws in dev mode
  return state;
});

• signals: The unsubscribe method from rxMethod is renamed to destroy.

BEFORE:

const logNumber = rxMethod<number>(tap(console.log));

const num1Ref = logNumber(interval(1_000));
const num2Ref = logNumber(interval(2_000));

// destroy `num1Ref` after 2 seconds
setTimeout(() => num1Ref.unsubscribe(), 2_000);

// destroy all reactive method refs after 5 seconds
setTimeout(() => logNumber.unsubscribe(), 5_000);

AFTER:

const logNumber = rxMethod<number>(tap(console.log));

const num1Ref = logNumber(interval(1_000));
const num2Ref = logNumber(interval(2_000));

// destroy `num1Ref` after 2 seconds
setTimeout(() => num1Ref.destroy(), 2_000);

// destroy all reactive method refs after 5 seconds
setTimeout(() => logNumber.destroy(), 5_000);

• schematics: The default setting for generating components using schematics is updated.

BEFORE:

The default setting for generating components using schematics does not use standalone components.

AFTER:

The default setting for generating components using schematics uses standalone components.

• The minimum required version of Angular has been updated.

BEFORE:

The minimum required version is Angular 18.x

AFTER:

The minimum required version is Angular 19.x

<a name="18.1.1"></a>

18.1.1 (2024-10-29)

Bug Fixes

• data: export HttpOptions (#4564) (4909627)
• router-store: use non-const enum to allow isolatedModules tsconfig option (#4554) (f993759)

<a name="18.1.0"></a>

18.1.0 (2024-10-08)

Bug Fixes

• component-store: remove @ngrx/operators from dependencies (#4532) (3b4b9c4)
• effects: remove @ngrx/operators from dependencies (#4531) (4fb78f1)
• signals: remove usage of SIGNAL from @angular/core/primitives/signals package (#4530) (cae429a)
• signals: use Injector of rxMethod instance caller if available (#4529) (ffc1d87), closes #4528
• store-devtools: add @angular/core as peer dependency (#4478) (62cceeb), closes #4479

Features

• eslint-plugin: add preferProtectedState rule (#4488) (32c772d), closes #4474
• signals: add deepComputed function (#4539) (269bd32)

<a name="18.0.2"></a>

18.0.2 (2024-07-31)

Bug Fixes

• eslint-plugin: do not report non-array returns in no-multiple-actions-in-effects (#4418) (92a68bc)
• operators: add @ngrx/operators to packageGroup for updates (#4472) (521ce7b), closes #4465
• signals: allow modifying entity id on update (#4404) (0106e93)

<a name="18.0.1"></a>

18.0.1 (2024-06-27)

Bug Fixes

• component-store: resolve issues in migration script to v18 (#4403) (a15d53e)
• effects: fix bugs in migration script to v18 (#4402) (6ae4723)
• eslint-plugin: only take return statement into account with no-multiple-actions-in-effects (#4410) (c9c646c), closes #4409

Features

• signals: rename signals to computed when defining custom features with input (#4395) (05f0940), closes #4391
• signals: replace idKey with selectId when defining custom entity ID (#4396) (67a5a93), closes #4217 #4392

<a name="18.0.1"></a>

18.0.0 (2024-06-13)

<a name="18.0.0-rc.1"></a>

18.0.0-rc.1 (2024-06-12)

Bug Fixes

• eslint-plugin: include signals to ESLint v8 rules (#4387) (7c75dcf), closes #4385

<a name="18.0.0-rc.0"></a>

18.0.0-rc.0 (2024-06-10)

Bug Fixes

• router-store: include string[] as return type for selectQueryParam (#4369) (b0b43f7)
• signals: export DeepSignal (#4377) (fa26c5c)

Features

• component-store: remove tapResponse operator (#4366) (285c810)
• effects: remove concatLatestFrom operator (#4367) (1a1b6df)
• eslint-plugin: add signals rules (#4380) (c002466)
• eslint-plugin: support ESLint v9 (and v8) (#4371) (e8d9ffa)

BREAKING CHANGES

• effects: The concatLatestFrom operator has been removed from @ngrx/effects in favor of the @ngrx/operators package.

BEFORE:

import { concatLatestFrom } from '@ngrx/effects';

AFTER:

import { concatLatestFrom } from '@ngrx/operators';

• component-store: The tapResponse operator has been removed from @ngrx/component-store in favor of the @ngrx/operators package.

BEFORE:

import { tapResponse } from '@ngrx/component-store';

AFTER:

import { tapResponse } from '@ngrx/operators';

<a name="18.0.0-beta.1"></a>