Unofficial wrapper for CHZZK API

Alpha Notice

Functionality of this crate is barely tested and breaking changes are not only anticipated, but also planned.

Disclaimer / Usage Note

As this wrapper relies on undocumented CHZZK web API intended for use exclusively by the official apps, functionality may spontaneously break.¹ Do NOT use this library to collect or expose information that is not accessible via the official web app. Authors of this API wrapper disclaim any accountability for misuse of this software.

Async Runtime

Uses tokio::spawn for non-wasm environments, js_sys::future::spawn_local for wasm. If there's a demand for other executors, these may change.

Optional Features

• log: Uses log crate to log.
• time: Deserialize as time::OffsetDateTime instead of String or number type. Does not guarantee equal offset for all data.
• rustls(default): Use rustls TLS.
• native-tls: Use native-tls TLS.
• dump-on-de-err: Dump API response as str to stdout when deserialization fails.
• __example: Provides a slightly more ergonomic experience for writing examples; not intended to be enabled by library users.

Running Examples

Refer to the example README before running examples.

May Implement & Needs Improvement

No guarantees to timeline or if it will actually be implemented.

• Change websocket message Donation to Announcement and enumify body variant
• Get info about content that credential follows
• Observe and implement more chat message types
• Move code around to more intuitive locations
• Better documentation
• Less cloning of data for users
• Customizable chat client fingerprint

Footnotes

1. This was chosen as official, documented API for third party apps lacks many features and is incompatible with some use cases. ↩