{"id":19517449,"url":"https://github.com/ivkos/botyo-bundle-persistence","last_synced_at":"2026-06-15T19:31:09.681Z","repository":{"id":143864628,"uuid":"113340928","full_name":"ivkos/botyo-bundle-persistence","owner":"ivkos","description":null,"archived":false,"fork":false,"pushed_at":"2018-06-08T12:50:19.000Z","size":15,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-18T19:23:50.720Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ivkos.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-12-06T16:31:11.000Z","updated_at":"2018-06-25T18:20:50.000Z","dependencies_parsed_at":null,"dependency_job_id":"bf57d13e-eced-4e09-a1cf-b97490e45903","html_url":"https://github.com/ivkos/botyo-bundle-persistence","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ivkos/botyo-bundle-persistence","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fbotyo-bundle-persistence","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fbotyo-bundle-persistence/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fbotyo-bundle-persistence/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fbotyo-bundle-persistence/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ivkos","download_url":"https://codeload.github.com/ivkos/botyo-bundle-persistence/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivkos%2Fbotyo-bundle-persistence/sbom","scorecard":{"id":498498,"data":{"date":"2025-08-11","repo":{"name":"github.com/ivkos/botyo-bundle-persistence","commit":"09c3ceed80e9b535ceb64fc2d37533d0665c8e80"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/8 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":"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":"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":"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":"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":"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":"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":"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: Apache License 2.0: 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-19T21:11:10.536Z","repository_id":143864628,"created_at":"2025-08-19T21:11:10.536Z","updated_at":"2025-08-19T21:11:10.536Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34377872,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-15T02:00:07.085Z","response_time":63,"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":[],"created_at":"2024-11-11T00:03:43.291Z","updated_at":"2026-06-15T19:31:09.674Z","avatar_url":"https://github.com/ivkos.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Persistence Bundle for Botyo\n[![npm](https://img.shields.io/npm/v/botyo-bundle-persistence.svg)](https://www.npmjs.com/package/botyo-bundle-persistence)\n[![npm](https://img.shields.io/npm/dt/botyo-bundle-persistence.svg)](https://www.npmjs.com/package/botyo-bundle-persistence)\n[![npm](https://img.shields.io/npm/l/botyo-bundle-persistence.svg)]()\n\nThe **Persistence Bundle for [Botyo](https://github.com/ivkos/botyo)** consists of a few components related to the persistence of messages in a MongoDB database.\n\nThe included components are:\n- `MongoDbConnector` - An `AsyncResolvable` that connects to a MongoDB server during the initialization of **Botyo** and provides access to the database via the `Db` object provided by the [MongoDB Node.JS Driver](https://mongodb.github.io/node-mongodb-native/).\n- `MessageDownloaderFilter` - Filter that saves each incoming message to the database.\n- `ChatThreadHistoryDownloaderScheduledTask` - Scheduled task that downloads the history of all chat threads **Botyo** is configured to listen to and saves it to database.\n\n## Install\n**Step 1.** Install the module from npm.\n\n`npm install --save botyo-bundle-persistence`\n\n**Step 2.** Configure the MongoDB connection.\n\nAdd the [Connection String URL](https://docs.mongodb.com/manual/reference/connection-string/) to your configuration file `config.yaml`:\n```yaml\nfacebook:\n  email: ...\n  password: ...\n  ...\n\n\n# Persistence Bundle Configuration\nmongo:\n  url: mongodb://localhost:27017/botyo\n\n  \nmodules:\n  ...\n```\n\n**Step 3.** Register the bundle.\n```typescript\nimport Botyo from \"botyo\";\nimport { PersistenceBundle } from \"botyo-bundle-persistence\"\n\nBotyo.builder()\n    ...\n    .registerBundle(PersistenceBundle)\n    ...\n    .build()\n    .start();\n```\n\n## Configuration\nThe configuration of the included modules has sensible defaults. However, you can still override the defaults if you need to.\n\n#### MessageDownloaderFilter\n```yaml\nmodules:\n    MessageDownloaderFilter:\n      enable: true  # enables the filter globally\n      \nchat-threads:\n    SOME_CHAT_THREAD_ID:\n      overrides:\n        modules.MessageDownloaderFilter:\n          enable: false     # disables the filter for this chat thread\n      participants:\n        SOME_PARTICIPANT_ID:\n          overrides:\n            modules.MessageDownloaderFilter:\n              enable: true  # enables the filter for this participant of this chat thread\n```\n\n#### ChatThreadHistoryDownloaderScheduledTask\n```yaml\nmodules:\n    ChatThreadHistoryDownloaderScheduledTask:\n      enable: true          # enables the task\n      schedule: 10800000    # milliseconds, how often to run; also accepts cron strings\n      executeOnStart: true  # execute on start of Botyo\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivkos%2Fbotyo-bundle-persistence","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fivkos%2Fbotyo-bundle-persistence","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivkos%2Fbotyo-bundle-persistence/lists"}