diff --git a/src/constants/AUTH_EVENTS.ts b/src/constants/AUTH_EVENTS.ts index ebadcfea5..4c9ecb916 100644 --- a/src/constants/AUTH_EVENTS.ts +++ b/src/constants/AUTH_EVENTS.ts @@ -1 +1,10 @@ +/** + * 로그인 성공 등 인증 흐름에서 `window`로 주고받는 `CustomEvent` 이름입니다. + * + * @author hyungjun + */ + +/** 이메일·카카오 로그인 등에서 `new CustomEvent(AUTH_LOGIN_SUCCESS_EVENT)`로 발생시키고, + * SSE 등 후속 연결 로직에서 `addEventListener`로 구독합니다. + */ export const AUTH_LOGIN_SUCCESS_EVENT = "authLoginSuccess"; diff --git a/src/constants/DEFAULT_LAT_LNG.ts b/src/constants/DEFAULT_LAT_LNG.ts deleted file mode 100644 index a4cb63cce..000000000 --- a/src/constants/DEFAULT_LAT_LNG.ts +++ /dev/null @@ -1 +0,0 @@ -export { DEFAULT_LAT_LNG, DEFAULT_ADDRESS } from "./DEFAULT_MAP_DATA"; diff --git a/src/constants/DEFAULT_MAP_DATA.ts b/src/constants/DEFAULT_MAP_DATA.ts index bd4549f89..0e19a1d96 100644 --- a/src/constants/DEFAULT_MAP_DATA.ts +++ b/src/constants/DEFAULT_MAP_DATA.ts @@ -1,2 +1,17 @@ +/** + * 기본 지도 중심 좌표·주소 상수 모음입니다. + * + * @author hyungjun + */ + +/** + * GPS 미허용·복원 전 등 지도 중심이 정해지지 않았을 때 사용하는 기본 좌표(서울 시청 인근). + * {@link DEFAULT_ADDRESS}와 동일한 행정구역을 가리키도록 맞춘 값입니다. + */ export const DEFAULT_LAT_LNG = { lat: 37.5665, lng: 126.978 }; + +/** + * {@link DEFAULT_LAT_LNG}에 대응하는 기본 주소 문자열. + * 검색 UI 플레이스홀더·역지오코딩 전 표시 등에 사용됩니다. + */ export const DEFAULT_ADDRESS = "서울특별시 중구"; diff --git a/src/constants/GEO_SESSION.ts b/src/constants/GEO_SESSION.ts index e54106d12..6d6708545 100644 --- a/src/constants/GEO_SESSION.ts +++ b/src/constants/GEO_SESSION.ts @@ -1,2 +1,8 @@ -/** 메인 지도에서 브라우저 위치 권한이 한 번이라도 성공한 뒤 세션 동안 바텀시트를 생략하기 위한 키 */ +/** + * 메인 지도 위치 권한·유도 UI와 연동되는 `sessionStorage` 키 상수입니다. + * + * @author hyungjun + */ + +/** 브라우저에서 위치 권한으로 좌표를 한 번이라도 성공적으로 받았는지 표시할 때 쓰는 `sessionStorage` 키 문자열입니다. */ export const MAIN_GEO_SESSION_KEY = "fmi-main-geolocation-confirmed"; diff --git a/src/constants/RELEASE_HOSTNAME.ts b/src/constants/RELEASE_HOSTNAME.ts index 30cc1de55..a7bc77e56 100644 --- a/src/constants/RELEASE_HOSTNAME.ts +++ b/src/constants/RELEASE_HOSTNAME.ts @@ -1 +1,10 @@ +/** + * release 환경의 `window.location.hostname`과 비교할 때 쓰는 호스트명 상수입니다. + * + * @author hyungjun + */ + +/** SSE·채팅 소켓 등에서 로컬과 유사하게 same-origin 프록시를 쓰거나, + * 개발용 토큰 전달 분기 등에 `window.location.hostname`과 직접 비교합니다. + */ export const RELEASE_HOSTNAME = "finditem-release.vercel.app"; diff --git a/src/constants/WEB_PUSH.ts b/src/constants/WEB_PUSH.ts index 9011feb3a..46c6ea948 100644 --- a/src/constants/WEB_PUSH.ts +++ b/src/constants/WEB_PUSH.ts @@ -10,13 +10,13 @@ */ /** - * pickVapidPublicKey: 알려진 필드명이 없을 때, 값이 VAPID 공개키(일반적으로 URL-safe Base64)로 - * 보이는지 판별하기 위한 최소 문자열 길이 휴리스틱입니다. + * pickVapidPublicKey: 알려진 필드명이 없을 때, + * 값이 VAPID 공개키(일반적으로 URL-safe Base64)로 보이는지 판별하기 위한 최소 문자열 길이 휴리스틱입니다. */ export const VAPID_PUBLIC_KEY_STRING_MIN_LENGTH_HEURISTIC = 80; /** - * 로그아웃 API 호출 전 푸시 구독 해제(DELETE) 대기 상한(ms). + * 로그아웃 API 호출 전 푸시 구독 해제(DELETE) 대기 상한(ms) * 초과 시 로그아웃은 진행하며, 이미 세션이 끊긴 뒤에는 구독 해제가 실패할 수 있습니다. */ export const WEB_PUSH_UNSUBSCRIBE_BEFORE_LOGOUT_TIMEOUT_MS = 4_000;