@mattermost/types 6.7.0-0

package/lib/teams.d.ts

@@ -0,0 +1,90 @@
+import { ServerError } from './errors';
+import { UserProfile } from './users';
+import { RelationOneToOne } from './utilities';
+export declare type TeamMembership = TeamUnread & {
+    user_id: string;
+    roles: string;
+    delete_at: number;
+    scheme_admin: boolean;
+    scheme_guest: boolean;
+    scheme_user: boolean;
+};
+export declare type TeamMemberWithError = {
+    member: TeamMembership;
+    user_id: string;
+    error: ServerError;
+};
+export declare type TeamType = 'O' | 'I';
+export declare type Team = {
+    id: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    display_name: string;
+    name: string;
+    description: string;
+    email: string;
+    type: TeamType;
+    company_name: string;
+    allowed_domains: string;
+    invite_id: string;
+    allow_open_invite: boolean;
+    scheme_id: string;
+    group_constrained: boolean;
+    policy_id?: string | null;
+};
+export declare type TeamsState = {
+    currentTeamId: string;
+    teams: Record<string, Team>;
+    myMembers: Record<string, TeamMembership>;
+    membersInTeam: RelationOneToOne<Team, RelationOneToOne<UserProfile, TeamMembership>>;
+    stats: RelationOneToOne<Team, TeamStats>;
+    groupsAssociatedToTeam: any;
+    totalCount: number;
+};
+export declare type TeamUnread = {
+    team_id: string;
+    /** The number of unread mentions in channels on this team, not including DMs and GMs */
+    mention_count: number;
+    /** The number of unread mentions in root posts in channels on this team, not including DMs and GMs */
+    mention_count_root: number;
+    /**
+     * The number of unread posts in channels on this team, not including DMs and GMs
+     *
+     * @remarks Note that this differs from ChannelMembership.msg_count and ChannelUnread.msg_count since it tracks
+     * unread posts instead of read posts.
+     */
+    msg_count: number;
+    /**
+     * The number of unread root posts in channels on this team, not including DMs and GMs
+     *
+     * @remarks Note that this differs from ChannelMember.msg_count_root and ChannelUnread.msg_count_root since it
+     * tracks unread posts instead of read posts.
+     */
+    msg_count_root: number;
+    thread_count?: number;
+    thread_mention_count?: number;
+};
+export declare type GetTeamMembersOpts = {
+    sort?: 'Username';
+    exclude_deleted_users?: boolean;
+};
+export declare type TeamsWithCount = {
+    teams: Team[];
+    total_count: number;
+};
+export declare type TeamStats = {
+    team_id: string;
+    total_member_count: number;
+    active_member_count: number;
+};
+export declare type TeamSearchOpts = {
+    page?: number;
+    per_page?: number;
+    allow_open_invite?: boolean;
+    group_constrained?: boolean;
+};
+export declare type TeamInviteWithError = {
+    email: string;
+    error: ServerError;
+};

package/lib/teams.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/terms_of_service.d.ts

@@ -0,0 +1,6 @@
+export declare type TermsOfService = {
+    id: string;
+    create_at: number;
+    user_id: string;
+    text: string;
+};

package/lib/terms_of_service.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/themes.d.ts

@@ -0,0 +1,34 @@
+export declare type LegacyThemeKey = 'default' | 'organization' | 'mattermostDark' | 'windows10';
+export declare type ThemeKey = 'denim' | 'sapphire' | 'quartz' | 'indigo' | 'onyx';
+export declare type LegacyThemeType = 'Mattermost' | 'Organization' | 'Mattermost Dark' | 'Windows Dark';
+export declare type ThemeType = 'Denim' | 'Sapphire' | 'Quartz' | 'Indigo' | 'Onyx';
+export declare type Theme = {
+    [key: string]: string | undefined;
+    type?: ThemeType | 'custom';
+    sidebarBg: string;
+    sidebarText: string;
+    sidebarUnreadText: string;
+    sidebarTextHoverBg: string;
+    sidebarTextActiveBorder: string;
+    sidebarTextActiveColor: string;
+    sidebarHeaderBg: string;
+    sidebarTeamBarBg: string;
+    sidebarHeaderTextColor: string;
+    onlineIndicator: string;
+    awayIndicator: string;
+    dndIndicator: string;
+    mentionBg: string;
+    mentionBj: string;
+    mentionColor: string;
+    centerChannelBg: string;
+    centerChannelColor: string;
+    newMessageSeparator: string;
+    linkColor: string;
+    buttonBg: string;
+    buttonColor: string;
+    errorTextColor: string;
+    mentionHighlightBg: string;
+    mentionHighlightLink: string;
+    codeTheme: string;
+};
+export declare type ThemeTypeMap = Record<ThemeType | LegacyThemeType, ThemeKey>;

package/lib/themes.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/threads.d.ts

