@ngxs/router-plugin 3.8.2-dev.master-2afb16f → 3.8.2-dev.master-1a7514e

package/index.d.ts

@@ -1,166 +1,4 @@
-import * as i0 from '@angular/core';
-import { ModuleWithProviders, EnvironmentProviders, OnDestroy, NgZone, Injector } from '@angular/core';
-import { NgxsRouterPluginOptions } from '@ngxs/router-plugin/internals';
-export { NavigationActionTiming, NgxsRouterPluginOptions } from '@ngxs/router-plugin/internals';
-import * as i1 from '@ngxs/store';
-import { StateToken, Store, StateContext } from '@ngxs/store';
-import { Params, NavigationExtras, RouterStateSnapshot, NavigationStart, RoutesRecognized, NavigationCancel, NavigationError, ResolveEnd, NavigationEnd, ActivatedRouteSnapshot, Router } from '@angular/router';
-
-declare class NgxsRouterPluginModule {
-    static forRoot(options?: NgxsRouterPluginOptions): ModuleWithProviders<NgxsRouterPluginModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsRouterPluginModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxsRouterPluginModule, never, [typeof i1.ɵNgxsFeatureModule], never>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<NgxsRouterPluginModule>;
-}
-declare function withNgxsRouterPlugin(options?: NgxsRouterPluginOptions): EnvironmentProviders;
-
 /**
- * Public event api of the router
+ * The public api for consumers of @ngxs/router-plugin
  */
