@mattermost/types 11.1.0-0 → 11.1.0-1

package/lib/content_flagging.d.ts

@@ -0,0 +1,24 @@
+import type { Post } from './posts';
+import type { NameMappedPropertyFields, PropertyValue } from './properties';
+export type ContentFlaggingEvent = 'flagged' | 'assigned' | 'removed' | 'dismissed';
+export type NotificationTarget = 'reviewers' | 'author' | 'reporter';
+export type ContentFlaggingConfig = {
+    reasons: string[];
+    reporter_comment_required: boolean;
+    reviewer_comment_required: boolean;
+    notify_reporter_on_dismissal?: boolean;
+    notify_reporter_on_removal?: boolean;
+};
+export type ContentFlaggingState = {
+    settings?: ContentFlaggingConfig;
+    fields?: NameMappedPropertyFields;
+    postValues?: {
+        [key: Post['id']]: Array<PropertyValue<unknown>>;
+    };
+};
+export declare enum ContentFlaggingStatus {
+    Pending = "Pending",
+    Assigned = "Assigned",
+    Removed = "Removed",
+    Retained = "Retained"
+}

package/lib/data_retention.d.ts

@@ -0,0 +1,30 @@
+export type DataRetentionCustomPolicy = {
+    id: string;
+    display_name: string;
+    post_duration: number;
+    team_count: number;
+    channel_count: number;
+};
+export type CreateDataRetentionCustomPolicy = {
+    display_name: string;
+    post_duration: number;
+    channel_ids: string[];
+    team_ids: string[];
+};
+export type PatchDataRetentionCustomPolicy = {
+    display_name: string;
+    post_duration: number;
+};
+export type PatchDataRetentionCustomPolicyTeams = {
+    team_ids: string[];
+};
+export type PatchDataRetentionCustomPolicyChannels = {
+    channel_ids: string[];
+};
+export type DataRetentionCustomPolicies = {
+    [x: string]: DataRetentionCustomPolicy;
+};
+export type GetDataRetentionCustomPoliciesRequest = {
+    policies: DataRetentionCustomPolicy[];
+    total_count: number;
+};

package/lib/drafts.d.ts

@@ -0,0 +1,14 @@
+import type { PostMetadata, PostPriorityMetadata } from './posts';
+export type Draft = {
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    user_id: string;
+    channel_id: string;
+    root_id: string;
+    message: string;
+    props: Record<string, any>;
+    file_ids?: string[];
+    metadata?: PostMetadata;
+    priority?: PostPriorityMetadata;
+};

package/lib/emojis.d.ts

@@ -0,0 +1,44 @@
+export type EmojiCategory = 'recent' | 'searchResults' | 'smileys-emotion' | 'people-body' | 'animals-nature' | 'food-drink' | 'activities' | 'travel-places' | 'objects' | 'symbols' | 'flags' | 'custom';
+export type CustomEmoji = {
+    id: string;
+    name: string;
+    category: 'custom';
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    creator_id: string;
+};
+export type SystemEmoji = {
+    name: string;
+    category: EmojiCategory;
+    image: string;
+    short_name: string;
+    short_names: string[];
+    batch: number;
+    skins?: string[];
+    skin_variations?: Record<string, SystemEmojiVariation>;
+    unified: string;
+};
+export type SystemEmojiVariation = {
+    unified: string;
+    non_qualified: null;
+    image: string;
+    sheet_x: number;
+    sheet_y: number;
+    added_in: string;
+    has_img_apple: boolean;
+    has_img_google: boolean;
+    has_img_twitter: boolean;
+    has_img_facebook: boolean;
+};
+export type Emoji = SystemEmoji | CustomEmoji;
+export type EmojisState = {
+    customEmoji: {
+        [x: string]: CustomEmoji;
+    };
+    nonExistentEmoji: Set<string>;
+};
+export type RecentEmojiData = {
+    name: string;
+    usageCount: number;
+};

