stream-chat 4.5.0-beta.0 → 5.1.1

package/src/errors.ts

@@ -28,7 +28,7 @@ export const APIErrorCodes: Record<string, { name: string; retryable: boolean }>
   '99': { name: 'AppSuspendedError', retryable: false },
 };
 
-type APIError = Error & { code?: number; isWSFailure?: boolean };
+type APIError = Error & { code: number; isWSFailure?: boolean };
 
 export function isAPIError(error: Error): error is APIError {
   return (error as APIError).code !== undefined;

package/src/types.ts

@@ -147,6 +147,48 @@ export type MessageFlagsResponse<
   }>;
 };
 
+export type FlagReport<
+  ChannelType extends UR = UR,
+  CommandType extends string = LiteralStringForUnion,
+  UserType extends UR = UR,
+  AttachmentType = UR,
+  MessageType = UR,
+  ReactionType = UR
+> = {
+  flags_count: number;
+  id: string;
+  message: MessageResponse<AttachmentType, ChannelType, CommandType, MessageType, ReactionType, UserType>;
+  user: UserResponse<UserType>;
+  created_at?: string;
+  review_details?: Object;
+  review_result?: string;
+  reviewed_at?: string;
+  reviewed_by?: UserResponse<UserType>;
+  updated_at?: string;
+};
+
+export type FlagReportsResponse<
+  ChannelType extends UR = UR,
+  CommandType extends string = LiteralStringForUnion,
+  UserType extends UR = UR,
+  AttachmentType = UR,
+  MessageType = UR,
+  ReactionType = UR
+> = APIResponse & {
+  flag_reports: Array<FlagReport<ChannelType, CommandType, UserType, AttachmentType, MessageType, ReactionType>>;
+};
+
+export type ReviewFlagReportResponse<
+  ChannelType extends UR = UR,
+  CommandType extends string = LiteralStringForUnion,
+  UserType extends UR = UR,
+  AttachmentType = UR,
+  MessageType = UR,
+  ReactionType = UR
+> = APIResponse & {
+  flag_report: FlagReport<ChannelType, CommandType, UserType, AttachmentType, MessageType, ReactionType>;
+};
+
 export type BannedUsersResponse<
   ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
