@mattermost/types 6.7.0-0

package/lib/plugins.d.ts

@@ -0,0 +1,119 @@
+declare type Plugin = {
+    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;
+    server?: PluginManifestServer;
+    backend?: PluginManifestServer;
+    webapp?: PluginManifestWebapp;
+    settings_schema?: PluginSettingsSchema;
+    props?: Record<string, any>;
+};
+export declare type PluginManifest = Plugin;
+export declare type PluginRedux = PluginManifest & {
+    active: boolean;
+};
+export declare type PluginManifestServer = {
+    executables?: {
+        'linux-amd64'?: string;
+        'darwin-amd64'?: string;
+        'windows-amd64'?: string;
+    };
+    executable: string;
+};
+export declare type PluginManifestWebapp = {
+    bundle_path: string;
+};
+export declare type PluginSettingsSchema = {
+    header: string;
+    footer: string;
+    settings: PluginSetting[];
+};
+export declare type PluginSetting = {
+    key: string;
+    display_name: string;
+    type: string;
+    help_text: string;
+    regenerate_help_text?: string;
+    placeholder: string;
+    default: any;
+    options?: PluginSettingOption[];
+};
+export declare type PluginSettingOption = {
+    display_name: string;
+    value: string;
+};
+export declare type PluginsResponse = {
+    active: PluginManifest[];
+    inactive: PluginManifest[];
+};
+export declare type PluginStatus = {
+    plugin_id: string;
+    cluster_id: string;
+    plugin_path: string;
+    state: number;
+    name: string;
+    description: string;
+    version: string;
+};
+declare type PluginInstance = {
+    cluster_id: string;
+    version: string;
+    state: number;
+};
+export declare type PluginStatusRedux = {
+    id: string;
+    name: string;
+    description: string;
+    version: string;
+    active: boolean;
+    state: number;
+    instances: PluginInstance[];
+};
+export declare type ClientPluginManifest = {
+    id: string;
+    min_server_version?: string;
+    version: string;
+    webapp: {
+        bundle_path: string;
+    };
+};
+export declare 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 declare 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/plugins.js

@@ -0,0 +1,22 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReleaseStage = exports.AuthorType = exports.HostingType = void 0;
+var HostingType;
+(function (HostingType) {
+    HostingType["OnPrem"] = "on-prem";
+    HostingType["Cloud"] = "cloud";
+})(HostingType = exports.HostingType || (exports.HostingType = {}));
+var AuthorType;
+(function (AuthorType) {
+    AuthorType["Mattermost"] = "mattermost";
+    AuthorType["Partner"] = "partner";
+    AuthorType["Community"] = "community";
+})(AuthorType = exports.AuthorType || (exports.AuthorType = {}));
+var ReleaseStage;
+(function (ReleaseStage) {
+    ReleaseStage["Production"] = "production";
+    ReleaseStage["Beta"] = "beta";
+    ReleaseStage["Experimental"] = "experimental";
+})(ReleaseStage = exports.ReleaseStage || (exports.ReleaseStage = {}));

package/lib/posts.d.ts

@@ -0,0 +1,126 @@
+import { ChannelType } from './channels';
+import { CustomEmoji } from './emojis';
+import { FileInfo } from './files';
+import { Reaction } from './reactions';
+import { RelationOneToOne, RelationOneToMany, IDMappedObjects } 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' | 'system_combined_user_activity';
+export declare type PostEmbedType = 'image' | 'link' | 'message_attachment' | 'opengraph' | 'permalink';
+export declare type PostEmbed = {
+    type: PostEmbedType;
+    url: string;
+    data?: OpenGraphMetadata | PostPreviewMetadata;
+};
+export declare type PostImage = {
+    format: string;
+    frameCount: number;
+    height: number;
+    width: number;
+};
+export declare type PostMetadata = {
+    embeds: PostEmbed[];
+    emojis: CustomEmoji[];
+    files: FileInfo[];
+    images: Record<string, 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;
+    original_id: string;
+    message: string;
+    type: PostType;
+    props: Record<string, any>;
+    hashtags: string;
+    pending_post_id: string;
+    reply_count: number;
+    file_ids?: string[];
+    metadata: PostMetadata;
+    failed?: boolean;
+    user_activity_posts?: Post[];
+    state?: 'DELETED';
+    filenames?: string[];
+    last_reply_at?: number;
+    participants?: any;
+    message_source?: string;
+    is_following?: boolean;
+    exists?: boolean;
+};
+export declare type UserActivityPost = Post & {
+    system_post_ids: string[];
+    user_activity_posts: Post[];
+};
+export declare type PostList = {
+    order: Array<Post['id']>;
+    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 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[];
+    selectedPostId: string;
+    currentFocusedPostId: string;
+    messagesHistory: MessageHistory;
+    expandedURLs: Record<string, 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[];
+};
+export declare type PostPreviewMetadata = {
+    post_id: string;
+    post?: Post;
+    channel_display_name: string;
+    team_name: string;
+    channel_type: ChannelType;
+    channel_id: string;
+};

