@azure/communication-identity 1.3.2-alpha.20250122.7 → 1.3.2-alpha.20250129.1

package/README.md

@@ -35,50 +35,58 @@ You can get a key and/or connection string from your Communication Services reso
 
 ### Create `KeyCredential` with `AzureKeyCredential` before initializing the client
 
-```typescript
+```ts snippet:ReadmeSampleCreateClient_KeyCredential
 import { AzureKeyCredential } from "@azure/core-auth";
 import { CommunicationIdentityClient } from "@azure/communication-identity";
 
-const credential = new AzureKeyCredential(KEY);
-const client = new CommunicationIdentityClient(ENDPOINT, credential);
+const key = "<some-key>";
+const endpoint = "https://contoso.eastus.communications.azure.net";
+
+const credential = new AzureKeyCredential(key);
+const client = new CommunicationIdentityClient(endpoint, credential);
 ```
 
 ### Using a connection string
 
-```typescript
+```ts snippet:ReadmeSampleCreateClient_ConnectionString
 import { CommunicationIdentityClient } from "@azure/communication-identity";
 
-const connectionString = `endpoint=ENDPOINT;accessKey=KEY`;
+// Example connection string
+const connectionString =
+  "endpoint=https://contoso.eastus.communications.azure.net/;accesskey=secret";
+
 const client = new CommunicationIdentityClient(connectionString);
 ```
 
 ### Using a `TokenCredential`
 
-```typescript
+```ts snippet:ReadmeSampleCreateClient_TokenCredential
 import { DefaultAzureCredential } from "@azure/identity";
 import { CommunicationIdentityClient } from "@azure/communication-identity";
 
+const endpoint = "https://contoso.eastus.communications.azure.net";
+
 const credential = new DefaultAzureCredential();
-const client = new CommunicationIdentityClient(ENDPOINT, credential);
+const client = new CommunicationIdentityClient(endpoint, credential);
 ```
 
 If you use a key to initialize the client you will also need to provide the appropriate endpoint. You can get this endpoint from your Communication Services resource in [Azure Portal][azure_portal].
 
 ## Usage
 
-### Creating an instance of CommunicationIdentityClient
+### Creating a new user
 
-```typescript
-import { CommunicationIdentityClient } from "@azure/communication-identity";
+Use the `createUser` method to create a new user.
 
-const client = new CommunicationIdentityClient(CONNECTION_STRING);
-```
+```ts snippet:ReadmeSampleCreateUser
+import { DefaultAzureCredential } from "@azure/identity";
+import { CommunicationIdentityClient } from "@azure/communication-identity";
 
-### Creating a new user
+const endpoint = "https://contoso.eastus.communications.azure.net";
 
-Use the `createUser` method to create a new user.
+const credential = new DefaultAzureCredential();
+const client = new CommunicationIdentityClient(endpoint, credential);
 
-```typescript
 const user = await client.createUser();
 ```
 
