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

package/index.d.ts

@@ -1,114 +1,4 @@
-import * as i0 from '@angular/core';
-import { InjectionToken, ModuleWithProviders, EnvironmentProviders, OnDestroy, Injector, NgZone } from '@angular/core';
-import { NgxsPlugin, NgxsNextPluginFn } from '@ngxs/store/plugins';
-
 /**
- * Interface for the redux-devtools-extension API.
+ * The public api for consumers of @ngxs/devtools-plugin
  */
-interface NgxsDevtoolsExtension {
-    init(state: any): void;
-    send(action: any, state?: any): void;
-    subscribe(fn: (message: NgxsDevtoolsAction) => void): VoidFunction;
-}
-interface NgxsDevtoolsAction {
-    type: string;
-    payload: any;
-    state: any;
-    id: number;
-    source: string;
-}
-interface NgxsDevtoolsOptions {
-    /**
-     * The name of the extension
-     */
-    name?: string;
-    /**
-     * Whether the dev tools is enabled or note. Useful for setting during production.
-     */
-    disabled?: boolean;
-    /**
-     * Max number of entiries to keep.
-     */
-    maxAge?: number;
-    /**
-     * If more than one action is dispatched in the indicated interval, all new actions will be collected
-     * and sent at once. It is the joint between performance and speed. When set to 0, all actions will be
-     * sent instantly. Set it to a higher value when experiencing perf issues (also maxAge to a lower value).
-     * Default is 500 ms.
-     */
-    latency?: number;
-    /**
-     * string or array of strings as regex - actions types to be hidden in the monitors (while passed to the reducers).
-     * If actionsWhitelist specified, actionsBlacklist is ignored.
-     */
-    actionsBlacklist?: string | string[];
-    /**
-     * string or array of strings as regex - actions types to be shown in the monitors (while passed to the reducers).
-     * If actionsWhitelist specified, actionsBlacklist is ignored.
-     */
-    actionsWhitelist?: string | string[];
-    /**
-     * called for every action before sending, takes state and action object, and returns true in case it allows
-     * sending the current data to the monitor. Use it as a more advanced version of
-     * actionsBlacklist/actionsWhitelist parameters
-     */
-    predicate?: (state: any, action: any) => boolean;
-    /**
-     * Reformat actions before sending to dev tools
-     */
-    actionSanitizer?: (action: any) => void;
-    /**
-     * Reformat state before sending to devtools
-     */
-    stateSanitizer?: (state: any) => void;
-    /**
-     * If set to true, will include stack trace for every dispatched action
-     */
-    trace?: boolean | (() => string);
-    /**
-     * Maximum stack trace frames to be stored (in case trace option was provided as true)
-     */
-    traceLimit?: number;
-}
-declare const NGXS_DEVTOOLS_OPTIONS: InjectionToken<unknown>;
-
-declare class NgxsReduxDevtoolsPluginModule {
-    static forRoot(options?: NgxsDevtoolsOptions): ModuleWithProviders<NgxsReduxDevtoolsPluginModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsReduxDevtoolsPluginModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxsReduxDevtoolsPluginModule, never, never, never>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<NgxsReduxDevtoolsPluginModule>;
-}
-declare function withNgxsReduxDevtoolsPlugin(options?: NgxsDevtoolsOptions): EnvironmentProviders;
-
-/**
- * Adds support for the Redux Devtools extension:
- * http://extension.remotedev.io/
- */
-declare class NgxsReduxDevtoolsPlugin implements OnDestroy, NgxsPlugin {
-    private _options;
-    private _injector;
-    private _ngZone;
-    private devtoolsExtension;
-    private readonly globalDevtools;
-    private unsubscribe;
-    constructor(_options: NgxsDevtoolsOptions, _injector: Injector, _ngZone: NgZone);
-    ngOnDestroy(): void;
-    /**
-     * Lazy get the store for circular dependency issues
-     */
-    private get store();
-    /**
-     * Middleware handle function
-     */
-    handle(state: any, action: any, next: NgxsNextPluginFn): any;
-    private sendToDevTools;
-    /**
-     * Handle the action from the dev tools subscription
-     */
-    dispatched(action: NgxsDevtoolsAction): void;
-    private connect;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsReduxDevtoolsPlugin, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<NgxsReduxDevtoolsPlugin>;
-}
-
-export { NGXS_DEVTOOLS_OPTIONS, type NgxsDevtoolsAction, type NgxsDevtoolsExtension, type NgxsDevtoolsOptions, NgxsReduxDevtoolsPlugin, NgxsReduxDevtoolsPluginModule, withNgxsReduxDevtoolsPlugin };
+export * from './src/public_api';

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@ngxs/devtools-plugin",
   "description": "redux devtools 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/core": ">=12.0.0 <19.0.0",
     "@ngxs/store": "^3.8.2 || ^3.8.2-dev",
     "rxjs": ">=6.5.5"
   },

package/src/devtools.module.d.ts

