add isOwnUser type guard and add OwnUser to Client User type

Author: nhannah

src/client.ts

@@ -63,6 +63,7 @@ import {
   Mute,
   MuteUserOptions,
   MuteUserResponse,
+  OwnUserResponse,
   PartialUserUpdate,
   PermissionAPIResponse,
   PermissionsAPIResponse,
@@ -101,7 +102,7 @@ export class StreamChat<
   ReactionType extends UnknownType = UnknownType,
   UserType extends UnknownType = UnknownType
 > {
-  _user?: UserResponse<UserType>;
+  _user?: OwnUserResponse<ChannelType, CommandType, UserType> | UserResponse<UserType>;
   activeChannels: {
     [key: string]: Channel<
       AttachmentType,
@@ -159,7 +160,7 @@ export class StreamChat<
   setUserPromise: ConnectAPIResponse<ChannelType, CommandType, UserType> | null;
   state: ClientState<UserType>;
   tokenManager: TokenManager<UserType>;
-  user?: UserResponse<UserType>;
+  user?: OwnUserResponse<ChannelType, CommandType, UserType> | UserResponse<UserType>;
   userAgent?: string;
   userID?: string;
   wsBaseURL?: string;
@@ -334,13 +335,13 @@ export class StreamChat<
   /**
    * connectUser - Set the current user and open a WebSocket connection
    *
-   * @param {UserResponse<UserType>} user Data about this user. IE {name: "john"}
+   * @param {OwnUserResponse<ChannelType, CommandType, UserType> | UserResponse<UserType>} user Data about this user. IE {name: "john"}
    * @param {TokenOrProvider} userTokenOrProvider Token or provider
    *
    * @return {ConnectAPIResponse<ChannelType, CommandType, UserType>} Returns a promise that resolves when the connection is setup
    */
   connectUser = (
-    user: UserResponse<UserType>,
+    user: OwnUserResponse<ChannelType, CommandType, UserType> | UserResponse<UserType>,
     userTokenOrProvider: TokenOrProvider,
   ): ConnectAPIResponse<ChannelType, CommandType, UserType> => {
     if (this.userID) {
@@ -386,21 +387,23 @@ export class StreamChat<
    *
    * setUser - Set the current user and open a WebSocket connection
    *
-   * @param {UserResponse<UserType>} user Data about this user. IE {name: "john"}
+   * @param {OwnUserResponse<ChannelType, CommandType, UserType> | UserResponse<UserType>} user Data about this user. IE {name: "john"}
    * @param {TokenOrProvider} userTokenOrProvider Token or provider
    *
    * @return {ConnectAPIResponse<ChannelType, CommandType, UserType>} Returns a promise that resolves when the connection is setup
    */
   setUser = (
-    user: UserResponse<UserType>,
+    user: OwnUserResponse<ChannelType, CommandType, UserType> | UserResponse<UserType>,
     userTokenOrProvider: TokenOrProvider,
   ): ConnectAPIResponse<ChannelType, CommandType, UserType> =>
     this.connectUser(user, userTokenOrProvider);
 
   _setToken = (user: UserResponse<UserType>, userTokenOrProvider: TokenOrProvider) =>
     this.tokenManager.setTokenOrProvider(userTokenOrProvider, user);
 
-  _setUser(user: UserResponse<UserType>) {
+  _setUser(
+    user: OwnUserResponse<ChannelType, CommandType, UserType> | UserResponse<UserType>,
+  ) {
     // this one is used by the frontend
     this.user = user;
     // this one is actually used for requests...

src/index.ts

@@ -9,4 +9,4 @@ export * from './permissions';
 export * from './signing';
 export * from './token_manager';
 export * from './types';
-export { chatCodes, logChatPromiseExecution } from './utils';
+export { isOwnUser, chatCodes, logChatPromiseExecution } from './utils';

src/utils.ts

@@ -1,5 +1,12 @@
 import FormData from 'form-data';
-import { AscDesc, QuerySort } from './types';
+import {
+  AscDesc,
+  LiteralStringForUnion,
+  OwnUserResponse,
+  QuerySort,
+  UnknownType,
+  UserResponse,
+} from './types';
 
 /**
  * logChatPromiseExecution - utility function for logging the execution of a promise..
@@ -55,6 +62,19 @@ function isFileWebAPI(uri: unknown): uri is File {
   return typeof window !== 'undefined' && 'File' in window && uri instanceof File;
 }
 
+export function isOwnUser<
+  ChannelType extends UnknownType = UnknownType,
+  CommandType extends string = LiteralStringForUnion,
+  UserType extends UnknownType = UnknownType
+>(
+  user?: OwnUserResponse<ChannelType, CommandType, UserType> | UserResponse<UserType>,
+): user is OwnUserResponse<ChannelType, CommandType, UserType> {
+  return (
+    (user as OwnUserResponse<ChannelType, CommandType, UserType>)?.total_unread_count !==
+    undefined
+  );
+}
+
 export function addFileToFormData(
   uri: string | NodeJS.ReadableStream | Buffer | File,
   name?: string,