Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 3.2 KB

File metadata and controls

63 lines (45 loc) · 3.2 KB

Changelog

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.

[Unreleased]

Added

  • Webhook handling spec helpers (CHA-2961): UnknownEvent class for forward-compat; GunzipPayload, DecodeSqsPayload, DecodeSnsPayload primitives; ParseEvent (returns typed event or UnknownEvent); VerifyAndParseWebhook HTTP composite; ParseSqs / ParseSns queue 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-string type field, gzip decompression failure, base64 decode failure, or malformed SNS envelope.
  • New instance methods on StreamClient (via BaseClient): VerifySignature(body, signature) and VerifyAndParseWebhook(body, signature) — drop the secret parameter in favor of the client's stored API secret. Dual API: static Webhook.* methods that take an explicit secret remain available.
  • New instance methods on StreamClient (via BaseClient): ParseSqs(string), ParseSns(string) (no signature; AWS IAM).
  • Conformance fixture suite under tests/fixtures/webhooks/.

Changed

  • No breaking changes.

Spec

[6.0.0] - 2026-03-05

Breaking Changes

  • Type names across all products now follow the OpenAPI spec naming convention: response types are suffixed with Response, input types with Request. See MIGRATION_v5_to_v6.md for the complete rename mapping.
  • Event (WebSocket envelope type) renamed to WSEvent. Base event type renamed from BaseEvent to Event (with field type instead of T).
  • Event composition changed from monolithic *Preset embeds to modular Has* types.
  • Pager renamed to PagerResponse and migrated from offset-based to cursor-based pagination (next/prev tokens).

Added

  • 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: WHEvent envelope 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.

[5.1.0] - 2026-02-18

[4.0.0] - 2025-09-30

[3.1.0] - 2025-07-15

[3.0.0] - 2025-06-01

[2.1.0] - 2025-03-15