@ngxs/store 19.0.0 → 20.0.0-dev.master-0db0003

package/index.d.ts

@@ -1,6 +1,6 @@
 import * as i0 from '@angular/core';
-import { Type, ModuleWithProviders, Signal, EnvironmentProviders } from '@angular/core';
-import { ɵSharedSelectorOptions as _SharedSelectorOptions, ɵStateClass as _StateClass, ɵActionOptions as _ActionOptions, StateToken, ɵStoreOptions as _StoreOptions } from '@ngxs/store/internals';
+import { ModuleWithProviders, Signal, EnvironmentProviders, Type } from '@angular/core';
+import { ɵActionOptions as _ActionOptions, StateToken, ɵSharedSelectorOptions as _SharedSelectorOptions, ɵStateClass as _StateClass, ɵStoreOptions as _StoreOptions } from '@ngxs/store/internals';
 export { ɵActionOptions as ActionOptions, StateToken } from '@ngxs/store/internals';
 import * as rxjs from 'rxjs';
 import { Observable, Subscription, OperatorFunction } from 'rxjs';
@@ -9,11 +9,6 @@ export { StateOperator } from '@ngxs/store/operators';
 import { NgxsPlugin, NgxsPluginFn } from '@ngxs/store/plugins';
 export { InitState, NGXS_PLUGINS, NgxsNextPluginFn, NgxsPlugin, NgxsPluginFn, UpdateState, actionMatcher, getActionTypeFromInstance, getValue, setValue } from '@ngxs/store/plugins';
 
-interface NgxsExecutionStrategy {
-    enter<T>(func: () => T): T;
-    leave<T>(func: () => T): T;
-}
-
 /**
  * The NGXS config settings.
  */
@@ -36,18 +31,6 @@ declare class NgxsConfig {
          */
         strictContentSecurityPolicy: boolean;
     };
-    /**
-     * Determines the execution context to perform async operations inside. An implementation can be
-     * provided to override the default behaviour where the async operations are run
-     * outside Angular's zone but all observable behaviours of NGXS are run back inside Angular's zone.
-     * These observable behaviours are from:
-     *   `store.selectSignal(...)`, `store.select(...)`, `actions.subscribe(...)` or `store.dispatch(...).subscribe(...)`
-     * Every `zone.run` causes Angular to run change detection on the whole tree (`app.tick()`) so of your
-     * application doesn't rely on zone.js running change detection then you can switch to the
-     * `NoopNgxsExecutionStrategy` that doesn't interact with zones.
-     * (default: null)
-     */
-    executionStrategy: Type<NgxsExecutionStrategy>;
     /**
      * Defining shared selector options
      */
@@ -276,14 +259,6 @@ declare class Store {
  */
 declare function State<T>(options: _StoreOptions<T>): (target: _StateClass) => void;
 
-/**
- * Decorator for selecting a slice of state from the store.
- *
- * @deprecated
- * Read the deprecation notice at this link: https://ngxs.io/deprecations/select-decorator-deprecation.
- */
-declare function Select<T>(rawSelector?: T, ...paths: string[]): PropertyDecorator;
-
 /**
  * Decorator for setting selector options at a method or class level.
  */
@@ -292,7 +267,7 @@ declare function SelectorOptions(options: _SharedSelectorOptions): ClassDecorato
 /**
  * Status of a dispatched action
  */
-declare const enum ActionStatus {
+declare enum ActionStatus {
     Dispatched = "DISPATCHED",
     Successful = "SUCCESSFUL",
     Canceled = "CANCELED",
@@ -448,11 +423,12 @@ declare function Selector(): SelectorType<unknown>;
  */
 declare function Selector<T extends SelectorDefTuple>(selectors: T): SelectorType<T>;
 
-declare class NoopNgxsExecutionStrategy implements NgxsExecutionStrategy {
-    enter<T>(func: () => T): T;
-    leave<T>(func: () => T): T;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NoopNgxsExecutionStrategy, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<NoopNgxsExecutionStrategy>;
+declare class ActionDirector {
+    private _registry;
+    private _actionHandlerFactory;
+    attachAction<TStateModel, TActionType extends ActionDef>(stateToken: StateToken<TStateModel>, Action: TActionType, handlerFn: (ctx: StateContext<TStateModel>, action: InstanceType<TActionType>) => void | Observable<void> | Promise<void>, options?: _ActionOptions): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ActionDirector, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ActionDirector>;
 }
 
 interface NgxsUnhandledErrorContext {
@@ -544,6 +520,9 @@ declare function provideStore(states?: _StateClass[], options?: NgxsModuleOption
  *   }
  * ];
  * ```
+ *
+ * To lazy-load feature states at the route level,
+ * please refer to the `lazyProvider` utility function.
  */
 declare function provideStates(states: _StateClass[], ...features: EnvironmentProviders[]): EnvironmentProviders;
 
@@ -608,6 +587,40 @@ declare function createSelectMap<T extends SelectorMap>(selectorMap: T): { reado
 type ActionMap = Record<string, ActionDef<any>>;
 declare function createDispatchMap<T extends ActionMap>(actionMap: T): { readonly [K in keyof T]: (...args: ConstructorParameters<T[K]>) => Observable<void>; };
 
+interface DefaultExport<T> {
+    default: T;
+}
+/**
+ * This function serves as a utility to lazy-load providers at the injection
+ * context level — for example, at the route level. If the feature state needs
+ * to be provided in more than one place, it might be indirectly included in
+ * the main bundle, which we want to avoid. This function can be used at the
+ * guard level to lazy-load the state provider before resolvers run and the
+ * component is initialized:
+ *
+ * ```ts
+ * const routes = [
+ *   {
+ *     path: 'home',
+ *     loadComponent: () => import(...),
+ *     canActivate: [
+ *       lazyProvider(async () => (await import('path-to-state-library')).invoicesStateProvider)
+ *     ]
+ *   }
+ * ];
+ * ```
+ *
+ * Where `invoicesStateProvider` is the following:
+ *
+ * ```ts
+ * // path-to-state-library/index.ts
+ *
+ * export const invoicesStateProvider = provideStates([InvoicesState]);
+ * ```
+ */
+declare function lazyProvider(factory: () => Promise<EnvironmentProviders | DefaultExport<EnvironmentProviders>>): () => Promise<boolean>;
+
 declare function ɵprovideNgxsInternalStateTokens(): i0.EnvironmentProviders;
 
-export { Action, type ActionCompletion, type ActionContext, type ActionDef, type ActionMap, ActionStatus, type ActionType, Actions, type NgxsAfterBootstrap, NgxsConfig, NgxsDevelopmentModule, type NgxsDevelopmentOptions, type NgxsExecutionStrategy, NgxsModule, type NgxsModuleOptions, type NgxsOnChanges, type NgxsOnInit, NgxsSimpleChange, NgxsUnhandledActionsLogger, type NgxsUnhandledErrorContext, NgxsUnhandledErrorHandler, NoopNgxsExecutionStrategy, type PropertySelectors, Select, Selector, type SelectorMap, SelectorOptions, State, type StateContext, Store, type TypedSelector, createDispatchMap, createModelSelector, createPickSelector, createPropertySelectors, createSelectMap, createSelector, dispatch, ofAction, ofActionCanceled, ofActionCompleted, ofActionDispatched, ofActionErrored, ofActionSuccessful, provideStates, provideStore, select, withNgxsDevelopmentOptions, withNgxsPendingTasks, withNgxsPlugin, withNgxsPreboot, NgxsFeatureModule as ɵNgxsFeatureModule, NgxsRootModule as ɵNgxsRootModule, type ɵSelectorDef, type ɵSelectorFunc, type ɵSelectorReturnType, type ɵStateSelector, ɵprovideNgxsInternalStateTokens };
+export { Action, ActionDirector, ActionStatus, Actions, NgxsConfig, NgxsDevelopmentModule, NgxsModule, NgxsSimpleChange, NgxsUnhandledActionsLogger, NgxsUnhandledErrorHandler, Selector, SelectorOptions, State, Store, createDispatchMap, createModelSelector, createPickSelector, createPropertySelectors, createSelectMap, createSelector, dispatch, lazyProvider, ofAction, ofActionCanceled, ofActionCompleted, ofActionDispatched, ofActionErrored, ofActionSuccessful, provideStates, provideStore, select, withNgxsDevelopmentOptions, withNgxsPendingTasks, withNgxsPlugin, withNgxsPreboot, NgxsFeatureModule as ɵNgxsFeatureModule, NgxsRootModule as ɵNgxsRootModule, ɵprovideNgxsInternalStateTokens };
+export type { ActionCompletion, ActionContext, ActionDef, ActionMap, ActionType, NgxsAfterBootstrap, NgxsDevelopmentOptions, NgxsModuleOptions, NgxsOnChanges, NgxsOnInit, NgxsUnhandledErrorContext, PropertySelectors, SelectorMap, StateContext, TypedSelector, ɵSelectorDef, ɵSelectorFunc, ɵSelectorReturnType, ɵStateSelector };

package/internals/index.d.ts

@@ -1,6 +1,6 @@
 import * as i0 from '@angular/core';
-import { InjectionToken, OnDestroy, Signal } from '@angular/core';
-import { ReplaySubject, Subject, BehaviorSubject, MonoTypeOperatorFunction } from 'rxjs';
+import { InjectionToken, Signal } from '@angular/core';
+import { Observable, BehaviorSubject, Subject, MonoTypeOperatorFunction } from 'rxjs';
 
 declare class StateToken<T = void> {
     private readonly _name;
@@ -136,7 +136,7 @@ declare class ɵInitialState {
 }
 declare const ɵINITIAL_STATE_TOKEN: InjectionToken<ɵPlainObject>;
 
-declare class ɵNgxsAppBootstrappedState extends ReplaySubject<boolean> {
+declare class ɵNgxsAppBootstrappedState extends BehaviorSubject<boolean> {
     constructor();
     bootstrap(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ɵNgxsAppBootstrappedState, never>;
@@ -194,12 +194,25 @@ declare function ɵwrapObserverCalls<TValue>(invokeFn: (fn: () => void) => void)
  * BehaviorSubject of the entire state.
  * @ignore
  */
-declare class ɵStateStream extends ɵOrderedBehaviorSubject<ɵPlainObject> implements OnDestroy {
+declare class ɵStateStream extends ɵOrderedBehaviorSubject<ɵPlainObject> {
     readonly state: Signal<ɵPlainObject>;
     constructor();
-    ngOnDestroy(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<ɵStateStream, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ɵStateStream>;
 }
 
-export { StateToken, type ɵActionHandlerMetaData, type ɵActionOptions, type ɵExtractTokenType, ɵINITIAL_STATE_TOKEN, ɵInitialState, ɵMETA_KEY, ɵMETA_OPTIONS_KEY, type ɵMetaDataModel, ɵNGXS_STATE_CONTEXT_FACTORY, ɵNGXS_STATE_FACTORY, ɵNgxsAppBootstrappedState, ɵOrderedBehaviorSubject, ɵOrderedSubject, type ɵPlainObject, type ɵPlainObjectOf, type ɵRuntimeSelectorContext, ɵSELECTOR_META_KEY, type ɵSelectFromRootState, type ɵSelectorFactory, type ɵSelectorMetaDataModel, type ɵSharedSelectorOptions, type ɵStateClass, type ɵStateClassInternal, ɵStateStream, type ɵStateToken, type ɵStoreOptions, type ɵTokenName, ɵensureSelectorMetadata, ɵensureStoreMetadata, ɵgetSelectorMetadata, ɵgetStoreMetadata, ɵmemoize, ɵwrapObserverCalls };
+declare const ɵhasOwnProperty: (target: any, key: PropertyKey) => boolean;
+declare const ɵdefineProperty: <T>(o: T, p: PropertyKey, attributes: PropertyDescriptor & ThisType<any>) => T;
+
+type ActionHandlerFn = (action: any) => Observable<unknown>;
+declare class ɵNgxsActionRegistry {
+    private readonly _actionTypeToHandlersMap;
+    constructor();
+    get(type: string): Set<ActionHandlerFn> | undefined;
+    register(type: string, handler: ActionHandlerFn): () => void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ɵNgxsActionRegistry, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ɵNgxsActionRegistry>;
+}
+
+export { StateToken, ɵINITIAL_STATE_TOKEN, ɵInitialState, ɵMETA_KEY, ɵMETA_OPTIONS_KEY, ɵNGXS_STATE_CONTEXT_FACTORY, ɵNGXS_STATE_FACTORY, ɵNgxsActionRegistry, ɵNgxsAppBootstrappedState, ɵOrderedBehaviorSubject, ɵOrderedSubject, ɵSELECTOR_META_KEY, ɵStateStream, ɵdefineProperty, ɵensureSelectorMetadata, ɵensureStoreMetadata, ɵgetSelectorMetadata, ɵgetStoreMetadata, ɵhasOwnProperty, ɵmemoize, ɵwrapObserverCalls };
+export type { ɵActionHandlerMetaData, ɵActionOptions, ɵExtractTokenType, ɵMetaDataModel, ɵPlainObject, ɵPlainObjectOf, ɵRuntimeSelectorContext, ɵSelectFromRootState, ɵSelectorFactory, ɵSelectorMetaDataModel, ɵSharedSelectorOptions, ɵStateClass, ɵStateClassInternal, ɵStateToken, ɵStoreOptions, ɵTokenName };

package/internals/testing/index.d.ts

@@ -1,5 +1,6 @@
-import { Store, NgxsModuleOptions } from '@ngxs/store';
-import { ModuleWithProviders } from '@angular/core';
+import { NgxsModuleOptions, Store } from '@ngxs/store';
+import * as i0 from '@angular/core';
+import { EnvironmentProviders, ModuleWithProviders } from '@angular/core';
 import { TestBedStatic } from '@angular/core/testing';
 import { ɵStateClass as _StateClass } from '@ngxs/store/internals';
 
@@ -28,4 +29,46 @@ type ConsoleRecorder = ConsoleRecord[];
 declare function loggedError(message: string): ConsoleRecord;
 declare function skipConsoleLogging<T extends (...args: any[]) => any>(fn: T, consoleRecorder?: ConsoleRecorder): ReturnType<T>;
 
-export { type ConsoleRecord, type ConsoleRecorder, NgxsTestBed, type NgxsTesting, freshPlatform, loggedError, skipConsoleLogging };
+declare class NgxsActionCollector {
+    /**
+     * Including this in your providers will
+     * set up the the action collector to start collecting actions
+     * from before NGXS initializes
+     * @example
+     * // In your providers declaration for your tests:
+     * {
+     *   providers: [
+     *     NgxsActionCollector.collectActions(),
+     *     provideStore([MyState]),
+     *   ],
+     *   // ...
+     * }
+     * // and then in your test:
+     * const actionCollector = TestBed.inject(NgxsActionCollector);
+     * const actionsDispatched = actionCollector.dispatched;
+     * const action = actionsDispatched.find(
+     *   (item) => item instanceof MyAction
+     * );
+     * expect(action).toBeDefined();
+     * @returns An environment initializer that starts the collector immediately
+     */
+    static collectActions(): EnvironmentProviders;
+    private _destroyed$;
+    private _stopped$;
+    private _started;
+    readonly dispatched: any[];
+    readonly completed: any[];
+    readonly successful: any[];
+    readonly errored: any[];
+    readonly cancelled: any[];
+    private _actions$;
+    constructor();
+    start(): void;
+    reset(): void;
+    stop(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsActionCollector, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NgxsActionCollector>;
+}
+
+export { NgxsActionCollector, NgxsTestBed, freshPlatform, loggedError, skipConsoleLogging };
+export type { ConsoleRecord, ConsoleRecorder, NgxsTesting };

package/operators/index.d.ts

@@ -62,8 +62,8 @@ declare function append<T>(items: NoInfer<T[]>): StateOperator<T[]>;
 declare function compose<T>(...operators: NoInfer<StateOperator<T>[]>): StateOperator<T>;
 
 type Predicate<T = any> = (value: T | Readonly<T>) => boolean;
-declare function isStateOperator<T>(value: T | StateOperator<T>): value is StateOperator<T>;
-declare function isPredicate<T>(value: Predicate<T> | boolean | number): value is Predicate<T>;
+declare const isStateOperator: <T>(value: T | StateOperator<T>) => value is StateOperator<T>;
+declare const isPredicate: <T>(value: Predicate<T> | boolean | number) => value is Predicate<T>;
 
 /**
  * @param condition - Condition can be a plain boolean value or a function,
@@ -99,4 +99,5 @@ declare function updateItem<T>(selector: number | NoInfer<Predicate<T>>, operato
  */
 declare function removeItem<T>(selector: number | NoInfer<Predicate<T>>): StateOperator<T[]>;
 
-export { type ExistingState, type NoInfer, type Predicate, type StateOperator, append, compose, iif, insertItem, isPredicate, isStateOperator, patch, removeItem, updateItem, type ɵPatchSpec };
+export { append, compose, iif, insertItem, isPredicate, isStateOperator, patch, removeItem, updateItem };
+export type { ExistingState, NoInfer, Predicate, StateOperator, ɵPatchSpec };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@ngxs/store",
-  "version": "19.0.0",
+  "version": "20.0.0-dev.master-0db0003",
   "license": "MIT",
   "sideEffects": false,
   "peerDependencies": {
-    "@angular/core": ">=19.0.0 <20.0.0",
+    "@angular/core": ">=20.0.0 <21.0.0",
     "rxjs": ">=7.0.0"
   },
   "schematics": "./schematics/collection.json",
@@ -26,14 +26,14 @@
       "types": "./internals/index.d.ts",
       "default": "./fesm2022/ngxs-store-internals.mjs"
     },
-    "./plugins": {
-      "types": "./plugins/index.d.ts",
-      "default": "./fesm2022/ngxs-store-plugins.mjs"
-    },
     "./operators": {
       "types": "./operators/index.d.ts",
       "default": "./fesm2022/ngxs-store-operators.mjs"
     },
+    "./plugins": {
+      "types": "./plugins/index.d.ts",
+      "default": "./fesm2022/ngxs-store-plugins.mjs"
+    },
     "./internals/testing": {
       "types": "./internals/testing/index.d.ts",
       "default": "./fesm2022/ngxs-store-internals-testing.mjs"
@@ -85,4 +85,4 @@
     "type": "opencollective",
     "url": "https://opencollective.com/ngxs"
   }
-}
+}

package/plugins/index.d.ts

@@ -66,4 +66,5 @@ declare const setValue: (obj: any, prop: string, val: any) => any;
  */
 declare const getValue: (obj: any, prop: string) => any;
 
-export { InitState, NGXS_PLUGINS, type NgxsNextPluginFn, type NgxsPlugin, type NgxsPluginFn, UpdateState, actionMatcher, getActionTypeFromInstance, getValue, setValue, ɵisPluginClass };
+export { InitState, NGXS_PLUGINS, UpdateState, actionMatcher, getActionTypeFromInstance, getValue, setValue, ɵisPluginClass };
+export type { NgxsNextPluginFn, NgxsPlugin, NgxsPluginFn };

package/schematics/src/utils/versions.json

@@ -1,3 +1,3 @@
 {
-  "@ngxs/store": "19.0.0"
+  "@ngxs/store": "20.0.0"
 }

package/experimental/package.json

@@ -1,3 +0,0 @@
-{
-  "module": "../fesm2022/ngxs-store-experimental.mjs"
-}

package/internals/package.json

@@ -1,3 +0,0 @@
-{
-  "module": "../fesm2022/ngxs-store-internals.mjs"
-}

package/internals/testing/package.json

@@ -1,3 +0,0 @@
-{
-  "module": "../../fesm2022/ngxs-store-internals-testing.mjs"
-}

package/operators/package.json

@@ -1,3 +0,0 @@
-{
-  "module": "../fesm2022/ngxs-store-operators.mjs"
-}

package/plugins/package.json

@@ -1,3 +0,0 @@
-{
-  "module": "../fesm2022/ngxs-store-plugins.mjs"
-}