@ethora/chat-component-rn 26.4.1

package/src/types/messages.ts

@@ -0,0 +1,61 @@
+export interface MainFields {
+  id: string;
+  body: string;
+  roomJID: string;
+  date: Date;
+  key: string;
+  coinsInMessage: number;
+  numberOfReplies: number;
+}
+
+export interface DataFields {
+  photoURL: string; // sender's photo
+  roomJid: string; // room JID (which room message belongs to) TO DO: remove this from Data - looks like a duplicate ?
+  senderFirstName: string; // TO DO: review - may replace with vCard / users store
+  senderLastName: string; // TO DO: review - may replace with vCard / users store
+  senderWalletAddress: string; // TO DO: review - may be deprecated, we can derive this from 'from' user's JID
+  senderJID?: string;
+  xmlns?: string; // probably system - websockets endpoint? not sure if used
+  isEdited?: boolean; // if message was edited (to display 'edited' in UI)
+
+  // push notifications
+  mucName?: string; // chat Room name to display in Push Notifications
+  push?: boolean; // specifies whether this message should be included in push notifications. Offline users subscribed to the Room will receive push alerts to their devices for those messages that have this parameter enabled. Should be enabled for all standard messages. E.g. don't specify this for system messages.
+
+  // replies and threads
+  quickReplies?: string[]; // number of responses in the thread ? TO DO: review, may be deprecated due to threads feature
+  isReply?: boolean; // if this is a response to another message (replies/threads)
+  showInChannel?: boolean; // for thread responses, whether user ticked 'copy to room', if not this will only be shown in the thread
+  mainMessage?: string; // for thread responses, the ID of the main message (or text quote?)
+
+  // system messages
+  isSystemMessage?: boolean; // if this flag is set, App UI will not process this as a standard text message, and will instead process this as a system message. For example, this could be a system message informing others about a Coin transfer from one User to another. Such message will be displayed in a different, more subtle way, in order to not clutter the Room
+  tokenAmount?: number; // (system message) for coin transfers - the number of tokens being sent - used in system type transfer messages. Typically this is used for “tipping” or social ranking mechanism. Users can tap on Messages of other users and tip them with Coins. Message will display a counter of Coins received, similarly to ‘likes’ in social networks
+  receiverMessageId?: boolean; // (system message) for coin transfers - the ID of the message that receives the transfer
+}
+
+export interface FileAttachmentParams {
+  createdAt: Date; // when file was created (from our API - mongodb)
+  fileName: string; // for file attachments this is used to display the file name
+  imageLocation: string; // for file attachments this is URL of the file itself, typically from our IPFS or Minio buckets based files service
+  imagePreview: string; // for file attachments that are pictures and some other supported file types (PDF etc) this will be a path to the preview / thumbnail version of the attachment
+  mimeType: string; // for file attachments this is the mimeType of the file, so that App interface can display the correct UI and/or icon (e.g. PDF, DOC) for this type of file
+  originalName: string; // similar to fileName, but uses full system name of the file attachments including extension etc. TF: either this or fileName may be deprecated
+  size: number; // for file attachments this will be used to display the file size so that users can estimate the impact of opening or downloading it
+  duration: number; // for attachments that are audio or video, this is their duration in seconds to inform the users how long it would take to to play it
+  waveForm: string; // for attachments that are audio, this will display the waveForm so that users can visually estimate the contents of the record
+  attachmentId: string; // this refers to the file object ID as per /files/ API. This is used to enable actions over the files in certain use cases
+}
+
+export interface NFTAttachmentParams {
+  wrappable: boolean; // this is used for the purposes of digital art and NFT. If enabled, this means users can wrap this content into NFT
+  nftId: string; // this is used for the purposes of digital art and NFT. This is used to link content with an NFT collection
+  nftActionType: string; //  this is used for the purposes of digital art and NFT. This is to inform App interface of what type of actions are available
+  contractAddress: string; // this is used when messages are linked to smart contracts
+}
+
+export interface MessageType extends MainFields, DataFields {}
+
+export interface FileAttachment extends MainFields, FileAttachmentParams {}
+
+export interface NFTAttachment extends MainFields, NFTAttachmentParams {}

