SendBird Desk SDK JavaScript

SDK SendBird Desk pour JavaScript

Ce projet fournit le SDK SendBird Desk pour JavaScript qui comprend le SDK de messagerie SendBird pour JavaScript, SendBird Desk SDK Core et un exemple de widget SendBird Desk.

Installer

Remarque : assurez-vous que node-js 18 et npm v9 ou supérieur sont installés

 npm install
npm run build

Remarque : Nous utilisons dts-bundle-generator car nous avons besoin d'un seul fichier d.ts pour le SDK. Des erreurs rollup-plugin-typescript2 apparaissent lorsque nous essayons d'utiliser declaration: true dans tsconfig.json .

Configuration des tests

Copiez .env.example dans .env et remplissez les valeurs.

Ces variables doivent également être configurées dans circle-ci. https://app.circleci.com/settings/project/github/sendbird/desk-js/environment-variables

Remarque : les variables d'environnement peuvent être trouvées dans 1password - Engineering/desk_staging_e2e_test Pour vous connecter en tant qu'administrateur dans le tableau de bord, utilisez E2E Admin - Dev dans 1password

Test

Nous utilisons jest avec js-dom pour tester Les cas de test se trouvent dans le répertoire test/cases et sont nommés `*.test.ts

Remarque : essayez de ne pas exécuter de tests en mode de surveillance automatique. Nous nous connecterions et nous déconnecterions du serveur pour chaque scénario de test

Test local

 npm run test

Publier pas encore implémenté / peut-être utiliser l'action github

1. Assurez-vous que la branche principale est à jour.
2. Coupez une branche de version - release/v#.#.## .
3. Sur la branche de sortie :

• Préparer le journal des modifications
• Mettre à jour la version dans le fichier package.json .

4. Faites des relations publiques vers la branche principale. { étapes facultatives
5. Faire une version -> npm run build; npm publish --tag beta
6. Vérifiez que la version candidate est prête à partir. }
7. Fusionner PR avec la branche principale.
8. Faire une version -> npm run build; npm publish
9. Ajoutez une note de version à la version github.
10. Copiez CHANGELOG , LICENSE , dist & package.json dans la branche principale du dépôt https://github.com/sendbird/SendBird-Desk-SDK-JavaScript .

Plus jolie

 npm run format

ou (dans Visual Studio Code) Installez Prettier - Code formatter . Ouvrez le fichier pour l'ajuster plus joliment, sélectionnez tout ( cmd+a ) et cmd+k, cmd+f .

Pelucheux

 npm run lint

Prise en charge du navigateur

• Navigateurs modernes prenant en charge ES6+ (Chrome, FireFox, Edge, Safari, etc.)
• Navigateurs mobiles (Android/iOS)