@azure/web-pubsub 1.0.0-beta.3 → 1.0.1-alpha.20220103.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/web-pubsub",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.1-alpha.20220103.2",
   "description": "Azure client library for Azure Web PubSub",
   "sdk-type": "client",
   "main": "dist/index.js",
@@ -11,8 +11,8 @@
     "build:browser": "echo \"Browser is not supported.\" && exit 0",
     "build:node": "tsc -p . && cross-env ONLY_NODE=true rollup -c 2>&1",
     "build:samples": "echo Obsolete.",
-    "build:test": "tsc -p . && rollup -c rollup.test.config.js 2>&1",
-    "build": "tsc -p . && rollup -c 2>&1 && api-extractor run --local",
+    "build:test": "tsc -p . && rollup -c 2>&1",
+    "build": "npm run clean && tsc -p . && rollup -c 2>&1 && api-extractor run --local",
     "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
     "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
     "clean": "rimraf dist dist-esm test-dist temp types *.tgz *.log",
@@ -22,16 +22,14 @@
     "integration-test:node": "echo skipped",
     "integration-test": "npm run integration-test:node && npm run integration-test:browser",
     "lint:fix": "eslint package.json api-extractor.json src test --ext .ts --fix --fix-type [problem,suggestion]",
-    "lint": "eslint package.json api-extractor.json src test --ext .ts -f html -o signalr-lintReport.html || exit 0",
+    "lint": "eslint package.json api-extractor.json src test --ext .ts",
     "pack": "npm pack 2>&1",
-    "prebuild": "npm run clean",
     "test:browser": "echo \"Browser is not supported.\" && exit 0",
     "test:node": "npm run build:test && npm run unit-test:node && npm run integration-test:node",
     "test": "npm run build:test && npm run unit-test && npm run integration-test",
     "unit-test:browser": "echo \"Browser is not supported.\" && exit 0",
-    "unit-test:node": "mocha --exit --reporter ../../../common/tools/mocha-multi-reporter.js dist-test/index.node.js",
-    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
-    "docs": "typedoc --excludePrivate --excludeNotExported --excludeExternals --stripInternal --mode file --out ./dist/docs ./src"
+    "unit-test:node": "mocha --exit -r esm --require ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace \"test/{,!(browser)/**/}*.spec.ts\"",
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
   },
   "files": [
     "dist/",
@@ -41,12 +39,24 @@
     "README.md",
     "LICENSE"
   ],
+  "//metadata": {
+    "constantPaths": [
+      {
+        "path": "src/generated/generatedClientContext.ts",
+        "prefix": "packageDetails"
+      },
+      {
+        "path": "swagger/README.md",
+        "prefix": "package-version"
+      }
+    ]
+  },
   "browser": {
     "./dist-esm/src/util/url.js": "./dist-esm/src/util/url.browser.js"
   },
   "repository": "github:Azure/azure-sdk-for-js",
   "keywords": [
-    "Azure",
+    "azure",
     "cloud"
   ],
   "author": "Microsoft Corporation",
@@ -57,34 +67,29 @@
   "engines": {
     "node": ">=12.0.0"
   },