package/src/types/models/action.model.ts

@@ -0,0 +1,30 @@
+import { IMessage } from './message.model';
+
+export interface DeleteModal {
+  isDeleteModal: boolean;
+  roomJid?: string;
+  messageId?: string;
+}
+
+export interface EditAction {
+  isEdit: boolean;
+  roomJid?: string;
+  messageId?: string;
+  text?: string;
+}
+
+// Consolidated ReactionAction, using the more comprehensive definition
+export interface ReactionAction {
+  roomJID: string;
+  messageId: string;
+  from: string; // Included from the first definition
+  reactions: string[];
+  latestReactionTimestamp?: string; // Included from the first definition
+  data?: Record<string, string>; // Included from the first definition
+}
+
+export interface AddRoomMessageAction {
+  roomJID: string;
+  message: IMessage;
+  start?: boolean;
+}

package/src/types/models/config.model.ts

@@ -0,0 +1,16 @@
+// Canonical IConfig now lives in `src/types/types.ts` (it's the surface
+// the XMPP provider, ChatWrapper, useSendMessage, persistence, scheduler,
+// and notification provider all import). This file re-exports it so the
+// UI layer (which imports from `types/models/config.model`) keeps working
+// without drifting from the flow layer.
+//
+// Add NEW fields to `src/types/types.ts:IConfig`, not here.
+
+export type {
+  IConfig,
+  FBConfig,
+  MessageBubble,
+  PartialRoomWithMandatoryKeys,
+  HistoryQoSConfig,
+  InAppNotificationConfig,
+} from '../types';

package/src/types/models/customComponents.model.ts

@@ -0,0 +1,53 @@
+/** @format */
+
+import React from 'react';
+import { IConfig, IMessage, MessageProps } from '../types';
+import { ViewStyle } from 'react-native';
+
+export interface DaySeparatorProps {
+  date: Date;
+  formattedDate: string;
+}
+
+export interface NewMessageLabelProps {
+  color?: string;
+}
+
+export interface DecoratedMessage {
+  message: IMessage;
+  showDateLabel: boolean;
+}
+
+export interface ScrollControllerApi {
+  scrollToBottom: () => void;
+  waitForImagesLoaded: () => Promise<void>;
+  showScrollButton: boolean;
+  newMessagesCount: number;
+  resetNewMessageCounter: () => void;
+}
+
+export interface CustomScrollableAreaProps {
+  roomJID: string;
+  messages: IMessage[];
+  decoratedMessages: DecoratedMessage[];
+  isLoading: boolean;
+  isReply: boolean;
+  activeMessage?: IMessage;
+  loadMoreMessages: (
+    chatJID: string,
+    max: number,
+    amount?: number
+  ) => Promise<void>;
+  renderMessage: (decorated: DecoratedMessage) => React.ReactNode;
+  scrollController: ScrollControllerApi;
+  typingIndicator?: React.ReactNode;
+  config?: IConfig;
+}
+
+export interface CustomComponentsContextValue {
+  CustomMessageComponent?: React.ComponentType<MessageProps>;
+  CustomInputComponent?: React.ComponentType<any>;
+  CustomScrollableArea?: React.ComponentType<CustomScrollableAreaProps>;
+  CustomDaySeparator?: React.ComponentType<DaySeparatorProps>;
+  CustomNewMessageLabel?: React.ComponentType<NewMessageLabelProps>;
+}

package/src/types/models/language.model.ts

@@ -0,0 +1,11 @@
+export type Iso639_1Codes = 'en' | 'es' | 'pt' | 'ht' | 'zh';
+
+export interface Language {
+  iso639_1: Iso639_1Codes;
+  name: string;
+}
+
+export type LanguageOptions = {
+  languages: Array<Language>;
+  language?: Iso639_1Codes;
+};

package/src/types/models/media.model.ts

@@ -0,0 +1,5 @@
+export type MediaFile = {
+  uri: string;
+  type: string;
+  name: string;
+};

package/src/types/models/message.model.ts

