@owp/core 2.5.45 → 2.5.48

package/dist/types/hooks/useCommonCodeList.d.ts

@@ -1,19 +1,27 @@
 import type { CommonCode } from '@/utils/commonCodeUtils';
 type CommonCodeQueryKey = 'IPX_COMMONCODE.CODEID' | 'IPX_COMMONCODE.GROUPID' | 'IPX_COMMONCODE.DESCRIPTION' | 'IPX_COMMONCODE.FLAG';
+/**
+ * 공통코드 필터 query 타입
+ */
 export type CommonCodeQuery = Partial<Pick<CommonCode, CommonCodeQueryKey>>;
+/**
+ * 공통코드 목록 필터링 옵션
+ */
 export interface UseFilteredCommonCodeListProps {
+    /** CODEID/GROUPID/DESCRIPTION/FLAG 기준 필터 조건 */
     query?: CommonCodeQuery;
+    /** false면 조회 결과를 빈 배열로 고정 */
     enabled?: boolean;
 }
 /**
- * 공통코드 목록 조회 훅
+ * storage-backed 공통코드 group map 조회 Hook
  */
 export declare const useGetCommonCodeList: () => {
     [codeId: string]: CommonCode[];
 };
 /**
- * 조건 기반 공통코드 목록 조회 훅
- * @param props 조회 옵션
+ * 전역 공통코드 목록에서 query 조건과 일치하는 row 목록을 반환하는 Hook
+ * @param props 필터 조건과 활성화 여부
  * @param props.query 공통코드 필터 조건
  * @param props.enabled 조회 활성화 여부
  */
