@mattermost/types 11.1.0-0 → 11.1.0-1

package/lib/plugins.d.ts

@@ -0,0 +1,136 @@
+type MessageDescriptor = {
+    id: string;
+    defaultMessage: string;
+};
+export type PluginManifest = {
+    id: string;
+    name: string;
+    description?: string;
+    homepage_url?: string;
+    support_url?: string;
+    release_notes_url?: string;
+    icon_path?: string;
+    version: string;
+    min_server_version?: string;
+    translate?: boolean;
+    server?: PluginManifestServer;
+    backend?: PluginManifestServer;
+    webapp?: PluginManifestWebapp;
+    settings_schema?: PluginSettingsSchema;
+    props?: Record<string, any>;
+};
+export type PluginRedux = PluginManifest & {
+    active: boolean;
+};
+export type PluginManifestServer = {
+    executables?: {
+        'linux-amd64'?: string;
+        'darwin-amd64'?: string;
+        'windows-amd64'?: string;
+    };
+    executable: string;
+};
+export type PluginManifestWebapp = {
+    bundle_path: string;
+};
+export type PluginSettingsSchema = {
+    header: string;
+    footer: string;
+    settings: PluginSetting[];
+    sections?: PluginSettingSection[];
+};
+export type PluginSettingSection = {
+    key: string;
+    title?: string;
+    subtitle?: string;
+    settings: PluginSetting[];
+    header?: string;
+    footer?: string;
+    custom?: boolean;
+    fallback?: boolean;
+};
+export type PluginSetting = {
+    key: string;
+    display_name: string;
+    type: string;
+    help_text: string | MessageDescriptor;
+    regenerate_help_text?: string;
+    placeholder: string;
+    default: any;
+    options?: PluginSettingOption[];
+    hosting?: 'on-prem' | 'cloud';
+};
+export type PluginSettingOption = {
+    display_name: string;
+    value: string;
+};
+export type PluginsResponse = {
+    active: PluginManifest[];
+    inactive: PluginManifest[];
+};
+export type PluginStatus = {
+    plugin_id: string;
+    cluster_id: string;
+    plugin_path: string;
+    state: number;
+    name: string;
+    description: string;
+    version: string;
+};
+type PluginInstance = {
+    cluster_id: string;
+    version: string;
+    state: number;
+};
+export type PluginStatusRedux = {
+    id: string;
+    name: string;
+    description: string;
+    version: string;
+    active: boolean;
+    state: number;
+    error?: string;
+    instances: PluginInstance[];
+};
+export type ClientPluginManifest = {
+    id: string;
+    min_server_version?: string;
+    version: string;
+    webapp: {
+        bundle_path: string;
+    };
+};
+export type MarketplaceLabel = {
+    name: string;
+    description?: string;
+    url?: string;
+    color?: string;
+};
+export declare enum HostingType {
+    OnPrem = "on-prem",
+    Cloud = "cloud"
+}
+export declare enum AuthorType {
+    Mattermost = "mattermost",
+    Partner = "partner",
+    Community = "community"
+}
+export declare enum ReleaseStage {
+    Production = "production",
+    Beta = "beta",
+    Experimental = "experimental"
+}
+export type MarketplacePlugin = {
+    homepage_url?: string;
+    icon_data?: string;
+    download_url?: string;
+    release_notes_url?: string;
+    labels?: MarketplaceLabel[];
+    hosting?: HostingType;
+    author_type: AuthorType;
+    release_stage: ReleaseStage;
+    enterprise: boolean;
+    manifest: PluginManifest;
+    installed_version?: string;
+};
+export {};

package/lib/posts.d.ts

