refactor: move metadata into internals (#2062)

This commit includes several updates:

1) Moves metadata interfaces and functions to the
`@ngxs/store/internals` subpackage.
2) Transfers interfaces and objects from `plugin_api.ts` to the
`@ngxs/store/plugins` subpackage.
3) Adds the `@deprecated` annotation to functions and types that were
exported from `public_to_deprecate.ts`.

packages/devtools-plugin/src/devtools.module.ts

@@ -5,7 +5,8 @@ import {
   EnvironmentProviders,
   makeEnvironmentProviders
 } from '@angular/core';
-import { NGXS_PLUGINS, withNgxsPlugin } from '@ngxs/store';
+import { withNgxsPlugin } from '@ngxs/store';
+import { NGXS_PLUGINS } from '@ngxs/store/plugins';
 
 import { NgxsDevtoolsOptions, NGXS_DEVTOOLS_OPTIONS } from './symbols';
 import { NgxsReduxDevtoolsPlugin } from './devtools.plugin';

packages/devtools-plugin/src/devtools.plugin.ts

@@ -1,11 +1,11 @@
 import { Inject, Injectable, Injector, NgZone, OnDestroy, ɵglobal } from '@angular/core';
+import { Store } from '@ngxs/store';
 import {
   InitState,
   getActionTypeFromInstance,
   NgxsNextPluginFn,
-  NgxsPlugin,
-  Store
-} from '@ngxs/store';
+  NgxsPlugin
+} from '@ngxs/store/plugins';
 import { tap, catchError } from 'rxjs/operators';
 
 import {

packages/form-plugin/src/directive.ts

@@ -1,6 +1,7 @@
 import { ChangeDetectorRef, Directive, Input, OnDestroy, OnInit } from '@angular/core';
 import { FormGroup, FormGroupDirective } from '@angular/forms';
-import { Actions, getValue, ofActionDispatched, Store } from '@ngxs/store';
+import { Actions, ofActionDispatched, Store } from '@ngxs/store';
+import { getValue } from '@ngxs/store/plugins';
 import { Observable, ReplaySubject } from 'rxjs';
 import { debounceTime, distinctUntilChanged, filter, takeUntil } from 'rxjs/operators';
 import {

packages/form-plugin/src/form.module.ts

@@ -4,7 +4,8 @@ import {
   EnvironmentProviders,
   makeEnvironmentProviders
 } from '@angular/core';
-import { NGXS_PLUGINS, withNgxsPlugin } from '@ngxs/store';
+import { withNgxsPlugin } from '@ngxs/store';
+import { NGXS_PLUGINS } from '@ngxs/store/plugins';
 
 import { NgxsFormPlugin } from './form.plugin';
 import { NgxsFormDirective } from './directive';

packages/form-plugin/src/form.plugin.ts

@@ -5,7 +5,7 @@ import {
   NgxsNextPluginFn,
   NgxsPlugin,
   setValue
-} from '@ngxs/store';
+} from '@ngxs/store/plugins';
 import {
   ResetForm,
   SetFormDirty,

packages/hmr-plugin/src/hmr-manager.ts

@@ -1,5 +1,5 @@
 import { ApplicationRef, ComponentRef, NgModuleRef } from '@angular/core';
-import { InitialState, NgxsBootstrapper } from '@ngxs/store/internals';
+import { ɵInitialState, ɵNgxsAppBootstrappedState } from '@ngxs/store/internals';
 
 import { HmrStorage } from './internal/hmr-storage';
 import {
@@ -31,22 +31,22 @@ export class HmrManager<T extends Partial<NgxsHmrLifeCycle<S>>, S = NgxsHmrSnaps
     return this.ngModule.injector.get(ApplicationRef);
   }
 
-  private get bootstrap(): NgxsBootstrapper {
-    return this.ngModule.injector.get(NgxsBootstrapper);
+  private get appBootstrappedState() {
+    return this.ngModule.injector.get(ɵNgxsAppBootstrappedState);
   }
 
   public async hmrModule(
     bootstrapFn: BootstrapModuleFn<T>,
     tick: () => void
   ): Promise<NgModuleRef<T>> {
-    InitialState.set(this.storage.snapshot);
+    ɵInitialState.set(this.storage.snapshot);
     this.ngModule = await bootstrapFn();
     this.context = new HmrStateContextFactory(this.ngModule);
     this.lifecycle = this.createLifecycle();
 
     tick();
 
-    InitialState.pop();
+    ɵInitialState.pop();
     return this.ngModule;
   }
 
@@ -71,7 +71,7 @@ export class HmrManager<T extends Partial<NgxsHmrLifeCycle<S>>, S = NgxsHmrSnaps
   private createLifecycle(): HmrLifecycle<T, S> {
     return new HmrLifecycle(
       this.ngModule.instance,
-      this.bootstrap,
+      this.appBootstrappedState,
       this.storage,
       this.context,
       this.optionsBuilder

packages/hmr-plugin/src/internal/hmr-lifecycle.ts

@@ -1,4 +1,4 @@
-import { NgxsBootstrapper } from '@ngxs/store/internals';
+import { ɵNgxsAppBootstrappedState } from '@ngxs/store/internals';
 import { Observable, Subscription } from 'rxjs';
 import { StateContext } from '@ngxs/store';
 
@@ -11,7 +11,7 @@ import { HmrStorage } from './hmr-storage';
 export class HmrLifecycle<T extends Partial<NgxsHmrLifeCycle<S>>, S> {
   constructor(
     private ngAppModule: T,
-    private bootstrap: NgxsBootstrapper,
+    private appBootstrappedState: ɵNgxsAppBootstrappedState,
     private storage: HmrStorage<S>,
     private context: HmrStateContextFactory<T, S>,
     private options: HmrOptionBuilder
@@ -52,10 +52,9 @@ export class HmrLifecycle<T extends Partial<NgxsHmrLifeCycle<S>>, S> {
   private stateEventLoop(callback: HmrCallback<S>): void {
     if (!this.storage.hasData()) return;
 
-    const appBootstrapped$: Observable<boolean> = this.bootstrap.appBootstrapped$;
     const state$: Observable<any> = this.context.store.select(state => state);
 
-    appBootstrapped$.subscribe(() => {
+    this.appBootstrappedState.subscribe(() => {
       let eventId: number;
       const storeEventId: Subscription = state$.subscribe(() => {
         // setTimeout used for zone detection after set hmr state

packages/logger-plugin/src/action-logger.ts

@@ -1,4 +1,5 @@
-import { getActionTypeFromInstance, Store } from '@ngxs/store';
+import { Store } from '@ngxs/store';
+import { getActionTypeFromInstance } from '@ngxs/store/plugins';
 
 import { formatTime } from './internals';
 import { LogWriter } from './log-writer';

packages/logger-plugin/src/logger.module.ts

@@ -5,7 +5,9 @@ import {
   NgModule,
   makeEnvironmentProviders
 } from '@angular/core';
-import { NGXS_PLUGINS, withNgxsPlugin } from '@ngxs/store';
+import { withNgxsPlugin } from '@ngxs/store';
+import { NGXS_PLUGINS } from '@ngxs/store/plugins';
+
 import { NgxsLoggerPlugin } from './logger.plugin';
 import { NgxsLoggerPluginOptions, NGXS_LOGGER_PLUGIN_OPTIONS } from './symbols';
 

packages/logger-plugin/src/logger.plugin.ts

@@ -1,6 +1,8 @@
 import { Inject, Injectable, Injector } from '@angular/core';
-import { NgxsNextPluginFn, NgxsPlugin, Store } from '@ngxs/store';
+import { Store } from '@ngxs/store';
+import { NgxsNextPluginFn, NgxsPlugin } from '@ngxs/store/plugins';
 import { catchError, tap } from 'rxjs/operators';
+
 import { ActionLogger } from './action-logger';
 import { LogWriter } from './log-writer';
 import { NgxsLoggerPluginOptions, NGXS_LOGGER_PLUGIN_OPTIONS } from './symbols';

packages/storage-plugin/src/storage.module.ts

@@ -7,7 +7,8 @@ import {
   EnvironmentProviders,
   makeEnvironmentProviders
 } from '@angular/core';
-import { NGXS_PLUGINS, withNgxsPlugin } from '@ngxs/store';
+import { withNgxsPlugin } from '@ngxs/store';
+import { NGXS_PLUGINS } from '@ngxs/store/plugins';
 import {
   NgxsStoragePluginOptions,
   STORAGE_ENGINE,

packages/storage-plugin/src/storage.plugin.ts

@@ -1,6 +1,6 @@
 import { PLATFORM_ID, Inject, Injectable } from '@angular/core';
 import { isPlatformServer } from '@angular/common';
-import { PlainObject } from '@ngxs/store/internals';
+import { ɵPlainObject } from '@ngxs/store/internals';
 import {
   NgxsPlugin,
   setValue,
@@ -9,7 +9,7 @@ import {
   UpdateState,
   actionMatcher,
   NgxsNextPluginFn
-} from '@ngxs/store';
+} from '@ngxs/store/plugins';
 import {
   ɵDEFAULT_STATE_KEY,
   ɵFinalNgxsStoragePluginOptions,
@@ -124,7 +124,7 @@ export class NgxsStoragePlugin implements NgxsPlugin {
                   }
                   return accumulator;
                 },
-                <PlainObject>{}
+                <ɵPlainObject>{}
               );
             }
 

packages/store/src/internal/custom-rxjs-subjects.ts → packages/store/internals/src/custom-rxjs-subjects.ts

@@ -53,7 +53,7 @@ function orderedQueueOperation<TArgs extends any[]>(operation: (...args: TArgs)
  * When `subject` is a standard `Subject<T>` the second subscriber would recieve `end` and then `start`.
  * When `subject` is a `OrderedSubject<T>` the second subscriber would recieve `start` and then `end`.
  */
-export class OrderedSubject<T> extends Subject<T> {
+export class ɵOrderedSubject<T> extends Subject<T> {
   private _orderedNext = orderedQueueOperation((value?: T) => super.next(<T>value));
 
   next(value?: T): void {
@@ -76,7 +76,7 @@ export class OrderedSubject<T> extends Subject<T> {
  * When `subject` is a standard `BehaviorSubject<T>` the second subscriber would recieve `end` and then `start`.
  * When `subject` is a `OrderedBehaviorSubject<T>` the second subscriber would recieve `start` and then `end`.
  */
-export class OrderedBehaviorSubject<T> extends BehaviorSubject<T> {
+export class ɵOrderedBehaviorSubject<T> extends BehaviorSubject<T> {
   private _orderedNext = orderedQueueOperation((value: T) => super.next(value));
   private _currentValue: T;
 

packages/store/internals/src/index.ts

@@ -1,12 +1,9 @@
-export { NgxsBootstrapper } from './ngxs-bootstrapper';
-export { memoize } from './memoize';
-export { INITIAL_STATE_TOKEN, InitialState } from './initial-state';
-export {
-  PlainObjectOf,
-  PlainObject,
-  ɵStateClass,
-  ɵMETA_KEY,
-  ɵMETA_OPTIONS_KEY,
-  ɵSELECTOR_META_KEY
-} from './symbols';
+export * from './symbols';
+export * from './metadata';
+export { ɵmemoize } from './memoize';
+export { StateToken } from './state-token';
+export { ɵINITIAL_STATE_TOKEN, ɵInitialState } from './initial-state';
+export { ɵNgxsAppBootstrappedState } from './ngxs-app-bootstrapped-state';
 export { ɵNGXS_STATE_CONTEXT_FACTORY, ɵNGXS_STATE_FACTORY } from './internal-tokens';
+export { ɵOrderedSubject, ɵOrderedBehaviorSubject } from './custom-rxjs-subjects';
+export { ɵStateStream } from './state-stream';

packages/store/internals/src/initial-state.ts

@@ -1,29 +1,29 @@
 import { InjectionToken } from '@angular/core';
 
-import { PlainObject } from './symbols';
+import { ɵPlainObject } from './symbols';
 
 declare const ngDevMode: boolean;
 
 const NG_DEV_MODE = typeof ngDevMode === 'undefined' || ngDevMode;
 
-export class InitialState {
-  private static _value: PlainObject = {};
+export class ɵInitialState {
+  private static _value: ɵPlainObject = {};
 
-  static set(state: PlainObject) {
+  static set(state: ɵPlainObject) {
     this._value = state;
   }
 
-  static pop(): PlainObject {
+  static pop(): ɵPlainObject {
     const state = this._value;
     this._value = {};
     return state;
   }
 }
 
-export const INITIAL_STATE_TOKEN = new InjectionToken<PlainObject>(
+export const ɵINITIAL_STATE_TOKEN = new InjectionToken<ɵPlainObject>(
   NG_DEV_MODE ? 'INITIAL_STATE_TOKEN' : '',
   {
     providedIn: 'root',
-    factory: () => InitialState.pop()
+    factory: () => ɵInitialState.pop()
   }
 );

packages/store/internals/src/memoize.ts

@@ -28,7 +28,7 @@ function areArgumentsShallowlyEqual(
  *
  * @ignore
  */
-export function memoize<T extends (...args: any[]) => any>(
+export function ɵmemoize<T extends (...args: any[]) => any>(
   func: T,
   equalityCheck = defaultEqualityCheck
 ): T {

packages/store/internals/src/metadata.ts

@@ -0,0 +1,70 @@
+import {
+  ɵMETA_KEY,
+  ɵSELECTOR_META_KEY,
+  ɵMetaDataModel,
+  ɵStateClassInternal,
+  ɵSelectorMetaDataModel,
+  ɵRuntimeSelectorContext
+} from './symbols';
+
+/**
+ * Ensures metadata is attached to the class and returns it.
+ *
+ * @ignore
+ */
+export function ɵensureStoreMetadata(target: ɵStateClassInternal): ɵMetaDataModel {
+  if (!target.hasOwnProperty(ɵMETA_KEY)) {
+    const defaultMetadata: ɵMetaDataModel = {
+      name: null,
+      actions: {},
+      defaults: {},
+      path: null,
+      makeRootSelector(context: ɵRuntimeSelectorContext) {
+        return context.getStateGetter(defaultMetadata.name);
+      },
+      children: []
+    };
+
+    Object.defineProperty(target, ɵMETA_KEY, { value: defaultMetadata });
+  }
+  return ɵgetStoreMetadata(target);
+}
+
+/**
+ * Get the metadata attached to the state class if it exists.
+ *
+ * @ignore
+ */
+export function ɵgetStoreMetadata(target: ɵStateClassInternal): ɵMetaDataModel {
+  return target[ɵMETA_KEY]!;
+}
+
+/**
+ * Ensures metadata is attached to the selector and returns it.
+ *
+ * @ignore
+ */
+export function ɵensureSelectorMetadata(target: Function): ɵSelectorMetaDataModel {
+  if (!target.hasOwnProperty(ɵSELECTOR_META_KEY)) {
+    const defaultMetadata: ɵSelectorMetaDataModel = {
+      makeRootSelector: null,
+      originalFn: null,
+      containerClass: null,
+      selectorName: null,
+      getSelectorOptions: () => ({})
+    };
+
+    Object.defineProperty(target, ɵSELECTOR_META_KEY, { value: defaultMetadata });
+  }
+
+  return ɵgetSelectorMetadata(target);
+}
+
+/**
+ * Get the metadata attached to the selector if it exists.
+ *
+ * @ignore
+ */
+export function ɵgetSelectorMetadata(target: any): ɵSelectorMetaDataModel {
+  return target[ɵSELECTOR_META_KEY];
+}

packages/store/internals/src/ngxs-app-bootstrapped-state.ts

@@ -0,0 +1,14 @@
+import { Injectable } from '@angular/core';
+import { ReplaySubject } from 'rxjs';
+
+@Injectable({ providedIn: 'root' })
+export class ɵNgxsAppBootstrappedState extends ReplaySubject<boolean> {
+  constructor() {
+    super(1);
+  }
+
+  bootstrap(): void {
+    this.next(true);
+    this.complete();
+  }
+}