A simple, intuitive, and powerful JavaScript signaling library
MIT License
Bot releases are visible (Hide)
Features
Fixes
Published by john-e-riordan almost 2 years ago
Features
Fixes
Published by john-e-riordan almost 2 years ago
Updates
iceGatheringComplete
method to support strategies other than the built in timeoutBreaking Changes
SimpleUser: The call signature for the register
method has changed. It is now register(registererRegisterOptions?: RegistererRegisterOptions): Promise<void>;
. Any RegistererOptions
which were being passed as the first parameter to the register
must now be provided to the constructor of SimpleUser
along with any other options.
UserAgentOptions: The options autoStart
and autoStop
have been removed.
See the Migration Guide from 0.20 to 0.21 for details.
Published by john-e-riordan about 2 years ago
Updates
master
to main
as default development branchPublished by james-criscuolo over 3 years ago
Features
onAck
delegation for Session (#911)Fixes
Published by james-criscuolo over 3 years ago
Features
Breaking Changes
Published by james-criscuolo almost 4 years ago
Fixes
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 of contactName
is currently broken.Published by james-criscuolo almost 4 years ago
Breaking Changes
hackWssInTransport
UserAgent parameter. If you were using this, it is now replaced with contactParams: { transport: "wss" }
Features
contactName
UserAgent parametercontactParams
UserAgent parameter. It defaults to { transport: "ws" }
Fixes
Published by james-criscuolo over 4 years ago
Fixed a hold issue with 0.17.0 (see #835)
Published by james-criscuolo over 4 years ago
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
Published by james-criscuolo over 4 years ago
Fixes
Features
Other
tslint
is deprecated, so replace with eslint
and prettier
tslib
(unnecessary after update from es5 build target)crypto-js
(new update broke some environments)es2017
es2015
, with package.json changes to make SIP.js a proper ES modulePublished by james-criscuolo over 4 years ago
This is the first release without the legacy API. If you have not migrated, 0.15.x contains both the legacy and new APIs. The new API on 0.15.11 is the same as the only API on this version. If you need help migrating, please see our migration document.
Other changes:
Published by james-criscuolo over 4 years ago
Both APIs
New API
Legacy API:
Published by james-criscuolo almost 5 years ago
Reverted updated to typescript 3.7.x, as it forces all applications using the types to also be >= 3.7.x. For more information see https://github.com/microsoft/TypeScript/issues/33939.
Published by james-criscuolo almost 5 years ago
This release only contains New API changes
SimpleUser
interface. API Users should use reconnect
and the UserAgentDelegate's onConnect
and onDisconnect
functions.Published by james-criscuolo almost 5 years ago
This release only contains New API changes
The default Web Transport has been reworked entirely, and while it is backwards compatible for most new API users, it is technically a breaking change, as the interface has been updated:
UserAgent.reconnect
reconnectionAttempts
& reconnectionDelay
onConnect
/onDisconnect
A handful of existing bugs were discovered and fixed in this refactor, so there are some seemingly unrelated fixes in here as well:
Published by james-criscuolo almost 5 years ago
Legacy API:
New API
0.16.0
is ready.Simple
has been ported to the new API, as SimpleUser
.SimpleUser
. You can try it by reading the demo README in the demo folder.terminated
final state added.RequestPendingError
if you try to register or unregister while a request is pending.Published by james-criscuolo about 5 years ago
As with all 0.15.x releases, the old API is effectively frozen. Changes listed are for the beta API unless explicitly labelled
Changes to old and new API
New API changes
close
to state machinePublished by james-criscuolo about 5 years ago
Changes are to new beta API only:
autostart
is now deprecated to make connection handling more straightforwardPublished by egreenmachine about 5 years ago
I messed up publishing to npm with our new release process, so I had to do a version bump.