@cometchat/chat-uikit-react 6.3.11 → 6.3.12

package/dist/index.d.ts

@@ -677,6 +677,11 @@ declare class UIKitSettings {
      * @type {CometChat.StorageMode}
      */
     readonly storageMode: CometChat.StorageMode;
+    /**
+     * Secure media mode for accessing protected media resources. Defaults to EMBEDDED if not set.
+     * @type {CometChat.SecureMediaMode}
+     */
+    readonly secureMediaMode: CometChat.SecureMediaMode;
     /**
      * Private constructor to initialize the settings using the provided builder.
      * @param {UIKitSettingsBuilder} builder - The builder instance containing the settings configuration.
@@ -743,6 +748,11 @@ declare class UIKitSettings {
      * @returns {CometChat.StorageMode} The storage mode.
      */
     getStorageMode(): CometChat.StorageMode;
+    /**
+     * Retrieves the secure media mode.
+     * @returns {CometChat.SecureMediaMode} The secure media mode.
+     */
+    getSecureMediaMode(): CometChat.SecureMediaMode;
 }
 declare class UIKitSettingsBuilder {
     /**
@@ -816,6 +826,11 @@ declare class UIKitSettingsBuilder {
      * @type {CometChat.StorageMode}
      */
     storageMode?: CometChat.StorageMode;
+    /**
+     * Secure media mode for accessing protected media resources. Defaults to EMBEDDED if not set.
+     * @type {CometChat.SecureMediaMode}
+     */
+    secureMediaMode?: CometChat.SecureMediaMode;
     /**
     * Builds and returns an instance of UIKitSettings.
     * @returns {UIKitSettings} A new instance of UIKitSettings with the specified configuration.
@@ -898,6 +913,12 @@ declare class UIKitSettingsBuilder {
      * @returns {UIKitSettingsBuilder} The builder instance.
     */
     setStorageMode(storageMode: CometChat.StorageMode): UIKitSettingsBuilder;
+    /**
+     * Sets the secure media mode for accessing protected media resources. Defaults to EMBEDDED.
+     * @param {CometChat.SecureMediaMode} secureMediaMode - The secure media mode.
+     * @returns {UIKitSettingsBuilder} The builder instance.
+     */
+    setSecureMediaMode(secureMediaMode: CometChat.SecureMediaMode): UIKitSettingsBuilder;
 }
 
 /**
@@ -7066,5 +7087,25 @@ interface CometChatAIAssistantChatHistoryProps {
 }
 declare const CometChatAIAssistantChatHistory: (props: CometChatAIAssistantChatHistoryProps) => react_jsx_runtime.JSX.Element;
 
-export { AuxiliaryButtonAlignment, ButtonAction, CalendarObject, CallButtonConfiguration, CallWorkflow, CallingConfiguration, CallingDetailsUtils, CallingExtension, CallingExtensionDecorator, ChatConfigurator, ChatSdkEventInitializer, CollaborativeDocumentConfiguration, CollaborativeDocumentExtension, CollaborativeDocumentExtensionDecorator, CollaborativeWhiteBoardExtensionDecorator, CollaborativeWhiteboardConfiguration, CollaborativeWhiteboardExtension, CometChatAIAssistantChat, CometChatAIAssistantChatHistory, CometChatAIAssistantMessageBubble, CometChatAIAssistantTools, CometChatActionBubble, CometChatActionSheet, CometChatActions, CometChatActionsIcon, CometChatActionsView, CometChatAudioBubble, CometChatAvatar, CometChatButton, CometChatCallBubble, CometChatCallButtons, CometChatCallEvents, CometChatCallLogs, CometChatChangeScope, CometChatCheckbox, CometChatConfirmDialog, CometChatContextMenu, CometChatConversationEvents, CometChatConversations, CometChatDate, CometChatDeleteBubble, CometChatDocumentBubble, CometChatDropDown, CometChatEditPreview, CometChatEmojiKeyboard, CometChatErrorView, CometChatFileBubble, CometChatFlagMessageDialog, CometChatFrameProvider, CometChatFullScreenViewer, CometChatGroupEvents, CometChatGroupMembers, CometChatGroups, CometChatImageBubble, CometChatIncomingCall, CometChatList, CometChatListItem, CometChatLocalize, CometChatMediaRecorder, CometChatMentionsFormatter, CometChatMessageBubble, CometChatMessageComposer, CometChatMessageComposerAction, CometChatMessageEvents, CometChatMessageHeader, CometChatMessageInformation, CometChatMessageList, CometChatMessageOption, CometChatMessagePreview, CometChatMessageTemplate, CometChatOngoingCall, CometChatOption, CometChatOutgoingCall, CometChatPopover, CometChatRadioButton, CometChatReactionInfo, CometChatReactionList, CometChatReactions, CometChatSearch, CometChatSearchBar, CometChatSearchFilter, CometChatSearchScope, CometChatStreamMessageBubble, CometChatTextBubble, CometChatTextFormatter, CometChatTextHighlightFormatter, CometChatThreadHeader, CometChatToast, CometChatUIEvents, CometChatUIKit, CometChatUIKitCalls, CometChatUIKitConstants, CometChatUIKitLoginListener, CometChatUIKitUtility, CometChatUrlsFormatter, CometChatUserEvents, CometChatUserMemberWrapper, CometChatUsers, CometChatUtilityConstants, CometChatVideoBubble, ConversationUtils, DataSource, DataSourceDecorator, DateTimePickerMode, DocumentIconAlignment, ElementType, EnterKeyBehavior, ExtensionsDataSource, GroupMemberUtils, HTTPSRequestMethods, IconButtonAlignment, LabelAlignment, LinkPreviewExtension, LinkPreviewExtensionDecorator, MentionsTargetElement, MentionsVisibility, MessageBubbleAlignment, MessageListAlignment, MessageReceiptUtils, MessageStatus, MessageTranslationExtension, MessageTranslationExtensionDecorator, MessageUtils, MessagesDataSource, MouseEventSource, OutgoingCallConfiguration, PanelAlignment, Placement$1 as Placement, PollsConfiguration, PollsExtension, PollsExtensionDecorator, PreviewMessageMode, Receipts, RecordingType, SelectionMode, States, StickersExtension, StickersExtensionDecorator, StorageUtils, TabAlignment, TabsVisibility, ThumbnailGenerationExtension, ThumbnailGenerationExtensionDecorator, TimestampAlignment, TitleAlignment, UIKitSettings, UIKitSettingsBuilder, UserMemberListType, closeCurrentMediaPlayer, convertMinutesToHoursMinutesSeconds, convertSecondsToHoursMinutesSeconds, createMessageCopy, createMessageCopyFromBaseMessage, currentAudioPlayer, currentMediaPlayer, decodeHTML, downloadRecordingFromURL, emitStreamingState, fireClickEvent, formatDateFromTimestamp, getAIAssistantTools, getCommonDateFormat, getLocalizedString, getStreamSpeed, getThemeMode, getThemeVariable, handleWebsocketMessage, hasLink, hasValidConversationSearchCriteria, hasValidMessageSearchCriteria, isDarkMode, isMessageSentByMe, isMissedCall, isMobileDevice, isMonthDifferent, isSafari, isSentByMe, isURL, messageStream, processFileForAudio, sanitizeCalendarObject, sanitizeHtmlStringToFragment, setAIAssistantTools, setStreamSpeed, shouldShowCustomMimeTypes, startStreamingMessage, stopStreamingMessage, streamingState$, useCometChatErrorHandler, useCometChatFrameContext, useDebouncedCallback, useRefSync, useStateRef, verifyCallUser };
+interface UseSecureMediaResult {
+    resolvedUrl: string | null;
+    isLoading: boolean;
+    error: Error | null;
+}
+/**
+ * Checks whether the given URL requires secure presigned access.
+ */
+declare function requiresSecureMediaAccess(url: string): boolean;
+/**
+ * Resolves a media URL to a presigned URL if secure access is required, else returns as-is.
+ * For imperative/non-hook contexts (downloads, WaveSurfer load, etc.).
+ */
+declare function resolveSecureUrl(url: string): Promise<string>;
+/**
+ * React hook that resolves a media URL to a presigned URL if secure access is required.
+ * Handles cancellation on unmount/url change.
+ */
+declare function useSecureMedia(url: string | null): UseSecureMediaResult;
+
+export { AuxiliaryButtonAlignment, ButtonAction, CalendarObject, CallButtonConfiguration, CallWorkflow, CallingConfiguration, CallingDetailsUtils, CallingExtension, CallingExtensionDecorator, ChatConfigurator, ChatSdkEventInitializer, CollaborativeDocumentConfiguration, CollaborativeDocumentExtension, CollaborativeDocumentExtensionDecorator, CollaborativeWhiteBoardExtensionDecorator, CollaborativeWhiteboardConfiguration, CollaborativeWhiteboardExtension, CometChatAIAssistantChat, CometChatAIAssistantChatHistory, CometChatAIAssistantMessageBubble, CometChatAIAssistantTools, CometChatActionBubble, CometChatActionSheet, CometChatActions, CometChatActionsIcon, CometChatActionsView, CometChatAudioBubble, CometChatAvatar, CometChatButton, CometChatCallBubble, CometChatCallButtons, CometChatCallEvents, CometChatCallLogs, CometChatChangeScope, CometChatCheckbox, CometChatConfirmDialog, CometChatContextMenu, CometChatConversationEvents, CometChatConversations, CometChatDate, CometChatDeleteBubble, CometChatDocumentBubble, CometChatDropDown, CometChatEditPreview, CometChatEmojiKeyboard, CometChatErrorView, CometChatFileBubble, CometChatFlagMessageDialog, CometChatFrameProvider, CometChatFullScreenViewer, CometChatGroupEvents, CometChatGroupMembers, CometChatGroups, CometChatImageBubble, CometChatIncomingCall, CometChatList, CometChatListItem, CometChatLocalize, CometChatMediaRecorder, CometChatMentionsFormatter, CometChatMessageBubble, CometChatMessageComposer, CometChatMessageComposerAction, CometChatMessageEvents, CometChatMessageHeader, CometChatMessageInformation, CometChatMessageList, CometChatMessageOption, CometChatMessagePreview, CometChatMessageTemplate, CometChatOngoingCall, CometChatOption, CometChatOutgoingCall, CometChatPopover, CometChatRadioButton, CometChatReactionInfo, CometChatReactionList, CometChatReactions, CometChatSearch, CometChatSearchBar, CometChatSearchFilter, CometChatSearchScope, CometChatStreamMessageBubble, CometChatTextBubble, CometChatTextFormatter, CometChatTextHighlightFormatter, CometChatThreadHeader, CometChatToast, CometChatUIEvents, CometChatUIKit, CometChatUIKitCalls, CometChatUIKitConstants, CometChatUIKitLoginListener, CometChatUIKitUtility, CometChatUrlsFormatter, CometChatUserEvents, CometChatUserMemberWrapper, CometChatUsers, CometChatUtilityConstants, CometChatVideoBubble, ConversationUtils, DataSource, DataSourceDecorator, DateTimePickerMode, DocumentIconAlignment, ElementType, EnterKeyBehavior, ExtensionsDataSource, GroupMemberUtils, HTTPSRequestMethods, IconButtonAlignment, LabelAlignment, LinkPreviewExtension, LinkPreviewExtensionDecorator, MentionsTargetElement, MentionsVisibility, MessageBubbleAlignment, MessageListAlignment, MessageReceiptUtils, MessageStatus, MessageTranslationExtension, MessageTranslationExtensionDecorator, MessageUtils, MessagesDataSource, MouseEventSource, OutgoingCallConfiguration, PanelAlignment, Placement$1 as Placement, PollsConfiguration, PollsExtension, PollsExtensionDecorator, PreviewMessageMode, Receipts, RecordingType, SelectionMode, States, StickersExtension, StickersExtensionDecorator, StorageUtils, TabAlignment, TabsVisibility, ThumbnailGenerationExtension, ThumbnailGenerationExtensionDecorator, TimestampAlignment, TitleAlignment, UIKitSettings, UIKitSettingsBuilder, UserMemberListType, closeCurrentMediaPlayer, convertMinutesToHoursMinutesSeconds, convertSecondsToHoursMinutesSeconds, createMessageCopy, createMessageCopyFromBaseMessage, currentAudioPlayer, currentMediaPlayer, decodeHTML, downloadRecordingFromURL, emitStreamingState, fireClickEvent, formatDateFromTimestamp, getAIAssistantTools, getCommonDateFormat, getLocalizedString, getStreamSpeed, getThemeMode, getThemeVariable, handleWebsocketMessage, hasLink, hasValidConversationSearchCriteria, hasValidMessageSearchCriteria, isDarkMode, isMessageSentByMe, isMissedCall, isMobileDevice, isMonthDifferent, isSafari, isSentByMe, isURL, messageStream, processFileForAudio, requiresSecureMediaAccess, resolveSecureUrl, sanitizeCalendarObject, sanitizeHtmlStringToFragment, setAIAssistantTools, setStreamSpeed, shouldShowCustomMimeTypes, startStreamingMessage, stopStreamingMessage, streamingState$, useCometChatErrorHandler, useCometChatFrameContext, useDebouncedCallback, useRefSync, useSecureMedia, useStateRef, verifyCallUser };
 export type { IActiveChatChanged, IDialog, IGroupLeft, IGroupMemberAdded, IGroupMemberJoined, IGroupMemberKickedBanned, IGroupMemberScopeChanged, IGroupMemberUnBanned, IMentionsCountWarning, IMessages, IModal, IMouseEvent, IOpenChat, IOwnershipChanged, IPanel, IShowOngoingCall, IStreamData, LocalizationSettings, PollOptions };