A platform for community discussion. Free, open, simple.
DEV: Convert `User` to TypeScript (#45187)
Sérgio Saquetim6c85d30563ed
diff --git a/docs/developer-guides/docs/03-code-internals/23-app-events-triggers.md b/docs/developer-guides/docs/03-code-internals/23-app-events-triggers.mdindex 13f52bf556c..b3e499a4fcf 100644--- a/docs/developer-guides/docs/03-code-internals/23-app-events-triggers.md+++ b/docs/developer-guides/docs/03-code-internals/23-app-events-triggers.md@@ -804,7 +804,7 @@ No arguments passed to this event.### do-not-disturb-#### do-not-disturb:changed [:link:](https://github.com/discourse/discourse/blob/main/frontend/discourse/app/models/user.js#L1291)+#### do-not-disturb:changed [:link:](https://github.com/discourse/discourse/blob/main/frontend/discourse/app/models/user.ts#L2118)| Position | Argument | Type | Always Present | Description || -------- | ------------------------- | -------- | -------------- | ----------- |@@ -1507,7 +1507,7 @@ No arguments passed to this event.### user-drafts-#### user-drafts:changed [:link:](https://github.com/discourse/discourse/blob/main/frontend/discourse/app/models/user.js#L1297)+#### user-drafts:changed [:link:](https://github.com/discourse/discourse/blob/main/frontend/discourse/app/models/user.ts#L2128)No arguments passed to this event.@@ -1533,7 +1533,7 @@ No arguments passed to this event.### user-reviewable-count-#### user-reviewable-count:changed [:link:](https://github.com/discourse/discourse/blob/main/frontend/discourse/app/models/user.js#L1302)+#### user-reviewable-count:changed [:link:](https://github.com/discourse/discourse/blob/main/frontend/discourse/app/models/user.ts#L2133)| Position | Argument | Type | Always Present | Description || -------- | -------- | -------- | -------------- | ----------- |diff --git a/frontend/discourse/admin/models/admin-user.js b/frontend/discourse/admin/models/admin-user.jsindex f75328e05ac..03ebbd07d19 100644--- a/frontend/discourse/admin/models/admin-user.js+++ b/frontend/discourse/admin/models/admin-user.js@@ -399,6 +399,18 @@ export default class AdminUser extends User {});}+ /**+ * The unreachable overload preserves the inherited framework destruction contract.+ *+ * @overload+ * @param {never} this+ * @returns {never}+ */+ /**+ * @overload+ * @param {Record<string, unknown>} formData+ * @returns {Promise<unknown>}+ */destroy(formData) {return ajax(`/admin/users/${this.id}.json`, {type: "DELETE",diff --git a/frontend/discourse/app/models/post-stream.ts b/frontend/discourse/app/models/post-stream.tsindex ee18a5a9879..3ec4e9f8ca7 100644--- a/frontend/discourse/app/models/post-stream.ts+++ b/frontend/discourse/app/models/post-stream.ts@@ -942,7 +942,7 @@ export default class PostStream extends RestModel {const ignoredUsers = this.currentUser?.ignored_users;posts.forEach((p) => {- if (ignoredUsers?.includes(p.username)) {+ if (ignoredUsers?.includes(p.username!)) {removeValueFromArray(this.stream, p.id);return;}@@ -1599,10 +1599,8 @@ export default class PostStream extends RestModel {_initUserModels(post: Post) {if (post.mentioned_users) {- post.mentioned_users = post.mentioned_users.map(- (u) =>- // TODO(typescript-pending): User is not registered in the store; remove when its model and creation attributes are typed.- this.store.createRecord("user", u as unknown as RestPayload) as User+ post.mentioned_users = post.mentioned_users.map((u) =>+ this.store.createRecord("user", u));}}diff --git a/frontend/discourse/app/models/post.ts b/frontend/discourse/app/models/post.tsindex 96bc09fba4f..74c379a4048 100644--- a/frontend/discourse/app/models/post.ts+++ b/frontend/discourse/app/models/post.ts@@ -231,9 +231,6 @@ type PostTopicDetails = Omit<Topic["details"], "notification_level"> & {notification_level?: number;};-/** TODO(typescript-pending): User forwarders omit server identity/admin fields; remove when User is typed. */-type PostCurrentUser = User & { id: number; admin: boolean };-/** TODO(typescript-pending): Topic user_badges is only object; remove when its badge payload and Badge are typed. */type PostTopicBadges = {users: Record<number, { badge_ids: number[] }>;@@ -333,9 +330,7 @@ export default class Post extends RestModel {}if (json && json.reply_to_user) {- json.reply_to_user = User.create(- json.reply_to_user as RestModelAttrs<User>- );+ json.reply_to_user = User.create(json.reply_to_user);}return json as PostMungedPayload;@@ -421,7 +416,7 @@ export default class Post extends RestModel {return ajax(`/posts/${postId}/raw-email.json`);}- @service declare currentUser: PostCurrentUser | null;+ @service declare currentUser: User | null;@service declare site: Site;@tracked action_code?: string;@@ -664,13 +659,12 @@ export default class Post extends RestModel {return !!this.currentUser;}- /** TODO(typescript-pending): User.staff is inferred from untyped role fields; remove its cast when User is typed. */get canDelete() {return (this.can_delete &&!this.deleted_at &&this.currentUser &&- ((this.currentUser.staff as boolean) || !this.user_deleted)+ (this.currentUser.staff || !this.user_deleted));}@@ -690,9 +684,8 @@ export default class Post extends RestModel {return !this.topic!.deleted && !isEmpty(this.flagsAvailable);}- /** TODO(typescript-pending): User.canManageTopic has no return type; remove its cast when User is typed. */get canManage() {- return this.currentUser?.canManageTopic as boolean | undefined;+ return this.currentUser?.canManageTopic;}get canPermanentlyDelete() {@@ -1015,8 +1008,7 @@ export default class Post extends RestModel {deleted_by: deletedBy,can_delete: false,can_permanently_delete:- this.siteSettings.can_permanently_delete &&- (deletedBy as PostCurrentUser).admin,+ this.siteSettings.can_permanently_delete && deletedBy.admin,can_recover: true,});} else {@@ -1096,7 +1088,7 @@ export default class Post extends RestModel {...modelFieldNames("post"),].forEach((key) => {// Plugin field names are open-ended; the reply-user branch is the only structural read.- // TODO(typescript-pending): User omits username; remove the structural casts when User is typed.+ // TODO(typescript-pending): plugin-registered field names have no typed map; remove these structural casts when that map is typed.let value = (otherPost as unknown as Record<string, unknown>)[key],oldValue = (this as unknown as Record<string, unknown>)[key];diff --git a/frontend/discourse/app/models/topic.ts b/frontend/discourse/app/models/topic.tsindex 7f6e4904ca6..e8d8fdf94a9 100644--- a/frontend/discourse/app/models/topic.ts+++ b/frontend/discourse/app/models/topic.ts@@ -1336,7 +1336,6 @@ export default class Topic extends RestModel {deleted_by: User,opts: { force_destroy?: boolean; [key: string]: unknown } = {}): globalThis.Promise<void> {- // TODO(typescript-pending): User omits server-assigned admin, visibleGroups and can_delete_all_posts_and_topics; remove when User is typed.return ajax(`/t/${this.id}`, {data: { context: window.location.pathname, ...opts },type: "DELETE",@@ -1348,19 +1347,15 @@ export default class Topic extends RestModel {"details.can_delete": false,"details.can_recover": true,"details.can_permanently_delete":- this.siteSettings.can_permanently_delete &&- (deleted_by as User & { admin: boolean }).admin,+ this.siteSettings.can_permanently_delete && deleted_by.admin,});if (opts.force_destroy ||(!deleted_by.staff &&- !(- deleted_by as User & { visibleGroups: { id: number }[] }- ).visibleGroups.some((group) =>+ !deleted_by.visibleGroups!.some((group) =>this.category?.moderating_group_ids?.includes(group.id)) &&- !(deleted_by as User & { can_delete_all_posts_and_topics: boolean })- .can_delete_all_posts_and_topics)+ !deleted_by.can_delete_all_posts_and_topics)) {DiscourseURL.redirectTo("/");}diff --git a/frontend/discourse/app/models/user-action.ts b/frontend/discourse/app/models/user-action.tsindex b54f4ea8275..2641e243ca8 100644--- a/frontend/discourse/app/models/user-action.ts+++ b/frontend/discourse/app/models/user-action.ts@@ -53,9 +53,6 @@ export interface UserActionFields {>;}-/** TODO(typescript-pending): User omits its server username; remove when User declares it. */-type UserActionCurrentUser = User & { username: string };-// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-unsafe-declaration-mergingexport default interface UserAction extends UserActionFields {}@@ -146,7 +143,7 @@ export default class UserAction extends RestModel {return collapsed;}- @service currentUser!: UserActionCurrentUser | null;+ @service currentUser!: User | null;@computed("name", "username")get presentName(): string | null | undefined {diff --git a/frontend/discourse/app/models/user-posts-stream.ts b/frontend/discourse/app/models/user-posts-stream.tsindex ff31439a1bd..e5c15f90ad0 100644--- a/frontend/discourse/app/models/user-posts-stream.ts+++ b/frontend/discourse/app/models/user-posts-stream.ts@@ -3,13 +3,13 @@ import EmberObject, { computed } from "@ember/object";import { ajax } from "discourse/lib/ajax";import getURL from "discourse/lib/get-url";import { autoTrackedArray } from "discourse/lib/tracked-tools";+import type User from "discourse/models/user";import UserAction, {type UserActionFields,} from "discourse/models/user-action";-import type { UserStreamUser } from "discourse/models/user-stream";export interface UserPostsStreamFields {- user?: UserStreamUser;+ user?: User;}// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-unsafe-declaration-mergingdiff --git a/frontend/discourse/app/models/user-stream.ts b/frontend/discourse/app/models/user-stream.tsindex 1a2ce8f6a32..cdf489c4bb7 100644--- a/frontend/discourse/app/models/user-stream.ts+++ b/frontend/discourse/app/models/user-stream.ts@@ -12,18 +12,13 @@ import UserAction, {type UserActionFields,} from "discourse/models/user-action";-/** TODO(typescript-pending): User.username_lower is inferred as any; remove when User is typed. */-export type UserStreamUser = Omit<User, "username_lower"> & {- username_lower: string;-};-export interface UserStreamFilter {filter?: number | null;actingUsername?: string | null;}export interface UserStreamFields {- user?: UserStreamUser;+ user?: User;filter?: number | null;}diff --git a/frontend/discourse/app/models/user.js b/frontend/discourse/app/models/user.tssimilarity index 51%rename from frontend/discourse/app/models/user.jsrename to frontend/discourse/app/models/user.tsindex 354ea85ff3e..ed6d7736ea8 100644--- a/frontend/discourse/app/models/user.js+++ b/frontend/discourse/app/models/user.ts@@ -1,15 +1,17 @@/* eslint-disable ember/no-observers */+/* eslint-disable prefer-const -- Preserve the original bindings in this types-only port. */import { tracked } from "@glimmer/tracking";import EmberObject, { computed, get, getProperties, set } from "@ember/object";import { dependentKeyCompat } from "@ember/object/compat";import Evented from "@ember/object/evented";import { getOwner, setOwner } from "@ember/owner";import { trackedArray } from "@ember/reactive/collections";-import { cancel } from "@ember/runloop";+import { cancel, type Timer } from "@ember/runloop";import { service } from "@ember/service";import { camelize } from "@ember/string";import { trustHTML } from "@ember/template";import { isEmpty } from "@ember/utils";+import type { MomentInput } from "moment";import { Promise } from "rsvp";import { ajax } from "discourse/lib/ajax";import {@@ -44,16 +46,470 @@ import Badge from "discourse/models/badge";import Bookmark from "discourse/models/bookmark";import Category from "discourse/models/category";import Group from "discourse/models/group";-import RestModel from "discourse/models/rest";-import Site from "discourse/models/site";-import UserAction from "discourse/models/user-action";+import RestModel, {+ type RestModelAttrs,+ type RestModelClass,+ type RestModelSaveResult,+ type RestModelStoreAttrs,+ type RestPayload,+} from "discourse/models/rest";+import Site, {+ type SiteSidebarSection,+ type SiteSidebarTag,+ type SiteTopTag,+} from "discourse/models/site";+import type { default as Topic, TopicBasicUser } from "discourse/models/topic";+import UserAction, {+ type UserActionFields,+} from "discourse/models/user-action";import UserActionStat from "discourse/models/user-action-stat";import UserBadge from "discourse/models/user-badge";import UserDraftsStream from "discourse/models/user-drafts-stream";import UserPostsStream from "discourse/models/user-posts-stream";import UserStream from "discourse/models/user-stream";+import type AppEventsService from "discourse/services/app-events";+import type NotificationsService from "discourse/services/notifications";+import type StoreService from "discourse/services/store";import { i18n } from "discourse-i18n";+/** Status supplied by the server; clearing a status assigns null on the user. */+export interface UserStatus {+ description: string;+ emoji: string;+ ends_at: string | null;+ message_bus_last_id?: number;+}++/** Options are partial: current-user and profile serializers expose different subsets. */+export interface UserOption {+ allow_private_messages?: boolean;+ auto_track_topics_after_msecs?: number;+ automatically_translate?: boolean;+ automatically_unpin_topics?: boolean;+ bookmark_auto_delete_preference?: number;+ color_scheme_id?: number | null;+ composition_mode?: number;+ dark_scheme_id?: number | null;+ default_calendar?: string;+ digest_after_minutes?: number | null;+ dynamic_favicon?: boolean;+ email_digests?: boolean | null;+ email_in_reply_to?: boolean;+ email_level?: number;+ email_messages_level?: number;+ email_previous_replies?: number;+ enable_allowed_pm_users?: boolean;+ enable_markdown_monospace_font?: boolean;+ enable_quoting?: boolean;+ enable_smart_lists?: boolean;+ enable_upcoming_change_available_notifications?: boolean;+ external_links_in_new_tab?: boolean;+ hidden_composer_toolbar_buttons?: string[];+ hide_presence?: boolean;+ hide_profile?: boolean;+ hide_profile_and_presence?: boolean;+ homepage_id?: number | null;+ include_tl0_in_digests?: boolean | null;+ interface_color_mode?: number;+ like_notification_frequency?: number;+ likes_notifications_disabled?: boolean;+ mailing_list_mode?: boolean;+ mailing_list_mode_frequency?: number;+ new_topic_duration_minutes?: number;+ notification_level_when_replying?: number;+ notify_on_linked_posts?: boolean;+ oldest_search_log_date?: string | null;+ push_notification_level?: string;+ redirected_to_top?: { reason: string | null; period: string | number } | null;+ seen_popups?: number[] | null;+ send_shortcut?: string;+ should_be_redirected_to_top?: boolean;+ show_original_content?: boolean;+ sidebar_link_to_filtered_list?: boolean;+ sidebar_show_count_of_new_items?: boolean;+ skip_new_user_tips?: boolean;+ text_size?: string;+ text_size_seq?: number;+ theme_ids?: number[];+ theme_key_seq?: number;+ timezone?: string | null;+ title_count_mode?: string;+ treat_as_new_topic_start_date?: string;+ understood_languages?: string[];+ user_id?: number;+ watched_precedence_over_muted?: boolean;+}++/** Visible memberships can be plain current-user entries or hydrated profile groups.+ * TODO(typescript-pending): Group omits its serializer fields; use its canonical fields when Group is typed.+ */+export interface UserGroup {+ id: number;+ name: string;+ automatic?: boolean;+ has_messages?: boolean;+ owner?: true;+ title?: string | null;+ flair_url?: string | null;+ flair_bg_color?: string | null;+ flair_color?: string | null;+ can_admin_group?: boolean;+ is_group_owner?: boolean;+ group_user?: {+ user_id: number;+ group_id: number;+ notification_level: number;+ owner?: boolean;+ };+}++/** TODO(typescript-pending): Badge's field forwarders and factories lack declared fields; remove when Badge is typed. */+type UserBadgeModel = Badge & {+ id: number;+ name: string;+ allow_title?: boolean;+ count?: number;+};++/** A user-authorized API key, before or after it is wrapped in an EmberObject. */+export interface UserApiKey {+ id: number;+ application_name: string;+ scopes: string[];+ created_at: string;+ last_used_at: string;+ expires_at: string | null;+ revoked?: boolean;+}++type WrappedUserApiKey = EmberObject &+ UserApiKey & {+ revoke(): void;+ undoRevoke(): void;+ };++/** Core serializer and client-assigned fields. Plugins augment this interface. */+export interface UserFields {+ /** Username-only instances are hydrated by findDetails before identity-dependent use. */+ id: number;+ /** Username-only instances are hydrated by findDetails before identity-dependent use. */+ username: string;+ avatar_template: string;+ added_at?: string;+ admin?: boolean;+ all_unread_notifications_count?: number;+ allowed_pm_usernames?: string[] | string;+ any_posts?: boolean;+ associated_account_avatars?: {+ id: number;+ name: string;+ upload_id: number;+ avatar_template: string;+ }[];+ associated_account_ids?: Record<string, string>;+ available_notification_types?: number[];+ badge_count?: number | null;+ badges?: UserBadgeModel[];+ bio_cooked?: string;+ bio_excerpt?: string;+ bio_raw?: string;+ can_be_deleted?: boolean;+ can_change_bio?: boolean;+ can_change_location?: boolean;+ can_change_post_owner?: true;+ can_change_tracking_preferences?: boolean;+ can_change_website?: boolean;+ can_create_admin_invite?: true;+ can_create_category?: true;+ can_create_group?: true;+ can_create_topic?: boolean;+ can_delete_account?: true;+ can_delete_all_posts?: boolean;+ can_delete_all_posts_and_topics?: boolean;+ can_edit?: boolean;+ can_edit_avatar?: boolean;+ can_edit_email?: boolean;+ can_edit_name?: boolean;+ can_edit_tags?: boolean;+ can_edit_username?: boolean;+ can_ignore_user?: boolean;+ can_ignore_users?: boolean;+ can_invite_to_forum?: true;+ can_localize_content?: boolean;+ can_mute_user?: boolean;+ can_mute_users?: boolean;+ can_pick_theme_with_custom_homepage?: boolean;+ can_post_anonymously?: boolean;+ can_review?: boolean;+ can_run_design_wizard?: true;+ can_see_emails?: boolean;+ can_see_ip?: boolean;+ can_send_private_email_messages?: boolean;+ can_send_private_message_to_user?: boolean;+ can_send_private_messages?: boolean;+ can_set_topic_timer?: boolean;+ can_upload_avatar?: boolean;+ can_upload_profile_header?: boolean;+ can_upload_user_card_background?: boolean;+ can_view_raw_email?: boolean;+ card_background_upload_url?: string;+ card_badge?: UserBadgeModel | null;+ created_at?: string;+ custom_avatar_template?: string;+ custom_avatar_upload_id?: number | null;+ custom_data?: unknown;+ custom_fields?: Record<string, unknown>;+ date_of_birth?: string | null;+ days_since_created?: number;+ days_visited?: number;+ display_sidebar_tags?: boolean;+ do_not_disturb_channel_position?: number;+ draft_count?: number;+ effective_locale?: string;+ email?: string | null;+ error?: boolean;+ external_id?: string | null;+ featured_topic?: {+ id: number;+ title: string;+ slug: string;+ fancy_title?: string;+ } | null;+ featured_user_badge_ids?: number[];+ featured_user_badges?: UserBadge[];+ finished?: boolean;+ flair_bg_color?: string | null;+ flair_color?: string | null;+ flair_group_id?: number | null;+ flair_name?: string | null;+ flair_url?: string | null;+ gravatar_avatar_template?: string;+ gravatar_avatar_upload_id?: number | null;+ grouped_unread_notifications?: Record<string, number>;+ has_new_upcoming_changes?: boolean;+ has_title_badges?: boolean;+ has_unseen_features?: boolean;+ hideReadOnlyAlert?: boolean;+ ignored?: boolean;+ impersonation_expires_at?: string | null;+ inactive?: boolean;+ indirectly_muted_category_ids?: number[];+ inviteLink?: string;+ invited_by?: User | null;+ isCurrent?: boolean;+ is_anonymous?: boolean;+ is_impersonating?: boolean;+ last_posted_at?: string | null;+ last_seen_at?: string | null;+ link_posting_access?: string;+ locale?: string | null;+ login_method?: string | null;+ mailing_list_posts_per_day?: number;+ moderator?: boolean;+ muted?: boolean;+ muted_category_ids?: number[];+ muted_tags?: (SiteTopTag | string)[];+ muted_topics?: { topicId: number; createdAt: number }[];+ muted_usernames?: string[] | string;+ name?: string | null;+ needs_required_fields_check?: boolean;+ new_personal_messages_notifications_count?: number;+ no_password?: true;+ notification_channel_position?: number | null;+ number_of_deleted_posts?: number;+ number_of_flags?: number;+ number_of_flags_given?: number;+ number_of_silencings?: number;+ number_of_suspensions?: number;+ owner?: boolean;+ pending_count?: number;+ pending_posts_count?: number;+ post_count?: number | null;+ posts_read_count?: number;+ previous_visit_at?: string | null;+ primary?: boolean;+ primary_group_id?: number | null;+ primary_group_name?: string | null;+ /** Legacy compatibility field; current serializers do not supply it. */+ private_messages_stats?: { all?: number; mine?: number; unread?: number };+ profile_background_upload_url?: string;+ profile_hidden?: true;+ profile_view_count?: number;+ read_faq?: boolean;+ read_first_notification?: boolean;+ recent_searches?: string[];+ recent_searches_detailed?: { term: string; at: string }[];+ recent_time_read?: number;+ regular_category_ids?: number[];+ regular_tags?: (SiteTopTag | string)[];+ request_accepted?: boolean;+ request_denied?: boolean;+ request_undone?: boolean;+ reviewable_count?: number;+ saving?: boolean;+ second_factor_backup_enabled?: boolean;+ second_factor_enabled?: boolean;+ second_factor_remaining_backup_codes?: number;+ seen_notification_id?: number;+ selected_user_associated_account_id?: number | null;+ show_mcp_authorizations?: boolean;+ show_site_owner_onboarding?: true;+ sidebar_category_ids?: number[];+ sidebar_tag_names?: string[];+ sidebar_tags?: SiteSidebarTag[];+ silence_reason?: string | null;+ silenced_till?: string | null;+ staged?: boolean;+ /** Legacy compatibility field; current serializers do not supply it. */+ stats?: UserActionStat[];+ suspend_reason?: string | null;+ suspended_till?: string | null;+ system_avatar_template?: string;+ system_avatar_upload_id?: number | null;+ time_read?: number | null;+ title?: string | null;+ top_category_ids?: number[];+ topic_count?: number | null;+ topics_entered?: number;+ topic_post_count?: Record<string, number>;+ tracked_category_ids?: number[];+ tracked_tags?: (SiteTopTag | string)[];+ trust_level?: number;+ unified_new_enabled?: boolean;+ unmuted_topics?: { topicId: number; createdAt: number }[];+ unread_high_priority_notifications?: number;+ unread_notifications?: number;+ unseen_reviewable_count?: number;+ uploaded_avatar_id?: number | null;+ use_logo_small_as_avatar?: boolean | string | null;+ user_api_keys?: UserApiKey[] | null;+ user_auth_tokens?: {+ id: number;+ client_ip?: string;+ location: string;+ browser: string;+ device: string;+ os: string;+ icon: string;+ created_at: string;+ seen_at: string;+ is_active?: boolean;+ }[];+ user_fields?: Record<string, string | string[] | boolean | null>;+ user_notification_schedule?: Partial<+ Record<`day_${0 | 1 | 2 | 3 | 4 | 5 | 6}_${"start" | "end"}_time`, number>+ > & { id?: number; user_id?: number; enabled: boolean };+ user_option?: UserOption;+ user_passkeys?: {+ id: number;+ name: string;+ last_used: string | null;+ created_at: string;+ }[];+ viewingSelf?: boolean;+ visibleGroups?: UserGroup[];+ watched_category_ids?: number[];+ watched_first_post_category_ids?: number[];+ watched_tags?: (SiteTopTag | string)[];+ watching_first_post_tags?: (SiteTopTag | string)[];+ website?: string;+ website_name?: string;+ whisperer?: boolean;+}++/** Creation accepts raw groups without exposing a writable deprecated groups getter. */+export type UserCreateAttrs<M = User> = Partial<+ Omit<M, "groups" | "trust_level" | "avatar_template">+> &+ RestModelStoreAttrs & {+ groups?: UserGroup[];+ /** Embedded post authors can carry null before hydration. */+ trust_level?: number | null;+ avatar_template?: string | null;+ };++/** findDetails consumes forCard by deleting it from the caller's options. */+export interface UserFindDetailsOptions {+ forCard?: boolean;+ existingRequest?: PromiseLike<UserDetailsResponse>;+ include_post_count_for?: number;+ [key: string]: unknown;+}++/** Raw profile/card data before findDetails replaces its relationships. */+export interface UserDetailsResponse {+ user: Omit<Partial<UserFields>, "stats" | "invited_by" | "card_badge"> & {+ stats?:+ | (Omit<Partial<UserActionStat>, "count"> & { count?: number | string })[]+ | UserActionStat[];+ groups?: RestModelAttrs<Group>[];+ group_users?: UserGroup["group_user"][];+ invited_by?: UserCreateAttrs | User | null;+ card_badge?: RestPayload | UserBadgeModel | null;+ timezone?: string | null;+ };+ [key: string]: unknown;+}++/** Activity summary, enriched with model instances, dates and links by summary(). */+export interface UserSummary {+ likes_given?: number;+ likes_received?: number;+ topics_entered?: number;+ posts_read_count?: number;+ days_visited?: number;+ topic_count?: number;+ post_count?: number;+ time_read?: number;+ recent_time_read?: number;+ bookmark_count?: number;+ can_see_summary_stats: boolean;+ can_see_user_actions: boolean;+ topic_ids: number[];+ topics: Topic[];+ replies: {+ topic_id: number;+ post_number: number;+ created_at: string;+ like_count: number;+ topic: Topic;+ url: string;+ createdAt: Date;+ }[];+ links: {+ topic_id: number;+ post_number: number;+ url: string;+ clicks: number;+ title: string | null;+ topic: Topic;+ post_url: string;+ }[];+ most_liked_by_users: (TopicBasicUser & { count: number })[];+ most_liked_users: (TopicBasicUser & { count: number })[];+ most_replied_to_users: (TopicBasicUser & { count: number })[];+ badges?: UserBadgeModel[];+ top_categories?: (Partial<Category> & {+ parent_category_id?: number | null;+ parentCategory?: Category;+ })[];+}++/** Signup form inputs; plugin-added request data is supplied by the transformer. */+export interface UserAccountAttrs {+ accountName?: string;+ accountEmail: string;+ accountPassword?: string;+ accountUsername: string;+ accountPasswordConfirm?: string;+ accountChallenge?: string;+ userFields?: UserFields["user_fields"];+ inviteCode?: string;+}++// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging+export default interface User extends UserFields, Evented {}+export const SECOND_FACTOR_METHODS = {TOTP: 1,BACKUP_CODE: 2,@@ -76,7 +532,7 @@ export function extendTextSizeCookie() {}}-const isForever = (dt) => moment().diff(dt, "years") < -100;+const isForever = (dt: MomentInput) => moment().diff(dt, "years") < -100;let userFields = ["allowed_pm_usernames",@@ -105,7 +561,7 @@ let userFields = ["website",];-export function addSaveableUserField(fieldName) {+export function addSaveableUserField(fieldName: string) {userFields.push(fieldName);}@@ -159,13 +615,13 @@ let userOptionFields = ["watched_precedence_over_muted",];-export function addSaveableUserOptionField(fieldName) {+export function addSaveableUserOptionField(fieldName: string) {userOptionFields.push(fieldName);}-function userOption(userOptionKey) {+function userOption(userOptionKey: keyof UserOption) {return computed(`user_option.${userOptionKey}`, {- get(key) {+ get(this: User, key: string) {deprecated(`Getting ${key} property of user object is deprecated. Use user_option object instead`,{@@ -177,7 +633,7 @@ function userOption(userOptionKey) {return this.get(`user_option.${key}`);},- set(key, value) {+ set(this: User, key: string, value: unknown) {deprecated(`Setting ${key} property of user object is deprecated. Use user_option object instead`,{@@ -196,9 +652,59 @@ function userOption(userOptionKey) {}@singleton+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-mergingexport default class User extends RestModel.extend(Evented) {- static createCurrent() {- const userJson = PreloadStore.get("currentUser");+ /** Added by `@singleton`; anonymous sessions have no current user. */+ declare static current: () => User | null;++ /** Reads or writes a current-user property; returns undefined for anonymous sessions. */+ declare static currentProp: {+ <K extends keyof User>(property: K): User[K] | undefined;+ <K extends keyof User>(property: K, value: User[K]): User[K] | undefined;+ <P extends string>(+ property: P extends keyof User ? never : P,+ value?: unknown+ ): unknown;+ };++ /** Replaces the singleton value without constructing or hydrating it. */+ declare static resetCurrent: <T extends User | null | undefined = undefined>(+ value?: T+ ) => T;++ /** Runtime implementation stays in reopenClass for its _super chain; it mutates groups and tracking fields in its input. */+ declare static create: <C extends RestModelClass>(+ this: C,+ attrs?: UserCreateAttrs<InstanceType<C>>+ ) => InstanceType<C>;++ declare static findByUsername: (+ username: string,+ options?: UserFindDetailsOptions+ ) => globalThis.Promise<User>;+ declare static checkUsername: (+ username?: string | null,+ email?: string | null,+ for_user_id?: number+ ) => globalThis.Promise<unknown>;+ declare static checkEmail: (email: string) => globalThis.Promise<unknown>;+ declare static loadRecentSearches: () => globalThis.Promise<unknown>;+ declare static resetRecentSearches: () => globalThis.Promise<unknown>;+ declare static groupStats: (stats: UserActionStat[]) => UserActionStat[];+ declare static createAccount: (+ attrs: UserAccountAttrs+ ) => globalThis.Promise<unknown>;+ declare static deleteStatusTrackingFields: (args: RestPayload) => void;++ static createCurrent(): User | null {+ // TODO(typescript-pending): PreloadStore has no payload contracts; remove when its keys are typed.+ const userJson = PreloadStore.get("currentUser") as+ | (UserCreateAttrs & {+ username: string;+ user_option: UserOption;+ visibleGroups?: UserGroup[];+ })+ | undefined;if (userJson) {userJson.isCurrent = true;@@ -213,7 +719,7 @@ export default class User extends RestModel.extend(Evented) {}if (userJson.primary_group_id) {- const primaryGroup = userJson.visibleGroups.find(+ const primaryGroup = userJson.visibleGroups!.find((group) => group.id === userJson.primary_group_id);if (primaryGroup) {@@ -226,7 +732,9 @@ export default class User extends RestModel.extend(Evented) {this._saveTimezone(userJson);}- const store = getOwnerWithFallback(this).lookup("service:store");+ const store = getOwnerWithFallback(this).lookup(+ "service:store"+ ) as StoreService;const currentUser = store.createRecord("user", userJson);currentUser.statusManager.trackStatus();return currentUser;@@ -235,52 +743,73 @@ export default class User extends RestModel.extend(Evented) {return null;}- @service appEvents;-- @tracked do_not_disturb_until;- @tracked status;- @tracked dismissed_banner_key;- @autoTrackedArray associated_accounts;- @autoTrackedArray ignored_usernames;- @autoTrackedArray ignored_users;- @autoTrackedArray secondary_emails;- @autoTrackedArray sidebar_sections;- @autoTrackedArray unconfirmed_emails;-- @userOption("mailing_list_mode") mailing_list_mode;- @userOption("external_links_in_new_tab") external_links_in_new_tab;- @userOption("enable_quoting") enable_quoting;- @userOption("enable_smart_lists") enable_smart_lists;- @userOption("enable_markdown_monospace_font") enable_markdown_monospace_font;- @userOption("dynamic_favicon") dynamic_favicon;- @userOption("automatically_unpin_topics") automatically_unpin_topics;- @userOption("likes_notifications_disabled") likes_notifications_disabled;- @userOption("hide_profile") hide_profile;- @userOption("hide_presence") hide_presence;- @userOption("title_count_mode") title_count_mode;- @userOption("timezone") timezone;- @userOption("skip_new_user_tips") skip_new_user_tips;- @userOption("default_calendar") default_calendar;+ @service appEvents!: AppEventsService;++ @tracked do_not_disturb_until: string | null | undefined;++ @tracked status: UserStatus | null | undefined;++ @tracked dismissed_banner_key: number | null | undefined;++ @autoTrackedArray+ associated_accounts: { name: string; description: string }[] | undefined;++ @autoTrackedArray ignored_usernames: string[] | undefined;+ @autoTrackedArray ignored_users: string[] | undefined;+ @autoTrackedArray secondary_emails: string[] | undefined;+ @autoTrackedArray sidebar_sections: SiteSidebarSection[] | undefined;+ @autoTrackedArray unconfirmed_emails: string[] | undefined;+ @userOption("mailing_list_mode")+ mailing_list_mode: UserOption["mailing_list_mode"];+ @userOption("external_links_in_new_tab")+ external_links_in_new_tab: UserOption["external_links_in_new_tab"];+ @userOption("enable_quoting") enable_quoting: UserOption["enable_quoting"];+ @userOption("enable_smart_lists")+ enable_smart_lists: UserOption["enable_smart_lists"];++ @userOption("enable_markdown_monospace_font")+ enable_markdown_monospace_font: UserOption["enable_markdown_monospace_font"];+ @userOption("dynamic_favicon") dynamic_favicon: UserOption["dynamic_favicon"];+ @userOption("automatically_unpin_topics")+ automatically_unpin_topics: UserOption["automatically_unpin_topics"];+ @userOption("likes_notifications_disabled")+ likes_notifications_disabled: UserOption["likes_notifications_disabled"];+ @userOption("hide_profile") hide_profile: UserOption["hide_profile"];+ @userOption("hide_presence") hide_presence: UserOption["hide_presence"];+ @userOption("title_count_mode")+ title_count_mode: UserOption["title_count_mode"];+ @userOption("timezone") timezone: UserOption["timezone"];+ @userOption("skip_new_user_tips")+ skip_new_user_tips: UserOption["skip_new_user_tips"];+ @userOption("default_calendar")+ default_calendar: UserOption["default_calendar"];@userOption("bookmark_auto_delete_preference")- bookmark_auto_delete_preference;- @userOption("seen_popups") seen_popups;- @userOption("should_be_redirected_to_top") should_be_redirected_to_top;- @userOption("redirected_to_top") redirected_to_top;- @userOption("treat_as_new_topic_start_date") treat_as_new_topic_start_date;- @userOption("composition_mode") composition_mode;-+ bookmark_auto_delete_preference: UserOption["bookmark_auto_delete_preference"];+ @userOption("seen_popups") seen_popups: UserOption["seen_popups"];+ @userOption("should_be_redirected_to_top")+ should_be_redirected_to_top: UserOption["should_be_redirected_to_top"];+ @userOption("redirected_to_top")+ redirected_to_top: UserOption["redirected_to_top"];+ @userOption("treat_as_new_topic_start_date")+ treat_as_new_topic_start_date: UserOption["treat_as_new_topic_start_date"];+ @userOption("composition_mode")+ composition_mode: UserOption["composition_mode"];numGroupsToDisplay = 2;-statusManager = new UserStatusManager(this);+ declare static _current: User | null | undefined;+ declare static _saveTimezone: (user: {+ username: string;+ user_option: UserOption;+ }) => void;- @tracked _location;+ @tracked _location: string | null | undefined;@computed("sidebar_category_ids")get sidebarCategoryIds() {return this.sidebar_category_ids;}- set sidebarCategoryIds(value) {+ set sidebarCategoryIds(value: number[] | undefined) {set(this, "sidebar_category_ids", value);}@@ -289,7 +818,7 @@ export default class User extends RestModel.extend(Evented) {return this.sidebar_sections;}- set sidebarSections(value) {+ set sidebarSections(value: SiteSidebarSection[] | undefined) {this.sidebar_sections = value;}@@ -300,7 +829,7 @@ export default class User extends RestModel.extend(Evented) {});}- set location(value) {+ set location(value: string | null | undefined) {this._location = value;}@@ -309,7 +838,7 @@ export default class User extends RestModel.extend(Evented) {return this.can_pick_theme_with_custom_homepage;}- set canPickThemeWithCustomHomepage(value) {+ set canPickThemeWithCustomHomepage(value: boolean | undefined) {set(this, "can_pick_theme_with_custom_homepage", value);}@@ -318,7 +847,7 @@ export default class User extends RestModel.extend(Evented) {return this.can_edit_tags;}- set canEditTags(value) {+ set canEditTags(value: boolean | undefined) {set(this, "can_edit_tags", value);}@@ -327,7 +856,7 @@ export default class User extends RestModel.extend(Evented) {return this.can_change_post_owner;}- set canChangePostOwner(value) {+ set canChangePostOwner(value: boolean | undefined) {set(this, "can_change_post_owner", value);}@@ -336,8 +865,8 @@ export default class User extends RestModel.extend(Evented) {return this.admin || this.moderator;}- // prevents staff property to be overridden- set staff(value) {}+ /** Prevents the staff property from being overridden. */+ set staff(value: boolean | undefined) {}@dependentKeyCompatget mutedCategories() {@@ -354,7 +883,7 @@ export default class User extends RestModel.extend(Evented) {return Category.findByIds(this.get("muted_category_ids"));}- set mutedCategories(categories) {+ set mutedCategories(categories: Category[]) {this.set("muted_category_ids",categories.map((c) => c.id)@@ -376,7 +905,7 @@ export default class User extends RestModel.extend(Evented) {return Category.findByIds(this.get("regular_category_ids"));}- set regularCategories(categories) {+ set regularCategories(categories: Category[]) {this.set("regular_category_ids",categories.map((c) => c.id)@@ -398,7 +927,7 @@ export default class User extends RestModel.extend(Evented) {return Category.findByIds(this.get("tracked_category_ids"));}- set trackedCategories(categories) {+ set trackedCategories(categories: Category[]) {this.set("tracked_category_ids",categories.map((c) => c.id)@@ -420,7 +949,7 @@ export default class User extends RestModel.extend(Evented) {return Category.findByIds(this.get("watched_category_ids"));}- set watchedCategories(categories) {+ set watchedCategories(categories: Category[]) {this.set("watched_category_ids",categories.map((c) => c.id)@@ -442,7 +971,7 @@ export default class User extends RestModel.extend(Evented) {return Category.findByIds(this.get("watched_first_post_category_ids"));}- set watchedFirstPostCategories(categories) {+ set watchedFirstPostCategories(categories: Category[]) {this.set("watched_first_post_category_ids",categories.map((c) => c.id)@@ -451,21 +980,21 @@ export default class User extends RestModel.extend(Evented) {@computed("private_messages_stats.all")get hasPMs() {- return this.private_messages_stats?.all > 0;+ return (this.private_messages_stats?.all as number) > 0;}@computed("private_messages_stats.mine")get hasStartedPMs() {- return this.private_messages_stats?.mine > 0;+ return (this.private_messages_stats?.mine as number) > 0;}@computed("private_messages_stats.unread")get hasUnreadPMs() {- return this.private_messages_stats?.unread > 0;+ return (this.private_messages_stats?.unread as number) > 0;}@computed("id", "username_lower")- get adminPath() {+ get adminPath(): string {return getURL(`/admin/users/${this.id}/${this.username_lower}`);}@@ -516,27 +1045,27 @@ export default class User extends RestModel.extend(Evented) {@computed("can_be_deleted", "post_count")get canBeDeleted() {const maxPostCount = this.siteSettings.delete_all_posts_max;- return this.can_be_deleted && this.post_count <= maxPostCount;+ return this.can_be_deleted && this.post_count! <= (maxPostCount as number);}@computed()- get stream() {+ get stream(): UserStream {return UserStream.create({ user: this });}@computed()- get bookmarks() {- return Bookmark.create({ user: this });+ get bookmarks(): Bookmark {+ // TODO(typescript-pending): Bookmark.create returns its base wrapper; remove when Bookmark is typed.+ return Bookmark.create({ user: this }) as Bookmark;}- /** @returns {UserPostsStream} */@computed()- get postsStream() {+ get postsStream(): UserPostsStream {return UserPostsStream.create({ user: this });}@computed()- get userDraftsStream() {+ get userDraftsStream(): UserDraftsStream {return UserDraftsStream.create({ user: this });}@@ -563,19 +1092,18 @@ export default class User extends RestModel.extend(Evented) {}@computed("username_lower")- get searchContext() {+ get searchContext(): { type: string; id: string; user: User } {return {type: "user",id: this.username_lower,- /** @type User */user: this,};}@computed("username", "name")- get displayName() {+ get displayName(): string {if (this.siteSettings.enable_names && !isEmpty(this.name)) {- return this.name;+ return this.name!;}return this.username;}@@ -596,7 +1124,7 @@ export default class User extends RestModel.extend(Evented) {}@computed()- get path() {+ get path(): string {// no need to observe, requires a hard refresh to updatereturn applyValueTransformer("user-path", userPath(this.username_lower), {user: this,@@ -604,11 +1132,14 @@ export default class User extends RestModel.extend(Evented) {}@computed()- get userApiKeys() {+ get userApiKeys(): WrappedUserApiKey[] | undefined {const keys = this.user_api_keys;if (keys) {return keys.map((raw) => {- let obj = EmberObject.create(raw);+ // The callbacks are installed immediately after wrapping the serialized key.+ let obj = EmberObject.create(+ raw as Partial<EmberObject>+ ) as WrappedUserApiKey;obj.revoke = () => {this.revokeApiKey(obj);@@ -624,21 +1155,21 @@ export default class User extends RestModel.extend(Evented) {}@computed()- get mutedTopicsPath() {+ get mutedTopicsPath(): string {return defaultHomepage() === "latest"? getURL("/?state=muted"): getURL("/latest?state=muted");}@computed()- get watchingTopicsPath() {+ get watchingTopicsPath(): string {return defaultHomepage() === "latest"? getURL("/?state=watching"): getURL("/latest?state=watching");}@computed()- get trackingTopicsPath() {+ get trackingTopicsPath(): string {return defaultHomepage() === "latest"? getURL("/?state=tracking"): getURL("/latest?state=tracking");@@ -651,17 +1182,19 @@ export default class User extends RestModel.extend(Evented) {@computed("trust_level")get trustLevel() {- return Site.currentProp("trustLevels").find(- (l) => l.id === parseInt(this.trust_level, 10)+ return Site.currentProp("trustLevels")!.find(+ (l) => l.id === parseInt(this.trust_level as unknown as string, 10));}@computed("previous_visit_at")+ /** Missing and null timestamps retain the Date constructor's legacy coercion. */get previousVisitAt() {- return new Date(this.previous_visit_at);+ return new Date(this.previous_visit_at as string);}@computed("suspended_till")+ /** Retains the timestamp's falsey value rather than normalizing it to false. */get suspended() {return this.suspended_till && moment(this.suspended_till).isAfter();}@@ -717,7 +1250,7 @@ export default class User extends RestModel.extend(Evented) {return groups.length === 0 ? null : groups;}- // The user's stat count, excluding PMs.+ /** The user's stat count, excluding PMs. */@computed("[email protected]")get statsCountNonPM() {if (isEmpty(this.statsExcludingPms)) {@@ -732,13 +1265,13 @@ export default class User extends RestModel.extend(Evented) {return count;}- // The user's stats, excluding PMs.+ /** The user's stats, excluding PMs. */@computed("[email protected]")- get statsExcludingPms() {+ get statsExcludingPms(): UserActionStat[] {if (isEmpty(this.stats)) {return [];}- return this.stats.filter((stat) => !stat.isPM);+ return this.stats!.filter((stat) => !stat.isPM);}@computed("can_delete_account")@@ -750,21 +1283,26 @@ export default class User extends RestModel.extend(Evented) {@dependentKeyCompatget sidebarLinkToFilteredList() {- return this.get("user_option.sidebar_link_to_filtered_list");+ // Nested property paths use the framework getter's unknown overload.+ return this.get(+ "user_option.sidebar_link_to_filtered_list"+ ) as UserOption["sidebar_link_to_filtered_list"];}@dependentKeyCompatget sidebarShowCountOfNewItems() {- return this.get("user_option.sidebar_show_count_of_new_items");+ return this.get(+ "user_option.sidebar_show_count_of_new_items"+ ) as UserOption["sidebar_show_count_of_new_items"];}@computed("[email protected]", "badges.[]")- get availableTitles() {- const titles = [];+ get availableTitles(): { name: string; id: string }[] {+ const titles: string[] = [];(this.visibleGroups || []).forEach((group) => {if (get(group, "title")) {- titles.push(get(group, "title"));+ titles.push(get(group, "title")!);}});@@ -774,19 +1312,23 @@ export default class User extends RestModel.extend(Evented) {}});- return uniqueItemsFromArray(titles)- .sort()- .map((title) => {- return {- name: escapeExpression(title),- id: title,- };- });+ return (uniqueItemsFromArray(titles) as string[]).sort().map((title) => {+ return {+ name: escapeExpression(title),+ id: title,+ };+ });}@computed("visibleGroups.[]")get availableFlairs() {- const flairs = [];+ const flairs: {+ id: number;+ name: string;+ url: string;+ bgColor?: string | null;+ color?: string | null;+ }[] = [];if (this.visibleGroups) {this.visibleGroups.forEach((group) => {@@ -808,8 +1350,10 @@ export default class User extends RestModel.extend(Evented) {@computed("user_option.text_size_seq", "user_option.text_size")get currentTextSize() {if (cookie(TEXT_SIZE_COOKIE_NAME)) {- const [cookieSize, cookieSeq] = cookie(TEXT_SIZE_COOKIE_NAME).split("|");- if (cookieSeq >= this.user_option?.text_size_seq) {+ const [cookieSize, cookieSeq] = (+ cookie(TEXT_SIZE_COOKIE_NAME) as string+ ).split("|");+ if (cookieSeq >= (this.user_option?.text_size_seq as unknown as string)) {return cookieSize;}}@@ -846,21 +1390,29 @@ export default class User extends RestModel.extend(Evented) {);}+ /** The legacy lookup uses an absent constant key, so unset modes also match. */get prefersAutoColor() {return (- this.user_option?.interface_color_mode === INTERFACE_COLOR_MODES.AUTODARK+ this.user_option?.interface_color_mode ===+ (+ INTERFACE_COLOR_MODES as typeof INTERFACE_COLOR_MODES & {+ AUTODARK?: number;+ }+ ).AUTODARK);}- destroySession(pushSubscription) {- const data = {};+ destroySession(+ pushSubscription?: PushSubscriptionJSON | null+ ): globalThis.Promise<unknown> {+ const data: { push_subscription?: PushSubscriptionJSON } = {};if (pushSubscription) {data.push_subscription = pushSubscription;}return ajax(`/session/${this.username}`, { type: "DELETE", data });}- revokeApiKey(key) {+ revokeApiKey(key: EmberObject & UserApiKey) {return ajax("/user-api-key/revoke", {type: "POST",data: { id: key.get("id") },@@ -869,7 +1421,7 @@ export default class User extends RestModel.extend(Evented) {});}- undoRevokeApiKey(key) {+ undoRevokeApiKey(key: EmberObject & UserApiKey) {return ajax("/user-api-key/undo-revoke", {type: "POST",data: { id: key.get("id") },@@ -878,9 +1430,16 @@ export default class User extends RestModel.extend(Evented) {});}- pmPath(topic) {+ pmPath(topic: Topic): string | undefined {const username = this.username_lower;- const details = topic.details;+ // TODO(typescript-pending): TopicDetails omits allowed-user/group fields; remove when TopicDetails is typed.+ const details = topic.details as Omit<+ Topic["details"],+ "allowed_users" | "allowed_groups"+ > & {+ allowed_users?: TopicBasicUser[];+ allowed_groups?: { id: number; name: string }[];+ };const allowedUsers = details?.allowed_users;const groups = details?.allowed_groups;@@ -889,7 +1448,9 @@ export default class User extends RestModel.extend(Evented) {return userPath(`${username}/messages`);} else if (groups) {const firstAllowedGroup = groups.find((allowedGroup) =>- this.visibleGroups.some((userGroup) => userGroup.id === allowedGroup.id)+ this.visibleGroups!.some(+ (userGroup) => userGroup.id === allowedGroup.id+ ));if (firstAllowedGroup) {@@ -898,14 +1459,14 @@ export default class User extends RestModel.extend(Evented) {}}- changeUsername(new_username) {+ changeUsername(new_username: string): globalThis.Promise<unknown> {return ajax(userPath(`${this.username_lower}/preferences/username`), {type: "PUT",data: { new_username },});}- addEmail(email) {+ addEmail(email: string) {return ajax(userPath(`${this.username_lower}/preferences/email`), {type: "POST",data: { email },@@ -914,13 +1475,13 @@ export default class User extends RestModel.extend(Evented) {this.set("unconfirmed_emails", []);}- if (!this.unconfirmed_emails.includes(email)) {- this.unconfirmed_emails.push(email);+ if (!this.unconfirmed_emails!.includes(email)) {+ this.unconfirmed_emails!.push(email);}});}- changeEmail(email) {+ changeEmail(email: string) {return ajax(userPath(`${this.username_lower}/preferences/email`), {type: "PUT",data: { email },@@ -929,14 +1490,14 @@ export default class User extends RestModel.extend(Evented) {this.set("unconfirmed_emails", []);}- this.unconfirmed_emails.push(email);+ this.unconfirmed_emails!.push(email);});}- save(fields) {+ override save(fields?: string[]) {const data = this.getProperties(userFields.filter((uf) => !fields || fields.includes(uf))- );+ ) as Record<string, unknown>;const filteredUserOptionFields = fields? userOptionFields.filter((uo) => fields.includes(uo))@@ -946,7 +1507,7 @@ export default class User extends RestModel.extend(Evented) {data[s] = this.get(`user_option.${s}`);});- const updatedState = {};+ const updatedState: Partial<UserFields> = {};["muted", "regular", "watched", "tracked", "watched_first_post"].forEach((categoryNotificationLevel) => {@@ -956,11 +1517,13 @@ export default class User extends RestModel.extend(Evented) {) {const categories = this.get(`${camelize(categoryNotificationLevel)}Categories`- );+ ) as Category[] | undefined;if (categories) {- const ids = categories.map((c) => c.get("id"));- updatedState[`${categoryNotificationLevel}_category_ids`] = ids;+ const ids = categories.map((c) => c.get("id")!);+ updatedState[+ `${categoryNotificationLevel}_category_ids` as "muted_category_ids"+ ] = ids;// HACK: Empty arrays are not sent in the request, we use [-1],// an invalid category ID, that will be ignored by the server.data[`${categoryNotificationLevel}_category_ids`] =@@ -977,7 +1540,7 @@ export default class User extends RestModel.extend(Evented) {"watching_first_post_tags",].forEach((prop) => {if (fields === undefined || fields.includes(prop)) {- const tags = this.get(prop);+ const tags = this.get(prop) as (SiteTopTag | string)[] | undefined;if (tags) {const names = tags.map((t) => (typeof t === "object" ? t.name : t));data[prop] = names.join(",");@@ -988,7 +1551,7 @@ export default class User extends RestModel.extend(Evented) {});["sidebar_category_ids", "sidebar_tag_names"].forEach((prop) => {- if (data[prop]?.length === 0) {+ if ((data[prop] as unknown[] | null | undefined)?.length === 0) {data[prop] = null;}});@@ -999,103 +1562,110 @@ export default class User extends RestModel.extend(Evented) {data,type: "PUT",})- .then((result) => {- this.setProperties(updatedState);- this.setProperties(getProperties(result.user, "bio_excerpt"));- return result;- })+ .then(+ (+ result: RestModelSaveResult<this> & { user: { bio_excerpt?: string } }+ ) => {+ this.setProperties(updatedState);+ this.setProperties(getProperties(result.user, "bio_excerpt"));+ return result;+ }+ ).finally(() => {this.set("isSaving", false);});}- setPrimaryEmail(email) {+ setPrimaryEmail(email: string) {return ajax(userPath(`${this.username}/preferences/primary-email.json`), {type: "PUT",data: { email },}).then(() => {- removeValueFromArray(this.secondary_emails, email);- this.secondary_emails.push(this.email);+ removeValueFromArray(this.secondary_emails!, email);+ this.secondary_emails!.push(this.email!);this.set("email", email);});}- async destroyEmail(email) {+ async destroyEmail(email: string) {await ajax(userPath(`${this.username}/preferences/email.json`), {type: "DELETE",data: { email },});removeValueFromArray(- this.unconfirmed_emails.includes(email)- ? this.unconfirmed_emails- : this.secondary_emails,+ this.unconfirmed_emails!.includes(email)+ ? this.unconfirmed_emails!+ : this.secondary_emails!,);}- changePassword() {+ changePassword(): globalThis.Promise<unknown> {return ajax("/session/forgot_password.json", {data: { login: this.email || this.username },type: "POST",});}- async removePassword() {+ async removePassword(): globalThis.Promise<unknown> {return ajax(userPath(`${this.username}/remove-password`), {type: "PUT",});}- loadSecondFactorCodes() {+ loadSecondFactorCodes(): globalThis.Promise<unknown> {return ajax("/u/second_factors.json", {type: "POST",});}- requestSecurityKeyChallenge() {+ requestSecurityKeyChallenge(): globalThis.Promise<unknown> {return ajax("/u/create_second_factor_security_key.json", {type: "POST",});}- registerSecurityKey(credential) {+ registerSecurityKey(credential: object): globalThis.Promise<unknown> {return ajax("/u/register_second_factor_security_key.json", {data: credential,type: "POST",});}- trustedSession() {+ trustedSession(): globalThis.Promise<unknown> {return ajax("/u/trusted-session.json");}- createPasskey() {+ createPasskey(): globalThis.Promise<unknown> {return ajax("/u/create_passkey.json", {type: "POST",});}- registerPasskey(credential) {+ registerPasskey(credential: object): globalThis.Promise<unknown> {return ajax("/u/register_passkey.json", {data: credential,type: "POST",});}- deletePasskey(id) {+ deletePasskey(id: number): globalThis.Promise<unknown> {return ajax(`/u/delete_passkey/${id}`, {type: "DELETE",});}- createSecondFactorTotp() {+ createSecondFactorTotp(): globalThis.Promise<unknown> {return ajax("/u/create_second_factor_totp.json", {type: "POST",});}- enableSecondFactorTotp(authToken, name) {+ enableSecondFactorTotp(+ authToken: string,+ name: string+ ): globalThis.Promise<unknown> {return ajax("/u/enable_second_factor_totp.json", {data: {second_factor_token: authToken,@@ -1105,13 +1675,18 @@ export default class User extends RestModel.extend(Evented) {});}- disableAllSecondFactors() {+ disableAllSecondFactors(): globalThis.Promise<unknown> {return ajax("/u/disable_second_factor.json", {type: "PUT",});}- updateSecondFactor(id, name, disable, targetMethod) {+ updateSecondFactor(+ id: number,+ name: string,+ disable: boolean,+ targetMethod?: number+ ): globalThis.Promise<unknown> {return ajax("/u/second_factor.json", {data: {second_factor_target: targetMethod,@@ -1123,7 +1698,11 @@ export default class User extends RestModel.extend(Evented) {});}- updateSecurityKey(id, name, disable) {+ updateSecurityKey(+ id: number,+ name: string,+ disable: boolean+ ): globalThis.Promise<unknown> {return ajax("/u/security_key.json", {data: {name,@@ -1134,7 +1713,12 @@ export default class User extends RestModel.extend(Evented) {});}- toggleSecondFactor(authToken, authMethod, targetMethod, enable) {+ toggleSecondFactor(+ authToken: string,+ authMethod: number,+ targetMethod: number,+ enable: boolean+ ): globalThis.Promise<unknown> {return ajax("/u/second_factor.json", {data: {second_factor_token: authToken,@@ -1146,21 +1730,24 @@ export default class User extends RestModel.extend(Evented) {});}- generateSecondFactorCodes() {+ generateSecondFactorCodes(): globalThis.Promise<unknown> {return ajax("/u/second_factors_backup.json", {type: "PUT",});}- revokeAssociatedAccount(providerName) {+ revokeAssociatedAccount(providerName: string): globalThis.Promise<unknown> {return ajax(userPath(`${this.username}/preferences/revoke-account`), {data: { provider_name: providerName },type: "POST",});}- async loadUserAction(id) {- const result = await ajax(`/user_actions/${id}.json`);+ async loadUserAction(id: number) {+ // TODO(typescript-pending): ajax has no endpoint response contracts; remove when user-action responses are typed.+ const result = (await ajax(`/user_actions/${id}.json`)) as {+ user_action?: UserActionFields & RestPayload;+ };if (!result?.user_action) {return;@@ -1182,14 +1769,16 @@ export default class User extends RestModel.extend(Evented) {this.stream.content.unshift(action[0]);}- inAllStream(ua) {+ inAllStream(ua: { action_type: number | null }) {return (ua.action_type === UserAction.TYPES.posts ||ua.action_type === UserAction.TYPES.topics);}- findDetails(options) {+ /** Hydrates this instance and consumes options.forCard in place. */+ findDetails(options?: UserFindDetailsOptions): globalThis.Promise<User> {+ // eslint-disable-next-line @typescript-eslint/no-this-alias -- Preserve the callback receiver in this types-only port.const user = this;return PreloadStore.getAndRemove(`user_${user.get("username")}`, () => {@@ -1208,21 +1797,22 @@ export default class User extends RestModel.extend(Evented) {: `${user.get("username")}.json`;return ajax(userPath(path), { data: options });- }).then((json) => {+ }).then((json: UserDetailsResponse) => {if (!isEmpty(json.user.stats)) {json.user.stats = User.groupStats(- json.user.stats.map((s) => {+ json.user.stats!.map((s) => {if (s.count) {- s.count = parseInt(s.count, 10);+ s.count = parseInt(s.count as string, 10);}- return UserActionStat.create(s);+ return UserActionStat.create(s as RestModelAttrs<UserActionStat>);}));}if (Object.hasOwn(json.user, "groups")) {- json.user.visibleGroups = json.user.groups.map((groupJson, index) => {- const group = Group.create(groupJson);+ json.user.visibleGroups = json.user.groups!.map((groupJson, index) => {+ // TODO(typescript-pending): Group omits group_user and serializer fields; remove when Group is typed.+ const group = Group.create(groupJson) as Group & UserGroup;group.group_user = json.user.group_users?.[index];return group;});@@ -1230,21 +1820,29 @@ export default class User extends RestModel.extend(Evented) {}if (json.user.invited_by) {- json.user.invited_by = User.create(json.user.invited_by);+ json.user.invited_by = User.create(+ json.user.invited_by as UserCreateAttrs+ );}if (!isEmpty(json.user.featured_user_badge_ids)) {- const userBadgesMap = {};- UserBadge.createFromJson(json).forEach((userBadge) => {- userBadgesMap[userBadge.get("id")] = userBadge;+ // TODO(typescript-pending): UserBadge omits id and createFromJson's element type; remove when UserBadge is typed.+ const userBadgesMap: Record<number, UserBadge> = {};+ (+ UserBadge.createFromJson(json) as (UserBadge & { id: number })[]+ ).forEach((userBadge) => {+ userBadgesMap[userBadge.get("id") as number] = userBadge;});- json.user.featured_user_badges = json.user.featured_user_badge_ids.map(+ json.user.featured_user_badges = json.user.featured_user_badge_ids!.map((id) => userBadgesMap[id]);}if (json.user.card_badge) {- json.user.card_badge = Badge.create(json.user.card_badge);+ // TODO(typescript-pending): Badge.create returns its base wrapper; remove when Badge is typed.+ json.user.card_badge = Badge.create(+ json.user.card_badge+ ) as UserBadgeModel;}const timezone = json.user.timezone;@@ -1261,7 +1859,7 @@ export default class User extends RestModel.extend(Evented) {});}- findStaffInfo() {+ findStaffInfo(): globalThis.Promise<void | null> {if (!User.currentProp("staff")) {return Promise.resolve(null);}@@ -1272,7 +1870,11 @@ export default class User extends RestModel.extend(Evented) {);}- pickAvatar(upload_id, type, associated_account_id) {+ pickAvatar(+ upload_id: number | null,+ type: string,+ associated_account_id?: number+ ): globalThis.Promise<unknown> {return ajax(userPath(`${this.username_lower}/preferences/avatar/pick`), {type: "PUT",data: {@@ -1283,38 +1885,46 @@ export default class User extends RestModel.extend(Evented) {});}- selectAvatar(avatarUrl) {+ selectAvatar(avatarUrl: string): globalThis.Promise<unknown> {return ajax(userPath(`${this.username_lower}/preferences/avatar/select`), {type: "PUT",data: { url: avatarUrl },});}- isAllowedToUploadAFile(type) {+ isAllowedToUploadAFile(type: string): boolean {const settingName = type === "image" ? "embedded_media" : "attachments";return (this.staff ||- this.trust_level > 0 ||- this.siteSettings[`newuser_max_${settingName}`] > 0+ this.trust_level! > 0 ||+ (this.siteSettings[`newuser_max_${settingName}`] as number) > 0);}- createInvite(email, group_ids, custom_message) {+ createInvite(+ email: string,+ group_ids?: number[],+ custom_message?: string+ ): globalThis.Promise<unknown> {return ajax("/invites", {type: "POST",data: { email, group_ids, custom_message },});}- generateInviteLink(email, group_ids, topic_id) {+ generateInviteLink(+ email?: string,+ group_ids?: number[],+ topic_id?: number+ ): globalThis.Promise<unknown> {return ajax("/invites", {type: "POST",data: { email, skip_email: true, group_ids, topic_id },});}- delete() {+ delete(): globalThis.Promise<unknown> {if (this.can_delete_account) {return ajax(userPath(this.username + ".json"), {type: "DELETE",@@ -1325,7 +1935,15 @@ export default class User extends RestModel.extend(Evented) {}}- updateNotificationLevel({ level, expiringAt = null, actingUser = null }) {+ updateNotificationLevel({+ level,+ expiringAt = null,+ actingUser = null,+ }: {+ level: "normal" | "mute" | "ignore";+ expiringAt?: string | null;+ actingUser?: User | null;+ }) {actingUser ||= User.current();return ajax(`${userPath(this.username)}/notification_level.json`, {@@ -1333,21 +1951,21 @@ export default class User extends RestModel.extend(Evented) {data: {notification_level: level,expiring_at: expiringAt,- acting_user_id: actingUser.id,+ acting_user_id: actingUser!.id,},}).then(() => {- if (!actingUser.ignored_users) {- actingUser.ignored_users = [];+ if (!actingUser!.ignored_users) {+ actingUser!.ignored_users = [];}if (level === "normal" || level === "mute") {- removeValueFromArray(actingUser.ignored_users, this.username);+ removeValueFromArray(actingUser!.ignored_users, this.username);} else if (level === "ignore") {- addUniqueValueToArray(actingUser.ignored_users, this.username);+ addUniqueValueToArray(actingUser!.ignored_users, this.username);}});}- dismissBanner(bannerKey) {+ dismissBanner(bannerKey: number) {this.set("dismissed_banner_key", bannerKey);ajax(userPath(this.username + ".json"), {type: "PUT",@@ -1370,19 +1988,29 @@ export default class User extends RestModel.extend(Evented) {});}- summary() {- const store = getOwnerWithFallback(this).lookup("service:store");+ summary(): globalThis.Promise<UserSummary> {+ const store = getOwnerWithFallback(this).lookup(+ "service:store"+ ) as StoreService;return ajax(userPath(`${this.username_lower}/summary.json`)).then(- (json) => {+ // TODO(typescript-pending): ajax has no endpoint response contracts; remove when summary responses are typed.+ (json: {+ topics: RestModelAttrs<Topic>[];+ user_summary: Omit<UserSummary, "badges"> & {+ badges?: { badge_id: number; count: number }[];+ };+ }) => {const summary = json.user_summary;- const topicMap = {};- const badgeMap = {};+ const topicMap: Record<number, Topic> = {};+ const badgeMap: Record<number, UserBadgeModel> = {};json.topics.forEach(- (t) => (topicMap[t.id] = store.createRecord("topic", t))+ (t) => (topicMap[t.id!] = store.createRecord("topic", t))+ );+ (Badge.createFromJson(json) as UserBadgeModel[]).forEach(+ (b) => (badgeMap[b.id] = b));- Badge.createFromJson(json).forEach((b) => (badgeMap[b.id] = b));summary.topics = summary.topic_ids.map((id) => topicMap[id]);@@ -1398,7 +2026,7 @@ export default class User extends RestModel.extend(Evented) {});if (summary.badges) {- summary.badges = summary.badges.map((ub) => {+ (summary as UserSummary).badges = summary.badges.map((ub) => {const badge = badgeMap[ub.badge_id];badge.count = ub.count;return badge;@@ -1413,16 +2041,16 @@ export default class User extends RestModel.extend(Evented) {});}- return summary;+ return summary as UserSummary;});}- canManageGroup(group) {+ canManageGroup(group: Group & UserGroup) {return group.get("can_admin_group") || group.get("is_group_owner");}- updateTextSizeCookie(newSize) {+ updateTextSizeCookie(newSize: string | null) {if (newSize) {const seq = this.get("user_option.text_size_seq");cookie(TEXT_SIZE_COOKIE_NAME, `${newSize}|${seq}`, {@@ -1443,11 +2071,15 @@ export default class User extends RestModel.extend(Evented) {});- return this.user_option.timezone;+ return this.user_option!.timezone;}- calculateMutedIds(notificationLevel, id, type) {- const muted_ids = this.get(type);+ calculateMutedIds(+ notificationLevel: number,+ id: number,+ type: "muted_category_ids"+ ): number[] {+ const muted_ids = this.get(type)!;if (notificationLevel === NotificationLevels.MUTED) {return uniqueItemsFromArray(muted_ids.concat(id));} else {@@ -1455,14 +2087,14 @@ export default class User extends RestModel.extend(Evented) {}}- setPrimaryGroup(primaryGroupId) {+ setPrimaryGroup(primaryGroupId: number | null): globalThis.Promise<unknown> {return ajax(`/admin/users/${this.id}/primary_group`, {type: "PUT",data: { primary_group_id: primaryGroupId },});}- enterDoNotDisturbFor(duration) {+ enterDoNotDisturbFor(duration: number) {return ajax({url: "/do-not-disturb.json",type: "POST",@@ -1481,45 +2113,58 @@ export default class User extends RestModel.extend(Evented) {});}- updateDoNotDisturbStatus(ends_at) {+ updateDoNotDisturbStatus(ends_at: string | null) {this.set("do_not_disturb_until", ends_at);this.appEvents.trigger("do-not-disturb:changed", this.do_not_disturb_until);- getOwner(this).lookup("service:notifications")._checkDoNotDisturb();+ (+ getOwner(this)!.lookup("service:notifications") as NotificationsService+ )._checkDoNotDisturb();}- updateDraftProperties(properties) {+ updateDraftProperties(+ properties: Partial<Pick<UserFields, "draft_count" | "pending_posts_count">>+ ) {this.setProperties(properties);this.appEvents.trigger("user-drafts:changed");}- updateReviewableCount(count) {+ updateReviewableCount(count: number) {this.set("reviewable_count", count);this.appEvents.trigger("user-reviewable-count:changed", count);}- isInDoNotDisturb() {- if (this !== getOwner(this).lookup("service:current-user")) {+ isInDoNotDisturb(): boolean {+ if (this !== getOwner(this)!.lookup("service:current-user")) {throw "isInDoNotDisturb is only supported for currentUser";}- return getOwner(this).lookup("service:notifications").isInDoNotDisturb;+ // TODO(typescript-pending): NotificationsService's tracked state is untyped; remove when the service is typed.+ return (+ getOwner(this)!.lookup(+ "service:notifications"+ ) as NotificationsService & { isInDoNotDisturb: boolean }+ ).isInDoNotDisturb;}}User.reopenClass({- // Find a `User` for a given username.- findByUsername(username, options) {+ /** Find a User for a given username. */+ findByUsername(username: string, options?: UserFindDetailsOptions) {const user = User.create({ username });return user.findDetails(options);},- checkUsername(username, email, for_user_id) {+ checkUsername(+ username?: string | null,+ email?: string | null,+ for_user_id?: number+ ) {return ajax(userPath("check_username"), {data: { username, email, for_user_id },});},- checkEmail(email) {+ checkEmail(email: string) {return ajax(userPath("check_email"), { data: { email } });},@@ -1531,7 +2176,7 @@ User.reopenClass({return ajax(`/u/recent-searches`, { type: "DELETE" });},- groupStats(stats) {+ groupStats(stats: UserActionStat[]) {const responses = UserActionStat.create({count: 0,action_type: UserAction.TYPES.replies,@@ -1543,7 +2188,7 @@ User.reopenClass({responses.set("count", responses.get("count") + stat.get("count"));});- const result = trackedArray();+ const result = trackedArray<UserActionStat>();result.push(...stats.filter((stat) => !stat.isResponse));let insertAt = 0;@@ -1561,8 +2206,8 @@ User.reopenClass({return result;},- async createAccount(attrs) {- let data = {+ async createAccount(attrs: UserAccountAttrs) {+ let data: RestPayload = {name: attrs.accountName,email: attrs.accountEmail,password: attrs.accountPassword,@@ -1588,7 +2233,7 @@ User.reopenClass({);},- _saveTimezone(user) {+ _saveTimezone(user: { username: string; user_option: UserOption }) {ajax(userPath(user.username + ".json"), {type: "PUT",dataType: "json",@@ -1596,7 +2241,10 @@ User.reopenClass({});},- create(args) {+ create(+ this: typeof User & { _super: (attrs: UserCreateAttrs) => User },+ args?: UserCreateAttrs & RestPayload+ ) {args = args || {};this.deleteStatusTrackingFields(args);@@ -1608,7 +2256,7 @@ User.reopenClass({return this._super(args);},- deleteStatusTrackingFields(args) {+ deleteStatusTrackingFields(args: RestPayload) {// every user instance has to have it's own tracking fields// when creating a new user model// its _subscribersCount and _clearStatusTimerId fields@@ -1627,22 +2275,21 @@ User.reopenClass({},});-// user status tracking+/** Tracks live status updates and expiry for one user. */class UserStatusManager {- @service appEvents;+ @service appEvents!: AppEventsService;- user;+ user: User;_subscribersCount = 0;- /** @type {import("@ember/runloop").Timer | null} */- _clearStatusTimerId = null;+ _clearStatusTimerId: Timer | null = null;- constructor(user) {+ constructor(user: User) {this.user = user;- setOwner(this, getOwner(user));+ setOwner(this, getOwner(user)!);}- // always call stopTrackingStatus() when done with a user+ /** Always call stopTrackingStatus() when done with a user. */trackStatus() {if (!this.user.id && !isTesting()) {// eslint-disable-next-line no-console@@ -1694,7 +2341,7 @@ class UserStatusManager {}}- _scheduleStatusClearing(endsAt) {+ _scheduleStatusClearing(endsAt: string) {if (isTesting()) {return;}@@ -1706,14 +2353,15 @@ class UserStatusManager {const utcNow = moment.utc();const remaining = moment.utc(endsAt).diff(utcNow, "milliseconds");this._clearStatusTimerId = discourseLater(- this,+ this as UserStatusManager,"_autoClearStatus",remaining);}_unscheduleStatusClearing() {- cancel(this._clearStatusTimerId);+ // Ember accepts null as a no-op at runtime, though cancel's declaration excludes it.+ cancel(this._clearStatusTimerId as Timer | undefined);this._clearStatusTimerId = null;}@@ -1721,7 +2369,7 @@ class UserStatusManager {this.user.status = null;}- _updateStatus(statuses) {+ _updateStatus(statuses: Record<number, UserStatus | null>) {if (statuses.hasOwnProperty(this.user.id)) {this.user.status = statuses[this.user.id];}@@ -1730,7 +2378,7 @@ class UserStatusManager {if (typeof Discourse !== "undefined") {let warned = false;- // eslint-disable-next-line no-undef+Object.defineProperty(Discourse, "User", {get() {if (!warned) {@@ -1744,3 +2392,7 @@ if (typeof Discourse !== "undefined") {},});}++/** Legacy globals supplied by the application, without introducing module imports. */+declare const moment: typeof import("moment");+declare const Discourse: object | undefined;diff --git a/frontend/discourse/app/services/store.ts b/frontend/discourse/app/services/store.tsindex 40852618caf..65749f8cd66 100644--- a/frontend/discourse/app/services/store.ts+++ b/frontend/discourse/app/services/store.ts@@ -26,6 +26,7 @@ import type {default as Topic,TopicCreateAttrs,} from "discourse/models/topic";+import type { default as User, UserCreateAttrs } from "discourse/models/user";import type UserDraft from "discourse/models/user-draft";/** Model instances by store type name. Plugins add theirs through module augmentation. */@@ -37,6 +38,7 @@ export interface ModelRegistry {"published-page": PublishedPage;site: Site;topic: Topic;+ user: User;"user-draft": UserDraft;}@@ -47,6 +49,7 @@ export interface ModelRegistry {export interface ModelCreateAttrsRegistry {post: PostCreateAttrs<Post>;topic: TopicCreateAttrs<Topic>;+ user: UserCreateAttrs<User>;}type ModelNameLowercaseLetter =diff --git a/frontend/discourse/type-tests/models/user-test.ts b/frontend/discourse/type-tests/models/user-test.tsnew file mode 100644index 00000000000..07de31f824c--- /dev/null+++ b/frontend/discourse/type-tests/models/user-test.ts@@ -0,0 +1,240 @@+import { expectTypeOf } from "expect-type";+import type AdminUser from "discourse/admin/models/admin-user";+import type Bookmark from "discourse/models/bookmark";+import type RestModel from "discourse/models/rest";+import type Topic from "discourse/models/topic";+import User, {+ SECOND_FACTOR_METHODS,+ type UserCreateAttrs,+ type UserFindDetailsOptions,+ type UserGroup,+ type UserOption,+ type UserStatus,+ type UserSummary,+} from "discourse/models/user";+import type UserActionStat from "discourse/models/user-action-stat";+import type UserDraftsStream from "discourse/models/user-drafts-stream";+import type {+ default as StoreService,+ ModelFor,+} from "discourse/services/store";++declare const store: StoreService;+declare const user: User;+declare const topic: Topic;+declare const stat: UserActionStat;+declare const admin: AdminUser;+declare const options: UserFindDetailsOptions;++expectTypeOf(user).toExtend<RestModel>();+expectTypeOf(user).not.toBeAny();+expectTypeOf<ModelFor<"user">>().toEqualTypeOf<User>();++/* Construction. */++// The current-user preload goes through the store with its groups and flags.+expectTypeOf(+ store.createRecord("user", {+ id: 1,+ username: "sam",+ isCurrent: true,+ groups: [{ id: 1, name: "staff", has_messages: true }],+ })+).toEqualTypeOf<User>();+// Routes and lookups create a user from its username alone.+expectTypeOf(User.create({ username: "sam" })).toEqualTypeOf<User>();+// A missing argument becomes an empty user.+expectTypeOf(User.create()).toEqualTypeOf<User>();+expectTypeOf(User.create(undefined)).toEqualTypeOf<User>();+// @ts-expect-error usernames are strings+User.create({ username: 1 });++expectTypeOf(User.current()).toEqualTypeOf<User | null>();+User.resetCurrent(null);+User.resetCurrent(user);++/* Identity: every server payload sends these; username-only users get them from `findDetails`. */++expectTypeOf(user.id).toEqualTypeOf<number>();+expectTypeOf(user.username).toEqualTypeOf<string>();+expectTypeOf(user.username_lower).toEqualTypeOf<string>();+expectTypeOf(user.avatar_template).toEqualTypeOf<string>();+// Omitted when names are disabled; null when the user has none.+expectTypeOf(user.name).toEqualTypeOf<string | null | undefined>();+expectTypeOf(user.title).toEqualTypeOf<string | null | undefined>();+// Embedded basic users omit roles and trust level.+expectTypeOf(user.admin).toEqualTypeOf<boolean | undefined>();+expectTypeOf(user.moderator).toEqualTypeOf<boolean | undefined>();+expectTypeOf(user.trust_level).toEqualTypeOf<number | undefined>();+expectTypeOf(user.primary_group_name).toEqualTypeOf<+ string | null | undefined+>();+expectTypeOf(user.flair_url).toEqualTypeOf<string | null | undefined>();+expectTypeOf(user.profile_hidden).toEqualTypeOf<true | undefined>();++/* Current-user payload. */++expectTypeOf(user.unread_notifications).toEqualTypeOf<number | undefined>();+expectTypeOf(user.grouped_unread_notifications).toEqualTypeOf<+ Record<string, number> | undefined+>();+expectTypeOf(user.can_send_private_messages).toEqualTypeOf<+ boolean | undefined+>();+// Sent only when true.+expectTypeOf(user.can_invite_to_forum).toEqualTypeOf<true | undefined>();+expectTypeOf(user.muted_category_ids).toEqualTypeOf<number[] | undefined>();+expectTypeOf(user.ignored_users).toEqualTypeOf<string[] | undefined>();+expectTypeOf(user.dismissed_banner_key).toEqualTypeOf<+ number | null | undefined+>();+expectTypeOf(user.do_not_disturb_until).toEqualTypeOf<+ string | null | undefined+>();++// Statuses expire at an ISO time or never; clearing one assigns null.+expectTypeOf(user.status).toEqualTypeOf<UserStatus | null | undefined>();+expectTypeOf<UserStatus["description"]>().toEqualTypeOf<string>();+expectTypeOf<UserStatus["emoji"]>().toEqualTypeOf<string>();+expectTypeOf<UserStatus["ends_at"]>().toEqualTypeOf<string | null>();+user.status = null;++/* Options: the current-user and profile serializers send different subsets. */++expectTypeOf(user.user_option).toEqualTypeOf<UserOption | undefined>();+expectTypeOf(user.user_option?.timezone).toEqualTypeOf<+ string | null | undefined+>();+expectTypeOf(user.user_option?.interface_color_mode).toEqualTypeOf<+ number | undefined+>();+expectTypeOf(user.user_option?.theme_ids).toEqualTypeOf<number[] | undefined>();+expectTypeOf(user.user_option?.seen_popups).toEqualTypeOf<+ number[] | null | undefined+>();++/* Derived state. */++expectTypeOf(user.staff).toEqualTypeOf<boolean | undefined>();+expectTypeOf(user.canManageTopic).toEqualTypeOf<boolean>();+expectTypeOf(user.canSetTopicTimer).toEqualTypeOf<boolean>();+expectTypeOf(user.isBasic).toEqualTypeOf<boolean>();+expectTypeOf(user.isLeader).toEqualTypeOf<boolean>();+expectTypeOf(user.displayName).toEqualTypeOf<string>();+expectTypeOf(user.adminPath).toEqualTypeOf<string>();+expectTypeOf(user.previousVisitAt).toEqualTypeOf<Date>();+expectTypeOf(user.suspendedForever).toEqualTypeOf<boolean>();+expectTypeOf(user.searchContext).toExtend<{+ type: string;+ id: string;+ user: User;+}>();+expectTypeOf(user.prefersDarkColor).toEqualTypeOf<boolean>();++/* Methods. */++expectTypeOf(user.findDetails()).resolves.toEqualTypeOf<User>();+expectTypeOf(+ user.findDetails({ forCard: true, include_post_count_for: 1 })+).resolves.toEqualTypeOf<User>();+expectTypeOf(+ User.findByUsername("sam", { forCard: true })+).resolves.toEqualTypeOf<User>();+User.findByUsername("sam");+user.findStaffInfo();+expectTypeOf(+ user.updateNotificationLevel({+ level: "ignore",+ expiringAt: "2026-10-27T10:00:00Z",+ actingUser: user,+ })+).resolves.toEqualTypeOf<void>();+user.updateNotificationLevel({ level: "normal", actingUser: user });+expectTypeOf(user.pmPath(topic)).toEqualTypeOf<string | undefined>();+expectTypeOf(user.isAllowedToUploadAFile("image")).toEqualTypeOf<boolean>();+expectTypeOf(user.inAllStream(stat)).toEqualTypeOf<boolean>();+expectTypeOf(user.isInDoNotDisturb()).toEqualTypeOf<boolean>();+expectTypeOf(user.dismissBanner(3)).toEqualTypeOf<void>();+user.updateDoNotDisturbStatus(null);+user.updateDoNotDisturbStatus("2026-10-27T10:00:00Z");+user.updateReviewableCount(3);+user.setPrimaryGroup(null);+user.setPrimaryGroup(1);+user.save();+user.save(["name", "title"]);+user.updateSecondFactor(0, "", true, SECOND_FACTOR_METHODS.BACKUP_CODE);+user.pickAvatar(1, "custom");++/* Statics. */++User.checkUsername("sam", undefined, 1);+// Username suggestions send no username.+User.checkUsername(null, "[email protected]");+expectTypeOf(User.groupStats([stat])).toEqualTypeOf<UserActionStat[]>();++/* Status tracking and events. */++user.statusManager.trackStatus();+user.statusManager.stopTrackingStatus();+expectTypeOf(user.statusManager.isTrackingStatus()).toEqualTypeOf<boolean>();+const listener = { onStatusChanged() {} };+user.on("status-changed", listener, "onStatusChanged");+user.off("status-changed", listener, "onStatusChanged");+user.trigger("status-changed", user);++/* Construction from existing users and other spellings. */++expectTypeOf<UserCreateAttrs>().not.toBeAny();+expectTypeOf(User.create(user)).toEqualTypeOf<User>();+expectTypeOf(store.createRecord("user", user)).toEqualTypeOf<User>();+expectTypeOf(+ store.createRecord("User", { username: "sam" })+).toEqualTypeOf<User>();++/* Groups, child models and falsey getters. */++expectTypeOf(user.visibleGroups).toEqualTypeOf<UserGroup[] | undefined>();+expectTypeOf(user.groups).toEqualTypeOf<UserGroup[] | undefined>();+expectTypeOf(user.bookmarks).toEqualTypeOf<Bookmark>();+expectTypeOf(user.userDraftsStream).toEqualTypeOf<UserDraftsStream>();+// Absent timestamps pass through the `&&` unchanged.+expectTypeOf(user.suspended).toEqualTypeOf<"" | boolean | null | undefined>();+expectTypeOf(user.silenced).toEqualTypeOf<"" | boolean | null | undefined>();+expectTypeOf(user.path).toEqualTypeOf<string>();+expectTypeOf(user.sidebarLinkToFilteredList).toEqualTypeOf<+ boolean | undefined+>();+expectTypeOf(user.calculateMutedIds(0, 1, "muted_category_ids")).toEqualTypeOf<+ number[]+>();+expectTypeOf(user.findDetails(options)).resolves.toEqualTypeOf<User>();+// Notification tags arrive as records and are saved as names.+const notificationTags: NonNullable<User["watched_tags"]> = [+ { id: 1, name: "support", slug: "support" },+ "support",+];+expectTypeOf(notificationTags).not.toBeAny();++/* Summary: statistics are permission-gated independently of profile fields. */++expectTypeOf(user.summary()).resolves.toEqualTypeOf<UserSummary>();+expectTypeOf<UserSummary["likes_given"]>().toEqualTypeOf<number | undefined>();+expectTypeOf<UserSummary["bookmark_count"]>().toEqualTypeOf<+ number | undefined+>();+expectTypeOf<+ UserSummary["most_liked_users"][number]["count"]+>().toEqualTypeOf<number>();++/* Singleton and Evented returns. */++expectTypeOf(User.currentProp("username")).toEqualTypeOf<string | undefined>();+expectTypeOf(User.resetCurrent()).toEqualTypeOf<undefined>();+expectTypeOf(user.on("status-changed", () => {})).toEqualTypeOf<User>();+expectTypeOf(user.one("status-changed", () => {})).toEqualTypeOf<User>();+expectTypeOf(user.has("status-changed")).toEqualTypeOf<boolean>();++/* Subclasses: AdminUser's HTTP destroy stays compatible with the inherited one. */++expectTypeOf<AdminUser>().toExtend<User>();+expectTypeOf(admin.destroy({ deletePosts: true })).resolves.not.toBeAny();