@mattermost/types 7.9.0 → 8.0.0

package/README.md

@@ -12,21 +12,6 @@ import {UserProfile} from '@mattermost/types/users';
 
 For technologies that don't support that yet, you can add an alias in its package resolution settings to support that.
 
-### TypeScript
-
-In the `tsconfig.json`, you can use `compilerOptions.paths` to add that alias. This also requires a `compilerOptions.baseUrl` if you haven't set that already.
-
-```json
-{
-    "compilerOptions": {
-        "baseUrl": ".",
-        "paths": {
-            "@mattermost/types/*": ["node_modules/@mattermost/types/lib/*"]
-        }
-    }
-}
-```
-
 ### Jest
 
 In your Jest config, you can use the `moduleNameMapper` field to add that alias.
@@ -44,8 +29,8 @@ In your Jest config, you can use the `moduleNameMapper` field to add that alias.
 As a member of Mattermost with write access to our NPM organization, you can build and publish this package by running the following commands:
 
 ```bash
-npm run build --workspace=packages/types
-npm publish --workspace=packages/types
+npm run build --workspace=platform/types
+npm publish --workspace=platform/types
 ```
 
 Make sure to increment the version number in `package.json` first! You can add `-0`, `-1`, etc for pre-release versions.

package/lib/admin.d.ts

