CHANGELOG.md

livekit-server-sdk

2.17.0

Minor Changes

• Add LiveKitAPI, a unified entry point that exposes every server API through a property (api.room, api.egress, api.ingress, api.sip, api.agentDispatch, api.connector). It can be constructed with an API key and secret, or with a pre-signed token (no secret required, so it can run client-side), and falls back to the LIVEKIT_URL, LIVEKIT_API_KEY, LIVEKIT_API_SECRET, and LIVEKIT_TOKEN environment variables. Individual clients also accept a token via ClientOptions. - #695 (@davidzhao)

• Add SipCallError, a TwirpError subclass thrown by SipClient.createSipParticipant / transferSipParticipant when a call fails with a SIP status. It exposes the SIP response code and reason as sipStatusCode / sipStatus getters, while other error metadata remains available via metadata. - #695 (@davidzhao)

Patch Changes

• feat: auto failover APIs with LK Cloud - #686 (@davidzhao)

2.16.0

Minor Changes

• Support SIP media configs. - #687 (@dennwc)

Patch Changes

• Add callee dispatch rule support to createSipDispatchRule - #684 (@lukasIO)

2.15.5

Patch Changes

• Add deployment to CreateDispatchOptions - #675 (@lukasIO)

2.15.4

Patch Changes

• Add token revocation timestamp to RemoveParticipant - #668 (@cnderrauber)

2.15.3

Patch Changes

• Bump @livekit/protocol to 1.45.6 and surface new fields on the agent dispatch and connector clients: - #657 (@anunaym14)

  • AgentDispatchClient.createDispatch: new restartPolicy option (cloud only)
  • ConnectorClient.dialWhatsAppCall / acceptWhatsAppCall: new ringingTimeout option (and waitUntilAnswered on accept)
  • ConnectorClient.disconnectWhatsAppCall: new optional disconnectReason parameter
  • Re-export JobRestartPolicy and DisconnectWhatsAppCallRequest_DisconnectReason

• Add canManageAgentSession to VideoGrant - #661 (@theomonnom)

2.15.2

Patch Changes

• add ringingTimeput field to SIP inbound create api - #645 (@s-hamdananwar)

2.15.1

Patch Changes

• Add ringingTimeout option to transferSipParticipant - #627 (@alexlivekit)

2.15.0

Minor Changes

• feat(connector): initial client impl - #573 (@anunaym14)

2.14.2

Patch Changes

• re-export types from @livekit/protocol - #574 (@davidzhao)

• Add media encryption field to inbound and outbound SIP trunks - #570 (@chrisackermann)

2.14.1

Patch Changes

• Add observability grant - #565 (@toubatbrian)

• Add outbound trunk configuration for sip participant. - #563 (@cloudwebrtc)

• Add optional timeouts to clients in server APIs - #560 (@bryfox)

2.14.0

Minor Changes

• Added displayName field to CreateSipParticipantOptions - #544 (@alexlivekit)

2.13.3

Patch Changes

• Add webhook event participant_connection_aborted - #528 (@boks1971)

2.13.2

Patch Changes

• feat(webhooks): Add webhooks to EgressClient - #517 (@davidzhao)

2.13.1

Patch Changes

• Add support for destination_country in outbound trunk - #489 (@biglittlebigben)

2.13.0

Minor Changes

• Support moving participant to another room - #473 (@cnderrauber)

2.12.0

Minor Changes

• Add destinationRoom to VideoGrant - #460 (@cnderrauber)

2.11.0

Minor Changes

• Add ForwardParticipant to room service - #440 (@cnderrauber)

Patch Changes

• chore: Add a clock tolerance parameter to support clock skew for webhooks - #442 (@Wundero)

2.10.2

Patch Changes

• fix: expose sipNumber in SipClient.CreateSIPParticipant - #427 (@davidzhao)

2.10.1

Patch Changes

• rename enableKrisp -> krispEnabled for consistency - #414 (@davidzhao)

2.10.0

Minor Changes

• Improve error insight for twirp related requests, changes the error signature to custom TwirpError - #390 (@lukasIO)

Patch Changes

• Update protocol and add SendDataRequest nonce - #400 (@lukasIO)

2.9.7

Patch Changes

• Fix cjs usage of WebhookReceiver - #382 (@lukasIO)

2.9.6

Patch Changes

• fix(deps): move @bufbuild/protobuf to dependencies - #351 (@danielmahon)

• Export enums AudioCodec and VideoCodec from @livekit/protocol - #375 (@Philzen)

