{"id":30892832,"url":"https://github.com/project-holo/discord-worker-framework","last_synced_at":"2025-09-08T20:03:08.394Z","repository":{"id":57152091,"uuid":"83895491","full_name":"project-holo/discord-worker-framework","owner":"project-holo","description":"⚙️ Discord multiservice worker framework consuming from MQTT/AMQP/STOMP. ","archived":false,"fork":false,"pushed_at":"2017-06-02T16:51:17.000Z","size":27,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-02T07:01:19.794Z","etag":null,"topics":["discord","framework","multiservice"],"latest_commit_sha":null,"homepage":"","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/project-holo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-03-04T13:31:13.000Z","updated_at":"2020-09-14T14:01:05.000Z","dependencies_parsed_at":"2022-09-05T16:20:54.132Z","dependency_job_id":null,"html_url":"https://github.com/project-holo/discord-worker-framework","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/project-holo/discord-worker-framework","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-holo%2Fdiscord-worker-framework","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-holo%2Fdiscord-worker-framework/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-holo%2Fdiscord-worker-framework/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-holo%2Fdiscord-worker-framework/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/project-holo","download_url":"https://codeload.github.com/project-holo/discord-worker-framework/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/project-holo%2Fdiscord-worker-framework/sbom","scorecard":{"id":746324,"data":{"date":"2025-08-11","repo":{"name":"github.com/project-holo/discord-worker-framework","commit":"07e0bd94d2868b97bfb90d2f79f2b87bfd5a667c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/14 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-22T18:52:52.273Z","repository_id":57152091,"created_at":"2025-08-22T18:52:52.273Z","updated_at":"2025-08-22T18:52:52.273Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274095404,"owners_count":25221432,"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","status":"online","status_checked_at":"2025-09-07T02:00:09.463Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["discord","framework","multiservice"],"created_at":"2025-09-08T20:01:55.576Z","updated_at":"2025-09-08T20:03:07.477Z","avatar_url":"https://github.com/project-holo.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Discord Worker Framework\n[![js-semistandard-style](https://img.shields.io/badge/code%20style-semistandard-brightgreen.svg?style=flat-square)](https://github.com/Flet/semistandard)\n\nA fast, light-weight framework for consuming incoming messages from\n[Discord](https://discordapp.com \"Discord Landing\") in a multi-service fashion.\n\nThis package consumes from a message broker such as ActiveMQ or RabbitMQ, parses\nand validates incoming data and emits it to be processed by the bot-specific\ncode.\n\nThis package also includes a `DiscordRestClient`, which can be used for sending\ninformation to the Discord API directly or through a rate-limiting proxy.\nRatelimits are managed by default, but this can be disabled.\n\n## NOTE: THIS PACKAGE MAY BREAK AT ANY TIME\n\nThis package follows semver, and the major version is `0`. This means that\nbreaking changes can be introduced in any update. Do not use this in production\nunless you know what you are doing.\n\n## Features\n\n- Fast\n- Low-level\n- Customizable\n- Connects to any message broker (adapters are included for AMQP and STOMP)\n- Allows for caching (included adapter available for Redis)\n- Allows for collecting statistics via an event emitter\n\n## Installing\n\n```\nnpm install discord-worker-framework --no-optional\n\n# Install EventEmitter3 for extra performance\nnpm install eventemitter3\n\n# If you would like to use the included Redis, AMQP or STOMP adapters, make sure\n# that `redis`, `amqp.node` and/or `stompit` are installed:\nnpm install redis amqp.node stompit\n```\n\n## Usage and Examples\n\nExamples can be found in the [examples/](examples/) directory. The\n[pingpong](examples/pingpong.js) demonstrates a simple ping pong bot. None of\nthe examples set a valid MessageBrokerConsumer, so you may need to edit files to\nmake them work for you.\n\n## Incoming Event Structure\n\nAll received events from the MessageBrokerConsumer must follow a standard JSON\nstructure or they will cause the Worker to fail to process incoming events:\n\n```js\n{\n  \"type\": \"\", // Discord event type, e.g. MESSAGE_CREATE, GUILD_CREATE\n  \"shard_id\": 0, // shard ID which the event was received from\n  \"data\": {} // event data, should match the structure from the Discord gateway\n}\n```\n\n[discord-gateway-client](https://github.com/project-holo/discord-gateway-client)\nis a project written in Golang that sends websocket events in this structure to\na STOMP broker, and is intended for use with this framework.\n\n## Events\n\nThe Worker currently emits the following events:\n\n- `discord:*`: Discord events, see examples for more information\n  - i.e. `discord:MESSAGE_CREATE` is a `MESSAGE_CREATE` event from Discord\n- `event:recv`: emitted when any event is received, with the data\n- `event:tested`: emitted when any event has been verified to match the event\n  structure schema (with result)\n- `event:dispatch`: emitted when any event is broadcasted to listener\n  (`discord:*`), with the raw received object from the MessageBrokerConsumer\n\n## Contributing\n\n1. Discuss major changes you wish to propose by creating an issue first\n2. Fork, clone, make changes (semistandard codestyle), push\n3. PR to the `master` branch (this will change in the future)\n\n## Testing\n\nTests are handled with `mocha`. You can run tests by using the `npm test`\ncommand, assuming you've cloned this repository directly and installed\ndevDependencies.\n\n### License\n\nA copy of the MIT license can be found in [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproject-holo%2Fdiscord-worker-framework","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fproject-holo%2Fdiscord-worker-framework","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fproject-holo%2Fdiscord-worker-framework/lists"}