{"id":46662688,"url":"https://github.com/rdkcentral/firebolt-apis","last_synced_at":"2026-04-02T19:09:59.058Z","repository":{"id":37274243,"uuid":"395593762","full_name":"rdkcentral/firebolt-apis","owner":"rdkcentral","description":"The Firebolt API OpenRPC schemas and SDK artifact configurations.","archived":false,"fork":false,"pushed_at":"2026-03-26T13:19:24.000Z","size":6799,"stargazers_count":17,"open_issues_count":65,"forks_count":25,"subscribers_count":11,"default_branch":"next","last_synced_at":"2026-03-26T17:16:54.378Z","etag":null,"topics":["apps","javascript","sdk"],"latest_commit_sha":null,"homepage":"","language":"C++","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/rdkcentral.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"COPYING","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":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-08-13T09:28:36.000Z","updated_at":"2025-12-20T15:37:14.000Z","dependencies_parsed_at":"2025-12-05T10:05:53.435Z","dependency_job_id":null,"html_url":"https://github.com/rdkcentral/firebolt-apis","commit_stats":{"total_commits":531,"total_committers":22,"mean_commits":"24.136363636363637","dds":0.647834274952919,"last_synced_commit":"e1f846a50920b860f63635cbb792ee03f31ffea4"},"previous_names":["rdkcentral/firebolt-core-sdk"],"tags_count":250,"template":false,"template_full_name":null,"purl":"pkg:github/rdkcentral/firebolt-apis","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2Ffirebolt-apis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2Ffirebolt-apis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2Ffirebolt-apis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2Ffirebolt-apis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rdkcentral","download_url":"https://codeload.github.com/rdkcentral/firebolt-apis/tar.gz/refs/heads/next","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rdkcentral%2Ffirebolt-apis/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31314033,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-02T12:59:32.332Z","status":"ssl_error","status_checked_at":"2026-04-02T12:54:48.875Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["apps","javascript","sdk"],"created_at":"2026-03-08T13:38:30.216Z","updated_at":"2026-04-02T19:09:59.025Z","avatar_url":"https://github.com/rdkcentral.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\ntitle: Firebolt APIs\n---\n\n[![semantic-release: conventional](https://img.shields.io/badge/semantic--release-conventional-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)\n\n# Firebolt APIs\n\nFirebolt APIs are defined by [OpenRPC schemas](https://spec.open-rpc.org) and used to generate SDK and documentation artifacts.\n\nThis repo contains the OpenRPC source for every Firebolt module, the three published SDK packages, and the CI/toolchain that compiles and validates them.\n\n## Packages\n\n| Package | Description |\n|---|---|\n| [`@firebolt-js/sdk`](src/sdks/core) | Core APIs for app developers |\n| [`@firebolt-js/manage-sdk`](src/sdks/manage) | Device management APIs |\n| [`@firebolt-js/discovery-sdk`](src/sdks/discovery) | Content discovery APIs |\n\n## Repository layout\n\n```\nsrc/openrpc/        # OpenRPC JSON source — one file per module (source of truth)\nsrc/schemas/        # Shared JSON Schema definitions\nsrc/sdks/           # npm workspace packages (generated — do not hand-edit build/ or dist/)\nrequirements/       # Normative specification documents\n.github/workflows/  # CI pipelines\n```\n\n## Build\n\nRequires Node.js LTS and npm 7+.\n\n```bash\nnpm ci                # install dependencies\nnpm run dist          # validate → compile → build all SDKs → test\nnpm run compile       # compile dist/firebolt-open-rpc.json only\nnpm run validate      # validate all OpenRPC sources\nnpm test              # run jest unit tests\nnpm run clean         # remove dist/ and workspace artifacts\n```\n\n## How compilation works\n\n1. Each `src/openrpc/\u003cmodule\u003e.json` is validated against the OpenRPC spec.\n2. All modules are merged into `dist/firebolt-open-rpc.json`.\n3. The compiled OpenRPC is sliced into per-SDK subsets (core / manage / discovery).\n4. TypeScript/JavaScript SDK source is code-generated from each slice.\n5. Jest tests exercise the generated SDKs against mock responses.\n\n**Never edit files under `src/sdks/*/build/` or `src/sdks/*/dist/`** — they are generated outputs.\n\n## Authoring APIs\n\nAll API changes start in `src/openrpc/\u003cmodule\u003e.json`. Key conventions:\n\n- Method names: `Module.method` (PascalCase module, camelCase method).\n- Use the `\"property\"` tag for getter/setter/subscriber triples — only define the getter; the toolchain generates the rest.\n- Use `\"property:immutable\"` for read-only properties.\n- Declare capabilities via `x-uses`, `x-manages`, or `x-provides` inside a `\"capabilities\"` tag block.\n- Every result schema needs at least one `\"examples\"` entry.\n\nSee [`requirements/`](requirements/) for normative specification documents and [`requirements/style-guide-and-template.md`](requirements/style-guide-and-template.md) for the spec template.\n\n## Testing CI locally with `act`\n\nThe MFOS integration test job can be run locally using [`act`](https://github.com/nektos/act), which runs GitHub Actions workflows in Docker.\n\n### Prerequisites\n\n```bash\n# Install act (macOS/Linux)\nbrew install act        # macOS\n# or see https://github.com/nektos/act#installation for Linux\n\n# Required system packages on Linux\nsudo apt-get install -y xvfb x11-utils google-chrome-stable\n```\n\n### Setup\n\nThe `INTENT` Actions variable must be present. Create `.act.vars` in the repo root (it is git-ignored):\n\n```\nINTENT={\"result\":{\"lmt\":0,\"us_privacy\":\"1-N-\",\"discovery\":{\"navigateTo\":{\"action\":\"search\",\"data\":{\"query\":\"{\\\"task\\\":\\\"runTest\\\",\\\"params\\\":{\\\"certification\\\":true,\\\"exceptionMethods\\\":[],\\\"methodsToBeExcluded\\\":[\\\"Lifecycle.finished\\\"]},\\\"action\\\":\\\"FIREBOLT-ALL\\\",\\\"context\\\":{\\\"communicationMode\\\":\\\"SDK\\\"},\\\"metadata\\\":{\\\"target\\\":\\\"MFOS\\\",\\\"targetVersion\\\":\\\"NIL\\\"},\\\"asynchronous\\\":false,\\\"appType\\\":\\\"firebolt\\\"}\"},\"context\":{\"source\":\"voice\"}}}}}\n```\n\n### Run\n\n```bash\nact -j RunStandaloneTests --var-file .act.vars\n```\n\n### Known quirks\n\n- **Chrome** — `act` uses a stripped Ubuntu image; the workflow installs `google-chrome-stable` automatically via the \"Install Chrome\" step.\n- **Xvfb** — `xdpyinfo` may not connect on all runners. The readiness check is non-fatal; headless Chrome does not require a live display.\n- **FCA webpack** — expect `ℹ ｢wdm｣: Compiled with warnings.` (not \"successfully\") on a clean install due to optional plugin stubs. This is normal and harmless.\n- **Cached repos** — `act` caches the `mock-firebolt` and `firebolt-certification-app` clones between runs. Use `make mfos-clean-all` to force a fresh clone.\n\n## Commit conventions\n\nThis repo uses [Conventional Commits](https://www.conventionalcommits.org/) enforced by commitlint.\n\n```\n\u003ctype\u003e(\u003cscope\u003e): \u003cSubject in sentence case\u003e\n```\n\nValid types: `feat`, `fix`, `build`, `chore`, `ci`, `docs`, `perf`, `refactor`, `revert`, `style`, `test`.\n\n## License\n\nCopyright 2023 Comcast Cable Communications Management, LLC — see [LICENSE](LICENSE) and [NOTICE](NOTICE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frdkcentral%2Ffirebolt-apis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frdkcentral%2Ffirebolt-apis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frdkcentral%2Ffirebolt-apis/lists"}