rn-webim-chat/src/types.ts

Webim chat wrapper for React-Native. Supports Android and iOS. Fixed issues for native platforms build that are present in the official package.

import type { CustomWebimNativeError } from './webimNativeError';
import type { WebimNativeErrorType } from './webimNativeError';

export type SessionBuilderParams = {
  accountName: string;
  location: string;
  accountJSON?: string;
  providedAuthorizationToken?: string;
  appVersion?: string;
  clearVisitorData?: boolean;
  storeHistoryLocally?: boolean;
  title?: string;
  pushToken?: string;
  prechat?: string;
};

export enum WebimEvents {
  NEW_MESSAGE = 'newMessage',
  REMOVE_MESSAGE = 'removeMessage',
  EDIT_MESSAGE = 'changedMessage',
  CLEAR_DIALOG = 'allMessagesRemoved',
  TOKEN_UPDATED = 'tokenUpdated',
  ERROR = 'error',
  STATE = 'onlineState',
  UNREAD_COUNTER = 'unreadCount',
  TYPING = 'typing',
  FILE_UPLOADING_PROGRESS = 'fileUploading',
}

export interface WebimAttachment {
  contentType: string;
  info: string;
  name: string;
  size: number;
  url: string;
}

type MessageTypeAlias =
  | 'OPERATOR'
  | 'VISITOR'
  | 'INFO'
  | 'ACTION_REQUEST'
  | 'CONTACTS_REQUEST'
  | 'FILE_FROM_OPERATOR'
  | 'FILE_FROM_VISITOR'
  | 'OPERATOR_BUSY'
  | 'KEYBOARD'
  | 'KEYBOARD_RESPONSE';

export type WebimMessage = {
  id: string;
  serverSideId: string;
  avatar?: string;
  time: number;
  type: MessageTypeAlias;
  text: string;
  name: string;
  status: 'SENT' | 'SENDING';
  read: boolean;
  canEdit: boolean;
  carReply: boolean;
  isEdited: boolean;
  canReact: boolean;
  canChangeReaction: boolean;
  visitorReaction?: string;
  stickerId?: number;
  quote?: Quote;
  attachment?: WebimAttachment;
  operatorId?: string;
};

export type Quote = {
  authorId?: string;
  senderName: string;
  messageId: string;
  messageText: string;
  messageType: MessageTypeAlias;
  state: 'FILLED' | 'NOT_FOUND' | 'PENDING';
  timestamp: Date | number;
  attachment?: WebimAttachment;
};

export type Operator = {
  id: string;
  name: string;
  avatar?: string;
  title: string;
  info: string;
};

export type AttachFileResult = {
  uri: string;
  name: string;
  mime: string;
  extension: string;
};

export type WebimNativeError = {
  message: string;
  errorCode: WebimNativeErrorType | CustomWebimNativeError;
  errorType: 'fatal' | 'common';
};

export type NewMessageListener = (data: WebimMessage) => void;
export type UpdateMessageListener = (data: {
  from: WebimMessage;
  to: WebimMessage;
}) => void;
export type RemoveMessageListener = (data: { msg: WebimMessage }) => void;
export type DialogClearedListener = () => void;
export type TokenUpdatedListener = (token: string) => void;
export type ErrorListener = (error: WebimNativeError) => void;
export type StateListener = (state: { old: string; new: string }) => void;
export type TypingListener = (state: { isTyping: boolean }) => void;
export type UnreadCountListener = (state: number) => void;
export type FileUploadingListener = (progress: {
  id: string;
  bytes: number;
  fullSize: number;
}) => void;

export type WebimEventListener =
  | NewMessageListener
  | UpdateMessageListener
  | RemoveMessageListener
  | DialogClearedListener
  | TokenUpdatedListener
  | ErrorListener
  | StateListener
  | TypingListener
  | UnreadCountListener
  | FileUploadingListener;