mattermost-redux/types/posts.d.ts

Common code (API client, Redux stores, logic, utility functions) for building a Mattermost client

import { CustomEmoji } from './emojis';
import { FileInfo } from './files';
import { Reaction } from './reactions';
import { $ID, RelationOneToOne, RelationOneToMany, IDMappedObjects, Dictionary } from './utilities';
export declare type PostType = 'system_add_remove' | 'system_add_to_channel' | 'system_add_to_team' | 'system_channel_deleted' | 'system_channel_restored' | 'system_displayname_change' | 'system_convert_channel' | 'system_ephemeral' | 'system_header_change' | 'system_join_channel' | 'system_join_leave' | 'system_leave_channel' | 'system_purpose_change' | 'system_remove_from_channel';
export declare type PostEmbedType = 'image' | 'link' | 'message_attachment' | 'opengraph';
export declare type PostEmbed = {
    type: PostEmbedType;
    url: string;
    data: Record<string, OpenGraphMetadata>;
};
export declare type PostImage = {
    format: string;
    frameCount: number;
    height: number;
    width: number;
};
export declare type PostMetadata = {
    embeds: PostEmbed[];
    emojis: CustomEmoji[];
    files: FileInfo[];
    images: Dictionary<PostImage>;
    reactions: Reaction[];
};
export declare type Post = {
    id: string;
    create_at: number;
    update_at: number;
    edit_at: number;
    delete_at: number;
    is_pinned: boolean;
    user_id: string;
    channel_id: string;
    root_id: string;
    parent_id: string;
    original_id: string;
    message: string;
    type: PostType;
    props: Record<string, any>;
    hashtags: string;
    pending_post_id: string;
    reply_count: number;
    file_ids?: any[];
    metadata: PostMetadata;
    failed?: boolean;
    user_activity_posts?: Post[];
    state?: 'DELETED';
    filenames?: string[];
    last_reply_at?: number;
    participants?: any;
    message_source?: string;
};
export declare type PostList = {
    order: Array<$ID<Post>>;
    posts: Map<string, Post>;
    next_post_id: string;
    prev_post_id: string;
};
export declare type PostSearchResults = PostList & {
    matches: RelationOneToOne<Post, string[]>;
};
export declare type PostWithFormatData = Post & {
    isFirstReply: boolean;
    isLastReply: boolean;
    previousPostIsComment: boolean;
    commentedOnPost?: Post;
    consecutivePostByUser: boolean;
    replyCount: number;
    isCommentMention: boolean;
    highlight: boolean;
};
export declare type PostOrderBlock = {
    order: string[];
    recent?: boolean;
    oldest?: boolean;
};
export declare type MessageHistory = {
    messages: string[];
    index: {
        post: number;
        comment: number;
    };
};
export declare type PostsState = {
    posts: IDMappedObjects<Post>;
    postsReplies: {
        [x in $ID<Post>]: number;
    };
    postsInChannel: Dictionary<PostOrderBlock[]>;
    postsInThread: RelationOneToMany<Post, Post>;
    reactions: RelationOneToOne<Post, Dictionary<Reaction>>;
    openGraph: RelationOneToOne<Post, Dictionary<OpenGraphMetadata>>;
    pendingPostIds: string[];
    selectedPostId: string;
    currentFocusedPostId: string;
    messagesHistory: MessageHistory;
    expandedURLs: Dictionary<string>;
};
export declare type OpenGraphMetadataImage = {
    secure_url?: string;
    url: string;
    height?: number;
    width?: number;
};
export declare type OpenGraphMetadata = {
    type?: string;
    title?: string;
    description?: string;
    site_name?: string;
    url?: string;
    images: OpenGraphMetadataImage[];
};