@mattermost/types 10.7.0 → 10.9.0

package/lib/access_control.d.ts

@@ -0,0 +1,70 @@
+import type { ChannelWithTeamData } from './channels';
+import type { UserProfile } from './users';
+export type AccessControlPolicy = {
+    id: string;
+    name: string;
+    type: string;
+    revision?: number;
+    created_at?: number;
+    version?: string;
+    active?: boolean;
+    imports?: string[];
+    props?: Record<string, unknown[]>;
+    rules: AccessControlPolicyRule[];
+};
+export type AccessControlPolicyCursor = {
+    id: string;
+};
+export type AccessControlPoliciesResult = {
+    policies: AccessControlPolicy[];
+    total: number;
+};
+export type AccessControlPolicySearchOpts = {
+    term: string;
+    type: string;
+    cursor: AccessControlPolicyCursor;
+    limit: number;
+};
+export type AccessControlPolicyChannelsResult = {
+    channels: ChannelWithTeamData[];
+    total: number;
+};
+export type AccessControlPolicyRule = {
+    actions?: string[];
+    expression: string;
+};
+export type CELExpressionError = {
+    message: string;
+    line: number;
+    column: number;
+};
+export type AccessControlTestResult = {
+    users: UserProfile[];
+    total: number;
+};
+export type AccessControlAttribute = {
+    name: string;
+    values: string[];
+};
+export type AccessControlVisualAST = {
+    conditions: AccessControlVisualASTNode[];
+};
+export type AccessControlVisualASTNode = {
+    attribute: string;
+    operator: string;
+    value: any;
+    value_type: number;
+};
+/**
+ * Type definition for access control attributes
+ */
+export type AccessControlAttributes = Record<string, string[]>;
+/**
+ * Interface for entities that can have access control
+ */
+export interface AccessControlled {
+    /**
+     * Whether access control is enforced for this entity
+     */
+    access_control_enforced?: boolean;
+}

package/lib/access_control.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/admin.d.ts

@@ -1,3 +1,4 @@
+import type { AccessControlPolicy } from './access_control';
 import type { Audit } from './audits';
 import type { Compliance } from './compliance';
 import type { AdminConfig, ClientLicense, EnvironmentConfig } from './config';
@@ -7,7 +8,7 @@ import type { PluginRedux, PluginStatusRedux } from './plugins';
 import type { SamlCertificateStatus, SamlMetadataResponse } from './saml';
 import type { Team } from './teams';
 import type { UserAccessToken, UserProfile } from './users';
