\n
\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n
\n","readmeFilename":"README.md","gitHead":"40e3483c20d3a92f1c9de25dff1fe05aa24920ce","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini","_id":"speedybot-mini@2.0.0-beta.6","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-68Jjxal0Dme4J7LEJwYgLCe3oDEXn+StFDXPRtKlYNn92xJBrq+KjlpD5vFJGCGE8aOKVYlqmXOu56prIGUzfg==","shasum":"445fa7126310669f4726aa26910062b51a54bead","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.0-beta.6.tgz","fileCount":31,"unpackedSize":259113,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDWeYzAhaJoQ5KcNp2OQ03IriHsFxM/9LKNCcmgZiICnAIhALAX3Nqp2YyDD1Qbtsx+CWRJWbGqU8sx2JND/LpBRblD"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjT+kmACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoGqA//aFJobRF79RGe0pGmTtlPmBAyTyUxXxsfC8Sh8VUum4Tyvn2J\r\ncEr5Kj71kZuRHm3L6HyIE93Ryou3NMrRFGFJHeLEPxixlNX0cSVW/vK8wVX1\r\nrKVxaQziGyh9r8basAytqm3Z6/vakAVI4SlqIbsUaZEsKVVgr/+XPsBr8zqC\r\ny5kqoPrzwcypco8OVuWH61j9mYSXwxgGD8WSffqBg/LLrqa62tDxHlQhTRtU\r\ngJijZN+HqeRG3e4Vi/CM2yuSQrD4p5vUQJ9v1+ln3mwwI63Lum47fVeC5axM\r\nfN8zQAPIqI+8FFl9BsA2ijZrSBZvSGRX6h5ho/QnLyYIf2tZUVAz41EoU19P\r\nflHVESsaCLadpQrNPN7YsKFb2C9ojbu2oKIaoLkLo1sje8qzQ7bAejGNPGeV\r\nUT2/byN/q0mJksrUNhMkp2SdHORz0o1sC1v/HkAI0NXhjiEyYBVeRFAFK3AS\r\n8AWRdaBB8CobGLvHmT+jF1bCvj7HfT6pjBXbtF4Y56rPwieNRqZ3xx5YEJoH\r\nXJoeyqDZP6IpmVd01orTEa6wpbpCejZMakjk35qPWWzhfcR7+8fChh2O31t3\r\ncwRQ8ukv6AmULe3OgiFsq3bL88xD+pfvyjQGAI0pUNj49HXdnDDa3Q8Doyg1\r\nTqeHqObUda2fJTqGl6qEksZE+a3AoPw9+CE=\r\n=ZqqG\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.0-beta.6_1666181414767_0.024088127919302815"},"_hasShrinkwrap":false},"2.0.0":{"name":"speedybot-mini","version":"2.0.0","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"save":"git add . && git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"gitHead":"c9611f3a008aeba2d9d27a9ab4ba15b5ce8185bf","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini ```","_id":"speedybot-mini@2.0.0","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-OUJAzWfJhz7IPgBRLViTWCJaO7wB059S027ptAjHD+KvMMkpLKHbt6+ptcwjxkafN0KCBWFCV+wWpWruzw6cGA==","shasum":"0af5f5242440267e5137edfaf9600975a6ee84c8","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.0.tgz","fileCount":31,"unpackedSize":259231,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDpgFub5Ksj+PO6Rk8dKD+P037xAPHcmVM5T1FLHJkJywIhAKSq4devhnMY1YjXh1Cihxd9zLAhLQZBlawZauSmi0RV"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjT/tRACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmqa8A//ZNCptz/8s9+PIE2HYIt+5PgfG6wxUtg2oLpHXp5njzQQlHIt\r\nqEiobWKCnZjmTXA0pwP2O9r9j7imT2z4+oLdwE5Cwu/GmDhKuvKEBpPslDuJ\r\nAz+b6TCW6424AdghHlViTsHyD9+SYvJ0g7fy0Z8SZNoIf85jGcVGl9R1LWYK\r\nSqJuEge5xFmxS4MWSQU7yC9DEz9W/74HT+kYgQJeV92YjLySzOzy/LVhSk4t\r\n8AkHw9SQxVyKIG9UC5etZ+369roP7fWMAeyjEEoj/C8TNEkWWVMjRbXDRsEx\r\n0AKxa/Z1bFsAomwhkLuWIUlV1MIrYtNUgtn84P0Lskxl1MwMozMWWR1KOEue\r\n3jUVzhdMlF3sQXjv3FWKrUIJuz0Vl/KP+mpoEw3QR70RjDVJ0vmsD3QfqtVB\r\nbZX26gnHUOe2OSTFHNiegmz7hkWowC5FKpXIvO4L8Hl7ilvYdne6Pbi5CcZY\r\nyeRrJENYAqm+R/pDJtI/6KgxcRXFT0UTGuhTky1cr7doilnI8+4M8IEQSwXa\r\n/QNLQzfA1xuSoClOBoZK3pnmRC4rIquGF4J0+4B3sQFRmbzDB4/1AigBs2Yo\r\n3SvQrF6XFqpICUFCdPJKLyJWozZ1GhPlNPTelPyXLqOuryfzhOakKpG12r8q\r\nHLA1tCDi7Ydw+sx/hD2GRTtgofq7/iEVnlE=\r\n=th/O\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.0_1666186065455_0.054148891653474474"},"_hasShrinkwrap":false},"2.0.0-beta.7":{"name":"speedybot-mini","version":"2.0.0-beta.7","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"save":"git add . && git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"readme":"# š `speedybot-mini` super-fast \"no-ops\" conversation design infrastructure\n\n```\nāāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā\nāāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā\nāāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini\n```\n\n**serverless chat that actually works**\n\nš [API Docs](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes)\n\nSpeedybot-mini is a portable chat engine that you can run almost anywhere\n\n## Quickstarts\n\n- **[speedybot garage š§š¤, manage webhooks/secrets/admin](https://codepen.io/valgaze/pen/MWVjEZV)**\n\n- **[Deploy to Deno](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/deno)**\n\n- **[Deploy to Worker](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/worker)**\n\n- **[Deploy to Traditional Server](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/express-incoming-webhook)**\n\n## Speedybot-mini\n\n- š Zero External Dependencies š\n- Adds support **[tappable suggestion \"chips\"](#chips)**\n- Includes **[SpeedyCard card builder](#speedycard)** (create rich **[Adaptive Cards](https://developer.webex.com/docs/api/guides/cards)** without wrangling JSON)\n- Locale & i18n support\n- Optimized for **[V8 Isolates](https://developers.cloudflare.com/workers/learning/how-workers-works/)** for milisecond response times (š„¶ no more cold start problems š„¶)\n- Runs on virtually any infrastructure-- servers, V8 isolates, containers, container-less, edge, etc\n\nThe era of manually writing \"handlers\" or matching text with RegEx's is coming to an end. In the future there will be far fewer \"keyword\" handlers and instead deeper integration with 3rd-party conversation services like **[Voiceflow](https://www.voiceflow.com/)**, **[Amazon Lex](https://aws.amazon.com/lex/)**, **[DialogFlow](https://cloud.google.com/dialogflow/docs)**\n\n## Syntax\n\n```sh\nnpm install speedybot-mini\n```\n\n**[See starter bot](./settings/config.ts)**\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch,\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs like file-upload, but for images\nCultureBot.onCamera(async ($bot, msg, fileData) => {\n $bot.send(`{oncamera} '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n});\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}`);\n});\n```\n\n```ts\nimport Culturebot from \"./config.ts\";\n\n// use .processIncoming to handle incoming requests\nexport default {\n async fetch(request: Request): Promise(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n\n
\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n
\n","readmeFilename":"README.md","gitHead":"4429d9dcc76dd3ac7d7065bc1cf48cd841b9b86a","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini ```","_id":"speedybot-mini@2.0.0-beta.7","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-EWf1nRTuKtjRVhptuwomOQngrsuc0AgP1SXMT4EIG0BrAn/YwtgIYsZ5s37x4/2pddPhavDX1cXy3UkxJmPNfw==","shasum":"74079f0e009b85c80c28d6fa6dd7cb53ba93add5","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.0-beta.7.tgz","fileCount":31,"unpackedSize":259238,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCxX2Wxspsoh2Y2KN4SFJRhl0cp6FNLahXMpw5yNEBHngIgSzZ9Q6D6ybWV9+DvTjb0exjsp3QttiotQlxQgaR/D00="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjU2W9ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr+SA//aEZAasOIcKYZzZiYbabsruRWO9W70Xdtir6W/AYeinKnd1t6\r\n8Rl/7ps7fhLMieeAs8m8M6akdhCXwLRW/mwo1gtar2Y/ISMXbMqo8KWNF2bs\r\nDKphCuM1CyVIk+cmNCOeS6/VBpvgoQRAhsYDokC4XWnMQVeyD/Fk7YwDkIsl\r\nwmxGx+LFvm61v1JIqxU489jix3CXIIpp3JY3ExNJzhA1DJhtdtYGEVxeWQqw\r\nfkGT/oI+e3oGYHMypdM0VneEy7977a4vM9KSAkoz27vRhP+gHIhnuzP1k5L1\r\nubwn27S436/AKLBKous9X9k8sesKqGWasvV2Q6NjomYw0UH3kbdhxGQS/ey+\r\nonmbKnc9qp2QMPuJlz7oA37dFvVNmDUglbYnfMJyohDdNAxdTsXQHhsoK+oi\r\n2zGqGcvAXkR1V7BI4yi2oCvh6bwIhXCRAWywENn8QrQopJ7xJTrNMG+mLtUE\r\nYJJnWd54jE7a4yq7rXULUznpN/nmrJcNE+2y+jXEStMNcjaEZnK9hUzTOvZW\r\n545Ww/3xs/5mvij8bLR3ZtVNti9jpUegHreJnrle2BvtoFnsX5LwfRHZgU2t\r\nijuOSTKnRbhc31WPOa44rEQO13zbBheXeRosIYhVJv83JRG64VO+qRo7d1yh\r\nmmZSW5ob6P5pqX5zk2L5HpPYylHFM5Yy+hQ=\r\n=kOWn\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.0-beta.7_1666409917422_0.871219469903469"},"_hasShrinkwrap":false},"2.0.0-beta.9":{"name":"speedybot-mini","version":"2.0.0-beta.9","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","@types/node-fetch":"^2.6.2","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","dependencies":{"node-fetch":"^3.2.10"},"readme":"# š `speedybot-mini` super-fast \"no-ops\" conversation design infrastructure\n\n```\nāāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā\nāāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā\nāāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini\n```\n\n**serverless chat that actually works**\n\nš [API Docs](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes)\n\nSpeedybot-mini is a portable chat engine that you can run almost anywhere\n\n## Quickstarts\n\n- **[speedybot garage š§š¤, manage webhooks/secrets/admin](https://codepen.io/valgaze/pen/MWVjEZV)**\n\n- **[Deploy to Deno](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/deno)**\n\n- **[Deploy to Worker](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/worker)**\n\n- **[Deploy to Traditional Server](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/express-incoming-webhook)**\n\n## Speedybot-mini\n\n- š Zero External Dependencies š\n- Adds support **[tappable suggestion \"chips\"](#chips)**\n- Includes **[SpeedyCard card builder](#speedycard)** (create rich **[Adaptive Cards](https://developer.webex.com/docs/api/guides/cards)** without wrangling JSON)\n- Locale & i18n support\n- Optimized for **[V8 Isolates](https://developers.cloudflare.com/workers/learning/how-workers-works/)** for milisecond response times (š„¶ no more cold start problems š„¶)\n- Runs on virtually any infrastructure-- servers, V8 isolates, containers, container-less, edge, etc\n\nThe era of manually writing \"handlers\" or matching text with RegEx's is coming to an end. In the future there will be far fewer \"keyword\" handlers and instead deeper integration with 3rd-party conversation services like **[Voiceflow](https://www.voiceflow.com/)**, **[Amazon Lex](https://aws.amazon.com/lex/)**, **[DialogFlow](https://cloud.google.com/dialogflow/docs)**\n\n## Syntax\n\n```sh\nnpm install speedybot-mini\n```\n\n**[See starter bot](./settings/config.ts)**\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch,\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs like file-upload, but for images\nCultureBot.onCamera(async ($bot, msg, fileData) => {\n $bot.send(`{oncamera} '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n});\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}`);\n});\n```\n\n```ts\nimport Culturebot from \"./config.ts\";\n\n// use .processIncoming to handle incoming requests\nexport default {\n async fetch(request: Request): Promise(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n\n
\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n
\n","readmeFilename":"README.md","gitHead":"7a24b17f060d1e3cce24e55d95df728634e8fdd6","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini ```","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.0-beta.9","_nodeVersion":"16.14.2","_npmVersion":"8.5.0","dist":{"integrity":"sha512-7RrXSuSWiviN5NJfwrPo2r5mR/xxNv+PTVZWBSS5+WlzQ9L5RdIiAGOlHPCRnUggSrfO/OQAbID8Zy51uYQ0oQ==","shasum":"c5f2e86c006c4c193fd15f6d27b2762e9846712b","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.0-beta.9.tgz","fileCount":32,"unpackedSize":260658,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCVdompTF5RRCFtfPgMCDqRVowPuS7/wCau/wx5ZNvq5gIhAKwN398EHhabhpFXK5ZzEvcH4F2s7uRgWjCiI+Z6+kZp"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjVu23ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrkkA/9E7LACAV8BiHlKTTA3+9dDwQYySl5Fi65tkIz8n0/ENw8VMYa\r\nWtmgAJfbGosw4HYwC/k44dk4KC5D9ES93/dDHd/JR+dLlFkCYQNHGJ3GRKXr\r\nd4HR4ml0Ujiv9BGpAUU1+oBkpXGMXj/uIl119FtF66Yj1zwPvgUhBIT1U9jZ\r\nVuWQSWwbe1fUT7IaAL71dBd0HwvUhNacXFV3ZGn+Or9GPcglpyKu19VZ+syu\r\nTYgzEo/Jg1tfc+vzhgDN3DQSZ4q6Vm8oSstbxQ3Hs+Bcp42uV+rKxppBrQeU\r\nC/BzI28BuW6TmCqI4IBb4pb1EeBki3bKV6eqjnVbJ+JZOxo4v5+rIiqjqW0w\r\nYw5mkjSDUbRyNSWQfhEZUY+44uaISVou4who9+lAlbD81iaankS4ixDxyaQ3\r\nYqU/2fJuaAp/zRS5tPM0brbitPHVRLv1VnIrJM0T+Ug3VvFpQpahATFZ8WBB\r\nKFC/7GT6KNpe4llyVUkC89yB6OSmgAOxKniLPWX4RnxrBA5e17OArxlNYE9r\r\n8XOWcCnEjliJrZkjmwAioy2oAzBiPjtX3drRCDEHZQ8W+qnsYQnovA6LQvH6\r\nSu3kb1UJJjW2H2ZEWfNMa+PeWWmVclwXkRlHQWWAs7IhKPgxyqTOfU2YjP/n\r\nQiE/QfdNLzCElIyXJZ5O3FoY2dK6sMY7u8E=\r\n=Dn/H\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.0-beta.9_1666641334821_0.17056767048635657"},"_hasShrinkwrap":false},"2.0.0-beta.10":{"name":"speedybot-mini","version":"2.0.0-beta.10","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","@types/node-fetch":"^2.6.2","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","dependencies":{"isomorphic-fetch":"^3.0.0"},"readme":"# š `speedybot-mini` super-fast \"no-ops\" conversation design infrastructure\n\n```\nāāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā\nāāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā\nāāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini\n```\n\n**serverless chat that actually works**\n\nš [API Docs](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes)\n\nSpeedybot-mini is a portable chat engine that you can run almost anywhere\n\n## Quickstarts\n\n- **[speedybot garage š§š¤, manage webhooks/secrets/admin](https://codepen.io/valgaze/pen/MWVjEZV)**\n\n- **[Deploy to Deno](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/deno)**\n\n- **[Deploy to Worker](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/worker)**\n\n- **[Deploy to Traditional Server](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/express-incoming-webhook)**\n\n## Speedybot-mini\n\n- š Zero External Dependencies š\n- Adds support **[tappable suggestion \"chips\"](#chips)**\n- Includes **[SpeedyCard card builder](#speedycard)** (create rich **[Adaptive Cards](https://developer.webex.com/docs/api/guides/cards)** without wrangling JSON)\n- Locale & i18n support\n- Optimized for **[V8 Isolates](https://developers.cloudflare.com/workers/learning/how-workers-works/)** for milisecond response times (š„¶ no more cold start problems š„¶)\n- Runs on virtually any infrastructure-- servers, V8 isolates, containers, container-less, edge, etc\n\nThe era of manually writing \"handlers\" or matching text with RegEx's is coming to an end. In the future there will be far fewer \"keyword\" handlers and instead deeper integration with 3rd-party conversation services like **[Voiceflow](https://www.voiceflow.com/)**, **[Amazon Lex](https://aws.amazon.com/lex/)**, **[DialogFlow](https://cloud.google.com/dialogflow/docs)**\n\n## Syntax\n\n```sh\nnpm install speedybot-mini\n```\n\n**[See starter bot](./settings/config.ts)**\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch,\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs like file-upload, but for images\nCultureBot.onCamera(async ($bot, msg, fileData) => {\n $bot.send(`{oncamera} '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n});\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}`);\n});\n```\n\n```ts\nimport Culturebot from \"./config.ts\";\n\n// use .processIncoming to handle incoming requests\nexport default {\n async fetch(request: Request): Promise(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n\n
\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n
\n","readmeFilename":"README.md","gitHead":"e288184ff4072f8af41cc962075b9be37e3497fb","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini ```","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.0-beta.10","_nodeVersion":"16.14.2","_npmVersion":"8.5.0","dist":{"integrity":"sha512-IZfOQgZrt3GRBh5TdIPh0iNtUZMjJXgL1eePhOXvBjLgt9pL98quohmBnxpvhqwxe73MSO7VyouObuzb3qnyRg==","shasum":"86d128d818cadeed17dfe9ea6c4f9f4cf0136ea6","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.0-beta.10.tgz","fileCount":32,"unpackedSize":260664,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAPSGztkRRV54+NyVUP+Pai2Iu6nrmb84Qag78tx7zz7AiB2RSgFY7ocep4gUGMjzruFABoGaDGerJi9R37VyRXrwg=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjVvHCACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoOPQ/9FkmGNL3Pkbyw89EInkeDrzF0Nt00VgFx0aNVeWhUH8CEmkBE\r\nnHZv6PItwh37oJIZ4OU5VyTHBiJExM/mOXJdfzuRoeUbPUKBGfDCD0FlU1wW\r\ndpP319gpYFzOYLqOt6COcVxxYDuvx5fHt2CtopiFge/UsLA1YENNXBA+4KIz\r\n/AaXUSaE+KtNxIB6A2aQ09iMnWse2er2mwG0VqheKJLtjLDmgBevWE8Ezpx3\r\nLI98Ih0/ZfZCYzav4wXhsw7Yg0GhNx+6jY63o4H+tIDP8BXCSQG1t3Y3NYlC\r\nv1QqtqBUTb2asN2DC/theb8iKDvvxkh0iIVEo0Db4R3UK3cVmewI3BHvpdit\r\n+qN4SGAk296nr67tGIfe8CU7YMymOjc9Bdw0HKSZ/YZYhhokfccYZW4xkmiy\r\nv33wI0atcVN62g4GQzYBu5HQ7WZqP5N9WDlBnE+PxYMkSq3MolQ/qPE+mBen\r\nfC3oFRFAYGDs41SB4+gtrlLzZZGzqKXn2mI9RbczfzZnzX+OqFxoopEECZZK\r\nKNjOWV6OMjn5DIfs7Pjjm0jorCZuAtwtt4z4bK5jEfF7z6Qdeayp4u7Ah8ZY\r\n1lBqPCXqQ7Hazy5eEpRhEjLX3mL/TUgUVFI6Zssysl5qmlrUnoGSzAMvJByu\r\nvIGzbLZKl1ZwRu7E+kxfPKwhXhPm4I4oljc=\r\n=/dj0\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.0-beta.10_1666642370274_0.7639781058445654"},"_hasShrinkwrap":false},"2.0.0-beta.11":{"name":"speedybot-mini","version":"2.0.0-beta.11","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","@types/node-fetch":"^2.6.2","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","dependencies":{"cross-fetch":"^3.1.5"},"readme":"# š `speedybot-mini` super-fast \"no-ops\" conversation design infrastructure\n\n```\nāāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā\nāāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā\nāāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini\n```\n\n**serverless chat that actually works**\n\nš [API Docs](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes)\n\nSpeedybot-mini is a portable chat engine that you can run almost anywhere\n\n## Quickstarts\n\n- **[speedybot garage š§š¤, manage webhooks/secrets/admin](https://codepen.io/valgaze/pen/MWVjEZV)**\n\n- **[Deploy to Deno](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/deno)**\n\n- **[Deploy to Worker](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/worker)**\n\n- **[Deploy to Traditional Server](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/express-incoming-webhook)**\n\n## Speedybot-mini\n\n- š Zero External Dependencies š\n- Adds support **[tappable suggestion \"chips\"](#chips)**\n- Includes **[SpeedyCard card builder](#speedycard)** (create rich **[Adaptive Cards](https://developer.webex.com/docs/api/guides/cards)** without wrangling JSON)\n- Locale & i18n support\n- Optimized for **[V8 Isolates](https://developers.cloudflare.com/workers/learning/how-workers-works/)** for milisecond response times (š„¶ no more cold start problems š„¶)\n- Runs on virtually any infrastructure-- servers, V8 isolates, containers, container-less, edge, etc\n\nThe era of manually writing \"handlers\" or matching text with RegEx's is coming to an end. In the future there will be far fewer \"keyword\" handlers and instead deeper integration with 3rd-party conversation services like **[Voiceflow](https://www.voiceflow.com/)**, **[Amazon Lex](https://aws.amazon.com/lex/)**, **[DialogFlow](https://cloud.google.com/dialogflow/docs)**\n\n## Syntax\n\n```sh\nnpm install speedybot-mini\n```\n\n**[See starter bot](./settings/config.ts)**\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch,\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs like file-upload, but for images\nCultureBot.onCamera(async ($bot, msg, fileData) => {\n $bot.send(`{oncamera} '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n});\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}`);\n});\n```\n\n```ts\nimport Culturebot from \"./config.ts\";\n\n// use .processIncoming to handle incoming requests\nexport default {\n async fetch(request: Request): Promise(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n\n
\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n
\n","readmeFilename":"README.md","gitHead":"b13a03c9dcdabecf2f840a2c6f3a75ed1ec35f9c","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini ```","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.0-beta.11","_nodeVersion":"16.14.2","_npmVersion":"8.5.0","dist":{"integrity":"sha512-2cEYTvnK+y0eJHCJ/jbTvCAtbK2ftxvO0zTBbj7p5qr1Bh79Xchtuv6kZNzSQrNeVpCPXn6AlvMdEeApEI5v8Q==","shasum":"557b347fd049604c14dccc130786d53bc943a596","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.0-beta.11.tgz","fileCount":32,"unpackedSize":260659,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQD2YNWKdxlsBwMqmr6rCatWj4ySj0te3fNwECnsjsk0sQIgcEpFYBITnPDKZqgh0bfd/R5q/z3JpfOeXyf7gY84CNk="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjVxa7ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpalg//d8AlCbzReBoOp8AhmmHMUJo9WNp2Hs3AgaJquENEVMgtFdua\r\nzKk1pZK+nW9koJXEF7VoI9XHpcrjYuuk8hSVZmy4UpTJL1M8pmVZfBrzPJrF\r\nU2IQdq1JI+G3JtPebJzuGFpYF3S+uIJ70B+rXf+s2A9nadCLAdsTM+bz2lkx\r\nO/x1PLNr7y9LehornsjkhvZE430oD7C//sX+PjthfKf9OxVKWF+Rwywd/yNp\r\nmmVdCzRHLyjjH2DN9fMl/tpWH4m5beeG+GT3Grq1+1UAzjQ8fEm4nrbVDc2w\r\n+Q37IYt3MnNVFO9tCY+VdDaruWRdXJLZ1AQd9DN9C9QDY8KbOVK6bnn1Pjn0\r\nVitSiaIYGCzKntPl2tANlVkJfBg6OJWdOlbdnW1tknKs8Vex1e4IJf4Idyh5\r\nSVam50RjFeI13Fm8sEMAaXpbnLNPDY6wEpmjrF4uRu14pOHn1va9GVBLviki\r\nNwD1L7dy/HDgJembOnnaVzvVVb2umfsizi3csbhM7uEE/fiTirMXidK0bbIx\r\nL/DMtYguGhgSH3WU0xqUmdnV5AkEwqdsZ/oHLzjpHR81CSqXBrper7Y6h3BP\r\n2+9RQq5oSoB6nZQUNSxLxwUFXhZg0o9/7U+ZDIn2iDLLxGNzVd8hSntktMw2\r\nlF6+RCqWAdtgfaVcJv8QRwT3+N4enFDfWNA=\r\n=lJYK\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.0-beta.11_1666651835376_0.6644438915004105"},"_hasShrinkwrap":false},"2.0.0-beta.12":{"name":"speedybot-mini","version":"2.0.0-beta.12","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","@types/node-fetch":"^2.6.2","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","dependencies":{"cross-fetch":"^3.1.5","isomorphic-fetch":"^3.0.0"},"readme":"# š `speedybot-mini` super-fast \"no-ops\" conversation design infrastructure\n\n```\nāāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā\nāāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā\nāāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini\n```\n\n**serverless chat that actually works**\n\nš [API Docs](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes)\n\nSpeedybot-mini is a portable chat engine that you can run almost anywhere\n\n## Quickstarts\n\n- **[speedybot garage š§š¤, manage webhooks/secrets/admin](https://codepen.io/valgaze/pen/MWVjEZV)**\n\n- **[Deploy to Deno](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/deno)**\n\n- **[Deploy to Worker](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/worker)**\n\n- **[Deploy to Traditional Server](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/express-incoming-webhook)**\n\n## Speedybot-mini\n\n- š Zero External Dependencies š\n- Adds support **[tappable suggestion \"chips\"](#chips)**\n- Includes **[SpeedyCard card builder](#speedycard)** (create rich **[Adaptive Cards](https://developer.webex.com/docs/api/guides/cards)** without wrangling JSON)\n- Locale & i18n support\n- Optimized for **[V8 Isolates](https://developers.cloudflare.com/workers/learning/how-workers-works/)** for milisecond response times (š„¶ no more cold start problems š„¶)\n- Runs on virtually any infrastructure-- servers, V8 isolates, containers, container-less, edge, etc\n\nThe era of manually writing \"handlers\" or matching text with RegEx's is coming to an end. In the future there will be far fewer \"keyword\" handlers and instead deeper integration with 3rd-party conversation services like **[Voiceflow](https://www.voiceflow.com/)**, **[Amazon Lex](https://aws.amazon.com/lex/)**, **[DialogFlow](https://cloud.google.com/dialogflow/docs)**\n\n## Syntax\n\n```sh\nnpm install speedybot-mini\n```\n\n**[See starter bot](./settings/config.ts)**\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch,\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs like file-upload, but for images\nCultureBot.onCamera(async ($bot, msg, fileData) => {\n $bot.send(`{oncamera} '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n});\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}`);\n});\n```\n\n```ts\nimport Culturebot from \"./config.ts\";\n\n// use .processIncoming to handle incoming requests\nexport default {\n async fetch(request: Request): Promise(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n\n
\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n
\n","readmeFilename":"README.md","gitHead":"f88b1ffce35cdf6c36140c3b25678ee6f67c8140","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini ```","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.0-beta.12","_nodeVersion":"16.14.2","_npmVersion":"8.5.0","dist":{"integrity":"sha512-dWiTOYHsY3bh0M2laMegABbldkE/f1Gmc524q7Xg8R1XL8pAFOFiKCSASmniAmdGtNL49ioqoK/VCEVu/4IVzw==","shasum":"9732adf81bb57e86134f08daf72158d5b44bd9ee","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.0-beta.12.tgz","fileCount":32,"unpackedSize":260693,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHaYqS4ZFm/vJ4SnFr3gycxQ9NWQz8Z8UYzpjX5jLYSJAiBoiOZjBdpOhrzCdFxZtgYybQ1ZsaDbRNG/Y08iN1dB1g=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjV/rrACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrxzQ/6AtEsxNAUdBdT5JUDBumDI4Ppm5vqXd0L5yFNK2ARjXZQuLQ2\r\nILx6KY70Ac28qMwzi9T/i5FvgVvdyBGShtu7efUZCJ+iW5VmFBe+qCTULuZD\r\nD+yjLS/4n1LP74HVpYHKmc67xmbxvxHEQYSHD+PtWzebBIP73JW7Y6Py1h3n\r\ntbAh4pgFwu8tFe+VN8Mtup+j933DyumXGdgL74M4yG0lBX0Wr03Y4K9wvA5i\r\nM2K+a4DO4SZp7YH/8wylRkYe7a6aqBlGwHIiD5nOlg5kvM7nWqZoirsZE8Rl\r\neLKLhLVGyR4leEWyv1jFXZnJZL+UqLvGtdMPmCZSL2TVRR1NH29a7YxORm5B\r\n0YkXAK8dgmxUgOYP9GkrhCgmc03ir9cejV7BoliH04VVsjG4DCxHV9GkmhMj\r\n6SatXu/oLvbH7TNTuhfJ06IW0yOy0vkBHjTFRxJjQ7O2uTI6AXjz05KJuKhw\r\nqV9pAgL20RIy0Jh3SBJIYvFKSgFU8MWF25aNO72CtCgs3KlMTjGZBm9o0usD\r\nelscvN08RtwnU3IAgZL9p1ltBkAIz4Zep8m/WZEIbQyhDjniqQj2jR22tDAY\r\nj3ySmP9bUdZJFnFE3uPO2A4TOU9Rju630+pgtgcRbm28JGSCjnnxV0wG8Tg4\r\nzzlcByKsjL4bOACvrQnuwiC8iGVjZV7Z6SU=\r\n=tC6c\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.0-beta.12_1666710250810_0.7260618256973681"},"_hasShrinkwrap":false},"2.0.0-beta.13":{"name":"speedybot-mini","version":"2.0.0-beta.13","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","@types/node-fetch":"^2.6.2","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","dependencies":{"cross-fetch":"^3.1.5","isomorphic-fetch":"^3.0.0","node-fetch":"^3.2.10"},"readme":"# š `speedybot-mini` super-fast \"no-ops\" conversation design infrastructure\n\n```\nāāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā\nāāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā\nāāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini\n```\n\n**serverless chat that actually works**\n\nš [API Docs](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes)\n\nSpeedybot-mini is a portable chat engine that you can run almost anywhere\n\n## Quickstarts\n\n- **[speedybot garage š§š¤, manage webhooks/secrets/admin](https://codepen.io/valgaze/pen/MWVjEZV)**\n\n- **[Deploy to Deno](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/deno)**\n\n- **[Deploy to Worker](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/worker)**\n\n- **[Deploy to Traditional Server](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/express-incoming-webhook)**\n\n## Speedybot-mini\n\n- š Zero External Dependencies š\n- Adds support **[tappable suggestion \"chips\"](#chips)**\n- Includes **[SpeedyCard card builder](#speedycard)** (create rich **[Adaptive Cards](https://developer.webex.com/docs/api/guides/cards)** without wrangling JSON)\n- Locale & i18n support\n- Optimized for **[V8 Isolates](https://developers.cloudflare.com/workers/learning/how-workers-works/)** for milisecond response times (š„¶ no more cold start problems š„¶)\n- Runs on virtually any infrastructure-- servers, V8 isolates, containers, container-less, edge, etc\n\nThe era of manually writing \"handlers\" or matching text with RegEx's is coming to an end. In the future there will be far fewer \"keyword\" handlers and instead deeper integration with 3rd-party conversation services like **[Voiceflow](https://www.voiceflow.com/)**, **[Amazon Lex](https://aws.amazon.com/lex/)**, **[DialogFlow](https://cloud.google.com/dialogflow/docs)**\n\n## Syntax\n\n```sh\nnpm install speedybot-mini\n```\n\n**[See starter bot](./settings/config.ts)**\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch,\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs like file-upload, but for images\nCultureBot.onCamera(async ($bot, msg, fileData) => {\n $bot.send(`{oncamera} '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n});\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}`);\n});\n```\n\n```ts\nimport Culturebot from \"./config.ts\";\n\n// use .processIncoming to handle incoming requests\nexport default {\n async fetch(request: Request): Promise(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n\n
\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n
\n","readmeFilename":"README.md","gitHead":"2cf0551a882a04913e587b14cd59810f744df7eb","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini ```","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.0-beta.13","_nodeVersion":"16.14.2","_npmVersion":"8.5.0","dist":{"integrity":"sha512-Gq3fQvINSRHgPSlObS9EwZOuY9gjkKMzyYGoWiATVf47yOMvrQxzEW8kkUmOKtoT16lD9XBecpJBciN09Qr6aA==","shasum":"85d79a63da23b4b80a4c188885d0c16bcf28aaa8","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.0-beta.13.tgz","fileCount":32,"unpackedSize":260722,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGN5OwzfwL7M4kFahROCsTwQCPq2S+26Hrb7KC9fWyDHAiEAgK9DnLysZlHPbGOjAPBkb1DZhp3V+KAO9L/VqvosFyw="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjV/uqACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpbhQ//ZdB8/0LNzNRdX1Qth/sERhj95fxKSXftVrXaGOfre3ycRznC\r\nBsNmFyzMe2nL/bXazxW+pXImZVYRWJqloXd8PotvFdGi+dK0KbBHbfXtjFFv\r\nFVatvtNj9mxvZwhXgBD3Q4B9JL2qW/6aIjtTbdAzY7/OVGNZmg2aew9pQEkw\r\n6n+rsv6TtsCt2lCEGlqALLsFgoyKYCwH4/WoD179Ut+MBt4Oi3I74SzbW1mj\r\nbWRxTG56R6SFS9yD9Q1p7UQmz0wyKTwz/GRzRlxvabvUqj8TEoOzSDIK4yFR\r\naQRwpR2Wyzyn9oz6G+UEPsR0R9jdwv4hSMEEulddh8jqNZ9wWwDLufVIy7gF\r\nYq+i8CKueTSfXFRO12nnXCtfSDy9hgbakShgIduW0HafwKuAC11ykUMxfvd+\r\nRK71TeJuhfeDWJe5sFihpNFEZzuUki/UL0GR+i4QYLFzn7Clb6nDmqyoeBP0\r\nGwFDXWbk1dnHTPckGyUmF6/9vUoM8tHgP1Aj0PdrrGMlwdwMierq2L1tApT0\r\nJvea9F777AQaAyvvL/0bWJZPDpsG4Sdpg+mAo8ZovTZMe+9hFeKjbn35M/Q3\r\n/q7ctBh7DtL8cAZTnDK8AeHgdk0JfV84XIGTgTnFwI+LhNoq6fDaNXSJgb0/\r\nQe6PjJNvHujdes+1BM8G7yJu47yGpZbvexk=\r\n=KT6A\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.0-beta.13_1666710442763_0.8334363707917631"},"_hasShrinkwrap":false},"2.0.0-beta.15":{"name":"speedybot-mini","version":"2.0.0-beta.15","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","readme":"# š `speedybot-mini` super-fast \"no-ops\" conversation design infrastructure\n\n```\nāāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā\nāāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā\nāāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini\n```\n\n**serverless chat that actually works**\n\nš [API Docs](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes)\n\nSpeedybot-mini is a portable chat engine that you can run almost anywhere\n\n## Quickstarts\n\n- **[speedybot garage š§š¤, manage webhooks/secrets/admin](https://codepen.io/valgaze/pen/MWVjEZV)**\n\n- **[Deploy to Deno](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/deno)**\n\n- **[Deploy to Worker](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/worker)**\n\n- **[Deploy to Traditional Server](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/express-incoming-webhook)**\n\n## Speedybot-mini\n\n- š Zero External Dependencies š\n- Adds support **[tappable suggestion \"chips\"](#chips)**\n- Includes **[SpeedyCard card builder](#speedycard)** (create rich **[Adaptive Cards](https://developer.webex.com/docs/api/guides/cards)** without wrangling JSON)\n- Locale & i18n support\n- Optimized for **[V8 Isolates](https://developers.cloudflare.com/workers/learning/how-workers-works/)** for milisecond response times (š„¶ no more cold start problems š„¶)\n- Runs on virtually any infrastructure-- servers, V8 isolates, containers, container-less, edge, etc\n\nThe era of manually writing \"handlers\" or matching text with RegEx's is coming to an end. In the future there will be far fewer \"keyword\" handlers and instead deeper integration with 3rd-party conversation services like **[Voiceflow](https://www.voiceflow.com/)**, **[Amazon Lex](https://aws.amazon.com/lex/)**, **[DialogFlow](https://cloud.google.com/dialogflow/docs)**\n\n## Syntax\n\n```sh\nnpm install speedybot-mini\n```\n\n**[See starter bot](./settings/config.ts)**\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch,\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs like file-upload, but for images\nCultureBot.onCamera(async ($bot, msg, fileData) => {\n $bot.send(`{oncamera} '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n});\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}`);\n});\n```\n\n```ts\nimport Culturebot from \"./config.ts\";\n\n// use .processIncoming to handle incoming requests\nexport default {\n async fetch(request: Request): Promise(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n\n
\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n
\n","readmeFilename":"README.md","gitHead":"ef6464aa4150a5b78cae8884d4eccf09d7d02a47","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini ```","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.0-beta.15","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-G7mypCRk7VKyFJAAKz82T5p+EdA49CmXVJ+DxFRexYSyCGygCzIwDwGVaLVM7E9lIeJLHm2eFJXy7OgDWcv1sg==","shasum":"f71512ad520c7e55d32724a76e84e66a16fecd89","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.0-beta.15.tgz","fileCount":32,"unpackedSize":260571,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFIHmjCWGm7yvEivac7fX+CzV15doNUH6VMqTB3F+jclAiEA2cvG+eZYBufd/aeNgu3A0y72nPMoswIT8zI+vyaVJhs="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjWLEEACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqCsQ//SJS65xM8rrTMEKUk/LNeYcRXYaGI6gYLCarYB4M0Py1YbqV4\r\nBNlFn/ShgouFzS0VNVnKP3tHmCA73C2WuhGIc/XXqVB2LsoUCEsauIPn0YcX\r\nSZuprwnGkgSCqwfZ4JSpVp07FImS/O1sjcSm4YFC5tkRP9rGLtiBpzSsRp9z\r\nmhRu/rcVUAyJeKojEOH7EZ5e1Px/qaEgt94PuEXZ2zD2WuchzqemGgE5eA6R\r\nC++9s8Sc+c11wu/lq3/wU22oe0kaTcD5NCo8Oa2h8GvNtHEzfj+kW1hkj/xk\r\nDQI76GzbOlpMO+Rgaw5jvnDprSTk0VXgG+yu5pzYGi0lycuQud/O8pdBdWsV\r\n6DI97FD0y7AWnk9QmEVRmVJ5tDBi3oaIuzBoVZJDO8wyQ7sj/WsStTeOdNxA\r\neHYVWsz+ki9Uu+DYp7CDBwfaBtQk+REgI1H8/zIQop2PnJ4qXvP59lHMI0kY\r\nP8qtY6RizdM77RJQR/UIP84l4mdibYLmI2jl4mhce0AQBTzJCZHYKmJhd1m7\r\nnd2N+ovX65Tg0yhHjDJvOConAtY+S7OEW1TRit5t0u0slqiE8yJik/qGNqNR\r\ne0YAyaif2jwl0Gcy0xBS/QY6Oykzd0duFnAFbSQ1JSH/p18MFu4huzmy9HiW\r\nRYqe/jrSm8LpzQsfCItdKFsLN1awyGQL+EA=\r\n=P1Wz\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.0-beta.15_1666756868184_0.3627872632566398"},"_hasShrinkwrap":false},"2.0.0-beta.16":{"name":"speedybot-mini","version":"2.0.0-beta.16","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm run build && npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","gitHead":"d0f98651ba7e8538e0252df9a4e9706dae9c64cf","readme":"# š `speedybot-mini` super-fast \"no-ops\" conversation design infrastructure\n\n```\nāāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā\nāāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā\nāāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini\n```\n\n**serverless chat that actually works**\n\nš [API Docs](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes)\n\nSpeedybot-mini is a portable chat engine that you can run almost anywhere\n\n## Quickstarts\n\n- **[speedybot garage š§š¤, manage webhooks/secrets/admin](https://codepen.io/valgaze/pen/MWVjEZV)**\n\n- **[Deploy to Deno](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/deno)**\n\n- **[Deploy to Worker](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/worker)**\n\n- **[Deploy to Traditional Server](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/express-incoming-webhook)**\n\n## Speedybot-mini\n\n- š Zero External Dependencies š\n- Adds support **[tappable suggestion \"chips\"](#chips)**\n- Includes **[SpeedyCard card builder](#speedycard)** (create rich **[Adaptive Cards](https://developer.webex.com/docs/api/guides/cards)** without wrangling JSON)\n- Locale & i18n support\n- Optimized for **[V8 Isolates](https://developers.cloudflare.com/workers/learning/how-workers-works/)** for milisecond response times (š„¶ no more cold start problems š„¶)\n- Runs on virtually any infrastructure-- servers, V8 isolates, containers, container-less, edge, etc\n\nThe era of manually writing \"handlers\" or matching text with RegEx's is coming to an end. In the future there will be far fewer \"keyword\" handlers and instead deeper integration with 3rd-party conversation services like **[Voiceflow](https://www.voiceflow.com/)**, **[Amazon Lex](https://aws.amazon.com/lex/)**, **[DialogFlow](https://cloud.google.com/dialogflow/docs)**\n\n## Syntax\n\n```sh\nnpm install speedybot-mini\n```\n\n**[See starter bot](./settings/config.ts)**\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch,\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs like file-upload, but for images\nCultureBot.onCamera(async ($bot, msg, fileData) => {\n $bot.send(`{oncamera} '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n});\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}`);\n});\n```\n\n```ts\nimport Culturebot from \"./config.ts\";\n\n// use .processIncoming to handle incoming requests\nexport default {\n async fetch(request: Request): Promise(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n\n
\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n
\n","readmeFilename":"README.md","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini ```","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.0-beta.16","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-kFD3nF5ylBTIkCvlE6CUc1wESh3zUK3z3sTf/GxA6yem7Z+s6bBWe+VZBr8U2zOVsbN5gM3GQY/J7OwPCz5Hag==","shasum":"5bcc9c2cf9bec7180946e6f8a436dae6c9a5e2b2","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.0-beta.16.tgz","fileCount":32,"unpackedSize":261198,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDnKpUIbI3Lndp77k9jnauADo9t7TLjVJwyGzpf98lLxAIgXFlrj2hFJdsOllfBOJK3lNnBlX2j9cwpwk6ZMOXB0jM="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjWLQTACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmokKhAAgZ0iXKjsMg1VALwJJd1uLtwfyo1g3UqWSqh8qdv+6wXNdzBn\r\nq+etBZSgVKuWnCZty/HTGiyjAigYHUpWSC7QAkKFtPeaZyx8Bcwmi0CC3JIi\r\nYVx7dbhTFcUrKe4wRXyKt6MbHKjyXVJl8ESy2pUaUga1oGQ7mtNrD1mpy4rs\r\nZw6tFvglOwbtpNl2V4X4BuvoS4lT3HlVDZPHMctAHRiH67cBLHcmfFQNuC2I\r\nIIK6zcgpKskv57nVBCkkNZWLCa9dX3j3gA36lPngLTm6bZZ0AQByzmE4g7UH\r\nZva0MBGMJFiAPYRkthqOEf2+/oCLKiMQkV2aghM56HUhPkPED56uy5VeE4NM\r\ndm14v19pp7ljTIgO0BM6ql+JMrWmQH23uziVMZy6MAqNccPAjwWwCWv5fZD8\r\n4Uu7BaYahRIEhbg6w1Hv/qWQ82J9GH5RiemgFvLFqzTKVlwPZqUt7WgjG5V7\r\nfYTthezlqwEKVS2Lx29N5Lpl7y+Ibv2PFRLBLANUdotj3qAAaShBltqEQ2fw\r\nGgX0LIUfEotnhugOcrvTgNqcFf7LWlJ00eipzNzPR0YZEAARna1RZPCcxU2R\r\n0EBW6sflSRcsrxrvx4lOtDESrIW2gU0kbersrYE0jewn2fdxYcYq2R5wSUUC\r\njtwRVkUuhAf9cVvjp9ntVXr4FeHLp+8aDxU=\r\n=zb71\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.0-beta.16_1666757650913_0.15743167175112016"},"_hasShrinkwrap":false},"2.0.1":{"name":"speedybot-mini","version":"2.0.1","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm run build && npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","gitHead":"58596910b169b3a89eabdbf5d6acf9801b7edbe7","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini ```","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.1","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-WM6EXS2bsH8wnYBW7onatWQ41ylUbPeOQQQ6U2kBInrw/INEgOBl1AmgPpFMwXrX3KQX116qNYQ+NMTo3jzBJQ==","shasum":"5228f026764047aca9bdcb7da64fadf9c258e6c6","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.1.tgz","fileCount":32,"unpackedSize":261190,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHJR//bebOCtKZQCvb/R+6lEjq4pDAatrJkHq8vC5LWPAiEAsOHHqGJmiFurGg7j1Fk7spRvBxwtGCF8X1GhQyzOZIU="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjXUJOACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp2Ng/+OypRp5sdmCpmQa9JQNtVUhhzJiG8LbcHFYOqroHfOL9jtNzg\r\nrOwL3buccHx1o1r5eC1cJV/JGeaddssIRtkZmqHVMcYElWSvBap5wHBZYJ5C\r\nksoUuG1Ab7vRYU32M+bHJiMjqWksa51d0PLhBZFnYWtc2MySCH0LR8kcFDnS\r\nN3yWouGEvLU7MOdm2CNSGsN6Ym/HW/7M8NbEYFrjyJLwS/4q/FoQb73QtnpG\r\nCIYuGAvlJyyrljuQG1oE8jxJ/3klNBa/YP14fNHZfeIIt/xWX0losgYHGUWw\r\nEmvu18M9W8pbPeNkZY0xt7t5jJ9I/nlbkm1EYp1LnmHPBWN+6DYE7t1zJl50\r\nxUP5JXkiZ4OxVGn/7G9A/gKa3i2DUjeuoF+cPVjaS3hCMe0uO73ZUohxHBFZ\r\nX18p5RXuU+yZGovrLUjW5eoB1/v2fevYbno5uUx0X+ZIkG8G5LvzYCbo/v5i\r\neul6C0uqmYGuhg8KzdTkAExVvBrg99GFYqyaaosUPjWobbBq4ZlTOGGH5H8o\r\nxDWFO3ZtNcdh0GY8llnOOS7y80vhSKuJPHg/az3nx231vH3xlaAoD1dS/nlF\r\n+c2PLNelhDgyzNmtM0K1fIexAHv16fSWItaGys25HUj09wdC1btwfVeoviah\r\n+JmUmeu0MH5JFW7l1GM6YP8wWhmWxs3xctg=\r\n=hwv9\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.1_1667056206653_0.9731325732581739"},"_hasShrinkwrap":false},"2.0.1-beta.16":{"name":"speedybot-mini","version":"2.0.1-beta.16","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm run build && npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","readme":"# š `speedybot-mini` super-fast \"no-ops\" conversation design infrastructure\n\n```\nāāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā\nāāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā\nāāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini\n```\n\n**serverless chat that actually works**\n\nš [API Docs](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes)\n\nSpeedybot-mini is a portable chat engine that you can run almost anywhere\n\n## Quickstarts\n\n- **[speedybot garage š§š¤, manage webhooks/secrets/admin](https://codepen.io/valgaze/pen/MWVjEZV)**\n\n- **[Deploy to Deno](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/deno)**\n\n- **[Deploy to Worker](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/worker)**\n\n- **[Deploy to Traditional Server](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/express-incoming-webhook)**\n\n## Speedybot-mini\n\n- š Zero External Dependencies š\n- Adds support **[tappable suggestion \"chips\"](#chips)**\n- Includes **[SpeedyCard card builder](#speedycard)** (create rich **[Adaptive Cards](https://developer.webex.com/docs/api/guides/cards)** without wrangling JSON)\n- Locale & i18n support\n- Optimized for **[V8 Isolates](https://developers.cloudflare.com/workers/learning/how-workers-works/)** for milisecond response times (š„¶ no more cold start problems š„¶)\n- Runs on virtually any infrastructure-- servers, V8 isolates, containers, container-less, edge, etc\n\nThe era of manually writing \"handlers\" or matching text with RegEx's is coming to an end. In the future there will be far fewer \"keyword\" handlers and instead deeper integration with 3rd-party conversation services like **[Voiceflow](https://www.voiceflow.com/)**, **[Amazon Lex](https://aws.amazon.com/lex/)**, **[DialogFlow](https://cloud.google.com/dialogflow/docs)**\n\n## Syntax\n\n```sh\nnpm install speedybot-mini\n```\n\n**[See starter bot](./settings/config.ts)**\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch,\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs like file-upload, but for images\nCultureBot.onCamera(async ($bot, msg, fileData) => {\n $bot.send(`{oncamera} '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n});\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}`);\n});\n```\n\n```ts\nimport Culturebot from \"./config.ts\";\n\n// use .processIncoming to handle incoming requests\nexport default {\n async fetch(request: Request): Promise(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n\n
\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n
\n","readmeFilename":"README.md","gitHead":"35574c0bcde0d675f7912fce73e5183a40cbcf79","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini ```","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.1-beta.16","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-TpxCjt+Lf25RU3oGhoy5nrg9AIxv6n8tRtWjBPPm83YYMdz36dWsDMZniUdwoHrq9Oy2jQXHWocA7GhcF62B1A==","shasum":"891f158689e70d00c847d67d47ccd1726de49509","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.1-beta.16.tgz","fileCount":32,"unpackedSize":261950,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEkDcB189L3zWpUBcU/jHZlR4kr2yKloigSxhUh4E2eCAiBQi1JkJFthdvnM5kchTqG5hh/1QL0BOGkyJozVPVVYzQ=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjYksnACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr23w//S9RLjujzg70vuihK7zBZzLkvFQwc5b2TfE2GmbfiG622dq59\r\n58cXzn/ZnWLvkY6KYs9CLrQtT7p27npupVIsx92wiXWaaf1A9ouxbYwQbrfT\r\nqGbWQRmVNdFB6evLle/PLgVA2MejmJ035nGLCKRwgbnr+WH3xrI4+nGUSuPL\r\nYmKend0ltiphxsqkeGnybqovguTRSHaU5jeFfqRAa7CGp0rkqn9b3VFtbhPo\r\n0O9nyE7oNj5ms+bTgAIMAo2uZT9D7Qvz/Pl3FGB4Fg1RWVVsebmm9gUsEQ3Z\r\nVMc/3Ocdje/NAozurasqJLkfaLQiMUxdc3Kc/07GOnSR4EmIMNCgcRRJbHlc\r\nKItrY0+QnHv8uBYZfkc37j73x0ro5D3ja/kwng/lBOaKgmASg8xeOdO1Pt6E\r\neTpE+pfo/Z1IH/JMB8/w2jPFOcw6fq0zq6i2IuLRobv0VjDGU5+uBmfSJfEs\r\nk1xhRHcOOi89eImCK0mfoNJctBKpo2XBQkLZKP7SAdBd6zsBNBRGm8MufMTT\r\n1ca6xUBeRaHxkAhmAR0p44EsxW1pJPHU5ErbfmMDtgarDkpCWuaEj0zJRQ3Z\r\netOOzS04qxJQeItw3VZ8Z7u66gsGaF7oEJYJX/I5PllruHb63GEhiJnX/7Ji\r\n4fj973F1ENeFqZYO7N1pPpbZlgyKGgy5Axg=\r\n=NZlZ\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.1-beta.16_1667386151561_0.037214195799621264"},"_hasShrinkwrap":false},"2.0.2":{"name":"speedybot-mini","version":"2.0.2","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm run build && npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","gitHead":"17088aac32c8d0771fddce0430b24ba2eb918a50","description":"``` āāā āāā āāā āāā āā¦ā ā¦ ā¦ āā āāā āā¦ā āāā ā āā āā£ āā£ āā āā¦ā ā ā©ā ā ā ā āāā ā© āāā āāā āā©ā ā© āāā āāā ā© mini ```","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.2","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-yl4GyJm0ZmMGTjq0mNaEDuegpAVPvr7G9Bl13wdf2P/13FC0wEshVfCNmqBYdNp9B4Y96Td9VvX2ZY5PUtrrqw==","shasum":"04b717f938c65f864652a0e28d458336e672f532","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.2.tgz","fileCount":32,"unpackedSize":262021,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCTNwWW3Uxdacj+q1HvFIeJOWzHVfEIEhgaUlCKivGm3QIhAO0C5Rv2+SgccX6aR0+szfyzd7wEo6WqjQDVY+ATesnN"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjYk5gACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpTPg/9Fo18Z41eqLXZ8VRMeR+KAU3vAmxMEPMOK0w5imFG8vdEvOsj\r\njIOJESDk4JCgHOcVVYFvzT4gHwXjBNEic0bKwT8v5K9T5+s+vAczo2kiXfl9\r\nL5HbaK4WKt/genMDNgO//yh9osII8LHrZ/VBC6qasGm5Yu4hMwqGKVPHorcH\r\n2uopgMTAKy/q5bPtZBlHT0m1xltu7du1WozjIdBSB4Mddg5HMIh+UT5MM6Re\r\nJi5rOlgRtE8NcjNLyqrDOgMoJfDLWFskFqt2DPZn5v+wWpNPLcZlzic7UzLj\r\nfrgX0M5ln0OQnnq6Q+bPeU3m3ZbAEmQPDzYVjvyJYlfq23oI4tO7zlbXPbeq\r\nFypXiHbUhYm9866vWnWthTI/MsoCw4OMKfE+JAKQi+rGnCKXYNURQGgOyd2o\r\nX7dm8joCkVmLH3weeFjRoqb9Hbd2NEABl4aDI9N4RS9VrPwJckxJqWrWDBH0\r\nDfL1ooVXSR+yuDHvA5vSsCqIzIjZT5J4cs1IzyazAJicgeUF/HO9UCSRFygu\r\nMMkG/ZRKBGV5vWwiSx5VzFX/6OYQTyWZFIvAYtsFj/ifXt5qSiTGlVeo1UyX\r\n2hYZD+9wio0Bf0yZbmhT09a8wct+8ja7iE8TLJjHbhK/BlR49gMwgfHDgbDL\r\nfsoIrBdJPzKiH9jQ2TY+s25rkhZsPLbEfH8=\r\n=VCfM\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.2_1667386976047_0.5389825812432456"},"_hasShrinkwrap":false},"2.0.3":{"name":"speedybot-mini","version":"2.0.3","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"dist:example":"tee examples/websockets/settings/config.ts examples/express-incoming-webhook/settings/config.ts examples/worker/settings/config.ts examples/aws-lambda/services/functions/config.ts < settings/config.ts >/dev/null","save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm run build && npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs && npm run dist:example","build:lite":"tsc && npm link && npm run dev","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","gitHead":"6f69d97b379ff30dcd2b4f2ea639aee964b86bbe","description":"","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.3","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-eyfREYz6VPCh2tZbF4ti4F+qPqQ7u9N6z0Yj41nsiVln5aP/mXDRUBDqPApCZzi3skA2tzXC7bMwYGti8RLnOA==","shasum":"c96579c800ecfa6d76c92000395f1c63d902d6bb","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.3.tgz","fileCount":32,"unpackedSize":302057,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCL+16DHdWtxIXbH0wb5kFKSvM+J6mpXWAgTp8LtKPweQIgaI3SEr7DXvoeQotcUGHUjVY7OJfAbjPUVkyijvHlePU="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjcFnTACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoUiQ//RNVAAUUUDskl1KjgPXlNFp/vCFKNqEK2WYBzJCCm4DCEZVOc\r\nERgkjIhoHqykQV65mJgWIvrxlskJb8UkWKwRHnuS6O4pLyf4W433CKOFKsD0\r\nm19ogjN81ILFZKWjypH8D+gA8R/2i3ndNxr4I++3//5Sn7wirxqosvsVAg81\r\nza6gdkCZhxcSHXLlg96+gwKlAkH/z1lXzJX/JickFcQ0I7i2I6iR4bvqdGCg\r\n2cX1Y1IFF6xBl87SIc+kZGQw5VlBPh8OdYSXtfQ+ft1C5OkUhEDajySiAY5i\r\nFbP8elKHld8nDNSsAL+NpbHvjNz8i4grKUV1bjJUQ6OXk8QnPBgErO9wSRK1\r\nrGotu6PGQ5b6x9uF9kcwIqIDZRDzsFRB2WoL4EEf8Ah9hr5B9FxXDBfdK/To\r\nwORWixMvhtndogKS/Z+yOAL02cwVyEgDbOW6hgKYwd/GmQbDDw37vKPcCdNf\r\nfSiGuzROAyxLZwp2Ct29zvjCmhoRsKWrE8iYtxsBLRNDdgZEEMxGXfa3w/FW\r\n7n8JQXZa7sFpxXM91IowSM0+q3OY6orIvH1sVLETAE8sZSVw3WTrM5F5se54\r\nwexZLSvbk1xIDCkTJSRJg+Z65j2Xu1iOk4L1OlNzcfkyoY/WOMt+TzaCFDij\r\nZI0XNunIADSoG+PREw3VqnWJFB544Xmz73k=\r\n=DVPm\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.3_1668307410858_0.17827496653705888"},"_hasShrinkwrap":false},"2.0.4":{"name":"speedybot-mini","version":"2.0.4","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"dist:example":"tee examples/websockets/settings/config.ts examples/express-incoming-webhook/settings/config.ts examples/worker/settings/config.ts examples/aws-lambda/services/functions/config.ts < settings/config.ts >/dev/null","save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","publish:beta":"npm run build && npm publish --tag beta","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","build":"npm test && tsc && npm run docs && npm run dist:example","build:lite":"tsc && npm link && npm run dev","test":"jest","dev":"tsnd --respawn --watch src/lib, src/lib/index"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","gitHead":"b910d334245ac8b47e28440cf2695f1c4693d05e","description":"","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.4","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-RyFhPWRm5Ht5IPN7z+4PhKPz+dBZj3Ft3eSqI25BwV7CnUoMtXxbbnthkp+dbsWNVVIz7M2q9uG/4DnaTeb3XQ==","shasum":"a16334dc58b12f4235472e6d0ff2e02a3866412e","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.4.tgz","fileCount":32,"unpackedSize":302109,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDHKJ5KEnkK92a4YTOlhFo2OmfrKHbW0fS3RIo69sy4jgIhAMdOMZVxSH8QJR+cSqMrdWzuuqnB+2OYRl4cnr6fBk/R"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjcFpPACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmrh6A//f2iYnqDI5nRGr/apjOBi8yV+sNppDWj0vJo9U8YaTKdRtDPg\r\nE8XvKpxq3LyuyISuLkr821iKOpLHREDMW9bbctJZzQCruD0/OqCHU5D6i8rs\r\nWrrWU02cA5E+9ayKKFERJ7n5c9CRaWEQRRF3ElRjT+XGPM5hqFEAHUQvSZnE\r\nbFWKKW36KOdjCF3va7UxE0sImSG+kDdNIS3r09ZOmkjGBAFriTuFxLuS2gQx\r\n6jQEG9WMe1OY+zyInZCSzXvgk5C0Ti51am6yaj9pjXTQMTPNwcxH1+GMZlQK\r\nj34tqZbo04w543fl0F55ZiNPa/Onq+TJi+8n2i5U/OTj9CCSJUn3lGXUu3lL\r\nnnbB5BR0lO8V7evIqizxiEY9q3DvWvDMf/J0D7YKC239wPNHUpApVZBGpWc8\r\nRrcF6JMajE4YJYafHaXOJWEdziOgixZ1VOIe2bT8V9I3iPUQvqrkcXKLYWwv\r\nvOqw9oHb1chgnI/zcmuWdTlKnH+paHSy3qvE8h1fqBO73TtvGD4elDXejyy0\r\nfols4mGhp0Jcx1TofZXU5HUJOZWQ+hU4iBdOVrXf3GAW6bJxZkxYFm/jgclC\r\nhIXtGk524IkEDttT5d4W3ceMzcY4XepXRPC2iDDnGVLqMXftn8DH4cwj25nI\r\nFAPf4ydsWMYTxQkBW6tPjeHUBZN3udMb/LA=\r\n=EDEO\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.4_1668307535253_0.9113567252505959"},"_hasShrinkwrap":false},"2.0.5":{"name":"speedybot-mini","version":"2.0.5","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"build":"npm test && tsc && npm run docs && npm run dist:example","build:lite":"tsc && npm link && npm run dev","dev:active":"npm link && npm run build:lite","dist:example":"tee examples/websockets/settings/config.ts examples/express-incoming-webhook/settings/config.ts examples/worker/settings/config.ts examples/aws-lambda/services/functions/config.ts < settings/config.ts >/dev/null","dev":"tsnd --respawn --watch src/lib, src/lib/index","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","publish:beta":"npm run build && npm publish --tag beta","save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","test":"jest"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","gitHead":"752c81781a7bce53134bed73114f26904ed7c2f5","description":"","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.5","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-4izuAz/J82Mdp4DlNE5Nkcy538sKSHB2hi+qmXiIZl0ASwE5MFg7HFVRyA7vVFxLlwfSF+1bbrRFp0mPe8y/yA==","shasum":"d4f04fe0fef592697f55f174034b890189e59d44","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.5.tgz","fileCount":32,"unpackedSize":302283,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEZsSjLkliKUckQ5CT1vfLItEne2d4DuWKwVTjNYluvfAiBuPaQTUQ13cmYr9StG/Fv797CbBTUPDebyUPPVRJ7T7A=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjcQ1OACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqBTw/7BMGEieoWPvSShsxm6I3PJcDeLUXpD/5xdmgG7dKoyzdaObx0\r\nRdbAKxdee0nmRLAn5cfq3aVoKrA7avRazfJi7I5ZC3ujFGV8SbYaFObEU7P0\r\nLuVlqPPwDOflrcJxd5iU+yIaLUDJ47/ARMNZAYOpsJySVpI11XQtl1Z3eDDv\r\n8QCRvjtXlzlMSG5zaDYJsXSVIxSn+YLTQs06IwLJ+YJppEjRM3Ap+SPolzTR\r\nfDls2Ph60pZSe3BfDtadJA40Jq1jc4BRBTPs4hXu0gx5KtRdyglUvX0MMWgS\r\njD4ZcnwpYgX4ULx8g1KoVYQL0AIppn3QRgY71Yj/XZz3mXWCJWVp7BuArN9v\r\ns047XezN/Vj/rFTmAPoodfRki5U440FqhCayoR5zAcPZC44cuqDYHCAhkX99\r\noGSM/7TrK2tI3Rkad9fuPPbMX4xuWwuN2Pa8EDaQ0GYAACA2L1zqLfZYIQa3\r\n+lJ48DExDm2J6v0CIpuEKO5opRT+0lZfMNvuF7EjB4okREQ21kNQBh29oO2h\r\nSYJ53/P5SXOpLfo7TIWFqZ8WB1Fs0OkLoICI8/bFnFaBh20uqcTo8Ox9kdb2\r\n9TLaJtDelNWnhLik2e+twZwKcq6ZP83qkOV0pEqkOBTU5mXGN6omjAurUwsc\r\nEwEtGG8DB6cbYr5uyuCD+Hpb8PjoPorzLuI=\r\n=gcGG\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.5_1668353358270_0.9962980844525886"},"_hasShrinkwrap":false},"2.0.0-beta.8":{"name":"speedybot-mini","version":"2.0.0-beta.8","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"build":"npm test && tsc && npm run docs && npm run dist:example","build:lite":"tsc && npm link && npm run dev","dev:active":"npm link && npm run build:lite","dist:example":"tee examples/websockets/settings/config.ts examples/express-incoming-webhook/settings/config.ts examples/worker/settings/config.ts examples/aws-lambda/services/functions/config.ts < settings/config.ts >/dev/null","dev":"tsnd --respawn --watch src/lib, src/lib/index","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","publish:beta":"npm run build && npm publish --tag beta","save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","test":"jest","stamp:beta":"npm version 2.0.0-beta.08"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","readme":"\n\n## Speedybot-mini\n\nSpeedybot is a tool to take you from zero to a user-valuable bot as quickly as possible w/ a buttery-smooth developer experience. In short, Speedybot lets you focus on the stuff that actually matters-- content and powerful integrations.\n\nIf you're in a hurry, see the **[quickstarts](#quickstarts)** to get up and running fast on a variety of infrastructure (websockets, server, serverless, container-less, etc).\n\n- š Zero External Dependencies š\n- Adds support **[tappable suggestion \"chips\"](#chips)**\n- Includes **[SpeedyCard card builder](#speedycard)** (create rich **[Adaptive Cards](https://developer.webex.com/docs/api/guides/cards)** without wrangling JSON)\n- Lots of handy utilities for things like **[alerts, cards, files, and more](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/BotInst.md#methods)**\n- Locale & i18n support\n- Runs on virtually any infrastructure-- servers, V8 isolates, containers, container-less, edge, etc\n\nThe era of manually writing \"handlers\" or matching text with RegEx's is coming to an end (though Speedybot has several trick to make writing those easier). In the future, there will be far fewer \"keyword\" handlers and instead deeper integration with 3rd-party conversation services like **[Voiceflow](https://www.voiceflow.com/)**, **[Amazon Lex](https://aws.amazon.com/lex/)**, **[DialogFlow](https://cloud.google.com/dialogflow/docs)** and Speedybot can help make that transition as smooth as possible\n\n## Quickstarts\n\nYou can get up and running FAST with Speedybot. Speedybot can run on a variety of architectures and environments\n\n- **[speedybot garage š§š¤, manage webhooks/secrets/admin](https://codepen.io/valgaze/pen/MWVjEZV)**\n\n- š **[API Docs](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes)**\n\n| Platform | Needs server? | Needs webhooks? |\n| --------------------------------------------------------------------------------------------------------------------------------- | ------------- | --------------- |\n| **[š Deploy with websockets](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/websockets)** | ā | ā |\n| **[š» Deploy to Simple Express Server](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/express-incoming-webhook)** | ā
| ā
|\n| **[Ī» Deploy to AWS Lamda](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/aws-lambda)** | ā | ā
|\n| **[š„ Deploy to Worker](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/worker)** | ā | ā
|\n| **[š¦ Deploy to Deno](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/deno)** | ā | ā
|\n\n## Syntax\n\n```sh\nnpm install speedybot-mini\n```\n\n**[See starter bot](https://github.com/valgaze/speedybot-mini/blob/deploy/settings/config.ts)**\n\n## How to make a bot\n\n## Keywords\n\nSpeedybot is made up of \"handlers\" that trigger based on special conditions-- depending on your needs you'll probably need only one or two in your project\n\n| Keyword | Description |\n| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **[.contains](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#contains)** | This will match if a trigger phrase is the 1st or only word in a message sent from a user |\n| **[.fuzzy](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#fuzzy)** | This will match if a trigger phrase exists _anywhere_ inside a message sent from the user |\n| **[.exact](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#exact)** | This will match if a trigger phrase is exactly (case-sensitve) a message sent from a user |\n| **[.fuzzy](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#regex)** | This will match if a message sent from a user passes the regex |\n| **[.every](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#every)** | This will match on every message from a user |\n| **[.nlu](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#nlu)** | This will match on every message from a user except if the trigger phrase is used by hard-coded handler, designed for use with natural language systems |\n| **[.onSubmit](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#onSubmit)** | This will trigger when data is sent from an **[](https://developer.webex.com/docs/api/guides/cards)** |\n| **[.onFile](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#onFile)** | This will trigger every time a file is sent to the agent and will provide file meta data |\n| **[.onCamera](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#onCamera)** | This will trigger every time an image file sent to the agent |\n| **[.noMatch](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#noMatch)** | This will trigger if there are no registered handlers for the user's text |\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bpt\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n\n
\n\nSee the main **[sample for all you can do](./settings/config.ts)**, but here's how you could make a simple agent\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bot\nexport default CultureBot;\n\n// 3) Do whatever you want!\n\n// Match handlers based on user input\nCultureBot.contains([\"hi\", \"yo\", \"hola\"], async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n $bot.send(\n $bot\n .card({\n title: `Hi ${msg.author.displayName}!`,\n subTitle: `Glad to have you here, you said ${msg.text}`,\n chips: [\"ping\", \"pong\"],\n })\n .setInput(`What's on your mind?`)\n );\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch, etc\n\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}'`);\n});\n```\n\nThere's much more, see this **[sample for all you can do](./settings/config.ts)**\n\n## SpeedyCard\n\nex. Tell the bot \"sendcard\" to get a card, type into the card & tap submit, catch submission using _<@submit>_ and echo back to user.\n\n- Getting started with AdaptiveCards (https://developer.webex.com/docs/api/guides/cards) can be a bit cumbersome and error-prone\n\n- SpeedyCard is a limited subset of AdaptiveCards with basic features with a focus on user interaction & simplicity (title, text, input box, menu-select, no \"collapsable\" sections, etc)\n\n- Inspired a bit by SwiftUI: https://developer.apple.com/xcode/swiftui/\n\n\n\nNote on Precedence
\n\nRule: the 1st registered handler will match in the event of a conflict\n\nEx. Below since it was set first, fuzzy will take precedence over `contains`\n\n```ts\nimport { Speedybot, Config } from \"speedybot-mini\";\n\nconst botConfig: Config = {\n token: \"__REPLACE__ME__\",\n};\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\nCultureBot.fuzzy(\"hi\", ($bot, msg) => {\n $bot.send(\"Fuzzy launched\");\n});\n\nCultureBot.contains(\"hi\", ($bot, msg) => {\n $bot.send(\"Contains launched\");\n});\n```\n\n\n
\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bot\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n
\n\n## Credits/Attribution\n\n- Cookie image courtesy of Daniel Lopez: https://unsplash.com/photos/aT7CE57EZL8 & https://unsplash.com/@soydanielwolf\n","readmeFilename":"README.md","gitHead":"960d1cd061d850fd322adad28ee09d3888a30a64","description":"","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.0-beta.8","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-ma813U4fXbofqwo/i03/9mwQf79+4cXm3o7uBjeMrfH0yl2gh28acHf0g/FSsHA0OpKm+Hb9SoaSWuBjizmP/Q==","shasum":"6999e9aefa303d81f2443f17571245c4ac8456e0","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.0-beta.8.tgz","fileCount":36,"unpackedSize":307135,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGv3soQSJqpxcRwFKltzLlFWU7ZTAl8sA0BeMV3iKGhMAiEAhFgqvgkiolsMfJlgU0uqVgA4zqZhbHq1N3Jdx5lJTDA="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjszy6ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmr6mw/+ITUT2u6eXJqlqnDNJPg6WamyTnqwuPXphblCh+yG+vEj7ojg\r\nK/R8xzcjXABXman0gNRcNIZ48h4kjcLgK8dvrWIbLeWW+fKFkJcApyo72Edi\r\nF06J27gheGY6Cm8/9OwLeroPBvmrl2gpNvhbsEL1dLlwnCztlfBDxNzp6yPK\r\nJ/BaZ55jkZckVix+yrbppwiwr4Ia4UAPndDDqGnI8VfJJnL9t6VCr/V/sQYH\r\n6d5ugU6oOxTy8DHWgVcwn4c3WWBOrVXV1rypa1RF6/1i4Qs04OGQz65BzxZU\r\npUDRZCiZDSOtDSN5HSut0RwZs0uVg1gTPBNjEtEqH5+TxKUIms67hdakP4y0\r\nDSxtuee2ieq66VziBAkrUEBa7aQQTAiAaCTtcReHaEG3LauL3X1+wWgEDOYr\r\nFDRkqoXhPNcP4edGpABvFDQlmCz2CkaaU/lUAtTvwvRbAXa1S3PH3Ge+24qD\r\nwc0o3djEm2Lw+X1lzsy2vmYK+3JW9+4aVA27FPJKG6NkcomSol6OVlBHEGrF\r\niFZEcxh2uvsSABQ08w9OLPHLOkzKGhtqeZo1yF96tNtYMlHHLjNgpeiXcU2G\r\nzL4PawlRtdRYij8u/rYbjTB+wRwQ6iQfnHeJP0uB/HyiiWYZsA7f/V9Ky5pd\r\nTEwikvjHal6u/eugzUT456wn7SBPO0dgJOc=\r\n=zVkA\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.0-beta.8_1672690874348_0.04263782428235352"},"_hasShrinkwrap":false},"2.0.6-beta.1":{"name":"speedybot-mini","version":"2.0.6-beta.1","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"build":"npm test && tsc && npm run docs && npm run dist:example","build:lite":"tsc && npm link && npm run dev","dev:active":"npm link && npm run build:lite","dist:example":"tee examples/websockets/settings/config.ts examples/express-incoming-webhook/settings/config.ts examples/worker/settings/config.ts examples/aws-lambda/services/functions/config.ts < settings/config.ts >/dev/null","dev":"tsnd --respawn --watch src/lib, src/lib/index","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","publish:beta":"npm run build && npm publish --tag beta","save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","test":"jest","stamp:beta":"npm version 2.0.0-beta.08"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","readme":"\n\n## Speedybot-mini\n\nSpeedybot is a tool to take you from zero to a user-valuable bot as quickly as possible w/ a buttery-smooth developer experience. In short, Speedybot lets you focus on the stuff that actually matters-- content and powerful integrations.\n\nIf you're in a hurry, see the **[quickstarts](#quickstarts)** to get up and running fast on a variety of infrastructure (websockets, server, serverless, container-less, etc).\n\n- š Zero External Dependencies š\n- Adds support **[tappable suggestion \"chips\"](#chips)**\n- Includes **[SpeedyCard card builder](#speedycard)** (create rich **[Adaptive Cards](https://developer.webex.com/docs/api/guides/cards)** without wrangling JSON)\n- Lots of handy utilities for things like **[alerts, cards, files, and more](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/BotInst.md#methods)**\n- Locale & i18n support\n- Runs on virtually any infrastructure-- servers, V8 isolates, containers, container-less, edge, etc\n\nThe era of manually writing \"handlers\" or matching text with RegEx's is coming to an end (though Speedybot has several trick to make writing those easier). In the future, there will be far fewer \"keyword\" handlers and instead deeper integration with 3rd-party conversation services like **[Voiceflow](https://www.voiceflow.com/)**, **[Amazon Lex](https://aws.amazon.com/lex/)**, **[DialogFlow](https://cloud.google.com/dialogflow/docs)** and Speedybot can help make that transition as smooth as possible\n\n## Quickstarts\n\nYou can get up and running FAST with Speedybot. Speedybot can run on a variety of architectures and environments\n\n- **[speedybot garage š§š¤, manage webhooks/secrets/admin](https://codepen.io/valgaze/pen/MWVjEZV)**\n\n- š **[API Docs](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/modules.md#classes)**\n\n| Platform | Needs server? | Needs webhooks? |\n| --------------------------------------------------------------------------------------------------------------------------------- | ------------- | --------------- |\n| **[š Deploy with websockets](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/websockets)** | ā | ā |\n| **[š» Deploy to Simple Express Server](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/express-incoming-webhook)** | ā
| ā
|\n| **[Ī» Deploy to AWS Lamda](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/aws-lambda)** | ā | ā
|\n| **[š„ Deploy to Worker](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/worker)** | ā | ā
|\n| **[š¦ Deploy to Deno](https://github.com/valgaze/speedybot-mini/tree/deploy/examples/deno)** | ā | ā
|\n\n## Syntax\n\n```sh\nnpm install speedybot-mini\n```\n\n**[See starter bot](https://github.com/valgaze/speedybot-mini/blob/deploy/settings/config.ts)**\n\n## How to make a bot\n\n## Keywords\n\nSpeedybot is made up of \"handlers\" that trigger based on special conditions-- depending on your needs you'll probably need only one or two in your project\n\n| Keyword | Description |\n| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **[.contains](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#contains)** | This will match if a trigger phrase is the 1st or only word in a message sent from a user |\n| **[.fuzzy](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#fuzzy)** | This will match if a trigger phrase exists _anywhere_ inside a message sent from the user |\n| **[.exact](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#exact)** | This will match if a trigger phrase is exactly (case-sensitve) a message sent from a user |\n| **[.fuzzy](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#regex)** | This will match if a message sent from a user passes the regex |\n| **[.every](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#every)** | This will match on every message from a user |\n| **[.nlu](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#nlu)** | This will match on every message from a user except if the trigger phrase is used by hard-coded handler, designed for use with natural language systems |\n| **[.onSubmit](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#onSubmit)** | This will trigger when data is sent from an **[](https://developer.webex.com/docs/api/guides/cards)** |\n| **[.onFile](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#onFile)** | This will trigger every time a file is sent to the agent and will provide file meta data |\n| **[.onCamera](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#onCamera)** | This will trigger every time an image file sent to the agent |\n| **[.noMatch](https://github.com/valgaze/speedybot-mini/blob/deploy/api-docs/classes/Speedybot.md#noMatch)** | This will trigger if there are no registered handlers for the user's text |\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bot\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n\n
\n\nSee the main **[sample for all you can do](./settings/config.ts)**, but here's how you could make a simple agent\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bot\nexport default CultureBot;\n\n// 3) Do whatever you want!\n\n// Match handlers based on user input\nCultureBot.contains([\"hi\", \"yo\", \"hola\"], async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n $bot.send(\n $bot\n .card({\n title: `Hi ${msg.author.displayName}!`,\n subTitle: `Glad to have you here, you said ${msg.text}`,\n chips: [\"ping\", \"pong\"],\n })\n .setInput(`What's on your mind?`)\n );\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch, etc\n\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}'`);\n});\n```\n\nThere's much more, see this **[sample for all you can do](./settings/config.ts)**\n\n## SpeedyCard\n\nex. Tell the bot \"sendcard\" to get a card, type into the card & tap submit, catch submission using _<@submit>_ and echo back to user.\n\n- Getting started with AdaptiveCards (https://developer.webex.com/docs/api/guides/cards) can be a bit cumbersome and error-prone\n\n- SpeedyCard is a limited subset of AdaptiveCards with basic features with a focus on user interaction & simplicity (title, text, input box, menu-select, no \"collapsable\" sections, etc)\n\n- Inspired a bit by SwiftUI: https://developer.apple.com/xcode/swiftui/\n\n\n\nNote on Precedence
\n\nRule: the 1st registered handler will match in the event of a conflict\n\nEx. Below since it was set first, fuzzy will take precedence over `contains`\n\n```ts\nimport { Speedybot, Config } from \"speedybot-mini\";\n\nconst botConfig: Config = {\n token: \"__REPLACE__ME__\",\n};\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\nCultureBot.fuzzy(\"hi\", ($bot, msg) => {\n $bot.send(\"Fuzzy launched\");\n});\n\nCultureBot.contains(\"hi\", ($bot, msg) => {\n $bot.send(\"Contains launched\");\n});\n```\n\n\n
\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bot\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n
\n\n## Credits/Attribution\n\n- Cookie image courtesy of Daniel Lopez: https://unsplash.com/photos/aT7CE57EZL8 & https://unsplash.com/@soydanielwolf\n","readmeFilename":"README.md","gitHead":"f2a399c993020f85b7cd0824dd392d171a6280de","description":"","bugs":{"url":"https://github.com/valgaze/speedybot/issues"},"homepage":"https://github.com/valgaze/speedybot#readme","_id":"speedybot-mini@2.0.6-beta.1","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-upX2e9enIbTJ7QNLpu46xZZGqLOh75RMCMudwIbw7E1kKK3Lp0CCA5lN5mEeQ4ZIadn2LO3ChrVx6i9Ql4uRgw==","shasum":"db1a5b053bfa53dbb48c92daa24ccbc657c2375b","tarball":"https://registry.npmjs.org/speedybot-mini/-/speedybot-mini-2.0.6-beta.1.tgz","fileCount":36,"unpackedSize":307417,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDVmqv8BaO6w/aT+VS266CqufOERNFjDen2Sizn5nXAEwIhAPgTBz0anrMVP1lc2qeJM7lTuQxSEKf+HRf/fB6lUf4A"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjsz/NACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq93hAAiAnnw/lJUqZKj1tvDAoVKdJGnSeKVsOvHGInsExLIUdfc1RP\r\nXok1KlAYqgHVA6c1UW1ITYoVoatlJJyroRnVxZgOVRDzjMpBsp9dw4n0IAPT\r\ng57TC6B8C1ZjVe6OKV0msA46h0rlpPdi2lZWi3n7Sy+YNFyuNd/f/IsaEkyJ\r\n5/7YQOFMlPfZA2E1wWyoN/Gx6PcMG/2rDu6qsY21BZJjv6ePlIx3NtEqAdr9\r\nAr74laaxLKJOYYLNhnP9FLuak5E+wqB+75I9hnBF7f+QWIA0366iiVE3ZE87\r\n3YryPcJER1lqI6pIvbU+/fbQ0j7IO++cC6PDD0xAWk46gCXBMmQdHjrIgj5n\r\nGBVf0mWo0HdUTbrKp1l0wwGAKJKCj7a5h322ps2q7JrilDHBDtvnm5WcYo5+\r\nFVS2BQc9ji+Tu33QXsz0KXLil2MX54fUu0aog5DmHi9gcCyv0V7c1LShHkyb\r\nZUCsEsOH4/f95EYeh/mFmNKhiQsaCgDpc2U0cF/y+aRhT1JotJBKnKwtq5C/\r\nQeqjKZq+cwWcNQq8Vt1n3DyLj2ULUUSnkDuGCPwVWPQtpLRNXRIFO4JeadfK\r\n5G7uOgiS3v+E9VC/CIU9t7Q5swtotMHstnRiu+HEev+eVgarTCN1CAavEUQp\r\nZPHxviPd/DCBpjJ/G9CviU6x+lxTqIqPHHA=\r\n=HdmS\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"valgaze","email":"valgaze@gmail.com"},"directories":{},"maintainers":[{"name":"valgaze","email":"valgaze@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/speedybot-mini_2.0.6-beta.1_1672691661579_0.9813448947245837"},"_hasShrinkwrap":false},"2.0.6":{"name":"speedybot-mini","version":"2.0.6","main":"dist/src/index.js","types":"dist/src/index.d.ts","devDependencies":{"@types/jest":"^29.1.2","@types/node":"^18.8.4","jest":"^29.2.0","ts-jest":"^29.0.3","ts-node-dev":"^2.0.0","tsx":"^3.10.1","typedoc":"0.22.18","typedoc-plugin-markdown":"3.12.1","typedoc-theme-hierarchy":"1.2.1","typescript":"^4.7.2"},"scripts":{"build":"npm test && tsc && npm run docs && npm run dist:example","build:lite":"tsc && npm link && npm run dev","dev:active":"npm link && npm run build:lite","dist:example":"tee examples/websockets/settings/config.ts examples/express-incoming-webhook/settings/config.ts examples/worker/settings/config.ts examples/aws-lambda/services/functions/config.ts < settings/config.ts >/dev/null","dev":"tsnd --respawn --watch src/lib, src/lib/index","docs":"rm -rf api-docs 2>/dev/null && npx --yes typedoc --media docs/assets --plugin typedoc-plugin-markdown --out api-docs src/docs.ts","publish:beta":"npm run build && npm publish --tag beta","save":"git add . &2.0.0-beta.& git commit -m \"checkpt\" && git push draft deploy","test":"jest"},"engines":{"node":">=18.11.0"},"repository":{"type":"git","url":"git+https://github.com/valgaze/speedybot-mini.git"},"keywords":["bot","scaffold","continerless","speedybot","serverless"],"author":{"name":"valgaze@gmail.com"},"license":"MIT","gitHead":"8973f15bf9bb5a5f99029ee60c9474b27016f0ce","description":"(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bot\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n \n \n \n š API Docs |\n š Quickstarts |\n š¬ Get Help\n \n \n \n š API Docs |\n š Quickstarts |\n š¬ Get Help\n ![\"speedybot-mini\"](\"https://github.com/valgaze/speedybot-mini/raw/deploy/docs/assets/logo.png?raw=true\"){kind=logo}
\n \n\n\n\nSee the main **[sample for all you can do](./settings/config.ts)**, but here's how you could make a simple agent\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bot\nexport default CultureBot;\n\n// 3) Do whatever you want!\n\n// Match handlers based on user input\nCultureBot.contains([\"hi\", \"yo\", \"hola\"], async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n $bot.send(\n $bot\n .card({\n title: `Hi ${msg.author.displayName}!`,\n subTitle: `Glad to have you here, you said ${msg.text}`,\n chips: [\"ping\", \"pong\"],\n })\n .setInput(`What's on your mind?`)\n );\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch, etc\n\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}'`);\n});\n```\n\nThere's much more, see this **[sample for all you can do](./settings/config.ts)**\n\n## SpeedyCard\n\nex. Tell the bot \"sendcard\" to get a card, type into the card & tap submit, catch submission using _<@submit>_ and echo back to user.\n\n- Getting started with AdaptiveCards (https://developer.webex.com/docs/api/guides/cards) can be a bit cumbersome and error-prone\n\n- SpeedyCard is a limited subset of AdaptiveCards with basic features with a focus on user interaction & simplicity (title, text, input box, menu-select, no \"collapsable\" sections, etc)\n\n- Inspired a bit by SwiftUI: https://developer.apple.com/xcode/swiftui/\n\n\n\nNote on Precedence
\n\nRule: the 1st registered handler will match in the event of a conflict\n\nEx. Below since it was set first, fuzzy will take precedence over `contains`\n\n```ts\nimport { Speedybot, Config } from \"speedybot-mini\";\n\nconst botConfig: Config = {\n token: \"__REPLACE__ME__\",\n};\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\nCultureBot.fuzzy(\"hi\", ($bot, msg) => {\n $bot.send(\"Fuzzy launched\");\n});\n\nCultureBot.contains(\"hi\", ($bot, msg) => {\n $bot.send(\"Contains launched\");\n});\n```\n\n\n\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bot\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n\n\n## Credits/Attribution\n\n- Cookie image courtesy of Daniel Lopez: https://unsplash.com/photos/aT7CE57EZL8 & https://unsplash.com/@soydanielwolf\n","readmeFilename":"README.md","gitHead":"849c461124ad5f6790eec907d8b1757ee4ca1770","description":"(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bot\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n \n \n\n\n\nSee the main **[sample for all you can do](./settings/config.ts)**, but here's how you could make a simple agent\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bot\nexport default CultureBot;\n\n// 3) Do whatever you want!\n\n// Match handlers based on user input\nCultureBot.contains([\"hi\", \"yo\", \"hola\"], async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n $bot.send(\n $bot\n .card({\n title: `Hi ${msg.author.displayName}!`,\n subTitle: `Glad to have you here, you said ${msg.text}`,\n chips: [\"ping\", \"pong\"],\n })\n .setInput(`What's on your mind?`)\n );\n});\n\n// Can also do Regex's\nCultureBot.regex(new RegExp(\"x\"), ($bot, msg) => {\n $bot.send(`Regex matched on this text: ${msg.text}`);\n});\n\n// Special keywords: .onSubmit, .onFile, .onCamera, .every, .noMatch, etc\n\n// Handle AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// Runs on file upload, can pass bytes to 3rd-party service\nCultureBot.onFile(async ($bot, msg, fileData) => {\n $bot.send(`You uploaded '${fileData.fileName}'`);\n $bot.send(`snip: ${fileData.markdownSnippet}`);\n $bot.send(fileData.data);\n}).config({ matchText: true });\n\n// Runs on EVERY input, kinda like middleware\n// This is where you would interact with an NLU service like DialogFlow, Amazon Lex, Voiceflow, etc\nCultureBot.every(async ($bot, msg) => {\n const { text } = msg;\n $bot.log(`.every handler ran with this text: '${text}'`);\n}).config({\n skipList: [\"$clear\"],\n});\n\n// If no matched handlers\nCultureBot.noMatch(($bot, msg) => {\n $bot.say(`Bummer, there was no matching handler for '${msg.text}'`);\n});\n```\n\nThere's much more, see this **[sample for all you can do](./settings/config.ts)**\n\n## SpeedyCard\n\nex. Tell the bot \"sendcard\" to get a card, type into the card & tap submit, catch submission using _<@submit>_ and echo back to user.\n\n- Getting started with AdaptiveCards (https://developer.webex.com/docs/api/guides/cards) can be a bit cumbersome and error-prone\n\n- SpeedyCard is a limited subset of AdaptiveCards with basic features with a focus on user interaction & simplicity (title, text, input box, menu-select, no \"collapsable\" sections, etc)\n\n- Inspired a bit by SwiftUI: https://developer.apple.com/xcode/swiftui/\n\n\n\nNote on Precedence
\n\nRule: the 1st registered handler will match in the event of a conflict\n\nEx. Below since it was set first, fuzzy will take precedence over `contains`\n\n```ts\nimport { Speedybot, Config } from \"speedybot-mini\";\n\nconst botConfig: Config = {\n token: \"__REPLACE__ME__\",\n};\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\nCultureBot.fuzzy(\"hi\", ($bot, msg) => {\n $bot.send(\"Fuzzy launched\");\n});\n\nCultureBot.contains(\"hi\", ($bot, msg) => {\n $bot.send(\"Contains launched\");\n});\n```\n\n\n\n\n## Chips\n\nex. Tell the bot \"chips\" to get a card with tappable \"chips\"\n\n\n\n(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bot\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\n// send a card\n\nCultureBot.contains(\"sendcard\", async ($bot, msg) => {\n const cardPayload = $bot\n .card()\n .setTitle(\"System is š\")\n .setSubtitle(\"If you see this card, everything is working\")\n .setImage(\"https://i.imgur.com/SW78JRd.jpg\")\n .setInput(`What's on your mind?`)\n .setTable([[`Bot's Time`, new Date().toTimeString()]])\n .setData({ mySpecialData: { a: 1, b: 2 } })\n .setUrl(\n \"https://www.youtube.com/watch?v=3GwjfUFyY6M\",\n \"Take a moment to celebrate\"\n );\n});\n```\n\n\n\n\n## Credits/Attribution\n\n- Cookie image courtesy of Daniel Lopez: https://unsplash.com/photos/aT7CE57EZL8 & https://unsplash.com/@soydanielwolf\n","readmeFilename":"README.md","gitHead":"894d83d47e979a94a6531eed3ea13cc0b9f5401a","description":"(Tap to see code)
\n\n```ts\nimport { Speedybot } from \"speedybot-mini\";\n\n// In a production environment use a secrets manager to pass in token\n// Get a token: https://developer.webex.com/my-apps/new/bot\nconst botConfig = { token: \"__REPLACE__ME__\" };\n\n// 1) Initialize your bot w/ config\nconst CultureBot = new Speedybot(botConfig);\n\n// 2) Export your bot\nexport default CultureBot;\n\n// 3) Do whatever you want!\n// Match handlers based on user input like\nCultureBot.contains(\"hi\", async ($bot, msg) => {\n $bot.send(`You said '${msg.text}', ${msg.author.displayName}!`);\n});\n\n// Handle/capture AdpativeCard submissions (non-chip submission)\nCultureBot.onSubmit(($bot, msg) => {\n $bot.send(`You submitted ${JSON.stringify(msg.data.inputs)}`);\n});\n\nCultureBot.contains([\"ping\", \"pong\"], ($bot, msg) => {\n const { text } = msg;\n if (text === \"ping\") {\n $bot.send(\"pong\");\n } else if (text === \"pong\") {\n $bot.send(\"ping\");\n }\n});\n\n// send a card with tappable chips\n\nCultureBot.contains(\"chips\", async ($bot, msg) => {\n $bot.send(\n $bot\n .card()\n .setChips([\n \"hey\",\n \"ping\",\n { label: \"say the phrase pong\", keyword: \"pong\" },\n ])\n );\n});\n```\n\n