{"_id":"@amityco/amityeko-bot-messenger","_rev":"15-6df5e3e2e5867344e40ef9d91a7ce7d0","name":"@amityco/amityeko-bot-messenger","dist-tags":{"latest":"2.1.0"},"versions":{"2.0.1":{"name":"@amityco/amityeko-bot-messenger","version":"2.0.1","keywords":["github","actions","amity","eko","amityeko","ekoapp"],"author":{"name":"Julien Barbay"},"license":"MIT","_id":"@amityco/amityeko-bot-messenger@2.0.1","maintainers":[{"name":"phatcharawadi","email":"phatcharawadi@amity.co"},{"name":"ekoapp","email":"developers@amity.co"}],"homepage":"https://github.com/AmityCo/amityeko-bot-messenger#readme","bugs":{"url":"https://github.com/AmityCo/amityeko-bot-messenger/issues"},"bin":{"aem":"bin/index.js"},"dist":{"shasum":"fbfa8cbda2209c1aeadfd5c73b91e253d0ecbd49","tarball":"https://registry.npmjs.org/@amityco/amityeko-bot-messenger/-/amityeko-bot-messenger-2.0.1.tgz","fileCount":15,"integrity":"sha512-8rgx7y7IaJxPZAANwIcyyi7OcQp62uS1lmbUx2iYxfSLtCNeZCG/3lbka9xD2HReaqrSwYKyhDio1Y4SVKHsHw==","signatures":[{"sig":"MEUCIQDAdPUHxR8RyzcKaPzAevLZvaW8Rtwy3rHSZp0Ru87oxgIgAQVW4/+S6tc2RrYUTyEwhJ0HR1qZt4EF2eHRiXBL3Uc=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":696108,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh19TvCRA9TVsSAnZWagAAp2gP/ion1L8pYNIFMuql1qrL\nSqygDCrRz22ujQhV/rFpt8DpUNYeBec2yhTr4NTxPLMk4KJcyrmqjBznBxDf\nUCBUZpD1EVW+hzyH4migeW2lpcrix2FlOLuFjomQ8MDgvr4FeXCyeyL52r2j\n/RANbeQRQ1k5vn4LII8DxZxHSeEe3AX1bUtxTuV5OPOCOS7l2xIyGPL33906\nal5MMs0X+4Zl56o5LuPmCgdHzpIFeO+PwVNXTQ/XVrChA32FQWUK82qB5w5I\n/H20BqR+SVs4plQJX1NUn/wNrNqrwDDKQBLqIJftXCJq9biQjD3UBOrHP7DN\nRobkKBVROXikd4ai2A2CIo2Qqyo4FBpa7i8VOUqW87EDu8Mi4zwToOLujJ6c\nEeZcSR5qYmBiNiFiP5OSEKxhZzdtrR/yy9fruJ07LQCjUDoY0A7KAZEAT7Nc\nZYKlLbpQ9Ce9zBRQichilnPK4vfsgz9IDYAjMQ2TYSF9lWRuWzQ613BxxWkk\nrwm89sgszam6HbdJXj2bAcyvTwbqglkr8+X/Y7HyP9Xy577+J7xP04/Hy8fd\nSHVHkQ/L+qtmOtYqpj07qXZSMBVN4o/VTGA6wvuel5KipVgOlNRzaTEVvjSj\n9aw7DbteUHYj/Vxq8aRt+yqa/ag8lwuP8jzmRpQjXd9s7108+2IM+n9kRK68\nJs7l\r\n=AXXx\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"04ef118c25cb5a080913c5352159289204853196","scripts":{"build":"esbuild action.js --bundle --platform=node --outfile=dist/index.js","version":"npm run build && git add dist/ && npm run changelog","changelog":"auto-changelog --config ./.autochangelog/config.json && git add CHANGELOG.md","postversion":"git push --follow-tags"},"_npmUser":{"name":"ekoapp","email":"developers@amity.co"},"repository":{"url":"git+https://github.com/AmityCo/amityeko-bot-messenger.git","type":"git"},"_npmVersion":"6.14.15","description":"A simple github action to send a message to AmityEko's app","directories":{},"_nodeVersion":"12.22.8","dependencies":{"axios":"^0.24.0","@actions/core":"^1.6.0","@actions/github":"^5.0.0"},"_hasShrinkwrap":false,"devDependencies":{"yargs":"^17.3.1","esbuild":"^0.13.8","auto-changelog":"^2.3.0","rc-config-loader":"^4.0.0"},"_npmOperationalInternal":{"tmp":"tmp/amityeko-bot-messenger_2.0.1_1641534702886_0.2268205564296255","host":"s3://npm-registry-packages"}},"2.0.2":{"name":"@amityco/amityeko-bot-messenger","version":"2.0.2","keywords":["github","actions","amity","eko","amityeko","ekoapp"],"author":{"name":"Julien Barbay"},"license":"MIT","_id":"@amityco/amityeko-bot-messenger@2.0.2","maintainers":[{"name":"phatcharawadi","email":"phatcharawadi@amity.co"},{"name":"ekoapp","email":"developers@amity.co"}],"homepage":"https://github.com/AmityCo/amityeko-bot-messenger#readme","bugs":{"url":"https://github.com/AmityCo/amityeko-bot-messenger/issues"},"bin":{"aem":"bin/index.js"},"dist":{"shasum":"38a1a3d3138e04f7baf238332cbdddb1bb80f19d","tarball":"https://registry.npmjs.org/@amityco/amityeko-bot-messenger/-/amityeko-bot-messenger-2.0.2.tgz","fileCount":15,"integrity":"sha512-CM6F3ZjKwqd1S7LeQwgmvwGIcfmT4zgX03W+kfDWVHFk36sCQsxNxtqVxEXEAibGFv621pm/v31Oub4r1jjeZQ==","signatures":[{"sig":"MEUCIBdsHs3kUEXso1eKi3Q9eDI01kEE/lAqiZQzCLqSOa0DAiEAphMHulPT8GJHm670Jz8AE3bLt5dFYl+VNX/GUevbzos=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":696562,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh19WpCRA9TVsSAnZWagAA7dsP/16qlv1kpoLRHZOlMC9H\n5x/IWlAbUPINxZ4zLt3fmF1ZZRMsTDr+c9/qF8inAqB2w9ZZ6sZic8IHyUvW\nL7Xh+h3KBJJ0OBenTeo2dyU6gJstYNlM5SIrc8/wFPUAua5aoOjNkbnEMX/m\nFKPuObYG7s0qkEA+puXNH9wqCSUoaZsl8FJQuths6j8Lre/KNe02WuLzroHs\nStfIhh7xEapaWqf5IjlZJ6oIv8eS6p5HuqVukPbDRUW1XlUWc6MlyUVrwK7r\nq5w+OPqMaQxm5TjRSxGxhY1K5pKjuBfXJqWUeBn99St6uaillS1B/puS/Lls\n0Tb0a80IUA74BGurRD5Ho9FupU+GIEsfC4sx8PCA6JaX3ohORDzI4oOMtG7L\nwLs6jv3+Zvez6x//kqTviB7cpGLWjkBfYLRiisU1xkr/FTzJyh7SDEucetM8\nO75dP4J9cudhOMpfRLeQN+5uCT+MhvGSgINHw0Vx1ze30X/yUg+GvIneZrO9\n5XTUyB2SZAtqB//49CtgW5LtsUkUo4QSquaBT305/+dG/GKrr00UKAeyUQpS\nUD2HTxax7vLBbW30Tg3CLKma1I1GFbs6nU40GgHDzLBzVBZh0x1c7tRZDISa\nDhn9rYCNo3An56N2ugiK2u7PDPyB96lBUoBJnM3cJ2vnVdim5/4K/jeoO5CD\nuySV\r\n=uO4Z\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","gitHead":"9e6c8c5bd562e419de0c84c690a60d8c87d31119","scripts":{"build":"esbuild action.js --bundle --platform=node --outfile=dist/index.js","version":"npm run build && git add dist/ && npm run changelog","changelog":"auto-changelog --config ./.autochangelog/config.json && git add CHANGELOG.md","postversion":"git push --follow-tags"},"_npmUser":{"name":"ekoapp","email":"developers@amity.co"},"repository":{"url":"git+https://github.com/AmityCo/amityeko-bot-messenger.git","type":"git"},"_npmVersion":"6.14.15","description":"A simple github action to send a message to AmityEko's app","directories":{},"_nodeVersion":"12.22.8","dependencies":{"axios":"^0.24.0","yargs":"^17.3.1","@actions/core":"^1.6.0","@actions/github":"^5.0.0","rc-config-loader":"^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"esbuild":"^0.13.8","auto-changelog":"^2.3.0"},"_npmOperationalInternal":{"tmp":"tmp/amityeko-bot-messenger_2.0.2_1641534889647_0.6344813775874769","host":"s3://npm-registry-packages"}},"2.1.0":{"name":"@amityco/amityeko-bot-messenger","version":"2.1.0","keywords":["github","actions","amity","eko","amityeko","ekoapp"],"author":{"name":"Julien Barbay"},"license":"MIT","_id":"@amityco/amityeko-bot-messenger@2.1.0","maintainers":[{"name":"ekoapp","email":"developers@amity.co"}],"homepage":"https://github.com/AmityCo/amityeko-bot-messenger#readme","bugs":{"url":"https://github.com/AmityCo/amityeko-bot-messenger/issues"},"bin":{"aem":"bin/index.js"},"dist":{"shasum":"0d220c77d2f8fbf9607b5293c09923cc8b766cf7","tarball":"https://registry.npmjs.org/@amityco/amityeko-bot-messenger/-/amityeko-bot-messenger-2.1.0.tgz","fileCount":16,"integrity":"sha512-A81gKKgIhF8du28IJKfQUnRH8tJhUSlrsE2fbLl6Cmr1lP+gF/SqIhoX7viVujP92lPXgKH12hb7CFpmI7ZHiA==","signatures":[{"sig":"MEUCIEKDNTTfdW8bYj5doU8GNRftX4po5Flae/BSB9DzoTgpAiEA1jc4OiURCMrkdZb8ESqF57bjIj5FjhG8iCmIVtMnCd8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":697242,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJiFl9+ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoqAg//UzaLg9IuhifeIVe9iaA0rwHU06AgnkK7h9Pt68Kyv96SicvZ\r\nRaycLRtsHMAH7pemv6XSH9XCzHvKM7oBVU9mGShJTLfAnkJGuvg+Z8wA+nAG\r\naCg8RYPi3OAY2SmIrM6YQSTwJgOoxewv8q4XImLPOtMAp5tsKSL52Nhzw8Hc\r\nojn1K2WzVtYOO6P6dcWWSxlv0qky6NnIE8piHMvelfh3n0PNfbPnKyDZCnZe\r\nnkdOxFsShm0qUE/eYKcvzIIVpURiKHBU7fgWDqy39RI2EeUBIS1ixnRvqOyI\r\nz9oIlR1lDQnXWevwUUhTn2L6CcFPIF2cyC0hkT5DSAlSkmX1nofH0bGHQdYB\r\n+UQiayrR4dppjEZdOnU6cMyIytpFYgvoJpFzgQzQ3wXlw9hIjxC+PZyVaxpf\r\n/dX84aJ2Tv9Q6BuIipbod2BKlXK4ahlVRnnyMe7zyUagd+HSvUBhnzPikEQD\r\nvQCH+QYyw8ROV71V0xjcAlOKF1RkT4XxN8dsFHuSL0goHyHtz2KDA+vg53+s\r\nYQPRTQM/7+2RrHtEHwAFegWG2hlHCS4t9jA/ALMMYKrOs4ww73si/NaMBgyf\r\nF6g7vXmKLYIW2Dgubl4xC+bzblpWisvendy22MWNAw85UegQDX3GzPXxw4Hl\r\noNgxxi+nOm1y18QTvri7Lnd6RLIXOIbII/g=\r\n=6aji\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","types":"lib/index.d.ts","gitHead":"48a2d313816a98aed58c4451cc0687b6f39b8049","scripts":{"build":"esbuild action.js --bundle --platform=node --outfile=dist/index.js","version":"npm run build && git add dist/ && npm run changelog","changelog":"auto-changelog --config ./.autochangelog/config.json && git add CHANGELOG.md","postversion":"git push --follow-tags"},"_npmUser":{"name":"ekoapp","email":"developers@amity.co"},"repository":{"url":"git+https://github.com/AmityCo/amityeko-bot-messenger.git","type":"git"},"_npmVersion":"6.14.16","description":"A simple github action to send a message to AmityEko's app","directories":{},"_nodeVersion":"12.22.10","dependencies":{"axios":"^0.24.0","yargs":"^17.3.1","@actions/core":"^1.6.0","@actions/github":"^5.0.0","rc-config-loader":"^4.0.0"},"_hasShrinkwrap":false,"devDependencies":{"esbuild":"^0.13.8","auto-changelog":"^2.3.0"},"_npmOperationalInternal":{"tmp":"tmp/amityeko-bot-messenger_2.1.0_1645633406557_0.5183691185678545","host":"s3://npm-registry-packages"}}},"time":{"created":"2022-01-07T05:51:42.818Z","modified":"2026-02-11T13:12:52.148Z","2.0.0":"2022-01-07T05:39:47.750Z","2.0.1":"2022-01-07T05:51:43.115Z","2.0.2":"2022-01-07T05:54:49.873Z","2.1.0":"2022-02-23T16:23:26.780Z"},"bugs":{"url":"https://github.com/AmityCo/amityeko-bot-messenger/issues"},"author":{"name":"Julien Barbay"},"license":"MIT","homepage":"https://github.com/AmityCo/amityeko-bot-messenger#readme","keywords":["github","actions","amity","eko","amityeko","ekoapp"],"repository":{"url":"git+https://github.com/AmityCo/amityeko-bot-messenger.git","type":"git"},"description":"A simple github action to send a message to AmityEko's app","maintainers":[{"email":"developers@amity.co","name":"ekoapp"},{"email":"touchaponk@gmail.com","name":"touchaponk"},{"email":"pakkawat@amity.co","name":"pakkawat"},{"email":"platform@social.plus","name":"platform-butler"},{"email":"phongnarin@social.plus","name":"phongnarin-anan"},{"email":"pasut@social.plus","name":"pasut"}],"readme":"# AmityEko Bot Messenger\n\n## What is it?\n\nThis is a:\n\n- (originally) [GitHub action](https://github.com/features/actions) for automating the send of a message to [AmityEko](https://www.amityeko.com/) application.\n- npm package ([@amityco/amityeko-bot-messenger](https://www.npmjs.com/package/@amityco/amityeko-bot-messenger))\n- command line tool (see below)\n\n## Who is it for?\n\nFor engineers whose company is using AmityEko, a way to automate messages of Github workflows and such.\n\n## Notes on usage\n\nAlthough you may find useful at first to send lots of messages for integration, be aware that CI usually runs _very often_ and you may end up flooding your group with messages. When doing so, you may drag the interest of the groups users _out_ of the group: they may end up not reading the messages, because there are too many messages to read.\n\n**Be a responsible human being and don't spam your peers :)**\n\n## How to use it?\n\n### Github Action\n\nIn your workflow, add:\n\n```yaml\n  - uses: AmityCo/amityeko-bot-messenger@v1\n    with:\n      accessToken: {{ secrets.AMITYEKO_TOKEN }}\n      groupId: {{ secrets.AMITYEKO_GROUP_ID }}\n      threadId: {{ secrets.AMITYEKO_THREAD_ID }}\n      content: |\n        Hello world!\n        This is a multi-line message :)\n```\n\nYou can also send an image (even a gif) with:\n\n```yaml\n  - uses: AmityCo/amityeko-bot-messenger@v1\n    with:\n      accessToken: {{ secrets.AMITYEKO_TOKEN }}\n      groupId: {{ secrets.AMITYEKO_GROUP_ID }}\n      threadId: {{ secrets.AMITYEKO_THREAD_ID }}\n      type: image\n      content: https://cataas.com/cat/gif\n```\n\n### NPM package\n\n1. `npm i -D @amityco/amityeko-bot-messenger`\n2. `import sendMessage from '@amityco/amityeko-bot-messenger'`\n\nThe signature function is:\n\n```ts\nfunction(\n  serverEndpoint: string,\n  accessToken: string,\n  groupId: string,\n  threadId: string,\n  type: 'text' | 'image',\n  content: string,\n): Promise<void>\n```\n\n### Command line usage\n\n1. `npm i -g @amityco/amityeko-bot-messenger`\n2. `aem text \"hello world\"` or `aem image https://cataas.com/cat/gif`\n#### Configuration\n\nYou can provide informations about server endpoint, access token, group and thread ids in few different ways.\n\n1. In a JSON file `$HOME/.aemrc`:\n\n```json\n{\n  \"serverEndpoint\": \"\",\n  \"accessToken\": \"\",\n  \"groupId\": \"\",\n  \"threadId\": \"\"\n}\n```\n\n2. As environment variables:\n\n```bash\nAMITYEKO_SERVER_ENDPOINT= AMITYEKO_ACCESS_TOKEN= AMITYEKO_GROUP_ID= AMITYEKO_THREAD_ID= aem text \"hello world\"\n```\n\n3. As command arguments:\n\n```bash\naem text \"hello world\" --endpoint= --token= --gid= --pid=\n```\n\n## Where can I find the necessary variables?\n\n### Access Token\n\nThe bot account must be created from the AmityEko admin panel, therefore you must either have access to it or ask an admin to create a bot for you. If you need more informations, ask the AmityEko staff for details.\n\n### Group ID, Thread ID\n\nWhen connected to the AmityEko app, you can easily find this information from the url. See the screenshot below for finding the correct values:\n\n<img src=\"./docs/url.png\" height=\"40\" />\n","readmeFilename":"README.md"}