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

package/dist/commonjs/groupClient.d.ts

@@ -0,0 +1,232 @@
+import type { CommonClientOptions, OperationOptions } from "@azure/core-client";
+import type { RequestBodyType } from "@azure/core-rest-pipeline";
+import type { GeneratedClient } from "./generated/generatedClient.js";
+import type { JSONTypes } from "./hubClient.js";
+/**
+ * Options for constructing a GroupAdmin client.
+ */
+export interface GroupAdminClientOptions extends CommonClientOptions {
+}
+/**
+ * Options for adding a connection to a group.
+ */
+export interface GroupAddConnectionOptions extends OperationOptions {
+}
+/**
+ * Options for adding a user to a group.
+ */
+export interface GroupAddUserOptions extends OperationOptions {
+}
+/**
+ * Options for checking if a user is in a group
+ */
+export interface GroupHasUserOptions extends OperationOptions {
+}
+/**
+ * Options for removing a user from a group
+ */
+export interface GroupRemoveUserOptions extends OperationOptions {
+}
+/**
+ * Options for removing a connection from a group
+ */
+export interface GroupRemoveConnectionOptions extends OperationOptions {
+}
+/**
+ * Options for sending messages to a group.
+ */
+export interface GroupSendToAllOptions 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 a group..
+ */
+export interface GroupSendTextToAllOptions extends GroupSendToAllOptions {
+    /**
+     * The content will be sent to the clients in plain text.
+     */
+    contentType: "text/plain";
+}
+/**
+ * Options for closing all connections to a group.
+ */
+export interface GroupCloseAllConnectionsOptions extends OperationOptions {
+    /**
+     * Reason the connection is being closed.
+     */
+    reason?: string;
+}
+export interface WebPubSubGroup {
+    /**
+     * The name of this group
+     */
+    readonly groupName: string;
+    /**
+     * The name of the hub this group belongs 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
+     */
+    readonly endpoint: string;
+    /**
+     * Add a specific connection to this group
+     *
+     * @param connectionId - The connection id to add to this group
+     * @param options - Additional options
+     */
+    addConnection(connectionId: string, options?: GroupAddConnectionOptions): Promise<void>;
+    /**
+     * Remove a specific connection from this group
+     *
+     * @param connectionId - The connection id to remove from this group
+     * @param options - Additional options
+     */
+    removeConnection(connectionId: string, options?: GroupRemoveConnectionOptions): Promise<void>;
+    /**
+     * Close all connections to the group
+     *
+     * @param options - Additional options
+     */
+    closeAllConnections(options?: GroupCloseAllConnectionsOptions): Promise<void>;
+    /**
+     * Add a user to this group
+     *
+     * @param username - The user name to add
+     * @param options - Additional options
+     */
+    addUser(username: string, options?: GroupAddUserOptions): Promise<void>;
+    /**
+     * Remove a user from this group
+     *
+     * @param username - The user name to remove
+     * @param options - Additional options
+     */
+    removeUser(username: string, options?: GroupRemoveUserOptions): Promise<void>;
+    /**
+     * Send a text message to every connection in this group
+     *
+     * @param message - The message to send
+     * @param options - Additional options
+     */
+    sendToAll(message: string, options: GroupSendTextToAllOptions): Promise<void>;
+    /**
+     * Send a json message to every connection in this group
+     *
+     * @param message - The message to send
+     * @param options - Additional options
+     */
+    sendToAll(message: JSONTypes, options?: GroupSendToAllOptions): Promise<void>;
+    /**
+     * Send a binary message to every connection in this group
+     *
+     * @param message - The binary message to send
+     * @param options - Additional options
+     */
+    sendToAll(message: RequestBodyType, options?: GroupSendToAllOptions): Promise<void>;
+}
+/**
+ * @hidden
+ */
+export declare class WebPubSubGroupImpl implements WebPubSubGroup {
+    private client;
+    /**
+     * The name of this group
+     */
+    readonly groupName: string;
+    /**
+     * The name of the hub this group belongs 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;
+    /**
+     * @internal
+     */
+    constructor(client: GeneratedClient, hubName: string, groupName: string);
+    /**
+     * Add a specific connection to this group
+     *
+     * @param connectionId - The connection id to add to this group
+     * @param options - Additional options
+     */
+    addConnection(connectionId: string, options?: GroupAddConnectionOptions): Promise<void>;
+    /**
+     * Remove a specific connection from this group
+     *
+     * @param connectionId - The connection id to remove from this group
+     * @param options - Additional options
+     */
+    removeConnection(connectionId: string, options?: GroupRemoveConnectionOptions): Promise<void>;
+    /**
+     * Close all connections to this group
+     *
+     * @param options - Additional options
+     */
+    closeAllConnections(options?: GroupCloseAllConnectionsOptions): Promise<void>;
+    /**
+     * Add a user to this group
+     *
+     * @param username - The user name to add
+     * @param options - Additional options
+     */
+    addUser(username: string, options?: GroupAddUserOptions): Promise<void>;
+    /**
+     * Remove a user from this group
+     *
+     * @param username - The user name to remove
+     * @param options - Additional options
+     */
+    removeUser(username: string, options?: GroupRemoveUserOptions): Promise<void>;
+    /**
+     * Send a text message to every connection in this group
+     *
+     * @param message - The message to send
+     * @param options - Additional options
+     */
+    sendToAll(message: string, options: GroupSendTextToAllOptions): Promise<void>;
+    /**
+     * Send a json message to every connection in this group
+     *
+     * @param message - The message to send
+     * @param options - Additional options
+     */
+    sendToAll(message: JSONTypes, options?: GroupSendToAllOptions): Promise<void>;
+    /**
+     * Send a binary message to every connection in this group
+     *
+     * @param message - The binary message to send
+     * @param options - Additional options
+     */
+    sendToAll(message: RequestBodyType, options?: GroupSendToAllOptions): Promise<void>;
+}
+//# sourceMappingURL=groupClient.d.ts.map