@@ -0,0 +1,69 @@
+import { IUser } from './user.model';
+import { TranslationObject } from '../types';
+import { Iso639_1Codes } from './language.model';
+
+export interface IMessage {
+  id: string;
+  user: IUser;
+  date: Date | string;
+  body: string;
+  roomJid: string;
+  key?: string;
+  coinsInMessage?: string | number;
+  numberOfReplies?: number[] | number;
+  isSystemMessage?: string;
+  isMediafile?: string;
+  locationPreview?: string;
+  mimetype?: string;
+  location?: string;
+  pending?: boolean;
+  timestamp?: number;
+  showInChannel?: string;
+  activeMessage?: boolean;
+  isReply?: boolean | string;
+  isDeleted?: boolean;
+  mainMessage?: string;
+  reply?: IReply[];
+  reaction?: Record<string, ReactionMessage>;
+  fileName?: string;
+  translations?: TranslationObject;
+  langSource?: Iso639_1Codes;
+  originalName?: string;
+  size?: string;
+  xmppId?: string;
+  xmppFrom?: string;
+  deleted?: boolean;
+}
+
+export interface ReactionMessage {
+  emoji: string[];
+  data: Record<string, string> | undefined;
+}
+
+export interface IReply extends IMessage {}
+
+export interface MessageBubble {
+  backgroundMessageUser?: string;
+  backgroundMessage?: string;
+  colorUser?: string;
+  color?: string;
+  borderRadius?: number;
+}
+
+export interface MessageProps {
+  message: IMessage;
+  isUser: boolean;
+  isReply: boolean;
+}
+
+export interface MediaMessageType {}
+
+export interface LastMessage extends Omit<Partial<IMessage>, 'date'> {
+  body: string;
+  date?: string | Date;
+  emoji?: string;
+  locationPreview?: string;
+  filename?: string;
+  mimetype?: string;
+  originalName?: string;
+}

package/src/types/models/modal.model.ts

@@ -0,0 +1,9 @@
+import { MODAL_TYPES } from '../types'; // Corrected path to use re-export from types.ts
+
+export type ModalType = (typeof MODAL_TYPES)[keyof typeof MODAL_TYPES];
+
+export interface ModalFile {
+  fileName: string;
+  fileURL: string;
+  mimetype: string;
+}

package/src/types/models/room.model.ts

@@ -0,0 +1,120 @@
+import { IMessage, LastMessage } from './message.model';
+
+export interface RoomMember {
+  firstName: string;
+  lastName: string;
+  xmppUsername: string;
+  _id: string;
+
+  ban_status?: string;
+  jid?: string;
+  name?: string;
+  role?: string;
+  last_active?: number;
+}
+
+export interface RoomLastMessage {
+  name: string;
+  body: string;
+}
+
+export interface IRoom {
+  name: string;
+  jid: string;
+  title: string;
+  usersCnt: number;
+  messages: IMessage[];
+  isLoading: boolean;
+  roomBg: string | null;
+
+  members?: RoomMember[];
+  type?: 'public' | 'group' | 'private';
+  creteadAt?: string; // Typo? Should it be createdAt?
+
+  appId?: string;
+  createdAt?: string;
+  createdBy?: string;
+  description?: string;
+  isAppChat?: boolean;
+  picture?: string;
+  updatedAt?: string;
+  __v?: number | string;
+  _id?: string;
+
+  id?: string;
+  lastMessage?: LastMessage;
+  lastMessageTimestamp?: number;
+  lastRoomMessage?: RoomLastMessage;
+  icon?: string | null;
+  composing?: boolean;
+  composingList?: string[];
+  lastViewedTimestamp?: number;
+  unreadMessages?: number;
+  noMessages?: boolean;
+  role?: string;
+
+  messageStats?: {
+    lastMessageTimestamp?: number;
+    firstMessageTimestamp?: number;
+  };
+  historyComplete?: boolean;
+}
+
+export interface ApiRoom {
+  name: string;
+  type: 'public' | 'group' | 'private';
+
+  title?: string;
+  description?: string;
+  picture?: string;
+  members?: RoomMember[];
+  createdBy?: string;
+  appId?: any;
+
+  _id?: string;
+  isAppChat?: boolean;
+  createdAt?: string;
+  updatedAt?: string;
+  __v?: string;
+}
+
+export interface PostRoom {
+  title: string;
+  uuid?: string;
+  type: 'public' | 'group';
+
+  description?: string;
+  picture?: string;
+  members?: string[];
+}
+
+export interface PostReportRoom {
+  chatName: string;
+  category: string;
+  text?: string;
+}
+
+export interface PostAddRoomMember {
+  chatName: string;
+  members: string[];
+}
+
+export interface DeleteRoomMember {
+  roomId: string;
+  members: string[];
+}
+
+export interface IRoomCompressed extends Pick<IRoom, 'jid'> {}
+
+export type PartialRoomWithMandatoryKeys = Partial<IRoom> &
+  Pick<IRoom, 'jid' | 'title'>;
+
+export interface ConfigRoom {
+  jid: string;
+  pinned: boolean;
+  _id?: string;
+}
+
+export type ChatAccessOption =
+  | { name: 'Public'; id: 'public' }
+  | { name: 'Members-only'; id: 'group' };

