stream-chat 4.4.3-dev.2 → 5.0.0

package/src/utils.ts

@@ -1,12 +1,5 @@
 import FormData from 'form-data';
-import {
-  AscDesc,
-  LiteralStringForUnion,
-  OwnUserBase,
-  OwnUserResponse,
-  UnknownType,
-  UserResponse,
-} from './types';
+import { AscDesc, LiteralStringForUnion, OwnUserBase, OwnUserResponse, UR, UserResponse } from './types';
 
 /**
  * logChatPromiseExecution - utility function for logging the execution of a promise..
@@ -42,8 +35,7 @@ function isReadableStream(obj: unknown): obj is NodeJS.ReadStream {
   return (
     obj !== null &&
     typeof obj === 'object' &&
-    ((obj as NodeJS.ReadStream).readable ||
-      typeof (obj as NodeJS.ReadStream)._read === 'function')
+    ((obj as NodeJS.ReadStream).readable || typeof (obj as NodeJS.ReadStream)._read === 'function')
   );
 }
 
@@ -63,16 +55,13 @@ function isFileWebAPI(uri: unknown): uri is File {
 }
 
 export function isOwnUser<
-  ChannelType extends UnknownType = UnknownType,
+  ChannelType extends UR = UR,
   CommandType extends string = LiteralStringForUnion,
-  UserType extends UnknownType = UnknownType
+  UserType extends UR = UR
 >(
   user?: OwnUserResponse<ChannelType, CommandType, UserType> | UserResponse<UserType>,
 ): user is OwnUserResponse<ChannelType, CommandType, UserType> {
-  return (
-    (user as OwnUserResponse<ChannelType, CommandType, UserType>)?.total_unread_count !==
-    undefined
-  );
+  return (user as OwnUserResponse<ChannelType, CommandType, UserType>)?.total_unread_count !== undefined;
 }
 
 export function isOwnUserBaseProperty(property: string) {
@@ -113,9 +102,7 @@ export function addFileToFormData(
 
   return data;
 }
-export function normalizeQuerySort<T extends Record<string, AscDesc | undefined>>(
-  sort: T | T[],
-) {
+export function normalizeQuerySort<T extends Record<string, AscDesc | undefined>>(sort: T | T[]) {
   const sortFields: Array<{ direction: AscDesc; field: keyof T }> = [];
   const sortArr = Array.isArray(sort) ? sort : [sort];
   for (const item of sortArr) {
@@ -199,15 +186,62 @@ function getRandomBytes(length: number): Uint8Array {
   return bytes;
 }
 
-export function convertErrorToJson(err: unknown) {
+export function convertErrorToJson(err: Error) {
   const jsonObj = {} as Record<string, unknown>;
 
   if (!err) return jsonObj;
 
-  Object.getOwnPropertyNames(err).forEach((key) => {
-    // @ts-ignore
-    jsonObj[key] = err[key];
-  });
+  try {
+    Object.getOwnPropertyNames(err).forEach((key) => {
+      jsonObj[key] = Object.getOwnPropertyDescriptor(err, key);
+    });
+  } catch (_) {
+    return {
+      error: 'failed to serialize the error',
+    };
+  }
 
   return jsonObj;
 }
+
+/**
+ * isOnline safely return the navigator.online value for browser env
+ * if navigator is not in global object, it always return true
+ */
+export function isOnline() {
+  const nav =
+    typeof navigator !== 'undefined'
+      ? navigator
+      : typeof window !== 'undefined' && window.navigator
+      ? window.navigator
+      : undefined;
+
+  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;
+}
+
+/**
+ * listenForConnectionChanges - Adds an event listener fired on browser going online or offline
+ */
+export function addConnectionEventListeners(cb: (e: Event) => void) {
+  if (typeof window !== 'undefined' && window.addEventListener) {
+    window.addEventListener('offline', cb);
+    window.addEventListener('online', cb);
+  }
+}
+
+export function removeConnectionEventListeners(cb: (e: Event) => void) {
+  if (typeof window !== 'undefined' && window.removeEventListener) {
+    window.removeEventListener('offline', cb);
+    window.removeEventListener('online', cb);
+  }
+}