@@ -0,0 +1,24 @@
+import { ModuleWithProviders, InjectionToken, EnvironmentProviders } from '@angular/core';
+import { NgxsDevtoolsOptions } from './symbols';
+import * as i0 from "@angular/core";
+export declare function devtoolsOptionsFactory(options: NgxsDevtoolsOptions): {
+    name: string;
+    disabled?: boolean | undefined;
+    maxAge?: number | undefined;
+    latency?: number | undefined;
+    actionsBlacklist?: string | string[] | undefined;
+    actionsWhitelist?: string | string[] | undefined;
+    predicate?: ((state: any, action: any) => boolean) | undefined;
+    actionSanitizer?: ((action: any) => void) | undefined;
+    stateSanitizer?: ((state: any) => void) | undefined;
+    trace?: boolean | (() => string) | undefined;
+    traceLimit?: number | undefined;
+};
+export declare const USER_OPTIONS: InjectionToken<unknown>;
+export declare class NgxsReduxDevtoolsPluginModule {
+    static forRoot(options?: NgxsDevtoolsOptions): ModuleWithProviders<NgxsReduxDevtoolsPluginModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsReduxDevtoolsPluginModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxsReduxDevtoolsPluginModule, never, never, never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<NgxsReduxDevtoolsPluginModule>;
+}
+export declare function withNgxsReduxDevtoolsPlugin(options?: NgxsDevtoolsOptions): EnvironmentProviders;

package/src/devtools.plugin.d.ts

@@ -0,0 +1,34 @@
+import { Injector, NgZone, OnDestroy } from '@angular/core';
+import { NgxsNextPluginFn, NgxsPlugin } from '@ngxs/store/plugins';
+import { NgxsDevtoolsAction, NgxsDevtoolsOptions } from './symbols';
+import * as i0 from "@angular/core";
+/**
+ * Adds support for the Redux Devtools extension:
+ * http://extension.remotedev.io/
+ */
+export declare class NgxsReduxDevtoolsPlugin implements OnDestroy, NgxsPlugin {
+    private _options;
+    private _injector;
+    private _ngZone;
+    private devtoolsExtension;
+    private readonly globalDevtools;
+    private unsubscribe;
+    constructor(_options: NgxsDevtoolsOptions, _injector: Injector, _ngZone: NgZone);
+    ngOnDestroy(): void;
+    /**
+     * Lazy get the store for circular dependency issues
+     */
+    private get store();
+    /**
+     * Middleware handle function
+     */
+    handle(state: any, action: any, next: NgxsNextPluginFn): any;
+    private sendToDevTools;
+    /**
+     * Handle the action from the dev tools subscription
+     */
+    dispatched(action: NgxsDevtoolsAction): void;
+    private connect;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsReduxDevtoolsPlugin, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<NgxsReduxDevtoolsPlugin>;
+}

package/src/public_api.d.ts

@@ -0,0 +1,3 @@
+export { NgxsReduxDevtoolsPluginModule, withNgxsReduxDevtoolsPlugin } from './devtools.module';
+export { NgxsReduxDevtoolsPlugin } from './devtools.plugin';
+export * from './symbols';

package/src/symbols.d.ts

@@ -0,0 +1,70 @@
+import { InjectionToken } from '@angular/core';
+/**
+ * Interface for the redux-devtools-extension API.
+ */
+export interface NgxsDevtoolsExtension {
+    init(state: any): void;
+    send(action: any, state?: any): void;
+    subscribe(fn: (message: NgxsDevtoolsAction) => void): VoidFunction;
+}
+export interface NgxsDevtoolsAction {
+    type: string;
+    payload: any;
+    state: any;
+    id: number;
+    source: string;
+}
+export interface NgxsDevtoolsOptions {
+    /**
+     * The name of the extension
+     */
+    name?: string;
+    /**
+     * Whether the dev tools is enabled or note. Useful for setting during production.
+     */
+    disabled?: boolean;
+    /**
+     * Max number of entiries to keep.
+     */
+    maxAge?: number;
+    /**
+     * If more than one action is dispatched in the indicated interval, all new actions will be collected
+     * and sent at once. It is the joint between performance and speed. When set to 0, all actions will be
+     * sent instantly. Set it to a higher value when experiencing perf issues (also maxAge to a lower value).
+     * Default is 500 ms.
+     */
+    latency?: number;
+    /**
+     * string or array of strings as regex - actions types to be hidden in the monitors (while passed to the reducers).
+     * If actionsWhitelist specified, actionsBlacklist is ignored.
+     */
+    actionsBlacklist?: string | string[];
+    /**
+     * string or array of strings as regex - actions types to be shown in the monitors (while passed to the reducers).
+     * If actionsWhitelist specified, actionsBlacklist is ignored.
+     */
+    actionsWhitelist?: string | string[];
+    /**
+     * called for every action before sending, takes state and action object, and returns true in case it allows
+     * sending the current data to the monitor. Use it as a more advanced version of
+     * actionsBlacklist/actionsWhitelist parameters
+     */
+    predicate?: (state: any, action: any) => boolean;
+    /**
+     * Reformat actions before sending to dev tools
+     */
+    actionSanitizer?: (action: any) => void;
+    /**
+     * Reformat state before sending to devtools
+     */
+    stateSanitizer?: (state: any) => void;
+    /**
+     * If set to true, will include stack trace for every dispatched action
+     */
+    trace?: boolean | (() => string);
+    /**
+     * Maximum stack trace frames to be stored (in case trace option was provided as true)
+     */
+    traceLimit?: number;
+}
+export declare const NGXS_DEVTOOLS_OPTIONS: InjectionToken<unknown>;