package/lib/posts.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/preferences.d.ts

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

package/lib/preferences.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/product_notices.d.ts

@@ -0,0 +1,26 @@
+export declare enum Action {
+    URL = "url"
+}
+export declare 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 declare type ProductNotices = ProductNotice[];

package/lib/product_notices.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Action = void 0;
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+var Action;
+(function (Action) {
+    Action["URL"] = "url";
+})(Action = exports.Action || (exports.Action = {}));

package/lib/reactions.d.ts

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

package/lib/reactions.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/requests.d.ts

@@ -0,0 +1,102 @@
+export declare type RequestStatusOption = 'not_started' | 'started' | 'success' | 'failure' | 'cancelled';
+export declare type RequestStatusType = {
+    status: RequestStatusOption;
+    error: null | Record<string, any>;
+};
+export declare type ChannelsRequestsStatuses = {
+    getChannels: RequestStatusType;
+    getAllChannels: RequestStatusType;
+    myChannels: RequestStatusType;
+    createChannel: RequestStatusType;
+    updateChannel: RequestStatusType;
+};
+export declare type GeneralRequestsStatuses = {
+    websocket: RequestStatusType;
+};
+export declare type PostsRequestsStatuses = {
+    createPost: RequestStatusType;
+    editPost: RequestStatusType;
+    getPostThread: RequestStatusType;
+};
+export declare type ThreadsRequestStatuses = {
+    getThreads: RequestStatusType;
+};
+export declare type TeamsRequestsStatuses = {
+    getMyTeams: RequestStatusType;
+    getTeams: RequestStatusType;
+    joinTeam: RequestStatusType;
+};
+export declare type UsersRequestsStatuses = {
+    checkMfa: RequestStatusType;
+    login: RequestStatusType;
+    logout: RequestStatusType;
+    autocompleteUsers: RequestStatusType;
+    updateMe: RequestStatusType;
+};
+export declare type AdminRequestsStatuses = {
+    getLogs: RequestStatusType;
+    getAudits: RequestStatusType;
+    getConfig: RequestStatusType;
+    updateConfig: RequestStatusType;
+    reloadConfig: RequestStatusType;
+    testEmail: RequestStatusType;
+    testSiteURL: RequestStatusType;
+    invalidateCaches: RequestStatusType;
+    recycleDatabase: RequestStatusType;
+    createCompliance: RequestStatusType;
+    getCompliance: RequestStatusType;
+    testS3Connection: RequestStatusType;
+    getLdapGroups: RequestStatusType;
+    linkLdapGroup: RequestStatusType;
+    unlinkLdapGroup: RequestStatusType;
+    deleteBrandImage: RequestStatusType;
+    disablePlugin: RequestStatusType;
+    enablePlugin: RequestStatusType;
+    getAnalytics: RequestStatusType;
+    getClusterStatus: RequestStatusType;
+    getEnvironmentConfig: RequestStatusType;
+    getPluginStatuses: RequestStatusType;
+    getPlugins: RequestStatusType;
+    getSamlCertificateStatus: RequestStatusType;
+    installPluginFromUrl: RequestStatusType;
+    purgeElasticsearchIndexes: RequestStatusType;
+    removeIdpSamlCertificate: RequestStatusType;
+    removeLicense: RequestStatusType;
+    removePlugin: RequestStatusType;
+    removePrivateSamlCertificate: RequestStatusType;
+    removePublicSamlCertificate: RequestStatusType;
+    syncLdap: RequestStatusType;
+    testElasticsearch: RequestStatusType;
+    testLdap: RequestStatusType;
+    uploadBrandImage: RequestStatusType;
+    uploadIdpSamlCertificate: RequestStatusType;
+    uploadLicense: RequestStatusType;
+    uploadPlugin: RequestStatusType;
+    uploadPrivateSamlCertificate: RequestStatusType;
+    uploadPublicSamlCertificate: RequestStatusType;
+};
+export declare type EmojisRequestsStatuses = {
+    createCustomEmoji: RequestStatusType;
+    getCustomEmojis: RequestStatusType;
+    deleteCustomEmoji: RequestStatusType;
+    getCustomEmoji: RequestStatusType;
+};
+export declare type FilesRequestsStatuses = {
+    uploadFiles: RequestStatusType;
+};
+export declare type RolesRequestsStatuses = {
+    getRolesByNames: RequestStatusType;
+    getRoleByName: RequestStatusType;
+    getRole: RequestStatusType;
+    editRole: RequestStatusType;
+};
+export declare type JobsRequestsStatuses = {
+    createJob: RequestStatusType;
+    getJob: RequestStatusType;
+    getJobs: RequestStatusType;
+    cancelJob: RequestStatusType;
+};
+export declare type SearchRequestsStatuses = {
+    flaggedPosts: RequestStatusType;
+    pinnedPosts: RequestStatusType;
+};

