Skip to content

Latest commit

 

History

History
235 lines (155 loc) · 12.7 KB

CHANGELOG.md

File metadata and controls

235 lines (155 loc) · 12.7 KB
Raw

Changelog

All notable changes to Pipecat Client Web will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[0.3.2] - 2024-12-16

Added

  • Screen media sharing methods implemented:
    • Added startScreenShare and stopScreenShare methods to RTVIClient and Transport.
    • Added isSharingScreen getter to RTVIClient and Transport.

Changes

  • baseUrl and endpoints are now optional parameters in the RTVIClient constructor (RTVIClientParams), allowing developers to connect directly to a transport without requiring a handshake auth bundle.
    • Note: Most transport services require an API key for secure operation, and setting these keys dangerously on the client is not recommended for production. This change intends to simplify testing and local developement where running a server-side connect method can be cumbersome.

[0.3.1] - 2024-12-10

Fixed

  • Incorrect package.lock version resulted in types being omitted from the previous build. This has been fixed (0.3.0 has been unpublished).

[0.3.0] - 2024-12-10

Changed

  • The RTVI client web libraries are now part of Pipecat. Repo and directory names have changed from RTVI to Pipecat.
  • Package names have also been updated:
    • realtime-ai is now @pipecat-ai/client-js
    • realtime-ai-react is now @pipecat-ai/client-react

Please update your imports to the new package names.

[0.2.3] - 2024-12-09

Fixed

  • Added initial callback for onSpeakerUpdated event
  • Fixed event name typo - TrackedStopped should be TrackStopped

[0.2.2] - 2024-11-12

Added

  • disconnectBot() method added to RTVIClient that disconnects the bot from the session, but keeps the session alive for the connected user.
  • logger singleton added and used within all RTVIClient files. This aims to provide more granular control over console output - with verbose logging enabled, RTVI can be a little noisy.
  • setLogLevel method added to RTVIClient to allow developers to set the log level.
  • disconnectBot() method added to RTVIMessage to allow developers to tell the bot to leave a session.

[0.2.1] - 2024-10-28

Removed

Changed

  • onBotText callback renamed to onBotLlmText for consistency. onBotText has been marked as deprecated.
  • onUserText callback and events removed as unused.
  • onBotLlmText callback correctly accepts a text:BotLLMTextData typed parameter.
  • onBotTranscript callback correctly accepts a text:BotLLMTextData typed parameter (previously TranscriptData)
  • botLlmStarted, botLlmStopped, botTtsStarted, botTtsStopped, onBotStartedSpeaking and onBotStoppedSpeaking pass no parameters. Previously, these callbacks were given a participant object which was unused.
  • TTSTextData type renamed to BotTTSTextData for consistency.

Fixed

  • endpoints is redefined as a partial, meaning you no longer receive a linting error when you only want to override a single endpoint.

[0.2.0] - 2024-09-13

RTVI 0.2.0 removes client-side configuration, ensuring that state management is handled exclusively by the bot or the developer’s application logic. Clients no longer maintain an internal config array that can be modified outside of a ready state. Developers who require stateful configuration before a session starts should implement it independently.

This change reinforces a key design principle of the RTVI standard: the bot should always be the single source of truth for configuration, and RTVI clients should remain stateless.

Additionally, this release expands action capabilities, enabling disconnected action dispatch, and renames key classes and types from VoiceClientX to RTVIClientX. Where possible, we have left deprecated aliases to maintain backward compatibility.

Added

  • params client constructor option, a partial object that will be sent as JSON stringified body params at connect() to your hosted endpoint. If you want to declare initial configuration in your client, or specify start services on the client, you can declare them here.
    • baseUrl: string;
    • headers?: Headers;
    • endpoints?: connect | action;
    • requestData?: object;
    • config?: RTVIClientConfigOption[];
    • Any additional request params for all fetch requests, e.g. [key: string]: unknown;
  • endpoints (as part of params) declares two default endpoints that are appended to your baseUrl. connect/ (start a realtime bot session) and /action (for disconnect actions).
  • onConfig and RTVIEvent.Config callback & event added, triggered by getConfig voice message.
  • @transportReady decorator added to methods that should only be called at runtime. Note: decorator support required several Parcel configuration changes and additional dev dependencies.
  • @getIfTransportInState getter decorator added to getter methods that should only be called in a specified transport state.
  • rtvi_client_version is now sent as a body parameter to the connect fetch request, enabling bot <> client compatibility checks.
  • action() will now function when in a disconnected state. When not connected, this method expects a HTTP streamed response from the action endpoint declared in your params.
  • New callbacks and events:
    • onBotTtsText Bot TTS text output
    • onBotTtsStarted Bot TTS response starts
    • onBotTtsStopped Bot TTS response stops
    • onBotText Streaming chunk/word, directly after LLM
    • onBotLlmStarted Bot LLM response starts
    • onBotLlmStopped Bot LLM response stops
    • onUserText Aggregated user text which is sent to LLM
    • onStorageItemStored Item was stored to storage

