@ermis-network/ermis-chat-sdk 1.0.5 → 1.0.7

package/dist/index.d.mts

@@ -222,6 +222,7 @@ type ChannelResponse<ErmisChatGenerics extends ExtendableGenerics = DefaultGener
     member_capabilities?: string[];
     is_pinned?: boolean;
     topics_enabled?: boolean;
+    parent_cid?: string;
     is_closed_topic?: boolean;
 };
 type QueryChannelsAPIResponse<ErmisChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
@@ -401,6 +402,7 @@ type Event$1<ErmisChatGenerics extends ExtendableGenerics = DefaultGenerics> = E
     message?: MessageResponse<ErmisChatGenerics>;
     online?: boolean;
     parent_id?: string;
+    parent_cid?: string;
     reaction?: ReactionResponse<ErmisChatGenerics>;
     received_at?: string | Date;
     unread_messages?: number;
@@ -428,6 +430,16 @@ type ChannelFilters = {
     parent_id?: string;
     include_parent?: boolean;
 };
+type CreateTopicData = {
+    name: string;
+    image?: string;
+    [key: string]: any;
+};
+type EditTopicData = {
+    name?: string;
+    image?: string;
+    description?: string;
+};
 type ChannelSort = {
     field: string;
     direction: -1 | 1;
@@ -863,6 +875,8 @@ declare class Channel<ErmisChatGenerics extends ExtendableGenerics = DefaultGene
     }): Promise<SendMessageAPIResponse<ErmisChatGenerics>>;
     pinMessage(messageID: string): Promise<unknown>;
     unpinMessage(messageID: string): Promise<unknown>;
+    pin(): Promise<APIResponse>;
+    unpin(): Promise<APIResponse>;
     editMessage(oldMessageID: string, message: EditMessage): Promise<unknown>;
     sendFile(uri: string | NodeJS.ReadableStream | Buffer | File, name?: string, contentType?: string, user?: UserResponse<ErmisChatGenerics>): Promise<SendFileAPIResponse>;
     /**
@@ -961,7 +975,7 @@ declare class Channel<ErmisChatGenerics extends ExtendableGenerics = DefaultGene
     }[];
     getCapabilitiesMember(): unknown;
     create: () => Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
-    createTopic(data: any): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
+    createTopic(data: CreateTopicData): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
     query(options: ChannelQueryOptions, messageSetToAddToIfDoesNotExist?: MessageSetType): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
     createDirectChannel(messageSetToAddToIfDoesNotExist?: MessageSetType): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
     queryMessagesLessThanId(message_id: string, limit?: number): Promise<MessageResponse<ErmisChatGenerics>[]>;
@@ -978,7 +992,7 @@ declare class Channel<ErmisChatGenerics extends ExtendableGenerics = DefaultGene
     disableTopics(): Promise<unknown>;
     closeTopic(topicCID: string): Promise<unknown>;
     reopenTopic(topicCID: string): Promise<unknown>;
-    editTopic(topicCID: string, data: any): Promise<any>;
+    editTopic(topicCID: string, data: EditTopicData): Promise<any>;
     on(eventType: EventTypes, callback: EventHandler<ErmisChatGenerics>): {
         unsubscribe: () => void;
     };
@@ -1132,8 +1146,8 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
      * @param extenal_auth        - Set to `true` to use your custom backend external authentication flow.
      * @returns                     A promise resolving to the API connection response once authenticated.
      */
-    connectUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null, extenal_auth?: boolean) => Promise<void | ConnectionOpen<ErmisChatGenerics>>;
-    setUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null, extenal_auth?: boolean) => Promise<void | ConnectionOpen<ErmisChatGenerics>>;
+    connectUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null, external_auth?: boolean) => Promise<void | ConnectionOpen<ErmisChatGenerics>>;
+    setUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null, external_auth?: boolean) => Promise<void | ConnectionOpen<ErmisChatGenerics>>;
     _setToken: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null) => Promise<void>;
     _setUser(user: UserResponse<ErmisChatGenerics>): void;
     closeConnection: (timeout?: number) => Promise<void>;
@@ -1218,10 +1232,17 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
     searchUsers(page: number, page_size: number, name?: string): Promise<UsersResponse>;
     queryContacts(): Promise<ContactResult>;
     _updateProjectID(project_id: string): void;