package/dist/commonjs/groupClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"groupClient.d.ts","sourceRoot":"","sources":["../../src/groupClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,mBAAmB,EAEnB,gBAAgB,EACjB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAEjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AAGtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB;CAAG;AAEvE;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;CAAG;AAEtE;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;CAAG;AAEhE;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;CAAG;AAEhE;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;CAAG;AAEnE;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,gBAAgB;CAAG;AAEzE;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D;;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,yBAA0B,SAAQ,qBAAqB;IACtE;;OAEG;IACH,WAAW,EAAE,YAAY,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,gBAAgB;IACvE;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B;;;;;OAKG;IACH,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExF;;;;;OAKG;IACH,gBAAgB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9F;;;;OAIG;IACH,mBAAmB,CAAC,OAAO,CAAC,EAAE,+BAA+B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9E;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9E;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACrF;AAED;;GAEG;AACH,qBAAa,kBAAmB,YAAW,cAAc;IACvD,OAAO,CAAC,MAAM,CAAmB;IAEjC;;OAEG;IACH,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,SAAgB,OAAO,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,SAAgB,UAAU,EAAE,MAAM,CAAgB;IAElD;;OAEG;IACI,QAAQ,EAAG,MAAM,CAAC;IAEzB;;OAEG;gBACS,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM;IAKvE;;;;;OAKG;IACU,aAAa,CACxB,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,IAAI,CAAC;IAkChB;;;;;OAKG;IACU,gBAAgB,CAC3B,YAAY,EAAE,MAAM,EACpB,OAAO,GAAE,4BAAiC,GACzC,OAAO,CAAC,IAAI,CAAC;IAehB;;;;OAIG;IACU,mBAAmB,CAAC,OAAO,GAAE,+BAAoC,GAAG,OAAO,CAAC,IAAI,CAAC;IAa9F;;;;;OAKG;IACU,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB,GAAG,OAAO,CAAC,IAAI,CAAC;IAWxF;;;;;OAKG;IACU,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,sBAA2B,GAAG,OAAO,CAAC,IAAI,CAAC;IAW9F;;;;;OAKG;IACU,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC;IAC1F;;;;;OAKG;IACU,SAAS,CAAC,OAAO,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAC1F;;;;;OAKG;IACU,SAAS,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;CAiBjG"}

