@builderbot/cli 1.3.10 → 1.3.12-alpha.1

package/dist/starters/apps/base-js-sherpa-json/src/app.js

@@ -0,0 +1,118 @@
+import { join } from 'path'
+import { createBot, createProvider, createFlow, addKeyword, utils } from '@builderbot/bot'
+import { JsonFileDB as Database } from '@builderbot/database-json'
+import { SherpaProvider as Provider } from '@builderbot/provider-sherpa'
+
+const PORT = process.env.PORT ?? 3008
+
+const discordFlow = addKeyword('doc').addAnswer(
+    ['You can see the documentation here', '📄 https://builderbot.app/docs \n', 'Do you want to continue? *yes*'].join(
+        '\n'
+    ),
+    { capture: true },
+    async (ctx, { gotoFlow, flowDynamic }) => {
+        if (ctx.body.toLocaleLowerCase().includes('yes')) {
+            return gotoFlow(registerFlow)
+        }
+        await flowDynamic('Thanks!')
+        return
+    }
+)
+
+const welcomeFlow = addKeyword(['hi', 'hello', 'hola'])
+    .addAnswer(`🙌 Hello welcome to this *Chatbot*`)
+    .addAnswer(
+        [
+            'I share with you the following links of interest about the project',
+            '👉 *doc* to view the documentation',
+        ].join('\n'),
+        { delay: 800, capture: true },
+        async (ctx, { fallBack }) => {
+            if (!ctx.body.toLocaleLowerCase().includes('doc')) {
+                return fallBack('You should type *doc*')
+            }
+            return
+        },
+        [discordFlow]
+    )
+
+const registerFlow = addKeyword(utils.setEvent('REGISTER_FLOW'))
+    .addAnswer(`What is your name?`, { capture: true }, async (ctx, { state }) => {
+        await state.update({ name: ctx.body })
+    })
+    .addAnswer('What is your age?', { capture: true }, async (ctx, { state }) => {
+        await state.update({ age: ctx.body })
+    })
+    .addAction(async (_, { flowDynamic, state }) => {
+        await flowDynamic(`${state.get('name')}, thanks for your information!: Your age: ${state.get('age')}`)
+    })
+
+const fullSamplesFlow = addKeyword(['samples', utils.setEvent('SAMPLES')])
+    .addAnswer(`💪 I'll send you a lot files...`)
+    .addAnswer(`Send image from Local`, { media: join(process.cwd(), 'assets', 'sample.png') })
+    .addAnswer(`Send video from URL`, {
+        media: 'https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExYTJ0ZGdjd2syeXAwMjQ4aWdkcW04OWlqcXI3Ynh1ODkwZ25zZWZ1dCZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/LCohAb657pSdHv0Q5h/giphy.mp4',
+    })
+    .addAnswer(`Send audio from URL`, { media: 'https://cdn.freesound.org/previews/728/728142_11861866-lq.mp3' })
+    .addAnswer(`Send file from URL`, {
+        media: 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf',
+    })
+
+const main = async () => {
+    const adapterFlow = createFlow([welcomeFlow, registerFlow, fullSamplesFlow])
+    
+    const adapterProvider = createProvider(Provider, 
+		{ version: [2, 3000, 1027934701] as any } 
+	)
+    
+    const adapterDB = new Database({ filename: 'db.json' })
+
+    const { handleCtx, httpServer } = await createBot({
+        flow: adapterFlow,
+        provider: adapterProvider,
+        database: adapterDB,
+    })
+
+    adapterProvider.server.post(
+        '/v1/messages',
+        handleCtx(async (bot, req, res) => {
+            const { number, message, urlMedia } = req.body
+            await bot.sendMessage(number, message, { media: urlMedia ?? null })
+            return res.end('sended')
+        })
+    )
+
+    adapterProvider.server.post(
+        '/v1/register',
+        handleCtx(async (bot, req, res) => {
+            const { number, name } = req.body
+            await bot.dispatch('REGISTER_FLOW', { from: number, name })
+            return res.end('trigger')
+        })
+    )
+
+    adapterProvider.server.post(
+        '/v1/samples',
+        handleCtx(async (bot, req, res) => {
+            const { number, name } = req.body
+            await bot.dispatch('SAMPLES', { from: number, name })
+            return res.end('trigger')
+        })
+    )
+
+    adapterProvider.server.post(
+        '/v1/blacklist',
+        handleCtx(async (bot, req, res) => {
+            const { number, intent } = req.body
+            if (intent === 'remove') bot.blacklist.remove(number)
+            if (intent === 'add') bot.blacklist.add(number)
+
+            res.writeHead(200, { 'Content-Type': 'application/json' })
+            return res.end(JSON.stringify({ status: 'ok', number, intent }))
+        })
+    )
+
+    httpServer(+PORT)
+}
+
+main()

