@mattermost/types 9.3.0 → 9.4.0

package/lib/admin.d.ts

@@ -16,11 +16,11 @@ export declare enum LogLevelEnum {
     WARN = "warn",
     ERROR = "error"
 }
-export declare type LogServerNames = string[];
-export declare type LogLevels = LogLevelEnum[];
-export declare type LogDateFrom = string;
-export declare type LogDateTo = string;
-export declare type LogObject = {
+export type LogServerNames = string[];
+export type LogLevels = LogLevelEnum[];
+export type LogDateFrom = string;
+export type LogDateTo = string;
+export type LogObject = {
     caller: string;
     job_id: string;
     level: LogLevelEnum;
@@ -28,13 +28,13 @@ export declare type LogObject = {
     timestamp: string;
     worker: string;
 };
-export declare type LogFilter = {
+export type LogFilter = {
     serverNames: LogServerNames;
     logLevels: LogLevels;
     dateFrom: LogDateFrom;
     dateTo: LogDateTo;
 };
-export declare type AdminState = {
+export type AdminState = {
     logs: LogObject[];
     plainLogs: string[];
     audits: Record<string, Audit>;
@@ -56,7 +56,7 @@ export declare type AdminState = {
     dataRetentionCustomPoliciesCount: number;
     prevTrialLicense: ClientLicense;
 };
-export declare type ClusterInfo = {
+export type ClusterInfo = {
     id: string;
     version: string;
     config_hash: string;
@@ -64,20 +64,20 @@ export declare type ClusterInfo = {
     hostname: string;
     schema_version: string;
 };
-export declare type AnalyticsRow = {
+export type AnalyticsRow = {
     name: string;
     value: number;
 };
-export declare type IndexedPluginAnalyticsRow = {
+export type IndexedPluginAnalyticsRow = {
     [key: string]: PluginAnalyticsRow;
 };
-export declare type PluginAnalyticsRow = {
+export type PluginAnalyticsRow = {
     id: string;
     name: React.ReactNode;
     icon: string;
     value: number;
 };
-export declare type SchemaMigration = {
+export type SchemaMigration = {
     version: number;
     name: string;
 };

package/lib/apps.d.ts

@@ -13,7 +13,7 @@ export declare enum Locations {
     Command = "/command",
     InPost = "/in_post"
 }
-export declare type AppManifest = {
+export type AppManifest = {
     app_id: string;
     version?: string;
     homepage_url?: string;
@@ -23,23 +23,23 @@ export declare type AppManifest = {
     requested_permissions?: Permission[];
     requested_locations?: Locations[];
 };
-export declare type AppModalState = {
+export type AppModalState = {
     form: AppForm;
     call: AppCallRequest;
 };
-export declare type AppCommandFormMap = {
+export type AppCommandFormMap = {
     [location: string]: AppForm;
 };
-export declare type BindingsInfo = {
+export type BindingsInfo = {
     bindings: AppBinding[];
     forms: AppCommandFormMap;
 };
-export declare type AppsState = {
+export type AppsState = {
     main: BindingsInfo;
     rhs: BindingsInfo;
     pluginEnabled: boolean;
 };
-export declare type AppBinding = {
+export type AppBinding = {
     app_id: string;
     location?: string;
     supported_product_ids?: ProductScope;
@@ -56,23 +56,23 @@ export declare type AppBinding = {
     form?: AppForm;
     submit?: AppCall;
 };
-export declare type AppCallValues = {
+export type AppCallValues = {
     [name: string]: any;
 };
-export declare type AppCall = {
+export type AppCall = {
     path: string;
     expand?: AppExpand;
     state?: any;
 };
-export declare type AppCallRequest = AppCall & {
+export type AppCallRequest = AppCall & {
     context: AppContext;
     values?: AppCallValues;
     raw_command?: string;
     selected_field?: string;
     query?: string;
 };
-export declare type AppCallResponseType = string;
-export declare type AppCallResponse<Res = unknown> = {
+export type AppCallResponseType = string;
+export type AppCallResponse<Res = unknown> = {
     type: AppCallResponseType;
     text?: string;
     data?: Res;
@@ -82,11 +82,11 @@ export declare type AppCallResponse<Res = unknown> = {
     form?: AppForm;
     app_metadata?: AppMetadataForClient;
 };
-export declare type AppMetadataForClient = {
+export type AppMetadataForClient = {
     bot_user_id: string;
     bot_username: string;
 };
-export declare type AppContext = {
+export type AppContext = {
     app_id: string;
     location?: string;
     acting_user_id?: string;
@@ -99,11 +99,11 @@ export declare type AppContext = {
     user_agent?: string;
     track_as_submit?: boolean;
 };
-export declare type AppContextProps = {
+export type AppContextProps = {
     [name: string]: string;
 };
-export declare type AppExpandLevel = '' | 'none' | 'summary' | '+summary' | 'all' | '+all' | 'id';
-export declare type AppExpand = {
+export type AppExpandLevel = '' | 'none' | 'summary' | '+summary' | 'all' | '+all' | 'id';
+export type AppExpand = {
     app?: AppExpandLevel;
     acting_user?: AppExpandLevel;
     acting_user_access_token?: AppExpandLevel;
@@ -117,7 +117,7 @@ export declare type AppExpand = {
     user?: AppExpandLevel;
     locale?: AppExpandLevel;
 };
-export declare type AppForm = {
+export type AppForm = {
     title?: string;
     header?: string;
     footer?: string;
@@ -130,17 +130,17 @@ export declare type AppForm = {
     submit?: AppCall;
     depends_on?: string[];
 };
-export declare type AppFormValue = string | AppSelectOption | boolean | null;
-export declare type AppFormValues = {
+export type AppFormValue = string | AppSelectOption | boolean | null;
+export type AppFormValues = {
     [name: string]: AppFormValue;
 };
-export declare type AppSelectOption = {
+export type AppSelectOption = {
     label: string;
     value: string;
     icon_data?: string;
 };
-export declare type AppFieldType = string;
-export declare type AppField = {
+export type AppFieldType = string;
+export type AppField = {
     name: string;
     type: AppFieldType;
     is_required?: boolean;
@@ -159,28 +159,28 @@ export declare type AppField = {
     min_length?: number;
     max_length?: number;
 };
-export declare type AutocompleteSuggestion = {
+export type AutocompleteSuggestion = {
     suggestion: string;
     complete?: string;
     description?: string;
     hint?: string;
     iconData?: string;
 };
-export declare type AutocompleteSuggestionWithComplete = AutocompleteSuggestion & {
+export type AutocompleteSuggestionWithComplete = AutocompleteSuggestion & {
     complete: string;
 };
-export declare type AutocompleteElement = AppField;
-export declare type AutocompleteStaticSelect = AutocompleteElement & {
+export type AutocompleteElement = AppField;
+export type AutocompleteStaticSelect = AutocompleteElement & {
     options: AppSelectOption[];
 };
-export declare type AutocompleteDynamicSelect = AutocompleteElement;
-export declare type AutocompleteUserSelect = AutocompleteElement;
-export declare type AutocompleteChannelSelect = AutocompleteElement;
-export declare type FormResponseData = {
+export type AutocompleteDynamicSelect = AutocompleteElement;
+export type AutocompleteUserSelect = AutocompleteElement;
+export type AutocompleteChannelSelect = AutocompleteElement;
+export type FormResponseData = {
     errors?: {
         [field: string]: string;
     };
 };
-export declare type AppLookupResponse = {
+export type AppLookupResponse = {
     items: AppSelectOption[];
 };

package/lib/audits.d.ts

@@ -1,4 +1,4 @@
-export declare type Audit = {
+export type Audit = {
     id: string;
     create_at: number;
     user_id: string;

package/lib/autocomplete.d.ts

@@ -1,9 +1,9 @@
 import { UserProfile } from './users';
-export declare type UserAutocomplete = {
+export type UserAutocomplete = {
     users: UserProfile[];
     out_of_channel?: UserProfile[];
 };
-export declare type AutocompleteSuggestion = {
+export type AutocompleteSuggestion = {
     Complete: string;
     Suggestion: string;
     Hint: string;

package/lib/boards.d.ts

@@ -1,6 +1,6 @@
 declare const boardTypes: string[];
-declare type BoardTypes = typeof boardTypes[number];
-declare type PropertyTypeEnum = 'text' | 'number' | 'select' | 'multiSelect' | 'date' | 'person' | 'file' | 'checkbox' | 'url' | 'email' | 'phone' | 'createdTime' | 'createdBy' | 'updatedTime' | 'updatedBy' | 'unknown';
+type BoardTypes = typeof boardTypes[number];
+type PropertyTypeEnum = 'text' | 'number' | 'select' | 'multiSelect' | 'date' | 'person' | 'file' | 'checkbox' | 'url' | 'email' | 'phone' | 'createdTime' | 'createdBy' | 'updatedTime' | 'updatedBy' | 'unknown';
 interface IPropertyOption {
     id: string;
     value: string;

package/lib/bots.d.ts

@@ -1,4 +1,4 @@
-export declare type Bot = {
+export type Bot = {
     user_id: string;
     username: string;
     display_name?: string;
@@ -8,7 +8,7 @@ export declare type Bot = {
     update_at: number;
     delete_at: number;
 };
-export declare type BotPatch = {
+export type BotPatch = {
     username: string;
     display_name: string;
     description: string;

package/lib/channel_categories.d.ts

@@ -2,14 +2,14 @@ import { Channel } from './channels';
 import { Team } from './teams';
 import { UserProfile } from './users';
 import { IDMappedObjects, RelationOneToOne } from './utilities';
-export declare type ChannelCategoryType = 'favorites' | 'channels' | 'direct_messages' | 'custom';
+export type ChannelCategoryType = 'favorites' | 'channels' | 'direct_messages' | 'custom';
 export declare enum CategorySorting {
     Alphabetical = "alpha",
     Default = "",
     Recency = "recent",
     Manual = "manual"
 }
-export declare type ChannelCategory = {
+export type ChannelCategory = {
     id: string;
     user_id: UserProfile['id'];
     team_id: Team['id'];
@@ -20,11 +20,11 @@ export declare type ChannelCategory = {
     muted: boolean;
     collapsed: boolean;
 };
-export declare type OrderedChannelCategories = {
+export type OrderedChannelCategories = {
     categories: ChannelCategory[];
     order: string[];
 };
-export declare type ChannelCategoriesState = {
+export type ChannelCategoriesState = {
     byId: IDMappedObjects<ChannelCategory>;
     orderByTeam: RelationOneToOne<Team, Array<ChannelCategory['id']>>;
 };

package/lib/channels.d.ts

@@ -1,24 +1,26 @@
 import { IDMappedObjects, RelationOneToMany, RelationOneToOne } from './utilities';
 import { Team } from './teams';
-export declare type ChannelType = 'O' | 'P' | 'D' | 'G' | 'threads';
-export declare type ChannelStats = {
+export type ChannelType = 'O' | 'P' | 'D' | 'G' | 'threads';
+export type ChannelStats = {
     channel_id: string;
     member_count: number;
     guest_count: number;
     pinnedpost_count: number;
     files_count: number;
 };
-export declare type ChannelNotifyProps = {
+export type ChannelNotifyProps = {
+    desktop_threads: 'default' | 'all' | 'mention' | 'none';
     desktop: 'default' | 'all' | 'mention' | 'none';
     desktop_sound: 'on' | 'off';
     desktop_notification_sound?: 'Bing' | 'Crackle' | 'Down' | 'Hello' | 'Ripple' | 'Upstairs';
     email: 'default' | 'all' | 'mention' | 'none';
     mark_unread: 'all' | 'mention';
     push: 'default' | 'all' | 'mention' | 'none';
+    push_threads: 'default' | 'all' | 'mention' | 'none';
     ignore_channel_mentions: 'default' | 'off' | 'on';
     channel_auto_follow_threads: 'off' | 'on';
 };
-export declare type Channel = {
+export type Channel = {
     id: string;
     create_at: number;
     update_at: number;
@@ -40,7 +42,7 @@ export declare type Channel = {
     props?: Record<string, any>;
     policy_id?: string | null;
 };
-export declare type ServerChannel = Channel & {
+export type ServerChannel = Channel & {
     /**
      * The total number of posts in this channel, not including join/leave messages
      *
@@ -54,22 +56,22 @@ export declare type ServerChannel = Channel & {
      */
     total_msg_count_root: number;
 };
-export declare type ChannelMessageCount = {
+export type ChannelMessageCount = {
     /** The total number of posts in this channel, not including join/leave messages */
     total: number;
     /** The number of root posts in this channel, not including join/leave messages */
     root: number;
 };
-export declare type ChannelWithTeamData = Channel & {
+export type ChannelWithTeamData = Channel & {
     team_display_name: string;
     team_name: string;
     team_update_at: number;
 };
-export declare type ChannelsWithTotalCount = {
+export type ChannelsWithTotalCount = {
     channels: ChannelWithTeamData[];
     total_count: number;
 };
-export declare type ChannelMembership = {
+export type ChannelMembership = {
     channel_id: string;
     user_id: string;
     roles: string;
@@ -90,7 +92,7 @@ export declare type ChannelMembership = {
     scheme_admin: boolean;
     post_root_id?: string;
 };
-export declare type ChannelUnread = {
+export type ChannelUnread = {
     channel_id: string;
     user_id: string;
     team_id: string;
@@ -107,7 +109,7 @@ export declare type ChannelUnread = {
     last_viewed_at: number;
     deltaMsgs: number;
 };
-export declare type ChannelsState = {
+export type ChannelsState = {
     currentChannelId: string;
     channels: IDMappedObjects<Channel>;
     channelsInTeam: RelationOneToMany<Team, Channel>;
@@ -123,7 +125,7 @@ export declare type ChannelsState = {
     messageCounts: RelationOneToOne<Channel, ChannelMessageCount>;
     channelsMemberCount: Record<string, number>;
 };
-export declare type ChannelModeration = {
+export type ChannelModeration = {
     name: string;
     roles: {
         guests?: {
@@ -140,24 +142,24 @@ export declare type ChannelModeration = {
         };
     };
 };
-export declare type ChannelModerationPatch = {
+export type ChannelModerationPatch = {
     name: string;
     roles: {
         guests?: boolean;
         members?: boolean;
     };
 };
-export declare type ChannelMemberCountByGroup = {
+export type ChannelMemberCountByGroup = {
     group_id: string;
     channel_member_count: number;
     channel_member_timezones_count: number;
 };
-export declare type ChannelMemberCountsByGroup = Record<string, ChannelMemberCountByGroup>;
-export declare type ChannelViewResponse = {
+export type ChannelMemberCountsByGroup = Record<string, ChannelMemberCountByGroup>;
+export type ChannelViewResponse = {
     status: string;
     last_viewed_at_times: RelationOneToOne<Channel, number>;
 };
-export declare type ChannelSearchOpts = {
+export type ChannelSearchOpts = {
     nonAdminSearch?: boolean;
     exclude_default_channels?: boolean;
     not_associated_to_group?: string;

package/lib/client4.d.ts

@@ -4,12 +4,12 @@ export declare enum LogLevel {
     Info = "INFO",
     Debug = "DEBUG"
 }
-export declare type ClientResponse<T> = {
+export type ClientResponse<T> = {
     response: Response;
     headers: Map<string, string>;
     data: T;
 };
-export declare type Options = {
+export type Options = {
     headers?: {
         [x: string]: string;
     };
@@ -19,10 +19,10 @@ export declare type Options = {
     body?: any;
     ignoreStatus?: boolean; /** If true, status codes > 300 are ignored and don't cause an error */
 };
-export declare type StatusOK = {
+export type StatusOK = {
     status: 'OK';
 };
-export declare type FetchPaginatedThreadOptions = {
+export type FetchPaginatedThreadOptions = {
     fetchThreads?: boolean;
     collapsedThreads?: boolean;
     collapsedThreadsExtended?: boolean;

package/lib/cloud.d.ts

@@ -1,5 +1,6 @@
+import { AllowedIPRange } from './config';
 import { ValueOf } from './utilities';
-export declare type CloudState = {
+export type CloudState = {
     subscription?: Subscription;
     products?: Record<string, Product>;
     customer?: CloudCustomer;
@@ -21,7 +22,12 @@ export declare type CloudState = {
         progress: ValueOf<typeof SelfHostedSignupProgress>;
     };
 };
-export declare type Subscription = {
+export type Installation = {
+    id: string;
+    state: string;
+    allowed_ip_ranges: AllowedIPRange[];
+};
+export type Subscription = {
     id: string;
     customer_id: string;
     product_id: string;
@@ -37,8 +43,10 @@ export declare type Subscription = {
     delinquent_since?: number;
     compliance_blocked?: string;
     billing_type?: string;
+    cancel_at?: number;
+    will_renew?: string;
 };
-export declare type Product = {
+export type Product = {
     id: string;
     name: string;
     description: string;
@@ -50,7 +58,7 @@ export declare type Product = {
     recurring_interval: string;
     cross_sells_to: string;
 };
-export declare type AddOn = {
+export type AddOn = {
     id: string;
     name: string;
     display_name: string;
@@ -71,9 +79,9 @@ export declare const SelfHostedSignupProgress: {
     readonly PAID: "PAID";
     readonly CREATED_LICENSE: "CREATED_LICENSE";
 };
-export declare type MetadataGatherWireTransferKeys = `${ValueOf<typeof TypePurchases>}_alt_payment_method`;
-export declare type CustomerMetadataGatherWireTransfer = Partial<Record<MetadataGatherWireTransferKeys, string>>;
-export declare type CloudCustomer = {
+export type MetadataGatherWireTransferKeys = `${ValueOf<typeof TypePurchases>}_alt_payment_method`;
+export type CustomerMetadataGatherWireTransfer = Partial<Record<MetadataGatherWireTransferKeys, string>>;
+export type CloudCustomer = {
     id: string;
     creator_id: string;
     create_at: number;
@@ -86,22 +94,22 @@ export declare type CloudCustomer = {
     company_address: Address;
     payment_method: PaymentMethod;
 } & CustomerMetadataGatherWireTransfer;
-export declare type LicenseSelfServeStatus = {
+export type LicenseSelfServeStatus = {
     is_expandable?: boolean;
     is_renewable?: boolean;
 };
-declare type RequestState = 'IDLE' | 'LOADING' | 'ERROR' | 'OK';
+type RequestState = 'IDLE' | 'LOADING' | 'ERROR' | 'OK';
 export interface LicenseSelfServeStatusReducer extends LicenseSelfServeStatus {
     getRequestState: RequestState;
 }
-export declare type CloudCustomerPatch = {
+export type CloudCustomerPatch = {
     email?: string;
     name?: string;
     num_employees?: number;
     contact_first_name?: string;
     contact_last_name?: string;
 } & CustomerMetadataGatherWireTransfer;
-export declare type Address = {
+export type Address = {
     city: string;
     country: string;
     line1: string;
@@ -109,7 +117,7 @@ export declare type Address = {
     postal_code: string;
     state: string;
 };
-export declare type PaymentMethod = {
+export type PaymentMethod = {
     type: string;
     last_four: string;
     exp_month: number;
@@ -117,12 +125,12 @@ export declare type PaymentMethod = {
     card_brand: string;
     name: string;
 };
-export declare type NotifyAdminRequest = {
+export type NotifyAdminRequest = {
     trial_notification: boolean;
     required_plan: string;
     required_feature: string;
 };
-export declare type Invoice = {
+export type Invoice = {
     id: string;
     number: string;
     create_at: number;
@@ -142,7 +150,7 @@ export declare const InvoiceLineItemType: {
     readonly OnPremise: "onpremise";
     readonly Metered: "metered";
 };
-export declare type InvoiceLineItem = {
+export type InvoiceLineItem = {
     price_id: string;
     total: number;
     quantity: number;
@@ -151,7 +159,7 @@ export declare type InvoiceLineItem = {
     type: typeof InvoiceLineItemType[keyof typeof InvoiceLineItemType];
     metadata: Record<string, string>;
 };
-export declare type Limits = {
+export type Limits = {
     messages?: {
         history?: number;
     };
@@ -173,12 +181,12 @@ export interface CloudUsage {
     };
     teams: TeamsUsage;
 }
-export declare type TeamsUsage = {
+export type TeamsUsage = {
     active: number;
     cloudArchived: number;
     teamsLoaded: boolean;
 };
-export declare type ValidBusinessEmail = {
+export type ValidBusinessEmail = {
     is_valid: boolean;
 };
 export interface CreateSubscriptionRequest {
@@ -192,11 +200,11 @@ export interface NewsletterRequestBody {
     subscribed_content: string;
 }
 export declare const areShippingDetailsValid: (address: Address | null | undefined) => boolean;
-export declare type Feedback = {
+export type Feedback = {
     reason: string;
     comments: string;
 };
-export declare type WorkspaceDeletionRequest = {
+export type WorkspaceDeletionRequest = {
     subscription_id: string;
     delete_feedback: Feedback;
 };

package/lib/compliance.d.ts

@@ -1,4 +1,4 @@
-export declare type Compliance = {
+export type Compliance = {
     id: string;
     create_at: number;
     user_id: string;