package/lib/errors.d.ts

@@ -0,0 +1,8 @@
+export type ServerError = {
+    type?: string;
+    server_error_id?: string;
+    stack?: string;
+    message: string;
+    status_code?: number;
+    url?: string;
+};

package/lib/files.d.ts

@@ -0,0 +1,41 @@
+export type FileInfo = {
+    id: string;
+    user_id: string;
+    channel_id: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    name: string;
+    extension: string;
+    size: number;
+    mime_type: string;
+    width: number;
+    height: number;
+    has_preview_image: boolean;
+    clientId: string;
+    post_id?: string;
+    mini_preview?: string;
+    archived: boolean;
+    link?: string;
+};
+export type FilesState = {
+    files: Record<string, FileInfo>;
+    filesFromSearch: Record<string, FileSearchResultItem>;
+    fileIdsByPostId: Record<string, string[]>;
+    filePublicLink?: {
+        link: string;
+    };
+};
+export type FileUploadResponse = {
+    file_infos: FileInfo[];
+    client_ids: string[];
+};
+export type FileSearchResultItem = FileInfo & {
+    channel_id: string;
+};
+export type FileSearchResults = {
+    order: Array<FileSearchResultItem['id']>;
+    file_infos: Map<string, FileSearchResultItem>;
+    next_file_info_id: string;
+    prev_file_info_id: string;
+};

package/lib/general.d.ts

@@ -0,0 +1,16 @@
+import type { ClientConfig, ClientLicense } from './config';
+import type { UserPropertyField } from './properties';
+import type { IDMappedObjects } from './utilities';
+export type GeneralState = {
+    config: Partial<ClientConfig>;
+    firstAdminVisitMarketplaceStatus: boolean;
+    firstAdminCompleteSetup: boolean;
+    license: ClientLicense;
+    serverVersion: string;
+    customProfileAttributes: IDMappedObjects<UserPropertyField>;
+    cwsAvailability: 'pending' | 'available' | 'unavailable' | 'not_applicable';
+};
+export type SystemSetting = {
+    name: string;
+    value: string;
+};

package/lib/groups.d.ts

