@owp/core 1.5.2 → 1.6.1

package/dist/types/utils/treeGridUtil.d.ts

@@ -1,36 +1,127 @@
+type TreeGridInsertPosition = 'above' | 'below' | 'top' | 'last';
+type TreeGridAddRowOptions<T> = {
+    canSelect?: boolean;
+    insertPosition?: TreeGridInsertPosition;
+    parent?: TRow & T;
+    anchorRow?: TRow & T;
+    initialValues?: T;
+};
+type TreeGridColumnVisibilityOptions = {
+    targetKey: string;
+    canVisible: boolean;
+};
+type TreeGridHighlightTargetOption = {
+    row: TRow;
+    col: string;
+};
 export declare const TREEGRID_WARNING_CELL_COLOR = "#f44336";
 export declare const TREEGRID_INPUT_CELL_COLOR = "#ffd6a8";
 export declare const TREEGRID_CELL_HIGHLIGHT_CLASS = "text-white text-xl font-semibold";
 export declare const TREEGRID_CELL_HIGHLIGHT_COLOR = "#ff8904";
+/**
+ * TreeGrid 인스턴스를 ID로 조회합니다.
+ * @param gridId TreeGrid 인스턴스 ID
+ */
 export declare const getGridById: (gridId: string) => TTGrid;
-export declare const getDataRowsById: <T>(gridId: string) => any[] | T;
-export declare const reloadBodyById: (gridId: string, rows: any) => void;
+/**
+ * TreeGrid의 데이터 행 목록을 조회합니다.
+ * @param gridId TreeGrid 인스턴스 ID
+ */
+export declare const getDataRowsById: <T>(gridId: string) => T;
+/**
+ * TreeGrid Body 데이터를 교체한 뒤 다시 로드합니다.
+ * @param gridId TreeGrid 인스턴스 ID
+ * @param rows 새로 반영할 행 데이터
+ */
+export declare const reloadBodyById: (gridId: string, rows: unknown) => void;
 /**
  * 행을 특정 위치에 추가
  * @param gridId TreeGrid 인스턴스 ID
- * @param options.canSelect 행 삽입 위치
- * @param options.parent
- * @param options.anchorRow above/below용 기준 row
+ * @param options.canSelect 행 선택 가능 여부
+ * @param options.parent 부모 행
+ * @param options.anchorRow above/below용 기준 행
  * @param options.insertPosition 행 삽입 위치
  * @param options.initialValues 신규 행 초기값
  */
-export declare const addRowById: <T>(gridId: string, options?: {
-    canSelect?: boolean;
-    insertPosition?: "above" | "below" | "top" | "last";
-    parent?: TRow & T;
-    anchorRow?: TRow & T;
-    initialValues?: T;
-}) => void;
+export declare const addRowById: <T>(gridId: string, options?: TreeGridAddRowOptions<T>) => void;
+/**
+ * TreeGrid의 추가/수정된 데이터 행을 조회합니다.
+ * @param gridId TreeGrid 인스턴스 ID
+ */
 export declare const getChangedDataRowsById: <T>(gridId: string) => {
-    [k: string]: Partial<{}>[];
+    added: T[];
+    changed: T[];
 };
+/**
+ * TreeGrid 데이터를 엑셀로 내보냅니다.
+ * @param gridId TreeGrid 인스턴스 ID
+ * @param title 다운로드 파일명
+ */
 export declare const exportExcelById: (gridId: string, title?: string) => void;
+/**
+ * TreeGrid에서 현재 선택된 행 목록을 조회합니다.
+ * @param gridId TreeGrid 인스턴스 ID
+ */
 export declare const getSelectedRowsById: <T>(gridId: string) => any[] | T;