-declare class Navigate {
-    path: any[];
-    queryParams?: Params | undefined;
-    extras?: NavigationExtras | undefined;
-    static readonly type = "[Router] Navigate";
-    constructor(path: any[], queryParams?: Params | undefined, extras?: NavigationExtras | undefined);
-}
-/**
- *
- * Angular Routers internal state events
- *
- */
-/**
- * An action dispatched when the router starts the navigation.
- */
-declare class RouterRequest<T = RouterStateSnapshot> {
-    routerState: T;
-    event: NavigationStart;
-    trigger: RouterTrigger;
-    static readonly type = "[Router] RouterRequest";
-    constructor(routerState: T, event: NavigationStart, trigger?: RouterTrigger);
-}
-/**
- * An action dispatched when the router navigates.
- */
-declare class RouterNavigation<T = RouterStateSnapshot> {
-    routerState: T;
-    event: RoutesRecognized;
-    trigger: RouterTrigger;
-    static readonly type = "[Router] RouterNavigation";
-    constructor(routerState: T, event: RoutesRecognized, trigger?: RouterTrigger);
-}
-/**
- * An action dispatched when the router cancel navigation.
- */
-declare class RouterCancel<T, V = RouterStateSnapshot> {
-    routerState: V;
-    storeState: T;
-    event: NavigationCancel;
-    trigger: RouterTrigger;
-    static readonly type = "[Router] RouterCancel";
-    constructor(routerState: V, storeState: T, event: NavigationCancel, trigger?: RouterTrigger);
-}
-/**
- * An action dispatched when the router errors.
- */
-declare class RouterError<T, V = RouterStateSnapshot> {
-    routerState: V;
-    storeState: T;
-    event: NavigationError;
-    trigger: RouterTrigger;
-    static readonly type = "[Router] RouterError";
-    constructor(routerState: V, storeState: T, event: NavigationError, trigger?: RouterTrigger);
-}
-/**
- * An action dispatched when the `ResolveEnd` event is triggered.
- */
-declare class RouterDataResolved<T = RouterStateSnapshot> {
-    routerState: T;
-    event: ResolveEnd;
-    trigger: RouterTrigger;
-    static readonly type = "[Router] RouterDataResolved";
-    constructor(routerState: T, event: ResolveEnd, trigger?: RouterTrigger);
-}
-/**
- * An action dispatched when the router navigation has been finished successfully.
- */
-declare class RouterNavigated<T = RouterStateSnapshot> {
-    routerState: T;
-    event: NavigationEnd;
-    trigger: RouterTrigger;
-    static readonly type = "[Router] RouterNavigated";
-    constructor(routerState: T, event: NavigationEnd, trigger?: RouterTrigger);
-}
-/**
- * An union type of router actions.
- */
-type RouterAction<T, V = RouterStateSnapshot> = RouterRequest<V> | RouterNavigation<V> | RouterCancel<T, V> | RouterError<T, V> | RouterDataResolved<V> | RouterNavigated<V>;
-
-declare abstract class RouterStateSerializer<T> {
-    abstract serialize(routerState: RouterStateSnapshot): T;
-}
-interface SerializedRouterStateSnapshot {
-    root: ActivatedRouteSnapshot;
-    url: string;
-}
-declare class DefaultRouterStateSerializer implements RouterStateSerializer<SerializedRouterStateSnapshot> {
-    serialize(routerState: RouterStateSnapshot): SerializedRouterStateSnapshot;
-    private serializeRoute;
-}
-
-interface RouterStateModel<T = RouterStateSnapshot> {
-    state?: T;
-    navigationId?: number;
-    trigger: RouterTrigger;
-}
-type RouterTrigger = 'none' | 'router' | 'store' | 'devtools';
-declare const ROUTER_STATE_TOKEN: StateToken<RouterStateModel<RouterStateSnapshot>>;
-declare class RouterState implements OnDestroy {
-    private _store;
-    private _router;
-    private _serializer;
-    private _ngZone;
-    /**
-     * Determines how navigation was performed by the `RouterState` itself
-     * or outside via `new Navigate(...)`
-     */
-    private _trigger;
-    /**
-     * That's the serialized state from the `Router` class
-     */
-    private _routerState;
-    /**
-     * That's the value of the `RouterState` state
-     */
-    private _storeState;
-    private _lastEvent;
-    private _options;
-    private _destroy$;
-    static state<T = RouterStateSnapshot>(state: RouterStateModel<T>): T | undefined;
-    static url(state: RouterStateModel): string | undefined;
-    constructor(_store: Store, _router: Router, _serializer: RouterStateSerializer<RouterStateSnapshot>, _ngZone: NgZone, injector: Injector);
-    ngOnDestroy(): void;
-    navigate(_: StateContext<RouterStateModel>, action: Navigate): Promise<boolean>;
-    angularRouterAction(ctx: StateContext<RouterStateModel>, action: RouterAction<RouterStateModel, RouterStateSnapshot>): void;
-    private _setUpStoreListener;
-    private _navigateIfNeeded;
-    private _setUpRouterEventsListener;
-    /** Reacts to `NavigationStart`. */
-    private _navigationStart;
-    /** Reacts to `ResolveEnd`. */
-    private _dispatchRouterDataResolved;
-    /** Reacts to `RoutesRecognized` or `NavigationEnd`, depends on the `navigationActionTiming`. */
-    private _dispatchRouterNavigation;
-    /** Reacts to `NavigationCancel`. */
-    private _dispatchRouterCancel;
-    /** Reacts to `NavigationEnd`. */
-    private _dispatchRouterError;
-    /** Reacts to `NavigationEnd`. */
-    private _dispatchRouterNavigated;
-    private _dispatchRouterAction;
-    private _reset;
-    static ɵfac: i0.ɵɵFactoryDeclaration<RouterState, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<RouterState>;
-}
-
-export { DefaultRouterStateSerializer, Navigate, NgxsRouterPluginModule, ROUTER_STATE_TOKEN, type RouterAction, RouterCancel, RouterDataResolved, RouterError, RouterNavigated, RouterNavigation, RouterRequest, RouterState, type RouterStateModel, RouterStateSerializer, type SerializedRouterStateSnapshot, withNgxsRouterPlugin };
+export * from './src/public_api';

package/internals/index.d.ts

@@ -1,14 +1 @@
-import { InjectionToken } from '@angular/core';
-
-declare const enum NavigationActionTiming {
-    PreActivation = 1,
-    PostActivation = 2
-}
-interface NgxsRouterPluginOptions {
-    navigationActionTiming?: NavigationActionTiming;
-}
-declare const ɵUSER_OPTIONS: InjectionToken<NgxsRouterPluginOptions | undefined>;
-declare const ɵNGXS_ROUTER_PLUGIN_OPTIONS: InjectionToken<NgxsRouterPluginOptions>;
-declare function ɵcreateRouterPluginOptions(options: NgxsRouterPluginOptions | undefined): NgxsRouterPluginOptions;
-
-export { NavigationActionTiming, type NgxsRouterPluginOptions, ɵNGXS_ROUTER_PLUGIN_OPTIONS, ɵUSER_OPTIONS, ɵcreateRouterPluginOptions };
+export * from './symbols';

package/internals/symbols.d.ts

