SendBird Desk SDK JavaScript

SendBird Desk SDK для JavaScript

Этот проект предоставляет SendBird Desk SDK для JavaScript, который включает SDK для обмена сообщениями SendBird для JavaScript, ядро ​​SendBird Desk SDK и образец виджета SendBird Desk.

Установить

Примечание. Убедитесь, что у вас установлены node-js 18 и npm v9 или выше.

 npm install
npm run build

Примечание. Мы используем dts-bundle-generator , поскольку нам нужен один файл d.ts для SDK. rollup-plugin-typescript2 выдает ошибку, когда мы пытаемся использовать declaration: true в tsconfig.json .

Настройка тестов

Скопируйте .env.example в .env и заполните значения.

Эти переменные также должны быть настроены в Circle-ci. https://app.circleci.com/settings/project/github/sendbird/desk-js/environment-variables

Примечание. Переменные env можно найти в 1password — Engineering/desk_staging_e2e_test. Чтобы войти в систему как администратор на информационной панели, используйте E2E Admin - Dev в 1password.

Тест

Мы используем jest с js-dom для тестирования. Тестовые примеры расположены в каталоге test/cases и называются `*.test.ts.

Примечание. Старайтесь не запускать тесты в режиме автоматического просмотра. Мы будем подключаться и отключаться от сервера для каждого тестового примера.

Локальный тест

 npm run test

Публикация еще не реализована/возможно, используйте действие github

1. Убедитесь, что основная ветка обновлена.
2. Вырезаем ветку релиза — release/v#.#.## .
3. В ветке релиза:

• Подготовьте список изменений
• Обновите версию в файле package.json .

4. Сделайте пиар в основной ветке. { необязательные шаги
5. Сделать выпуск -> npm run build; npm publish --tag beta
6. Проверить кандидата на выпуск можно. }
7. Объединить PR с основной веткой.
8. Сделать выпуск -> npm run build; npm publish
9. Добавьте примечание к выпуску в выпуск github.
10. Скопируйте CHANGELOG , LICENSE , dist & package.json в основную ветку репозитория https://github.com/sendbird/SendBird-Desk-SDK-JavaScript .

красивее

 npm run format

или (в Visual Studio Code) установите плагин Prettier - Code formatter . Откройте файл, чтобы настроить его красивее, выберите все ( cmd+a ) и cmd+k, cmd+f .

Линтинг

 npm run lint

Поддержка браузера

• Современные браузеры, поддерживающие ES6+ (Chrome, FireFox, Edge, Safari и т. д.)
• Мобильные браузеры (Android/iOS)