Skip to content

A platform for community discussion. Free, open, simple.

DEV: Type strict-narrowed members in controllers and routes (#44657)

Sérgio Saquetima56b8424cae5
diff --git a/frontend/discourse/admin/controllers/admin-api-keys/new.js b/frontend/discourse/admin/controllers/admin-api-keys/new.js
index 3fed1a13f11..0c6c04e576c 100644
--- a/frontend/discourse/admin/controllers/admin-api-keys/new.js
+++ b/frontend/discourse/admin/controllers/admin-api-keys/new.js
@@ -9,6 +9,15 @@ import { popupAjaxError } from "discourse/lib/ajax-error";
import { i18n } from "discourse-i18n";
import ApiKeyUrlsModal from "../../components/modal/api-key-urls.gjs";
+/**
+ * @typedef {Object} ApiKeyScope
+ * @property {string} scope_id
+ * @property {string} key
+ * @property {string} name
+ * @property {string[] | null} params
+ * @property {string[]} urls
+ * @property {boolean} [selected]
+ */
export default class AdminApiKeysNewController extends Controller {
@service router;
@@ -25,7 +34,11 @@ export default class AdminApiKeysNewController extends Controller {
{ id: "read_only", name: i18n("admin.api.scopes.read_only") },
{ id: "global", name: i18n("admin.api.scopes.global") },
];
+
+ /** @type {ApiKeyScope[] | null} */
globalScopes = null;
+
+ /** @type {Record<string, ApiKeyScope[]> | null} */
scopes = null;
init() {
diff --git a/frontend/discourse/admin/controllers/admin-config/color-palettes/index.js b/frontend/discourse/admin/controllers/admin-config/color-palettes/index.js
index 4a6d8797f8f..e9b1b4361b0 100644
--- a/frontend/discourse/admin/controllers/admin-config/color-palettes/index.js
+++ b/frontend/discourse/admin/controllers/admin-config/color-palettes/index.js
@@ -16,6 +16,7 @@ export default class AdminConfigColorPalettesIndexController extends Controller
@service session;
@service interfaceColor;
+ /** @type {import("discourse/admin/models/theme").default | null} */
@tracked defaultTheme = null;
isDefaultThemeLightColorScheme = (scheme) => {
@@ -26,9 +27,16 @@ export default class AdminConfigColorPalettesIndexController extends Controller
return this.defaultTheme?.dark_color_scheme_id === scheme.id;
};
+ /** @type {number | undefined} */
_initialUserLightColorSchemeId = undefined;
+
+ /** @type {number | undefined} */
_initialUserDarkColorSchemeId = undefined;
+
+ /** @type {number | null | undefined} */
_initialDefaultThemeLightColorSchemeId = null;
+
+ /** @type {number | null | undefined} */
_initialDefaultThemeDarkColorSchemeId = null;
get allBaseColorSchemes() {
diff --git a/frontend/discourse/admin/controllers/admin-email-templates/edit.js b/frontend/discourse/admin/controllers/admin-email-templates/edit.js
index 54b6465ff4d..3c24629289b 100644
--- a/frontend/discourse/admin/controllers/admin-email-templates/edit.js
+++ b/frontend/discourse/admin/controllers/admin-email-templates/edit.js
@@ -13,6 +13,7 @@ export default class AdminEmailTemplatesEditController extends Controller {
@service dialog;
@controller adminEmailTemplates;
+ /** @type {import("discourse/admin/models/email-template").default | null | undefined} */
@tracked emailTemplate = null;
saved = false;
diff --git a/frontend/discourse/admin/controllers/admin-email/advanced-test.js b/frontend/discourse/admin/controllers/admin-email/advanced-test.js
index 2ae222da0c7..fe6d08b7225 100644
--- a/frontend/discourse/admin/controllers/admin-email/advanced-test.js
+++ b/frontend/discourse/admin/controllers/admin-email/advanced-test.js
@@ -4,10 +4,19 @@ import { ajax } from "discourse/lib/ajax";
import { popupAjaxError } from "discourse/lib/ajax-error";
export default class AdminEmailAdvancedTestController extends Controller {
+ /** @type {string | null} */
email = null;
+
+ /** @type {string | null} */
text = null;
+
+ /** @type {string | null} */
elided = null;
+
+ /** @type {1 | 2 | null} */
format = null;
+
+ /** @type {boolean | null} */
loading = null;
@action
diff --git a/frontend/discourse/admin/controllers/admin-email/preview-digest.js b/frontend/discourse/admin/controllers/admin-email/preview-digest.js
index 51066efa2ac..d16d7297c22 100644
--- a/frontend/discourse/admin/controllers/admin-email/preview-digest.js
+++ b/frontend/discourse/admin/controllers/admin-email/preview-digest.js
@@ -8,8 +8,13 @@ import { popupAjaxError } from "discourse/lib/ajax-error";
export default class AdminEmailPreviewDigestController extends Controller {
@service dialog;
+ /** @type {string | null | undefined} */
username = null;
+
+ /** @type {string | null} */
lastSeen = null;
+
+ /** @type {string | null} */
email = null;
@computed("email")
diff --git a/frontend/discourse/admin/controllers/admin-groups/index.js b/frontend/discourse/admin/controllers/admin-groups/index.js
index 813c297e457..ffe8f5bfa7e 100644
--- a/frontend/discourse/admin/controllers/admin-groups/index.js
+++ b/frontend/discourse/admin/controllers/admin-groups/index.js
@@ -8,10 +8,18 @@ export default class AdminGroupsIndexController extends Controller {
@service store;
queryParams = ["order", "asc", "filter", "type"];
+
+ /** @type {string | null} */
order = null;
+
+ /** @type {boolean | string | null} */
asc = null;
filter = "";
+
+ /** @type {string | null} */
type = null;
+
+ /** @type {import("discourse/models/result-set").default | null} */
groups = null;
@action
diff --git a/frontend/discourse/admin/controllers/admin-logs/screened-ip-addresses.js b/frontend/discourse/admin/controllers/admin-logs/screened-ip-addresses.js
index e9318b40c44..b32359e3023 100644
--- a/frontend/discourse/admin/controllers/admin-logs/screened-ip-addresses.js
+++ b/frontend/discourse/admin/controllers/admin-logs/screened-ip-addresses.js
@@ -16,8 +16,11 @@ import { i18n } from "discourse-i18n";
export default class AdminLogsScreenedIpAddressesController extends Controller {
@service dialog;
+ /** @type {string | null} */
@tracked filter = null;
@tracked loading = false;
+
+ /** @type {string | null} */
@tracked savedIpAddress = null;
@autoTrackedArray model;
diff --git a/frontend/discourse/admin/controllers/admin-logs/staff-action-logs.js b/frontend/discourse/admin/controllers/admin-logs/staff-action-logs.js
index 6fbf149bdb0..8e81dc252c7 100644
--- a/frontend/discourse/admin/controllers/admin-logs/staff-action-logs.js
+++ b/frontend/discourse/admin/controllers/admin-logs/staff-action-logs.js
@@ -13,8 +13,14 @@ export default class AdminLogsStaffActionLogsController extends Controller {
@service store;
queryParams = ["filters", "startDate", "endDate"];
+
+ /** @type {import("discourse/models/result-set").default | (import("@ember/object").default & { loadingMore: boolean }) | null} */
model = null;
+
+ /** @type {import("@ember/object").default & { action_name?: string, action_id?: number, custom_type?: string, acting_user?: string, target_user?: string, subject?: string } | null} */
filters = null;
+
+ /** @type {{ id: string, action_id: number, name: string, name_raw: string }[] | null} */
userHistoryActions = null;
/** @type {moment.Moment | null} */
@@ -35,6 +41,7 @@ export default class AdminLogsStaffActionLogsController extends Controller {
: null;
}
+ /** @returns {boolean | null} */
@computed("filters")
get filtersExists() {
return this.filters && Object.keys(this.filters).length > 0;
diff --git a/frontend/discourse/admin/controllers/admin-permalinks/index.js b/frontend/discourse/admin/controllers/admin-permalinks/index.js
index 5ce95832fdd..9174ff72bcd 100644
--- a/frontend/discourse/admin/controllers/admin-permalinks/index.js
+++ b/frontend/discourse/admin/controllers/admin-permalinks/index.js
@@ -15,6 +15,8 @@ export default class AdminPermalinksIndexController extends Controller {
@service toasts;
@tracked loading = false;
+
+ /** @type {string | null} */
@tracked filter = null;
@autoTrackedArray model;
diff --git a/frontend/discourse/admin/controllers/admin-plugins/index.js b/frontend/discourse/admin/controllers/admin-plugins/index.js
index 322c8fea2fe..209a602d0ea 100644
--- a/frontend/discourse/admin/controllers/admin-plugins/index.js
+++ b/frontend/discourse/admin/controllers/admin-plugins/index.js
@@ -9,6 +9,8 @@ export default class AdminPluginsIndexController extends Controller {
@service session;
queryParams = ["filter"];
+
+ /** @type {string | null} */
filter = null;
get searchableProps() {
diff --git a/frontend/discourse/admin/controllers/admin-reports/show.js b/frontend/discourse/admin/controllers/admin-reports/show.js
index 0419156560f..a11ee171f2d 100644
--- a/frontend/discourse/admin/controllers/admin-reports/show.js
+++ b/frontend/discourse/admin/controllers/admin-reports/show.js
@@ -17,9 +17,17 @@ export default class AdminReportsShowController extends Controller {
"chart_grouping",
"mode",
]);
+
+ /** @type {string | null} */
start_date = null;
+
+ /** @type {string | null} */
end_date = null;
+
+ /** @type {Record<string, unknown> | null} */
filters = null;
+
+ /** @type {string | null} */
chart_grouping = null;
@computed("model.type")
diff --git a/frontend/discourse/admin/controllers/admin-search-logs/term.js b/frontend/discourse/admin/controllers/admin-search-logs/term.js
index 4958044a60f..174ae3c7ea5 100644
--- a/frontend/discourse/admin/controllers/admin-search-logs/term.js
+++ b/frontend/discourse/admin/controllers/admin-search-logs/term.js
@@ -7,6 +7,8 @@ export default class AdminSearchLogsTermController extends Controller {
@service siteSettings;
loading = false;
+
+ /** @type {string | null} */
term = null;
period = DEFAULT_PERIOD;
searchType = "all";
diff --git a/frontend/discourse/admin/controllers/admin-site-text/edit.js b/frontend/discourse/admin/controllers/admin-site-text/edit.js
index a843dc70f1c..29129562a83 100644
--- a/frontend/discourse/admin/controllers/admin-site-text/edit.js
+++ b/frontend/discourse/admin/controllers/admin-site-text/edit.js
@@ -12,6 +12,8 @@ export default class AdminSiteTextEdit extends Controller {
@service dialog;
@tracked siteText;
+
+ /** @type {number | string | null} */
@tracked themeId = null;
saved = false;
queryParams = ["locale", { themeId: "theme_id" }];
diff --git a/frontend/discourse/admin/controllers/admin-site-text/index.js b/frontend/discourse/admin/controllers/admin-site-text/index.js
index 90b4767d7b1..b22c85c6541 100644
--- a/frontend/discourse/admin/controllers/admin-site-text/index.js
+++ b/frontend/discourse/admin/controllers/admin-site-text/index.js
@@ -17,6 +17,7 @@ export default class AdminSiteTextIndexController extends Controller {
@service modal;
@service store;
+ /** @type {number | string | null} */
@tracked themeId = null;
@tracked locale;
@tracked q;
diff --git a/frontend/discourse/admin/controllers/admin-site-traffic.js b/frontend/discourse/admin/controllers/admin-site-traffic.js
index d493565c090..b7f6314af96 100644
--- a/frontend/discourse/admin/controllers/admin-site-traffic.js
+++ b/frontend/discourse/admin/controllers/admin-site-traffic.js
@@ -42,21 +42,66 @@ const DIMENSION_KEYS = {
ip: "ip_addresses",
};
+/**
+ * @typedef {Object} SiteTrafficDimension
+ * @property {string} value
+ * @property {string} label
+ * @property {number} pageviews
+ */
+/**
+ * @typedef {Object} SiteTraffic
+ * @property {{ reason: string, available_start_date?: string, pageview_limit?: number, pageview_limit_start_at?: string } | null} partial_data
+ * @property {{ pageviews: number, distinct_sessions: number, logged_in_share: number, bounce_rate: number, average_session_duration_seconds: number }} summary
+ * @property {{ date: string, pageviews: number, logged_in_human_pageviews: number, anonymous_human_pageviews: number, likely_crawler_pageviews: number }[]} series
+ * @property {Record<"logged_in_human_pageviews" | "anonymous_human_pageviews" | "likely_crawler_pageviews", string>} series_colors
+ * @property {Record<"top_urls" | "entry_urls" | "referrers" | "countries" | "networks" | "browsers" | "languages" | "ip_addresses", SiteTrafficDimension[]>} dimensions
+ * @property {{ key: string, value: string, label: string }[]} [active_filters]
+ * @property {string} chart_start_date
+ * @property {string} chart_end_date
+ */
export default class AdminSiteTrafficController extends Controller {
@tracked range = DEFAULT_PERIOD;
+
+ /** @type {string | null} */
@tracked start_date = null;
+
+ /** @type {string | null} */
@tracked end_date = null;
+
+ /** @type {string | null} */
@tracked traffic_type = null;
+
+ /** @type {string | null} */
@tracked top_url = null;
+
+ /** @type {string | null} */
@tracked entry_url = null;
+
+ /** @type {string | null} */
@tracked referrer = null;
+
+ /** @type {string | null} */
@tracked country = null;
+
+ /** @type {string | null} */
@tracked network = null;
+
+ /** @type {string | null} */
@tracked browser = null;
+
+ /** @type {string | null} */
@tracked language = null;
+
+ /** @type {string | null} */
@tracked ip = null;
+
+ /** @type {SiteTraffic | null} */
@tracked traffic = null;
+
+ /** @type {"timeout" | "unexpected" | null} */
@tracked fetchError = null;
+
+ /** @type {Record<string, string[]>} */
@tracked draftFilters = Object.fromEntries(
FILTER_KEYS.map((key) => [key, []])
);
diff --git a/frontend/discourse/admin/controllers/admin-user/index.js b/frontend/discourse/admin/controllers/admin-user/index.js
index 8de60e375b4..c6b38d83598 100644
--- a/frontend/discourse/admin/controllers/admin-user/index.js
+++ b/frontend/discourse/admin/controllers/admin-user/index.js
@@ -25,11 +25,20 @@ export default class AdminUserIndexController extends Controller {
@service siteSettings;
@service modal;
+ /** @type {number[] | null} */
@tracked customGroupIdsBuffer = null;
+
+ /** @type {number | null | undefined} */
originalPrimaryGroupId = null;
+
+ /** @type {{ id: number, name: string, full_name?: string, display_name?: string, automatic: boolean, flair_url?: string | null, flair_bg_color?: string | null, flair_color?: string | null }[] | null} */
availableGroups = null;
userTitleValue = null;
+
+ /** @type {string | null} */
ssoExternalEmail = null;
+
+ /** @type {string | null} */
ssoLastPayload = null;
isLoading = false;
diff --git a/frontend/discourse/admin/controllers/admin-users-list/show.js b/frontend/discourse/admin/controllers/admin-users-list/show.js
index 90b6a5e96ce..475c213deb6 100644
--- a/frontend/discourse/admin/controllers/admin-users-list/show.js
+++ b/frontend/discourse/admin/controllers/admin-users-list/show.js
@@ -27,16 +27,28 @@ export default class AdminUsersListShowController extends Controller {
@tracked bulkSelectedUsersMap = {};
@tracked accountType = USER_ACCOUNT_TYPES.HUMAN;
+
+ /** @type {string | null | undefined} */
@tracked activation = null;
@tracked refreshing = false;
+
+ /** @type {string | null | undefined} */
@tracked listFilter = null;
+
+ /** @type {string | null | undefined} */
@tracked initialFilter = null;
+ /** @type {string | null} */
@tracked query = null;
+
+ /** @type {string | null | undefined} */
@tracked order = null;
+
+ /** @type {boolean | string | null | undefined} */
@tracked asc = null;
@tracked showEmails = false;
+ /** @type {HTMLInputElement | null} */
lastSelected = null;
#page = 1;
diff --git a/frontend/discourse/admin/controllers/admin-watched-words.js b/frontend/discourse/admin/controllers/admin-watched-words.js
index e6cc967eca1..e5d7f7748a4 100644
--- a/frontend/discourse/admin/controllers/admin-watched-words.js
+++ b/frontend/discourse/admin/controllers/admin-watched-words.js
@@ -21,7 +21,10 @@ export default class AdminWatchedWordsController extends Controller {
@service messageBus;
@service menu;
+ /** @type {string | null} */
@tracked filter = null;
+
+ /** @type {HTMLElement | null} */
menuTrigger = null;
@autoTrackedArray allWatchedWords;
diff --git a/frontend/discourse/admin/controllers/admin-watched-words/action.js b/frontend/discourse/admin/controllers/admin-watched-words/action.js
index c6c58b183f7..8aa36860a45 100644
--- a/frontend/discourse/admin/controllers/admin-watched-words/action.js
+++ b/frontend/discourse/admin/controllers/admin-watched-words/action.js
@@ -15,6 +15,7 @@ export default class AdminWatchedWordsActionController extends Controller {
@service modal;
@controller adminWatchedWords;
+ /** @type {string | null} */
@tracked actionNameKey = null;
@dependentKeyCompat
diff --git a/frontend/discourse/admin/controllers/admin/dashboard.js b/frontend/discourse/admin/controllers/admin/dashboard.js
index a1d63f25c74..9fee9975372 100644
--- a/frontend/discourse/admin/controllers/admin/dashboard.js
+++ b/frontend/discourse/admin/controllers/admin/dashboard.js
@@ -16,6 +16,14 @@ import { autoTrackedArray } from "discourse/lib/tracked-tools";
const PROBLEMS_CHECK_MINUTES = 1;
+/**
+ * @typedef {Object} LoadedDashboardSections
+ * @property {string} [period]
+ * @property {Date} [startDate]
+ * @property {Date} [endDate]
+ * @property {{ id: string, data?: unknown, error?: boolean }[]} sections
+ * @property {{ sections: { id: string, visible: boolean }[] }} [configuration]
+ */
export default class AdminDashboardController extends Controller {
@service siteSettings;
@service exception;
@@ -24,8 +32,14 @@ export default class AdminDashboardController extends Controller {
@tracked loadingProblems = false;
@tracked problemsFetchedAt;
@tracked range = DEFAULT_PERIOD;
+
+ /** @type {string | null} */
@tracked start_date = null;
+
+ /** @type {string | null} */
@tracked end_date = null;
+
+ /** @type {LoadedDashboardSections | null} */
@tracked loadedSections = null;
@tracked loadingSections = false;
@tracked sectionsFetchError = false;
@@ -34,6 +48,8 @@ export default class AdminDashboardController extends Controller {
queryParams = ["range", "start_date", "end_date"];
isLoading = false;
+
+ /** @type {Date | null} */
dashboardFetchedAt = null;
_sectionsLoadId = 0;
_sectionsLoadingCount = 0;
diff --git a/frontend/discourse/admin/controllers/admin/dashboard/general.js b/frontend/discourse/admin/controllers/admin/dashboard/general.js
index 72745265548..6097999db6b 100644
--- a/frontend/discourse/admin/controllers/admin/dashboard/general.js
+++ b/frontend/discourse/admin/controllers/admin/dashboard/general.js
@@ -19,6 +19,8 @@ export default class AdminDashboardGeneralController extends AdminDashboardTabCo
@service exception;
isLoading = false;
+
+ /** @type {Date | null} */
dashboardFetchedAt = null;
@staticReport("users_by_type") usersByTypeReport;
diff --git a/frontend/discourse/admin/controllers/admin/whats-new.js b/frontend/discourse/admin/controllers/admin/whats-new.js
index 256fb3c4429..6aebdee9e81 100644
--- a/frontend/discourse/admin/controllers/admin/whats-new.js
+++ b/frontend/discourse/admin/controllers/admin/whats-new.js
@@ -3,6 +3,7 @@ import Controller from "@ember/controller";
import { action } from "@ember/object";
export default class AdminWhatsNewController extends Controller {
+ /** @type {string | null} */
@tracked scrollTo = null;
queryParams = ["scrollTo"];
diff --git a/frontend/discourse/admin/controllers/edit-category/tabs.js b/frontend/discourse/admin/controllers/edit-category/tabs.js
index 23ce3cf1c61..ea17776c081 100644
--- a/frontend/discourse/admin/controllers/edit-category/tabs.js
+++ b/frontend/discourse/admin/controllers/edit-category/tabs.js
@@ -69,6 +69,23 @@ const SIMPLIFIED_FIELD_LIST = [
const SHOW_ADVANCED_TABS_KEY = "category_edit_show_advanced_tabs";
const DISCUSSION_TYPE_ID = "discussion";
+/**
+ * @typedef {Record<string, unknown> & { name?: string, style_type?: string, emoji?: string | null, icon?: string | null }} CategoryFormData
+ */
+/**
+ * @typedef {Object} CategoryFormApi
+ * @property {(name: string, value: unknown) => Promise<void>} set
+ * @property {(values: Record<string, unknown>) => Promise<void>} setProperties
+ * @property {(name: string) => unknown} get
+ * @property {() => void} commit
+ * @property {(name: string) => void} commitField
+ * @property {(event?: Event) => Promise<void>} submit
+ * @property {(event?: Event) => Promise<void>} reset
+ * @property {(name: string, error: { title?: string, message?: string }) => void} addError
+ * @property {(name: string) => void} removeError
+ * @property {() => void} removeErrors
+ * @property {boolean} isDirty
+ */
export default class EditCategoryTabsController extends Controller {
@service currentUser;
@service dialog;
@@ -84,6 +101,8 @@ export default class EditCategoryTabsController extends Controller {
this.keyValueStore.getItem(SHOW_ADVANCED_TABS_KEY) === "true";
@tracked formData;
@tracked selectedTab = "general";
+
+ /** @type {CategoryFormApi | null} */
@tracked formApi = null;
@tracked siteTextsLocale = this.siteSettings.default_locale;
@tracked isLoadingSiteTextsLocale = false;
@@ -94,6 +113,8 @@ export default class EditCategoryTabsController extends Controller {
deleting = false;
showTooltip = false;
expandedMenu = false;
+
+ /** @type {{ slug?: string } | null} */
parentParams = null;
validators = [];
@@ -248,10 +269,11 @@ export default class EditCategoryTabsController extends Controller {
* Both `addError` and `removeError` are passed to validators so they can
* manage errors bidirectionally.
*
- * @param {Object} data - The current form draft data.
- * @param {Object} helpers
- * @param {Function} helpers.addError - Adds a validation error for a field.
- * @param {Function} helpers.removeError - Removes a validation error for a field.
+ * @param {CategoryFormData} data - The current form draft data.
+ * @param {Pick<CategoryFormApi, "addError" | "removeError">} helpers
+ * @param {CategoryFormApi["addError"]} helpers.addError - Adds a validation error for a field.
+ * @param {CategoryFormApi["removeError"]} helpers.removeError - Removes a validation error for a field.
+ * @returns {void}
*/
@action
validateForm(data, { addError, removeError }) {
diff --git a/frontend/discourse/admin/routes/admin-site-settings.js b/frontend/discourse/admin/routes/admin-site-settings.js
index 49f2fb35786..2edefbb32a1 100644
--- a/frontend/discourse/admin/routes/admin-site-settings.js
+++ b/frontend/discourse/admin/routes/admin-site-settings.js
@@ -5,6 +5,15 @@ import SiteSetting from "discourse/admin/models/site-setting";
import DiscourseRoute from "discourse/routes/discourse";
import { i18n } from "discourse-i18n";
+/**
+ * @typedef {Object} SiteSettingCategory
+ * @property {string} nameKey
+ * @property {string} name
+ * @property {import("discourse/admin/models/site-setting").default[]} siteSettings
+ * @property {number | string} [count]
+ * @property {boolean} [hasMore]
+ * @property {number} [maxResults]
+ */
export default class AdminSiteSettingsRoute extends DiscourseRoute {
@service adminSiteSettingStore;
@service siteSettingChangeTracker;
@@ -24,6 +33,7 @@ export default class AdminSiteSettingsRoute extends DiscourseRoute {
},
};
+ /** @type {SiteSettingCategory[] | null} */
_siteSettings = null;
titleToken() {
@@ -64,6 +74,7 @@ export default class AdminSiteSettingsRoute extends DiscourseRoute {
}
}
+ /** @returns {SiteSettingCategory[]} */
@action
filterSettings(filter, onlyOverridden, dependsOn) {
const settingFilter = new SiteSettingFilter(this._siteSettings);
diff --git a/frontend/discourse/admin/routes/admin-site-traffic.js b/frontend/discourse/admin/routes/admin-site-traffic.js
index 48cb9fbc455..436684da115 100644
--- a/frontend/discourse/admin/routes/admin-site-traffic.js
+++ b/frontend/discourse/admin/routes/admin-site-traffic.js
@@ -45,6 +45,7 @@ export default class AdminSiteTrafficRoute extends DiscourseRoute {
return i18n("admin.site_traffic_explorer.title");
}
+ /** @returns {Promise<{ traffic: import("discourse/admin/controllers/admin-site-traffic").SiteTraffic | null, fetchError: "timeout" | "unexpected" | null }>} */
model(params) {
const requestParams = this.#requestParams(params);
diff --git a/frontend/discourse/admin/routes/admin-user.js b/frontend/discourse/admin/routes/admin-user.js
index fdcdfe542b2..cd10dd6c0b2 100644
--- a/frontend/discourse/admin/routes/admin-user.js
+++ b/frontend/discourse/admin/routes/admin-user.js
@@ -14,6 +14,10 @@ export default class AdminUserRoute extends DiscourseRoute {
};
}
+ /**
+ * @param {{ user_id: string | number }} params
+ * @returns {Promise<import("discourse/admin/models/admin-user").default>}
+ */
model(params) {
return AdminUser.find(get(params, "user_id"));
}
diff --git a/frontend/discourse/app/controllers/application.js b/frontend/discourse/app/controllers/application.js
index 64c012bef23..dc2a864fc93 100644
--- a/frontend/discourse/app/controllers/application.js
+++ b/frontend/discourse/app/controllers/application.js
@@ -23,6 +23,8 @@ export default class ApplicationController extends Controller {
showTop = true;
sidebarDisabledRouteOverride = false;
+
+ /** @type {string | null} */
navigationMenuQueryParamOverride = null;
_showSiteHeader = true;
@tracked _showSidebar;
diff --git a/frontend/discourse/app/controllers/badges/show.js b/frontend/discourse/app/controllers/badges/show.js
index f9783b64cc8..c5681900878 100644
--- a/frontend/discourse/app/controllers/badges/show.js
+++ b/frontend/discourse/app/controllers/badges/show.js
@@ -9,12 +9,16 @@ import { i18n } from "discourse-i18n";
export default class ShowController extends Controller {
@tracked model;
+
+ /** @type {string | null} */
@tracked username = null;
@tracked loadingMore = false;
@tracked noMoreBadges = false;
@tracked showTitlePicker = false;
@tracked userBadgesAll;
@tracked userBadgesGrantCount;
+
+ /** @type {import("discourse/models/user-badge").default[] | null} */
@autoTrackedArray userBadges = null;
queryParams = ["username"];
diff --git a/frontend/discourse/app/controllers/discovery/list.js b/frontend/discourse/app/controllers/discovery/list.js
index 527445bae5b..c0b54ec3d5b 100644
--- a/frontend/discourse/app/controllers/discovery/list.js
+++ b/frontend/discourse/app/controllers/discovery/list.js
@@ -57,6 +57,8 @@ export default class DiscoveryListController extends Controller {
@tracked model;
@tracked showTagInfo = false;
+
+ /** @type {import("discourse/models/tag-info").default | null} */
@tracked tagInfo = null;
@tracked loadingTagInfo = false;
queryParams = Object.keys(queryParams);
diff --git a/frontend/discourse/app/controllers/full-page-search.js b/frontend/discourse/app/controllers/full-page-search.js
index e1eb7f6598e..59cbd65bab0 100644
--- a/frontend/discourse/app/controllers/full-page-search.js
+++ b/frontend/discourse/app/controllers/full-page-search.js
@@ -85,6 +85,7 @@ export default class FullPageSearchController extends Controller {
@tracked searching = false;
@tracked loading = false;
+ /** @type {boolean | null} */
bulkSelectEnabled = null;
queryParams = [
@@ -97,15 +98,25 @@ export default class FullPageSearchController extends Controller {
];
q;
+
+ /** @type {string | number | null} */
context_id = null;
search_type = SEARCH_TYPE_DEFAULT;
+
+ /** @type {string | null} */
context = null;
sortOrder = 0;
+
+ /** @type {{ name: string, id: number, term?: string, alias?: string }[] | null} */
sortOrders = null;
invalidSearch = false;
page = 1;
+
+ /** @type {number | null} */
resultCount = null;
additionalSearchResults = [];
+
+ /** @type {string | null | undefined} */
error = null;
_searchOnSortChange = true;
diff --git a/frontend/discourse/app/controllers/group.js b/frontend/discourse/app/controllers/group.js
index 3d8f01fe1b4..a0dc262b911 100644
--- a/frontend/discourse/app/controllers/group.js
+++ b/frontend/discourse/app/controllers/group.js
@@ -24,6 +24,8 @@ export default class GroupController extends Controller {
counts = null;
showing = "members";
+
+ /** @type {boolean | null} */
destroying = null;
showTooltip = false;
diff --git a/frontend/discourse/app/controllers/group/index.js b/frontend/discourse/app/controllers/group/index.js
index 37b505241b8..e0795fbcb43 100644
--- a/frontend/discourse/app/controllers/group/index.js
+++ b/frontend/discourse/app/controllers/group/index.js
@@ -15,12 +15,19 @@ export default class GroupIndexController extends Controller {
@service currentUser;
@service dialog;
+ /** @type {import("discourse/models/user").default[] | null} */
@autoTrackedArray bulkSelection = null;
queryParams = ["order", "asc", "filter"];
+
+ /** @type {string | null} */
order = null;
asc = true;
+
+ /** @type {string | null} */
filter = null;
+
+ /** @type {string | null} */
filterInput = null;
loading = false;
isBulk = false;
diff --git a/frontend/discourse/app/controllers/group/manage/categories.js b/frontend/discourse/app/controllers/group/manage/categories.js
index 007804cbeb6..adfdcc50fb4 100644
--- a/frontend/discourse/app/controllers/group/manage/categories.js
+++ b/frontend/discourse/app/controllers/group/manage/categories.js
@@ -2,6 +2,7 @@ import Controller from "@ember/controller";
import { computed } from "@ember/object";
export default class GroupManageCategoriesController extends Controller {
+ /** @returns {import("discourse/models/category").default[]} */
@computed(
"model.watchingCategories.[]",
"model.watchingFirstPostCategories.[]",
diff --git a/frontend/discourse/app/controllers/group/manage/profile.js b/frontend/discourse/app/controllers/group/manage/profile.js
index 89cc038b35c..1492ac079b8 100644
--- a/frontend/discourse/app/controllers/group/manage/profile.js
+++ b/frontend/discourse/app/controllers/group/manage/profile.js
@@ -1,5 +1,6 @@
import Controller from "@ember/controller";
export default class GroupManageProfileController extends Controller {
+ /** @type {boolean | null} */
saving = null;
}
diff --git a/frontend/discourse/app/controllers/group/manage/tags.js b/frontend/discourse/app/controllers/group/manage/tags.js
index b0c453930df..8d229d618d9 100644
--- a/frontend/discourse/app/controllers/group/manage/tags.js
+++ b/frontend/discourse/app/controllers/group/manage/tags.js
@@ -2,6 +2,7 @@ import Controller from "@ember/controller";
import { computed } from "@ember/object";
export default class GroupManageTagsController extends Controller {
+ /** @returns {Array<{ id: number, name: string, slug?: string }>} */
@computed(
"model.watching_tags.[]",
"model.watching_first_post_tags.[]",
diff --git a/frontend/discourse/app/controllers/group/requests.js b/frontend/discourse/app/controllers/group/requests.js
index cdc9e1391d6..82d308701cc 100644
--- a/frontend/discourse/app/controllers/group/requests.js
+++ b/frontend/discourse/app/controllers/group/requests.js
@@ -11,8 +11,14 @@ export default class GroupRequestsController extends Controller {
queryParams = ["order", "asc", "filter"];
order = "";
+
+ /** @type {boolean | string | null} */
asc = null;
+
+ /** @type {string | null} */
filter = null;
+
+ /** @type {string | null} */
filterInput = null;
loading = false;
diff --git a/frontend/discourse/app/controllers/groups/index.js b/frontend/discourse/app/controllers/groups/index.js
index 750006944ab..02af717f71f 100644
--- a/frontend/discourse/app/controllers/groups/index.js
+++ b/frontend/discourse/app/controllers/groups/index.js
@@ -5,10 +5,18 @@ import { INPUT_DELAY } from "discourse/lib/environment";
export default class GroupsIndexController extends Controller {
queryParams = ["order", "asc", "filter", "type"];
+
+ /** @type {string | null} */
order = null;
+
+ /** @type {boolean | string | null} */
asc = null;
filter = "";
+
+ /** @type {string | null} */
type = null;
+
+ /** @type {import("discourse/models/result-set").default | null} */
groups = null;
@action
diff --git a/frontend/discourse/app/controllers/groups/new.js b/frontend/discourse/app/controllers/groups/new.js
index fb7364b3fd2..54cd8aa3b29 100644
--- a/frontend/discourse/app/controllers/groups/new.js
+++ b/frontend/discourse/app/controllers/groups/new.js
@@ -8,6 +8,7 @@ export default class GroupsNewController extends Controller {
@service site;
@service groupAutomaticMembersDialog;
+ /** @type {boolean | null} */
saving = null;
@computed("model.ownerUsernames")
diff --git a/frontend/discourse/app/controllers/invites/show.js b/frontend/discourse/app/controllers/invites/show.js
index 11f538cf692..2250b3a6831 100644
--- a/frontend/discourse/app/controllers/invites/show.js
+++ b/frontend/discourse/app/controllers/invites/show.js
@@ -45,8 +45,14 @@ export default class InvitesShowController extends Controller {
this.site.get("user_fields")?.filter((f) => f.show_on_signup),
getAccountPassword: () => this.accountPassword,
});
+
+ /** @type {string | null} */
successMessage = null;
+
+ /** @type {string | null} */
errorMessage = null;
+
+ /** @type {import("@ember/object").default & { username?: string | null, name?: string | null, email?: string | null, email_valid?: boolean, auth_provider?: string, associate_url?: string, can_edit_username?: boolean, can_edit_name?: boolean } | null} */
authOptions = null;
maskPassword = true;
diff --git a/frontend/discourse/app/controllers/login.js b/frontend/discourse/app/controllers/login.js
index cb2f3a06e09..865e5b3bb3d 100644
--- a/frontend/discourse/app/controllers/login.js
+++ b/frontend/discourse/app/controllers/login.js
@@ -51,6 +51,8 @@ export default class LoginPageController extends Controller {
@tracked secondFactorToken;
@tracked flash;
@tracked flashType;
+
+ /** @type {string | null} */
@tracked loginMode = null;
queryParams = [{ loginMode: "mode" }];
diff --git a/frontend/discourse/app/controllers/nested.js b/frontend/discourse/app/controllers/nested.js
index fc5aac6510a..320e60fdd7b 100644
--- a/frontend/discourse/app/controllers/nested.js
+++ b/frontend/discourse/app/controllers/nested.js
@@ -23,6 +23,12 @@ import processNode, {
registerPostInTopicPostStream,
} from "../lib/process-node.js";
+/**
+ * @typedef {Object} NestedContextNode
+ * @property {import("discourse/models/post").default} post
+ * @property {NestedContextNode[]} children
+ * @property {number | string} _renderKey
+ */
export default class NestedController extends Controller {
@service appEvents;
@service composer;
@@ -46,13 +52,21 @@ export default class NestedController extends Controller {
@tracked effectiveSort;
@tracked messageBusLastId;
@tracked postNumber;
+
+ /** @type {string | number | null} */
@tracked context = null;
@tracked contextMode = false;
+
+ /** @type {NestedContextNode | null} */
@tracked contextChain = null;
@tracked initialFocusedPath = [];
+
+ /** @type {number | null} */
@tracked targetPostNumber = null;
@tracked contextNoAncestors = false;
@tracked ancestorsTruncated = false;
+
+ /** @type {number | null} */
@tracked topAncestorPostNumber = null;
@tracked newRootPostIds = [];
@tracked editingTopic = false;
@@ -74,6 +88,7 @@ export default class NestedController extends Controller {
fetchedChildrenCache = new Map();
// Scroll anchor for cache restoration: { postNumber, offsetFromTop, scrollY? }
+ /** @type {{ postNumber: number, offsetFromTop: number, scrollY?: number } | null} */
scrollAnchor = null;
quoteState = new QuoteState();
diff --git a/frontend/discourse/app/controllers/password-reset.js b/frontend/discourse/app/controllers/password-reset.js
index e23c05101fa..62806e42c1c 100644
--- a/frontend/discourse/app/controllers/password-reset.js
+++ b/frontend/discourse/app/controllers/password-reset.js
@@ -14,7 +14,11 @@ export default class PasswordResetController extends Controller {
@tracked accountPassword;
passwordRequired = true;
+
+ /** @type {string | null} */
errorMessage = null;
+
+ /** @type {string | null} */
successMessage = null;
requiresApproval = false;
redirected = false;
diff --git a/frontend/discourse/app/controllers/preferences/account.js b/frontend/discourse/app/controllers/preferences/account.js
index 18808810300..f05f8b48dba 100644
--- a/frontend/discourse/app/controllers/preferences/account.js
+++ b/frontend/discourse/app/controllers/preferences/account.js
@@ -20,10 +20,20 @@ export default class AccountController extends Controller {
@controller user;
canSaveUser = true;
+
+ /** @type {string | null | undefined} */
newNameInput = null;
+
+ /** @type {string | null | undefined} */
newTitleInput = null;
+
+ /** @type {number | null | undefined} */
newPrimaryGroupInput = null;
+
+ /** @type {{ description: string, emoji: string, ends_at?: string | null, message_bus_last_id?: number } | null | undefined} */
newStatus = null;
+
+ /** @type {Record<string, boolean> | null} */
revoking = null;
init() {
diff --git a/frontend/discourse/app/controllers/preferences/email.js b/frontend/discourse/app/controllers/preferences/email.js
index 98bdc6442d7..f1c1f6edcf4 100644
--- a/frontend/discourse/app/controllers/preferences/email.js
+++ b/frontend/discourse/app/controllers/preferences/email.js
@@ -11,8 +11,14 @@ export default class EmailController extends Controller {
saving = false;
error = false;
success = false;
+
+ /** @type {string | null | undefined} */
oldEmail = null;
+
+ /** @type {string | null | undefined} */
newEmail = null;
+
+ /** @type {string | null} */
successMessage = null;
@computed("newEmail")
diff --git a/frontend/discourse/app/controllers/preferences/interface.js b/frontend/discourse/app/controllers/preferences/interface.js
index fd354b443b1..6f3536293a2 100644
--- a/frontend/discourse/app/controllers/preferences/interface.js
+++ b/frontend/discourse/app/controllers/preferences/interface.js
@@ -51,9 +51,12 @@ export default class InterfaceController extends Controller {
@service session;
@controller("preferences") preferencesController;
+ /** @type {number | null} */
@tracked selectedInterfaceColorModeId = null;
currentThemeId = currentThemeId();
previewingColorScheme = false;
+
+ /** @type {number | null | undefined} */
selectedDarkColorSchemeId = null;
makeColorSchemeDefault = true;
subpageTitle = i18n("user.preferences_nav.interface");
diff --git a/frontend/discourse/app/controllers/preferences/second-factor.js b/frontend/discourse/app/controllers/preferences/second-factor.js
index 553bcf80d15..6ffd5d91aac 100644
--- a/frontend/discourse/app/controllers/preferences/second-factor.js
+++ b/frontend/discourse/app/controllers/preferences/second-factor.js
@@ -22,7 +22,11 @@ export default class SecondFactorController extends Controller {
loading = false;
dirty = false;
+
+ /** @type {string | null} */
errorMessage = null;
+
+ /** @type {string | null} */
newUsername = null;
secondFactorMethod = SECOND_FACTOR_METHODS.TOTP;
diff --git a/frontend/discourse/app/controllers/preferences/security.js b/frontend/discourse/app/controllers/preferences/security.js
index 2feca158eb5..e1920fd0928 100644
--- a/frontend/discourse/app/controllers/preferences/security.js
+++ b/frontend/discourse/app/controllers/preferences/security.js
@@ -21,6 +21,7 @@ export default class SecurityController extends Controller {
@service router;
@service currentUser;
+ /** @type {string | null} */
passwordProgress = null;
subpageTitle = i18n("user.preferences_nav.security");
showAllAuthTokens = false;
diff --git a/frontend/discourse/app/controllers/preferences/tags.js b/frontend/discourse/app/controllers/preferences/tags.js
index 60e4f2a45d7..1c3e881e52b 100644
--- a/frontend/discourse/app/controllers/preferences/tags.js
+++ b/frontend/discourse/app/controllers/preferences/tags.js
@@ -17,6 +17,7 @@ export default class TagsController extends Controller {
);
}
+ /** @returns {Array<{ id: number, name: string, slug?: string }>} */
@computed(
"model.watched_tags.[]",
"model.watching_first_post_tags.[]",
diff --git a/frontend/discourse/app/controllers/preferences/tracking.js b/frontend/discourse/app/controllers/preferences/tracking.js
index 0522982cdd4..1f8531d41e5 100644
--- a/frontend/discourse/app/controllers/preferences/tracking.js
+++ b/frontend/discourse/app/controllers/preferences/tracking.js
@@ -90,6 +90,7 @@ export default class extends Controller {
return this.currentUser.id === this.model.id;
}
+ /** @returns {Array<{ id: number, name: string, slug?: string }>} */
@computed(
"model.watched_tags.[]",
"model.watching_first_post_tags.[]",
@@ -123,6 +124,7 @@ export default class extends Controller {
return show;
}
+ /** @returns {import("discourse/models/category").default[]} */
@computed(
"model.watchedCategories",
"model.watchedFirstPostCategories",
diff --git a/frontend/discourse/app/controllers/review/index.js b/frontend/discourse/app/controllers/review/index.js
index f5716511ca7..bde2fd548c2 100644
--- a/frontend/discourse/app/controllers/review/index.js
+++ b/frontend/discourse/app/controllers/review/index.js
@@ -32,21 +32,38 @@ export default class ReviewIndexController extends Controller {
"score_type",
];
+ /** @type {string | null | undefined} */
type = null;
status = "pending";
priority = this.siteSettings.reviewable_default_visibility;
+
+ /** @type {number | string | null} */
category_id = null;
+
+ /** @type {import("discourse/models/result-set").default | null} */
reviewables = null;
+
+ /** @type {number | string | null} */
topic_id = null;
filtersExpanded = false;
username = "";
reviewed_by = "";
claimed_by = "";
flagged_by = "";
+
+ /** @type {string | null} */
from_date = null;
+
+ /** @type {string | null} */
to_date = null;
+
+ /** @type {string | null} */
sort_order = null;
+
+ /** @type {string | null} */
additional_filters = null;
+
+ /** @type {number | string | null} */
filterScoreType = null;
unknownTypeSource = REVIEWABLE_UNKNOWN_TYPE_SOURCE;
diff --git a/frontend/discourse/app/controllers/second-factor-auth.js b/frontend/discourse/app/controllers/second-factor-auth.js
index 3dd2fa8cdbf..46824a8d9ee 100644
--- a/frontend/discourse/app/controllers/second-factor-auth.js
+++ b/frontend/discourse/app/controllers/second-factor-auth.js
@@ -15,10 +15,16 @@ export default class SecondFactorAuthController extends Controller {
SECURITY_KEY = SECURITY_KEY;
PASSKEY = PASSKEY;
queryParams = ["nonce"];
+
+ /** @type {string | null} */
message = null;
loadError = false;
messageIsError = false;
+
+ /** @type {string | null} */
secondFactorToken = null;
+
+ /** @type {number | null} */
userSelectedMethod = null;
isLoading = false;
diff --git a/frontend/discourse/app/controllers/signup.js b/frontend/discourse/app/controllers/signup.js
index a9d33772e10..4ceb39e0a44 100644
--- a/frontend/discourse/app/controllers/signup.js
+++ b/frontend/discourse/app/controllers/signup.js
@@ -45,6 +45,8 @@ export default class SignupPageController extends Controller {
accountChallenge = 0;
accountHoneypot = 0;
formSubmitted = false;
+
+ /** @type {string | null} */
prefilledUsername = null;
maskPassword = true;
emailValidationVisible = false;
diff --git a/frontend/discourse/app/controllers/tag/edit/tab.js b/frontend/discourse/app/controllers/tag/edit/tab.js
index 51b9b15f2fc..404df60579d 100644
--- a/frontend/discourse/app/controllers/tag/edit/tab.js
+++ b/frontend/discourse/app/controllers/tag/edit/tab.js
@@ -4,6 +4,7 @@ import Controller, { inject as controller } from "@ember/controller";
export default class TagEditTabController extends Controller {
@controller("tag.edit") parentController;
+ /** @type {{ tag_slug: string, tag_id: string } | null} */
@tracked parentParams = null;
get selectedTab() {
diff --git a/frontend/discourse/app/controllers/tags/index.js b/frontend/discourse/app/controllers/tags/index.js
index d1fec3104b2..580d2f49502 100644
--- a/frontend/discourse/app/controllers/tags/index.js
+++ b/frontend/discourse/app/controllers/tags/index.js
@@ -11,6 +11,8 @@ export default class TagsIndexController extends Controller {
@tracked bulkTagInput = "";
@tracked isCreatingTags = false;
+
+ /** @type {{ created: string[], existing: string[], failed: Record<string, string> } | null} */
@tracked bulkCreateResults = null;
sortedByCount = true;
diff --git a/frontend/discourse/app/controllers/topic.js b/frontend/discourse/app/controllers/topic.js
index 75fbdf3391b..0ffbc7b751e 100644
--- a/frontend/discourse/app/controllers/topic.js
+++ b/frontend/discourse/app/controllers/topic.js
@@ -112,8 +112,14 @@ export default class TopicController extends Controller {
@tracked model;
@tracked multiSelect = false;
+
+ /** @type {boolean | null} */
@tracked hasScrolled = null;
+
+ /** @type {string | null} */
@tracked translationLocale = null;
+
+ /** @type {string | null} */
@tracked translationTitle = null;
@tracked editingTopicLocalization = false;
@autoTrackedArray bookmarks = [];
@@ -122,22 +128,48 @@ export default class TopicController extends Controller {
queryParams = TOPIC_QUERY_PARAMS;
editingTopic = false;
+
+ /** @type {string | null} */
enteredAt = null;
+
+ /** @type {number | null | undefined} */
enteredIndex = null;
retrying = false;
userTriggeredProgress = null;
+
+ /** @type {string | null} */
username_filters = null;
+
+ /** @type {number | string | null} */
replies_to_post_number = null;
+
+ /** @type {string | null} */
filter = null;
+
+ /** @type {string | null} */
sort = null;
+
+ /** @type {string | number | null} */
context = null;
collapseReplies = false;
quoteState = new QuoteState();
+
+ /** @type {number | null} */
currentPostId = null;
+
+ /** @type {number | null | undefined} */
userLastReadPostNumber = null;
+
+ /** @type {number | null} */
highestPostNumber = null;
+
+ /** @type {Promise<{ id: number, topic_id: number, locale: string, title: string, fancy_title: string }> | null} */
_localizationFetchPromise = null;
+
+ /** @type {string | null} */
_originalTranslationTitle = null;
+
+ /** @type {number | null} */
_progressIndex = null;
_retryInProgress = false;
_retryRateLimited = false;
diff --git a/frontend/discourse/app/controllers/user-activity.js b/frontend/discourse/app/controllers/user-activity.js
index b2dc9365d5f..7947d4933ca 100644
--- a/frontend/discourse/app/controllers/user-activity.js
+++ b/frontend/discourse/app/controllers/user-activity.js
@@ -8,6 +8,7 @@ export default class UserActivityController extends Controller {
@service currentUser;
@controller user;
+ /** @type {number | null | undefined} */
@tracked userActionType = null;
@computed("currentUser.draft_count")
diff --git a/frontend/discourse/app/controllers/user-activity/bookmarks.js b/frontend/discourse/app/controllers/user-activity/bookmarks.js
index c0527294059..bb59445e5f2 100644
--- a/frontend/discourse/app/controllers/user-activity/bookmarks.js
+++ b/frontend/discourse/app/controllers/user-activity/bookmarks.js
@@ -18,6 +18,7 @@ export default class UserActivityBookmarksController extends Controller {
queryParams = ["q"];
+ /** @type {string | null | undefined} */
q = null;
loading = false;
loadingMore = false;
diff --git a/frontend/discourse/app/controllers/user-api-key-activate.js b/frontend/discourse/app/controllers/user-api-key-activate.js
index 095b6d5747b..c780394c53d 100644
--- a/frontend/discourse/app/controllers/user-api-key-activate.js
+++ b/frontend/discourse/app/controllers/user-api-key-activate.js
@@ -9,12 +9,32 @@ import { i18n } from "discourse-i18n";
const CODE_FIELD = "code";
+/**
+ * @typedef {Object} ActivationCodeFormApi
+ * @property {(name: string, value: unknown) => Promise<void>} set
+ * @property {(values: Record<string, unknown>) => Promise<void>} setProperties
+ * @property {(name: string) => unknown} get
+ * @property {() => void} commit
+ * @property {(name: string) => void} commitField
+ * @property {(event?: Event) => Promise<void>} submit
+ * @property {(event?: Event) => Promise<void>} reset
+ * @property {(name: string, error: { title?: string, message?: string }) => void} addError
+ * @property {(name: string) => void} removeError
+ * @property {() => void} removeErrors
+ * @property {boolean} isDirty
+ */
export default class UserApiKeyActivateController extends Controller {
@tracked page;
+
+ /** @type {string | null} */
@tracked error = null;
@tracked isLoading = false;
queryParams = ["request"];
+
+ /** @type {string | null} */
request = null;
+
+ /** @type {ActivationCodeFormApi | null} */
codeFormApi = null;
codeFormData = { [CODE_FIELD]: "" };
approvalFormData = {};
diff --git a/frontend/discourse/app/controllers/user-invited/show.js b/frontend/discourse/app/controllers/user-invited/show.js
index c03bc4c7301..191c768ad33 100644
--- a/frontend/discourse/app/controllers/user-invited/show.js
+++ b/frontend/discourse/app/controllers/user-invited/show.js
@@ -24,10 +24,17 @@ export default class UserInvitedShowController extends Controller {
@tracked canLoadMore = true;
@tracked hasLoadedInitialInvites = false;
@tracked invitesLoading = false;
+
+ /** @type {string | null} */
@tracked filter = null;
+ /** @type {import("discourse/models/user").default | null} */
user = null;
+
+ /** @type {import("@ember/object").default & { invites: import("discourse/models/invite").default[], can_see_invite_details: boolean, counts?: { pending: number, redeemed: number, expired: number, total: number }, error?: string } | null | undefined} */
model = null;
+
+ /** @type {{ pending: number, redeemed: number, expired: number, total: number } | null | undefined} */
invitesCount = null;
reinvitedAll = false;
diff --git a/frontend/discourse/app/controllers/user-private-messages/tags.js b/frontend/discourse/app/controllers/user-private-messages/tags.js
index c5ff2eacb3c..1c6a20f1fab 100644
--- a/frontend/discourse/app/controllers/user-private-messages/tags.js
+++ b/frontend/discourse/app/controllers/user-private-messages/tags.js
@@ -2,5 +2,6 @@ import { tracked } from "@glimmer/tracking";
import Controller from "@ember/controller";
export default class extends Controller {
+ /** @type {string | null} */
@tracked tagName = null;
}
diff --git a/frontend/discourse/app/controllers/user-private-messages/tags/index.js b/frontend/discourse/app/controllers/user-private-messages/tags/index.js
index 4eaa2d14f67..f4d7c294f78 100644
--- a/frontend/discourse/app/controllers/user-private-messages/tags/index.js
+++ b/frontend/discourse/app/controllers/user-private-messages/tags/index.js
@@ -3,6 +3,7 @@ import Controller from "@ember/controller";
import { action } from "@ember/object";
export default class extends Controller {
+ /** @type {string | null} */
@tracked tagsForUser = null;
@tracked sortedByCount = true;
@tracked sortedByName = false;
diff --git a/frontend/discourse/app/controllers/user-topics-list.js b/frontend/discourse/app/controllers/user-topics-list.js
index 1fdb4f51775..ecba83dffde 100644
--- a/frontend/discourse/app/controllers/user-topics-list.js
+++ b/frontend/discourse/app/controllers/user-topics-list.js
@@ -24,6 +24,8 @@ export default class UserTopicsListController extends Controller {
hideCategory = false;
showPosters = false;
channel = null;
+
+ /** @type {string | null} */
tagsForUser = null;
queryParams = Object.keys(QUERY_PARAMS);
diff --git a/frontend/discourse/app/controllers/users.js b/frontend/discourse/app/controllers/users.js
index a489d0238f5..586a9f0797d 100644
--- a/frontend/discourse/app/controllers/users.js
+++ b/frontend/discourse/app/controllers/users.js
@@ -9,6 +9,18 @@ import discourseDebounce from "discourse/lib/debounce";
import { longDate } from "discourse/lib/formatter";
import Group from "discourse/models/group";
+/**
+ * @typedef {Object} DirectoryParams
+ * @property {string} [period]
+ * @property {string} [order]
+ * @property {boolean | string | null} [asc]
+ * @property {string} [name]
+ * @property {string | null} [group]
+ * @property {string | null} [exclude_usernames]
+ * @property {string | null} [exclude_groups]
+ * @property {string} [user_field_ids]
+ * @property {string} [plugin_column_ids]
+ */
export default class UsersController extends Controller {
@service modal;
@service siteSettings;
@@ -26,15 +38,31 @@ export default class UsersController extends Controller {
];
order = "";
+
+ /** @type {boolean | string | null} */
asc = null;
name = "";
+
+ /** @type {string | null | undefined} */
group = null;
+
+ /** @type {string | null | undefined} */
nameInput = null;
+
+ /** @type {string | null} */
exclude_usernames = null;
+
+ /** @type {string | null} */
exclude_groups = null;
isLoading = false;
+
+ /** @type {{ id: number, name: string, type: string, position: number, icon: string | null, user_field_id: number | null }[] | null} */
columns = null;
+
+ /** @type {{ name: string, id: string }[] | null} */
groupOptions = null;
+
+ /** @type {DirectoryParams | null} */
params = null;
@computed("currentUser", "groupOptions")
diff --git a/frontend/discourse/app/routes/build-private-messages-group-route.js b/frontend/discourse/app/routes/build-private-messages-group-route.js
index 3cd73abe4b2..8c637aa45c0 100644
--- a/frontend/discourse/app/routes/build-private-messages-group-route.js
+++ b/frontend/discourse/app/routes/build-private-messages-group-route.js
@@ -10,6 +10,7 @@ export default (inboxType, filter) => {
"private-messages-groups",
filter
) {
+ /** @type {string | null | undefined} */
groupName = null;
titleToken() {
diff --git a/frontend/discourse/app/routes/topic.js b/frontend/discourse/app/routes/topic.js
index 667c3c3c645..a0340452ee0 100644
--- a/frontend/discourse/app/routes/topic.js
+++ b/frontend/discourse/app/routes/topic.js
@@ -35,7 +35,10 @@ export default class TopicRoute extends DiscourseRoute {
@service modal;
@service router;
+ /** @type {ReturnType<typeof import("discourse/lib/later").default> | null} */
scheduledReplace = null;
+
+ /** @type {number | null} */
lastScrollPos = null;
isTransitioning = false;
queryParams = {
diff --git a/frontend/discourse/app/routes/user-activity/bookmarks.js b/frontend/discourse/app/routes/user-activity/bookmarks.js
index f4dbb48285b..45c76f0dff2 100644
--- a/frontend/discourse/app/routes/user-activity/bookmarks.js
+++ b/frontend/discourse/app/routes/user-activity/bookmarks.js
@@ -38,7 +38,10 @@ export default class UserActivityBookmarks extends DiscourseRoute {
return this._loadBookmarks(params)
.then(async (response) => {
if (!response.user_bookmark_list) {
- return { bookmarks: [] };
+ return {
+ bookmarks:
+ /** @type {import("discourse/models/bookmark").default[]} */ ([]),
+ };
}
response.user_bookmark_list.categories?.forEach((category) =>