Releases: onsip/SIP.js
0.21.2
0.21.1
0.21.0
Updates
- Exposed
iceGatheringComplete
method to support strategies other than the built in timeout - Project was updated for ECMAScript module (ESM) support
- Introduced new SessionManager class
- Minor bug fixes
Breaking Changes
-
SimpleUser: The call signature for the
register
method has changed. It is nowregister(registererRegisterOptions?: RegistererRegisterOptions): Promise<void>;
. AnyRegistererOptions
which were being passed as the first parameter to theregister
must now be provided to the constructor ofSimpleUser
along with any other options. -
UserAgentOptions: The options
autoStart
andautoStop
have been removed.
See the Migration Guide from 0.20 to 0.21 for details.
0.20.1
Updates
- Updated development dependencies
- Fixed tests which broke due to updated tools
- Regenerated all documentation with latest tools
- Node.js 16 is now minimum for doing future development
- Moved to from
master
tomain
as default development branch
0.20.0
Features
- Add support for extraHeaders on Invitation.accept (#910)
- Make the interval at which re-REGISTER requests are sent configurable (UserAgentOptions.refreshFrequency) (#902)
- Add
onAck
delegation for Session (#911)
Fixes
- add gruu check to registerer to restore previous behavior
- publisher: add check so that it does not attempt to enter published state when already there
- fix a typo in extra headers for an uncommon failure case
0.19.0
Features
- Add configuration parameter for automatically sending an initial response (sendInitialProvisionalResponse) (#892)
Breaking Changes
- Update Web SDH and SimpleUser hold implementation. Our built-in implementations are now RFC compliant with the latest relevant transceivers RFC (RFC 8829). Previously, there were some situations where the previous implementation didn't work (see #898). Users who extend our Web SessionDescriptionHandler may have worked around these broken situations in the past, so should be sure to review their code and test while updating.
0.18.1
Fixes
- Adding host and port checks may break people not using the
contactName
UserAgent parameter, so this fix changes the checks to only check those if the parameter is set. The server mucking with host and port is entirely legal, so in cases where that occurs usage ofcontactName
is currently broken.
0.18.0
Breaking Changes
- Removed
hackWssInTransport
UserAgent parameter. If you were using this, it is now replaced withcontactParams: { transport: "wss" }
Features
- Add
contactName
UserAgent parameter - Add
contactParams
UserAgent parameter. It defaults to{ transport: "ws" }
- Add the possibility to change log level in logger
Fixes
- Fix hold bug in SimpleUser
- Fix bug in parser with error reporting
- Improve some internal types
0.17.1
0.17.0
The Session Description Handler has been reworked with tests and documentation added. For users without custom session description handlers, no change will be needed, it is not a breaking change. Existing custom Session Description Handlers will continue to work, unless the old default Session Description Handler was extended (as it's no longer in the same location). For those cases, the old one should be fully copied to your source if you'd like it to continue to work as it did. Extending the old default was not easy, but the new one attempts to rectify this, so in many situations there may be some potential for code cleanup.
Additionally, we will no longer be distributing the webpack-bundled source with our npm package. Importing sip.js
has not been using the webpack bundle for several versions, so we anticipate no issue for most users. For those who imported from sip.js/dist/<one of the bundles>
or used sip.js/dist
in some other fashion, the bundles are still attached to the release notes here, and will continue to be.
Also related to distribution, we now ship with no dependencies and are entirely tree shakeable, so we hope this eliminates a subset of potential issues with bundling and transpiling.
Fixes
Features