Merge branch 'main' into route-data-refactor

[lemmy-ui.git] / src / shared / interfaces.ts

diff --git a/src/shared/interfaces.ts b/src/shared/interfaces.ts
index 6872db3869bee1c458cf175dde5efb2655b7c38b..dbba70406b1314037691fa5b6add9b023138b76d 100644 (file)
--- a/src/shared/interfaces.ts
+++ b/src/shared/interfaces.ts
@@ -1,19 +1,23 @@
-import {
-  CommentView,
-  GetSiteResponse,
-  LemmyHttp,
-  UserMentionView,
-} from "lemmy-js-client";
+import { CommentView, GetSiteResponse } from "lemmy-js-client";
+import type { ParsedQs } from "qs";
+import { RequestState, WrappedLemmyHttp } from "./services/HttpService";
+import { ErrorPageData } from "./utils";
 
-export interface IsoData {
+/**
+ * This contains serialized data, it needs to be deserialized before use.
+ */
+export interface IsoData<T extends Record<string, RequestState<any>> = any> {
   path: string;
-  routeData: any[];
+  routeData: T;
   site_res: GetSiteResponse;
-  // Lang and theme
-  lang: string;
-  // communities?: ListCommunitiesResponse;
+  errorPageData?: ErrorPageData;
 }
 
+export type IsoDataOptionalSite<
+  T extends Record<string, RequestState<any>> = any
+> = Partial<IsoData<T>> &
+  Pick<IsoData<T>, Exclude<keyof IsoData<T>, "site_res">>;
+
 export interface ILemmyConfig {
   wsHost?: string;
 }
@@ -25,36 +29,23 @@ declare global {
   }
 }
 
-export interface InitialFetchRequest {
-  auth: string;
+export interface InitialFetchRequest<T extends ParsedQs = ParsedQs> {
+  auth?: string;
+  client: WrappedLemmyHttp;
   path: string;
-  client: LemmyHttp;
-}
-
-export interface CommentNode {
-  comment_view: CommentView | UserMentionView;
-  children?: CommentNode[];
-  depth?: number;
+  query: T;
+  site: GetSiteResponse;
 }
 
 export interface PostFormParams {
-  name: string;
+  name?: string;
   url?: string;
   body?: string;
-  community_name?: string;
-  community_id?: number;
-}
-
-export enum CommentSortType {
-  Hot,
-  Top,
-  New,
-  Old,
 }
 
 export enum CommentViewType {
   Tree,
-  Chat,
+  Flat,
 }
 
 export enum DataType {
@@ -67,9 +58,27 @@ export enum BanType {
   Site,
 }
 
-export enum UserDetailsView {
-  Overview,
-  Comments,
-  Posts,
-  Saved,
+export enum PersonDetailsView {
+  Overview = "Overview",
+  Comments = "Comments",
+  Posts = "Posts",
+  Saved = "Saved",
+}
+
+export enum PurgeType {
+  Person,
+  Community,
+  Post,
+  Comment,
+}
+
+export enum VoteType {
+  Upvote,
+  Downvote,
+}
+
+export interface CommentNodeI {
+  comment_view: CommentView;
+  children: Array<CommentNodeI>;
+  depth: number;
 }