@ngxs/store 3.7.3-dev.master-5175b98 → 3.7.3

package/src/symbols.d.ts

@@ -1,135 +1,137 @@
-import { InjectionToken, Type } from '@angular/core';
-import { Observable } from 'rxjs';
-import { PlainObject, StateClass } from '@ngxs/store/internals';
-import { SharedSelectorOptions } from './internal/internals';
-import { NgxsExecutionStrategy } from './execution/symbols';
-import { StateToken } from './state-token/state-token';
-export declare const ROOT_STATE_TOKEN: InjectionToken<any>;
-export declare const FEATURE_STATE_TOKEN: InjectionToken<any>;
-export declare const NGXS_PLUGINS: InjectionToken<{}>;
-export declare const META_KEY = "NGXS_META";
-export declare const META_OPTIONS_KEY = "NGXS_OPTIONS_META";
-export declare const SELECTOR_META_KEY = "NGXS_SELECTOR_META";
-export declare type NgxsLifeCycle = Partial<NgxsOnChanges> & Partial<NgxsOnInit> & Partial<NgxsAfterBootstrap>;
-export declare type NgxsPluginFn = (state: any, mutation: any, next: NgxsNextPluginFn) => any;
-/**
- * The NGXS config settings.
- */
-export declare class NgxsConfig {
-    /**
-     * Run in development mode. This will add additional debugging features:
-     * - Object.freeze on the state and actions to guarantee immutability
-     * (default: false)
-     */
-    developmentMode: boolean;
-    compatibility: {
-        /**
-         * Support a strict Content Security Policy.
-         * This will circumvent some optimisations that violate a strict CSP through the use of `new Function(...)`.
-         * (default: false)
-         */
-        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:
-     *   `@Select(...)`, `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 the default state before module initialization
-     * This is convenient if we need to create a define our own set of states.
-     * @deprecated will be removed after v4
-     * (default: {})
-     */
-    defaultsState: PlainObject;
-    /**
-     * Defining shared selector options
-     */
-    selectorOptions: SharedSelectorOptions;
-    constructor();
-}
-export declare type StateOperator<T> = (existing: Readonly<T>) => T;
-/**
- * State context provided to the actions in the state.
- */
-export interface StateContext<T> {
-    /**
-     * Get the current state.
-     */
-    getState(): T;
-    /**
-     * Reset the state to a new value.
-     */
-    setState(val: T | StateOperator<T>): T;
-    /**
-     * Patch the existing state with the provided value.
-     */
-    patchState(val: Partial<T>): T;
-    /**
-     * Dispatch a new action and return the dispatched observable.
-     */
-    dispatch(actions: any | any[]): Observable<void>;
-}
-export declare type NgxsNextPluginFn = (state: any, mutation: any) => any;
-/**
- * Plugin interface
- */
-export interface NgxsPlugin {
-    /**
-     * Handle the state/action before its submitted to the state handlers.
-     */
-    handle(state: any, action: any, next: NgxsNextPluginFn): any;
-}
-/**
- * Options that can be provided to the store.
- */
-export interface StoreOptions<T> {
-    /**
-     * Name of the state. Required.
-     */
-    name: string | StateToken<T>;
-    /**
-     * Default values for the state. If not provided, uses empty object.
-     */
-    defaults?: T;
-    /**
-     * Sub states for the given state.
-     */
-    children?: StateClass[];
-}
-/**
- * Represents a basic change from a previous to a new value for a single state instance.
- * Passed as a value in a NgxsSimpleChanges object to the ngxsOnChanges hook.
- */
-export declare class NgxsSimpleChange<T = any> {
-    readonly previousValue: T;
-    readonly currentValue: T;
-    readonly firstChange: boolean;
-    constructor(previousValue: T, currentValue: T, firstChange: boolean);
-}
-/**
- * On init interface
- */
-export interface NgxsOnInit {
-    ngxsOnInit(ctx?: StateContext<any>): void | any;
-}
-/**
- * On change interface
- */
-export interface NgxsOnChanges {
-    ngxsOnChanges(change: NgxsSimpleChange): void;
-}
-/**
- * After bootstrap interface
- */
-export interface NgxsAfterBootstrap {
-    ngxsAfterBootstrap(ctx?: StateContext<any>): void;
-}
-export declare type NgxsModuleOptions = Partial<NgxsConfig>;
+import { InjectionToken, Type } from '@angular/core';
+import { Observable } from 'rxjs';
+import { PlainObject, StateClass } from '@ngxs/store/internals';
+import { SharedSelectorOptions, Callback } from './internal/internals';
+import { NgxsExecutionStrategy } from './execution/symbols';
+import { StateToken } from './state-token/state-token';
+export declare const ROOT_STATE_TOKEN: InjectionToken<any>;
+export declare const FEATURE_STATE_TOKEN: InjectionToken<any>;
+export declare const NGXS_PLUGINS: InjectionToken<{}>;
+export declare const NG_TEST_MODE: InjectionToken<Callback<boolean, any>>;
+export declare const NG_DEV_MODE: InjectionToken<Callback<boolean, any>>;
+export declare const META_KEY = "NGXS_META";
+export declare const META_OPTIONS_KEY = "NGXS_OPTIONS_META";
+export declare const SELECTOR_META_KEY = "NGXS_SELECTOR_META";
+export declare type NgxsLifeCycle = Partial<NgxsOnChanges> & Partial<NgxsOnInit> & Partial<NgxsAfterBootstrap>;
+export declare type NgxsPluginFn = (state: any, mutation: any, next: NgxsNextPluginFn) => any;
+/**
+ * The NGXS config settings.
+ */
+export declare class NgxsConfig {
+    /**
+     * Run in development mode. This will add additional debugging features:
+     * - Object.freeze on the state and actions to guarantee immutability
+     * (default: false)
+     */
+    developmentMode: boolean;
+    compatibility: {
+        /**
+         * Support a strict Content Security Policy.
+         * This will circumvent some optimisations that violate a strict CSP through the use of `new Function(...)`.
+         * (default: false)
+         */
+        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:
+     *   `@Select(...)`, `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 the default state before module initialization
+     * This is convenient if we need to create a define our own set of states.
+     * @deprecated will be removed after v4
+     * (default: {})
+     */
+    defaultsState: PlainObject;
+    /**
+     * Defining shared selector options
+     */
+    selectorOptions: SharedSelectorOptions;
+    constructor();
+}
+export declare type StateOperator<T> = (existing: Readonly<T>) => T;
+/**
+ * State context provided to the actions in the state.
+ */
+export interface StateContext<T> {
+    /**
+     * Get the current state.
+     */
+    getState(): T;
+    /**
+     * Reset the state to a new value.
+     */
+    setState(val: T | StateOperator<T>): T;
+    /**
+     * Patch the existing state with the provided value.
+     */
+    patchState(val: Partial<T>): T;
+    /**
+     * Dispatch a new action and return the dispatched observable.
+     */
+    dispatch(actions: any | any[]): Observable<void>;
+}
+export declare type NgxsNextPluginFn = (state: any, mutation: any) => any;
+/**
+ * Plugin interface
+ */
+export interface NgxsPlugin {
+    /**
+     * Handle the state/action before its submitted to the state handlers.
+     */
+    handle(state: any, action: any, next: NgxsNextPluginFn): any;
+}
+/**
+ * Options that can be provided to the store.
+ */
+export interface StoreOptions<T> {
+    /**
+     * Name of the state. Required.
+     */
+    name: string | StateToken<T>;
+    /**
+     * Default values for the state. If not provided, uses empty object.
+     */
+    defaults?: T;
+    /**
+     * Sub states for the given state.
+     */
+    children?: StateClass[];
+}
+/**
+ * Represents a basic change from a previous to a new value for a single state instance.
+ * Passed as a value in a NgxsSimpleChanges object to the ngxsOnChanges hook.
+ */
+export declare class NgxsSimpleChange<T = any> {
+    readonly previousValue: T;
+    readonly currentValue: T;
+    readonly firstChange: boolean;
+    constructor(previousValue: T, currentValue: T, firstChange: boolean);
+}
+/**
+ * On init interface
+ */
+export interface NgxsOnInit {
+    ngxsOnInit(ctx?: StateContext<any>): void | any;
+}
+/**
+ * On change interface
+ */
+export interface NgxsOnChanges {
+    ngxsOnChanges(change: NgxsSimpleChange): void;
+}
+/**
+ * After bootstrap interface
+ */
+export interface NgxsAfterBootstrap {
+    ngxsAfterBootstrap(ctx?: StateContext<any>): void;
+}
+export declare type NgxsModuleOptions = Partial<NgxsConfig>;

package/src/utils/compose.d.ts

@@ -1,23 +1,23 @@
-export declare type StateFn = (...args: any[]) => any;
-/**
- * Composes a array of functions from left to right. Example:
- *
- *      compose([fn, final])(state, action);
- *
- * then the funcs have a signature like:
- *
- *      function fn (state, action, next) {
- *          console.log('here', state, action, next);
- *          return next(state, action);
- *      }
- *
- *      function final (state, action) {
- *          console.log('here', state, action);
- *          return state;
- *      }
- *
- * the last function should not call `next`.
- *
- * @ignore
- */
-export declare const compose: (funcs: StateFn[]) => (...args: any[]) => any;
+export declare type StateFn = (...args: any[]) => any;
+/**
+ * Composes a array of functions from left to right. Example:
+ *
+ *      compose([fn, final])(state, action);
+ *
+ * then the funcs have a signature like:
+ *
+ *      function fn (state, action, next) {
+ *          console.log('here', state, action, next);
+ *          return next(state, action);
+ *      }
+ *
+ *      function final (state, action) {
+ *          console.log('here', state, action);
+ *          return state;
+ *      }
+ *
+ * the last function should not call `next`.
+ *
+ * @ignore
+ */
+export declare const compose: (funcs: StateFn[]) => (...args: any[]) => any;

package/src/utils/freeze.d.ts

@@ -1,5 +1,5 @@
-/**
- * Object freeze code
- * https://github.com/jsdf/deep-freeze
- */
-export declare const deepFreeze: (o: any) => any;
+/**
+ * Object freeze code
+ * https://github.com/jsdf/deep-freeze
+ */
+export declare const deepFreeze: (o: any) => any;

package/src/utils/selector-utils.d.ts

@@ -1,23 +1,23 @@
-import { SharedSelectorOptions, SelectorFactory } from '../internal/internals';
-export declare const selectorOptionsMetaAccessor: {
-    getOptions: (target: any) => SharedSelectorOptions;
-    defineOptions: (target: any, options: SharedSelectorOptions) => void;
-};
-interface CreationMetadata {
-    containerClass: any;
-    selectorName: string;
-    getSelectorOptions?: () => SharedSelectorOptions;
-}
-/**
- * Function for creating a selector
- * @param selectors The selectors to use to create the arguments of this function
- * @param originalFn The original function being made into a selector
- * @param creationMetadata
- */
-export declare function createSelector<T extends (...args: any[]) => any>(selectors: any[] | undefined, originalFn: T, creationMetadata?: CreationMetadata): T;
-/**
- * This function gets the factory function to create the selector to get the selected slice from the app state
- * @ignore
- */
-export declare function getRootSelectorFactory(selector: any): SelectorFactory;
-export {};
+import { SharedSelectorOptions, SelectorFactory } from '../internal/internals';
+export declare const selectorOptionsMetaAccessor: {
+    getOptions: (target: any) => SharedSelectorOptions;
+    defineOptions: (target: any, options: SharedSelectorOptions) => void;
+};
+interface CreationMetadata {
+    containerClass: any;
+    selectorName: string;
+    getSelectorOptions?: () => SharedSelectorOptions;
+}
+/**
+ * Function for creating a selector
+ * @param selectors The selectors to use to create the arguments of this function
+ * @param originalFn The original function being made into a selector
+ * @param creationMetadata
+ */
+export declare function createSelector<T extends (...args: any[]) => any>(selectors: any[] | undefined, originalFn: T, creationMetadata?: CreationMetadata): T;
+/**
+ * This function gets the factory function to create the selector to get the selected slice from the app state
+ * @ignore
+ */
+export declare function getRootSelectorFactory(selector: any): SelectorFactory;
+export {};

package/src/utils/store-validators.d.ts

@@ -1,7 +1,8 @@
-import { StateClassInternal, StatesByName } from '../internal/internals';
-export declare abstract class StoreValidators {
-    private static stateNameRegex;
-    static checkThatStateIsNamedCorrectly(name: string | null): void | never;
-    static checkThatStateNameIsUnique(stateName: string, state: StateClassInternal, statesByName: StatesByName): void | never;
-    static checkThatStateClassesHaveBeenDecorated(stateClasses: StateClassInternal[]): void | never;
-}
+import { MetaDataModel, StateClassInternal, StatesByName } from '../internal/internals';
+export declare abstract class StoreValidators {
+    static stateNameRegex: RegExp;
+    static stateNameErrorMessage(name: string): string;
+    static checkCorrectStateName(name: string | null): void;
+    static checkStateNameIsUnique(state: StateClassInternal, statesByName: StatesByName): string;
+    static getValidStateMeta(state: StateClassInternal): MetaDataModel;
+}

package/src/utils/utils.d.ts

@@ -1,46 +1,46 @@
-/**
- * Returns the type from an action instance/class.
- * @ignore
- */
-export declare function getActionTypeFromInstance(action: any): string | undefined;
-/**
- * Matches a action
- * @ignore
- */
-export declare function actionMatcher(action1: any): (action2: any) => boolean;
-/**
- * Set a deeply nested value. Example:
- *
- *   setValue({ foo: { bar: { eat: false } } },
- *      'foo.bar.eat', true) //=> { foo: { bar: { eat: true } } }
- *
- * While it traverses it also creates new objects from top down.
- *
- * @ignore
- */
-export declare const setValue: (obj: any, prop: string, val: any) => any;
-/**
- * Get a deeply nested value. Example:
- *
- *    getValue({ foo: bar: [] }, 'foo.bar') //=> []
- *
- * @ignore
- */
-export declare const getValue: (obj: any, prop: string) => any;
-/**
- * Simple object check.
- *
- *    isObject({a:1}) //=> true
- *    isObject(1) //=> false
- *
- * @ignore
- */
-export declare const isObject: (item: any) => boolean;
-/**
- * Deep merge two objects.
- *
- *    mergeDeep({a:1, b:{x: 1, y:2}}, {b:{x: 3}, c:4}) //=> {a:1, b:{x:3, y:2}, c:4}
- *
- * @param base base object onto which `sources` will be applied
- */
-export declare const mergeDeep: (base: any, ...sources: any[]) => any;
+/**
+ * Returns the type from an action instance/class.
+ * @ignore
+ */
+export declare function getActionTypeFromInstance(action: any): string | undefined;
+/**
+ * Matches a action
+ * @ignore
+ */
+export declare function actionMatcher(action1: any): (action2: any) => boolean;
+/**
+ * Set a deeply nested value. Example:
+ *
+ *   setValue({ foo: { bar: { eat: false } } },
+ *      'foo.bar.eat', true) //=> { foo: { bar: { eat: true } } }
+ *
+ * While it traverses it also creates new objects from top down.
+ *
+ * @ignore
+ */
+export declare const setValue: (obj: any, prop: string, val: any) => any;
+/**
+ * Get a deeply nested value. Example:
+ *
+ *    getValue({ foo: bar: [] }, 'foo.bar') //=> []
+ *
+ * @ignore
+ */
+export declare const getValue: (obj: any, prop: string) => any;
+/**
+ * Simple object check.
+ *
+ *    isObject({a:1}) //=> true
+ *    isObject(1) //=> false
+ *
+ * @ignore
+ */
+export declare const isObject: (item: any) => boolean;
+/**
+ * Deep merge two objects.
+ *
+ *    mergeDeep({a:1, b:{x: 1, y:2}}, {b:{x: 3}, c:4}) //=> {a:1, b:{x:3, y:2}, c:4}
+ *
+ * @param base base object onto which `sources` will be applied
+ */
+export declare const mergeDeep: (base: any, ...sources: any[]) => any;

package/types/index.d.ts

@@ -1,2 +1,2 @@
-/* file: packages/store/types/index.d.ts */
-// TypeScript Version: 3.4
+/* file: packages/store/types/index.d.ts */
+// TypeScript Version: 3.4