@azure/web-pubsub 1.1.4-alpha.20241118.1 → 1.1.4-alpha.20241120.2

package/dist/esm/hubClient.d.ts

@@ -0,0 +1,478 @@
+import type { CommonClientOptions, OperationOptions } from "@azure/core-client";
+import type { RequestBodyType } from "@azure/core-rest-pipeline";
+import type { WebPubSubGroup, GroupAddConnectionOptions, GroupRemoveConnectionOptions } from "./groupClient.js";
+import type { AzureKeyCredential, TokenCredential } from "@azure/core-auth";
+/**
+ * Options for closing a connection to a hub.
+ */
+export interface HubCloseConnectionOptions extends OperationOptions {
+    /**
+     * Reason the connection is being closed.
+     */
+    reason?: string;
+}
+/**
+ * Options for closing all connections to a hub.
+ */
+export interface HubCloseAllConnectionsOptions extends OperationOptions {
+    /**
+     * Reason the connection is being closed.
+     */
+    reason?: string;
+}
+/**
+ * Options for closing all of a user's connections to a hub.
+ */
+export interface HubCloseUserConnectionsOptions extends OperationOptions {
+    /**
+     * Reason the connection is being closed.
+     */
+    reason?: string;
+}
+/**
+ * Options for sending messages to hubs.
+ */
+export interface HubSendToAllOptions extends OperationOptions {
+    /**
+     * Connection ids to exclude from receiving this message.
+     */
+    excludedConnections?: string[];
+    /**
+     * The filter syntax to filter out the connections to send the messages to following OData filter syntax.
+     * Examples:
+     *  * Exclude connections from `user1` and `user2`: `userId ne 'user1' and userId ne 'user2'`
+     *  * Exclude connections in `group1`: `not('group1' in groups)`
+     * Details about `filter` syntax please see [OData filter syntax for Azure Web PubSub](https://aka.ms/awps/filter-syntax).
+     */
+    filter?: string;
+    /**
+     * The time-to-live (TTL) value in seconds for messages sent to the service.
+     * 0 is the default value, which means the message never expires.
+     * 300 is the maximum value.
+     * If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service.
+     * This parameter can help when the client's bandwidth is limited.
+     */
+    messageTtlSeconds?: number;
+}
+/**
+ * Options for sending text messages to hubs.
+ */
+export interface HubSendTextToAllOptions extends HubSendToAllOptions {
+    /**
+     * The content will be sent to the clients in plain text.
+     */
+    contentType: "text/plain";
+}
+/**
+ * Types which can be serialized and sent as JSON.
+ */
+export type JSONTypes = string | number | boolean | object;
+/**
+ * Options for constructing a HubAdmin client.
+ */
+export interface WebPubSubServiceClientOptions extends CommonClientOptions {
+    /**
+     * Reverse proxy endpoint (for example, your Azure API management endpoint)
+     */
+    reverseProxyEndpoint?: string;
+    /**
+     * Options to configure the logging options.
+     */
+    loggingOptions?: WebPubSubServiceClientLogOptions;
+}
+/**
+ * Options to configure the logging options.
+ */
+export declare interface WebPubSubServiceClientLogOptions {
+    /**
+     * Header names whose values will be logged when logging is enabled.
+     * Defaults include a list of well-known safe headers. Any headers
+     * specified in this field will be added to that list.  Any other values will
+     * be written to logs as "REDACTED".
+     */
+    additionalAllowedHeaderNames?: string[];
+    /**
+     * Query string names whose values will be logged when logging is enabled. By default no
+     * query string values are logged.
+     */
+    additionalAllowedQueryParameters?: string[];
+}
+/**
+ * Options for checking if a connection exists.
+ */
+export interface HasConnectionOptions extends OperationOptions {
+}
+/**
+ * Options for checking if a group exists.
+ */
+export interface HubHasGroupOptions extends OperationOptions {
+}
+/**
+ * Options for checking if a user exists.
+ */
+export interface HubHasUserOptions extends OperationOptions {
+}
+/**
+ * Options for removing a user from all groups.
+ */
+export interface HubRemoveUserFromAllGroupsOptions extends HubCloseConnectionOptions {
+}
+/**
+ * Options for sending a message to a specific connection.
+ */
+export interface HubSendToConnectionOptions extends OperationOptions {
+    /**
+     * The time-to-live (TTL) value in seconds for messages sent to the service.
+     * 0 is the default value, which means the message never expires.
+     * 300 is the maximum value.
+     * If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service.
+     * This parameter can help when the client's bandwidth is limited.
+     */
+    messageTtlSeconds?: number;
+}
+/**
+ * Options for sending a text message to a connection.
+ */
+export interface HubSendTextToConnectionOptions extends HubSendToConnectionOptions {
+    contentType: "text/plain";
+}
+/**
+ * Options for sending a message to a user.
+ */
+export interface HubSendToUserOptions extends OperationOptions {
+    /**
+     * The filter syntax to filter out the connections to send the messages to following OData filter syntax.
+     * Examples:
+     *  * Exclude connections in `group1`: `not('group1' in groups)`
+     *  * Send to connections in `group1` or `group2`: `'group1' in groups or `group2` in groups`
+     * Details about `filter` syntax please see [OData filter syntax for Azure Web PubSub](https://aka.ms/awps/filter-syntax).
+     */
+    filter?: string;
+    /**
+     * The time-to-live (TTL) value in seconds for messages sent to the service.
+     * 0 is the default value, which means the message never expires.
+     * 300 is the maximum value.
+     * If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service.
+     * This parameter can help when the client's bandwidth is limited.
+     */
+    messageTtlSeconds?: number;
+}
+/**
+ * Options for sending a text message to a user.
+ */
+export interface HubSendTextToUserOptions extends HubSendToUserOptions {
+    /**
+     * The content will be sent to the clients in plain text.
+     */
+    contentType: "text/plain";
+}
+export type Permission = "joinLeaveGroup" | "sendToGroup";
+/**
+ * Options for grant permissions to a connection
+ */
+export interface HubGrantPermissionOptions extends OperationOptions {
+    /**
+     * The meaning of the target depends on the specific permission.
+     * For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name.
+     */
+    targetName?: string;
+}
+/**
+ * Options for revoke permissions from a connection
+ */
+export interface HubRevokePermissionOptions extends OperationOptions {
+    /**
+     * The meaning of the target depends on the specific permission.
+     * For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name.
+     */
+    targetName?: string;
+}
+/**
+ * Options for checking if a connection has the specified permission
+ */
+export interface HubHasPermissionOptions extends OperationOptions {
+    /**
+     * The meaning of the target depends on the specific permission.
+     * For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name.
+     */
+    targetName?: string;
+}
+/**
+ * The type of client endpoint that is being requested.
+ */
+export type WebPubSubClientProtocol = "default" | "mqtt" | "socketio";
+/**
+ * Options for generating a token to connect a client to the Azure Web Pubsub service.
+ */
+export interface GenerateClientTokenOptions extends OperationOptions {
+    /**
+     * The userId for the client.
+     */
+    userId?: string;
+    /**
+     * The roles that the connection with the generated token will have.
+     * Roles give the client initial permissions to leave, join, or publish to groups when using PubSub subprotocol
+     * * `webpubsub.joinLeaveGroup`: the client can join or leave any group
+     * * `webpubsub.sendToGroup`: the client can send messages to any group
+     * * `webpubsub.joinLeaveGroup.<group>`: the client can join or leave group `<group>`
+     * * `webpubsub.sendToGroup.<group>`: the client can send messages to group `<group>`
+     *
+     * {@link https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions}
+     */
+    roles?: string[];
+    /**
+     * Minutes until the token expires.
+     */
+    expirationTimeInMinutes?: number;
+    /**
+     * The groups to join when the client connects
+     */
+    groups?: string[];
+    /**
+     * The protocol type of the client
+     * * `default`: Default WebPubSub Client. Example Client Connection URL: _wss://exampleHost.com/client/hubs/exampleHub_
+     * * `mqtt`: MQTT Client. Example Client Connection URL:  _wss://exampleHost.com/client/mqtt/hubs/exampleHub_
+     */
+    clientProtocol?: WebPubSubClientProtocol;
+}
+/**
+ * A response containing the client token.
+ */
+export interface ClientTokenResponse {
+    /**
+     * The client token.
+     */
+    token: string;
+    /**
+     * The URL client connects to
+     */
+    baseUrl: string;
+    /**
+     * The URL client connects to with access_token query string
+     */
+    url: string;
+}
+/**
+ * Client for connecting to a Web PubSub hub
+ */
+export declare class WebPubSubServiceClient {
+    private readonly client;
+    private credential;
+    private readonly clientOptions?;
+    /**
+     * The name of the hub this client is connected to
+     */
+    readonly hubName: string;
+    /**
+     * The Web PubSub API version being used by this client
+     */
+    readonly apiVersion: string;
+    /**
+     * The Web PubSub endpoint this client is connected to
+     */
+    endpoint: string;
+    /**
+     * Creates an instance of a WebPubSubServiceClient for sending messages and managing groups, connections, and users.
+     *
+     * Example usage:
+     * ```ts
+     * import { WebPubSubServiceClient } from "@azure/web-pubsub";
+     * const connectionString = process.env['WEB_PUBSUB_CONNECTION_STRING'];
+     * const client = new WebPubSubServiceClient(connectionString, 'chat');
+     * ```
+     *
+     * @param connectionString - The connection string
+     * @param hubName - The name of the hub to connect to. If omitted, '_default' is used.
+     * @param options - Options to configure the http pipeline
+     */
+    constructor(connectionString: string, hubName: string, options?: WebPubSubServiceClientOptions);
+    /**
+     * Creates an instance of a WebPubSubServiceClient for sending messages and managing groups, connections, and users.
+     *
+     * Example usage:
+     * ```ts
+     * import { WebPubSubServiceClient, AzureKeyCredential } from "@azure/web-pubsub";
+     * const cred = new AzureKeyCredential("<your web pubsub api key>");
+     * const endpoint = "https://xxxx.webpubsubdev.azure.com"
+     * const client = new WebPubSubServiceClient(endpoint, cred, 'chat');
+     * ```
+     *
+     * @param endpoint - The endpoint to connect to
+     * @param credential - An AzureKeyCredential holding your service key
+     * @param hubName - The name of the hub to connect to.
+     * @param options - Options to configure the http pipeline
+     */
+    constructor(endpoint: string, credential: AzureKeyCredential | TokenCredential, hubName: string, options?: WebPubSubServiceClientOptions);
+    /**
+     * Get a client for a group
+     * @param groupName - The name of the group to connect to.
+     */
+    group(groupName: string): WebPubSubGroup;
+    /**
+     * Broadcast a text message to all connections on this hub.
+     *
+     * @param message - The text message to send
+     * @param options - Additional options
+     */
+    sendToAll(message: string, options: HubSendTextToAllOptions): Promise<void>;
+    /**
+     * Broadcast a JSON message to all connections on this hub.
+     *
+     * @param message - The JSON message to send
+     * @param options - Additional options
+     */
+    sendToAll(message: JSONTypes, options?: HubSendToAllOptions): Promise<void>;
+    /**
+     * Broadcast a binary message to all connections on this hub.
+     *
+     * @param message - The message to send
+     * @param options - Additional options
+     */
+    sendToAll(message: RequestBodyType, options?: HubSendToAllOptions): Promise<void>;
+    /**
+     * Send a text message to a specific user
+     *
+     * @param username - User name to send to
+     * @param message - The text message to send
+     * @param options - Additional options
+     */
+    sendToUser(username: string, message: string, options: HubSendTextToUserOptions): Promise<void>;
+    /**
+     * Send a JSON message to a specific user
+     *
+     * @param username - User name to send to
+     * @param message - The josn message to send
+     * @param options - Additional options
+     */
+    sendToUser(username: string, message: JSONTypes, options?: HubSendToUserOptions): Promise<void>;
+    /**
+     * Send a binary message to a specific user
+     *
+     * @param username - The user name to send to
+     * @param message - The binary message to send
+     * @param options - Additional options
+     */
+    sendToUser(username: string, message: RequestBodyType, options?: HubSendToUserOptions | HubSendTextToUserOptions): Promise<void>;
+    /**
+     * Send a text message to a specific connection
+     *
+     * @param connectionId - Connection id to send to
+     * @param message - The text message
+     * @param options - Additional options
+     */
+    sendToConnection(connectionId: string, message: string, options: HubSendTextToConnectionOptions): Promise<void>;
+    /**
+     * Send a binary message to a specific connection
+     *
+     * @param connectionId - Connection id to send to
+     * @param message - The JSON message
+     * @param options - Additional options
+     */
+    sendToConnection(connectionId: string, message: JSONTypes, options?: HubSendToConnectionOptions): Promise<void>;
+    /**
+     * Send a binary message to a specific connection
+     *
+     * @param connectionId - Connection id to send to
+     * @param message - The binary message
+     * @param options - Additional options
+     */
+    sendToConnection(connectionId: string, message: RequestBodyType, options?: HubSendToConnectionOptions | HubSendTextToConnectionOptions): Promise<void>;
+    /**
+     * Check if a specific connection is connected to this hub
+     *
+     * @param connectionId - Connection id to check
+     * @param options - Additional options
+     */
+    connectionExists(connectionId: string, options?: HasConnectionOptions): Promise<boolean>;
+    /**
+     * Close a specific connection to this hub
+     *
+     * @param connectionId - Connection id to close
+     * @param options - Additional options
+     */
+    closeConnection(connectionId: string, options?: HubCloseConnectionOptions): Promise<void>;
+    /**
+     * Close all connections to this hub
+     *
+     * @param options - Additional options
+     */
+    closeAllConnections(options?: HubCloseAllConnectionsOptions): Promise<void>;
+    /**
+     * Close all connections with the given user id
+     *
+     * @param user - User id to close
+     * @param options - Additional options
+     */
+    closeUserConnections(userId: string, options?: HubCloseUserConnectionsOptions): Promise<void>;
+    /**
+     * Remove a specific user from all groups they are joined to
+     * @param userId - The user id to remove from all groups
+     * @param options - Additional options
+     */
+    removeUserFromAllGroups(userId: string, options?: HubCloseConnectionOptions): Promise<void>;
+    /**
+     * Remove a specific connection from all groups they are joined to
+     * @param connectionId - The connection id to remove from all groups
+     * @param options - Additional options
+     */
+    removeConnectionFromAllGroups(connectionId: string, options?: HubCloseConnectionOptions): Promise<void>;
+    /**
+     * Add filtered connections to multiple groups
+     * @param groups - A list of groups which target connections will be added into
+     * @param filter - An OData filter which target connections satisfy
+     * @param options - Additional options
+     */
+    addConnectionsToGroups(groups: string[], filter: string, options?: GroupAddConnectionOptions): Promise<void>;
+    /**
+     * Remove filtered connections from multiple groups
+     * @param groups - A list of groups which target connections will be removed from
+     * @param filter - An OData filter which target connections satisfy
+     * @param options - Additional options
+     */
+    removeConnectionsFromGroups(groups: string[], filter: string, options?: GroupRemoveConnectionOptions): Promise<void>;
+    /**
+     * Check if a particular group exists (i.e. has active connections).
+     *
+     * @param groupName - The group name to check for
+     * @param options - Additional options
+     */
+    groupExists(groupName: string, options?: HubHasGroupOptions): Promise<boolean>;
+    /**
+     * Check if a particular user is connected to this hub.
+     *
+     * @param username - The user name to check for
+     * @param options - Additional options
+     */
+    userExists(username: string, options?: HubHasUserOptions): Promise<boolean>;
+    /**
+     * Grant permissions to a connection
+     *
+     * @param connectionId - The connection id to grant permissions to
+     * @param Permission - The permission to grant
+     * @param options - Additional options
+     */
+    grantPermission(connectionId: string, permission: Permission, options?: HubGrantPermissionOptions): Promise<void>;
+    /**
+     * Revoke permissions from a connection
+     *
+     * @param connectionId - The connection id to revoke permissions from
+     * @param Permission - The permission to revoke
+     * @param options - Additional options
+     */
+    revokePermission(connectionId: string, permission: Permission, options?: HubRevokePermissionOptions): Promise<void>;
+    /**
+     * Check if the connection has the specified permission
+     *
+     * @param connectionId - The connection id to check permission
+     * @param Permission - The permission to check
+     * @param options - Additional options
+     */
+    hasPermission(connectionId: string, permission: Permission, options?: HubHasPermissionOptions): Promise<boolean>;
+    /**
+     * Generate a token for a client to connect to the Azure Web PubSub service.
+     *
+     * @param options - Additional options
+     */
+    getClientAccessToken(options?: GenerateClientTokenOptions): Promise<ClientTokenResponse>;
+}
+//# sourceMappingURL=hubClient.d.ts.map