-import type { RelationOneToOne } from './utilities';
+import type { RelationOneToOne, IDMappedObjects } from './utilities';
 export declare enum LogLevelEnum {
     SILLY = "silly",
     DEBUG = "debug",
@@ -60,6 +61,8 @@ export type AdminState = {
     dataRetentionCustomPolicies: DataRetentionCustomPolicies;
     dataRetentionCustomPoliciesCount: number;
     prevTrialLicense: ClientLicense;
+    accessControlPolicies: IDMappedObjects<AccessControlPolicy>;
+    channelsForAccessControlPolicy: Record<string, string[]>;
 };
 export type AnalyticsState = {
     POST_PER_DAY?: AnalyticsRow[];

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,8 @@ export type Channel = {
     shared?: boolean;
     props?: Record<string, any>;
     policy_id?: string | null;
+    banner_info?: ChannelBanner;
+    policy_enforced?: boolean;
 };
 export type ServerChannel = Channel & {
     /**
@@ -174,4 +182,7 @@ export type ChannelSearchOpts = {
     deleted?: boolean;
     page?: number;
     per_page?: number;
+    access_control_policy_enforced?: boolean;
+    exclude_access_control_policy_enforced?: boolean;
+    parent_access_control_policy_id?: string;
 };

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/client4.d.ts

@@ -32,9 +32,11 @@ export type FetchPaginatedThreadOptions = {
     fetchThreads?: boolean;
     collapsedThreads?: boolean;
     collapsedThreadsExtended?: boolean;
+    updatesOnly?: boolean;
     direction?: 'up' | 'down';
     fetchAll?: boolean;
     perPage?: number;
     fromCreateAt?: number;
+    fromUpdateAt?: number;
     fromPost?: string;
 };

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;
@@ -121,6 +122,7 @@ export type ClientConfig = {
     FeatureFlagAppsEnabled: string;
     FeatureFlagCallsEnabled: string;
     FeatureFlagCustomProfileAttributes: string;
+    FeatureFlagAttributeBasedAccessControl: string;
     FeatureFlagWebSocketEventScope: string;
     ForgotPasswordLink: string;
     GiphySdkKey: string;
@@ -164,6 +166,9 @@ export type ClientConfig = {
     PostEditTimeLimit: string;
     PrivacyPolicyLink: string;
     ReportAProblemLink: string;
+    ReportAProblemType: string;
+    ReportAProblemMail: string;
+    AllowDownloadLogs: string;
     RequireEmailVerification: string;
     RestrictDirectMessage: string;
     RunJobs: string;
@@ -343,6 +348,7 @@ export type ServiceSettings = {
     GiphySdkKey: string;
     PostEditTimeLimit: number;
     TimeBetweenUserTypingUpdatesMilliseconds: number;
+    EnableCrossTeamSearch: boolean;
     EnablePostSearch: boolean;
     EnableFileSearch: boolean;
     MinimumHashtagLength: number;
@@ -391,6 +397,8 @@ export type ServiceSettings = {
     EnableDesktopLandingPage: boolean;
     MaximumURLLength: number;
     ScheduledPosts: boolean;
+    EnableWebHubChannelIteration: boolean;
+    FrameAncestors: string;
 };
 export type TeamSettings = {
     SiteName: string;
@@ -465,6 +473,7 @@ export type ExperimentalAuditSettings = {
     FileCompress: boolean;
     FileMaxQueueSize: number;
     AdvancedLoggingJSON: Record<string, any>;
+    Certificate: string;
 };
 export type NotificationLogSettings = {
     EnableConsole: boolean;
@@ -598,6 +607,9 @@ export type SupportSettings = {
     AboutLink: string;
     HelpLink: string;
     ReportAProblemLink: string;
+    ReportAProblemType: string;
+    ReportAProblemMail: string;
+    AllowDownloadLogs: boolean;
     ForgotPasswordLink: string;
     SupportEmail: string;
     CustomTermsOfServiceEnabled: boolean;
@@ -736,6 +748,9 @@ export type NativeAppSettings = {
     AndroidAppDownloadLink: string;
     IosAppDownloadLink: string;
     MobileExternalBrowser: boolean;
+    MobileEnableBiometrics: boolean;
+    MobilePreventScreenCapture: boolean;
+    MobileJailbreakProtection: boolean;
 };
 export type ClusterSettings = {
     Enable: boolean;
@@ -756,6 +771,7 @@ export type MetricsSettings = {
     ListenAddress: string;
     EnableClientMetrics: boolean;
     EnableNotificationMetrics: boolean;
+    ClientSideUserIds: string[];
 };
 export type ExperimentalSettings = {
     ClientSideCertEnable: boolean;
@@ -779,6 +795,7 @@ export type CacheSettings = {
     RedisAddress: string;
     RedisPassword: string;
     RedisDB: number;
+    RedisCachePrefix: string;
     DisableClientCache: boolean;
 };
 export type ElasticsearchSettings = {
@@ -799,6 +816,7 @@ export type ElasticsearchSettings = {
     AggregatePostsAfterDays: number;
     PostsAggregatorJobStartTime: string;
     IndexPrefix: string;
+    GlobalSearchPrefix: string;
     LiveIndexingBatchSize: number;
     BatchSize: number;
     RequestTimeoutSeconds: number;
@@ -906,6 +924,10 @@ export type ExportSettings = {
     Directory: string;
     RetentionDays: number;
 };
+export type AccessControlSettings = {
+    EnableAttributeBasedAccessControl: boolean;
+    EnableChannelScopeAccessControl: boolean;
+};
 export type AdminConfig = {
     ServiceSettings: ServiceSettings;
     TeamSettings: TeamSettings;
@@ -951,6 +973,7 @@ export type AdminConfig = {
     ExportSettings: ExportSettings;
     WranglerSettings: WranglerSettings;
     ConnectedWorkspacesSettings: ConnectedWorkspacesSettings;
+    AccessControlSettings: AccessControlSettings;
 };
 export type ReplicaLagSetting = {
     DataSource: string;

package/lib/groups.d.ts

@@ -152,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/jobs.d.ts

@@ -1,5 +1,5 @@
 import type { IDMappedObjects } from './utilities';
-export type JobType = 'data_retention' | 'elasticsearch_post_indexing' | 'bleve_post_indexing' | 'ldap_sync' | 'message_export';
+export type JobType = 'data_retention' | 'elasticsearch_post_indexing' | 'bleve_post_indexing' | 'ldap_sync' | 'message_export' | 'access_control_sync';
 export type JobStatus = 'pending' | 'in_progress' | 'success' | 'error' | 'cancel_requested' | 'canceled' | 'warning';
 export type Job = JobTypeBase & {
     id: string;

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,13 +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;
+    attrs: {
+        sort_order: number;
+        visibility: FieldVisibility;
+        value_type: FieldValueType;
+        options?: PropertyFieldOption[];
+        ldap?: string;
+        saml?: string;
     };
 };
-export type UserPropertyFieldPatch = Partial<Pick<UserPropertyField, 'name' | 'attrs' | 'type' | 'attrs'>>;
+export type UserPropertyFieldPatch = Partial<Pick<UserPropertyField, 'name' | 'attrs' | 'type'>>;

package/lib/users.d.ts

@@ -55,8 +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;
-    custom_profile_attributes?: Record<string, string>;
 };
 export type UserProfileWithLastViewAt = UserProfile & {
     last_viewed_at: number;

package/package.json

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