stream-chat 8.42.0 → 8.43.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/dist/browser.es.js +531 -161
- 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 +531 -161
- package/dist/browser.js.map +1 -1
- package/dist/index.es.js +531 -161
- package/dist/index.es.js.map +1 -1
- package/dist/index.js +531 -161
- package/dist/index.js.map +1 -1
- package/dist/types/channel.d.ts +62 -2
- package/dist/types/channel.d.ts.map +1 -1
- package/dist/types/moderation.d.ts +30 -1
- package/dist/types/moderation.d.ts.map +1 -1
- package/dist/types/types.d.ts +27 -4
- package/dist/types/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/channel.ts +91 -2
- package/src/moderation.ts +64 -0
- package/src/types.ts +34 -4
package/dist/types/channel.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
2
|
import { ChannelState } from './channel_state';
|
|
3
3
|
import { StreamChat } from './client';
|
|
4
|
-
import { APIResponse, BanUserOptions, ChannelAPIResponse, ChannelData, ChannelMemberAPIResponse, ChannelMemberResponse, ChannelQueryOptions, ChannelResponse, ChannelUpdateOptions, CreateCallOptions, CreateCallResponse, DefaultGenerics, DeleteChannelAPIResponse, Event, EventAPIResponse, EventHandler, EventTypes, ExtendableGenerics, FormatMessageResponse, GetMultipleMessagesAPIResponse, GetReactionsAPIResponse, GetRepliesAPIResponse, InviteOptions, MarkReadOptions, MarkUnreadOptions, MemberSort, Message, MessageFilters, MessagePaginationOptions, MessageResponse, MessageSetType, MuteChannelAPIResponse, PartialUpdateChannel, PartialUpdateChannelAPIResponse, PartialUpdateMember, PinnedMessagePaginationOptions, PinnedMessagesSort, QueryMembersOptions, Reaction, ReactionAPIResponse, SearchAPIResponse, SearchOptions, SendMessageAPIResponse, TruncateChannelAPIResponse, TruncateOptions, UpdateChannelAPIResponse, UserFilters, UserResponse, QueryChannelAPIResponse, PollVoteData, SendMessageOptions, AscDesc } from './types';
|
|
4
|
+
import { APIResponse, BanUserOptions, ChannelAPIResponse, ChannelData, ChannelMemberAPIResponse, ChannelMemberResponse, ChannelQueryOptions, ChannelResponse, ChannelUpdateOptions, CreateCallOptions, CreateCallResponse, DefaultGenerics, DeleteChannelAPIResponse, Event, EventAPIResponse, EventHandler, EventTypes, ExtendableGenerics, FormatMessageResponse, GetMultipleMessagesAPIResponse, GetReactionsAPIResponse, GetRepliesAPIResponse, InviteOptions, MarkReadOptions, MarkUnreadOptions, MemberSort, Message, MessageFilters, MessagePaginationOptions, MessageResponse, MessageSetType, MuteChannelAPIResponse, PartialUpdateChannel, PartialUpdateChannelAPIResponse, PartialUpdateMember, PinnedMessagePaginationOptions, PinnedMessagesSort, QueryMembersOptions, Reaction, ReactionAPIResponse, SearchAPIResponse, SearchOptions, SendMessageAPIResponse, TruncateChannelAPIResponse, TruncateOptions, UpdateChannelAPIResponse, UserFilters, UserResponse, QueryChannelAPIResponse, PollVoteData, SendMessageOptions, AscDesc, PartialUpdateMemberAPIResponse } from './types';
|
|
5
5
|
import { Role } from './permissions';
|
|
6
6
|
/**
|
|
7
7
|
* Channel - The Channel class manages it's own state.
|
|
@@ -119,7 +119,7 @@ export declare class Channel<StreamChatGenerics extends ExtendableGenerics = Def
|
|
|
119
119
|
*
|
|
120
120
|
* @return {Promise<ChannelMemberResponse<StreamChatGenerics>>} Updated member
|
|
121
121
|
*/
|
|
122
|
-
partialUpdateMember(user_id: string, updates: PartialUpdateMember
|
|
122
|
+
partialUpdateMember(user_id: string, updates: PartialUpdateMember): Promise<PartialUpdateMemberAPIResponse<StreamChatGenerics>>;
|
|
123
123
|
/**
|
|
124
124
|
* sendReaction - Send a reaction about a message
|
|
125
125
|
*
|
|
@@ -302,6 +302,66 @@ export declare class Channel<StreamChatGenerics extends ExtendableGenerics = Def
|
|
|
302
302
|
unmute(opts?: {
|
|
303
303
|
user_id?: string;
|
|
304
304
|
}): Promise<APIResponse>;
|
|
305
|
+
/**
|
|
306
|
+
* archive - archives the current channel
|
|
307
|
+
* @param {{ user_id?: string }} opts user_id if called server side
|
|
308
|
+
* @return {Promise<ChannelMemberResponse<StreamChatGenerics>>} The server response
|
|
309
|
+
*
|
|
310
|
+
* example:
|
|
311
|
+
* await channel.archives();
|
|
312
|
+
*
|
|
313
|
+
* example server side:
|
|
314
|
+
* await channel.archive({user_id: userId});
|
|
315
|
+
*
|
|
316
|
+
*/
|
|
317
|
+
archive(opts?: {
|
|
318
|
+
user_id?: string;
|
|
319
|
+
}): Promise<ChannelMemberResponse<StreamChatGenerics>>;
|
|
320
|
+
/**
|
|
321
|
+
* unarchive - unarchives the current channel
|
|
322
|
+
* @param {{ user_id?: string }} opts user_id if called server side
|
|
323
|
+
* @return {Promise<ChannelMemberResponse<StreamChatGenerics>>} The server response
|
|
324
|
+
*
|
|
325
|
+
* example:
|
|
326
|
+
* await channel.unarchive();
|
|
327
|
+
*
|
|
328
|
+
* example server side:
|
|
329
|
+
* await channel.unarchive({user_id: userId});
|
|
330
|
+
*
|
|
331
|
+
*/
|
|
332
|
+
unarchive(opts?: {
|
|
333
|
+
user_id?: string;
|
|
334
|
+
}): Promise<ChannelMemberResponse<StreamChatGenerics>>;
|
|
335
|
+
/**
|
|
336
|
+
* pin - pins the current channel
|
|
337
|
+
* @param {{ user_id?: string }} opts user_id if called server side
|
|
338
|
+
* @return {Promise<ChannelMemberResponse<StreamChatGenerics>>} The server response
|
|
339
|
+
*
|
|
340
|
+
* example:
|
|
341
|
+
* await channel.pin();
|
|
342
|
+
*
|
|
343
|
+
* example server side:
|
|
344
|
+
* await channel.pin({user_id: userId});
|
|
345
|
+
*
|
|
346
|
+
*/
|
|
347
|
+
pin(opts?: {
|
|
348
|
+
user_id?: string;
|
|
349
|
+
}): Promise<ChannelMemberResponse<StreamChatGenerics>>;
|
|
350
|
+
/**
|
|
351
|
+
* unpin - unpins the current channel
|
|
352
|
+
* @param {{ user_id?: string }} opts user_id if called server side
|
|
353
|
+
* @return {Promise<ChannelMemberResponse<StreamChatGenerics>>} The server response
|
|
354
|
+
*
|
|
355
|
+
* example:
|
|
356
|
+
* await channel.unpin();
|
|
357
|
+
*
|
|
358
|
+
* example server side:
|
|
359
|
+
* await channel.unpin({user_id: userId});
|
|
360
|
+
*
|
|
361
|
+
*/
|
|
362
|
+
unpin(opts?: {
|
|
363
|
+
user_id?: string;
|
|
364
|
+
}): Promise<ChannelMemberResponse<StreamChatGenerics>>;
|
|
305
365
|
/**
|
|
306
366
|
* muteStatus - returns the mute status for the current channel
|
|
307
367
|
* @return {{ muted: boolean; createdAt: Date | null; expiresAt: Date | null }} { muted: true | false, createdAt: Date | null, expiresAt: Date | null}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../src/channel.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EACL,WAAW,EACX,cAAc,EACd,kBAAkB,EAClB,WAAW,EAEX,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,wBAAwB,EACxB,KAAK,EACL,gBAAgB,EAChB,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,qBAAqB,EACrB,8BAA8B,EAC9B,uBAAuB,EACvB,qBAAqB,EACrB,aAAa,EACb,eAAe,EACf,iBAAiB,EACjB,UAAU,EACV,OAAO,EACP,cAAc,EACd,wBAAwB,EACxB,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,oBAAoB,EACpB,+BAA+B,EAC/B,mBAAmB,EACnB,8BAA8B,EAC9B,kBAAkB,EAClB,mBAAmB,EACnB,QAAQ,EACR,mBAAmB,EACnB,iBAAiB,EAEjB,aAAa,EAEb,sBAAsB,EACtB,0BAA0B,EAC1B,eAAe,EACf,wBAAwB,EACxB,WAAW,EACX,YAAY,EACZ,uBAAuB,EACvB,YAAY,EACZ,kBAAkB,EAClB,OAAO,
|
|
1
|
+
{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../src/channel.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EACL,WAAW,EACX,cAAc,EACd,kBAAkB,EAClB,WAAW,EAEX,wBAAwB,EACxB,qBAAqB,EACrB,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,wBAAwB,EACxB,KAAK,EACL,gBAAgB,EAChB,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,qBAAqB,EACrB,8BAA8B,EAC9B,uBAAuB,EACvB,qBAAqB,EACrB,aAAa,EACb,eAAe,EACf,iBAAiB,EACjB,UAAU,EACV,OAAO,EACP,cAAc,EACd,wBAAwB,EACxB,eAAe,EACf,cAAc,EACd,sBAAsB,EACtB,oBAAoB,EACpB,+BAA+B,EAC/B,mBAAmB,EACnB,8BAA8B,EAC9B,kBAAkB,EAClB,mBAAmB,EACnB,QAAQ,EACR,mBAAmB,EACnB,iBAAiB,EAEjB,aAAa,EAEb,sBAAsB,EACtB,0BAA0B,EAC1B,eAAe,EACf,wBAAwB,EACxB,WAAW,EACX,YAAY,EACZ,uBAAuB,EACvB,YAAY,EACZ,kBAAkB,EAClB,OAAO,EACP,8BAA8B,EAC/B,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAGrC;;GAEG;AACH,qBAAa,OAAO,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe;IAClF,OAAO,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,GAAG,SAAS,CAAC;IACvB,IAAI,EAAE,WAAW,CAAC,kBAAkB,CAAC,GAAG,eAAe,CAAC,kBAAkB,CAAC,GAAG,SAAS,CAAC;IACxF,KAAK,EAAE,WAAW,CAAC,kBAAkB,CAAC,GAAG,eAAe,CAAC,kBAAkB,CAAC,CAAC;IAC7E,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO;IACP,SAAS,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,YAAY,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAA;KAAE,CAAC;IAC5E,KAAK,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAAC;IACxC;;;;;;;;OAQG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,WAAW,EAAE,OAAO,CAAC;IACrB,aAAa,CAAC,EAAE,IAAI,CAAC;IACrB,eAAe,EAAE,IAAI,GAAG,IAAI,CAAC;IAC7B,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,OAAO,CAAC;IAEtB;;;;;;;;;OASG;gBAED,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAAC,EACtC,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,MAAM,GAAG,SAAS,EACtB,IAAI,EAAE,WAAW,CAAC,kBAAkB,CAAC;IA8BvC;;;;OAIG;IACH,SAAS,IAAI,UAAU,CAAC,kBAAkB,CAAC;IAO3C;;;;OAIG;IACH,SAAS;IAKT;;;;;;;;;;;;OAYG;IACG,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC,EAAE,kBAAkB;IAOpF,QAAQ,CACN,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,cAAc,GAAG,MAAM,GAAG,IAAI,EACnD,IAAI,CAAC,EAAE,MAAM,EACb,WAAW,CAAC,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,YAAY,CAAC,kBAAkB,CAAC;IAKzC,SAAS,CACP,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,cAAc,GAAG,IAAI,EAC1C,IAAI,CAAC,EAAE,MAAM,EACb,WAAW,CAAC,EAAE,MAAM,EACpB,IAAI,CAAC,EAAE,YAAY,CAAC,kBAAkB,CAAC;IAKzC,UAAU,CAAC,GAAG,EAAE,MAAM;IAItB,WAAW,CAAC,GAAG,EAAE,MAAM;IAIvB;;;;;;OAMG;IACG,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC;IAOhD;;;;;;;OAOG;IACG,MAAM,CACV,KAAK,EAAE,cAAc,CAAC,kBAAkB,CAAC,GAAG,MAAM,EAClD,OAAO,GAAE,aAAa,CAAC,kBAAkB,CAAC,GAAG;QAC3C,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,yBAAyB,CAAC,EAAE,cAAc,CAAC,kBAAkB,CAAC,CAAC;QAC/D,KAAK,CAAC,EAAE,MAAM,CAAC;KACX;IA0BR;;;;;;;;;OASG;IACG,YAAY,CAChB,gBAAgB,EAAE,WAAW,CAAC,kBAAkB,CAAC,EACjD,IAAI,GAAE,UAAU,CAAC,kBAAkB,CAAM,EACzC,OAAO,GAAE,mBAAwB;IA0BnC;;;;;;;OAOG;IACG,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,mBAAmB;IAWvE;;;;;;;;OAQG;IACG,YAAY,CAChB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,QAAQ,CAAC,kBAAkB,CAAC,EACtC,OAAO,CAAC,EAAE;QAAE,cAAc,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAE;IAiB7D;;;;;;;;OAQG;IACH,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM;IAiBxE;;;;;;;OAOG;IACG,MAAM,CACV,WAAW,GAAE,OAAO,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAM,EACzG,aAAa,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,EAC3C,OAAO,CAAC,EAAE,oBAAoB;IA0BhC;;;;;;OAMG;IACG,aAAa,CAAC,MAAM,EAAE,oBAAoB,CAAC,kBAAkB,CAAC;IAqBpE;;;;;OAKG;IACG,cAAc,CAAC,gBAAgB,EAAE,MAAM;IAQ7C;;;;OAIG;IACG,eAAe;IAQrB;;;;;;OAMG;IACG,MAAM,CAAC,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAO;IAMpD;;;;OAIG;IACG,QAAQ,CAAC,OAAO,GAAE,eAAe,CAAC,kBAAkB,CAAM;IAOhE;;;;;;OAMG;IACG,YAAY,CAAC,OAAO,GAAE,aAAa,CAAC,kBAAkB,CAAM;IAIlE;;;;;;OAMG;IACG,YAAY,CAAC,OAAO,GAAE,aAAa,CAAC,kBAAkB,CAAM;IAIlE;;;;;;;OAOG;IACG,UAAU,CACd,OAAO,EAAE,MAAM,EAAE,GAAG;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,IAAI,CAAA;KAAE,EAAE,EAC9D,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,EACrC,OAAO,GAAE,oBAAyB;IAKpC;;;;;;;OAOG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,EAAE,OAAO,GAAE,oBAAyB;IAIhH;;;;;;;OAOG;IACG,WAAW,CACf,KAAK,EAAE;QAAE,YAAY,EAAE,IAAI,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,EAChD,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,EACrC,OAAO,GAAE,oBAAyB;IAKpC;;;;;;;OAOG;IACG,aAAa,CACjB,OAAO,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,IAAI,CAAA;KAAE,EAAE,GAAG,MAAM,EAAE,EAC9D,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,EACrC,OAAO,GAAE,oBAAyB;IAKpC;;;;;;;OAOG;IACG,aAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,EAAE,OAAO,GAAE,oBAAyB;IAIhH;;;;;;;OAOG;IACG,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,EAAE,OAAO,GAAE,oBAAyB;IAInH;;;;;OAKG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM;IAM7B;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,IAAI,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;IAO/D;;;;;;;OAOG;IACG,MAAM,CAAC,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;IAO5C;;;;;;;;;;;OAWG;IACG,OAAO,CAAC,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;IAU7C;;;;;;;;;;;OAWG;IACG,SAAS,CAAC,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;IAU/C;;;;;;;;;;;OAWG;IACG,GAAG,CAAC,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;IAUzC;;;;;;;;;;;OAWG;IACG,KAAK,CAAC,IAAI,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAA;KAAO;IAU3C;;;OAGG;IACH,UAAU,IAAI;QACZ,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;QACvB,SAAS,EAAE,IAAI,GAAG,IAAI,CAAC;QACvB,KAAK,EAAE,OAAO,CAAC;KAChB;IAKD,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAgB9D;;;;;OAKG;IACG,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE;IAmBjE;;;;OAIG;IACG,UAAU,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE;IAalE,0BAA0B,IAAI,OAAO;IAOrC;;;;OAIG;IACH,WAAW,IAAI,qBAAqB,CAAC,kBAAkB,CAAC,GAAG,SAAS;IAgBpE;;;;;OAKG;IACG,QAAQ,CAAC,IAAI,GAAE,eAAe,CAAC,kBAAkB,CAAM;IAY7D;;;;;OAKG;IACG,UAAU,CAAC,IAAI,EAAE,iBAAiB,CAAC,kBAAkB,CAAC;IAY5D;;OAEG;IACH,KAAK;IAYL;;;;;;OAMG;IACG,KAAK,CAAC,OAAO,CAAC,EAAE,mBAAmB,CAAC,kBAAkB,CAAC;IA0B7D;;;;OAIG;IACG,YAAY;IAWlB;;;;;;;;;OASG;IACG,UAAU,CACd,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,wBAAwB,GAAG;QAAE,IAAI,CAAC,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,EACjG,IAAI,CAAC,EAAE;QAAE,UAAU,EAAE,OAAO,CAAA;KAAE,EAAE;IAmBlC;;;;;;;OAOG;IACG,iBAAiB,CACrB,OAAO,EAAE,8BAA8B,GAAG;QAAE,IAAI,CAAC,EAAE,YAAY,CAAC,kBAAkB,CAAC,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,EACvG,IAAI,GAAE,kBAAuB;IAa/B;;;;;;;OAOG;IACH,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;IAS7E;;;;;;OAMG;IACH,eAAe,CAAC,UAAU,EAAE,MAAM,EAAE;IAMpC;;;OAGG;IACH,QAAQ;IAOR,qBAAqB,CAAC,OAAO,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,GAAG,eAAe,CAAC,kBAAkB,CAAC;IAiB9G;;;;;;OAMG;IACH,WAAW,CAAC,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI;IAalC;;;;OAIG;IACH,mBAAmB;IAkBnB;;;;;OAKG;IACH,MAAM,0HAQJ;IAEF;;;;;;;OAOG;IACG,KAAK,CACT,OAAO,CAAC,EAAE,mBAAmB,CAAC,kBAAkB,CAAC,EACjD,+BAA+B,GAAE,cAA0B;IAiF7D;;;;;;OAMG;IACG,OAAO,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,CAAC,kBAAkB,CAAC;IAS/E;;;;;;;OAOG;IACG,IAAI,CAAC,MAAM,GAAE,MAAM,GAAG,IAAW,EAAE,YAAY,UAAQ;IAS7D;;;;;OAKG;IACG,IAAI,CAAC,MAAM,GAAE,MAAM,GAAG,IAAW;IAOvC;;;;;OAKG;IACG,SAAS,CAAC,YAAY,EAAE,MAAM;IAQpC;;;;;;OAMG;IACG,SAAS,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,CAAC,kBAAkB,CAAC;IASjF;;;;;OAKG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM;IAQ1C;;;;;OAKG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB;IAI3C;;;;;OAKG;IACG,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY;IAI1D,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;;;IAIlE;;;;;;;;;OASG;IACH,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,CAAC,kBAAkB,CAAC,GAAG;QAAE,WAAW,EAAE,MAAM,IAAI,CAAA;KAAE;IAClG,EAAE,CAAC,QAAQ,EAAE,YAAY,CAAC,kBAAkB,CAAC,GAAG;QAAE,WAAW,EAAE,MAAM,IAAI,CAAA;KAAE;IA6B3E;;;OAGG;IACH,GAAG,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,CAAC,kBAAkB,CAAC,GAAG,IAAI;IAC5E,GAAG,CAAC,QAAQ,EAAE,YAAY,CAAC,kBAAkB,CAAC,GAAG,IAAI;IAmBrD,mBAAmB,CAAC,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC;IAwOpD,qBAAqB,UAAW,MAAM,kBAAkB,CAAC,UAiBvD;IAEF;;;;OAIG;IACH,WAAW,eAKT;IAEF,iBAAiB;IASjB,gBAAgB,CACd,KAAK,EAAE,kBAAkB,CAAC,kBAAkB,CAAC,EAC7C,+BAA+B,GAAE,cAAyB;;;IAgF5D,4BAA4B,CAAC,KAAK,EAAE,KAAK,CAAC,kBAAkB,CAAC;IAU7D,eAAe,CAAC,OAAO,EAAE,qBAAqB,CAAC,kBAAkB,CAAC,EAAE;IASpE,WAAW;CASZ"}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { APIResponse, ModerationConfig, DefaultGenerics, ExtendableGenerics, GetConfigResponse, GetUserModerationReportResponse, ReviewQueueFilters, ReviewQueuePaginationOptions, ReviewQueueResponse, ReviewQueueSort, UpsertConfigResponse, ModerationFlagOptions, ModerationMuteOptions, GetUserModerationReportOptions, SubmitActionOptions } from './types';
|
|
1
|
+
import { APIResponse, ModerationConfig, DefaultGenerics, ExtendableGenerics, GetConfigResponse, GetUserModerationReportResponse, ReviewQueueFilters, ReviewQueuePaginationOptions, ReviewQueueResponse, ReviewQueueSort, UpsertConfigResponse, ModerationFlagOptions, ModerationMuteOptions, GetUserModerationReportOptions, SubmitActionOptions, QueryModerationConfigsFilters, QueryModerationConfigsSort, Pager } from './types';
|
|
2
2
|
import { StreamChat } from './client';
|
|
3
3
|
export declare const MODERATION_ENTITY_TYPES: {
|
|
4
4
|
user: string;
|
|
@@ -100,8 +100,37 @@ export declare class Moderation<StreamChatGenerics extends ExtendableGenerics =
|
|
|
100
100
|
* @param {string} key Key for which moderation config is to be fetched
|
|
101
101
|
*/
|
|
102
102
|
getConfig(key: string): Promise<GetConfigResponse>;
|
|
103
|
+
deleteConfig(key: string): Promise<unknown>;
|
|
104
|
+
/**
|
|
105
|
+
* Query moderation configs
|
|
106
|
+
* @param {Object} filterConditions Filter conditions for querying moderation configs
|
|
107
|
+
* @param {Object} sort Sort conditions for querying moderation configs
|
|
108
|
+
* @param {Object} options Additional options for querying moderation configs
|
|
109
|
+
*/
|
|
110
|
+
queryConfigs(filterConditions: QueryModerationConfigsFilters, sort: QueryModerationConfigsSort, options?: Pager): Promise<unknown>;
|
|
103
111
|
submitAction(actionType: string, itemID: string, options?: SubmitActionOptions): Promise<{
|
|
104
112
|
item_id: string;
|
|
105
113
|
} & APIResponse>;
|
|
114
|
+
/**
|
|
115
|
+
*
|
|
116
|
+
* @param {string} entityType string Type of entity to be checked E.g., stream:user, stream:chat:v1:message, or any custom string
|
|
117
|
+
* @param {string} entityID string ID of the entity to be checked. This is mainly for tracking purposes
|
|
118
|
+
* @param {string} entityCreatorID string ID of the entity creator
|
|
119
|
+
* @param {object} moderationPayload object Content to be checked for moderation. E.g., { texts: ['text1', 'text2'], images: ['image1', 'image2']}
|
|
120
|
+
* @param {Array} moderationPayload.texts array Array of texts to be checked for moderation
|
|
121
|
+
* @param {Array} moderationPayload.images array Array of images to be checked for moderation
|
|
122
|
+
* @param {Array} moderationPayload.videos array Array of videos to be checked for moderation
|
|
123
|
+
* @param configKey
|
|
124
|
+
* @param options
|
|
125
|
+
* @returns
|
|
126
|
+
*/
|
|
127
|
+
check(entityType: string, entityID: string, entityCreatorID: string, moderationPayload: {
|
|
128
|
+
custom?: Record<string, any>;
|
|
129
|
+
images?: string[];
|
|
130
|
+
texts?: string[];
|
|
131
|
+
videos?: string[];
|
|
132
|
+
}, configKey: string, options?: {
|
|
133
|
+
force_sync?: boolean;
|
|
134
|
+
}): Promise<unknown>;
|
|
106
135
|
}
|
|
107
136
|
//# sourceMappingURL=moderation.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"moderation.d.ts","sourceRoot":"","sources":["../../src/moderation.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,+BAA+B,EAE/B,kBAAkB,EAClB,4BAA4B,EAC5B,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,8BAA8B,EAC9B,mBAAmB,
|
|
1
|
+
{"version":3,"file":"moderation.d.ts","sourceRoot":"","sources":["../../src/moderation.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,iBAAiB,EACjB,+BAA+B,EAE/B,kBAAkB,EAClB,4BAA4B,EAC5B,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACpB,qBAAqB,EACrB,qBAAqB,EACrB,8BAA8B,EAC9B,mBAAmB,EACnB,6BAA6B,EAC7B,0BAA0B,EAC1B,KAAK,EACN,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAGtC,eAAO,MAAM,uBAAuB;;;CAGnC,CAAC;AAGF,qBAAa,UAAU,CAAC,kBAAkB,SAAS,kBAAkB,GAAG,eAAe;IACrF,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAC;gBAE3B,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAAC;IAIlD;;;;;;;;;OASG;IACG,QAAQ,CAAC,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B;;;IAIzF;;;;;;;;;OASG;IACG,WAAW,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B;;;IAIxF;;;;;;;;;;;;OAYG;IACG,IAAI,CACR,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,MAAM,EAAE,MAAM,EACd,OAAO,GAAE,qBAA0B;iBAEM,MAAM;;IASjD;;;;;;;OAOG;IACG,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,qBAA0B;;;;;IAUpE;;;;;;OAMG;IACG,UAAU,CACd,QAAQ,EAAE,MAAM,EAChB,OAAO,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;iBAEwC,MAAM;;IASjD;;;;;;;OAOG;IACG,uBAAuB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC;IAU1F;;;;;OAKG;IACG,gBAAgB,CACpB,gBAAgB,GAAE,kBAAuB,EACzC,IAAI,GAAE,eAAoB,EAC1B,OAAO,GAAE,4BAAiC;IAS5C;;;OAGG;IACG,YAAY,CAAC,MAAM,GAAE,gBAAqB;IAIhD;;;OAGG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM;IAIrB,YAAY,CAAC,GAAG,EAAE,MAAM;IAI9B;;;;;OAKG;IACG,YAAY,CAChB,gBAAgB,EAAE,6BAA6B,EAC/C,IAAI,EAAE,0BAA0B,EAChC,OAAO,GAAE,KAAU;IASf,YAAY,CAAC,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,mBAAwB;iBAC7C,MAAM;;IAUjD;;;;;;;;;;;;OAYG;IACG,KAAK,CACT,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,eAAe,EAAE,MAAM,EACvB,iBAAiB,EAAE;QAEjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7B,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;QACjB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,EACD,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE;QACR,UAAU,CAAC,EAAE,OAAO,CAAC;KACtB;CAWJ"}
|
package/dist/types/types.d.ts
CHANGED
|
@@ -282,7 +282,13 @@ export declare type ChannelUpdateOptions = {
|
|
|
282
282
|
export declare type ChannelMemberAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
283
283
|
members: ChannelMemberResponse<StreamChatGenerics>[];
|
|
284
284
|
};
|
|
285
|
+
export declare type ChannelMemberUpdates = {
|
|
286
|
+
archived?: boolean;
|
|
287
|
+
channel_role?: Role;
|
|
288
|
+
pinned?: boolean;
|
|
289
|
+
};
|
|
285
290
|
export declare type ChannelMemberResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
291
|
+
archived_at?: string;
|
|
286
292
|
ban_expires?: string;
|
|
287
293
|
banned?: boolean;
|
|
288
294
|
channel_role?: Role;
|
|
@@ -292,6 +298,7 @@ export declare type ChannelMemberResponse<StreamChatGenerics extends ExtendableG
|
|
|
292
298
|
invited?: boolean;
|
|
293
299
|
is_moderator?: boolean;
|
|
294
300
|
notifications_muted?: boolean;
|
|
301
|
+
pinned_at?: string;
|
|
295
302
|
role?: string;
|
|
296
303
|
shadow_banned?: boolean;
|
|
297
304
|
status?: string;
|
|
@@ -299,6 +306,9 @@ export declare type ChannelMemberResponse<StreamChatGenerics extends ExtendableG
|
|
|
299
306
|
user?: UserResponse<StreamChatGenerics>;
|
|
300
307
|
user_id?: string;
|
|
301
308
|
};
|
|
309
|
+
export declare type PartialUpdateMemberAPIResponse<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
|
|
310
|
+
channel_member: ChannelMemberResponse<StreamChatGenerics>;
|
|
311
|
+
};
|
|
302
312
|
export declare type CheckPushResponse = APIResponse & {
|
|
303
313
|
device_errors?: {
|
|
304
314
|
[deviceID: string]: {
|
|
@@ -1195,6 +1205,9 @@ export declare type ChannelFilters<StreamChatGenerics extends ExtendableGenerics
|
|
|
1195
1205
|
reactionType: StreamChatGenerics['reactionType'];
|
|
1196
1206
|
userType: StreamChatGenerics['userType'];
|
|
1197
1207
|
}>[Key]>;
|
|
1208
|
+
} & {
|
|
1209
|
+
archived?: boolean;
|
|
1210
|
+
pinned?: boolean;
|
|
1198
1211
|
}>;
|
|
1199
1212
|
export declare type QueryPollsParams = {
|
|
1200
1213
|
filter?: QueryPollsFilters;
|
|
@@ -1389,7 +1402,9 @@ export declare type ReactionSort<StreamChatGenerics extends ExtendableGenerics =
|
|
|
1389
1402
|
export declare type ReactionSortBase<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Sort<StreamChatGenerics['reactionType']> & {
|
|
1390
1403
|
created_at?: AscDesc;
|
|
1391
1404
|
};
|
|
1392
|
-
export declare type ChannelSort<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = ChannelSortBase<StreamChatGenerics> | Array<ChannelSortBase<StreamChatGenerics
|
|
1405
|
+
export declare type ChannelSort<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = ChannelSortBase<StreamChatGenerics> | Array<ChannelSortBase<StreamChatGenerics>> | {
|
|
1406
|
+
pinned_at: AscDesc;
|
|
1407
|
+
};
|
|
1393
1408
|
export declare type ChannelSortBase<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = Sort<StreamChatGenerics['channelType']> & {
|
|
1394
1409
|
created_at?: AscDesc;
|
|
1395
1410
|
has_unread?: AscDesc;
|
|
@@ -1845,9 +1860,9 @@ export declare type PartialUpdateChannel<StreamChatGenerics extends ExtendableGe
|
|
|
1845
1860
|
set?: Partial<ChannelResponse<StreamChatGenerics>>;
|
|
1846
1861
|
unset?: Array<keyof ChannelResponse<StreamChatGenerics>>;
|
|
1847
1862
|
};
|
|
1848
|
-
export declare type PartialUpdateMember
|
|
1849
|
-
set?:
|
|
1850
|
-
unset?: Array<keyof
|
|
1863
|
+
export declare type PartialUpdateMember = {
|
|
1864
|
+
set?: ChannelMemberUpdates;
|
|
1865
|
+
unset?: Array<keyof ChannelMemberUpdates>;
|
|
1851
1866
|
};
|
|
1852
1867
|
export declare type PartialUserUpdate<StreamChatGenerics extends ExtendableGenerics = DefaultGenerics> = {
|
|
1853
1868
|
id: string;
|
|
@@ -2410,6 +2425,13 @@ export declare type GetUserModerationReportResponse<StreamChatGenerics extends E
|
|
|
2410
2425
|
}>;
|
|
2411
2426
|
user_mutes?: Mute<StreamChatGenerics>[];
|
|
2412
2427
|
};
|
|
2428
|
+
export declare type QueryModerationConfigsFilters = QueryFilters<{
|
|
2429
|
+
key?: string;
|
|
2430
|
+
} & {
|
|
2431
|
+
created_at?: PrimitiveFilter<string>;
|
|
2432
|
+
} & {
|
|
2433
|
+
updated_at?: PrimitiveFilter<string>;
|
|
2434
|
+
}>;
|
|
2413
2435
|
export declare type ReviewQueueFilters = QueryFilters<{
|
|
2414
2436
|
assigned_to?: RequireOnlyOne<Pick<QueryFilter<ReviewQueueItem['assigned_to']>, '$eq' | '$in'>> | PrimitiveFilter<ReviewQueueItem['assigned_to']>;
|
|
2415
2437
|
} & {
|
|
@@ -2440,6 +2462,7 @@ export declare type ReviewQueueFilters = QueryFilters<{
|
|
|
2440
2462
|
has_video?: boolean;
|
|
2441
2463
|
}>;
|
|
2442
2464
|
export declare type ReviewQueueSort = Sort<Pick<ReviewQueueItem, 'id' | 'created_at' | 'updated_at'>> | Array<Sort<Pick<ReviewQueueItem, 'id' | 'created_at' | 'updated_at'>>>;
|
|
2465
|
+
export declare type QueryModerationConfigsSort = Array<Sort<'key' | 'created_at' | 'updated_at'>>;
|
|
2443
2466
|
export declare type ReviewQueuePaginationOptions = Pager;
|
|
2444
2467
|
export declare type ReviewQueueResponse = {
|
|
2445
2468
|
items: ReviewQueueItem[];
|