@owp/core 2.5.47 → 2.5.48

package/dist/types/contexts/OwpAppContext.d.ts

@@ -0,0 +1,164 @@
+import type { OwpLoadingProps } from '@/components/OwpLoading/OwpLoading';
+import type { OwpNavItemType } from '@/types/OwpNavigationTypes';
+import type { OwpRoutesType } from '@/types/OwpRouteTypes';
+import type { OwpSettingsConfigType, OwpThemesType } from '@/types/OwpSettingsTypes';
+import { type ComponentType, type CSSProperties, type ReactNode } from 'react';
+import type { PartialDeep } from 'type-fest';
+/**
+ * OWP logo slot component props
+ */
+export interface OwpLogoSlotProps {
+    /** logo root className */
+    className?: string;
+    /** logo root inline style */
+    style?: CSSProperties;
+}
+/**
+ * Page skeleton preset item type
+ */
+export type OwpPageSkeletonItemType = 'search-header' | 'table' | 'grid' | 'card' | 'chart' | 'stat';
+/**
+ * Route loading skeleton item layout 설정
+ */
+export interface OwpPageSkeletonItem {
+    /** skeleton item preset type */
+    type: OwpPageSkeletonItemType;
+    /** grid column span */
+    colSpan?: number;
+    /** grid row span */
+    rowSpan?: number;
+    /** grid column start index */
+    colStart?: number;
+    /** grid row start index */
+    rowStart?: number;
+}
+/**
+ * Route loading skeleton layout spec
+ */
+export interface OwpPageSkeletonSpec {
+    /** skeleton grid column 수 */
+    columns?: number;
+    /** skeleton row 기본 높이 */
+    rowHeight?: number;
+    /** viewport 전체 기준 skeleton 여부 */
+    fullscreen?: boolean;
+    /** content height를 채우는 skeleton 여부 */
+    fillContentHeight?: boolean;
+    /** skeleton item 목록 */
+    items: OwpPageSkeletonItem[];
+}
+/**
+ * Route loading slot component props
+ */
+export interface OwpRouteLoadingSlotProps extends OwpLoadingProps {
+    /** 현재 route pathname */
+    pathname: string;
+    /** 첫 route loading 상태 여부 */
+    isFirstRouteLoading: boolean;
+}
+/**
+ * Route loading 표시 설정
+ */
+export interface OwpRouteLoadingConfig extends OwpLoadingProps {
+    /** pathname별 skeleton spec 생성 함수 */
+    getSkeletonSpec?: (pathname: string) => OwpPageSkeletonSpec | undefined;
+    /** click으로 route loading을 해제하는 test toggle. 기본값 false */
+    releaseOnClick?: boolean;
+}
+/**
+ * OWP app bootstrap config 묶음
+ */
+export interface OwpAppConfigs {
+    /** React Router route config */
+    routesConfig: OwpRoutesType;
+    /** OWP settings override */
+    settingsConfig?: PartialDeep<OwpSettingsConfigType>;
+    /** OWP theme set override */
+    themesConfig?: PartialDeep<OwpThemesType>;
+    /** navigation tree config */
+    navigationConfig: OwpNavItemType[];
+}
+/**
+ * OWP app slot component registry
+ */
+export interface OwpAppSlots {
+    /** logo 영역 slot component */
+    logo?: ComponentType<OwpLogoSlotProps>;
+    /** route loading slot component */
+    routeLoading?: ComponentType<OwpRouteLoadingSlotProps>;
+}
+/**
+ * OWP app slot별 props
+ */
+export interface OwpAppSlotProps {
+    /** logo slot props */
+    logo?: OwpLogoSlotProps;
+    /** route loading slot props와 loading config */
+    routeLoading?: Omit<Partial<OwpRouteLoadingSlotProps>, 'pathname' | 'isFirstRouteLoading'> & OwpRouteLoadingConfig;
+}
+/**
+ * OWP runtime 환경값
+ */
+export interface OwpAppEnv {
+    /** API base URL */
+    apiBaseUrl?: string;
+    /** access token guard 활성화 여부 */
+    isAccessTokenGuardEnabled?: boolean;
+    /** auto logout dialog 활성화 여부 */
+    isAutoLogoutEnabled?: boolean;
+    /** auto logout idle timeout(ms) */
+    autoLogoutIdleTimeoutMs?: number;
+    /** backend navigation 조회 사용 여부 */
+    isBackendNavigationEnabled?: boolean;
+    /** API 오류 메시지 표시 여부 */
+    isErrorMessageEnabled?: boolean;
+    /** i18n language 동기화 활성화 여부 */
+    isI18nEnabled?: boolean;
+    /** language switcher 표시 여부 */
+    isI18nLanguageSwitcherEnabled?: boolean;
+    /** active route 변경 시 navigation remount 활성화 여부 */
+    isNavigationActiveRouteRemountEnabled?: boolean;
+    /** 비밀번호 변경 메뉴 활성화 여부 */
+    isPasswordChangeEnabled?: boolean;
+    /** request log payload 출력 여부 */
+    isRequestLogPayloadEnabled?: boolean;
+    /** theme preview 기능 활성화 여부 */
+    isThemePreviewEnabled?: boolean;
+    /** theme preview dialog lazy loader */
+    themePreviewDialogLoader?: () => Promise<unknown>;
+    [key: string]: unknown;
+}
+/**
+ * OWP app context value
+ */
+export interface OwpAppContextValue extends OwpAppConfigs {
+    /** runtime 환경값 */
+    env?: OwpAppEnv;
+    /** app slot component registry */
+    slots?: OwpAppSlots;
+    /** app slot별 props */
+    slotProps?: OwpAppSlotProps;
+}
+/**
+ * OWP app provider props
+ */
+export interface OwpAppProviderProps {
+    /** app bootstrap config 묶음 */
+    configs: OwpAppConfigs;
+    /** app slot component registry */
+    slots?: OwpAppSlots;
+    /** app slot별 props */
+    slotProps?: OwpAppSlotProps;
+    /** provider children */
+    children?: ReactNode;
+    /** runtime 환경값 */
+    env?: OwpAppEnv;
+}
+/**
+ * OWP app context
+ */
+export declare const OwpAppContext: import("react").Context<OwpAppContextValue>;
+/**
+ * OWP app context를 조회하고 provider 누락 시 오류를 던지는 Hook
+ */
+export declare const useOwpAppContext: () => OwpAppContextValue;