package/lib/requests.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/roles.d.ts

@@ -0,0 +1,13 @@
+export declare type ChannelModerationRoles = 'members' | 'guests';
+export declare 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/roles.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/saml.d.ts

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

package/lib/saml.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/schemes.d.ts

@@ -0,0 +1,29 @@
+export declare type SchemeScope = 'team' | 'channel';
+export declare 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 declare type SchemesState = {
+    schemes: {
+        [x: string]: Scheme;
+    };
+};
+export declare type SchemePatch = {
+    name?: string;
+    description?: string;
+};

package/lib/schemes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/search.d.ts

@@ -0,0 +1,27 @@
+export declare type Search = {
+    terms: string;
+    isOrSearch: boolean;
+};
+export declare type SearchState = {
+    current: any;
+    results: string[];
+    fileResults: string[];
+    flagged: string[];
+    pinned: Record<string, string[]>;
+    isSearchingTerm: boolean;
+    isSearchGettingMore: boolean;
+    recent: {
+        [x: string]: Search[];
+    };
+    matches: {
+        [x: string]: string[];
+    };
+};
+export declare type SearchParameter = {
+    terms: string;
+    is_or_search: boolean;
+    time_zone_offset?: number;
+    page: number;
+    per_page: number;
+    include_deleted_channels: boolean;
+};

package/lib/search.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/sessions.d.ts

@@ -0,0 +1,15 @@
+import { TeamMembership } from './teams';
+export declare type Session = {
+    id: string;
+    token: string;
+    create_at: number;
+    expires_at: number;
+    last_activity_at: number;
+    user_id: string;
+    device_id: string;
+    roles: string;
+    is_oauth: boolean;
+    props: Record<string, any>;
+    team_members: TeamMembership[];
+    local: boolean;
+};

package/lib/sessions.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/setup.d.ts

@@ -0,0 +1,3 @@
+export declare type CompleteOnboardingRequest = {
+    install_plugins: string[];
+};

package/lib/setup.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/store.d.ts

@@ -0,0 +1,76 @@
+import { AdminState } from './admin';
+import { Bot } from './bots';
+import { ChannelsState } from './channels';
+import { ChannelCategoriesState } from './channel_categories';
+import { CloudState } from './cloud';
+import { EmojisState } from './emojis';
+import { FilesState } from './files';
+import { GeneralState } from './general';
+import { GroupsState } from './groups';
+import { IntegrationsState } from './integrations';
+import { JobsState } from './jobs';
+import { PostsState } from './posts';
+import { PreferenceType } from './preferences';
+import { AdminRequestsStatuses, ChannelsRequestsStatuses, FilesRequestsStatuses, GeneralRequestsStatuses, JobsRequestsStatuses, PostsRequestsStatuses, RolesRequestsStatuses, TeamsRequestsStatuses, UsersRequestsStatuses } from './requests';
+import { Role } from './roles';
+import { SchemesState } from './schemes';
+import { SearchState } from './search';
+import { TeamsState } from './teams';
+import { ThreadsState } from './threads';
+import { Typing } from './typing';
+import { UsersState } from './users';
+import { AppsState } from './apps';
+export declare type GlobalState = {
+    entities: {
+        general: GeneralState;
+        users: UsersState;
+        teams: TeamsState;
+        channels: ChannelsState;
+        posts: PostsState;
+        threads: ThreadsState;
+        bots: {
+            accounts: Record<string, Bot>;
+        };
+        preferences: {
+            myPreferences: {
+                [x: string]: PreferenceType;
+            };
+        };
+        admin: AdminState;
+        jobs: JobsState;
+        search: SearchState;
+        integrations: IntegrationsState;
+        files: FilesState;
+        emojis: EmojisState;
+        typing: Typing;
+        roles: {
+            roles: {
+                [x: string]: Role;
+            };
+            pending: Set<string>;
+        };
+        schemes: SchemesState;
+        gifs: any;
+        groups: GroupsState;
+        channelCategories: ChannelCategoriesState;
+        apps: AppsState;
+        cloud: CloudState;
+    };
+    errors: any[];
+    requests: {
+        channels: ChannelsRequestsStatuses;
+        general: GeneralRequestsStatuses;
+        posts: PostsRequestsStatuses;
+        teams: TeamsRequestsStatuses;
+        users: UsersRequestsStatuses;
+        admin: AdminRequestsStatuses;
+        files: FilesRequestsStatuses;
+        roles: RolesRequestsStatuses;
+        jobs: JobsRequestsStatuses;
+    };
+    websocket: {
+        connected: boolean;
+        lastConnectAt: number;
+        lastDisconnectAt: number;
+    };
+};

package/lib/store.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });