@ngxs/store 3.8.1-dev.master-5942e46 → 3.8.1-dev.master-9b1dc3e

package/fesm2020/ngxs-store.mjs

@@ -48,6 +48,18 @@ function getZoneWarningMessage() {
 function getUndecoratedStateInIvyWarningMessage(name) {
     return `'${name}' class should be decorated with @Injectable() right after the @State() decorator`;
 }
+function getInvalidInitializationOrderMessage(addedStates) {
+    let message = 'You have an invalid state initialization order. This typically occurs when `NgxsModule.forFeature`\n' +
+        'or `provideStates` is called before `NgxsModule.forRoot` or `provideStore`.\n' +
+        'One example is when `NgxsRouterPluginModule.forRoot` is called before `NgxsModule.forRoot`.';
+    if (addedStates) {
+        const stateNames = Object.keys(addedStates).map(stateName => `"${stateName}"`);
+        message +=
+            '\nFeature states added before the store initialization is complete: ' +
+                `${stateNames.join(', ')}.`;
+    }
+    return message;
+}
 function throwSelectFactoryNotConnectedError() {
     throw new Error('You have forgotten to import the NGXS module!');
 }
@@ -111,18 +123,18 @@ function verifyZoneIsNotNooped(ngZone) {
     console.warn(getZoneWarningMessage());
 }
 
-const NG_DEV_MODE$3 = typeof ngDevMode === 'undefined' || ngDevMode;
+const NG_DEV_MODE$4 = typeof ngDevMode === 'undefined' || ngDevMode;
 /**
  * Consumers have the option to utilize the execution strategy provided by
  * `NgxsModule.forRoot({executionStrategy})` or `provideStore([], {executionStrategy})`.
  */
-const CUSTOM_NGXS_EXECUTION_STRATEGY = new InjectionToken(NG_DEV_MODE$3 ? 'CUSTOM_NGXS_EXECUTION_STRATEGY' : '');
+const CUSTOM_NGXS_EXECUTION_STRATEGY = new InjectionToken(NG_DEV_MODE$4 ? 'CUSTOM_NGXS_EXECUTION_STRATEGY' : '');
 /**
  * The injection token is used internally to resolve an instance of the execution
  * strategy. It checks whether consumers have provided their own `executionStrategy`
  * and also verifies if we are operating in a zone-aware environment.
  */
-const NGXS_EXECUTION_STRATEGY = new InjectionToken(NG_DEV_MODE$3 ? 'NGXS_EXECUTION_STRATEGY' : '', {
+const NGXS_EXECUTION_STRATEGY = new InjectionToken(NG_DEV_MODE$4 ? 'NGXS_EXECUTION_STRATEGY' : '', {
     providedIn: 'root',
     factory: () => {
         const injector = inject(INJECTOR);
@@ -515,21 +527,21 @@ const mergeDeep = (base, ...sources) => {
     return mergeDeep(base, ...sources);
 };
 
-const NG_DEV_MODE$2 = typeof ngDevMode === 'undefined' || ngDevMode;
+const NG_DEV_MODE$3 = typeof ngDevMode === 'undefined' || ngDevMode;
 // The injection token is used to resolve a list of states provided at
 // the root level through either `NgxsModule.forRoot` or `provideStore`.
-const ROOT_STATE_TOKEN = new InjectionToken(NG_DEV_MODE$2 ? 'ROOT_STATE_TOKEN' : '');
+const ROOT_STATE_TOKEN = new InjectionToken(NG_DEV_MODE$3 ? 'ROOT_STATE_TOKEN' : '');
 // The injection token is used to resolve a list of states provided at
 // the feature level through either `NgxsModule.forFeature` or `provideStates`.
 // The Array<Array> is used to overload the resolved value of the token because
 // it is a multi-provider token.
-const FEATURE_STATE_TOKEN = new InjectionToken(NG_DEV_MODE$2 ? 'FEATURE_STATE_TOKEN' : '');
+const FEATURE_STATE_TOKEN = new InjectionToken(NG_DEV_MODE$3 ? 'FEATURE_STATE_TOKEN' : '');
 // The injection token is used to resolve to custom NGXS plugins provided
 // at the root level through either `{provide}` scheme or `withNgxsPlugin`.
-const NGXS_PLUGINS = new InjectionToken(NG_DEV_MODE$2 ? 'NGXS_PLUGINS' : '');
+const NGXS_PLUGINS = new InjectionToken(NG_DEV_MODE$3 ? 'NGXS_PLUGINS' : '');
 // The injection token is used to resolve to options provided at the root
 // level through either `NgxsModule.forRoot` or `provideStore`.
-const NGXS_OPTIONS = new InjectionToken(NG_DEV_MODE$2 ? 'NGXS_OPTIONS' : '');
+const NGXS_OPTIONS = new InjectionToken(NG_DEV_MODE$3 ? 'NGXS_OPTIONS' : '');
 /**
  * The NGXS config settings.
  */
@@ -1380,7 +1392,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.4", ngImpor
                     args: [NGXS_DEVELOPMENT_OPTIONS]
                 }] }]; } });
 