@@ -0,0 +1,182 @@
+import type { Channel, ChannelType } from './channels';
+import type { CustomEmoji } from './emojis';
+import type { FileInfo } from './files';
+import type { Reaction } from './reactions';
+import type { TeamType } from './teams';
+import type { UserProfile } from './users';
+import { type RelationOneToOne, type RelationOneToMany, type IDMappedObjects } from './utilities';
+export 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' | 'system_combined_user_activity' | 'system_fake_parent_deleted' | 'system_generic' | 'reminder' | 'system_wrangler' | 'custom_spillage_report' | '';
+export type PostEmbedType = 'image' | 'link' | 'message_attachment' | 'opengraph' | 'permalink';
+export type PostEmbed = {
+    type: PostEmbedType;
+    url: string;
+    data?: OpenGraphMetadata | PostPreviewMetadata;
+};
+export type PostImage = {
+    format: string;
+    frameCount: number;
+    height: number;
+    width: number;
+};
+export type PostAcknowledgement = {
+    post_id: Post['id'];
+    user_id: UserProfile['id'];
+    acknowledged_at: number;
+};
+export type PostPriorityMetadata = {
+    priority: PostPriority | '';
+    requested_ack?: boolean;
+    persistent_notifications?: boolean;
+};
+export type PostMetadata = {
+    embeds: PostEmbed[];
+    emojis: CustomEmoji[];
+    files: FileInfo[];
+    images: Record<string, PostImage>;
+    reactions?: Reaction[];
+    priority?: PostPriorityMetadata;
+    acknowledgements?: PostAcknowledgement[];
+};
+export 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;
+    original_id: string;
+    message: string;
+    type: PostType;
+    props: Record<string, unknown>;
+    hashtags: string;
+    pending_post_id: string;
+    reply_count: number;
+    file_ids?: string[];
+    metadata: PostMetadata;
+    failed?: boolean;
+    user_activity_posts?: Post[];
+    state?: PostState;
+    filenames?: string[];
+    last_reply_at?: number;
+    participants?: any;
+    message_source?: string;
+    is_following?: boolean;
+    exists?: boolean;
+    remote_id?: string;
+};
+export type PostState = 'DELETED';
+export declare enum PostPriority {
+    URGENT = "urgent",
+    IMPORTANT = "important"
+}
+export type PostList = {
+    order: Array<Post['id']>;
+    posts: Record<string, Post>;
+    next_post_id: string;
+    prev_post_id: string;
+    first_inaccessible_post_time: number;
+};
+export type PaginatedPostList = PostList & {
+    has_next: boolean;
+};
+export type PostSearchResults = PostList & {
+    matches: RelationOneToOne<Post, string[]>;
+};
+export type PostOrderBlock = {
+    order: string[];
+    recent?: boolean;
+    oldest?: boolean;
+};
+export type MessageHistory = {
+    messages: string[];
+    index: {
+        post: number;
+        comment: number;
+    };
+};
+export type PostsState = {
+    posts: IDMappedObjects<Post>;
+    postsReplies: {
+        [x in Post['id']]: number;
+    };
+    postsInChannel: Record<string, PostOrderBlock[]>;
+    postsInThread: RelationOneToMany<Post, Post>;
+    reactions: RelationOneToOne<Post, Record<string, Reaction>>;
+    openGraph: RelationOneToOne<Post, Record<string, OpenGraphMetadata>>;
+    pendingPostIds: string[];
+    postEditHistory: Post[];
+    currentFocusedPostId: string;
+    messagesHistory: MessageHistory;
+    limitedViews: {
+        channels: Record<Channel['id'], number>;
+        threads: Record<Post['root_id'], number>;
+    };
+    acknowledgements: RelationOneToOne<Post, Record<UserProfile['id'], number>>;
+};
+export declare type OpenGraphMetadataImage = {
+    secure_url?: string;
+    url: string;
+    type?: string;
+    height?: number;
+    width?: number;
+};
+export declare type OpenGraphMetadata = {
+    type?: string;
+    title?: string;
+    description?: string;
+    site_name?: string;
+    url?: string;
+    images: OpenGraphMetadataImage[];
+};
+export declare type PostPreviewMetadata = {
+    post_id: string;
+    post?: Post;
+    channel_display_name: string;
+    team_name: string;
+    channel_type: ChannelType;
+    channel_id: string;
+};
+export declare type PostsUsageResponse = {
+    count: number;
+};
+export declare type FilesUsageResponse = {
+    bytes: number;
+};
+export declare type TeamsUsageResponse = {
+    active: number;
+    cloud_archived: number;
+};
+export type PostAnalytics = {
+    channel_id: string;
+    post_id: string;
+    user_actual_id: string;
+    root_id: string;
+    priority?: PostPriority | '';
+    requested_ack?: boolean;
+    persistent_notifications?: boolean;
+};
+export type ActivityEntry = {
+    postType: Post['type'];
+    actorId: string[];
+    userIds: string[];
+    usernames: string[];
+};
+export type PostInfo = {
+    channel_id: string;
+    channel_type: ChannelType;
+    channel_display_name: string;
+    has_joined_channel: boolean;
+    team_id: string;
+    team_type: TeamType;
+    team_display_name: string;
+    has_joined_team: boolean;
+};
+export type NotificationStatus = 'error' | 'not_sent' | 'unsupported' | 'success';
+export type NotificationResult = {
+    status: NotificationStatus;
+    reason?: string;
+    data?: string;
+};

