ReadonlyidStable transport tag (e.g. 'baileys', 'telegram') — used to namespace conversation keys if one Bot ever runs multiple providers concurrently.
ReadonlycapabilitiesThe bot's own user id once connected (for group mention matching). Optional.
Chronological journal of inbound messages/interactions (as emitted, before any chaos
wrapper) and of every send with the ref it returned. Bounded by maxJournal.
Edits recorded by editMessage (enabled by streaming 'edit'/'draft' or supports.edit).
Draft previews recorded by sendDraft (enabled by streaming: 'draft' or supports.drafts).
Messages deleted through deleteMessage (enabled by streaming not 'none' or supports.delete).
Interaction acks recorded by acknowledgeInteraction, in order.
OptionaltextPer-chat text format — present only when MockProviderOptions.textFormatFor is given.
ReadonlymaxJournal cap (MockProviderOptions.maxJournal).
start() calls so far.
stop() calls so far.
Records the edit in edits. Hidden (undefined) unless enabled — see MockProviderOptions.supports.
Records the ack in acks (button/callback interactions).
Optionalopts: { text?: string; defer?: boolean }Records the ref in deleted. Hidden (undefined) unless enabled — see MockProviderOptions.supports.
Records the draft in drafts. Hidden (undefined) unless enabled — see MockProviderOptions.supports.
Optionalopts: DraftOptionsSimulate the user pressing "stop" on the latest draft that offered it.
Send normalized content. Rejects with a typed error (section 8) on failure.
Optionaloptions: SendOptionsSubscribe to the normalized event stream. Returns an unsubscriber.
Bytes of a simulated media: a copy of the bytes behind the ref (incomingMedia,
chat.sendMedia); an empty buffer for a legacy token: null ref
(incoming(text, { type: 'image' })). A { url } token without bytes rejects with
MediaUnavailableError — the mock never touches the network.
Optionalref: MediaRefForget the journal (the seq counter keeps growing; outbox is untouched).
Simulate an inbound media message (type: kind, body = caption). source bytes are
what downloadMedia returns; { url } alone is metadata only, and the download
then rejects with MediaUnavailableError.
Simulate a shared location (type: 'location', ctx.sharedLocation). The body is
the place name, else the address, else '' — as the real providers set it.
Simulate a UI interaction (button/list row/slash command; kind defaults to 'button').
Simulate a reaction to a message (bot.on('reaction'), 'reaction' hooks). to is
the reacted message; the sender defaults to from (the chat), as in a DM.
Simulate an inbound call notification (what bot.on('call') and the CALL
trigger receive). Reuse the same id to emit later updates of one call. For a
group call pass chatId (the group) and isGroup: true; from is the caller.
Transport-agnostic provider contract.
TRawis the provider's native raw payload (proto.IWebMessageInfo, webhook entry, gateway object); it staysunknownin all shared code and is narrowed only inside provider-specific paths.STABILITY CONTRACT (normative): for the lifetime of a session, the same entity MUST yield the same
senderIdand the same chat the samechatIdon every emitted event. All transport-internal aliasing is resolved inside the provider before emission. The core performs no identity reconciliation.INBOUND ID CONTRACT (normative): a message's
ref.idand an interaction'sinteractionIdidentify ONE logical inbound event within its chat: distinct events get distinct ids, and a redelivery of the same event (webhook retry, reconnect replay) carries the same id. Core relies on this for inbound idempotency (BotConfig.dedupe, keyed bychatId+ id). When the transport provides no such id, synthesize one from per-event data that a redelivery repeats (e.g. kind + event timestamp) or emit'', which opts the event out of deduplication. Never fall back to a per-user constant (sender id,user_ref) or a shared placeholder ('<prefix>_0').