@@ -0,0 +1,169 @@
+import type { UserProfile } from './users';
+import type { RelationOneToOne } from './utilities';
+export declare enum SyncableType {
+    Team = "team",
+    Channel = "channel"
+}
+export type SyncablePatch = {
+    scheme_admin: boolean;
+    auto_add: boolean;
+};
+export type GroupPatch = {
+    allow_reference: boolean;
+    name?: string;
+};
+export type CustomGroupPatch = {
+    name: string;
+    display_name: string;
+};
+export type Group = {
+    id: string;
+    name: string;
+    display_name: string;
+    description: string;
+    source: string;
+    remote_id: string | null;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    has_syncables: boolean;
+    member_count: number;
+    scheme_admin: boolean;
+    allow_reference: boolean;
+    channel_member_count?: number;
+    channel_member_timezones_count?: number;
+    member_ids?: string[];
+};
+/**
+ * Main sources for groups
+ */
+export declare enum GroupSource {
+    Ldap = "ldap",
+    Custom = "custom"
+}
+/**
+ * Special prefixes that can be added to group sources when they come from plugins
+ * Used for identifying plugin-created groups by checking if source starts with this prefix
+ */
+export declare enum PluginGroupSourcePrefix {
+    Plugin = "plugin_"
+}
+export type GroupTeam = {
+    team_id: string;
+    team_display_name: string;
+    team_type?: string;
+    group_id?: string;
+    auto_add?: boolean;
+    scheme_admin?: boolean;
+    create_at?: number;
+    delete_at?: number;
+    update_at?: number;
+};
+export type GroupChannel = {
+    channel_id: string;
+    channel_display_name: string;
+    channel_type?: string;
+    team_id: string;
+    team_display_name: string;
+    team_type?: string;
+    group_id?: string;
+    auto_add?: boolean;
+    scheme_admin?: boolean;
+    create_at?: number;
+    delete_at?: number;
+    update_at?: number;
+};
+export type GroupSyncable = {
+    group_id: string;
+    auto_add: boolean;
+    scheme_admin: boolean;
+    create_at: number;
+    delete_at: number;
+    update_at: number;
+    type: 'Team' | 'Channel';
+};
+export type GroupSyncablesState = {
+    teams: GroupTeam[];
+    channels: GroupChannel[];
+};
+export type GroupsState = {
+    syncables: Record<string, GroupSyncablesState>;
+    stats: RelationOneToOne<Group, GroupStats>;
+    groups: Record<string, Group>;
+    myGroups: string[];
+};
+export type GroupStats = {
+    group_id: string;
+    total_member_count: number;
+};
+export type GroupSearchOpts = {
+    q: string;
+    is_linked?: boolean;
+    is_configured?: boolean;
+};
+export type MixedUnlinkedGroup = {
+    mattermost_group_id?: string;
+    name: string;
+    primary_key: string;
+    has_syncables?: boolean;
+};
+export type MixedUnlinkedGroupRedux = MixedUnlinkedGroup & {
+    failed?: boolean;
+};
+export type UserWithGroup = UserProfile & {
+    groups: Group[];
+    scheme_guest: boolean;
+    scheme_user: boolean;
+    scheme_admin: boolean;
+};
+export type GroupsWithCount = {
+    groups: Group[];
+    total_group_count: number;
+    channelID?: string;
+    teamID?: string;
+};
+export type UsersWithGroupsAndCount = {
+    users: UserWithGroup[];
+    total_count: number;
+};
+export type GroupCreateWithUserIds = {
+    name: string;
+    allow_reference: boolean;
+    display_name: string;
+    source: string;
+    user_ids: string[];
+    description?: string;
+};
+export type GetGroupsParams = {
+    filter_allow_reference?: boolean;
+    page?: number;
+    per_page?: number;
+    include_member_count?: boolean;
+    include_archived?: boolean;
+    filter_archived?: boolean;
+    include_member_ids?: boolean;
+};
+export type GetGroupsForUserParams = GetGroupsParams & {
+    filter_has_member: string;
+};
+export type GroupSearchParams = GetGroupsParams & {
+    q: string;
+    filter_has_member?: string;
+    include_timezones?: string;
+    include_channel_member_count?: string;
+};
+export type GroupMember = {
+    group_id: string;
+    user_id: string;
+    create_at: number;
+    deleted_at: number;
+};
+export type GroupMembership = {
+    user_id: string;
+    roles: string;
+};
+export type GroupPermissions = {
+    can_delete: boolean;
+    can_manage_members: boolean;
+    can_restore: boolean;
+};

package/lib/hosted_customer.d.ts

@@ -0,0 +1,7 @@
+import type { Product } from './cloud';
+export type HostedCustomerState = {
+    products: {
+        products: Record<string, Product>;
+        productsLoaded: boolean;
+    };
+};

package/lib/integration_actions.d.ts

@@ -0,0 +1,20 @@
+export type PostAction = {
+    id?: string;
+    type?: string;
+    name?: string;
+    disabled?: boolean;
+    style?: string;
+    data_source?: string;
+    options?: PostActionOption[];
+    default_option?: string;
+    cookie?: string;
+};
+export declare function isPostAction(v: unknown): v is PostAction;
+export type PostActionOption = {
+    text: string;
+    value: string;
+};
+export type PostActionResponse = {
+    status: string;
+    trigger_id: string;
+};

package/lib/integrations.d.ts

