@farmzone/fz-template-react 1.0.3 → 1.0.5

package/template/src/app/api/queries.ts

@@ -1,321 +1,326 @@
-import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
-import { toast } from "@farmzone/fz-react-ui";
-
-import { apiInstance, apiFormDataInstance } from "@/app/api/api";
-import {
-  COMMENT_QUERY_KEY,
-  DASHBOARD_QUERY_KEY,
-  LOG_QUERY_KEY,
-  POST_QUERY_KEY,
-  SAMPLE_QUERY_KEY,
-  USER_QUERY_KEY,
-} from "@/app/api/queryKey";
-import { COMMON_MESSAGES } from "@/shared/config/text";
-import type {
-  LoginResponse,
-  PageResponse,
-  Sample,
-  GetSamplesParams,
-  SampleForm,
-  Post,
-  GetPostsParams,
-  PostForm,
-  Comment,
-  CommentForm,
-  CommentTargetType,
-  CommentEditForm,
-  User,
-  GetUsersParams,
-  UserForm,
-  UserEditForm,
-  ActionLog,
-  GetLogsParams,
-  UserDashboardResponse,
-} from "@/types";
-
-// --- Auth ---
-
-export const usePostLogin = () => {
-  return useMutation({
-    mutationFn: (params: { userId: string; password: string }) =>
-      apiInstance.post<LoginResponse>("/auth/login", params).then((res) => res.data),
-    onSuccess: () => {
-      toast.success("로그인 성공", { duration: 1500 });
-    },
-  });
-};
-
-// --- Sample ---
-
-export const useGetSamples = (params: GetSamplesParams) => {
-  return useQuery({
-    queryKey: [SAMPLE_QUERY_KEY, "list", params],
-    queryFn: () => apiInstance.get<PageResponse<Sample>>("/samples", { params }).then((r) => r.data),
-  });
-};
-
-export const useGetSample = (id: number | null) => {
-  return useQuery({
-    queryKey: [SAMPLE_QUERY_KEY, "detail", id],
-    queryFn: () => apiInstance.get<Sample>(`/samples/${id}`).then((r) => r.data),
-    enabled: id !== null,
-  });
-};
-
-export const usePostSample = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: (data: SampleForm) => apiInstance.post<Sample>("/samples", data).then((r) => r.data),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [SAMPLE_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.SAVE_SUCCESS);
-    },
-  });
-};
-
-export const usePutSample = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: ({ id, data }: { id: number; data: SampleForm }) =>
-      apiInstance.put<Sample>(`/samples/${id}`, data).then((r) => r.data),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [SAMPLE_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.UPDATE_SUCCESS);
-    },
-  });
-};
-
-export const useDeleteSample = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: (id: number) => apiInstance.delete(`/samples/${id}`),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [SAMPLE_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
-    },
-  });
-};
-
-export const useDeleteSamples = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: (ids: Array<number>) =>
-      apiInstance.delete("/samples", {
-        params: { ids },
-        paramsSerializer: { indexes: null },
-      }),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [SAMPLE_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
-    },
-  });
-};
-
-// --- Post ---
-
-export const useGetPosts = (params: GetPostsParams) => {
-  return useQuery({
-    queryKey: [POST_QUERY_KEY, "list", params],
-    queryFn: () => apiInstance.get<PageResponse<Post>>("/posts", { params }).then((r) => r.data),
-  });
-};
-
-export const useGetPost = (id: number | null) => {
-  return useQuery({
-    queryKey: [POST_QUERY_KEY, "detail", id],
-    queryFn: () => apiInstance.get<Post>(`/posts/${id}`).then((r) => r.data),
-    enabled: id !== null,
-  });
-};
-
-export const usePostPost = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: (data: PostForm) => apiInstance.post<Post>("/posts", data).then((r) => r.data),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [POST_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.SAVE_SUCCESS);
-    },
-  });
-};
-
-export const usePutPost = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: ({ id, data }: { id: number; data: PostForm }) =>
-      apiInstance.put<Post>(`/posts/${id}`, data).then((r) => r.data),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [POST_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.UPDATE_SUCCESS);
-    },
-  });
-};
-
-export const useDeletePost = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: (id: number) => apiInstance.delete(`/posts/${id}`),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [POST_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
-    },
-  });
-};
-
-export const useDeletePosts = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: (ids: Array<number>) =>
-      apiInstance.delete("/posts", {
-        params: { ids },
-        paramsSerializer: { indexes: null },
-      }),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [POST_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
-    },
-  });
-};
-
-// --- Comment ---
-
-export const useGetComments = (targetType: CommentTargetType, targetId: number) => {
-  return useQuery({
-    queryKey: [COMMENT_QUERY_KEY, targetType, targetId],
-    queryFn: () =>
-      apiInstance.get<Array<Comment>>("/comments", { params: { targetType, targetId } }).then((r) => r.data),
-  });
-};
-
-export const usePostComment = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: (data: CommentForm) => apiInstance.post<Comment>("/comments", data).then((r) => r.data),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [COMMENT_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.SAVE_SUCCESS);
-    },
-  });
-};
-
-export const usePutComment = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: ({ commentId, data }: { commentId: number; data: CommentEditForm }) =>
-      apiInstance.put<Comment>(`/comments/${commentId}`, data).then((r) => r.data),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [COMMENT_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.UPDATE_SUCCESS);
-    },
-  });
-};
-
-export const useDeleteComment = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: (commentId: number) => apiInstance.delete(`/comments/${commentId}`),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [COMMENT_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
-    },
-  });
-};
-
-// --- User ---
-
-export const checkUserIdAvailable = (userId: string): Promise<boolean> =>
-  apiInstance.get<boolean>("/users/check/id", { params: { userId } }).then((r) => r.data);
-
-export const useGetUsers = (params: GetUsersParams) => {
-  return useQuery({
-    queryKey: [USER_QUERY_KEY, "list", params],
-    queryFn: () => apiInstance.get<PageResponse<User>>("/users", { params }).then((r) => r.data),
-  });
-};
-
-export const useGetUser = (id: number | null) => {
-  return useQuery({
-    queryKey: [USER_QUERY_KEY, "detail", id],
-    queryFn: () => apiInstance.get<User>(`/users/${id}`).then((r) => r.data),
-    enabled: id !== null,
-  });
-};
-
-export const usePostUser = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: async ({ data, file }: { data: UserForm; file?: File }) => {
-      const formData = new FormData();
-      formData.append("request", JSON.stringify(data));
-      if (file) formData.append("files", file);
-      return (await apiFormDataInstance.post<User>("/users", formData)).data;
-    },
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [USER_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.SAVE_SUCCESS);
-    },
-  });
-};
-
-export const usePutUser = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: async ({ id, data, file }: { id: number; data: UserEditForm; file?: File }) => {
-      const formData = new FormData();
-      formData.append("request", JSON.stringify(data));
-      if (file) formData.append("files", file);
-      return (await apiFormDataInstance.put<User>(`/users/${id}`, formData)).data;
-    },
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [USER_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.UPDATE_SUCCESS);
-    },
-  });
-};
-
-export const useDeleteUser = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: (id: number) => apiInstance.delete(`/users/${id}`),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [USER_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
-    },
-  });
-};
-
-export const useDeleteUsers = () => {
-  const queryClient = useQueryClient();
-  return useMutation({
-    mutationFn: (ids: Array<number>) =>
-      apiInstance.delete("/users", {
-        params: { ids },
-        paramsSerializer: { indexes: null },
-      }),
-    onSuccess: () => {
-      void queryClient.invalidateQueries({ queryKey: [USER_QUERY_KEY] });
-      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
-    },
-  });
-};
-
-// --- Action Log ---
-
-export const useGetLogs = (params: GetLogsParams) => {
-  return useQuery({
-    queryKey: [LOG_QUERY_KEY, "list", params],
-    queryFn: () => apiInstance.get<PageResponse<ActionLog>>("/action-logs", { params }).then((r) => r.data),
-  });
-};
-
-// --- Dashboard ---
-
-export const useGetUserDashboard = (period = "30d") => {
-  return useQuery({
-    queryKey: [DASHBOARD_QUERY_KEY, period],
-    queryFn: () =>
-      apiInstance
-        .get<UserDashboardResponse>("/users/dashboard", { params: { period } })
-        .then((r) => r.data),
-  });
-};
+import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
+import { toast } from "@farmzone/fz-react-ui";
+
+import { apiInstance, apiFormDataInstance } from "@/app/api/api";
+import {
+  COMMENT_QUERY_KEY,
+  DASHBOARD_QUERY_KEY,
+  LOG_QUERY_KEY,
+  POST_QUERY_KEY,
+  SAMPLE_QUERY_KEY,
+  USER_QUERY_KEY,
+} from "@/app/api/queryKey";
+import { COMMON_MESSAGES } from "@/shared/config/text";
+import type {
+  LoginResponse,
+  PageResponse,
+  Sample,
+  GetSamplesParams,
+  SampleForm,
+  Post,
+  GetPostsParams,
+  PostForm,
+  Comment,
+  CommentForm,
+  CommentTargetType,
+  CommentEditForm,
+  User,
+  GetUsersParams,
+  UserForm,
+  UserEditForm,
+  ActionLog,
+  GetLogsParams,
+  UserDashboardResponse,
+} from "@/types";
+
+// --- Auth ---
+
+export const usePostLogin = () => {
+  return useMutation({
+    mutationFn: (params: { userId: string; password: string }) =>
+      apiInstance.post<LoginResponse>("/auth/login", params).then((res) => res.data),
+    onSuccess: () => {
+      toast.success("로그인 성공", { duration: 1500 });
+    },
+  });
+};
+
+// --- Sample ---
+
+export const useGetSamples = (params: GetSamplesParams) => {
+  return useQuery({
+    queryKey: [SAMPLE_QUERY_KEY, "list", params],
+    queryFn: () => apiInstance.get<PageResponse<Sample>>("/samples", { params }).then((r) => r.data),
+  });
+};
+
+export const useGetSample = (id: number | null) => {
+  return useQuery({
+    queryKey: [SAMPLE_QUERY_KEY, "detail", id],
+    queryFn: () => apiInstance.get<Sample>(`/samples/${id}`).then((r) => r.data),
+    enabled: id !== null,
+  });
+};
+
+export const usePostSample = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (data: SampleForm) => apiInstance.post<Sample>("/samples", data).then((r) => r.data),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [SAMPLE_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.SAVE_SUCCESS);
+    },
+  });
+};
+
+export const usePutSample = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: ({ id, data }: { id: number; data: SampleForm }) =>
+      apiInstance.put<Sample>(`/samples/${id}`, data).then((r) => r.data),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [SAMPLE_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.UPDATE_SUCCESS);
+    },
+  });
+};
+
+export const useDeleteSample = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (id: number) => apiInstance.delete(`/samples/${id}`),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [SAMPLE_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
+    },
+  });
+};
+
+export const useDeleteSamples = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (ids: Array<number>) =>
+      apiInstance.delete("/samples", {
+        params: { ids },
+        paramsSerializer: { indexes: null },
+      }),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [SAMPLE_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
+    },
+  });
+};
+
+// --- Post ---
+
+export const useGetPosts = (params: GetPostsParams) => {
+  return useQuery({
+    queryKey: [POST_QUERY_KEY, "list", params],
+    queryFn: () => apiInstance.get<PageResponse<Post>>("/posts", { params }).then((r) => r.data),
+  });
+};
+
+export const useGetPost = (id: number | null) => {
+  return useQuery({
+    queryKey: [POST_QUERY_KEY, "detail", id],
+    queryFn: () => apiInstance.get<Post>(`/posts/${id}`).then((r) => r.data),
+    enabled: id !== null,
+  });
+};
+
+export const usePostPost = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (data: PostForm) => apiInstance.post<Post>("/posts", data).then((r) => r.data),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [POST_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.SAVE_SUCCESS);
+    },
+  });
+};
+
+export const usePutPost = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: ({ id, data }: { id: number; data: PostForm }) =>
+      apiInstance.put<Post>(`/posts/${id}`, data).then((r) => r.data),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [POST_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.UPDATE_SUCCESS);
+    },
+  });
+};
+
+export const useDeletePost = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (id: number) => apiInstance.delete(`/posts/${id}`),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [POST_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
+    },
+  });
+};
+
+export const useDeletePosts = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (ids: Array<number>) =>
+      apiInstance.delete("/posts", {
+        params: { ids },
+        paramsSerializer: { indexes: null },
+      }),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [POST_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
+    },
+  });
+};
+
+// --- Comment ---
+
+export const useGetComments = (targetType: CommentTargetType, targetId: number) => {
+  return useQuery({
+    queryKey: [COMMENT_QUERY_KEY, targetType, targetId],
+    queryFn: () =>
+      apiInstance.get<Array<Comment>>("/comments", { params: { targetType, targetId } }).then((r) => r.data),
+  });
+};
+
+export const usePostComment = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (data: CommentForm) => apiInstance.post<Comment>("/comments", data).then((r) => r.data),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [COMMENT_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.SAVE_SUCCESS);
+    },
+  });
+};
+
+export const usePutComment = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: ({ commentId, data }: { commentId: number; data: CommentEditForm }) =>
+      apiInstance.put<Comment>(`/comments/${commentId}`, data).then((r) => r.data),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [COMMENT_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.UPDATE_SUCCESS);
+    },
+  });
+};
+
+export const useDeleteComment = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (commentId: number) => apiInstance.delete(`/comments/${commentId}`),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [COMMENT_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
+    },
+  });
+};
+
+// --- Sample check ---
+
+export const checkSampleNameAvailable = (name: string): Promise<boolean> =>
+  apiInstance.get<boolean>("/samples/check/name", { params: { name } }).then((r) => r.data);
+
+// --- User ---
+
+export const checkUserIdAvailable = (userId: string): Promise<boolean> =>
+  apiInstance.get<boolean>("/users/check/id", { params: { userId } }).then((r) => r.data);
+
+export const useGetUsers = (params: GetUsersParams) => {
+  return useQuery({
+    queryKey: [USER_QUERY_KEY, "list", params],
+    queryFn: () => apiInstance.get<PageResponse<User>>("/users", { params }).then((r) => r.data),
+  });
+};
+
+export const useGetUser = (id: number | null) => {
+  return useQuery({
+    queryKey: [USER_QUERY_KEY, "detail", id],
+    queryFn: () => apiInstance.get<User>(`/users/${id}`).then((r) => r.data),
+    enabled: id !== null,
+  });
+};
+
+export const usePostUser = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: async ({ data, file }: { data: UserForm; file?: File }) => {
+      const formData = new FormData();
+      formData.append("request", JSON.stringify(data));
+      if (file) formData.append("files", file);
+      return (await apiFormDataInstance.post<User>("/users", formData)).data;
+    },
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [USER_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.SAVE_SUCCESS);
+    },
+  });
+};
+
+export const usePutUser = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: async ({ id, data, file }: { id: number; data: UserEditForm; file?: File }) => {
+      const formData = new FormData();
+      formData.append("request", JSON.stringify(data));
+      if (file) formData.append("files", file);
+      return (await apiFormDataInstance.put<User>(`/users/${id}`, formData)).data;
+    },
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [USER_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.UPDATE_SUCCESS);
+    },
+  });
+};
+
+export const useDeleteUser = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (id: number) => apiInstance.delete(`/users/${id}`),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [USER_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
+    },
+  });
+};
+
+export const useDeleteUsers = () => {
+  const queryClient = useQueryClient();
+  return useMutation({
+    mutationFn: (ids: Array<number>) =>
+      apiInstance.delete("/users", {
+        params: { ids },
+        paramsSerializer: { indexes: null },
+      }),
+    onSuccess: () => {
+      void queryClient.invalidateQueries({ queryKey: [USER_QUERY_KEY] });
+      toast.success(COMMON_MESSAGES.DELETE_SUCCESS);
+    },
+  });
+};
+
+// --- Action Log ---
+
+export const useGetLogs = (params: GetLogsParams) => {
+  return useQuery({
+    queryKey: [LOG_QUERY_KEY, "list", params],
+    queryFn: () => apiInstance.get<PageResponse<ActionLog>>("/action-logs", { params }).then((r) => r.data),
+  });
+};
+
+// --- Dashboard ---
+
+export const useGetUserDashboard = (period = "30d") => {
+  return useQuery({
+    queryKey: [DASHBOARD_QUERY_KEY, period],
+    queryFn: () =>
+      apiInstance
+        .get<UserDashboardResponse>("/users/dashboard", { params: { period } })
+        .then((r) => r.data),
+  });
+};

package/template/src/app/api/queryKey.ts

@@ -1,7 +1,7 @@
-export const AUTH_QUERY_KEY = "auth";
-export const SAMPLE_QUERY_KEY = "sample";
-export const POST_QUERY_KEY = "post";
-export const COMMENT_QUERY_KEY = "comment";
-export const USER_QUERY_KEY = "user";
-export const LOG_QUERY_KEY = "log";
-export const DASHBOARD_QUERY_KEY = "dashboard";
+export const AUTH_QUERY_KEY = "auth";
+export const SAMPLE_QUERY_KEY = "sample";
+export const POST_QUERY_KEY = "post";
+export const COMMENT_QUERY_KEY = "comment";
+export const USER_QUERY_KEY = "user";
+export const LOG_QUERY_KEY = "log";
+export const DASHBOARD_QUERY_KEY = "dashboard";