@@ -0,0 +1,59 @@
+import type { Post } from './posts';
+import type { Team } from './teams';
+import type { Channel } from './channels';
+import type { UserProfile } from './users';
+import type { IDMappedObjects, RelationOneToMany, RelationOneToOne } from './utilities';
+export declare enum UserThreadType {
+    Synthetic = "S"
+}
+export declare type UserThread = {
+    id: string;
+    reply_count: number;
+    last_reply_at: number;
+    last_viewed_at: number;
+    participants: Array<{
+        id: UserProfile['id'];
+    } | UserProfile>;
+    unread_replies: number;
+    unread_mentions: number;
+    is_following: boolean;
+    type?: UserThreadType;
+    /**
+     * only depend on channel_id and user_id for UserThread<>Channel/User mapping,
+     * use normalized post store/selectors as those are kept up-to-date in the store
+     */
+    post: {
+        channel_id: Channel['id'];
+        user_id: UserProfile['id'];
+    };
+};
+declare type SyntheticMissingKeys = 'unread_replies' | 'unread_mentions' | 'last_viewed_at';
+export declare type UserThreadSynthetic = Omit<UserThread, SyntheticMissingKeys> & {
+    type: UserThreadType.Synthetic;
+};
+export declare function threadIsSynthetic(thread: UserThread | UserThreadSynthetic): thread is UserThreadSynthetic;
+export declare type UserThreadWithPost = UserThread & {
+    post: Post;
+};
+export declare type UserThreadList = {
+    total: number;
+    total_unread_threads: number;
+    total_unread_mentions: number;
+    threads: UserThreadWithPost[];
+};
+export declare type ThreadsState = {
+    threadsInTeam: RelationOneToMany<Team, UserThread>;
+    unreadThreadsInTeam: RelationOneToMany<Team, UserThread>;
+    threads: IDMappedObjects<UserThread>;
+    counts: RelationOneToOne<Team, {
+        total: number;
+        total_unread_threads: number;
+        total_unread_mentions: number;
+    }>;
+    countsIncludingDirect: RelationOneToOne<Team, {
+        total: number;
+        total_unread_threads: number;
+        total_unread_mentions: number;
+    }>;
+};
+export {};

package/lib/threads.js

@@ -0,0 +1,13 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.threadIsSynthetic = exports.UserThreadType = void 0;
+var UserThreadType;
+(function (UserThreadType) {
+    UserThreadType["Synthetic"] = "S"; // derived from post
+})(UserThreadType = exports.UserThreadType || (exports.UserThreadType = {}));
+function threadIsSynthetic(thread) {
+    return thread.type === UserThreadType.Synthetic;
+}
+exports.threadIsSynthetic = threadIsSynthetic;

package/lib/typing.d.ts

@@ -0,0 +1,5 @@
+export declare type Typing = {
+    [x: string]: {
+        [x: string]: number;
+    };
+};

package/lib/typing.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/users.d.ts

@@ -0,0 +1,134 @@
+import { Audit } from './audits';
+import { Channel } from './channels';
+import { Group } from './groups';
+import { PostType } from './posts';
+import { Session } from './sessions';
+import { Team } from './teams';
+import { IDMappedObjects, RelationOneToMany, RelationOneToManyUnique, RelationOneToOne } from './utilities';
+export declare type UserNotifyProps = {
+    desktop: 'default' | 'all' | 'mention' | 'none';
+    desktop_sound: 'true' | 'false';
+    email: 'true' | 'false';
+    mark_unread: 'all' | 'mention';
+    push: 'default' | 'all' | 'mention' | 'none';
+    push_status: 'ooo' | 'offline' | 'away' | 'dnd' | 'online';
+    comments: 'never' | 'root' | 'any';
+    first_name: 'true' | 'false';
+    channel: 'true' | 'false';
+    mention_keys: string;
+};
+export declare type UserProfile = {
+    id: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+    username: string;
+    password: string;
+    auth_data: string;
+    auth_service: string;
+    email: string;
+    email_verified: boolean;
+    nickname: string;
+    first_name: string;
+    last_name: string;
+    position: string;
+    roles: string;
+    allow_marketing: boolean;
+    props: Record<string, string>;
+    notify_props: UserNotifyProps;
+    last_password_update: number;
+    last_picture_update: number;
+    failed_attempts: number;
+    locale: string;
+    timezone?: UserTimezone;
+    mfa_active: boolean;
+    mfa_secret: string;
+    last_activity_at: number;
+    is_bot: boolean;
+    bot_description: string;
+    bot_last_icon_update: number;
+    terms_of_service_id: string;
+    terms_of_service_create_at: number;
+    remote_id?: string;
+    status?: string;
+};
+export declare type UserProfileWithLastViewAt = UserProfile & {
+    last_viewed_at: number;
+};
+export declare type UsersState = {
+    currentUserId: string;
+    isManualStatus: RelationOneToOne<UserProfile, boolean>;
+    mySessions: Session[];
+    myAudits: Audit[];
+    profiles: IDMappedObjects<UserProfile>;
+    profilesInTeam: RelationOneToMany<Team, UserProfile>;
+    profilesNotInTeam: RelationOneToMany<Team, UserProfile>;
+    profilesWithoutTeam: Set<string>;
+    profilesInChannel: RelationOneToManyUnique<Channel, UserProfile>;
+    profilesNotInChannel: RelationOneToManyUnique<Channel, UserProfile>;
+    profilesInGroup: RelationOneToMany<Group, UserProfile>;
+    profilesNotInGroup: RelationOneToMany<Group, UserProfile>;
+    statuses: RelationOneToOne<UserProfile, string>;
+    stats: RelationOneToOne<UserProfile, UsersStats>;
+    filteredStats?: UsersStats;
+    myUserAccessTokens: Record<string, UserAccessToken>;
+};
+export declare type UserTimezone = {
+    useAutomaticTimezone: boolean | string;
+    automaticTimezone: string;
+    manualTimezone: string;
+};
+export declare type UserActivity = {
+    [postType in PostType]: {
+        [userId in UserProfile['id']]: {
+            ids: Array<UserProfile['id']>;
+            usernames: Array<UserProfile['username']>;
+        } | Array<UserProfile['id']>;
+    };
+};
+export declare type UserStatus = {
+    user_id: string;
+    status: string;
+    manual?: boolean;
+    last_activity_at?: number;
+    active_channel?: string;
+    dnd_end_time?: number;
+};
+export declare enum CustomStatusDuration {
+    DONT_CLEAR = "",
+    THIRTY_MINUTES = "thirty_minutes",
+    ONE_HOUR = "one_hour",
+    FOUR_HOURS = "four_hours",
+    TODAY = "today",
+    THIS_WEEK = "this_week",
+    DATE_AND_TIME = "date_and_time",
+    CUSTOM_DATE_TIME = "custom_date_time"
+}
+export declare type UserCustomStatus = {
+    emoji: string;
+    text: string;
+    duration: CustomStatusDuration;
+    expires_at?: string;
+};
+export declare type UserAccessToken = {
+    id: string;
+    token?: string;
+    user_id: string;
+    description: string;
+    is_active: boolean;
+};
+export declare type UsersStats = {
+    total_users_count: number;
+};
+export declare type GetFilteredUsersStatsOpts = {
+    in_team?: string;
+    in_channel?: string;
+    include_deleted?: boolean;
+    include_bots?: boolean;
+    roles?: string[];
+    channel_roles?: string[];
+    team_roles?: string[];
+};
+export declare type AuthChangeResponse = {
+    follow_link: string;
+};

