legalgonews/legalgo-FE-reactrouter
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: refactor API response schemas for improve consistency

Browse Source
This commit is contained in:
Ardeman 2025-03-07 09:04:11 +08:00
parent 7163266100
commit d765d92df7
11 changed files with 40 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
app/apis/admin/get-news.ts
View File

@ -1,6 +1,7 @@
import { z } from 'zod'
import { categorySchema } from '~/apis/common/get-categories'
import { categoryResponseSchema } from '~/apis/common/get-categories'
import { tagResponseSchema } from '~/apis/common/get-tags'
import { HttpServer, type THttpServer } from '~/libs/http-server'
const authorSchema = z.object({
@ -8,18 +9,12 @@ const authorSchema = z.object({
name: z.string(),
profile_picture: z.string(),
})
const newsSchema = z.object({
const newsResponseSchema = z.object({
id: z.string(),
title: z.string(),
content: z.string(),
categories: z.array(categorySchema),
tags: z.array(
z.object({
id: z.string(),
name: z.string(),
code: z.string(),
}),
),
categories: z.array(categoryResponseSchema),
tags: z.array(tagResponseSchema),
is_premium: z.boolean(),
slug: z.string(),
featured_image: z.string(),
@ -29,16 +24,16 @@ const newsSchema = z.object({
updated_at: z.string(),
author: authorSchema,
})
const dataSchema = z.object({
data: z.array(newsSchema),
const dataResponseSchema = z.object({
data: z.array(newsResponseSchema),
})
export type TNewsSchema = z.infer<typeof newsSchema>
export type TNewsResponse = z.infer<typeof newsResponseSchema>
export const getNews = async (parameters: THttpServer) => {
try {
const { data } = await HttpServer(parameters).get(`/api/news`)
return dataSchema.parse(data)
return dataResponseSchema.parse(data)
} catch (error) {
// eslint-disable-next-line unicorn/no-useless-promise-resolve-reject
return Promise.reject(error)

4
app/apis/admin/get-staff.ts
View File

@ -2,7 +2,7 @@ import { z } from 'zod'
import { HttpServer, type THttpServer } from '~/libs/http-server'
const staffSchema = z.object({
const staffResponseSchema = z.object({
data: z.object({
id: z.string(),
email: z.string(),
@ -14,7 +14,7 @@ const staffSchema = z.object({
export const getStaff = async (parameters: THttpServer) => {
try {
const { data } = await HttpServer(parameters).get(`/api/staff/profile`)
return staffSchema.parse(data)
return staffResponseSchema.parse(data)
} catch (error) {
// eslint-disable-next-line unicorn/no-useless-promise-resolve-reject
return Promise.reject(error)

12
app/apis/common/get-categories.ts
View File

@ -2,22 +2,22 @@ import { z } from 'zod'
import { HttpServer, type THttpServer } from '~/libs/http-server'
export const categorySchema = z.object({
export const categoryResponseSchema = z.object({
id: z.string(),
name: z.string(),
code: z.string(),
})
const categoriesSchema = z.object({
data: z.array(categorySchema),
const categoriesResponseSchema = z.object({
data: z.array(categoryResponseSchema),
})
export type TCategorySchema = z.infer<typeof categorySchema>
export type TCategoriesSchema = z.infer<typeof categoriesSchema>
export type TCategoryResponse = z.infer<typeof categoryResponseSchema>
export type TCategoriesResponse = z.infer<typeof categoriesResponseSchema>
export const getCategories = async (parameters?: THttpServer) => {
try {
const { data } = await HttpServer(parameters).get(`/api/category`)
return categoriesSchema.parse(data)
return categoriesResponseSchema.parse(data)
} catch (error) {
// eslint-disable-next-line unicorn/no-useless-promise-resolve-reject
return Promise.reject(error)

4
app/apis/common/get-subscriptions.ts
View File

@ -2,7 +2,7 @@ import { z } from 'zod'
import { HttpServer, type THttpServer } from '~/libs/http-server'
const subscriptionSchema = z.object({
const subscriptionResponseSchema = z.object({
data: z.array(
z.object({
id: z.string(),
@ -15,7 +15,7 @@ const subscriptionSchema = z.object({
export const getSubscriptions = async (parameters?: THttpServer) => {
try {
const { data } = await HttpServer(parameters).get(`/api/subscribe-plan`)
return subscriptionSchema.parse(data)
return subscriptionResponseSchema.parse(data)
} catch (error) {
// eslint-disable-next-line unicorn/no-useless-promise-resolve-reject
return Promise.reject(error)

10
app/apis/common/get-tags.ts
View File

@ -2,21 +2,21 @@ import { z } from 'zod'
import { HttpServer, type THttpServer } from '~/libs/http-server'
const tagSchema = z.object({
export const tagResponseSchema = z.object({
id: z.string(),
code: z.string(),
name: z.string(),
})
const tagsSchema = z.object({
data: z.array(tagSchema),
const tagsResponseSchema = z.object({
data: z.array(tagResponseSchema),
})
export type TTagSchema = z.infer<typeof tagSchema>
export type TTagResponse = z.infer<typeof tagResponseSchema>
export const getTags = async (parameters?: THttpServer) => {
try {
const { data } = await HttpServer(parameters).get(`/api/tag`)
return tagsSchema.parse(data)
return tagsResponseSchema.parse(data)
} catch (error) {
// eslint-disable-next-line unicorn/no-useless-promise-resolve-reject
return Promise.reject(error)

6
app/apis/news/get-user.ts
View File

@ -2,7 +2,7 @@ import { z } from 'zod'
import { HttpServer, type THttpServer } from '~/libs/http-server'
const userSchema = z.object({
const userResponseSchema = z.object({
data: z.object({
id: z.string(),
email: z.string(),
@ -23,12 +23,12 @@ const userSchema = z.object({
}),
})
export type TUser = z.infer<typeof userSchema>
export type TUserResponse = z.infer<typeof userResponseSchema>
export const getUser = async (parameters: THttpServer) => {
try {
const { data } = await HttpServer(parameters).get(`/api/user/profile`)
return userSchema.parse(data)
return userResponseSchema.parse(data)
} catch (error) {
// eslint-disable-next-line unicorn/no-useless-promise-resolve-reject
return Promise.reject(error)

2
app/apis/news/login-user.ts
View File

@ -3,7 +3,7 @@ import { z } from 'zod'
import { type TLoginSchema } from '~/layouts/news/form-login'
import { HttpServer } from '~/libs/http-server'
const loginResponseSchema = z.object({
export const loginResponseSchema = z.object({
data: z.object({
token: z.string(),
}),

8
app/apis/news/register-user.ts
View File

@ -1,13 +1,7 @@
import { z } from 'zod'
import type { TRegisterSchema } from '~/layouts/news/form-register'
import { HttpServer } from '~/libs/http-server'
const loginResponseSchema = z.object({
data: z.object({
token: z.string(),
}),
})
import { loginResponseSchema } from './login-user'
export const userRegisterRequest = async (payload: TRegisterSchema) => {
try {

4
app/layouts/news/header-menu-mobile.tsx
View File

@ -1,7 +1,7 @@
import { useState } from 'react'
import { Link, useFetcher, useRouteLoaderData } from 'react-router'
import type { TCategoriesSchema } from '~/apis/common/get-categories'
import type { TCategoriesResponse } from '~/apis/common/get-categories'
import { CloseIcon } from '~/components/icons/close'
import { MenuIcon } from '~/components/icons/menu'
import { Button } from '~/components/ui/button'
@ -10,7 +10,7 @@ import { HeaderSearch } from '~/layouts/news/header-search'
import type { loader } from '~/routes/_layout'
type THeaderMenuMobile = {
menu?: TCategoriesSchema['data']
menu?: TCategoriesResponse['data']
}
export default function HeaderMenuMobile(properties: THeaderMenuMobile) {

13
app/pages/dashboard-contents/index.tsx
View File

@ -2,9 +2,9 @@ import DT from 'datatables.net-dt'
import DataTable from 'datatables.net-react'
import { Link, useRouteLoaderData } from 'react-router'
import type { TNewsSchema } from '~/apis/admin/get-news'
import type { TCategorySchema } from '~/apis/common/get-categories'
import type { TTagSchema } from '~/apis/common/get-tags'
import type { TNewsResponse } from '~/apis/admin/get-news'
import type { TCategoryResponse } from '~/apis/common/get-categories'
import type { TTagResponse } from '~/apis/common/get-tags'
import { Button } from '~/components/ui/button'
import { UiTable } from '~/components/ui/table'
import { TitleDashboard } from '~/components/ui/title-dashboard'
@ -55,14 +55,15 @@ export const ContentsPage = () => {
]
const dataSlot = {
1: (value: string) => formatDate(value),
2: (_value: unknown, _type: unknown, data: TNewsSchema) => (
2: (_value: unknown, _type: unknown, data: TNewsResponse) => (
<div>
<div>{data.author.name}</div>
<div className="text-sm text-[#7C7C7C]">ID: {data.id.slice(0, 8)}</div>
</div>
),
4: (value: TCategorySchema[]) => value.map((item) => item.name).join(', '),
5: (value: TTagSchema[]) => value.map((item) => item.name).join(', '),
4: (value: TCategoryResponse[]) =>
value.map((item) => item.name).join(', '),
5: (value: TTagResponse[]) => value.map((item) => item.name).join(', '),
6: (value: string) =>
value ? (
<div className="rounded-full bg-[#FFFCAF] px-2 text-center text-[#DBCA6E]">

4
app/utils/render.tsx
View File

@ -1,13 +1,13 @@
import type { MouseEventHandler } from 'react'
import { Link } from 'react-router'
import type { TUser } from '~/apis/news/get-user'
import type { TUserResponse } from '~/apis/news/get-user'
type TGetPremiumAttribute = {
isPremium?: boolean
slug: string
onClick: MouseEventHandler<HTMLElement>
userData?: TUser['data']
userData?: TUserResponse['data']
}
export const getPremiumAttribute = (parameters: TGetPremiumAttribute) => {