package/dist/esm/hubClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hubClient.d.ts","sourceRoot":"","sources":["../../src/hubClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,mBAAmB,EAEnB,gBAAgB,EACjB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAGjE,OAAO,KAAK,EACV,cAAc,EACd,yBAAyB,EACzB,4BAA4B,EAC7B,MAAM,kBAAkB,CAAC;AAE1B,OAAO,KAAK,EAAE,kBAAkB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAe5E;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IACjE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,gBAAgB;IACrE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,gBAAgB;IACtE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;IAClE;;OAEG;IACH,WAAW,EAAE,YAAY,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACxE;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,cAAc,CAAC,EAAE,gCAAgC,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,gCAAgC;IACvD;;;;;OAKG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;IACxC;;;OAGG;IACH,gCAAgC,CAAC,EAAE,MAAM,EAAE,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;CAAG;AAEjE;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;CAAG;AAE/D;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;CAAG;AAE9D;;GAEG;AACH,MAAM,WAAW,iCAAkC,SAAQ,yBAAyB;CAAG;AAEvF;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,gBAAgB;IAClE;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,0BAA0B;IAChF,WAAW,EAAE,YAAY,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,oBAAoB;IACpE;;OAEG;IACH,WAAW,EAAE,YAAY,CAAC;CAC3B;AAED,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,aAAa,CAAC;AAE1D;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IACjE;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,gBAAgB;IAClE;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,gBAAgB;IAClE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;;;OAIG;IACH,cAAc,CAAC,EAAE,uBAAuB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkB;IACzC,OAAO,CAAC,UAAU,CAAwC;IAC1D,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAgC;IAE/D;;OAEG;IACH,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC;;OAEG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAgB;IAElD;;OAEG;IACI,QAAQ,EAAG,MAAM,CAAC;IAEzB;;;;;;;;;;;;;OAaG;gBACS,gBAAgB,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,6BAA6B;IAE9F;;;;;;;;;;;;;;;OAeG;gBAED,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,kBAAkB,GAAG,eAAe,EAChD,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,6BAA6B;IAuDzC;;;OAGG;IACI,KAAK,CAAC,SAAS,EAAE,MAAM,GAAG,cAAc;IAI/C;;;;;OAKG;IAEU,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IACxF;;;;;OAKG;IACU,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IACxF;;;;;OAKG;IACU,SAAS,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB9F;;;;;;OAMG;IACU,UAAU,CACrB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,MAAM,EAEf,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,IAAI,CAAC;IAEhB;;;;;;OAMG;IACU,UAAU,CACrB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,SAAS,EAClB,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,IAAI,CAAC;IAEhB;;;;;;OAMG;IACU,UAAU,CACrB,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE,eAAe,EACxB,OAAO,CAAC,EAAE,oBAAoB,GAAG,wBAAwB,GACxD,OAAO,CAAC,IAAI,CAAC;IAsBhB;;;;;;OAMG;IACU,gBAAgB,CAC3B,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,MAAM,EAEf,OAAO,EAAE,8BAA8B,GACtC,OAAO,CAAC,IAAI,CAAC;IAEhB;;;;;;OAMG;IACU,gBAAgB,CAC3B,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,SAAS,EAClB,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,IAAI,CAAC;IAEhB;;;;;;OAMG;IACU,gBAAgB,CAC3B,YAAY,EAAE,MAAM,EACpB,OAAO,EAAE,eAAe,EACxB,OAAO,CAAC,EAAE,0BAA0B,GAAG,8BAA8B,GACpE,OAAO,CAAC,IAAI,CAAC;IAuBhB;;;;;OAKG;IACU,gBAAgB,CAC3B,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,oBAAyB,GACjC,OAAO,CAAC,OAAO,CAAC;IAkCnB;;;;;OAKG;IACU,eAAe,CAC1B,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,IAAI,CAAC;IAUhB;;;;OAIG;IACU,mBAAmB,CAAC,OAAO,GAAE,6BAAkC,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5F;;;;;OAKG;IACU,oBAAoB,CAC/B,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,8BAAmC,GAC3C,OAAO,CAAC,IAAI,CAAC;IAUhB;;;;OAIG;IACU,uBAAuB,CAClC,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,IAAI,CAAC;IAUhB;;;;OAIG;IACU,6BAA6B,CACxC,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,IAAI,CAAC;IAchB;;;;;OAKG;IACU,sBAAsB,CACjC,MAAM,EAAE,MAAM,EAAE,EAChB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;;OAKG;IACU,2BAA2B,CACtC,MAAM,EAAE,MAAM,EAAE,EAChB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,4BAAiC,GACzC,OAAO,CAAC,IAAI,CAAC;IAiBhB;;;;;OAKG;IACU,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,GAAE,kBAAuB,GAAG,OAAO,CAAC,OAAO,CAAC;IAiC/F;;;;;OAKG;IACU,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,iBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC;IAkC5F;;;;;;OAMG;IACU,eAAe,CAC1B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,UAAU,EACtB,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;OAMG;IACU,gBAAgB,CAC3B,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,UAAU,EACtB,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,IAAI,CAAC;IAehB;;;;;;OAMG;IACU,aAAa,CACxB,YAAY,EAAE,MAAM,EACpB,UAAU,EAAE,UAAU,EACtB,OAAO,GAAE,uBAA4B,GACpC,OAAO,CAAC,OAAO,CAAC;IAkCnB;;;;OAIG;IACU,oBAAoB,CAC/B,OAAO,GAAE,0BAA+B,GACvC,OAAO,CAAC,mBAAmB,CAAC;CAsDhC"}

