@builderbot/cli 1.3.15-alpha.9 → 1.4.0

package/dist/configuration/index.d.ts

@@ -12,7 +12,18 @@ export interface ValueLabel {
     value: string;
     label: string;
 }
+export interface TemplateCombination {
+    provider: string;
+    language: string;
+    database: string;
+}
+export interface TemplateValidationResult {
+    pass: boolean;
+    message: string;
+}
 export declare const PROVIDER_LIST: Provider[];
 export declare const PROVIDER_DATA: ValueLabel[];
+export type ProviderData = ValueLabel;
 export declare const AVAILABLE_LANGUAGES: ValueLabel[];
+export declare const validateTemplateCombination: ({ provider, language, database, }: TemplateCombination) => TemplateValidationResult;
 //# sourceMappingURL=index.d.ts.map

package/dist/configuration/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/configuration/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,mBAAmB;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,QAAQ,GAAG,gBAAgB,GAAG,mBAAmB,CAAA;AAE7D,MAAM,WAAW,UAAU;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CAChB;AAED,eAAO,MAAM,aAAa,EAAE,QAAQ,EAYnC,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,UAAU,EAMrC,CAAA;AAED,eAAO,MAAM,mBAAmB,EAAE,UAAU,EAG3C,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/configuration/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,mBAAmB;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,MAAM,QAAQ,GAAG,gBAAgB,GAAG,mBAAmB,CAAA;AAE7D,MAAM,WAAW,UAAU;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,mBAAmB;IAChC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,wBAAwB;IACrC,IAAI,EAAE,OAAO,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CAClB;AAED,eAAO,MAAM,aAAa,EAAE,QAAQ,EAcnC,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,UAAU,EAMrC,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,UAAU,CAAA;AAErC,eAAO,MAAM,mBAAmB,EAAE,UAAU,EAG3C,CAAA;AAMD,eAAO,MAAM,2BAA2B,GAAI,mCAIzC,mBAAmB,KAAG,wBAqBxB,CAAA"}

package/dist/index.cjs

