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
package/dist/types/types.d.ts
CHANGED
|
@@ -24,6 +24,24 @@ export declare type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T,
|
|
|
24
24
|
}[Keys];
|
|
25
25
|
export declare type UR = Record<string, unknown>;
|
|
26
26
|
export declare type UnknownType = UR;
|
|
27
|
+
export declare type DefaultGenerics = {
|
|
28
|
+
attachmentType: UR;
|
|
29
|
+
channelType: UR;
|
|
30
|
+
commandType: LiteralStringForUnion;
|
|
31
|
+
eventType: UR;
|
|
32
|
+
messageType: UR;
|
|
33
|
+
reactionType: UR;
|
|
34
|
+
userType: UR;
|
|
35
|
+
};
|
|
36
|
+
export declare type ExtendableGenerics = {
|
|
37
|
+
attachmentType: UR;
|
|
38
|
+
channelType: UR;
|
|
39
|
+
commandType: string;
|
|
40
|
+
eventType: UR;
|
|
41
|
+
messageType: UR;
|
|
42
|
+
reactionType: UR;
|
|
43
|
+
userType: UR;
|
|
44
|
+
};
|
|
27
45
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T extends (...args: any[]) => infer U ? U : T extends Promise<infer U> ? U : T;
|
|
28
46
|
/**
|
|
29
47
|
* Response Types
|
|
@@ -31,13 +49,13 @@ export declare type Unpacked<T> = T extends (infer U)[] ? U : T extends (...args
|
|
|
31
49
|
export declare type APIResponse = {
|
|
32
50
|
duration: string;
|
|
33
51
|
};
|
|
34
|
-
export declare type AppSettingsAPIResponse<
|
|
52
|
+
export declare type AppSettingsAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
35
53
|
app?: {
|
|
36
54
|
channel_configs: Record<string, {
|
|
37
55
|
automod?: ChannelConfigAutomod;
|
|
38
56
|
automod_behavior?: ChannelConfigAutomodBehavior;
|
|
39
57
|
blocklist_behavior?: ChannelConfigAutomodBehavior;
|
|
40
|
-
commands?: CommandVariants<
|
|
58
|
+
commands?: CommandVariants<StreamChatGenerics>[];
|
|
41
59
|
connect_events?: boolean;
|
|
42
60
|
created_at?: string;
|
|
43
61
|
custom_events?: boolean;
|
|
@@ -103,43 +121,64 @@ export declare type ModerationResult = {
|
|
|
103
121
|
blocklist_name?: string;
|
|
104
122
|
moderated_by?: string;
|
|
105
123
|
};
|
|
106
|
-
export declare type
|
|
124
|
+
export declare type AutomodDetails = {
|
|
125
|
+
action?: string;
|
|
126
|
+
image_labels?: Array<string>;
|
|
127
|
+
original_message_type?: string;
|
|
128
|
+
result?: ModerationResult;
|
|
129
|
+
};
|
|
130
|
+
export declare type FlagDetails = {
|
|
131
|
+
automod?: AutomodDetails;
|
|
132
|
+
};
|
|
133
|
+
export declare type Flag<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
134
|
+
created_at: string;
|
|
135
|
+
created_by_automod: boolean;
|
|
136
|
+
updated_at: string;
|
|
137
|
+
details?: FlagDetails;
|
|
138
|
+
target_message?: MessageResponse<StreamChatGenerics>;
|
|
139
|
+
target_user?: UserResponse<StreamChatGenerics>;
|
|
140
|
+
user?: UserResponse<StreamChatGenerics>;
|
|
141
|
+
};
|
|
142
|
+
export declare type FlagsResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
143
|
+
flags?: Array<Flag<StreamChatGenerics>>;
|
|
144
|
+
};
|
|
145
|
+
export declare type MessageFlagsResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
107
146
|
flags?: Array<{
|
|
108
|
-
message: MessageResponse<
|
|
109
|
-
user: UserResponse<
|
|
147
|
+
message: MessageResponse<StreamChatGenerics>;
|
|
148
|
+
user: UserResponse<StreamChatGenerics>;
|
|
110
149
|
approved_at?: string;
|
|
111
150
|
created_at?: string;
|
|
112
151
|
created_by_automod?: boolean;
|
|
113
152
|
moderation_result?: ModerationResult;
|
|
114
153
|
rejected_at?: string;
|
|
115
154
|
reviewed_at?: string;
|
|
116
|
-
reviewed_by?: UserResponse<
|
|
155
|
+
reviewed_by?: UserResponse<StreamChatGenerics>;
|
|
117
156
|
updated_at?: string;
|
|
118
157
|
}>;
|
|
119
158
|
};
|
|
120
|
-
export declare type FlagReport<
|
|
159
|
+
export declare type FlagReport<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
121
160
|
flags_count: number;
|
|
122
161
|
id: string;
|
|
123
|
-
message: MessageResponse<
|
|
124
|
-
user: UserResponse<
|
|
162
|
+
message: MessageResponse<StreamChatGenerics>;
|
|
163
|
+
user: UserResponse<StreamChatGenerics>;
|
|
125
164
|
created_at?: string;
|
|
126
|
-
details?:
|
|
165
|
+
details?: FlagDetails;
|
|
127
166
|
review_result?: string;
|
|
128
167
|
reviewed_at?: string;
|
|
129
|
-
reviewed_by?: UserResponse<
|
|
168
|
+
reviewed_by?: UserResponse<StreamChatGenerics>;
|
|
130
169
|
updated_at?: string;
|
|
131
170
|
};
|
|
132
|
-
export declare type FlagReportsResponse<
|
|
133
|
-
flag_reports: Array<FlagReport<
|
|
171
|
+
export declare type FlagReportsResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
172
|
+
flag_reports: Array<FlagReport<StreamChatGenerics>>;
|
|
134
173
|
};
|
|
135
|
-
export declare type ReviewFlagReportResponse<
|
|
136
|
-
flag_report: FlagReport<
|
|
174
|
+
export declare type ReviewFlagReportResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
175
|
+
flag_report: FlagReport<StreamChatGenerics>;
|
|
137
176
|
};
|
|
138
|
-
export declare type BannedUsersResponse<
|
|
177
|
+
export declare type BannedUsersResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
139
178
|
bans?: Array<{
|
|
140
|
-
user: UserResponse<
|
|
141
|
-
banned_by?: UserResponse<
|
|
142
|
-
channel?: ChannelResponse<
|
|
179
|
+
user: UserResponse<StreamChatGenerics>;
|
|
180
|
+
banned_by?: UserResponse<StreamChatGenerics>;
|
|
181
|
+
channel?: ChannelResponse<StreamChatGenerics>;
|
|
143
182
|
expires?: string;
|
|
144
183
|
ip_ban?: boolean;
|
|
145
184
|
reason?: string;
|
|
@@ -150,7 +189,7 @@ export declare type BlockListResponse = BlockList & {
|
|
|
150
189
|
created_at?: string;
|
|
151
190
|
updated_at?: string;
|
|
152
191
|
};
|
|
153
|
-
export declare type ChannelResponse<
|
|
192
|
+
export declare type ChannelResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = StreamChatGenerics['channelType'] & {
|
|
154
193
|
cid: string;
|
|
155
194
|
disabled: boolean;
|
|
156
195
|
frozen: boolean;
|
|
@@ -158,17 +197,17 @@ export declare type ChannelResponse<ChannelType = UR, CommandType extends string
|
|
|
158
197
|
type: string;
|
|
159
198
|
auto_translation_enabled?: boolean;
|
|
160
199
|
auto_translation_language?: TranslationLanguages | '';
|
|
161
|
-
config?: ChannelConfigWithInfo<
|
|
200
|
+
config?: ChannelConfigWithInfo<StreamChatGenerics>;
|
|
162
201
|
cooldown?: number;
|
|
163
202
|
created_at?: string;
|
|
164
|
-
created_by?: UserResponse<
|
|
203
|
+
created_by?: UserResponse<StreamChatGenerics> | null;
|
|
165
204
|
created_by_id?: string;
|
|
166
205
|
deleted_at?: string;
|
|
167
206
|
hidden?: boolean;
|
|
168
207
|
invites?: string[];
|
|
169
208
|
last_message_at?: string;
|
|
170
209
|
member_count?: number;
|
|
171
|
-
members?: ChannelMemberResponse<
|
|
210
|
+
members?: ChannelMemberResponse<StreamChatGenerics>[];
|
|
172
211
|
muted?: boolean;
|
|
173
212
|
name?: string;
|
|
174
213
|
own_capabilities?: string[];
|
|
@@ -176,25 +215,25 @@ export declare type ChannelResponse<ChannelType = UR, CommandType extends string
|
|
|
176
215
|
truncated_at?: string;
|
|
177
216
|
updated_at?: string;
|
|
178
217
|
};
|
|
179
|
-
export declare type ChannelAPIResponse<
|
|
180
|
-
channel: ChannelResponse<
|
|
181
|
-
members: ChannelMemberResponse<
|
|
182
|
-
messages: MessageResponse<
|
|
183
|
-
pinned_messages: MessageResponse<
|
|
218
|
+
export declare type ChannelAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
219
|
+
channel: ChannelResponse<StreamChatGenerics>;
|
|
220
|
+
members: ChannelMemberResponse<StreamChatGenerics>[];
|
|
221
|
+
messages: MessageResponse<StreamChatGenerics>[];
|
|
222
|
+
pinned_messages: MessageResponse<StreamChatGenerics>[];
|
|
184
223
|
hidden?: boolean;
|
|
185
|
-
membership?: ChannelMembership<
|
|
186
|
-
read?: ReadResponse<
|
|
224
|
+
membership?: ChannelMembership<StreamChatGenerics> | null;
|
|
225
|
+
read?: ReadResponse<StreamChatGenerics>[];
|
|
187
226
|
watcher_count?: number;
|
|
188
|
-
watchers?: UserResponse<
|
|
227
|
+
watchers?: UserResponse<StreamChatGenerics>[];
|
|
189
228
|
};
|
|
190
229
|
export declare type ChannelUpdateOptions = {
|
|
191
230
|
hide_history?: boolean;
|
|
192
231
|
skip_push?: boolean;
|
|
193
232
|
};
|
|
194
|
-
export declare type ChannelMemberAPIResponse<
|
|
195
|
-
members: ChannelMemberResponse<
|
|
233
|
+
export declare type ChannelMemberAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
234
|
+
members: ChannelMemberResponse<StreamChatGenerics>[];
|
|
196
235
|
};
|
|
197
|
-
export declare type ChannelMemberResponse<
|
|
236
|
+
export declare type ChannelMemberResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
198
237
|
banned?: boolean;
|
|
199
238
|
channel_role?: Role;
|
|
200
239
|
created_at?: string;
|
|
@@ -205,7 +244,7 @@ export declare type ChannelMemberResponse<UserType = UR> = {
|
|
|
205
244
|
role?: string;
|
|
206
245
|
shadow_banned?: boolean;
|
|
207
246
|
updated_at?: string;
|
|
208
|
-
user?: UserResponse<
|
|
247
|
+
user?: UserResponse<StreamChatGenerics>;
|
|
209
248
|
user_id?: string;
|
|
210
249
|
};
|
|
211
250
|
export declare type CheckPushResponse = APIResponse & {
|
|
@@ -226,29 +265,29 @@ export declare type CheckSQSResponse = APIResponse & {
|
|
|
226
265
|
data?: {};
|
|
227
266
|
error?: string;
|
|
228
267
|
};
|
|
229
|
-
export declare type CommandResponse<
|
|
268
|
+
export declare type CommandResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Partial<CreatedAtUpdatedAt> & {
|
|
230
269
|
args?: string;
|
|
231
270
|
description?: string;
|
|
232
|
-
name?: CommandVariants<
|
|
233
|
-
set?: CommandVariants<
|
|
271
|
+
name?: CommandVariants<StreamChatGenerics>;
|
|
272
|
+
set?: CommandVariants<StreamChatGenerics>;
|
|
234
273
|
};
|
|
235
|
-
export declare type ConnectAPIResponse<
|
|
236
|
-
export declare type CreateChannelResponse<
|
|
274
|
+
export declare type ConnectAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Promise<void | ConnectionOpen<StreamChatGenerics>>;
|
|
275
|
+
export declare type CreateChannelResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & Omit<CreateChannelOptions<StreamChatGenerics>, 'client_id' | 'connection_id'> & {
|
|
237
276
|
created_at: string;
|
|
238
277
|
updated_at: string;
|
|
239
278
|
grants?: Record<string, string[]>;
|
|
240
279
|
};
|
|
241
|
-
export declare type CreateCommandResponse<
|
|
242
|
-
command: CreateCommandOptions<
|
|
280
|
+
export declare type CreateCommandResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
281
|
+
command: CreateCommandOptions<StreamChatGenerics> & CreatedAtUpdatedAt;
|
|
243
282
|
};
|
|
244
|
-
export declare type DeleteChannelAPIResponse<
|
|
245
|
-
channel: ChannelResponse<
|
|
283
|
+
export declare type DeleteChannelAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
284
|
+
channel: ChannelResponse<StreamChatGenerics>;
|
|
246
285
|
};
|
|
247
|
-
export declare type DeleteCommandResponse<
|
|
248
|
-
name?: CommandVariants<
|
|
286
|
+
export declare type DeleteCommandResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
287
|
+
name?: CommandVariants<StreamChatGenerics>;
|
|
249
288
|
};
|
|
250
|
-
export declare type EventAPIResponse<
|
|
251
|
-
event: Event<
|
|
289
|
+
export declare type EventAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
290
|
+
event: Event<StreamChatGenerics>;
|
|
252
291
|
};
|
|
253
292
|
export declare type ExportChannelResponse = {
|
|
254
293
|
task_id: string;
|
|
@@ -262,13 +301,13 @@ export declare type ExportChannelStatusResponse = {
|
|
|
262
301
|
result?: {};
|
|
263
302
|
updated_at?: string;
|
|
264
303
|
};
|
|
265
|
-
export declare type FlagMessageResponse<
|
|
304
|
+
export declare type FlagMessageResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
266
305
|
flag: {
|
|
267
306
|
created_at: string;
|
|
268
307
|
created_by_automod: boolean;
|
|
269
308
|
target_message_id: string;
|
|
270
309
|
updated_at: string;
|
|
271
|
-
user: UserResponse<
|
|
310
|
+
user: UserResponse<StreamChatGenerics>;
|
|
272
311
|
approved_at?: string;
|
|
273
312
|
channel_cid?: string;
|
|
274
313
|
details?: Object;
|
|
@@ -278,13 +317,13 @@ export declare type FlagMessageResponse<UserType = UR> = APIResponse & {
|
|
|
278
317
|
reviewed_by?: string;
|
|
279
318
|
};
|
|
280
319
|
};
|
|
281
|
-
export declare type FlagUserResponse<
|
|
320
|
+
export declare type FlagUserResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
282
321
|
flag: {
|
|
283
322
|
created_at: string;
|
|
284
323
|
created_by_automod: boolean;
|
|
285
|
-
target_user: UserResponse<
|
|
324
|
+
target_user: UserResponse<StreamChatGenerics>;
|
|
286
325
|
updated_at: string;
|
|
287
|
-
user: UserResponse<
|
|
326
|
+
user: UserResponse<StreamChatGenerics>;
|
|
288
327
|
approved_at?: string;
|
|
289
328
|
details?: Object;
|
|
290
329
|
rejected_at?: string;
|
|
@@ -292,21 +331,29 @@ export declare type FlagUserResponse<UserType = UR> = APIResponse & {
|
|
|
292
331
|
reviewed_by?: string;
|
|
293
332
|
};
|
|
294
333
|
};
|
|
295
|
-
export declare type FormatMessageResponse<
|
|
334
|
+
export declare type FormatMessageResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Omit<MessageResponse<{
|
|
335
|
+
attachmentType: StreamChatGenerics['attachmentType'];
|
|
336
|
+
channelType: StreamChatGenerics['channelType'];
|
|
337
|
+
commandType: StreamChatGenerics['commandType'];
|
|
338
|
+
eventType: StreamChatGenerics['eventType'];
|
|
339
|
+
messageType: {};
|
|
340
|
+
reactionType: StreamChatGenerics['reactionType'];
|
|
341
|
+
userType: StreamChatGenerics['userType'];
|
|
342
|
+
}>, 'created_at' | 'pinned_at' | 'updated_at' | 'status'> & StreamChatGenerics['messageType'] & {
|
|
296
343
|
created_at: Date;
|
|
297
344
|
pinned_at: Date | null;
|
|
298
345
|
status: string;
|
|
299
346
|
updated_at: Date;
|
|
300
347
|
};
|
|
301
|
-
export declare type GetChannelTypeResponse<
|
|
348
|
+
export declare type GetChannelTypeResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & Omit<CreateChannelOptions<StreamChatGenerics>, 'client_id' | 'connection_id' | 'commands'> & {
|
|
302
349
|
created_at: string;
|
|
303
350
|
updated_at: string;
|
|
304
|
-
commands?: CommandResponse<
|
|
351
|
+
commands?: CommandResponse<StreamChatGenerics>[];
|
|
305
352
|
grants?: Record<string, string[]>;
|
|
306
353
|
};
|
|
307
|
-
export declare type GetCommandResponse<
|
|
308
|
-
export declare type GetMultipleMessagesAPIResponse<
|
|
309
|
-
messages: MessageResponse<
|
|
354
|
+
export declare type GetCommandResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & CreateCommandOptions<StreamChatGenerics> & CreatedAtUpdatedAt;
|
|
355
|
+
export declare type GetMultipleMessagesAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
356
|
+
messages: MessageResponse<StreamChatGenerics>[];
|
|
310
357
|
};
|
|
311
358
|
export declare type GetRateLimitsResponse = APIResponse & {
|
|
312
359
|
android?: RateLimitsMap;
|
|
@@ -314,36 +361,36 @@ export declare type GetRateLimitsResponse = APIResponse & {
|
|
|
314
361
|
server_side?: RateLimitsMap;
|
|
315
362
|
web?: RateLimitsMap;
|
|
316
363
|
};
|
|
317
|
-
export declare type GetReactionsAPIResponse<
|
|
318
|
-
reactions: ReactionResponse<
|
|
364
|
+
export declare type GetReactionsAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
365
|
+
reactions: ReactionResponse<StreamChatGenerics>[];
|
|
319
366
|
};
|
|
320
|
-
export declare type GetRepliesAPIResponse<
|
|
321
|
-
messages: MessageResponse<
|
|
367
|
+
export declare type GetRepliesAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
368
|
+
messages: MessageResponse<StreamChatGenerics>[];
|
|
322
369
|
};
|
|
323
|
-
export declare type ListChannelResponse<
|
|
324
|
-
channel_types: Record<string, Omit<CreateChannelOptions<
|
|
325
|
-
commands: CommandResponse<
|
|
370
|
+
export declare type ListChannelResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
371
|
+
channel_types: Record<string, Omit<CreateChannelOptions<StreamChatGenerics>, 'client_id' | 'connection_id' | 'commands'> & {
|
|
372
|
+
commands: CommandResponse<StreamChatGenerics>[];
|
|
326
373
|
created_at: string;
|
|
327
374
|
updated_at: string;
|
|
328
375
|
grants?: Record<string, string[]>;
|
|
329
376
|
}>;
|
|
330
377
|
};
|
|
331
|
-
export declare type ListChannelTypesAPIResponse<
|
|
332
|
-
export declare type ListCommandsResponse<
|
|
333
|
-
commands: Array<CreateCommandOptions<
|
|
378
|
+
export declare type ListChannelTypesAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = ListChannelResponse<StreamChatGenerics>;
|
|
379
|
+
export declare type ListCommandsResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
380
|
+
commands: Array<CreateCommandOptions<StreamChatGenerics> & Partial<CreatedAtUpdatedAt>>;
|
|
334
381
|
};
|
|
335
|
-
export declare type MuteChannelAPIResponse<
|
|
336
|
-
channel_mute: ChannelMute<
|
|
337
|
-
own_user: OwnUserResponse<
|
|
338
|
-
channel_mutes?: ChannelMute<
|
|
339
|
-
mute?: MuteResponse<
|
|
382
|
+
export declare type MuteChannelAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
383
|
+
channel_mute: ChannelMute<StreamChatGenerics>;
|
|
384
|
+
own_user: OwnUserResponse<StreamChatGenerics>;
|
|
385
|
+
channel_mutes?: ChannelMute<StreamChatGenerics>[];
|
|
386
|
+
mute?: MuteResponse<StreamChatGenerics>;
|
|
340
387
|
};
|
|
341
|
-
export declare type MessageResponse<
|
|
342
|
-
quoted_message?: MessageResponseBase<
|
|
388
|
+
export declare type MessageResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = MessageResponseBase<StreamChatGenerics> & {
|
|
389
|
+
quoted_message?: MessageResponseBase<StreamChatGenerics>;
|
|
343
390
|
};
|
|
344
|
-
export declare type MessageResponseBase<
|
|
391
|
+
export declare type MessageResponseBase<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = MessageBase<StreamChatGenerics> & {
|
|
345
392
|
args?: string;
|
|
346
|
-
channel?: ChannelResponse<
|
|
393
|
+
channel?: ChannelResponse<StreamChatGenerics>;
|
|
347
394
|
cid?: string;
|
|
348
395
|
command?: string;
|
|
349
396
|
command_info?: {
|
|
@@ -354,12 +401,12 @@ export declare type MessageResponseBase<AttachmentType = UR, ChannelType = UR, C
|
|
|
354
401
|
i18n?: RequireAtLeastOne<Record<`${TranslationLanguages}_text`, string>> & {
|
|
355
402
|
language: TranslationLanguages;
|
|
356
403
|
};
|
|
357
|
-
latest_reactions?: ReactionResponse<
|
|
358
|
-
mentioned_users?: UserResponse<
|
|
359
|
-
own_reactions?: ReactionResponse<
|
|
404
|
+
latest_reactions?: ReactionResponse<StreamChatGenerics>[];
|
|
405
|
+
mentioned_users?: UserResponse<StreamChatGenerics>[];
|
|
406
|
+
own_reactions?: ReactionResponse<StreamChatGenerics>[] | null;
|
|
360
407
|
pin_expires?: string | null;
|
|
361
408
|
pinned_at?: string | null;
|
|
362
|
-
pinned_by?: UserResponse<
|
|
409
|
+
pinned_by?: UserResponse<StreamChatGenerics> | null;
|
|
363
410
|
reaction_counts?: {
|
|
364
411
|
[key: string]: number;
|
|
365
412
|
} | null;
|
|
@@ -370,36 +417,36 @@ export declare type MessageResponseBase<AttachmentType = UR, ChannelType = UR, C
|
|
|
370
417
|
shadowed?: boolean;
|
|
371
418
|
silent?: boolean;
|
|
372
419
|
status?: string;
|
|
373
|
-
thread_participants?: UserResponse<
|
|
420
|
+
thread_participants?: UserResponse<StreamChatGenerics>[];
|
|
374
421
|
type?: MessageLabel;
|
|
375
422
|
updated_at?: string;
|
|
376
423
|
};
|
|
377
|
-
export declare type MuteResponse<
|
|
378
|
-
user: UserResponse<
|
|
424
|
+
export declare type MuteResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
425
|
+
user: UserResponse<StreamChatGenerics>;
|
|
379
426
|
created_at?: string;
|
|
380
427
|
expires?: string;
|
|
381
|
-
target?: UserResponse<
|
|
428
|
+
target?: UserResponse<StreamChatGenerics>;
|
|
382
429
|
updated_at?: string;
|
|
383
430
|
};
|
|
384
|
-
export declare type MuteUserResponse<
|
|
385
|
-
mute?: MuteResponse<
|
|
386
|
-
mutes?: Array<Mute<
|
|
387
|
-
own_user?: OwnUserResponse<
|
|
431
|
+
export declare type MuteUserResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
432
|
+
mute?: MuteResponse<StreamChatGenerics>;
|
|
433
|
+
mutes?: Array<Mute<StreamChatGenerics>>;
|
|
434
|
+
own_user?: OwnUserResponse<StreamChatGenerics>;
|
|
388
435
|
};
|
|
389
|
-
export declare type OwnUserBase<
|
|
390
|
-
channel_mutes: ChannelMute<
|
|
391
|
-
devices: Device<
|
|
392
|
-
mutes: Mute<
|
|
436
|
+
export declare type OwnUserBase<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
437
|
+
channel_mutes: ChannelMute<StreamChatGenerics>[];
|
|
438
|
+
devices: Device<StreamChatGenerics>[];
|
|
439
|
+
mutes: Mute<StreamChatGenerics>[];
|
|
393
440
|
total_unread_count: number;
|
|
394
441
|
unread_channels: number;
|
|
395
442
|
unread_count: number;
|
|
396
443
|
invisible?: boolean;
|
|
397
444
|
roles?: string[];
|
|
398
445
|
};
|
|
399
|
-
export declare type OwnUserResponse<
|
|
400
|
-
export declare type PartialUpdateChannelAPIResponse<
|
|
401
|
-
channel: ChannelResponse<
|
|
402
|
-
members: ChannelMemberResponse<
|
|
446
|
+
export declare type OwnUserResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = UserResponse<StreamChatGenerics> & OwnUserBase<StreamChatGenerics>;
|
|
447
|
+
export declare type PartialUpdateChannelAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
448
|
+
channel: ChannelResponse<StreamChatGenerics>;
|
|
449
|
+
members: ChannelMemberResponse<StreamChatGenerics>[];
|
|
403
450
|
};
|
|
404
451
|
export declare type PermissionAPIResponse = APIResponse & {
|
|
405
452
|
permission?: PermissionAPIObject;
|
|
@@ -407,22 +454,22 @@ export declare type PermissionAPIResponse = APIResponse & {
|
|
|
407
454
|
export declare type PermissionsAPIResponse = APIResponse & {
|
|
408
455
|
permissions?: PermissionAPIObject[];
|
|
409
456
|
};
|
|
410
|
-
export declare type ReactionAPIResponse<
|
|
411
|
-
message: MessageResponse<
|
|
412
|
-
reaction: ReactionResponse<
|
|
457
|
+
export declare type ReactionAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
458
|
+
message: MessageResponse<StreamChatGenerics>;
|
|
459
|
+
reaction: ReactionResponse<StreamChatGenerics>;
|
|
413
460
|
};
|
|
414
|
-
export declare type ReactionResponse<
|
|
461
|
+
export declare type ReactionResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Reaction<StreamChatGenerics> & {
|
|
415
462
|
created_at: string;
|
|
416
463
|
updated_at: string;
|
|
417
464
|
};
|
|
418
|
-
export declare type ReadResponse<
|
|
465
|
+
export declare type ReadResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
419
466
|
last_read: string;
|
|
420
|
-
user: UserResponse<
|
|
467
|
+
user: UserResponse<StreamChatGenerics>;
|
|
421
468
|
unread_messages?: number;
|
|
422
469
|
};
|
|
423
|
-
export declare type SearchAPIResponse<
|
|
470
|
+
export declare type SearchAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
424
471
|
results: {
|
|
425
|
-
message: MessageResponse<
|
|
472
|
+
message: MessageResponse<StreamChatGenerics>;
|
|
426
473
|
}[];
|
|
427
474
|
next?: string;
|
|
428
475
|
previous?: string;
|
|
@@ -437,39 +484,39 @@ export declare type SearchWarning = {
|
|
|
437
484
|
export declare type SendFileAPIResponse = APIResponse & {
|
|
438
485
|
file: string;
|
|
439
486
|
};
|
|
440
|
-
export declare type SendMessageAPIResponse<
|
|
441
|
-
message: MessageResponse<
|
|
487
|
+
export declare type SendMessageAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
488
|
+
message: MessageResponse<StreamChatGenerics>;
|
|
442
489
|
};
|
|
443
|
-
export declare type TruncateChannelAPIResponse<
|
|
444
|
-
channel: ChannelResponse<
|
|
445
|
-
message?: MessageResponse<
|
|
490
|
+
export declare type TruncateChannelAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
491
|
+
channel: ChannelResponse<StreamChatGenerics>;
|
|
492
|
+
message?: MessageResponse<StreamChatGenerics>;
|
|
446
493
|
};
|
|
447
|
-
export declare type UpdateChannelAPIResponse<
|
|
448
|
-
channel: ChannelResponse<
|
|
449
|
-
members: ChannelMemberResponse<
|
|
450
|
-
message?: MessageResponse<
|
|
494
|
+
export declare type UpdateChannelAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
495
|
+
channel: ChannelResponse<StreamChatGenerics>;
|
|
496
|
+
members: ChannelMemberResponse<StreamChatGenerics>[];
|
|
497
|
+
message?: MessageResponse<StreamChatGenerics>;
|
|
451
498
|
};
|
|
452
|
-
export declare type UpdateChannelResponse<
|
|
499
|
+
export declare type UpdateChannelResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & Omit<CreateChannelOptions<StreamChatGenerics>, 'client_id' | 'connection_id'> & {
|
|
453
500
|
created_at: string;
|
|
454
501
|
updated_at: string;
|
|
455
502
|
};
|
|
456
|
-
export declare type UpdateCommandResponse<
|
|
457
|
-
command: UpdateCommandOptions<
|
|
458
|
-
name: CommandVariants<
|
|
503
|
+
export declare type UpdateCommandResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
504
|
+
command: UpdateCommandOptions<StreamChatGenerics> & CreatedAtUpdatedAt & {
|
|
505
|
+
name: CommandVariants<StreamChatGenerics>;
|
|
459
506
|
};
|
|
460
507
|
};
|
|
461
|
-
export declare type UpdateMessageAPIResponse<
|
|
462
|
-
message: MessageResponse<
|
|
508
|
+
export declare type UpdateMessageAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
509
|
+
message: MessageResponse<StreamChatGenerics>;
|
|
463
510
|
};
|
|
464
|
-
export declare type UsersAPIResponse<
|
|
465
|
-
users: Array<UserResponse<
|
|
511
|
+
export declare type UsersAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
512
|
+
users: Array<UserResponse<StreamChatGenerics>>;
|
|
466
513
|
};
|
|
467
|
-
export declare type UpdateUsersAPIResponse<
|
|
514
|
+
export declare type UpdateUsersAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
468
515
|
users: {
|
|
469
|
-
[key: string]: UserResponse<
|
|
516
|
+
[key: string]: UserResponse<StreamChatGenerics>;
|
|
470
517
|
};
|
|
471
518
|
};
|
|
472
|
-
export declare type UserResponse<
|
|
519
|
+
export declare type UserResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = User<StreamChatGenerics> & {
|
|
473
520
|
banned?: boolean;
|
|
474
521
|
created_at?: string;
|
|
475
522
|
deactivated_at?: string;
|
|
@@ -493,6 +540,10 @@ export declare type MessageFlagsPaginationOptions = {
|
|
|
493
540
|
limit?: number;
|
|
494
541
|
offset?: number;
|
|
495
542
|
};
|
|
543
|
+
export declare type FlagsPaginationOptions = {
|
|
544
|
+
limit?: number;
|
|
545
|
+
offset?: number;
|
|
546
|
+
};
|
|
496
547
|
export declare type FlagReportsPaginationOptions = {
|
|
497
548
|
limit?: number;
|
|
498
549
|
offset?: number;
|
|
@@ -502,8 +553,8 @@ export declare type ReviewFlagReportOptions = {
|
|
|
502
553
|
user_id?: string;
|
|
503
554
|
};
|
|
504
555
|
export declare type BannedUsersPaginationOptions = Omit<PaginationOptions, 'id_gt' | 'id_gte' | 'id_lt' | 'id_lte'>;
|
|
505
|
-
export declare type BanUserOptions<
|
|
506
|
-
banned_by?: UserResponse<
|
|
556
|
+
export declare type BanUserOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = UnBanUserOptions & {
|
|
557
|
+
banned_by?: UserResponse<StreamChatGenerics>;
|
|
507
558
|
banned_by_id?: string;
|
|
508
559
|
ip_ban?: boolean;
|
|
509
560
|
reason?: string;
|
|
@@ -519,10 +570,10 @@ export declare type ChannelOptions = {
|
|
|
519
570
|
user_id?: string;
|
|
520
571
|
watch?: boolean;
|
|
521
572
|
};
|
|
522
|
-
export declare type ChannelQueryOptions<
|
|
573
|
+
export declare type ChannelQueryOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
523
574
|
client_id?: string;
|
|
524
575
|
connection_id?: string;
|
|
525
|
-
data?: ChannelResponse<
|
|
576
|
+
data?: ChannelResponse<StreamChatGenerics>;
|
|
526
577
|
members?: PaginationOptions;
|
|
527
578
|
messages?: MessagePaginationOptions;
|
|
528
579
|
presence?: boolean;
|
|
@@ -533,14 +584,14 @@ export declare type ChannelQueryOptions<ChannelType = UR, CommandType extends st
|
|
|
533
584
|
export declare type ChannelStateOptions = {
|
|
534
585
|
skipInitialization?: string[];
|
|
535
586
|
};
|
|
536
|
-
export declare type CreateChannelOptions<
|
|
587
|
+
export declare type CreateChannelOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
537
588
|
automod?: ChannelConfigAutomod;
|
|
538
589
|
automod_behavior?: ChannelConfigAutomodBehavior;
|
|
539
590
|
automod_thresholds?: ChannelConfigAutomodThresholds;
|
|
540
591
|
blocklist?: string;
|
|
541
592
|
blocklist_behavior?: ChannelConfigAutomodBehavior;
|
|
542
593
|
client_id?: string;
|
|
543
|
-
commands?: CommandVariants<
|
|
594
|
+
commands?: CommandVariants<StreamChatGenerics>[];
|
|
544
595
|
connect_events?: boolean;
|
|
545
596
|
connection_id?: string;
|
|
546
597
|
custom_events?: boolean;
|
|
@@ -560,11 +611,11 @@ export declare type CreateChannelOptions<CommandType extends string = LiteralStr
|
|
|
560
611
|
uploads?: boolean;
|
|
561
612
|
url_enrichment?: boolean;
|
|
562
613
|
};
|
|
563
|
-
export declare type CreateCommandOptions<
|
|
614
|
+
export declare type CreateCommandOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
564
615
|
description: string;
|
|
565
|
-
name: CommandVariants<
|
|
616
|
+
name: CommandVariants<StreamChatGenerics>;
|
|
566
617
|
args?: string;
|
|
567
|
-
set?: CommandVariants<
|
|
618
|
+
set?: CommandVariants<StreamChatGenerics>;
|
|
568
619
|
};
|
|
569
620
|
export declare type CustomPermissionOptions = {
|
|
570
621
|
action: string;
|
|
@@ -575,38 +626,38 @@ export declare type CustomPermissionOptions = {
|
|
|
575
626
|
owner?: boolean;
|
|
576
627
|
same_team?: boolean;
|
|
577
628
|
};
|
|
578
|
-
export declare type InviteOptions<
|
|
629
|
+
export declare type InviteOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
579
630
|
accept_invite?: boolean;
|
|
580
631
|
add_members?: string[];
|
|
581
632
|
add_moderators?: string[];
|
|
582
633
|
client_id?: string;
|
|
583
634
|
connection_id?: string;
|
|
584
|
-
data?: Omit<ChannelResponse<
|
|
635
|
+
data?: Omit<ChannelResponse<StreamChatGenerics>, 'id' | 'cid'>;
|
|
585
636
|
demote_moderators?: string[];
|
|
586
637
|
invites?: string[];
|
|
587
|
-
message?: MessageResponse<
|
|
638
|
+
message?: MessageResponse<StreamChatGenerics>;
|
|
588
639
|
reject_invite?: boolean;
|
|
589
640
|
remove_members?: string[];
|
|
590
|
-
user?: UserResponse<
|
|
641
|
+
user?: UserResponse<StreamChatGenerics>;
|
|
591
642
|
user_id?: string;
|
|
592
643
|
};
|
|
593
644
|
/** @deprecated use MarkChannelsReadOptions instead */
|
|
594
|
-
export declare type MarkAllReadOptions<
|
|
595
|
-
export declare type MarkChannelsReadOptions<
|
|
645
|
+
export declare type MarkAllReadOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = MarkChannelsReadOptions<StreamChatGenerics>;
|
|
646
|
+
export declare type MarkChannelsReadOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
596
647
|
client_id?: string;
|
|
597
648
|
connection_id?: string;
|
|
598
649
|
read_by_channel?: Record<string, string>;
|
|
599
|
-
user?: UserResponse<
|
|
650
|
+
user?: UserResponse<StreamChatGenerics>;
|
|
600
651
|
user_id?: string;
|
|
601
652
|
};
|
|
602
|
-
export declare type MarkReadOptions<
|
|
653
|
+
export declare type MarkReadOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
603
654
|
client_id?: string;
|
|
604
655
|
connection_id?: string;
|
|
605
656
|
message_id?: string;
|
|
606
|
-
user?: UserResponse<
|
|
657
|
+
user?: UserResponse<StreamChatGenerics>;
|
|
607
658
|
user_id?: string;
|
|
608
659
|
};
|
|
609
|
-
export declare type MuteUserOptions<
|
|
660
|
+
export declare type MuteUserOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
610
661
|
client_id?: string;
|
|
611
662
|
connection_id?: string;
|
|
612
663
|
id?: string;
|
|
@@ -614,7 +665,7 @@ export declare type MuteUserOptions<UserType = UR> = {
|
|
|
614
665
|
target_user_id?: string;
|
|
615
666
|
timeout?: number;
|
|
616
667
|
type?: string;
|
|
617
|
-
user?: UserResponse<
|
|
668
|
+
user?: UserResponse<StreamChatGenerics>;
|
|
618
669
|
user_id?: string;
|
|
619
670
|
};
|
|
620
671
|
export declare type PaginationOptions = {
|
|
@@ -655,11 +706,11 @@ export declare type QueryMembersOptions = {
|
|
|
655
706
|
user_id_lt?: string;
|
|
656
707
|
user_id_lte?: string;
|
|
657
708
|
};
|
|
658
|
-
export declare type SearchOptions<
|
|
709
|
+
export declare type SearchOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
659
710
|
limit?: number;
|
|
660
711
|
next?: string;
|
|
661
712
|
offset?: number;
|
|
662
|
-
sort?: SearchMessageSort<
|
|
713
|
+
sort?: SearchMessageSort<StreamChatGenerics>;
|
|
663
714
|
};
|
|
664
715
|
export declare type StreamChatOptions = AxiosRequestConfig & {
|
|
665
716
|
/**
|
|
@@ -697,14 +748,14 @@ export declare type UnBanUserOptions = {
|
|
|
697
748
|
target_user_id?: string;
|
|
698
749
|
type?: string;
|
|
699
750
|
};
|
|
700
|
-
export declare type UpdateChannelOptions<
|
|
751
|
+
export declare type UpdateChannelOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Omit<CreateChannelOptions<StreamChatGenerics>, 'name'> & {
|
|
701
752
|
created_at?: string;
|
|
702
753
|
updated_at?: string;
|
|
703
754
|
};
|
|
704
|
-
export declare type UpdateCommandOptions<
|
|
755
|
+
export declare type UpdateCommandOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
705
756
|
description: string;
|
|
706
757
|
args?: string;
|
|
707
|
-
set?: CommandVariants<
|
|
758
|
+
set?: CommandVariants<StreamChatGenerics>;
|
|
708
759
|
};
|
|
709
760
|
export declare type UserOptions = {
|
|
710
761
|
limit?: number;
|
|
@@ -718,9 +769,9 @@ export declare type ConnectionChangeEvent = {
|
|
|
718
769
|
type: EventTypes;
|
|
719
770
|
online?: boolean;
|
|
720
771
|
};
|
|
721
|
-
export declare type Event<
|
|
772
|
+
export declare type Event<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = StreamChatGenerics['eventType'] & {
|
|
722
773
|
type: EventTypes;
|
|
723
|
-
channel?: ChannelResponse<
|
|
774
|
+
channel?: ChannelResponse<StreamChatGenerics>;
|
|
724
775
|
channel_id?: string;
|
|
725
776
|
channel_type?: string;
|
|
726
777
|
cid?: string;
|
|
@@ -729,25 +780,25 @@ export declare type Event<AttachmentType extends UR = UR, ChannelType extends UR
|
|
|
729
780
|
created_at?: string;
|
|
730
781
|
hard_delete?: boolean;
|
|
731
782
|
mark_messages_deleted?: boolean;
|
|
732
|
-
me?: OwnUserResponse<
|
|
733
|
-
member?: ChannelMemberResponse<
|
|
734
|
-
message?: MessageResponse<
|
|
783
|
+
me?: OwnUserResponse<StreamChatGenerics>;
|
|
784
|
+
member?: ChannelMemberResponse<StreamChatGenerics>;
|
|
785
|
+
message?: MessageResponse<StreamChatGenerics>;
|
|
735
786
|
online?: boolean;
|
|
736
787
|
parent_id?: string;
|
|
737
|
-
reaction?: ReactionResponse<
|
|
788
|
+
reaction?: ReactionResponse<StreamChatGenerics>;
|
|
738
789
|
received_at?: string | Date;
|
|
739
790
|
team?: string;
|
|
740
791
|
total_unread_count?: number;
|
|
741
792
|
unread_channels?: number;
|
|
742
793
|
unread_count?: number;
|
|
743
|
-
user?: UserResponse<
|
|
794
|
+
user?: UserResponse<StreamChatGenerics>;
|
|
744
795
|
user_id?: string;
|
|
745
796
|
watcher_count?: number;
|
|
746
797
|
};
|
|
747
|
-
export declare type UserCustomEvent<
|
|
798
|
+
export declare type UserCustomEvent<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = StreamChatGenerics['eventType'] & {
|
|
748
799
|
type: string;
|
|
749
800
|
};
|
|
750
|
-
export declare type EventHandler<
|
|
801
|
+
export declare type EventHandler<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = (event: Event<StreamChatGenerics>) => void;
|
|
751
802
|
export declare type EventTypes = 'all' | keyof typeof EVENT_MAP;
|
|
752
803
|
/**
|
|
753
804
|
* Filter Types
|
|
@@ -768,10 +819,32 @@ export declare type MessageFlagsFilters = QueryFilters<{
|
|
|
768
819
|
} & {
|
|
769
820
|
[Key in keyof Omit<MessageFlagsFiltersOptions, 'channel_cid' | 'user_id' | 'is_reviewed'>]: RequireOnlyOne<QueryFilter<MessageFlagsFiltersOptions[Key]>> | PrimitiveFilter<MessageFlagsFiltersOptions[Key]>;
|
|
770
821
|
}>;
|
|
822
|
+
export declare type FlagsFiltersOptions = {
|
|
823
|
+
channel_cid?: string;
|
|
824
|
+
message_id?: string;
|
|
825
|
+
message_user_id?: string;
|
|
826
|
+
reporter_id?: string;
|
|
827
|
+
team?: string;
|
|
828
|
+
user_id?: string;
|
|
829
|
+
};
|
|
830
|
+
export declare type FlagsFilters = QueryFilters<{
|
|
831
|
+
user_id?: RequireOnlyOne<Pick<QueryFilter<FlagsFiltersOptions['user_id']>, '$eq' | '$in'>> | PrimitiveFilter<FlagsFiltersOptions['user_id']>;
|
|
832
|
+
} & {
|
|
833
|
+
message_id?: RequireOnlyOne<Pick<QueryFilter<FlagsFiltersOptions['message_id']>, '$eq' | '$in'>> | PrimitiveFilter<FlagsFiltersOptions['message_id']>;
|
|
834
|
+
} & {
|
|
835
|
+
message_user_id?: RequireOnlyOne<Pick<QueryFilter<FlagsFiltersOptions['message_user_id']>, '$eq' | '$in'>> | PrimitiveFilter<FlagsFiltersOptions['message_user_id']>;
|
|
836
|
+
} & {
|
|
837
|
+
channel_cid?: RequireOnlyOne<Pick<QueryFilter<FlagsFiltersOptions['channel_cid']>, '$eq' | '$in'>> | PrimitiveFilter<FlagsFiltersOptions['channel_cid']>;
|
|
838
|
+
} & {
|
|
839
|
+
reporter_id?: RequireOnlyOne<Pick<QueryFilter<FlagsFiltersOptions['reporter_id']>, '$eq' | '$in'>> | PrimitiveFilter<FlagsFiltersOptions['reporter_id']>;
|
|
840
|
+
} & {
|
|
841
|
+
team?: RequireOnlyOne<Pick<QueryFilter<FlagsFiltersOptions['team']>, '$eq' | '$in'>> | PrimitiveFilter<FlagsFiltersOptions['team']>;
|
|
842
|
+
}>;
|
|
771
843
|
export declare type FlagReportsFiltersOptions = {
|
|
772
844
|
channel_cid?: string;
|
|
773
845
|
is_reviewed?: boolean;
|
|
774
846
|
message_id?: string;
|
|
847
|
+
message_user_id?: string;
|
|
775
848
|
report_id?: string;
|
|
776
849
|
review_result?: string;
|
|
777
850
|
reviewed_by?: string;
|
|
@@ -788,6 +861,8 @@ export declare type FlagReportsFilters = QueryFilters<{
|
|
|
788
861
|
user_id?: RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['user_id']>, '$eq' | '$in'>> | PrimitiveFilter<FlagReportsFiltersOptions['user_id']>;
|
|
789
862
|
} & {
|
|
790
863
|
message_id?: RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['message_id']>, '$eq' | '$in'>> | PrimitiveFilter<FlagReportsFiltersOptions['message_id']>;
|
|
864
|
+
} & {
|
|
865
|
+
message_user_id?: RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['message_user_id']>, '$eq' | '$in'>> | PrimitiveFilter<FlagReportsFiltersOptions['message_user_id']>;
|
|
791
866
|
} & {
|
|
792
867
|
channel_cid?: RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['channel_cid']>, '$eq' | '$in'>> | PrimitiveFilter<FlagReportsFiltersOptions['channel_cid']>;
|
|
793
868
|
} & {
|
|
@@ -811,27 +886,75 @@ export declare type BannedUsersFilters = QueryFilters<{
|
|
|
811
886
|
} & {
|
|
812
887
|
[Key in keyof Omit<BannedUsersFilterOptions, 'channel_cid' | 'reason'>]: RequireOnlyOne<QueryFilter<BannedUsersFilterOptions[Key]>> | PrimitiveFilter<BannedUsersFilterOptions[Key]>;
|
|
813
888
|
}>;
|
|
814
|
-
export declare type ChannelFilters<
|
|
889
|
+
export declare type ChannelFilters<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = QueryFilters<ContainsOperator<StreamChatGenerics['channelType']> & {
|
|
815
890
|
members?: RequireOnlyOne<Pick<QueryFilter<string>, '$in' | '$nin'>> | RequireOnlyOne<Pick<QueryFilter<string[]>, '$eq'>> | PrimitiveFilter<string[]>;
|
|
816
891
|
} & {
|
|
817
892
|
name?: RequireOnlyOne<{
|
|
818
|
-
$autocomplete?: ChannelResponse<
|
|
819
|
-
} & QueryFilter<ChannelResponse<
|
|
893
|
+
$autocomplete?: ChannelResponse<StreamChatGenerics>['name'];
|
|
894
|
+
} & QueryFilter<ChannelResponse<StreamChatGenerics>['name']>> | PrimitiveFilter<ChannelResponse<StreamChatGenerics>['name']>;
|
|
820
895
|
} & {
|
|
821
|
-
[Key in keyof Omit<ChannelResponse<{
|
|
896
|
+
[Key in keyof Omit<ChannelResponse<{
|
|
897
|
+
attachmentType: StreamChatGenerics['attachmentType'];
|
|
898
|
+
channelType: {};
|
|
899
|
+
commandType: StreamChatGenerics['commandType'];
|
|
900
|
+
eventType: StreamChatGenerics['eventType'];
|
|
901
|
+
messageType: StreamChatGenerics['messageType'];
|
|
902
|
+
reactionType: StreamChatGenerics['reactionType'];
|
|
903
|
+
userType: StreamChatGenerics['userType'];
|
|
904
|
+
}>, 'name' | 'members'>]: RequireOnlyOne<QueryFilter<ChannelResponse<{
|
|
905
|
+
attachmentType: StreamChatGenerics['attachmentType'];
|
|
906
|
+
channelType: {};
|
|
907
|
+
commandType: StreamChatGenerics['commandType'];
|
|
908
|
+
eventType: StreamChatGenerics['eventType'];
|
|
909
|
+
messageType: StreamChatGenerics['messageType'];
|
|
910
|
+
reactionType: StreamChatGenerics['reactionType'];
|
|
911
|
+
userType: StreamChatGenerics['userType'];
|
|
912
|
+
}>[Key]>> | PrimitiveFilter<ChannelResponse<{
|
|
913
|
+
attachmentType: StreamChatGenerics['attachmentType'];
|
|
914
|
+
channelType: {};
|
|
915
|
+
commandType: StreamChatGenerics['commandType'];
|
|
916
|
+
eventType: StreamChatGenerics['eventType'];
|
|
917
|
+
messageType: StreamChatGenerics['messageType'];
|
|
918
|
+
reactionType: StreamChatGenerics['reactionType'];
|
|
919
|
+
userType: StreamChatGenerics['userType'];
|
|
920
|
+
}>[Key]>;
|
|
822
921
|
}>;
|
|
823
922
|
export declare type ContainsOperator<CustomType = {}> = {
|
|
824
923
|
[Key in keyof CustomType]?: CustomType[Key] extends (infer ContainType)[] ? RequireOnlyOne<{
|
|
825
924
|
$contains?: ContainType extends object ? PrimitiveFilter<RequireAtLeastOne<ContainType>> : PrimitiveFilter<ContainType>;
|
|
826
925
|
} & QueryFilter<PrimitiveFilter<ContainType>[]>> | PrimitiveFilter<PrimitiveFilter<ContainType>[]> : RequireOnlyOne<QueryFilter<CustomType[Key]>> | PrimitiveFilter<CustomType[Key]>;
|
|
827
926
|
};
|
|
828
|
-
export declare type MessageFilters<
|
|
927
|
+
export declare type MessageFilters<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = QueryFilters<ContainsOperator<StreamChatGenerics['messageType']> & {
|
|
829
928
|
text?: RequireOnlyOne<{
|
|
830
|
-
$autocomplete?: MessageResponse<
|
|
831
|
-
$q?: MessageResponse<
|
|
832
|
-
} & QueryFilter<MessageResponse<
|
|
929
|
+
$autocomplete?: MessageResponse<StreamChatGenerics>['text'];
|
|
930
|
+
$q?: MessageResponse<StreamChatGenerics>['text'];
|
|
931
|
+
} & QueryFilter<MessageResponse<StreamChatGenerics>['text']>> | PrimitiveFilter<MessageResponse<StreamChatGenerics>['text']>;
|
|
833
932
|
} & {
|
|
834
|
-
[Key in keyof Omit<MessageResponse<
|
|
933
|
+
[Key in keyof Omit<MessageResponse<{
|
|
934
|
+
attachmentType: StreamChatGenerics['attachmentType'];
|
|
935
|
+
channelType: StreamChatGenerics['channelType'];
|
|
936
|
+
commandType: StreamChatGenerics['commandType'];
|
|
937
|
+
eventType: StreamChatGenerics['eventType'];
|
|
938
|
+
messageType: {};
|
|
939
|
+
reactionType: StreamChatGenerics['reactionType'];
|
|
940
|
+
userType: StreamChatGenerics['userType'];
|
|
941
|
+
}>, 'text'>]?: RequireOnlyOne<QueryFilter<MessageResponse<{
|
|
942
|
+
attachmentType: StreamChatGenerics['attachmentType'];
|
|
943
|
+
channelType: StreamChatGenerics['channelType'];
|
|
944
|
+
commandType: StreamChatGenerics['commandType'];
|
|
945
|
+
eventType: StreamChatGenerics['eventType'];
|
|
946
|
+
messageType: {};
|
|
947
|
+
reactionType: StreamChatGenerics['reactionType'];
|
|
948
|
+
userType: StreamChatGenerics['userType'];
|
|
949
|
+
}>[Key]>> | PrimitiveFilter<MessageResponse<{
|
|
950
|
+
attachmentType: StreamChatGenerics['attachmentType'];
|
|
951
|
+
channelType: StreamChatGenerics['channelType'];
|
|
952
|
+
commandType: StreamChatGenerics['commandType'];
|
|
953
|
+
eventType: StreamChatGenerics['eventType'];
|
|
954
|
+
messageType: {};
|
|
955
|
+
reactionType: StreamChatGenerics['reactionType'];
|
|
956
|
+
userType: StreamChatGenerics['userType'];
|
|
957
|
+
}>[Key]>;
|
|
835
958
|
}>;
|
|
836
959
|
export declare type PrimitiveFilter<ObjectType> = ObjectType | null;
|
|
837
960
|
export declare type QueryFilter<ObjectType = string> = NonNullable<ObjectType> extends string | number | boolean ? {
|
|
@@ -859,22 +982,46 @@ export declare type QueryLogicalOperators<Operators> = {
|
|
|
859
982
|
$nor?: ArrayOneOrMore<QueryFilters<Operators>>;
|
|
860
983
|
$or?: ArrayTwoOrMore<QueryFilters<Operators>>;
|
|
861
984
|
};
|
|
862
|
-
export declare type UserFilters<
|
|
985
|
+
export declare type UserFilters<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = QueryFilters<ContainsOperator<StreamChatGenerics['userType']> & {
|
|
863
986
|
id?: RequireOnlyOne<{
|
|
864
|
-
$autocomplete?: UserResponse<
|
|
865
|
-
} & QueryFilter<UserResponse<
|
|
987
|
+
$autocomplete?: UserResponse<StreamChatGenerics>['id'];
|
|
988
|
+
} & QueryFilter<UserResponse<StreamChatGenerics>['id']>> | PrimitiveFilter<UserResponse<StreamChatGenerics>['id']>;
|
|
866
989
|
name?: RequireOnlyOne<{
|
|
867
|
-
$autocomplete?: UserResponse<
|
|
868
|
-
} & QueryFilter<UserResponse<
|
|
990
|
+
$autocomplete?: UserResponse<StreamChatGenerics>['name'];
|
|
991
|
+
} & QueryFilter<UserResponse<StreamChatGenerics>['name']>> | PrimitiveFilter<UserResponse<StreamChatGenerics>['name']>;
|
|
869
992
|
teams?: RequireOnlyOne<{
|
|
870
993
|
$contains?: PrimitiveFilter<string>;
|
|
871
|
-
$eq?: PrimitiveFilter<UserResponse<
|
|
872
|
-
}> | PrimitiveFilter<UserResponse<
|
|
994
|
+
$eq?: PrimitiveFilter<UserResponse<StreamChatGenerics>['teams']>;
|
|
995
|
+
}> | PrimitiveFilter<UserResponse<StreamChatGenerics>['teams']>;
|
|
873
996
|
username?: RequireOnlyOne<{
|
|
874
|
-
$autocomplete?: UserResponse<
|
|
875
|
-
} & QueryFilter<UserResponse<
|
|
997
|
+
$autocomplete?: UserResponse<StreamChatGenerics>['username'];
|
|
998
|
+
} & QueryFilter<UserResponse<StreamChatGenerics>['username']>> | PrimitiveFilter<UserResponse<StreamChatGenerics>['username']>;
|
|
876
999
|
} & {
|
|
877
|
-
[Key in keyof Omit<UserResponse<{
|
|
1000
|
+
[Key in keyof Omit<UserResponse<{
|
|
1001
|
+
attachmentType: StreamChatGenerics['attachmentType'];
|
|
1002
|
+
channelType: StreamChatGenerics['channelType'];
|
|
1003
|
+
commandType: StreamChatGenerics['commandType'];
|
|
1004
|
+
eventType: StreamChatGenerics['eventType'];
|
|
1005
|
+
messageType: StreamChatGenerics['messageType'];
|
|
1006
|
+
reactionType: StreamChatGenerics['reactionType'];
|
|
1007
|
+
userType: {};
|
|
1008
|
+
}>, 'id' | 'name' | 'teams' | 'username'>]?: RequireOnlyOne<QueryFilter<UserResponse<{
|
|
1009
|
+
attachmentType: StreamChatGenerics['attachmentType'];
|
|
1010
|
+
channelType: StreamChatGenerics['channelType'];
|
|
1011
|
+
commandType: StreamChatGenerics['commandType'];
|
|
1012
|
+
eventType: StreamChatGenerics['eventType'];
|
|
1013
|
+
messageType: StreamChatGenerics['messageType'];
|
|
1014
|
+
reactionType: StreamChatGenerics['reactionType'];
|
|
1015
|
+
userType: {};
|
|
1016
|
+
}>[Key]>> | PrimitiveFilter<UserResponse<{
|
|
1017
|
+
attachmentType: StreamChatGenerics['attachmentType'];
|
|
1018
|
+
channelType: StreamChatGenerics['channelType'];
|
|
1019
|
+
commandType: StreamChatGenerics['commandType'];
|
|
1020
|
+
eventType: StreamChatGenerics['eventType'];
|
|
1021
|
+
messageType: StreamChatGenerics['messageType'];
|
|
1022
|
+
reactionType: StreamChatGenerics['reactionType'];
|
|
1023
|
+
userType: {};
|
|
1024
|
+
}>[Key]>;
|
|
878
1025
|
}>;
|
|
879
1026
|
/**
|
|
880
1027
|
* Sort Types
|
|
@@ -883,8 +1030,8 @@ export declare type BannedUsersSort = BannedUsersSortBase | Array<BannedUsersSor
|
|
|
883
1030
|
export declare type BannedUsersSortBase = {
|
|
884
1031
|
created_at?: AscDesc;
|
|
885
1032
|
};
|
|
886
|
-
export declare type ChannelSort<
|
|
887
|
-
export declare type ChannelSortBase<
|
|
1033
|
+
export declare type ChannelSort<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = ChannelSortBase<StreamChatGenerics> | Array<ChannelSortBase<StreamChatGenerics>>;
|
|
1034
|
+
export declare type ChannelSortBase<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Sort<StreamChatGenerics> & {
|
|
888
1035
|
created_at?: AscDesc;
|
|
889
1036
|
has_unread?: AscDesc;
|
|
890
1037
|
last_message_at?: AscDesc;
|
|
@@ -900,9 +1047,9 @@ export declare type PinnedMessagesSortBase = {
|
|
|
900
1047
|
export declare type Sort<T> = {
|
|
901
1048
|
[P in keyof T]?: AscDesc;
|
|
902
1049
|
};
|
|
903
|
-
export declare type UserSort<
|
|
904
|
-
export declare type MemberSort<
|
|
905
|
-
export declare type SearchMessageSortBase<
|
|
1050
|
+
export declare type UserSort<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Sort<UserResponse<StreamChatGenerics>> | Array<Sort<UserResponse<StreamChatGenerics>>>;
|
|
1051
|
+
export declare type MemberSort<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Sort<Pick<UserResponse<StreamChatGenerics>, 'id' | 'created_at' | 'name'>> | Array<Sort<Pick<UserResponse<StreamChatGenerics>, 'id' | 'created_at' | 'name'>>>;
|
|
1052
|
+
export declare type SearchMessageSortBase<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Sort<StreamChatGenerics['messageType']> & {
|
|
906
1053
|
attachments?: AscDesc;
|
|
907
1054
|
'attachments.type'?: AscDesc;
|
|
908
1055
|
created_at?: AscDesc;
|
|
@@ -917,8 +1064,8 @@ export declare type SearchMessageSortBase<MessageType = UR> = Sort<MessageType>
|
|
|
917
1064
|
updated_at?: AscDesc;
|
|
918
1065
|
'user.id'?: AscDesc;
|
|
919
1066
|
};
|
|
920
|
-
export declare type SearchMessageSort<
|
|
921
|
-
export declare type QuerySort<
|
|
1067
|
+
export declare type SearchMessageSort<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = SearchMessageSortBase<StreamChatGenerics> | Array<SearchMessageSortBase<StreamChatGenerics>>;
|
|
1068
|
+
export declare type QuerySort<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = BannedUsersSort | ChannelSort<StreamChatGenerics> | SearchMessageSort<StreamChatGenerics> | UserSort<StreamChatGenerics>;
|
|
922
1069
|
/**
|
|
923
1070
|
* Base Types
|
|
924
1071
|
*/
|
|
@@ -931,6 +1078,7 @@ export declare type Action = {
|
|
|
931
1078
|
};
|
|
932
1079
|
export declare type AnonUserType = {};
|
|
933
1080
|
export declare type APNConfig = {
|
|
1081
|
+
auth_key?: string;
|
|
934
1082
|
auth_type?: string;
|
|
935
1083
|
bundle_id?: string;
|
|
936
1084
|
development?: boolean;
|
|
@@ -938,6 +1086,7 @@ export declare type APNConfig = {
|
|
|
938
1086
|
host?: string;
|
|
939
1087
|
key_id?: string;
|
|
940
1088
|
notification_template?: string;
|
|
1089
|
+
p12_cert?: string;
|
|
941
1090
|
team_id?: string;
|
|
942
1091
|
};
|
|
943
1092
|
export declare type AppSettings = {
|
|
@@ -960,7 +1109,7 @@ export declare type AppSettings = {
|
|
|
960
1109
|
enforce_unique_usernames?: 'no' | 'app' | 'team';
|
|
961
1110
|
file_upload_config?: FileUploadConfig;
|
|
962
1111
|
firebase_config?: {
|
|
963
|
-
credentials_json
|
|
1112
|
+
credentials_json?: string;
|
|
964
1113
|
data_template?: string;
|
|
965
1114
|
notification_template?: string;
|
|
966
1115
|
server_key?: string;
|
|
@@ -987,7 +1136,7 @@ export declare type AppSettings = {
|
|
|
987
1136
|
secret: string;
|
|
988
1137
|
};
|
|
989
1138
|
};
|
|
990
|
-
export declare type Attachment<
|
|
1139
|
+
export declare type Attachment<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = StreamChatGenerics['attachmentType'] & {
|
|
991
1140
|
actions?: Action[];
|
|
992
1141
|
asset_url?: string;
|
|
993
1142
|
author_icon?: string;
|
|
@@ -999,6 +1148,7 @@ export declare type Attachment<T = UR> = T & {
|
|
|
999
1148
|
file_size?: number | string;
|
|
1000
1149
|
footer?: string;
|
|
1001
1150
|
footer_icon?: string;
|
|
1151
|
+
giphy?: GiphyData;
|
|
1002
1152
|
image_url?: string;
|
|
1003
1153
|
mime_type?: string;
|
|
1004
1154
|
og_scrape_url?: string;
|
|
@@ -1027,8 +1177,8 @@ export declare type BlockList = {
|
|
|
1027
1177
|
name: string;
|
|
1028
1178
|
words: string[];
|
|
1029
1179
|
};
|
|
1030
|
-
export declare type ChannelConfig<
|
|
1031
|
-
commands?: CommandVariants<
|
|
1180
|
+
export declare type ChannelConfig<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = ChannelConfigFields & CreatedAtUpdatedAt & {
|
|
1181
|
+
commands?: CommandVariants<StreamChatGenerics>[];
|
|
1032
1182
|
};
|
|
1033
1183
|
export declare type ChannelConfigAutomod = '' | 'AI' | 'disabled' | 'simple';
|
|
1034
1184
|
export declare type ChannelConfigAutomodBehavior = '' | 'block' | 'flag';
|
|
@@ -1066,14 +1216,14 @@ export declare type ChannelConfigFields = {
|
|
|
1066
1216
|
uploads?: boolean;
|
|
1067
1217
|
url_enrichment?: boolean;
|
|
1068
1218
|
};
|
|
1069
|
-
export declare type ChannelConfigWithInfo<
|
|
1070
|
-
commands?: CommandResponse<
|
|
1219
|
+
export declare type ChannelConfigWithInfo<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = ChannelConfigFields & CreatedAtUpdatedAt & {
|
|
1220
|
+
commands?: CommandResponse<StreamChatGenerics>[];
|
|
1071
1221
|
};
|
|
1072
|
-
export declare type ChannelData<
|
|
1222
|
+
export declare type ChannelData<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = StreamChatGenerics['channelType'] & {
|
|
1073
1223
|
members?: string[];
|
|
1074
1224
|
name?: string;
|
|
1075
1225
|
};
|
|
1076
|
-
export declare type ChannelMembership<
|
|
1226
|
+
export declare type ChannelMembership<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
1077
1227
|
banned?: boolean;
|
|
1078
1228
|
channel_role?: Role;
|
|
1079
1229
|
created_at?: string;
|
|
@@ -1081,11 +1231,11 @@ export declare type ChannelMembership<UserType = UR> = {
|
|
|
1081
1231
|
role?: string;
|
|
1082
1232
|
shadow_banned?: boolean;
|
|
1083
1233
|
updated_at?: string;
|
|
1084
|
-
user?: UserResponse<
|
|
1234
|
+
user?: UserResponse<StreamChatGenerics>;
|
|
1085
1235
|
};
|
|
1086
|
-
export declare type ChannelMute<
|
|
1087
|
-
user: UserResponse<
|
|
1088
|
-
channel?: ChannelResponse<
|
|
1236
|
+
export declare type ChannelMute<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
1237
|
+
user: UserResponse<StreamChatGenerics>;
|
|
1238
|
+
channel?: ChannelResponse<StreamChatGenerics>;
|
|
1089
1239
|
created_at?: string;
|
|
1090
1240
|
expires?: string;
|
|
1091
1241
|
updated_at?: string;
|
|
@@ -1097,35 +1247,35 @@ export declare type ChannelRole = {
|
|
|
1097
1247
|
resource?: string;
|
|
1098
1248
|
same_team?: boolean;
|
|
1099
1249
|
};
|
|
1100
|
-
export declare type CheckPushInput<
|
|
1250
|
+
export declare type CheckPushInput<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
1101
1251
|
apn_template?: string;
|
|
1102
1252
|
client_id?: string;
|
|
1103
1253
|
connection_id?: string;
|
|
1104
1254
|
firebase_data_template?: string;
|
|
1105
1255
|
firebase_template?: string;
|
|
1106
1256
|
message_id?: string;
|
|
1107
|
-
user?: UserResponse<
|
|
1257
|
+
user?: UserResponse<StreamChatGenerics>;
|
|
1108
1258
|
user_id?: string;
|
|
1109
1259
|
};
|
|
1110
1260
|
export declare type PushProvider = 'apn' | 'firebase' | 'huawei' | 'xiaomi';
|
|
1111
|
-
export declare type CommandVariants<
|
|
1112
|
-
export declare type Configs<
|
|
1113
|
-
[channel_type: string]: ChannelConfigWithInfo<
|
|
1261
|
+
export declare type CommandVariants<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = 'all' | 'ban' | 'fun_set' | 'giphy' | 'moderation_set' | 'mute' | 'unban' | 'unmute' | StreamChatGenerics['commandType'];
|
|
1262
|
+
export declare type Configs<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
1263
|
+
[channel_type: string]: ChannelConfigWithInfo<StreamChatGenerics> | undefined;
|
|
1114
1264
|
};
|
|
1115
|
-
export declare type ConnectionOpen<
|
|
1265
|
+
export declare type ConnectionOpen<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
1116
1266
|
connection_id: string;
|
|
1117
1267
|
cid?: string;
|
|
1118
1268
|
created_at?: string;
|
|
1119
|
-
me?: OwnUserResponse<
|
|
1269
|
+
me?: OwnUserResponse<StreamChatGenerics>;
|
|
1120
1270
|
type?: string;
|
|
1121
1271
|
};
|
|
1122
1272
|
export declare type CreatedAtUpdatedAt = {
|
|
1123
1273
|
created_at: string;
|
|
1124
1274
|
updated_at: string;
|
|
1125
1275
|
};
|
|
1126
|
-
export declare type Device<
|
|
1276
|
+
export declare type Device<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = DeviceFields & {
|
|
1127
1277
|
provider?: string;
|
|
1128
|
-
user?: UserResponse<
|
|
1278
|
+
user?: UserResponse<StreamChatGenerics>;
|
|
1129
1279
|
user_id?: string;
|
|
1130
1280
|
};
|
|
1131
1281
|
export declare type BaseDeviceFields = {
|
|
@@ -1170,22 +1320,36 @@ export declare type FirebaseConfig = {
|
|
|
1170
1320
|
data_template?: string;
|
|
1171
1321
|
enabled?: boolean;
|
|
1172
1322
|
notification_template?: string;
|
|
1323
|
+
server_key?: string;
|
|
1324
|
+
};
|
|
1325
|
+
declare type GiphyVersionInfo = {
|
|
1326
|
+
height: string;
|
|
1327
|
+
url: string;
|
|
1328
|
+
width: string;
|
|
1329
|
+
};
|
|
1330
|
+
declare type GiphyVersions = 'original' | 'fixed_height' | 'fixed_height_still' | 'fixed_height_downsampled' | 'fixed_width' | 'fixed_width_still' | 'fixed_width_downsampled';
|
|
1331
|
+
declare type GiphyData = {
|
|
1332
|
+
[key in GiphyVersions]: GiphyVersionInfo;
|
|
1173
1333
|
};
|
|
1174
1334
|
export declare type HuaweiConfig = {
|
|
1175
1335
|
enabled?: boolean;
|
|
1336
|
+
id?: string;
|
|
1337
|
+
secret?: string;
|
|
1176
1338
|
};
|
|
1177
1339
|
export declare type XiaomiConfig = {
|
|
1178
1340
|
enabled?: boolean;
|
|
1341
|
+
package_name?: string;
|
|
1342
|
+
secret?: string;
|
|
1179
1343
|
};
|
|
1180
1344
|
export declare type LiteralStringForUnion = string & {};
|
|
1181
1345
|
export declare type LogLevel = 'info' | 'error' | 'warn';
|
|
1182
1346
|
export declare type Logger = (logLevel: LogLevel, message: string, extraData?: Record<string, unknown>) => void;
|
|
1183
|
-
export declare type Message<
|
|
1347
|
+
export declare type Message<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Partial<MessageBase<StreamChatGenerics>> & {
|
|
1184
1348
|
mentioned_users?: string[];
|
|
1185
1349
|
};
|
|
1186
|
-
export declare type MessageBase<
|
|
1350
|
+
export declare type MessageBase<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = StreamChatGenerics['messageType'] & {
|
|
1187
1351
|
id: string;
|
|
1188
|
-
attachments?: Attachment<
|
|
1352
|
+
attachments?: Attachment<StreamChatGenerics>[];
|
|
1189
1353
|
html?: string;
|
|
1190
1354
|
mml?: string;
|
|
1191
1355
|
parent_id?: string;
|
|
@@ -1195,29 +1359,29 @@ export declare type MessageBase<AttachmentType = UR, MessageType = UR, UserType
|
|
|
1195
1359
|
quoted_message_id?: string;
|
|
1196
1360
|
show_in_channel?: boolean;
|
|
1197
1361
|
text?: string;
|
|
1198
|
-
user?: UserResponse<
|
|
1362
|
+
user?: UserResponse<StreamChatGenerics> | null;
|
|
1199
1363
|
user_id?: string;
|
|
1200
1364
|
};
|
|
1201
1365
|
export declare type MessageLabel = 'deleted' | 'ephemeral' | 'error' | 'regular' | 'reply' | 'system';
|
|
1202
|
-
export declare type Mute<
|
|
1366
|
+
export declare type Mute<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
1203
1367
|
created_at: string;
|
|
1204
|
-
target: UserResponse<
|
|
1368
|
+
target: UserResponse<StreamChatGenerics>;
|
|
1205
1369
|
updated_at: string;
|
|
1206
|
-
user: UserResponse<
|
|
1370
|
+
user: UserResponse<StreamChatGenerics>;
|
|
1207
1371
|
};
|
|
1208
|
-
export declare type PartialUpdateChannel<
|
|
1209
|
-
set?: Partial<ChannelResponse<
|
|
1210
|
-
unset?: Array<keyof ChannelResponse<
|
|
1372
|
+
export declare type PartialUpdateChannel<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
1373
|
+
set?: Partial<ChannelResponse<StreamChatGenerics>>;
|
|
1374
|
+
unset?: Array<keyof ChannelResponse<StreamChatGenerics>>;
|
|
1211
1375
|
};
|
|
1212
|
-
export declare type PartialUserUpdate<
|
|
1376
|
+
export declare type PartialUserUpdate<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
1213
1377
|
id: string;
|
|
1214
|
-
set?: Partial<UserResponse<
|
|
1215
|
-
unset?: Array<keyof UserResponse<
|
|
1378
|
+
set?: Partial<UserResponse<StreamChatGenerics>>;
|
|
1379
|
+
unset?: Array<keyof UserResponse<StreamChatGenerics>>;
|
|
1216
1380
|
};
|
|
1217
|
-
export declare type MessageUpdatableFields<
|
|
1218
|
-
export declare type PartialMessageUpdate<
|
|
1219
|
-
set?: Partial<MessageUpdatableFields<
|
|
1220
|
-
unset?: Array<keyof MessageUpdatableFields<
|
|
1381
|
+
export declare type MessageUpdatableFields<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Omit<MessageResponse<StreamChatGenerics>, 'cid' | 'created_at' | 'updated_at' | 'deleted_at' | 'user' | 'user_id'>;
|
|
1382
|
+
export declare type PartialMessageUpdate<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
1383
|
+
set?: Partial<MessageUpdatableFields<StreamChatGenerics>>;
|
|
1384
|
+
unset?: Array<keyof MessageUpdatableFields<StreamChatGenerics>>;
|
|
1221
1385
|
};
|
|
1222
1386
|
export declare type PermissionAPIObject = {
|
|
1223
1387
|
action?: string;
|
|
@@ -1255,23 +1419,23 @@ export declare type RateLimitsInfo = {
|
|
|
1255
1419
|
reset: number;
|
|
1256
1420
|
};
|
|
1257
1421
|
export declare type RateLimitsMap = Record<EndpointName, RateLimitsInfo>;
|
|
1258
|
-
export declare type Reaction<
|
|
1422
|
+
export declare type Reaction<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = StreamChatGenerics['reactionType'] & {
|
|
1259
1423
|
type: string;
|
|
1260
1424
|
message_id?: string;
|
|
1261
1425
|
score?: number;
|
|
1262
|
-
user?: UserResponse<
|
|
1426
|
+
user?: UserResponse<StreamChatGenerics> | null;
|
|
1263
1427
|
user_id?: string;
|
|
1264
1428
|
};
|
|
1265
1429
|
export declare type Resource = 'AddLinks' | 'BanUser' | 'CreateChannel' | 'CreateMessage' | 'CreateReaction' | 'DeleteAttachment' | 'DeleteChannel' | 'DeleteMessage' | 'DeleteReaction' | 'EditUser' | 'MuteUser' | 'ReadChannel' | 'RunMessageAction' | 'UpdateChannel' | 'UpdateChannelMembers' | 'UpdateMessage' | 'UpdateUser' | 'UploadAttachment';
|
|
1266
|
-
export declare type SearchPayload<
|
|
1430
|
+
export declare type SearchPayload<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Omit<SearchOptions<StreamChatGenerics>, 'sort'> & {
|
|
1267
1431
|
client_id?: string;
|
|
1268
1432
|
connection_id?: string;
|
|
1269
|
-
filter_conditions?: ChannelFilters<
|
|
1270
|
-
message_filter_conditions?: MessageFilters<
|
|
1433
|
+
filter_conditions?: ChannelFilters<StreamChatGenerics>;
|
|
1434
|
+
message_filter_conditions?: MessageFilters<StreamChatGenerics>;
|
|
1271
1435
|
query?: string;
|
|
1272
1436
|
sort?: Array<{
|
|
1273
1437
|
direction: AscDesc;
|
|
1274
|
-
field: keyof SearchMessageSortBase<
|
|
1438
|
+
field: keyof SearchMessageSortBase<StreamChatGenerics>;
|
|
1275
1439
|
}>;
|
|
1276
1440
|
};
|
|
1277
1441
|
export declare type TestPushDataInput = {
|
|
@@ -1291,10 +1455,10 @@ export declare type TokenProvider = () => Promise<string>;
|
|
|
1291
1455
|
export declare type TranslationLanguages = '' | 'af' | 'am' | 'ar' | 'az' | 'bg' | 'bn' | 'bs' | 'cs' | 'da' | 'de' | 'el' | 'en' | 'es' | 'es-MX' | 'et' | 'fa' | 'fa-AF' | 'fi' | 'fr' | 'fr-CA' | 'ha' | 'he' | 'hi' | 'hr' | 'hu' | 'id' | 'it' | 'ja' | 'ka' | 'ko' | 'lv' | 'ms' | 'nl' | 'no' | 'pl' | 'ps' | 'pt' | 'ro' | 'ru' | 'sk' | 'sl' | 'so' | 'sq' | 'sr' | 'sv' | 'sw' | 'ta' | 'th' | 'tl' | 'tr' | 'uk' | 'ur' | 'vi' | 'zh' | 'zh-TW';
|
|
1292
1456
|
export declare type TypingStartEvent = Event;
|
|
1293
1457
|
export declare type ReservedMessageFields = 'command' | 'created_at' | 'html' | 'latest_reactions' | 'own_reactions' | 'quoted_message' | 'reaction_counts' | 'reply_count' | 'type' | 'updated_at' | 'user' | '__html';
|
|
1294
|
-
export declare type UpdatedMessage<
|
|
1458
|
+
export declare type UpdatedMessage<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Omit<MessageResponse<StreamChatGenerics>, 'mentioned_users'> & {
|
|
1295
1459
|
mentioned_users?: string[];
|
|
1296
1460
|
};
|
|
1297
|
-
export declare type User<
|
|
1461
|
+
export declare type User<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = StreamChatGenerics['userType'] & {
|
|
1298
1462
|
id: string;
|
|
1299
1463
|
anon?: boolean;
|
|
1300
1464
|
name?: string;
|
|
@@ -1367,15 +1531,18 @@ export declare type TaskStatus = {
|
|
|
1367
1531
|
};
|
|
1368
1532
|
result?: UR;
|
|
1369
1533
|
};
|
|
1370
|
-
export declare type TruncateOptions<
|
|
1534
|
+
export declare type TruncateOptions<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
1371
1535
|
hard_delete?: boolean;
|
|
1372
|
-
message?: Message<
|
|
1536
|
+
message?: Message<StreamChatGenerics>;
|
|
1373
1537
|
skip_push?: boolean;
|
|
1374
1538
|
truncated_at?: Date;
|
|
1375
1539
|
};
|
|
1540
|
+
export declare type CreateImportURLResponse = {
|
|
1541
|
+
path: string;
|
|
1542
|
+
upload_url: string;
|
|
1543
|
+
};
|
|
1376
1544
|
export declare type CreateImportResponse = {
|
|
1377
1545
|
import_task: ImportTask;
|
|
1378
|
-
upload_url: string;
|
|
1379
1546
|
};
|
|
1380
1547
|
export declare type GetImportResponse = {
|
|
1381
1548
|
import_task: ImportTask;
|
|
@@ -1394,12 +1561,13 @@ export declare type ImportTaskHistory = {
|
|
|
1394
1561
|
};
|
|
1395
1562
|
export declare type ImportTask = {
|
|
1396
1563
|
created_at: string;
|
|
1397
|
-
filename: string;
|
|
1398
1564
|
history: ImportTaskHistory[];
|
|
1399
1565
|
id: string;
|
|
1566
|
+
path: string;
|
|
1400
1567
|
state: string;
|
|
1401
1568
|
updated_at: string;
|
|
1402
1569
|
result?: UR;
|
|
1403
1570
|
size?: number;
|
|
1404
1571
|
};
|
|
1572
|
+
export {};
|
|
1405
1573
|
//# sourceMappingURL=types.d.ts.map
|