{"id":15780387,"url":"https://github.com/ulisesgascon/synology-chat-communicator","last_synced_at":"2025-04-01T13:33:41.502Z","repository":{"id":65811938,"uuid":"600448050","full_name":"UlisesGascon/synology-chat-communicator","owner":"UlisesGascon","description":"Simple wrapper to send Messages to Synology Chat","archived":false,"fork":false,"pushed_at":"2024-05-08T19:28:04.000Z","size":329,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-24T20:02:25.872Z","etag":null,"topics":["synology","synology-chat"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/synology-chat-communicator","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/UlisesGascon.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-11T14:27:53.000Z","updated_at":"2024-05-08T19:28:05.000Z","dependencies_parsed_at":"2024-10-04T18:41:32.717Z","dependency_job_id":"3ece2be5-6a79-4934-abee-ea235b710468","html_url":"https://github.com/UlisesGascon/synology-chat-communicator","commit_stats":{"total_commits":31,"total_committers":2,"mean_commits":15.5,"dds":"0.12903225806451613","last_synced_commit":"635976e6168cd93ca63a505ebfc63169399da23f"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UlisesGascon%2Fsynology-chat-communicator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UlisesGascon%2Fsynology-chat-communicator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UlisesGascon%2Fsynology-chat-communicator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/UlisesGascon%2Fsynology-chat-communicator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/UlisesGascon","download_url":"https://codeload.github.com/UlisesGascon/synology-chat-communicator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246604610,"owners_count":20804099,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["synology","synology-chat"],"created_at":"2024-10-04T18:41:26.219Z","updated_at":"2025-04-01T13:33:41.176Z","avatar_url":"https://github.com/UlisesGascon.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cp align=\"center\"\u003e\u003ch1 align=\"center\"\u003e\n  synology-chat-communicator\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  Simple wrapper to send Messages to Synology Chat\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.org/package/synology-chat-communicator\"\u003e\u003cimg src=\"https://badgen.net/npm/v/synology-chat-communicator\" alt=\"npm version\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.org/package/synology-chat-communicator\"\u003e\u003cimg src=\"https://badgen.net/npm/license/synology-chat-communicator\" alt=\"license\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.org/package/synology-chat-communicator\"\u003e\u003cimg src=\"https://badgen.net/npm/dt/synology-chat-communicator\" alt=\"downloads\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://snyk.io/test/github/ulisesgascon/synology-chat-communicator\"\u003e\u003cimg src=\"https://snyk.io/test/github/ulisesgascon/synology-chat-communicator/badge.svg\" alt=\"Known Vulnerabilities\"/\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\n# About\n\nSimple wrapper to send Messages to [Synology Chat](https://www.synology.com/es-es/dsm/feature/chat)\n\n🌟 If you want a Go version, please check [go-synology-chat](https://github.com/UlisesGascon/go-synology-chat) 🌟\n\n\n## ❤️ Awesome Features:\n\n\n- Out of the box simple Interface. 🔥\n- Added support for multimedia messages 🍺\n- Simple way to send direct messages to one or many users  🎉\n- Direct support to list users and channels 🔊\n- `debug` is supported 💪\n- Easy to use and great test coverage ✅\n\n\n## Installation\n\n```bash\nnpm install synology-chat-communicator\n```\n\n## Usage\n\n### Simple example\n\n```js\nconst { sendDirectMessage, getUsers, getChannels } = require('synology-chat-communicator')({\n    token: '\u003cYOUR-TOKEN\u003e',\n    baseUrl: 'https://\u003cIP-OR-URL\u003e:\u003cPORT\u003e',\n    ignoreSSLErrors: true\n})\n\n;(async () =\u003e {\n\n    const channels = await getChannels()\n    console.log(\"channels:\", channels)\n\n    const users = await getUsers()\n    console.log(\"users:\", users)\n\n    const user = users[0]\n    const userIdsList = users.map(({user_id}) =\u003e user_id)\n\n    const message = await sendDirectMessage(user.user_id, `Hello, ${user.username}!`)\n    console.log(\"message:\", message)\n\n    const mediaMessage = await sendDirectMessage(user.user_id, `Check out this cool picture, ${user.username}!`, 'https://ulisesgascon.com/ulises_gascon.jpg')\n    console.log(\"Media Message:\", mediaMessage)\n\n    const massiveMessage = await sendDirectMessage(userIdsList, \"I am the new 🤖. Chat with me!\")\n    console.log(\"Massive Message:\", massiveMessage)\n})()\n```\n\n### Disable SSL validation\n\nIf you have a Synology NAS with invalid SSL certificates (due to expiration or other issues), you can disable the SSL validation in the requests generated by the library by using the configuration parameter `ignoreSSLErrors`.\n\n\n## Additional Features\n\nPlease check out the official [DSM Documentation](https://kb.synology.com/en-uk/DSM/help/Chat/chat_integration?version=7) to include new features\n\n\n\n\n## Built With\n\nDevelopment only:\n\n- [Standard](https://www.npmjs.com/package/standard) - Linting propuses\n- [Husky](https://www.npmjs.com/package/husky) - Git Hooks\n- [commitlint](https://www.npmjs.com/package/@commitlint/cli) - Linting commit messages\n- [jest](https://www.npmjs.com/package/jest) - Testing\n- [standard](https://www.npmjs.com/package/standard) - Linting\n- [standard-version](https://www.npmjs.com/package/standard-version) - Manage changelog and releases\n\nProduction only:\n\n- [debug](https://www.npmjs.com/package/debug) - Debug the app\n- [got](https://www.npmjs.com/package/got) - Human-friendly and powerful HTTP request library for Node.js\n\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](https://github.com/UlisesGascon/.github/blob/main/contributing.md) for details on our code of conduct, and the process for submitting pull requests to us.\n\n## Versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/ulisesGascon/synology-chat-communicator/tags).\n\n## Authors\n\n- **Ulises Gascón** - Initial work- - [@ulisesGascon](https://github.com/ulisesGascon)\n\nSee also the list of [contributors](https://github.com/ulisesGascon/synology-chat-communicator/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details\n\n## Acknowledgments\n\n- This project is under development, but you can help us to improve it! We :heart: FOSS!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fulisesgascon%2Fsynology-chat-communicator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fulisesgascon%2Fsynology-chat-communicator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fulisesgascon%2Fsynology-chat-communicator/lists"}