@@ -0,0 +1,187 @@
+import type { MessageAttachment } from './message_attachments';
+import type { IDMappedObjects } from './utilities';
+export type IncomingWebhook = {
+    id: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    user_id: string;
+    channel_id: string;
+    team_id: string;
+    display_name: string;
+    description: string;
+    username: string;
+    icon_url: string;
+    channel_locked: boolean;
+};
+export type IncomingWebhooksWithCount = {
+    incoming_webhooks: IncomingWebhook[];
+    total_count: number;
+};
+export type OutgoingWebhook = {
+    id: string;
+    token: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    creator_id: string;
+    channel_id: string;
+    team_id: string;
+    trigger_words: string[];
+    trigger_when: number;
+    callback_urls: string[];
+    display_name: string;
+    description: string;
+    content_type: string;
+    username: string;
+    icon_url: string;
+};
+export type Command = {
+    'id': string;
+    'token': string;
+    'create_at': number;
+    'update_at': number;
+    'delete_at': number;
+    'creator_id': string;
+    'team_id': string;
+    'trigger': string;
+    'method': 'P' | 'G' | '';
+    'username': string;
+    'icon_url': string;
+    'auto_complete': boolean;
+    'auto_complete_desc': string;
+    'auto_complete_hint': string;
+    'display_name': string;
+    'description': string;
+    'url': string;
+};
+export type CommandArgs = {
+    channel_id: string;
+    team_id?: string;
+    root_id?: string;
+};
+export type DialogArgs = {
+    channel_id: string;
+};
+export type CommandResponse = {
+    response_type: string;
+    text: string;
+    username: string;
+    channel_id: SVGAnimatedString;
+    icon_url: string;
+    type: string;
+    props: Record<string, any>;
+    goto_location: string;
+    trigger_id: string;
+    skip_slack_parsing: boolean;
+    attachments: MessageAttachment[];
+    extra_responses: CommandResponse[];
+};
+export type AutocompleteSuggestion = {
+    Complete: string;
+    Suggestion: string;
+    Hint: string;
+    Description: string;
+    IconData: string;
+    type?: string;
+};
+export type CommandAutocompleteSuggestion = AutocompleteSuggestion;
+export type OAuthApp = {
+    'id': string;
+    'creator_id': string;
+    'create_at': number;
+    'update_at': number;
+    'client_secret': string;
+    'name': string;
+    'description': string;
+    'icon_url': string;
+    'callback_urls': string[];
+    'homepage': string;
+    'is_trusted': boolean;
+};
+export type OutgoingOAuthConnection = {
+    'id': string;
+    'name': string;
+    'creator_id': string;
+    'create_at': number;
+    'update_at': number;
+    'client_id': string;
+    'client_secret'?: string;
+    'credentials_username'?: string;
+    'credentials_password'?: string;
+    'oauth_token_url': string;
+    'grant_type': 'client_credentials' | 'password';
+    'audiences': string[];
+};
+export type IntegrationsState = {
+    incomingHooks: IDMappedObjects<IncomingWebhook>;
+    incomingHooksTotalCount: number;
+    outgoingHooks: IDMappedObjects<OutgoingWebhook>;
+    oauthApps: IDMappedObjects<OAuthApp>;
+    outgoingOAuthConnections: IDMappedObjects<OutgoingOAuthConnection>;
+    appsOAuthAppIDs: string[];
+    appsBotIDs: string[];
+    systemCommands: IDMappedObjects<Command>;
+    commands: IDMappedObjects<Command>;
+    dialogArguments?: DialogArgs;
+    dialogTriggerId: string;
+    dialog?: {
+        url: string;
+        dialog: Dialog;
+        trigger_id: string;
+    };
+};
+type Dialog = {
+    callback_id?: string;
+    elements?: DialogElement[];
+    title: string;
+    introduction_text?: string;
+    icon_url?: string;
+    submit_label?: string;
+    notify_on_cancel?: boolean;
+    state?: string;
+    source_url?: string;
+};
+export type DialogSubmission = {
+    url?: string;
+    callback_id: string;
+    state: string;
+    user_id: string;
+    channel_id: string;
+    team_id: string;
+    submission: {
+        [x: string]: string | string[];
+    };
+    cancelled: boolean;
+    type?: string;
+};
+export type DialogElement = {
+    display_name: string;
+    name: string;
+    type: string;
+    subtype: string;
+    default: string;
+    placeholder: string;
+    help_text: string;
+    optional: boolean;
+    min_length: number;
+    max_length: number;
+    data_source: string;
+    data_source_url?: string;
+    multiselect?: boolean;
+    options: Array<{
+        text: string;
+        value: any;
+    }>;
+    refresh?: boolean;
+    min_date?: string;
+    max_date?: string;
+    time_interval?: number;
+};
+export type SubmitDialogResponse = {
+    error?: string;
+    errors?: Record<string, string>;
+    type?: string;
+    form?: Dialog;
+};
+export {};