package/dist/starters/apps/base-js-sherpa-memory/.dockerignore

@@ -0,0 +1,7 @@
+dist/*
+node_modules
+.env
+
+*_sessions
+*tokens
+.wwebjs*

package/dist/starters/apps/base-js-sherpa-memory/.eslintrc.json

@@ -0,0 +1,17 @@
+{
+  "env": {
+    "browser": true,
+    "node": true,
+    "es2021": true
+  },
+  "extends": ["eslint:recommended", "plugin:builderbot/recommended"],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["builderbot"],
+  "rules": {
+    "no-unsafe-optional-chaining": "off",
+    "import/no-duplicates": "off"
+  }
+}

package/dist/starters/apps/base-js-sherpa-memory/Dockerfile

@@ -0,0 +1,39 @@
+# Image size ~ 400MB
+FROM node:21-alpine3.18 as builder
+
+WORKDIR /app
+
+RUN corepack enable && corepack prepare pnpm@latest --activate
+ENV PNPM_HOME=/usr/local/bin
+
+COPY . .
+
+COPY package*.json *-lock.yaml ./
+
+RUN apk add --no-cache --virtual .gyp \
+        python3 \
+        make \
+        g++ \
+    && apk add --no-cache git \
+    && pnpm install \
+    && apk del .gyp
+
+FROM node:21-alpine3.18 as deploy
+
+WORKDIR /app
+
+ARG PORT
+ENV PORT $PORT
+EXPOSE $PORT
+
+COPY --from=builder /app ./
+COPY --from=builder /app/*.json /app/*-lock.yaml ./
+
+RUN corepack enable && corepack prepare pnpm@latest --activate 
+ENV PNPM_HOME=/usr/local/bin
+
+RUN npm cache clean --force && pnpm install --production --ignore-scripts \
+    && addgroup -g 1001 -S nodejs && adduser -S -u 1001 nodejs \
+    && rm -rf $PNPM_HOME/.npm $PNPM_HOME/.node-gyp
+
+CMD ["npm", "start"]

package/dist/starters/apps/base-js-sherpa-memory/README.md

@@ -0,0 +1,44 @@
+<p align="center">
+  <a href="https://builderbot.app/">
+    <picture>
+      <img src="https://builderbot.app/assets/thumbnail-vector.png" height="80">
+    </picture>
+    <h2 align="center">BuilderBot</h2>
+  </a>
+</p>
+
+
+
+<p align="center">
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/@builderbot/bot">
+    <img alt="" src="https://img.shields.io/npm/v/@builderbot/bot?color=%2300c200&label=%40bot-whatsapp">
+  </a>
+  <a aria-label="Join the community on GitHub" href="https://link.codigoencasa.com/DISCORD">
+    <img alt="" src="https://img.shields.io/discord/915193197645402142?logo=discord">
+  </a>
+</p>
+
+
+## Getting Started
+
+With this library, you can build automated conversation flows agnostic to the WhatsApp provider, set up automated responses for frequently asked questions, receive and respond to messages automatically, and track interactions with customers. Additionally, you can easily set up triggers to expand functionalities limitlessly.
+
+```
+npm create builderbot@latest
+```
+
+
+## Documentation
+
+Visit [builderbot](https://builderbot.app/) to view the full documentation.
+
+
+## Official Course
+
+If you want to discover all the functions and features offered by the library you can take the course.
+[View Course](https://app.codigoencasa.com/courses/builderbot?refCode=LEIFER)
+
+
+## Contact Us
+- [💻 Discord](https://link.codigoencasa.com/DISCORD)
+- [👌 𝕏 (Twitter)](https://twitter.com/leifermendez)

package/dist/starters/apps/base-js-sherpa-memory/_gitignore

@@ -0,0 +1,10 @@
+dist/*
+node_modules
+.env
+
+*_sessions
+*tokens
+.wwebjs*
+
+*.log
+*qr.png

package/dist/starters/apps/base-js-sherpa-memory/nodemon.json

@@ -0,0 +1,9 @@
+{
+  "watch": ["src"],
+  "ext": "js",
+  "ignore": [
+    "**/*.test.js",
+    "**/*.spec.js"
+],
+  "delay": "3"
+}

