@ngxs/websocket-plugin 18.1.2 → 18.1.3

package/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2018 <amcdaniel2@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/index.d.ts

@@ -1,8 +1,104 @@
+import * as i0 from '@angular/core';
+import { InjectionToken, ModuleWithProviders, EnvironmentProviders } from '@angular/core';
+
+declare const NGXS_WEBSOCKET_OPTIONS: InjectionToken<NgxsWebSocketPluginOptions>;
+interface NgxsWebSocketPluginOptions {
+    /**
+     * URL of the websocket.
+     */
+    url?: string;
+    /**
+     * Either a single protocol string or an array of protocol strings.
+     * These strings are used to indicate sub-protocols, so that a single server
+     * can implement multiple WebSocket sub-protocols (for example, you might want one server to be able
+     * to handle different types of interactions depending on the specified protocol).
+     * If you don't specify a protocol string, an empty string is assumed.
+     */
+    protocol?: string | string[];
+    /**
+     * Sets the `binaryType` property of the underlying WebSocket.
+     */
+    binaryType?: 'blob' | 'arraybuffer';
+    /**
+     * The property name to distigunish this type for the store.
+     * Default: 'type'
+     */
+    typeKey?: string;
+    /**
+     * Interval to try and reconnect.
+     * Default: 5000
+     */
+    reconnectInterval?: number;
+    /**
+     * Number of reconnect attemps.
+     * Default: 10
+     */
+    reconnectAttempts?: number;
+    /**
+     * Serializer to call before sending messages
+     * Default: `json.stringify`
+     */
+    serializer?: (data: any) => string;
+    /**
+     * Deseralizer before publishing the message.
+     */
+    deserializer?: (e: MessageEvent) => any;
+}
 /**
- * The public api for consumers of @ngxs/websocket-plugin
+ * Action to connect to the websocket. Optionally pass a URL.
  */
-export * from './src/public_api';
+declare class ConnectWebSocket {
+    payload?: NgxsWebSocketPluginOptions | undefined;
+    static readonly type = "[WebSocket] Connect";
+    constructor(payload?: NgxsWebSocketPluginOptions | undefined);
+}
 /**
- * The private api for consumers of @ngxs/websocket-plugin
+ * Action triggered when a error ocurrs
  */
-export * from './src/private_api';
+declare class WebSocketMessageError {
+    payload: any;
+    static readonly type = "[WebSocket] Message Error";
+    constructor(payload: any);
+}
+/**
+ * Action to disconnect the websocket.
+ */
+declare class DisconnectWebSocket {
+    static readonly type = "[WebSocket] Disconnect";
+}
+/**
+ * Action triggered when websocket is connected
+ */
+declare class WebSocketConnected {
+    static readonly type = "[WebSocket] Connected";
+}
+/**
+ * Action triggered when websocket is disconnected
+ */
+declare class WebSocketDisconnected {
+    static readonly type = "[WebSocket] Disconnected";
+}
+/**
+ * Action to send to the server.
+ */
+declare class SendWebSocketMessage {
+    payload: any;
+    static readonly type = "[WebSocket] Send Message";
+    constructor(payload: any);
+}
+/**
+ * Action dispatched when the user tries to connect if the connection already exists.
+ */
+declare class WebSocketConnectionUpdated {
+    static readonly type = "[WebSocket] Connection Updated";
+}
+
+declare class NgxsWebSocketPluginModule {
+    static forRoot(options?: NgxsWebSocketPluginOptions): ModuleWithProviders<NgxsWebSocketPluginModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsWebSocketPluginModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxsWebSocketPluginModule, never, never, never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<NgxsWebSocketPluginModule>;
+}
+declare function withNgxsWebSocketPlugin(options?: NgxsWebSocketPluginOptions): EnvironmentProviders;
+
+export { ConnectWebSocket, DisconnectWebSocket, NgxsWebSocketPluginModule, SendWebSocketMessage, WebSocketConnected, WebSocketConnectionUpdated, WebSocketDisconnected, WebSocketMessageError, withNgxsWebSocketPlugin, NGXS_WEBSOCKET_OPTIONS as ɵNGXS_WEBSOCKET_OPTIONS };

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@ngxs/websocket-plugin",
   "description": "WebSocket plugin for @ngxs/store",