@@ -36,6 +36,7 @@ export declare type LogFilter = {
 };
 export declare type AdminState = {
     logs: LogObject[];
+    plainLogs: string[];
     audits: Record<string, Audit>;
     config: Partial<AdminConfig>;
     environmentConfig: Partial<EnvironmentConfig>;

package/lib/apps.d.ts

@@ -102,10 +102,11 @@ export declare type AppContext = {
 export declare type AppContextProps = {
     [name: string]: string;
 };
-export declare type AppExpandLevel = string;
+export declare type AppExpandLevel = '' | 'none' | 'summary' | '+summary' | 'all' | '+all';
 export declare type AppExpand = {
     app?: AppExpandLevel;
     acting_user?: AppExpandLevel;
+    acting_user_access_token?: AppExpandLevel;
     channel?: AppExpandLevel;
     config?: AppExpandLevel;
     mentioned?: AppExpandLevel;
@@ -114,6 +115,7 @@ export declare type AppExpand = {
     root_post?: AppExpandLevel;
     team?: AppExpandLevel;
     user?: AppExpandLevel;
+    locale?: AppExpandLevel;
 };
 export declare type AppForm = {
     title?: string;

package/lib/channels.d.ts

@@ -10,10 +10,13 @@ export declare type ChannelStats = {
 };
 export declare type ChannelNotifyProps = {
     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';
     ignore_channel_mentions: 'default' | 'off' | 'on';
+    channel_auto_follow_threads: 'off' | 'on';
 };
 export declare type Channel = {
     id: string;

package/lib/cloud.d.ts

@@ -36,6 +36,7 @@ export declare type Subscription = {
     is_free_trial: string;
     delinquent_since?: number;
     compliance_blocked?: string;
+    billing_type?: string;
 };
 export declare type Product = {
     id: string;
@@ -186,6 +187,10 @@ export interface CreateSubscriptionRequest {
     seats: number;
     internal_purchase_order?: string;
 }
+export interface NewsletterRequestBody {
+    email: string;
+    subscribed_content: string;
+}
 export declare const areShippingDetailsValid: (address: Address | null | undefined) => boolean;
 export declare type Feedback = {
     reason: string;
@@ -193,6 +198,6 @@ export declare type Feedback = {
 };
 export declare type WorkspaceDeletionRequest = {
     subscription_id: string;
-    feedback: Feedback;
+    delete_feedback: Feedback;
 };
 export {};

package/lib/config.d.ts

@@ -13,13 +13,10 @@ export declare type ClientConfig = {
     BannerColor: string;
     BannerText: string;
     BannerTextColor: string;
-    BuildBoards: string;
     BuildDate: string;
     BuildEnterpriseReady: string;
     BuildHash: string;
-    BuildHashBoards: string;
     BuildHashEnterprise: string;
-    BuildHashPlaybooks: string;
     BuildNumber: string;
     CollapsedThreads: CollapsedThreads;
     CustomBrandText: string;
@@ -28,6 +25,7 @@ export declare type ClientConfig = {
     CustomTermsOfServiceReAcceptancePeriod: string;
     CustomUrlSchemes: string;
     CWSURL: string;
+    CWSMock: string;
     DataRetentionEnableFileDeletion: string;
     DataRetentionEnableMessageDeletion: string;
     DataRetentionFileRetentionDays: string;
@@ -36,6 +34,7 @@ export declare type ClientConfig = {
     DefaultTheme: string;
     DiagnosticId: string;
     DiagnosticsEnabled: string;
+    DisableRefetchingOnBrowserFocus: string;
     EmailLoginButtonBorderColor: string;
     EmailLoginButtonColor: string;
     EmailLoginButtonTextColor: string;
@@ -119,6 +118,7 @@ export declare type ClientConfig = {
     FeatureFlagGraphQL: string;
     GfycatAPIKey: string;
     GfycatAPISecret: string;
+    GiphySdkKey: string;
     GoogleDeveloperKey: string;
     GuestAccountsEnforceMultifactorAuthentication: string;
     HasImageProxy: string;
@@ -187,11 +187,17 @@ export declare type ClientConfig = {
     WebsocketSecurePort: string;
     WebsocketURL: string;
     ExperimentalSharedChannels: string;
-    EnableAppBar: string;
+    DisableAppBar: string;
     EnableComplianceExport: string;
     PostPriority: string;
     ReduceOnBoardingTaskList: string;
     PostAcknowledgements: string;
+    AllowPersistentNotifications: string;
+    PersistentNotificationMaxRecipients: string;
+    PersistentNotificationIntervalMinutes: string;
+    AllowPersistentNotificationsForGuests: string;
+    DelayChannelAutocomplete: 'true' | 'false';
+    ServiceEnvironment: string;
 };
 export declare type License = {
     id: string;
@@ -241,12 +247,19 @@ export declare type RequestLicenseBody = {
     users: number;
     terms_accepted: boolean;
     receive_emails_accepted: boolean;
+    contact_name: string;
+    contact_email: string;
+    company_name: string;
+    company_size: string;
+    company_country: string;
 };
 export declare type DataRetentionPolicy = {
     message_deletion_enabled: boolean;
     file_deletion_enabled: boolean;
     message_retention_cutoff: number;
     file_retention_cutoff: number;
+    boards_retention_cutoff: number;
+    boards_deletion_enabled: boolean;
 };
 export declare type ServiceSettings = {
     SiteURL: string;
@@ -312,6 +325,7 @@ export declare type ServiceSettings = {
     EnableGifPicker: boolean;
     GfycatAPIKey: string;
     GfycatAPISecret: string;
+    GiphySdkKey: string;
     PostEditTimeLimit: number;
     TimeBetweenUserTypingUpdatesMilliseconds: number;
     EnablePostSearch: boolean;
@@ -352,6 +366,11 @@ export declare type ServiceSettings = {
     EnableCustomGroups: boolean;
     SelfHostedPurchase: boolean;
     AllowSyncedDrafts: boolean;
+    AllowPersistentNotifications: boolean;
+    AllowPersistentNotificationsForGuests: boolean;
+    PersistentNotificationIntervalMinutes: number;
+    PersistentNotificationMaxCount: number;
+    PersistentNotificationMaxRecipients: number;
 };
 export declare type TeamSettings = {
     SiteName: string;
@@ -499,7 +518,6 @@ export declare type EmailSettings = {
     LoginButtonColor: string;
     LoginButtonBorderColor: string;
     LoginButtonTextColor: string;
-    EnableInactivityEmail: boolean;
 };
 export declare type RateLimitSettings = {
     Enable: boolean;
@@ -686,8 +704,9 @@ export declare type ExperimentalSettings = {
     UseNewSAMLLibrary: boolean;
     EnableSharedChannels: boolean;
     EnableRemoteClusterService: boolean;
-    EnableAppBar: boolean;
-    PatchPluginsReactDOM: boolean;
+    DisableAppBar: boolean;
+    DisableRefetchingOnBrowserFocus: boolean;
+    DelayChannelAutocomplete: boolean;
 };
 export declare type AnalyticsSettings = {
     MaxUsersForStatistics: number;
@@ -717,6 +736,7 @@ export declare type ElasticsearchSettings = {
     ClientCert: string;
     ClientKey: string;
     Trace: string;
+    IgnoredPurgeIndexes: string;
 };
 export declare type BleveSettings = {
     IndexDir: string;
@@ -756,9 +776,7 @@ export declare type JobSettings = {
     CleanupJobsThresholdDays: number;
     CleanupConfigThresholdDays: number;
 };
-export declare type ProductSettings = {
-    EnablePublicSharedBoards: boolean;
-};
+export declare type ProductSettings = {};
 export declare type PluginSettings = {
     Enable: boolean;
     EnableUploads: boolean;
@@ -874,3 +892,8 @@ export declare enum CollapsedThreads {
     DEFAULT_OFF = "default_off",
     ALWAYS_ON = "always_on"
 }
+export declare enum ServiceEnvironment {
+    PRODUCTION = "production",
+    TEST = "test",
+    DEV = "dev"
+}

package/lib/config.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.CollapsedThreads = void 0;
+exports.ServiceEnvironment = exports.CollapsedThreads = void 0;
 var CollapsedThreads;
 (function (CollapsedThreads) {
     CollapsedThreads["DISABLED"] = "disabled";
@@ -10,3 +10,9 @@ var CollapsedThreads;
     CollapsedThreads["DEFAULT_OFF"] = "default_off";
     CollapsedThreads["ALWAYS_ON"] = "always_on";
 })(CollapsedThreads = exports.CollapsedThreads || (exports.CollapsedThreads = {}));
+var ServiceEnvironment;
+(function (ServiceEnvironment) {
+    ServiceEnvironment["PRODUCTION"] = "production";
+    ServiceEnvironment["TEST"] = "test";
+    ServiceEnvironment["DEV"] = "dev";
+})(ServiceEnvironment = exports.ServiceEnvironment || (exports.ServiceEnvironment = {}));

package/lib/hosted_customer.d.ts

@@ -13,6 +13,7 @@ export interface SelfHostedSignupForm {
     first_name: string;
     last_name: string;
     billing_address: Address;
+    shipping_address: Address;
     organization: string;
 }
 export interface SelfHostedSignupBootstrapResponse {
@@ -61,4 +62,8 @@ export interface TrueUpReviewProfileReducer extends TrueUpReviewProfile {
 export interface TrueUpReviewStatusReducer extends TrueUpReviewStatus {
     getRequestState: RequestState;
 }
+export declare type SelfHostedExpansionRequest = {
+    seats: number;
+    license_id: string;
+};
 export {};

package/lib/posts.d.ts

@@ -4,7 +4,7 @@ import { FileInfo } from './files';
 import { Reaction } from './reactions';
 import { UserProfile } from './users';
 import { RelationOneToOne, RelationOneToMany, IDMappedObjects } from './utilities';
-export declare 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' | '';
+export declare 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 declare type PostEmbedType = 'image' | 'link' | 'message_attachment' | 'opengraph' | 'permalink';
 export declare type PostEmbed = {
     type: PostEmbedType;
@@ -158,3 +158,9 @@ export declare type PostAnalytics = {
     requested_ack?: boolean;
     persistent_notifications?: boolean;
 };
+export declare type ActivityEntry = {
+    postType: Post['type'];
+    actorId: string[];
+    userIds: string[];
+    usernames: string[];
+};

package/lib/setup.d.ts

@@ -1,3 +1,4 @@
 export declare type CompleteOnboardingRequest = {
+    organization: string;
     install_plugins: string[];
 };

package/lib/store.d.ts

@@ -23,7 +23,6 @@ import { UsersState } from './users';
 import { AppsState } from './apps';
 import { InsightsState } from './insights';
 import { GifsState } from './gifs';
-import { WorkTemplatesState } from './work_templates';
 export declare type GlobalState = {
     entities: {
         general: GeneralState;
@@ -62,7 +61,6 @@ export declare type GlobalState = {
         hostedCustomer: HostedCustomerState;
         usage: CloudUsage;
         insights: InsightsState;
-        worktemplates: WorkTemplatesState;
     };
     errors: any[];
     requests: {

package/lib/users.d.ts

@@ -7,6 +7,7 @@ import { IDMappedObjects, RelationOneToMany, RelationOneToManyUnique, RelationOn
 export declare type UserNotifyProps = {
     desktop: 'default' | 'all' | 'mention' | 'none';
     desktop_sound: 'true' | 'false';
+    calls_desktop_sound: 'true' | 'false';
     email: 'true' | 'false';
     mark_unread: 'all' | 'mention';
     push: 'default' | 'all' | 'mention' | 'none';
@@ -16,6 +17,7 @@ export declare type UserNotifyProps = {
     channel: 'true' | 'false';
     mention_keys: string;
     desktop_notification_sound?: 'Bing' | 'Crackle' | 'Down' | 'Hello' | 'Ripple' | 'Upstairs';
+    calls_notification_sound?: 'Dynamic' | 'Calm' | 'Urgent' | 'Cheerful';
     desktop_threads?: 'default' | 'all' | 'mention' | 'none';
     email_threads?: 'default' | 'all' | 'mention' | 'none';
     push_threads?: 'default' | 'all' | 'mention' | 'none';

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@mattermost/types",
-  "version": "7.9.0",
+  "version": "8.0.0",
   "description": "Shared type definitions used by the Mattermost web app",
   "keywords": [
     "mattermost"
   ],
-  "homepage": "https://github.com/mattermost/mattermost-webapp/tree/master/packages/types#readme",
+  "homepage": "https://github.com/mattermost/mattermost-server/tree/master/webapp/platform/types#readme",
   "license": "MIT",
   "files": [
     "lib"
@@ -13,11 +13,17 @@
   "exports": {
     "./*": "./lib/*.js"
   },
-  "types": "./lib/*.d.ts",
+  "typesVersions": {
+    ">=3.1": {
+      "*": [
+        "./lib/*.d.ts"
+      ]
+    }
+  },
   "repository": {
     "type": "git",
-    "url": "github:mattermost/mattermost-webapp",
-    "directory": "packages/types"
+    "url": "github:mattermost/mattermost-server",
+    "directory": "webapp/platform/types"
   },
   "peerDependencies": {
     "typescript": "^4.3"

package/lib/work_templates.d.ts

@@ -1,82 +0,0 @@
-import { RequireOnlyOne } from './utilities';
-export declare type WorkTemplatesState = {
-    categories: Category[];
-    templatesInCategory: Record<string, WorkTemplate[]>;
-    playbookTemplates: PlaybookTemplateType[];
-};
-interface PlaybookTemplateType {
-    title: string;
-    template: any;
-}
-export interface ExecuteWorkTemplateRequest {
-    team_id: string;
-    name: string;
-    visibility: Visibility;
-    work_template: WorkTemplate;
-    playbook_templates?: PlaybookTemplateType[];
-}
-export interface ExecuteWorkTemplateResponse {
-    channel_with_playbook_ids: string[];
-    channel_ids: string[];
-}
-export interface WorkTemplate {
-    id: string;
-    category: string;
-    useCase: string;
-    description: Description;
-    illustration: string;
-    visibility: Visibility;
-    content: ValidContent[];
-}
-export declare const categories: string[];
-export interface Category {
-    id: typeof categories[number];
-    name: string;
-}
-export interface Channel {
-    id: string;
-    name: string;
-    illustration: string;
-    playbook?: string;
-}
-export interface Board {
-    id: string;
-    name: string;
-    illustration: string;
-    channel?: string;
-}
-export interface Playbook {
-    id: string;
-    name: string;
-    illustration: string;
-    template: string;
-}
-export interface Integration {
-    id: string;
-    name?: string;
-    icon?: string;
-    installed?: boolean;
-}
-interface Content {
-    channel?: Channel;
-    board?: Board;
-    playbook?: Playbook;
-    integration?: Integration;
-}
-declare type ValidContent = RequireOnlyOne<Content, 'channel' | 'board' | 'playbook' | 'integration'>;
-export interface MessageWithIllustration {
-    message: string;
-    illustration?: string;
-}
-declare type MessageWithMandatoryIllustration = Partial<MessageWithIllustration> & Required<Pick<MessageWithIllustration, 'illustration'>>;
-interface Description {
-    channel: MessageWithIllustration;
-    board: MessageWithIllustration;
-    playbook: MessageWithIllustration;
-    integration: MessageWithMandatoryIllustration;
-}
-export declare enum Visibility {
-    Public = "public",
-    Private = "private"
-}
-export {};

package/lib/work_templates.js

@@ -1,11 +0,0 @@
-"use strict";
-// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
-// See LICENSE.txt for license information.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Visibility = exports.categories = void 0;
-exports.categories = ['product', 'devops', 'company_wide', 'leadership', 'design'];
-var Visibility;
-(function (Visibility) {
-    Visibility["Public"] = "public";
-    Visibility["Private"] = "private";
-})(Visibility = exports.Visibility || (exports.Visibility = {}));