v0.6.0

Added

• local:join and local:leave events emitted when join() / leave() methods are called.
• local:share and local:unshare events emitted when share() / unshare() methods are called.
• local:open and local:close events emitted when open() / close() methods are called.
• Streams with all tracks ended are automatically unshared (unless managed is true).

Changed

• Breaking: namespace option in signaling drivers is now a string instead of string[].
• Breaking: share() / unshare() no longer return a MediaStream.
• Breaking: managed now means the stream is externally managed and will not be stopped or unshared automatically.

v0.5.0

Added

• Add support for ReadableStream data in the send method.
• Add unit tests for utilities and some drivers.
• Add optional metadata (info field) when sending messages.
• Add abort signal handling to stop message transmission early.
• Add toJSON method to serialize peer information for local and remote peers.
• Add AGENTS.md file with rules for AI agents interacting with this project.

Changed

• Update the send method API to return an async iterator that can be used to track data transmission progress or a Promise that resolves when the data is delivered.
• Chunk and buffer large messages during transmission via data channels, supporting larger payloads out of the box.
• Breaking: Change incoming data to be either a ReadableStream or a Promise. Read the stream to track receiving progress; use the Promise to get a specific data type when the full message is received.
• Breaking: Send data through only one data channel instead of multiple. If the label is omitted, it uses the default label.

v0.4.0

Added

• Add MqttDriver for signaling using MQTT over WebSockets.
• Add CentrifugeDriver for signaling using a Centrifuge-based backend.
• Add ackTimeout option to SocketIoDriver to specify the timeout for acknowledgments from the server.
• Add iceCandidateDebounce option to Peer to specify the debounce time for sending ICE candidates via signaling.
• Add example code snippets showing how to run some backends locally for testing using Docker.

Changed

• Rename dispatch method to publish in the Driver interface for better clarity and consistency with common messaging terminology.
• Rename publish and unpublish methods in the Peer and RemotePeer classes to share and unshare respectively to avoid confusion with the publish method in the Driver interface.
• The SseDriver uses a Mercure-compatible endpoint by default (/.well-known/mercure).
• The Driver class sets the active accessor to false by default.
• The room property is escaped when namespace hashing is disabled.
• Most drivers use peer or room identifiers as event names instead of concatenating them, which simplifies implementation and shortens event names.
• Some drivers use empty prefixes by default, so if you want to use a prefix, you need to specify one in the options.
• Some drivers with a prefix property add an additional string to the beginning of the event name without any separators, so if you want to separate the prefix from the event name, you need to include a separator in the prefix.
• Use a Protobuf-like format for signaling messages instead of a custom binary format.

v0.3.0

Added

• Add SseDriver for signaling using Server-Sent Events (SSE).
• Add debouncing for ICE candidates sent via signaling to reduce the number of messages.

Changed

• Use derived encryption keys for signaling instead of manually specified secret keys.
• Enable signaling encryption by default.
• Use the compressed public key as the peer ID.
• The minimum build target is ES2020 to allow the use of modern JavaScript features such as BigInt.
• Rename 'signalingHashing' to 'namespaceHashing' for clarity.
• The license has been changed from GPL-3.0 to Apache-2.0 to allow more permissive use of the library in both open-source and commercial projects.

v0.2.0

Added

• Add SocketIoDriver for signaling using Socket.IO.
• Add SupabaseDriver for signaling using Supabase Realtime.
• Add a destroy method to some drivers.

Changed

• Update the NATS driver to use nats-core instead of nats.ws.
• Refactor error codes for clarity.
• Refactor the driver interface to use plain arrays instead of typed arrays for improved serialization.
• Enable namespace hashing by default to improve privacy and avoid issues with unsupported characters in namespaces.

v0.1.0

Added

• Initial release of the project.
• TypeScript support.
• Core functionality: peer connections, signaling, media streams, and data channels.
• Basic documentation and API reference.
• Automated tests for core features.
• Logging for better debugging.
• CI/CD pipeline for automated testing and deployment.
• Example code snippets and usage examples.