{"id":50512656,"url":"https://github.com/anmho/bluebubbles-sdk","last_synced_at":"2026-06-02T21:04:38.927Z","repository":{"id":350850215,"uuid":"1208502354","full_name":"anmho/bluebubbles-sdk","owner":"anmho","description":"Resource-grouped TypeScript SDK for the BlueBubbles Server API","archived":false,"fork":false,"pushed_at":"2026-04-28T08:53:07.000Z","size":466,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-19T23:51:50.008Z","etag":null,"topics":["bluebubbles","mintlify","openapi","sdk","typescript"],"latest_commit_sha":null,"homepage":"https://bluebubbles.anmho.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/anmho.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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":"2026-04-12T11:24:50.000Z","updated_at":"2026-04-28T08:53:11.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/anmho/bluebubbles-sdk","commit_stats":null,"previous_names":["anmho/bluebubbles-sdk"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/anmho/bluebubbles-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anmho%2Fbluebubbles-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anmho%2Fbluebubbles-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anmho%2Fbluebubbles-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anmho%2Fbluebubbles-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anmho","download_url":"https://codeload.github.com/anmho/bluebubbles-sdk/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anmho%2Fbluebubbles-sdk/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33835766,"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-02T02:00:07.132Z","response_time":109,"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":["bluebubbles","mintlify","openapi","sdk","typescript"],"created_at":"2026-06-02T21:04:37.918Z","updated_at":"2026-06-02T21:04:38.922Z","avatar_url":"https://github.com/anmho.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @anmho/bluebubbles-sdk\n\nResource-grouped TypeScript SDK for BlueBubbles.\n\n- Primitives and types are generated by Hey API.\n- Public client is a thin static wrapper over generated primitives.\n- OpenAPI spec is derived from the official BlueBubbles Postman collection.\n- Documentation: https://bluebubbles.anmho.com/\n\n## Install\n\n```bash\nnpm install @anmho/bluebubbles-sdk\n```\n\n## Usage\n\n```ts\nimport { BlueBubblesClient } from '@anmho/bluebubbles-sdk';\n\nconst client = new BlueBubblesClient({\n  baseUrl: 'http://localhost:1234',\n  password: 'your-server-password',\n});\n\nconst chat = await client.chats.get({ path: { chatGuid: 'iMessage;+;12345' } });\nconst chats = await client.chats.query(); // optional input\n\nawait client.messages.sendText({\n  body: {\n    chatGuid: 'iMessage;+;12345',\n    message: 'hello from sdk',\n  },\n});\n\nconst attachment = await client.attachments.download({ path: { guid: 'ATTACHMENT_GUID' } });\n```\n\n## Resources\n\n`client.attachments`, `client.backups`, `client.chats`, `client.contacts`, `client.fcm`, `client.handles`, `client.icloud`, `client.macos`, `client.messages`, `client.server`, `client.web`, `client.webhooks`\n\n## Event constants\n\n```ts\nimport { WEBHOOK_EVENT_TYPES } from '@anmho/bluebubbles-sdk';\n\nawait client.webhooks.create({\n  url: 'https://example.com/webhooks/bluebubbles',\n  events: [WEBHOOK_EVENT_TYPES.NEW_MESSAGE, WEBHOOK_EVENT_TYPES.UPDATED_MESSAGE],\n});\n\nconst event = client.webhooks.constructEvent(rawBody);\nif (event.type === WEBHOOK_EVENT_TYPES.NEW_MESSAGE) {\n  console.log(event.data);\n}\n```\n\n## Generation\n\n```bash\nnpm run spec:download\nnpm run generate\n```\n\n`spec:download` (optional spec refresh):\n1. Downloads the official Postman collection.\n2. Normalizes unresolved placeholders required by the converter.\n3. Converts Postman -\u003e OpenAPI (`spec/openapi.yaml`).\n\n`generate` (normal SDK build path):\n1. Generates Hey API primitives and types to `src/generated`.\n\n`spec/openapi.yaml` is the source of truth for generation.  \n`prepare_postman.ts` is only used during `spec:download` to make Postman conversion reproducible.\n\n## Repro Steps\n\nFrom a clean checkout:\n\n```bash\nnpm ci\nnpm run generate\nnpm test\n```\n\nIf you want to refresh the spec first:\n\n```bash\nnpm run spec:download\nnpm run generate\nnpm test\n```\n\n## Contributing\n\n1. Create a feature branch and make your changes.\n2. Run local checks before opening a PR:\n\n```bash\nnpm run generate\nnpm run build\nnpm test\n```\n\n3. For any user-facing SDK change, add a changeset:\n\n```bash\nnpm run changeset\n```\n\nChoose `patch`, `minor`, or `major` for `@anmho/bluebubbles-sdk` and include a short summary.\n\n4. Commit both your code changes and the generated `.changeset/*.md` file.\n\nRelease flow:\n- Merging PRs into `main` updates or creates a release PR.\n- Merging the release PR publishes to npm and creates a GitHub Release.\n- Merging a normal feature PR into `main` does not publish by itself. Publish only happens when the generated `chore(release): version package` PR is merged.\n\nRelease troubleshooting:\n- Merging a normal PR does not publish immediately. Publish happens only after the release PR is merged.\n- If no `.changeset/*.md` file is included in merged PRs, no release PR is created.\n- The npm Trusted Publisher mapping for `anmho/bluebubbles-sdk` and `release.yml` must remain configured on npm.\n- The publish build must be green (`npm run build`) in CI.\n\n### Example release-ready PR\n\nUse this sequence when your PR includes user-facing SDK changes:\n\n```bash\n# 1) Make your code/docs change\ngit checkout -b feat/my-change\n\n# 2) Add release metadata\nnpm run changeset\n\n# 3) Validate locally\nnpm run generate\nnpm run build\nnpm test\n\n# 4) Commit and open PR\ngit add .\ngit commit -m \"feat: describe your change\"\ngit push\n```\n\nThe changeset file should look like:\n\n```md\n---\n\"@anmho/bluebubbles-sdk\": patch\n---\n\nBrief release note for users.\n```\n\nAfter merge to `main`, automation opens or updates a release PR. Merging that release PR publishes to npm and creates a GitHub Release.\n\nThe publish workflow lives in `.github/workflows/release.yml` and uses npm trusted publishing via GitHub OIDC, not `NPM_TOKEN`.\n\n## Scripts\n\n- `spec:download`\n- `generate`\n- `build`\n- `check`\n- `test`\n- `docs:sync-openapi`\n- `docs:dev`\n- `docs:validate`\n\n## Notes\n\n- Do not hand-edit generated files in `src/generated`.\n- The wrapper keeps BlueBubbles semantics and groups methods by resource.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanmho%2Fbluebubbles-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanmho%2Fbluebubbles-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanmho%2Fbluebubbles-sdk/lists"}