@@ -0,0 +1,11 @@
+import { InjectionToken } from '@angular/core';
+export declare const enum NavigationActionTiming {
+    PreActivation = 1,
+    PostActivation = 2
+}
+export interface NgxsRouterPluginOptions {
+    navigationActionTiming?: NavigationActionTiming;
+}
+export declare const ɵUSER_OPTIONS: InjectionToken<NgxsRouterPluginOptions | undefined>;
+export declare const ɵNGXS_ROUTER_PLUGIN_OPTIONS: InjectionToken<NgxsRouterPluginOptions>;
+export declare function ɵcreateRouterPluginOptions(options: NgxsRouterPluginOptions | undefined): NgxsRouterPluginOptions;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ngxs/router-plugin",
   "description": "router plugin for @ngxs/store",
-  "version": "3.8.2-dev.master-2afb16f",
+  "version": "3.8.2-dev.master-1a7514e",
   "sideEffects": false,
   "peerDependencies": {
-    "@angular/core": ">=12.0.0 <18.0.0",
-    "@angular/router": ">=12.0.0 <18.0.0",
+    "@angular/core": ">=12.0.0 <19.0.0",
+    "@angular/router": ">=12.0.0 <19.0.0",
     "@ngxs/store": "^3.8.2 || ^3.8.2-dev",
     "rxjs": ">=6.5.5"
   },

package/src/public_api.d.ts

@@ -0,0 +1,5 @@
+export { NgxsRouterPluginModule, withNgxsRouterPlugin } from './router.module';
+export { ROUTER_STATE_TOKEN, RouterState, RouterStateModel } from './router.state';
+export { RouterStateSerializer, DefaultRouterStateSerializer, SerializedRouterStateSnapshot } from './serializer';
+export * from './router.actions';
+export { NavigationActionTiming, NgxsRouterPluginOptions } from '@ngxs/router-plugin/internals';

package/src/router.actions.d.ts

@@ -0,0 +1,83 @@
+import { NavigationCancel, NavigationError, NavigationExtras, Params, RouterStateSnapshot, RoutesRecognized, ResolveEnd, NavigationStart, NavigationEnd } from '@angular/router';
+import { RouterTrigger } from './router.state';
+/**
+ * Public event api of the router
+ */
+export declare class Navigate {
+    path: any[];
+    queryParams?: Params | undefined;
+    extras?: NavigationExtras | undefined;
+    static readonly type = "[Router] Navigate";
+    constructor(path: any[], queryParams?: Params | undefined, extras?: NavigationExtras | undefined);
+}
+/**
+ *
+ * Angular Routers internal state events
+ *
+ */
+/**
+ * An action dispatched when the router starts the navigation.
+ */
+export declare class RouterRequest<T = RouterStateSnapshot> {
+    routerState: T;
+    event: NavigationStart;
+    trigger: RouterTrigger;
+    static readonly type = "[Router] RouterRequest";
+    constructor(routerState: T, event: NavigationStart, trigger?: RouterTrigger);
+}
+/**
+ * An action dispatched when the router navigates.
+ */
+export declare class RouterNavigation<T = RouterStateSnapshot> {
+    routerState: T;
+    event: RoutesRecognized;
+    trigger: RouterTrigger;
+    static readonly type = "[Router] RouterNavigation";
+    constructor(routerState: T, event: RoutesRecognized, trigger?: RouterTrigger);
+}
+/**
+ * An action dispatched when the router cancel navigation.
+ */
+export declare class RouterCancel<T, V = RouterStateSnapshot> {
+    routerState: V;
+    storeState: T;
+    event: NavigationCancel;
+    trigger: RouterTrigger;
+    static readonly type = "[Router] RouterCancel";
+    constructor(routerState: V, storeState: T, event: NavigationCancel, trigger?: RouterTrigger);
+}
+/**
+ * An action dispatched when the router errors.
+ */
+export declare class RouterError<T, V = RouterStateSnapshot> {
+    routerState: V;
+    storeState: T;
+    event: NavigationError;
+    trigger: RouterTrigger;
+    static readonly type = "[Router] RouterError";
+    constructor(routerState: V, storeState: T, event: NavigationError, trigger?: RouterTrigger);
+}
+/**
+ * An action dispatched when the `ResolveEnd` event is triggered.
+ */
+export declare class RouterDataResolved<T = RouterStateSnapshot> {
+    routerState: T;
+    event: ResolveEnd;
+    trigger: RouterTrigger;
+    static readonly type = "[Router] RouterDataResolved";
+    constructor(routerState: T, event: ResolveEnd, trigger?: RouterTrigger);
+}
+/**
+ * An action dispatched when the router navigation has been finished successfully.
+ */
+export declare class RouterNavigated<T = RouterStateSnapshot> {
+    routerState: T;
+    event: NavigationEnd;
+    trigger: RouterTrigger;
+    static readonly type = "[Router] RouterNavigated";
+    constructor(routerState: T, event: NavigationEnd, trigger?: RouterTrigger);
+}
+/**
+ * An union type of router actions.
+ */
+export type RouterAction<T, V = RouterStateSnapshot> = RouterRequest<V> | RouterNavigation<V> | RouterCancel<T, V> | RouterError<T, V> | RouterDataResolved<V> | RouterNavigated<V>;