-  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/search/search/",
+  "homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/web-pubsub/web-pubsub/README.md",
   "sideEffects": false,
   "dependencies": {
     "@azure/core-auth": "^1.3.0",
     "@azure/core-client": "^1.0.0",
     "@azure/core-rest-pipeline": "^1.1.0",
-    "@azure/core-tracing": "1.0.0-preview.12",
+    "@azure/core-tracing": "1.0.0-preview.13",
     "@azure/logger": "^1.0.0",
     "tslib": "^2.2.0",
     "jsonwebtoken": "^8.5.1"
   },
   "devDependencies": {
-    "@azure/dev-tool": "^1.0.0",
-    "@azure/eslint-plugin-azure-sdk": "^3.0.0",
-    "@azure/identity": "^1.1.0",
-    "@azure/test-utils-recorder": "^1.0.0",
-    "@microsoft/api-extractor": "7.7.11",
-    "@rollup/plugin-commonjs": "11.0.2",
-    "@rollup/plugin-json": "^4.0.0",
-    "@rollup/plugin-multi-entry": "^3.0.0",
-    "@rollup/plugin-node-resolve": "^8.0.0",
-    "@rollup/plugin-replace": "^2.2.0",
+    "@azure/dev-tool": ">=1.0.0-alpha <1.0.0-alphb",
+    "@azure/eslint-plugin-azure-sdk": ">=3.0.0-alpha <3.0.0-alphb",
+    "@azure/identity": "^2.0.1",
+    "@azure-tools/test-recorder": "^1.0.0",
+    "@microsoft/api-extractor": "^7.18.11",
     "@types/chai": "^4.1.6",
     "@types/jsonwebtoken": "~8.5.0",
     "@types/mocha": "^7.0.2",
     "@types/node": "^12.0.0",
-    "@types/query-string": "6.2.0",
     "@types/sinon": "^9.0.4",
+    "@types/ws": "^8.2.0",
     "chai": "^4.2.0",
     "cross-env": "^7.0.2",
     "dotenv": "^8.2.0",
@@ -104,21 +109,16 @@
     "karma-mocha-reporter": "^2.2.5",
     "karma-sourcemap-loader": "^0.3.8",
     "mocha": "^7.1.1",
-    "mocha-junit-reporter": "^1.18.0",
-    "nyc": "^14.0.0",
-    "prettier": "^1.16.4",
-    "puppeteer": "^3.3.0",
-    "query-string": "^5.0.0",
+    "mocha-junit-reporter": "^2.0.0",
+    "nyc": "^15.0.0",
+    "prettier": "^2.5.1",
+    "puppeteer": "^10.2.0",
     "rimraf": "^3.0.0",
     "rollup": "^1.16.3",
-    "rollup-plugin-shim": "^1.0.0",
-    "rollup-plugin-sourcemaps": "^0.4.2",
-    "rollup-plugin-terser": "^5.1.1",
-    "rollup-plugin-visualizer": "^4.0.4",
     "sinon": "^9.0.2",
     "source-map-support": "^0.5.9",
     "typescript": "~4.2.0",
-    "typedoc": "0.15.2"
+    "ws": "^8.2.0"
   },
   "//sampleConfiguration": {
     "productName": "Azure Web PubSub",

package/types/web-pubsub.d.ts

@@ -2,28 +2,38 @@ import { AzureKeyCredential } from '@azure/core-auth';
 import { CommonClientOptions } from '@azure/core-client';
 import { OperationOptions } from '@azure/core-client';
 import { RequestBodyType } from '@azure/core-rest-pipeline';
+import { TokenCredential } from '@azure/core-auth';
+
 export { AzureKeyCredential }
 
 /**
- * Options for closing a connection to a hub.
+ * A response containing the client token.
  */
-export declare interface CloseConnectionOptions extends OperationOptions {
+export declare interface ClientTokenResponse {
     /**
-     * Reason the connection is being closed.
+     * The client token.
      */
-    reason?: string;
+    token: string;
+    /**
+     * The URL client connects to
+     */
+    baseUrl: string;
+    /**
+     * The URL client connects to with access_token query string
+     */
+    url: string;
 }
 
 /**
- * Options for auth a client
+ * Options for generating a token to connect a client to the Azure Web Pubsub service.
  */
-export declare interface GetAuthenticationTokenOptions {
+export declare interface GenerateClientTokenOptions extends OperationOptions {
     /**
-     * The userId for the client
+     * The userId for the client.
      */
     userId?: string;
     /**
-     * The roles the client have.
+     * 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
@@ -34,27 +44,9 @@ export declare interface GetAuthenticationTokenOptions {
      */
     roles?: string[];
     /**
-     * The time-to-live minutes for the access token. If not set, the default value is 60 minutes.
-     */
-    ttl?: number;
-}
-
-/**
- * Response for the authed client, including the url and the jwt token
- */
-export declare interface GetAuthenticationTokenResponse {
-    /**
-     * The URL client connects to
-     */
-    baseUrl: string;
-    /**
-     * The JWT token the client uses to connect
-     */
-    token: string;
-    /**
-     * The URL client connects to with access_token query string
+     * Minutes until the token expires.
      */
-    url: string;
+    expirationTimeInMinutes?: number;
 }
 
 /**
@@ -75,6 +67,16 @@ export declare interface GroupAddUserOptions extends OperationOptions {
 export declare interface GroupAdminClientOptions extends CommonClientOptions {
 }
 
+/**
+ * Options for closing all connections to a group.
+ */
+export declare interface GroupCloseAllConnectionsOptions extends OperationOptions {
+    /**
+     * Reason the connection is being closed.
+     */
+    reason?: string;
+}
+
 /**
  * Options for checking if a user is in a group
  */
@@ -121,9 +123,33 @@ export declare interface HasConnectionOptions extends OperationOptions {
 }
 
 /**
- * Options for constructing a HubAdmin client.
+ * Options for closing all connections to a hub.
  */
-export declare interface HubAdminClientOptions extends CommonClientOptions {
+export declare interface HubCloseAllConnectionsOptions extends OperationOptions {
+    /**
+     * Reason the connection is being closed.
+     */
+    reason?: string;
+}
+
+/**
+ * Options for closing a connection to a hub.
+ */
+export declare interface HubCloseConnectionOptions extends OperationOptions {
+    /**
+     * Reason the connection is being closed.
+     */
+    reason?: string;
+}
+
+/**
+ * Options for closing all of a user's connections to a hub.
+ */
+export declare interface HubCloseUserConnectionsOptions extends OperationOptions {
+    /**
+     * Reason the connection is being closed.
+     */
+    reason?: string;
 }
 
 /**
@@ -144,7 +170,7 @@ export declare interface HubHasGroupOptions extends OperationOptions {
 }
 
 /**
- * Options for check if a connection has the specified permission
+ * Options for checking if a connection has the specified permission
  */
 export declare interface HubHasPermissionOptions extends OperationOptions {
     /**
@@ -163,7 +189,7 @@ export declare interface HubHasUserOptions extends OperationOptions {
 /**
  * Options for removing a user from all groups.
  */
-export declare interface HubRemoveUserFromAllGroupsOptions extends CloseConnectionOptions {
+export declare interface HubRemoveUserFromAllGroupsOptions extends HubCloseConnectionOptions {
 }
 
 /**
@@ -247,50 +273,56 @@ export declare interface WebPubSubGroup {
     /**
      * Add a specific connection to this group
      *
-     * @param connectionId The connection id to add to this group
-     * @param options Additional options
+     * @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
+     * @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
+     * @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
+     * @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
+     * @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
+     * @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
+     * @param message - The binary message to send
+     * @param options - Additional options
      */
     sendToAll(message: RequestBodyType, options?: GroupSendToAllOptions): Promise<void>;
 }
@@ -324,11 +356,11 @@ export declare class WebPubSubServiceClient {
      * 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
+     * @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?: HubAdminClientOptions);
+    constructor(connectionString: string, hubName: string, options?: WebPubSubServiceClientOptions);
     /**
      * Creates an instance of a WebPubSubServiceClient for sending messages and managing groups, connections, and users.
      *
@@ -340,149 +372,173 @@ export declare class WebPubSubServiceClient {
      * 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, hubName: string, options?: HubAdminClientOptions);
-    /**
-     * Auth the client connection with userId and custom claims if any
-     * @param options The options that the client has
+     * @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
      */
-    getAuthenticationToken(options?: GetAuthenticationTokenOptions): Promise<GetAuthenticationTokenResponse>;
+    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.
+     * @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
+     * @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
+     * @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
+     * @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
+     * @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
+     * @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
+     * @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
+     * @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
+     * @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
+     * @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
+     * @param connectionId - Connection id to check
+     * @param options - Additional options
      */
-    hasConnection(connectionId: string, options?: HasConnectionOptions): Promise<boolean>;
+    connectionExists(connectionId: string, options?: HasConnectionOptions): Promise<boolean>;
     /**
      * Close a specific connection to this hub
      *
-     * @param connectionId Connection id to close
-     * @param options Additional options
+     * @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
      */
-    closeConnection(connectionId: string, options?: CloseConnectionOptions): Promise<void>;
+    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
+     * @param userId - The user id to remove from all groups
+     * @param options - Additional options
      */
-    removeUserFromAllGroups(userId: string, options?: CloseConnectionOptions): Promise<void>;
+    removeUserFromAllGroups(userId: string, options?: HubCloseConnectionOptions): 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
+     * @param groupName - The group name to check for
+     * @param options - Additional options
      */
-    hasGroup(groupName: string, options?: HubHasGroupOptions): Promise<boolean>;
+    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
+     * @param username - The user name to check for
+     * @param options - Additional options
      */
-    hasUser(username: string, options?: HubHasUserOptions): Promise<boolean>;
+    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
+     * @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
+     * @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
+     * @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>;
+}
+
+/**
+ * Options for constructing a HubAdmin client.
+ */
+export declare interface WebPubSubServiceClientOptions extends CommonClientOptions {
+    /**
+     * Reverse proxy endpoint (for example, your Azure API management endpoint)
+     */
+    reverseProxyEndpoint?: string;
 }
 
 export { }

package/dist-esm/src/normalizeOptions.js

@@ -1,8 +0,0 @@
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-import { __rest } from "tslib";
-export default function normalizeSendToAllOptions(options) {
-    const { excludedConnections } = options, otherOptions = __rest(options, ["excludedConnections"]);
-    return Object.assign(Object.assign({}, otherOptions), { excluded: excludedConnections });
-}
-//# sourceMappingURL=normalizeOptions.js.map

package/dist-esm/src/normalizeOptions.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"normalizeOptions.js","sourceRoot":"","sources":["../../src/normalizeOptions.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;;AAElC,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAC/C,OAAU;IAEV,MAAM,EAAE,mBAAmB,KAAsB,OAAO,EAAxB,YAAY,UAAK,OAAO,EAAlD,uBAAwC,CAAU,CAAC;IACzD,uCACK,YAAY,KACf,QAAQ,EAAE,mBAAmB,IAC7B;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport default function normalizeSendToAllOptions<T extends { excludedConnections?: string[] }>(\n  options: T\n) {\n  const { excludedConnections, ...otherOptions } = options;\n  return {\n    ...otherOptions,\n    excluded: excludedConnections\n  };\n}\n"]}