-  "version": "18.1.2",
+  "version": "18.1.3",
   "sideEffects": true,
   "peerDependencies": {
-    "@ngxs/store": "^18.1.2 || ^18.1.2-dev",
+    "@ngxs/store": "^18.1.3 || ^18.1.3-dev",
     "@angular/core": ">=16.0.0 <19.0.0",
     "rxjs": ">=6.5.5"
   },

package/src/private_api.d.ts

@@ -1 +0,0 @@
-export { NGXS_WEBSOCKET_OPTIONS as ɵNGXS_WEBSOCKET_OPTIONS } from './symbols';

package/src/providers.d.ts

@@ -1,31 +0,0 @@
-import { WebSocketHandler } from './websocket-handler';
-import { NgxsWebSocketPluginOptions } from './symbols';
-export declare function ɵwebsocketOptionsFactory(options: NgxsWebSocketPluginOptions): {
-    url?: string | undefined;
-    protocol?: string | string[] | undefined;
-    binaryType?: "blob" | "arraybuffer" | undefined;
-    typeKey: string;
-    reconnectInterval: number;
-    reconnectAttempts: number;
-    serializer: (data: any) => string;
-    deserializer: (e: MessageEvent<any>) => any;
-};
-export declare function ɵgetProviders(options?: NgxsWebSocketPluginOptions): ({
-    provide: import("@angular/core").InjectionToken<unknown>;
-    useValue: NgxsWebSocketPluginOptions | undefined;
-    useFactory?: undefined;
-    deps?: undefined;
-    multi?: undefined;
-} | {
-    provide: import("@angular/core").InjectionToken<NgxsWebSocketPluginOptions>;
-    useFactory: typeof ɵwebsocketOptionsFactory;
-    deps: import("@angular/core").InjectionToken<unknown>[];
-    useValue?: undefined;
-    multi?: undefined;
-} | {
-    provide: import("@angular/core").InjectionToken<readonly (() => void | import("rxjs").Observable<unknown> | Promise<unknown>)[]>;
-    useFactory: () => () => void;
-    deps: (typeof WebSocketHandler)[];
-    multi: boolean;
-    useValue?: undefined;
-})[];

package/src/public_api.d.ts

@@ -1,2 +0,0 @@
-export { NgxsWebSocketPluginModule, withNgxsWebSocketPlugin } from './websocket.module';
-export { ConnectWebSocket, WebSocketMessageError, DisconnectWebSocket, WebSocketDisconnected, SendWebSocketMessage, WebSocketConnectionUpdated, WebSocketConnected } from './symbols';

package/src/symbols.d.ts

