@mattermost/types 6.7.0-0

package/lib/config.js

@@ -0,0 +1,11 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollapsedThreads = void 0;
+var CollapsedThreads;
+(function (CollapsedThreads) {
+    CollapsedThreads["DISABLED"] = "disabled";
+    CollapsedThreads["DEFAULT_ON"] = "default_on";
+    CollapsedThreads["DEFAULT_OFF"] = "default_off";
+})(CollapsedThreads = exports.CollapsedThreads || (exports.CollapsedThreads = {}));

package/lib/data_retention.d.ts

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

package/lib/data_retention.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/emojis.d.ts

@@ -0,0 +1,28 @@
+export declare type EmojiCategory = 'recent' | 'searchResults' | 'smileys-emotion' | 'people-body' | 'animals-nature' | 'food-drink' | 'activities' | 'travel-places' | 'objects' | 'symbols' | 'flags' | 'custom';
+export declare type CustomEmoji = {
+    id: string;
+    name: string;
+    category: 'custom';
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    creator_id: string;
+};
+export declare type SystemEmoji = {
+    name: string;
+    category: EmojiCategory;
+    image: string;
+    short_name: string;
+    short_names: string[];
+    batch: number;
+    skins?: string[];
+    skin_variations?: Record<string, Emoji>;
+    unified: string;
+};
+export declare type Emoji = SystemEmoji | CustomEmoji;
+export declare type EmojisState = {
+    customEmoji: {
+        [x: string]: CustomEmoji;
+    };
+    nonExistentEmoji: Set<string>;
+};

package/lib/emojis.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/errors.d.ts

@@ -0,0 +1,12 @@
+export declare type ServerError = {
+    server_error_id?: string;
+    stack?: string;
+    intl?: {
+        id: string;
+        defaultMessage: string;
+        values?: any;
+    };
+    message: string;
+    status_code?: number;
+    url?: string;
+};

package/lib/errors.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/files.d.ts

@@ -0,0 +1,37 @@
+export declare type FileInfo = {
+    id: string;
+    user_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;
+};
+export declare type FilesState = {
+    files: Record<string, FileInfo>;
+    filesFromSearch: Record<string, FileSearchResultItem>;
+    fileIdsByPostId: Record<string, string[]>;
+    filePublicLink?: {
+        link: string;
+    };
+};
+export declare type FileUploadResponse = {
+    file_infos: FileInfo[];
+    client_ids: string[];
+};
+export declare type FileSearchResultItem = FileInfo & {
+    channel_id: string;
+};
+export declare type FileSearchResults = {
+    order: Array<FileSearchResultItem['id']>;
+    file_infos: Map<string, FileSearchResultItem>;
+    next_file_info_id: string;
+    prev_file_info_id: string;
+};

package/lib/files.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/general.d.ts

@@ -0,0 +1,26 @@
+import { ClientConfig, ClientLicense, WarnMetricStatus } from './config';
+export declare type GeneralState = {
+    appState: boolean;
+    credentials: any;
+    config: Partial<ClientConfig>;
+    dataRetentionPolicy: any;
+    deviceToken: string;
+    firstAdminVisitMarketplaceStatus: boolean;
+    firstAdminCompleteSetup: boolean;
+    license: ClientLicense;
+    serverVersion: string;
+    warnMetricsStatus: Record<string, WarnMetricStatus>;
+};
+export declare type SystemSetting = {
+    name: string;
+    value: string;
+};
+export declare enum LicenseSkus {
+    E10 = "E10",
+    E20 = "E20",
+    Starter = "starter",
+    Professional = "professional",
+    Enterprise = "enterprise"
+}
+export declare const isEnterpriseLicense: (license?: ClientLicense | undefined) => boolean;
+export declare const isNonEnterpriseLicense: (license?: ClientLicense | undefined) => boolean;

package/lib/general.js

@@ -0,0 +1,24 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNonEnterpriseLicense = exports.isEnterpriseLicense = exports.LicenseSkus = void 0;
+var LicenseSkus;
+(function (LicenseSkus) {
+    LicenseSkus["E10"] = "E10";
+    LicenseSkus["E20"] = "E20";
+    LicenseSkus["Starter"] = "starter";
+    LicenseSkus["Professional"] = "professional";
+    LicenseSkus["Enterprise"] = "enterprise";
+})(LicenseSkus = exports.LicenseSkus || (exports.LicenseSkus = {}));
+const isEnterpriseLicense = (license) => {
+    switch (license === null || license === void 0 ? void 0 : license.SkuShortName) {
+        case LicenseSkus.Enterprise:
+        case LicenseSkus.E20:
+            return true;
+    }
+    return false;
+};
+exports.isEnterpriseLicense = isEnterpriseLicense;
+const isNonEnterpriseLicense = (license) => !exports.isEnterpriseLicense(license);
+exports.isNonEnterpriseLicense = isNonEnterpriseLicense;

package/lib/groups.d.ts

