fix!: replace StreamChatGenerics with module augmentation

[arnautov-anton]

fix: channel_role has been removed from the type of the members parameter of the Channel.inviteMembers method
fix: properties created_by and created_by_id have been added to ChannelData and ChannelQueryOptions types

BREAKING CHANGES:

• dropped StreamChatGenerics, use Custom<Entity>Data to extend your types
• type InviteOptions has been renamed to UpdateChannelOptions
• type UpdateChannelOptions has been renamed to UpdateChannelTypeRequest
• type ThreadResponseCustomData has been renamed to CustomThreadData
• type MarkAllReadOptions has been deleted in favour of type MarkChannelsReadOptions
• type QueryFilter no longer supports $ne and $nin operators
• type ChannelMembership has been deleted in favour of type ChannelMemberResponse
• function formatMessage (utils.ts) no longer returns __html property in the formatted message output

[github-actions]

Size Change: -344 B (-0.12%)

Total Size: 290 kB

Filename	Size	Change
dist/cjs/index.browser.cjs	82.1 kB	-119 B (-0.14%)
dist/cjs/index.node.cjs	126 kB	-112 B (-0.09%)
dist/esm/index.js	81.8 kB	-113 B (-0.14%)

_{compressed-size-action}

[arnautov-anton]

Might have to figure out a better way for this to work. Currently using keyof CustomCommandType to make it work with interface merging.

[arnautov-anton]

This right here: https://github.com/GetStream/stream-chat-js/pull/1458/files#diff-c54113cf61ec99691748a3890bfbeb00e10efb3f0a76f03a0fd9ec49072e410aR2124

Actual module augmentation would have to look something like:

// file.d.ts

import 'stream-chat';

declare module 'stream-chat' {
    interface CustomCommandType {
        customCommand: unknown;
        otherCustomCommand: unknown;
    }
}

[isekovanic]

Looks good ! We're already doing similar things for other parts of the RN SDK (extending functionality and overloads) so this will come natural.

The entire change is breaking I assume, right ? What's the strategy to go about merging this when the time comes ? I suppose all SDKs would need to bump their major versions if they wish to upgrade their version of stream-chat. Although kind of large in size, the change seems easy to do (if generics were being used in the first place).

[arnautov-anton]

Yes, in case of React SDK we'd be releasing v13.0.0 which will bump its stream-chat peer to v9.0.0 - the peer of the SDK is currently bound to v8-something.

As for the migration - see this draft of a migration guide here, feel free to suggest enhancements. Not sure where it'll live yet, I assume both React and RN will be similar in terms of migration but I'm open to adding tabs to switch between RN and React.

[isekovanic]

That's fair - in that case we should pick it up earlier rather than later since stream-chat is a direct dependency for stream-chat-react-native (and not a peer one).

Since we'll likely have to do a V7 to go along with it as well, maybe we can do the same ? it should get rid of our pesky TS errors when there's a version mismatch (despite the fact it's a direct dependency).

fyi @oliverlaz

[oliverlaz]

@isekovanic I agree!

We should have a similar guide, and also we need to update the following chapters:

• https://getstream.io/chat/docs/sdk/react/guides/typescript_and_generics/
• https://getstream.io/chat/docs/sdk/react-native/customization/typescript/