package/src/router.module.d.ts

@@ -0,0 +1,11 @@
+import { EnvironmentProviders, ModuleWithProviders } from '@angular/core';
+import { NgxsRouterPluginOptions } from '@ngxs/router-plugin/internals';
+import * as i0 from "@angular/core";
+import * as i1 from "@ngxs/store";
+export declare class NgxsRouterPluginModule {
+    static forRoot(options?: NgxsRouterPluginOptions): ModuleWithProviders<NgxsRouterPluginModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsRouterPluginModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxsRouterPluginModule, never, [typeof i1.ɵNgxsFeatureModule], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<NgxsRouterPluginModule>;
+}
+export declare function withNgxsRouterPlugin(options?: NgxsRouterPluginOptions): EnvironmentProviders;

package/src/router.state.d.ts

@@ -0,0 +1,60 @@
+import { NgZone, OnDestroy, Injector } from '@angular/core';
+import { Router, RouterStateSnapshot } from '@angular/router';
+import { StateContext, StateToken, Store } from '@ngxs/store';
+import { Navigate, RouterAction } from './router.actions';
+import { RouterStateSerializer } from './serializer';
+import * as i0 from "@angular/core";
+export interface RouterStateModel<T = RouterStateSnapshot> {
+    state?: T;
+    navigationId?: number;
+    trigger: RouterTrigger;
+}
+export type RouterTrigger = 'none' | 'router' | 'store' | 'devtools';
+export declare const ROUTER_STATE_TOKEN: StateToken<RouterStateModel<RouterStateSnapshot>>;
+export declare class RouterState implements OnDestroy {
+    private _store;
+    private _router;
+    private _serializer;
+    private _ngZone;
+    /**
+     * Determines how navigation was performed by the `RouterState` itself
+     * or outside via `new Navigate(...)`
+     */
+    private _trigger;
+    /**
+     * That's the serialized state from the `Router` class
+     */
+    private _routerState;
+    /**
+     * That's the value of the `RouterState` state
+     */
+    private _storeState;
+    private _lastEvent;
+    private _options;
+    private _destroy$;
+    static state<T = RouterStateSnapshot>(state: RouterStateModel<T>): T | undefined;
+    static url(state: RouterStateModel): string | undefined;
+    constructor(_store: Store, _router: Router, _serializer: RouterStateSerializer<RouterStateSnapshot>, _ngZone: NgZone, injector: Injector);
+    ngOnDestroy(): void;
+    navigate(_: StateContext<RouterStateModel>, action: Navigate): Promise<boolean>;
+    angularRouterAction(ctx: StateContext<RouterStateModel>, action: RouterAction<RouterStateModel, RouterStateSnapshot>): void;
+    private _setUpStoreListener;
+    private _navigateIfNeeded;
+    private _setUpRouterEventsListener;
+    /** Reacts to `NavigationStart`. */
+    private _navigationStart;
+    /** Reacts to `ResolveEnd`. */
+    private _dispatchRouterDataResolved;
+    /** Reacts to `RoutesRecognized` or `NavigationEnd`, depends on the `navigationActionTiming`. */
+    private _dispatchRouterNavigation;
+    /** Reacts to `NavigationCancel`. */
+    private _dispatchRouterCancel;
+    /** Reacts to `NavigationEnd`. */
+    private _dispatchRouterError;
+    /** Reacts to `NavigationEnd`. */
+    private _dispatchRouterNavigated;
+    private _dispatchRouterAction;
+    private _reset;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RouterState, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<RouterState>;
+}

package/src/serializer.d.ts

@@ -0,0 +1,12 @@
+import { ActivatedRouteSnapshot, RouterStateSnapshot } from '@angular/router';
+export declare abstract class RouterStateSerializer<T> {
+    abstract serialize(routerState: RouterStateSnapshot): T;
+}
+export interface SerializedRouterStateSnapshot {
+    root: ActivatedRouteSnapshot;
+    url: string;
+}
+export declare class DefaultRouterStateSerializer implements RouterStateSerializer<SerializedRouterStateSnapshot> {
+    serialize(routerState: RouterStateSnapshot): SerializedRouterStateSnapshot;
+    private serializeRoute;
+}