package/{dist-esm/src → dist/esm}/hubClient.js

@@ -1,16 +1,16 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 import { RestError } from "@azure/core-rest-pipeline";
-import { GeneratedClient } from "./generated/generatedClient";
-import { WebPubSubGroupImpl } from "./groupClient";
+import { GeneratedClient } from "./generated/generatedClient.js";
+import { WebPubSubGroupImpl } from "./groupClient.js";
 import { isTokenCredential } from "@azure/core-auth";
-import { webPubSubKeyCredentialPolicy } from "./webPubSubCredentialPolicy";
-import { tracingClient } from "./tracing";
-import { logger } from "./logger";
-import { parseConnectionString } from "./parseConnectionString";
+import { webPubSubKeyCredentialPolicy } from "./webPubSubCredentialPolicy.js";
+import { tracingClient } from "./tracing.js";
+import { logger } from "./logger.js";
+import { parseConnectionString } from "./parseConnectionString.js";
 import jwt from "jsonwebtoken";
-import { getPayloadForMessage } from "./utils";
-import { webPubSubReverseProxyPolicy } from "./reverseProxyPolicy";
+import { getPayloadForMessage } from "./utils.js";
+import { webPubSubReverseProxyPolicy } from "./reverseProxyPolicy.js";
 /**
  * Client for connecting to a Web PubSub hub
  */
