fix: Refactored user type definition to align with server returns

Zenoo · Zenoo · commit d2e0cc2ada24 · 2022-12-21T11:06:41.000+01:00
diff --git a/client/public/static/i18n/en/common.json b/client/public/static/i18n/en/common.json
@@ -1,4 +1,5 @@
 {
+  "home": "Home",
   "userList": "User list",
   "Examples": "Examples",
   "giveAdminRights": "Give admin rights",
diff --git a/client/public/static/i18n/fr/common.json b/client/public/static/i18n/fr/common.json
@@ -1,4 +1,5 @@
 {
+  "home": "Accueil",
   "userList": "Utilisateurs",
   "Examples": "Exemples",
   "giveAdminRights": "Donner les droits admin",
diff --git a/client/src/api/RecordRoutes.ts b/client/src/api/RecordRoutes.ts
@@ -1,17 +1,16 @@
 import { Prisma, Record } from '@fullstack-typescript-monorepo/prisma';
-import Fetch from '../utils/fetcher';
 import Super from './Super';
-import { User } from './UserRoutes';
+import { User, UserWithPerson } from './UserRoutes';
 
 export type RecordWithAuthor = Record & {
   author: User;
 };
+export type RecordWithAuthorWithPerson = Record & {
+  author: UserWithPerson;
+};
 
 const RecordRoutes = {
-  ...Super<Record, Prisma.RecordUpdateInput>('record'),
-  list: (object?: string) => Fetch<RecordWithAuthor[]>('/api/record/list', {
-    object,
-  }),
+  ...Super<Record, Prisma.RecordInclude, Prisma.RecordWhereInput, Prisma.RecordUpdateInput>('record'),
 };
 
 export default RecordRoutes;
diff --git a/client/src/api/RequestRoutes.ts b/client/src/api/RequestRoutes.ts
@@ -1,10 +1,8 @@
 import { Prisma, Request } from '@fullstack-typescript-monorepo/prisma';
 import Super from './Super';
 
-export type RequestUpdate = Partial<Request>;
-
 const RequestRoutes = {
-  ...Super<Request, Prisma.RequestUpdateInput>('request'),
+  ...Super<Request, never, Prisma.RequestWhereInput, Prisma.RequestUpdateInput>('request'),
 };
 
 export default RequestRoutes;
diff --git a/client/src/api/Super.ts b/client/src/api/Super.ts
@@ -1,34 +1,26 @@
-import { PrismaInclude } from '@fullstack-typescript-monorepo/core';
 import { TableState } from '../components/Datatable';
 import Fetch from '../utils/fetcher';
 
-export interface getProps {
-  id: number;
-  include?: PrismaInclude;
-}
-
-const Super = <Model, Setter extends object>(model: string) => ({
+const Super = <Model, Include, Where, Setter extends object>(model: string) => ({
   insert: (data: Setter) => Fetch<Model>(`/api/${model}`, data, 'PUT'),
-  get: ({ id, include }: getProps) => Fetch<Model>(`/api/${model}/${id}/get`, {
-    include,
-  }, 'POST'),
-  getAll: (include: PrismaInclude) => Fetch<Model[]>(`/api/${model}/all`, {
+  get: ({ id, include }: { id: number, include?: Include }) => Fetch<Model>(`/api/${model}/${id}/get`, {
     include,
   }, 'POST'),
+  list: (params: { include?: Include, where?: Where }) => Fetch<Model[]>(`/api/${model}/list`, params, 'POST'),
   getAllAsCsv: (title: string) => Fetch<Blob>(`/api/${model}/all/csv`, {
     title,
   }),
   table: (
     state: TableState,
-    include?: PrismaInclude,
+    include?: Include,
   ) => Fetch<{ data: Model[], count: number }>(`/api/${model}/table`, {
     state,
     include,
   }, 'POST'),
   update: (
     id: number,
     data: Setter,
-    include?: PrismaInclude
+    include?: Include
   ) => Fetch<Model>(`/api/${model}/${id}/update`, {
     data,
     include,
diff --git a/client/src/api/UserRoutes.ts b/client/src/api/UserRoutes.ts
@@ -1,14 +1,24 @@
 import { Person, Prisma, User as _User } from '@fullstack-typescript-monorepo/prisma';
+import { TableState } from '../components/Datatable';
 import Fetch from '../utils/fetcher';
 import Super from './Super';
 
-export interface User extends Omit<_User, 'password'> {
+export type User = Omit<_User, 'password'>;
+
+export type UserWithPerson = User & {
   person: Person;
-}
+};
 
 const UserRoutes = {
-  ...Super<User, Prisma.UserUpdateInput>('user'),
-  authenticate: (login: string, password: string): Promise<User> => Fetch<User>('/api/user/authenticate', {
+  ...Super<User, Prisma.UserInclude, Prisma.UserWhereInput, Prisma.UserUpdateInput>('user'),
+  table: (
+    state: TableState,
+    include?: Prisma.UserInclude,
+  ) => Fetch<{ data: UserWithPerson[], count: number }>('/api/user/table', {
+    state,
+    include,
+  }, 'POST'),
+  authenticate: (login: string, password: string) => Fetch<UserWithPerson>('/api/user/authenticate', {
     login,
     password,
   }, 'POST'),
diff --git a/client/src/components/ActionsTable.tsx b/client/src/components/ActionsTable.tsx
@@ -1,8 +1,8 @@
 import { Paper, Stack, Table, TableBody, TableCell, TableContainer, TableHead, TableRow } from '@mui/material';
 import moment from 'moment';
-import React, { useEffect } from 'react';
+import React, { useEffect, useMemo } from 'react';
 import { useTranslation } from 'react-i18next';
-import RecordRoutes from '../api/RecordRoutes';
+import RecordRoutes, { RecordWithAuthorWithPerson } from '../api/RecordRoutes';
 import useStateAsync from '../hooks/useStateAsync';
 import Text from './Text';
 
@@ -18,11 +18,15 @@ const ActionsTable = ({
 }: ActionsTableProps) => {
   const { t } = useTranslation('actions');
 
-  const { data: records, reload: reloadRecords } = useStateAsync(
+  const recordsListParams = useMemo(() => ({
+    include: { author: { include: { person: true } } },
+  }), []);
+  const { data: _records, reload: reloadRecords } = useStateAsync(
     [],
     RecordRoutes.list,
-    object,
+    recordsListParams,
   );
+  const records = _records as RecordWithAuthorWithPerson[];
 
   // Reload table when new record is added and/or when reloadActions is updated
   useEffect(() => {
diff --git a/client/src/hooks/useAuth.tsx b/client/src/hooks/useAuth.tsx
@@ -1,15 +1,15 @@
 import React, { useCallback, useContext, useMemo, useState } from 'react';
-import UserRoutes, { User } from '../api/UserRoutes';
+import UserRoutes, { UserWithPerson } from '../api/UserRoutes';
 
 interface AuthContextInterface {
-  user: User,
+  user: UserWithPerson,
   authed: boolean,
-  signin: (login: string, password: string) => Promise<User | null>,
+  signin: (login: string, password: string) => Promise<UserWithPerson | null>,
   signout: () => void,
-  updateData: (data: User) => void,
+  updateData: (data: UserWithPerson) => void,
 }
 
-export const emptyUser: User = {
+export const emptyUser: UserWithPerson = {
   id: 0,
   login: '',
   admin: false,
@@ -49,7 +49,7 @@ interface AuthProviderProps {
 }
 
 export const AuthProvider = ({ children }: AuthProviderProps) => {
-  const [user, setUser] = useState<User>(emptyUser);
+  const [user, setUser] = useState<UserWithPerson>(emptyUser);
   const [authed, setAuthed] = useState(false);
 
   const signin = useCallback((
@@ -70,7 +70,7 @@ export const AuthProvider = ({ children }: AuthProviderProps) => {
     setUser(emptyUser);
   }, []);
 
-  const updateData = useCallback((data: User) => {
+  const updateData = useCallback((data: UserWithPerson) => {
     setUser(data);
   }, []);
 
diff --git a/client/src/views/HomeView.tsx b/client/src/views/HomeView.tsx
@@ -1,15 +1,19 @@
 import { Card, CardContent } from '@mui/material';
 import React from 'react';
+import { useTranslation } from 'react-i18next';
 import Page from '../components/Page';
+import Text from '../components/Text';
 
-const HomeView = () => (
-  <Page
-    title="User list"
-  >
-    <Card>
-      <CardContent>Hello !</CardContent>
-    </Card>
-  </Page>
-);
+const HomeView = () => {
+  const { t } = useTranslation();
+
+  return (
+    <Page title={t('home')}>
+      <Card>
+        <CardContent><Text>Hello !</Text></CardContent>
+      </Card>
+    </Page>
+  );
+};
 
 export default HomeView;
diff --git a/client/src/views/account/AccountView/ProfileDetails.tsx b/client/src/views/account/AccountView/ProfileDetails.tsx
@@ -3,7 +3,7 @@ import { Box, Card, CardContent, CardHeader, Divider, Grid, TextField } from '@m
 import React from 'react';
 import { useWatch } from 'react-hook-form';
 import { useTranslation } from 'react-i18next';
-import UserRoutes from '../../../api/UserRoutes';
+import UserRoutes, { UserWithPerson } from '../../../api/UserRoutes';
 import { useAlert } from '../../../hooks/useAlert';
 import { useAuth } from '../../../hooks/useAuth';
 import useForm from '../../../hooks/useForm';
@@ -60,7 +60,7 @@ const ProfileDetails = ({ ...rest }) => {
     await UserRoutes.update(auth.user.id, {
       person: { update: processedData }
     }, { person: true }).then((newData) => {
-      auth.updateData(newData);
+      auth.updateData(newData as UserWithPerson);
       Alert.open('success', t('common:saved'));
     }).catch(catchError(Alert));
     Loader.close();
diff --git a/client/src/views/admin/user/UserEditView.tsx b/client/src/views/admin/user/UserEditView.tsx
@@ -2,7 +2,7 @@ import { Card, CardContent, CardHeader, Divider } from '@mui/material';
 import React, { useMemo } from 'react';
 import { useTranslation } from 'react-i18next';
 import { useParams } from 'react-router-dom';
-import UserRoutes from '../../../api/UserRoutes';
+import UserRoutes, { UserWithPerson } from '../../../api/UserRoutes';
 import UserForm from '../../../components/forms/UserForm';
 import Loader from '../../../components/Loader';
 import Page from '../../../components/Page';
@@ -19,11 +19,12 @@ const UserEditView = () => {
     id,
     include: { person: true },
   }), [id]);
-  const { data: user } = useStateAsync(
+  const { data: _user } = useStateAsync(
     emptyUser,
     UserRoutes.get,
     callParams,
   );
+  const user = _user as UserWithPerson;
 
   return (
     <Page title={id ? t('editUser') : t('newUser')}>
diff --git a/client/src/views/admin/user/UserListView.tsx b/client/src/views/admin/user/UserListView.tsx
@@ -1,6 +1,6 @@
 import React, { useCallback } from 'react';
 import { useNavigate } from 'react-router-dom';
-import UserRoutes, { User } from '../../../api/UserRoutes';
+import UserRoutes, { UserWithPerson } from '../../../api/UserRoutes';
 import Page from '../../../components/Page';
 import TableLayout from '../../../layouts/TableLayout';
 
@@ -10,7 +10,7 @@ const UserListView = () => {
   /**
    * Data mapper
    */
-  const mapper = useCallback((user: User) => ({
+  const mapper = useCallback((user: UserWithPerson) => ({
     id: user.id,
     login: user.login,
     'person.firstName, person.lastName': `${user.person ? `${user.person.firstName} ${user.person.lastName}` : ''}`,
diff --git a/server/src/controllers/REST.ts b/server/src/controllers/REST.ts
@@ -56,6 +56,10 @@ const get = (model: string) => (prisma: PrismaClient) => async (
     const { id } = req.params;
     const { include } = req.body;
 
+    if (!+id) {
+      throw new Error('No ID provided');
+    }
+
     const prismaModel = (prisma as GenericPrisma)[model] as MOCK_PrismaModel;
 
     const object = await prismaModel.findUniqueOrThrow({
@@ -70,21 +74,22 @@ const get = (model: string) => (prisma: PrismaClient) => async (
 };
 
 /**
- * Get all objects from the database
+ * List objects from the database
  * @param model
  */
-const getAll = (model: string) => (prisma: PrismaClient) => async (
-  req: Request<never, unknown, { include?: PrismaInclude }>,
+const list = (model: string) => (prisma: PrismaClient) => async (
+  req: Request<never, unknown, { include?: PrismaInclude, where?: object }>,
   res: Response,
 ) => {
   try {
     await auth(prisma, req);
 
-    const { include } = req.body;
+    const { include, where } = req.body;
 
     const prismaModel = (prisma as GenericPrisma)[model] as MOCK_PrismaModel;
 
     const objects = await prismaModel.findMany({
+      where,
       include,
     });
 
@@ -203,7 +208,7 @@ const deleteObject = (model: string) => (prisma: PrismaClient) => async (
 const REST = (model: string) => ({
   insert: insert(model),
   get: get(model),
-  getAll: getAll(model),
+  list: list(model),
   getAllAsCsv: getAllAsCsv(model),
   table: table(model),
   update: update(model),
diff --git a/server/src/routes.ts b/server/src/routes.ts
@@ -17,7 +17,7 @@ const initRoutes = (app: Express, prisma: PrismaClient) => {
   // User
   app.post('/api/user/authenticate', Users.authenticate(prisma));
   app.post('/api/user/reset-password', Users.resetPassword(prisma));
-  app.post('/api/user/all', Users.getAll(prisma));
+  app.post('/api/user/list', Users.list(prisma));
   app.get('/api/user/all/csv', Users.getAllAsCsv(prisma));
   app.put('/api/user', Users.insert(prisma));
   app.post('/api/user/:id/get', Users.get(prisma));
@@ -29,8 +29,7 @@ const initRoutes = (app: Express, prisma: PrismaClient) => {
   app.get('/api/user/:login/reset-code-check', Users.checkResetCodeValidity(prisma));
 
   // Record
-  app.get('/api/record/list', Records.list(prisma));
-  app.post('/api/record/all', Records.getAll(prisma));
+  app.post('/api/record/list', Records.list(prisma));
   app.get('/api/record/all/csv', Records.getAllAsCsv(prisma));
   app.put('/api/record', Records.insert(prisma));
   app.post('/api/record/:id/get', Records.get(prisma));
@@ -39,7 +38,7 @@ const initRoutes = (app: Express, prisma: PrismaClient) => {
   app.delete('/api/record/:id', Records.delete(prisma));
 
   // Request
-  app.post('/api/request/all', Requests.getAll(prisma));
+  app.post('/api/request/list', Requests.list(prisma));
   app.get('/api/request/all/csv', Requests.getAllAsCsv(prisma));
   app.put('/api/request', Requests.insert(prisma));
   app.post('/api/request/:id/get', Requests.get(prisma));
diff --git a/server/src/utils/sendError.ts b/server/src/utils/sendError.ts
@@ -1,7 +1,7 @@
 import {
   PrismaClientInitializationError,
   PrismaClientKnownRequestError, PrismaClientUnknownRequestError, PrismaClientValidationError,
-} from '@fullstack-typescript-monorepo/prisma/lib/runtime';
+} from '@fullstack-typescript-monorepo/prisma/runtime';
 import { Response } from 'express';
 
 const sendError = (res: Response, error: unknown) => {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`{`
	`2`	`+ "home": "Home",`
`2`	`3`	`"userList": "User list",`
`3`	`4`	`"Examples": "Examples",`
`4`	`5`	`"giveAdminRights": "Give admin rights",`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`{`
	`2`	`+ "home": "Accueil",`
`2`	`3`	`"userList": "Utilisateurs",`
`3`	`4`	`"Examples": "Exemples",`
`4`	`5`	`"giveAdminRights": "Donner les droits admin",`