@@ -0,0 +1,132 @@
+import { UserProfile } from './users';
+import { RelationOneToOne } from './utilities';
+export declare type SyncableType = 'team' | 'channel';
+export declare type SyncablePatch = {
+    scheme_admin: boolean;
+    auto_add: boolean;
+};
+export declare type GroupPatch = {
+    allow_reference: boolean;
+    name?: string;
+};
+export declare type CustomGroupPatch = {
+    name: string;
+    display_name: string;
+};
+export declare 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;
+};
+export declare 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 declare 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 declare type GroupSyncable = {
+    group_id: string;
+    auto_add: boolean;
+    scheme_admin: boolean;
+    create_at: number;
+    delete_at: number;
+    update_at: number;
+    type: 'Team' | 'Channel';
+};
+export declare type GroupSyncablesState = {
+    teams: GroupTeam[];
+    channels: GroupChannel[];
+};
+export declare type GroupsState = {
+    syncables: Record<string, GroupSyncablesState>;
+    stats: RelationOneToOne<Group, GroupStats>;
+    groups: Record<string, Group>;
+    myGroups: string[];
+};
+export declare type GroupStats = {
+    group_id: string;
+    total_member_count: number;
+};
+export declare type GroupSearchOpts = {
+    q: string;
+    is_linked?: boolean;
+    is_configured?: boolean;
+};
+export declare type MixedUnlinkedGroup = {
+    mattermost_group_id?: string;
+    name: string;
+    primary_key: string;
+    has_syncables?: boolean;
+};
+export declare type MixedUnlinkedGroupRedux = MixedUnlinkedGroup & {
+    failed?: boolean;
+};
+export declare type UserWithGroup = UserProfile & {
+    groups: Group[];
+    scheme_guest: boolean;
+    scheme_user: boolean;
+    scheme_admin: boolean;
+};
+export declare type GroupsWithCount = {
+    groups: Group[];
+    total_group_count: number;
+    channelID?: string;
+    teamID?: string;
+};
+export declare type UsersWithGroupsAndCount = {
+    users: UserWithGroup[];
+    total_count: number;
+};
+export declare type GroupCreateWithUserIds = {
+    name: string;
+    allow_reference: boolean;
+    display_name: string;
+    source: string;
+    user_ids: string[];
+    description?: string;
+};
+export declare type GroupSearachParams = {
+    q: string;
+    filter_allow_reference: boolean;
+    page: number;
+    per_page: number;
+    include_member_count: boolean;
+    user_id?: string;
+};
+export declare type GroupMembership = {
+    user_id: string;
+    roles: string;
+};
+export declare type GroupPermissions = {
+    can_delete: boolean;
+    can_manage_members: boolean;
+};

package/lib/groups.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/integration_actions.d.ts

@@ -0,0 +1,24 @@
+export declare type PostAction = {
+    id?: string;
+    type?: string;
+    name?: string;
+    disabled?: boolean;
+    style?: string;
+    data_source?: string;
+    options?: PostActionOption[];
+    default_option?: string;
+    integration?: PostActionIntegration;
+    cookie?: string;
+};
+export declare type PostActionOption = {
+    text: string;
+    value: string;
+};
+export declare type PostActionIntegration = {
+    url?: string;
+    context?: Record<string, any>;
+};
+export declare type PostActionResponse = {
+    status: string;
+    trigger_id: string;
+};

package/lib/integration_actions.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/integrations.d.ts

@@ -0,0 +1,150 @@
+import { MessageAttachment } from './message_attachments';
+import { IDMappedObjects } from './utilities';
+export declare 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 declare 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 declare 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 declare type CommandArgs = {
+    channel_id: string;
+    team_id?: string;
+    root_id?: string;
+};
+export declare 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 declare type AutocompleteSuggestion = {
+    Complete: string;
+    Suggestion: string;
+    Hint: string;
+    Description: string;
+    IconData: string;
+};
+export declare type CommandAutocompleteSuggestion = AutocompleteSuggestion;
+export declare 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 declare type IntegrationsState = {
+    incomingHooks: IDMappedObjects<IncomingWebhook>;
+    outgoingHooks: IDMappedObjects<OutgoingWebhook>;
+    oauthApps: IDMappedObjects<OAuthApp>;
+    appsOAuthAppIDs: string[];
+    appsBotIDs: string[];
+    systemCommands: IDMappedObjects<Command>;
+    commands: IDMappedObjects<Command>;
+};
+export declare type InteractiveDialogConfig = {
+    app_id: string;
+    trigger_id: string;
+    url: string;
+    dialog: {
+        callback_id: string;
+        title: string;
+        introduction_text: string;
+        icon_url?: string;
+        elements: DialogElement[];
+        submit_label: string;
+        notify_on_cancel: boolean;
+        state: string;
+    };
+};
+export declare type DialogSubmission = {
+    url: string;
+    callback_id: string;
+    state: string;
+    user_id: string;
+    channel_id: string;
+    team_id: string;
+    submission: {
+        [x: string]: string;
+    };
+    cancelled: boolean;
+};
+export declare 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;
+    options: Array<{
+        text: string;
+        value: any;
+    }>;
+};
+export declare type SubmitDialogResponse = {
+    error?: string;
+    errors?: Record<string, string>;
+};

package/lib/integrations.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/jobs.d.ts

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

package/lib/jobs.js

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

package/lib/marketplace.d.ts

@@ -0,0 +1,43 @@
+import { PluginManifest } from './plugins';
+import { AppManifest } from './apps';
+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"
+}
+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/marketplace.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/message_attachments.d.ts

@@ -0,0 +1,25 @@
+import { PostAction } from './integration_actions';
+export declare type MessageAttachment = {
+    id: number;
+    fallback: string;
+    color: string;
+    pretext: string;
+    author_name: string;
+    author_link: string;
+    author_icon: string;
+    title: string;
+    title_link: string;
+    text: string;
+    fields: MessageAttachmentField[];
+    image_url: string;
+    thumb_url: string;
+    footer: string;
+    footer_icon: string;
+    timestamp: number | string;
+    actions?: PostAction[];
+};
+export declare type MessageAttachmentField = {
+    title: string;
+    value: any;
+    short: boolean;
+};

package/lib/message_attachments.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/mfa.d.ts

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

package/lib/mfa.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 });