@stomp/stompjs 7.1.0 → 7.2.0

package/src/compatibility/compat-client.ts

@@ -131,7 +131,7 @@ export class CompatClient extends Client {
    */
   public disconnect(
     disconnectCallback?: any,
-    headers: StompHeaders = {}
+    headers: StompHeaders = {},
   ): void {
     if (disconnectCallback) {
       this.onDisconnect = disconnectCallback;
@@ -164,7 +164,7 @@ export class CompatClient extends Client {
   public send(
     destination: string,
     headers: { [key: string]: any } = {},
-    body: string = ''
+    body: string = '',
   ): void {
     headers = (Object as any).assign({}, headers);
 

package/src/compatibility/stomp.ts

@@ -108,7 +108,7 @@ export class Stomp {
     } else {
       console.warn(
         'Stomp.over did not receive a factory, auto reconnect will not work. ' +
-          'Please see https://stomp-js.github.io/api-docs/latest/classes/Stomp.html#over'
+          'Please see https://stomp-js.github.io/api-docs/latest/classes/Stomp.html#over',
       );
       wsFn = () => ws;
     }

package/src/frame-impl.ts

@@ -92,7 +92,7 @@ export class FrameImpl implements IFrame {
    */
   public static fromRawFrame(
     rawFrame: IRawFrameType,
-    escapeHeaderValues: boolean
+    escapeHeaderValues: boolean,
   ): FrameImpl {
     const headers: StompHeaders = {};
     const trim = (str: string): string => str.replace(/^\s+|\s+$/g, '');
@@ -143,7 +143,7 @@ export class FrameImpl implements IFrame {
     if (this.isBinaryBody) {
       return FrameImpl.toUnit8Array(
         cmdAndHeaders,
-        this._binaryBody as Uint8Array
+        this._binaryBody as Uint8Array,
       ).buffer;
     } else {
       return cmdAndHeaders + this._body + BYTE.NULL;
@@ -196,19 +196,19 @@ export class FrameImpl implements IFrame {
 
   private static toUnit8Array(
     cmdAndHeaders: string,
-    binaryBody: Uint8Array
-  ): Uint8Array {
+    binaryBody: Uint8Array,
+  ): Uint8Array<ArrayBuffer> {
     const uint8CmdAndHeaders = new TextEncoder().encode(cmdAndHeaders);
     const nullTerminator = new Uint8Array([0]);
     const uint8Frame = new Uint8Array(
-      uint8CmdAndHeaders.length + binaryBody.length + nullTerminator.length
+      uint8CmdAndHeaders.length + binaryBody.length + nullTerminator.length,
     );
 
     uint8Frame.set(uint8CmdAndHeaders);
     uint8Frame.set(binaryBody, uint8CmdAndHeaders.length);
     uint8Frame.set(
       nullTerminator,
-      uint8CmdAndHeaders.length + binaryBody.length
+      uint8CmdAndHeaders.length + binaryBody.length,
     );
 
     return uint8Frame;

package/src/i-transaction.ts

@@ -2,8 +2,6 @@
  * A Transaction is created by calling [Client#begin]{@link Client#begin}
  *
  * Part of `@stomp/stompjs`.
- *
- * TODO: Example and caveat
  */
 export interface ITransaction {
   /**

package/src/parser.ts

@@ -75,14 +75,14 @@ export class Parser {
 
   public constructor(
     public onFrame: (rawFrame: IRawFrameType) => void,
-    public onIncomingPing: () => void
+    public onIncomingPing: () => void,
   ) {
     this._initState();
   }
 
   public parseChunk(
     segment: string | ArrayBuffer,
-    appendMissingNULLonIncoming: boolean = false
+    appendMissingNULLonIncoming: boolean = false,
   ) {
     let chunk: Uint8Array;
 
@@ -193,7 +193,7 @@ export class Parser {
     const contentLengthHeader = this._results.headers.filter(
       (header: [string, string]) => {
         return header[0] === 'content-length';
-      }
+      },
     )[0];
 
     if (contentLengthHeader) {
@@ -229,7 +229,7 @@ export class Parser {
     } catch (e) {
       console.log(
         `Ignoring an exception thrown by a frame handler. Original exception: `,
-        e
+        e,
       );
     }
 

package/src/stomp-config.ts

@@ -8,8 +8,10 @@ import {
   messageCallbackType,
   ReconnectionTimeMode,
   wsErrorCallbackType,
+  emptyCallbackType,
 } from './types.js';
 import { Versions } from './versions.js';
+import { Client } from './client.js';
 
 /**
  * Configuration options for STOMP Client, each key corresponds to
@@ -59,6 +61,11 @@ export class StompConfig {
    */
   public heartbeatIncoming?: number;
 
+  /**
+   * See [Client#heartbeatToleranceMultiplier]{@link Client#heartbeatToleranceMultiplier}.
+   */
+  public heartbeatToleranceMultiplier?: number;
+
   /**
    * See [Client#heartbeatOutgoing]{@link Client#heartbeatOutgoing}.
    */
@@ -117,7 +124,7 @@ export class StompConfig {
   /**
    * See [Client#beforeConnect]{@link Client#beforeConnect}.
    */
-  public beforeConnect?: () => void | Promise<void>;
+  public beforeConnect?: (client: Client) => void | Promise<void>;
 
   /**
    * See [Client#onConnect]{@link Client#onConnect}.
@@ -144,6 +151,15 @@ export class StompConfig {
    */
   public onWebSocketError?: wsErrorCallbackType;
 
+  /**
+   * See [Client#onHeartbeatReceived]{@link Client#onHeartbeatReceived}.
+   */
+  public onHeartbeatReceived?: emptyCallbackType;
+
+  /**
+   * See [Client#onHeartbeatLost]{@link Client#onHeartbeatLost}.
+   */
+  public onHeartbeatLost?: emptyCallbackType;
   /**
    * See [Client#logRawCommunication]{@link Client#logRawCommunication}.
    */

package/src/stomp-handler.ts

@@ -11,6 +11,7 @@ import { Ticker } from './ticker.js';
 import {
   closeEventCallbackType,
   debugFnType,
+  emptyCallbackType,
   frameCallbackType,
   IPublishParams,
   IStompSocket,
@@ -40,6 +41,8 @@ export class StompHandler {
 
   public heartbeatIncoming: number;
 
+  public heartbeatToleranceMultiplier: number;
+
   public heartbeatOutgoing: number;
 
   public onUnhandledMessage: messageCallbackType;
@@ -48,6 +51,10 @@ export class StompHandler {
 
   public onUnhandledFrame: frameCallbackType;
 
+  public onHeartbeatReceived: emptyCallbackType;
+
+  public onHeartbeatLost: emptyCallbackType;
+
   public onConnect: frameCallbackType;
 
   public onDisconnect: frameCallbackType;
@@ -93,7 +100,7 @@ export class StompHandler {
   constructor(
     private _client: Client,
     public _webSocket: IStompSocket,
-    config: IStomptHandlerConfig
+    config: IStomptHandlerConfig,
   ) {
     // used to index subscribers
     this._counter = 0;
@@ -115,6 +122,7 @@ export class StompHandler {
     this.connectHeaders = config.connectHeaders;
     this.disconnectHeaders = config.disconnectHeaders;
     this.heartbeatIncoming = config.heartbeatIncoming;
+    this.heartbeatToleranceMultiplier = config.heartbeatGracePeriods;
     this.heartbeatOutgoing = config.heartbeatOutgoing;
     this.splitLargeFrames = config.splitLargeFrames;
     this.maxWebSocketChunkSize = config.maxWebSocketChunkSize;
@@ -130,6 +138,8 @@ export class StompHandler {
     this.onUnhandledMessage = config.onUnhandledMessage;
     this.onUnhandledReceipt = config.onUnhandledReceipt;
     this.onUnhandledFrame = config.onUnhandledFrame;
+    this.onHeartbeatReceived = config.onHeartbeatReceived;
+    this.onHeartbeatLost = config.onHeartbeatLost;
   }
 
   public start(): void {
@@ -138,7 +148,7 @@ export class StompHandler {
       rawFrame => {
         const frame = FrameImpl.fromRawFrame(
           rawFrame,
-          this._escapeHeaderValues
+          this._escapeHeaderValues,
         );
 
         // if this.logRawCommunication is set, the rawChunk is logged at this._webSocket.onmessage
@@ -153,7 +163,8 @@ export class StompHandler {
       // On Incoming Ping
       () => {
         this.debug('<<< PONG');
-      }
+        this.onHeartbeatReceived();
+      },
     );
 
     this._webSocket.onmessage = (evt: IStompSocketMessageEvent) => {
@@ -170,7 +181,7 @@ export class StompHandler {
 
       parser.parseChunk(
         evt.data as string | ArrayBuffer,
-        this.appendMissingNULLonIncoming
+        this.appendMissingNULLonIncoming,
       );
     };
 
@@ -291,7 +302,11 @@ export class StompHandler {
       const ttl: number = Math.max(this.heartbeatOutgoing, serverIncoming);
       this.debug(`send PING every ${ttl}ms`);
 
-      this._pinger = new Ticker(ttl, this._client.heartbeatStrategy, this.debug);
+      this._pinger = new Ticker(
+        ttl,
+        this._client.heartbeatStrategy,
+        this.debug,
+      );
       this._pinger.start(() => {
         if (this._webSocket.readyState === StompSocketState.OPEN) {
           this._webSocket.send(BYTE.LF);
@@ -305,9 +320,10 @@ export class StompHandler {
       this.debug(`check PONG every ${ttl}ms`);
       this._ponger = setInterval(() => {
         const delta = Date.now() - this._lastServerActivityTS;
-        // We wait twice the TTL to be flexible on window's setInterval calls
-        if (delta > ttl * 2) {
+        // We wait multiple grace periods to be flexible on window's setInterval calls
+        if (delta > ttl * this.heartbeatToleranceMultiplier) {
           this.debug(`did not receive server activity for the last ${delta}ms`);
+          this.onHeartbeatLost();
           this._closeOrDiscardWebsocket();
         }
       }, ttl);
@@ -317,7 +333,7 @@ export class StompHandler {
   private _closeOrDiscardWebsocket() {
     if (this.discardWebsocketOnCommFailure) {
       this.debug(
-        'Discarding websocket, the underlying socket may linger for a while'
+        'Discarding websocket, the underlying socket may linger for a while',
       );
       this.discardWebsocket();
     } else {
@@ -369,7 +385,8 @@ export class StompHandler {
       skipContentLengthHeader,
     });
 
-    let rawChunk = frame.serialize();
+    let rawChunk: string | ArrayBuffer | Uint8Array<ArrayBuffer> =
+      frame.serialize();
 
     if (this.logRawCommunication) {
       this.debug(`>>> ${rawChunk}`);
@@ -400,7 +417,7 @@ export class StompHandler {
         // clone before updating
         const disconnectHeaders = (Object as any).assign(
           {},
-          this.disconnectHeaders
+          this.disconnectHeaders,
         );
 
         if (!disconnectHeaders.receipt) {
@@ -458,7 +475,7 @@ export class StompHandler {
   public subscribe(
     destination: string,
     callback: messageCallbackType,
-    headers: StompHeaders = {}
+    headers: StompHeaders = {},
   ): StompSubscription {
     headers = (Object as any).assign({}, headers);
 
@@ -527,7 +544,7 @@ export class StompHandler {
   public ack(
     messageId: string,
     subscriptionId: string,
-    headers: StompHeaders = {}
+    headers: StompHeaders = {},
   ): void {
     headers = (Object as any).assign({}, headers);
 
@@ -543,7 +560,7 @@ export class StompHandler {
   public nack(
     messageId: string,
     subscriptionId: string,
-    headers: StompHeaders = {}
+    headers: StompHeaders = {},
   ): void {
     headers = (Object as any).assign({}, headers);
 

package/src/stomp-headers.ts

@@ -1,5 +1,5 @@
 /**
- * STOMP headers. Many functions calls will accept headers as parameters.
+ * STOMP headers. Many function calls will accept headers as parameters.
  * The headers sent by Broker will be available as [IFrame#headers]{@link IFrame#headers}.
  *
  * `key` and `value` must be valid strings.

package/src/ticker.ts

@@ -14,8 +14,8 @@ export class Ticker {
   constructor(
     private readonly _interval: number,
     private readonly _strategy = TickerStrategy.Interval,
-    private readonly _debug: debugFnType) {
-  }
+    private readonly _debug: debugFnType,
+  ) {}
 
   public start(tick: (elapsedTime: number) => void): void {
     this.stop();
@@ -33,7 +33,9 @@ export class Ticker {
   }
 
   private shouldUseWorker(): boolean {
-    return typeof(Worker) !== 'undefined' && this._strategy === TickerStrategy.Worker
+    return (
+      typeof Worker !== 'undefined' && this._strategy === TickerStrategy.Worker
+    );
   }
 
   private runWorker(tick: (elapsedTime: number) => void): void {
@@ -41,10 +43,10 @@ export class Ticker {
     if (!this._worker) {
       this._worker = new Worker(
         URL.createObjectURL(
-          new Blob([this._workerScript], { type: 'text/javascript' })
-        )
+          new Blob([this._workerScript], { type: 'text/javascript' }),
+        ),
       );
-      this._worker.onmessage = (message) => tick(message.data);
+      this._worker.onmessage = message => tick(message.data);
     }
   }
 

package/src/types.ts

@@ -24,6 +24,13 @@ export type messageCallbackType = (message: IMessage) => void;
  */
 export type frameCallbackType = ((frame: IFrame) => void) | (() => void);
 
+/**
+ * This callback is an "Event" only callback, no parameters provided.
+ *
+ * Part of `@stomp/stompjs`.
+ */
+export type emptyCallbackType = () => void;
+
 /**
  * This callback will receive a [CloseEvent]{@link https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent}
  * as parameter.
@@ -113,7 +120,7 @@ export interface IStompSocket {
   url: string;
   onclose: ((ev?: any) => any) | undefined | null;
   onerror: ((ev: any) => any) | undefined | null;
-  onmessage: ((ev: IStompSocketMessageEvent) => any) | undefined | null;
+  onmessage: ((ev: any) => any) | undefined | null;
   onopen: ((ev?: any) => any) | undefined | null;
   terminate?: (() => any) | undefined | null;
 
@@ -135,7 +142,7 @@ export interface IStompSocket {
   /**
    * Transmits data using the connection. data can be a string or an ArrayBuffer.
    */
-  send(data: string | ArrayBuffer): void;
+  send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void;
 }
 
 /**
@@ -162,7 +169,7 @@ export enum ActivationState {
  */
 export enum ReconnectionTimeMode {
   LINEAR,
-  EXPONENTIAL
+  EXPONENTIAL,
 }
 
 /**
@@ -170,7 +177,7 @@ export enum ReconnectionTimeMode {
  */
 export enum TickerStrategy {
   Interval = 'interval',
-  Worker = 'worker'
+  Worker = 'worker',
 }
 
 /**
@@ -182,6 +189,7 @@ export interface IStomptHandlerConfig {
   connectHeaders: StompHeaders;
   disconnectHeaders: StompHeaders;
   heartbeatIncoming: number;
+  heartbeatGracePeriods: number;
   heartbeatOutgoing: number;
   heartbeatStrategy: TickerStrategy;
   splitLargeFrames: boolean;
@@ -198,4 +206,6 @@ export interface IStomptHandlerConfig {
   onUnhandledMessage: messageCallbackType;
   onUnhandledReceipt: frameCallbackType;
   onUnhandledFrame: frameCallbackType;
+  onHeartbeatReceived: emptyCallbackType;
+  onHeartbeatLost: emptyCallbackType;
 }