package/dist/starters/apps/base-js-sherpa-memory/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "base-bailey-json",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/app.js",
+  "type": "module",
+  "scripts": {
+    "lint": "eslint . --no-ignore",
+    "dev": "npm run lint && nodemon --signal SIGKILL ./src/app.js",
+    "start": "node ./src/app.js"
+  },
+  "keywords": [],
+  "dependencies": {
+    "@builderbot/bot": "latest",
+    "@builderbot/provider-sherpa": "latest"
+  },
+  "devDependencies": {
+    "eslint-plugin-builderbot": "latest",
+    "eslint": "^8.57.0",
+    "nodemon": "^3.1.0"
+  },
+  "author": "",
+  "license": "ISC"
+}

package/dist/starters/apps/base-js-sherpa-memory/src/app.js

@@ -0,0 +1,117 @@
+import { join } from 'path'
+import { createBot, createProvider, createFlow, addKeyword, utils } from '@builderbot/bot'
+import { MemoryDB as Database } from '@builderbot/bot'
+import { SherpaProvider as Provider } from '@builderbot/provider-sherpa'
+
+const PORT = process.env.PORT ?? 3008
+
+const discordFlow = addKeyword('doc').addAnswer(
+    ['You can see the documentation here', '📄 https://builderbot.app/docs \n', 'Do you want to continue? *yes*'].join(
+        '\n'
+    ),
+    { capture: true },
+    async (ctx, { gotoFlow, flowDynamic }) => {
+        if (ctx.body.toLocaleLowerCase().includes('yes')) {
+            return gotoFlow(registerFlow)
+        }
+        await flowDynamic('Thanks!')
+        return
+    }
+)
+
+const welcomeFlow = addKeyword(['hi', 'hello', 'hola'])
+    .addAnswer(`🙌 Hello welcome to this *Chatbot*`)
+    .addAnswer(
+        [
+            'I share with you the following links of interest about the project',
+            '👉 *doc* to view the documentation',
+        ].join('\n'),
+        { delay: 800, capture: true },
+        async (ctx, { fallBack }) => {
+            if (!ctx.body.toLocaleLowerCase().includes('doc')) {
+                return fallBack('You should type *doc*')
+            }
+            return
+        },
+        [discordFlow]
+    )
+
+const registerFlow = addKeyword(utils.setEvent('REGISTER_FLOW'))
+    .addAnswer(`What is your name?`, { capture: true }, async (ctx, { state }) => {
+        await state.update({ name: ctx.body })
+    })
+    .addAnswer('What is your age?', { capture: true }, async (ctx, { state }) => {
+        await state.update({ age: ctx.body })
+    })
+    .addAction(async (_, { flowDynamic, state }) => {
+        await flowDynamic(`${state.get('name')}, thanks for your information!: Your age: ${state.get('age')}`)
+    })
+
+const fullSamplesFlow = addKeyword(['samples', utils.setEvent('SAMPLES')])
+    .addAnswer(`💪 I'll send you a lot files...`)
+    .addAnswer(`Send image from Local`, { media: join(process.cwd(), 'assets', 'sample.png') })
+    .addAnswer(`Send video from URL`, {
+        media: 'https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExYTJ0ZGdjd2syeXAwMjQ4aWdkcW04OWlqcXI3Ynh1ODkwZ25zZWZ1dCZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/LCohAb657pSdHv0Q5h/giphy.mp4',
+    })
+    .addAnswer(`Send audio from URL`, { media: 'https://cdn.freesound.org/previews/728/728142_11861866-lq.mp3' })
+    .addAnswer(`Send file from URL`, {
+        media: 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf',
+    })
+
+const main = async () => {
+    const adapterFlow = createFlow([welcomeFlow, registerFlow, fullSamplesFlow])
+    
+    const adapterProvider = createProvider(Provider, 
+		{ version: [2, 3000, 1027934701] as any } 
+	)
+    const adapterDB = new Database()
+
+    const { handleCtx, httpServer } = await createBot({
+        flow: adapterFlow,
+        provider: adapterProvider,
+        database: adapterDB,
+    })
+
+    adapterProvider.server.post(
+        '/v1/messages',
+        handleCtx(async (bot, req, res) => {
+            const { number, message, urlMedia } = req.body
+            await bot.sendMessage(number, message, { media: urlMedia ?? null })
+            return res.end('sended')
+        })
+    )
+
+    adapterProvider.server.post(
+        '/v1/register',
+        handleCtx(async (bot, req, res) => {
+            const { number, name } = req.body
+            await bot.dispatch('REGISTER_FLOW', { from: number, name })
+            return res.end('trigger')
+        })
+    )
+
+    adapterProvider.server.post(
+        '/v1/samples',
+        handleCtx(async (bot, req, res) => {
+            const { number, name } = req.body
+            await bot.dispatch('SAMPLES', { from: number, name })
+            return res.end('trigger')
+        })
+    )
+
+    adapterProvider.server.post(
+        '/v1/blacklist',
+        handleCtx(async (bot, req, res) => {
+            const { number, intent } = req.body
+            if (intent === 'remove') bot.blacklist.remove(number)
+            if (intent === 'add') bot.blacklist.add(number)
+
+            res.writeHead(200, { 'Content-Type': 'application/json' })
+            return res.end(JSON.stringify({ status: 'ok', number, intent }))
+        })
+    )
+
+    httpServer(+PORT)
+}
+
+main()

