@mattermost/types 6.7.0-0

package/README.md

@@ -0,0 +1,53 @@
+# Mattermost Types
+
+This package contains shared type definitions used by [the Mattermost web app](https://github.com/mattermost/mattermost-webapp) and related projects.
+
+**It is currently a work in progress and contains internal types that will be removed in a followup release.**
+
+## Usage
+
+For technologies that support [subpath exports](https://nodejs.org/api/packages.html#subpath-exports), such as Node.js, Webpack, and Babel, you can import these types directly from individual files.
+
+```javascript
+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.
+
+```json
+{
+    "moduleNameMapper": {
+        "^@mattermost/types/(.*)$": "<rootDir>/node_modules/@mattermost/types/lib/$1"
+    }
+}
+```
+
+## Compilation and Packaging
+
+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
+```
+
+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

@@ -0,0 +1,50 @@
+import { Audit } from './audits';
+import { Compliance } from './compliance';
+import { AdminConfig, ClientLicense, EnvironmentConfig } from './config';
+import { DataRetentionCustomPolicies } from './data_retention';
+import { MixedUnlinkedGroupRedux } from './groups';
+import { PluginRedux, PluginStatusRedux } from './plugins';
+import { SamlCertificateStatus, SamlMetadataResponse } from './saml';
+import { Team } from './teams';
+import { UserAccessToken, UserProfile } from './users';
+import { RelationOneToOne } from './utilities';
+export declare type ConsoleAccess = {
+    read: Record<string, boolean>;
+    write: Record<string, boolean>;
+};
+export declare type AdminState = {
+    logs: string[];
+    audits: Record<string, Audit>;
+    config: Partial<AdminConfig>;
+    environmentConfig: Partial<EnvironmentConfig>;
+    complianceReports: Record<string, Compliance>;
+    ldapGroups: Record<string, MixedUnlinkedGroupRedux>;
+    ldapGroupsCount: number;
+    userAccessTokens: Record<string, UserAccessToken>;
+    clusterInfo: ClusterInfo[];
+    samlCertStatus?: SamlCertificateStatus;
+    analytics?: Record<string, number | AnalyticsRow[]>;
+    teamAnalytics?: RelationOneToOne<Team, Record<string, number | AnalyticsRow[]>>;
+    userAccessTokensByUser?: RelationOneToOne<UserProfile, Record<string, UserAccessToken>>;
+    plugins?: Record<string, PluginRedux>;
+    pluginStatuses?: Record<string, PluginStatusRedux>;
+    samlMetadataResponse?: SamlMetadataResponse;
+    dataRetentionCustomPolicies: DataRetentionCustomPolicies;
+    dataRetentionCustomPoliciesCount: number;
+    prevTrialLicense: ClientLicense;
+};
+export declare type ClusterInfo = {
+    id: string;
+    version: string;
+    config_hash: string;
+    ipaddress: string;
+    hostname: string;
+};
+export declare type AnalyticsRow = {
+    name: string;
+    value: number;
+};
+export declare type SchemaMigration = {
+    version: number;
+    name: string;
+};

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

@@ -0,0 +1,182 @@
+export declare enum Permission {
+    UserJoinedChannelNotification = "user_joined_channel_notification",
+    ActAsBot = "act_as_bot",
+    ActAsUser = "act_as_user",
+    PermissionActAsAdmin = "act_as_admin",
+    RemoteOAuth2 = "remote_oauth2",
+    RemoteWebhooks = "remote_webhooks"
+}
+export declare enum Locations {
+    PostMenu = "/post_menu",
+    ChannelHeader = "/channel_header",
+    Command = "/command",
+    InPost = "/in_post"
+}
+export declare type AppManifest = {
+    app_id: string;
+    version?: string;
+    homepage_url?: string;
+    icon?: string;
+    display_name: string;
+    description?: string;
+    requested_permissions?: Permission[];
+    requested_locations?: Locations[];
+};
+export declare type AppModalState = {
+    form: AppForm;
+    call: AppCallRequest;
+};
+export declare type AppCommandFormMap = {
+    [location: string]: AppForm;
+};
+export declare type BindingsInfo = {
+    bindings: AppBinding[];
+    forms: AppCommandFormMap;
+};
+export declare type AppsState = {
+    main: BindingsInfo;
+    rhs: BindingsInfo;
+    pluginEnabled: boolean;
+};
+export declare type AppBinding = {
+    app_id: string;
+    location?: string;
+    icon?: string;
+    label: string;
+    hint?: string;
+    description?: string;
+    role_id?: string;
+    depends_on_team?: boolean;
+    depends_on_channel?: boolean;
+    depends_on_user?: boolean;
+    depends_on_post?: boolean;
+    bindings?: AppBinding[];
+    form?: AppForm;
+    submit?: AppCall;
+};
+export declare type AppCallValues = {
+    [name: string]: any;
+};
+export declare type AppCall = {
+    path: string;
+    expand?: AppExpand;
+    state?: any;
+};
+export declare 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> = {
+    type: AppCallResponseType;
+    text?: string;
+    data?: Res;
+    navigate_to_url?: string;
+    use_external_browser?: boolean;
+    call?: AppCall;
+    form?: AppForm;
+    app_metadata?: AppMetadataForClient;
+};
+export declare type AppMetadataForClient = {
+    bot_user_id: string;
+    bot_username: string;
+};
+export declare type AppContext = {
+    app_id: string;
+    location?: string;
+    acting_user_id?: string;
+    user_id?: string;
+    channel_id?: string;
+    team_id?: string;
+    post_id?: string;
+    root_id?: string;
+    props?: AppContextProps;
+    user_agent?: string;
+    track_as_submit?: boolean;
+};
+export declare type AppContextProps = {
+    [name: string]: string;
+};
+export declare type AppExpandLevel = string;
+export declare type AppExpand = {
+    app?: AppExpandLevel;
+    acting_user?: AppExpandLevel;
+    channel?: AppExpandLevel;
+    config?: AppExpandLevel;
+    mentioned?: AppExpandLevel;
+    parent_post?: AppExpandLevel;
+    post?: AppExpandLevel;
+    root_post?: AppExpandLevel;
+    team?: AppExpandLevel;
+    user?: AppExpandLevel;
+};
+export declare type AppForm = {
+    title?: string;
+    header?: string;
+    footer?: string;
+    icon?: string;
+    submit_buttons?: string;
+    cancel_button?: boolean;
+    submit_on_cancel?: boolean;
+    fields?: AppField[];
+    source?: AppCall;
+    submit?: AppCall;
+    depends_on?: string[];
+};
+export declare type AppFormValue = string | AppSelectOption | boolean | null;
+export declare type AppFormValues = {
+    [name: string]: AppFormValue;
+};
+export declare type AppSelectOption = {
+    label: string;
+    value: string;
+    icon_data?: string;
+};
+export declare type AppFieldType = string;
+export declare type AppField = {
+    name: string;
+    type: AppFieldType;
+    is_required?: boolean;
+    readonly?: boolean;
+    value?: AppFormValue;
+    description?: string;
+    label?: string;
+    hint?: string;
+    position?: number;
+    modal_label?: string;
+    refresh?: boolean;
+    options?: AppSelectOption[];
+    multiselect?: boolean;
+    lookup?: AppCall;
+    subtype?: string;
+    min_length?: number;
+    max_length?: number;
+};
+export declare type AutocompleteSuggestion = {
+    suggestion: string;
+    complete?: string;
+    description?: string;
+    hint?: string;
+    iconData?: string;
+};
+export declare type AutocompleteSuggestionWithComplete = AutocompleteSuggestion & {
+    complete: string;
+};
+export declare type AutocompleteElement = AppField;
+export declare type AutocompleteStaticSelect = AutocompleteElement & {
+    options: AppSelectOption[];
+};
+export declare type AutocompleteDynamicSelect = AutocompleteElement;
+export declare type AutocompleteUserSelect = AutocompleteElement;
+export declare type AutocompleteChannelSelect = AutocompleteElement;
+export declare type FormResponseData = {
+    errors?: {
+        [field: string]: string;
+    };
+};
+export declare type AppLookupResponse = {
+    items: AppSelectOption[];
+};

package/lib/apps.js

@@ -0,0 +1,24 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Locations = exports.Permission = void 0;
+// This file's contents belong to the Apps Framework feature.
+// Apps Framework feature is experimental, and the contents of this file are
+// susceptible to breaking changes without pushing the major version of this package.
+var Permission;
+(function (Permission) {
+    Permission["UserJoinedChannelNotification"] = "user_joined_channel_notification";
+    Permission["ActAsBot"] = "act_as_bot";
+    Permission["ActAsUser"] = "act_as_user";
+    Permission["PermissionActAsAdmin"] = "act_as_admin";
+    Permission["RemoteOAuth2"] = "remote_oauth2";
+    Permission["RemoteWebhooks"] = "remote_webhooks";
+})(Permission = exports.Permission || (exports.Permission = {}));
+var Locations;
+(function (Locations) {
+    Locations["PostMenu"] = "/post_menu";
+    Locations["ChannelHeader"] = "/channel_header";
+    Locations["Command"] = "/command";
+    Locations["InPost"] = "/in_post";
+})(Locations = exports.Locations || (exports.Locations = {}));

package/lib/audits.d.ts

@@ -0,0 +1,9 @@
+export declare type Audit = {
+    id: string;
+    create_at: number;
+    user_id: string;
+    action: string;
+    extra_info: string;
+    ip_address: string;
+    session_id: string;
+};

package/lib/audits.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/autocomplete.d.ts

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

package/lib/autocomplete.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/bots.d.ts

@@ -0,0 +1,15 @@
+export declare type Bot = {
+    user_id: string;
+    username: string;
+    display_name?: string;
+    description?: string;
+    owner_id: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+};
+export declare type BotPatch = {
+    username: string;
+    display_name: string;
+    description: string;
+};

package/lib/bots.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/channel_categories.d.ts

@@ -0,0 +1,30 @@
+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 declare enum CategorySorting {
+    Alphabetical = "alpha",
+    Default = "",
+    Recency = "recent",
+    Manual = "manual"
+}
+export declare type ChannelCategory = {
+    id: string;
+    user_id: UserProfile['id'];
+    team_id: Team['id'];
+    type: ChannelCategoryType;
+    display_name: string;
+    sorting: CategorySorting;
+    channel_ids: Array<Channel['id']>;
+    muted: boolean;
+    collapsed: boolean;
+};
+export declare type OrderedChannelCategories = {
+    categories: ChannelCategory[];
+    order: string[];
+};
+export declare type ChannelCategoriesState = {
+    byId: IDMappedObjects<ChannelCategory>;
+    orderByTeam: RelationOneToOne<Team, Array<ChannelCategory['id']>>;
+};

package/lib/channel_categories.js

@@ -0,0 +1,12 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CategorySorting = void 0;
+var CategorySorting;
+(function (CategorySorting) {
+    CategorySorting["Alphabetical"] = "alpha";
+    CategorySorting["Default"] = "";
+    CategorySorting["Recency"] = "recent";
+    CategorySorting["Manual"] = "manual";
+})(CategorySorting = exports.CategorySorting || (exports.CategorySorting = {}));

package/lib/channels.d.ts

@@ -0,0 +1,165 @@
+import { IDMappedObjects, RelationOneToMany, RelationOneToOne } from './utilities';
+import { Team } from './teams';
+export declare type ChannelType = 'O' | 'P' | 'D' | 'G';
+export declare type ChannelStats = {
+    channel_id: string;
+    member_count: number;
+    guest_count: number;
+    pinnedpost_count: number;
+    files_count: number;
+};
+export declare type ChannelNotifyProps = {
+    desktop: 'default' | 'all' | 'mention' | 'none';
+    email: 'default' | 'all' | 'mention' | 'none';
+    mark_unread: 'all' | 'mention';
+    push: 'default' | 'all' | 'mention' | 'none';
+    ignore_channel_mentions: 'default' | 'off' | 'on';
+};
+export declare type Channel = {
+    id: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    team_id: string;
+    type: ChannelType;
+    display_name: string;
+    name: string;
+    header: string;
+    purpose: string;
+    last_post_at: number;
+    last_root_post_at: number;
+    creator_id: string;
+    scheme_id: string;
+    teammate_id?: string;
+    status?: string;
+    group_constrained: boolean;
+    shared?: boolean;
+    props?: Record<string, any>;
+    policy_id?: string | null;
+};
+export declare type ServerChannel = Channel & {
+    /**
+     * The total number of posts in this channel, not including join/leave messages
+     *
+     * @remarks This field will be moved to a {@link ChannelMessageCount} object when this channel is stored in Redux.
+     */
+    total_msg_count: number;
+    /**
+     * The number of root posts in this channel, not including join/leave messages
+     *
+     * @remarks This field will be moved to a {@link ChannelMessageCount} object when this channel is stored in Redux.
+     */
+    total_msg_count_root: number;
+};
+export declare 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 & {
+    team_display_name: string;
+    team_name: string;
+    team_update_at: number;
+};
+export declare type ChannelsWithTotalCount = {
+    channels: ChannelWithTeamData[];
+    total_count: number;
+};
+export declare type ChannelMembership = {
+    channel_id: string;
+    user_id: string;
+    roles: string;
+    last_viewed_at: number;
+    /** The number of posts in this channel which have been read by the user */
+    msg_count: number;
+    /** The number of root posts in this channel which have been read by the user */
+    msg_count_root: number;
+    /** The number of unread mentions in this channel */
+    mention_count: number;
+    /** The number of unread mentions in root posts in this channel */
+    mention_count_root: number;
+    notify_props: Partial<ChannelNotifyProps>;
+    last_update_at: number;
+    scheme_user: boolean;
+    scheme_admin: boolean;
+    post_root_id?: string;
+};
+export declare type ChannelUnread = {
+    channel_id: string;
+    user_id: string;
+    team_id: string;
+    /** The number of posts which have been read by the user */
+    msg_count: number;
+    /** The number of root posts which have been read by the user */
+    msg_count_root: number;
+    /** The number of unread mentions in this channel */
+    mention_count: number;
+    /** The number of unread mentions in root posts in this channel */
+    mention_count_root: number;
+    last_viewed_at: number;
+    deltaMsgs: number;
+};
+export declare type ChannelsState = {
+    currentChannelId: string;
+    channels: IDMappedObjects<Channel>;
+    channelsInTeam: RelationOneToMany<Team, Channel>;
+    myMembers: RelationOneToOne<Channel, ChannelMembership>;
+    roles: RelationOneToOne<Channel, Set<string>>;
+    membersInChannel: RelationOneToOne<Channel, Record<string, ChannelMembership>>;
+    stats: RelationOneToOne<Channel, ChannelStats>;
+    groupsAssociatedToChannel: any;
+    totalCount: number;
+    manuallyUnread: RelationOneToOne<Channel, boolean>;
+    channelModerations: RelationOneToOne<Channel, ChannelModeration[]>;
+    channelMemberCountsByGroup: RelationOneToOne<Channel, ChannelMemberCountsByGroup>;
+    messageCounts: RelationOneToOne<Channel, ChannelMessageCount>;
+};
+export declare type ChannelModeration = {
+    name: string;
+    roles: {
+        guests?: {
+            value: boolean;
+            enabled: boolean;
+        };
+        members: {
+            value: boolean;
+            enabled: boolean;
+        };
+        admins: {
+            value: boolean;
+            enabled: boolean;
+        };
+    };
+};
+export declare type ChannelModerationPatch = {
+    name: string;
+    roles: {
+        guests?: boolean;
+        members?: boolean;
+    };
+};
+export declare 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 = {
+    status: string;
+    last_viewed_at_times: RelationOneToOne<Channel, number>;
+};
+export declare type ChannelSearchOpts = {
+    nonAdminSearch?: boolean;
+    exclude_default_channels?: boolean;
+    not_associated_to_group?: string;
+    team_ids?: string[];
+    group_constrained?: boolean;
+    exclude_group_constrained?: boolean;
+    public?: boolean;
+    private?: boolean;
+    include_deleted?: boolean;
+    deleted?: boolean;
+    page?: number;
+    per_page?: number;
+};

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

@@ -0,0 +1,41 @@
+export declare enum LogLevel {
+    Error = "ERROR",
+    Warning = "WARNING",
+    Info = "INFO",
+    Debug = "DEBUG"
+}
+export declare type ClientResponse<T> = {
+    response: Response;
+    headers: Map<string, string>;
+    data: T;
+};
+declare type ErrorOffline = {
+    message: string;
+    url: string;
+};
+declare type ErrorInvalidResponse = {
+    intl: {
+        id: string;
+        defaultMessage: string;
+    };
+};
+export declare type ErrorApi = {
+    message: string;
+    server_error_id: string;
+    status_code: number;
+    url: string;
+};
+export declare type Client4Error = ErrorOffline | ErrorInvalidResponse | ErrorApi;
+export declare type Options = {
+    headers?: {
+        [x: string]: string;
+    };
+    method?: string;
+    url?: string;
+    credentials?: 'omit' | 'same-origin' | 'include';
+    body?: any;
+};
+export declare type StatusOK = {
+    status: 'OK';
+};
+export {};

package/lib/client4.js

@@ -0,0 +1,12 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogLevel = void 0;
+var LogLevel;
+(function (LogLevel) {
+    LogLevel["Error"] = "ERROR";
+    LogLevel["Warning"] = "WARNING";
+    LogLevel["Info"] = "INFO";
+    LogLevel["Debug"] = "DEBUG";
+})(LogLevel = exports.LogLevel || (exports.LogLevel = {}));