Moving the resolvedStatus within the ThreadListFilter type

When adding the `resolvedStatus` to the LocationData API, I noticed that it wasn't relevant
to the ThreadList, as the ThreadList doesn't have pagination and fetches all threads anyway - doing
all filtering within the component. So I created a union type. This is not great 1. because it doesn't
enforce consistency in our API filters, and 2. because the docs look bad (I had not noticed). TsDoc
can't handle union types and it's a known bug (microsoft/tsdoc#164). This
PR moves the `resolvedStatus` within the ThreadListFilter type, then goes through all its uses and
decides on whether to omit it or not.

Test Plan:
Tested ThreadedComments with all 4 tab options and they worked correctly. Then tested the
ThreadedComments by switching the underlying API to use the deprecated parameter, which also worked
as expected.

Also, docs look really nice again :)


Reviewers: flooey, jwatzman, km-nur

Reviewed By: km-nur

Pull Request: https://github.com/getcord/monorepo/pull/6436

monorepo-commit: e8a3e6ed8846cff9baeffc16e7e1dabdb7e42cb7

Author: nickfil22

packages/react/components/ThreadList.tsx

@@ -26,7 +26,7 @@ export type ThreadListReactComponentProps = PropsWithFlags<
     showScreenshotPreviewInMessage?: boolean;
     highlightOpenFloatingThread?: boolean;
     highlightThreadId?: string;
-    filter?: ThreadListFilter;
+    filter?: Omit<ThreadListFilter, 'resolvedStatus'>;
     showPlaceholder?: boolean;
     partialMatch?: boolean;
     onThreadClick?: (

packages/types/thread.ts

@@ -287,6 +287,7 @@ export interface ThreadObserverOptions {
 export type ObserveThreadSummaryOptions = ThreadObserverOptions;
 export type ObserveThreadDataOptions = ThreadObserverOptions;
 
+export type ResolvedStatus = 'any' | 'resolved' | 'unresolved';
 export type ThreadListFilter = {
   /**
    * The value for a `metadata` entry should be an object representing the
@@ -304,12 +305,19 @@ export type ThreadListFilter = {
    * @privateRemarks hidden
    */
   organizationID?: string;
+  /**
+   * If set to `resolved`, only resolved threads will be returned. If set to `unresolved`,
+   * only unresolved threads will be returned. If set to `any`, both resolved and
+   * unresolved threads will be returned.
+   *
+   * If unset, defaults to `unresolved`.
+   */
+  resolvedStatus?: ResolvedStatus;
 };
 export type SortDirection = 'ascending' | 'descending';
 export type SortBy =
   | 'first_message_timestamp'
   | 'most_recent_message_timestamp';
-export type ResolvedStatus = 'any' | 'resolved' | 'unresolved';
 export type ObserveLocationDataOptions = {
   /**
    * This option controls the criteria for how threads are sorted.
@@ -367,16 +375,7 @@ export type ObserveLocationDataOptions = {
   /**
    * An object that can be used to filter the threads returned.
    */
-  filter?: ThreadListFilter & {
-    /**
-     * If set to `resolved`, only resolved threads will be returned. If set to `unresolved`,
-     * only unresolved threads will be returned. If set to `any`, both resolved and
-     * unresolved threads will be returned.
-     *
-     * If unset, defaults to `unresolved`.
-     */
-    resolvedStatus?: ResolvedStatus;
-  };
+  filter?: ThreadListFilter;
 };
 
 export type LocationData = PaginationParams & {