package/dist/starters/apps/base-js-sherpa-mongo/.dockerignore

@@ -0,0 +1,7 @@
+dist/*
+node_modules
+.env
+
+*_sessions
+*tokens
+.wwebjs*

package/dist/starters/apps/base-js-sherpa-mongo/.eslintrc.json

@@ -0,0 +1,17 @@
+{
+  "env": {
+    "browser": true,
+    "node": true,
+    "es2021": true
+  },
+  "extends": ["eslint:recommended", "plugin:builderbot/recommended"],
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "plugins": ["builderbot"],
+  "rules": {
+    "no-unsafe-optional-chaining": "off",
+    "import/no-duplicates": "off"
+  }
+}

package/dist/starters/apps/base-js-sherpa-mongo/Dockerfile

@@ -0,0 +1,39 @@
+# Image size ~ 400MB
+FROM node:21-alpine3.18 as builder
+
+WORKDIR /app
+
+RUN corepack enable && corepack prepare pnpm@latest --activate
+ENV PNPM_HOME=/usr/local/bin
+
+COPY . .
+
+COPY package*.json *-lock.yaml ./
+
+RUN apk add --no-cache --virtual .gyp \
+        python3 \
+        make \
+        g++ \
+    && apk add --no-cache git \
+    && pnpm install \
+    && apk del .gyp
+
+FROM node:21-alpine3.18 as deploy
+
+WORKDIR /app
+
+ARG PORT
+ENV PORT $PORT
+EXPOSE $PORT
+
+COPY --from=builder /app ./
+COPY --from=builder /app/*.json /app/*-lock.yaml ./
+
+RUN corepack enable && corepack prepare pnpm@latest --activate 
+ENV PNPM_HOME=/usr/local/bin
+
+RUN npm cache clean --force && pnpm install --production --ignore-scripts \
+    && addgroup -g 1001 -S nodejs && adduser -S -u 1001 nodejs \
+    && rm -rf $PNPM_HOME/.npm $PNPM_HOME/.node-gyp
+
+CMD ["npm", "start"]

package/dist/starters/apps/base-js-sherpa-mongo/README.md

@@ -0,0 +1,44 @@
+<p align="center">
+  <a href="https://builderbot.app/">
+    <picture>
+      <img src="https://builderbot.app/assets/thumbnail-vector.png" height="80">
+    </picture>
+    <h2 align="center">BuilderBot</h2>
+  </a>
+</p>
+
+
+
+<p align="center">
+  <a aria-label="NPM version" href="https://www.npmjs.com/package/@builderbot/bot">
+    <img alt="" src="https://img.shields.io/npm/v/@builderbot/bot?color=%2300c200&label=%40bot-whatsapp">
+  </a>
+  <a aria-label="Join the community on GitHub" href="https://link.codigoencasa.com/DISCORD">
+    <img alt="" src="https://img.shields.io/discord/915193197645402142?logo=discord">
+  </a>
+</p>
+
+
+## Getting Started
+
+With this library, you can build automated conversation flows agnostic to the WhatsApp provider, set up automated responses for frequently asked questions, receive and respond to messages automatically, and track interactions with customers. Additionally, you can easily set up triggers to expand functionalities limitlessly.
+
+```
+npm create builderbot@latest
+```
+
+
+## Documentation
+
+Visit [builderbot](https://builderbot.app/) to view the full documentation.
+
+
+## Official Course
+
+If you want to discover all the functions and features offered by the library you can take the course.
+[View Course](https://app.codigoencasa.com/courses/builderbot?refCode=LEIFER)
+
+
+## Contact Us
+- [💻 Discord](https://link.codigoencasa.com/DISCORD)
+- [👌 𝕏 (Twitter)](https://twitter.com/leifermendez)

package/dist/starters/apps/base-js-sherpa-mongo/_gitignore

@@ -0,0 +1,10 @@
+dist/*
+node_modules
+.env
+
+*_sessions
+*tokens
+.wwebjs*
+
+*.log
+*qr.png

package/dist/starters/apps/base-js-sherpa-mongo/nodemon.json

@@ -0,0 +1,9 @@
+{
+  "watch": ["src"],
+  "ext": "js",
+  "ignore": [
+    "**/*.test.js",
+    "**/*.spec.js"
+],
+  "delay": "3"
+}

