@mattermost/types 10.6.0 → 10.8.0

package/lib/channels.d.ts

@@ -20,6 +20,12 @@ export type ChannelNotifyProps = {
     ignore_channel_mentions: 'default' | 'off' | 'on';
     channel_auto_follow_threads: 'off' | 'on';
 };
+export type ChannelBanner = {
+    enabled?: boolean;
+    text?: string;
+    background_color?: string;
+};
+export declare function channelBannerEnabled(banner: ChannelBanner | undefined): boolean;
 export type Channel = {
     id: string;
     create_at: number;
@@ -41,6 +47,7 @@ export type Channel = {
     shared?: boolean;
     props?: Record<string, any>;
     policy_id?: string | null;
+    banner_info?: ChannelBanner;
 };
 export type ServerChannel = Channel & {
     /**

package/lib/channels.js

@@ -2,3 +2,10 @@
 // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
 // See LICENSE.txt for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.channelBannerEnabled = channelBannerEnabled;
+function channelBannerEnabled(banner) {
+    if (!banner) {
+        return false;
+    }
+    return Boolean(banner.enabled) && Boolean(banner.text) && Boolean(banner.background_color);
+}

package/lib/config.d.ts

@@ -59,6 +59,7 @@ export type ClientConfig = {
     EnableUserStatuses: string;
     EnableLastActiveTime: string;
     EnableTimedDND: string;
+    EnableCrossTeamSearch: 'true' | 'false';
     EnableCustomTermsOfService: string;
     EnableDeveloper: string;
     EnableDiagnostics: string;
@@ -343,6 +344,7 @@ export type ServiceSettings = {
     GiphySdkKey: string;
     PostEditTimeLimit: number;
     TimeBetweenUserTypingUpdatesMilliseconds: number;
+    EnableCrossTeamSearch: boolean;
     EnablePostSearch: boolean;
     EnableFileSearch: boolean;
     MinimumHashtagLength: number;
@@ -391,6 +393,8 @@ export type ServiceSettings = {
     EnableDesktopLandingPage: boolean;
     MaximumURLLength: number;
     ScheduledPosts: boolean;
+    EnableWebHubChannelIteration: boolean;
+    FrameAncestors: string;
 };
 export type TeamSettings = {
     SiteName: string;
@@ -680,6 +684,7 @@ export type LdapSettings = {
     LoginButtonColor: string;
     LoginButtonBorderColor: string;
     LoginButtonTextColor: string;
+    MaximumLoginAttempts: number;
 };
 export type ComplianceSettings = {
     Enable: boolean;
@@ -735,6 +740,9 @@ export type NativeAppSettings = {
     AndroidAppDownloadLink: string;
     IosAppDownloadLink: string;
     MobileExternalBrowser: boolean;
+    MobileEnableBiometrics: boolean;
+    MobilePreventScreenCapture: boolean;
+    MobileJailbreakProtection: boolean;
 };
 export type ClusterSettings = {
     Enable: boolean;
@@ -755,6 +763,7 @@ export type MetricsSettings = {
     ListenAddress: string;
     EnableClientMetrics: boolean;
     EnableNotificationMetrics: boolean;
+    ClientSideUserIds: string[];
 };
 export type ExperimentalSettings = {
     ClientSideCertEnable: boolean;
@@ -778,6 +787,7 @@ export type CacheSettings = {
     RedisAddress: string;
     RedisPassword: string;
     RedisDB: number;
+    RedisCachePrefix: string;
     DisableClientCache: boolean;
 };
 export type ElasticsearchSettings = {
@@ -798,6 +808,7 @@ export type ElasticsearchSettings = {
     AggregatePostsAfterDays: number;
     PostsAggregatorJobStartTime: string;
     IndexPrefix: string;
+    GlobalSearchPrefix: string;
     LiveIndexingBatchSize: number;
     BatchSize: number;
     RequestTimeoutSeconds: number;

package/lib/groups.d.ts

@@ -34,10 +34,20 @@ export type Group = {
     channel_member_timezones_count?: number;
     member_ids?: string[];
 };
+/**
+ * Main sources for groups
+ */
 export declare enum GroupSource {
     Ldap = "ldap",
     Custom = "custom"
 }
+/**
+ * Special prefixes that can be added to group sources when they come from plugins
+ * Used for identifying plugin-created groups by checking if source starts with this prefix
+ */
+export declare enum PluginGroupSourcePrefix {
+    Plugin = "plugin_"
+}
 export type GroupTeam = {
     team_id: string;
     team_display_name: string;
@@ -142,6 +152,12 @@ export type GroupSearchParams = GetGroupsParams & {
     include_timezones?: string;
     include_channel_member_count?: string;
 };
+export type GroupMember = {
+    group_id: string;
+    user_id: string;
+    create_at: number;
+    deleted_at: number;
+};
 export type GroupMembership = {
     user_id: string;
     roles: string;

package/lib/groups.js

@@ -2,14 +2,25 @@
 // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
 // See LICENSE.txt for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GroupSource = exports.SyncableType = void 0;
+exports.PluginGroupSourcePrefix = exports.GroupSource = exports.SyncableType = void 0;
 var SyncableType;
 (function (SyncableType) {
     SyncableType["Team"] = "team";
     SyncableType["Channel"] = "channel";
 })(SyncableType || (exports.SyncableType = SyncableType = {}));
+/**
+ * Main sources for groups
+ */
 var GroupSource;
 (function (GroupSource) {
     GroupSource["Ldap"] = "ldap";
     GroupSource["Custom"] = "custom";
 })(GroupSource || (exports.GroupSource = GroupSource = {}));
+/**
+ * Special prefixes that can be added to group sources when they come from plugins
+ * Used for identifying plugin-created groups by checking if source starts with this prefix
+ */
+var PluginGroupSourcePrefix;
+(function (PluginGroupSourcePrefix) {
+    PluginGroupSourcePrefix["Plugin"] = "plugin_";
+})(PluginGroupSourcePrefix || (exports.PluginGroupSourcePrefix = PluginGroupSourcePrefix = {}));

package/lib/integrations.d.ts

@@ -120,9 +120,11 @@ export type IntegrationsState = {
     appsBotIDs: string[];
     systemCommands: IDMappedObjects<Command>;
     commands: IDMappedObjects<Command>;
+    dialogTriggerId: string;
     dialog?: {
         url: string;
         dialog: Dialog;
+        trigger_id: string;
     };
 };
 type Dialog = {

package/lib/properties.d.ts

@@ -1,8 +1,9 @@
+export type FieldType = ('text' | 'select' | 'multiselect' | 'date' | 'user' | 'multiuser');
 export type PropertyField = {
     id: string;
     group_id: string;
     name: string;
-    type: string;
+    type: FieldType;
     attrs?: {
         [key: string]: unknown;
     };
@@ -22,10 +23,25 @@ export type PropertyValue<T> = {
     update_at: number;
     delete_at: number;
 };
-export type UserPropertyFieldType = 'text';
+export type UserPropertyFieldType = 'text' | 'select' | 'multiselect';
 export type UserPropertyFieldGroupID = 'custom_profile_attributes';
+export type UserPropertyValueType = 'phone' | 'url' | '';
+export type FieldVisibility = 'always' | 'hidden' | 'when_set';
+export type FieldValueType = 'email' | 'url' | 'phone' | '';
+export type PropertyFieldOption = {
+    id: string;
+    name: string;
+    color?: string;
+};
 export type UserPropertyField = PropertyField & {
-    type: UserPropertyFieldType;
     group_id: UserPropertyFieldGroupID;
+    attrs: {
+        sort_order: number;
+        visibility: FieldVisibility;
+        value_type: FieldValueType;
+        options?: PropertyFieldOption[];
+        ldap?: string;
+        saml?: string;
+    };
 };
 export type UserPropertyFieldPatch = Partial<Pick<UserPropertyField, 'name' | 'attrs' | 'type'>>;

package/lib/users.d.ts

@@ -55,6 +55,8 @@ export type UserProfile = {
     terms_of_service_create_at: number;
     remote_id?: string;
     status?: string;
+    custom_profile_attributes?: Record<string, string | string[]>;
+    failed_attempts?: number;
 };
 export type UserProfileWithLastViewAt = UserProfile & {
     last_viewed_at: number;
@@ -90,6 +92,10 @@ export type UserStatus = {
     manual?: boolean;
     last_activity_at?: number;
     active_channel?: string;
+    /**
+     * The time when a user's timed DND status will expire. Unlike other timestamps in the app, this is in seconds
+     * instead of milliseconds.
+     */
     dnd_end_time?: number;
 };
 export declare enum CustomStatusDuration {

package/lib/utilities.d.ts

@@ -60,21 +60,17 @@ export declare const collectionToArray: <T extends {
 }>({ data, order }: IDMappedCollection<T>) => T[];
 export declare const collectionReplaceItem: <T extends {
     id: string;
-}>(collection: IDMappedCollection<T>, item: T) => {
-    data: IDMappedObjects<T> & {
-        [x: string]: T;
-    };
+}>(collection: IDMappedCollection<T>, ...items: T[]) => {
+    data: IDMappedObjects<T>;
     order: T["id"][];
     errors?: RelationOneToOne<T, Error> | undefined;
     warnings?: RelationOneToOne<T, { [Key in keyof T]?: string | undefined; }> | undefined;
 };
 export declare const collectionAddItem: <T extends {
     id: string;
-}>(collection: IDMappedCollection<T>, item: T) => {
-    data: IDMappedObjects<T> & {
-        [x: string]: T;
-    };
+}>(collection: IDMappedCollection<T>, ...items: T[]) => {
     order: string[];
+    data: IDMappedObjects<T>;
     errors?: RelationOneToOne<T, Error> | undefined;
     warnings?: RelationOneToOne<T, { [Key in keyof T]?: string | undefined; }> | undefined;
 };
@@ -86,4 +82,7 @@ export declare const collectionRemoveItem: <T extends {
     errors?: RelationOneToOne<T, Error> | undefined;
     warnings?: RelationOneToOne<T, { [Key in keyof T]?: string | undefined; }> | undefined;
 };
+export declare const idMappedObjectsFromArr: <T extends {
+    id: string;
+}>(items: T[], current?: IDMappedObjects<T>) => IDMappedObjects<T>;
 export {};

package/lib/utilities.js

@@ -2,7 +2,7 @@
 // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
 // See LICENSE.txt for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.collectionRemoveItem = exports.collectionAddItem = exports.collectionReplaceItem = exports.collectionToArray = exports.collectionFromArray = void 0;
+exports.idMappedObjectsFromArr = exports.collectionRemoveItem = exports.collectionAddItem = exports.collectionReplaceItem = exports.collectionToArray = exports.collectionFromArray = void 0;
 exports.isArrayOf = isArrayOf;
 exports.isStringArray = isStringArray;
 exports.isRecordOf = isRecordOf;
@@ -39,12 +39,12 @@ const collectionToArray = ({ data, order }) => {
     return order.map((id) => data[id]);
 };
 exports.collectionToArray = collectionToArray;
-const collectionReplaceItem = (collection, item) => {
-    return Object.assign(Object.assign({}, collection), { data: Object.assign(Object.assign({}, collection.data), { [item.id]: item }) });
+const collectionReplaceItem = (collection, ...items) => {
+    return Object.assign(Object.assign({}, collection), { data: (0, exports.idMappedObjectsFromArr)(items, collection.data) });
 };
 exports.collectionReplaceItem = collectionReplaceItem;
-const collectionAddItem = (collection, item) => {
-    return Object.assign(Object.assign({}, collection), { data: Object.assign(Object.assign({}, collection.data), { [item.id]: item }), order: [...collection.order, item.id] });
+const collectionAddItem = (collection, ...items) => {
+    return Object.assign(Object.assign({}, (0, exports.collectionReplaceItem)(collection, ...items)), { order: [...collection.order, ...items.map(({ id }) => id)] });
 };
 exports.collectionAddItem = collectionAddItem;
 const collectionRemoveItem = (collection, item) => {
@@ -54,3 +54,7 @@ const collectionRemoveItem = (collection, item) => {
     return Object.assign(Object.assign({}, collection), { data, order });
 };
 exports.collectionRemoveItem = collectionRemoveItem;
+const idMappedObjectsFromArr = (items, current) => {
+    return items.reduce((r, item) => (Object.assign(Object.assign({}, r), { [item.id]: item })), Object.assign({}, current));
+};
+exports.idMappedObjectsFromArr = idMappedObjectsFromArr;

package/package.json

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