-    uploadFile(file: File): Promise<{
+    /**
+     * Uploads a new avatar image for the current user.
+     * The user's avatar URL is automatically updated in both the client and the local state.
+     *
+     * @param file - The image file to upload.
+     * @returns The response containing the new avatar URL.
+     */
+    uploadAvatar(file: File): Promise<{
         avatar: string;
     }>;
-    updateProfile(name: string, about_me: string): Promise<UserResponse<ErmisChatGenerics>>;
+    updateProfile(updates: Partial<UserResponse<ErmisChatGenerics>>): Promise<UserResponse<ErmisChatGenerics>>;
     /**
      * Queries the API for a list of channels based on provided search filters and sort conditions.
      * Also hydrates these channels into the local SDK state memory.
@@ -1262,6 +1283,24 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
     channel(type: string, id: string, custom?: ChannelData<ErmisChatGenerics>): Channel<ErmisChatGenerics>;
     getChannelById: (channelType: string, channelID: string | undefined, custom: ChannelData<ErmisChatGenerics>) => Channel<ErmisChatGenerics>;
     getChannel: (channelType: string, custom: ChannelData<ErmisChatGenerics>) => Channel<ErmisChatGenerics>;
+    /**
+     * Creates a quick channel and immediately registers it on the server.
+     * Quick channels are public group channels that anyone can join without an invitation.
+     * The creator is added as the first member automatically.
+     *
+     * @param name - An optional display name for the channel.
+     * @returns A promise that resolves to the created `Channel` object.
+     */
+    createQuickChannel(name?: string): Promise<Channel<ErmisChatGenerics>>;
+    /**
+     * Joins a quick channel by its ID.
+     * Automatically checks whether the caller is already a member.
+     * If not, it joins the channel and synchronizes state.
+     *
+     * @param channelId - The ID of the quick channel to join.
+     * @returns A promise that resolves to the joined `Channel` object.
+     */
+    joinQuickChannel(channelId: string): Promise<Channel<ErmisChatGenerics>>;
     _normalizeExpiration(timeoutOrExpirationDate?: null | number | string | Date): string | null;
     getUserAgent(): string;
     setUserAgent(userAgent: string): void;
@@ -1659,4 +1698,4 @@ interface SignalMessageResult {
  */
 declare function parseSignalMessage(value: string, myUserId: string): SignalMessageResult | null;
 
-export { type APIErrorResponse, type APIResponse, type AscDesc, type Attachment, type AttachmentResponse, type AudioConfig, CallAction, type CallEventData, type CallEventType, CallStatus, CallType, type CallTypeValue, Channel, type ChannelAPIResponse, type ChannelData, type ChannelFilters, type ChannelMemberResponse, type ChannelMembership, type ChannelQueryOptions, type ChannelResponse, type ChannelSort, ChannelState, type ChannelStateOptions, ClientState, type ConnectAPIResponse, type ConnectionOpen, type Contact, type ContactResponse, type ContactResult, type DefaultGenerics, EVENT_MAP, type EditMessage, ErmisAuthProvider, ErmisCallNode, ErmisChat, type ErmisChatOptions, ErrorFromResponse, type Event$1 as Event, type EventHandler, type EventTypes, type ExtendableGenerics, FRAME_TYPE, type FormatMessageResponse, type ForwardMessage, type IMediaReceiverEvents, type INodeCall, type LiteralStringForUnion, type LogLevel, type Logger, type Message, type MessageBase, type MessageLabel, type MessageResponse, type MessageResponseBase, type MessageSetType, type Metadata, type PollMessage, type QueryChannelAPIResponse, type QueryChannelsAPIResponse, type Reaction, type ReactionAPIResponse, type ReactionResponse, type ReadResponse, type Role, type SendFileAPIResponse, type SendMessageAPIResponse, type SignalData, type SignalMessageResult, StableWSConnection, TokenManager, type TransceiverState, type UR, type UpdateChannelAPIResponse, type UserCallInfo, type UserResponse, type UsersResponse, type VideoConfig, type VoiceRecordingMeta, buildAttachmentPayload, chatCodes, createForwardMessagePayload, formatMessage, getAttachmentCategory, isHeicFile, isVideoFile, logChatPromiseExecution, normalizeFileName, parseSignalMessage, parseSystemMessage };
+export { type APIErrorResponse, type APIResponse, type AscDesc, type Attachment, type AttachmentResponse, type AudioConfig, CallAction, type CallEventData, type CallEventType, CallStatus, CallType, type CallTypeValue, Channel, type ChannelAPIResponse, type ChannelData, type ChannelFilters, type ChannelMemberResponse, type ChannelMembership, type ChannelQueryOptions, type ChannelResponse, type ChannelSort, ChannelState, type ChannelStateOptions, ClientState, type ConnectAPIResponse, type ConnectionOpen, type Contact, type ContactResponse, type ContactResult, type CreateTopicData, type DefaultGenerics, EVENT_MAP, type EditMessage, type EditTopicData, ErmisAuthProvider, ErmisCallNode, ErmisChat, type ErmisChatOptions, ErrorFromResponse, type Event$1 as Event, type EventHandler, type EventTypes, type ExtendableGenerics, FRAME_TYPE, type FormatMessageResponse, type ForwardMessage, type IMediaReceiverEvents, type INodeCall, type LiteralStringForUnion, type LogLevel, type Logger, type Message, type MessageBase, type MessageLabel, type MessageResponse, type MessageResponseBase, type MessageSetType, type Metadata, type PollMessage, type QueryChannelAPIResponse, type QueryChannelsAPIResponse, type Reaction, type ReactionAPIResponse, type ReactionResponse, type ReadResponse, type Role, type SendFileAPIResponse, type SendMessageAPIResponse, type SignalData, type SignalMessageResult, StableWSConnection, TokenManager, type TransceiverState, type UR, type UpdateChannelAPIResponse, type UserCallInfo, type UserResponse, type UsersResponse, type VideoConfig, type VoiceRecordingMeta, buildAttachmentPayload, chatCodes, createForwardMessagePayload, formatMessage, getAttachmentCategory, isHeicFile, isVideoFile, logChatPromiseExecution, normalizeFileName, parseSignalMessage, parseSystemMessage };

package/dist/index.d.ts

@@ -222,6 +222,7 @@ type ChannelResponse<ErmisChatGenerics extends ExtendableGenerics = DefaultGener
     member_capabilities?: string[];
     is_pinned?: boolean;
     topics_enabled?: boolean;
+    parent_cid?: string;
     is_closed_topic?: boolean;
 };
 type QueryChannelsAPIResponse<ErmisChatGenerics extends ExtendableGenerics = DefaultGenerics> = APIResponse & {
@@ -401,6 +402,7 @@ type Event$1<ErmisChatGenerics extends ExtendableGenerics = DefaultGenerics> = E
     message?: MessageResponse<ErmisChatGenerics>;
     online?: boolean;
     parent_id?: string;
+    parent_cid?: string;
     reaction?: ReactionResponse<ErmisChatGenerics>;
     received_at?: string | Date;
     unread_messages?: number;
@@ -428,6 +430,16 @@ type ChannelFilters = {
     parent_id?: string;
     include_parent?: boolean;
 };
+type CreateTopicData = {
+    name: string;
+    image?: string;
+    [key: string]: any;
+};
+type EditTopicData = {
+    name?: string;
+    image?: string;
+    description?: string;
+};
 type ChannelSort = {
     field: string;
     direction: -1 | 1;
@@ -863,6 +875,8 @@ declare class Channel<ErmisChatGenerics extends ExtendableGenerics = DefaultGene
     }): Promise<SendMessageAPIResponse<ErmisChatGenerics>>;
     pinMessage(messageID: string): Promise<unknown>;
     unpinMessage(messageID: string): Promise<unknown>;
+    pin(): Promise<APIResponse>;
+    unpin(): Promise<APIResponse>;
     editMessage(oldMessageID: string, message: EditMessage): Promise<unknown>;
     sendFile(uri: string | NodeJS.ReadableStream | Buffer | File, name?: string, contentType?: string, user?: UserResponse<ErmisChatGenerics>): Promise<SendFileAPIResponse>;
     /**
@@ -961,7 +975,7 @@ declare class Channel<ErmisChatGenerics extends ExtendableGenerics = DefaultGene
     }[];
     getCapabilitiesMember(): unknown;
     create: () => Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
-    createTopic(data: any): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
+    createTopic(data: CreateTopicData): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
     query(options: ChannelQueryOptions, messageSetToAddToIfDoesNotExist?: MessageSetType): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
     createDirectChannel(messageSetToAddToIfDoesNotExist?: MessageSetType): Promise<QueryChannelAPIResponse<ErmisChatGenerics>>;
     queryMessagesLessThanId(message_id: string, limit?: number): Promise<MessageResponse<ErmisChatGenerics>[]>;
@@ -978,7 +992,7 @@ declare class Channel<ErmisChatGenerics extends ExtendableGenerics = DefaultGene
     disableTopics(): Promise<unknown>;
     closeTopic(topicCID: string): Promise<unknown>;
     reopenTopic(topicCID: string): Promise<unknown>;
-    editTopic(topicCID: string, data: any): Promise<any>;
+    editTopic(topicCID: string, data: EditTopicData): Promise<any>;
     on(eventType: EventTypes, callback: EventHandler<ErmisChatGenerics>): {
         unsubscribe: () => void;
     };
@@ -1132,8 +1146,8 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
      * @param extenal_auth        - Set to `true` to use your custom backend external authentication flow.
      * @returns                     A promise resolving to the API connection response once authenticated.
      */
-    connectUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null, extenal_auth?: boolean) => Promise<void | ConnectionOpen<ErmisChatGenerics>>;
-    setUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null, extenal_auth?: boolean) => Promise<void | ConnectionOpen<ErmisChatGenerics>>;
+    connectUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null, external_auth?: boolean) => Promise<void | ConnectionOpen<ErmisChatGenerics>>;
+    setUser: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null, external_auth?: boolean) => Promise<void | ConnectionOpen<ErmisChatGenerics>>;
     _setToken: (user: UserResponse<ErmisChatGenerics>, userTokenOrProvider: string | null) => Promise<void>;
     _setUser(user: UserResponse<ErmisChatGenerics>): void;
     closeConnection: (timeout?: number) => Promise<void>;