Changed

  • start() has been renamed to connect().
  • Client no longer expects a services map as a constructor param (note: remains in place but flagged as deprecated.) If you want to pass a services map to your endpoint, please use params.
  • customHeaders has been renamed to headers.
  • Config getter and setter methods (getConfig and updateConfig) are only supported at runtime.
  • updateConfig promise is typed to Promise<VoiceMessage> (previously unknown to support offline updates.)
  • getConfig promise is typed to Promise<VoiceClientOptions[]> (previously unknown to support offline updates.)
  • services getter and setter methods have been deprecated.
  • getServiceOptionsFromConfig, getServiceOptionValueFromConfig, setConfigOptions and setServiceOptionInConfig are now async to support getConfig at runtime and accept an optional config param for working with local config arrays.
  • registerHelper no longer checks for a registered service and instead relies on string matching.
  • LLM Helper getContext() now accepts optional config param for working with local configs.
  • customAuthHandler updated to receive startParams as second dependency.
  • jest tests updated to reflect changes.
  • VoiceClientOptions is now RTVIClientOptions.
  • VoiceClientConfigOption is now RTVIClientConfigOption.
  • VoiceEvent is now RTVIEvent.

Fixed

  • RTVIMessageType.CONFIG message now correctly calls onConfig and RTIEvents.Config.

Deprecated

  • getBotConfig has been renamed to getConfig to match the bot action name / for consistency.
  • voiceClient.config getter is deprecated.
  • config and services constructor params should now be set inside of params and are optional.
  • customBodyParams and customHeaders have been marked as deprecated. Use params instead.

Removed

  • RTVIClient.partialToConfig removed (unused)
  • nanoid dependency removed.

[0.1.10] - 2024-09-06

  • LLMContextMessage content not types to unknown to support broader LLM use-cases.

[0.1.9] - 2024-09-04

Changed

  • voiceClient.action() now returns a new type VoiceMessageActionResponse that aligns to RTVI's action response shape. Dispatching an action is the same as dispatching a VoiceMessage except the messageDispatcher will type the response accordingly. action-response will resolve or reject as a VoiceMessageActionResponse, whereas any other message type is typed as a VoiceMessage. This change makes it less verbose to handle action responses, where the data blob will always contain a result property.
  • LLM Helper getContext returns a valid promise return type (Promise<LLMContext>).
  • LLMHelper getContext resolves with the action result (not the data object).
  • LLMHelper setContext returns a valid promise return type (Promise<boolean>).
  • LLMHelper setContext resolves with the action result boolean (not the data object).
  • LLMHelper appendToMessages returns a valid promise return type (Promise<boolean>).
  • LLMHelper appendToMessages resolves with the action result boolean (not the data object).

Fixed

  • customAuthHandler is now provided with the timeout object, allowing developers to manually clear it (if set) in response to their custom auth logic.
  • getServiceOptionsFromConfig returns unknown | undefined when a service option is not found in the config definition.
  • getServiceOptionsValueFromConfig returns unknown | undefined when a service option or value is not found in the config definition.
  • getServiceOptionValueFromConfig returns a deep clone of the value, to avoid nested references.
  • VoiceMessageType.CONFIG_AVAILABLE resolves the dispatched action, allowing describeConfig() to be awaited.
  • VoiceMessageType.ACTIONS_AVAILABLE resolves the dispatched action, allowing describeActions() to be awaited.

Added

  • Action dispatch tests

[0.1.8] - 2024-09-02

Fixed

  • getServiceOptionsFromConfig and getServiceOptionValueFromConfig return a deep clone of property to avoid references in returned values.
  • LLM Helper getContext now returns a new instance of context when not in ready state.

Changed

  • updateConfig now calls the onConfigUpdated callback (and event) when not in ready state.

[0.1.7] - 2024-08-28

Fixed

  • All config mutation methods (getServiceOptionsFromConfig, getServiceOptionValueFromConfig, setServiceOptionInConfig) now work when not in a ready state.

Added

  • New config method: getServiceOptionValueFromConfig. Returns value of config service option with passed service key and option name.
  • setServiceOptionInConfig now accepts either one or many ConfigOption arguments (and will set or update all)
  • setServiceOptionInConfig now accepts an optional 'config' param, which it will use over the default VoiceClient config. Useful if you want to mutate an existing config option across multiple services before calling updateConfig.
  • New config method setConfigOptions updates multiple service options by running each item through setServiceOptionInConfig.

Fixed

  • "@daily-co/daily-js" should not be included in the rtvi-client-js package.json. This dependency is only necessary for rtvi-client-js-daily.
  • Jest unit tests added for config manipulation within rtvi-client-js (yarn run test)

[0.1.6] - 2024-08-26

Fixed

  • getServiceOptionsFromConfig should return a new object, not an instance of the config. This prevents methods like setContext from mutating local config unintentionally.

[0.1.5] - 2024-08-19

Added

  • Client now sends a client-ready message once it receives a track start event from the transport. This avoids scenarios where the bot starts speaking too soon, before the client has had a change to subscribe to the audio track.

[0.1.4] - 2024-08-19

Added

  • VoiceClientVideo component added to rtvi-client-react for rendering local or remote video tracks
  • partialToConfig voice client method that returns a new VoiceClientConfigOption[] from provided partial. Does not update config.

Fixed

  • Fixes an issue when re-creating a DailyVoiceClient. Doing so will no longer result in throwing an error. Note: Simultaneous DailyVoiceClient instances is not supported. Creating a new DailyVoiceClient will invalidate any pre-existing ones.

[0.1.3] - 2024-08-17

Added

  • setServiceOptionsInConfig Returns mutated / merged config for specified key and service config option
  • Voice client constructor customBodyParams:object. Add custom request parameters to send with the POST request to baseUrl
  • Set voice client services object (when client has not yet connected)

Fixed

  • Pass timeout to customAuthHandler

[0.1.2] - 2024-08-16

  • API refactor to align to RTVI 0.1