package/dist/types/contexts/OwpAppProvider.d.ts

@@ -1,84 +1,7 @@
-import type { OwpSettingsConfigType, OwpThemesType } from '@/types/OwpSettingsTypes';
-import type { OwpNavItemType } from '@/types/OwpNavigationTypes';
-import type { OwpLoadingProps } from '@/components/OwpLoading/OwpLoading';
-import { CSSProperties, ComponentType, ReactNode } from 'react';
-import { PartialDeep } from 'type-fest';
+import { type OwpAppProviderProps } from './OwpAppContext';
+export type { OwpAppProviderProps } from './OwpAppContext';
 /**
- * Logo slot props
+ * OWP app config/env/slot context를 제공하고 env를 storage에 동기화하는 provider
+ * @param props app configs, runtime env, slot registry, children
  */
-export interface OwpLogoSlotProps {
-    className?: string;
-    style?: CSSProperties;
-}
-export type OwpPageSkeletonItemType = 'search-header' | 'table' | 'grid' | 'card' | 'chart' | 'stat';
-export interface OwpPageSkeletonItem {
-    type: OwpPageSkeletonItemType;
-    colSpan?: number;
-    rowSpan?: number;
-    colStart?: number;
-    rowStart?: number;
-}
-export interface OwpPageSkeletonSpec {
-    columns?: number;
-    rowHeight?: number;
-    fullscreen?: boolean;
-    fillContentHeight?: boolean;
-    items: OwpPageSkeletonItem[];
-}
-export interface OwpRouteLoadingSlotProps extends OwpLoadingProps {
-    pathname: string;
-    isFirstRouteLoading: boolean;
-}
-export interface OwpRouteLoadingConfig extends OwpLoadingProps {
-    getSkeletonSpec?: (pathname: string) => OwpPageSkeletonSpec | undefined;
-    /** Click-to-release test toggle. Default false */
-    releaseOnClick?: boolean;
-}
-export interface OwpAppConfigs {
-    routesConfig: any;
-    settingsConfig?: PartialDeep<OwpSettingsConfigType>;
-    themesConfig?: PartialDeep<OwpThemesType>;
-    navigationConfig: OwpNavItemType[];
-}
-/**
- * App slots
- */
-export interface OwpAppSlots {
-    logo?: ComponentType<OwpLogoSlotProps>;
-    routeLoading?: ComponentType<OwpRouteLoadingSlotProps>;
-}
-export interface OwpAppSlotProps {
-    logo?: OwpLogoSlotProps;
-    routeLoading?: Omit<Partial<OwpRouteLoadingSlotProps>, 'pathname' | 'isFirstRouteLoading'> & OwpRouteLoadingConfig;
-}
-export interface OwpAppEnv {
-    apiBaseUrl?: string;
-    isAccessTokenGuardEnabled?: boolean;
-    isAutoLogoutEnabled?: boolean;
-    autoLogoutIdleTimeoutMs?: number;
-    isBackendNavigationEnabled?: boolean;
-    isErrorMessageEnabled?: boolean;
-    isI18nEnabled?: boolean;
-    isI18nLanguageSwitcherEnabled?: boolean;
-    isNavigationActiveRouteRemountEnabled?: boolean;
-    isPasswordChangeEnabled?: boolean;
-    isRequestLogPayloadEnabled?: boolean;
-    isThemePreviewEnabled?: boolean;
-    themePreviewDialogLoader?: () => Promise<unknown>;
-    [key: string]: unknown;
-}
-export interface OwpAppContextValue extends OwpAppConfigs {
-    env?: OwpAppEnv;
-    slots?: OwpAppSlots;
-    slotProps?: OwpAppSlotProps;
-}
-export declare const OwpAppContext: import("react").Context<OwpAppContextValue>;
-export interface OwpAppProviderProps {
-    configs: OwpAppConfigs;
-    slots?: OwpAppSlots;
-    slotProps?: OwpAppSlotProps;
-    children?: ReactNode;
-    env?: OwpAppEnv;
-}
 export declare const OwpAppProvider: ({ configs, slots, slotProps, children, env, }: OwpAppProviderProps) => import("react/jsx-runtime").JSX.Element;
