plazbot/dist/workers/worker.d.ts

Official Plazbot SDK for creating AI agents for WhatsApp, portals, and developers.

import type { WorkerConfig, WorkerDefinition } from './types';
/**
 * Define un worker (event listener) que reacciona a eventos de Plazbot.
 *
 * Los eventos se mapean a triggers del backend existente:
 * - `message.received` — cliente envio un mensaje
 * - `message.image.received` — cliente envio una imagen
 * - `contact.created` — se creo un contacto nuevo
 * - `conversation.resolved` — se resolvio el chat
 * (ver tipos/events.ts para la lista completa)
 *
 * @example
 * ```typescript
 * import { defineWorker } from 'plazbot/workers';
 *
 * export default defineWorker({
 *   name: 'bienvenida',
 *   reference: 'Saluda a contactos nuevos',
 *   events: ['contact.created'],
 *   async handler(event, plz) {
 *     const { contact } = event.data;
 *     if (!contact?.phoneNumber) return;
 *     await plz.whatsapp.send({ to: contact.phoneNumber, message: 'Bienvenido!' });
 *   },
 * });
 * ```
 */
export declare function defineWorker(config: WorkerConfig): WorkerDefinition;