@@ -334,7 +334,7 @@ export class WebPubSubServiceClient {
             const baseUrl = clientEndpoint + clientPath;
             let token;
             if (isTokenCredential(this.credential)) {
-                const response = await this.client.webPubSub.generateClientToken(this.hubName, updatedOptions);
+                const response = await this.client.webPubSub.generateClientToken(this.hubName, Object.assign(Object.assign({}, updatedOptions), { clientType: clientProtocol }));
                 token = response.token;
             }
             else {

package/dist/esm/hubClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hubClient.js","sourceRoot":"","sources":["../../src/hubClient.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAQlC,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAMjE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAEtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,GAAG,MAAM,cAAc,CAAC;AAC/B,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAMlD,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AAmRtE;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAyDjC,YACE,0BAAkC,EAClC,cAA8D,EAC9D,aAAsD,EACtD,IAAoC;;QApDtC;;WAEG;QACa,eAAU,GAAW,YAAY,CAAC;QAmDhD,+BAA+B;QAC/B,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;YACvC,IAAI,CAAC,QAAQ,GAAG,0BAA0B,CAAC;YAC3C,IAAI,CAAC,OAAO,GAAG,aAAuB,CAAC;YACvC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;YAC1B,IAAI,CAAC,UAAU,GAAG,cAAc,CAAC;QACnC,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,qBAAqB,CAAC,0BAA0B,CAAC,CAAC;YACnE,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;YAClC,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;YACtC,IAAI,CAAC,OAAO,GAAG,cAAwB,CAAC;YACxC,IAAI,CAAC,aAAa,GAAG,aAA8C,CAAC;QACtE,CAAC;QAED,MAAM,uBAAuB,iDACxB,IAAI,CAAC,aAAa,GAClB;YACD,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,cAAc,EAAE;gBACd,4BAA4B,EAC1B,MAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,cAAc,0CAAE,4BAA4B;gBAClE,gCAAgC,EAC9B,MAAA,MAAA,IAAI,CAAC,aAAa,0CAAE,cAAc,0CAAE,gCAAgC;gBACtE,MAAM,EAAE,MAAM,CAAC,IAAI;aACpB;SACF,GACE,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC;YACpC,CAAC,CAAC;gBACE,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,gBAAgB,EAAE,CAAC,sCAAsC,CAAC;aAC3D;YACH,CAAC,CAAC,EAAE,CAAC,CACR,CAAC;QAEF,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,QAAQ,EAAE,uBAAuB,CAAC,CAAC;QAE1E,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;QAChF,CAAC;QAED,IAAI,MAAA,IAAI,CAAC,aAAa,0CAAE,oBAAoB,EAAE,CAAC;YAC7C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAC5B,2BAA2B,CAAC,MAAA,IAAI,CAAC,aAAa,0CAAE,oBAAoB,CAAC,CACtE,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAiB;QAC5B,OAAO,IAAI,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IACtE,CAAC;IAyBM,KAAK,CAAC,SAAS,CACpB,OAAoC,EACpC,UAAyD,EAAE;QAE3D,OAAO,aAAa,CAAC,QAAQ,CAAC,kCAAkC,EAAE,OAAO,EAAE,CAAC,cAAc,EAAE,EAAE;YAC5F,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YAC/E,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CACpC,IAAI,CAAC,OAAO,EACZ,WAAW,EACX,OAAc,EACd,cAAc,CACf,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAyCM,KAAK,CAAC,UAAU,CACrB,QAAgB,EAChB,OAAoC,EACpC,UAAgC,EAAE;QAElC,OAAO,aAAa,CAAC,QAAQ,CAC3B,mCAAmC,EACnC,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YAC/E,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CACrC,IAAI,CAAC,OAAO,EACZ,QAAQ,EACR,WAAW,EACX,OAAc,EACd,cAAc,CACf,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAyCM,KAAK,CAAC,gBAAgB,CAC3B,YAAoB,EACpB,OAAoC,EACpC,UAAsC,EAAE;QAExC,OAAO,aAAa,CAAC,QAAQ,CAC3B,yCAAyC,EACzC,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YAE/E,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAC3C,IAAI,CAAC,OAAO,EACZ,YAAY,EACZ,WAAW,EACX,OAAc,EACd,cAAc,CACf,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,gBAAgB,CAC3B,YAAoB,EACpB,UAAgC,EAAE;QAElC,IAAI,QAA2C,CAAC;QAChD,SAAS,UAAU,CAAC,WAAkC,EAAE,YAAqB;YAC3E,QAAQ,GAAG,WAAW,CAAC;YACvB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACvB,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;QAED,OAAO,aAAa,CAAC,QAAQ,CAC3B,yCAAyC,EACzC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,kCAClE,cAAc,KACjB,UAAU,IACV,CAAC;YAEH,IAAI,QAAS,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,IAAI,QAAS,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACpC,OAAO,KAAK,CAAC;YACf,CAAC;iBAAM,CAAC;gBACN,mDAAmD;gBACnD,MAAM,IAAI,SAAS,CAAC,QAAS,CAAC,UAAW,EAAE;oBACzC,UAAU,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM;oBAC5B,OAAO,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO;oBAC1B,QAAQ,EAAE,QAAQ;iBACnB,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,eAAe,CAC1B,YAAoB,EACpB,UAAqC,EAAE;QAEvC,OAAO,aAAa,CAAC,QAAQ,CAC3B,wCAAwC,EACxC,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;QAC3F,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,mBAAmB,CAAC,UAAyC,EAAE;QAC1E,OAAO,aAAa,CAAC,QAAQ,CAC3B,4CAA4C,EAC5C,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;QACjF,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,oBAAoB,CAC/B,MAAc,EACd,UAA0C,EAAE;QAE5C,OAAO,aAAa,CAAC,QAAQ,CAC3B,6CAA6C,EAC7C,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,oBAAoB,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;QAC1F,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,uBAAuB,CAClC,MAAc,EACd,UAAqC,EAAE;QAEvC,OAAO,aAAa,CAAC,QAAQ,CAC3B,gDAAgD,EAChD,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,uBAAuB,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,cAAc,CAAC,CAAC;QAC7F,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,6BAA6B,CACxC,YAAoB,EACpB,UAAqC,EAAE;QAEvC,OAAO,aAAa,CAAC,QAAQ,CAC3B,sDAAsD,EACtD,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,6BAA6B,CACxD,IAAI,CAAC,OAAO,EACZ,YAAY,EACZ,cAAc,CACf,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,sBAAsB,CACjC,MAAgB,EAChB,MAAc,EACd,UAAqC,EAAE;QAEvC,OAAO,aAAa,CAAC,QAAQ,CAC3B,+CAA+C,EAC/C,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,sBAAsB,CACjD,IAAI,CAAC,OAAO,EACZ;gBACE,MAAM,EAAE,MAAM;gBACd,MAAM,EAAE,MAAM;aACO,EACvB,cAAc,CACf,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,2BAA2B,CACtC,MAAgB,EAChB,MAAc,EACd,UAAwC,EAAE;QAE1C,OAAO,aAAa,CAAC,QAAQ,CAC3B,oDAAoD,EACpD,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,2BAA2B,CACtD,IAAI,CAAC,OAAO,EACZ;gBACE,MAAM,EAAE,MAAM;gBACd,MAAM,EAAE,MAAM;aACY,EAC5B,cAAc,CACf,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,UAA8B,EAAE;QAC1E,IAAI,QAA2C,CAAC;QAChD,SAAS,UAAU,CAAC,WAAkC,EAAE,YAAqB;YAC3E,QAAQ,GAAG,WAAW,CAAC;YACvB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACvB,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;QAED,OAAO,aAAa,CAAC,QAAQ,CAC3B,oCAAoC,EACpC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,kCAC1D,cAAc,KACjB,UAAU,IACV,CAAC;YAEH,IAAI,QAAS,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,IAAI,QAAS,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACpC,OAAO,KAAK,CAAC;YACf,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,SAAS,CAAC,QAAS,CAAC,UAAW,EAAE;oBACzC,UAAU,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM;oBAC5B,OAAO,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO;oBAC1B,QAAQ,EAAE,QAAQ;iBACnB,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,UAA6B,EAAE;QACvE,IAAI,QAA2C,CAAC;QAChD,SAAS,UAAU,CAAC,WAAkC,EAAE,YAAqB;YAC3E,QAAQ,GAAG,WAAW,CAAC;YACvB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACvB,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;QAED,OAAO,aAAa,CAAC,QAAQ,CAC3B,mCAAmC,EACnC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,kCACxD,cAAc,KACjB,UAAU,IACV,CAAC;YAEH,IAAI,QAAS,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,IAAI,QAAS,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACpC,OAAO,KAAK,CAAC;YACf,CAAC;iBAAM,CAAC;gBACN,mDAAmD;gBACnD,MAAM,IAAI,SAAS,CAAC,QAAS,CAAC,UAAW,EAAE;oBACzC,UAAU,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM;oBAC5B,OAAO,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO;oBAC1B,QAAQ,EAAE,QAAQ;iBACnB,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,eAAe,CAC1B,YAAoB,EACpB,UAAsB,EACtB,UAAqC,EAAE;QAEvC,OAAO,aAAa,CAAC,QAAQ,CAC3B,wCAAwC,EACxC,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAC1C,IAAI,CAAC,OAAO,EACZ,UAAU,EACV,YAAY,EACZ,cAAc,CACf,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,gBAAgB,CAC3B,YAAoB,EACpB,UAAsB,EACtB,UAAsC,EAAE;QAExC,OAAO,aAAa,CAAC,QAAQ,CAC3B,yCAAyC,EACzC,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,gBAAgB,CAC3C,IAAI,CAAC,OAAO,EACZ,UAAU,EACV,YAAY,EACZ,cAAc,CACf,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,aAAa,CACxB,YAAoB,EACpB,UAAsB,EACtB,UAAmC,EAAE;QAErC,IAAI,QAA2C,CAAC;QAChD,SAAS,UAAU,CAAC,WAAkC,EAAE,YAAqB;YAC3E,QAAQ,GAAG,WAAW,CAAC;YACvB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;gBACvB,OAAO,CAAC,UAAU,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;YAChD,CAAC;QACH,CAAC;QAED,OAAO,aAAa,CAAC,QAAQ,CAC3B,sCAAsC,EACtC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,kCAC7E,cAAc,KACjB,UAAU,IACV,CAAC;YAEH,IAAI,QAAS,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,IAAI,QAAS,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBACpC,OAAO,KAAK,CAAC;YACf,CAAC;iBAAM,CAAC;gBACN,mDAAmD;gBACnD,MAAM,IAAI,SAAS,CAAC,QAAS,CAAC,UAAW,EAAE;oBACzC,UAAU,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM;oBAC5B,OAAO,EAAE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO;oBAC1B,QAAQ,EAAE,QAAQ;iBACnB,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,oBAAoB,CAC/B,UAAsC,EAAE;QAExC,OAAO,aAAa,CAAC,QAAQ,CAC3B,6CAA6C,EAC7C,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;YACnF,MAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAC;YACrE,MAAM,cAAc,GAAG,cAAc,CAAC,cAAc,CAAC;YACrD,IAAI,UAAU,GAAG,eAAe,IAAI,CAAC,OAAO,EAAE,CAAC;YAC/C,QAAQ,cAAc,EAAE,CAAC;gBACvB,KAAK,MAAM;oBACT,UAAU,GAAG,qBAAqB,IAAI,CAAC,OAAO,EAAE,CAAC;oBACjD,MAAM;gBACR,KAAK,UAAU;oBACb,UAAU,GAAG,yBAAyB,IAAI,CAAC,OAAO,EAAE,CAAC;YACzD,CAAC;YACD,MAAM,OAAO,GAAG,cAAc,GAAG,UAAU,CAAC;YAE5C,IAAI,KAAa,CAAC;YAClB,IAAI,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;gBACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAAC,IAAI,CAAC,OAAO,kCACxE,cAAc,KACjB,UAAU,EAAE,cAAc,IAC1B,CAAC;gBACH,KAAK,GAAG,QAAQ,CAAC,KAAM,CAAC;YAC1B,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC;gBAChC,MAAM,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;gBACvC,MAAM,OAAO,GAAG;oBACd,IAAI,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,KAAK;oBAC3B,iBAAiB,EAAE,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,MAAM;iBAC1C,CAAC;gBACF,MAAM,WAAW,GAAoB;oBACnC,QAAQ,EAAE,QAAQ;oBAClB,SAAS,EACP,CAAA,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,uBAAuB,MAAK,SAAS;wBACnD,CAAC,CAAC,IAAI;wBACN,CAAC,CAAC,GAAG,cAAc,CAAC,uBAAuB,GAAG;oBAClD,SAAS,EAAE,OAAO;iBACnB,CAAC;gBACF,IAAI,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,MAAM,EAAE,CAAC;oBAC3B,WAAW,CAAC,OAAO,GAAG,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,MAAM,CAAC;gBAC/C,CAAC;gBACD,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;YAC9C,CAAC;YAED,OAAO;gBACL,KAAK;gBACL,OAAO;gBACP,GAAG,EAAE,GAAG,OAAO,iBAAiB,KAAK,EAAE;aACxC,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type {\n  CommonClientOptions,\n  FullOperationResponse,\n  OperationOptions,\n} from \"@azure/core-client\";\nimport type { RequestBodyType } from \"@azure/core-rest-pipeline\";\nimport { RestError } from \"@azure/core-rest-pipeline\";\nimport { GeneratedClient } from \"./generated/generatedClient.js\";\nimport type {\n  WebPubSubGroup,\n  GroupAddConnectionOptions,\n  GroupRemoveConnectionOptions,\n} from \"./groupClient.js\";\nimport { WebPubSubGroupImpl } from \"./groupClient.js\";\nimport type { AzureKeyCredential, TokenCredential } from \"@azure/core-auth\";\nimport { isTokenCredential } from \"@azure/core-auth\";\nimport { webPubSubKeyCredentialPolicy } from \"./webPubSubCredentialPolicy.js\";\nimport { tracingClient } from \"./tracing.js\";\nimport { logger } from \"./logger.js\";\nimport { parseConnectionString } from \"./parseConnectionString.js\";\nimport jwt from \"jsonwebtoken\";\nimport { getPayloadForMessage } from \"./utils.js\";\nimport type {\n  GeneratedClientOptionalParams,\n  AddToGroupsRequest,\n  RemoveFromGroupsRequest,\n} from \"./generated/index.js\";\nimport { webPubSubReverseProxyPolicy } from \"./reverseProxyPolicy.js\";\n\n/**\n * Options for closing a connection to a hub.\n */\nexport interface HubCloseConnectionOptions extends OperationOptions {\n  /**\n   * Reason the connection is being closed.\n   */\n  reason?: string;\n}\n\n/**\n * Options for closing all connections to a hub.\n */\nexport interface HubCloseAllConnectionsOptions extends OperationOptions {\n  /**\n   * Reason the connection is being closed.\n   */\n  reason?: string;\n}\n\n/**\n * Options for closing all of a user's connections to a hub.\n */\nexport interface HubCloseUserConnectionsOptions extends OperationOptions {\n  /**\n   * Reason the connection is being closed.\n   */\n  reason?: string;\n}\n\n/**\n * Options for sending messages to hubs.\n */\nexport interface HubSendToAllOptions extends OperationOptions {\n  /**\n   * Connection ids to exclude from receiving this message.\n   */\n  excludedConnections?: string[];\n  /**\n   * The filter syntax to filter out the connections to send the messages to following OData filter syntax.\n   * Examples:\n   *  * Exclude connections from `user1` and `user2`: `userId ne 'user1' and userId ne 'user2'`\n   *  * Exclude connections in `group1`: `not('group1' in groups)`\n   * Details about `filter` syntax please see [OData filter syntax for Azure Web PubSub](https://aka.ms/awps/filter-syntax).\n   */\n  filter?: string;\n  /**\n   * The time-to-live (TTL) value in seconds for messages sent to the service.\n   * 0 is the default value, which means the message never expires.\n   * 300 is the maximum value.\n   * If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service.\n   * This parameter can help when the client's bandwidth is limited.\n   */\n  messageTtlSeconds?: number;\n}\n\n/**\n * Options for sending text messages to hubs.\n */\nexport interface HubSendTextToAllOptions extends HubSendToAllOptions {\n  /**\n   * The content will be sent to the clients in plain text.\n   */\n  contentType: \"text/plain\";\n}\n\n/**\n * Types which can be serialized and sent as JSON.\n */\nexport type JSONTypes = string | number | boolean | object;\n\n/**\n * Options for constructing a HubAdmin client.\n */\nexport interface WebPubSubServiceClientOptions extends CommonClientOptions {\n  /**\n   * Reverse proxy endpoint (for example, your Azure API management endpoint)\n   */\n  reverseProxyEndpoint?: string;\n  /**\n   * Options to configure the logging options.\n   */\n  loggingOptions?: WebPubSubServiceClientLogOptions;\n}\n\n/**\n * Options to configure the logging options.\n */\nexport declare interface WebPubSubServiceClientLogOptions {\n  /**\n   * Header names whose values will be logged when logging is enabled.\n   * Defaults include a list of well-known safe headers. Any headers\n   * specified in this field will be added to that list.  Any other values will\n   * be written to logs as \"REDACTED\".\n   */\n  additionalAllowedHeaderNames?: string[];\n  /**\n   * Query string names whose values will be logged when logging is enabled. By default no\n   * query string values are logged.\n   */\n  additionalAllowedQueryParameters?: string[];\n}\n\n/**\n * Options for checking if a connection exists.\n */\nexport interface HasConnectionOptions extends OperationOptions {}\n\n/**\n * Options for checking if a group exists.\n */\nexport interface HubHasGroupOptions extends OperationOptions {}\n\n/**\n * Options for checking if a user exists.\n */\nexport interface HubHasUserOptions extends OperationOptions {}\n\n/**\n * Options for removing a user from all groups.\n */\nexport interface HubRemoveUserFromAllGroupsOptions extends HubCloseConnectionOptions {}\n\n/**\n * Options for sending a message to a specific connection.\n */\nexport interface HubSendToConnectionOptions extends OperationOptions {\n  /**\n   * The time-to-live (TTL) value in seconds for messages sent to the service.\n   * 0 is the default value, which means the message never expires.\n   * 300 is the maximum value.\n   * If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service.\n   * This parameter can help when the client's bandwidth is limited.\n   */\n  messageTtlSeconds?: number;\n}\n\n/**\n * Options for sending a text message to a connection.\n */\nexport interface HubSendTextToConnectionOptions extends HubSendToConnectionOptions {\n  contentType: \"text/plain\";\n}\n\n/**\n * Options for sending a message to a user.\n */\nexport interface HubSendToUserOptions extends OperationOptions {\n  /**\n   * The filter syntax to filter out the connections to send the messages to following OData filter syntax.\n   * Examples:\n   *  * Exclude connections in `group1`: `not('group1' in groups)`\n   *  * Send to connections in `group1` or `group2`: `'group1' in groups or `group2` in groups`\n   * Details about `filter` syntax please see [OData filter syntax for Azure Web PubSub](https://aka.ms/awps/filter-syntax).\n   */\n  filter?: string;\n  /**\n   * The time-to-live (TTL) value in seconds for messages sent to the service.\n   * 0 is the default value, which means the message never expires.\n   * 300 is the maximum value.\n   * If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service.\n   * This parameter can help when the client's bandwidth is limited.\n   */\n  messageTtlSeconds?: number;\n}\n\n/**\n * Options for sending a text message to a user.\n */\nexport interface HubSendTextToUserOptions extends HubSendToUserOptions {\n  /**\n   * The content will be sent to the clients in plain text.\n   */\n  contentType: \"text/plain\";\n}\n\nexport type Permission = \"joinLeaveGroup\" | \"sendToGroup\";\n\n/**\n * Options for grant permissions to a connection\n */\nexport interface HubGrantPermissionOptions extends OperationOptions {\n  /**\n   * The meaning of the target depends on the specific permission.\n   * For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name.\n   */\n  targetName?: string;\n}\n\n/**\n * Options for revoke permissions from a connection\n */\nexport interface HubRevokePermissionOptions extends OperationOptions {\n  /**\n   * The meaning of the target depends on the specific permission.\n   * For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name.\n   */\n  targetName?: string;\n}\n\n/**\n * Options for checking if a connection has the specified permission\n */\nexport interface HubHasPermissionOptions extends OperationOptions {\n  /**\n   * The meaning of the target depends on the specific permission.\n   * For joinLeaveGroup and sendToGroup, targetName is a required parameter standing for the group name.\n   */\n  targetName?: string;\n}\n\n/**\n * The type of client endpoint that is being requested.\n */\nexport type WebPubSubClientProtocol = \"default\" | \"mqtt\" | \"socketio\";\n\n/**\n * Options for generating a token to connect a client to the Azure Web Pubsub service.\n */\nexport interface GenerateClientTokenOptions extends OperationOptions {\n  /**\n   * The userId for the client.\n   */\n  userId?: string;\n\n  /**\n   * The roles that the connection with the generated token will have.\n   * Roles give the client initial permissions to leave, join, or publish to groups when using PubSub subprotocol\n   * * `webpubsub.joinLeaveGroup`: the client can join or leave any group\n   * * `webpubsub.sendToGroup`: the client can send messages to any group\n   * * `webpubsub.joinLeaveGroup.<group>`: the client can join or leave group `<group>`\n   * * `webpubsub.sendToGroup.<group>`: the client can send messages to group `<group>`\n   *\n   * {@link https://azure.github.io/azure-webpubsub/references/pubsub-websocket-subprotocol#permissions}\n   */\n  roles?: string[];\n\n  /**\n   * Minutes until the token expires.\n   */\n  expirationTimeInMinutes?: number;\n\n  /**\n   * The groups to join when the client connects\n   */\n  groups?: string[];\n\n  /**\n   * The protocol type of the client\n   * * `default`: Default WebPubSub Client. Example Client Connection URL: _wss://exampleHost.com/client/hubs/exampleHub_\n   * * `mqtt`: MQTT Client. Example Client Connection URL:  _wss://exampleHost.com/client/mqtt/hubs/exampleHub_\n   */\n  clientProtocol?: WebPubSubClientProtocol;\n}\n\n/**\n * A response containing the client token.\n */\nexport interface ClientTokenResponse {\n  /**\n   * The client token.\n   */\n  token: string;\n  /**\n   * The URL client connects to\n   */\n  baseUrl: string;\n  /**\n   * The URL client connects to with access_token query string\n   */\n  url: string;\n}\n\n/**\n * Client for connecting to a Web PubSub hub\n */\nexport class WebPubSubServiceClient {\n  private readonly client: GeneratedClient;\n  private credential!: AzureKeyCredential | TokenCredential;\n  private readonly clientOptions?: WebPubSubServiceClientOptions;\n\n  /**\n   * The name of the hub this client is connected to\n   */\n  public readonly hubName: string;\n  /**\n   * The Web PubSub API version being used by this client\n   */\n  public readonly apiVersion: string = \"2024-01-01\";\n\n  /**\n   * The Web PubSub endpoint this client is connected to\n   */\n  public endpoint!: string;\n\n  /**\n   * Creates an instance of a WebPubSubServiceClient for sending messages and managing groups, connections, and users.\n   *\n   * Example usage:\n   * ```ts\n   * import { WebPubSubServiceClient } from \"@azure/web-pubsub\";\n   * const connectionString = process.env['WEB_PUBSUB_CONNECTION_STRING'];\n   * const client = new WebPubSubServiceClient(connectionString, 'chat');\n   * ```\n   *\n   * @param connectionString - The connection string\n   * @param hubName - The name of the hub to connect to. If omitted, '_default' is used.\n   * @param options - Options to configure the http pipeline\n   */\n  constructor(connectionString: string, hubName: string, options?: WebPubSubServiceClientOptions);\n\n  /**\n   * Creates an instance of a WebPubSubServiceClient for sending messages and managing groups, connections, and users.\n   *\n   * Example usage:\n   * ```ts\n   * import { WebPubSubServiceClient, AzureKeyCredential } from \"@azure/web-pubsub\";\n   * const cred = new AzureKeyCredential(\"<your web pubsub api key>\");\n   * const endpoint = \"https://xxxx.webpubsubdev.azure.com\"\n   * const client = new WebPubSubServiceClient(endpoint, cred, 'chat');\n   * ```\n   *\n   * @param endpoint - The endpoint to connect to\n   * @param credential - An AzureKeyCredential holding your service key\n   * @param hubName - The name of the hub to connect to.\n   * @param options - Options to configure the http pipeline\n   */\n  constructor(\n    endpoint: string,\n    credential: AzureKeyCredential | TokenCredential,\n    hubName: string,\n    options?: WebPubSubServiceClientOptions,\n  );\n  constructor(\n    endpointOrConnectionString: string,\n    credsOrHubName?: AzureKeyCredential | TokenCredential | string,\n    hubNameOrOpts?: string | WebPubSubServiceClientOptions,\n    opts?: WebPubSubServiceClientOptions,\n  ) {\n    // unpack constructor arguments\n    if (typeof credsOrHubName === \"object\") {\n      this.endpoint = endpointOrConnectionString;\n      this.hubName = hubNameOrOpts as string;\n      this.clientOptions = opts;\n      this.credential = credsOrHubName;\n    } else {\n      const parsedCs = parseConnectionString(endpointOrConnectionString);\n      this.endpoint = parsedCs.endpoint;\n      this.credential = parsedCs.credential;\n      this.hubName = credsOrHubName as string;\n      this.clientOptions = hubNameOrOpts as WebPubSubServiceClientOptions;\n    }\n\n    const internalPipelineOptions: GeneratedClientOptionalParams = {\n      ...this.clientOptions,\n      ...{\n        apiVersion: this.apiVersion,\n        loggingOptions: {\n          additionalAllowedHeaderNames:\n            this.clientOptions?.loggingOptions?.additionalAllowedHeaderNames,\n          additionalAllowedQueryParameters:\n            this.clientOptions?.loggingOptions?.additionalAllowedQueryParameters,\n          logger: logger.info,\n        },\n      },\n      ...(isTokenCredential(this.credential)\n        ? {\n            credential: this.credential,\n            credentialScopes: [\"https://webpubsub.azure.com/.default\"],\n          }\n        : {}),\n    };\n\n    this.client = new GeneratedClient(this.endpoint, internalPipelineOptions);\n\n    if (!isTokenCredential(this.credential)) {\n      this.client.pipeline.addPolicy(webPubSubKeyCredentialPolicy(this.credential));\n    }\n\n    if (this.clientOptions?.reverseProxyEndpoint) {\n      this.client.pipeline.addPolicy(\n        webPubSubReverseProxyPolicy(this.clientOptions?.reverseProxyEndpoint),\n      );\n    }\n  }\n\n  /**\n   * Get a client for a group\n   * @param groupName - The name of the group to connect to.\n   */\n  public group(groupName: string): WebPubSubGroup {\n    return new WebPubSubGroupImpl(this.client, this.hubName, groupName);\n  }\n\n  /**\n   * Broadcast a text message to all connections on this hub.\n   *\n   * @param message - The text message to send\n   * @param options - Additional options\n   */\n  // eslint-disable-next-line @azure/azure-sdk/ts-naming-options\n  public async sendToAll(message: string, options: HubSendTextToAllOptions): Promise<void>;\n  /**\n   * Broadcast a JSON message to all connections on this hub.\n   *\n   * @param message - The JSON message to send\n   * @param options - Additional options\n   */\n  public async sendToAll(message: JSONTypes, options?: HubSendToAllOptions): Promise<void>;\n  /**\n   * Broadcast a binary message to all connections on this hub.\n   *\n   * @param message - The message to send\n   * @param options - Additional options\n   */\n  public async sendToAll(message: RequestBodyType, options?: HubSendToAllOptions): Promise<void>;\n\n  public async sendToAll(\n    message: RequestBodyType | JSONTypes,\n    options: HubSendToAllOptions | HubSendTextToAllOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\"WebPubSubServiceClient.sendToAll\", options, (updatedOptions) => {\n      const { contentType, payload } = getPayloadForMessage(message, updatedOptions);\n      return this.client.webPubSub.sendToAll(\n        this.hubName,\n        contentType,\n        payload as any,\n        updatedOptions,\n      );\n    });\n  }\n\n  /**\n   * Send a text message to a specific user\n   *\n   * @param username - User name to send to\n   * @param message - The text message to send\n   * @param options - Additional options\n   */\n  public async sendToUser(\n    username: string,\n    message: string,\n    // eslint-disable-next-line @azure/azure-sdk/ts-naming-options\n    options: HubSendTextToUserOptions,\n  ): Promise<void>;\n\n  /**\n   * Send a JSON message to a specific user\n   *\n   * @param username - User name to send to\n   * @param message - The josn message to send\n   * @param options - Additional options\n   */\n  public async sendToUser(\n    username: string,\n    message: JSONTypes,\n    options?: HubSendToUserOptions,\n  ): Promise<void>;\n\n  /**\n   * Send a binary message to a specific user\n   *\n   * @param username - The user name to send to\n   * @param message - The binary message to send\n   * @param options - Additional options\n   */\n  public async sendToUser(\n    username: string,\n    message: RequestBodyType,\n    options?: HubSendToUserOptions | HubSendTextToUserOptions,\n  ): Promise<void>;\n  public async sendToUser(\n    username: string,\n    message: RequestBodyType | JSONTypes,\n    options: HubSendToUserOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.sendToUser\",\n      options,\n      (updatedOptions) => {\n        const { contentType, payload } = getPayloadForMessage(message, updatedOptions);\n        return this.client.webPubSub.sendToUser(\n          this.hubName,\n          username,\n          contentType,\n          payload as any,\n          updatedOptions,\n        );\n      },\n    );\n  }\n\n  /**\n   * Send a text message to a specific connection\n   *\n   * @param connectionId - Connection id to send to\n   * @param message - The text message\n   * @param options - Additional options\n   */\n  public async sendToConnection(\n    connectionId: string,\n    message: string,\n    // eslint-disable-next-line @azure/azure-sdk/ts-naming-options\n    options: HubSendTextToConnectionOptions,\n  ): Promise<void>;\n\n  /**\n   * Send a binary message to a specific connection\n   *\n   * @param connectionId - Connection id to send to\n   * @param message - The JSON message\n   * @param options - Additional options\n   */\n  public async sendToConnection(\n    connectionId: string,\n    message: JSONTypes,\n    options?: HubSendToConnectionOptions,\n  ): Promise<void>;\n\n  /**\n   * Send a binary message to a specific connection\n   *\n   * @param connectionId - Connection id to send to\n   * @param message - The binary message\n   * @param options - Additional options\n   */\n  public async sendToConnection(\n    connectionId: string,\n    message: RequestBodyType,\n    options?: HubSendToConnectionOptions | HubSendTextToConnectionOptions,\n  ): Promise<void>;\n  public async sendToConnection(\n    connectionId: string,\n    message: RequestBodyType | JSONTypes,\n    options: HubSendToConnectionOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.sendToConnection\",\n      options,\n      (updatedOptions) => {\n        const { contentType, payload } = getPayloadForMessage(message, updatedOptions);\n\n        return this.client.webPubSub.sendToConnection(\n          this.hubName,\n          connectionId,\n          contentType,\n          payload as any,\n          updatedOptions,\n        );\n      },\n    );\n  }\n\n  /**\n   * Check if a specific connection is connected to this hub\n   *\n   * @param connectionId - Connection id to check\n   * @param options - Additional options\n   */\n  public async connectionExists(\n    connectionId: string,\n    options: HasConnectionOptions = {},\n  ): Promise<boolean> {\n    let response: FullOperationResponse | undefined;\n    function onResponse(rawResponse: FullOperationResponse, flatResponse: unknown): void {\n      response = rawResponse;\n      if (options.onResponse) {\n        options.onResponse(rawResponse, flatResponse);\n      }\n    }\n\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.connectionExists\",\n      options,\n      async (updatedOptions) => {\n        await this.client.webPubSub.connectionExists(this.hubName, connectionId, {\n          ...updatedOptions,\n          onResponse,\n        });\n\n        if (response!.status === 200) {\n          return true;\n        } else if (response!.status === 404) {\n          return false;\n        } else {\n          // this is sad - wish this was handled by autorest.\n          throw new RestError(response!.bodyAsText!, {\n            statusCode: response?.status,\n            request: response?.request,\n            response: response,\n          });\n        }\n      },\n    );\n  }\n\n  /**\n   * Close a specific connection to this hub\n   *\n   * @param connectionId - Connection id to close\n   * @param options - Additional options\n   */\n  public async closeConnection(\n    connectionId: string,\n    options: HubCloseConnectionOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.closeConnection\",\n      options,\n      (updatedOptions) => {\n        return this.client.webPubSub.closeConnection(this.hubName, connectionId, updatedOptions);\n      },\n    );\n  }\n\n  /**\n   * Close all connections to this hub\n   *\n   * @param options - Additional options\n   */\n  public async closeAllConnections(options: HubCloseAllConnectionsOptions = {}): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.closeAllConnections\",\n      options,\n      (updatedOptions) => {\n        return this.client.webPubSub.closeAllConnections(this.hubName, updatedOptions);\n      },\n    );\n  }\n\n  /**\n   * Close all connections with the given user id\n   *\n   * @param user - User id to close\n   * @param options - Additional options\n   */\n  public async closeUserConnections(\n    userId: string,\n    options: HubCloseUserConnectionsOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.closeUserConnections\",\n      options,\n      (updatedOptions) => {\n        return this.client.webPubSub.closeUserConnections(this.hubName, userId, updatedOptions);\n      },\n    );\n  }\n\n  /**\n   * Remove a specific user from all groups they are joined to\n   * @param userId - The user id to remove from all groups\n   * @param options - Additional options\n   */\n  public async removeUserFromAllGroups(\n    userId: string,\n    options: HubCloseConnectionOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.removeUserFromAllGroups\",\n      options,\n      (updatedOptions) => {\n        return this.client.webPubSub.removeUserFromAllGroups(this.hubName, userId, updatedOptions);\n      },\n    );\n  }\n\n  /**\n   * Remove a specific connection from all groups they are joined to\n   * @param connectionId - The connection id to remove from all groups\n   * @param options - Additional options\n   */\n  public async removeConnectionFromAllGroups(\n    connectionId: string,\n    options: HubCloseConnectionOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.removeConnectionFromAllGroups\",\n      options,\n      (updatedOptions) => {\n        return this.client.webPubSub.removeConnectionFromAllGroups(\n          this.hubName,\n          connectionId,\n          updatedOptions,\n        );\n      },\n    );\n  }\n\n  /**\n   * Add filtered connections to multiple groups\n   * @param groups - A list of groups which target connections will be added into\n   * @param filter - An OData filter which target connections satisfy\n   * @param options - Additional options\n   */\n  public async addConnectionsToGroups(\n    groups: string[],\n    filter: string,\n    options: GroupAddConnectionOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.addConnectionsToGroups\",\n      options,\n      (updatedOptions) => {\n        return this.client.webPubSub.addConnectionsToGroups(\n          this.hubName,\n          {\n            groups: groups,\n            filter: filter,\n          } as AddToGroupsRequest,\n          updatedOptions,\n        );\n      },\n    );\n  }\n\n  /**\n   * Remove filtered connections from multiple groups\n   * @param groups - A list of groups which target connections will be removed from\n   * @param filter - An OData filter which target connections satisfy\n   * @param options - Additional options\n   */\n  public async removeConnectionsFromGroups(\n    groups: string[],\n    filter: string,\n    options: GroupRemoveConnectionOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.removeConnectionsFromGroups\",\n      options,\n      (updatedOptions) => {\n        return this.client.webPubSub.removeConnectionsFromGroups(\n          this.hubName,\n          {\n            groups: groups,\n            filter: filter,\n          } as RemoveFromGroupsRequest,\n          updatedOptions,\n        );\n      },\n    );\n  }\n\n  /**\n   * Check if a particular group exists (i.e. has active connections).\n   *\n   * @param groupName - The group name to check for\n   * @param options - Additional options\n   */\n  public async groupExists(groupName: string, options: HubHasGroupOptions = {}): Promise<boolean> {\n    let response: FullOperationResponse | undefined;\n    function onResponse(rawResponse: FullOperationResponse, flatResponse: unknown): void {\n      response = rawResponse;\n      if (options.onResponse) {\n        options.onResponse(rawResponse, flatResponse);\n      }\n    }\n\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.groupExists\",\n      options,\n      async (updatedOptions) => {\n        await this.client.webPubSub.groupExists(this.hubName, groupName, {\n          ...updatedOptions,\n          onResponse,\n        });\n\n        if (response!.status === 200) {\n          return true;\n        } else if (response!.status === 404) {\n          return false;\n        } else {\n          throw new RestError(response!.bodyAsText!, {\n            statusCode: response?.status,\n            request: response?.request,\n            response: response,\n          });\n        }\n      },\n    );\n  }\n\n  /**\n   * Check if a particular user is connected to this hub.\n   *\n   * @param username - The user name to check for\n   * @param options - Additional options\n   */\n  public async userExists(username: string, options: HubHasUserOptions = {}): Promise<boolean> {\n    let response: FullOperationResponse | undefined;\n    function onResponse(rawResponse: FullOperationResponse, flatResponse: unknown): void {\n      response = rawResponse;\n      if (options.onResponse) {\n        options.onResponse(rawResponse, flatResponse);\n      }\n    }\n\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.userExists\",\n      options,\n      async (updatedOptions) => {\n        await this.client.webPubSub.userExists(this.hubName, username, {\n          ...updatedOptions,\n          onResponse,\n        });\n\n        if (response!.status === 200) {\n          return true;\n        } else if (response!.status === 404) {\n          return false;\n        } else {\n          // this is sad - wish this was handled by autorest.\n          throw new RestError(response!.bodyAsText!, {\n            statusCode: response?.status,\n            request: response?.request,\n            response: response,\n          });\n        }\n      },\n    );\n  }\n\n  /**\n   * Grant permissions to a connection\n   *\n   * @param connectionId - The connection id to grant permissions to\n   * @param Permission - The permission to grant\n   * @param options - Additional options\n   */\n  public async grantPermission(\n    connectionId: string,\n    permission: Permission,\n    options: HubGrantPermissionOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.grantPermission\",\n      options,\n      (updatedOptions) => {\n        return this.client.webPubSub.grantPermission(\n          this.hubName,\n          permission,\n          connectionId,\n          updatedOptions,\n        );\n      },\n    );\n  }\n\n  /**\n   * Revoke permissions from a connection\n   *\n   * @param connectionId - The connection id to revoke permissions from\n   * @param Permission - The permission to revoke\n   * @param options - Additional options\n   */\n  public async revokePermission(\n    connectionId: string,\n    permission: Permission,\n    options: HubRevokePermissionOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.revokePermission\",\n      options,\n      (updatedOptions) => {\n        return this.client.webPubSub.revokePermission(\n          this.hubName,\n          permission,\n          connectionId,\n          updatedOptions,\n        );\n      },\n    );\n  }\n\n  /**\n   * Check if the connection has the specified permission\n   *\n   * @param connectionId - The connection id to check permission\n   * @param Permission - The permission to check\n   * @param options - Additional options\n   */\n  public async hasPermission(\n    connectionId: string,\n    permission: Permission,\n    options: HubHasPermissionOptions = {},\n  ): Promise<boolean> {\n    let response: FullOperationResponse | undefined;\n    function onResponse(rawResponse: FullOperationResponse, flatResponse: unknown): void {\n      response = rawResponse;\n      if (options.onResponse) {\n        options.onResponse(rawResponse, flatResponse);\n      }\n    }\n\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.hasPermission\",\n      options,\n      async (updatedOptions) => {\n        await this.client.webPubSub.checkPermission(this.hubName, permission, connectionId, {\n          ...updatedOptions,\n          onResponse,\n        });\n\n        if (response!.status === 200) {\n          return true;\n        } else if (response!.status === 404) {\n          return false;\n        } else {\n          // this is sad - wish this was handled by autorest.\n          throw new RestError(response!.bodyAsText!, {\n            statusCode: response?.status,\n            request: response?.request,\n            response: response,\n          });\n        }\n      },\n    );\n  }\n\n  /**\n   * Generate a token for a client to connect to the Azure Web PubSub service.\n   *\n   * @param options - Additional options\n   */\n  public async getClientAccessToken(\n    options: GenerateClientTokenOptions = {},\n  ): Promise<ClientTokenResponse> {\n    return tracingClient.withSpan(\n      \"WebPubSubServiceClient.getClientAccessToken\",\n      options,\n      async (updatedOptions) => {\n        const endpoint = this.endpoint.endsWith(\"/\") ? this.endpoint : this.endpoint + \"/\";\n        const clientEndpoint = endpoint.replace(/(http)(s?:\\/\\/)/gi, \"ws$2\");\n        const clientProtocol = updatedOptions.clientProtocol;\n        let clientPath = `client/hubs/${this.hubName}`;\n        switch (clientProtocol) {\n          case \"mqtt\":\n            clientPath = `clients/mqtt/hubs/${this.hubName}`;\n            break;\n          case \"socketio\":\n            clientPath = `clients/socketio/hubs/${this.hubName}`;\n        }\n        const baseUrl = clientEndpoint + clientPath;\n\n        let token: string;\n        if (isTokenCredential(this.credential)) {\n          const response = await this.client.webPubSub.generateClientToken(this.hubName, {\n            ...updatedOptions,\n            clientType: clientProtocol,\n          });\n          token = response.token!;\n        } else {\n          const key = this.credential.key;\n          const audience = endpoint + clientPath;\n          const payload = {\n            role: updatedOptions?.roles,\n            \"webpubsub.group\": updatedOptions?.groups,\n          };\n          const signOptions: jwt.SignOptions = {\n            audience: audience,\n            expiresIn:\n              updatedOptions?.expirationTimeInMinutes === undefined\n                ? \"1h\"\n                : `${updatedOptions.expirationTimeInMinutes}m`,\n            algorithm: \"HS256\",\n          };\n          if (updatedOptions?.userId) {\n            signOptions.subject = updatedOptions?.userId;\n          }\n          token = jwt.sign(payload, key, signOptions);\n        }\n\n        return {\n          token,\n          baseUrl,\n          url: `${baseUrl}?access_token=${token}`,\n        };\n      },\n    );\n  }\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,5 @@
+export { AzureKeyCredential } from "@azure/core-auth";
+export { WebPubSubServiceClient, HubSendToAllOptions, ClientTokenResponse, HubCloseConnectionOptions, HubCloseAllConnectionsOptions, HubCloseUserConnectionsOptions, GenerateClientTokenOptions, HasConnectionOptions, HubHasGroupOptions, HubHasUserOptions, WebPubSubServiceClientOptions, WebPubSubServiceClientLogOptions, HubRemoveUserFromAllGroupsOptions, HubSendToConnectionOptions, HubSendToUserOptions, HubGrantPermissionOptions, HubRevokePermissionOptions, HubHasPermissionOptions, HubSendTextToAllOptions, HubSendTextToConnectionOptions, HubSendTextToUserOptions, JSONTypes, Permission, WebPubSubClientProtocol, } from "./hubClient.js";
+export { WebPubSubGroup, GroupAddConnectionOptions, GroupCloseAllConnectionsOptions, GroupAddUserOptions, GroupAdminClientOptions, GroupHasUserOptions, GroupRemoveConnectionOptions, GroupRemoveUserOptions, GroupSendTextToAllOptions, GroupSendToAllOptions, } from "./groupClient.js";
+export { odata } from "./utils.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EACL,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,6BAA6B,EAC7B,8BAA8B,EAC9B,0BAA0B,EAC1B,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,EACjB,6BAA6B,EAC7B,gCAAgC,EAChC,iCAAiC,EACjC,0BAA0B,EAC1B,oBAAoB,EACpB,yBAAyB,EACzB,0BAA0B,EAC1B,uBAAuB,EACvB,uBAAuB,EACvB,8BAA8B,EAC9B,wBAAwB,EACxB,SAAS,EACT,UAAU,EACV,uBAAuB,GACxB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,cAAc,EACd,yBAAyB,EACzB,+BAA+B,EAC/B,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,4BAA4B,EAC5B,sBAAsB,EACtB,yBAAyB,EACzB,qBAAqB,GACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC"}

package/{dist-esm/src → dist/esm}/index.js

@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 export { AzureKeyCredential } from "@azure/core-auth";
-export { WebPubSubServiceClient, } from "./hubClient";
-export { odata } from "./utils";
+export { WebPubSubServiceClient, } from "./hubClient.js";
+export { odata } from "./utils.js";
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EACL,sBAAsB,GAwBvB,MAAM,gBAAgB,CAAC;AAaxB,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nexport { AzureKeyCredential } from \"@azure/core-auth\";\nexport {\n  WebPubSubServiceClient,\n  HubSendToAllOptions,\n  ClientTokenResponse,\n  HubCloseConnectionOptions,\n  HubCloseAllConnectionsOptions,\n  HubCloseUserConnectionsOptions,\n  GenerateClientTokenOptions,\n  HasConnectionOptions,\n  HubHasGroupOptions,\n  HubHasUserOptions,\n  WebPubSubServiceClientOptions,\n  WebPubSubServiceClientLogOptions,\n  HubRemoveUserFromAllGroupsOptions,\n  HubSendToConnectionOptions,\n  HubSendToUserOptions,\n  HubGrantPermissionOptions,\n  HubRevokePermissionOptions,\n  HubHasPermissionOptions,\n  HubSendTextToAllOptions,\n  HubSendTextToConnectionOptions,\n  HubSendTextToUserOptions,\n  JSONTypes,\n  Permission,\n  WebPubSubClientProtocol,\n} from \"./hubClient.js\";\nexport {\n  WebPubSubGroup,\n  GroupAddConnectionOptions,\n  GroupCloseAllConnectionsOptions,\n  GroupAddUserOptions,\n  GroupAdminClientOptions,\n  GroupHasUserOptions,\n  GroupRemoveConnectionOptions,\n  GroupRemoveUserOptions,\n  GroupSendTextToAllOptions,\n  GroupSendToAllOptions,\n} from \"./groupClient.js\";\nexport { odata } from \"./utils.js\";\n"]}