-export declare const changeVisibleCellByGridId: (gridId: string, options: {
-    targetKey: string;
-    canVisible: boolean;
-}) => void;
-export declare const setHighlightTargetCellByGridId: (gridId: string, targetOption: {
-    row: TRow;
-    col: string;
-}) => void;
+/**
+ * TreeGrid 컬럼의 표시 여부를 변경합니다.
+ * @param gridId TreeGrid 인스턴스 ID
+ * @param options.targetKey 표시 상태를 변경할 컬럼 키
+ * @param options.canVisible 컬럼 표시 여부
+ */
+export declare const changeVisibleCellByGridId: (gridId: string, options: TreeGridColumnVisibilityOptions) => void;
+/**
+ * 특정 셀에 강조 스타일을 적용합니다.
+ * @param gridId TreeGrid 인스턴스 ID
+ * @param targetOption.row 강조할 대상 행
+ * @param targetOption.col 강조할 대상 컬럼
+ */
+export declare const setHighlightTargetCellByGridId: (gridId: string, targetOption: TreeGridHighlightTargetOption) => void;
+/**
+ * TreeGrid의 현재 선택 상태를 모두 해제합니다.
+ * @param gridId TreeGrid 인스턴스 ID
+ */
+export declare const resetGridSelection: (gridId: string) => void;
+/**
+ * 여러 TreeGrid의 선택 상태를 모두 해제합니다.
+ * @param gridIds TreeGrid 인스턴스 ID 목록
+ */
+export declare const resetGridsSelection: (gridIds: string[]) => void;
+/**
+ * TreeGrid의 변경 사항과 선택 상태를 모두 초기화합니다.
+ * @param gridId TreeGrid 인스턴스 ID
+ */
+export declare const resetGridChanges: (gridId: string) => void;
+/**
+ * 여러 TreeGrid의 변경 사항과 선택 상태를 모두 초기화합니다.
+ * @param gridIds TreeGrid 인스턴스 ID 목록
+ */
+export declare const resetGridsChanges: (gridIds: string[]) => void;
+/**
+ * TreeGrid 컬럼을 Enum 타입으로 설정하고 옵션 목록을 반영합니다.
+ * @param gridId TreeGrid 인스턴스 ID
+ * @param columnName Enum을 적용할 컬럼명
+ * @param options Enum 옵션 목록
+ * @param valueKey Enum 값으로 사용할 필드명
+ * @param labelKeys Enum 라벨로 사용할 필드 우선순위 목록
+ */
+export declare const setGridEnum: <T extends object>(gridId: string, columnName: string, options: T[] | undefined, valueKey: keyof T & string, labelKeys: Array<keyof T & string>) => void;
+/** 권장 네이밍 별칭 */
+export declare const getTreeGridById: (gridId: string) => TTGrid;
+export declare const getTreeGridDataRowsById: <T>(gridId: string) => T;
+export declare const reloadTreeGridBodyById: (gridId: string, rows: unknown) => void;
+export declare const addTreeGridRowById: <T>(gridId: string, options?: TreeGridAddRowOptions<T>) => void;
+export declare const getTreeGridRowChangesById: <T>(gridId: string) => {
+    added: T[];
+    changed: T[];
+};
+export declare const exportTreeGridToExcelById: (gridId: string, title?: string) => void;
+export declare const getTreeGridSelectedRowsById: <T>(gridId: string) => any[] | T;
+export declare const setTreeGridColumnVisibilityById: (gridId: string, options: TreeGridColumnVisibilityOptions) => void;
+export declare const highlightTreeGridCellById: (gridId: string, targetOption: TreeGridHighlightTargetOption) => void;
+export declare const resetTreeGridSelectionById: (gridId: string) => void;
+export declare const resetTreeGridSelectionsByIds: (gridIds: string[]) => void;
+export declare const resetTreeGridChangesById: (gridId: string) => void;
+export declare const resetTreeGridChangesByIds: (gridIds: string[]) => void;
+export declare const setTreeGridColumnEnumOptionsById: <T extends object>(gridId: string, columnName: string, options: T[] | undefined, valueKey: keyof T & string, labelKeys: Array<keyof T & string>) => void;
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@owp/core",
   "private": false,
-  "version": "1.5.2",
+  "version": "1.6.1",
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.js",