@realtimexsco/live-chat 1.3.0 → 1.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -1628
- package/dist/index.cjs +311 -146
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.mts +78 -10
- package/dist/index.d.ts +78 -10
- package/dist/index.mjs +311 -147
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -87,6 +87,58 @@ interface IAttachment {
|
|
|
87
87
|
uploaded?: ISocketMessageAttachment;
|
|
88
88
|
}
|
|
89
89
|
|
|
90
|
+
/**
|
|
91
|
+
* Named API targets for selective query-param injection.
|
|
92
|
+
* Consumers pick which endpoints receive `queryParams`.
|
|
93
|
+
*/
|
|
94
|
+
declare const CHAT_GET_API_KEYS: readonly ["users", "conversations", "conversationInfo", "messages", "pinnedMessages", "starredMessages", "searchMessages", "searchMessagesContext"];
|
|
95
|
+
declare const CHAT_API_KEYS: readonly ["all", "get", "login", "users", "conversations", "conversationInfo", "messages", "pinnedMessages", "starredMessages", "searchMessages", "searchMessagesContext", "createGroup", "updateGroupPermissions", "updateGroupInfo", "manageMembers", "manageAdmins", "blockUnblock", "presignedUrls"];
|
|
96
|
+
type ChatApiKey = (typeof CHAT_API_KEYS)[number];
|
|
97
|
+
type ChatGetApiKey = (typeof CHAT_GET_API_KEYS)[number];
|
|
98
|
+
type ChatQueryParamValue = string | number | boolean;
|
|
99
|
+
type ChatQueryParams = Record<string, ChatQueryParamValue>;
|
|
100
|
+
type ChatQueryParamsByApi = Partial<Record<Exclude<ChatApiKey, "all" | "get">, ChatQueryParams>>;
|
|
101
|
+
/** Match an axios request URL to a named API key (first match wins). */
|
|
102
|
+
declare function resolveChatApiKey(url?: string): Exclude<ChatApiKey, "all" | "get"> | null;
|
|
103
|
+
|
|
104
|
+
declare const setChatClientId: (id: string) => void;
|
|
105
|
+
declare const setChatAccessToken: (token: string) => void;
|
|
106
|
+
declare const setChatBaseURL: (url: string) => void;
|
|
107
|
+
declare const getChatBaseUrl: () => string;
|
|
108
|
+
declare const setChatSocketUrl: (url: string) => void;
|
|
109
|
+
declare const getChatSocketUrl: () => string;
|
|
110
|
+
declare const setChatQueryParams: (params?: ChatQueryParams | null) => void;
|
|
111
|
+
declare const getChatQueryParams: () => {
|
|
112
|
+
[x: string]: string;
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* Which APIs receive shared `queryParams`.
|
|
116
|
+
* Default `['get']` = every GET endpoint.
|
|
117
|
+
* Use `['all']` for every method, or specific keys like `['conversations']`.
|
|
118
|
+
*/
|
|
119
|
+
declare const setChatQueryParamApis: (apis?: ChatApiKey[] | null) => void;
|
|
120
|
+
declare const getChatQueryParamApis: () => ("all" | "get" | "login" | "users" | "conversations" | "conversationInfo" | "messages" | "pinnedMessages" | "starredMessages" | "searchMessages" | "searchMessagesContext" | "createGroup" | "updateGroupPermissions" | "updateGroupInfo" | "manageMembers" | "manageAdmins" | "blockUnblock" | "presignedUrls")[];
|
|
121
|
+
/** Per-API query params (override / extend shared params for that endpoint). */
|
|
122
|
+
declare const setChatQueryParamsByApi: (byApi?: ChatQueryParamsByApi | null) => void;
|
|
123
|
+
declare const getChatQueryParamsByApi: () => {
|
|
124
|
+
login?: Record<string, string> | undefined;
|
|
125
|
+
users?: Record<string, string> | undefined;
|
|
126
|
+
conversations?: Record<string, string> | undefined;
|
|
127
|
+
conversationInfo?: Record<string, string> | undefined;
|
|
128
|
+
messages?: Record<string, string> | undefined;
|
|
129
|
+
pinnedMessages?: Record<string, string> | undefined;
|
|
130
|
+
starredMessages?: Record<string, string> | undefined;
|
|
131
|
+
searchMessages?: Record<string, string> | undefined;
|
|
132
|
+
searchMessagesContext?: Record<string, string> | undefined;
|
|
133
|
+
createGroup?: Record<string, string> | undefined;
|
|
134
|
+
updateGroupPermissions?: Record<string, string> | undefined;
|
|
135
|
+
updateGroupInfo?: Record<string, string> | undefined;
|
|
136
|
+
manageMembers?: Record<string, string> | undefined;
|
|
137
|
+
manageAdmins?: Record<string, string> | undefined;
|
|
138
|
+
blockUnblock?: Record<string, string> | undefined;
|
|
139
|
+
presignedUrls?: Record<string, string> | undefined;
|
|
140
|
+
};
|
|
141
|
+
|
|
90
142
|
interface ChatForwardItem {
|
|
91
143
|
message: IMessage;
|
|
92
144
|
attachmentId?: string;
|
|
@@ -810,13 +862,22 @@ interface ChatProps {
|
|
|
810
862
|
loggedUserDetails?: any;
|
|
811
863
|
apiUrl: string;
|
|
812
864
|
socketUrl?: string;
|
|
865
|
+
/** Shared query params for selected APIs (see `queryParamApis`) */
|
|
866
|
+
queryParams?: ChatQueryParams;
|
|
867
|
+
/**
|
|
868
|
+
* Which APIs receive `queryParams`.
|
|
869
|
+
* Default: `['get']` (all GET endpoints).
|
|
870
|
+
*/
|
|
871
|
+
queryParamApis?: ChatApiKey[];
|
|
872
|
+
/** Different query params per API key */
|
|
873
|
+
queryParamsByApi?: ChatQueryParamsByApi;
|
|
813
874
|
channelsData?: IChannel[];
|
|
814
875
|
messagesData?: Record<string, IMessage[]>;
|
|
815
876
|
onMessageReceived?: (message: any) => void;
|
|
816
877
|
onSocketConnected?: (socketId: string) => void;
|
|
817
878
|
onSocketError?: (error: string) => void;
|
|
818
879
|
}
|
|
819
|
-
declare const Chat: ({ children, onSendMessage, client, theme, uiConfig, themeColor, accessToken, loggedUserDetails, apiUrl, socketUrl, channelsData, messagesData, onMessageReceived, onSocketConnected, onSocketError }: ChatProps) => React__default.JSX.Element;
|
|
880
|
+
declare const Chat: ({ children, onSendMessage, client, theme, uiConfig, themeColor, accessToken, loggedUserDetails, apiUrl, socketUrl, queryParams, queryParamApis, queryParamsByApi, channelsData, messagesData, onMessageReceived, onSocketConnected, onSocketError }: ChatProps) => React__default.JSX.Element;
|
|
820
881
|
|
|
821
882
|
type ChatColorMode = 'light' | 'dark';
|
|
822
883
|
|
|
@@ -887,6 +948,20 @@ interface ChatMainProps {
|
|
|
887
948
|
accessToken: string;
|
|
888
949
|
apiUrl: string;
|
|
889
950
|
socketUrl?: string;
|
|
951
|
+
/** Shared query params for selected APIs (see `queryParamApis`) */
|
|
952
|
+
queryParams?: ChatQueryParams;
|
|
953
|
+
/**
|
|
954
|
+
* Which APIs receive `queryParams`.
|
|
955
|
+
* Default: `['get']` (all GET endpoints).
|
|
956
|
+
* Examples: `['conversations']`, `['get']`, `['all']`.
|
|
957
|
+
*/
|
|
958
|
+
queryParamApis?: ChatApiKey[];
|
|
959
|
+
/**
|
|
960
|
+
* Different query params per API.
|
|
961
|
+
* GET keys: users, conversations, conversationInfo, messages,
|
|
962
|
+
* pinnedMessages, starredMessages, searchMessages, searchMessagesContext
|
|
963
|
+
*/
|
|
964
|
+
queryParamsByApi?: ChatQueryParamsByApi;
|
|
890
965
|
themeColor?: string;
|
|
891
966
|
theme?: string;
|
|
892
967
|
uiConfig?: UIConfig;
|
|
@@ -918,7 +993,7 @@ interface ChatMainProps {
|
|
|
918
993
|
/** Extra classes on the viewport wrapper */
|
|
919
994
|
viewportClassName?: string;
|
|
920
995
|
}
|
|
921
|
-
declare const ChatMain: ({ clientId, loggedUserDetails, accessToken, apiUrl, socketUrl, themeColor, theme, uiConfig, components, classNames, features, layout, colorMode, defaultColorMode, onColorModeChange, showColorModeToggle, locale, timeZone, hour12, defaultLocale, defaultTimeZone, defaultHour12, onDateTimePreferencesChange, showDateTimeSettings, error, info, onErrorDismiss, onInfoDismiss, viewportHeight, viewportClassName, }: ChatMainProps) => React__default.JSX.Element;
|
|
996
|
+
declare const ChatMain: ({ clientId, loggedUserDetails, accessToken, apiUrl, socketUrl, queryParams, queryParamApis, queryParamsByApi, themeColor, theme, uiConfig, components, classNames, features, layout, colorMode, defaultColorMode, onColorModeChange, showColorModeToggle, locale, timeZone, hour12, defaultLocale, defaultTimeZone, defaultHour12, onDateTimePreferencesChange, showDateTimeSettings, error, info, onErrorDismiss, onInfoDismiss, viewportHeight, viewportClassName, }: ChatMainProps) => React__default.JSX.Element;
|
|
922
997
|
|
|
923
998
|
declare const useStore: zustand.UseBoundStore<Omit<zustand.StoreApi<AppStoreState>, "setState" | "persist"> & {
|
|
924
999
|
setState(partial: AppStoreState | Partial<AppStoreState> | ((state: AppStoreState) => AppStoreState | Partial<AppStoreState>), replace?: false | undefined): unknown;
|
|
@@ -1221,13 +1296,6 @@ declare const useChatController: () => {
|
|
|
1221
1296
|
setActiveChannel: (channel: IChannel | null) => void;
|
|
1222
1297
|
};
|
|
1223
1298
|
|
|
1224
|
-
declare const setChatClientId: (id: string) => void;
|
|
1225
|
-
declare const setChatAccessToken: (token: string) => void;
|
|
1226
|
-
declare const setChatBaseURL: (url: string) => void;
|
|
1227
|
-
declare const getChatBaseUrl: () => string;
|
|
1228
|
-
declare const setChatSocketUrl: (url: string) => void;
|
|
1229
|
-
declare const getChatSocketUrl: () => string;
|
|
1230
|
-
|
|
1231
1299
|
/** Normalize API base URL passed by the host app (must end with /api/v1). */
|
|
1232
1300
|
declare function resolveApiUrl(apiUrl?: string): string;
|
|
1233
1301
|
/**
|
|
@@ -1412,4 +1480,4 @@ declare function ChatAlertsProvider({ children, value, }: {
|
|
|
1412
1480
|
}): React.JSX.Element;
|
|
1413
1481
|
declare function useChatAlerts(): ChatAlertsContextValue;
|
|
1414
1482
|
|
|
1415
|
-
export { type ActiveChannelMessagesSlotProps, type AdminsDrawerSlotProps, type AttachmentsDrawerSlotProps, type AvatarSlotProps, Channel, type ChannelDetailsDrawerSlotProps, ChannelHeaderView as ChannelHeader, type ChannelHeaderSlotProps, ChannelListView as ChannelList, ChannelListItem, type ChannelListItemSlotProps, type ChannelListSlotProps, type ChannelMessageBoxSlotProps, Chat, type ChatActionModalSlotProps, ChatAlertsProvider, ChatAvatar, type ChatCallContext, type ChatClassNames, type ChatColorMode, type ChatComponents, type ChatCustomizationConfig, ChatCustomizationProvider, type ChatDateTimePreferences, type ChatFeatures, ChatLayout, type ChatLayoutConfig, type ChatLayoutSlotProps, ChatLocaleProvider, ChatMain, type ChatPanelAlertsSlotProps, ChatThemeProvider, ChatViewport, type ChatViewportHeight, DefaultChannelListItem, DefaultChatAvatar, DefaultChatLayout, ForwardModalView as ForwardModal, type ForwardModalSlotProps, HeaderCallActions, type HeaderCallActionsSlotProps, type HeaderLeftSideSlotProps, type HeaderRightSideSlotProps, type HeaderSearchOverlaySlotProps, type IAttachment, type IChannel, type IDMDelete, type IDMEditMessage, type IDMForward, type IDMMessage, type IDMPin, type IDMReaction, type IDMRead, type IDMStar, type IDMTyping, type IDMUnstar, type IMessage, type ISocketConfig, LoggedUserDetails, type LoggedUserDetailsSlotProps, type MembersDrawerSlotProps, type MessageAttachmentsSlotProps, ChannelMessageBoxView as MessageInput, MessageItemView as MessageItem, type MessageItemSlotProps, ActiveChannelMessagesView as MessageList, type MessageReactionsSlotProps, type MessageReplySnippetSlotProps, type MessageStatusSlotProps, type MessageToolbarSlotProps, type PermissionDrawerSlotProps, type PhoneCallButtonSlotProps, type PinnedMessagesDrawerSlotProps, type StarredMessagesDrawerSlotProps, type UIConfig, type VideoCallButtonSlotProps, capitalizeFirst, ChatMain as default, defaultChatClassNames, defaultChatComponents, defaultChatFeatures, defaultChatLayoutConfig, downloadFile, getChatBaseUrl, getChatSocketUrl, getFirstAndLastNameOneCharacter, getResponsiveWidth, getSocketConfig, isEmpty, mergeChatCustomization, mergeChatLayoutConfig, packageDefaultComponents, resolveApiUrl, resolveSocketUrl, setChatAccessToken, setChatBaseURL, setChatClientId, setChatSocketUrl, showNotification, socketService, uniqueList, useChatAlerts, useChatContext, useChatController, useChatCustomization, useChatCustomizationOptional, useChatFeatures, useChatFeaturesOptional, useChatLocale, useStore as useChatStore, useChatTheme };
|
|
1483
|
+
export { type ActiveChannelMessagesSlotProps, type AdminsDrawerSlotProps, type AttachmentsDrawerSlotProps, type AvatarSlotProps, CHAT_API_KEYS, CHAT_GET_API_KEYS, Channel, type ChannelDetailsDrawerSlotProps, ChannelHeaderView as ChannelHeader, type ChannelHeaderSlotProps, ChannelListView as ChannelList, ChannelListItem, type ChannelListItemSlotProps, type ChannelListSlotProps, type ChannelMessageBoxSlotProps, Chat, type ChatActionModalSlotProps, ChatAlertsProvider, type ChatApiKey, ChatAvatar, type ChatCallContext, type ChatClassNames, type ChatColorMode, type ChatComponents, type ChatCustomizationConfig, ChatCustomizationProvider, type ChatDateTimePreferences, type ChatFeatures, type ChatGetApiKey, ChatLayout, type ChatLayoutConfig, type ChatLayoutSlotProps, ChatLocaleProvider, ChatMain, type ChatPanelAlertsSlotProps, type ChatQueryParams, type ChatQueryParamsByApi, ChatThemeProvider, ChatViewport, type ChatViewportHeight, DefaultChannelListItem, DefaultChatAvatar, DefaultChatLayout, ForwardModalView as ForwardModal, type ForwardModalSlotProps, HeaderCallActions, type HeaderCallActionsSlotProps, type HeaderLeftSideSlotProps, type HeaderRightSideSlotProps, type HeaderSearchOverlaySlotProps, type IAttachment, type IChannel, type IDMDelete, type IDMEditMessage, type IDMForward, type IDMMessage, type IDMPin, type IDMReaction, type IDMRead, type IDMStar, type IDMTyping, type IDMUnstar, type IMessage, type ISocketConfig, LoggedUserDetails, type LoggedUserDetailsSlotProps, type MembersDrawerSlotProps, type MessageAttachmentsSlotProps, ChannelMessageBoxView as MessageInput, MessageItemView as MessageItem, type MessageItemSlotProps, ActiveChannelMessagesView as MessageList, type MessageReactionsSlotProps, type MessageReplySnippetSlotProps, type MessageStatusSlotProps, type MessageToolbarSlotProps, type PermissionDrawerSlotProps, type PhoneCallButtonSlotProps, type PinnedMessagesDrawerSlotProps, type StarredMessagesDrawerSlotProps, type UIConfig, type VideoCallButtonSlotProps, capitalizeFirst, ChatMain as default, defaultChatClassNames, defaultChatComponents, defaultChatFeatures, defaultChatLayoutConfig, downloadFile, getChatBaseUrl, getChatQueryParamApis, getChatQueryParams, getChatQueryParamsByApi, getChatSocketUrl, getFirstAndLastNameOneCharacter, getResponsiveWidth, getSocketConfig, isEmpty, mergeChatCustomization, mergeChatLayoutConfig, packageDefaultComponents, resolveApiUrl, resolveChatApiKey, resolveSocketUrl, setChatAccessToken, setChatBaseURL, setChatClientId, setChatQueryParamApis, setChatQueryParams, setChatQueryParamsByApi, setChatSocketUrl, showNotification, socketService, uniqueList, useChatAlerts, useChatContext, useChatController, useChatCustomization, useChatCustomizationOptional, useChatFeatures, useChatFeaturesOptional, useChatLocale, useStore as useChatStore, useChatTheme };
|
package/dist/index.d.ts
CHANGED
|
@@ -87,6 +87,58 @@ interface IAttachment {
|
|
|
87
87
|
uploaded?: ISocketMessageAttachment;
|
|
88
88
|
}
|
|
89
89
|
|
|
90
|
+
/**
|
|
91
|
+
* Named API targets for selective query-param injection.
|
|
92
|
+
* Consumers pick which endpoints receive `queryParams`.
|
|
93
|
+
*/
|
|
94
|
+
declare const CHAT_GET_API_KEYS: readonly ["users", "conversations", "conversationInfo", "messages", "pinnedMessages", "starredMessages", "searchMessages", "searchMessagesContext"];
|
|
95
|
+
declare const CHAT_API_KEYS: readonly ["all", "get", "login", "users", "conversations", "conversationInfo", "messages", "pinnedMessages", "starredMessages", "searchMessages", "searchMessagesContext", "createGroup", "updateGroupPermissions", "updateGroupInfo", "manageMembers", "manageAdmins", "blockUnblock", "presignedUrls"];
|
|
96
|
+
type ChatApiKey = (typeof CHAT_API_KEYS)[number];
|
|
97
|
+
type ChatGetApiKey = (typeof CHAT_GET_API_KEYS)[number];
|
|
98
|
+
type ChatQueryParamValue = string | number | boolean;
|
|
99
|
+
type ChatQueryParams = Record<string, ChatQueryParamValue>;
|
|
100
|
+
type ChatQueryParamsByApi = Partial<Record<Exclude<ChatApiKey, "all" | "get">, ChatQueryParams>>;
|
|
101
|
+
/** Match an axios request URL to a named API key (first match wins). */
|
|
102
|
+
declare function resolveChatApiKey(url?: string): Exclude<ChatApiKey, "all" | "get"> | null;
|
|
103
|
+
|
|
104
|
+
declare const setChatClientId: (id: string) => void;
|
|
105
|
+
declare const setChatAccessToken: (token: string) => void;
|
|
106
|
+
declare const setChatBaseURL: (url: string) => void;
|
|
107
|
+
declare const getChatBaseUrl: () => string;
|
|
108
|
+
declare const setChatSocketUrl: (url: string) => void;
|
|
109
|
+
declare const getChatSocketUrl: () => string;
|
|
110
|
+
declare const setChatQueryParams: (params?: ChatQueryParams | null) => void;
|
|
111
|
+
declare const getChatQueryParams: () => {
|
|
112
|
+
[x: string]: string;
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* Which APIs receive shared `queryParams`.
|
|
116
|
+
* Default `['get']` = every GET endpoint.
|
|
117
|
+
* Use `['all']` for every method, or specific keys like `['conversations']`.
|
|
118
|
+
*/
|
|
119
|
+
declare const setChatQueryParamApis: (apis?: ChatApiKey[] | null) => void;
|
|
120
|
+
declare const getChatQueryParamApis: () => ("all" | "get" | "login" | "users" | "conversations" | "conversationInfo" | "messages" | "pinnedMessages" | "starredMessages" | "searchMessages" | "searchMessagesContext" | "createGroup" | "updateGroupPermissions" | "updateGroupInfo" | "manageMembers" | "manageAdmins" | "blockUnblock" | "presignedUrls")[];
|
|
121
|
+
/** Per-API query params (override / extend shared params for that endpoint). */
|
|
122
|
+
declare const setChatQueryParamsByApi: (byApi?: ChatQueryParamsByApi | null) => void;
|
|
123
|
+
declare const getChatQueryParamsByApi: () => {
|
|
124
|
+
login?: Record<string, string> | undefined;
|
|
125
|
+
users?: Record<string, string> | undefined;
|
|
126
|
+
conversations?: Record<string, string> | undefined;
|
|
127
|
+
conversationInfo?: Record<string, string> | undefined;
|
|
128
|
+
messages?: Record<string, string> | undefined;
|
|
129
|
+
pinnedMessages?: Record<string, string> | undefined;
|
|
130
|
+
starredMessages?: Record<string, string> | undefined;
|
|
131
|
+
searchMessages?: Record<string, string> | undefined;
|
|
132
|
+
searchMessagesContext?: Record<string, string> | undefined;
|
|
133
|
+
createGroup?: Record<string, string> | undefined;
|
|
134
|
+
updateGroupPermissions?: Record<string, string> | undefined;
|
|
135
|
+
updateGroupInfo?: Record<string, string> | undefined;
|
|
136
|
+
manageMembers?: Record<string, string> | undefined;
|
|
137
|
+
manageAdmins?: Record<string, string> | undefined;
|
|
138
|
+
blockUnblock?: Record<string, string> | undefined;
|
|
139
|
+
presignedUrls?: Record<string, string> | undefined;
|
|
140
|
+
};
|
|
141
|
+
|
|
90
142
|
interface ChatForwardItem {
|
|
91
143
|
message: IMessage;
|
|
92
144
|
attachmentId?: string;
|
|
@@ -810,13 +862,22 @@ interface ChatProps {
|
|
|
810
862
|
loggedUserDetails?: any;
|
|
811
863
|
apiUrl: string;
|
|
812
864
|
socketUrl?: string;
|
|
865
|
+
/** Shared query params for selected APIs (see `queryParamApis`) */
|
|
866
|
+
queryParams?: ChatQueryParams;
|
|
867
|
+
/**
|
|
868
|
+
* Which APIs receive `queryParams`.
|
|
869
|
+
* Default: `['get']` (all GET endpoints).
|
|
870
|
+
*/
|
|
871
|
+
queryParamApis?: ChatApiKey[];
|
|
872
|
+
/** Different query params per API key */
|
|
873
|
+
queryParamsByApi?: ChatQueryParamsByApi;
|
|
813
874
|
channelsData?: IChannel[];
|
|
814
875
|
messagesData?: Record<string, IMessage[]>;
|
|
815
876
|
onMessageReceived?: (message: any) => void;
|
|
816
877
|
onSocketConnected?: (socketId: string) => void;
|
|
817
878
|
onSocketError?: (error: string) => void;
|
|
818
879
|
}
|
|
819
|
-
declare const Chat: ({ children, onSendMessage, client, theme, uiConfig, themeColor, accessToken, loggedUserDetails, apiUrl, socketUrl, channelsData, messagesData, onMessageReceived, onSocketConnected, onSocketError }: ChatProps) => React__default.JSX.Element;
|
|
880
|
+
declare const Chat: ({ children, onSendMessage, client, theme, uiConfig, themeColor, accessToken, loggedUserDetails, apiUrl, socketUrl, queryParams, queryParamApis, queryParamsByApi, channelsData, messagesData, onMessageReceived, onSocketConnected, onSocketError }: ChatProps) => React__default.JSX.Element;
|
|
820
881
|
|
|
821
882
|
type ChatColorMode = 'light' | 'dark';
|
|
822
883
|
|
|
@@ -887,6 +948,20 @@ interface ChatMainProps {
|
|
|
887
948
|
accessToken: string;
|
|
888
949
|
apiUrl: string;
|
|
889
950
|
socketUrl?: string;
|
|
951
|
+
/** Shared query params for selected APIs (see `queryParamApis`) */
|
|
952
|
+
queryParams?: ChatQueryParams;
|
|
953
|
+
/**
|
|
954
|
+
* Which APIs receive `queryParams`.
|
|
955
|
+
* Default: `['get']` (all GET endpoints).
|
|
956
|
+
* Examples: `['conversations']`, `['get']`, `['all']`.
|
|
957
|
+
*/
|
|
958
|
+
queryParamApis?: ChatApiKey[];
|
|
959
|
+
/**
|
|
960
|
+
* Different query params per API.
|
|
961
|
+
* GET keys: users, conversations, conversationInfo, messages,
|
|
962
|
+
* pinnedMessages, starredMessages, searchMessages, searchMessagesContext
|
|
963
|
+
*/
|
|
964
|
+
queryParamsByApi?: ChatQueryParamsByApi;
|
|
890
965
|
themeColor?: string;
|
|
891
966
|
theme?: string;
|
|
892
967
|
uiConfig?: UIConfig;
|
|
@@ -918,7 +993,7 @@ interface ChatMainProps {
|
|
|
918
993
|
/** Extra classes on the viewport wrapper */
|
|
919
994
|
viewportClassName?: string;
|
|
920
995
|
}
|
|
921
|
-
declare const ChatMain: ({ clientId, loggedUserDetails, accessToken, apiUrl, socketUrl, themeColor, theme, uiConfig, components, classNames, features, layout, colorMode, defaultColorMode, onColorModeChange, showColorModeToggle, locale, timeZone, hour12, defaultLocale, defaultTimeZone, defaultHour12, onDateTimePreferencesChange, showDateTimeSettings, error, info, onErrorDismiss, onInfoDismiss, viewportHeight, viewportClassName, }: ChatMainProps) => React__default.JSX.Element;
|
|
996
|
+
declare const ChatMain: ({ clientId, loggedUserDetails, accessToken, apiUrl, socketUrl, queryParams, queryParamApis, queryParamsByApi, themeColor, theme, uiConfig, components, classNames, features, layout, colorMode, defaultColorMode, onColorModeChange, showColorModeToggle, locale, timeZone, hour12, defaultLocale, defaultTimeZone, defaultHour12, onDateTimePreferencesChange, showDateTimeSettings, error, info, onErrorDismiss, onInfoDismiss, viewportHeight, viewportClassName, }: ChatMainProps) => React__default.JSX.Element;
|
|
922
997
|
|
|
923
998
|
declare const useStore: zustand.UseBoundStore<Omit<zustand.StoreApi<AppStoreState>, "setState" | "persist"> & {
|
|
924
999
|
setState(partial: AppStoreState | Partial<AppStoreState> | ((state: AppStoreState) => AppStoreState | Partial<AppStoreState>), replace?: false | undefined): unknown;
|
|
@@ -1221,13 +1296,6 @@ declare const useChatController: () => {
|
|
|
1221
1296
|
setActiveChannel: (channel: IChannel | null) => void;
|
|
1222
1297
|
};
|
|
1223
1298
|
|
|
1224
|
-
declare const setChatClientId: (id: string) => void;
|
|
1225
|
-
declare const setChatAccessToken: (token: string) => void;
|
|
1226
|
-
declare const setChatBaseURL: (url: string) => void;
|
|
1227
|
-
declare const getChatBaseUrl: () => string;
|
|
1228
|
-
declare const setChatSocketUrl: (url: string) => void;
|
|
1229
|
-
declare const getChatSocketUrl: () => string;
|
|
1230
|
-
|
|
1231
1299
|
/** Normalize API base URL passed by the host app (must end with /api/v1). */
|
|
1232
1300
|
declare function resolveApiUrl(apiUrl?: string): string;
|
|
1233
1301
|
/**
|
|
@@ -1412,4 +1480,4 @@ declare function ChatAlertsProvider({ children, value, }: {
|
|
|
1412
1480
|
}): React.JSX.Element;
|
|
1413
1481
|
declare function useChatAlerts(): ChatAlertsContextValue;
|
|
1414
1482
|
|
|
1415
|
-
export { type ActiveChannelMessagesSlotProps, type AdminsDrawerSlotProps, type AttachmentsDrawerSlotProps, type AvatarSlotProps, Channel, type ChannelDetailsDrawerSlotProps, ChannelHeaderView as ChannelHeader, type ChannelHeaderSlotProps, ChannelListView as ChannelList, ChannelListItem, type ChannelListItemSlotProps, type ChannelListSlotProps, type ChannelMessageBoxSlotProps, Chat, type ChatActionModalSlotProps, ChatAlertsProvider, ChatAvatar, type ChatCallContext, type ChatClassNames, type ChatColorMode, type ChatComponents, type ChatCustomizationConfig, ChatCustomizationProvider, type ChatDateTimePreferences, type ChatFeatures, ChatLayout, type ChatLayoutConfig, type ChatLayoutSlotProps, ChatLocaleProvider, ChatMain, type ChatPanelAlertsSlotProps, ChatThemeProvider, ChatViewport, type ChatViewportHeight, DefaultChannelListItem, DefaultChatAvatar, DefaultChatLayout, ForwardModalView as ForwardModal, type ForwardModalSlotProps, HeaderCallActions, type HeaderCallActionsSlotProps, type HeaderLeftSideSlotProps, type HeaderRightSideSlotProps, type HeaderSearchOverlaySlotProps, type IAttachment, type IChannel, type IDMDelete, type IDMEditMessage, type IDMForward, type IDMMessage, type IDMPin, type IDMReaction, type IDMRead, type IDMStar, type IDMTyping, type IDMUnstar, type IMessage, type ISocketConfig, LoggedUserDetails, type LoggedUserDetailsSlotProps, type MembersDrawerSlotProps, type MessageAttachmentsSlotProps, ChannelMessageBoxView as MessageInput, MessageItemView as MessageItem, type MessageItemSlotProps, ActiveChannelMessagesView as MessageList, type MessageReactionsSlotProps, type MessageReplySnippetSlotProps, type MessageStatusSlotProps, type MessageToolbarSlotProps, type PermissionDrawerSlotProps, type PhoneCallButtonSlotProps, type PinnedMessagesDrawerSlotProps, type StarredMessagesDrawerSlotProps, type UIConfig, type VideoCallButtonSlotProps, capitalizeFirst, ChatMain as default, defaultChatClassNames, defaultChatComponents, defaultChatFeatures, defaultChatLayoutConfig, downloadFile, getChatBaseUrl, getChatSocketUrl, getFirstAndLastNameOneCharacter, getResponsiveWidth, getSocketConfig, isEmpty, mergeChatCustomization, mergeChatLayoutConfig, packageDefaultComponents, resolveApiUrl, resolveSocketUrl, setChatAccessToken, setChatBaseURL, setChatClientId, setChatSocketUrl, showNotification, socketService, uniqueList, useChatAlerts, useChatContext, useChatController, useChatCustomization, useChatCustomizationOptional, useChatFeatures, useChatFeaturesOptional, useChatLocale, useStore as useChatStore, useChatTheme };
|
|
1483
|
+
export { type ActiveChannelMessagesSlotProps, type AdminsDrawerSlotProps, type AttachmentsDrawerSlotProps, type AvatarSlotProps, CHAT_API_KEYS, CHAT_GET_API_KEYS, Channel, type ChannelDetailsDrawerSlotProps, ChannelHeaderView as ChannelHeader, type ChannelHeaderSlotProps, ChannelListView as ChannelList, ChannelListItem, type ChannelListItemSlotProps, type ChannelListSlotProps, type ChannelMessageBoxSlotProps, Chat, type ChatActionModalSlotProps, ChatAlertsProvider, type ChatApiKey, ChatAvatar, type ChatCallContext, type ChatClassNames, type ChatColorMode, type ChatComponents, type ChatCustomizationConfig, ChatCustomizationProvider, type ChatDateTimePreferences, type ChatFeatures, type ChatGetApiKey, ChatLayout, type ChatLayoutConfig, type ChatLayoutSlotProps, ChatLocaleProvider, ChatMain, type ChatPanelAlertsSlotProps, type ChatQueryParams, type ChatQueryParamsByApi, ChatThemeProvider, ChatViewport, type ChatViewportHeight, DefaultChannelListItem, DefaultChatAvatar, DefaultChatLayout, ForwardModalView as ForwardModal, type ForwardModalSlotProps, HeaderCallActions, type HeaderCallActionsSlotProps, type HeaderLeftSideSlotProps, type HeaderRightSideSlotProps, type HeaderSearchOverlaySlotProps, type IAttachment, type IChannel, type IDMDelete, type IDMEditMessage, type IDMForward, type IDMMessage, type IDMPin, type IDMReaction, type IDMRead, type IDMStar, type IDMTyping, type IDMUnstar, type IMessage, type ISocketConfig, LoggedUserDetails, type LoggedUserDetailsSlotProps, type MembersDrawerSlotProps, type MessageAttachmentsSlotProps, ChannelMessageBoxView as MessageInput, MessageItemView as MessageItem, type MessageItemSlotProps, ActiveChannelMessagesView as MessageList, type MessageReactionsSlotProps, type MessageReplySnippetSlotProps, type MessageStatusSlotProps, type MessageToolbarSlotProps, type PermissionDrawerSlotProps, type PhoneCallButtonSlotProps, type PinnedMessagesDrawerSlotProps, type StarredMessagesDrawerSlotProps, type UIConfig, type VideoCallButtonSlotProps, capitalizeFirst, ChatMain as default, defaultChatClassNames, defaultChatComponents, defaultChatFeatures, defaultChatLayoutConfig, downloadFile, getChatBaseUrl, getChatQueryParamApis, getChatQueryParams, getChatQueryParamsByApi, getChatSocketUrl, getFirstAndLastNameOneCharacter, getResponsiveWidth, getSocketConfig, isEmpty, mergeChatCustomization, mergeChatLayoutConfig, packageDefaultComponents, resolveApiUrl, resolveChatApiKey, resolveSocketUrl, setChatAccessToken, setChatBaseURL, setChatClientId, setChatQueryParamApis, setChatQueryParams, setChatQueryParamsByApi, setChatSocketUrl, showNotification, socketService, uniqueList, useChatAlerts, useChatContext, useChatController, useChatCustomization, useChatCustomizationOptional, useChatFeatures, useChatFeaturesOptional, useChatLocale, useStore as useChatStore, useChatTheme };
|