stream-chat 5.6.0 → 6.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -114
- package/dist/browser.es.js +464 -366
- package/dist/browser.es.js.map +1 -1
- package/dist/browser.full-bundle.min.js +1 -1
- package/dist/browser.full-bundle.min.js.map +1 -1
- package/dist/browser.js +464 -366
- package/dist/browser.js.map +1 -1
- package/dist/index.es.js +464 -366
- package/dist/index.es.js.map +1 -1
- package/dist/index.js +464 -366
- package/dist/index.js.map +1 -1
- package/dist/types/channel.d.ts +124 -124
- package/dist/types/channel.d.ts.map +1 -1
- package/dist/types/channel_state.d.ts +41 -41
- package/dist/types/channel_state.d.ts.map +1 -1
- package/dist/types/client.d.ts +190 -163
- package/dist/types/client.d.ts.map +1 -1
- package/dist/types/client_state.d.ts +6 -6
- package/dist/types/client_state.d.ts.map +1 -1
- package/dist/types/connection.d.ts +10 -10
- package/dist/types/connection.d.ts.map +1 -1
- package/dist/types/connection_fallback.d.ts +7 -7
- package/dist/types/connection_fallback.d.ts.map +1 -1
- package/dist/types/insights.d.ts +2 -2
- package/dist/types/token_manager.d.ts +6 -6
- package/dist/types/token_manager.d.ts.map +1 -1
- package/dist/types/types.d.ts +404 -236
- package/dist/types/types.d.ts.map +1 -1
- package/dist/types/utils.d.ts +2 -2
- package/dist/types/utils.d.ts.map +1 -1
- package/package.json +2 -2
- package/src/channel.ts +196 -290
- package/src/channel_state.ts +54 -219
- package/src/client.ts +297 -524
- package/src/client_state.ts +6 -6
- package/src/connection.ts +7 -22
- package/src/connection_fallback.ts +7 -21
- package/src/token_manager.ts +6 -6
- package/src/types.ts +540 -487
- package/src/utils.ts +7 -11
|
@@ -1,26 +1,26 @@
|
|
|
1
1
|
import { Channel } from './channel';
|
|
2
|
-
import { ChannelMemberResponse, ChannelMembership, FormatMessageResponse, Event,
|
|
3
|
-
declare type ChannelReadStatus<
|
|
2
|
+
import { ChannelMemberResponse, ChannelMembership, FormatMessageResponse, Event, ExtendableGenerics, DefaultGenerics, MessageResponse, ReactionResponse, UserResponse } from './types';
|
|
3
|
+
declare type ChannelReadStatus<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Record<string, {
|
|
4
4
|
last_read: Date;
|
|
5
5
|
unread_messages: number;
|
|
6
|
-
user: UserResponse<
|
|
6
|
+
user: UserResponse<StreamChatGenerics>;
|
|
7
7
|
}>;
|
|
8
8
|
/**
|
|
9
9
|
* ChannelState - A container class for the channel state.
|
|
10
10
|
*/
|
|
11
|
-
export declare class ChannelState<
|
|
12
|
-
_channel: Channel<
|
|
11
|
+
export declare class ChannelState<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> {
|
|
12
|
+
_channel: Channel<StreamChatGenerics>;
|
|
13
13
|
watcher_count: number;
|
|
14
|
-
typing: Record<string, Event<
|
|
15
|
-
read: ChannelReadStatus<
|
|
16
|
-
messages: Array<ReturnType<ChannelState<
|
|
17
|
-
pinnedMessages: Array<ReturnType<ChannelState<
|
|
18
|
-
threads: Record<string, Array<ReturnType<ChannelState<
|
|
19
|
-
mutedUsers: Array<UserResponse<
|
|
20
|
-
watchers: Record<string, UserResponse<
|
|
21
|
-
members: Record<string, ChannelMemberResponse<
|
|
14
|
+
typing: Record<string, Event<StreamChatGenerics>>;
|
|
15
|
+
read: ChannelReadStatus<StreamChatGenerics>;
|
|
16
|
+
messages: Array<ReturnType<ChannelState<StreamChatGenerics>['formatMessage']>>;
|
|
17
|
+
pinnedMessages: Array<ReturnType<ChannelState<StreamChatGenerics>['formatMessage']>>;
|
|
18
|
+
threads: Record<string, Array<ReturnType<ChannelState<StreamChatGenerics>['formatMessage']>>>;
|
|
19
|
+
mutedUsers: Array<UserResponse<StreamChatGenerics>>;
|
|
20
|
+
watchers: Record<string, UserResponse<StreamChatGenerics>>;
|
|
21
|
+
members: Record<string, ChannelMemberResponse<StreamChatGenerics>>;
|
|
22
22
|
unreadCount: number;
|
|
23
|
-
membership: ChannelMembership<
|
|
23
|
+
membership: ChannelMembership<StreamChatGenerics>;
|
|
24
24
|
last_message_at: Date | null;
|
|
25
25
|
/**
|
|
26
26
|
* Flag which indicates if channel state contain latest/recent messages or no.
|
|
@@ -29,60 +29,60 @@ export declare class ChannelState<AttachmentType extends UR = UR, ChannelType ex
|
|
|
29
29
|
* be pushed on to message list.
|
|
30
30
|
*/
|
|
31
31
|
isUpToDate: boolean;
|
|
32
|
-
constructor(channel: Channel<
|
|
32
|
+
constructor(channel: Channel<StreamChatGenerics>);
|
|
33
33
|
/**
|
|
34
34
|
* addMessageSorted - Add a message to the state
|
|
35
35
|
*
|
|
36
|
-
* @param {MessageResponse<
|
|
36
|
+
* @param {MessageResponse<StreamChatGenerics>} newMessage A new message
|
|
37
37
|
* @param {boolean} timestampChanged Whether updating a message with changed created_at value.
|
|
38
38
|
* @param {boolean} addIfDoesNotExist Add message if it is not in the list, used to prevent out of order updated messages from being added.
|
|
39
39
|
*
|
|
40
40
|
*/
|
|
41
|
-
addMessageSorted(newMessage: MessageResponse<
|
|
41
|
+
addMessageSorted(newMessage: MessageResponse<StreamChatGenerics>, timestampChanged?: boolean, addIfDoesNotExist?: boolean): void;
|
|
42
42
|
/**
|
|
43
43
|
* formatMessage - Takes the message object. Parses the dates, sets __html
|
|
44
44
|
* and sets the status to received if missing. Returns a message object
|
|
45
45
|
*
|
|
46
|
-
* @param {MessageResponse<
|
|
46
|
+
* @param {MessageResponse<StreamChatGenerics>} message a message object
|
|
47
47
|
*
|
|
48
48
|
*/
|
|
49
|
-
formatMessage(message: MessageResponse<
|
|
49
|
+
formatMessage(message: MessageResponse<StreamChatGenerics>): FormatMessageResponse<StreamChatGenerics>;
|
|
50
50
|
/**
|
|
51
51
|
* addMessagesSorted - Add the list of messages to state and resorts the messages
|
|
52
52
|
*
|
|
53
|
-
* @param {Array<MessageResponse<
|
|
53
|
+
* @param {Array<MessageResponse<StreamChatGenerics>>} newMessages A list of messages
|
|
54
54
|
* @param {boolean} timestampChanged Whether updating messages with changed created_at value.
|
|
55
55
|
* @param {boolean} initializing Whether channel is being initialized.
|
|
56
56
|
* @param {boolean} addIfDoesNotExist Add message if it is not in the list, used to prevent out of order updated messages from being added.
|
|
57
57
|
*
|
|
58
58
|
*/
|
|
59
|
-
addMessagesSorted(newMessages: MessageResponse<
|
|
59
|
+
addMessagesSorted(newMessages: MessageResponse<StreamChatGenerics>[], timestampChanged?: boolean, initializing?: boolean, addIfDoesNotExist?: boolean): void;
|
|
60
60
|
/**
|
|
61
61
|
* addPinnedMessages - adds messages in pinnedMessages property
|
|
62
62
|
*
|
|
63
|
-
* @param {Array<MessageResponse<
|
|
63
|
+
* @param {Array<MessageResponse<StreamChatGenerics>>} pinnedMessages A list of pinned messages
|
|
64
64
|
*
|
|
65
65
|
*/
|
|
66
|
-
addPinnedMessages(pinnedMessages: MessageResponse<
|
|
66
|
+
addPinnedMessages(pinnedMessages: MessageResponse<StreamChatGenerics>[]): void;
|
|
67
67
|
/**
|
|
68
68
|
* addPinnedMessage - adds message in pinnedMessages
|
|
69
69
|
*
|
|
70
|
-
* @param {MessageResponse<
|
|
70
|
+
* @param {MessageResponse<StreamChatGenerics>} pinnedMessage message to update
|
|
71
71
|
*
|
|
72
72
|
*/
|
|
73
|
-
addPinnedMessage(pinnedMessage: MessageResponse<
|
|
73
|
+
addPinnedMessage(pinnedMessage: MessageResponse<StreamChatGenerics>): void;
|
|
74
74
|
/**
|
|
75
75
|
* removePinnedMessage - removes pinned message from pinnedMessages
|
|
76
76
|
*
|
|
77
|
-
* @param {MessageResponse<
|
|
77
|
+
* @param {MessageResponse<StreamChatGenerics>} message message to remove
|
|
78
78
|
*
|
|
79
79
|
*/
|
|
80
|
-
removePinnedMessage(message: MessageResponse<
|
|
81
|
-
addReaction(reaction: ReactionResponse<
|
|
82
|
-
_addOwnReactionToMessage(ownReactions: ReactionResponse<
|
|
83
|
-
_removeOwnReactionFromMessage(ownReactions: ReactionResponse<
|
|
84
|
-
removeReaction(reaction: ReactionResponse<
|
|
85
|
-
removeQuotedMessageReferences(message: MessageResponse<
|
|
80
|
+
removePinnedMessage(message: MessageResponse<StreamChatGenerics>): void;
|
|
81
|
+
addReaction(reaction: ReactionResponse<StreamChatGenerics>, message?: MessageResponse<StreamChatGenerics>, enforce_unique?: boolean): MessageResponse<StreamChatGenerics> | undefined;
|
|
82
|
+
_addOwnReactionToMessage(ownReactions: ReactionResponse<StreamChatGenerics>[] | null | undefined, reaction: ReactionResponse<StreamChatGenerics>, enforce_unique?: boolean): ReactionResponse<StreamChatGenerics>[];
|
|
83
|
+
_removeOwnReactionFromMessage(ownReactions: ReactionResponse<StreamChatGenerics>[] | null | undefined, reaction: ReactionResponse<StreamChatGenerics>): ReactionResponse<StreamChatGenerics>[] | null | undefined;
|
|
84
|
+
removeReaction(reaction: ReactionResponse<StreamChatGenerics>, message?: MessageResponse<StreamChatGenerics>): MessageResponse<StreamChatGenerics> | undefined;
|
|
85
|
+
removeQuotedMessageReferences(message: MessageResponse<StreamChatGenerics>): void;
|
|
86
86
|
/**
|
|
87
87
|
* Updates all instances of given message in channel state
|
|
88
88
|
* @param message
|
|
@@ -93,7 +93,7 @@ export declare class ChannelState<AttachmentType extends UR = UR, ChannelType ex
|
|
|
93
93
|
parent_id?: string;
|
|
94
94
|
pinned?: boolean;
|
|
95
95
|
show_in_channel?: boolean;
|
|
96
|
-
}, updateFunc: (msg: ReturnType<ChannelState<
|
|
96
|
+
}, updateFunc: (msg: ReturnType<ChannelState<StreamChatGenerics>['formatMessage']>) => ReturnType<ChannelState<StreamChatGenerics>['formatMessage']>): void;
|
|
97
97
|
/**
|
|
98
98
|
* Setter for isUpToDate.
|
|
99
99
|
*
|
|
@@ -106,13 +106,13 @@ export declare class ChannelState<AttachmentType extends UR = UR, ChannelType ex
|
|
|
106
106
|
/**
|
|
107
107
|
* _addToMessageList - Adds a message to a list of messages, tries to update first, appends if message isn't found
|
|
108
108
|
*
|
|
109
|
-
* @param {Array<ReturnType<ChannelState<
|
|
109
|
+
* @param {Array<ReturnType<ChannelState<StreamChatGenerics>['formatMessage']>>} messages A list of messages
|
|
110
110
|
* @param message
|
|
111
111
|
* @param {boolean} timestampChanged Whether updating a message with changed created_at value.
|
|
112
112
|
* @param {string} sortBy field name to use to sort the messages by
|
|
113
113
|
* @param {boolean} addIfDoesNotExist Add message if it is not in the list, used to prevent out of order updated messages from being added.
|
|
114
114
|
*/
|
|
115
|
-
_addToMessageList(messages: Array<ReturnType<ChannelState<
|
|
115
|
+
_addToMessageList(messages: Array<ReturnType<ChannelState<StreamChatGenerics>['formatMessage']>>, message: ReturnType<ChannelState<StreamChatGenerics>['formatMessage']>, timestampChanged?: boolean, sortBy?: 'pinned_at' | 'created_at', addIfDoesNotExist?: boolean): FormatMessageResponse<StreamChatGenerics>[];
|
|
116
116
|
/**
|
|
117
117
|
* removeMessage - Description
|
|
118
118
|
*
|
|
@@ -124,26 +124,26 @@ export declare class ChannelState<AttachmentType extends UR = UR, ChannelType ex
|
|
|
124
124
|
id: string;
|
|
125
125
|
parent_id?: string;
|
|
126
126
|
}): boolean;
|
|
127
|
-
removeMessageFromArray: (msgArray: Array<ReturnType<ChannelState<
|
|
127
|
+
removeMessageFromArray: (msgArray: Array<ReturnType<ChannelState<StreamChatGenerics>['formatMessage']>>, msg: {
|
|
128
128
|
id: string;
|
|
129
129
|
parent_id?: string;
|
|
130
130
|
}) => {
|
|
131
131
|
removed: boolean;
|
|
132
|
-
result: FormatMessageResponse<
|
|
132
|
+
result: FormatMessageResponse<StreamChatGenerics>[];
|
|
133
133
|
};
|
|
134
134
|
/**
|
|
135
135
|
* Updates the message.user property with updated user object, for messages.
|
|
136
136
|
*
|
|
137
|
-
* @param {UserResponse<
|
|
137
|
+
* @param {UserResponse<StreamChatGenerics>} user
|
|
138
138
|
*/
|
|
139
|
-
updateUserMessages: (user: UserResponse<
|
|
139
|
+
updateUserMessages: (user: UserResponse<StreamChatGenerics>) => void;
|
|
140
140
|
/**
|
|
141
141
|
* Marks the messages as deleted, from deleted user.
|
|
142
142
|
*
|
|
143
|
-
* @param {UserResponse<
|
|
143
|
+
* @param {UserResponse<StreamChatGenerics>} user
|
|
144
144
|
* @param {boolean} hardDelete
|
|
145
145
|
*/
|
|
146
|
-
deleteUserMessages: (user: UserResponse<
|
|
146
|
+
deleteUserMessages: (user: UserResponse<StreamChatGenerics>, hardDelete?: boolean) => void;
|
|
147
147
|
/**
|
|
148
148
|
* filterErrorMessages - Removes error messages from the channel state.
|
|
149
149
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"channel_state.d.ts","sourceRoot":"","sources":["../../src/channel_state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,qBAAqB,EACrB,KAAK,EACL,
|
|
1
|
+
{"version":3,"file":"channel_state.d.ts","sourceRoot":"","sources":["../../src/channel_state.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,qBAAqB,EACrB,KAAK,EACL,kBAAkB,EAClB,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,YAAY,EACb,MAAM,SAAS,CAAC;AAEjB,aAAK,iBAAiB,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe,IAAI,MAAM,CAC9F,MAAM,EACN;IAAE,SAAS,EAAE,IAAI,CAAC;IAAC,eAAe,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAAA;CAAE,CACrF,CAAC;AAEF;;GAEG;AACH,qBAAa,YAAY,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe;IACvF,QAAQ,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAClD,IAAI,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;IAC5C,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC/E,cAAc,EAAE,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IACrF,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9F,UAAU,EAAE,KAAK,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACpD,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAC3D,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IACnE,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,iBAAiB,CAAC,kBAAkB,CAAC,CAAC;IAClD,eAAe,EAAE,IAAI,GAAG,IAAI,CAAC;IAC7B;;;;;OAKG;IACH,UAAU,EAAE,OAAO,CAAC;gBACR,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC;IAwBhD;;;;;;;OAOG;IACH,gBAAgB,CACd,UAAU,EAAE,eAAe,CAAC,kBAAkB,CAAC,EAC/C,gBAAgB,UAAQ,EACxB,iBAAiB,UAAO;IAK1B;;;;;;OAMG;IACH,aAAa,CAAC,OAAO,EAAE,eAAe,CAAC,kBAAkB,CAAC,GAAG,qBAAqB,CAAC,kBAAkB,CAAC;IAetG;;;;;;;;OAQG;IACH,iBAAiB,CACf,WAAW,EAAE,eAAe,CAAC,kBAAkB,CAAC,EAAE,EAClD,gBAAgB,UAAQ,EACxB,YAAY,UAAQ,EACpB,iBAAiB,UAAO;IAuE1B;;;;;OAKG;IACH,iBAAiB,CAAC,cAAc,EAAE,eAAe,CAAC,kBAAkB,CAAC,EAAE;IAMvE;;;;;OAKG;IACH,gBAAgB,CAAC,aAAa,EAAE,eAAe,CAAC,kBAAkB,CAAC;IASnE;;;;;OAKG;IACH,mBAAmB,CAAC,OAAO,EAAE,eAAe,CAAC,kBAAkB,CAAC;IAKhE,WAAW,CACT,QAAQ,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,EAC9C,OAAO,CAAC,EAAE,eAAe,CAAC,kBAAkB,CAAC,EAC7C,cAAc,CAAC,EAAE,OAAO;IAW1B,wBAAwB,CACtB,YAAY,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,EAAE,GAAG,IAAI,GAAG,SAAS,EACvE,QAAQ,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,EAC9C,cAAc,CAAC,EAAE,OAAO;IAgB1B,6BAA6B,CAC3B,YAAY,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,EAAE,GAAG,IAAI,GAAG,SAAS,EACvE,QAAQ,EAAE,gBAAgB,CAAC,kBAAkB,CAAC;IAQhD,cAAc,CAAC,QAAQ,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC,EAAE,eAAe,CAAC,kBAAkB,CAAC;IAU5G,6BAA6B,CAAC,OAAO,EAAE,eAAe,CAAC,kBAAkB,CAAC;IAiB1E;;;;OAIG;IACH,cAAc,CACZ,OAAO,EAAE;QACP,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,eAAe,CAAC,EAAE,OAAO,CAAC;KAC3B,EACD,UAAU,EAAE,CACV,GAAG,EAAE,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,eAAe,CAAC,CAAC,KAC/D,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,eAAe,CAAC,CAAC;IA4BpE;;;;;;;OAOG;IACH,aAAa,eAAgB,OAAO,UAElC;IAEF;;;;;;;;OAQG;IACH,iBAAiB,CACf,QAAQ,EAAE,KAAK,CAAC,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,EAC9E,OAAO,EAAE,UAAU,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,eAAe,CAAC,CAAC,EACtE,gBAAgB,UAAQ,EACxB,MAAM,GAAE,WAAW,GAAG,YAA2B,EACjD,iBAAiB,UAAO;IA8D1B;;;;;;OAMG;IACH,aAAa,CAAC,eAAe,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE;IAmBjE,sBAAsB,aACV,MAAM,WAAW,aAAa,kBAAkB,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,OACzE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE;;;MAKvC;IAEF;;;;OAIG;IACH,kBAAkB,SAAU,aAAa,kBAAkB,CAAC,UAoB1D;IAEF;;;;;OAKG;IACH,kBAAkB,SAAU,aAAa,kBAAkB,CAAC,gCAkD1D;IAEF;;;OAGG;IACH,mBAAmB;IAMnB;;OAEG;IACH,KAAK;IAmBL,aAAa;CAId"}
|