-export declare const useOwpAppContext: () => OwpAppContextValue;

package/dist/types/contexts/OwpCoreProvider.d.ts

@@ -1,21 +1,25 @@
 import { StyledEngineProvider } from '@mui/material/styles';
 import { QueryClient, QueryClientConfig } from '@tanstack/react-query';
-import { ComponentProps } from 'react';
-import { OwpAppProviderProps } from './OwpAppProvider';
+import { type ComponentProps } from 'react';
+import type { OwpAppProviderProps } from './OwpAppContext';
 import { OwpStoreProviderProps } from './OwpStoreProvider';
 type OwpStyledEngineProviderProps = Omit<ComponentProps<typeof StyledEngineProvider>, 'children'>;
+/**
+ * OWP core provider composition props
+ */
 export interface OwpCoreProviderProps extends OwpAppProviderProps {
+    /** 외부에서 생성한 React Query client */
     queryClient?: QueryClient;
+    /** 내부 QueryClient 생성 시 사용할 config */
     queryClientConfig?: QueryClientConfig;
+    /** Jotai store 초기 상태 override */
     storePreloadedState?: OwpStoreProviderProps['preloadedState'];
+    /** MUI StyledEngineProvider props */
     styledEngineProviderProps?: OwpStyledEngineProviderProps;
 }
 /**
- * App, Jotai, React Query provider composition
- * @param queryClient 외부 QueryClient 인스턴스
- * @param queryClientConfig QueryClient 생성 옵션
- * @param storePreloadedState 초기 전역 상태
- * @param styledEngineProviderProps StyledEngineProvider 옵션
+ * App context, Jotai store, React Query, MUI StyledEngine provider를 조합하는 root provider
+ * @param props app provider 설정과 query/store/style provider 설정
  */
 export declare function OwpCoreProvider({ children, queryClient, queryClientConfig, storePreloadedState, styledEngineProviderProps, ...appProviderProps }: OwpCoreProviderProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/contexts/OwpStoreProvider.d.ts

@@ -1,12 +1,16 @@
 import type { OwpStorePreloadedState } from '@/store/atoms/internal/types';
-import { ReactNode } from 'react';
+import { type ReactNode } from 'react';
+/**
+ * OWP Jotai store provider props
+ */
 export interface OwpStoreProviderProps {
+    /** provider children */
     children?: ReactNode;
+    /** store 생성 시 병합할 초기 상태 */
     preloadedState?: OwpStorePreloadedState;
 }
 /**
- * OWP Jotai store provider
- * @param children 하위 콘텐츠
- * @param preloadedState 초기 전역 상태
+ * OWP Jotai store를 한 번 생성해 하위 provider에 고정하는 provider
+ * @param props children과 preloaded state
  */
 export declare function OwpStoreProvider({ children, preloadedState }: OwpStoreProviderProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/contexts/OwpUiProvider.d.ts

@@ -1,17 +1,22 @@
 import { SnackbarProvider } from 'notistack';
-import { ComponentProps, ReactNode } from 'react';
+import { type ComponentProps, type ReactNode } from 'react';
 import type { DialogProviderProps } from '@/types/OwpDialogTypes';
 type OwpDialogsProviderProps = Omit<DialogProviderProps, 'children'>;
 type OwpSnackbarProviderProps = Omit<ComponentProps<typeof SnackbarProvider>, 'children'>;
+/**
+ * OWP UI provider composition props
+ */
 export interface OwpUiProviderProps {
+    /** provider children */
     children?: ReactNode;
+    /** OwpDialogsProvider에 전달할 props */
     dialogsProviderProps?: OwpDialogsProviderProps;
+    /** notistack SnackbarProvider에 전달할 props */
     snackbarProviderProps?: OwpSnackbarProviderProps;
 }
 /**
- * Dialog, snackbar provider composition
- * @param dialogsProviderProps OwpDialogsProvider 옵션
- * @param snackbarProviderProps SnackbarProvider 옵션
+ * Dialog, snackbar, page lock loading, auto logout UI provider를 조합하는 provider
+ * @param props dialog/snackbar provider 옵션과 children
  */
 export declare function OwpUiProvider({ children, dialogsProviderProps, snackbarProviderProps, }: OwpUiProviderProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/contexts/index.d.ts

@@ -1,3 +1,4 @@
+export * from './OwpAppContext';
 export * from './OwpAppProvider';
 export * from './OwpCoreProvider';
 export * from './OwpStoreProvider';

package/dist/types/dayjs.d.ts

@@ -8,11 +8,11 @@ declare module 'dayjs' {
     }
 }
 /**
- * 브라우저 배포용 dayjs locale/plugin 초기화
+ * browser 배포용 dayjs locale/plugin 초기화
  */
 export declare const ensureDayjsBrowserSetup: () => typeof dayjs;
 /**
- * 브라우저 배포용 dayjs 인스턴스
+ * browser 배포용 dayjs instance
  */
 export declare const owpDayjs: typeof dayjs;
 export default owpDayjs;

package/dist/types/features/themePreview/components/ThemePreviewCanvas.d.ts

@@ -4,5 +4,9 @@ interface ThemePreviewCanvasProps {
     isLoading?: boolean;
     settings: ThemePreviewSettings;
 }
+/**
+ * Theme Preview draft settings를 실제 UI 조각으로 render하는 preview canvas
+ * @param props 활성 section, loading 상태, draft settings
+ */
 export declare function ThemePreviewCanvas({ activeSection, isLoading, settings, }: ThemePreviewCanvasProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/features/themePreview/components/ThemePreviewCanvasSections.d.ts

@@ -29,7 +29,9 @@ interface ThemePreviewCommonSectionProps {
     mainThemePreviewStoreState: ThemePreviewStoreState;
     previewSectionCardSx: SxProps<Theme>;
 }
+/** Main/theme 공통 token을 한 화면에서 비교하는 preview section */
 export declare const ThemePreviewCommonSection: import("react").NamedExoticComponent<ThemePreviewCommonSectionProps>;
+/** Button palette와 contrast를 단독으로 확인하는 preview section */
 export declare const ThemePreviewButtonsSection: import("react").NamedExoticComponent<ThemePreviewButtonsSectionProps>;
 interface ThemePreviewSnackbarsSectionProps {
     previewSectionCardSx: SxProps<Theme>;
@@ -43,6 +45,7 @@ interface ThemePreviewSnackbarsSectionProps {
     snackbarPreviewMaxSnack: number;
     snackbarAutoHideDuration: SnackbarProviderTheme['autoHideDuration'];
 }
+/** Snackbar variant, 위치, typography를 확인하는 preview section */
 export declare const ThemePreviewSnackbarsSection: import("react").NamedExoticComponent<ThemePreviewSnackbarsSectionProps>;
 interface ThemePreviewSearchHeaderSectionProps {
     activeSection: 'main' | 'navbar' | 'toolbar';
@@ -59,6 +62,7 @@ interface ThemePreviewSearchHeaderSectionProps {
     tableTheme: ThemePreviewTableConfigType;
     tableThemePreviewVersionKey: string;
 }
+/** Navbar/toolbar/main 배경 위의 search header와 content shell preview section */
 export declare const ThemePreviewSearchHeaderSection: import("react").NamedExoticComponent<ThemePreviewSearchHeaderSectionProps>;
 interface ThemePreviewGridSectionProps {
     editableThemePreviewGridId: string;
@@ -68,6 +72,7 @@ interface ThemePreviewGridSectionProps {
     previewSectionCardSx: SxProps<Theme>;
     readonlyThemePreviewGridId: string;
 }
+/** Editable/readonly TreeGrid theme token을 비교하는 preview section */
 export declare const ThemePreviewGridSection: import("react").NamedExoticComponent<ThemePreviewGridSectionProps>;
 interface ThemePreviewTablesSectionProps {
     mainThemePreviewStoreState: ThemePreviewStoreState;
@@ -76,6 +81,7 @@ interface ThemePreviewTablesSectionProps {
     tableTheme: ThemePreviewTableConfigType;
     tableThemePreviewVersionKey: string;
 }
+/** FieldTable, basic table, DataTable theme token을 비교하는 preview section */
 export declare const ThemePreviewTablesSection: import("react").NamedExoticComponent<ThemePreviewTablesSectionProps>;
 interface ThemePreviewGridPreviewTableProps {
     gridBodyBorder: string;
@@ -86,5 +92,6 @@ interface ThemePreviewGridPreviewTableProps {
     layoutPreviewGridHeaderColor: string;
     layoutPreviewGridHeaderFontSize: string;
 }
+/** Layout preview용 static grid table */
 export declare const ThemePreviewGridPreviewTable: import("react").NamedExoticComponent<ThemePreviewGridPreviewTableProps>;
 export {};

package/dist/types/features/themePreview/components/ThemePreviewColorField.d.ts

@@ -8,5 +8,9 @@ interface ThemePreviewColorFieldProps {
     onChange: (path: string, value: string) => void;
     onReset?: (path: string) => void;
 }
+/**
+ * Theme Preview field definition을 text/color/select 입력으로 render하는 edit field
+ * @param props field definition, section, draft settings, change/reset handler
+ */
 export declare function ThemePreviewColorField({ disabled, definition, resetVersion, sectionKey, settings, onChange, onReset, }: ThemePreviewColorFieldProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/features/themePreview/components/ThemePreviewControls.d.ts

@@ -17,5 +17,9 @@ interface ThemePreviewControlsProps {
     onPresetKeyChange: (presetKey: string) => void;
     onPresetModeChange: (mode: ThemePreviewMode) => void;
 }
+/**
+ * Theme Preview section/preset 선택과 field 편집 컨트롤 패널
+ * @param props active section, preset 상태, draft settings, palette/preset 변경 handler
+ */
 export declare function ThemePreviewControls({ activeSection, presetOptions, selectedMode, selectedPresetKey, settings, resetVersion, onSectionChange, onPaletteValueChange, onPaletteValuesChange, onPaletteValueReset, onPaletteValuesReset, onPresetKeyChange, onPresetModeChange, }: ThemePreviewControlsProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/features/themePreview/components/themePreviewCanvas.icons.d.ts

@@ -1,3 +1,4 @@
 import type { SnackbarVariantKey } from '@/features/themePreview/configs/snackbar';
 import type { ReactNode } from 'react';
+/** Snackbar variant별 preview icon 매핑 */
 export declare const snackbarPreviewIconByVariant: Record<SnackbarVariantKey, ReactNode>;

package/dist/types/features/themePreview/components/themePreviewCanvas.shared.d.ts

@@ -4,42 +4,59 @@ import type { ThemePreviewTableConfigType } from '@/features/themePreview/config
 import { type SxProps, type Theme } from '@mui/material/styles';
 import type { ComponentProps } from 'react';
 import type { ThemePreviewPaletteSectionKey, ThemePreviewSectionKey, ThemePreviewSettings } from '../types';
+/** Preview canvas chrome border color */
 export declare const previewChromeBorder = "#e2e8f0";
+/** Preview section card 기본 className */
 export declare const previewSectionCardClassName = "rounded-lg p-14";
+/** Preview 내부 card가 theme shadow 영향을 받지 않도록 고정하는 sx */
 export declare const previewInnerCardSx: {
     readonly boxShadow: "none";
 };
+/** Editable TreeGrid preview instance ID */
 export declare const themePreviewEditableTreeGridId = "ThemePreviewGrid";
+/** Readonly TreeGrid preview instance ID */
 export declare const themePreviewReadonlyTreeGridId = "ThemePreviewReadonlyGrid";
+/** Grid preview body fallback background */
 export declare const gridPreviewBodyBackground = "#ffffff";
+/** Grid preview body fallback text color */
 export declare const gridPreviewBodyText = "rgb(17, 24, 39)";
+/** 기본 canvas에서 노출하는 preview section 순서 */
 export declare const defaultPreviewSectionOrder: readonly ["common", "searchHeader"];
+/** Grid preview table column label 목록 */
 export declare const gridPreviewColumnLabels: readonly ["부서명", "사용자ID", "성명", "사용여부"];
+/** Navbar preview에서 표시할 menu label 목록 */
 export declare const navbarPreviewItems: readonly ["Dashboard", "Theme Preview", "사용자 관리", "권한 그룹"];
+/** Preview data에서 user ID를 표시명으로 바꾸는 lookup */
 export declare const previewUserNameById: {
     readonly admin: "관리자";
     readonly impix: "담당자1";
     readonly owp: "담당자2";
 };
+/** Snackbar variant별 preview message */
 export declare const snackbarPreviewMessageByVariant: Record<SnackbarVariantKey, string>;
+/** Search header field table preview data */
 export declare const searchHeaderPreviewData: {
     previewValue: string;
 };
+/** Field table preview data */
 export declare const tableFieldPreviewData: {
     departmentName: string;
     managerName: "담당자1";
     useYn: string;
     locationName: string;
 };
+/** Field table preview layout */
 export declare const tableFieldPreviewLayout: {
     title: string;
     key: string;
 }[][];
+/** Basic table preview header label map */
 export declare const tablePreviewHeaders: {
     departmentName: string;
     managerName: string;
     useYn: string;
 };
+/** Basic table preview row data */
 export declare const tablePreviewRows: ({
     departmentName: string;
     managerName: "담당자1";
@@ -49,6 +66,7 @@ export declare const tablePreviewRows: ({
     managerName: "담당자2";
     useYn: string;
 })[];
+/** Grid style table preview에서 한 행만 노출할 때 사용하는 row data */
 export declare const gridStyledTablePreviewRows: ({
     departmentName: string;
     managerName: "담당자1";
@@ -58,12 +76,14 @@ export declare const gridStyledTablePreviewRows: ({
     managerName: "담당자2";
     useYn: string;
 })[];
+/** DataTable preview head cell 설정 */
 export declare const dataTablePreviewHeadCells: {
     id: string;
     label: string;
     align: string;
     valueAlign: string;
 }[];
+/** DataTable preview row data */
 export declare const dataTablePreviewRows: ({
     userId: string;
     userName: "담당자1";
@@ -73,6 +93,7 @@ export declare const dataTablePreviewRows: ({
     userName: "담당자2";
     useYn: string;
 })[];
+/** Grid style DataTable preview에서 한 행만 노출할 때 사용하는 row data */
 export declare const gridStyledDataTablePreviewRows: ({
     userId: string;
     userName: "담당자1";
@@ -82,6 +103,7 @@ export declare const gridStyledDataTablePreviewRows: ({
     userName: "담당자2";
     useYn: string;
 })[];
+/** TreeGrid canvas preview body row data */
 export declare const gridCanvasPreviewRows: ({
     'OWP_THEME_PREVIEW.ITEM_NAME': string;
     'OWP_THEME_PREVIEW.REMARK': string;
@@ -101,21 +123,80 @@ export declare const gridCanvasPreviewRows: ({
     CanSelect: number;
     Selected?: undefined;
 })[];
+/** Preview control에서 사용하는 no-op callback */
 export declare const previewNoop: () => void;
 type ThemePreviewFieldTableCellSx = NonNullable<ComponentProps<typeof OwpFieldTable>['cellSx']>;
 type ThemePreviewFieldTableTitleSx = NonNullable<ComponentProps<typeof OwpFieldTable>['titleSx']>;
+/** Canvas에 배치 가능한 preview section key */
 export type ThemePreviewLayoutSectionKey = 'common' | 'buttons' | 'snackbars' | 'searchHeader' | 'grid' | 'tables';
+/** Static grid preview table row data */
 export declare const gridPreviewRows: readonly [readonly ["관리부", "admin", "관리자", "사용"], readonly ["생산1팀", "impix", "담당자1", "사용"]];
+/**
+ * Preview remount가 필요한 설정 객체를 안정적인 key로 변환
+ * @param sourceValue version key에 반영할 설정 값
+ */
 export declare function createThemePreviewVersionKey(sourceValue: unknown): string;
+/**
+ * Theme preview palette section의 중첩 color value 조회
+ * @param settings preview settings
+ * @param sectionKey palette section key
+ * @param path dotted color path
+ */
 export declare function getPaletteValue(settings: ThemePreviewSettings, sectionKey: ThemePreviewPaletteSectionKey, path: string): string;
+/**
+ * 빈 문자열 theme token을 미정의 값으로 정규화
+ * @param value preview style input value
+ */
 export declare function getThemePreviewStyleValue<T extends number | string | undefined>(value: T): T;
+/**
+ * Table radius preview 값을 radius zero 옵션과 함께 해석
+ * @param borderRadius table borderRadius 설정
+ * @param canTableRadiusZero radius 0 강제 여부
+ */
 export declare function getThemePreviewResolvedBorderRadius(borderRadius: ThemePreviewTableConfigType['borderRadius'], canTableRadiusZero?: boolean): string | number;
+/**
+ * Preview table wrapper에 radius/overflow 보정 sx 생성
+ * @param tableTheme table preview theme
+ * @param canTableRadiusZero radius 0 강제 여부
+ */
 export declare function getThemePreviewTableFrameSx(tableTheme: ThemePreviewTableConfigType, canTableRadiusZero?: boolean): SxProps<Theme>;
+/**
+ * FieldTable preview의 table/body cell sx 생성
+ * @param tableTheme table preview theme
+ * @param canTableRadiusZero radius 0 강제 여부
+ */
 export declare function getThemePreviewFieldTableSx(tableTheme: ThemePreviewTableConfigType, canTableRadiusZero?: boolean): SxProps<Theme>;
+/**
+ * FieldTable title cell preview sx 생성
+ * @param tableTheme table preview theme
+ */
 export declare function getThemePreviewFieldTableTitleSx(tableTheme: ThemePreviewTableConfigType): ThemePreviewFieldTableTitleSx | undefined;
+/**
+ * FieldTable value cell preview sx 생성
+ * @param tableTheme table preview theme
+ */
 export declare function getThemePreviewFieldTableCellSx(tableTheme: ThemePreviewTableConfigType): ThemePreviewFieldTableCellSx | undefined;
+/**
+ * Basic table preview sx 생성
+ * @param tableTheme table preview theme
+ * @param canTableRadiusZero radius 0 강제 여부
+ */
 export declare function getThemePreviewBasicTableSx(tableTheme: ThemePreviewTableConfigType, canTableRadiusZero?: boolean): SxProps<Theme>;
+/**
+ * DataTable preview sx 생성
+ * @param tableTheme table preview theme
+ * @param canTableRadiusZero radius 0 강제 여부
+ */
 export declare function getThemePreviewDataTableSx(tableTheme: ThemePreviewTableConfigType, canTableRadiusZero?: boolean): SxProps<Theme>;
+/**
+ * 지정 색상 위에서 더 잘 보이는 preview text color 선택
+ * @param color 배경색
+ * @param fallbackColor contrast가 동률일 때 사용할 색상
+ */
 export declare function getPreviewContrastColor(color: string, fallbackColor: string): string;
+/**
+ * active theme section에 맞는 canvas preview section 순서 반환
+ * @param activeSection 현재 편집 중인 theme section
+ */
 export declare function getPreviewSectionOrder(activeSection: ThemePreviewSectionKey): ThemePreviewLayoutSectionKey[];
 export {};

package/dist/types/features/themePreview/configs/grid.d.ts

@@ -1,3 +1,6 @@
+/**
+ * Theme Preview 기본 grid theme
+ */
 export declare const defaultGridTheme: {
     header: {
         backgroundColor: string;