package/lib/preferences.d.ts

@@ -0,0 +1,9 @@
+export type PreferenceType = {
+    category: string;
+    name: string;
+    user_id: string;
+    value: string;
+};
+export type PreferencesType = {
+    [x: string]: PreferenceType;
+};

package/lib/product_notices.d.ts

@@ -0,0 +1,26 @@
+export declare enum Action {
+    URL = "url"
+}
+export type ProductNotice = {
+    /** Unique identifier for this notice. Can be a running number. Used for storing 'viewed' state on the server. */
+    id: string;
+    /** Notice title. Use {{Mattermost}} instead of plain text to support white-labeling. Text supports Markdown. */
+    title: string;
+    /** Notice content. Use {{Mattermost}} instead of plain text to support white-labeling. Text supports Markdown. */
+    description: string;
+    image?: string;
+    /** Optional override for the action button text (defaults to OK) */
+    actionText?: string;
+    /** Optional action to perform on action button click. (defaults to closing the notice) */
+    action?: Action;
+    /** Optional action parameter.
+     * Example: {"action": "url", actionParam: "/console/some-page"}
+     */
+    actionParam?: string;
+    sysAdminOnly: boolean;
+    teamAdminOnly: boolean;
+};
+/** List of product notices. Order is important and is used to resolve priorities.
+ * Each notice will only be show if conditions are met.
+ */
+export type ProductNotices = ProductNotice[];

package/lib/products.d.ts

@@ -0,0 +1,8 @@
+/**
+ * - `null` - explicitly Channels
+ * - `string` - uuid - any other product
+ */
+export type ProductIdentifier = null | string;
+/** @see {@link ProductIdentifier} */
+export type ProductScope = ProductIdentifier | ProductIdentifier[];
+export declare function isProductScope(v: unknown): v is ProductScope;

package/lib/properties.d.ts

@@ -0,0 +1,60 @@
+export type FieldType = ('text' | 'select' | 'multiselect' | 'date' | 'user' | 'multiuser');
+export type PropertyField = {
+    id: string;
+    group_id: string;
+    name: string;
+    type: FieldType;
+    attrs?: {
+        subType?: string;
+        [key: string]: unknown;
+    };
+    target_id?: string;
+    target_type?: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+};
+export type NameMappedPropertyFields = {
+    [key: PropertyField['name']]: PropertyField;
+};
+export type PropertyValue<T> = {
+    id: string;
+    target_id: string;
+    target_type: string;
+    group_id: string;
+    field_id: string;
+    value: T;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+};
+export type UserPropertyFieldType = 'text' | 'select' | 'multiselect';
+export type UserPropertyFieldGroupID = 'custom_profile_attributes';
+export type UserPropertyValueType = 'phone' | 'url' | '';
+export type FieldVisibility = 'always' | 'hidden' | 'when_set';
+export type FieldValueType = 'email' | 'url' | 'phone' | '';
+export type PropertyFieldOption = {
+    id: string;
+    name: string;
+    color?: string;
+};
+export type UserPropertyField = PropertyField & {
+    group_id: UserPropertyFieldGroupID;
+    attrs: {
+        sort_order: number;
+        visibility: FieldVisibility;
+        value_type: FieldValueType;
+        options?: PropertyFieldOption[];
+        ldap?: string;
+        saml?: string;
+        managed?: string;
+    };
+};
+export type SelectPropertyField = PropertyField & {
+    attrs?: {
+        editable?: boolean;
+        options?: PropertyFieldOption[];
+    };
+};
+export declare const supportsOptions: (field: UserPropertyField) => boolean;
+export type UserPropertyFieldPatch = Partial<Pick<UserPropertyField, 'name' | 'attrs' | 'type'>>;

