@lumiastream/ui 0.2.8-alpha.8 → 0.2.9

package/dist/utils/chatMedia.d.ts

@@ -0,0 +1,106 @@
+declare const MEDIA_PREVIEW_USER_LEVEL_VALUES: readonly ["streamer", "moderators", "vips", "tier3", "tier2", "subscribers", "regular", "follower", "anyone"];
+type MediaPreviewUserLevel = (typeof MEDIA_PREVIEW_USER_LEVEL_VALUES)[number];
+type ChatboxMediaPreviewKind = 'image' | 'video' | 'audio' | 'youtube' | 'youtubeShort' | 'spotify';
+type ChatboxMediaPreview = {
+    kind: ChatboxMediaPreviewKind;
+    src: string;
+    title?: string;
+};
+type MessageLinkPart = {
+    text: string;
+    url?: string;
+};
+type ChatMessageToken = {
+    type: 'text';
+    text: string;
+} | {
+    type: 'link';
+    text: string;
+    url: string;
+} | {
+    type: 'media';
+    text: string;
+    url: string;
+    media: ChatboxMediaPreview;
+};
+type MediaPreviewRoleSettings = {
+    previewMediaForViewers: boolean;
+    previewMediaForSubscribers: boolean;
+    previewMediaForVips: boolean;
+    previewMediaForModerators: boolean;
+    previewMediaForStreamer: boolean;
+    previewMediaForTier3: boolean;
+    previewMediaForTier2: boolean;
+    previewMediaForRegular: boolean;
+    previewMediaForFollower: boolean;
+    previewMediaForAnyone: boolean;
+};
+type MediaPreviewRoleSettingsInput = Partial<Record<keyof MediaPreviewRoleSettings, unknown>> & {
+    previewMediaUserLevels?: unknown;
+};
+type ChatMessageTokenizationOptions = {
+    hyperClickableLinks?: boolean;
+    previewMediaInChat?: boolean;
+};
+type ChatterProfileUrlInput = {
+    platform?: unknown;
+    username?: unknown;
+    displayname?: unknown;
+    userId?: unknown;
+};
+type ChatMessageEmoteStore = {
+    ffz?: Record<string, string>;
+    bttv?: Record<string, string>;
+    seventv?: Record<string, string>;
+};
+type ChatMessageContentItem = string | {
+    id: string;
+    urls: string[];
+    key: string;
+} | {
+    id: string;
+    type: 'cheer';
+    roundedAmount: number;
+    cheerAmount: number;
+    bitColor: string;
+    key: string;
+};
+type BuildChatMessageContentOptions = {
+    message?: string;
+    replaceWord?: string;
+    filteredWordsRegex?: RegExp;
+    emotesRaw?: string;
+    emotesPack?: Record<string, any> | any[];
+    origin?: string;
+    emoteParserType?: string;
+    isCheer?: boolean;
+    storeEmotes?: ChatMessageEmoteStore;
+    youtubeEmotes?: Record<string, string>;
+    allowParserTypes?: string[];
+};
+type ChatterProfileResolverPayload = {
+    username?: string;
+    displayname?: string;
+    userId?: string;
+    platform?: string;
+    extraSettings?: Record<string, any>;
+};
+type ChatterProfileResolver = (payload: ChatterProfileResolverPayload) => Promise<unknown> | unknown;
+type ResolveChatterProfileUrlWithResolversInput = ChatterProfileUrlInput & {
+    extraSettings?: Record<string, any>;
+    resolvers?: Array<ChatterProfileResolver | null | undefined>;
+};
+declare const parseMessageLinks: (value: string) => MessageLinkPart[];
+declare const tokenizeChatMessage: (value: string, options?: ChatMessageTokenizationOptions) => ChatMessageToken[];
+declare const buildChatMessageContent: ({ message, replaceWord, filteredWordsRegex, emotesRaw, emotesPack, origin, emoteParserType, isCheer, storeEmotes, youtubeEmotes, allowParserTypes, }: BuildChatMessageContentOptions) => ChatMessageContentItem[];
+declare const resolveMediaPreviewSetting: (value: unknown, fallback: boolean) => boolean;
+declare const normalizeMediaPreviewUserLevels: (value: unknown) => MediaPreviewUserLevel[];
+declare const resolveMediaPreviewRoleSettings: (settings: MediaPreviewRoleSettingsInput) => MediaPreviewRoleSettings;
+declare const getNormalizedUserLevels: (value: unknown) => Record<string, boolean>;
+declare const isMediaPreviewAllowedForUser: (userLevelsRaw: unknown, roleSettings: MediaPreviewRoleSettings) => boolean;
+declare const getMediaPreviewFromUrl: (url: string) => ChatboxMediaPreview | null;
+declare const resolvePlatformChatterProfileUrl: ({ platform, username, displayname, userId }: ChatterProfileUrlInput) => string | null;
+declare const normalizeHttpUrl: (value: unknown) => string | null;
+declare const resolveChatterProfileUrlWithResolvers: ({ platform, username, displayname, userId, extraSettings, resolvers, }: ResolveChatterProfileUrlWithResolversInput) => Promise<string | null>;
+
+export { type BuildChatMessageContentOptions, type ChatMessageContentItem, type ChatMessageEmoteStore, type ChatMessageToken, type ChatMessageTokenizationOptions, type ChatboxMediaPreview, type ChatboxMediaPreviewKind, type ChatterProfileResolver, type ChatterProfileResolverPayload, type ChatterProfileUrlInput, MEDIA_PREVIEW_USER_LEVEL_VALUES, type MediaPreviewRoleSettings, type MediaPreviewRoleSettingsInput, type MediaPreviewUserLevel, type MessageLinkPart, type ResolveChatterProfileUrlWithResolversInput, buildChatMessageContent, getMediaPreviewFromUrl, getNormalizedUserLevels, isMediaPreviewAllowedForUser, normalizeHttpUrl, normalizeMediaPreviewUserLevels, parseMessageLinks, resolveChatterProfileUrlWithResolvers, resolveMediaPreviewRoleSettings, resolveMediaPreviewSetting, resolvePlatformChatterProfileUrl, tokenizeChatMessage };