feat: refactor API response schemas for improve consistency

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
+9 -14
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)
+2 -2
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)
+6 -6
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)
+2 -2
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)
+5 -5
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)
+3 -3
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)
+1 -1
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(),
}),
+1 -7
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 {