Dev - IdleState

[binhodev]

Que tipo de Pull Request es?

• Mejoras
• Bug
• Docs / tests

Descripción

IdleState: Managing Inactivity in Chatbots Efficiently

IdleState is an effective solution for handling user inactivity in chatbots. It offers the following essential functions:

1. setIdleTime(number): Set the maximum idle time in seconds.

2. start(): Start the inactivity count from the bot's first response.

3. on(): Monitor the end of the count using the "idle" listener and execute a callback when necessary.

4. restart(): Restart the inactivity count as needed.

5. stop(): Stop the count when it is no longer necessary.

With these features, IdleState allows efficient management of user inactivity, making interactions with chatbots more agile and adaptable to the specific needs of your chatbot.

Example:

const { createBot, createProvider, createFlow, addKeyword } = require('@bot-whatsapp/bot')

const QRPortalWeb = require('@bot-whatsapp/portal')
const BaileysProvider = require('@bot-whatsapp/provider/baileys')
const JsonFileAdapter = require('@bot-whatsapp/database/json')

const flowEndChat = addKeyword('end').addAnswer('Este servicio fue cancelado por falta de actividad del cliente.')

const flowSecundario = addKeyword(['2', 'siguiente']).addAnswer(
    ['📄 Aquí tenemos el flujo secundario'],
    null,
    (_, { idleState }) => {
        idleState.stop()
    }
)

const flowDocs = addKeyword(['doc', 'documentacion', 'documentación']).addAnswer(
    [
        '📄 Aquí encontras las documentación recuerda que puedes mejorarla',
        'https://bot-whatsapp.netlify.app/',
        '\n*2* Para siguiente paso.',
    ],
    null,
    (_, { idleState }) => {
        idleState.reset()
    },
    [flowSecundario]
)

const flowTuto = addKeyword(['tutorial', 'tuto']).addAnswer(
    [
        '🙌 Aquí encontras un ejemplo rapido',
        'https://bot-whatsapp.netlify.app/docs/example/',
        '\n*2* Para siguiente paso.',
    ],
    null,
    null,
    [flowSecundario]
)

const flowGracias = addKeyword(['gracias', 'grac']).addAnswer(
    [
        '🚀 Puedes aportar tu granito de arena a este proyecto',
        '[*opencollective*] https://opencollective.com/bot-whatsapp',
        '[*buymeacoffee*] https://www.buymeacoffee.com/leifermendez',
        '[*patreon*] https://www.patreon.com/leifermendez',
        '\n*2* Para siguiente paso.',
    ],
    null,
    null,
    [flowSecundario]
)

const flowDiscord = addKeyword(['discord']).addAnswer(
    ['🤪 Únete al discord', 'https://link.codigoencasa.com/DISCORD', '\n*2* Para siguiente paso.'],
    null,
    null,
    [flowSecundario]
)

const flowPrincipal = addKeyword(['hola', 'ole', 'alo'])
    .addAction((_, { idleState, gotoFlow }) => {
        idleState.setIdleTime(10)
        idleState.start()
        idleState.on('idle', async () => {
            return await gotoFlow(flowEndChat)
        })
    })
    .addAnswer('🙌 Hola bienvenido a este *Chatbot*')
    .addAnswer(
        [
            'te comparto los siguientes links de interes sobre el proyecto',
            '👉 *doc* para ver la documentación',
            '👉 *gracias*  para ver la lista de videos',
            '👉 *discord* unirte al discord',
        ],
        null,
        (_, { idleState }) => {
            idleState.reset()
        },
        [flowDocs, flowGracias, flowTuto, flowDiscord]
    )

const main = async () => {
    const adapterDB = new JsonFileAdapter()
    const adapterFlow = createFlow([flowPrincipal])
    const adapterProvider = createProvider(BaileysProvider)

    createBot({
        flow: adapterFlow,
        provider: adapterProvider,
        database: adapterDB,
    })

    QRPortalWeb()
}

main()

Video Example:
https://vimeo.com/864136855/afe2980760

Forma parte de este proyecto.

• Discord
• Twitter
• Youtube
• Telegram

[binhodev]

Example code and video updated.

[Aronchavez]

Hola tengo un problema con idleState no funciona:

Estuve revisando el archivo bundlebot.cjs y al parecer hay que usarlo con capture true?

[leifermendez]

🔥🔥 ver implementackon aquí https://github.com/codigoencasa/bot-whatsapp/blob/main/__test__/0.2.1-case.test.js

[leifermendez]

FC

Hola tengo un problema con idleState no funciona:

Estuve revisando el archivo bundlebot.cjs y al parecer hay que usarlo con capture true?

https://github.com/codigoencasa/bot-whatsapp/blob/main/__test__/0.2.1-case.test.js

[Aronchavez]

Gracias funciona perfecto @leifermendez , podriamos hacer algo como esto:

Como se puede ver se hace un aviso antes de finalizar el flujo , pd: yo no uso botones el ejemplo lo saco de un chatbot muy bueno de aca mi pais