All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Webhook handling spec helpers (CHA-2961):
UnknownEventclass for forward-compat;GunzipPayload,DecodeSqsPayload,DecodeSnsPayloadprimitives;ParseEvent(returns typed event orUnknownEvent);VerifyAndParseWebhookHTTP composite;ParseSqs/ParseSnsqueue composites (no signature — backend emits no HMAC for queue messages today; queue transports are secured via AWS IAM access controls). Transparent gzip via magic-byte detection. - New exception class:
Webhook.StreamInvalidWebhookException— unified failure type for signature mismatch, invalid JSON, missing/non-stringtypefield, gzip decompression failure, base64 decode failure, or malformed SNS envelope. - New instance methods on
StreamClient(viaBaseClient):VerifySignature(body, signature)andVerifyAndParseWebhook(body, signature)— drop thesecretparameter in favor of the client's stored API secret. Dual API: staticWebhook.*methods that take an explicit secret remain available. - New instance methods on
StreamClient(viaBaseClient):ParseSqs(string),ParseSns(string)(no signature; AWS IAM). - Conformance fixture suite under
tests/fixtures/webhooks/.
- No breaking changes.
- Type names across all products now follow the OpenAPI spec naming convention: response types are suffixed with
Response, input types withRequest. See MIGRATION_v5_to_v6.md for the complete rename mapping. Event(WebSocket envelope type) renamed toWSEvent. Base event type renamed fromBaseEventtoEvent(with fieldtypeinstead ofT).- Event composition changed from monolithic
*Presetembeds to modularHas*types. Pagerrenamed toPagerResponseand migrated from offset-based to cursor-based pagination (next/prevtokens).
- Full product coverage: Chat, Video, Moderation, and Feeds APIs are all supported in a single SDK.
- Feeds: activities, feeds, feed groups, follows, comments, reactions, collections, bookmarks, membership levels, feed views, and more.
- Video: calls, recordings, transcription, closed captions, SFU, call statistics, user feedback analytics, and more.
- Moderation: flags, review queue, moderation rules, config, appeals, moderation logs, and more.
- Push notification types, preferences, and templates.
- Webhook support:
WHEventenvelope class for receiving webhook payloads, utility methods for decoding and verifying webhook signatures, and a full set of individual typed event classes for every event across all products (Chat, Video, Moderation, Feeds) usable as discriminated event types. - Cursor-based pagination across all list endpoints.