@@ -1,100 +0,0 @@
-import { InjectionToken } from '@angular/core';
-export declare const NGXS_WEBSOCKET_OPTIONS: InjectionToken<NgxsWebSocketPluginOptions>;
-export declare const USER_OPTIONS: InjectionToken<unknown>;
-export interface NgxsWebSocketPluginOptions {
-    /**
-     * URL of the websocket.
-     */
-    url?: string;
-    /**
-     * Either a single protocol string or an array of protocol strings.
-     * These strings are used to indicate sub-protocols, so that a single server
-     * can implement multiple WebSocket sub-protocols (for example, you might want one server to be able
-     * to handle different types of interactions depending on the specified protocol).
-     * If you don't specify a protocol string, an empty string is assumed.
-     */
-    protocol?: string | string[];
-    /**
-     * Sets the `binaryType` property of the underlying WebSocket.
-     */
-    binaryType?: 'blob' | 'arraybuffer';
-    /**
-     * The property name to distigunish this type for the store.
-     * Default: 'type'
-     */
-    typeKey?: string;
-    /**
-     * Interval to try and reconnect.
-     * Default: 5000
-     */
-    reconnectInterval?: number;
-    /**
-     * Number of reconnect attemps.
-     * Default: 10
-     */
-    reconnectAttempts?: number;
-    /**
-     * Serializer to call before sending messages
-     * Default: `json.stringify`
-     */
-    serializer?: (data: any) => string;
-    /**
-     * Deseralizer before publishing the message.
-     */
-    deserializer?: (e: MessageEvent) => any;
-}
-/**
- * Action to connect to the websocket. Optionally pass a URL.
- */
-export declare class ConnectWebSocket {
-    payload?: NgxsWebSocketPluginOptions | undefined;
-    static readonly type = "[WebSocket] Connect";
-    constructor(payload?: NgxsWebSocketPluginOptions | undefined);
-}
-/**
- * Action triggered when a error ocurrs
- */
-export declare class WebSocketMessageError {
-    payload: any;
-    static readonly type = "[WebSocket] Message Error";
-    constructor(payload: any);
-}
-/**
- * Action to disconnect the websocket.
- */
-export declare class DisconnectWebSocket {
-    static readonly type = "[WebSocket] Disconnect";
-}
-/**
- * Action triggered when websocket is connected
- */
-export declare class WebSocketConnected {
-    static readonly type = "[WebSocket] Connected";
-}
-/**
- * Action triggered when websocket is disconnected
- */
-export declare class WebSocketDisconnected {
-    static readonly type = "[WebSocket] Disconnected";
-}
-/**
- * Action to send to the server.
- */
-export declare class SendWebSocketMessage {
-    payload: any;
-    static readonly type = "[WebSocket] Send Message";
-    constructor(payload: any);
-}
-/**
- * Action dispatched when the user tries to connect if the connection already exists.
- */
-export declare class WebSocketConnectionUpdated {
-    static readonly type = "[WebSocket] Connection Updated";
-}
-/**
- * This error is thrown where there is no `type` (or custom `typeKey`) property
- * on the message that came from the server side socket
- */
-export declare class TypeKeyPropertyMissingError extends Error {
-    constructor(typeKey: string);
-}

package/src/websocket-handler.d.ts

@@ -1,23 +0,0 @@
-import { OnDestroy, NgZone } from '@angular/core';
-import { Actions, Store } from '@ngxs/store';
-import { NgxsWebSocketPluginOptions } from './symbols';
-import * as i0 from "@angular/core";
-export declare class WebSocketHandler implements OnDestroy {
-    private _store;
-    private _ngZone;
-    private _actions$;
-    private _options;
-    private _socket;
-    private readonly _socketClosed$;
-    private readonly _typeKey;
-    private readonly _destroy$;
-    constructor(_store: Store, _ngZone: NgZone, _actions$: Actions, _options: NgxsWebSocketPluginOptions);
-    ngOnDestroy(): void;
-    private _setupActionsListeners;
-    private connect;
-    private _disconnect;
-    private send;
-    private _closeConnection;
-    static ɵfac: i0.ɵɵFactoryDeclaration<WebSocketHandler, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<WebSocketHandler>;
-}

package/src/websocket.module.d.ts

@@ -1,10 +0,0 @@
-import { ModuleWithProviders, EnvironmentProviders } from '@angular/core';
-import { NgxsWebSocketPluginOptions } from './symbols';
-import * as i0 from "@angular/core";
-export declare class NgxsWebSocketPluginModule {
-    static forRoot(options?: NgxsWebSocketPluginOptions): ModuleWithProviders<NgxsWebSocketPluginModule>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsWebSocketPluginModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxsWebSocketPluginModule, never, never, never>;
-    static ɵinj: i0.ɵɵInjectorDeclaration<NgxsWebSocketPluginModule>;
-}
-export declare function withNgxsWebSocketPlugin(options?: NgxsWebSocketPluginOptions): EnvironmentProviders;