Movatterモバイル変換

unjs/crosswsPublic

NotificationsYou must be signed in to change notification settings
Fork23
Star480

v0.3.4

10 Feb 20:41

pi0

v0.3.4

46b1c84

Compare

Choose a tag to compare

v0.3.4Latest

Latest

compare changes

🚀 Enhancements

cloudflare: SupportresolveDurableStub (#130)

🩹 Fixes

Global publish via first subscribed peer (#103)
Definerequest.context as read-only (#133)
node, uws: Send data as blob only if it is not string (#124)
bun: Passcode andreason toclose hook (#132)

💅 Types

Stricter type declarations (#129)
Specify an explicit return type foruint8Array() (#128)

📖 Documentation

node: Checkupgrade === "websocket" in example (#131)
Add dynamic example for changeable resolve (e5daf22)

❤️ Contributors

Pooya Parsa (@pi0)
Sandro Circi (@sandros94)
Flo (@TecToast)
Tee Ming (@eltigerchino)

Contributors

pi0, sandros94, and 2 other contributors

Assets2

1 person reacted

v0.3.3

24 Jan 21:06

pi0

v0.3.3

3bb5269

This commit was created on GitHub.com and signed with GitHub’sverified signature.

GPG key ID:B5690EEEBB952194

Verified

Learn about vigilant mode.

Compare

Choose a tag to compare

v0.3.3

compare changes

🚀 Enhancements

Allow throwing error with.response prop inupgrade (#113)

❤️ Contributors

Luke Hagar (@LukeHagar)

Contributors

LukeHagar

Assets2

v0.3.2

22 Jan 11:16

pi0

v0.3.2

a1cab88

Compare

Choose a tag to compare

v0.3.2

compare changes

Note

🔑 This release includes enhancements to make authentication and session handling easier.

You can validate therequest param in theupgrade hook andthrow aResponse as an error to terminate the upgrade (#91)
You can access a shared context fromrequest.context in theupgrade hook and frompeer.context in the other hooks to preserve session data (#110,#111 (Note: context can be volatile in some environments likecloudflare-durable)

🩹 Fixes

types:peer.request always has.headers if defined (e915f8d)
types: Markpeer.request as always defined (8fbb59b)

📖 Documentation

Fix typos (#84,#85)
Add tip for usingdestr for JSON parsing (#109)

🏡 Chore

examples: Fix typo (#107)

❤️ Contributors

Pooya Parsa (@pi0)
Luke Hagar (@LukeHagar)
39sho (@39sho)
Sandro Circi (@sandros94)
Jamaluddin Rumi (@jamaluddinrumi)

Contributors

jamaluddinrumi, pi0, and 3 other contributors

Assets2

3 people reacted

v0.3.1

10 Sep 21:11

pi0

v0.3.1

1f5411a

Compare

Choose a tag to compare

v0.3.1

compare changes

🩹 Fixes

types:AdapterOptions type (#80)

❤️ Contributors

Hayatosc (@hayatosc)

Assets2

2 people reacted

v0.3.0

04 Sep 20:14

pi0

v0.3.0

4a5e168

Compare

Choose a tag to compare

v0.3.0

compare changes

Important

Since this is a major version, ecosystem migration takes time. Stay tuned forlisthen,h3 andnitro dependency upgrades.

🌟 What is new?

Better stability

Crossws 0.3.x includes an overhaul of refactors, stability improvements, and new features. A new codebase and testing matrix had been implemented (#55) to make sure all supported adapters and runtimes work as expected and are consistent with each other.

Refined Peer API

The peer object allows easy interaction with connected WebSocket clients from server route hooks (peer docs).

To improve Web standards compatibility, accessing upgrade URL and headers is now possible withpeer.request.url andpeer.request.headers (breaking change), andpeer.addr is also renamed topeer.remoteAddress to improve readability (breaking change) and support is increased across providers. You can also use new lazy-generated and securepeer.id (UUID v4) for various purposes including temporary sessions or persistent state.

Two new methods are now supported to close connected peers usingpeer.close(code, reason) andpeer.terminate(). With this new version, you can access a standardWebSocket interface usingpeer.websocket.

Note

Today many of the server runtimes don't provide a spec-compliantWebSocket API. Crossws uses an internal proxy to polyfill consistent access toextensions,protocol, andreadyState. Seecompatibility table for more details.

Refined Message API

Onmessagehook, you receive a message object containing data from the client (message docs).

Parsing incoming messages can be tricky across runtimes. Message object now has stable methods.text(),.json(),.uint8Array(),.arrayBuffer(),.blob() to safely read message as desired format. If you need, you can also access.rawData,.peer,.event (if available), and lazy generated secure UUID v4.id

Authentication via`upgrade` hook

When you need to authenticate and validate WebSocket clients before they can upgrade, you can now easily use theupgrade hook to check incoming URLs and headers/cookies and return a Web StandardResponse in case you need to abort the upgrade.

Pubsub with Deno and Cloudflare Durable Objects

One of the common use cases of WebSockets is pubsub. This release adds pub-sub support toDeno provider and also you can globally broadcast messages usingws.publish for advanced use cases.

Normally with cloudflare workers, it is not possible to connect multiple peers with each other. CloudflareDurable Objects (available on paid plans) allows building collaborative editing tools, interactive chat, multiplayer games, and applications that need coordination among multiple clients.

Crossws provides a new composable method to easily integrate WebSocket handlers with Durable Objects. Hibernation is supported out of the box to reduce billing costs when connected clients are inactive. (durable object peer docs)

Changelog

🚀 Enhancements

⚠️ Overhaul internal implementation (#55)
⚠️ Overhaul peer and message interface (#70)
node, uws: Automatically detect binary message type (#53)
peer: Addpeer.close() andpeer.terminate() support (#36)
Cloudflare durable objects support (#54) (docs)
deno: Support pub/sub (#58)
Universal access to all peers (#60)
Global publish usingws.publish (#61)
Experimental SSE-based adapter to support websocket in limited runtimes (#62,#66,#68) (docs
peer: Use secure lazy random UUID v4 (#64)