8 | 
9 |
10 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/assets/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom modules/delegate-bot-conversation/assets/logo.png
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/build.extras.js:
--------------------------------------------------------------------------------
1 | /**
2 | * This file includes paths (or glob: https://www.npmjs.com/package/glob) that will be copied in the "dist" folder when the module is built.
3 | *
4 | * Why would you want to put files in the "dist" folder?
5 | * Only files in that folder can be read by Botpress, so if your templates aren't in the "dist" folder, they won't be available.
6 | */
7 | module.exports = {
8 | copyFiles: ['src/bot-templates/**']
9 | }
10 |
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/delegate-bot-conversation.tgz:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom modules/delegate-bot-conversation/delegate-bot-conversation.tgz
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "delegate-bot-conversation",
3 | "version": "1.0.0",
4 | "description": "Transfer a conversation from one bot to another and back again",
5 | "private": true,
6 | "main": "dist/backend/index.js",
7 | "author": "Botpress, Inc.",
8 | "license": "AGPL-3.0-only",
9 | "webpack": {
10 | "externals": {
11 | "react-select": "ReactSelect",
12 | "reactstrap": "Reactstrap",
13 | "botpress/tooltip": "BotpressTooltip"
14 | }
15 | },
16 | "scripts": {
17 | "build": "node ../../build/module-builder/bin/entry build",
18 | "watch": "node ../../build/module-builder/bin/entry watch",
19 | "package": "node ../../build/module-builder/bin/entry package"
20 | },
21 | "dependencies": {}
22 | }
23 |
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/src/actions/README.md:
--------------------------------------------------------------------------------
1 | ## Actions
2 |
3 | Every time the server is started, Actions that you put in this folder will be copied in the `data/global/actions/delegate-bot-conversation/` folder.
4 | They will overwrite existing files only if they haven't been edited manually.
5 |
6 | Actions added this way will be available on the flow editor using `delegate-bot-conversation/your-action-name`
7 |
8 | Check the documentation for more information about [Actions](https://botpress.com/docs/build/code#actions)
9 |
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/src/actions/end-delegation.js:
--------------------------------------------------------------------------------
1 | const _ = require('lodash')
2 |
3 | /**
4 | * Send an event back to the main bot so it knows to end delegation.
5 | * @End Delegation
6 | * @category Custom
7 | */
8 | const myAction = async () => {
9 | if (event.channel === 'api') {
10 | await bp.events.sendEvent(
11 | bp.IO.Event({
12 | ..._.pick(event, ['channel', 'target', 'threadId', 'botId']),
13 | type: 'custom',
14 | direction: 'outgoing',
15 | payload: {
16 | type: 'end_delegation'
17 | }
18 | })
19 | )
20 | }
21 | }
22 |
23 | return myAction()
24 |
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/src/backend/api.ts:
--------------------------------------------------------------------------------
1 | import * as sdk from 'botpress/sdk'
2 |
3 | export default async (bp: typeof sdk) => {
4 | /**
5 | * This is an example route to get you started.
6 | * Your API will be available at `http://localhost:3000/api/v1/bots/BOT_NAME/mod/delegate-bot-conversation`
7 | * Just replace BOT_NAME by your bot ID
8 | */
9 | const router = bp.http.createRouterForBot('delegate-bot-conversation')
10 |
11 | // Link to access this route: http://localhost:3000/api/v1/bots/BOT_NAME/mod/delegate-bot-conversation/my-first-route
12 | router.get('/my-first-route', async (req, res) => {
13 | // Since the bot ID is required to access your module,
14 | const botId = req.params.botId
15 |
16 | /**
17 | * This is how you would get your module configuration for a specific bot.
18 | * If there is no configuration for the bot, global config will be used. Check `config.ts` to set your configurations
19 | */
20 | const config = await bp.config.getModuleConfigForBot('delegate-bot-conversation', botId)
21 |
22 | res.sendStatus(200)
23 | })
24 | }
25 |
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/src/backend/endDelegation.ts:
--------------------------------------------------------------------------------
1 | import * as sdk from 'botpress/sdk'
2 |
3 | export const generateFlow = async (
4 | data: any,
5 | metadata: sdk.FlowGeneratorMetadata
6 | ): Promise
9 |
10 |
11 | Files in the assets folder are publicly available to anyone.
12 | You can link to other files using relative path: /assets/modules/delegate-bot-conversation
13 | When you change assets in your module folder, Botpress needs to be restarted to take new files
14 |
16 | Place the skill on any of the sub bot's flows, where you want to end the delegation. There's no configuration
17 | needed, just drag and drop. Important: At least one message must be sent to the sub Bot in order to end
18 | the delegation.
19 |
20 | )
21 | }
22 | }
23 |
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/src/views/full/index.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 |
3 | /**
4 | * This is an example on how you may export multiple components from your view
5 | * If your module offers custom Skills, you would export your skill components here
6 | */
7 |
8 | export { Delegate } from './delegate'
9 | export { EndDelegation } from './endDelegation'
10 |
11 | /**
12 | * This file is the full view of your module. It automatically includes heavy dependencies, like react-bootstrap
13 | * If you want to display an interface for your module, export your principal view as "default"
14 | */
15 | export default class MyMainView extends React.Component {
16 | render() {
17 | return Some interface
18 | }
19 | }
20 |
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/src/views/lite/index.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 |
3 | /**
4 | * The lite views are meant to be lightweight. They shouldn't include heavy dependencies.
5 | * Common use case is to add custom components on the web chat. It's also possible to share them to other modules
6 | *
7 | * Even if you don't plan to include a lite view, you must include an empty view that returns 'null'
8 | */
9 | export class LiteView extends React.Component {
10 | render() {
11 | return null
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/src/views/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../../tsconfig_view.shared.json",
3 | "compilerOptions": {
4 | "baseUrl": "./",
5 | "typeRoots": ["../../node_modules/@types", "lite/typings.d.ts"]
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../tsconfig.shared.json",
3 | "compilerOptions": {
4 | "baseUrl": "./"
5 | }
6 | }
7 |
--------------------------------------------------------------------------------
/custom modules/delegate-bot-conversation/yarn.lock:
--------------------------------------------------------------------------------
1 | # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
2 | # yarn lockfile v1
3 |
4 |
5 |
--------------------------------------------------------------------------------
/custom modules/download-transcript-button/download-transcript-button.tgz:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom modules/download-transcript-button/download-transcript-button.tgz
--------------------------------------------------------------------------------
/custom modules/download-transcript-button/source code/README.md:
--------------------------------------------------------------------------------
1 | ### How to modify/develop new features to the module
2 |
3 | 1. Copy this folder to the `modules` folder of your botpress repository
4 | 2. Change the folder name to 'download-transcript-button'
5 | 3. Download dependencies and build the module: `yarn && yarn build`
6 | 4. Edit your `data/global/botpress.config.json` and add the module location, like below:
7 | 5. Run Botpress to see the module being used
8 |
9 | ```js
10 | "modules": [
11 | ...
12 | {
13 | "location": "MODULES_ROOT/download-transcript-button",
14 | "enabled": true
15 | }
16 | ]
17 | ```
18 |
19 | 6. Change the source code
20 | 7. Build the module: `yarn build`
21 | 8. To package it and create a '.tgz' file, run `yarn && yarn build`
22 |
--------------------------------------------------------------------------------
/custom modules/download-transcript-button/source code/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "download-transcript-button",
3 | "version": "1.0.0",
4 | "description": "Download Transcript Button",
5 | "private": true,
6 | "main": "dist/backend/index.js",
7 | "scripts": {
8 | "build": "node ../../build/module-builder/bin/entry build",
9 | "watch": "node ../../build/module-builder/bin/entry watch",
10 | "package": "node ../../build/module-builder/bin/entry package"
11 | },
12 | "author": "Botpress, Inc.",
13 | "license": "AGPL-3.0-only",
14 | "dependencies": {
15 | "react-select": "^2.4.2"
16 | }
17 | }
18 |
--------------------------------------------------------------------------------
/custom modules/download-transcript-button/source code/src/actions/sendDownloadTranscriptButton.js:
--------------------------------------------------------------------------------
1 | /**
2 | *
3 | * @title Send Download Transcript Button
4 | * @category Module Download Transcription Button
5 | * @author Botpress, Inc.
6 | */
7 | const sendDownloadTranscriptButton = async () => {
8 | if (event.channel != 'web') {
9 | return
10 | }
11 |
12 | const postbackEvent = bp.IO.Event({
13 | type: 'custom',
14 | channel: 'web',
15 | direction: 'outgoing',
16 | target: event.target,
17 | botId: event.botId,
18 | payload: { type: 'custom', component: 'DownloadTranscriptButton', module: 'download-transcript-button' }
19 | })
20 |
21 | await bp.events.sendEvent(postbackEvent)
22 | }
23 |
24 | return sendDownloadTranscriptButton()
25 |
--------------------------------------------------------------------------------
/custom modules/download-transcript-button/source code/src/backend/index.ts:
--------------------------------------------------------------------------------
1 | import * as sdk from 'botpress/sdk'
2 |
3 | const entryPoint: sdk.ModuleEntryPoint = {
4 | definition: {
5 | name: 'download-transcript-button',
6 | menuIcon: 'none',
7 | menuText: 'Download Transcript Button',
8 | fullName: 'Download Transcript Button',
9 | noInterface: true, // This prevents your module from being displayed in the menu, since we only add custom components here
10 | homepage: 'https://botpress.com'
11 | }
12 | }
13 |
14 | export default entryPoint
15 |
--------------------------------------------------------------------------------
/custom modules/download-transcript-button/source code/src/views/full/index.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 |
3 | export default class MyModule extends React.Component {
4 | render() {
5 | return null
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/custom modules/download-transcript-button/source code/src/views/lite/components/DownloadTranscriptButton.jsx:
--------------------------------------------------------------------------------
1 | export class DownloadTranscriptButton extends React.Component {
2 | onClick = () => {
3 | this.props.store.downloadConversation()
4 | }
5 |
6 | render() {
7 | return (
8 |
11 | )
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/custom modules/download-transcript-button/source code/src/views/lite/index.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 |
3 | export { DownloadTranscriptButton } from './components/DownloadTranscriptButton'
4 |
5 | export class InjectedBelow extends React.Component {
6 | render() {
7 | return null
8 | }
9 | }
10 |
--------------------------------------------------------------------------------
/custom modules/download-transcript-button/source code/src/views/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../../tsconfig_view.shared.json",
3 | "compilerOptions": {
4 | "baseUrl": "./",
5 | "typeRoots": ["../../node_modules/@types", "lite/typings.d.ts"]
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/custom modules/download-transcript-button/source code/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../tsconfig.shared.json",
3 | "compilerOptions": {
4 | "baseUrl": "./"
5 | }
6 | }
7 |
--------------------------------------------------------------------------------
/custom modules/flow-utils/README.md:
--------------------------------------------------------------------------------
1 | # Flow Utils
2 | Original Author: David Vitora
3 |
4 | ## Overview
5 | This module gives many of the fuctionalities of arrays to the flow editor.
6 | - For Each Skill
7 | - iterate through array
8 | - Add To Array Skill
9 | - Add and item on array at temp/user/session memory
10 | - Create Array Skill
11 | - Create an array on temp/user/session memory
12 | - Raw Reply Skill
13 | - Provides details that can be helpful for debugging and desinging dynamic content for skills
14 |
15 |
16 | ## Use Cases
17 | - processing array data
18 | - creating/editing array objects
19 | - debugging
20 |
21 |
22 | ## How to Use
23 | 1. Add Module (flow-utils.tgz)
24 | 2. Go to Flow editor
25 | 3. Select Desired Skill
26 | - For Each
27 | - 
28 |
29 | - Add to Array
30 | - 
31 |
32 | - Create Array
33 | - 
34 |
35 | - Raw Reply
36 | - 
37 |
38 | 4. Add to flows
39 |
40 |
--------------------------------------------------------------------------------
/custom modules/flow-utils/bot_demo.tgz:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom modules/flow-utils/bot_demo.tgz
--------------------------------------------------------------------------------
/custom modules/flow-utils/build.extras.js:
--------------------------------------------------------------------------------
1 | // This is only to make sure that the module builder exports the demo bot template.
2 | // If you don't include bot templates with your module, this file can be excluded.
3 | module.exports = {
4 | copyFiles: ['src/bot-templates/**']
5 | }
6 |
--------------------------------------------------------------------------------
/custom modules/flow-utils/flow-utils.tgz:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom modules/flow-utils/flow-utils.tgz
--------------------------------------------------------------------------------
/custom modules/flow-utils/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "flow-utils",
3 | "version": "1.0.0",
4 | "description": "Flow Utils",
5 | "private": true,
6 | "main": "dist/backend/index.js",
7 | "webpack": {
8 | "externals": {
9 | "reactstrap": "Reactstrap",
10 | "botpress/tooltip": "BotpressTooltip"
11 | }
12 | },
13 | "scripts": {
14 | "build": "node ../../build/module-builder/bin/entry build",
15 | "watch": "node ../../build/module-builder/bin/entry watch",
16 | "package": "node ../../build/module-builder/bin/entry package"
17 | },
18 | "author": "Botpress, Inc.",
19 | "license": "AGPL-3.0-only",
20 | "dependencies": {
21 | "he": "^1.2.0",
22 | "nanoid": "^2.1.6",
23 | "react-bootstrap": "^0.33.1",
24 | "react-select": "^2.4.2"
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/custom modules/flow-utils/src/actions/add_to_array.js:
--------------------------------------------------------------------------------
1 | /**
2 | * @hidden true
3 | */
4 |
5 | const _ = require('lodash')
6 | var he = require('he')
7 |
8 | const add_to_array = async (variableArrayName, variableArrayScope, value) => {
9 | const context = {
10 | event,
11 | user: event.state.user,
12 | temp: event.state.temp,
13 | session: event.state.session
14 | }
15 |
16 | if (value.trim().match(/^\${.*}$/g)) {
17 | // bp.cms.renderTemplate will use mustache, which is not good to assign complex values
18 | value = _.get(context, value.replace(/\${|}/g, ''))
19 | } else {
20 | value = he.decode(value)
21 | }
22 |
23 | try {
24 | value = JSON.parse(value)
25 | } catch (e) {
26 | bp.logger.attachError(e).error('[AddToArray] Error parsing item')
27 | }
28 |
29 | const scope = event.state[variableArrayScope]
30 | const array = _.get(event.state, `${variableArrayScope}.${variableArrayName}`)
31 | if (!scope || !array || !Array.isArray(array)) {
32 | throw new Error(`Array with variableName ${variableArrayName} and scope ${variableArrayScope} doesn't exist`)
33 | }
34 |
35 | array.push(value)
36 | }
37 |
38 | return add_to_array(args.variableName, args.variableScope, args.value)
39 |
--------------------------------------------------------------------------------
/custom modules/flow-utils/src/actions/create_array.js:
--------------------------------------------------------------------------------
1 | /**
2 | * @hidden true
3 | */
4 |
5 | const _ = require('lodash')
6 |
7 | const create_array = async (variableArrayName, variableArrayScope, value) => {
8 | try {
9 | value = JSON.parse(value)
10 | } catch (e) {
11 | value = undefined
12 | bp.logger.attachError(e).error('[CreateArray] Error parsing array')
13 | }
14 |
15 | if (!event.state[variableArrayScope]) {
16 | throw new Error(`Invalid scope ${variableArrayScope}`)
17 | }
18 |
19 | _.set(event.state, `${variableArrayScope}.${variableArrayName}`, value || [])
20 | }
21 |
22 | return create_array(args.variableName, args.variableScope, args.value)
23 |
--------------------------------------------------------------------------------
/custom modules/flow-utils/src/actions/increment_variable.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Increments a variable by an amount
3 | * @title Increment Variable
4 | * @category Flow-Utils
5 | * @author David
6 | * @param {string} variableType - temp/session/user
7 | * @param {string} variableName - Variable Name
8 | * @param {number} amountToIncrement - Amount to Increment in the number variable
9 | */
10 |
11 | const _ = require('lodash')
12 |
13 | const myAction = async (variableType, variableName, amountToIncrement) => {
14 | _.set(
15 | event.state,
16 | `${variableType}.${variableName}`,
17 | (Number.parseFloat(_.get(event.state, `${variableType}.${variableName}`)) || 0) +
18 | Number.parseFloat(amountToIncrement)
19 | )
20 | }
21 | return myAction(args.variableType, args.variableName, args.amountToIncrement)
22 |
--------------------------------------------------------------------------------
/custom modules/flow-utils/src/actions/reply.js:
--------------------------------------------------------------------------------
1 | /**
2 | * @hidden true
3 | */
4 |
5 | const _ = require('lodash')
6 |
7 | const rawReply = async (contentType, payload) => {
8 | const context = {
9 | event,
10 | user: event.state.user,
11 | temp: event.state.temp,
12 | session: event.state.session
13 | }
14 | try {
15 | _.forEach(payload, (value, key) => {
16 | try {
17 | if (value.trim().match(/^\${.*}$/g)) {
18 | // bp.cms.renderTemplate will use mustache, which is not good to assign complex values
19 | payload[key] = _.get(context, value.replace(/\${|}/g, ''))
20 | } else if (value.match(/{{|}}/g)) {
21 | // only use it if the string has lots of variables to fiil
22 | payload[key] = bp.cms.renderTemplate(value, context)
23 | }
24 | payload[key] = JSON.parse(payload[key])
25 | } catch (e) {}
26 | })
27 | const payloads = await bp.cms.renderElement(contentType, payload, event)
28 | bp.events.replyToEvent(
29 | {
30 | botId: event.botId,
31 | channel: event.channel,
32 | target: event.target,
33 | threadId: event.threadId
34 | },
35 | payloads,
36 | event.id
37 | )
38 | } catch (e) {
39 | bp.logger.attachError(e).error('[Reply] Error')
40 | }
41 | }
42 |
43 | return rawReply(args.contentType, args.payload)
44 |
--------------------------------------------------------------------------------
/custom modules/flow-utils/src/backend/AddToArray.ts:
--------------------------------------------------------------------------------
1 | import * as sdk from 'botpress/sdk'
2 | import _ from 'lodash'
3 |
4 | const generateFlow = async (data: any, metadata: sdk.FlowGeneratorMetadata): Promise
9 | {
11 | const blob = new Blob([buff], { type: 'audio/wav' })
12 | const fd = new FormData()
13 | fd.append('file', blob, 'audio.wav')
14 | fd.append('webSessionId', props.store.api.baseUserPayload.webSessionId)
15 | fd.append('conversationId', props.store.currentConversationId)
16 |
17 | await props.store.bp.axios.post('/mod/riva/sendAudio', fd)
18 | }}
19 | >
20 |
21 | )
22 | }
23 |
24 | export default Composer
25 |
--------------------------------------------------------------------------------
/custom modules/riva/src/views/lite/Recorder/FileUploader.tsx:
--------------------------------------------------------------------------------
1 | import { FileInput } from '@blueprintjs/core'
2 | import React from 'react'
3 |
4 | const FileUploader = props => {
5 | const handleFileUpload = async event => {
6 | if (!event.target.files) {
7 | return
8 | }
9 |
10 | const fd = new FormData()
11 | fd.append('file', event.target.files[0], 'audio.wav')
12 | fd.append('webSessionId', props.store.api.baseUserPayload.webSessionId)
13 | fd.append('conversationId', props.store.currentConversationId)
14 |
15 | await props.store.bp.axios.post('/mod/riva/sendAudio', fd)
16 | }
17 |
18 | return Some interface
17 | }
18 | }
19 |
--------------------------------------------------------------------------------
/custom modules/starter-module/src/views/lite/index.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 |
3 | /**
4 | * The lite views are meant to be lightweight. They shouldn't include heavy dependencies.
5 | * Common use case is to add custom components on the web chat. It's also possible to share them to other modules
6 | *
7 | * Even if you don't plan to include a lite view, you must include an empty view that returns 'null'
8 | */
9 | export class LiteView extends React.Component {
10 | render() {
11 | return null
12 | }
13 | }
14 |
--------------------------------------------------------------------------------
/custom modules/starter-module/src/views/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../../tsconfig_view.shared.json",
3 | "compilerOptions": {
4 | "baseUrl": "./",
5 | "typeRoots": ["../../node_modules/@types", "lite/typings.d.ts"]
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/custom modules/starter-module/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../tsconfig.shared.json",
3 | "compilerOptions": {
4 | "baseUrl": "./"
5 | }
6 | }
7 |
--------------------------------------------------------------------------------
/custom modules/starter-module/yarn.lock:
--------------------------------------------------------------------------------
1 | # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
2 | # yarn lockfile v1
3 |
4 |
5 |
--------------------------------------------------------------------------------
/custom modules/upload-skill/.gitignore:
--------------------------------------------------------------------------------
1 | /bin
2 | /node_modules
3 | /node_production_modules
4 | /dist
5 | /assets/web/
6 | /assets/config.schema.json
7 | botpress.d.ts
8 | global.d.ts
9 |
--------------------------------------------------------------------------------
/custom modules/upload-skill/README.md:
--------------------------------------------------------------------------------
1 | # Upload Skill
2 |
3 | ## Overview
4 |
5 | This is aBotpress skill to upload media files to a database or AWS S3. Supported platforms are webchat and messenger.
6 |
7 | ## How to use
8 |
9 | 1. Copy the folder `upload-skill` to `modules/upload-skill`
10 | 2. Open a terminal in the folder `modules/upload-skill` and type `yarn && yarn build`
11 | 3. Edit your `botpress.config.json` and add the module location, like below:
12 |
13 | ```js
14 | "modules": [
15 | ...
16 | {
17 | "location": "MODULES_ROOT/upload-skill",
18 | "enabled": true
19 | }
20 | ]
21 | ```
22 |
23 | 4. Edit `data/bots/your_bot_name/bot.config.json` and add the desired content types in the `contentTypes` section.
24 |
25 | ```
26 | "contentTypes": [
27 | "upload_file",
28 | ...
29 | ]
30 | }
31 | ```
32 |
33 | 5. Start Botpress: `yarn start`
34 | 6. Choose any bots in your workspace, then you should see the module in the sidebar !
35 |
36 | ### Avaliable content types
37 |
38 | - `upload_file`
39 |
--------------------------------------------------------------------------------
/custom modules/upload-skill/assets/README.md:
--------------------------------------------------------------------------------
1 | ## Assets
2 |
3 | Every time the server is started, all the content of this folder will be copied in the `assets/modules/complete-module/` folder.
4 | They will overwrite existing files.
5 |
6 | Beware: This is a little different from actions and hooks, since they will be replaced even if you edit them.
7 |
8 | ## WARNING
9 |
10 | Every file in this folder will be publicly available for unauthenticated users.
11 | Only front-end bundles, images, css, etc. should be in this folder.
12 |
--------------------------------------------------------------------------------
/custom modules/upload-skill/assets/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
8 | 
9 |
10 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/custom modules/upload-skill/assets/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom modules/upload-skill/assets/logo.png
--------------------------------------------------------------------------------
/custom modules/upload-skill/build.extras.js:
--------------------------------------------------------------------------------
1 | /**
2 | * This file includes paths (or glob: https://www.npmjs.com/package/glob) that will be copied in the "dist" folder when the module is built.
3 | *
4 | * Why would you want to put files in the "dist" folder?
5 | * Only files in that folder can be read by Botpress, so if your templates aren't in the "dist" folder, they won't be available.
6 | */
7 | module.exports = {
8 | copyFiles: ['src/bot-templates/**']
9 | }
10 |
--------------------------------------------------------------------------------
/custom modules/upload-skill/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "upload-skill",
3 | "version": "1.0.0",
4 | "description": "Uploads files from end users",
5 | "private": true,
6 | "main": "dist/backend/index.js",
7 | "author": "Botpress, Inc.",
8 | "license": "AGPL-3.0-only",
9 | "webpack": {
10 | "externals": {
11 | "reactstrap": "Reactstrap",
12 | "botpress/tooltip": "BotpressTooltip"
13 | }
14 | },
15 | "scripts": {
16 | "build": "node ../../build/module-builder/bin/entry build",
17 | "watch": "node ../../build/module-builder/bin/entry watch",
18 | "package": "node ../../build/module-builder/bin/entry package"
19 | },
20 | "dependencies": {
21 | "aws-sdk": "^2.1122.0",
22 | "express-fileupload": "^1.4.0",
23 | "uuid": "^8.3.2"
24 | }
25 | }
26 |
--------------------------------------------------------------------------------
/custom modules/upload-skill/src/actions/README.md:
--------------------------------------------------------------------------------
1 | ## Actions
2 |
3 | Every time the server is started, Actions that you put in this folder will be copied in the `data/global/actions/complete-module/` folder.
4 | They will overwrite existing files only if they haven't been edited manually.
5 |
6 | Actions added this way will be available on the flow editor using `complete-module/your-action-name`
7 |
8 | Check the documentation for more information about [Actions](https://botpress.com/docs/build/code#actions)
9 |
--------------------------------------------------------------------------------
/custom modules/upload-skill/src/backend/UploadFile.ts:
--------------------------------------------------------------------------------
1 | import * as sdk from 'botpress/sdk'
2 |
3 | export const generateFlow = async (
4 | data: any,
5 | metadata: sdk.FlowGeneratorMetadata
6 | ): Promise
9 |
10 |
11 | Files in the assets folder are publicly available to anyone.
12 | You can link to other files using relative path: /assets/modules/complete-module
13 | When you change assets in your module folder, Botpress needs to be restarted to take new files
14 |
Some interface
17 | }
18 | }
19 |
--------------------------------------------------------------------------------
/custom modules/upload-skill/src/views/lite/index.jsx:
--------------------------------------------------------------------------------
1 | export { UploadFile } from './components/UploadFile'
2 |
--------------------------------------------------------------------------------
/custom modules/upload-skill/src/views/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../../tsconfig_view.shared.json",
3 | "compilerOptions": {
4 | "baseUrl": "./",
5 | "typeRoots": ["../../node_modules/@types", "lite/typings.d.ts"]
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/custom modules/upload-skill/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../tsconfig.shared.json",
3 | "compilerOptions": {
4 | "baseUrl": "./"
5 | }
6 | }
7 |
--------------------------------------------------------------------------------
/custom modules/upload-skill/upload-skill.tgz:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom modules/upload-skill/upload-skill.tgz
--------------------------------------------------------------------------------
/custom modules/validate-email/README.md:
--------------------------------------------------------------------------------
1 | # Validate Email Module
2 | Original Author: bassamtantawi-botpress
3 |
4 | ## Overview
5 | Allows access to a new skill to prompt for, receive and validate email address(es).
6 |
7 | ## How to use
8 |
9 | 1. Upload Module
10 | 2. Go to flow Editor
11 | 3. Select Skill12 |  13 | 4. Add in the pertinent information for the skill and click insert 14 |  15 | 5. Set transitions for success (valid email entered) and failure (invalid email entered) 16 | 17 | ### Quick start option 18 | 1. Copy the folder `validate-email` to `modules/validate-email` 19 | 2. Open a terminal in the folder `modules/validate-email` and type `yarn && yarn build` 20 | 3. Edit your `botpress.config.json` and add the module location, like below: 21 | 22 | ```js 23 | "modules": [ 24 | ... 25 | { 26 | "location": "MODULES_ROOT/validate-email", 27 | "enabled": true 28 | } 29 | ] 30 | ``` 31 | 4. Start Botpress: `yarn start` 32 | 5. Choose any bots in your workspace, then you should see the module in the sidebar 33 | -------------------------------------------------------------------------------- /custom modules/validate-email/assets/README.md: -------------------------------------------------------------------------------- 1 | ## Assets 2 | 3 | Every time the server is started, all the content of this folder will be copied in the `assets/modules/complete-module/` folder. 4 | They will overwrite existing files. 5 | 6 | Beware: This is a little different from actions and hooks, since they will be replaced even if you edit them. 7 | 8 | ## WARNING 9 | 10 | Every file in this folder will be publicly available for unauthenticated users. 11 | Only front-end bundles, images, css, etc. should be in this folder. 12 | -------------------------------------------------------------------------------- /custom modules/validate-email/assets/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 |
8 |
9 |
10 |
16 |
17 |
18 |
--------------------------------------------------------------------------------
/custom modules/validate-email/assets/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom modules/validate-email/assets/logo.png
--------------------------------------------------------------------------------
/custom modules/validate-email/build.extras.js:
--------------------------------------------------------------------------------
1 | /**
2 | * This file includes paths (or glob: https://www.npmjs.com/package/glob) that will be copied in the "dist" folder when the module is built.
3 | *
4 | * Why would you want to put files in the "dist" folder?
5 | * Only files in that folder can be read by Botpress, so if your templates aren't in the "dist" folder, they won't be available.
6 | */
7 | module.exports = {
8 | copyFiles: ['src/bot-templates/**']
9 | }
10 |
--------------------------------------------------------------------------------
/custom modules/validate-email/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "validate-email",
3 | "version": "1.0.0",
4 | "description": "Validate e-mails entered",
5 | "private": true,
6 | "main": "dist/backend/index.js",
7 | "author": "Botpress, Inc.",
8 | "license": "AGPL-3.0-only",
9 | "webpack": {
10 | "externals": {
11 | "reactstrap": "Reactstrap",
12 | "botpress/tooltip": "BotpressTooltip"
13 | }
14 | },
15 | "scripts": {
16 | "build": "node ../../build/module-builder/bin/entry build",
17 | "watch": "node ../../build/module-builder/bin/entry watch",
18 | "package": "node ../../build/module-builder/bin/entry package"
19 | },
20 | "dependencies": {
21 | }
22 | }
23 |
--------------------------------------------------------------------------------
/custom modules/validate-email/src/actions/README.md:
--------------------------------------------------------------------------------
1 | ## Actions
2 |
3 | Every time the server is started, Actions that you put in this folder will be copied in the `data/global/actions/validate-email/` folder.
4 | They will overwrite existing files only if they haven't been edited manually.
5 |
6 | Actions added this way will be available on the flow editor using `validate-email/your-action-name`
7 |
8 | Check the documentation for more information about [Actions](https://botpress.com/docs/build/code#actions)
9 |
--------------------------------------------------------------------------------
/custom modules/validate-email/src/actions/validate-email.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Small description of your action
3 | * @title The title displayed in the flow editor
4 | * @category Custom
5 | * @author Your_Name
6 | * @param {string} reference - An example string variable
7 | * @param {any} multiple - Another Example value
8 | */
9 | const myAction = async (reference, multiple) => {
10 |
11 | const result = event.nlu.entities.filter(entity => entity.name === 'email').map(function (entity) {
12 | return entity.data.value;
13 | });
14 |
15 | if (!result.length) {
16 | return
17 | }
18 | if (multiple) {
19 | temp[reference] = result
20 | } else {
21 | temp[reference] = result[0]
22 | }
23 |
24 |
25 |
26 | }
27 |
28 | return myAction(args.reference, args.multiple)
29 |
--------------------------------------------------------------------------------
/custom modules/validate-email/src/backend/utils.ts:
--------------------------------------------------------------------------------
1 | export const asBytes = (size: string) => {
2 | if (typeof size === 'number') {
3 | return size
4 | }
5 |
6 | size = typeof size === 'string' ? size : '0'
7 |
8 | const matches = size
9 | .replace(',', '.')
10 | .toLowerCase()
11 | .match(/(\d+\.?\d{0,})\s{0,}(mb|gb|pt|kb|b)?/i)
12 |
13 | if (!matches || !matches.length) {
14 | return 0
15 | }
16 |
17 | /**/ if (matches[2] === 'b') {
18 | return Number(matches[1]) * Math.pow(1024, 0)
19 | } else if (matches[2] === 'kb') {
20 | return Number(matches[1]) * Math.pow(1024, 1)
21 | } else if (matches[2] === 'mb') {
22 | return Number(matches[1]) * Math.pow(1024, 2)
23 | } else if (matches[2] === 'gb') {
24 | return Number(matches[1]) * Math.pow(1024, 3)
25 | } else if (matches[2] === 'tb') {
26 | return Number(matches[1]) * Math.pow(1024, 4)
27 | }
28 |
29 | return Number(matches[1])
30 | }
31 |
--------------------------------------------------------------------------------
/custom modules/validate-email/src/translations/en.json:
--------------------------------------------------------------------------------
1 | {
2 | "dashboard": "Dashboard",
3 | "export": "Export",
4 | "exportCsv": "Export as CSV",
5 | "exportJson": "Export as JSON",
6 | "filterChannels": "Filter channels",
7 | "fullName": "Validate email",
8 | "title": "Validate email",
9 | "placeholderText": "Dropdown placeholder text",
10 | "typingIndicator": "Show typing indicators",
11 | "useMarkdown": "Use markdown",
12 | "markdownHelp": "Refer to this documentation for markdown syntax: ",
13 | "disableFreeText": "Disable free text",
14 | "description":"A message showing some file with an optional title",
15 | "changeText":"Change the text",
16 | "pickContent":"Pick content",
17 | "reference":"Reference variable in the temp memory where the result will be stored",
18 | "referenceTitle":"Reference",
19 | "multipleTitle":"Multiple",
20 | "train":"Note: The Bot must be trained for this skill to work properly.",
21 | "contentTitle":"Select the content element to be used to request the user's e-mail address",
22 | "multiple":"Multiple emails, if set to true, an array of all detected emails will be assigned to the reference variable instead of a text string"
23 | }
24 |
--------------------------------------------------------------------------------
/custom modules/validate-email/src/translations/fr.json:
--------------------------------------------------------------------------------
1 | {
2 | "title": "Email validé",
3 | "dashboard": "Planche",
4 | "export": " Exporter",
5 | "exportCsv": "Exporter en CSV",
6 | "exportJson": "Exporter en JSON",
7 | "filterChannels": "Filtrer les canaux",
8 | "fullName": "Email validé",
9 | "placeholderText": "Texte d'espace réservé déroulant",
10 | "typingIndicator": "Afficher les indicateurs de frappe",
11 | "useMarkdown": "utiliser la démarque",
12 | "markdownHelp": "Consultez cette documentation pour la syntaxe Markdown :",
13 | "disableFreeText": "Désactiver le texte libre",
14 | "description":"Un message montrant un fichier avec un titre optionnel",
15 | "changeText":"Modifier le texte",
16 | "pickContent":"Choisir le contenu",
17 | "reference":"Variable de référence dans la mémoire temporaire où le résultat sera stocké",
18 | "referenceTitle":"Référence",
19 | "multipleTitle":"Multiple",
20 | "train":"Note : Le Bot doit être formé pour que cette compétence fonctionne correctement.",
21 | "contentTitle":"Sélectionnez l'élément de contenu à utiliser pour demander l'adresse e-mail de l'utilisateur",
22 | "multiple":"Emails multiples, si cette option est activée, un tableau de tous les emails détectés sera attribué à la variable de référence au lieu d'une chaîne de texte."
23 | }
24 |
--------------------------------------------------------------------------------
/custom modules/validate-email/src/views/full/index.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 |
3 | /**
4 | * This is an example on how you may export multiple components from your view
5 | * If your module offers custom Skills, you would export your skill components here
6 | */
7 |
8 | export { InputEmail } from './InputEmail'
9 |
10 | /**
11 | * This file is the full view of your module. It automatically includes heavy dependencies, like react-bootstrap
12 | * If you want to display an interface for your module, export your principal view as "default"
13 | */
14 | export default class MyMainView extends React.Component {
15 | render() {
16 | return
9 |
10 |
11 | Files in the assets folder are publicly available to anyone.
12 | You can link to other files using relative path: /assets/modules/complete-module
13 | When you change assets in your module folder, Botpress needs to be restarted to take new files
14 |
Some interface
17 | }
18 | }
19 |
--------------------------------------------------------------------------------
/custom modules/validate-email/src/views/lite/index.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 |
3 | const Index = () => {
4 | return
5 | }
6 |
7 | export default Index
8 |
--------------------------------------------------------------------------------
/custom modules/validate-email/src/views/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../../tsconfig_view.shared.json",
3 | "compilerOptions": {
4 | "baseUrl": "./",
5 | "typeRoots": ["../../node_modules/@types", "lite/typings.d.ts"]
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/custom modules/validate-email/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../tsconfig.shared.json",
3 | "compilerOptions": {
4 | "baseUrl": "./"
5 | }
6 | }
7 |
--------------------------------------------------------------------------------
/custom modules/validate-email/validate-email.tgz:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom modules/validate-email/validate-email.tgz
--------------------------------------------------------------------------------
/custom solutions/Add New Element to Channel/before.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom solutions/Add New Element to Channel/before.png
--------------------------------------------------------------------------------
/custom solutions/Add New Element to Channel/block-kit-builder.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom solutions/Add New Element to Channel/block-kit-builder.png
--------------------------------------------------------------------------------
/custom solutions/Add New Element to Channel/flow.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom solutions/Add New Element to Channel/flow.png
--------------------------------------------------------------------------------
/custom solutions/Add New Element to Channel/incoming.js:
--------------------------------------------------------------------------------
1 | if (event.state.user.sendToTemp) {
2 | event.state.temp = { ...event.state.temp, ...event.state.user.sendToTemp }
3 | delete event.state.user.sendToTemp
4 | }
--------------------------------------------------------------------------------
/custom solutions/Add New Element to Channel/on-unmount.js:
--------------------------------------------------------------------------------
1 | bp.http.deleteRouterForBot('slack') // keep this for testing so that you may easily remount bot and see changes
2 |
--------------------------------------------------------------------------------
/custom solutions/Build Custom Modules Using Module Builder/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom solutions/Build Custom Modules Using Module Builder/1.png
--------------------------------------------------------------------------------
/custom solutions/Build Custom Modules Using Module Builder/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom solutions/Build Custom Modules Using Module Builder/2.png
--------------------------------------------------------------------------------
/custom solutions/Build Custom Modules Using Module Builder/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom solutions/Build Custom Modules Using Module Builder/3.png
--------------------------------------------------------------------------------
/custom solutions/Build Custom Modules Using Module Builder/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom solutions/Build Custom Modules Using Module Builder/4.png
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom solutions/Build Custom Web Chat Components/1.png
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom solutions/Build Custom Web Chat Components/2.png
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom solutions/Build Custom Web Chat Components/3.png
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom solutions/Build Custom Web Chat Components/4.png
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/custom-web-component-module.zip:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/botpress/solutions/af5a8cd42211ba79b415cf9974c39c054e38b430/custom solutions/Build Custom Web Chat Components/custom-web-component-module.zip
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/custom-web-component-module/.gitignore:
--------------------------------------------------------------------------------
1 | dist
2 | node_modules
3 | *.tgz
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/custom-web-component-module/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "custom-web-component-module",
3 | "version": "1.0.0",
4 | "description": "Some description on what this module is about",
5 | "private": true,
6 | "main": "dist/backend/index.js",
7 | "author": "Botpress, Inc.",
8 | "license": "AGPL-3.0-only",
9 | "scripts": {
10 | "build": "node ../../build/module-builder/bin/entry build",
11 | "watch": "node ../../build/module-builder/bin/entry watch",
12 | "package": "node ../../build/module-builder/bin/entry package"
13 | },
14 | "dependencies": {}
15 | }
16 |
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/custom-web-component-module/src/backend/index.ts:
--------------------------------------------------------------------------------
1 | import * as sdk from 'botpress/sdk'
2 |
3 | const entryPoint: sdk.ModuleEntryPoint = {
4 | definition: {
5 | // This must match the name of your module's folder, and the name in package.json
6 | name: 'custom-web-component-module',
7 | /**
8 | * By default we are using the https://blueprintjs.com/docs/#icons. Use the corresponding name
9 | * Otherwise, create an icon in the assets module in the following format studio_${module.menuIcon}
10 | */
11 | menuIcon: 'flag',
12 | // This is the name of your module which will be displayed in the sidebar
13 | menuText: 'Custom Web Component',
14 | // When set to `true`, the name and icon of your module won't be displayed in the sidebar
15 | noInterface: false,
16 | // The full name is used in other places, for example when displaying bot templates
17 | fullName: 'Custom Web Component',
18 | // Not used anywhere, but should be a link to your website or module repository
19 | homepage: 'https://botpress.com'
20 | }
21 | }
22 |
23 | export default entryPoint
24 |
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/custom-web-component-module/src/config.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * Anything that you would like to make configurable to the bot owner would go in this file.
3 | * Botpress handles itself loading the configuration files.
4 | *
5 | * Bot configuration files will override Global configuration when available:
6 | * For example, `data/bots/MY_BOT/config/custom-web-component-module.json` will be used by MY_BOT, while `data/global/config/custom-web-component-module.json` will be used for all others
7 | */
8 | export interface Config {
9 | /**
10 | * @default https://botpress.com
11 | */
12 | someEndpoint: string
13 | /**
14 | * @default 10
15 | */
16 | maxMessages: number
17 | }
18 |
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/custom-web-component-module/src/views/full/index.jsx:
--------------------------------------------------------------------------------
1 | /**
2 | * This file is the full view of your module. It automatically includes heavy dependencies, like react-bootstrap
3 | * If you want to display an interface for your module, export your principal view as "default"
4 | */
5 | export default class MyMainView extends React.Component {
6 | render() {
7 | return Some interface
8 | }
9 | }
10 |
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/custom-web-component-module/src/views/lite/before_container.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 |
3 |
4 | export class MyBeforeContainer extends React.Component {
5 | interval
6 |
7 | componentDidMount() {
8 | // We need to wait for the current conversation to be loaded before cleaning it
9 | this.interval = setInterval(() => {
10 | if(this.props.store.currentConversation) {
11 | this.props.store.clearMessages()
12 | this.interval && clearInterval(this.interval)
13 | }
14 | }, 50)
15 | }
16 |
17 | componentWillUnmount() {
18 | this.interval && clearInterval(this.interval)
19 | }
20 |
21 | render() {
22 | return null
23 | }
24 | }
25 |
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/custom-web-component-module/src/views/lite/index.jsx:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 |
3 | export { MyBeforeContainer } from './before_container'
4 | /**
5 | * The lite views are meant to be lightweight. They shouldn't include heavy dependencies.
6 | * Common use case is to add custom components on the web chat. It's also possible to share them to other modules
7 | *
8 | * Even if you don't plan to include a lite view, you must include an empty view that returns 'null'
9 | */
10 | export class LiteView extends React.Component {
11 | render() {
12 | return null
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/custom-web-component-module/src/views/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../../../tsconfig_view.shared.json",
3 | "compilerOptions": {
4 | "baseUrl": "./",
5 | "typeRoots": ["../../node_modules/@types", "lite/typings.d.ts"]
6 | }
7 | }
8 |
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/custom-web-component-module/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../tsconfig.shared.json",
3 | "compilerOptions": {
4 | "baseUrl": "./"
5 | }
6 | }
7 |
--------------------------------------------------------------------------------
/custom solutions/Build Custom Web Chat Components/custom-web-component-module/yarn.lock:
--------------------------------------------------------------------------------
1 | # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
2 | # yarn lockfile v1
3 |
4 |
5 |
--------------------------------------------------------------------------------
/custom solutions/Create Dynamic Choices/Basic/basic-dynamic-choice.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Create and send a basic dynamic single-choice element
3 | * @title Basic Dynamic Choice
4 | * @category Custom
5 | * @author Botpress
6 | * @param {int} quantity - how many choices to render
7 | */
8 |
9 | const axios = require('axios')
10 |
11 | const dynamicSingleChoice = async quantity => {
12 | var numResponse = await axios.get(
13 | `https://www.random.org/integers/?num=${quantity}&min=1&max=100&col=1&base=10&format=plain&rnd=new`
14 | )
15 | var nums = numResponse.data.split('\n')
16 | let choices = []
17 | nums.forEach(num => {
18 | bp.logger.info(num)
19 | choices.push({ title: num, value: num })
20 | })
21 | choices = choices.filter(n => n)
22 | const payloads = await bp.cms.renderElement(
23 | 'builtin_single-choice',
24 | {
25 | text: 'Pick a number!',
26 | typing: true,
27 | choices: choices
28 | },
29 | event
30 | )
31 |
32 | bp.events.replyToEvent(
33 | {
34 | botId: event.botId,
35 | channel: event.channel,
36 | target: event.target,
37 | threadId: event.threadId
38 | },
39 | payloads,
40 | event.id
41 | )
42 | }
43 |
44 | return dynamicSingleChoice(args.quantity)
45 |
--------------------------------------------------------------------------------
/custom solutions/Create Dynamic Choices/readme.md:
--------------------------------------------------------------------------------
1 | # Create Dynamic Choices
2 |
3 | Original author: @laurentlp
4 |
5 | Last updated by @Gordon-BP on 8 June 2022
6 |
7 | ## Overview
8 | This solution contains basic and advanced example actions for dynamically creating and rendering a single choice element.
9 |
10 | 
11 |
12 |
13 | ## Use cases:
14 | There are many cases when users need to choose from a set of choices that is not hard-coded. This solution provides basic and advanced solutions.
15 |
16 | ### Basic Example
17 | This example gets a user-specified quantity of random numbers and renders them as buttons.
18 |
19 | ### Advanced Example
20 | This example also renders a user-specified quantity of random numbers, but has additional configurable options and can process and respond to failures and invalid choices.
21 |
22 | ## How to use
23 | Specific instructions are in the examples' respective folders.
24 |
--------------------------------------------------------------------------------
/custom solutions/Create Link to Download Conversation History/readme.md:
--------------------------------------------------------------------------------
1 | # Create Link to Download Conversation History
2 |
3 | This solution will create a API endpoint that users can access to download their conversation history
4 |
5 | # How to use it
6 |
7 | 1. Create the after_server_start hook available in this folder (createDownloadConversationRouter.js) as a global hook in your server, and restart your server
8 | 2. Use the action from the file SendTranscriptDownloadLink.js, also included in this folder, to send the transcript download link to your user.
9 |
--------------------------------------------------------------------------------
/custom solutions/Create URL from User Query/README.md:
--------------------------------------------------------------------------------
1 | This is an example on how to take information provided by the user to generate a link (or button on Messenger) to redirect a user on a website to finish the transaction.
2 |
--------------------------------------------------------------------------------
/custom solutions/Create URL from User Query/actions/utils.js:
--------------------------------------------------------------------------------
1 | const getUserIdFromTarget = async (eventTarget, bp) => {
2 | const getName = async query => {
3 | const result = await bp.database.raw(query)
4 | return result.rows ? result.rows[0].name : result[0].name
5 | }
6 |
7 | const userId = await getName(
8 | `SELECT name FROM msg_senders s, msg_usermap m WHERE s.id = m."senderId" AND m."userId" = '${eventTarget}'`
9 | )
10 |
11 | return userId
12 | }
13 |
14 | const getMessengerConfig = async (botId, bp) => {
15 | const config = await bp.bots.getBotById(botId)
16 | const channels = config.messaging.channels
17 |
18 | if (!channels || !channels.messenger) {
19 | return bp.logger.warn(`Messenger channel is not configured properly`)
20 | }
21 |
22 | const { accessToken } = channels.messenger
23 | return { accessToken }
24 | }
25 |
26 | module.exports = { getUserIdFromTarget, getMessengerConfig }
27 |
--------------------------------------------------------------------------------
/custom solutions/Create logout link/readme.md:
--------------------------------------------------------------------------------
1 | # Create logout link
2 |
3 | This solution will create a url that can be accessed in the user's browser to logout the current session
4 |
5 | # How to install
6 |
7 | 1. Create the after_server_start hook available in this folder (create_logout_router.js) as a global hook in your server, and restart your server
8 |
9 | # How to use it
10 |
11 | When logged in with a user in the admin panel, access the URL [HOST/api/v1/bots/___/mod/logout/logout](http://localhost:3000/api/v1/bots/___/mod/logout/logout) in the browser
12 |
13 | Additionally, you can specify an environment variable called EXPOSED_LOGOUT_RETURN_URL to specify what URL the browser should be redirect to after the logout.
14 |
--------------------------------------------------------------------------------
/custom solutions/Custom Analytics - User Path/Global Hooks/after_bot_unmount/custom-analytics.js:
--------------------------------------------------------------------------------
1 | function hook(bp: typeof sdk, botId: string) {
2 | /** Your code starts below */
3 |
4 | bp.http.deleteRouterForBot("custom-analytics");
5 |
6 | /** Your code ends here */
7 | }
8 |
--------------------------------------------------------------------------------
/custom solutions/Custom Analytics - User Path/Global Hooks/before_incoming_middleware/generate_session_id.js:
--------------------------------------------------------------------------------
1 | function hook(bp: typeof sdk, event: sdk.IO.IncomingEvent) {
2 | /** Your code starts below */
3 |
4 | const uuid = require("uuid");
5 |
6 | if (event.state && event.state.context && event.state.context.currentFlow == undefined) {
7 | const generated = uuid.v4();
8 | event.state.session.generatedSessionId = generated.substring(0, generated.indexOf("-"));
9 | event.setFlag(bp.IO.WellKnownFlags.FORCE_PERSIST_STATE, true);
10 | }
11 |
12 | /** Your code ends here */
13 | }
14 |
--------------------------------------------------------------------------------
/custom solutions/Custom Analytics - User Path/README.md:
--------------------------------------------------------------------------------
1 | ### What it does
2 |
3 | Sends user path telemetry to a new custom table
4 |
5 | ### How to do it
6 |
7 | 1 - Create global hooks (after_bot_mount, after_bot_unmount, before_incoming_middleware)
8 |
9 | 2 - Create bot hooks for bots that you want to track (after_incoming_middleware)
10 |
11 | 3 - Restart server and talk to the bot
12 |
13 | 4 - Check results by quering the database (table 'custom-analytics') or making Curl request bellow (Change [BOTPRESS_URL], [BOT_ID] and [TOKEN]):
14 |
15 | curl --location --request GET '[BOTPRESS_URL]/api/v1/bots/[BOT_ID]/mod/custom-analytics/aggregate' \
16 | --header 'authorization: Bearer [TOKEN]'
17 |
--------------------------------------------------------------------------------
/custom solutions/Custom amount time typing indicator/README.md:
--------------------------------------------------------------------------------
1 | ### What it does
2 |
3 | Send a typing indicator as long as some async function is processing
4 |
5 | ### How to do it
6 |
7 | Use the code from the 'custom_typing_time.js' file to create an action.
8 |
--------------------------------------------------------------------------------
/custom solutions/Custom amount time typing indicator/custom_typing_time.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Small description of your action
3 | * @title The title displayed in the flow editor
4 | * @category Custom
5 | * @author Your_Name
6 | */
7 | const myAction = async () => {
8 | const intervalMs = 500;
9 | const interval = setInterval(() => {
10 | bp.events.replyToEvent(event, [{ type: "typing", value: intervalMs }]);
11 | }, intervalMs);
12 |
13 | // Make your API call (may take between any amount of time to execute)
14 | // ...
15 |
16 | clearInterval(interval);
17 |
18 | // Do something with your response
19 | // ...
20 | };
21 |
22 | return myAction();
23 |
--------------------------------------------------------------------------------
/custom solutions/Custom oAuth with Converse Api/README.md:
--------------------------------------------------------------------------------
1 | ### About
2 |
3 | This is the hook for custom JWT auth with converse API.
4 |
5 | ### How it works
6 |
7 | Whenever you are hitting the Converse Api endpoint you should put your signed token to the metadata object.
8 | The hook checks if the token is correctly signed with secret and authorizes the request and allows talking to the bot.
9 | Otherwise it redirects to the unauthorized flow which you can configure.
10 |
11 | ### How to use
12 | 1. Add hook to the before_incoming_middleware
13 | 2. Create unauthorized flow and change the name of it at the line 59
14 | 3. Add your secret to the env. variable or to the file system, fetch it and set at the line 4.
15 | 4. Hit the endpoint `/api/v1/bots/
7 | 3. Make sure no Q&As are set to redirect
8 |
9 |
--------------------------------------------------------------------------------
/custom solutions/Redirect All Qnas/Redirect_All_Qnas.js:
--------------------------------------------------------------------------------
1 | // Define the flow and node to redirect to after the Q&A is answered
2 | const nextNode = {
3 | type: 'redirect',
4 | flow: 'main.flow.json',
5 | node: 'entry'
6 | }
7 |
8 | async function hook() {
9 | if (!suggestions.length || !suggestions[0].decision || event.type !== 'text') {
10 | return
11 | }
12 |
13 | const suggestion = suggestions[0]
14 | const decision = suggestion.decision
15 |
16 | if (decision.status === 'elected' && suggestion.source === 'qna') {
17 | bp.logger.info('adding redirect....')
18 | suggestion.payloads = [...suggestion.payloads, nextNode]
19 | }
20 | }
21 | return hook()
22 |
--------------------------------------------------------------------------------
/custom solutions/Redirect user during conversation if URL has a parameter/inject_variable_from_webchat.js:
--------------------------------------------------------------------------------
1 | // We just care if the event comes from web and has the type custom-inject-variable
2 | if (event.channel == 'web' && event.type == 'custom-inject-variable') {
3 | // We add this to prevent the bot from being triggered
4 | event.setFlag(bp.IO.WellKnownFlags.SKIP_DIALOG_ENGINE, true)
5 |
6 | // We add this in order save state variables when SKIP_DIALOG_ENGINE is set
7 | event.setFlag(bp.IO.WellKnownFlags.FORCE_PERSIST_STATE, true)
8 |
9 | // if we don't have a payload in the event, prevent further
10 | // execution
11 | if (!event.payload.payload || !event.payload.payload.payload) {
12 | return
13 | }
14 |
15 | // We save a temporary variable for each property from the payload object
16 | for (const key of Object.keys(event.payload.payload.payload)) {
17 | event.state.temp[key] = event.payload.payload.payload[key]
18 | }
19 | }
--------------------------------------------------------------------------------
/custom solutions/Redirect user during conversation if URL has a parameter/inject_variable_template_v1.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 | There should be a black button on the right bottom corner
8 |
9 |
10 |
11 |
12 |
28 |
29 |
30 |
--------------------------------------------------------------------------------
/custom solutions/Redirection on session reset/README.md:
--------------------------------------------------------------------------------
1 | ### What it does
2 |
3 | Redirect to the beginning of a flow and process the first node when a user resets his session
4 |
5 | ### How to do it
6 |
7 | Use the code from the 'redirect_reset_session.js' file to create a before_incoming_middleware hook
8 |
--------------------------------------------------------------------------------
/custom solutions/Redirection on session reset/redirect_reset_session.js:
--------------------------------------------------------------------------------
1 | async function redirect() {
2 | if (event.type === 'session_reset') {
3 | const sessionId = bp.dialog.createId(event)
4 | await bp.dialog.jumpTo(sessionId, event, 'main.flow.json', 'entry')
5 |
6 | const newEvent = bp.IO.Event({
7 | type: 'any',
8 | payload: {},
9 | direction: event.direction,
10 | channel: event.channel,
11 | target: event.target,
12 | botId: event.botId,
13 | threadId: event.threadId
14 | })
15 |
16 | newEvent.debugger = true
17 | await bp.events.sendEvent(newEvent)
18 | }
19 | }
20 |
21 | return redirect()
--------------------------------------------------------------------------------
/custom solutions/Run Script 30 Minutes Before End of Day/readme.md:
--------------------------------------------------------------------------------
1 | # Routine using hooks
2 |
3 | This After Server Start hook creates a routine that will run every day, 30 minutes before the end of the day, just once. It will consider other Botpress nodes to avoid duplication (using a lock).
4 |
5 | **To use:**
6 |
7 | 1. Create an after_server_start hook using the script attached (routine.js)
8 | 2. Modify the runTask function with your code to create the desired task
9 | 3. Restart server
10 |
--------------------------------------------------------------------------------
/custom solutions/Send Specific QnA to a User/README.md:
--------------------------------------------------------------------------------
1 | This action forces a specific QnA to be sent a user, while ignoring any automatically detected QnAs.
2 |
3 | ## How to Use
4 |
5 | 1. Create your QnAs as normal
6 | 2. Make a choice skill where the values are the IDs for the QnAs you want to trigger
7 |
8 | 
9 |
10 | 3. You can easily find the QnA ID by exporting the QnAs as JSON. Just remember to add `__qna__` to the start of the ID
11 |
12 | 
13 |
14 | 4. Fill in the parameters:
15 |
16 | **qnaId**: If you're using this after a choice skill, set it to `{{event.payload.payload}}`. Otherwise set it to the Qna ID from step 3
17 |
18 | **collectFeedback**: true to show the thumbs up/down icons, false to hide them
19 |
20 | **followRedirect**: true to follow the qna redirect (if applicable), false to use the node's transition as a follow-up.
21 |
22 | 
23 |
--------------------------------------------------------------------------------
/custom solutions/Send adaptive cards using teams/README.md:
--------------------------------------------------------------------------------
1 | This is an action that can be used to send adaptive cards with teams
2 |
3 | As long as the Teams channel is configured properly, this action "should" work.
4 | It's possible that some URLs might need to be changed depending on the region or information on Azure.
5 |
6 | The adaptive cards example was taken from: https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference#adaptive-card
7 |
8 | 
9 |
10 | 
11 |
--------------------------------------------------------------------------------
/custom solutions/Set Nested Value/Readme.md:
--------------------------------------------------------------------------------
1 | # Set Nested Value
2 |
3 | Original author: @ptrckbp
4 |
5 | Last updated by @ptrckbp on 4 June 2022
6 |
7 | ## Overview
8 | This custom action extends the builtin `set-variable` action to enable developers to add and modify nth-level fields within an object.
9 |
10 | ## Use cases:
11 | Imagine you have an object like:
12 | ```
13 | temp:{
14 | data:{
15 | resources:{
16 | field1: "Foo"
17 | }
18 | }
19 | }
20 | ```
21 |
22 | and you want to change it to:
23 | ```
24 | temp:{
25 | data:{
26 | resources:{
27 | field1: "Bar"
28 | }
29 | }
30 | }
31 | ```
32 |
33 | Just run this action with the following parameters:
34 |
35 | 
36 |
37 | ## How to use
38 | 1. Create a node and add this action to it.
39 | 2. Fill out parameters as desired:
40 |
41 | **Scope:** Either `user`, `session`, or `temp`
42 |
43 | **Key:** The path to the field, separated by periods (".")
44 |
45 | **Value:** The end value to set the field to
46 |
47 | ### Note:
48 | This action will create any fields or object levels that don't exist. If no value is specified, the field will be undefined.
49 |
--------------------------------------------------------------------------------
/custom solutions/Set Nested Value/set-nested-value.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Sets the value of an Nth level field on an object.
3 | * @title Set nested value
4 | * @category Custom
5 | * @author Botpress
6 | * @param {string} scope - either temp, session, or user
7 | * @param {string} key - The field's directory, separated with dots like "data.response.field1"
8 | * @param {any} value - What to set the final value to
9 | */
10 | const setNestedValue = (scope, key, value) => {
11 | const inputKeys = key.split('.')
12 | let movingKey = event.state[scope]
13 | for (let i = 0; i < inputKeys.length; i++) {
14 | const currentKey = inputKeys[i]
15 |
16 | if (i === inputKeys.length - 1) {
17 | console.log(value)
18 | movingKey[currentKey] = value
19 | return
20 | }
21 | console.log(currentKey)
22 | if (!movingKey[currentKey]) {
23 | movingKey[currentKey] = {}
24 | }
25 |
26 | movingKey = movingKey[currentKey]
27 | }
28 | }
29 | return setNestedValue(args.scope, args.key, args.value)
30 |
--------------------------------------------------------------------------------
/custom solutions/Standardize Words Hook/README.md:
--------------------------------------------------------------------------------
1 | ### What it does
2 |
3 | It is a "before-incoming-middleware" hook that will changes words to standardize it
4 |
5 | Example: change "covid-19" or "covid 19" to "covid"
6 |
7 | ### How to do it
8 |
9 | 1 - Create a "before-incoming-middleware" hook using the script "standardise_word.js"
10 |
11 | 2 - Change words in the "maps" object as needed
12 |
--------------------------------------------------------------------------------
/custom solutions/Standardize Words Hook/standardise_word.js:
--------------------------------------------------------------------------------
1 | function hook(bp: typeof sdk, event: sdk.IO.IncomingEvent) {
2 | /** Your code starts below */
3 | if (event.type !== "text") {
4 | return;
5 | }
6 | const _ = require("lodash");
7 | const maps = {
8 | covid: [
9 | /\bcoronavirus\b/gi,
10 | /\bcorona\b/gi,
11 | /\bcoronnavirus\b/gi,
12 | /\bcarona\b/gi,
13 | /\bcovid-19\b/gi,
14 | /\bcovid19\b/gi,
15 | /\bcovid 19\b/gi,
16 | /\sars-cov-2\b/gi,
17 | /\pandemic\b/gi,
18 | ],
19 | };
20 | let phrase = event.preview;
21 | _.entries(maps).forEach(([key, syn]) => {
22 | syn.forEach((e) => {
23 | phrase = phrase.toLowerCase().replace(e, key);
24 | });
25 | });
26 | event.preview = phrase;
27 | event.payload.text = phrase;
28 | /** Your code ends here */
29 | }
30 |
--------------------------------------------------------------------------------
/custom solutions/Success Telemetry/Subviews/README.md:
--------------------------------------------------------------------------------
1 | - Each folder is from a metric, each subfolder has an hook which will create a desired subview in a metric type
2 | - The hook can be created as an 'after_server_start' hook (recommended)
3 | - After creating/modifying the hook, restart the server.
4 |
--------------------------------------------------------------------------------
/custom solutions/Success Telemetry/Subviews/solutions/download_csv_button/Readme.md:
--------------------------------------------------------------------------------
1 | This will create a button to download a CSV file with the results
2 |
3 | # Example
4 | 
5 | 
6 | 
7 |
8 |
9 | OBS: make sure to use the same file name for the hook, since hooks execute in alphabetical order and we need the zz_ to make sure that all metrics are registered before.
10 |
11 |
--------------------------------------------------------------------------------
/custom solutions/Success Telemetry/Subviews/workflow/Separated Workflow/Readme.md:
--------------------------------------------------------------------------------
1 | # Example
2 | 
3 |
--------------------------------------------------------------------------------
/custom solutions/Third party translations/bot.config.json:
--------------------------------------------------------------------------------
1 | {
2 | "translation": {
3 | "google": {
4 | "endpoint": "https://translation.googleapis.com/language/translate/v2",
5 | "token": "YOUR_API_TOKEN"
6 | },
7 | "deepl": {
8 | "endpoint": "https://api-free.deepl.com/v2/translate",
9 | "token": "YOUR_API_TOKEN"
10 | },
11 | "huggingface_fr_en": {
12 | "endpoint": "https://api-inference.huggingface.co/models/Helsinki-NLP/opus-mt-fr-en",
13 | "token": "YOUR_API_TOKEN"
14 | },
15 | "huggingface_en_fr":
16 | {
17 | "endpoint": "https://api-inference.huggingface.co/models/Helsinki-NLP/opus-mt-en-fr",
18 | "token": "YOUR_API_TOKEN"
19 | }
20 | },
21 | }
22 |
--------------------------------------------------------------------------------
/custom solutions/UserDropout/DataInsert.js:
--------------------------------------------------------------------------------
1 | function action(bp: typeof sdk, event: sdk.IO.IncomingEvent, args: any, { user, temp, session } = event.state) {
2 | /** Your code starts below */
3 |
4 | /**
5 | * Small description of your action
6 | * @title The title displayed in the flow editor
7 | * @category Custom
8 | * @author Mohsen
9 | * @param {string} first - User first name
10 | * @param {string} last - User last name
11 | * @param {string} Node - Current node in the flow
12 | */
13 |
14 | async function myAction(first, last, Node) {
15 | await bp.database.insertAndRetrieve('Example_DB', {
16 | UserName: first,
17 | LastName: last,
18 | CurrentNode: Node
19 |
20 | //example of what could be inserted in the data table, entries will depend on what is being tracked.
21 | })
22 | }
23 | return myAction(args.first, args.last, args.Node)
24 |
25 | /** Your code ends here */
26 | }
27 |
--------------------------------------------------------------------------------
/custom solutions/UserDropout/Hooks/TableCreation.js:
--------------------------------------------------------------------------------
1 | function hook(bp: typeof sdk) {
2 | /** Your code starts below */
3 |
4 |
5 | function CreateTable(){
6 | const tableName = 'Example_DB'
7 | bp.database.CreateTableIfNotExists(tableName, function(table){
8 | table.increment('id').primary
9 | table.string('FirstName')
10 | table.string('LastName')
11 | table.string('TargetUsers')
12 | })
13 | }
14 | CreateTable()
15 |
16 | /** Your code ends here */
17 | }
18 |
--------------------------------------------------------------------------------
/custom solutions/UserDropout/Hooks/TargetUserEntry.js:
--------------------------------------------------------------------------------
1 | function hook(bp: typeof sdk, event: sdk.IO.IncomingEvent) {
2 | /** Your code starts below */
3 |
4 | //BEFORE INCOMING MIDDLEWARE
5 |
6 | const DATABASE_TABLE = 'Example_DB'
7 |
8 | if(event.type === 'visit'){
9 | bp.logger.info('User Visit' , event)
10 | bp.database.insertAndRetrieve(DATABASE_TABLE, {
11 | TargetUsers: event.target
12 | })
13 | bp.logger.info('Target User has been inserte')
14 | } else {
15 | bp.database(DATABASE_TABLE).delete({
16 | TargetUsers: event.target
17 | //Deleting the Users that actually carried on with the conversation
18 | })
19 | bp.logger.info('User that is not registered as an event.target === visited has been deleted')
20 | }
21 |
22 | /** Your code ends here */
23 | }
24 |
--------------------------------------------------------------------------------
/custom solutions/UserDropout/NodeUpdate.js:
--------------------------------------------------------------------------------
1 | function action(bp: typeof sdk, event: sdk.IO.IncomingEvent, args: any, { user, temp, session } = event.state) {
2 | /** Your code starts below */
3 |
4 | const tableName = 'Example_DB'
5 | this.knex = bp.database
6 |
7 | /**
8 | * Small description of your action
9 | * @title The title displayed in the flow editor
10 | * @category Custom
11 | * @author Your_Name
12 | * @param {string} UserName - Nmae of the User
13 | * @param {any} columnSelector - Column you wish to change
14 | * @param {any} currentNode - The new Value to be stored in that column
15 | */
16 |
17 | const myAction = async (UserName, columnSelector,currentNode) => {
18 | await this.knex(tableName)
19 | .where('Name' , ' = ' , UserName)
20 | //the where condition that allows you to access the desried data entry.
21 | .update(columnSelector,currentNode)
22 | //The update will take in the column chosen, in this case the column that stores the node.
23 | //Second parameter will be the value you want to change it to, this should be the current node.
24 | }
25 |
26 | return myAction(args.UserName, args.columnSelector , args.currentNode)
27 |
28 | /** Your code ends here */
29 | }
30 |
31 |
--------------------------------------------------------------------------------
/custom solutions/Working with Dates/README.md:
--------------------------------------------------------------------------------
1 | Two methods for date manipulation.
2 |
3 | 1. Date Parser
4 | This action takes a parameter (either the user's text, another variable or a date), then it formats it in the requested format, and stores the result in the configured variable.
5 |
6 | If format is left empty, it will return a JS date object
7 | When format is equal to "moment", it will return a moment object
8 | Any other value for format will return the date formatted to the specified format (ex: YYYY-MM-DD for 2022-03-28)
9 |
10 | 2. Date Compare
11 |
12 | This action takes a parameter (either a string, a date object or a moment object) then returns whether the first date `isBefore`, `isAfter` or `isEqual` the second one.
13 |
--------------------------------------------------------------------------------
/custom solutions/Working with Dates/actions/date-compare.js:
--------------------------------------------------------------------------------
1 | const moment = require('moment')
2 |
3 | /**
4 | * Compare two dates.
5 | * The result is stored in temp.dateComparison and can have 3 different values: isBefore, isAfter, isEqual
6 | * @title Date comparison
7 | * @category Date
8 | * @author Botpress
9 | * @param {string|Date|moment} date1 The first date to compare
10 | * @param {string|Date|moment} date2 The date to compare it to
11 | * @param {string} [output=dateComparison] Name of the temporary variable where the result will be saved
12 | */
13 | const compareDates = async (rawDate1, rawDate2, output) => {
14 | if (!rawDate1 || !rawDate2) {
15 | return bp.logger.warn(`Both dates must be configured`)
16 | }
17 |
18 | const date1 = moment(rawDate1)
19 | const date2 = moment(rawDate2)
20 |
21 | if (date1.isBefore(date2)) {
22 | temp[output] = 'isBefore'
23 | } else if (date1.isAfter(date2)) {
24 | temp[output] = 'isAfter'
25 | } else {
26 | temp[output] = 'isEqual'
27 | }
28 | }
29 |
30 | return compareDates(args.date1, args.date2, args.output)
31 |
--------------------------------------------------------------------------------
/custom solutions/Working with Dates/actions/date-parser.js:
--------------------------------------------------------------------------------
1 | const moment = require('moment')
2 |
3 | /**
4 | * Generic date parser. Leave the date empty to use today's date.
5 | * If the format is empty, it will return a normal Date object.
6 | * Set the format to 'moment' to return the moment object
7 | * Value is stored in {{temp.parsedDate}} by default
8 | * @title Date parser
9 | * @category Date
10 | * @author Botpress
11 | * @param {string|Date|moment} date The date to process (can be a string or a js Date object)
12 | * @param {string} [format=YYYY-MM-DD] Format of the date to output.
13 | * @param {string} [output=parsedDate] Name of the temporary variable where the result will be saved
14 | *
15 | */
16 | const parseDate = async (rawDate, format, output) => {
17 | const date = moment(!rawDate ? undefined : rawDate)
18 |
19 | if (!format) {
20 | temp[output] = date.toDate()
21 | } else if (format === 'moment') {
22 | temp[output]
23 | } else {
24 | temp[output] = date.format(format)
25 | }
26 | }
27 |
28 | return parseDate(args.date, args.format, args.output)
29 |
--------------------------------------------------------------------------------
/custom solutions/[HITL-Next] Jump to flow after resolving /README.md:
--------------------------------------------------------------------------------
1 | # [HITL-Next] Jump to flow after resolving
2 |
3 | Original author: @davidvitora
4 |
5 | Last updated by @davidvitora on Jul 11 2022
6 |
7 | ## Overview
8 |
9 | Use this solution if you want your agent using HITL-Next to specify a flow to send the user after the agent resolves the conversation
10 |
11 | ## How to Install
12 |
13 | Simply add the two hooks available in this folder
14 |
15 | ## How to use it
16 |
17 | To specify the flow, during a conversation the agent must type the following command in the chatbox
18 |
19 | [cmd]sendTo:FLOW_NAME:NODE_NAME
20 |
21 | example: [cmd]sendTo:flow2:entry
22 |
23 | If you want to jump to the start node, you can simply use [cmd]sendTo:FLOW_NAME
24 |
25 | example: [cmd]sendTo:flow2
26 |
27 |
--------------------------------------------------------------------------------
/custom solutions/[HITL-Next] Jump to flow after resolving /hooks/before_incoming_middleware/sendTo-in.js:
--------------------------------------------------------------------------------
1 | // Jump to specified flow/node if any
2 | async function send() {
3 | const { sendTo } = event.state.session
4 | if (sendTo) {
5 | const { flowName, nodeName } = sendTo
6 | event.state.session.sendTo = undefined
7 | await bp.dialog.jumpTo(event.threadId, event, flowName, nodeName)
8 | event.setFlag(bp.IO.WellKnownFlags.FORCE_PERSIST_STATE, true)
9 | }
10 | }
11 |
12 | // resolved event from HITL-Next
13 | if (event.type == 'hitlnext' && event.payload.exitType == 'handoffResolved') {
14 | return send()
15 | }
16 |
17 | // Internal event to register the sendTo action
18 | else if (event.type == 'sendTo') {
19 | const { flowName, nodeName } = event.payload
20 | if (flowName) {
21 | event.state.session.sendTo = { flowName, nodeName }
22 | }
23 | event.setFlag(bp.IO.WellKnownFlags.FORCE_PERSIST_STATE, true)
24 | event.setFlag(bp.IO.WellKnownFlags.SKIP_DIALOG_ENGINE, true)
25 | event.setFlag(bp.IO.WellKnownFlags.SKIP_NATIVE_NLU, true)
26 | event.setFlag(bp.IO.WellKnownFlags.SKIP_QNA_PROCESSING, true)
27 | }
28 |
--------------------------------------------------------------------------------
/custom solutions/[HITL-Next] Jump to flow after resolving /hooks/before_outgoing_middleware/sendTo-out.js:
--------------------------------------------------------------------------------
1 | const text = event.payload && event.payload.text
2 | const cmd = text && text.startsWith('[cmd]') && text.substring(5)
3 |
4 | if (cmd) {
5 | const args = cmd.split(':')
6 | const [cmdName, flowName, nodeName] = args
7 |
8 | if (cmdName == 'sendTo') {
9 | if (flowName) {
10 | const { messageId, botId, channel, target, threadId } = event
11 | const internalEvent = bp.IO.Event({
12 | messageId,
13 | botId,
14 | channel,
15 | direction: 'incoming',
16 | payload: { flowName, nodeName },
17 | target,
18 | threadId,
19 | type: 'sendTo'
20 | })
21 | // Send internal incoming event to register desire to jump
22 | bp.events.sendEvent(internalEvent)
23 | }
24 | }
25 | // prevent command outgoing event from being sent to the user
26 | event.channel = 'invalid'
27 | event.setFlag(bp.IO.WellKnownFlags.FORCE_PERSIST_STATE, true)
28 | event.setFlag(bp.IO.WellKnownFlags.SKIP_DIALOG_ENGINE, true)
29 | event.setFlag(bp.IO.WellKnownFlags.SKIP_NATIVE_NLU, true)
30 | event.setFlag(bp.IO.WellKnownFlags.SKIP_QNA_PROCESSING, true)
31 | }
32 |
--------------------------------------------------------------------------------
/custom_tools/NLU_Testing/.env:
--------------------------------------------------------------------------------
1 |
2 | # Endpoint is where your bot is exposed
3 | ENDPOINT=http://localhost:3000
4 |
5 | # These are the credentials used for making API calls
6 | EMAIL=
7 | PASSWORD=
8 |
9 | # This is the ID of the bot you're testing
10 | BOT_ID=
11 |
12 | #Whether or not to record extracted entities in the test set
13 | #Should be either TRUE or FALSE
14 | EXTRACT_ENTITIES=TRUE
15 |
16 | #Whether or not to extract confidence
17 | #Should be either TRUE or FALSE
18 | EXTRACT_CONFIDENCE=TRUE
19 |
20 | # This is your test dataset. Must be a CSV file with two columns like:
21 | # Utterance | Expected
22 | TEST_PATH=
23 |
24 | # This is the name all the results data will be grouped under
25 | COL_NAME=Actual
26 |
27 | # This is your results file. Make it separate if you want, or same as testPath to keep it all in the same file
28 | RESULTS_PATH=
29 |
30 | # This is the folder where all the Q&A .json files are
31 | QNA_FOLDER_PATH=