TypeScript SDK | Meeting BaaS

Le TypeScript SDK est le package officiellement supporté qui permet aux développeurs de s'intégrer avec l'API Meeting BaaS — l'interface universelle pour automatiser les meetings sur Google Meet, Zoom et Microsoft Teams.

🚀 Nouveautés dans la v5.0.0 : Refonte complète de l'architecture avec un meilleur support TypeScript, une gestion des erreurs améliorée et une expérience développeur enrichie. Consultez le guide de migration pour les instructions de mise à niveau.

Sécurité des types complète avec des définitions TypeScript exhaustives
Mises à jour automatiques synchronisées avec notre spécification OpenAPI
Accès simplifié à toutes les fonctionnalités d'automatisation des meetings
Cohérence multiplateforme pour tous les fournisseurs de meetings supportés
Gestion des erreurs améliorée avec des réponses en union discriminée
Validation des paramètres avec validation automatique du schema Zod
Bundle tree-shakeable pour de meilleures performances

Fonctionnalités clés

BaaS API Client : Fonctions fortement typées pour interagir avec l'API Meeting BaaS
Gestion des bots : Créer, rejoindre et gérer des bots de meeting sur toutes les plateformes
Intégration calendrier : Connectez vos calendriers et planifiez automatiquement les enregistrements de meetings
Couverture API complète : Accès à tous les endpoints de l'API Meeting BaaS
Support TypeScript : Définitions TypeScript complètes pour toutes les API
Gestion des erreurs améliorée : Réponses en union discriminée pour une gestion des erreurs type-safe
Validation des paramètres : Validation automatique du schema Zod pour tous les appels API
Tree-shakeable : Importez uniquement les méthodes dont vous avez besoin
Tests complets : Couverture de tests exhaustive avec mocking MSW

Configuration requise

Node.js : Version 18.0.0 ou supérieure
Gestionnaires de paquets : npm, yarn ou pnpm

Versions Node.js testées : 18, 19, 20, 21, 22

Installation

Installez le SDK Meeting BaaS avec votre gestionnaire de paquets préféré :

npm-install.sh

npm install @meeting-baas/sdk

yarn-install.sh

yarn add @meeting-baas/sdk

pnpm-install.sh

pnpm add @meeting-baas/sdk

Démarrage rapide

Créez une nouvelle instance du client BaaS avec votre clé API :

basic-usage.ts

import { createBaasClient } from "@meeting-baas/sdk";

// Create a BaaS client
const client = createBaasClient({
  api_key: "your-api-key", // Get yours at https://meetingbaas.com
});

async function example() {
  // Join a meeting
  const { success, data, error } = await client.joinMeeting({
    bot_name: "Meeting Assistant",
    meeting_url: "https://meet.google.com/abc-def-ghi",
    reserved: true,
  });
  
  if (success) {
    console.log("Bot joined successfully:", data.bot_id);
  } else {
    console.error("Error joining meeting:", error);
  }
}

advanced-usage.ts

import { createBaasClient } from "@meeting-baas/sdk";

const client = createBaasClient({
  api_key: "your-api-key",
  timeout: 60000
});

async function comprehensiveExample() {
  // Join a meeting with all options
  const joinResult = await client.joinMeeting({
    meeting_url: "https://meet.google.com/abc-defg-hij",
    bot_name: "Advanced Test Bot",
    reserved: false,
    bot_image: "https://example.com/bot-image.jpg",
    enter_message: "Hello from the advanced test bot!",
    extra: { test_id: "advanced-example" },
    recording_mode: "speaker_view",
    speech_to_text: { provider: "Gladia" },
    webhook_url: "https://example.com/webhook"
  });

  if (joinResult.success) {
    const botId = joinResult.data.bot_id;
    console.log("Bot joined with ID:", botId);

    // Get meeting data with transcripts
    const meetingDataResult = await client.getMeetingData({
      bot_id: botId,
      include_transcripts: true
    });

    if (meetingDataResult.success) {
      console.log("Meeting duration:", meetingDataResult.data.duration);
    }
  }
}

Intégration calendrier

Le SDK offre des capacités complètes d'intégration calendrier :

calendar-integration.ts

import { createBaasClient } from "@meeting-baas/sdk";

const client = createBaasClient({
  api_key: "your-api-key",
});

// Create a calendar integration
const calendarResult = await client.createCalendar({
  oauth_client_id: "your-oauth-client-id",
  oauth_client_secret: "your-oauth-client-secret",
  oauth_refresh_token: "your-oauth-refresh-token",
  platform: "Google",
});

if (calendarResult.success) {
  console.log("Calendar created:", calendarResult.data);

  // List all calendars
  const calendarsResult = await client.listCalendars();
  if (calendarsResult.success) {
    console.log("All calendars:", calendarsResult.data);
  }

  // List events from a calendar
  const eventsResult = await client.listCalendarEvents({
    calendar_id: calendarResult.data.calendar.uuid,
    start_date_gte: new Date().toISOString(),
    start_date_lte: new Date(Date.now() + 7 * 24 * 60 * 60 * 1000).toISOString()
  });
  
  if (eventsResult.success) {
    console.log("Events:", eventsResult.data);
  }
}

Gestion des erreurs

Le SDK fournit une gestion des erreurs type-safe avec des réponses en union discriminée :

error-handling.ts

import { createBaasClient } from "@meeting-baas/sdk";

const client = createBaasClient({
  api_key: "your-api-key",
});

const result = await client.joinMeeting({
  meeting_url: "https://meet.google.com/abc-def-ghi",
  bot_name: "My Bot",
  reserved: false
});

if (result.success) {
  // TypeScript knows result.data is JoinResponse
  console.log("Bot ID:", result.data.bot_id);
} else {
  // TypeScript knows result.error is ZodError | Error
  if (result.error instanceof ZodError) {
    console.error("Validation error:", result.error.errors);
  } else {
    console.error("API error:", result.error.message);
  }
}

Migration depuis la v4.x

Si vous effectuez une mise à niveau depuis la v4.x, consultez le guide de migration pour des instructions détaillées.