[communication-identity] Rename createUserWithToken to createUserAndToken (Azure#14078)

Author: DominikMe

sdk/communication/communication-chat/package.json

@@ -77,7 +77,7 @@
     "@azure/core-paging": "^1.1.1"
   },
   "devDependencies": {
-    "@azure/communication-identity": "1.0.0-beta.4",
+    "@azure/communication-identity": "1.0.0-beta.5",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
     "@azure/test-utils-recorder": "^1.0.0",
     "@microsoft/api-extractor": "7.7.11",

sdk/communication/communication-chat/test/utils/recordedClient.ts

@@ -40,7 +40,7 @@ export const environmentSetup: RecorderEnvironmentSetup = {
 
 export async function createTestUser(): Promise<CommunicationUserToken> {
   const identityClient = new CommunicationIdentityClient(env.COMMUNICATION_CONNECTION_STRING);
-  return await identityClient.createUserWithToken(["chat"]);
+  return await identityClient.createUserAndToken(["chat"]);
 }
 
 export async function deleteTestUser(testUser: CommunicationUserIdentifier) {

sdk/communication/communication-identity/CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Breaking Changes
 
 - `CommunicationIdentityClient` method `issueToken` renamed to `getToken`.
+- `CommunicationIdentityClient` method `createUserWithToken` renamed to `createUserAndToken`.
 - Renamed `CommunicationIdentityOptions` to `CommunicationIdentityClientOptions`.
 - Removed `_response` from returned models.
 

sdk/communication/communication-identity/README.md

@@ -92,9 +92,9 @@ To refresh the user token, issue another token with the same user.
 { token } = await client.getToken(user, ["chat"]);
 ```
 
-### Creating a user together with a token in a single request
+### Creating a user and a token in a single request
 
-For convenience, use `createUserWithToken` to create a new user and issue a token with one function call. This translates into a single web request as opposed to creating a user first and then issuing a token.
+For convenience, use `createUserAndToken` to create a new user and issue a token with one function call. This translates into a single web request as opposed to creating a user first and then issuing a token.
 
 ```typescript
 let { user, token } = await client.createUserWithToken(["chat"]);

sdk/communication/communication-identity/review/communication-identity.api.md

@@ -22,7 +22,7 @@ export class CommunicationIdentityClient {
     constructor(endpoint: string, credential: KeyCredential, options?: CommunicationIdentityClientOptions);
     constructor(endpoint: string, credential: TokenCredential, options?: CommunicationIdentityClientOptions);
     createUser(options?: OperationOptions): Promise<CommunicationUserIdentifier>;
-    createUserWithToken(scopes: TokenScope[], options?: OperationOptions): Promise<CommunicationUserToken>;
+    createUserAndToken(scopes: TokenScope[], options?: OperationOptions): Promise<CommunicationUserToken>;
     deleteUser(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<void>;
     getToken(user: CommunicationUserIdentifier, scopes: TokenScope[], options?: OperationOptions): Promise<CommunicationAccessToken>;
     revokeTokens(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<void>;

sdk/communication/communication-identity/src/communicationIdentityClient.ts

@@ -196,12 +196,12 @@ export class CommunicationIdentityClient {
    * @param scopes - Scopes to include in the token.
    * @param options - Additional options for the request.
    */
-  public async createUserWithToken(
+  public async createUserAndToken(
     scopes: TokenScope[],
     options: OperationOptions = {}
   ): Promise<CommunicationUserToken> {
     const { span, updatedOptions } = createSpan(
-      "CommunicationIdentity-createUserWithToken",
+      "CommunicationIdentity-createUserAndToken",
       options
     );
     try {

sdk/communication/communication-identity/test/communicationIdentityClient.spec.ts

@@ -31,7 +31,7 @@ describe("CommunicationIdentityClient [Playback/Live]", function() {
   });
 
   it("successfully creates a user and token", async function() {
-    const { user: newUser, token } = await client.createUserWithToken(["voip"]);
+    const { user: newUser, token } = await client.createUserAndToken(["voip"]);
     assert.isString(newUser.communicationUserId);
     assert.isString(token);
   });
@@ -49,7 +49,7 @@ describe("CommunicationIdentityClient [Playback/Live]", function() {
   });
 
   it("successfully creates a user and gets a token in a single request", async function() {
-    const { user: newUser, token, expiresOn } = await client.createUserWithToken(["chat", "voip"]);
+    const { user: newUser, token, expiresOn } = await client.createUserAndToken(["chat", "voip"]);
     assert.isTrue(isCommunicationUserIdentifier(newUser));
     assert.isString(token);
     assert.instanceOf(expiresOn, Date);

sdk/communication/communication-identity/test/utils/mockHttpClients.ts

@@ -40,7 +40,7 @@ export const createUserHttpClient: HttpClient = createMockHttpClient<
   identity: { id: "identity" }
 });
 
-export const createUserWithTokenHttpClient: HttpClient = createMockHttpClient<
+export const createUserAndTokenHttpClient: HttpClient = createMockHttpClient<
   CommunicationIdentityAccessTokenResult
 >(201, {
   identity: { id: "identity" },

sdk/communication/communication-identity/test/utils/testCommunicationIdentityClient.ts

@@ -13,7 +13,7 @@ import {
   getTokenHttpClient,
   createUserHttpClient,
   revokeTokensHttpClient,
-  createUserWithTokenHttpClient
+  createUserAndTokenHttpClient
 } from "./mockHttpClients";
 
 export class TestCommunicationIdentityClient {
@@ -49,13 +49,13 @@ export class TestCommunicationIdentityClient {
     return client.createUser(options);
   }
 
-  public async createUserWithTokenTest(
+  public async createUserAndTokenTest(
     scopes: TokenScope[],
     options: OperationOptions = {}
   ): Promise<CommunicationUserToken> {
     const client = new CommunicationIdentityClient(this.connectionString, {
-      httpClient: createUserWithTokenHttpClient
+      httpClient: createUserAndTokenHttpClient
     });
-    return client.createUserWithToken(scopes, options);
+    return client.createUserAndToken(scopes, options);
   }
 }