@mattermost/types 7.0.0 → 7.3.0

package/README.md

@@ -2,8 +2,6 @@
 
 This package contains shared type definitions used by [the Mattermost web app](https://github.com/mattermost/mattermost-webapp) and related projects.
 
-**It is currently a work in progress and contains internal types that will be removed in a followup release.**
-
 ## Usage
 
 For technologies that support [subpath exports](https://nodejs.org/api/packages.html#subpath-exports), such as Node.js, Webpack, and Babel, you can import these types directly from individual files.

package/lib/boards.d.ts

@@ -0,0 +1,6 @@
+export declare type BoardsUsageResponse = {
+    cards: number;
+    views: number;
+    used_cards: number;
+    card_limit_timestamp: number;
+};

package/lib/boards.js

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

package/lib/channels.d.ts

@@ -1,6 +1,6 @@
 import { IDMappedObjects, RelationOneToMany, RelationOneToOne } from './utilities';
 import { Team } from './teams';
-export declare type ChannelType = 'O' | 'P' | 'D' | 'G';
+export declare type ChannelType = 'O' | 'P' | 'D' | 'G' | 'threads';
 export declare type ChannelStats = {
     channel_id: string;
     member_count: number;
@@ -159,6 +159,7 @@ export declare type ChannelSearchOpts = {
     public?: boolean;
     private?: boolean;
     include_deleted?: boolean;
+    include_search_by_id?: boolean;
     deleted?: boolean;
     page?: number;
     per_page?: number;

package/lib/client4.d.ts

@@ -21,3 +21,13 @@ export declare type Options = {
 export declare type StatusOK = {
     status: 'OK';
 };
+export declare type FetchPaginatedThreadOptions = {
+    fetchThreads?: boolean;
+    collapsedThreads?: boolean;
+    collapsedThreadsExtended?: boolean;
+    direction?: 'up' | 'down';
+    fetchAll?: boolean;
+    perPage?: number;
+    fromCreateAt?: number;
+    fromPost?: string;
+};

package/lib/cloud.d.ts

@@ -8,7 +8,13 @@ export declare type CloudState = {
         limits: Limits;
     };
 };
-export declare type Subscription = {
+export declare type Subscription = SubscriptionBase & {
+    is_legacy_cloud_paid_tier?: boolean;
+};
+export declare type SubscriptionResponse = SubscriptionBase & {
+    is_paid_tier: string;
+};
+declare type SubscriptionBase = {
     id: string;
     customer_id: string;
     product_id: string;
@@ -17,10 +23,10 @@ export declare type Subscription = {
     end_at: number;
     create_at: number;
     seats: number;
-    is_paid_tier: string;
     last_invoice?: Invoice;
     trial_end_at: number;
     is_free_trial: string;
+    delinquent_since?: number;
 };
 export declare type Product = {
     id: string;
@@ -75,6 +81,9 @@ export declare type PaymentMethod = {
     card_brand: string;
     name: string;
 };
+export declare type NotifyAdminRequest = {
+    current_team_id: string;
+};
 export declare type Invoice = {
     id: string;
     number: string;
@@ -122,3 +131,32 @@ export declare type Limits = {
         views?: number;
     };
 };
+export interface CloudUsage {
+    files: {
+        totalStorage: number;
+        totalStorageLoaded: boolean;
+    };
+    messages: {
+        history: number;
+        historyLoaded: boolean;
+    };
+    boards: {
+        cards: number;
+        cardsLoaded: boolean;
+    };
+    teams: TeamsUsage;
+    integrations: IntegrationsUsage;
+}
+export interface IntegrationsUsage {
+    enabled: number;
+    enabledLoaded: boolean;
+}
+export declare type TeamsUsage = {
+    active: number;
+    cloudArchived: number;
+    teamsLoaded: boolean;
+};
+export declare type ValidBusinessEmail = {
+    is_valid: boolean;
+};
+export {};

package/lib/config.d.ts

@@ -103,7 +103,6 @@ export declare type ClientConfig = {
     ExperimentalDataPrefetch: string;
     ExperimentalEnableAuthenticationTransfer: string;
     ExperimentalEnableAutomaticReplies: string;
-    ExperimentalEnableClickToReply: string;
     ExperimentalEnableDefaultChannelLeaveJoinMessages: string;
     ExperimentalEnablePostMetadata: string;
     ExperimentalGroupUnreadChannels: string;
@@ -111,6 +110,8 @@ export declare type ClientConfig = {
     ExperimentalTimezone: string;
     ExperimentalViewArchivedChannels: string;
     FileLevel: string;
+    FeatureFlagGraphQL: string;
+    FeatureFlagPlanUpgradeButtonText: string;
     GfycatAPIKey: string;
     GfycatAPISecret: string;
     GoogleDeveloperKey: string;
@@ -120,6 +121,7 @@ export declare type ClientConfig = {
     IosAppDownloadLink: string;
     IosLatestVersion: string;
     IosMinVersion: string;
+    InsightsEnabled: string;
     InstallationDate: string;
     IsDefaultMarketplace: string;
     LdapFirstNameAttributeSet: string;
@@ -180,6 +182,7 @@ export declare type ClientConfig = {
     WebsocketURL: string;
     ExperimentalSharedChannels: string;
     EnableAppBar: string;
+    EnableComplianceExport: string;
 };
 export declare type License = {
     id: string;
@@ -629,7 +632,6 @@ export declare type MetricsSettings = {
 export declare type ExperimentalSettings = {
     ClientSideCertEnable: boolean;
     ClientSideCertCheck: string;
-    EnableClickToReply: boolean;
     LinkMetadataTimeoutMilliseconds: number;
     RestrictSystemAdmin: boolean;
     UseNewSAMLLibrary: boolean;

package/lib/emojis.d.ts

@@ -16,9 +16,21 @@ export declare type SystemEmoji = {
     short_names: string[];
     batch: number;
     skins?: string[];
-    skin_variations?: Record<string, Emoji>;
+    skin_variations?: Record<string, SystemEmojiVariation>;
     unified: string;
 };
+export declare 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 declare type Emoji = SystemEmoji | CustomEmoji;
 export declare type EmojisState = {
     customEmoji: {
@@ -26,3 +38,7 @@ export declare type EmojisState = {
     };
     nonExistentEmoji: Set<string>;
 };
+export declare type RecentEmojiData = {
+    name: string;
+    usageCount: number;
+};

package/lib/errors.d.ts

@@ -1,11 +1,6 @@
 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/files.d.ts

@@ -14,6 +14,7 @@ export declare type FileInfo = {
     clientId: string;
     post_id?: string;
     mini_preview?: string;
+    archived: boolean;
 };
 export declare type FilesState = {
     files: Record<string, FileInfo>;

package/lib/general.d.ts

@@ -1,10 +1,7 @@
 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;

package/lib/insights.d.ts

@@ -1,6 +1,14 @@
+import { ChannelType } from './channels';
+import { Post } from './posts';
 export declare enum InsightsWidgetTypes {
     TOP_CHANNELS = "TOP_CHANNELS",
-    TOP_REACTIONS = "TOP_REACTIONS"
+    TOP_REACTIONS = "TOP_REACTIONS",
+    TOP_THREADS = "TOP_THREADS",
+    TOP_BOARDS = "TOP_BOARDS",
+    LEAST_ACTIVE_CHANNELS = "LEAST_ACTIVE_CHANNELS",
+    TOP_PLAYBOOKS = "TOP_PLAYBOOKS",
+    TOP_DMS = "TOP_DMS",
+    NEW_TEAM_MEMBERS = "NEW_TEAM_MEMBERS"
 }
 export declare enum CardSizes {
     large = "lg",
@@ -23,7 +31,121 @@ export declare type TopReactionResponse = {
     items: TopReaction[];
     timeFrame?: TimeFrame;
 };
+export declare type TopChannel = {
+    id: string;
+    type: ChannelType;
+    display_name: string;
+    name: string;
+    team_id: string;
+    message_count: number;
+};
+export declare type TopChannelGraphData = Record<string, Record<string, number>>;
+export declare type TopChannelResponse = {
+    has_next: boolean;
+    items: TopChannel[];
+    daily_channel_post_counts: TopChannelGraphData;
+};
 export declare type InsightsState = {
     topReactions: Record<string, Record<TimeFrame, Record<string, TopReaction>>>;
     myTopReactions: Record<string, Record<TimeFrame, Record<string, TopReaction>>>;
 };
+export declare type TopChannelActionResult = {
+    data?: TopChannelResponse;
+    error?: any;
+};
+export declare type TopThread = {
+    channel_id: string;
+    channel_display_name: string;
+    channel_name: string;
+    participants: string[];
+    user_information: {
+        id: string;
+        first_name: string;
+        last_name: string;
+        last_picture_update: number;
+    };
+    post: Post;
+};
+export declare type TopThreadResponse = {
+    has_next: boolean;
+    items: TopThread[];
+};
+export declare type TopThreadActionResult = {
+    data?: TopThreadResponse;
+    error?: any;
+};
+export declare type TopBoard = {
+    boardID: string;
+    icon: string;
+    title: string;
+    activityCount: number;
+    activeUsers: string;
+    createdBy: string;
+};
+export declare type TopBoardResponse = {
+    has_next: boolean;
+    items: TopBoard[];
+};
+export declare type LeastActiveChannel = {
+    id: string;
+    display_name: string;
+    name: string;
+    participants: string[];
+    last_activity_at: number;
+    type: ChannelType;
+    team_id: string;
+    message_count: number;
+};
+export declare type LeastActiveChannelsResponse = {
+    has_next: boolean;
+    items: LeastActiveChannel[];
+};
+export declare type LeastActiveChannelsActionResult = {
+    data?: LeastActiveChannelsResponse;
+    error?: any;
+};
+export declare type TopPlaybook = {
+    playbook_id: string;
+    num_runs: number;
+    title: string;
+    last_run_at: number;
+};
+export declare type TopPlaybookResponse = {
+    has_next: boolean;
+    items: TopPlaybook[];
+};
+declare type MinUserProfile = {
+    id: string;
+    first_name: string;
+    last_name: string;
+    last_picture_update: number;
+    nickname: string;
+    position: string;
+    username: string;
+};
+export declare type TopDM = {
+    outgoing_message_count: number;
+    post_count: number;
+    second_participant: MinUserProfile;
+};
+export declare type TopDMsResponse = {
+    has_next: boolean;
+    items: TopDM[];
+};
+export declare type TopDMsActionResult = {
+    data?: TopDMsResponse;
+    error?: any;
+};
+export declare type NewMember = MinUserProfile & {
+    create_at: number;
+};
+export declare type NewMembersResponse = {
+    has_next: boolean;
+    items: NewMember[];
+    total_count: number;
+};
+export declare type NewMembersActionResult = {
+    data?: NewMembersResponse;
+    error?: any;
+};
+export {};

package/lib/insights.js

@@ -7,6 +7,12 @@ var InsightsWidgetTypes;
 (function (InsightsWidgetTypes) {
     InsightsWidgetTypes["TOP_CHANNELS"] = "TOP_CHANNELS";
     InsightsWidgetTypes["TOP_REACTIONS"] = "TOP_REACTIONS";
+    InsightsWidgetTypes["TOP_THREADS"] = "TOP_THREADS";
+    InsightsWidgetTypes["TOP_BOARDS"] = "TOP_BOARDS";
+    InsightsWidgetTypes["LEAST_ACTIVE_CHANNELS"] = "LEAST_ACTIVE_CHANNELS";
+    InsightsWidgetTypes["TOP_PLAYBOOKS"] = "TOP_PLAYBOOKS";
+    InsightsWidgetTypes["TOP_DMS"] = "TOP_DMS";
+    InsightsWidgetTypes["NEW_TEAM_MEMBERS"] = "NEW_TEAM_MEMBERS";
 })(InsightsWidgetTypes = exports.InsightsWidgetTypes || (exports.InsightsWidgetTypes = {}));
 var CardSizes;
 (function (CardSizes) {

package/lib/plugins.d.ts

@@ -44,6 +44,7 @@ export declare type PluginSetting = {
     placeholder: string;
     default: any;
     options?: PluginSettingOption[];
+    hosting?: 'on-prem' | 'cloud';
 };
 export declare type PluginSettingOption = {
     display_name: string;
@@ -74,6 +75,7 @@ export declare type PluginStatusRedux = {
     version: string;
     active: boolean;
     state: number;
+    error?: string;
     instances: PluginInstance[];
 };
 export declare type ClientPluginManifest = {

package/lib/posts.d.ts

@@ -1,9 +1,9 @@
-import { ChannelType } from './channels';
+import { Channel, 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 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' | '';
 export declare type PostEmbedType = 'image' | 'link' | 'message_attachment' | 'opengraph' | 'permalink';
 export declare type PostEmbed = {
     type: PostEmbedType;
@@ -54,9 +54,13 @@ export declare type Post = {
 };
 export declare type PostList = {
     order: Array<Post['id']>;
-    posts: Map<string, Post>;
+    posts: Record<string, Post>;
     next_post_id: string;
     prev_post_id: string;
+    first_inaccessible_post_time: number;
+};
+export declare type PaginatedPostList = PostList & {
+    has_next: boolean;
 };
 export declare type PostSearchResults = PostList & {
     matches: RelationOneToOne<Post, string[]>;
@@ -87,10 +91,15 @@ export declare type PostsState = {
     currentFocusedPostId: string;
     messagesHistory: MessageHistory;
     expandedURLs: Record<string, string>;
+    limitedViews: {
+        channels: Record<Channel['id'], number>;
+        threads: Record<Post['root_id'], number>;
+    };
 };
 export declare type OpenGraphMetadataImage = {
     secure_url?: string;
     url: string;
+    type?: string;
     height?: number;
     width?: number;
 };
@@ -110,3 +119,13 @@ export declare type PostPreviewMetadata = {
     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;
+};

package/lib/requests.d.ts

@@ -27,53 +27,13 @@ export declare type TeamsRequestsStatuses = {
     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;

package/lib/search.d.ts

@@ -10,6 +10,7 @@ export declare type SearchState = {
     pinned: Record<string, string[]>;
     isSearchingTerm: boolean;
     isSearchGettingMore: boolean;
+    isLimitedResults: number;
     recent: {
         [x: string]: Search[];
     };

package/lib/store.d.ts

@@ -2,7 +2,7 @@ import { AdminState } from './admin';
 import { Bot } from './bots';
 import { ChannelsState } from './channels';
 import { ChannelCategoriesState } from './channel_categories';
-import { CloudState } from './cloud';
+import { CloudState, CloudUsage } from './cloud';
 import { EmojisState } from './emojis';
 import { FilesState } from './files';
 import { GeneralState } from './general';
@@ -56,6 +56,7 @@ export declare type GlobalState = {
         channelCategories: ChannelCategoriesState;
         apps: AppsState;
         cloud: CloudState;
+        usage: CloudUsage;
         insights: InsightsState;
     };
     errors: any[];

package/lib/users.d.ts

@@ -15,6 +15,12 @@ export declare type UserNotifyProps = {
     first_name: 'true' | 'false';
     channel: 'true' | 'false';
     mention_keys: string;
+    desktop_notification_sound?: 'Bing' | 'Crackle' | 'Down' | 'Hello' | 'Ripple' | 'Upstairs';
+    desktop_threads?: 'default' | 'all' | 'mention' | 'none';
+    email_threads?: 'default' | 'all' | 'mention' | 'none';
+    push_threads?: 'default' | 'all' | 'mention' | 'none';
+    auto_responder_active?: 'true' | 'false';
+    auto_responder_message?: string;
 };
 export declare type UserProfile = {
     id: string;
@@ -23,29 +29,23 @@ export declare type UserProfile = {
     delete_at: number;
     username: string;
     password: string;
-    auth_data: string;
     auth_service: string;
     email: string;
-    email_verified: boolean;
     nickname: string;
     first_name: string;
     last_name: string;
     position: string;
     roles: string;
-    allow_marketing: boolean;
     props: Record<string, string>;
     notify_props: UserNotifyProps;
     last_password_update: number;
     last_picture_update: number;
-    failed_attempts: number;
     locale: string;
     timezone?: UserTimezone;
     mfa_active: boolean;
-    mfa_secret: string;
     last_activity_at: number;
     is_bot: boolean;
     bot_description: string;
-    bot_last_icon_update: number;
     terms_of_service_id: string;
     terms_of_service_create_at: number;
     remote_id?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mattermost/types",
-  "version": "7.0.0",
+  "version": "7.3.0",
   "description": "Shared type definitions used by the Mattermost web app",
   "keywords": [
     "mattermost"
@@ -28,7 +28,8 @@
     }
   },
   "scripts": {
-    "build": "tsc -b -v",
+    "build": "tsc --build --verbose",
+    "run": "tsc --watch --preserveWatchOutput",
     "clean": "rm -rf tsconfig.tsbuildinfo ./lib"
   }
 }