A platform for community discussion. Free, open, simple.
DEV: Convert the user activity models to TypeScript (#45176)
Sérgio Saquetime2b20e6eb4cb
diff --git a/docs/developer-guides/package.json b/docs/developer-guides/package.jsonindex 67b7d9e5859..8d3b4e346bb 100644--- a/docs/developer-guides/package.json+++ b/docs/developer-guides/package.json@@ -6,7 +6,7 @@"lint:fix": "prettier --write '**/*.{md,json,mjs,yml}'"},"devDependencies": {- "@discourse/lint-configs": "^3.9.0",+ "@discourse/lint-configs": "^3.9.1","prettier": "3.8.1"}}diff --git a/frontend/discourse/app/models/associated-group.js b/frontend/discourse/app/models/associated-group.jsdeleted file mode 100644index b5de9175d1e..00000000000--- a/frontend/discourse/app/models/associated-group.js+++ /dev/null@@ -1,13 +0,0 @@-import EmberObject from "@ember/object";-import { ajax } from "discourse/lib/ajax";-import { popupAjaxError } from "discourse/lib/ajax-error";--export default class AssociatedGroup extends EmberObject {- static list() {- return ajax("/associated_groups")- .then((result) => {- return result.associated_groups.map((ag) => AssociatedGroup.create(ag));- })- .catch(popupAjaxError);- }-}diff --git a/frontend/discourse/app/models/associated-group.ts b/frontend/discourse/app/models/associated-group.tsnew file mode 100644index 00000000000..61afa40fbcc--- /dev/null+++ b/frontend/discourse/app/models/associated-group.ts@@ -0,0 +1,29 @@+import EmberObject from "@ember/object";+import { ajax } from "discourse/lib/ajax";+import { popupAjaxError } from "discourse/lib/ajax-error";++export interface AssociatedGroupFields {+ id: number;+ name: string;+ provider_name: string;+ label: string;+}++// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-unsafe-declaration-merging+export default interface AssociatedGroup extends AssociatedGroupFields {}++// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging+export default class AssociatedGroup extends EmberObject {+ static list(): Promise<AssociatedGroup[] | undefined> {+ return (+ ajax("/associated_groups")+ .then((result: { associated_groups: AssociatedGroupFields[] }) => {+ return result.associated_groups.map((ag) =>+ AssociatedGroup.create(ag)+ );+ })+ // TODO(typescript-pending): popupAjaxError infers void; remove the cast when it declares its undefined return.+ .catch(popupAjaxError) as Promise<AssociatedGroup[] | undefined>+ );+ }+}diff --git a/frontend/discourse/app/models/draft.js b/frontend/discourse/app/models/draft.tssimilarity index 52%rename from frontend/discourse/app/models/draft.jsrename to frontend/discourse/app/models/draft.tsindex b48017aac91..991ac5548a2 100644--- a/frontend/discourse/app/models/draft.js+++ b/frontend/discourse/app/models/draft.ts@@ -1,18 +1,32 @@import EmberObject from "@ember/object";import { ajax } from "discourse/lib/ajax";import getURL from "discourse/lib/get-url";+import type { TopicBasicUser } from "discourse/models/topic";++export interface DraftGetResponse {+ draft: string | null;+ draft_sequence: number;+}++export interface DraftSaveResponse {+ success: "OK";+ draft_sequence: number;+ conflict_user?: TopicBasicUser;+}export default class Draft extends EmberObject {- static clear(key, sequence) {+ static clear(key: string, sequence: number): Promise<{ success: "OK" }> {return ajax(`/drafts/${key}.json`, {type: "DELETE",data: { draft_key: key, sequence },});}- static bulkClear(drafts) {+ static bulkClear(+ drafts: { draft_key: string; sequence: number }[]+ ): Promise<{ success: "OK"; deleted_count: number }> {const draft_keys = drafts.map((d) => d.draft_key);- const sequences = {};+ const sequences: Record<string, number> = {};drafts.forEach((d) => {sequences[d.draft_key] = d.sequence;});@@ -23,16 +37,22 @@ export default class Draft extends EmberObject {});}- static get(key) {+ static get(key: string): Promise<DraftGetResponse> {return ajax(`/drafts/${key}.json`);}- static getLocal(key, current) {+ static getLocal<T>(key: string, current: T): T {// TODO: implement thisreturn current;}- static save(key, sequence, data, clientId, { forceSave = false } = {}) {+ static save(+ key: string,+ sequence: number,+ data: string | object,+ clientId: string,+ { forceSave = false }: { forceSave?: boolean } = {}+ ): Promise<DraftSaveResponse> {data = typeof data === "string" ? data : JSON.stringify(data);return ajax("/drafts.json", {type: "POST",@@ -47,10 +67,17 @@ export default class Draft extends EmberObject {});}- static saveBeacon(key, sequence, data, clientId, csrfToken) {+ static saveBeacon(+ key: string,+ sequence: number,+ data: string | object,+ clientId: string,+ csrfToken: string+ ): void {const formData = new FormData();formData.append("draft_key", key);- formData.append("sequence", sequence);+ // FormData coerces numeric sequences to strings at the existing browser boundary.+ formData.append("sequence", sequence as unknown as string);formData.append("data", JSON.stringify(data));formData.append("owner", clientId);formData.append("authenticity_token", csrfToken);diff --git a/frontend/discourse/app/models/group-history.js b/frontend/discourse/app/models/group-history.jsdeleted file mode 100644index 154f5d47c49..00000000000--- a/frontend/discourse/app/models/group-history.js+++ /dev/null@@ -1,10 +0,0 @@-import { computed } from "@ember/object";-import RestModel from "discourse/models/rest";-import { i18n } from "discourse-i18n";--export default class GroupHistory extends RestModel {- @computed("action")- get actionTitle() {- return i18n(`group_histories.actions.${this.action}`);- }-}diff --git a/frontend/discourse/app/models/group-history.ts b/frontend/discourse/app/models/group-history.tsnew file mode 100644index 00000000000..efcf453c42c--- /dev/null+++ b/frontend/discourse/app/models/group-history.ts@@ -0,0 +1,25 @@+import { computed } from "@ember/object";+import RestModel from "discourse/models/rest";+import type { TopicBasicUser } from "discourse/models/topic";+import { i18n } from "discourse-i18n";++export interface GroupHistoryFields {+ action: string;+ subject: string | null;+ prev_value: string | null;+ new_value: string | null;+ created_at: string;+ acting_user: TopicBasicUser | null;+ target_user: TopicBasicUser | null;+}++// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-unsafe-declaration-merging+export default interface GroupHistory extends GroupHistoryFields {}++// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging+export default class GroupHistory extends RestModel {+ @computed("action")+ get actionTitle(): string {+ return i18n(`group_histories.actions.${this.action}`);+ }+}diff --git a/frontend/discourse/app/models/user-action-group.js b/frontend/discourse/app/models/user-action-group.jsdeleted file mode 100644index 80db4430042..00000000000--- a/frontend/discourse/app/models/user-action-group.js+++ /dev/null@@ -1,10 +0,0 @@-import EmberObject from "@ember/object";--export default class UserActionGroup extends EmberObject {- push(item) {- if (!this.items) {- this.items = [];- }- return this.items.push(item);- }-}diff --git a/frontend/discourse/app/models/user-action-group.ts b/frontend/discourse/app/models/user-action-group.tsnew file mode 100644index 00000000000..b0032cbd3ad--- /dev/null+++ b/frontend/discourse/app/models/user-action-group.ts@@ -0,0 +1,20 @@+import EmberObject from "@ember/object";+import type UserAction from "discourse/models/user-action";++export interface UserActionGroupFields {+ icon: string;+ items?: UserAction[];+}++// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-unsafe-declaration-merging+export default interface UserActionGroup extends UserActionGroupFields {}++// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-merging+export default class UserActionGroup extends EmberObject {+ push(item: UserAction): number {+ if (!this.items) {+ this.items = [];+ }+ return this.items.push(item);+ }+}diff --git a/frontend/discourse/app/models/user-action-stat.js b/frontend/discourse/app/models/user-action-stat.tssimilarity index 61%rename from frontend/discourse/app/models/user-action-stat.jsrename to frontend/discourse/app/models/user-action-stat.tsindex 0da3797c95e..e3ba3749f03 100644--- a/frontend/discourse/app/models/user-action-stat.js+++ b/frontend/discourse/app/models/user-action-stat.ts@@ -3,9 +3,19 @@ import RestModel from "discourse/models/rest";import UserAction from "discourse/models/user-action";import { i18n } from "discourse-i18n";+/** Counts supplied by the client when grouping user activity. */+export interface UserActionStatFields {+ count: number;+ action_type: number;+}++// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-unsafe-declaration-merging+export default interface UserActionStat extends UserActionStatFields {}++// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-mergingexport default class UserActionStat extends RestModel {@computed("action_type")- get description() {+ get description(): string {return i18n(`user_action_groups.${this.action_type}`);}diff --git a/frontend/discourse/app/models/user-action.js b/frontend/discourse/app/models/user-action.tssimilarity index 64%rename from frontend/discourse/app/models/user-action.jsrename to frontend/discourse/app/models/user-action.tsindex 0edcaf6735e..b54f4ea8275 100644--- a/frontend/discourse/app/models/user-action.js+++ b/frontend/discourse/app/models/user-action.ts@@ -3,10 +3,62 @@ import { service } from "@ember/service";import { emojiUnescape } from "discourse/lib/text";import { userPath } from "discourse/lib/url";import { escapeExpression, postUrl } from "discourse/lib/utilities";-import RestModel from "discourse/models/rest";+import RestModel, { type RestModelAttrs } from "discourse/models/rest";+import type { TopicBasicUser } from "discourse/models/topic";+import type User from "discourse/models/user";import UserActionGroup from "discourse/models/user-action-group";import Category from "./category.ts";+/** Fields shared by the activity and admin post feeds; feed-specific fields are optional. */+export interface UserActionFields {+ action_type: number | null;+ created_at: string;+ avatar_template: string;+ topic_id: number;+ post_id: number | null;+ post_number: number | null;+ title: string | null;+ username: string | null;+ name?: string | null;+ slug?: string | null;+ category_id: number | null;+ deleted: boolean;+ hidden: boolean | null;+ acting_username?: string | null;+ acting_avatar_template?: string;+ acting_name?: string | null;+ acting_user_id?: number;+ target_username?: string | null;+ target_name?: string | null;+ target_user_id?: number;+ user_id?: number;+ post_type?: number | null;+ reply_to_post_number?: number | null;+ excerpt?: string | null;+ truncated?: true;+ deleted_at?: string | null;+ deleted_by?: TopicBasicUser;+ id?: number;+ moderator_action?: boolean;+ action_code?: string | null;+ action_code_who?: string;+ action_code_path?: string;+ edit_reason?: string | null;+ closed?: boolean;+ archived?: boolean;+ description?: string;+ childGroups?: Record<+ "likes" | "stars" | "edits" | "bookmarks",+ UserActionGroup+ >;+}++/** 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-merging+export default interface UserAction extends UserActionFields {}+const UserActionTypes = {likes_given: 1,likes_received: 2,@@ -21,12 +73,15 @@ const UserActionTypes = {messages_received: 13,links: 17,};-const InvertedActionTypes = {};+const InvertedActionTypes: Record<string, number | undefined> = {};Object.keys(UserActionTypes).forEach(- (k) => (InvertedActionTypes[k] = UserActionTypes[k])+ (k) =>+ (InvertedActionTypes[k] =+ UserActionTypes[k as keyof typeof UserActionTypes]));+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-mergingexport default class UserAction extends RestModel {static TYPES = UserActionTypes;@@ -48,9 +103,9 @@ export default class UserAction extends RestModel {UserActionTypes.messages_received,];- static collapseStream(stream) {- const uniq = {};- const collapsed = [];+ static collapseStream(stream: UserAction[]): UserAction[] {+ const uniq: Record<string, number | undefined> = {};+ const collapsed: UserAction[] = [];let pos = 0;stream.forEach((item) => {@@ -58,8 +113,13 @@ export default class UserAction extends RestModel {const found = uniq[key];if (found === void 0) {let current;- if (UserAction.TO_COLLAPSE.includes(item.action_type)) {- current = UserAction.create(item);+ if (+ (UserAction.TO_COLLAPSE as (number | null)[]).includes(+ item.action_type+ )+ ) {+ // TODO(typescript-pending): RestModelAttrs requires an index signature; remove when create accepts model instances.+ current = UserAction.create(item as RestModelAttrs<UserAction>);item.switchToActing();current.addChild(item);} else {@@ -69,7 +129,11 @@ export default class UserAction extends RestModel {collapsed[pos] = current;pos += 1;} else {- if (UserAction.TO_COLLAPSE.includes(item.action_type)) {+ if (+ (UserAction.TO_COLLAPSE as (number | null)[]).includes(+ item.action_type+ )+ ) {item.switchToActing();collapsed[found].addChild(item);} else {@@ -82,10 +146,10 @@ export default class UserAction extends RestModel {return collapsed;}- @service currentUser;+ @service currentUser!: UserActionCurrentUser | null;@computed("name", "username")- get presentName() {+ get presentName(): string | null | undefined {return this.name || this.username;}@@ -194,32 +258,33 @@ export default class UserAction extends RestModel {}@computed("target_username")- get targetUserUrl() {+ get targetUserUrl(): string {return userPath(this.target_username);}+ /** Requires a username; null usernames throw when this getter is accessed. */@computed("username")get usernameLower() {- return this.username.toLowerCase();+ return this.username!.toLowerCase();}@computed("usernameLower")- get userUrl() {+ get userUrl(): string {return userPath(this.usernameLower);}@computed()- get postUrl() {+ get postUrl(): string {return postUrl(this.slug, this.topic_id, this.post_number);}@computed()- get replyUrl() {+ get replyUrl(): string {return postUrl(this.slug, this.topic_id, this.reply_to_post_number);}@computed("title")- get titleHtml() {+ get titleHtml(): string | null {return this.title && emojiUnescape(escapeExpression(this.title));}@@ -236,16 +301,16 @@ export default class UserAction extends RestModel {)get children() {const g = this.childGroups;- let rval = [];+ let rval: UserActionGroup[] = [];if (g) {rval = [g.likes, g.stars, g.edits, g.bookmarks].filter(function (i) {- return i.get("items") && i.get("items").length > 0;+ return i.get("items") && i.get("items")!.length > 0;});}return rval;}- addChild(action) {+ addChild(action: UserAction): void {let groups = this.childGroups;if (!groups) {groups = {@@ -268,15 +333,18 @@ export default class UserAction extends RestModel {return "bookmarks";}})();- const current = groups[bucket];+ // Unsupported action types retain the existing undefined-key lookup.+ const current = groups[bucket as keyof typeof groups];if (current) {current.push(action);}}+ /** Copies the acting identity, including undefined when the row omits it. */switchToActing() {this.setProperties({- username: this.acting_username,+ // Admin post rows omit the acting user; preserve the existing undefined assignment.+ username: this.acting_username as string | null,name: this.actingDisplayName,});}diff --git a/frontend/discourse/app/models/user-posts-stream.js b/frontend/discourse/app/models/user-posts-stream.tssimilarity index 55%rename from frontend/discourse/app/models/user-posts-stream.jsrename to frontend/discourse/app/models/user-posts-stream.tsindex 4d973c78473..ff31439a1bd 100644--- a/frontend/discourse/app/models/user-posts-stream.js+++ b/frontend/discourse/app/models/user-posts-stream.ts@@ -3,25 +3,36 @@ 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 UserAction from "discourse/models/user-action";+import UserAction, {+ type UserActionFields,+} from "discourse/models/user-action";+import type { UserStreamUser } from "discourse/models/user-stream";+export interface UserPostsStreamFields {+ user?: UserStreamUser;+}++// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-unsafe-declaration-merging+export default interface UserPostsStream extends UserPostsStreamFields {}++// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-mergingexport default class UserPostsStream extends EmberObject {@tracked canLoadMore = true;- @tracked filter;+ @tracked filter: "deleted" | "pending" | undefined;@tracked itemsLoaded = 0;- @tracked lastLoadedUrl;+ @tracked lastLoadedUrl: string | null | undefined;@tracked loaded = false;@tracked loading = false;- @autoTrackedArray content = [];+ @autoTrackedArray content: UserAction[] = [];@computed("user.username_lower", "filter", "itemsLoaded")- get url() {+ get url(): string {return getURL(`/posts/${this.user?.username_lower}/${this.filter}?offset=${this.itemsLoaded}`);}- async filterBy(opts) {+ async filterBy(opts: { filter: "deleted" | "pending" }): Promise<void> {if (this.loaded && this.filter === opts.filter) {return;}@@ -36,7 +47,7 @@ export default class UserPostsStream extends EmberObject {return this.findItems();}- async findItems() {+ async findItems(): Promise<void> {if (this.loading || !this.canLoadMore) {return;}@@ -44,7 +55,11 @@ export default class UserPostsStream extends EmberObject {this.loading = true;try {- const result = await ajax(this.url);+ // TODO(typescript-pending): ajax lacks response types; remove the cast when this endpoint can be typed by ajax.+ const result = (await ajax(this.url)) as+ | (UserActionFields & Record<string, unknown>)[]+ | null+ | undefined;if (result) {const posts = result.map((post) => UserAction.create(post));this.content.push(...posts);diff --git a/frontend/discourse/app/models/user-stream.js b/frontend/discourse/app/models/user-stream.tssimilarity index 62%rename from frontend/discourse/app/models/user-stream.jsrename to frontend/discourse/app/models/user-stream.tsindex cec22cd76e9..1a2ce8f6a32 100644--- a/frontend/discourse/app/models/user-stream.js+++ b/frontend/discourse/app/models/user-stream.ts@@ -4,20 +4,43 @@ import { ajax } from "discourse/lib/ajax";import { removeValueFromArray } from "discourse/lib/array-tools";import getURL from "discourse/lib/get-url";import { autoTrackedArray } from "discourse/lib/tracked-tools";+import type { CategoryFields } from "discourse/models/category";import RestModel from "discourse/models/rest";import Site from "discourse/models/site";-import UserAction from "discourse/models/user-action";+import type User from "discourse/models/user";+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;+ filter?: number | null;+}++// eslint-disable-next-line @typescript-eslint/no-empty-object-type, @typescript-eslint/no-unsafe-declaration-merging+export default interface UserStream extends UserStreamFields {}+// eslint-disable-next-line @typescript-eslint/no-unsafe-declaration-mergingexport default class UserStream extends RestModel {- @tracked actingUsername;- @tracked lastLoadedUrl;+ @tracked actingUsername: string | null | undefined;+ @tracked lastLoadedUrl: string | null | undefined;@tracked loaded = false;@tracked loading = false;@tracked itemsLoaded = 0;- @autoTrackedArray content = [];+ @autoTrackedArray content: UserAction[] = [];@computed("itemsLoaded", "user.username_lower")- get baseUrl() {+ get baseUrl(): string {return getURL(`/user_actions.json?offset=${this.itemsLoaded}&username=${this.user?.username_lower}`);@@ -37,7 +60,7 @@ export default class UserStream extends RestModel {}@computed("baseUrl", "filterParam", "actingUsername")- get nextFindUrl() {+ get nextFindUrl(): string {let findUrl = this.baseUrl;if (this.filterParam) {findUrl += `&filter=${this.filterParam}`;@@ -60,7 +83,7 @@ export default class UserStream extends RestModel {return this.nextFindUrl !== this.lastLoadedUrl;}- async filterBy(opts) {+ async filterBy(opts: UserStreamFilter): Promise<void> {this.setProperties({itemsLoaded: 0,content: [],@@ -71,11 +94,13 @@ export default class UserStream extends RestModel {return this.findItems();}- remove(userAction) {+ remove(userAction: UserAction): void {// 1) remove the user action from the child groupsthis.content.forEach((ua) => {["likes", "stars", "edits", "bookmarks"].forEach((group) => {- const items = ua.get(`childGroups.${group}.items`);+ const items = ua.get(`childGroups.${group}.items`) as+ | UserAction[]+ | undefined;if (items) {removeValueFromArray(items, userAction);}@@ -85,14 +110,15 @@ export default class UserStream extends RestModel {// 2) remove the parents that have no childrenconst content = this.content.filter((ua) => {return ["likes", "stars", "edits", "bookmarks"].some((group) => {- return ua.get(`childGroups.${group}.items.length`) > 0;+ // Missing child groups compare as undefined > 0, which excludes them.+ return (ua.get(`childGroups.${group}.items.length`) as number) > 0;});});this.setProperties({ content, itemsLoaded: content.length });}- async findItems() {+ async findItems(): Promise<void> {if (this.loading || !this.canLoadMore) {// Don't load the same stream twice. We're probably at the end.return;@@ -102,9 +128,16 @@ export default class UserStream extends RestModel {this.loading = true;try {- const result = await ajax(findUrl);+ // TODO(typescript-pending): ajax lacks response types; remove the cast when this endpoint can be typed by ajax.+ const result = (await ajax(findUrl)) as+ | {+ user_actions?: (UserActionFields & Record<string, unknown>)[];+ categories?: CategoryFields[];+ }+ | null+ | undefined;if (result && result.user_actions) {- const copy = [];+ const copy: UserAction[] = [];result.categories?.forEach((category) => {Site.current().updateCategory(category);diff --git a/frontend/discourse/app/models/user.js b/frontend/discourse/app/models/user.jsindex 26da50173d8..354ea85ff3e 100644--- a/frontend/discourse/app/models/user.js+++ b/frontend/discourse/app/models/user.js@@ -529,6 +529,7 @@ export default class User extends RestModel.extend(Evented) {return Bookmark.create({ user: this });}+ /** @returns {UserPostsStream} */@computed()get postsStream() {return UserPostsStream.create({ user: this });diff --git a/frontend/discourse/type-tests/models/user-side-test.ts b/frontend/discourse/type-tests/models/user-side-test.tsnew file mode 100644index 00000000000..1bbc6ed9bfe--- /dev/null+++ b/frontend/discourse/type-tests/models/user-side-test.ts@@ -0,0 +1,156 @@+import type EmberObject from "@ember/object";+import { expectTypeOf } from "expect-type";+import AssociatedGroup from "discourse/models/associated-group";+import type Category from "discourse/models/category";+import Draft from "discourse/models/draft";+import type GroupHistory from "discourse/models/group-history";+import type RestModel from "discourse/models/rest";+import type { TopicBasicUser } from "discourse/models/topic";+import UserAction from "discourse/models/user-action";+import type UserActionGroup from "discourse/models/user-action-group";+import UserActionStat from "discourse/models/user-action-stat";+import type UserPostsStream from "discourse/models/user-posts-stream";+import type UserStream from "discourse/models/user-stream";++/* UserAction: `/user_actions.json` rows, or posts from `/posts/:username/deleted`. */++declare const action: UserAction;+expectTypeOf(action).toExtend<RestModel>();+// The deleted-posts feed finds no reply action for most posts.+expectTypeOf(action.action_type).toEqualTypeOf<number | null>();+expectTypeOf(action.created_at).toEqualTypeOf<string>();+expectTypeOf(action.topic_id).toEqualTypeOf<number>();+expectTypeOf(action.post_id).toEqualTypeOf<number | null>();+expectTypeOf(action.post_number).toEqualTypeOf<number | null>();+expectTypeOf(action.avatar_template).toEqualTypeOf<string>();+expectTypeOf(action.title).toEqualTypeOf<string | null>();+// Sent only when names are enabled.+expectTypeOf(action.name).toEqualTypeOf<string | null | undefined>();+// Collapsing a like or edit swaps in the acting user, who can be absent.+expectTypeOf(action.username).toEqualTypeOf<string | null>();+expectTypeOf(action.acting_username).toEqualTypeOf<string | null | undefined>();+expectTypeOf(action.acting_avatar_template).toEqualTypeOf<string | undefined>();+expectTypeOf(action.target_username).toEqualTypeOf<string | null | undefined>();+expectTypeOf(action.category_id).toEqualTypeOf<number | null>();+expectTypeOf(action.deleted).toEqualTypeOf<boolean>();+// Topic actions have no post row, so its columns come back null.+expectTypeOf(action.hidden).toEqualTypeOf<boolean | null>();+expectTypeOf(action.post_type).toEqualTypeOf<number | null | undefined>();+// Sent only for replies.+expectTypeOf(action.reply_to_post_number).toEqualTypeOf<+ number | null | undefined+>();+// Omitted when the viewer can't see the post behind the excerpt.+expectTypeOf(action.excerpt).toEqualTypeOf<string | null | undefined>();+expectTypeOf(action.truncated).toEqualTypeOf<true | undefined>();+// The deleted-posts feed only.+expectTypeOf(action.deleted_at).toEqualTypeOf<string | null | undefined>();+expectTypeOf(action.deleted_by).toEqualTypeOf<TopicBasicUser | undefined>();++expectTypeOf(action.presentName).toEqualTypeOf<string | null | undefined>();+expectTypeOf(action.isPM).toEqualTypeOf<boolean>();+expectTypeOf(action.postReplyType).toEqualTypeOf<boolean>();+expectTypeOf(action.descriptionKey).toEqualTypeOf<string | undefined>();+expectTypeOf(action.postUrl).toEqualTypeOf<string>();+expectTypeOf(action.userUrl).toEqualTypeOf<string>();+expectTypeOf(action.titleHtml).toEqualTypeOf<string | null>();+// Sent only when the topic has a title.+expectTypeOf(action.slug).toEqualTypeOf<string | null | undefined>();+expectTypeOf(action.action_code).toEqualTypeOf<string | null | undefined>();+expectTypeOf(action.edit_reason).toEqualTypeOf<string | null | undefined>();+expectTypeOf(action.category).toEqualTypeOf<Category | undefined>();+expectTypeOf(action.children).toEqualTypeOf<UserActionGroup[]>();+action.addChild(action);+action.switchToActing();++expectTypeOf(UserAction.TYPES.likes_given).toEqualTypeOf<number>();+expectTypeOf(UserAction.TYPES.messages_received).toEqualTypeOf<number>();+expectTypeOf(UserAction.TO_COLLAPSE).toEqualTypeOf<number[]>();+expectTypeOf(UserAction.collapseStream([action])).toEqualTypeOf<UserAction[]>();++declare const group: UserActionGroup;+expectTypeOf(group).toExtend<EmberObject>();+expectTypeOf(group.icon).toEqualTypeOf<string>();+expectTypeOf(group.items).toEqualTypeOf<UserAction[] | undefined>();+expectTypeOf(group.push(action)).toEqualTypeOf<number>();++/* UserActionStat: built client-side to group response counts. */++const stat = UserActionStat.create({ count: 0, action_type: 6 });+expectTypeOf(stat.count).toEqualTypeOf<number>();+expectTypeOf(stat.action_type).toEqualTypeOf<number>();+expectTypeOf(stat.description).toEqualTypeOf<string>();+expectTypeOf(stat.isPM).toEqualTypeOf<boolean>();+expectTypeOf(stat.isResponse).toEqualTypeOf<boolean>();++/* Streams. */++declare const stream: UserStream;+expectTypeOf(stream.content).toEqualTypeOf<UserAction[]>();+expectTypeOf(stream.loaded).toEqualTypeOf<boolean>();+expectTypeOf(stream.loading).toEqualTypeOf<boolean>();+expectTypeOf(stream.itemsLoaded).toEqualTypeOf<number>();+expectTypeOf(stream.nextFindUrl).toEqualTypeOf<string>();+expectTypeOf(stream.canLoadMore).toEqualTypeOf<boolean>();+expectTypeOf(stream.noContent).toEqualTypeOf<boolean>();+expectTypeOf(stream.findItems()).resolves.toEqualTypeOf<void>();+// Activity routes pass a numeric action type or none, and an optional acting user.+expectTypeOf(+ stream.filterBy({ filter: 1, actingUsername: "sam" })+).resolves.toEqualTypeOf<void>();+stream.filterBy({ filter: undefined, actingUsername: undefined });+stream.filterBy({ filter: null, actingUsername: null });+stream.filterBy({});+stream.remove(action);++declare const postsStream: UserPostsStream;+expectTypeOf(postsStream).toExtend<EmberObject>();+expectTypeOf(postsStream.content).toEqualTypeOf<UserAction[]>();+expectTypeOf(postsStream.canLoadMore).toEqualTypeOf<boolean>();+expectTypeOf(postsStream.url).toEqualTypeOf<string>();+expectTypeOf(+ postsStream.filterBy({ filter: "deleted" })+).resolves.toEqualTypeOf<void>();+postsStream.filterBy({ filter: "pending" });++/* GroupHistory: entries from the group logs. */++declare const history: GroupHistory;+expectTypeOf(history.action).toEqualTypeOf<string>();+expectTypeOf(history.subject).toEqualTypeOf<string | null>();+expectTypeOf(history.prev_value).toEqualTypeOf<string | null>();+expectTypeOf(history.new_value).toEqualTypeOf<string | null>();+expectTypeOf(history.created_at).toEqualTypeOf<string>();+expectTypeOf(history.acting_user).toEqualTypeOf<TopicBasicUser | null>();+expectTypeOf(history.target_user).toEqualTypeOf<TopicBasicUser | null>();+expectTypeOf(history.actionTitle).toEqualTypeOf<string>();++/* AssociatedGroup: groups from authentication providers. */++expectTypeOf(AssociatedGroup.list()).resolves.toEqualTypeOf<+ AssociatedGroup[] | undefined+>();+declare const associated: AssociatedGroup;+expectTypeOf(associated.id).toEqualTypeOf<number>();+expectTypeOf(associated.name).toEqualTypeOf<string>();+expectTypeOf(associated.provider_name).toEqualTypeOf<string>();+expectTypeOf(associated.label).toEqualTypeOf<string>();++/* Draft: static helpers over the drafts endpoints. */++// `draft` is the saved JSON string, or null when there is none or it is stale.+expectTypeOf(Draft.get("new_topic")).resolves.toEqualTypeOf<{+ draft: string | null;+ draft_sequence: number;+}>();+expectTypeOf(+ Draft.save("new_topic", 0, { reply: "x" }, "client-1")+).resolves.toExtend<{ success: "OK"; draft_sequence: number }>();+Draft.save("new_topic", 0, "{}", "client-1", { forceSave: true });+Draft.clear("new_topic", 3);+Draft.bulkClear([{ draft_key: "new_topic", sequence: 3 }]);+expectTypeOf(Draft.getLocal("new_topic", "{}")).toEqualTypeOf<string>();+expectTypeOf(Draft.getLocal("new_topic", null)).toEqualTypeOf<null>();+expectTypeOf(+ Draft.saveBeacon("new_topic", 0, { reply: "x" }, "client-1", "token")+).toEqualTypeOf<void>();diff --git a/package.json b/package.jsonindex 244de2c6534..a680efcdd29 100644--- a/package.json+++ b/package.json@@ -4,7 +4,7 @@"author": "Discourse","license": "GPL-2.0-only","devDependencies": {- "@discourse/lint-configs": "^3.9.0",+ "@discourse/lint-configs": "^3.9.1","@discourse/moment-timezone-names-translations": "^1.0.0","@fortawesome/fontawesome-free": "7.3.1","@glint/ember-tsc": "^1.11.6",diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex a1d7470a2ab..6d835525025 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -183,8 +183,8 @@ importers:.:devDependencies:'@discourse/lint-configs':- specifier: ^3.9.0- version: 3.9.0([email protected]([email protected])([email protected]))([email protected])([email protected])([email protected]([email protected])([email protected]))([email protected])+ specifier: ^3.9.1+ version: 3.9.1([email protected]([email protected])([email protected]))([email protected])([email protected])([email protected]([email protected])([email protected]))([email protected])'@discourse/moment-timezone-names-translations':specifier: ^1.0.0version: 1.0.0@@ -246,8 +246,8 @@ importers:docs/developer-guides:devDependencies:'@discourse/lint-configs':- specifier: ^3.9.0- version: 3.9.0([email protected]([email protected])([email protected]))([email protected])([email protected])([email protected]([email protected])([email protected]))([email protected])+ specifier: ^3.9.1+ version: 3.9.1([email protected]([email protected])([email protected]))([email protected])([email protected])([email protected]([email protected])([email protected]))([email protected])prettier:specifier: 3.8.1version: 3.8.1@@ -1988,8 +1988,8 @@ packages:'@discourse/[email protected]':resolution: {integrity: sha512-Veu75DEDC7uKsCCsD94UIjFwvHE73+AATBQbBWb83QyJV34wmyxl2Ji+fiiM234mlNn4cpo3DUl0QFrXgRTcfA==}- '@discourse/[email protected]':- resolution: {integrity: sha512-SC93pPZwXAofUOMR7A/IauuqXkvh5mrJsgwld7aO2tnGkaXkIzMBz/XSQWIZNVEEnGMLwKpMnHKZe8lxE/MP8w==}+ '@discourse/[email protected]':+ resolution: {integrity: sha512-8AKysdyxJnNoSSFKKLk0k6q+cX/M9AUNAad5bTfMGcyaAiVO+fy94Kf9z3nexPUmy4ALWEuaTdEp4aW+Xfsjmw==}peerDependencies:eslint: 10.6.0prettier: 3.8.1@@ -9375,7 +9375,7 @@ snapshots:dependencies:wasm-feature-detect: 1.8.0- '@discourse/[email protected]([email protected]([email protected])([email protected]))([email protected])([email protected])([email protected]([email protected])([email protected]))([email protected])':+ '@discourse/[email protected]([email protected]([email protected])([email protected]))([email protected])([email protected])([email protected]([email protected])([email protected]))([email protected])':dependencies:'@babel/core': 8.0.1'@babel/eslint-parser': 8.0.1(@babel/[email protected])([email protected]([email protected])([email protected]))