![\"asyncapi-cable\"](\"logo.png\")
\n\n \n
\n Generate typed AnyCable channel clients from an\n AsyncAPI 3.0 document. Produces platform-agnostic channel classes +\n message types (usable on web and React Native) plus a thin, framework-specific\n wrapper (Vue composables or React hooks).\n
\n\nThe \"[Orval](https://orval.dev) for cable\" — point it at your AsyncAPI cable\ndocument and get end-to-end typed real-time clients, the same way Orval turns an\nOpenAPI spec into a typed REST client.\n\n## Two packages, one contract\n\nThis repository ships both ends of the cable contract:\n\n| Package | Path | What it does |\n|---------|------|--------------|\n| npm **`asyncapi-cable`** | `/` | Generates typed AnyCable clients *from* an AsyncAPI 3 document |\n| gem **`asyncapi_cable`** | [`ruby/`](ruby) | Generates that document *from* your Rails ActionCable channels, and validates broadcast payloads against it at runtime |\n\nThey are released independently — the gem writes the document, the npm package\nconsumes it — and neither requires the other. The gem pairs with\n[`openapi-ruby`](https://github.com/openapi-ruby/openapi-ruby), sharing its\nschema-component registry so one component can appear in both the OpenAPI and\nthe AsyncAPI document.\n\n## Key Features\n\n- **AsyncAPI 3.0 → typed AnyCable clients** — channel classes + message payload types generated from your cable document\n- **Platform-agnostic core** — the channel classes + models depend only on `@anycable/core`, so they run on web *and* React Native\n- **Vue & React presets** — per-target `preset` emits Vue composables (`onScopeDispose`) or React hooks (`useEffect`); only the runtime + wrapper differ\n- **Typed payloads** — message types generated via [`@asyncapi/modelina`](https://github.com/asyncapi/modelina), preserving snake_case wire keys\n- **Typed payloads behind a JSON string** — a `payload` declared as a string with `contentSchema` gets its decoded model generated plus a `parseXPayload` helper, so the cast lives in one place instead of at every call site\n- **Single cable seam** — only `runtime.ts` imports your AnyCable instance ([Orval-mutator](https://orval.dev/guides/custom-client) style), configurable per target\n- **Multi-target config** — one `cable.config.mjs` (analog of `orval.config.ts`) generates many documents at once\n- **Vendor extensions** — `x-actioncable-channel` maps to the Rails channel identifier; `x-client-supplied: false` marks server-derived params\n\n## Requirements\n\n- Node >= 20\n- An AsyncAPI 3.0 cable document\n- In the consuming app: `@anycable/core`, plus `vue` (vue preset) or `react` (react preset)\n\n## Install\n\n```bash\npnpm add -D asyncapi-cable\n# the generated code imports these in the consuming app:\npnpm add @anycable/core # + vue (vue preset) or react (react preset)\n```\n\n## Usage\n\nAdd a `cable.config.mjs` (analog of `orval.config.ts`):\n\n```js\nexport default {\n cableInternalV1: {\n input: \"asyncapi/cable_internal.yaml\",\n output: {\n target: \"src/services/cableInternalV1\",\n // the \"mutator\": a file exporting your AnyCable instance getter\n cable: { path: \"../cableClient\", name: \"getCable\" },\n preset: \"vue\", // or \"react\"\n },\n },\n};\n```\n\nThen run:\n\n```bash\npnpm exec asyncapi-cable -c cable.config.mjs\n```\n\nThe config is a map of *target name* → target. Each target:\n\n| Key | Required | Description |\n|-----|----------|-------------|\n| `input` | ✓ | Path to a local AsyncAPI 3.0 document (resolved from the cwd), or an `http(s)` URL to fetch it from (e.g. a backend that serves the contract) |\n| `output.target` | ✓ | Directory for the generated code — **wiped and rebuilt** on each run |\n| `output.cable.path` | | Import path (from `runtime.ts`) to the file exporting your AnyCable getter |\n| `output.cable.name` | | Named export of that getter (defaults to a built-in seam if `cable` is omitted) |\n| `output.preset` | | `\"vue\"` (default) or `\"react\"` |\n| `output.enumType` | | `\"enum\"` (default) or `\"union\"` — see [Enums](#enums) |\n\n## What it emits\n\n```\n