2.9.5

Patch Changes

• updated SIP APIs to include new API options - #364 (@davidzhao)

2.9.4

Patch Changes

• Fix screenshare option not being applied to participant egress - #362 (@chrisackermann)

• Fix types export for CJS and build config - #359 (@lukasIO)

2.9.3

Patch Changes

• support for node v18 - #349 (@lalitkapoor)

2.9.2

Patch Changes

• fix(cjs): don't default export ServiceBase - #346 (@nbsp)

2.9.1

Patch Changes

• Enable verbatimModuleSyntax and isolatedModules - #341 (@lukasIO)

• Update protocol dependency - #344 (@lukasIO)

• Update protocol dependency - #342 (@lukasIO)

2.9.0

Minor Changes

• natively support CommonJS - #334 (@nbsp)

• SIP: Add missing params in CreateSIPParticipant - #337 (@umarniz)

Patch Changes

• SIP: added headers options to SIP inbound and output create requests - #332 (@s-hamdananwar)

2.8.1

Patch Changes

• Fix incorrect import in AgentDispatchClient - #331 (@davidzhao)

2.8.0

Minor Changes

• Explicit agent dispatch via API and token - #324 (@davidzhao)

2.7.3

Patch Changes

• Allow requesting dialtone during transfer - #307 (@biglittlebigben)

2.7.2

Patch Changes

• Fix ingress creation parameter inline documentation - #296 (@biglittlebigben)

2.7.1

Patch Changes

• Support canSubscribeMetrics - #293 (@boks1971)

2.7.0

Minor Changes

• Implement transferSipParticipant - #281 (@biglittlebigben)

Patch Changes

• Fix mutex in livekit-rtc - #287 (@bcherry) Fix linter warnings in livekit-server-sdk

2.6.2

Patch Changes

• Include support for SRT Egress - #266 (@bcherry)

2.6.1

Patch Changes

• Export EgressStatus enum - #247 (@lukasIO)

2.6.0

Minor Changes

• Added ability to update Participant attributes - #242 (@lukasIO)

2.5.1

Patch Changes

• Export RoomEgress to make it possible to use AutoEgress - #222 (@davidzhao)

2.5.0

Minor Changes

• Support new SIP Inbound/Outbound Trunks and grants. - #219 (@dennwc)

Patch Changes

• Added kind and attributes to AccessToken generation - #215 (@davidzhao)

• Adds missing await to startParticipantEgress #221 - #220 (@lukasIO)

2.4.0

Minor Changes

• Accept new SIP metadata. - #182 (@dennwc)

Patch Changes

• Update dependency @livekit/protocol to v1.17.0 - #185 (@renovate)

2.3.0

Minor Changes

• Add SIP service. - #173 (@dennwc)

2.2.0

Minor Changes

• Bump minimum engine requirement to node 19 - #155 (@lukasIO)

• Add support for enableTranscoding - #171 (@biglittlebigben)

Patch Changes

• Allow user to set participant metadata when creating Ingress - #152 (@davidzhao)

2.1.2

Patch Changes

• Support for departure timeout in CreateRoom - #150 (@davidzhao)

2.1.1

Patch Changes

• Make use of @livekit/protocol package - #147 (@lukasIO)

2.1.0

Minor Changes

• Expose protobuf TrackSource and map TrackSource claims to string - #145 (@lukasIO)

Patch Changes

• Add support for Egress Image Output - #143 (@biglittlebigben)

2.0.4

Patch Changes

• Add agent field to VideoGrant - #141 (@lukasIO)

2.0.3

Patch Changes

• Export types needed for Egress - #137 (@davidzhao)

2.0.2

Patch Changes

• Fix issue decoding unknown fields in webhook receiver - #135 (@davidzhao)

2.0.1

Patch Changes

• Ignore unknown fields in protobuf parsing - #132 (@lukasIO)

2.0.0

Major Changes

• Change module type to ESM - #118 (@lukasIO)

• Require node 18 as minimum version - #118 (@lukasIO)

• Make WebhookEvent names type safe - #125 (@lukasIO)

• Token generation is now async (replaced jsonwebtoken with jose for better JS runtime support) - #118 (@lukasIO)

• Replace protobufjs with protobuf-es - #118 (@lukasIO)

Minor Changes

• Use globally available web crypto API instead of nodeJS crypto module - #122 (@lukasIO)

Patch Changes

• Throw error on bad Twirp response status and use async/await instead of promise chaining for improved error catching - #124 (@lukasIO)