@ngxs/store 3.8.2-dev.master-67d50ea → 3.8.2-dev.master-728bfff

package/index.d.ts

@@ -1,6 +1,6 @@
 import * as i0 from '@angular/core';
 import { Type, ModuleWithProviders, OnDestroy, NgZone, Injector, Signal, EnvironmentProviders } from '@angular/core';
-import { ɵSharedSelectorOptions as _SharedSelectorOptions, ɵStateClass as _StateClass, ɵActionOptions as _ActionOptions, ɵPlainObjectOf as _PlainObjectOf, ɵStateClassInternal as _StateClassInternal, ɵActionHandlerMetaData as _ActionHandlerMetaData, ɵOrderedSubject as _OrderedSubject, ɵStateStream as _StateStream, ɵRuntimeSelectorContext as _RuntimeSelectorContext, StateToken, ɵStoreOptions as _StoreOptions, ɵExtractTokenType as _ExtractTokenType } from '@ngxs/store/internals';
+import { ɵSharedSelectorOptions as _SharedSelectorOptions, ɵStateClass as _StateClass, ɵActionOptions as _ActionOptions, ɵPlainObjectOf as _PlainObjectOf, ɵStateClassInternal as _StateClassInternal, ɵActionHandlerMetaData as _ActionHandlerMetaData, ɵOrderedSubject as _OrderedSubject, ɵStateStream as _StateStream, ɵRuntimeSelectorContext as _RuntimeSelectorContext, StateToken, ɵStoreOptions as _StoreOptions } from '@ngxs/store/internals';
 export { ɵActionOptions as ActionOptions, StateToken } from '@ngxs/store/internals';
 import * as rxjs from 'rxjs';
 import { Observable, Subject, Subscription, OperatorFunction } from 'rxjs';
@@ -507,8 +507,77 @@ declare function ofActionCompleted<T extends ActionType[]>(...allowedTypes: T):
  */
 declare function ofActionErrored<T extends ActionType[]>(...allowedTypes: T): OperatorFunction<ActionContext<Constructed<T[TupleKeys<T>]>>, ActionCompletion<Constructed<T[TupleKeys<T>]>>>;
 
-type SelectorSpec<T, U> = [T] extends [never] ? (...states: any[]) => any : T extends StateToken<any> ? (state: _ExtractTokenType<T>) => U : (...states: any[]) => any;
-type SelectorType<T> = <U>(target: any, key: string | symbol, descriptor: TypedPropertyDescriptor<SelectorSpec<T, U>>) => TypedPropertyDescriptor<SelectorSpec<T, U>> | void;
+/**
+ * Defines a tuple of selector functions, state tokens, and state classes that a selector decorated
+ * by `@Selector()` can depend on.
+ */
+type SelectorDefTuple = ɵSelectorDef<any>[] | [ɵSelectorDef<any>];
+type UnknownToAny<T> = unknown extends T ? any : T;
+type EnsureArray<T> = T extends any[] ? T : never;
+/**
+ * Given a tuple of selector functions, state tokens, state classes, etc., returns a tuple of what
+ * a dependent selector would expect to receive for that parent as an argument when called.
+ *
+ * For example, if the first element in `ParentsTuple` is a selector function that returns a
+ * `number`, then the first element of the result tuple will be `number`. If the second element
+ * in `ParentsTuple` is a state class with model `{ name: string }`, then the second element of
+ * the result tuple will be `{ name: string }`.
+ */
+type SelectorReturnTypeList<ParentsTuple extends SelectorDefTuple> = EnsureArray<{
+    [ParentsTupleIndex in keyof ParentsTuple]: ParentsTuple[ParentsTupleIndex] extends ɵSelectorDef<any> ? UnknownToAny<ɵSelectorReturnType<ParentsTuple[ParentsTupleIndex]>> : never;
+}>;
+/**
+ * Defines a selector function matching a given argument list of parent selectors/states/tokens
+ * and a given return type.
+ */
+type SelectorSpec<ParentsTuple, Return> = ParentsTuple extends [] ? () => any : ParentsTuple extends SelectorDefTuple ? (...states: SelectorReturnTypeList<ParentsTuple>) => Return : () => any;
+/**
+ * Defines a selector function matching `SelectorSpec<ParentsTuple, Return>` but with the assumption that the
+ * container state has been injected as the first argument.
+ */
+type SelectorSpecWithInjectedState<ParentsTuple, Return> = SelectorSpec<ParentsTuple extends SelectorDefTuple ? [any, ...ParentsTuple] : [any], ParentsTuple extends SelectorDefTuple ? Return : any>;
+/**
+ * Defines a property descriptor for the `@Selector` decorator that decorates a function with
+ * parent selectors/states/tokens `ParentsTuple` and return type `Return`.
+ */
+type DescriptorWithNoInjectedState<ParentsTuple, Return> = TypedPropertyDescriptor<SelectorSpec<ParentsTuple, Return>>;
+/**
+ * Same as `DescriptorWithNoInjectedState` but with state injected as the first argument.
+ */
+type DescriptorWithInjectedState<ParentsTuple, Return> = TypedPropertyDescriptor<SelectorSpecWithInjectedState<ParentsTuple, Return>>;
+type DecoratorArgs<Descriptor> = [target: any, key: string | symbol, descriptor?: Descriptor];
+/**
+ * Defines the return type of a call to `@Selector` when there is no argument given
+ * (e.g. `@Selector()` counts, but `@Selector([])` does not)
+ *
+ * This result is a decorator that can only be used to decorate a function with no arguments or a
+ * single argument that is the container state.
+ */
+type SelectorTypeNoDecoratorArgs = {
+    <Return>(...args: DecoratorArgs<DescriptorWithNoInjectedState<unknown, Return>>): void | DescriptorWithNoInjectedState<unknown, Return>;
+    <Return>(...args: DecoratorArgs<DescriptorWithInjectedState<unknown, Return>>): void | DescriptorWithInjectedState<unknown, Return>;
+};
+/**
+ * Defines the return type of a call to `@Selector` when there is an argument given.
+ * (e.g. `@Selector([])` counts, but `@Selector()` does not)
+ *
+ * This result is a decorator that can only be used to decorate a function with an argument list
+ * matching the results of the tuple of parents `ParentsTuple`.
+ */
+type SelectorTypeWithDecoratorArgs<ParentsTuple> = {
+    <Return>(...args: DecoratorArgs<DescriptorWithNoInjectedState<ParentsTuple, Return>>): void | DescriptorWithNoInjectedState<ParentsTuple, Return>;
+    /**
+     * @deprecated
+     * Read the deprecation notice at this link: https://ngxs.io/deprecations/inject-container-state-deprecation.md.
+     */
+    <Return>(...args: DecoratorArgs<DescriptorWithInjectedState<ParentsTuple, Return>>): void | DescriptorWithInjectedState<ParentsTuple, Return>;
+};
+/**
+ * Defines the return type of a call to `@Selector`. This result is a decorator that can only be
+ * used to decorate a function with an argument list matching `ParentsTuple`, the results of the
+ * tuple of parent selectors/state tokens/state classes.
+ */
+type SelectorType<ParentsTuple> = unknown extends ParentsTuple ? SelectorTypeNoDecoratorArgs : SelectorTypeWithDecoratorArgs<ParentsTuple>;
 
 /**
  * Decorator for creating a state selector for the current state.
@@ -517,7 +586,7 @@ declare function Selector(): SelectorType<unknown>;
 /**
  * Decorator for creating a state selector from the provided selectors (and optionally the container State, depending on the applicable Selector Options).
  */
