@mattermost/types 7.0.0 → 7.1.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/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,7 +23,6 @@ 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;
@@ -122,3 +127,29 @@ 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 {};

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;
@@ -120,6 +119,7 @@ export declare type ClientConfig = {
     IosAppDownloadLink: string;
     IosLatestVersion: string;
     IosMinVersion: string;
+    InsightsEnabled: string;
     InstallationDate: string;
     IsDefaultMarketplace: string;
     LdapFirstNameAttributeSet: string;
@@ -180,6 +180,7 @@ export declare type ClientConfig = {
     WebsocketURL: string;
     ExperimentalSharedChannels: string;
     EnableAppBar: string;
+    EnableComplianceExport: string;
 };
 export declare type License = {
     id: string;
@@ -629,7 +630,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/insights.d.ts

@@ -1,6 +1,10 @@
+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"
 }
 export declare enum CardSizes {
     large = "lg",
@@ -23,7 +27,59 @@ 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;
+    workspaceID: string;
+};
+export declare type TopBoardResponse = {
+    has_next: boolean;
+    items: TopBoard[];
+};

package/lib/insights.js

@@ -7,6 +7,8 @@ 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 = exports.InsightsWidgetTypes || (exports.InsightsWidgetTypes = {}));
 var CardSizes;
 (function (CardSizes) {

package/lib/posts.d.ts

@@ -54,10 +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;
 };
+export declare type PaginatedPostList = PostList & {
+    has_next: boolean;
+};
 export declare type PostSearchResults = PostList & {
     matches: RelationOneToOne<Post, string[]>;
 };
@@ -91,6 +94,7 @@ export declare type PostsState = {
 export declare type OpenGraphMetadataImage = {
     secure_url?: string;
     url: string;
+    type?: string;
     height?: number;
     width?: number;
 };
@@ -110,3 +114,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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mattermost/types",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "Shared type definitions used by the Mattermost web app",
   "keywords": [
     "mattermost"