@@ -92,22 +100,55 @@ Use the `getToken` method to issue or refresh a token for an existing user. The
 - `chat.join.limited` (A more limited version of chat.join that doesn't allow to add or remove participants)
 - `voip.join` (Access to Calling APIs but without the authorization to start new calls)
 
-```typescript
+```ts snippet:ReadmeSampleCreateToken
+import { DefaultAzureCredential } from "@azure/identity";
+import { CommunicationIdentityClient } from "@azure/communication-identity";
+
+const endpoint = "https://contoso.eastus.communications.azure.net";
+
+const credential = new DefaultAzureCredential();
+const client = new CommunicationIdentityClient(endpoint, credential);
+
+const user = await client.createUser();
+
 const { token } = await client.getToken(user, ["chat"]);
 ```
 
 To refresh the user token, issue another token with the same user.
 
-```typescript
-const { token } = await client.getToken(user, ["chat"]);
+```ts snippet:ReadmeSampleRefreshToken
+import { DefaultAzureCredential } from "@azure/identity";
+import { CommunicationIdentityClient } from "@azure/communication-identity";
+
+const endpoint = "https://contoso.eastus.communications.azure.net";
+
+const credential = new DefaultAzureCredential();
+const client = new CommunicationIdentityClient(endpoint, credential);
+
+const user = await client.createUser();
+
+let { token } = await client.getToken(user, ["chat"]);
+
+// Refresh the token again
+({ token } = await client.getToken(user, ["chat"]));
 ```
 
 ### Creating a user token with custom expiration
 
 It's also possible to create a Communication Identity access token by customizing the expiration time. Validity period of the token must be within [60,1440] minutes range. If not provided, the default value of 1440 minutes (24 hours) will be used.
 
-```typescript
-const tokenOptions: GetTokenOptions = { tokenExpiresInMinutes: 60 };
+```ts snippet:ReadmeSampleCreateTokenWithOptions
+import { DefaultAzureCredential } from "@azure/identity";
+import { CommunicationIdentityClient } from "@azure/communication-identity";
+
+const endpoint = "https://contoso.eastus.communications.azure.net";
+
+const credential = new DefaultAzureCredential();
+const client = new CommunicationIdentityClient(endpoint, credential);
+
+const user = await client.createUser();
+
+const tokenOptions = { tokenExpiresInMinutes: 60 };
 const { token } = await client.getToken(user, ["chat"], tokenOptions);
 ```
 
@@ -115,7 +156,15 @@ const { token } = await client.getToken(user, ["chat"], tokenOptions);
 
 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
+```ts snippet:ReadmeSampleCreateUserAndToken
+import { DefaultAzureCredential } from "@azure/identity";
+import { CommunicationIdentityClient } from "@azure/communication-identity";
+
+const endpoint = "https://contoso.eastus.communications.azure.net";
+
+const credential = new DefaultAzureCredential();
+const client = new CommunicationIdentityClient(endpoint, credential);
+
 const { user, token } = await client.createUserAndToken(["chat"]);
 ```
 
@@ -123,8 +172,16 @@ const { user, token } = await client.createUserAndToken(["chat"]);
 
 It's also possible to create a Communication Identity access token by customizing the expiration time. Validity period of the token must be within [60,1440] minutes range. If not provided, the default value of 1440 minutes (24 hours) will be used.
 
-```typescript
-const userAndTokenOptions: CreateUserAndTokenOptions = { tokenExpiresInMinutes: 60 };
+```ts snippet:ReadmeSampleCreateUserAndTokenWithOptions
+import { DefaultAzureCredential } from "@azure/identity";
+import { CommunicationIdentityClient } from "@azure/communication-identity";
+
+const endpoint = "https://contoso.eastus.communications.azure.net";
+
+const credential = new DefaultAzureCredential();
+const client = new CommunicationIdentityClient(endpoint, credential);
+
+const userAndTokenOptions = { tokenExpiresInMinutes: 60 };
 const { user, token } = await client.createUserAndToken(["chat"], userAndTokenOptions);
 ```
 
@@ -132,7 +189,19 @@ const { user, token } = await client.createUserAndToken(["chat"], userAndTokenOp
 
 Use the `revokeTokens` method to revoke all issued tokens for a user.
 
-```typescript
+```ts snippet:ReadmeSampleRevokeTokens
+import { DefaultAzureCredential } from "@azure/identity";
+import { CommunicationIdentityClient } from "@azure/communication-identity";
+
+const endpoint = "https://contoso.eastus.communications.azure.net";
+
+const credential = new DefaultAzureCredential();
+const client = new CommunicationIdentityClient(endpoint, credential);
+
+// Create user
+const user = await client.createUser();
+
+// Later when you want to revoke the user's tokens
 await client.revokeTokens(user);
 ```
 
@@ -140,7 +209,19 @@ await client.revokeTokens(user);
 
 Use the `deleteUser` method to delete a user.
 
-```typescript
+```ts snippet:ReadmeSampleDeleteUser
+import { DefaultAzureCredential } from "@azure/identity";
+import { CommunicationIdentityClient } from "@azure/communication-identity";
+
+const endpoint = "https://contoso.eastus.communications.azure.net";
+
+const credential = new DefaultAzureCredential();
+const client = new CommunicationIdentityClient(endpoint, credential);
+
+// Create user
+const user = await client.createUser();
+
+// Later when you want to delete the user
 await client.deleteUser(user);
 ```
 
@@ -148,8 +229,16 @@ await client.deleteUser(user);
 
 Use `getTokenForTeamsUser` method to exchange an Azure AD access token of a Teams user for a new `CommunicationAccessToken` with a matching expiration time.
 
-```typescript
-await client.getTokenForTeamsUser({
+```ts snippet:ReadmeSampleGetTokenForTeamsUser
+import { DefaultAzureCredential } from "@azure/identity";
+import { CommunicationIdentityClient } from "@azure/communication-identity";
+
+const endpoint = "https://contoso.eastus.communications.azure.net";
+
+const credential = new DefaultAzureCredential();
+const client = new CommunicationIdentityClient(endpoint, credential);
+
+const { token, expiresOn } = await client.getTokenForTeamsUser({
   teamsUserAadToken: "<aad-access-token-of-a-teams-user>",
   clientId: "<cliend-id-of-an-aad-application>",
   userObjectId: "<aad-object-id-of-a-teams-user>",
@@ -158,6 +247,16 @@ await client.getTokenForTeamsUser({
 
 ## Troubleshooting
 
+### Logging
+
+Enabling logging may help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
+
+```ts snippet:SetLogLevel
+import { setLogLevel } from "@azure/logger";
+
+setLogLevel("info");
+```
+
 ## Next steps
 
 Please take a look at the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/communication-identity",
-  "version": "1.3.2-alpha.20250122.7",
+  "version": "1.3.2-alpha.20250129.1",
   "description": "SDK for Azure Communication service which facilitates user token administration.",
   "sdk-type": "client",
   "main": "./dist/commonjs/index.js",
@@ -33,7 +33,7 @@
     "unit-test": "npm run unit-test:node && npm run unit-test:browser",
     "unit-test:browser": "npm run clean && dev-tool run build-package && dev-tool run build-test && dev-tool run test:vitest --browser",
     "unit-test:node": "dev-tool run test:vitest",
-    "update-snippets": "echo skipped"
+    "update-snippets": "dev-tool run update-snippets"
   },
   "//metadata": {
     "constantPaths": [
@@ -95,13 +95,13 @@
     "@azure/communication-common": "^2.3.1",
     "@azure/core-auth": "^1.9.0",
     "@azure/core-client": "^1.9.2",
-    "@azure/core-lro": "^2.2.0",
+    "@azure/core-lro": "^2.7.2",
     "@azure/core-paging": "^1.6.2",
-    "@azure/core-rest-pipeline": "^1.18.0",
+    "@azure/core-rest-pipeline": "^1.18.2",
     "@azure/core-tracing": "^1.2.0",
     "@azure/logger": "^1.1.4",
-    "events": "^3.0.0",
-    "tslib": "^2.2.0"
+    "events": "^3.3.0",
+    "tslib": "^2.8.1"
   },
   "devDependencies": {
     "@azure-tools/test-credential": "^2.0.0",
@@ -113,13 +113,13 @@
     "@azure/identity": "^4.5.0",
     "@azure/msal-node": "^2.16.1",
     "@types/node": "^18.0.0",
-    "@vitest/browser": "^2.1.5",
-    "@vitest/coverage-istanbul": "^2.1.5",
+    "@vitest/browser": "^3.0.3",
+    "@vitest/coverage-istanbul": "^3.0.3",
     "dotenv": "^16.0.0",
     "eslint": "^9.9.0",
     "playwright": "^1.48.2",
     "typescript": "~5.7.2",
-    "vitest": "^2.1.5"
+    "vitest": "^3.0.3"
   },
   "type": "module",
   "tshy": {