fix: Portal frontend 50 (#56)

* fix: auto_gen_password

* fix: model types

* reuse types

* fix: handle result state

* fix type params

* fix imports

src/api/models.ts

@@ -5,6 +5,9 @@ import type { CountryIsoCodes, UkCounties } from "../utils/general"
 // User Models
 // -----------------------------------------------------------------------------
 
+type _UserTeacher<T extends Teacher> = Omit<T, "user">
+type _UserStudent<S extends Student> = Omit<S, "user" | "auto_gen_password">
+
 export type User = Model<
   number,
   {
@@ -16,49 +19,49 @@ export type User = Model<
     is_staff: boolean
     is_active: boolean
     date_joined: Date
-    requesting_to_join_class?: string
-    teacher?: Teacher
-    student?: Student
+    requesting_to_join_class?: Class["id"]
+    teacher?: _UserTeacher<Teacher>
+    student?: _UserStudent<Student>
   }
 >
 
 export type TeacherUser<Fields = User> = Fields & {
   email: string
   last_name: string
-  teacher: Teacher
-  student: undefined
+  teacher: _UserTeacher<Teacher>
+  student?: undefined
 }
 
 export type SchoolTeacherUser<Fields = User> = TeacherUser<Fields> & {
-  teacher: SchoolTeacher
+  teacher: _UserTeacher<SchoolTeacher>
 }
 
 export type AdminSchoolTeacherUser<Fields = User> =
   SchoolTeacherUser<Fields> & {
-    teacher: AdminSchoolTeacher
+    teacher: _UserTeacher<AdminSchoolTeacher>
   }
 
 export type NonAdminSchoolTeacherUser<Fields = User> =
   SchoolTeacherUser<Fields> & {
-    teacher: NonAdminSchoolTeacher
+    teacher: _UserTeacher<NonAdminSchoolTeacher>
   }
 
 export type NonSchoolTeacherUser<Fields = User> = TeacherUser<Fields> & {
-  teacher: NonSchoolTeacher
+  teacher: _UserTeacher<NonSchoolTeacher>
 }
 
 export type StudentUser<Fields = User> = Fields & {
-  email: undefined
-  last_name: undefined
-  teacher: undefined
-  student: Student
+  email?: undefined
+  last_name?: undefined
+  teacher?: undefined
+  student: _UserStudent<Student>
 }
 
 export type IndependentUser<Fields = User> = Fields & {
   email: string
   last_name: string
-  teacher: undefined
-  student: undefined
+  teacher?: undefined
+  student?: undefined
 }
 
 // -----------------------------------------------------------------------------
@@ -68,14 +71,14 @@ export type IndependentUser<Fields = User> = Fields & {
 export type Teacher = Model<
   number,
   {
-    user: number
-    school?: number
+    user: User["id"]
+    school?: School["id"]
     is_admin: boolean
   }
 >
 
 export type SchoolTeacher<Fields = Teacher> = Fields & {
-  school: number
+  school: School["id"]
 }
 
 export type AdminSchoolTeacher<Fields = Teacher> = SchoolTeacher<Fields> & {
@@ -87,7 +90,7 @@ export type NonAdminSchoolTeacher<Fields = Teacher> = SchoolTeacher<Fields> & {
 }
 
 export type NonSchoolTeacher<Fields = Teacher> = Fields & {
-  school: undefined
+  school?: undefined
 }
 
 // -----------------------------------------------------------------------------
@@ -97,9 +100,10 @@ export type NonSchoolTeacher<Fields = Teacher> = Fields & {
 export type Student = Model<
   number,
   {
-    user: number
-    school: number
-    klass: string
+    user: User["id"]
+    school: School["id"]
+    klass: Class["id"]
+    auto_gen_password: string
   }
 >
 
@@ -116,8 +120,8 @@ export type Class = Model<
   string,
   {
     name: string
-    teacher: number
-    school: number
+    teacher: Teacher["id"]
+    school: School["id"]
     read_classmates_data: boolean
     receive_requests_until?: Date
   }
@@ -126,15 +130,15 @@ export type Class = Model<
 export type AuthFactor = Model<
   number,
   {
-    user: number
+    user: User["id"]
     type: "otp"
   }
 >
 
 export type OtpBypassToken = Model<
   number,
   {
-    user: number
+    user: User["id"]
     token: string
   }
 >

src/components/TablePagination.tsx

@@ -14,7 +14,7 @@ import {
 } from "react"
 
 import { type Pagination, usePagination } from "../hooks/api"
-import { type ListArg, type ListResult, handleQueryState } from "../utils/api"
+import { type ListArg, type ListResult, handleResultState } from "../utils/api"
 
 export type TablePaginationProps<
   QueryArg extends ListArg,
@@ -91,7 +91,7 @@ const TablePagination = <
 
   return (
     <Stack {...stackProps}>
-      {handleQueryState(result, ({ data }) =>
+      {handleResultState(result, ({ data }) =>
         children(data, {
           limit,
           page,

src/hooks/router.tsx

@@ -21,26 +21,23 @@ import {
   type TryValidateSyncRT,
 } from "../utils/schema"
 
-export type Navigate<State extends Record<string, any> = Record<string, any>> =
-  {
-    (
-      to: To,
-      options?: Omit<NavigateOptions, "state"> & {
-        state?: State & Partial<PageState>
-        next?: boolean
-      },
-    ): void
-    (delta: number): void
-  }
+export type Navigate = {
+  <State extends Record<string, any> = Record<string, any>>(
+    to: To,
+    options?: Omit<NavigateOptions, "state"> & {
+      state?: State & Partial<PageState>
+      next?: boolean
+    },
+  ): void
+  (delta: number): void
+}
 
-export function useNavigate<
-  State extends Record<string, any> = Record<string, any>,
->(): Navigate<State> {
+export function useNavigate(): Navigate {
   const navigate = _useNavigate()
   const searchParams = useSearchParams()
 
   return (
-    toOrDelta,
+    toOrDelta: To | number,
     options: (NavigateOptions & { next?: boolean }) | undefined = undefined,
   ) => {
     if (typeof toOrDelta === "number") navigate(toOrDelta)
@@ -128,7 +125,6 @@ export function useParams<
 export function useParamsRequired<
   OnErrorRT extends TryValidateSyncOnErrorRT<ObjectSchemaFromShape<Shape>>,
   Shape extends ObjectShape = {},
-  State extends Record<string, any> = Record<string, any>,
 >({
   shape,
   children,
@@ -142,7 +138,7 @@ export function useParamsRequired<
       TryValidateSyncRT<ObjectSchemaFromShape<Shape>, OnErrorRT>
     >,
   ) => ReactNode
-  onValidationError: (navigate: Navigate<State>) => void
+  onValidationError: (navigate: Navigate) => void
   onValidationSuccess?: (
     params: NonNullable<
       TryValidateSyncRT<ObjectSchemaFromShape<Shape>, OnErrorRT>
@@ -154,7 +150,7 @@ export function useParamsRequired<
   >
 }) {
   const params = useParams(shape, validateOptions)
-  const navigate = useNavigate<State>()
+  const navigate = useNavigate()
 
   useEffect(
     () => {

src/utils/api.tsx

@@ -3,6 +3,7 @@ import type {
   FetchBaseQueryError,
   TypedUseQueryHookResult,
   TypedUseQueryStateResult,
+  TypedUseMutationResult,
 } from "@reduxjs/toolkit/query/react"
 import { type ReactNode } from "react"
 
@@ -292,10 +293,11 @@ export type HandleQueryStateOptions = Partial<{
   error: ReactNode
 }>
 
-export function handleQueryState<QueryArg, ResultType>(
+export function handleResultState<QueryArg, ResultType>(
   result:
     | TypedUseQueryHookResult<ResultType, QueryArg, any>
-    | TypedUseQueryStateResult<ResultType, QueryArg, any>,
+    | TypedUseQueryStateResult<ResultType, QueryArg, any>
+    | TypedUseMutationResult<ResultType, QueryArg, any>,
   children: (data: NonNullable<ResultType>) => ReactNode,
   options?: HandleQueryStateOptions,
 ): ReactNode {