package/lib/jobs.d.ts

@@ -0,0 +1,23 @@
+import type { IDMappedObjects } from './utilities';
+export type JobType = 'data_retention' | 'elasticsearch_post_indexing' | 'bleve_post_indexing' | 'ldap_sync' | 'message_export' | 'access_control_sync';
+export type JobStatus = 'pending' | 'in_progress' | 'success' | 'error' | 'cancel_requested' | 'canceled' | 'warning';
+export type Job = JobTypeBase & {
+    id: string;
+    priority: number;
+    create_at: number;
+    start_at: number;
+    last_activity_at: number;
+    status: JobStatus;
+    progress: number;
+    data: any;
+};
+export type JobsByType = {
+    [x in JobType]?: Job[];
+};
+export type JobsState = {
+    jobs: IDMappedObjects<Job>;
+    jobsByTypeList: JobsByType;
+};
+export type JobTypeBase = {
+    type: JobType;
+};

package/lib/limits.d.ts

@@ -0,0 +1,10 @@
+export type LimitsState = {
+    serverLimits: ServerLimits;
+};
+export type ServerLimits = {
+    activeUserCount: number;
+    maxUsersLimit: number;
+    maxUsersHardLimit?: number;
+    lastAccessiblePostTime?: number;
+    postHistoryLimit?: number;
+};

package/lib/marketplace.d.ts

@@ -0,0 +1,42 @@
+import type { AppManifest } from './apps';
+import type { PluginManifest } from './plugins';
+export type MarketplaceLabel = {
+    name: string;
+    description?: string;
+    url?: 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"
+}
+interface MarketplaceBaseItem {
+    labels?: MarketplaceLabel[];
+    hosting?: HostingType;
+    author_type: AuthorType;
+    release_stage: ReleaseStage;
+    enterprise: boolean;
+}
+export interface MarketplacePlugin extends MarketplaceBaseItem {
+    manifest: PluginManifest;
+    icon_data?: string;
+    homepage_url?: string;
+    download_url?: string;
+    release_notes_url?: string;
+    installed_version?: string;
+}
+export interface MarketplaceApp extends MarketplaceBaseItem {
+    manifest: AppManifest;
+    installed: boolean;
+    icon_url?: string;
+}
+export {};

package/lib/message_attachments.d.ts

@@ -0,0 +1,24 @@
+import { type PostAction } from './integration_actions';
+export type MessageAttachment = {
+    fallback?: string;
+    color?: string;
+    pretext?: string;
+    author_name?: string;
+    author_link?: string;
+    author_icon?: string;
+    title?: string;
+    title_link?: string;
+    text?: string;
+    fields?: MessageAttachmentField[] | null;
+    image_url?: string;
+    thumb_url?: string;
+    footer?: string;
+    footer_icon?: string;
+    actions?: PostAction[];
+};
+export declare function isMessageAttachmentArray(v: unknown): v is MessageAttachment[];
+export type MessageAttachmentField = {
+    title?: string;
+    value?: unknown;
+    short?: boolean;
+};

package/lib/mfa.d.ts

@@ -0,0 +1,4 @@
+export type MfaSecret = {
+    secret: string;
+    qr_code: string;
+};