@@ -22,7 +30,7 @@ export declare const useFilteredCommonCodeList: ({ query, enabled, }?: UseFilter
     isLoading: boolean;
 };
 /**
- * 공통코드 목록 설정 훅
+ * storage-backed 공통코드 group map setter Hook
  */
 export declare const useSetCommonCodeList: () => (args_0: typeof import("jotai/utils").RESET | {
     [codeId: string]: CommonCode[];

package/dist/types/hooks/useConfirm.d.ts

@@ -1,13 +1,17 @@
 import type { OwpAlertDialogPayload } from '@/components/OwpDialog';
 import type { ButtonProps } from '@mui/material';
+/**
+ * confirm 계열 dialog 호출 옵션
+ */
 export interface ConfirmProps extends Omit<OwpAlertDialogPayload, 'cancelButtonProps'> {
+    /** dialog close 후 결과를 받을 optional callback */
     onClose?: (result: boolean) => Promise<void>;
 }
 interface ConfirmBaseProps extends ConfirmProps {
     cancelButtonProps?: ButtonProps;
 }
 /**
- * 확인 대화상자 훅
+ * alert dialog 기반 confirm helper 묶음
  */
 export declare const useConfirm: () => {
     confirm: (props: ConfirmBaseProps) => Promise<boolean>;

package/dist/types/hooks/useCurrentUser.d.ts

@@ -1,11 +1,14 @@
+/**
+ * storage에 보관되는 현재 사용자 정보
+ */
 export interface CurrentUser {
     [key: string]: any;
 }
 /**
- * 현재 사용자 정보 조회
+ * storage-backed 현재 사용자 정보 조회 Hook
  */
 export declare const useGetCurrentUser: () => CurrentUser;
 /**
- * 현재 사용자 정보 설정
+ * storage-backed 현재 사용자 정보 setter Hook
  */
 export declare const useSetCurrentUser: () => (args_0: typeof import("jotai/utils").RESET | CurrentUser | ((prev: CurrentUser) => typeof import("jotai/utils").RESET | CurrentUser)) => void;

package/dist/types/hooks/useCurrentUserId.d.ts

@@ -1,8 +1,8 @@
 /**
- * 현재 사용자 ID 조회 훅
+ * storage-backed 현재 사용자 ID 조회 Hook
  */
 export declare const useGetCurrentUserId: () => string;
 /**
- * 현재 사용자 ID 설정 훅
+ * storage-backed 현재 사용자 ID setter Hook
  */
 export declare const useSetCurrentUserId: () => (args_0: string | typeof import("jotai/utils").RESET | ((prev: string) => string | typeof import("jotai/utils").RESET)) => void;

package/dist/types/hooks/useCurrentUserSeq.d.ts

@@ -1,17 +1,24 @@
+/**
+ * 현재 사용자 USERSEQ 값 타입
+ */
 export type CurrentUserSeq = string | number;
+/**
+ * USERSEQ 필수 검증 옵션
+ */
 export interface UseEnsureCurrentUserSeqOptions {
+    /** USERSEQ가 없을 때 표시할 snackbar translation key */
     snackbarMessageKey?: string;
 }
 /**
- * 현재 사용자 USERSEQ 조회 훅
+ * storage-backed 현재 사용자 USERSEQ 조회 Hook
  */
 export declare const useGetCurrentUserSeq: () => CurrentUserSeq;
 /**
- * 현재 사용자 USERSEQ 설정 훅
+ * storage-backed 현재 사용자 USERSEQ setter Hook
  */
 export declare const useSetCurrentUserSeq: () => (args_0: typeof import("jotai/utils").RESET | CurrentUserSeq | ((prev: CurrentUserSeq) => typeof import("jotai/utils").RESET | CurrentUserSeq)) => void;
 /**
- * 현재 사용자 USERSEQ 필수 검증 훅
- * @param snackbarMessageKey 사용자 정보 부재 안내 메시지 키
+ * USERSEQ가 없으면 snackbar를 표시하고 undefined를 반환하는 guard 함수 생성 Hook
+ * @param options 사용자 정보 부재 안내 메시지 key
  */
 export declare const useEnsureCurrentUserSeq: ({ snackbarMessageKey, }?: UseEnsureCurrentUserSeqOptions) => () => CurrentUserSeq;

package/dist/types/hooks/useFormDataUploadMutation.d.ts

@@ -1,30 +1,45 @@
 import { createFormDataBody, type FormDataUploadBody, type FormDataUploadParams, type TAdditionalFields } from '@/utils/createFormDataBody';
 export type { FormDataFieldValue, FormDataUploadBody, FormDataUploadParams, TAdditionalFields, } from '@/utils/createFormDataBody';
 type FormDataUploadMutationLike = {
-    mutate: (...args: any[]) => void;
+    mutate: (...args: unknown[]) => void;
 };
 type FormDataUploadMutationMutateParameters<TMutation extends FormDataUploadMutationLike> = Parameters<TMutation['mutate']>;
 type FormDataUploadMutationVariables<TMutation extends FormDataUploadMutationLike> = FormDataUploadMutationMutateParameters<TMutation>[0];
 type FormDataUploadMutateOptions<TMutation extends FormDataUploadMutationLike> = FormDataUploadMutationMutateParameters<TMutation>[1];
+/**
+ * FormData upload mutation 변수 생성기에 전달되는 인자
+ */
 export interface FormDataUploadMutationVariablesArgs<TFields extends TAdditionalFields = TAdditionalFields> {
+    /** 정규화된 upload body */
     body: FormDataUploadBody<TFields>;
+    /** 기본 serializer로 생성된 FormData */
     formData: FormData;
+    /** body를 FormData로 변환하는 기본 serializer */
     bodySerializer: typeof createFormDataBody;
 }
 interface UseFormDataUploadMutationBaseProps<TMutation extends FormDataUploadMutationLike> {
     mutation: TMutation;
     fileNameFieldName?: string;
 }
+/**
+ * FormData upload mutation hook props
+ */
 export type UseFormDataUploadMutationProps<TMutation extends FormDataUploadMutationLike, TFields extends TAdditionalFields = TAdditionalFields> = FormDataUploadMutationVariables<TMutation> extends FormData ? UseFormDataUploadMutationBaseProps<TMutation> & {
+    /** mutation variables가 FormData이면 생략 가능한 variables 생성기 */
     createVariables?: (args: FormDataUploadMutationVariablesArgs<TFields>) => FormDataUploadMutationVariables<TMutation>;
 } : UseFormDataUploadMutationBaseProps<TMutation> & {
+    /** mutation variables가 FormData가 아닐 때 필수 variables 생성기 */
     createVariables: (args: FormDataUploadMutationVariablesArgs<TFields>) => FormDataUploadMutationVariables<TMutation>;
 };
+/**
+ * 원본 mutation 객체에 `uploadFile` helper를 더한 반환 타입
+ */
 export type UseFormDataUploadMutationResult<TMutation extends FormDataUploadMutationLike, TFields extends TAdditionalFields = TAdditionalFields> = TMutation & {
+    /** file/additionalFields 입력을 mutation variables로 변환해 mutate 호출 */
     uploadFile: (params: FormDataUploadParams<TFields>, options?: FormDataUploadMutateOptions<TMutation>) => void;
 };
 /**
- * FormData 업로드 mutation 어댑터 훅
- * @param props mutation 객체 및 변수 생성기
+ * file upload 입력을 FormData 기반 mutation 호출로 변환하는 adapter Hook
+ * @param props mutation 객체, variables 생성기, file name field 설정
  */
 export declare const useFormDataUploadMutation: <TMutation extends FormDataUploadMutationLike, TFields extends TAdditionalFields = TAdditionalFields>(props: UseFormDataUploadMutationProps<TMutation, TFields>) => UseFormDataUploadMutationResult<TMutation, TFields>;

package/dist/types/hooks/useInitApp.d.ts

@@ -1,10 +1,14 @@
+/**
+ * app bootstrap 초기화 옵션
+ */
 export interface UseInitAppOptions {
+    /** 초기 로고 이미지 경로 */
     logoSrc: string;
+    /** document title로 설정할 제목 */
     title?: string;
 }
 /**
- * 앱 기본 상태 초기화 훅
- * @param logoSrc 초기 로고 경로
- * @param title 문서 제목
+ * OWP app 진입 시 logo, title, navigation, 공통코드, page loading 상태를 초기화하는 Hook
+ * @param options 초기 로고 경로와 document title
  */
 export declare const useInitApp: ({ logoSrc, title }: UseInitAppOptions) => void;

package/dist/types/hooks/useLogoSrc.d.ts

@@ -1,8 +1,8 @@
 /**
- * 현재 로고 경로 조회 훅
+ * storage-backed 현재 로고 경로 조회 Hook
  */
 export declare const useGetLogoSrc: () => string;
 /**
- * 현재 로고 경로 설정 훅
+ * storage-backed 현재 로고 경로 setter Hook
  */
 export declare const useSetLogoSrc: () => (args_0: string | typeof import("jotai/utils").RESET | ((prev: string) => string | typeof import("jotai/utils").RESET)) => void;

package/dist/types/hooks/useNavigation.d.ts

@@ -1,9 +1,9 @@
 import type { OwpNavItemType } from '@/types/OwpNavigationTypes';
 /**
- * 내비게이션 목록 조회 훅
+ * storage-backed navigation 목록 조회 Hook
  */
 export declare const useGetNavigationList: () => OwpNavItemType[];
 /**
- * 내비게이션 목록 설정 훅
+ * storage-backed navigation 목록 setter Hook
  */
 export declare const useSetNavigationList: () => (args_0: OwpNavItemType[] | typeof import("jotai/utils").RESET | ((prev: OwpNavItemType[]) => OwpNavItemType[] | typeof import("jotai/utils").RESET)) => void;

package/dist/types/hooks/useOwpSettings.d.ts

@@ -2,19 +2,19 @@ import type { OwpSettingsConfigType } from '@/types/OwpSettingsTypes';
 import type { OwpSettingsState } from '@/store/atoms/internal/types';
 import type { PartialDeep } from 'type-fest';
 /**
- * OWP settings 원본 상태 조회 훅
+ * defaults/current를 포함한 OWP settings 전체 atom 조회 Hook
  */
 export declare const useGetOwpSettings: () => OwpSettingsState;
 /**
- * 현재 settings 조회 훅
+ * 현재 적용 중인 OWP settings 조회 Hook
  */
 export declare const useGetCurrentSettings: () => OwpSettingsConfigType;
 /**
- * 기본 settings 조회 훅
+ * default 기준 OWP settings 조회 Hook
  */
 export declare const useGetDefaultSettings: () => OwpSettingsConfigType;
 /**
- * 현재 layout config 조회 훅
+ * 현재 settings의 layout config 조회 Hook
  */
 export declare const useGetCurrentLayoutConfig: () => {
     mode?: string;
@@ -36,38 +36,38 @@ export declare const useGetCurrentLayoutConfig: () => {
     };
 };
 /**
- * Main theme 조회 훅
+ * 현재 settings 기준 main MUI theme 조회 Hook
  */
 export declare const useGetMainTheme: () => import("@mui/material").Theme;
 /**
- * Navbar theme 조회 훅
+ * 현재 settings 기준 navbar MUI theme 조회 Hook
  */
 export declare const useGetNavbarTheme: () => import("@mui/material").Theme;
 /**
- * Toolbar theme 조회 훅
+ * 현재 settings 기준 toolbar MUI theme 조회 Hook
  */
 export declare const useGetToolbarTheme: () => import("@mui/material").Theme;
 /**
- * Footer theme 조회 훅
+ * 현재 settings 기준 footer MUI theme 조회 Hook
  */
 export declare const useGetFooterTheme: () => import("@mui/material").Theme;
 /**
- * Custom scrollbar 사용 여부 조회 훅
+ * 현재 settings의 custom scrollbar 사용 여부 조회 Hook
  */
 export declare const useGetCustomScrollbarsEnabled: () => boolean;
 /**
- * 현재 settings 설정 훅
+ * 현재 OWP settings를 교체하는 setter Hook
  */
 export declare const useSetSettings: () => (nextSettings: OwpSettingsConfigType) => void;
 /**
- * 기본 settings 설정 훅
+ * default settings를 partial deep merge로 변경하는 setter Hook
  */
 export declare const useSetDefaultSettings: () => (nextSettings: PartialDeep<OwpSettingsConfigType>) => OwpSettingsState;
 /**
- * Settings 초기화 훅
+ * 현재 settings를 defaults 기준으로 되돌리는 setter Hook
  */
 export declare const useResetSettings: () => () => void;
 /**
- * Theme 설정 변경 훅
+ * main/navbar/toolbar/footer theme set을 한 번에 변경하는 setter Hook
  */
 export declare const useChangeOwpTheme: () => (theme: import("@/types/OwpSettingsTypes").OwpThemesType) => OwpSettingsState;

package/dist/types/hooks/useOwpTranslation.d.ts

@@ -1,5 +1,5 @@
 /**
- * OWP 번역 훅
+ * OWP Translation namespace와 key 기반 defaultValue 보강을 제공하는 Hook
  */
 export declare const useOwpTranslation: () => {
     0: import("i18next").TFunction<"owp", undefined>;

package/dist/types/hooks/usePageLockLoading.d.ts

@@ -1,10 +1,10 @@
 import type { OwpPageLockLoadingProps } from '@/components/OwpPageLockLoading';
 /**
- * 페이지 잠금 로딩 상태 조회
+ * storage-backed page lock loading 상태 조회 Hook
  */
 export declare const useGetPageLockLoading: () => OwpPageLockLoadingProps;
 /**
- * 페이지 잠금 로딩 상태 설정
+ * page lock loading 상태 setter를 반환하는 Hook
  */
 export declare const usePageLockLoading: () => {
     setLoading: (args_0: typeof import("jotai/utils").RESET | OwpPageLockLoadingProps | ((prev: OwpPageLockLoadingProps) => typeof import("jotai/utils").RESET | OwpPageLockLoadingProps)) => void;

package/dist/types/hooks/useStorage.d.ts

@@ -1,5 +1,9 @@
-export type StorageEnv = {
-    [key: string]: any;
+/**
+ * OWP app 환경값 storage payload
+ */
+export type StorageEnv = Record<string, unknown> & {
+    /** API base URL */
+    apiBaseUrl?: string;
 };
 /**
  * 앱 환경값 저장
@@ -7,11 +11,13 @@ export type StorageEnv = {
  */
 export declare const setEnv: (env: StorageEnv) => void;
 /**
- * 앱 환경값 조회
+ * storage에 저장된 OWP app 환경값 조회
+ * @returns 객체가 아니거나 파싱 실패 시 빈 객체
  */
 export declare const getEnv: () => StorageEnv;
 /**
- * 스토리지 유틸 훅
+ * OWP storage helper Hook
+ * @returns 보존 대상 key를 제외하고 storage를 초기화하는 함수와 env getter/setter
  */
 export declare const useStorage: () => {
     resetStorage: () => void;

package/dist/types/hooks/useTreeGridCommonCodeEnums.d.ts

@@ -1,14 +1,14 @@
 /**
- * TreeGrid 공통코드 Enum 옵션 정보
- * @param field Enum을 반영할 컬럼명
- * @param codeId 공통코드 그룹 ID
+ * 공통코드를 TreeGrid column Enum option으로 반영하기 위한 설정
  */
 export interface TreeGridCommonCodeEnumConfig {
+    /** Enum을 반영할 TreeGrid column key */
     field: string;
+    /** 공통코드 group id */
     codeId: string;
 }
 /**
- * TreeGrid 공통코드 Enum 옵션 일괄 반영
+ * 전역 공통코드 cache를 TreeGrid column Enum option으로 일괄 반영하는 Hook
  * @param id TreeGrid 인스턴스 ID
  * @param configs Enum 반영 대상 목록
  * @param isGridReady TreeGrid 준비 여부

package/dist/types/hooks/useTreeGridEnums.d.ts

@@ -1,19 +1,19 @@
 type TreeGridEnumOption = Record<string, unknown>;
 /**
- * TreeGrid 임의 Enum 옵션 정보
- * @param field Enum을 반영할 컬럼명
- * @param options Enum 옵션 목록
- * @param valueKey Enum 값으로 사용할 필드명
- * @param labelKeys Enum 라벨로 사용할 필드 우선순위 목록
+ * TreeGrid column Enum option 반영 설정
  */
 export interface TreeGridEnumConfig<T extends TreeGridEnumOption> {
+    /** Enum을 반영할 TreeGrid column key */
     field: string;
+    /** Enum option 원본 목록 */
     options?: T[];
+    /** Enum value로 사용할 option field key */
     valueKey: keyof T & string;
+    /** Enum label 후보 field key 우선순위 */
     labelKeys: Array<keyof T & string>;
 }
 /**
- * TreeGrid 임의 Enum 옵션 일괄 반영
+ * TreeGrid instance가 준비되면 지정 column에 Enum option을 일괄 반영하는 Hook
  * @param id TreeGrid 인스턴스 ID
  * @param configs Enum 반영 대상 목록
  * @param isGridReady TreeGrid 준비 여부

package/dist/types/hooks/useTreeGridExcelExport.d.ts

@@ -1,7 +1,10 @@
 import type { ExportTreeGridExcelOptions } from '@/utils/treeGridExportExcelUtil';
+/**
+ * TreeGrid Excel export 옵션 또는 다운로드 파일명
+ */
 export type UseTreeGridExcelExportOptions = Omit<ExportTreeGridExcelOptions, 't'> | string;
 /**
- * TreeGrid 엑셀 내보내기 훅
+ * TreeGrid instance id로 Excel export 함수를 지연 로드해 실행하는 Hook
  * @param gridId TreeGrid 인스턴스 ID
  */
 export declare const useTreeGridExcelExport: (gridId: string) => {

package/dist/types/layout/Layout.d.ts

@@ -1,5 +1,5 @@
 import { LayoutConfigDefaultsType } from '@/configs/layoutConfig';
-import { ReactNode } from 'react';
+import { type ReactNode } from 'react';
 type LayoutProps = {
     layoutConfig?: LayoutConfigDefaultsType;
     children?: ReactNode;

package/dist/types/layout/components/navbar/NavbarToggleButton.d.ts

@@ -1,11 +1,12 @@
 import { type IconButtonProps } from '@mui/material/IconButton';
-import { ReactNode } from 'react';
+import type { ReactNode } from 'react';
+/** Navbar 접힘/모바일 열림을 토글하는 icon button 속성 */
 export type NavbarToggleButtonProps = IconButtonProps & {
+    /** 배경 surface에 맞춘 버튼 tone */
     surfaceTone?: 'inherit' | 'light';
+    /** hover 시 표시할 tooltip title */
     tooltipTitle?: ReactNode;
 };
-/**
- * The navbar toggle button.
- */
+/** Navbar 접힘 상태 또는 모바일 drawer 열림 상태를 전환하는 버튼 */
 declare function NavbarToggleButton(props: NavbarToggleButtonProps): import("react/jsx-runtime").JSX.Element;
 export default NavbarToggleButton;

package/dist/types/layout/components/navigation/NavItem.d.ts

@@ -1,15 +1,21 @@
 import type { OwpNavItemType as NavItemType } from '@/types/OwpNavigationTypes';
+/** Navigation item renderer에 전달되는 공통 속성 */
 export type NavItemComponentProps = {
+    /** render할 navigation item type */
     type: string;
+    /** navigation item 원본 설정 */
     item: NavItemType;
+    /** vertical item density 축소 여부 */
     dense?: boolean;
+    /** 중첩 collapse depth */
     nestedLevel?: number;
+    /** leaf/collapse item click callback */
     onItemClick?: (item: NavItemType) => void;
+    /** permission rule 적용 여부 */
     checkPermission?: boolean;
+    /** 현재 route 기준으로 펼쳐 둘 collapse ID 집합 */
     openedCollapseIds?: ReadonlySet<string>;
 };
-/**
- * Component to render a nav item by type.
-*/
+/** type 값에 맞는 vertical navigation item renderer 선택 */
 declare function NavItem(props: NavItemComponentProps): import("react/jsx-runtime").JSX.Element;
 export { NavItem };

package/dist/types/layout/components/navigation/NavigationMenu.d.ts

@@ -1,24 +1,29 @@
 import type { OwpNavItemType as NavItemType } from '@/types/OwpNavigationTypes';
+/** Vertical navigation menu rendering과 route 기반 collapse open 상태 속성 */
 export type NavigationMenuProps = {
+    /** root className */
     className?: string;
+    /** navigation item density 축소 여부 */
     dense?: boolean;
+    /** 상위 navigation 영역 활성 여부 */
     active?: boolean;
+    /** item click callback */
     onItemClick?: (item: NavItemType) => void;
+    /** render할 navigation tree */
     navigation?: NavItemType[];
+    /** navigation layout 종류 */
     layout?: 'vertical';
+    /** 최상위 level 여부 */
     firstLevel?: boolean;
+    /** 외부에서 지정한 선택 item ID */
     selectedId?: string;
+    /** permission rule 적용 여부 */
     checkPermission?: boolean;
+    /** 외부에서 제어하는 collapse open ID 집합 */
     openedCollapseIds?: ReadonlySet<string>;
 };
-/**
- * NavigationMenu
- * Component for displaying a navigation bar which contains nav items
- * and acts as parent for providing props to its children components
- */
+/** Navigation tree를 vertical layout으로 render하고 현재 route의 collapse를 자동 확장 */
 declare function NavigationMenu(props: NavigationMenuProps): import("react/jsx-runtime").JSX.Element;
-/**
- * Memoized navigation menu component.
- */
+/** NavigationMenu memoized export */
 declare const MemoizedNavigationMenu: import("react").MemoExoticComponent<typeof NavigationMenu>;
 export { MemoizedNavigationMenu as NavigationMenu };

package/dist/types/store/atoms/navbarAtoms.d.ts

@@ -1,8 +1,12 @@
 import type { NavbarState } from './internal/types';
 /**
- * Navbar 기본 상태 생성
+ * Navbar 상태 초기값 생성
+ * @param overrides 기본 상태에 병합할 부분 상태
  */
 export declare function createNavbarState(overrides?: Partial<NavbarState>): NavbarState;
+/**
+ * Navbar 전체 상태 atom
+ */
 export declare const navbarStateAtom: import("jotai").PrimitiveAtom<NavbarState> & {
     init: NavbarState;
 };

package/dist/types/store/atoms/owpSettingsAtoms.d.ts

@@ -3,7 +3,7 @@ import { type WritableAtom } from 'jotai';
 import type { PartialDeep } from 'type-fest';
 import type { OwpSettingsState } from './internal/types';
 /**
- * Light theme text palette
+ * Light mode 기본 text palette
  */
 export declare const lightPaletteText: {
     primary: string;
@@ -11,7 +11,7 @@ export declare const lightPaletteText: {
     disabled: string;
 };
 /**
- * Dark theme text palette
+ * Dark mode 기본 text palette
  */
 export declare const darkPaletteText: {
     primary: string;
@@ -19,15 +19,31 @@ export declare const darkPaletteText: {
     disabled: string;
 };
 /**
- * Settings 기본 상태 생성
+ * OWP settings atom 상태 초기값 생성
+ * @param initialValue initial/default/current 기준 settings
  */
 export declare function createSettingsState(initialValue: OwpSettingsConfigType): OwpSettingsState;
+/**
+ * OWP settings 전체 상태 atom
+ */
 export declare const owpSettingsStateAtom: import("jotai").PrimitiveAtom<OwpSettingsState> & {
     init: OwpSettingsState;
 };
+/**
+ * OWP settings 전체 상태 조회 atom
+ */
 export declare const owpSettingsAtom: import("jotai").Atom<OwpSettingsState>;
+/**
+ * default settings 조회 atom
+ */
 export declare const defaultSettingsAtom: import("jotai").Atom<OwpSettingsConfigType>;
+/**
+ * current settings 조회 atom
+ */
 export declare const currentSettingsAtom: import("jotai").Atom<OwpSettingsConfigType>;
+/**
+ * current layout config 조회 atom
+ */
 export declare const currentLayoutConfigAtom: import("jotai").Atom<{
     mode?: string;
     containerWidth?: string;
@@ -47,37 +63,73 @@ export declare const currentLayoutConfigAtom: import("jotai").Atom<{
         style?: string;
     };
 }>;
+/**
+ * custom scrollbar 사용 여부 조회 atom
+ */
 export declare const customScrollbarsEnabledAtom: import("jotai").Atom<boolean>;
+/**
+ * current direction 조회 atom
+ */
 export declare const directionAtom: import("jotai").Atom<"rtl" | "ltr">;
+/**
+ * main theme 설정 조회 atom
+ */
 export declare const mainThemeSettingsAtom: import("jotai").Atom<OwpThemeType>;
+/**
+ * navbar theme 설정 조회 atom
+ */
 export declare const navbarThemeSettingsAtom: import("jotai").Atom<OwpThemeType>;
+/**
+ * toolbar theme 설정 조회 atom
+ */
 export declare const toolbarThemeSettingsAtom: import("jotai").Atom<OwpThemeType>;
+/**
+ * footer theme 설정 조회 atom
+ */
 export declare const footerThemeSettingsAtom: import("jotai").Atom<OwpThemeType>;
+/**
+ * main MUI theme 생성 atom
+ */
 export declare const mainThemeAtom: import("jotai").Atom<import("@mui/material").Theme>;
+/**
+ * main theme를 dark mode로 변환한 MUI theme atom
+ */
 export declare const mainThemeDarkAtom: import("jotai").Atom<import("@mui/material").Theme>;
+/**
+ * main theme를 light mode로 변환한 MUI theme atom
+ */
 export declare const mainThemeLightAtom: import("jotai").Atom<import("@mui/material").Theme>;
+/**
+ * navbar MUI theme 생성 atom
+ */
 export declare const navbarThemeAtom: import("jotai").Atom<import("@mui/material").Theme>;
+/**
+ * toolbar MUI theme 생성 atom
+ */
 export declare const toolbarThemeAtom: import("jotai").Atom<import("@mui/material").Theme>;
+/**
+ * footer MUI theme 생성 atom
+ */
 export declare const footerThemeAtom: import("jotai").Atom<import("@mui/material").Theme>;
 /**
- * 현재 settings 적용 atom
+ * next settings를 defaults와 병합해 current settings로 적용하는 atom
  */
 export declare const setSettingsAtom: WritableAtom<unknown, [nextSettings: OwpSettingsConfigType], void>;
 /**
- * 기본 settings 변경 atom
+ * default/current settings를 partial deep override로 갱신하는 atom
  */
 export declare const setDefaultSettingsAtom: WritableAtom<null, [
     PartialDeep<OwpSettingsConfigType>
 ], OwpSettingsState>;
 /**
- * 초기 settings 복원 atom
+ * 초기 settings snapshot으로 settings 상태를 복원하는 atom
  */
 export declare const setInitialSettingsAtom: WritableAtom<unknown, [], void>;
 /**
- * 현재 defaults 기준 초기화 atom
+ * current settings를 현재 defaults로 초기화하는 atom
  */
 export declare const resetSettingsAtom: WritableAtom<unknown, [], void>;
 /**
- * Theme 설정 변경 atom
+ * main/navbar/toolbar/footer theme set을 settings default/current에 반영하는 atom
  */
 export declare const changeOwpThemeAtom: WritableAtom<unknown, [theme: OwpThemesType], OwpSettingsState>;

package/dist/types/store/atoms/owpStore.d.ts

@@ -2,12 +2,19 @@ import type { OwpSettingsConfigType, OwpThemesType } from '@/types/OwpSettingsTy
 import { createStore } from 'jotai/vanilla';
 import type { PartialDeep } from 'type-fest';
 import type { OwpStorePreloadedState, OwpStoreState } from './internal/types';
+/**
+ * OWP Jotai vanilla store 타입
+ */
 export type OwpStore = ReturnType<typeof createStore>;
 /**
- * OWP 전역 상태 초기값 생성
+ * settings/theme config와 preloaded state를 병합해 OWP store state 생성
+ * @param settingsConfig app settings override
+ * @param themesConfig app theme override
+ * @param preloadedState store slice별 초기 상태
  */
 export declare function createOwpStoreState(settingsConfig?: PartialDeep<OwpSettingsConfigType>, themesConfig?: PartialDeep<OwpThemesType>, preloadedState?: OwpStorePreloadedState): OwpStoreState;
 /**
- * OWP Jotai store 생성
+ * OWP settings/navbar atom이 초기화된 Jotai vanilla store 생성
+ * @param initialState store slice 초기 상태
  */
 export declare function createOwpStore(initialState: OwpStoreState): OwpStore;