package/lib/users.js

@@ -0,0 +1,16 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomStatusDuration = void 0;
+var CustomStatusDuration;
+(function (CustomStatusDuration) {
+    CustomStatusDuration["DONT_CLEAR"] = "";
+    CustomStatusDuration["THIRTY_MINUTES"] = "thirty_minutes";
+    CustomStatusDuration["ONE_HOUR"] = "one_hour";
+    CustomStatusDuration["FOUR_HOURS"] = "four_hours";
+    CustomStatusDuration["TODAY"] = "today";
+    CustomStatusDuration["THIS_WEEK"] = "this_week";
+    CustomStatusDuration["DATE_AND_TIME"] = "date_and_time";
+    CustomStatusDuration["CUSTOM_DATE_TIME"] = "custom_date_time";
+})(CustomStatusDuration = exports.CustomStatusDuration || (exports.CustomStatusDuration = {}));

package/lib/utilities.d.ts

@@ -0,0 +1,25 @@
+export declare type RelationOneToOne<E extends {
+    id: string;
+}, T> = {
+    [x in E['id']]: T;
+};
+export declare type RelationOneToMany<E1 extends {
+    id: string;
+}, E2 extends {
+    id: string;
+}> = {
+    [x in E1['id']]: Array<E2['id']>;
+};
+export declare type RelationOneToManyUnique<E1 extends {
+    id: string;
+}, E2 extends {
+    id: string;
+}> = {
+    [x in E1['id']]: Set<E2['id']>;
+};
+export declare type IDMappedObjects<E extends {
+    id: string;
+}> = RelationOneToOne<E, E>;
+export declare type DeepPartial<T> = {
+    [P in keyof T]?: DeepPartial<T[P]>;
+};

package/lib/utilities.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/websocket.d.ts

@@ -0,0 +1,17 @@
+export declare type WebSocketBroadcast = {
+    omit_users: Record<string, boolean>;
+    user_id: string;
+    channel_id: string;
+    team_id: string;
+};
+export declare type WebSocketMessage<T> = {
+    event: string;
+    data: T;
+    broadcast: WebSocketBroadcast;
+    seq: number;
+};
+export declare type WebsocketStatus = {
+    connected: boolean;
+    lastConnectAt: number;
+    lastDisconnectAt: number;
+};

package/lib/websocket.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/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@mattermost/types",
+  "version": "6.7.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",
+  "license": "MIT",
+  "files": [
+    "lib"
+  ],
+  "exports": {
+    "./*": "./lib/*.js"
+  },
+  "types": "./lib/*.d.ts",
+  "respository": {
+    "type": "git",
+    "url": "github:mattermost/mattermost-webapp",
+    "directory": "packages/types"
+  },
+  "peerDependencies": {
+    "typescript": "^4.3"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "tsc -b -v",
+    "clean": "rm -rf tsconfig.tsbuildinfo ./lib"
+  }
+}