From 39bf03c4f5f72847aae4b55ac4f533adc744e7f3 Mon Sep 17 00:00:00 2001 From: bicochan Date: Mon, 17 Mar 2025 13:27:19 +0900 Subject: [PATCH 1/4] =?UTF-8?q?refactor:=20provider=20=EB=A0=88=EC=9D=B4?= =?UTF-8?q?=EC=96=B4=20=EB=B3=80=EA=B2=BD=20&=20=EB=88=84=EB=9D=BD?= =?UTF-8?q?=EB=90=9C=20public=20api=20=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- apps/cs/app/api/proxy/[...url]/route.ts | 2 +- apps/cs/next.config.ts | 1 - apps/cs/src/app/index.tsx | 2 +- .../providers}/app-provider.tsx | 4 +- apps/cs/src/app/providers/index.ts | 1 + .../providers}/query-provider.tsx | 0 .../auth/{login => }/api/login-service.ts | 9 +++- apps/cs/src/entities/auth/index.ts | 2 + .../auth/lib}/auth-provider.tsx | 19 +++------ .../auth/{login => }/lib/token-manager.ts | 4 +- apps/cs/src/entities/auth/login/index.ts | 1 - .../auth/{login => }/model/login-interface.ts | 0 apps/cs/src/entities/code/api/code-service.ts | 4 +- apps/cs/src/entities/code/ui/code-select.tsx | 2 +- apps/cs/src/entities/site/index.ts | 2 - apps/cs/src/entities/user/api/user-service.ts | 15 ------- apps/cs/src/entities/user/index.ts | 1 - apps/cs/src/entities/user/lib/use-user.ts | 20 --------- .../src/entities/user/model/user-interface.ts | 41 ------------------- .../cs/src/pages/auth/login/ui/login-page.tsx | 2 +- .../site/api/site-service.ts | 4 +- .../site/model/site-interface.ts | 0 .../cs/src/pages/site/model/table-columns.tsx | 2 +- apps/cs/src/pages/site/ui/create-page.tsx | 3 +- apps/cs/src/pages/site/ui/modify-page.tsx | 6 +-- apps/cs/src/pages/site/ui/site-form.tsx | 6 +-- apps/cs/src/pages/site/ui/site-page.tsx | 5 ++- apps/cs/src/shared/api/index.ts | 1 + apps/cs/src/shared/config/index.ts | 2 + .../{provider => lib}/cookie-provider.tsx | 12 +----- apps/cs/src/shared/lib/index.ts | 2 + apps/cs/src/shared/provider/index.ts | 3 -- 32 files changed, 46 insertions(+), 132 deletions(-) rename apps/cs/src/{shared/provider => app/providers}/app-provider.tsx (81%) create mode 100644 apps/cs/src/app/providers/index.ts rename apps/cs/src/{shared/provider => app/providers}/query-provider.tsx (100%) rename apps/cs/src/entities/auth/{login => }/api/login-service.ts (94%) create mode 100644 apps/cs/src/entities/auth/index.ts rename apps/cs/src/{shared/provider => entities/auth/lib}/auth-provider.tsx (80%) rename apps/cs/src/entities/auth/{login => }/lib/token-manager.ts (94%) delete mode 100644 apps/cs/src/entities/auth/login/index.ts rename apps/cs/src/entities/auth/{login => }/model/login-interface.ts (100%) delete mode 100644 apps/cs/src/entities/site/index.ts delete mode 100644 apps/cs/src/entities/user/api/user-service.ts delete mode 100644 apps/cs/src/entities/user/index.ts delete mode 100644 apps/cs/src/entities/user/lib/use-user.ts delete mode 100644 apps/cs/src/entities/user/model/user-interface.ts rename apps/cs/src/{entities => pages}/site/api/site-service.ts (93%) rename apps/cs/src/{entities => pages}/site/model/site-interface.ts (100%) create mode 100644 apps/cs/src/shared/api/index.ts create mode 100644 apps/cs/src/shared/config/index.ts rename apps/cs/src/shared/{provider => lib}/cookie-provider.tsx (67%) create mode 100644 apps/cs/src/shared/lib/index.ts delete mode 100644 apps/cs/src/shared/provider/index.ts diff --git a/apps/cs/app/api/proxy/[...url]/route.ts b/apps/cs/app/api/proxy/[...url]/route.ts index 5397e5fe6..d3092c5c1 100644 --- a/apps/cs/app/api/proxy/[...url]/route.ts +++ b/apps/cs/app/api/proxy/[...url]/route.ts @@ -5,7 +5,7 @@ import { REFRESH_TOKEN, SERVER_API_URL, SITE_ID, -} from "@/shared/config/env"; +} from "@/shared/config"; import { cookies } from "next/headers"; import { NextResponse } from "next/server"; diff --git a/apps/cs/next.config.ts b/apps/cs/next.config.ts index 5e3560133..7c1a12675 100644 --- a/apps/cs/next.config.ts +++ b/apps/cs/next.config.ts @@ -27,7 +27,6 @@ const nextConfig: NextConfig = { "import.meta.env.VITE_AUTH_USER_ID": JSON.stringify( process.env.NEXT_PUBLIC_AUTH_USER_ID, ), - "process.env.SITE_ID": JSON.stringify(process.env.NEXT_PUBLIC_SITE_ID), }), ); diff --git a/apps/cs/src/app/index.tsx b/apps/cs/src/app/index.tsx index eb1d7f7c7..d1d5e56e1 100644 --- a/apps/cs/src/app/index.tsx +++ b/apps/cs/src/app/index.tsx @@ -1,6 +1,6 @@ import "./styles/base.css"; import "./styles/components.css"; -import { AppProvider } from "@/shared/provider"; +import { AppProvider } from "./providers"; const App = ({ children }: Readonly<{ children: React.ReactNode }>) => { return ( diff --git a/apps/cs/src/shared/provider/app-provider.tsx b/apps/cs/src/app/providers/app-provider.tsx similarity index 81% rename from apps/cs/src/shared/provider/app-provider.tsx rename to apps/cs/src/app/providers/app-provider.tsx index 175cc6aaa..7bd2ec683 100644 --- a/apps/cs/src/shared/provider/app-provider.tsx +++ b/apps/cs/src/app/providers/app-provider.tsx @@ -1,8 +1,8 @@ "use client"; import { ConfirmProvider } from "@frontend-opensource/use-react-hooks"; -import { AuthProvider } from "./auth-provider"; -import { CookieProvider } from "./cookie-provider"; +import { AuthProvider } from "@/entities/auth"; +import { CookieProvider } from "@/shared/lib"; import { QueryProvider } from "./query-provider"; const AppProvider = ({ children }: Readonly<{ children: React.ReactNode }>) => { diff --git a/apps/cs/src/app/providers/index.ts b/apps/cs/src/app/providers/index.ts new file mode 100644 index 000000000..15f99b7fd --- /dev/null +++ b/apps/cs/src/app/providers/index.ts @@ -0,0 +1 @@ +export { AppProvider } from "./app-provider"; diff --git a/apps/cs/src/shared/provider/query-provider.tsx b/apps/cs/src/app/providers/query-provider.tsx similarity index 100% rename from apps/cs/src/shared/provider/query-provider.tsx rename to apps/cs/src/app/providers/query-provider.tsx diff --git a/apps/cs/src/entities/auth/login/api/login-service.ts b/apps/cs/src/entities/auth/api/login-service.ts similarity index 94% rename from apps/cs/src/entities/auth/login/api/login-service.ts rename to apps/cs/src/entities/auth/api/login-service.ts index 8c14547a0..c1968fe36 100644 --- a/apps/cs/src/entities/auth/login/api/login-service.ts +++ b/apps/cs/src/entities/auth/api/login-service.ts @@ -1,6 +1,11 @@ import { AxiosError } from "axios"; -import { ENDPOINT, JWT_EXPIRATION_TIME } from "@/shared/config/api"; -import { ACCESS_TOKEN, AUTH_USER_ID, CLAIM_NAME } from "@/shared/config/env"; +import { + ENDPOINT, + JWT_EXPIRATION_TIME, + ACCESS_TOKEN, + AUTH_USER_ID, + CLAIM_NAME, +} from "@/shared/config"; import type { LoginService, ILogin } from "../model/login-interface"; import { tokenManager } from "../lib/token-manager"; diff --git a/apps/cs/src/entities/auth/index.ts b/apps/cs/src/entities/auth/index.ts new file mode 100644 index 000000000..97579d0a5 --- /dev/null +++ b/apps/cs/src/entities/auth/index.ts @@ -0,0 +1,2 @@ +export { LoginApi } from "./api/login-service"; +export { AuthProvider } from "./lib/auth-provider"; diff --git a/apps/cs/src/shared/provider/auth-provider.tsx b/apps/cs/src/entities/auth/lib/auth-provider.tsx similarity index 80% rename from apps/cs/src/shared/provider/auth-provider.tsx rename to apps/cs/src/entities/auth/lib/auth-provider.tsx index 60b273641..551cfa79d 100644 --- a/apps/cs/src/shared/provider/auth-provider.tsx +++ b/apps/cs/src/entities/auth/lib/auth-provider.tsx @@ -2,12 +2,11 @@ import { useRouter } from "next/navigation"; import { useQuery } from "@tanstack/react-query"; -import { createContext, useContext, useState } from "react"; -import { client } from "../api/client"; -import { ENDPOINT } from "../config/api"; -import { AUTH_USER_ID } from "../config/env"; -import { getCookie } from "../lib/cookie"; -import { LoginApi } from "@/entities/auth/login"; +import { createContext, useState } from "react"; +import { client } from "@/shared/api"; +import { ENDPOINT, AUTH_USER_ID } from "@/shared/config"; +import { getCookie } from "@/shared/lib"; +import { LoginApi } from "../api/login-service"; interface IUserInfo { regDt: string; @@ -91,11 +90,3 @@ export const AuthProvider = ({ children }: { children: React.ReactNode }) => { ); }; - -export const useAuth = (): AuthContextType => { - const context = useContext(AuthContext); - if (!context) { - throw new Error("useAuth must be used within an AuthProvider"); - } - return context; -}; diff --git a/apps/cs/src/entities/auth/login/lib/token-manager.ts b/apps/cs/src/entities/auth/lib/token-manager.ts similarity index 94% rename from apps/cs/src/entities/auth/login/lib/token-manager.ts rename to apps/cs/src/entities/auth/lib/token-manager.ts index 4429c7d1b..0e761486a 100644 --- a/apps/cs/src/entities/auth/login/lib/token-manager.ts +++ b/apps/cs/src/entities/auth/lib/token-manager.ts @@ -1,5 +1,5 @@ -import { AUTH_USER_ID, CLAIM_NAME } from "@/shared/config/env"; -import { getCookie, setCookie, removeCookie } from "@/shared/lib/cookie"; +import { AUTH_USER_ID, CLAIM_NAME } from "@/shared/config"; +import { getCookie, setCookie, removeCookie } from "@/shared/lib"; export class TokenManager { private static instance: TokenManager; diff --git a/apps/cs/src/entities/auth/login/index.ts b/apps/cs/src/entities/auth/login/index.ts deleted file mode 100644 index 8c7981ac9..000000000 --- a/apps/cs/src/entities/auth/login/index.ts +++ /dev/null @@ -1 +0,0 @@ -export { LoginApi } from "./api/login-service"; diff --git a/apps/cs/src/entities/auth/login/model/login-interface.ts b/apps/cs/src/entities/auth/model/login-interface.ts similarity index 100% rename from apps/cs/src/entities/auth/login/model/login-interface.ts rename to apps/cs/src/entities/auth/model/login-interface.ts diff --git a/apps/cs/src/entities/code/api/code-service.ts b/apps/cs/src/entities/code/api/code-service.ts index 3a789f2aa..0d1055f6a 100644 --- a/apps/cs/src/entities/code/api/code-service.ts +++ b/apps/cs/src/entities/code/api/code-service.ts @@ -1,5 +1,5 @@ -import { client } from "@/shared/api/client"; -import { ENDPOINT } from "@/shared/config/api"; +import { client } from "@/shared/api"; +import { ENDPOINT } from "@/shared/config"; import type { CodeService, ICode } from "../model/code-interface"; export class CodeApiService implements CodeService { diff --git a/apps/cs/src/entities/code/ui/code-select.tsx b/apps/cs/src/entities/code/ui/code-select.tsx index 5d73ee1d3..00b3157aa 100644 --- a/apps/cs/src/entities/code/ui/code-select.tsx +++ b/apps/cs/src/entities/code/ui/code-select.tsx @@ -6,7 +6,7 @@ import { SelectTrigger, SelectValue, } from "@common/components"; -import { ENDPOINT } from "@/shared/config/api"; +import { ENDPOINT } from "@/shared/config"; import { CodeApi } from "../api/code-service"; type CodeSelectProps = { diff --git a/apps/cs/src/entities/site/index.ts b/apps/cs/src/entities/site/index.ts deleted file mode 100644 index 47f9d7b50..000000000 --- a/apps/cs/src/entities/site/index.ts +++ /dev/null @@ -1,2 +0,0 @@ -export { SiteApi } from "./api/site-service"; -export * from "./model/site-interface"; diff --git a/apps/cs/src/entities/user/api/user-service.ts b/apps/cs/src/entities/user/api/user-service.ts deleted file mode 100644 index 41319bc1f..000000000 --- a/apps/cs/src/entities/user/api/user-service.ts +++ /dev/null @@ -1,15 +0,0 @@ -import { client } from "@/shared/api/client"; -import { ENDPOINT } from "@/shared/config/api"; -import type { IUser, IUserInfo, UserService } from "../model/user-interface"; - -export class UsersApiService implements UserService { - public async userInfo(payload: IUser): Promise { - const response = await client.get( - `${ENDPOINT.USER_SERVICE.USERS}/${payload.userUniqId}`, - ); - - return response.data; - } -} - -export const UserApi = new UsersApiService(); diff --git a/apps/cs/src/entities/user/index.ts b/apps/cs/src/entities/user/index.ts deleted file mode 100644 index 3076aa261..000000000 --- a/apps/cs/src/entities/user/index.ts +++ /dev/null @@ -1 +0,0 @@ -export { useUser } from "./lib/use-user"; diff --git a/apps/cs/src/entities/user/lib/use-user.ts b/apps/cs/src/entities/user/lib/use-user.ts deleted file mode 100644 index 97cd2f034..000000000 --- a/apps/cs/src/entities/user/lib/use-user.ts +++ /dev/null @@ -1,20 +0,0 @@ -import { useQuery } from "@tanstack/react-query"; -import { ENDPOINT } from "@/shared/config/api"; -import { AUTH_USER_ID } from "@/shared/config/env"; -import { useCookie } from "@/shared/provider"; -import { UserApi } from "../api/user-service"; - -const useUser = () => { - const { getCookie } = useCookie(); - const { data } = useQuery({ - queryKey: [ENDPOINT.USER_SERVICE.USERS], - queryFn: () => - UserApi.userInfo({ - userUniqId: getCookie(AUTH_USER_ID) ?? "", - }), - }); - - return { userInfo: data }; -}; - -export { useUser }; diff --git a/apps/cs/src/entities/user/model/user-interface.ts b/apps/cs/src/entities/user/model/user-interface.ts deleted file mode 100644 index cba4a6206..000000000 --- a/apps/cs/src/entities/user/model/user-interface.ts +++ /dev/null @@ -1,41 +0,0 @@ -export interface IUser { - userUniqId: string; -} - -export interface IUserInfo { - regDt: string; - mdfcnDt: string; - rgtr: string; - mdfr: string; - userUnqId: string; - userId: string; - userName: string; - email: string; - encryptedPassword: string; - refreshToken: string; - userStateCode: string; - lastLoginDate: string; - loginFailCount: number; - pswdHnt: string; - pswdAns: string; - mphn: string; - telno: string; - zip: string; - addr: string; - daddr: string; - laeSeCd: string; - ogdpSeCd: string; - aprvYn: string; - autzrId: string; - expryYmd: string; - lastPswdChgDt: string; - googleId: string; - kakaoId: string; - naverId: string; - isSocialUser: boolean; - hasPassword: boolean; -} - -export interface UserService { - userInfo: (payload: IUser) => Promise; -} diff --git a/apps/cs/src/pages/auth/login/ui/login-page.tsx b/apps/cs/src/pages/auth/login/ui/login-page.tsx index c8eb1e2f9..d5e12966a 100644 --- a/apps/cs/src/pages/auth/login/ui/login-page.tsx +++ b/apps/cs/src/pages/auth/login/ui/login-page.tsx @@ -2,7 +2,7 @@ import Image from "next/image"; import { images } from "@common/assets"; -import { LoginApi } from "@/entities/auth/login"; +import { LoginApi } from "@/entities/auth"; import "./login.css"; function LoginPage() { diff --git a/apps/cs/src/entities/site/api/site-service.ts b/apps/cs/src/pages/site/api/site-service.ts similarity index 93% rename from apps/cs/src/entities/site/api/site-service.ts rename to apps/cs/src/pages/site/api/site-service.ts index 1c9d34361..22363de68 100644 --- a/apps/cs/src/entities/site/api/site-service.ts +++ b/apps/cs/src/pages/site/api/site-service.ts @@ -1,5 +1,5 @@ -import { client } from "@/shared/api/client"; -import { ENDPOINT } from "@/shared/config/api"; +import { client } from "@/shared/api"; +import { ENDPOINT } from "@/shared/config"; import { siteFormSchema, type ISiteInfo, diff --git a/apps/cs/src/entities/site/model/site-interface.ts b/apps/cs/src/pages/site/model/site-interface.ts similarity index 100% rename from apps/cs/src/entities/site/model/site-interface.ts rename to apps/cs/src/pages/site/model/site-interface.ts diff --git a/apps/cs/src/pages/site/model/table-columns.tsx b/apps/cs/src/pages/site/model/table-columns.tsx index ddf211aea..35c084896 100644 --- a/apps/cs/src/pages/site/model/table-columns.tsx +++ b/apps/cs/src/pages/site/model/table-columns.tsx @@ -1,6 +1,6 @@ import dayjs from "dayjs"; import { createColumnHelper } from "@tanstack/react-table"; -import type { ISite } from "@/entities/site/model/site-interface"; +import type { ISite } from "./site-interface"; const columnHelper = createColumnHelper(); diff --git a/apps/cs/src/pages/site/ui/create-page.tsx b/apps/cs/src/pages/site/ui/create-page.tsx index 10d2d9030..a79c16022 100644 --- a/apps/cs/src/pages/site/ui/create-page.tsx +++ b/apps/cs/src/pages/site/ui/create-page.tsx @@ -5,7 +5,8 @@ import { useRouter } from "next/navigation"; import { useForm } from "react-hook-form"; import { useMutation } from "@tanstack/react-query"; import { zodResolver } from "@hookform/resolvers/zod"; -import { SiteApi, siteFormSchema, type SiteFormData } from "@/entities/site"; +import { SiteApi } from "../api/site-service"; +import { siteFormSchema, type SiteFormData } from "../model/site-interface"; import { SitePageLayout } from "./layout"; import { SiteForm } from "./site-form"; import { diff --git a/apps/cs/src/pages/site/ui/modify-page.tsx b/apps/cs/src/pages/site/ui/modify-page.tsx index 982f12472..8c3bbd093 100644 --- a/apps/cs/src/pages/site/ui/modify-page.tsx +++ b/apps/cs/src/pages/site/ui/modify-page.tsx @@ -5,13 +5,13 @@ import { useRouter } from "next/navigation"; import { useForm } from "react-hook-form"; import { useMutation, useQuery } from "@tanstack/react-query"; import { zodResolver } from "@hookform/resolvers/zod"; +import { ENDPOINT } from "@/shared/config"; +import { SiteApi } from "../api/site-service"; import { - SiteApi, siteFormSchema, type ISiteDetail, type SiteFormData, -} from "@/entities/site"; -import { ENDPOINT } from "@/shared/config/api"; +} from "../model/site-interface"; import { SitePageLayout } from "./layout"; import { SiteForm } from "./site-form"; import { diff --git a/apps/cs/src/pages/site/ui/site-form.tsx b/apps/cs/src/pages/site/ui/site-form.tsx index 2178befca..c554a868c 100644 --- a/apps/cs/src/pages/site/ui/site-form.tsx +++ b/apps/cs/src/pages/site/ui/site-form.tsx @@ -19,7 +19,6 @@ import { TableRow, } from "@common/components"; import { CodeSelect } from "@/entities/code"; -import { type ISiteDetail, type SiteFormData } from "@/entities/site"; import { FormItem, FormControl, @@ -27,6 +26,7 @@ import { Form, FormMessage, } from "@/shared/ui/form"; +import { type ISiteDetail, type SiteFormData } from "../model/site-interface"; import { IPManagementDialog } from "./ip-management-dialog"; import { DomainManagementDialog, @@ -37,7 +37,7 @@ type SiteFormProps = { form: UseFormReturn; siteId?: string; handleSave: (data: SiteFormData) => void; - handleDelete: () => void; + handleDelete?: () => void; }; function SiteForm({ form, siteId, handleSave, handleDelete }: SiteFormProps) { @@ -65,7 +65,7 @@ function SiteForm({ form, siteId, handleSave, handleDelete }: SiteFormProps) { const onDelete = async () => { if (await confirm("정말 삭제하시겠습니까?")) { - handleDelete(); + handleDelete?.(); } }; diff --git a/apps/cs/src/pages/site/ui/site-page.tsx b/apps/cs/src/pages/site/ui/site-page.tsx index 4b095caff..1e026c6ec 100644 --- a/apps/cs/src/pages/site/ui/site-page.tsx +++ b/apps/cs/src/pages/site/ui/site-page.tsx @@ -7,8 +7,9 @@ import { useEffect, useState } from "react"; import { useQuery } from "@tanstack/react-query"; import { getCoreRowModel, useReactTable } from "@tanstack/react-table"; import { Button, Input, DataTable } from "@common/components"; -import { SiteApi, type ISite, type ISiteParams } from "@/entities/site"; -import { ENDPOINT } from "@/shared/config/api"; +import { ENDPOINT } from "@/shared/config"; +import { SiteApi } from "../api/site-service"; +import { type ISite, type ISiteParams } from "../model/site-interface"; import { columns } from "../model/table-columns"; import { SitePageLayout } from "./layout"; diff --git a/apps/cs/src/shared/api/index.ts b/apps/cs/src/shared/api/index.ts new file mode 100644 index 000000000..b7b9d6121 --- /dev/null +++ b/apps/cs/src/shared/api/index.ts @@ -0,0 +1 @@ +export { client } from "./client"; diff --git a/apps/cs/src/shared/config/index.ts b/apps/cs/src/shared/config/index.ts new file mode 100644 index 000000000..cd83447d5 --- /dev/null +++ b/apps/cs/src/shared/config/index.ts @@ -0,0 +1,2 @@ +export * from "./api"; +export * from "./env"; diff --git a/apps/cs/src/shared/provider/cookie-provider.tsx b/apps/cs/src/shared/lib/cookie-provider.tsx similarity index 67% rename from apps/cs/src/shared/provider/cookie-provider.tsx rename to apps/cs/src/shared/lib/cookie-provider.tsx index c50050cf5..f844d4f8a 100644 --- a/apps/cs/src/shared/provider/cookie-provider.tsx +++ b/apps/cs/src/shared/lib/cookie-provider.tsx @@ -1,7 +1,7 @@ "use client"; -import { createContext, useContext } from "react"; -import { getCookie, setCookie, removeCookie } from "../lib/cookie"; +import { createContext } from "react"; +import { getCookie, setCookie, removeCookie } from "./cookie"; export interface CookieContextType { getCookie: (name: string) => string | undefined; @@ -28,11 +28,3 @@ export function CookieProvider({ children }: { children: React.ReactNode }) { ); } - -export function useCookie(): CookieContextType { - const context = useContext(CookieContext); - if (!context) { - throw new Error("useCookie must be used within a CookieProvider"); - } - return context; -} diff --git a/apps/cs/src/shared/lib/index.ts b/apps/cs/src/shared/lib/index.ts new file mode 100644 index 000000000..0f4be9c9b --- /dev/null +++ b/apps/cs/src/shared/lib/index.ts @@ -0,0 +1,2 @@ +export { CookieProvider } from "./cookie-provider"; +export { getCookie, setCookie, removeCookie } from "./cookie"; diff --git a/apps/cs/src/shared/provider/index.ts b/apps/cs/src/shared/provider/index.ts deleted file mode 100644 index 6b1832501..000000000 --- a/apps/cs/src/shared/provider/index.ts +++ /dev/null @@ -1,3 +0,0 @@ -export { AppProvider } from "./app-provider"; -export { useAuth } from "./auth-provider"; -export { useCookie } from "./cookie-provider"; From c81735b8b897b59b44786a7d59b5b2977e22a570 Mon Sep 17 00:00:00 2001 From: bicochan Date: Mon, 17 Mar 2025 14:50:18 +0900 Subject: [PATCH 2/4] =?UTF-8?q?feat:=20user=20store=20=EC=83=9D=EC=84=B1(z?= =?UTF-8?q?ustand)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- apps/cs/package.json | 3 +- apps/cs/src/app/providers/app-provider.tsx | 19 ++-- apps/cs/src/entities/auth/index.ts | 2 +- .../src/entities/auth/lib/auth-provider.tsx | 92 ------------------- apps/cs/src/entities/auth/ui/auth-wrapper.tsx | 46 ++++++++++ apps/cs/src/shared/lib/cookie-provider.tsx | 30 ------ apps/cs/src/shared/lib/index.ts | 2 +- apps/cs/src/shared/lib/use-user-store.ts | 14 +++ apps/cs/src/shared/providers/index.ts | 2 + .../providers/query-provider.tsx | 0 .../src/shared/providers/store-provider.tsx | 27 ++++++ apps/cs/src/shared/store/index.ts | 1 + apps/cs/src/shared/store/user-store.ts | 56 +++++++++++ pnpm-lock.yaml | 25 +++++ 14 files changed, 184 insertions(+), 135 deletions(-) delete mode 100644 apps/cs/src/entities/auth/lib/auth-provider.tsx create mode 100644 apps/cs/src/entities/auth/ui/auth-wrapper.tsx delete mode 100644 apps/cs/src/shared/lib/cookie-provider.tsx create mode 100644 apps/cs/src/shared/lib/use-user-store.ts create mode 100644 apps/cs/src/shared/providers/index.ts rename apps/cs/src/{app => shared}/providers/query-provider.tsx (100%) create mode 100644 apps/cs/src/shared/providers/store-provider.tsx create mode 100644 apps/cs/src/shared/store/index.ts create mode 100644 apps/cs/src/shared/store/user-store.ts diff --git a/apps/cs/package.json b/apps/cs/package.json index 402f0d414..4b400a285 100644 --- a/apps/cs/package.json +++ b/apps/cs/package.json @@ -25,7 +25,8 @@ "react-chartjs-2": "^5.3.0", "react-hook-form": "^7.54.2", "tailwindcss-animate": "^1.0.7", - "zod": "^3.24.2" + "zod": "^3.24.2", + "zustand": "^5.0.3" }, "devDependencies": { "@eslint/eslintrc": "^3", diff --git a/apps/cs/src/app/providers/app-provider.tsx b/apps/cs/src/app/providers/app-provider.tsx index 7bd2ec683..cf477dcc0 100644 --- a/apps/cs/src/app/providers/app-provider.tsx +++ b/apps/cs/src/app/providers/app-provider.tsx @@ -1,19 +1,18 @@ "use client"; import { ConfirmProvider } from "@frontend-opensource/use-react-hooks"; -import { AuthProvider } from "@/entities/auth"; -import { CookieProvider } from "@/shared/lib"; -import { QueryProvider } from "./query-provider"; +import { AuthWrapper } from "@/entities/auth"; +import { QueryProvider, StoreProvider } from "@/shared/providers"; const AppProvider = ({ children }: Readonly<{ children: React.ReactNode }>) => { return ( - - - - {children} - - - + + + + {children} + + + ); }; diff --git a/apps/cs/src/entities/auth/index.ts b/apps/cs/src/entities/auth/index.ts index 97579d0a5..dc3fb96c9 100644 --- a/apps/cs/src/entities/auth/index.ts +++ b/apps/cs/src/entities/auth/index.ts @@ -1,2 +1,2 @@ export { LoginApi } from "./api/login-service"; -export { AuthProvider } from "./lib/auth-provider"; +export { AuthWrapper } from "./ui/auth-wrapper"; diff --git a/apps/cs/src/entities/auth/lib/auth-provider.tsx b/apps/cs/src/entities/auth/lib/auth-provider.tsx deleted file mode 100644 index 551cfa79d..000000000 --- a/apps/cs/src/entities/auth/lib/auth-provider.tsx +++ /dev/null @@ -1,92 +0,0 @@ -"use client"; - -import { useRouter } from "next/navigation"; -import { useQuery } from "@tanstack/react-query"; -import { createContext, useState } from "react"; -import { client } from "@/shared/api"; -import { ENDPOINT, AUTH_USER_ID } from "@/shared/config"; -import { getCookie } from "@/shared/lib"; -import { LoginApi } from "../api/login-service"; - -interface IUserInfo { - regDt: string; - mdfcnDt: string; - rgtr: string; - mdfr: string; - userUnqId: string; - userId: string; - userName: string; - email: string; - encryptedPassword: string; - refreshToken: string; - userStateCode: string; - lastLoginDate: string; - loginFailCount: number; - pswdHnt: string; - pswdAns: string; - mphn: string; - telno: string; - zip: string; - addr: string; - daddr: string; - laeSeCd: string; - ogdpSeCd: string; - aprvYn: string; - autzrId: string; - expryYmd: string; - lastPswdChgDt: string; - googleId: string; - kakaoId: string; - naverId: string; - isSocialUser: boolean; - hasPassword: boolean; -} - -export interface AuthContextType { - userInfo: IUserInfo | null; -} - -export const AuthContext = createContext(null); - -export const AuthProvider = ({ children }: { children: React.ReactNode }) => { - const router = useRouter(); - const [userInfo, setUserInfo] = useState(null); - - useQuery({ - queryKey: [ENDPOINT.USER_SERVICE.USERS], - queryFn: async () => { - try { - const userId = getCookie(AUTH_USER_ID); - - if (!userId) { - throw new Error("Missing required authentication tokens"); - } - - const response = await client.get( - `${ENDPOINT.USER_SERVICE.USERS}/${userId}`, - ); - setUserInfo(response.data); - return response; - } catch (error) { - console.error(error); - try { - await LoginApi.silentRefresh(); - } catch (refreshError) { - console.error("Token refresh failed:", refreshError); - setUserInfo(null); - router.push("/auth/login"); - } - } - }, - }); - - const authContextValue: AuthContextType = { - userInfo, - }; - - return ( - - {children} - - ); -}; diff --git a/apps/cs/src/entities/auth/ui/auth-wrapper.tsx b/apps/cs/src/entities/auth/ui/auth-wrapper.tsx new file mode 100644 index 000000000..ba175e697 --- /dev/null +++ b/apps/cs/src/entities/auth/ui/auth-wrapper.tsx @@ -0,0 +1,46 @@ +"use client"; + +import { useRouter } from "next/navigation"; +import { useQuery } from "@tanstack/react-query"; +import { client } from "@/shared/api"; +import { ENDPOINT, AUTH_USER_ID } from "@/shared/config"; +import { getCookie, useUserStore } from "@/shared/lib"; +import type { IUserInfo } from "@/shared/store"; +import { LoginApi } from "../api/login-service"; + +const AuthWrapper = ({ children }: { children: React.ReactNode }) => { + const router = useRouter(); + const { setUserInfo } = useUserStore((state) => state); + + useQuery({ + queryKey: [ENDPOINT.USER_SERVICE.USERS], + queryFn: async () => { + try { + const userId = getCookie(AUTH_USER_ID); + + if (!userId) { + throw new Error("Missing required authentication tokens"); + } + + const response = await client.get( + `${ENDPOINT.USER_SERVICE.USERS}/${userId}`, + ); + setUserInfo(response.data); + return response; + } catch (error) { + console.error(error); + try { + await LoginApi.silentRefresh(); + } catch (refreshError) { + console.error("Token refresh failed:", refreshError); + setUserInfo(null); + router.push("/auth/login"); + } + } + }, + }); + + return <>{children}; +}; + +export { AuthWrapper }; diff --git a/apps/cs/src/shared/lib/cookie-provider.tsx b/apps/cs/src/shared/lib/cookie-provider.tsx deleted file mode 100644 index f844d4f8a..000000000 --- a/apps/cs/src/shared/lib/cookie-provider.tsx +++ /dev/null @@ -1,30 +0,0 @@ -"use client"; - -import { createContext } from "react"; -import { getCookie, setCookie, removeCookie } from "./cookie"; - -export interface CookieContextType { - getCookie: (name: string) => string | undefined; - setCookie: ( - name: string, - value: string, - options: Cookies.CookieAttributes, - ) => void; - removeCookie: (name: string, options: Cookies.CookieAttributes) => void; -} - -export const CookieContext = createContext(null); - -export function CookieProvider({ children }: { children: React.ReactNode }) { - const cookieContextValue: CookieContextType = { - getCookie, - setCookie, - removeCookie, - }; - - return ( - - {children} - - ); -} diff --git a/apps/cs/src/shared/lib/index.ts b/apps/cs/src/shared/lib/index.ts index 0f4be9c9b..259525de6 100644 --- a/apps/cs/src/shared/lib/index.ts +++ b/apps/cs/src/shared/lib/index.ts @@ -1,2 +1,2 @@ -export { CookieProvider } from "./cookie-provider"; export { getCookie, setCookie, removeCookie } from "./cookie"; +export { useUserStore } from "./use-user-store"; diff --git a/apps/cs/src/shared/lib/use-user-store.ts b/apps/cs/src/shared/lib/use-user-store.ts new file mode 100644 index 000000000..f4bf9763a --- /dev/null +++ b/apps/cs/src/shared/lib/use-user-store.ts @@ -0,0 +1,14 @@ +import { useStore } from "zustand"; +import { useContext } from "react"; +import { type UserStore } from "@/shared/store/user-store"; +import { StoreContext } from "../providers/store-provider"; + +export const useUserStore = (selector: (store: UserStore) => T): T => { + const storeContext = useContext(StoreContext); + + if (!storeContext) { + throw new Error("useUserStore must be used within StoreProvider"); + } + + return useStore(storeContext.userStore, selector); +}; diff --git a/apps/cs/src/shared/providers/index.ts b/apps/cs/src/shared/providers/index.ts new file mode 100644 index 000000000..5d9f096a3 --- /dev/null +++ b/apps/cs/src/shared/providers/index.ts @@ -0,0 +1,2 @@ +export { QueryProvider } from "./query-provider"; +export { StoreProvider } from "./store-provider"; diff --git a/apps/cs/src/app/providers/query-provider.tsx b/apps/cs/src/shared/providers/query-provider.tsx similarity index 100% rename from apps/cs/src/app/providers/query-provider.tsx rename to apps/cs/src/shared/providers/query-provider.tsx diff --git a/apps/cs/src/shared/providers/store-provider.tsx b/apps/cs/src/shared/providers/store-provider.tsx new file mode 100644 index 000000000..ec913f235 --- /dev/null +++ b/apps/cs/src/shared/providers/store-provider.tsx @@ -0,0 +1,27 @@ +"use client"; + +import { createContext, useRef } from "react"; +import { createUserStore } from "@/shared/store/user-store"; + +type StoreContextType = { + userStore: ReturnType; +}; + +export const StoreContext = createContext( + undefined, +); + +export const StoreProvider = ({ children }: { children: React.ReactNode }) => { + const storeRef = useRef(null); + if (storeRef.current === null) { + storeRef.current = { + userStore: createUserStore(), + }; + } + + return ( + + {children} + + ); +}; diff --git a/apps/cs/src/shared/store/index.ts b/apps/cs/src/shared/store/index.ts new file mode 100644 index 000000000..4dae19ced --- /dev/null +++ b/apps/cs/src/shared/store/index.ts @@ -0,0 +1 @@ +export { createUserStore, type IUserInfo } from "./user-store"; diff --git a/apps/cs/src/shared/store/user-store.ts b/apps/cs/src/shared/store/user-store.ts new file mode 100644 index 000000000..00379fb1f --- /dev/null +++ b/apps/cs/src/shared/store/user-store.ts @@ -0,0 +1,56 @@ +import { createStore } from "zustand/vanilla"; + +export interface IUserInfo { + regDt: string; + mdfcnDt: string; + rgtr: string; + mdfr: string; + userUnqId: string; + userId: string; + userName: string; + email: string; + encryptedPassword: string; + refreshToken: string; + userStateCode: string; + lastLoginDate: string; + loginFailCount: number; + pswdHnt: string; + pswdAns: string; + mphn: string; + telno: string; + zip: string; + addr: string; + daddr: string; + laeSeCd: string; + ogdpSeCd: string; + aprvYn: string; + autzrId: string; + expryYmd: string; + lastPswdChgDt: string; + googleId: string; + kakaoId: string; + naverId: string; + isSocialUser: boolean; + hasPassword: boolean; +} + +export type UserState = { + userInfo: IUserInfo | null; +}; + +export type UserActions = { + setUserInfo: (userInfo: IUserInfo | null) => void; +}; + +export type UserStore = UserState & UserActions; + +export const defaultInitState: UserState = { + userInfo: null, +}; + +export const createUserStore = (initState: UserState = defaultInitState) => { + return createStore()((set) => ({ + ...initState, + setUserInfo: (userInfo: IUserInfo | null) => set(() => ({ userInfo })), + })); +}; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 58b9fe203..484efdd1d 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -87,6 +87,9 @@ importers: zod: specifier: ^3.24.2 version: 3.24.2 + zustand: + specifier: ^5.0.3 + version: 5.0.3(@types/react@18.3.18)(react@18.3.1) devDependencies: '@eslint/eslintrc': specifier: ^3 @@ -7982,3 +7985,25 @@ packages: /zod@3.24.2: resolution: {integrity: sha512-lY7CDW43ECgW9u1TcT3IoXHflywfVqDYze4waEz812jR/bZ8FHDsl7pFQoSZTz5N+2NqRXs8GBwnAwo3ZNxqhQ==} + + /zustand@5.0.3(@types/react@18.3.18)(react@18.3.1): + resolution: {integrity: sha512-14fwWQtU3pH4dE0dOpdMiWjddcH+QzKIgk1cl8epwSE7yag43k/AD/m4L6+K7DytAOr9gGBe3/EXj9g7cdostg==} + engines: {node: '>=12.20.0'} + peerDependencies: + '@types/react': ^18.3.18 + immer: '>=9.0.6' + react: ^18.3.1 + use-sync-external-store: '>=1.2.0' + peerDependenciesMeta: + '@types/react': + optional: true + immer: + optional: true + react: + optional: true + use-sync-external-store: + optional: true + dependencies: + '@types/react': 18.3.18 + react: 18.3.1 + dev: false From 574286139c5783de2da4b244b3a720623fa14311 Mon Sep 17 00:00:00 2001 From: bicochan Date: Mon, 17 Mar 2025 15:24:58 +0900 Subject: [PATCH 3/4] =?UTF-8?q?feat:=20sidebar=20=EC=BB=B4=ED=8F=AC?= =?UTF-8?q?=EB=84=8C=ED=8A=B8=20=EC=83=9D=EC=84=B1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/common/assets/src/styles/base.css | 16 + packages/common/components/package.json | 2 + .../components/src/hooks/use-mobile.tsx | 21 + .../components/src/ui/separator/index.tsx | 29 + .../common/components/src/ui/sheet/index.tsx | 140 ++++ .../components/src/ui/sidebar/index.tsx | 779 ++++++++++++++++++ .../components/src/ui/skeleton/index.tsx | 15 + .../components/src/ui/tooltip/index.tsx | 28 + pnpm-lock.yaml | 57 ++ tailwind.config.preset.ts | 10 + 10 files changed, 1097 insertions(+) create mode 100644 packages/common/components/src/hooks/use-mobile.tsx create mode 100644 packages/common/components/src/ui/separator/index.tsx create mode 100644 packages/common/components/src/ui/sheet/index.tsx create mode 100644 packages/common/components/src/ui/sidebar/index.tsx create mode 100644 packages/common/components/src/ui/skeleton/index.tsx create mode 100644 packages/common/components/src/ui/tooltip/index.tsx diff --git a/packages/common/assets/src/styles/base.css b/packages/common/assets/src/styles/base.css index 8a33518bc..a99b29843 100644 --- a/packages/common/assets/src/styles/base.css +++ b/packages/common/assets/src/styles/base.css @@ -32,6 +32,14 @@ --chart-5: #ff7865; --chart-6: #e65db5; --radius: 1rem; + --sidebar-background: 0 0% 98%; + --sidebar-foreground: 240 5.3% 26.1%; + --sidebar-primary: 240 5.9% 10%; + --sidebar-primary-foreground: 0 0% 98%; + --sidebar-accent: 240 4.8% 95.9%; + --sidebar-accent-foreground: 240 5.9% 10%; + --sidebar-border: 220 13% 91%; + --sidebar-ring: 217.2 91.2% 59.8%; --field: #fff; --form: #fff; --container: #f1f6f9; @@ -66,6 +74,14 @@ --chart-5: #ffbcad; --chart-6: #f4a0d3; --radius: 1rem; + --sidebar-background: 240 5.9% 10%; + --sidebar-foreground: 240 4.8% 95.9%; + --sidebar-primary: 224.3 76.3% 48%; + --sidebar-primary-foreground: 0 0% 100%; + --sidebar-accent: 240 3.7% 15.9%; + --sidebar-accent-foreground: 240 4.8% 95.9%; + --sidebar-border: 240 3.7% 15.9%; + --sidebar-ring: 217.2 91.2% 59.8%; --field: #5b6269; --form: #1a1a1a; --container: #0a0a0a; diff --git a/packages/common/components/package.json b/packages/common/components/package.json index 7c04950f7..7556b9738 100644 --- a/packages/common/components/package.json +++ b/packages/common/components/package.json @@ -35,10 +35,12 @@ "@radix-ui/react-popover": "^1.1.6", "@radix-ui/react-radio-group": "^1.2.2", "@radix-ui/react-select": "^2.1.6", + "@radix-ui/react-separator": "^1.1.2", "@radix-ui/react-slider": "^1.2.3", "@radix-ui/react-slot": "^1.1.2", "@radix-ui/react-switch": "^1.1.3", "@radix-ui/react-tabs": "^1.1.3", + "@radix-ui/react-tooltip": "^1.1.8", "@radix-ui/react-visually-hidden": "^1.1.2", "@tanstack/react-query": "^5.67.1", "@tanstack/react-table": "^8.21.2", diff --git a/packages/common/components/src/hooks/use-mobile.tsx b/packages/common/components/src/hooks/use-mobile.tsx new file mode 100644 index 000000000..a93d58393 --- /dev/null +++ b/packages/common/components/src/hooks/use-mobile.tsx @@ -0,0 +1,21 @@ +import * as React from "react"; + +const MOBILE_BREAKPOINT = 768; + +export function useIsMobile() { + const [isMobile, setIsMobile] = React.useState( + undefined, + ); + + React.useEffect(() => { + const mql = window.matchMedia(`(max-width: ${MOBILE_BREAKPOINT - 1}px)`); + const onChange = () => { + setIsMobile(window.innerWidth < MOBILE_BREAKPOINT); + }; + mql.addEventListener("change", onChange); + setIsMobile(window.innerWidth < MOBILE_BREAKPOINT); + return () => mql.removeEventListener("change", onChange); + }, []); + + return !!isMobile; +} diff --git a/packages/common/components/src/ui/separator/index.tsx b/packages/common/components/src/ui/separator/index.tsx new file mode 100644 index 000000000..79b37ace3 --- /dev/null +++ b/packages/common/components/src/ui/separator/index.tsx @@ -0,0 +1,29 @@ +import * as React from "react"; +import * as SeparatorPrimitive from "@radix-ui/react-separator"; + +import { cn } from "../../lib/utils"; + +const Separator = React.forwardRef< + React.ElementRef, + React.ComponentPropsWithoutRef +>( + ( + { className, orientation = "horizontal", decorative = true, ...props }, + ref, + ) => ( + + ), +); +Separator.displayName = SeparatorPrimitive.Root.displayName; + +export { Separator }; diff --git a/packages/common/components/src/ui/sheet/index.tsx b/packages/common/components/src/ui/sheet/index.tsx new file mode 100644 index 000000000..10a35d74c --- /dev/null +++ b/packages/common/components/src/ui/sheet/index.tsx @@ -0,0 +1,140 @@ +"use client"; + +import * as React from "react"; +import * as SheetPrimitive from "@radix-ui/react-dialog"; +import { cva, type VariantProps } from "class-variance-authority"; +import { X } from "lucide-react"; + +import { cn } from "../../lib/utils"; + +const Sheet = SheetPrimitive.Root; + +const SheetTrigger = SheetPrimitive.Trigger; + +const SheetClose = SheetPrimitive.Close; + +const SheetPortal = SheetPrimitive.Portal; + +const SheetOverlay = React.forwardRef< + React.ElementRef, + React.ComponentPropsWithoutRef +>(({ className, ...props }, ref) => ( + +)); +SheetOverlay.displayName = SheetPrimitive.Overlay.displayName; + +const sheetVariants = cva( + "fixed z-50 gap-4 bg-background p-6 shadow-lg transition ease-in-out data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:duration-300 data-[state=open]:duration-500", + { + variants: { + side: { + top: "inset-x-0 top-0 border-b data-[state=closed]:slide-out-to-top data-[state=open]:slide-in-from-top", + bottom: + "inset-x-0 bottom-0 border-t data-[state=closed]:slide-out-to-bottom data-[state=open]:slide-in-from-bottom", + left: "inset-y-0 left-0 h-full w-3/4 border-r data-[state=closed]:slide-out-to-left data-[state=open]:slide-in-from-left sm:max-w-sm", + right: + "inset-y-0 right-0 h-full w-3/4 border-l data-[state=closed]:slide-out-to-right data-[state=open]:slide-in-from-right sm:max-w-sm", + }, + }, + defaultVariants: { + side: "right", + }, + }, +); + +interface SheetContentProps + extends React.ComponentPropsWithoutRef, + VariantProps {} + +const SheetContent = React.forwardRef< + React.ElementRef, + SheetContentProps +>(({ side = "right", className, children, ...props }, ref) => ( + + + + {children} + + + Close + + + +)); +SheetContent.displayName = SheetPrimitive.Content.displayName; + +const SheetHeader = ({ + className, + ...props +}: React.HTMLAttributes) => ( +
+); +SheetHeader.displayName = "SheetHeader"; + +const SheetFooter = ({ + className, + ...props +}: React.HTMLAttributes) => ( +
+); +SheetFooter.displayName = "SheetFooter"; + +const SheetTitle = React.forwardRef< + React.ElementRef, + React.ComponentPropsWithoutRef +>(({ className, ...props }, ref) => ( + +)); +SheetTitle.displayName = SheetPrimitive.Title.displayName; + +const SheetDescription = React.forwardRef< + React.ElementRef, + React.ComponentPropsWithoutRef +>(({ className, ...props }, ref) => ( + +)); +SheetDescription.displayName = SheetPrimitive.Description.displayName; + +export { + Sheet, + SheetPortal, + SheetOverlay, + SheetTrigger, + SheetClose, + SheetContent, + SheetHeader, + SheetFooter, + SheetTitle, + SheetDescription, +}; diff --git a/packages/common/components/src/ui/sidebar/index.tsx b/packages/common/components/src/ui/sidebar/index.tsx new file mode 100644 index 000000000..eee581419 --- /dev/null +++ b/packages/common/components/src/ui/sidebar/index.tsx @@ -0,0 +1,779 @@ +import * as React from "react"; +import { Slot } from "@radix-ui/react-slot"; +import { type VariantProps, cva } from "class-variance-authority"; +import { PanelLeft } from "lucide-react"; + +import { useIsMobile } from "../../hooks/use-mobile"; +import { cn } from "../../lib/utils"; +import { Button } from "../button"; +import { Input } from "../input"; +import { Separator } from "../separator"; +import { + Sheet, + SheetContent, + SheetDescription, + SheetHeader, + SheetTitle, +} from "../sheet"; +import { Skeleton } from "../skeleton"; +import { + Tooltip, + TooltipContent, + TooltipProvider, + TooltipTrigger, +} from "../tooltip"; + +const SIDEBAR_COOKIE_NAME = "sidebar_state"; +const SIDEBAR_COOKIE_MAX_AGE = 60 * 60 * 24 * 7; +const SIDEBAR_WIDTH = "16rem"; +const SIDEBAR_WIDTH_MOBILE = "18rem"; +const SIDEBAR_WIDTH_ICON = "3rem"; +const SIDEBAR_KEYBOARD_SHORTCUT = "b"; + +type SidebarContextProps = { + state: "expanded" | "collapsed"; + open: boolean; + setOpen: (open: boolean) => void; + openMobile: boolean; + setOpenMobile: (open: boolean) => void; + isMobile: boolean; + toggleSidebar: () => void; +}; + +const SidebarContext = React.createContext(null); + +function useSidebar() { + const context = React.useContext(SidebarContext); + if (!context) { + throw new Error("useSidebar must be used within a SidebarProvider."); + } + + return context; +} + +const SidebarProvider = React.forwardRef< + HTMLDivElement, + React.ComponentProps<"div"> & { + defaultOpen?: boolean; + open?: boolean; + onOpenChange?: (open: boolean) => void; + } +>( + ( + { + defaultOpen = true, + open: openProp, + onOpenChange: setOpenProp, + className, + style, + children, + ...props + }, + ref, + ) => { + const isMobile = useIsMobile(); + const [openMobile, setOpenMobile] = React.useState(false); + + // This is the internal state of the sidebar. + // We use openProp and setOpenProp for control from outside the component. + const [_open, _setOpen] = React.useState(defaultOpen); + const open = openProp ?? _open; + const setOpen = React.useCallback( + (value: boolean | ((value: boolean) => boolean)) => { + const openState = typeof value === "function" ? value(open) : value; + if (setOpenProp) { + setOpenProp(openState); + } else { + _setOpen(openState); + } + + // This sets the cookie to keep the sidebar state. + document.cookie = `${SIDEBAR_COOKIE_NAME}=${openState}; path=/; max-age=${SIDEBAR_COOKIE_MAX_AGE}`; + }, + [setOpenProp, open], + ); + + // Helper to toggle the sidebar. + const toggleSidebar = React.useCallback(() => { + return isMobile + ? setOpenMobile((open) => !open) + : setOpen((open) => !open); + }, [isMobile, setOpen, setOpenMobile]); + + // Adds a keyboard shortcut to toggle the sidebar. + React.useEffect(() => { + const handleKeyDown = (event: KeyboardEvent) => { + if ( + event.key === SIDEBAR_KEYBOARD_SHORTCUT && + (event.metaKey || event.ctrlKey) + ) { + event.preventDefault(); + toggleSidebar(); + } + }; + + window.addEventListener("keydown", handleKeyDown); + return () => window.removeEventListener("keydown", handleKeyDown); + }, [toggleSidebar]); + + // We add a state so that we can do data-state="expanded" or "collapsed". + // This makes it easier to style the sidebar with Tailwind classes. + const state = open ? "expanded" : "collapsed"; + + const contextValue = React.useMemo( + () => ({ + state, + open, + setOpen, + isMobile, + openMobile, + setOpenMobile, + toggleSidebar, + }), + [ + state, + open, + setOpen, + isMobile, + openMobile, + setOpenMobile, + toggleSidebar, + ], + ); + + return ( + + +
+ {children} +
+ + + ); + }, +); +SidebarProvider.displayName = "SidebarProvider"; + +const Sidebar = React.forwardRef< + HTMLDivElement, + React.ComponentProps<"div"> & { + side?: "left" | "right"; + variant?: "sidebar" | "floating" | "inset"; + collapsible?: "offcanvas" | "icon" | "none"; + } +>( + ( + { + side = "left", + variant = "sidebar", + collapsible = "offcanvas", + className, + children, + ...props + }, + ref, + ) => { + const { isMobile, state, openMobile, setOpenMobile } = useSidebar(); + + if (collapsible === "none") { + return ( +
+ {children} +
+ ); + } + + if (isMobile) { + return ( + + + + Sidebar + Displays the mobile sidebar. + +
{children}
+ + + ); + } + + return ( +
+ {/* This is what handles the sidebar gap on desktop */} +
+ +
+ ); + }, +); +Sidebar.displayName = "Sidebar"; + +const SidebarTrigger = React.forwardRef< + React.ElementRef, + React.ComponentProps +>(({ className, onClick, ...props }, ref) => { + const { toggleSidebar } = useSidebar(); + + return ( + + ); +}); +SidebarTrigger.displayName = "SidebarTrigger"; + +const SidebarRail = React.forwardRef< + HTMLButtonElement, + React.ComponentProps<"button"> +>(({ className, ...props }, ref) => { + const { toggleSidebar } = useSidebar(); + + return ( +