feat(provider): added dialogflow

This commit is contained in:
Leifer Mendez
2022-12-19 13:32:54 +01:00
12 changed files with 225 additions and 8 deletions

View File

@@ -1,2 +1,2 @@
CTX: Es el objeto que representa un mensaje, con opciones, id, ref
messageInComming: Objeto entrante del provider {body, from,...}
messageInComming: Objeto entrante del provider {body, from,to,...}

View File

@@ -10,6 +10,7 @@
"create-bot:rollup": "rollup --config ./packages/create-bot-whatsapp/rollup-create.config.js ",
"bot:rollup": "rollup --config ./packages/bot/rollup-bot.config.js",
"provider:rollup": "rollup --config ./packages/provider/rollup-provider.config.js ",
"contexts:rollup": "rollup --config ./packages/contexts/rollup-contexts.config.js",
"database:rollup": "rollup --config ./packages/database/rollup-database.config.js",
"create-bot-whatsapp:rollup": "rollup --config ./packages/create-bot-whatsapp/rollup-create.config.js",
"format:check": "prettier --check ./packages",
@@ -17,7 +18,7 @@
"fmt.staged": "pretty-quick --staged",
"lint:check": "eslint ./packages",
"lint:fix": "eslint --fix ./packages",
"build": "yarn run cli:rollup && yarn run bot:rollup && yarn run provider:rollup && yarn run database:rollup && yarn run create-bot-whatsapp:rollup",
"build": "yarn run cli:rollup && yarn run bot:rollup && yarn run provider:rollup && yarn run database:rollup && yarn run contexts:rollup && yarn run create-bot-whatsapp:rollup",
"copy.lib": "node ./scripts/move.js",
"test.unit": "node ./node_modules/uvu/bin.js packages test",
"test.coverage": "node ./node_modules/c8/bin/c8.js npm run test.unit",
@@ -37,6 +38,7 @@
"packages/cli",
"packages/database",
"packages/provider",
"packages/contexts",
"packages/docs"
],
"keywords": [

View File

@@ -58,13 +58,13 @@ class CoreClass {
]
/**
*
* @param {*} messageInComming
* GLOSSARY.md
* @param {*} messageCtxInComming
* @returns
*/
handleMsg = async (messageInComming) => {
logger.log(`[handleMsg]: `, messageInComming)
const { body, from } = messageInComming
handleMsg = async (messageCtxInComming) => {
logger.log(`[handleMsg]: `, messageCtxInComming)
const { body, from } = messageCtxInComming
let msgToSend = []
let fallBackFlag = false

View File

@@ -0,0 +1,16 @@
{
"name": "@bot-whatsapp/contexts",
"version": "0.0.1",
"description": "",
"main": "./lib/bundle.contexts.cjs",
"files": [
"./lib/"
],
"exports": {
"./mock": "./lib/mock/index.cjs",
"./dialogflow": "./lib/dialogflow/index.cjs"
},
"dependencies": {
"@bot-whatsapp/bot": "*"
}
}

View File

@@ -0,0 +1,24 @@
const banner = require('../../config/banner.rollup.json')
const commonjs = require('@rollup/plugin-commonjs')
const { join } = require('path')
module.exports = [
{
input: join(__dirname, 'src', 'mock', 'index.js'),
output: {
banner: banner['banner.output'].join(''),
file: join(__dirname, 'lib', 'mock', 'index.cjs'),
format: 'cjs',
},
plugins: [commonjs()],
},
{
input: join(__dirname, 'src', 'dialogflow', 'index.js'),
output: {
banner: banner['banner.output'].join(''),
file: join(__dirname, 'lib', 'dialogflow', 'index.cjs'),
format: 'cjs',
},
plugins: [commonjs()],
},
]

View File

@@ -0,0 +1,113 @@
const { CoreClass } = require('@bot-whatsapp/bot')
const dialogflow = require('@google-cloud/dialogflow')
const { existsSync, readFileSync } = require('fs')
const { join } = require('path')
/**
* Necesita extender de core.class
* handleMsg(messageInComming) // const { body, from } = messageInComming
*/
const GOOGLE_ACCOUNT_PATH = join(process.cwd(), 'google-key.json')
class DialogFlowContext extends CoreClass {
projectId = null
configuration = null
sessionClient = null
optionsDX = {
language: 'es',
}
constructor(_database, _provider, _optionsDX = {}) {
super(null, _database, _provider)
this.optionsDX = { ...this.optionsDX, ..._optionsDX }
this.init()
}
/**
* Verificar conexión con servicio de DialogFlow
*/
init = () => {
if (!existsSync(GOOGLE_ACCOUNT_PATH)) {
console.log(`[ERROR]: No se encontro ${GOOGLE_ACCOUNT_PATH}`)
/**
* Emitir evento de error para que se mueste por consola dicinedo que no tiene el json
* */
}
const rawJson = readFileSync(GOOGLE_ACCOUNT_PATH, 'utf-8')
const { project_id, private_key, client_email } = JSON.parse(rawJson)
this.projectId = project_id
this.configuration = {
credentials: {
private_key,
client_email,
},
}
this.sessionClient = new dialogflow.SessionsClient(this.configuration)
}
/**
* GLOSSARY.md
* @param {*} messageCtxInComming
* @returns
*/
handleMsg = async (messageCtxInComming) => {
const languageCode = this.optionsDX.language
const { from, body } = messageCtxInComming
let customPayload = {}
/**
* 📄 Creamos session de contexto basado en el numero de la persona
* para evitar este problema.
* https://github.com/codigoencasa/bot-whatsapp/pull/140
*/
const session = this.sessionClient.projectAgentSessionPath(
this.projectId,
from
)
const reqDialog = {
session,
queryInput: {
text: {
text: body,
languageCode,
},
},
}
const [single] = (await this.sessionClient.detectIntent(reqDialog)) || [
null,
]
const { queryResult } = single
const msgPayload = queryResult?.fulfillmentMessages?.find(
(a) => a.message === 'payload'
)
// Revisamos si el dialogFlow tiene multimedia
if (msgPayload && msgPayload?.payload) {
const { fields } = msgPayload.payload
const mapButtons = fields?.buttons?.listValue?.values.map((m) => {
return m?.structValue?.fields?.body?.stringValue
})
customPayload = {
media: fields?.media?.stringValue,
buttons: mapButtons,
}
}
const ctxFromDX = {
...customPayload,
answer: queryResult?.fulfillmentText,
}
this.sendFlow([ctxFromDX], from)
}
}
module.exports = DialogFlowContext

View File

@@ -0,0 +1,14 @@
const DialogFlowClass = require('./dialogflow.class')
/**
* Crear instancia de clase Bot
* @param {*} args
* @returns
*/
const createBotDialog = async ({ database, provider }) =>
new DialogFlowClass(database, provider)
module.exports = {
createBotDialog,
DialogFlowClass,
}

View File

@@ -0,0 +1,14 @@
const MockClass = require('./mock.class')
/**
* Crear instancia de clase Bot
* @param {*} args
* @returns
*/
const createBotMock = async ({ database, provider }) =>
new MockClass(database, provider)
module.exports = {
createBotMock,
MockClass,
}

View File

@@ -0,0 +1,24 @@
const { CoreClass } = require('@bot-whatsapp/bot')
/**
* Necesita extender de core.class
* handleMsg(messageInComming) // const { body, from } = messageInComming
*/
class MockContext extends CoreClass {
constructor(_database, _provider) {
super(null, _database, _provider)
}
init = () => {}
/**
* GLOSSARY.md
* @param {*} messageCtxInComming
* @returns
*/
handleMsg = async ({ from, body }) => {
console.log('DEBUG:', messageCtxInComming)
}
}
module.exports = MockContext

View File

@@ -100,7 +100,8 @@ class BaileysProvider extends ProviderClass {
},
{
event: 'messages.upsert',
func: ({ messages }) => {
func: ({ messages, type }) => {
if (type !== 'notify') return
const [messageCtx] = messages
let payload = {
...messageCtx,

View File

@@ -15,4 +15,5 @@ Promise.all([
copyLibPkg('bot', appDir),
copyLibPkg('database', appDir),
copyLibPkg('provider', appDir),
copyLibPkg('contexts', appDir),
]).then(() => console.log('Todas las librerías copiadas'))

View File

@@ -963,6 +963,14 @@ __metadata:
languageName: unknown
linkType: soft
"@bot-whatsapp/contexts@workspace:packages/contexts":
version: 0.0.0-use.local
resolution: "@bot-whatsapp/contexts@workspace:packages/contexts"
dependencies:
"@bot-whatsapp/bot": "*"
languageName: unknown
linkType: soft
"@bot-whatsapp/database@npm:*":
version: 0.1.2
resolution: "@bot-whatsapp/database@npm:0.1.2"