-const NG_DEV_MODE$1 = typeof ngDevMode === 'undefined' || ngDevMode;
+const NG_DEV_MODE$2 = typeof ngDevMode === 'undefined' || ngDevMode;
 /**
  * The `StateFactory` class adds root and feature states to the graph.
  * This extracts state names from state classes, checks if they already
@@ -1472,7 +1484,7 @@ class StateFactory {
      * Add a new state to the global defs.
      */
     add(stateClasses) {
-        if (NG_DEV_MODE$1) {
+        if (NG_DEV_MODE$2) {
             ensureStatesAreDecorated(stateClasses);
         }
         const { newStates } = this.addToStatesMap(stateClasses);
@@ -1492,7 +1504,7 @@ class StateFactory {
             // `State` decorator. This check is moved here because the `ɵprov` property
             // will not exist on the class in JIT mode (because it's set asynchronously
             // during JIT compilation through `Object.defineProperty`).
-            if (NG_DEV_MODE$1) {
+            if (NG_DEV_MODE$2) {
                 ensureStateClassIsInjectable(stateClass);
             }
             const stateMap = {
@@ -1594,7 +1606,7 @@ class StateFactory {
         }
         // The `NgxsUnhandledActionsLogger` is a tree-shakable class which functions
         // only during development.
-        if (NG_DEV_MODE$1 && !actionHasBeenHandled) {
+        if (NG_DEV_MODE$2 && !actionHasBeenHandled) {
             const unhandledActionsLogger = this._injector.get(NgxsUnhandledActionsLogger, null);
             // The `NgxsUnhandledActionsLogger` will not be resolved by the injector if the
             // `NgxsDevelopmentModule` is not provided. It's enough to check whether the `injector.get`
@@ -1613,7 +1625,7 @@ class StateFactory {
         const statesMap = this.statesByName;
         for (const stateClass of stateClasses) {
             const stateName = getStoreMetadata$1(stateClass).name;
-            if (NG_DEV_MODE$1) {
+            if (NG_DEV_MODE$2) {
                 ensureStateNameIsUnique(stateName, stateClass, statesMap);
             }
             const unmountedState = !statesMap[stateName];
@@ -1767,6 +1779,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "15.2.4", ngImpor
             args: [{ providedIn: 'root' }]
         }], ctorParameters: function () { return [{ type: Store }, { type: NgxsConfig }]; } });
 
+const NG_DEV_MODE$1 = typeof ngDevMode === 'undefined' || ngDevMode;
 class LifecycleStateManager {
     constructor(_store, _internalErrorReporter, _internalStateOperations, _stateContextFactory, _bootstrapper) {
         this._store = _store;
@@ -1780,6 +1793,21 @@ class LifecycleStateManager {
         this._destroy$.next();
     }
     ngxsBootstrap(action, results) {
+        if (NG_DEV_MODE$1) {
+            if (action instanceof InitState) {
+                this._initStateHasBeenDispatched = true;
+            }
+            else if (
+            // This is a dev mode-only check that ensures the correct order of
+            // state initialization. The `NgxsModule.forRoot` or `provideStore` should
+            // always come first, followed by `forFeature` and `provideStates`. If the
+            // `UpdateState` is dispatched before the `InitState` is dispatched, it indicates
+            // that modules or providers are in an invalid order.
+            action instanceof UpdateState &&
+                !this._initStateHasBeenDispatched) {
+                console.error(getInvalidInitializationOrderMessage(action.addedStates));
+            }
+        }
         this._internalStateOperations
             .getRootStateOperations()
             .dispatch(action)