package/src/types/models/user.model.ts

@@ -0,0 +1,90 @@
+import { Iso639_1Codes } from './language.model';
+import { IMessage } from './message.model';
+
+export interface IUser extends Partial<User> {
+  id: string;
+  name?: string;
+  userJID?: string | null;
+  token?: string;
+  refreshToken?: string;
+}
+
+export interface User {
+  walletAddress: string;
+
+  description?: string;
+  token: string;
+  refreshToken: string;
+
+  defaultWallet: {
+    walletAddress: string;
+  };
+  _id: string;
+  firstName: string;
+  lastName: string;
+  email?: string;
+  profileImage?: string;
+  emails?: [
+    {
+      loginType: string;
+      email: string;
+      verified: boolean;
+      _id: string;
+    },
+  ];
+  appId: string;
+
+  username: string;
+  xmppPassword: string;
+
+  langSource?: Iso639_1Codes;
+
+  homeScreen?: string;
+  registrationChannelType?: string;
+  updatedAt?: string;
+  authMethod?: string;
+  resetPasswordExpires?: string;
+  resetPasswordToken?: string;
+  xmppUsername?: string;
+  roles?: string[];
+  tags?: string[];
+  __v?: number;
+
+  isProfileOpen?: boolean;
+  isAssetsOpen?: boolean;
+  isAgreeWithTerms?: boolean;
+  isSuperAdmin?: boolean;
+}
+
+export interface ConfigUser {
+  email: string;
+  password: string;
+}
+
+export interface StorageUser {
+  appId: string;
+  company: any[];
+  firstName: string;
+  homeScreen: string;
+
+  lastName: string;
+  referrerId: string;
+  refreshToken: string;
+  token: string;
+  walletAddress: string;
+  xmppPassword: string;
+  _id: string;
+
+  isAgreeWithTerms?: boolean;
+  isAllowedNewAppCreate?: boolean;
+  isAssetsOpen?: boolean;
+  isProfileOpen?: boolean;
+}
+
+// review
+export interface UserType extends IMessage {
+  id: any;
+  user: any;
+  timestamp: any;
+  text: any;
+}

package/src/types/models/xmpp.model.ts

