@azure/web-pubsub-express 1.0.0-beta.1 → 1.0.1-alpha.20211215.2

package/types/web-pubsub-express.d.ts

@@ -48,6 +48,10 @@ export declare interface ConnectionContext {
      * The subprotocol of this connection.
      */
     subprotocol?: string;
+    /**
+     * Get the additional states for the connection, such states are perserved throughout the lifetime of the connection.
+     */
+    states: Record<string, any>;
 }
 
 /**
@@ -66,6 +70,10 @@ export declare interface ConnectRequest {
      * The queries that the client WebSocket connection has when it connects.
      */
     queries?: Record<string, string[]>;
+    /**
+     * The headers that the client WebSocket connection has when it connects.
+     */
+    headers?: Record<string, string[]>;
     /**
      * The subprotocols that the client WebSocket connection uses to do handshake.
      */
@@ -102,15 +110,21 @@ export declare interface ConnectResponse {
  * The handler to set connect event response
  */
 export declare interface ConnectResponseHandler {
+    /**
+     * Set the state of the connection
+     * @param name - The name of the state
+     * @param value - The value of the state
+     */
+    setState(name: string, value: unknown): void;
     /**
      * Return success response to the service.
-     * @param response The response for the connect event.
+     * @param response - The response for the connect event.
      */
     success(response?: ConnectResponse): void;
     /**
      * Return failed response and the service will reject the client WebSocket connection.
-     * @param code Code can be 400 user error, 401 unauthorized and 500 server error.
-     * @param detail The detail of the error.
+     * @param code - Code can be 400 user error, 401 unauthorized and 500 server error.
+     * @param detail - The detail of the error.
      */
     fail(code: 400 | 401 | 500, detail?: string): void;
 }
@@ -164,16 +178,22 @@ export declare type UserEventRequest = {
  * The handler to set user event response
  */
 export declare interface UserEventResponseHandler {
+    /**
+     * Set the state of the connection
+     * @param name - The name of the state
+     * @param value - The value of the state
+     */
+    setState(name: string, value: unknown): void;
     /**
      * Return success response with data to be delivered to the client WebSocket connection.
-     * @param data The payload data to be returned to the client.
-     * @param dataType The type of the payload data.
+     * @param data - The payload data to be returned to the client.
+     * @param dataType - The type of the payload data.
      */
     success(data?: string | ArrayBuffer, dataType?: "binary" | "text" | "json"): void;
     /**
      * Return failed response and the service will close the client WebSocket connection.
-     * @param code Code can be 400 user error, 401 unauthorized and 500 server error.
-     * @param detail The detail of the error.
+     * @param code - Code can be 400 user error, 401 unauthorized and 500 server error.
+     * @param detail - The detail of the error.
      */
     fail(code: 400 | 401 | 500, detail?: string): void;
 }
@@ -196,7 +216,7 @@ export declare class WebPubSubEventHandler {
      * import express from "express";
      * import { WebPubSubEventHandler } from "@azure/web-pubsub-express";
      * const endpoint = "https://xxxx.webpubsubdev.azure.com"
-     * const handler = new WebPubSubEventHandler('chat', [ endpoint ] {
+     * const handler = new WebPubSubEventHandler('chat', {
      *   handleConnect: (req, res) => {
      *     console.log(JSON.stringify(req));
      *     return {};
@@ -208,15 +228,15 @@ export declare class WebPubSubEventHandler {
      *     console.log(JSON.stringify(req));
      *     res.success("Hey " + req.data, req.dataType);
      *    };
+     *   allowedEndpoints: [ endpoint ]
      *  },
      * });
      * ```
      *
-     * @param hub The name of the hub to listen to
-     * @param allowedEndpoints The allowed endpoints for the incoming CloudEvents request
-     * @param options Options to configure the event handler
+     * @param hub - The name of the hub to listen to
+     * @param options - Options to configure the event handler
      */
-    constructor(hub: string, allowedEndpoints: string[], options?: WebPubSubEventHandlerOptions);
+    constructor(hub: string, options?: WebPubSubEventHandlerOptions);
     /**
      * Get the middleware to process the CloudEvents requests
      */
@@ -231,10 +251,6 @@ export declare interface WebPubSubEventHandlerOptions {
      * Custom serving path for the path of the CloudEvents handler.
      */
     path?: string;
-    /**
-     * Configures if you'd like to dump the incoming HTTP request.
-     */
-    dumpRequest?: boolean;
     /**
      * Handle 'connect' event, the service waits for the response to proceed.
      */
@@ -252,6 +268,10 @@ export declare interface WebPubSubEventHandlerOptions {
      * Event triggers for "disconnected" unblocking event. This is an unblocking event and the service does not wait for the response.
      */
     onDisconnected?: (disconnectedRequest: DisconnectedRequest) => void;
+    /**
+     * If not specified, by default allow all the endpoints, otherwise only allow specified endpoints
+     */
+    allowedEndpoints?: string[];
 }
 
 export { }