
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
@botpress/chat
Advanced tools
npm install @botpress/chat # for npm
yarn add @botpress/chat # for yarn
pnpm add @botpress/chat # for pnpm
The @botpress/chat
package exports a Client
class that can be used to interact with the Botpress Chat API. Here's a basic example:
import { Client } from '@botpress/chat'
const main = async () => {
/**
* You can find your webhook id in the the Botpress Dashboard.
* Navigate to your bot's Chat Integration configuration. Look for:
* https://webhook.botpress.cloud/$YOUR_WEBHOOK_ID
*/
const webhookId = process.env.WEBHOOK_ID
if (!webhookId) {
throw new Error('WEBHOOK_ID is required')
}
const client = new Client({
apiUrl: `https://chat.botpress.cloud/${webhookId}`,
})
// 0. create a chat user
const { user, key: xChatKey } = await client.createUser({})
// 1. create a conversation
const { conversation } = await client.createConversation({ xChatKey, participants: [user.id] })
// 2. send a message
const { message } = await client.createMessage({
xChatKey,
conversationId: conversation.id,
payload: {
type: 'text',
text: 'hello world',
},
})
console.log('message', message)
// 3. sleep for a bit
await new Promise((resolve) => setTimeout(resolve, 2000))
// 4. list messages
const { messages } = await client.listMessages({
xChatKey,
conversationId: conversation.id,
})
console.log('messages', messages)
}
void main()
.then(() => {
console.log('done')
process.exit(0)
})
.catch((err) => {
console.error(err)
process.exit(1)
})
You can also listen for messages and events in real-time:
// ...
const listener = await client.listenConversation({ id: conversation.id, xChatKey })
listener.on('message_created', (ev) => {
if (ev.userId === user.id) {
// message created by my current user, ignoring...
return
}
console.log('message received >>>', ev)
})
The Client
class does not automatically reconnect to the server if the connection is lost. This allow's you to handle reconnection in a way that makes sense for your application. To be notified when the connection is lost, you can listen for the error
event:
// ...
const state = { messages }
const onDisconnection = async () => {
try {
await listener.connect()
const { messages } = await client.listMessages({ xChatKey, conversationId: conversation.id })
state.messages = messages
} catch (thrown) {
console.error('failed to reconnect, retrying...', thrown)
setTimeout(onDisconnection, 1000) // consider using a backoff strategy
}
}
listener.on('error', (err) => {
console.error('connection lost', err)
void onDisconnection()
})
FAQs
Botpress Chat API Client
The npm package @botpress/chat receives a total of 385 weekly downloads. As such, @botpress/chat popularity was classified as not popular.
We found that @botpress/chat demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.