package/lib/reactions.d.ts

@@ -0,0 +1,6 @@
+export type Reaction = {
+    user_id: string;
+    post_id: string;
+    emoji_name: string;
+    create_at: number;
+};

package/lib/remote_clusters.d.ts

@@ -0,0 +1,35 @@
+export type RemoteClusterInvite = {
+    remote_id: string;
+    remote_team_id: string;
+    site_url: string;
+    token: string;
+};
+export type RemoteClusterAcceptInvite = {
+    name: string;
+    display_name: string;
+    default_team_id: string;
+    invite: string;
+    password: string;
+};
+export type RemoteClusterPatch = Pick<RemoteCluster, 'display_name' | 'default_team_id'>;
+export declare function isRemoteClusterPatch(x: Partial<RemoteClusterPatch>): x is RemoteClusterPatch;
+export type RemoteCluster = {
+    remote_id: string;
+    remote_team_id: string;
+    name: string;
+    display_name: string;
+    site_url: string;
+    create_at: number;
+    delete_at: number;
+    last_ping_at: number;
+    token?: string;
+    remote_token?: string;
+    topics: string;
+    creator_id: string;
+    plugin_id: string;
+    options: number;
+    default_team_id: string;
+};
+export type RemoteClusterWithPassword = RemoteCluster & {
+    password: string;
+};

package/lib/reports.d.ts

@@ -0,0 +1,65 @@
+import type { UserProfile } from './users';
+export declare enum UserReportSortColumns {
+    username = "Username",
+    email = "Email",
+    createAt = "CreateAt",
+    firstName = "FirstName",
+    lastName = "LastName",
+    nickname = "Nickname"
+}
+export declare enum ReportSortDirection {
+    ascending = "asc",
+    descending = "desc"
+}
+export declare enum ReportDuration {
+    AllTime = "all_time",
+    Last30Days = "last_30_days",
+    PreviousMonth = "previous_month",
+    Last6Months = "last_6_months"
+}
+export declare enum CursorPaginationDirection {
+    'prev' = "prev",
+    'next' = "next"
+}
+export type UserReportFilter = {
+    role_filter?: string;
+    has_no_team?: boolean;
+    team_filter?: string;
+    hide_active?: boolean;
+    hide_inactive?: boolean;
+    search_term?: string;
+};
+export type UserReportOptions = UserReportFilter & {
+    page_size?: number;
+    /**
+     * The column to sort on. Provide the id of the column. Use the UserReportSortColumns enum.
+     */
+    sort_column?: UserReportSortColumns;
+    /**
+     * The sort direction to use. Either "asc" or "desc". Use the ReportSortDirection enum.
+     */
+    sort_direction?: ReportSortDirection;
+    /**
+     * The direction to paginate in. Either "up" or "down". Use the CursorPaginationDirection enum.
+     */
+    direction?: CursorPaginationDirection;
+    /**
+     * The cursor to paginate from.
+     */
+    from_column_value?: string;
+    /**
+     * The id of the user to paginate from.
+     */
+    from_id?: string;
+    /**
+     * The duration to filter by. Use the ReportDuration enum.
+     */
+    date_range?: ReportDuration;
+};
+export type UserReport = UserProfile & {
+    last_login_at: number;
+    last_status_at?: number;
+    last_post_date?: number;
+    days_active?: number;
+    total_posts?: number;
+};

package/lib/requests.d.ts