package/dist/commonjs/groupClient.js

@@ -0,0 +1,101 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebPubSubGroupImpl = void 0;
+const core_rest_pipeline_1 = require("@azure/core-rest-pipeline");
+const tracing_js_1 = require("./tracing.js");
+const utils_js_1 = require("./utils.js");
+/**
+ * @hidden
+ */
+class WebPubSubGroupImpl {
+    /**
+     * @internal
+     */
+    constructor(client, hubName, groupName) {
+        /**
+         * The Web PubSub API version being used by this client
+         */
+        this.apiVersion = "2020-10-01";
+        this.client = client;
+        this.groupName = groupName;
+        this.hubName = hubName;
+    }
+    /**
+     * Add a specific connection to this group
+     *
+     * @param connectionId - The connection id to add to this group
+     * @param options - Additional options
+     */
+    async addConnection(connectionId, options = {}) {
+        let response;
+        function onResponse(rawResponse, flatResponse) {
+            response = rawResponse;
+            if (options.onResponse) {
+                options.onResponse(rawResponse, flatResponse);
+            }
+        }
+        return tracing_js_1.tracingClient.withSpan("WebPubSubGroupClient.addConnection", options, async (updatedOptions) => {
+            await this.client.webPubSub.addConnectionToGroup(this.hubName, this.groupName, connectionId, Object.assign(Object.assign({}, updatedOptions), { onResponse }));
+            if (response.status === 404) {
+                throw new core_rest_pipeline_1.RestError(`Connection id '${connectionId}' doesn't exist`, {
+                    statusCode: response === null || response === void 0 ? void 0 : response.status,
+                    request: response === null || response === void 0 ? void 0 : response.request,
+                    response: response,
+                });
+            }
+        });
+    }
+    /**
+     * Remove a specific connection from this group
+     *
+     * @param connectionId - The connection id to remove from this group
+     * @param options - Additional options
+     */
+    async removeConnection(connectionId, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("WebPubSubGroupClient.removeConnection", options, (updatedOptions) => {
+            return this.client.webPubSub.removeConnectionFromGroup(this.hubName, this.groupName, connectionId, updatedOptions);
+        });
+    }
+    /**
+     * Close all connections to this group
+     *
+     * @param options - Additional options
+     */
+    async closeAllConnections(options = {}) {
+        return tracing_js_1.tracingClient.withSpan("WebPubSubGroupClient.closeAllConnections", options, (updatedOptions) => {
+            return this.client.webPubSub.closeGroupConnections(this.hubName, this.groupName, updatedOptions);
+        });
+    }
+    /**
+     * Add a user to this group
+     *
+     * @param username - The user name to add
+     * @param options - Additional options
+     */
+    async addUser(username, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("WebPubSubGroupClient.addUser", options, (updatedOptions) => {
+            return this.client.webPubSub.addUserToGroup(this.hubName, this.groupName, username, updatedOptions);
+        });
+    }
+    /**
+     * Remove a user from this group
+     *
+     * @param username - The user name to remove
+     * @param options - Additional options
+     */
+    async removeUser(username, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("WebPubSubGroupClient.removeUser", options, (updatedOptions) => {
+            return this.client.webPubSub.removeUserFromGroup(this.hubName, this.groupName, username, updatedOptions);
+        });
+    }
+    async sendToAll(message, options = {}) {
+        return tracing_js_1.tracingClient.withSpan("WebPubSubGroupClient.sendToAll", options, (updatedOptions) => {
+            const { contentType, payload } = (0, utils_js_1.getPayloadForMessage)(message, updatedOptions);
+            return this.client.webPubSub.sendToGroup(this.hubName, this.groupName, contentType, payload, updatedOptions);
+        });
+    }
+}
+exports.WebPubSubGroupImpl = WebPubSubGroupImpl;
+//# sourceMappingURL=groupClient.js.map