package/dist/starters/apps/base-js-sherpa-mongo/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "base-bailey-json",
+  "version": "1.0.0",
+  "description": "",
+  "main": "src/app.js",
+  "type": "module",
+  "scripts": {
+    "lint": "eslint . --no-ignore",
+    "dev": "npm run lint && nodemon --signal SIGKILL ./src/app.js",
+    "start": "node ./src/app.js"
+  },
+  "keywords": [],
+  "dependencies": {
+    "@builderbot/bot": "latest",
+    "@builderbot/provider-sherpa": "latest",
+    "@builderbot/database-mongo": "latest"
+  },
+  "devDependencies": {
+    "eslint-plugin-builderbot": "latest",
+    "eslint": "^8.57.0",
+    "nodemon": "^3.1.0"
+  },
+  "author": "",
+  "license": "ISC"
+}

package/dist/starters/apps/base-js-sherpa-mongo/src/app.js

@@ -0,0 +1,120 @@
+import { join } from 'path'
+import { createBot, createProvider, createFlow, addKeyword, utils } from '@builderbot/bot'
+import { MongoAdapter as Database } from '@builderbot/database-mongo'
+import { SherpaProvider as Provider } from '@builderbot/provider-sherpa'
+
+const PORT = process.env.PORT ?? 3008
+
+const discordFlow = addKeyword('doc').addAnswer(
+    ['You can see the documentation here', '📄 https://builderbot.app/docs \n', 'Do you want to continue? *yes*'].join(
+        '\n'
+    ),
+    { capture: true },
+    async (ctx, { gotoFlow, flowDynamic }) => {
+        if (ctx.body.toLocaleLowerCase().includes('yes')) {
+            return gotoFlow(registerFlow)
+        }
+        await flowDynamic('Thanks!')
+        return
+    }
+)
+
+const welcomeFlow = addKeyword(['hi', 'hello', 'hola'])
+    .addAnswer(`🙌 Hello welcome to this *Chatbot*`)
+    .addAnswer(
+        [
+            'I share with you the following links of interest about the project',
+            '👉 *doc* to view the documentation',
+        ].join('\n'),
+        { delay: 800, capture: true },
+        async (ctx, { fallBack }) => {
+            if (!ctx.body.toLocaleLowerCase().includes('doc')) {
+                return fallBack('You should type *doc*')
+            }
+            return
+        },
+        [discordFlow]
+    )
+
+const registerFlow = addKeyword(utils.setEvent('REGISTER_FLOW'))
+    .addAnswer(`What is your name?`, { capture: true }, async (ctx, { state }) => {
+        await state.update({ name: ctx.body })
+    })
+    .addAnswer('What is your age?', { capture: true }, async (ctx, { state }) => {
+        await state.update({ age: ctx.body })
+    })
+    .addAction(async (_, { flowDynamic, state }) => {
+        await flowDynamic(`${state.get('name')}, thanks for your information!: Your age: ${state.get('age')}`)
+    })
+
+const fullSamplesFlow = addKeyword(['samples', utils.setEvent('SAMPLES')])
+    .addAnswer(`💪 I'll send you a lot files...`)
+    .addAnswer(`Send image from Local`, { media: join(process.cwd(), 'assets', 'sample.png') })
+    .addAnswer(`Send video from URL`, {
+        media: 'https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExYTJ0ZGdjd2syeXAwMjQ4aWdkcW04OWlqcXI3Ynh1ODkwZ25zZWZ1dCZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/LCohAb657pSdHv0Q5h/giphy.mp4',
+    })
+    .addAnswer(`Send audio from URL`, { media: 'https://cdn.freesound.org/previews/728/728142_11861866-lq.mp3' })
+    .addAnswer(`Send file from URL`, {
+        media: 'https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf',
+    })
+
+const main = async () => {
+    const adapterFlow = createFlow([welcomeFlow, registerFlow, fullSamplesFlow])
+    
+    const adapterProvider = createProvider(Provider, 
+		{ version: [2, 3000, 1027934701] as any } 
+	)
+        const adapterDB = new Database({
+        dbUri: process.env.MONGO_DB_URI,
+        dbName: process.env.MONGO_DB_NAME,
+    })
+
+    const { handleCtx, httpServer } = await createBot({
+        flow: adapterFlow,
+        provider: adapterProvider,
+        database: adapterDB,
+    })
+
+    adapterProvider.server.post(
+        '/v1/messages',
+        handleCtx(async (bot, req, res) => {
+            const { number, message, urlMedia } = req.body
+            await bot.sendMessage(number, message, { media: urlMedia ?? null })
+            return res.end('sended')
+        })
+    )
+
+    adapterProvider.server.post(
+        '/v1/register',
+        handleCtx(async (bot, req, res) => {
+            const { number, name } = req.body
+            await bot.dispatch('REGISTER_FLOW', { from: number, name })
+            return res.end('trigger')
+        })
+    )
+
+    adapterProvider.server.post(
+        '/v1/samples',
+        handleCtx(async (bot, req, res) => {
+            const { number, name } = req.body
+            await bot.dispatch('SAMPLES', { from: number, name })
+            return res.end('trigger')
+        })
+    )
+
+    adapterProvider.server.post(
+        '/v1/blacklist',
+        handleCtx(async (bot, req, res) => {
+            const { number, intent } = req.body
+            if (intent === 'remove') bot.blacklist.remove(number)
+            if (intent === 'add') bot.blacklist.add(number)
+
+            res.writeHead(200, { 'Content-Type': 'application/json' })
+            return res.end(JSON.stringify({ status: 'ok', number, intent }))
+        })
+    )
+
+    httpServer(+PORT)
+}
+
+main()