@azure/communication-common

Azure Communication Common client library for JavaScript

This package contains common code for Azure Communication Service libraries.

Getting started

Prerequisites

• An Azure subscription.
• An existing Communication Services resource. If you need to create the resource, you can use the Azure Portal or Azure CLI.

Installing

npm install @azure/communication-common

Key concepts

CommunicationUserCredential and AzureCommunicationUserCredential

A CommunicationUserCredential authenticates a user with Communication Services, such as Chat or Calling. It optionally provides an auto-refresh mechanism to ensure a continuously stable authentication state during communications.

It is up to you the developer to first create valid user tokens with the Azure Communication Administration library. Then you use these tokens to create a AzureCommunicationUserCredential.

CommunicationUserCredential is only the interface, please always use the AzureCommunicationUserCredential constructor to create a credential and take advantage of the built-in refresh logic.

Examples

Create a credential with a static token

const userCredential = new AzureCommunicationUserCredential(
  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjM2MDB9.adM-ddBZZlQ1WlN3pdPBOF5G4Wh9iZpxNP_fSvpF4cWs"
);

Create a credential with a callback

Here we assume that we have a function fetchTokenFromMyServerForUser that makes a network request to retrieve a token string for a user. We pass it into the credential to fetch a token for Bob from our own server. Our server would use the Azure Communication Administration library to issue tokens.

const userCredential = new AzureCommunicationUserCredential({
  tokenRefresher: async () => fetchTokenFromMyServerForUser("[e-mail]")
});

Create a credential with proactive refreshing

Setting refreshProactively to true will call your tokenRefresher function when the token is close to expiry.

const userCredential = new AzureCommunicationUserCredential({
  tokenRefresher: async () => fetchTokenFromMyServerForUser("[e-mail]"),
  refreshProactively: true
});

Create a credential with proactive refreshing and an initial token

Passing initialToken is an optional optimization to skip the first call to tokenRefresher. You can use this to separate the boot from your application from subsequent token refresh cycles.

const userCredential = new AzureCommunicationUserCredential({
  tokenRefresher: async () => fetchTokenFromMyServerForUser("[e-mail]"),
  refreshProactively: true,
  initialToken:
    "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjM2MDB9.adM-ddBZZlQ1WlN3pdPBOF5G4Wh9iZpxNP_fSvpF4cWs"
});

Troubleshooting

Next steps

• Read more about Communication user access tokens

Contributing

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.

Related projects

• Microsoft Azure SDK for Javascript