@@ -326,6 +368,7 @@ export type FlagMessageResponse<UserType = UR> = APIResponse & {
     updated_at: string;
     user: UserResponse<UserType>;
     approved_at?: string;
+    details?: Object; // Any JSON
     rejected_at?: string;
     reviewed_at?: string;
     reviewed_by?: string;
@@ -340,6 +383,7 @@ export type FlagUserResponse<UserType = UR> = APIResponse & {
     updated_at: string;
     user: UserResponse<UserType>;
     approved_at?: string;
+    details?: Object; // Any JSON
     rejected_at?: string;
     reviewed_at?: string;
     reviewed_by?: string;
@@ -426,7 +470,7 @@ export type ListChannelTypesAPIResponse<
 > = ListChannelResponse<CommandType>;
 
 export type ListCommandsResponse<CommandType extends string = LiteralStringForUnion> = APIResponse & {
-  commands: Array<CreateCommandOptions<CommandType> & CreatedAtUpdatedAt>;
+  commands: Array<CreateCommandOptions<CommandType> & Partial<CreatedAtUpdatedAt>>;
 };
 
 export type MuteChannelAPIResponse<
@@ -665,11 +709,17 @@ export type UserResponse<UserType = UR> = User<UserType> & {
   language?: TranslationLanguages | '';
   last_active?: string;
   online?: boolean;
+  push_notifications?: PushNotificationSettings;
   revoke_tokens_issued_before?: string;
   shadow_banned?: boolean;
   updated_at?: string;
 };
 
+export type PushNotificationSettings = {
+  disabled?: boolean;
+  disabled_until?: string | null;
+};
+
 /**
  * Option Types
  */
@@ -679,6 +729,16 @@ export type MessageFlagsPaginationOptions = {
   offset?: number;
 };
 
+export type FlagReportsPaginationOptions = {
+  limit?: number;
+  offset?: number;
+};
+
+export type ReviewFlagReportOptions = {
+  review_details?: Object;
+  user_id?: string;
+};
+
 export type BannedUsersPaginationOptions = Omit<PaginationOptions, 'id_gt' | 'id_gte' | 'id_lt' | 'id_lte'>;
 
 export type BanUserOptions<UserType = UR> = UnBanUserOptions & {
@@ -687,14 +747,6 @@ export type BanUserOptions<UserType = UR> = UnBanUserOptions & {
   ip_ban?: boolean;
   reason?: string;
   timeout?: number;
-  /**
-   * @deprecated please use banned_by
-   */
-  user?: UserResponse<UserType>;
-  /**
-   * @deprecated please use banned_by_id
-   */
-  user_id?: string;
 };
 
 export type ChannelOptions = {
@@ -842,6 +894,21 @@ export type MessagePaginationOptions = PaginationOptions & {
   id_around?: string;
 };
 
+export type PinnedMessagePaginationOptions = {
+  id_around?: string;
+  id_gt?: string;
+  id_gte?: string;
+  id_lt?: string;
+  id_lte?: string;
+  limit?: number;
+  offset?: number;
+  pinned_at_after?: string | Date;
+  pinned_at_after_or_equal?: string | Date;
+  pinned_at_around?: string | Date;
+  pinned_at_before?: string | Date;
+  pinned_at_before_or_equal?: string | Date;
+};
+
 export type QueryMembersOptions = {
   limit?: number;
   offset?: number;
@@ -985,6 +1052,7 @@ export type EventTypes =
   | 'channel.unmuted'
   | 'channel.updated'
   | 'channel.visible'
+  | 'transport.changed' // ws vs longpoll
   | 'connection.changed'
   | 'connection.recovered'
   | 'health.check'
@@ -1052,6 +1120,43 @@ export type MessageFlagsFilters = QueryFilters<
     }
 >;
 
+export type FlagReportsFiltersOptions = {
+  is_reviewed?: boolean;
+  message_id?: string;
+  report_id?: string;
+  review_result?: string;
+  reviewed_by?: string;
+  user_id?: string;
+};
+
+export type FlagReportsFilters = QueryFilters<
+  {
+    report_id?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['report_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagReportsFiltersOptions['report_id']>;
+  } & {
+    review_result?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['review_result']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagReportsFiltersOptions['review_result']>;
+  } & {
+    reviewed_by?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['reviewed_by']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagReportsFiltersOptions['reviewed_by']>;
+  } & {
+    user_id?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['user_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagReportsFiltersOptions['user_id']>;
+  } & {
+    message_id?:
+      | RequireOnlyOne<Pick<QueryFilter<FlagReportsFiltersOptions['message_id']>, '$eq' | '$in'>>
+      | PrimitiveFilter<FlagReportsFiltersOptions['message_id']>;
+  } & {
+      [Key in keyof Omit<
+        FlagReportsFiltersOptions,
+        'report_id' | 'user_id' | 'message_id' | 'review_result' | 'reviewed_by'
+      >]: RequireOnlyOne<QueryFilter<FlagReportsFiltersOptions[Key]>> | PrimitiveFilter<FlagReportsFiltersOptions[Key]>;
+    }
+>;
 export type BannedUsersFilterOptions = {
   banned_by_id?: string;
   channel_cid?: string;
@@ -1238,6 +1343,9 @@ export type ChannelSortBase<ChannelType = UR> = Sort<ChannelType> & {
   updated_at?: AscDesc;
 };
 
+export type PinnedMessagesSort = PinnedMessagesSortBase | Array<PinnedMessagesSortBase>;
+export type PinnedMessagesSortBase = { pinned_at?: AscDesc };
+
 export type Sort<T> = {
   [P in keyof T]?: AscDesc;
 };
@@ -1613,13 +1721,16 @@ export type EndpointName =
 export type ExportChannelRequest = {
   id: string;
   type: string;
+  cid?: string;
   messages_since?: Date;
   messages_until?: Date;
 };
 
 export type ExportChannelOptions = {
   clear_deleted_message_text?: boolean;
+  export_users?: boolean;
   include_truncated_messages?: boolean;
+  version?: string;
 };
 
 export type Field = {
@@ -1665,7 +1776,9 @@ export type MessageBase<AttachmentType = UR, MessageType = UR, UserType = UR> =
   html?: string;
   mml?: string;
   parent_id?: string;
+  pin_expires?: string;
   pinned?: boolean;
+  pinned_at?: string;
   quoted_message_id?: string;
   show_in_channel?: boolean;
   text?: string;
@@ -1709,6 +1822,7 @@ export type PermissionAPIObject = {
   custom?: boolean;
   description?: string;
   id?: string;
+  level?: string;
   name?: string;
   owner?: boolean;
   same_team?: boolean;

package/src/utils.ts

@@ -205,7 +205,7 @@ export function convertErrorToJson(err: Error) {
 }
 
 /**
- * isOnline safely return the navigator.online value
+ * isOnline safely return the navigator.online value for browser env
  * if navigator is not in global object, it always return true
  */
 export function isOnline() {
@@ -216,7 +216,16 @@ export function isOnline() {
       ? window.navigator
       : undefined;
 
-  if (!nav) return true;
+  if (!nav) {
+    console.warn('isOnline failed to access window.navigator and assume browser is online');
+    return true;
+  }
+
+  // RN navigator has undefined for onLine
+  if (typeof nav.onLine !== 'boolean') {
+    return true;
+  }
+
   return nav.onLine;
 }