@mattermost/types 9.4.0 → 9.6.0

package/lib/admin.d.ts

@@ -34,6 +34,12 @@ export type LogFilter = {
     dateFrom: LogDateFrom;
     dateTo: LogDateTo;
 };
+export type LogFilterQuery = {
+    server_names: LogServerNames;
+    log_levels: LogLevels;
+    date_from: LogDateFrom;
+    date_to: LogDateTo;
+};
 export type AdminState = {
     logs: LogObject[];
     plainLogs: string[];

package/lib/cloud.d.ts

@@ -45,6 +45,7 @@ export type Subscription = {
     billing_type?: string;
     cancel_at?: number;
     will_renew?: string;
+    simulated_current_time_ms?: number;
 };
 export type Product = {
     id: string;
@@ -158,6 +159,8 @@ export type InvoiceLineItem = {
     description: string;
     type: typeof InvoiceLineItemType[keyof typeof InvoiceLineItemType];
     metadata: Record<string, string>;
+    period_start: number;
+    period_end: number;
 };
 export type Limits = {
     messages?: {

package/lib/config.d.ts

@@ -28,8 +28,8 @@ export type ClientConfig = {
     CWSMock: string;
     DataRetentionEnableFileDeletion: string;
     DataRetentionEnableMessageDeletion: string;
-    DataRetentionFileRetentionDays: string;
-    DataRetentionMessageRetentionDays: string;
+    DataRetentionFileRetentionHours: string;
+    DataRetentionMessageRetentionHours: string;
     DefaultClientLocale: string;
     DefaultTheme: string;
     DiagnosticId: string;
@@ -52,6 +52,7 @@ export type ClientConfig = {
     EnableCustomEmoji: string;
     EnableCustomGroups: string;
     EnableCustomUserStatuses: string;
+    EnableUserStatuses: string;
     EnableLastActiveTime: string;
     EnableTimedDND: string;
     EnableCustomTermsOfService: string;
@@ -76,6 +77,7 @@ export type ClientConfig = {
     EnableMobileFileUpload: string;
     EnableMultifactorAuthentication: string;
     EnableOAuthServiceProvider: string;
+    EnableOutgoingOAuthConnections: string;
     EnableOpenServer: string;
     EnableOutgoingWebhooks: string;
     EnablePostIconOverride: string;
@@ -194,6 +196,12 @@ export type ClientConfig = {
     PersistentNotificationIntervalMinutes: string;
     AllowPersistentNotificationsForGuests: string;
     DelayChannelAutocomplete: 'true' | 'false';
+    WranglerPermittedWranglerRoles: string;
+    WranglerAllowedEmailDomain: string;
+    WranglerMoveThreadMaxCount: string;
+    WranglerMoveThreadFromPrivateChannelEnable: string;
+    WranglerMoveThreadFromDirectMessageChannelEnable: string;
+    WranglerMoveThreadFromGroupMessageChannelEnable: string;
     ServiceEnvironment: string;
     UniqueEmojiReactionLimitPerPost: string;
 };
@@ -285,6 +293,7 @@ export type ServiceSettings = {
     EnableIncomingWebhooks: boolean;
     EnableOutgoingWebhooks: boolean;
     EnableCommands: boolean;
+    OutgoingIntegrationRequestsTimeout: number;
     EnablePostUsernameOverride: boolean;
     EnablePostIconOverride: boolean;
     EnableLinkPreviews: boolean;
@@ -369,6 +378,7 @@ export type ServiceSettings = {
     PersistentNotificationMaxRecipients: number;
     UniqueEmojiReactionLimitPerPost: number;
     RefreshPostStatsRunTime: string;
+    MaximumPayloadSizeBytes: number;
 };
 export type TeamSettings = {
     SiteName: string;
@@ -433,6 +443,7 @@ export type LogSettings = {
     EnableSentry: boolean;
     AdvancedLoggingConfig: string;
     AdvancedLoggingJSON: Record<string, any>;
+    MaxFieldSize: number;
 };
 export type ExperimentalAuditSettings = {
     FileEnabled: boolean;
@@ -465,6 +476,15 @@ export type PasswordSettings = {
     Symbol: boolean;
     EnableForgotLink: boolean;
 };
+export type WranglerSettings = {
+    PermittedWranglerRoles: string[];
+    AllowedEmailDomain: string[];
+    MoveThreadMaxCount: number;
+    MoveThreadToAnotherTeamEnable: boolean;
+    MoveThreadFromPrivateChannelEnable: boolean;
+    MoveThreadFromDirectMessageChannelEnable: boolean;
+    MoveThreadFromGroupMessageChannelEnable: boolean;
+};
 export type FileSettings = {
     EnableFileAttachments: boolean;
     EnableMobileUpload: boolean;
@@ -771,7 +791,9 @@ export type DataRetentionSettings = {
     EnableMessageDeletion: boolean;
     EnableFileDeletion: boolean;
     MessageRetentionDays: number;
+    MessageRetentionHours: number;
     FileRetentionDays: number;
+    FileRetentionHours: number;
     DeletionJobStartTime: string;
     BatchSize: number;
     EnableBoardsDeletion: boolean;
@@ -896,6 +918,7 @@ export type AdminConfig = {
     FeatureFlags: FeatureFlags;
     ImportSettings: ImportSettings;
     ExportSettings: ExportSettings;
+    WranglerSettings: WranglerSettings;
 };
 export type ReplicaLagSetting = {
     DataSource: string;

package/lib/general.d.ts

@@ -1,12 +1,10 @@
-import { ClientConfig, ClientLicense, WarnMetricStatus } from './config';
+import { ClientConfig, ClientLicense } from './config';
 export type GeneralState = {
     config: Partial<ClientConfig>;
-    dataRetentionPolicy: any;
     firstAdminVisitMarketplaceStatus: boolean;
     firstAdminCompleteSetup: boolean;
     license: ClientLicense;
     serverVersion: string;
-    warnMetricsStatus: Record<string, WarnMetricStatus>;
 };
 export type SystemSetting = {
     name: string;

package/lib/integrations.d.ts

@@ -92,10 +92,25 @@ export type OAuthApp = {
     '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>;
     outgoingHooks: IDMappedObjects<OutgoingWebhook>;
     oauthApps: IDMappedObjects<OAuthApp>;
+    outgoingOAuthConnections: IDMappedObjects<OutgoingOAuthConnection>;
     appsOAuthAppIDs: string[];
     appsBotIDs: string[];
     systemCommands: IDMappedObjects<Command>;

package/lib/limits.d.ts

@@ -0,0 +1,7 @@
+export type LimitsState = {
+    usersLimits: UsersLimits;
+};
+export type UsersLimits = {
+    activeUserCount: number;
+    maxUsersLimit: number;
+};

package/lib/limits.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/plugins.d.ts

@@ -1,3 +1,7 @@
+type MessageDescriptor = {
+    id: string;
+    defaultMessage: string;
+};
 export type PluginManifest = {
     id: string;
     name: string;
@@ -38,7 +42,7 @@ export type PluginSetting = {
     key: string;
     display_name: string;
     type: string;
-    help_text: string;
+    help_text: string | MessageDescriptor;
     regenerate_help_text?: string;
     placeholder: string;
     default: any;

package/lib/posts.d.ts

@@ -5,7 +5,7 @@ import { Reaction } from './reactions';
 import { TeamType } from './teams';
 import { UserProfile } from './users';
 import { RelationOneToOne, RelationOneToMany, IDMappedObjects } from './utilities';
-export 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' | 'system_generic' | 'reminder' | '';
+export 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' | 'system_generic' | 'reminder' | 'system_wrangler' | '';
 export type PostEmbedType = 'image' | 'link' | 'message_attachment' | 'opengraph' | 'permalink';
 export type PostEmbed = {
     type: PostEmbedType;
@@ -106,7 +106,6 @@ export type PostsState = {
     reactions: RelationOneToOne<Post, Record<string, Reaction>>;
     openGraph: RelationOneToOne<Post, Record<string, OpenGraphMetadata>>;
     pendingPostIds: string[];
-    selectedPostId: string;
     postEditHistory: Post[];
     currentFocusedPostId: string;
     messagesHistory: MessageHistory;

package/lib/reports.d.ts

@@ -0,0 +1,65 @@
+import { UserProfile } from './users';
+export declare enum UserReportSortColumns {
+    username = "Username",
+    email = "Email",
+    createAt = "CreateAt",
+    firstName = "FirstName",
+    lastName = "LastName",
+    nickname = "Nickname"
+}
+export declare enum ReportSortDirection {
+    ascending = "asc",
+    descending = "desc"
+}
+export declare enum ReportDuration {
+    AllTime = "all_time",
+    Last30Days = "last_30_days",
+    PreviousMonth = "previous_month",
+    Last6Months = "last_6_months"
+}
+export declare enum CursorPaginationDirection {
+    'prev' = "prev",
+    'next' = "next"
+}
+export type UserReportFilter = {
+    role_filter?: string;
+    has_no_team?: boolean;
+    team_filter?: string;
+    hide_active?: boolean;
+    hide_inactive?: boolean;
+    search_term?: string;
+};
+export type UserReportOptions = UserReportFilter & {
+    page_size?: number;
+    /**
+     * The column to sort on. Provide the id of the column. Use the UserReportSortColumns enum.
+     */
+    sort_column?: UserReportSortColumns;
+    /**
+     * The sort direction to use. Either "asc" or "desc". Use the ReportSortDirection enum.
+     */
+    sort_direction?: ReportSortDirection;
+    /**
+     * The direction to paginate in. Either "up" or "down". Use the CursorPaginationDirection enum.
+     */
+    direction?: CursorPaginationDirection;
+    /**
+     * The cursor to paginate from.
+     */
+    from_column_value?: string;
+    /**
+     * The id of the user to paginate from.
+     */
+    from_id?: string;
+    /**
+     * The duration to filter by. Use the ReportDuration enum.
+     */
+    date_range?: ReportDuration;
+};
+export type UserReport = UserProfile & {
+    last_login_at: number;
+    last_status_at?: number;
+    last_post_date?: number;
+    days_active?: number;
+    total_posts?: number;
+};

package/lib/reports.js

@@ -0,0 +1,31 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CursorPaginationDirection = exports.ReportDuration = exports.ReportSortDirection = exports.UserReportSortColumns = void 0;
+var UserReportSortColumns;
+(function (UserReportSortColumns) {
+    UserReportSortColumns["username"] = "Username";
+    UserReportSortColumns["email"] = "Email";
+    UserReportSortColumns["createAt"] = "CreateAt";
+    UserReportSortColumns["firstName"] = "FirstName";
+    UserReportSortColumns["lastName"] = "LastName";
+    UserReportSortColumns["nickname"] = "Nickname";
+})(UserReportSortColumns = exports.UserReportSortColumns || (exports.UserReportSortColumns = {}));
+var ReportSortDirection;
+(function (ReportSortDirection) {
+    ReportSortDirection["ascending"] = "asc";
+    ReportSortDirection["descending"] = "desc";
+})(ReportSortDirection = exports.ReportSortDirection || (exports.ReportSortDirection = {}));
+var ReportDuration;
+(function (ReportDuration) {
+    ReportDuration["AllTime"] = "all_time";
+    ReportDuration["Last30Days"] = "last_30_days";
+    ReportDuration["PreviousMonth"] = "previous_month";
+    ReportDuration["Last6Months"] = "last_6_months";
+})(ReportDuration = exports.ReportDuration || (exports.ReportDuration = {}));
+var CursorPaginationDirection;
+(function (CursorPaginationDirection) {
+    CursorPaginationDirection["prev"] = "prev";
+    CursorPaginationDirection["next"] = "next";
+})(CursorPaginationDirection = exports.CursorPaginationDirection || (exports.CursorPaginationDirection = {}));

package/lib/requests.d.ts

@@ -8,7 +8,6 @@ export type ChannelsRequestsStatuses = {
     getAllChannels: RequestStatusType;
     myChannels: RequestStatusType;
     createChannel: RequestStatusType;
-    updateChannel: RequestStatusType;
 };
 export type GeneralRequestsStatuses = {
     websocket: RequestStatusType;
@@ -24,7 +23,6 @@ export type ThreadsRequestStatuses = {
 export type TeamsRequestsStatuses = {
     getMyTeams: RequestStatusType;
     getTeams: RequestStatusType;
-    joinTeam: RequestStatusType;
 };
 export type UsersRequestsStatuses = {
     login: RequestStatusType;

package/lib/search.d.ts

@@ -11,9 +11,6 @@ export type SearchState = {
     isSearchingTerm: boolean;
     isSearchGettingMore: boolean;
     isLimitedResults: number;
-    recent: {
-        [x: string]: Search[];
-    };
     matches: {
         [x: string]: string[];
     };

package/lib/store.d.ts

@@ -21,10 +21,12 @@ import { ThreadsState } from './threads';
 import { Typing } from './typing';
 import { UsersState } from './users';
 import { AppsState } from './apps';
+import { LimitsState } from './limits';
 export type GlobalState = {
     entities: {
         general: GeneralState;
         users: UsersState;
+        limits: LimitsState;
         teams: TeamsState;
         channels: ChannelsState;
         posts: PostsState;

package/lib/teams.d.ts

@@ -79,13 +79,19 @@ export type TeamStats = {
     total_member_count: number;
     active_member_count: number;
 };
-export type TeamSearchOpts = {
-    page?: number;
-    per_page?: number;
+export type TeamSearchOpts = PagedTeamSearchOpts | NotPagedTeamSearchOpts;
+export type PagedTeamSearchOpts = {
+    page: number;
+    per_page: number;
+} & NotPagedTeamSearchOpts;
+export type NotPagedTeamSearchOpts = {
     allow_open_invite?: boolean;
     group_constrained?: boolean;
 };
 export type TeamInviteWithError = {
     email: string;
-    error: ServerError;
+    error: {
+        id: string;
+        message: string;
+    };
 };

package/package.json

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