@@ -0,0 +1,155 @@
+// Canonical xmpp types now live in `src/types/types.ts`. This file
+// re-exports them so callers importing from `types/models/xmpp.model`
+// stay aligned with the flow layer. Add NEW fields/methods to
+// `src/types/types.ts` (or `src/networking/xmppClient.ts` for class
+// methods) rather than duplicating here.
+
+import { Client } from '@xmpp/client';
+import XmppClient from '../../networking/xmppClient';
+import { Iso639_1Codes } from './language.model';
+import { IMessage } from './message.model';
+
+export type { xmppSettingsInterface, HistoryQoSConfig } from '../types';
+
+export interface XmppState {
+  client: XmppClient | null;
+  loading: boolean;
+}
+
+export interface MediaUploadData {
+  file: any; // RN: usually a {uri,name,type} object; web: File
+  type: string;
+  name?: string;
+}
+
+export type HistorySource =
+  | 'active'
+  | 'send_ack'
+  | 'background'
+  | 'default';
+
+export interface HistoryFetchOptions {
+  coalesceRoom?: boolean;
+  skipIfPreloaded?: boolean;
+  source?: HistorySource;
+}
+
+export interface XmppClientInterface {
+  client: Client;
+  devServer?: string;
+  host: string;
+  service: string;
+  conference: string;
+  username: string;
+  status: string;
+
+  password: string;
+  reconnectAttempts: number;
+  maxReconnectAttempts: number;
+  reconnectDelay: number;
+
+  // ---- lifecycle ----
+  checkOnline(): boolean;
+  initializeClient(): void;
+  attachEventListeners(): void;
+  reconnect(): void;
+  close(): Promise<void>;
+  ensureConnected(timeout?: number): Promise<void>;
+  waitForOnline(timeout?: number): Promise<void>;
+  disconnect?(options?: { suppressReconnect?: boolean }): Promise<void>;
+
+  // ---- QoS / MAM ----
+  setActiveRoomJid(roomJID: string | null): void;
+  isActiveRoomGateOpen(): boolean;
+  promoteRoomHistory(roomJID: string): void;
+  onCriticalSend(roomJID: string, messageId?: string): void;
+  prioritizeRoomPresence(roomJID: string): Promise<boolean>;
+  enqueueHistoryTask(params: {
+    chatJID: string;
+    max: number;
+    before?: number;
+    id?: string;
+    source?: HistorySource;
+  }): Promise<any>;
+
+  // ---- rooms ----
+  getRoomsStanza(disableGetRooms?: boolean): Promise<void>;
+  createRoomStanza(
+    title: string,
+    description: string,
+    to?: string
+  ): Promise<string | object>;
+  inviteRoomRequestStanza(to: string, roomJid: string): Promise<void>;
+  leaveTheRoomStanza(roomJID: string): void;
+  presenceInRoomStanza(roomJID: string): void;
+  getHistoryStanza(
+    chatJID: string,
+    max: number,
+    before?: number,
+    otherStanzaId?: string,
+    options?: HistoryFetchOptions
+  ): Promise<IMessage[]>;
+  getLastMessageArchiveStanza(roomJID: string): void;
+  setRoomImageStanza(
+    roomJid: string,
+    roomThumbnail: string,
+    type: string,
+    roomBackground?: string
+  ): void;
+  getRoomInfoStanza(roomJID: string): void;
+  getRoomMembersStanza(roomJID: string): void;
+  setVCardStanza?(xmppUsername: string): void;
+  createPrivateRoomStanza?(
+    title: string,
+    description: string,
+    to: string
+  ): Promise<string>;
+
+  // ---- messages ----
+  sendMessage(
+    roomJID: string,
+    firstName: string,
+    lastName: string,
+    photo: string,
+    walletAddress: string,
+    userMessage: string,
+    notDisplayedValue?: string,
+    isReply?: boolean,
+    showInChannel?: boolean,
+    mainMessage?: string,
+    customId?: string
+  ): void;
+  deleteMessageStanza(room: string, msgId: string): void;
+  editMessageStanza(room: string, msgId: string, text: string): void;
+  sendTypingRequestStanza(
+    chatId: string,
+    fullName: string,
+    start: boolean
+  ): void;
+  getChatsPrivateStoreRequestStanza(): Promise<any>;
+  actionSetTimestampToPrivateStoreStanza(
+    chatId: string,
+    timestamp: number,
+    chats?: string[]
+  ): Promise<void>;
+  sendMediaMessageStanza(roomJID: string, data: any, id?: string): void;
+  sendMessageReactionStanza?(
+    messageId: string,
+    roomJid: string,
+    reactionsList: string[],
+    reactionSymbol?: string
+  ): void;
+  sendTextMessageWithTranslateTagStanza?(
+    roomJID: string,
+    firstName: string,
+    lastName: string,
+    photo: string,
+    walletAddress: string,
+    userMessage: string,
+    notDisplayedValue?: string,
+    isReply?: boolean,
+    showInChannel?: boolean,
+    mainMessage?: string,
+    langSource?: Iso639_1Codes
+  ): void;
+}