@mattermost/types 6.7.0-0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +53 -0
- package/lib/admin.d.ts +50 -0
- package/lib/admin.js +4 -0
- package/lib/apps.d.ts +182 -0
- package/lib/apps.js +24 -0
- package/lib/audits.d.ts +9 -0
- package/lib/audits.js +4 -0
- package/lib/autocomplete.d.ts +12 -0
- package/lib/autocomplete.js +4 -0
- package/lib/bots.d.ts +15 -0
- package/lib/bots.js +4 -0
- package/lib/channel_categories.d.ts +30 -0
- package/lib/channel_categories.js +12 -0
- package/lib/channels.d.ts +165 -0
- package/lib/channels.js +4 -0
- package/lib/client4.d.ts +41 -0
- package/lib/client4.js +12 -0
- package/lib/cloud.d.ts +102 -0
- package/lib/cloud.js +12 -0
- package/lib/compliance.d.ts +13 -0
- package/lib/compliance.js +4 -0
- package/lib/config.d.ts +781 -0
- package/lib/config.js +11 -0
- package/lib/data_retention.d.ts +30 -0
- package/lib/data_retention.js +4 -0
- package/lib/emojis.d.ts +28 -0
- package/lib/emojis.js +4 -0
- package/lib/errors.d.ts +12 -0
- package/lib/errors.js +4 -0
- package/lib/files.d.ts +37 -0
- package/lib/files.js +4 -0
- package/lib/general.d.ts +26 -0
- package/lib/general.js +24 -0
- package/lib/groups.d.ts +132 -0
- package/lib/groups.js +4 -0
- package/lib/integration_actions.d.ts +24 -0
- package/lib/integration_actions.js +4 -0
- package/lib/integrations.d.ts +150 -0
- package/lib/integrations.js +4 -0
- package/lib/jobs.d.ts +23 -0
- package/lib/jobs.js +2 -0
- package/lib/marketplace.d.ts +43 -0
- package/lib/marketplace.js +22 -0
- package/lib/message_attachments.d.ts +25 -0
- package/lib/message_attachments.js +4 -0
- package/lib/mfa.d.ts +4 -0
- package/lib/mfa.js +4 -0
- package/lib/plugins.d.ts +119 -0
- package/lib/plugins.js +22 -0
- package/lib/posts.d.ts +126 -0
- package/lib/posts.js +4 -0
- package/lib/preferences.d.ts +9 -0
- package/lib/preferences.js +4 -0
- package/lib/product_notices.d.ts +26 -0
- package/lib/product_notices.js +9 -0
- package/lib/reactions.d.ts +6 -0
- package/lib/reactions.js +2 -0
- package/lib/requests.d.ts +102 -0
- package/lib/requests.js +4 -0
- package/lib/roles.d.ts +13 -0
- package/lib/roles.js +2 -0
- package/lib/saml.d.ts +10 -0
- package/lib/saml.js +4 -0
- package/lib/schemes.d.ts +29 -0
- package/lib/schemes.js +2 -0
- package/lib/search.d.ts +27 -0
- package/lib/search.js +4 -0
- package/lib/sessions.d.ts +15 -0
- package/lib/sessions.js +4 -0
- package/lib/setup.d.ts +3 -0
- package/lib/setup.js +4 -0
- package/lib/store.d.ts +76 -0
- package/lib/store.js +4 -0
- package/lib/teams.d.ts +90 -0
- package/lib/teams.js +4 -0
- package/lib/terms_of_service.d.ts +6 -0
- package/lib/terms_of_service.js +4 -0
- package/lib/themes.d.ts +34 -0
- package/lib/themes.js +4 -0
- package/lib/threads.d.ts +59 -0
- package/lib/threads.js +13 -0
- package/lib/typing.d.ts +5 -0
- package/lib/typing.js +2 -0
- package/lib/users.d.ts +134 -0
- package/lib/users.js +16 -0
- package/lib/utilities.d.ts +25 -0
- package/lib/utilities.js +4 -0
- package/lib/websocket.d.ts +17 -0
- package/lib/websocket.js +4 -0
- package/package.json +34 -0
package/lib/config.d.ts
ADDED
|
@@ -0,0 +1,781 @@
|
|
|
1
|
+
import { ThemeKey } from './themes';
|
|
2
|
+
export declare type ClientConfig = {
|
|
3
|
+
AboutLink: string;
|
|
4
|
+
AllowBannerDismissal: string;
|
|
5
|
+
AllowCustomThemes: string;
|
|
6
|
+
AllowedThemes: string;
|
|
7
|
+
AndroidAppDownloadLink: string;
|
|
8
|
+
AndroidLatestVersion: string;
|
|
9
|
+
AndroidMinVersion: string;
|
|
10
|
+
AppDownloadLink: string;
|
|
11
|
+
AsymmetricSigningPublicKey: string;
|
|
12
|
+
AvailableLocales: string;
|
|
13
|
+
BannerColor: string;
|
|
14
|
+
BannerText: string;
|
|
15
|
+
BannerTextColor: string;
|
|
16
|
+
BuildDate: string;
|
|
17
|
+
BuildEnterpriseReady: string;
|
|
18
|
+
BuildHash: string;
|
|
19
|
+
BuildHashEnterprise: string;
|
|
20
|
+
BuildNumber: string;
|
|
21
|
+
CollapsedThreads: CollapsedThreads;
|
|
22
|
+
CustomBrandText: string;
|
|
23
|
+
CustomDescriptionText: string;
|
|
24
|
+
CustomTermsOfServiceId: string;
|
|
25
|
+
CustomTermsOfServiceReAcceptancePeriod: string;
|
|
26
|
+
CustomUrlSchemes: string;
|
|
27
|
+
CWSURL: string;
|
|
28
|
+
DataRetentionEnableFileDeletion: string;
|
|
29
|
+
DataRetentionEnableMessageDeletion: string;
|
|
30
|
+
DataRetentionFileRetentionDays: string;
|
|
31
|
+
DataRetentionMessageRetentionDays: string;
|
|
32
|
+
DefaultClientLocale: string;
|
|
33
|
+
DefaultTheme: ThemeKey;
|
|
34
|
+
DiagnosticId: string;
|
|
35
|
+
DiagnosticsEnabled: string;
|
|
36
|
+
EmailLoginButtonBorderColor: string;
|
|
37
|
+
EmailLoginButtonColor: string;
|
|
38
|
+
EmailLoginButtonTextColor: string;
|
|
39
|
+
EmailNotificationContentsType: string;
|
|
40
|
+
EnableAskCommunityLink: string;
|
|
41
|
+
EnableBanner: string;
|
|
42
|
+
EnableBotAccountCreation: string;
|
|
43
|
+
EnableChannelViewedMessages: string;
|
|
44
|
+
EnableClientPerformanceDebugging: string;
|
|
45
|
+
EnableCluster: string;
|
|
46
|
+
EnableCommands: string;
|
|
47
|
+
EnableCompliance: string;
|
|
48
|
+
EnableConfirmNotificationsToChannel: string;
|
|
49
|
+
EnableCustomBrand: string;
|
|
50
|
+
EnableCustomEmoji: string;
|
|
51
|
+
EnableCustomGroups: string;
|
|
52
|
+
EnableCustomUserStatuses: string;
|
|
53
|
+
EnableTimedDND: string;
|
|
54
|
+
EnableCustomTermsOfService: string;
|
|
55
|
+
EnableDeveloper: string;
|
|
56
|
+
EnableDiagnostics: string;
|
|
57
|
+
EnableEmailBatching: string;
|
|
58
|
+
EnableEmailInvitations: string;
|
|
59
|
+
EnableEmojiPicker: string;
|
|
60
|
+
EnableFileAttachments: string;
|
|
61
|
+
EnableFile: string;
|
|
62
|
+
EnableGifPicker: string;
|
|
63
|
+
EnableGuestAccounts: string;
|
|
64
|
+
EnableIncomingWebhooks: string;
|
|
65
|
+
EnableLatex: string;
|
|
66
|
+
EnableInlineLatex: string;
|
|
67
|
+
EnableLdap: string;
|
|
68
|
+
EnableLinkPreviews: string;
|
|
69
|
+
EnableMarketplace: string;
|
|
70
|
+
EnableMetrics: string;
|
|
71
|
+
EnableMobileFileDownload: string;
|
|
72
|
+
EnableMobileFileUpload: string;
|
|
73
|
+
EnableMultifactorAuthentication: string;
|
|
74
|
+
EnableOAuthServiceProvider: string;
|
|
75
|
+
EnableOpenServer: string;
|
|
76
|
+
EnableOutgoingWebhooks: string;
|
|
77
|
+
EnablePostIconOverride: string;
|
|
78
|
+
EnablePostUsernameOverride: string;
|
|
79
|
+
EnablePreviewFeatures: string;
|
|
80
|
+
EnablePreviewModeBanner: string;
|
|
81
|
+
EnablePublicLink: string;
|
|
82
|
+
EnableReliableWebSockets: string;
|
|
83
|
+
EnableSaml: string;
|
|
84
|
+
EnableSignInWithEmail: string;
|
|
85
|
+
EnableSignInWithUsername: string;
|
|
86
|
+
EnableSignUpWithEmail: string;
|
|
87
|
+
EnableSignUpWithGitLab: string;
|
|
88
|
+
EnableSignUpWithGoogle: string;
|
|
89
|
+
EnableSignUpWithOffice365: string;
|
|
90
|
+
EnableSignUpWithOpenId: string;
|
|
91
|
+
EnableSVGs: string;
|
|
92
|
+
EnableTesting: string;
|
|
93
|
+
EnableThemeSelection: string;
|
|
94
|
+
EnableTutorial: string;
|
|
95
|
+
EnableOnboardingFlow: string;
|
|
96
|
+
EnableUserAccessTokens: string;
|
|
97
|
+
EnableUserCreation: string;
|
|
98
|
+
EnableUserDeactivation: string;
|
|
99
|
+
EnableUserTypingMessages: string;
|
|
100
|
+
EnforceMultifactorAuthentication: string;
|
|
101
|
+
ExperimentalClientSideCertCheck: string;
|
|
102
|
+
ExperimentalClientSideCertEnable: string;
|
|
103
|
+
ExperimentalCloudBilling: string;
|
|
104
|
+
ExperimentalDataPrefetch: string;
|
|
105
|
+
ExperimentalEnableAuthenticationTransfer: string;
|
|
106
|
+
ExperimentalEnableAutomaticReplies: string;
|
|
107
|
+
ExperimentalEnableClickToReply: string;
|
|
108
|
+
ExperimentalEnableDefaultChannelLeaveJoinMessages: string;
|
|
109
|
+
ExperimentalEnablePostMetadata: string;
|
|
110
|
+
ExperimentalGroupUnreadChannels: string;
|
|
111
|
+
ExperimentalPrimaryTeam: string;
|
|
112
|
+
ExperimentalTimezone: string;
|
|
113
|
+
ExperimentalViewArchivedChannels: string;
|
|
114
|
+
FileLevel: string;
|
|
115
|
+
GfycatAPIKey: string;
|
|
116
|
+
GfycatAPISecret: string;
|
|
117
|
+
GoogleDeveloperKey: string;
|
|
118
|
+
GuestAccountsEnforceMultifactorAuthentication: string;
|
|
119
|
+
HasImageProxy: string;
|
|
120
|
+
HelpLink: string;
|
|
121
|
+
IosAppDownloadLink: string;
|
|
122
|
+
IosLatestVersion: string;
|
|
123
|
+
IosMinVersion: string;
|
|
124
|
+
InstallationDate: string;
|
|
125
|
+
IsDefaultMarketplace: string;
|
|
126
|
+
LdapFirstNameAttributeSet: string;
|
|
127
|
+
LdapLastNameAttributeSet: string;
|
|
128
|
+
LdapLoginButtonBorderColor: string;
|
|
129
|
+
LdapLoginButtonColor: string;
|
|
130
|
+
LdapLoginButtonTextColor: string;
|
|
131
|
+
LdapLoginFieldName: string;
|
|
132
|
+
LdapNicknameAttributeSet: string;
|
|
133
|
+
LdapPositionAttributeSet: string;
|
|
134
|
+
LdapPictureAttributeSet: string;
|
|
135
|
+
LockTeammateNameDisplay: string;
|
|
136
|
+
ManagedResourcePaths: string;
|
|
137
|
+
MaxFileSize: string;
|
|
138
|
+
MaxPostSize: string;
|
|
139
|
+
MaxNotificationsPerChannel: string;
|
|
140
|
+
MinimumHashtagLength: string;
|
|
141
|
+
NoAccounts: string;
|
|
142
|
+
GitLabButtonText: string;
|
|
143
|
+
GitLabButtonColor: string;
|
|
144
|
+
OpenIdButtonText: string;
|
|
145
|
+
OpenIdButtonColor: string;
|
|
146
|
+
PasswordMinimumLength: string;
|
|
147
|
+
PasswordRequireLowercase: string;
|
|
148
|
+
PasswordRequireNumber: string;
|
|
149
|
+
PasswordRequireSymbol: string;
|
|
150
|
+
PasswordRequireUppercase: string;
|
|
151
|
+
PluginsEnabled: string;
|
|
152
|
+
PostEditTimeLimit: string;
|
|
153
|
+
PrivacyPolicyLink: string;
|
|
154
|
+
ReportAProblemLink: string;
|
|
155
|
+
RequireEmailVerification: string;
|
|
156
|
+
RestrictDirectMessage: string;
|
|
157
|
+
RunJobs: string;
|
|
158
|
+
SamlFirstNameAttributeSet: string;
|
|
159
|
+
SamlLastNameAttributeSet: string;
|
|
160
|
+
SamlLoginButtonBorderColor: string;
|
|
161
|
+
SamlLoginButtonColor: string;
|
|
162
|
+
SamlLoginButtonText: string;
|
|
163
|
+
SamlLoginButtonTextColor: string;
|
|
164
|
+
SamlNicknameAttributeSet: string;
|
|
165
|
+
SamlPositionAttributeSet: string;
|
|
166
|
+
SchemaVersion: string;
|
|
167
|
+
SendEmailNotifications: string;
|
|
168
|
+
SendPushNotifications: string;
|
|
169
|
+
ShowEmailAddress: string;
|
|
170
|
+
SiteName: string;
|
|
171
|
+
SiteURL: string;
|
|
172
|
+
SQLDriverName: string;
|
|
173
|
+
SupportEmail: string;
|
|
174
|
+
TeammateNameDisplay: string;
|
|
175
|
+
TermsOfServiceLink: string;
|
|
176
|
+
TimeBetweenUserTypingUpdatesMilliseconds: string;
|
|
177
|
+
UpgradedFromTE: string;
|
|
178
|
+
Version: string;
|
|
179
|
+
WebsocketPort: string;
|
|
180
|
+
WebsocketSecurePort: string;
|
|
181
|
+
WebsocketURL: string;
|
|
182
|
+
ExperimentalSharedChannels: string;
|
|
183
|
+
};
|
|
184
|
+
export declare type License = {
|
|
185
|
+
id: string;
|
|
186
|
+
issued_at: number;
|
|
187
|
+
starts_at: number;
|
|
188
|
+
expires_at: string;
|
|
189
|
+
customer: LicenseCustomer;
|
|
190
|
+
features: LicenseFeatures;
|
|
191
|
+
sku_name: string;
|
|
192
|
+
short_sku_name: string;
|
|
193
|
+
};
|
|
194
|
+
export declare type LicenseCustomer = {
|
|
195
|
+
id: string;
|
|
196
|
+
name: string;
|
|
197
|
+
email: string;
|
|
198
|
+
company: string;
|
|
199
|
+
};
|
|
200
|
+
export declare type LicenseFeatures = {
|
|
201
|
+
users?: number;
|
|
202
|
+
ldap?: boolean;
|
|
203
|
+
ldap_groups?: boolean;
|
|
204
|
+
mfa?: boolean;
|
|
205
|
+
google_oauth?: boolean;
|
|
206
|
+
office365_oauth?: boolean;
|
|
207
|
+
compliance?: boolean;
|
|
208
|
+
cluster?: boolean;
|
|
209
|
+
metrics?: boolean;
|
|
210
|
+
mhpns?: boolean;
|
|
211
|
+
saml?: boolean;
|
|
212
|
+
elastic_search?: boolean;
|
|
213
|
+
announcement?: boolean;
|
|
214
|
+
theme_management?: boolean;
|
|
215
|
+
email_notification_contents?: boolean;
|
|
216
|
+
data_retention?: boolean;
|
|
217
|
+
message_export?: boolean;
|
|
218
|
+
custom_permissions_schemes?: boolean;
|
|
219
|
+
custom_terms_of_service?: boolean;
|
|
220
|
+
guest_accounts?: boolean;
|
|
221
|
+
guest_accounts_permissions?: boolean;
|
|
222
|
+
id_loaded?: boolean;
|
|
223
|
+
lock_teammate_name_display?: boolean;
|
|
224
|
+
cloud?: boolean;
|
|
225
|
+
future_features?: boolean;
|
|
226
|
+
};
|
|
227
|
+
export declare type ClientLicense = Record<string, string>;
|
|
228
|
+
export declare type DataRetentionPolicy = {
|
|
229
|
+
message_deletion_enabled: boolean;
|
|
230
|
+
file_deletion_enabled: boolean;
|
|
231
|
+
message_retention_cutoff: number;
|
|
232
|
+
file_retention_cutoff: number;
|
|
233
|
+
};
|
|
234
|
+
export declare type ServiceSettings = {
|
|
235
|
+
SiteURL: string;
|
|
236
|
+
WebsocketURL: string;
|
|
237
|
+
LicenseFileLocation: string;
|
|
238
|
+
ListenAddress: string;
|
|
239
|
+
ConnectionSecurity: string;
|
|
240
|
+
TLSCertFile: string;
|
|
241
|
+
TLSKeyFile: string;
|
|
242
|
+
TLSMinVer: string;
|
|
243
|
+
TLSStrictTransport: boolean;
|
|
244
|
+
TLSStrictTransportMaxAge: number;
|
|
245
|
+
TLSOverwriteCiphers: string[];
|
|
246
|
+
UseLetsEncrypt: boolean;
|
|
247
|
+
LetsEncryptCertificateCacheFile: string;
|
|
248
|
+
Forward80To443: boolean;
|
|
249
|
+
TrustedProxyIPHeader: string[];
|
|
250
|
+
ReadTimeout: number;
|
|
251
|
+
WriteTimeout: number;
|
|
252
|
+
IdleTimeout: number;
|
|
253
|
+
MaximumLoginAttempts: number;
|
|
254
|
+
GoroutineHealthThreshold: number;
|
|
255
|
+
GoogleDeveloperKey: string;
|
|
256
|
+
EnableOAuthServiceProvider: boolean;
|
|
257
|
+
EnableIncomingWebhooks: boolean;
|
|
258
|
+
EnableOutgoingWebhooks: boolean;
|
|
259
|
+
EnableCommands: boolean;
|
|
260
|
+
EnablePostUsernameOverride: boolean;
|
|
261
|
+
EnablePostIconOverride: boolean;
|
|
262
|
+
EnableLinkPreviews: boolean;
|
|
263
|
+
EnableTesting: boolean;
|
|
264
|
+
EnableDeveloper: boolean;
|
|
265
|
+
EnableOpenTracing: boolean;
|
|
266
|
+
EnableSecurityFixAlert: boolean;
|
|
267
|
+
EnableInsecureOutgoingConnections: boolean;
|
|
268
|
+
AllowedUntrustedInternalConnections: string;
|
|
269
|
+
EnableMultifactorAuthentication: boolean;
|
|
270
|
+
EnforceMultifactorAuthentication: boolean;
|
|
271
|
+
EnableUserAccessTokens: boolean;
|
|
272
|
+
AllowCorsFrom: string;
|
|
273
|
+
CorsExposedHeaders: string;
|
|
274
|
+
CorsAllowCredentials: boolean;
|
|
275
|
+
CorsDebug: boolean;
|
|
276
|
+
AllowCookiesForSubdomains: boolean;
|
|
277
|
+
ExtendSessionLengthWithActivity: boolean;
|
|
278
|
+
SessionLengthWebInDays: number;
|
|
279
|
+
SessionLengthMobileInDays: number;
|
|
280
|
+
SessionLengthSSOInDays: number;
|
|
281
|
+
SessionCacheInMinutes: number;
|
|
282
|
+
SessionIdleTimeoutInMinutes: number;
|
|
283
|
+
WebsocketSecurePort: number;
|
|
284
|
+
WebsocketPort: number;
|
|
285
|
+
WebserverMode: string;
|
|
286
|
+
EnableCustomEmoji: boolean;
|
|
287
|
+
EnableEmojiPicker: boolean;
|
|
288
|
+
EnableGifPicker: boolean;
|
|
289
|
+
GfycatApiKey: string;
|
|
290
|
+
GfycatApiSecret: string;
|
|
291
|
+
PostEditTimeLimit: number;
|
|
292
|
+
TimeBetweenUserTypingUpdatesMilliseconds: number;
|
|
293
|
+
EnablePostSearch: boolean;
|
|
294
|
+
MinimumHashtagLength: number;
|
|
295
|
+
EnableUserTypingMessages: boolean;
|
|
296
|
+
EnableChannelViewedMessages: boolean;
|
|
297
|
+
EnableUserStatuses: boolean;
|
|
298
|
+
ExperimentalEnableAuthenticationTransfer: boolean;
|
|
299
|
+
ClusterLogTimeoutMilliseconds: number;
|
|
300
|
+
EnablePreviewFeatures: boolean;
|
|
301
|
+
EnableTutorial: boolean;
|
|
302
|
+
EnableOnboardingFlow: boolean;
|
|
303
|
+
ExperimentalEnableDefaultChannelLeaveJoinMessages: boolean;
|
|
304
|
+
ExperimentalGroupUnreadChannels: string;
|
|
305
|
+
ExperimentalDataPrefetch: boolean;
|
|
306
|
+
EnableAPITeamDeletion: boolean;
|
|
307
|
+
ExperimentalEnableHardenedMode: boolean;
|
|
308
|
+
ExperimentalStrictCSRFEnforcement: boolean;
|
|
309
|
+
EnableEmailInvitations: boolean;
|
|
310
|
+
DisableBotsWhenOwnerIsDeactivated: boolean;
|
|
311
|
+
EnableBotAccountCreation: boolean;
|
|
312
|
+
EnableSVGs: boolean;
|
|
313
|
+
EnableLatex: boolean;
|
|
314
|
+
EnableLocalMode: boolean;
|
|
315
|
+
LocalModeSocketLocation: string;
|
|
316
|
+
CollapsedThreads: 'disabled' | 'default_on' | 'default_off';
|
|
317
|
+
ThreadAutoFollow: boolean;
|
|
318
|
+
};
|
|
319
|
+
export declare type TeamSettings = {
|
|
320
|
+
SiteName: string;
|
|
321
|
+
MaxUsersPerTeam: number;
|
|
322
|
+
EnableCustomUserStatuses: boolean;
|
|
323
|
+
EnableUserCreation: boolean;
|
|
324
|
+
EnableOpenServer: boolean;
|
|
325
|
+
EnableUserDeactivation: boolean;
|
|
326
|
+
RestrictCreationToDomains: string;
|
|
327
|
+
EnableCustomBrand: boolean;
|
|
328
|
+
CustomBrandText: string;
|
|
329
|
+
CustomDescriptionText: string;
|
|
330
|
+
RestrictDirectMessage: string;
|
|
331
|
+
UserStatusAwayTimeout: number;
|
|
332
|
+
MaxChannelsPerTeam: number;
|
|
333
|
+
MaxNotificationsPerChannel: number;
|
|
334
|
+
EnableConfirmNotificationsToChannel: boolean;
|
|
335
|
+
TeammateNameDisplay: string;
|
|
336
|
+
ExperimentalViewArchivedChannels: boolean;
|
|
337
|
+
ExperimentalEnableAutomaticReplies: boolean;
|
|
338
|
+
LockTeammateNameDisplay: boolean;
|
|
339
|
+
ExperimentalPrimaryTeam: string;
|
|
340
|
+
ExperimentalDefaultChannels: string[];
|
|
341
|
+
};
|
|
342
|
+
export declare type ClientRequirements = {
|
|
343
|
+
AndroidLatestVersion: string;
|
|
344
|
+
AndroidMinVersion: string;
|
|
345
|
+
IosLatestVersion: string;
|
|
346
|
+
IosMinVersion: string;
|
|
347
|
+
};
|
|
348
|
+
export declare type SqlSettings = {
|
|
349
|
+
DriverName: string;
|
|
350
|
+
DataSource: string;
|
|
351
|
+
DataSourceReplicas: string[];
|
|
352
|
+
DataSourceSearchReplicas: string[];
|
|
353
|
+
MaxIdleConns: number;
|
|
354
|
+
ConnMaxLifetimeMilliseconds: number;
|
|
355
|
+
MaxOpenConns: number;
|
|
356
|
+
Trace: boolean;
|
|
357
|
+
AtRestEncryptKey: string;
|
|
358
|
+
QueryTimeout: number;
|
|
359
|
+
DisableDatabaseSearch: boolean;
|
|
360
|
+
};
|
|
361
|
+
export declare type LogSettings = {
|
|
362
|
+
EnableConsole: boolean;
|
|
363
|
+
ConsoleLevel: string;
|
|
364
|
+
ConsoleJson: boolean;
|
|
365
|
+
EnableFile: boolean;
|
|
366
|
+
FileLevel: string;
|
|
367
|
+
FileJson: boolean;
|
|
368
|
+
FileLocation: string;
|
|
369
|
+
EnableWebhookDebugging: boolean;
|
|
370
|
+
EnableDiagnostics: boolean;
|
|
371
|
+
EnableSentry: boolean;
|
|
372
|
+
};
|
|
373
|
+
export declare type ExperimentalAuditSettings = {
|
|
374
|
+
SysLogEnabled: boolean;
|
|
375
|
+
SysLogIP: string;
|
|
376
|
+
SysLogPort: number;
|
|
377
|
+
SysLogTag: string;
|
|
378
|
+
SysLogCert: string;
|
|
379
|
+
SysLogInsecure: boolean;
|
|
380
|
+
SysLogMaxQueueSize: number;
|
|
381
|
+
FileEnabled: boolean;
|
|
382
|
+
FileName: string;
|
|
383
|
+
FileMaxSizeMB: number;
|
|
384
|
+
FileMaxAgeDays: number;
|
|
385
|
+
FileMaxBackups: number;
|
|
386
|
+
FileCompress: boolean;
|
|
387
|
+
FileMaxQueueSize: number;
|
|
388
|
+
};
|
|
389
|
+
export declare type NotificationLogSettings = {
|
|
390
|
+
EnableConsole: boolean;
|
|
391
|
+
ConsoleLevel: string;
|
|
392
|
+
ConsoleJson: boolean;
|
|
393
|
+
EnableFile: boolean;
|
|
394
|
+
FileLevel: string;
|
|
395
|
+
FileJson: boolean;
|
|
396
|
+
FileLocation: string;
|
|
397
|
+
};
|
|
398
|
+
export declare type PasswordSettings = {
|
|
399
|
+
MinimumLength: number;
|
|
400
|
+
Lowercase: boolean;
|
|
401
|
+
Number: boolean;
|
|
402
|
+
Uppercase: boolean;
|
|
403
|
+
Symbol: boolean;
|
|
404
|
+
};
|
|
405
|
+
export declare type FileSettings = {
|
|
406
|
+
EnableFileAttachments: boolean;
|
|
407
|
+
EnableMobileUpload: boolean;
|
|
408
|
+
EnableMobileDownload: boolean;
|
|
409
|
+
MaxFileSize: number;
|
|
410
|
+
DriverName: string;
|
|
411
|
+
Directory: string;
|
|
412
|
+
EnablePublicLink: boolean;
|
|
413
|
+
PublicLinkSalt: string;
|
|
414
|
+
InitialFont: string;
|
|
415
|
+
AmazonS3AccessKeyId: string;
|
|
416
|
+
AmazonS3SecretAccessKey: string;
|
|
417
|
+
AmazonS3Bucket: string;
|
|
418
|
+
AmazonS3Region: string;
|
|
419
|
+
AmazonS3Endpoint: string;
|
|
420
|
+
AmazonS3SSL: boolean;
|
|
421
|
+
AmazonS3SignV2: boolean;
|
|
422
|
+
AmazonS3SSE: boolean;
|
|
423
|
+
AmazonS3Trace: boolean;
|
|
424
|
+
};
|
|
425
|
+
export declare type EmailSettings = {
|
|
426
|
+
EnableSignUpWithEmail: boolean;
|
|
427
|
+
EnableSignInWithEmail: boolean;
|
|
428
|
+
EnableSignInWithUsername: boolean;
|
|
429
|
+
SendEmailNotifications: boolean;
|
|
430
|
+
UseChannelInEmailNotifications: boolean;
|
|
431
|
+
RequireEmailVerification: boolean;
|
|
432
|
+
FeedbackName: string;
|
|
433
|
+
FeedbackEmail: string;
|
|
434
|
+
ReplyToAddress: string;
|
|
435
|
+
FeedbackOrganization: string;
|
|
436
|
+
EnableSMTPAuth: boolean;
|
|
437
|
+
SMTPUsername: string;
|
|
438
|
+
SMTPPassword: string;
|
|
439
|
+
SMTPServer: string;
|
|
440
|
+
SMTPPort: string;
|
|
441
|
+
SMTPServerTimeout: number;
|
|
442
|
+
ConnectionSecurity: string;
|
|
443
|
+
SendPushNotifications: boolean;
|
|
444
|
+
PushNotificationServer: string;
|
|
445
|
+
PushNotificationContents: string;
|
|
446
|
+
EnableEmailBatching: boolean;
|
|
447
|
+
EmailBatchingBufferSize: number;
|
|
448
|
+
EmailBatchingInterval: number;
|
|
449
|
+
EnablePreviewModeBanner: boolean;
|
|
450
|
+
SkipServerCertificateVerification: boolean;
|
|
451
|
+
EmailNotificationContentsType: string;
|
|
452
|
+
LoginButtonColor: string;
|
|
453
|
+
LoginButtonBorderColor: string;
|
|
454
|
+
LoginButtonTextColor: string;
|
|
455
|
+
};
|
|
456
|
+
export declare type RateLimitSettings = {
|
|
457
|
+
Enable: boolean;
|
|
458
|
+
PerSec: number;
|
|
459
|
+
MaxBurst: number;
|
|
460
|
+
MemoryStoreSize: number;
|
|
461
|
+
VaryByRemoteAddr: boolean;
|
|
462
|
+
VaryByUser: boolean;
|
|
463
|
+
VaryByHeader: string;
|
|
464
|
+
};
|
|
465
|
+
export declare type PrivacySettings = {
|
|
466
|
+
ShowEmailAddress: boolean;
|
|
467
|
+
ShowFullName: boolean;
|
|
468
|
+
};
|
|
469
|
+
export declare type SupportSettings = {
|
|
470
|
+
TermsOfServiceLink: string;
|
|
471
|
+
PrivacyPolicyLink: string;
|
|
472
|
+
AboutLink: string;
|
|
473
|
+
HelpLink: string;
|
|
474
|
+
ReportAProblemLink: string;
|
|
475
|
+
SupportEmail: string;
|
|
476
|
+
CustomTermsOfServiceEnabled: boolean;
|
|
477
|
+
CustomTermsOfServiceReAcceptancePeriod: number;
|
|
478
|
+
};
|
|
479
|
+
export declare type AnnouncementSettings = {
|
|
480
|
+
EnableBanner: boolean;
|
|
481
|
+
BannerText: string;
|
|
482
|
+
BannerColor: string;
|
|
483
|
+
BannerTextColor: string;
|
|
484
|
+
AllowBannerDismissal: boolean;
|
|
485
|
+
};
|
|
486
|
+
export declare type ThemeSettings = {
|
|
487
|
+
EnableThemeSelection: boolean;
|
|
488
|
+
DefaultTheme: string;
|
|
489
|
+
AllowCustomThemes: boolean;
|
|
490
|
+
AllowedThemes: string[];
|
|
491
|
+
};
|
|
492
|
+
export declare type SSOSettings = {
|
|
493
|
+
Enable: boolean;
|
|
494
|
+
Secret: string;
|
|
495
|
+
Id: string;
|
|
496
|
+
Scope: string;
|
|
497
|
+
AuthEndpoint: string;
|
|
498
|
+
TokenEndpoint: string;
|
|
499
|
+
UserAPIEndpoint: string;
|
|
500
|
+
DiscoveryEndpoint: string;
|
|
501
|
+
ButtonText: string;
|
|
502
|
+
ButtonColor: string;
|
|
503
|
+
};
|
|
504
|
+
export declare type Office365Settings = {
|
|
505
|
+
Enable: boolean;
|
|
506
|
+
Secret: string;
|
|
507
|
+
Id: string;
|
|
508
|
+
Scope: string;
|
|
509
|
+
AuthEndpoint: string;
|
|
510
|
+
TokenEndpoint: string;
|
|
511
|
+
UserAPIEndpoint: string;
|
|
512
|
+
DiscoveryEndpoint: string;
|
|
513
|
+
DirectoryId: string;
|
|
514
|
+
};
|
|
515
|
+
export declare type LdapSettings = {
|
|
516
|
+
Enable: boolean;
|
|
517
|
+
EnableSync: boolean;
|
|
518
|
+
LdapServer: string;
|
|
519
|
+
LdapPort: number;
|
|
520
|
+
ConnectionSecurity: string;
|
|
521
|
+
BaseDN: string;
|
|
522
|
+
BindUsername: string;
|
|
523
|
+
BindPassword: string;
|
|
524
|
+
UserFilter: string;
|
|
525
|
+
GroupFilter: string;
|
|
526
|
+
GuestFilter: string;
|
|
527
|
+
EnableAdminFilter: boolean;
|
|
528
|
+
AdminFilter: string;
|
|
529
|
+
GroupDisplayNameAttribute: string;
|
|
530
|
+
GroupIdAttribute: string;
|
|
531
|
+
FirstNameAttribute: string;
|
|
532
|
+
LastNameAttribute: string;
|
|
533
|
+
EmailAttribute: string;
|
|
534
|
+
UsernameAttribute: string;
|
|
535
|
+
NicknameAttribute: string;
|
|
536
|
+
IdAttribute: string;
|
|
537
|
+
PositionAttribute: string;
|
|
538
|
+
LoginIdAttribute: string;
|
|
539
|
+
PictureAttribute: string;
|
|
540
|
+
SyncIntervalMinutes: number;
|
|
541
|
+
SkipCertificateVerification: boolean;
|
|
542
|
+
QueryTimeout: number;
|
|
543
|
+
MaxPageSize: number;
|
|
544
|
+
LoginFieldName: string;
|
|
545
|
+
LoginButtonColor: string;
|
|
546
|
+
LoginButtonBorderColor: string;
|
|
547
|
+
LoginButtonTextColor: string;
|
|
548
|
+
Trace: boolean;
|
|
549
|
+
};
|
|
550
|
+
export declare type ComplianceSettings = {
|
|
551
|
+
Enable: boolean;
|
|
552
|
+
Directory: string;
|
|
553
|
+
EnableDaily: boolean;
|
|
554
|
+
};
|
|
555
|
+
export declare type LocalizationSettings = {
|
|
556
|
+
DefaultServerLocale: string;
|
|
557
|
+
DefaultClientLocale: string;
|
|
558
|
+
AvailableLocales: string;
|
|
559
|
+
};
|
|
560
|
+
export declare type SamlSettings = {
|
|
561
|
+
Enable: boolean;
|
|
562
|
+
EnableSyncWithLdap: boolean;
|
|
563
|
+
EnableSyncWithLdapIncludeAuth: boolean;
|
|
564
|
+
IgnoreGuestsLdapSync: boolean;
|
|
565
|
+
Verify: boolean;
|
|
566
|
+
Encrypt: boolean;
|
|
567
|
+
SignRequest: boolean;
|
|
568
|
+
IdpURL: string;
|
|
569
|
+
IdpDescriptorURL: string;
|
|
570
|
+
IdpMetadataURL: string;
|
|
571
|
+
AssertionConsumerServiceURL: string;
|
|
572
|
+
SignatureAlgorithm: string;
|
|
573
|
+
CanonicalAlgorithm: string;
|
|
574
|
+
ScopingIDPProviderId: string;
|
|
575
|
+
ScopingIDPName: string;
|
|
576
|
+
IdpCertificateFile: string;
|
|
577
|
+
PublicCertificateFile: string;
|
|
578
|
+
PrivateKeyFile: string;
|
|
579
|
+
IdAttribute: string;
|
|
580
|
+
GuestAttribute: string;
|
|
581
|
+
EnableAdminAttribute: boolean;
|
|
582
|
+
AdminAttribute: string;
|
|
583
|
+
FirstNameAttribute: string;
|
|
584
|
+
LastNameAttribute: string;
|
|
585
|
+
EmailAttribute: string;
|
|
586
|
+
UsernameAttribute: string;
|
|
587
|
+
NicknameAttribute: string;
|
|
588
|
+
LocaleAttribute: string;
|
|
589
|
+
PositionAttribute: string;
|
|
590
|
+
LoginButtonText: string;
|
|
591
|
+
LoginButtonColor: string;
|
|
592
|
+
LoginButtonBorderColor: string;
|
|
593
|
+
LoginButtonTextColor: string;
|
|
594
|
+
};
|
|
595
|
+
export declare type NativeAppSettings = {
|
|
596
|
+
AppDownloadLink: string;
|
|
597
|
+
AndroidAppDownloadLink: string;
|
|
598
|
+
IosAppDownloadLink: string;
|
|
599
|
+
};
|
|
600
|
+
export declare type ClusterSettings = {
|
|
601
|
+
Enable: boolean;
|
|
602
|
+
ClusterName: string;
|
|
603
|
+
OverrideHostname: string;
|
|
604
|
+
NetworkInterface: string;
|
|
605
|
+
BindAddress: string;
|
|
606
|
+
AdvertiseAddress: string;
|
|
607
|
+
UseIPAddress: boolean;
|
|
608
|
+
EnableExperimentalGossipEncryption: boolean;
|
|
609
|
+
ReadOnlyConfig: boolean;
|
|
610
|
+
GossipPort: number;
|
|
611
|
+
StreamingPort: number;
|
|
612
|
+
MaxIdleConns: number;
|
|
613
|
+
MaxIdleConnsPerHost: number;
|
|
614
|
+
IdleConnTimeoutMilliseconds: number;
|
|
615
|
+
};
|
|
616
|
+
export declare type MetricsSettings = {
|
|
617
|
+
Enable: boolean;
|
|
618
|
+
BlockProfileRate: number;
|
|
619
|
+
ListenAddress: string;
|
|
620
|
+
};
|
|
621
|
+
export declare type ExperimentalSettings = {
|
|
622
|
+
ClientSideCertEnable: boolean;
|
|
623
|
+
ClientSideCertCheck: string;
|
|
624
|
+
EnableClickToReply: boolean;
|
|
625
|
+
LinkMetadataTimeoutMilliseconds: number;
|
|
626
|
+
RestrictSystemAdmin: boolean;
|
|
627
|
+
UseNewSAMLLibrary: boolean;
|
|
628
|
+
CloudBilling: boolean;
|
|
629
|
+
};
|
|
630
|
+
export declare type AnalyticsSettings = {
|
|
631
|
+
MaxUsersForStatistics: number;
|
|
632
|
+
};
|
|
633
|
+
export declare type ElasticsearchSettings = {
|
|
634
|
+
ConnectionURL: string;
|
|
635
|
+
Username: string;
|
|
636
|
+
Password: string;
|
|
637
|
+
EnableIndexing: boolean;
|
|
638
|
+
EnableSearching: boolean;
|
|
639
|
+
EnableAutocomplete: boolean;
|
|
640
|
+
Sniff: boolean;
|
|
641
|
+
PostIndexReplicas: number;
|
|
642
|
+
PostIndexShards: number;
|
|
643
|
+
ChannelIndexReplicas: number;
|
|
644
|
+
ChannelIndexShards: number;
|
|
645
|
+
UserIndexReplicas: number;
|
|
646
|
+
UserIndexShards: number;
|
|
647
|
+
AggregatePostsAfterDays: number;
|
|
648
|
+
PostsAggregatorJobStartTime: string;
|
|
649
|
+
IndexPrefix: string;
|
|
650
|
+
LiveIndexingBatchSize: number;
|
|
651
|
+
BatchSize: number;
|
|
652
|
+
RequestTimeoutSeconds: number;
|
|
653
|
+
SkipTLSVerification: boolean;
|
|
654
|
+
Trace: string;
|
|
655
|
+
};
|
|
656
|
+
export declare type BleveSettings = {
|
|
657
|
+
IndexDir: string;
|
|
658
|
+
EnableIndexing: boolean;
|
|
659
|
+
EnableSearching: boolean;
|
|
660
|
+
EnableAutocomplete: boolean;
|
|
661
|
+
BatchSize: number;
|
|
662
|
+
};
|
|
663
|
+
export declare type DataRetentionSettings = {
|
|
664
|
+
EnableMessageDeletion: boolean;
|
|
665
|
+
EnableFileDeletion: boolean;
|
|
666
|
+
EnableBoardsDeletion: boolean;
|
|
667
|
+
MessageRetentionDays: number;
|
|
668
|
+
FileRetentionDays: number;
|
|
669
|
+
BoardsRetentionDays: number;
|
|
670
|
+
DeletionJobStartTime: string;
|
|
671
|
+
};
|
|
672
|
+
export declare type MessageExportSettings = {
|
|
673
|
+
EnableExport: boolean;
|
|
674
|
+
DownloadExportResults: boolean;
|
|
675
|
+
ExportFormat: string;
|
|
676
|
+
DailyRunTime: string;
|
|
677
|
+
ExportFromTimestamp: number;
|
|
678
|
+
BatchSize: number;
|
|
679
|
+
GlobalRelaySettings: {
|
|
680
|
+
CustomerType: string;
|
|
681
|
+
SMTPUsername: string;
|
|
682
|
+
SMTPPassword: string;
|
|
683
|
+
EmailAddress: string;
|
|
684
|
+
};
|
|
685
|
+
};
|
|
686
|
+
export declare type JobSettings = {
|
|
687
|
+
RunJobs: boolean;
|
|
688
|
+
RunScheduler: boolean;
|
|
689
|
+
};
|
|
690
|
+
export declare type PluginSettings = {
|
|
691
|
+
Enable: boolean;
|
|
692
|
+
EnableUploads: boolean;
|
|
693
|
+
AllowInsecureDownloadURL: boolean;
|
|
694
|
+
EnableHealthCheck: boolean;
|
|
695
|
+
Directory: string;
|
|
696
|
+
ClientDirectory: string;
|
|
697
|
+
Plugins: Record<string, any>;
|
|
698
|
+
PluginStates: Record<string, {
|
|
699
|
+
Enable: boolean;
|
|
700
|
+
}>;
|
|
701
|
+
EnableMarketplace: boolean;
|
|
702
|
+
EnableRemoteMarketplace: boolean;
|
|
703
|
+
AutomaticPrepackagedPlugins: boolean;
|
|
704
|
+
RequirePluginSignature: boolean;
|
|
705
|
+
MarketplaceURL: string;
|
|
706
|
+
SignaturePublicKeyFiles: string[];
|
|
707
|
+
};
|
|
708
|
+
export declare type DisplaySettings = {
|
|
709
|
+
CustomURLSchemes: string[];
|
|
710
|
+
ExperimentalTimezone: boolean;
|
|
711
|
+
};
|
|
712
|
+
export declare type GuestAccountsSettings = {
|
|
713
|
+
Enable: boolean;
|
|
714
|
+
AllowEmailAccounts: boolean;
|
|
715
|
+
EnforceMultifactorAuthentication: boolean;
|
|
716
|
+
RestrictCreationToDomains: string;
|
|
717
|
+
};
|
|
718
|
+
export declare type ImageProxySettings = {
|
|
719
|
+
Enable: boolean;
|
|
720
|
+
ImageProxyType: string;
|
|
721
|
+
RemoteImageProxyURL: string;
|
|
722
|
+
RemoteImageProxyOptions: string;
|
|
723
|
+
};
|
|
724
|
+
export declare type FeatureFlags = Record<string, string>;
|
|
725
|
+
export declare type AdminConfig = {
|
|
726
|
+
ServiceSettings: ServiceSettings;
|
|
727
|
+
TeamSettings: TeamSettings;
|
|
728
|
+
ClientRequirements: ClientRequirements;
|
|
729
|
+
SqlSettings: SqlSettings;
|
|
730
|
+
LogSettings: LogSettings;
|
|
731
|
+
ExperimentalAuditSettings: ExperimentalAuditSettings;
|
|
732
|
+
NotificationLogSettings: NotificationLogSettings;
|
|
733
|
+
PasswordSettings: PasswordSettings;
|
|
734
|
+
FileSettings: FileSettings;
|
|
735
|
+
EmailSettings: EmailSettings;
|
|
736
|
+
RateLimitSettings: RateLimitSettings;
|
|
737
|
+
PrivacySettings: PrivacySettings;
|
|
738
|
+
SupportSettings: SupportSettings;
|
|
739
|
+
AnnouncementSettings: AnnouncementSettings;
|
|
740
|
+
ThemeSettings: ThemeSettings;
|
|
741
|
+
GitLabSettings: SSOSettings;
|
|
742
|
+
GoogleSettings: SSOSettings;
|
|
743
|
+
Office365Settings: Office365Settings;
|
|
744
|
+
OpenIdSettings: SSOSettings;
|
|
745
|
+
LdapSettings: LdapSettings;
|
|
746
|
+
ComplianceSettings: ComplianceSettings;
|
|
747
|
+
LocalizationSettings: LocalizationSettings;
|
|
748
|
+
SamlSettings: SamlSettings;
|
|
749
|
+
NativeAppSettings: NativeAppSettings;
|
|
750
|
+
ClusterSettings: ClusterSettings;
|
|
751
|
+
MetricsSettings: MetricsSettings;
|
|
752
|
+
ExperimentalSettings: ExperimentalSettings;
|
|
753
|
+
AnalyticsSettings: AnalyticsSettings;
|
|
754
|
+
ElasticsearchSettings: ElasticsearchSettings;
|
|
755
|
+
BleveSettings: BleveSettings;
|
|
756
|
+
DataRetentionSettings: DataRetentionSettings;
|
|
757
|
+
MessageExportSettings: MessageExportSettings;
|
|
758
|
+
JobSettings: JobSettings;
|
|
759
|
+
PluginSettings: PluginSettings;
|
|
760
|
+
DisplaySettings: DisplaySettings;
|
|
761
|
+
GuestAccountsSettings: GuestAccountsSettings;
|
|
762
|
+
ImageProxySettings: ImageProxySettings;
|
|
763
|
+
FeatureFlags: FeatureFlags;
|
|
764
|
+
};
|
|
765
|
+
export declare type EnvironmentConfigSettings<T> = {
|
|
766
|
+
[P in keyof T]: boolean;
|
|
767
|
+
};
|
|
768
|
+
export declare type EnvironmentConfig = {
|
|
769
|
+
[P in keyof AdminConfig]: EnvironmentConfigSettings<AdminConfig[P]>;
|
|
770
|
+
};
|
|
771
|
+
export declare type WarnMetricStatus = {
|
|
772
|
+
id: string;
|
|
773
|
+
limit: number;
|
|
774
|
+
acked: boolean;
|
|
775
|
+
store_status: string;
|
|
776
|
+
};
|
|
777
|
+
export declare enum CollapsedThreads {
|
|
778
|
+
DISABLED = "disabled",
|
|
779
|
+
DEFAULT_ON = "default_on",
|
|
780
|
+
DEFAULT_OFF = "default_off"
|
|
781
|
+
}
|