package/dist/commonjs/groupClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"groupClient.js","sourceRoot":"","sources":["../../src/groupClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAQlC,kEAAsD;AAEtD,6CAA6C;AAC7C,yCAAkD;AAkKlD;;GAEG;AACH,MAAa,kBAAkB;IAuB7B;;OAEG;IACH,YAAY,MAAuB,EAAE,OAAe,EAAE,SAAiB;QAbvE;;WAEG;QACa,eAAU,GAAW,YAAY,CAAC;QAWhD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CACxB,YAAoB,EACpB,UAAqC,EAAE;QAEvC,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,0BAAa,CAAC,QAAQ,CAC3B,oCAAoC,EACpC,OAAO,EACP,KAAK,EAAE,cAAc,EAAE,EAAE;YACvB,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,oBAAoB,CAC9C,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,SAAS,EACd,YAAY,kCAEP,cAAc,KACjB,UAAU,IAEb,CAAC;YAEF,IAAI,QAAS,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC7B,MAAM,IAAI,8BAAS,CAAC,kBAAkB,YAAY,iBAAiB,EAAE;oBACnE,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,gBAAgB,CAC3B,YAAoB,EACpB,UAAwC,EAAE;QAE1C,OAAO,0BAAa,CAAC,QAAQ,CAC3B,uCAAuC,EACvC,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,yBAAyB,CACpD,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,SAAS,EACd,YAAY,EACZ,cAAc,CACf,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,mBAAmB,CAAC,UAA2C,EAAE;QAC5E,OAAO,0BAAa,CAAC,QAAQ,CAC3B,0CAA0C,EAC1C,OAAO,EACP,CAAC,cAAc,EAAE,EAAE;YACjB,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,qBAAqB,CAChD,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,SAAS,EACd,cAAc,CACf,CAAC;QACJ,CAAC,CACF,CAAC;IACJ,CAAC;IACD;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,QAAgB,EAAE,UAA+B,EAAE;QACtE,OAAO,0BAAa,CAAC,QAAQ,CAAC,8BAA8B,EAAE,OAAO,EAAE,CAAC,cAAc,EAAE,EAAE;YACxF,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CACzC,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,SAAS,EACd,QAAQ,EACR,cAAc,CACf,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,UAAU,CAAC,QAAgB,EAAE,UAAkC,EAAE;QAC5E,OAAO,0BAAa,CAAC,QAAQ,CAAC,iCAAiC,EAAE,OAAO,EAAE,CAAC,cAAc,EAAE,EAAE;YAC3F,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,mBAAmB,CAC9C,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,SAAS,EACd,QAAQ,EACR,cAAc,CACf,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAwBM,KAAK,CAAC,SAAS,CACpB,OAAoC,EACpC,UAA6D,EAAE;QAE/D,OAAO,0BAAa,CAAC,QAAQ,CAAC,gCAAgC,EAAE,OAAO,EAAE,CAAC,cAAc,EAAE,EAAE;YAC1F,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAA,+BAAoB,EAAC,OAAO,EAAE,cAAc,CAAC,CAAC;YAC/E,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,WAAW,CACtC,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,SAAS,EACd,WAAW,EACX,OAAc,EACd,cAAc,CACf,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA3LD,gDA2LC","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 type { GeneratedClient } from \"./generated/generatedClient.js\";\nimport { tracingClient } from \"./tracing.js\";\nimport { getPayloadForMessage } from \"./utils.js\";\nimport type { JSONTypes } from \"./hubClient.js\";\n\n/**\n * Options for constructing a GroupAdmin client.\n */\nexport interface GroupAdminClientOptions extends CommonClientOptions {}\n\n/**\n * Options for adding a connection to a group.\n */\nexport interface GroupAddConnectionOptions extends OperationOptions {}\n\n/**\n * Options for adding a user to a group.\n */\nexport interface GroupAddUserOptions extends OperationOptions {}\n\n/**\n * Options for checking if a user is in a group\n */\nexport interface GroupHasUserOptions extends OperationOptions {}\n\n/**\n * Options for removing a user from a group\n */\nexport interface GroupRemoveUserOptions extends OperationOptions {}\n\n/**\n * Options for removing a connection from a group\n */\nexport interface GroupRemoveConnectionOptions extends OperationOptions {}\n\n/**\n * Options for sending messages to a group.\n */\nexport interface GroupSendToAllOptions 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 a group..\n */\nexport interface GroupSendTextToAllOptions extends GroupSendToAllOptions {\n  /**\n   * The content will be sent to the clients in plain text.\n   */\n  contentType: \"text/plain\";\n}\n\n/**\n * Options for closing all connections to a group.\n */\nexport interface GroupCloseAllConnectionsOptions extends OperationOptions {\n  /**\n   * Reason the connection is being closed.\n   */\n  reason?: string;\n}\n\nexport interface WebPubSubGroup {\n  /**\n   * The name of this group\n   */\n  readonly groupName: string;\n\n  /**\n   * The name of the hub this group belongs to\n   */\n  readonly hubName: string;\n\n  /**\n   * The Web PubSub API version being used by this client\n   */\n  readonly apiVersion: string;\n\n  /**\n   * The Web PubSub endpoint this client is connected to\n   */\n  readonly endpoint: string;\n\n  /**\n   * Add a specific connection to this group\n   *\n   * @param connectionId - The connection id to add to this group\n   * @param options - Additional options\n   */\n  addConnection(connectionId: string, options?: GroupAddConnectionOptions): Promise<void>;\n\n  /**\n   * Remove a specific connection from this group\n   *\n   * @param connectionId - The connection id to remove from this group\n   * @param options - Additional options\n   */\n  removeConnection(connectionId: string, options?: GroupRemoveConnectionOptions): Promise<void>;\n\n  /**\n   * Close all connections to the group\n   *\n   * @param options - Additional options\n   */\n  closeAllConnections(options?: GroupCloseAllConnectionsOptions): Promise<void>;\n\n  /**\n   * Add a user to this group\n   *\n   * @param username - The user name to add\n   * @param options - Additional options\n   */\n  addUser(username: string, options?: GroupAddUserOptions): Promise<void>;\n\n  /**\n   * Remove a user from this group\n   *\n   * @param username - The user name to remove\n   * @param options - Additional options\n   */\n  removeUser(username: string, options?: GroupRemoveUserOptions): Promise<void>;\n\n  /**\n   * Send a text message to every connection in this group\n   *\n   * @param message - The message to send\n   * @param options - Additional options\n   */\n  sendToAll(message: string, options: GroupSendTextToAllOptions): Promise<void>;\n  /**\n   * Send a json message to every connection in this group\n   *\n   * @param message - The message to send\n   * @param options - Additional options\n   */\n  sendToAll(message: JSONTypes, options?: GroupSendToAllOptions): Promise<void>;\n  /**\n   * Send a binary message to every connection in this group\n   *\n   * @param message - The binary message to send\n   * @param options - Additional options\n   */\n  sendToAll(message: RequestBodyType, options?: GroupSendToAllOptions): Promise<void>;\n}\n\n/**\n * @hidden\n */\nexport class WebPubSubGroupImpl implements WebPubSubGroup {\n  private client!: GeneratedClient;\n\n  /**\n   * The name of this group\n   */\n  public readonly groupName: string;\n\n  /**\n   * The name of the hub this group belongs to\n   */\n  public readonly hubName: string;\n\n  /**\n   * The Web PubSub API version being used by this client\n   */\n  public readonly apiVersion: string = \"2020-10-01\";\n\n  /**\n   * The Web PubSub endpoint this client is connected to\n   */\n  public endpoint!: string;\n\n  /**\n   * @internal\n   */\n  constructor(client: GeneratedClient, hubName: string, groupName: string) {\n    this.client = client;\n    this.groupName = groupName;\n    this.hubName = hubName;\n  }\n  /**\n   * Add a specific connection to this group\n   *\n   * @param connectionId - The connection id to add to this group\n   * @param options - Additional options\n   */\n  public async addConnection(\n    connectionId: string,\n    options: GroupAddConnectionOptions = {},\n  ): Promise<void> {\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      \"WebPubSubGroupClient.addConnection\",\n      options,\n      async (updatedOptions) => {\n        await this.client.webPubSub.addConnectionToGroup(\n          this.hubName,\n          this.groupName,\n          connectionId,\n          {\n            ...updatedOptions,\n            onResponse,\n          },\n        );\n\n        if (response!.status === 404) {\n          throw new RestError(`Connection id '${connectionId}' doesn't exist`, {\n            statusCode: response?.status,\n            request: response?.request,\n            response: response,\n          });\n        }\n      },\n    );\n  }\n\n  /**\n   * Remove a specific connection from this group\n   *\n   * @param connectionId - The connection id to remove from this group\n   * @param options - Additional options\n   */\n  public async removeConnection(\n    connectionId: string,\n    options: GroupRemoveConnectionOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubGroupClient.removeConnection\",\n      options,\n      (updatedOptions) => {\n        return this.client.webPubSub.removeConnectionFromGroup(\n          this.hubName,\n          this.groupName,\n          connectionId,\n          updatedOptions,\n        );\n      },\n    );\n  }\n\n  /**\n   * Close all connections to this group\n   *\n   * @param options - Additional options\n   */\n  public async closeAllConnections(options: GroupCloseAllConnectionsOptions = {}): Promise<void> {\n    return tracingClient.withSpan(\n      \"WebPubSubGroupClient.closeAllConnections\",\n      options,\n      (updatedOptions) => {\n        return this.client.webPubSub.closeGroupConnections(\n          this.hubName,\n          this.groupName,\n          updatedOptions,\n        );\n      },\n    );\n  }\n  /**\n   * Add a user to this group\n   *\n   * @param username - The user name to add\n   * @param options - Additional options\n   */\n  public async addUser(username: string, options: GroupAddUserOptions = {}): Promise<void> {\n    return tracingClient.withSpan(\"WebPubSubGroupClient.addUser\", options, (updatedOptions) => {\n      return this.client.webPubSub.addUserToGroup(\n        this.hubName,\n        this.groupName,\n        username,\n        updatedOptions,\n      );\n    });\n  }\n\n  /**\n   * Remove a user from this group\n   *\n   * @param username - The user name to remove\n   * @param options - Additional options\n   */\n  public async removeUser(username: string, options: GroupRemoveUserOptions = {}): Promise<void> {\n    return tracingClient.withSpan(\"WebPubSubGroupClient.removeUser\", options, (updatedOptions) => {\n      return this.client.webPubSub.removeUserFromGroup(\n        this.hubName,\n        this.groupName,\n        username,\n        updatedOptions,\n      );\n    });\n  }\n\n  /**\n   * Send a text message to every connection in this group\n   *\n   * @param message - The message to send\n   * @param options - Additional options\n   */\n  public async sendToAll(message: string, options: GroupSendTextToAllOptions): Promise<void>;\n  /**\n   * Send a json message to every connection in this group\n   *\n   * @param message - The message to send\n   * @param options - Additional options\n   */\n  public async sendToAll(message: JSONTypes, options?: GroupSendToAllOptions): Promise<void>;\n  /**\n   * Send a binary message to every connection in this group\n   *\n   * @param message - The binary message to send\n   * @param options - Additional options\n   */\n  public async sendToAll(message: RequestBodyType, options?: GroupSendToAllOptions): Promise<void>;\n\n  public async sendToAll(\n    message: JSONTypes | RequestBodyType,\n    options: GroupSendToAllOptions | GroupSendTextToAllOptions = {},\n  ): Promise<void> {\n    return tracingClient.withSpan(\"WebPubSubGroupClient.sendToAll\", options, (updatedOptions) => {\n      const { contentType, payload } = getPayloadForMessage(message, updatedOptions);\n      return this.client.webPubSub.sendToGroup(\n        this.hubName,\n        this.groupName,\n        contentType,\n        payload as any,\n        updatedOptions,\n      );\n    });\n  }\n}\n"]}