TypeScript SDK

SDK v5 ya está aquí, rediseñado

El TypeScript SDK es el paquete oficialmente soportado que permite a los desarrolladores integrarse con la API de Meeting BaaS: la interfaz universal para automatizar reuniones en Google Meet, Zoom y Microsoft Teams.

🚀 Nuevo en v5.0.0: Rediseño arquitectónico completo con soporte mejorado de TypeScript, mejor manejo de errores y una experiencia de desarrollador mejorada. Consulte la guía de migración para obtener instrucciones de actualización.

  • Seguridad de tipos completa con definiciones TypeScript exhaustivas
  • Actualizaciones automáticas sincronizadas con nuestra especificación OpenAPI
  • Acceso simplificado a todas las capacidades de automatización de reuniones
  • Consistencia multiplataforma para todos los proveedores de reuniones compatibles
  • Manejo mejorado de errores con respuestas de unión discriminada
  • Validación de parámetros con validación automática de schema Zod
  • Bundle tree-shakeable para mejor rendimiento

Características principales

  • BaaS API Client: Funciones con tipado estricto para interactuar con la API de Meeting BaaS
  • Bot Management: Cree, una y administre bots de reuniones en múltiples plataformas
  • Calendar Integration: Conecte calendarios y programe automáticamente grabaciones de reuniones
  • Cobertura completa de la API: Acceso a todos los endpoints de la API de Meeting BaaS
  • Soporte de TypeScript: Definiciones TypeScript completas para todas las APIs
  • Manejo mejorado de errores: Respuestas de unión discriminada para el manejo de errores con seguridad de tipos
  • Validación de parámetros: Validación automática de schema Zod para todas las llamadas a la API
  • Tree-shakeable: Importe únicamente los métodos que necesita
  • Pruebas exhaustivas: Cobertura de pruebas completa con mocking MSW

Requisitos del sistema

  • Node.js: Versión 18.0.0 o superior
  • Gestores de paquetes: npm, yarn o pnpm

Versiones de Node.js probadas: 18, 19, 20, 21, 22

Instalación

Instale el SDK de Meeting BaaS usando su gestor de paquetes preferido:

npm-install.sh
npm install @meeting-baas/sdk
yarn-install.sh
yarn add @meeting-baas/sdk
pnpm-install.sh
pnpm add @meeting-baas/sdk

Inicio rápido

Cree una nueva instancia del cliente BaaS con su API key:

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);
    }
  }
}

Integración de calendario

El SDK proporciona capacidades completas de integración de calendario:

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);
  }
}

Manejo de errores

El SDK proporciona manejo de errores con seguridad de tipos mediante respuestas de unión discriminada:

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);
  }
}

Migración desde v4.x

Si está actualizando desde v4.x, consulte la guía de migración para obtener instrucciones detalladas de migración.

Meeting BaaS API Preview Features

Recursos