Skip to content

Releases: AgoraIO-Conversational-AI/agent-client-toolkit-ts

v2.10.0

Choose a tag to compare

@alienzh alienzh released this 14 Sep 22:59
7795faa

TypeScript toolkit v2.10.0

What's Changed

Full Changelog: v2.9.1...v2.10.0

v2.9.1

Choose a tag to compare

@alienzh alienzh released this 24 Jul 06:42
4174fa7

Release v2.9.1

What's Changed

  • feat(convoai): add manual SOS/EOS support for 2.9.0 by @alienzh in #13
  • Restore ConversationalAIAPI compatibility and render-mode fallback by @alienzh in #14

Full Changelog: v1.2.0...v2.9.1

v2.9.0

Choose a tag to compare

@github-actions github-actions released this 10 Jul 06:15

What's Changed

New Contributors

Full Changelog: v1.2.0...v2.9.0

v1.2.0

Choose a tag to compare

@github-actions github-actions released this 09 Apr 17:15
v1.2.0
fedba58

Release title: v1.2.0

Release body:

What's changed

  • TypeScript public config contracts now use toolkit-owned structural interfaces: RTCEngine and RTMEngine
  • AgoraVoiceAI.init() now accepts compatible RTC/RTM client objects without requiring as unknown as casts in strict package-manager layouts
  • Public type surface no longer depends on agora-rtm event/class types (RTMClient, RTMEvents) for config and transcript event payload typing
  • Tightened RTC structural typing with transcript-focused helper interfaces (RTCStreamMessageLike, RTCDataStreamParamsLike) and stricter RTCEngine.on/off overloads for 'stream-message' and 'audio-pts'
  • Added development-time engine-shape validation in AgoraVoiceAI.init() with actionable error messages when required RTC/RTM methods are missing
  • Improved public API discoverability with expanded JSDoc for AgoraVoiceAIConfig, renderMode, React hooks, and TranscriptHelperItem<T> generic typing

Added

  • Interop type-check fixture: packages/conversational-ai/__typetests__/interop.ts with typecheck:interop script
  • Coverage command surface (test:coverage) for root, core, and React packages
  • CI coverage summary output in GitHub Actions step summary
  • Additional lifecycle tests for invalid RTC/RTM engine inputs and React hook test coverage expansion

Upgrade notes

  • Quick guide: see MIGRATION.md#11x---120 for 1.1.x -> 1.2.0.
  • AgoraVoiceAIConfig.rtcEngine and RTMConfig.rtmEngine now use structural contracts (RTCEngine, RTMEngine) instead of peer SDK class/interface types.
  • Existing real Agora RTC/RTM clients continue to work without code changes.
  • If your app previously used casts (for example as unknown as), they are now redundant and can be removed.
  • If you authored custom wrappers, ensure they implement the required methods:
    • RTC: on, off
    • RTM: publish, addEventListener, removeEventListener
  • Runtime checks now fail fast in development when required engine methods are missing; align custom test doubles with the structural contracts.
  • Coverage policy now explicitly aligns with the configured Vitest thresholds in CONTRIBUTING.md.

agora-agent-client-toolkit-react

Changed

  • Removed internal rtcEngine cast workaround when passing useRTCClient() into AgoraVoiceAI.init()

Full Changelog: v1.1.0...v1.2.0

1.1.0

Choose a tag to compare

@digitallysavvy digitallysavvy released this 17 Mar 23:15

Release title: v1.1.0

Release body:

What's changed

Bug fixes

  • Chunked message assembly — rawPartIdx === 0 (invalid for 1-based wire format) previously
    passed through as chunk index 0, causing silent incorrect message assembly. Now explicitly
    rejected.
  • Transcript uid resolution — agent transcriptions were sometimes attributed to the wrong uid
    when stream_id was absent. Uid is now resolved via message.object type check, making it
    reliable in all cases.
  • PTS reset on reconnect — setPts(0) was silently ignored, causing word rendering to freeze
    after a stream restart. PTS can now reset to 0 correctly.
  • React context exports — context.ts updated to correctly import from the renamed core
    package.

Packages

Package Version
agora-agent-client-toolkit 1.1.0
agora-agent-client-toolkit-react 1.1.0

Full changelog:
https://github.com/AgoraIO-Conversational-AI/agent-client-toolkit-ts/blob/main/CHANGELOG.md

1.0.0

Choose a tag to compare

@digitallysavvy digitallysavvy released this 12 Mar 00:19
727fe79

[v1.0.0] — 2026-03-11

Initial public release.

agora-agent-client-toolkit

  • AgoraVoiceAI singleton with async init()
  • Event system: TRANSCRIPT_UPDATED, AGENT_STATE_CHANGED, AGENT_ERROR, AGENT_METRICS, AGENT_INTERRUPTED, MESSAGE_ERROR, MESSAGE_RECEIPT_UPDATED, MESSAGE_SAL_STATUS, DEBUG_LOG
  • RTC-only mode — RTM is optional; methods requiring RTM (sendText, sendImage, interrupt) throw RTMRequiredError
  • CovSubRenderController with TEXT, WORD, and AUTO rendering modes
  • ChunkedMessageAssembler for stream message reassembly with input validation and cache size limits
  • Structured error classes: ConversationalAIError, NotInitializedError, RTMRequiredError
  • Optional Agora metrics via enableAgoraMetrics: true (requires @agora-js/report)
  • Zero required runtime dependencies

agora-agent-client-toolkit-react

  • useConversationalAI — flagship lifecycle hook (init, subscribe, destroy)
  • useTranscript — standalone transcript observer
  • useAgentState — standalone agent state observer
  • useAgentError — standalone error observer (AGENT_ERROR + MESSAGE_ERROR)
  • useAgentMetrics — standalone metrics observer