@@ -287,6 +287,8 @@ const PROVIDER_LIST = [
     { value: 'meta', label: 'Meta' },
     { value: 'facebook-messenger', label: 'Facebook Messenger' },
     { value: 'instagram', label: 'Instagram' },
+    { value: 'gupshup', label: 'Gupshup' },
+    { value: 'gohighlevel', label: 'GoHighLevel' },
     { value: 'email', label: 'Email', hint: 'IMAP/SMTP' },
 ];
 const PROVIDER_DATA = [
@@ -300,6 +302,23 @@ const AVAILABLE_LANGUAGES = [
     { value: 'ts', label: 'TypeScript' },
     { value: 'js', label: 'JavaScript' },
 ];
+const GUPSHUP_SUPPORTED_TEMPLATE_COMBINATIONS = [
+    { provider: 'gupshup', language: 'ts', database: 'memory' },
+];
+const validateTemplateCombination = ({ provider, language, database, }) => {
+    if (provider !== 'gupshup') {
+        return { pass: true, message: '' };
+    }
+    const pass = GUPSHUP_SUPPORTED_TEMPLATE_COMBINATIONS.some((combo) => combo.provider === provider && combo.language === language && combo.database === database);
+    if (pass) {
+        return { pass, message: '' };
+    }
+    const supportedCombinations = GUPSHUP_SUPPORTED_TEMPLATE_COMBINATIONS.map((combo) => `--provider=${combo.provider} --language=${combo.language} --database=${combo.database}`).join('\n');
+    return {
+        pass,
+        message: `Unsupported template combination for provider ${provider}.\nSupported combinations:\n${supportedCombinations}`,
+    };
+};
 
 var fs = {};
 
@@ -9518,6 +9537,14 @@ const createApp = async (templateName) => {
     await promises.rename(require$$1.join(pathTemplate, '_gitignore'), require$$1.join(pathTemplate, '.gitignore'));
     return pathTemplate;
 };
+const validateTemplateSupportOrExit = (provider, language, database) => {
+    const validation = validateTemplateCombination({ provider, language, database });
+    if (validation.pass) {
+        return;
+    }
+    xe(validation.message);
+    process.exit(0);
+};
 const startInteractive = async (version) => {
     try {
         const stepContinue = await ye({
@@ -9555,6 +9582,7 @@ const startInteractive = async (version) => {
             xe('Operation canceled');
             return process.exit(0);
         }
+        validateTemplateSupportOrExit(stepProvider, stepLanguage, stepDatabase);
         await createBot({
             stepLanguage: stepLanguage,
             stepProvider: stepProvider,
@@ -9630,6 +9658,7 @@ function validateArgs(args) {
         xe(`Invalid language: ${args['language']}`);
         process.exit(0);
     }
+    validateTemplateSupportOrExit(args['provider'], args['language'], args['database']);
 }
 const logError = async (e) => {
     console.log(e);

package/dist/interactive/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interactive/index.ts"],"names":[],"mappings":"AAgQA,QAAA,MAAM,KAAK,QAAa,OAAO,CAAC,IAAI,CAanC,CAAA;AAED,OAAO,EAAE,KAAK,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interactive/index.ts"],"names":[],"mappings":"AA8QA,QAAA,MAAM,KAAK,QAAa,OAAO,CAAC,IAAI,CAanC,CAAA;AAED,OAAO,EAAE,KAAK,EAAE,CAAA"}

package/dist/starters/apps/base-js-gohighlevel-json/.dockerignore

@@ -0,0 +1,16 @@
+dist/*
+node_modules
+.env
+
+*_sessions
+*tokens
+.wwebjs*
+
+.git
+.gitignore
+Dockerfile*
+npm-debug.log*
+pnpm-debug.log*
+tests
+docs
+*.md

package/dist/starters/apps/base-js-gohighlevel-json/Dockerfile

@@ -0,0 +1,40 @@
+# 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/assets ./assets
+COPY --from=builder /app/dist ./dist
+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-gohighlevel-json/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-gohighlevel-json/_gitignore

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

package/dist/starters/apps/base-js-gohighlevel-json/eslint.config.js

@@ -0,0 +1,23 @@
+import builderbot from 'eslint-plugin-builderbot'
+
+export default [
+    {
+        ignores: ['dist/**', 'node_modules/**', 'rollup.config.js'],
+    },
+    {
+        plugins: {
+            builderbot,
+        },
+        languageOptions: {
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+        },
+        rules: {
+            ...builderbot.configs.recommended.rules,
+            '@typescript-eslint/no-explicit-any': 'off',
+            '@typescript-eslint/no-unused-vars': 'off',
+            '@typescript-eslint/ban-ts-comment': 'off',
+            'no-unsafe-optional-chaining': 'off',
+        },
+    },
+]

package/dist/starters/apps/base-js-gohighlevel-json/nodemon.json

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

package/dist/starters/apps/base-js-gohighlevel-json/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-gohighlevel": "latest",
+    "@builderbot/database-json": "latest"
+  },
+  "devDependencies": {
+    "eslint-plugin-builderbot": "latest",
+    "eslint": "^9.39.1",
+    "nodemon": "^3.1.11"
+  },
+  "author": "",
+  "license": "ISC"
+}

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

@@ -0,0 +1,130 @@
+import { join } from 'path'
+import { createBot, createProvider, createFlow, addKeyword, utils } from '@builderbot/bot'
+import { JsonFileDB as Database } from '@builderbot/database-json'
+import { GoHighLevelProvider as Provider } from '@builderbot/provider-gohighlevel'
+
+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, {
+        clientId: process.env.GHL_CLIENT_ID ?? 'YOUR_CLIENT_ID',
+        clientSecret: process.env.GHL_CLIENT_SECRET ?? 'YOUR_CLIENT_SECRET',
+        locationId: process.env.GHL_LOCATION_ID ?? 'YOUR_LOCATION_ID',
+        channelType: 'WhatsApp',
+        apiVersion: '2021-07-28'
+    })
+    
+    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 }))
+        })
+    )
+
+    adapterProvider.server.get(
+        '/v1/blacklist/list',
+        handleCtx(async (bot, req, res) => {
+            const blacklist = bot.blacklist.getList()
+            res.writeHead(200, { 'Content-Type': 'application/json' })
+            return res.end(JSON.stringify({ status: 'ok', blacklist }))
+        })
+    )
+
+    httpServer(+PORT)
+}
+
+main()

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

@@ -0,0 +1,16 @@
+dist/*
+node_modules
+.env
+
+*_sessions
+*tokens
+.wwebjs*
+
+.git
+.gitignore
+Dockerfile*
+npm-debug.log*
+pnpm-debug.log*
+tests
+docs
+*.md

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

@@ -0,0 +1,40 @@
+# 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/assets ./assets
+COPY --from=builder /app/dist ./dist
+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-gohighlevel-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-gohighlevel-memory/_gitignore

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

package/dist/starters/apps/base-js-gohighlevel-memory/eslint.config.js

@@ -0,0 +1,23 @@
+import builderbot from 'eslint-plugin-builderbot'
+
+export default [
+    {
+        ignores: ['dist/**', 'node_modules/**', 'rollup.config.js'],
+    },
+    {
+        plugins: {
+            builderbot,
+        },
+        languageOptions: {
+            ecmaVersion: 'latest',
+            sourceType: 'module',
+        },
+        rules: {
+            ...builderbot.configs.recommended.rules,
+            '@typescript-eslint/no-explicit-any': 'off',
+            '@typescript-eslint/no-unused-vars': 'off',
+            '@typescript-eslint/ban-ts-comment': 'off',
+            'no-unsafe-optional-chaining': 'off',
+        },
+    },
+]

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

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

package/dist/starters/apps/base-js-gohighlevel-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-gohighlevel": "latest"
+  },
+  "devDependencies": {
+    "eslint-plugin-builderbot": "latest",
+    "eslint": "^9.39.1",
+    "nodemon": "^3.1.11"
+  },
+  "author": "",
+  "license": "ISC"
+}