@@ -0,0 +1,53 @@
+export type RequestStatusOption = 'not_started' | 'started' | 'success' | 'failure' | 'cancelled';
+export type RequestStatusType = {
+    status: RequestStatusOption;
+    error: null | Record<string, any>;
+};
+export type ChannelsRequestsStatuses = {
+    getChannels: RequestStatusType;
+    getAllChannels: RequestStatusType;
+    myChannels: RequestStatusType;
+    createChannel: RequestStatusType;
+};
+export type GeneralRequestsStatuses = {
+    websocket: RequestStatusType;
+};
+export type PostsRequestsStatuses = {
+    createPost: RequestStatusType;
+    editPost: RequestStatusType;
+    getPostThread: RequestStatusType;
+};
+export type ThreadsRequestStatuses = {
+    getThreads: RequestStatusType;
+};
+export type TeamsRequestsStatuses = {
+    getTeams: RequestStatusType;
+};
+export type UsersRequestsStatuses = {
+    login: RequestStatusType;
+    logout: RequestStatusType;
+    autocompleteUsers: RequestStatusType;
+    updateMe: RequestStatusType;
+};
+export type AdminRequestsStatuses = {
+    createCompliance: RequestStatusType;
+};
+export type EmojisRequestsStatuses = {
+    createCustomEmoji: RequestStatusType;
+    getCustomEmojis: RequestStatusType;
+    deleteCustomEmoji: RequestStatusType;
+    getCustomEmoji: RequestStatusType;
+};
+export type FilesRequestsStatuses = {
+    uploadFiles: RequestStatusType;
+};
+export type RolesRequestsStatuses = {
+    getRolesByNames: RequestStatusType;
+    getRoleByName: RequestStatusType;
+    getRole: RequestStatusType;
+    editRole: RequestStatusType;
+};
+export type SearchRequestsStatuses = {
+    flaggedPosts: RequestStatusType;
+    pinnedPosts: RequestStatusType;
+};

package/lib/roles.d.ts

@@ -0,0 +1,12 @@
+export type Role = {
+    id: string;
+    name: string;
+    display_name: string;
+    description: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    permissions: string[];
+    scheme_managed: boolean;
+    built_in: boolean;
+};

package/lib/saml.d.ts

@@ -0,0 +1,10 @@
+export type SamlCertificateStatus = {
+    idp_certificate_file: string;
+    private_key_file: string;
+    public_certificate_file: string;
+};
+export type SamlMetadataResponse = {
+    idp_descriptor_url: string;
+    idp_url: string;
+    idp_public_certificate: string;
+};

package/lib/schedule_post.d.ts

@@ -0,0 +1,27 @@
+import type { Draft } from './drafts';
+import type { Post } from './posts';
+export type ScheduledPostErrorCode = 'unknown' | 'channel_archived' | 'channel_not_found' | 'user_missing' | 'user_deleted' | 'no_channel_permission' | 'no_channel_member' | 'thread_deleted' | 'unable_to_send' | 'invalid_post';
+export type SchedulingInfo = {
+    scheduled_at: number;
+    processed_at?: number;
+    error_code?: ScheduledPostErrorCode;
+};
+export type ScheduledPost = Omit<Draft, 'delete_at'> & SchedulingInfo & {
+    id: string;
+};
+export type ScheduledPostsState = {
+    byId: {
+        [scheduledPostId: string]: ScheduledPost | undefined;
+    };
+    byTeamId: {
+        [teamId: string]: string[];
+    };
+    errorsByTeamId: {
+        [teamId: string]: string[];
+    };
+    byChannelOrThreadId: {
+        [channelId: string]: string[];
+    };
+};
+export declare function scheduledPostFromPost(post: Post, schedulingInfo: SchedulingInfo): ScheduledPost;
+export declare function scheduledPostToPost(scheduledPost: ScheduledPost): Post;

package/lib/schemes.d.ts

@@ -0,0 +1,29 @@
+export type SchemeScope = 'team' | 'channel';
+export type Scheme = {
+    id: string;
+    name: string;
+    description: string;
+    display_name: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    scope: SchemeScope;
+    default_team_admin_role: string;
+    default_team_user_role: string;
+    default_team_guest_role: string;
+    default_channel_admin_role: string;
+    default_channel_user_role: string;
+    default_channel_guest_role: string;
+    default_playbook_admin_role: string;
+    default_playbook_member_role: string;
+    default_run_member_role: string;
+};
+export type SchemesState = {
+    schemes: {
+        [x: string]: Scheme;
+    };
+};
+export type SchemePatch = {
+    name?: string;
+    description?: string;
+};