https://github.com/jpeng-ms/chat-sdk-test

@azure/communication-chat debug tool
https://github.com/jpeng-ms/chat-sdk-test

azure chatsdk javascript microsoft

Last synced: 8 days ago
JSON representation

@azure/communication-chat debug tool

• Host: GitHub
• URL: https://github.com/jpeng-ms/chat-sdk-test
• Owner: jpeng-ms
• License: mit
• Created: 2023-03-17T08:52:16.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-11T00:28:36.000Z (4 months ago)
• Last Synced: 2024-11-01T23:12:50.441Z (about 2 months ago)
• Topics: azure, chatsdk, javascript, microsoft
• Language: JavaScript
• Homepage: https://jpeng-ms.github.io/Chat-SDK-Test/
• Size: 43.9 MB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Chat SDK Test Tool

![workflow](https://github.com/jpeng-ms/Chat-SDK-Test/actions/workflows/node.js.yml/badge.svg)

![GitHub issues](https://img.shields.io/github/issues/jpeng-ms/Chat-SDK-Test)

[![License](https://img.shields.io/github/license/jpeng-ms/Chat-SDK-Test)]()

An sample project that helps developers to test out Chat JS SDK (@azure/communication-chat).

# Background

Azure Communication Service (ACS) provides various communication services such as Calling, Chat, SMS, etc. This tool is meant to support ACS developers and provides a testing tool for Chat Interop and Adhoc scenarios specifically. Learn more about ACS [here](https://learn.microsoft.com/en-us/azure/communication-services/overview).

In particular, you might need some or all of the following information:

1. `connection string` of your Azure communication resoruce. You can obtain this via Azure portal. Click [here](https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/create-communication-resource?tabs=linux&pivots=platform-azp#access-your-connection-strings-and-service-endpoints) for more info

2. `meeting URL` of the Teams meeting you have set up

3. `MRI` of users you would like to add to the chat. For the MRI of ACS users, you can create one on Azure portal. For teams user, you can obtain this either from Teams admin via powerShell or making calls to MS Graph API. 

# Getting started

run `npm install; npm start` to start the demo. 

The webpage would be hosted under `http://localhost:3000/`

# Supported Chat Types

1. ACS Chat with ACS user



2. Interop chat with Teams user

       - enter meeting URL as thread ID, then choose `join call/chat`

       - make sure you are admitted to the call before starting any chat related activities

|  |  |

| --- | ---|

3. Adhoc chat with Teams user

       - select `new thread` tab

       - select `create chat`

       - select `add participant`

          - enter the MRI, display of the Teams user

          - *make sure the Teams tenant has ACS Interop federation enabled*



# Features

### Inline image rendering

|![image](https://github.com/jpeng-ms/Chat-SDK-Test/assets/109105353/1a65bfeb-a530-44ba-bb22-13efe7a11e3c)| |

| --- | ---|

### File attachment rendering

|![image](https://github.com/jpeng-ms/Chat-SDK-Test/assets/109105353/99339fc1-ff4d-4849-96e6-c40bc46f3473) |  |

| --- | ---|

# Others

### Readings

1. https://www.npmjs.com/package/@azure/communication-chat

2. https://learn.microsoft.com/en-us/azure/communication-services/concepts/chat/concepts

3. https://learn.microsoft.com/en-us/azure/communication-services/quickstarts/chat/get-started?tabs=linux&pivots=programming-language-javascript

4. https://learn.microsoft.com/en-us/azure/communication-services/concepts/chat/sdk-features

### Support

Please report any issue in this [github repo](https://github.com/jpeng-ms/Chat-SDK-Test/issues) with steps to reproduce and screenshots if any.

### Credit

- UI based on [`react-advanced-form`](https://github.com/taniarascia/react-advanced-form)