-declare function Selector<T extends ɵSelectorDef<any>>(selectors: T[]): SelectorType<T>;
+declare function Selector<T extends SelectorDefTuple>(selectors: T): SelectorType<T>;
 
 declare class NoopNgxsExecutionStrategy implements NgxsExecutionStrategy {
     enter<T>(func: () => T): T;
@@ -624,6 +693,28 @@ declare function provideStates(states: _StateClass[], ...features: EnvironmentPr
  */
 declare function withNgxsPlugin(plugin: Type<NgxsPlugin>): EnvironmentProviders;
 
+/**
+ * This function registers a preboot function which will be called before the root
+ * store initializer is run, but after all of the NGXS features are provided and
+ * available for injection. This is useful for registering action stream listeners
+ * before any action is dispatched.
+ *
+ * ```ts
+ * bootstrapApplication(AppComponent, {
+ *   providers: [
+ *     provideStore(
+ *       [CountriesState],
+ *       withNgxsPreboot(() => {
+ *         const actions$ = inject(Actions);
+ *         actions$.subscribe(ctx => console.log(ctx));
+ *       })
+ *     )
+ *   ]
+ * });
+ * ```
+ */
+declare function withNgxsPreboot(prebootFn: VoidFunction): i0.EnvironmentProviders;
+
 /**
  * This function serves as a utility and has multiple purposes.
  * Firstly, it allows you to select properties from the state class
@@ -647,4 +738,4 @@ 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>; };
 
-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, withNgxsPlugin, NgxsFeatureModule as ɵNgxsFeatureModule, NgxsRootModule as ɵNgxsRootModule, type ɵSelectorDef, type ɵSelectorFunc, type ɵSelectorReturnType, type ɵStateSelector };
+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, withNgxsPlugin, withNgxsPreboot, NgxsFeatureModule as ɵNgxsFeatureModule, NgxsRootModule as ɵNgxsRootModule, type ɵSelectorDef, type ɵSelectorFunc, type ɵSelectorReturnType, type ɵStateSelector };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ngxs/store",
-  "version": "3.8.2-dev.master-67d50ea",
+  "version": "3.8.2-dev.master-728bfff",
   "license": "MIT",
   "sideEffects": false,
   "peerDependencies": {