ngssm-store 22.1.0 → 22.2.1

package/types/ngssm-store.d.ts

@@ -1,245 +1,196 @@
-import * as i0 from '@angular/core';
-import { InjectionToken, EnvironmentProviders, OnDestroy, Type, Signal } from '@angular/core';
-import { Observable } from 'rxjs';
-
-interface FeatureStateSpecification {
-    readonly featureStateKey: string;
-    readonly initialState: object;
-}
-declare const NGSSM_COMPONENT_WITH_FEATURE_STATE: InjectionToken<FeatureStateSpecification>;
-
-declare const provideNgssmFeatureState: (featureStateKey: string, initialValue: object) => EnvironmentProviders;
-
-declare class ProvideNgssmFeatureStateDirective implements OnDestroy {
-    private readonly component;
-    private store;
-    constructor();
-    ngOnDestroy(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ProvideNgssmFeatureStateDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<ProvideNgssmFeatureStateDirective, "[provideNgssmFeatureState]", never, {}, {}, never, never, true, never>;
-}
-
-interface Action {
-    type: string;
-}
-
-type State = Record<string, object>;
-
-interface Reducer {
-    processedActions: string[];
-    updateState(state: State, action: Action): State;
-}
-declare const NGSSM_REDUCER: InjectionToken<Reducer>;
-declare const provideReducer: (reducer: Type<unknown>) => EnvironmentProviders;
-declare const provideReducers: (...reducers: Type<unknown>[]) => EnvironmentProviders;
-
-declare class FeatureStateReducer implements Reducer {
-    readonly processedActions: string[];
-    updateState(state: State, action: Action): State;
-    static ɵfac: i0.ɵɵFactoryDeclaration<FeatureStateReducer, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<FeatureStateReducer>;
-}
-
-interface ActionDispatcher {
-    dispatchAction(action: Action): void;
-    dispatchActionType(type: string): void;
-}
-
-declare const NgSsmFeatureState: (specification: FeatureStateSpecification) => (target: object) => void;
+import * as i0 from "@angular/core";
+import { EnvironmentProviders, InjectionToken, OnDestroy, Signal, Type } from "@angular/core";
+import { Observable } from "rxjs";
+export interface FeatureStateSpecification {
+  readonly featureStateKey: string;
+  readonly initialState: object;
+}
+export declare const NGSSM_COMPONENT_WITH_FEATURE_STATE: InjectionToken<FeatureStateSpecification>;
+export declare const provideNgssmFeatureState: (featureStateKey: string, initialValue: object) => EnvironmentProviders;
+export declare class ProvideNgssmFeatureStateDirective implements OnDestroy {
+  private readonly component;
+  private store;
+  constructor();
+  ngOnDestroy(): void;
+  static ɵfac: i0.ɵɵFactoryDeclaration<ProvideNgssmFeatureStateDirective, never>;
+  static ɵdir: i0.ɵɵDirectiveDeclaration<ProvideNgssmFeatureStateDirective, "[provideNgssmFeatureState]", never, {}, {}, never, never, true, never>;
+}
+export interface Action {
+  type: string;
+}
+export type State = Record<string, object>;
+export interface Reducer {
+  processedActions: string[];
+  updateState(state: State, action: Action): State;
+}
+export declare const NGSSM_REDUCER: InjectionToken<Reducer>;
+export declare const provideReducer: (reducer: Type<unknown>) => EnvironmentProviders;
+export declare const provideReducers: (...reducers: Type<unknown>[]) => EnvironmentProviders;
+export declare class FeatureStateReducer implements Reducer {
+  readonly processedActions: string[];
+  updateState(state: State, action: Action): State;
+  static ɵfac: i0.ɵɵFactoryDeclaration<FeatureStateReducer, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+export interface ActionDispatcher {
+  dispatchAction(action: Action): void;
+  dispatchActionType(type: string): void;
+}
+export declare const NgSsmFeatureState: (specification: FeatureStateSpecification) => (target: object) => void;
 /**
  * The `Store` class is a centralized state management system for Angular applications.
  * It manages the application state, processes actions using reducers, and handles side effects using effects.
- * The class integrates both RxJS (`BehaviorSubject`) and Angular signals for reactive state management.
+ * The class exposes Angular signals for reactive state management.
  *
  * ### Features:
  * - Centralized state management with support for reducers and effects.
- * - Reactive state updates using both RxJS and Angular signals.
+ * - Reactive state updates using Angular signals.
  * - Modular initialization of feature states, reducers, and effects.
  * - Sequential action processing with an action queue.
  * - Logging for debugging and monitoring state changes and action processing.
  *
  * ### Usage:
  * - Dispatch actions using `dispatchAction` or `dispatchActionType`.
- * - Subscribe to state updates using `state$` (RxJS) or `state` (Angular signal).
+ * - Read state updates using `state` (Angular signal).
  */
-declare class Store implements ActionDispatcher {
-    useMacroTasks: boolean;
-    forceChangeDetectionAfterActionProcessed: boolean;
-    private readonly logger;
-    private readonly reducers;
-    private readonly effects;
-    private readonly initializers;
-    private readonly injector;
-    private readonly applicationRef;
-    private readonly _state$;
-    private readonly actionQueue;
-    private readonly reducersPerActionType;
-    private readonly effectsPerActionType;
-    private readonly _stateSignal;
-    private readonly _processedAction;
-    private readonly _processedAction$;
-    /**
-     * Initializes the `Store` with reducers, effects, and state initializers.
-     * Also sets up the initial state and registers reducers and effects.
-     */
-    constructor();
-    /**
-     * Returns the current state as an RxJS observable.
-     * Useful for subscribing to state changes in a reactive manner.
-     */
-    get state$(): Observable<State>;
-    /**
-     * Returns the most recently action processed by reducers as an Angular signal.
-     * Useful for accessing the last processed action in a reactive manner.
-     * This signal is updated before processing the effects.
-     */
-    get processedAction(): Signal<Action>;
-    /**
-     * Returns the most recently action processed by reducers as an observale.
-     * Useful for accessing the last processed action in a reactive manner.
-     * This signal is updated before processing the effects.
-     */
-    get processedAction$(): Observable<Action>;
-    /**
-     * Returns the current state as an Angular signal.
-     * Useful for signal-based reactivity in Angular components.
-     */
-    get state(): Signal<State>;
-    /**
-     * Dispatches an action to the store.
-     * The action is added to the action queue and processed sequentially.
-     *
-     * @param action - The action to dispatch.
-     */
-    dispatchAction(action: Action): void;
-    /**
-     * Dispatches an action by its type.
-     * This is a shorthand for dispatching actions without additional payload.
-     *
-     * @param type - The type of the action to dispatch.
-     */
-    dispatchActionType(type: string): void;
-    /**
-     * Processes the next action in the action queue.
-     * Applies reducers to update the state and executes effects for side effects.
-     */
-    private processNextAction;
-    /**
-     * Applies reducers to the current state based on the dispatched action.
-     * Updates the state if there are changes and sets the processed action signal.
-     *
-     * @param nextAction - The action being processed.
-     * @returns The updated state after applying reducers.
-     */
-    private applyReducers;
-    /**
-     * Executes an effect for a given action.
-     * Handles any errors that occur during effect execution.
-     *
-     * @param effect - The effect to execute.
-     * @param updatedState - The updated state after reducers have been applied.
-     * @param nextAction - The action being processed.
-     */
-    private runEffect;
-    /**
-     * Initializes reducers or effects and maps them to their corresponding action types.
-     *
-     * @param processors - The array of reducers or effects to initialize.
-     * @param processorMap - The map to store processors by action type.
-     * @param getProcessedActions - A function to retrieve the action types processed by a processor.
-     */
-    private initializeProcessors;
-    private addTaskForNextAction;
-    static ɵfac: i0.ɵɵFactoryDeclaration<Store, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<Store>;
-}
-
-type EffectFunc = (state: State, action: Action) => void;
-interface Effect {
-    isFunc?: boolean;
-    processedActions: string[];
-    processAction(actiondispatcher: ActionDispatcher, state: State, action: Action): void;
-}
-declare const NGSSM_EFFECT: InjectionToken<Effect>;
-declare const provideEffect: (effect: Type<unknown>) => EnvironmentProviders;
-declare const provideEffects: (...effects: Type<unknown>[]) => EnvironmentProviders;
-declare const provideEffectFunc: (actionType: string, effectFunc: EffectFunc) => EnvironmentProviders;
-
-declare class NgSsmComponent implements OnDestroy {
-    protected store: Store;
-    private readonly _unsubscribeAll$;
-    protected get unsubscribeAll$(): Observable<void>;
-    ngOnDestroy(): void;
-    watch<T>(selector: (state: State) => T): Observable<T>;
-    dispatchAction(action: Action): void;
-    dispatchActionType(actionType: string): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgSsmComponent, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<NgSsmComponent, never, never, {}, {}, never, never, true, never>;
-}
-
-interface StateInitializer {
-    initializeState(state: State): State;
-}
-declare const NGSSM_STATE_INITIALIZER: InjectionToken<StateInitializer>;
-
-declare enum LogLevel {
-    debug = "Debug",
-    information = "Information",
-    error = "Error"
-}
-
-interface LogEvent {
-    level: LogLevel;
-    message: string;
-    payload?: unknown;
-}
-
-declare class Logger {
-    private readonly _logEvents$;
-    get logEvents$(): Observable<LogEvent>;
-    debug(message: string, payload?: unknown): void;
-    information(message: string, payload?: unknown): void;
-    error(message: string, payload?: unknown): void;
-    log(level: LogLevel, message: string, payload?: unknown): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<Logger, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<Logger>;
-}
-
-declare class ConsoleAppender {
-    private logger;
-    private readonly stopEvent$;
-    start(contextName?: string): void;
-    stop(): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ConsoleAppender, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ConsoleAppender>;
-}
-
-declare const NGSSM_CONSOLE_APPENDER_NAME: InjectionToken<string>;
-declare const startConsoleAppenderFactory: () => (() => void);
-declare const provideConsoleAppender: (name: string) => EnvironmentProviders;
-
-declare enum NgssmStoreActionType {
-    registerFeatureState = "[NgssmStoreActionType] registerFeatureState",
-    unregisterFeatureState = "[NgssmStoreActionType] unregisterFeatureState"
-}
-
-declare class NgssmRegisterFeatureStateAction implements Action {
-    readonly featureStateKey: string;
-    readonly initialValue: object;
-    readonly type: string;
-    constructor(featureStateKey: string, initialValue: object);
-}
-
-declare class NgssmUnregisterFeatureStateAction implements Action {
-    readonly featureStateKey: string;
-    readonly type: string;
-    constructor(featureStateKey: string);
-}
-
-declare const ACTION_DISPATCHER: InjectionToken<ActionDispatcher>;
-declare const provideNgssmStore: () => EnvironmentProviders;
-
-declare const createSignal: <T = unknown>(selector: (state: State) => T) => Signal<T>;
-
-export { ACTION_DISPATCHER, ConsoleAppender, FeatureStateReducer, LogLevel, Logger, NGSSM_COMPONENT_WITH_FEATURE_STATE, NGSSM_CONSOLE_APPENDER_NAME, NGSSM_EFFECT, NGSSM_REDUCER, NGSSM_STATE_INITIALIZER, NgSsmComponent, NgSsmFeatureState, NgssmRegisterFeatureStateAction, NgssmStoreActionType, NgssmUnregisterFeatureStateAction, ProvideNgssmFeatureStateDirective, Store, createSignal, provideConsoleAppender, provideEffect, provideEffectFunc, provideEffects, provideNgssmFeatureState, provideNgssmStore, provideReducer, provideReducers, startConsoleAppenderFactory };
-export type { Action, ActionDispatcher, Effect, EffectFunc, FeatureStateSpecification, LogEvent, Reducer, State, StateInitializer };
+export declare class Store implements ActionDispatcher {
+  useMacroTasks: boolean;
+  forceChangeDetectionAfterActionProcessed: boolean;
+  private readonly logger;
+  private readonly reducers;
+  private readonly effects;
+  private readonly initializers;
+  private readonly injector;
+  private readonly applicationRef;
+  private readonly actionQueue;
+  private readonly reducersPerActionType;
+  private readonly effectsPerActionType;
+  private readonly _stateSignal;
+  private readonly _processedAction;
+  /**
+   * Initializes the `Store` with reducers, effects, and state initializers.
+   * Also sets up the initial state and registers reducers and effects.
+   */
+  constructor();
+  /**
+   * Returns the most recently action processed by reducers as an Angular signal.
+   * Useful for accessing the last processed action in a reactive manner.
+   * This signal is updated before processing the effects.
+   */
+  get processedAction(): Signal<Action>;
+  /**
+   * Returns the current state as an Angular signal.
+   * Useful for signal-based reactivity in Angular components.
+   */
+  get state(): Signal<State>;
+  /**
+   * Dispatches an action to the store.
+   * The action is added to the action queue and processed sequentially.
+   *
+   * @param action - The action to dispatch.
+   */
+  dispatchAction(action: Action): void;
+  /**
+   * Dispatches an action by its type.
+   * This is a shorthand for dispatching actions without additional payload.
+   *
+   * @param type - The type of the action to dispatch.
+   */
+  dispatchActionType(type: string): void;
+  /**
+   * Processes the next action in the action queue.
+   * Applies reducers to update the state and executes effects for side effects.
+   */
+  private processNextAction;
+  /**
+   * Applies reducers to the current state based on the dispatched action.
+   * Updates the state if there are changes and sets the processed action signal.
+   *
+   * @param nextAction - The action being processed.
+   * @returns The updated state after applying reducers.
+   */
+  private applyReducers;
+  /**
+   * Executes an effect for a given action.
+   * Handles any errors that occur during effect execution.
+   *
+   * @param effect - The effect to execute.
+   * @param updatedState - The updated state after reducers have been applied.
+   * @param nextAction - The action being processed.
+   */
+  private runEffect;
+  /**
+   * Initializes reducers or effects and maps them to their corresponding action types.
+   *
+   * @param processors - The array of reducers or effects to initialize.
+   * @param processorMap - The map to store processors by action type.
+   * @param getProcessedActions - A function to retrieve the action types processed by a processor.
+   */
+  private initializeProcessors;
+  private addTaskForNextAction;
+  static ɵfac: i0.ɵɵFactoryDeclaration<Store, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+export type EffectFunc<TActionType extends Action = Action> = (state: State, action: TActionType) => void;
+export interface Effect {
+  isFunc?: boolean;
+  processedActions: string[];
+  processAction(actiondispatcher: ActionDispatcher, state: State, action: Action): void;
+}
+export declare const NGSSM_EFFECT: InjectionToken<Effect>;
+export declare const provideEffect: (effect: Type<unknown>) => EnvironmentProviders;
+export declare const provideEffects: (...effects: Type<unknown>[]) => EnvironmentProviders;
+export declare const provideEffectFunc: <TActionType extends Action = Action>(actionType: string, effectFunc: EffectFunc<TActionType>) => EnvironmentProviders;
+export interface StateInitializer {
+  initializeState(state: State): State;
+}
+export declare const NGSSM_STATE_INITIALIZER: InjectionToken<StateInitializer>;
+export declare enum LogLevel {
+  debug = "Debug",
+  information = "Information",
+  error = "Error"
+}
+export interface LogEvent {
+  level: LogLevel;
+  message: string;
+  payload?: unknown;
+}
+export declare class Logger {
+  private readonly _logEvents$;
+  get logEvents$(): Observable<LogEvent>;
+  debug(message: string, payload?: unknown): void;
+  information(message: string, payload?: unknown): void;
+  error(message: string, payload?: unknown): void;
+  log(level: LogLevel, message: string, payload?: unknown): void;
+  static ɵfac: i0.ɵɵFactoryDeclaration<Logger, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+export declare class ConsoleAppender {
+  private logger;
+  private readonly stopEvent$;
+  start(contextName?: string): void;
+  stop(): void;
+  static ɵfac: i0.ɵɵFactoryDeclaration<ConsoleAppender, never>;
+  static ɵprov: i0.ɵɵInjectableDeclaration<any>;
+}
+export declare const NGSSM_CONSOLE_APPENDER_NAME: InjectionToken<string>;
+export declare const startConsoleAppenderFactory: () => (() => void);
+export declare const provideConsoleAppender: (name: string) => EnvironmentProviders;
+export declare enum NgssmStoreActionType {
+  registerFeatureState = "[NgssmStoreActionType] registerFeatureState",
+  unregisterFeatureState = "[NgssmStoreActionType] unregisterFeatureState"
+}
+export declare class NgssmRegisterFeatureStateAction implements Action {
+  readonly featureStateKey: string;
+  readonly initialValue: object;
+  readonly type: string;
+  constructor(featureStateKey: string, initialValue: object);
+}
+export declare class NgssmUnregisterFeatureStateAction implements Action {
+  readonly featureStateKey: string;
+  readonly type: string;
+  constructor(featureStateKey: string);
+}
+export declare const ACTION_DISPATCHER: InjectionToken<ActionDispatcher>;
+export declare const provideNgssmStore: () => EnvironmentProviders;
+export declare const createSignal: <T = unknown>(selector: (state: State) => T) => Signal<T>;