@botmesh/baileys for WhatsApp) and, optionally, a store
(@botmesh/sqlite-store, @botmesh/redis-store) and the @botmesh/ai plugin.
This entry exports what an application needs: the Bot, the flow DSL, the message
vocabulary, the option types and the errors an app can catch. The other entries:
@botmesh/core/testing: test kit (createTestBot,MockProvider, chaos kit, golden transcripts, crash simulation, in-memory coordinators).@botmesh/core/spi: for authors of stores, durability backends, schedule stores, coordinators, tracer integrations and transports (reference backends, record types, key and form helpers).@botmesh/core/dev: thebotmesh devterminal simulator.@botmesh/core/internal: engine building blocks, with no semver guarantee.
Example
Bot
- MessageHandler
- CommandHandler
- BotEvents
- BotEventArgs
- StopOptions
- ConversationTarget
- Bot
- InboundDedupeOptions
- EchoFilterOptions
- IdleEvent
- IdleHandler
- LoggerLike
- RateLimitRetryOptions
- BotConfig
- SubjectDataExport
- SubjectDeletionResult
Config- validateConfig
Messages & context
- LoadMediaOptions
- loadMediaOf
- SerializedMediaRef
- MediaUnavailableReason
- TypingConfig
- ReplyOptions
- MessagingSupport
- MessagingFeature
- EditOptions
- EditResult
- PacedSendCancelled
- MediaPayload
- MediaSource
- Button
- ListSection
- SendOptions
- OutboundContent
- SendResult
- TextFormat
- DraftOptions
- DefaultTools
- MessageContext
- SentMessage
- ContextI18n
- SplitTextOptions
- splitMessage
- streamText
- StreamSource
- StreamStrategy
- StreamOptions
- StreamResult
- StreamTarget
Triggers
- RegisteredFlowInfo
- FlowTriggerTarget
- FlowTriggerOptions
- TypeTrigger
- WelcomeTrigger
- isTypeTrigger
- isWelcomeTrigger
- typeTrigger
- WELCOME
- MEDIA
- IMAGE
- VIDEO
- AUDIO
- VOICE_NOTE
- DOCUMENT
- STICKER
- LOCATION
- CONTACT
- POLL
- CALL
- MatchStrategy
- TriggerScope
- TriggerObject
- Trigger
Flows
- EmptyFlowState
- FlowControls
- FlowStateWith
- FlowStateMerge
- FlowStateOf
- DynamicText
- FlowAction
- FlowGuard
- FlowDelay
- SayStepOptions
- AskStepOptions
- ChooseStepOptions
- GuardFailure
- ChooseOption
- CompiledAskOptions
- CompiledChooseOption
- CompiledStep
- CompiledFlow
- isCompiledFlow
- flow
addKeyword- FlowBuilder
- FLOW_MEDIA_KINDS
- FlowMediaKind
- FlowFileMediaKind
- FlowLocation
- FlowMediaOptions
- DynamicMediaSource
- FlowMediaSource
- isFlowMediaKind
- SchemaIssueLike
- SchemaParseResult
- SchemaLike
- InferSchema
Conversations
- RuntimeMessage
- WaitAccepts
- ResolvedWaitOptions
- ConversationControlsBase
- ConversationFn
- ConversationRegistration
- ConversationOutcome
- EnterOptions
- ConversationStartInfo
- ConversationEndInfo
- ConversationObserver
- ConversationSnapshot
- SchemaWaitOptions
- WaitMediaType
- ConversationControls
- ConversationTimeout
- ConversationCancelled
- RetriesExceeded
- ConversationEnded
- ConversationGoto
- ConversationHandler
- IdleCallback
- ConversationRetry
- WaitOptions
Forms
- FormFieldType
- FormOptions
- FormFieldBase
- TextFormField
- NumberFormField
- EmailFormField
- DateFormField
- SelectFormField
- MultiSelectFormField
- OptInFormField
- FormField
- FormDefinition
- FormValue
- FormValues
- FormReply
- FormMode
- FormStepOptions
- FormContent
Hooks & plugins
- HookEvent
- HookPhase
- HookHandler
- HookErrorHandler
- SendHookContext
- HookContextMap
- HookContextOf
- HookBeforeContext
- AnyHookHandler
- HookRegistration
- PluginContext
- PluginSpec
- SyncInstallError
- Plugin
- definePlugin
- isPlugin
- SlashCommandsConfig
- slashCommandsPlugin
Handoff & access lists
- AccessListName
- AccessListAction
- AccessListChange
- AccessListSnapshot
- WhitelistSnapshot
- AccessListsSnapshot
- AccessDecision
- AccessList
- Whitelist
- HandoffConfig
- HandoffOptions
- ResumeOptions
- StoredHandoff
- HandoffState
- HandoffEvent
- ResumeEvent
i18n
- CORE_MESSAGES
- CoreMessageKey
- BUILTIN_LOCALES
- PluralCategory
- PluralForms
- LocaleMessages
- TranslateParams
- Translate
- LanguageDetector
- LangSource
- I18nConfig
Store
- StoredMessage
- AIMessage
- StoredChat
- StoredContact
- FlowCheckpoint
- IStore
- StoreKind
BuiltinStoreConfig- MemoryStoreLogger
- MemoryStoreOptions
- MemoryStore
- StoreNamespace
- NamespacedStore
User data
Scheduler
- ScheduledTask
- CronTaskOptions
- MissedRunPolicy
- DurableTaskOptions
- ScheduledRun
- DurableTaskHandler
- ScheduleStore
- SchedulerOptions
Operations
- BroadcastProgress
- BroadcastOptions
- BroadcastFailure
- BroadcastResult
- ConversationCounters
- BotMetricsSnapshot
- ConversationStartedEvent
- ConversationEndedEvent
- PrometheusOptions
- PROMETHEUS_CONTENT_TYPE
- toPrometheus
- TriggerOptions
- TriggerSkipReason
- TriggerResult
- TriggerRaw
Errors
- ConversationError
- ConcurrentWaitError
- RetryUnavailableError
- ProviderNotLeaderError
- LeaseLostError
- CoordinationUnavailableError
- BotNotRunningError
- InvalidProviderEventError
- MediaUnavailableError
- ProviderError
- UnsupportedContentError
- RateLimitedError
- RecipientUnreachableError
- PayloadTooLargeError
- MediaTooLargeError
- OutsideSessionWindowError
- SendDeferredError
- UserDataError
- TimeoutError
- ConfigValidationError
Provider
- ChatId
- UserId
- MessageId
- MessageRef
- ChatKind
- ChatInfo
- SenderInfo
- MessageType
- MediaRef
- InboundLocation
- QuotedRef
- InboundMessage
- InboundInteraction
- DeliveryStatus
- InboundReaction
- PollVote
- InboundListener
- InboundEvent
- GroupEvent
- PresenceEvent
- CallEvent
- ProviderCapabilities
- StreamingMode
- ConnectionState
- DisconnectReason
- ConnectionUpdate
- IProvider
Durability
- DurabilityMetrics
- DurabilityControl
- FileDurabilityOptions
- FileDurability
- DurableKv
- MemoryDurability
- DurabilityBackend
- RetryBackoff
- DurabilityConfig
Coordination
- SchedulerLease
- LeaseProvider
- Fence
- LeaseLossReason
- CoordinatorEvents
- Coordinator
- CoordinationConfig
- ConversationHandoverConfig
- HandoverFallback
- HandoverContext
- InterruptedConversation
- ConversationHandoverEvent
Tracing
- TRACE_ATTR
- SPAN_NAMES
- TraceAttributeValue
- TraceAttributes
- SpanKind
- SpanStatus
- SpanContextRef
- SpanLink
- SpanException
- BotSpan
- SpanOptions
- BotTracer
- TelemetryConfig
- BotTracing
Flow inspection
- FlowGraphNodeKind
- FlowGraphTimeoutSource
- FlowGraphOption
- FlowGraphFormInfo
- FlowGraphNode
- FlowGraphEdgeKind
- FlowGraphEdge
- FlowGraphGroup
- FlowGraphFlow
- FlowGraph
- DescribeOptions
- describeFlows
- FlowRoute
- FlowInventory
- FlowInventoryProvider
- FlowSource
- TriggerPatternInfo
- TriggerInfo
- describeTrigger
- LintSeverity
- LintCode
- LintDiagnostic
- LintOptions
- lintFlows
Golden transcripts
- TRANSCRIPT_FORMAT
- TRANSCRIPT_VERSION
- TranscriptInbound
- TranscriptOutbound
- TranscriptTurn
- Transcript
- TranscriptFormatError
- createTranscript
- serializeTranscript
- parseTranscript
- FromMessagesOptions
- transcriptFromMessages
- TranscriptMessageSource
- TranscriptStoreOwner
- transcriptFromStore
- RecordTranscriptOptions
- DEFAULT_MAX_TURNS
- TranscriptRecorder
- RecordingProvider
- recordTranscript
- RedactionRule
- RedactionMap
- RedactOptions
- createRedactionMap
- redactTranscript