@@ -1218,10 +1232,17 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
     searchUsers(page: number, page_size: number, name?: string): Promise<UsersResponse>;
     queryContacts(): Promise<ContactResult>;
     _updateProjectID(project_id: string): void;
-    uploadFile(file: File): Promise<{
+    /**
+     * Uploads a new avatar image for the current user.
+     * The user's avatar URL is automatically updated in both the client and the local state.
+     *
+     * @param file - The image file to upload.
+     * @returns The response containing the new avatar URL.
+     */
+    uploadAvatar(file: File): Promise<{
         avatar: string;
     }>;
-    updateProfile(name: string, about_me: string): Promise<UserResponse<ErmisChatGenerics>>;
+    updateProfile(updates: Partial<UserResponse<ErmisChatGenerics>>): Promise<UserResponse<ErmisChatGenerics>>;
     /**
      * Queries the API for a list of channels based on provided search filters and sort conditions.
      * Also hydrates these channels into the local SDK state memory.
@@ -1262,6 +1283,24 @@ declare class ErmisChat<ErmisChatGenerics extends ExtendableGenerics = DefaultGe
     channel(type: string, id: string, custom?: ChannelData<ErmisChatGenerics>): Channel<ErmisChatGenerics>;
     getChannelById: (channelType: string, channelID: string | undefined, custom: ChannelData<ErmisChatGenerics>) => Channel<ErmisChatGenerics>;
     getChannel: (channelType: string, custom: ChannelData<ErmisChatGenerics>) => Channel<ErmisChatGenerics>;
+    /**
+     * Creates a quick channel and immediately registers it on the server.
+     * Quick channels are public group channels that anyone can join without an invitation.
+     * The creator is added as the first member automatically.
+     *
+     * @param name - An optional display name for the channel.
+     * @returns A promise that resolves to the created `Channel` object.
+     */
+    createQuickChannel(name?: string): Promise<Channel<ErmisChatGenerics>>;
+    /**
+     * Joins a quick channel by its ID.
+     * Automatically checks whether the caller is already a member.
+     * If not, it joins the channel and synchronizes state.
+     *
+     * @param channelId - The ID of the quick channel to join.
+     * @returns A promise that resolves to the joined `Channel` object.
+     */
+    joinQuickChannel(channelId: string): Promise<Channel<ErmisChatGenerics>>;
     _normalizeExpiration(timeoutOrExpirationDate?: null | number | string | Date): string | null;
     getUserAgent(): string;
     setUserAgent(userAgent: string): void;
@@ -1659,4 +1698,4 @@ interface SignalMessageResult {
  */
 declare function parseSignalMessage(value: string, myUserId: string): SignalMessageResult | null;
 
-export { type APIErrorResponse, type APIResponse, type AscDesc, type Attachment, type AttachmentResponse, type AudioConfig, CallAction, type CallEventData, type CallEventType, CallStatus, CallType, type CallTypeValue, Channel, type ChannelAPIResponse, type ChannelData, type ChannelFilters, type ChannelMemberResponse, type ChannelMembership, type ChannelQueryOptions, type ChannelResponse, type ChannelSort, ChannelState, type ChannelStateOptions, ClientState, type ConnectAPIResponse, type ConnectionOpen, type Contact, type ContactResponse, type ContactResult, type DefaultGenerics, EVENT_MAP, type EditMessage, ErmisAuthProvider, ErmisCallNode, ErmisChat, type ErmisChatOptions, ErrorFromResponse, type Event$1 as Event, type EventHandler, type EventTypes, type ExtendableGenerics, FRAME_TYPE, type FormatMessageResponse, type ForwardMessage, type IMediaReceiverEvents, type INodeCall, type LiteralStringForUnion, type LogLevel, type Logger, type Message, type MessageBase, type MessageLabel, type MessageResponse, type MessageResponseBase, type MessageSetType, type Metadata, type PollMessage, type QueryChannelAPIResponse, type QueryChannelsAPIResponse, type Reaction, type ReactionAPIResponse, type ReactionResponse, type ReadResponse, type Role, type SendFileAPIResponse, type SendMessageAPIResponse, type SignalData, type SignalMessageResult, StableWSConnection, TokenManager, type TransceiverState, type UR, type UpdateChannelAPIResponse, type UserCallInfo, type UserResponse, type UsersResponse, type VideoConfig, type VoiceRecordingMeta, buildAttachmentPayload, chatCodes, createForwardMessagePayload, formatMessage, getAttachmentCategory, isHeicFile, isVideoFile, logChatPromiseExecution, normalizeFileName, parseSignalMessage, parseSystemMessage };
+export { type APIErrorResponse, type APIResponse, type AscDesc, type Attachment, type AttachmentResponse, type AudioConfig, CallAction, type CallEventData, type CallEventType, CallStatus, CallType, type CallTypeValue, Channel, type ChannelAPIResponse, type ChannelData, type ChannelFilters, type ChannelMemberResponse, type ChannelMembership, type ChannelQueryOptions, type ChannelResponse, type ChannelSort, ChannelState, type ChannelStateOptions, ClientState, type ConnectAPIResponse, type ConnectionOpen, type Contact, type ContactResponse, type ContactResult, type CreateTopicData, type DefaultGenerics, EVENT_MAP, type EditMessage, type EditTopicData, ErmisAuthProvider, ErmisCallNode, ErmisChat, type ErmisChatOptions, ErrorFromResponse, type Event$1 as Event, type EventHandler, type EventTypes, type ExtendableGenerics, FRAME_TYPE, type FormatMessageResponse, type ForwardMessage, type IMediaReceiverEvents, type INodeCall, type LiteralStringForUnion, type LogLevel, type Logger, type Message, type MessageBase, type MessageLabel, type MessageResponse, type MessageResponseBase, type MessageSetType, type Metadata, type PollMessage, type QueryChannelAPIResponse, type QueryChannelsAPIResponse, type Reaction, type ReactionAPIResponse, type ReactionResponse, type ReadResponse, type Role, type SendFileAPIResponse, type SendMessageAPIResponse, type SignalData, type SignalMessageResult, StableWSConnection, TokenManager, type TransceiverState, type UR, type UpdateChannelAPIResponse, type UserCallInfo, type UserResponse, type UsersResponse, type VideoConfig, type VoiceRecordingMeta, buildAttachmentPayload, chatCodes, createForwardMessagePayload, formatMessage, getAttachmentCategory, isHeicFile, isVideoFile, logChatPromiseExecution, normalizeFileName, parseSignalMessage, parseSystemMessage };