ia-table 0.13.2 → 0.14.0

package/dist/index.d.ts

@@ -498,6 +498,8 @@ export declare interface RowSpanParams {
 
 export declare type SmartGridActionTypes = typeof ACTION_TYPES;
 
+export declare type SmartGridAggregationType = "sum" | "count" | "avg" | "min" | "max";
+
 export declare interface SmartGridAPI {
     getInfiniteRowModel: () => SmartGridInfiniteRowModel | null;
     getInfiniteCache: () => SmartGridInfiniteCache | null;
@@ -666,7 +668,10 @@ export declare interface SmartGridBaseColumnDefinition {
     isWithEmptyHeaderName?: boolean;
     isParentWithChildEmptyHeaderName?: boolean;
     path?: string[];
+    pathIdentifier?: string;
     parentField?: string | null;
+    value?: string | number;
+    dimension_type?: string;
     originalFields?: string[];
     colId?: string;
     colSpan?: number;
@@ -697,6 +702,7 @@ export declare interface SmartGridBaseColumnDefinition {
         columnGroupShow?: "open" | "closed";
         is_multi?: boolean;
         options_column?: string;
+        aggregation_func?: SmartGridSelectOption[];
         [key: string]: unknown;
     };
     headerComponent?: default_2.FC<SmartGridHeaderStyleParams>;
@@ -706,6 +712,10 @@ export declare interface SmartGridBaseColumnDefinition {
     originalPath?: string[] | null;
     isReorderedColumn?: boolean | null;
     processCellForClipboard?: (params: SmartGridCellRendererParams) => string;
+    pivotAggregation?: "sum" | "count" | "avg" | "min" | "max";
+    pivotFilterValue?: string;
+    pivotFilterMode?: "value" | "condition";
+    pivotFilterCondition?: string;
     [key: string]: unknown;
 }
 
@@ -871,6 +881,7 @@ export declare interface SmartGridButtonProps {
     leftIcon?: ReactNode;
     rightIcon?: ReactNode;
     buttonRef?: MutableRefObject<HTMLButtonElement> | RefObject<HTMLButtonElement>;
+    simpleButton?: boolean;
 }
 
 export declare type SmartGridButtonSize = "small" | "medium" | "large";
@@ -1111,6 +1122,7 @@ export declare type SmartGridCellRendererParams = {
     leftLabel?: string;
     rightLabel?: string;
     splits?: SmartGridColumnDefinition[];
+    isEnableResetButton?: boolean;
 } & Record<string, unknown>;
 
 export declare interface SmartGridCellRendererRendererProps {
@@ -1624,6 +1636,8 @@ export declare type SmartGridFetDataParams = (body: SmartGridFetchDataFunctionBo
     totalCount?: number | null;
 }>;
 
+export declare type SmartGridFilterMode = "value" | "condition";
+
 export declare interface SmartGridFilterModel {
     pattern: string;
     search_type: string;
@@ -2319,6 +2333,231 @@ export declare type SmartGridPinnedType = "leftPinned" | "rightPinned" | null;
 
 export declare type SmartGridPinType = "leftPinnedOnly" | "rightPinnedOnly" | "normal";
 
+export declare interface SmartGridPivotAggregationOption {
+    value: string;
+    label: string;
+}
+
+export declare interface SmartGridPivotConfig {
+    PivotComponent: React.FC<SmartGridPivotWrapperProps>;
+    savedPivotState: SmartGridPivotState | undefined;
+    pivotPanelColumnDef: SmartGridColumnDefinition[];
+    enablePivotTutorial?: boolean;
+    savedPivots?: SmartGridPivotState[];
+    recentlyUsedPivots?: SmartGridPivotState[];
+    isHidePivotSave?: boolean;
+    pivotChildren?: React.ReactNode;
+    handlePivotSave?: (state: SmartGridPivotSavePayload, setIsPivotOpen: React.Dispatch<React.SetStateAction<boolean>>) => void;
+    handlePivotApply?: (state: SmartGridPivotState, setIsPivotOpen: React.Dispatch<React.SetStateAction<boolean>>) => void;
+    pivotAggregationFunc?: SmartGridSelectOption[];
+    showPivotTotalsSection?: boolean;
+    isPivotRowGrandTotal?: boolean;
+    isPivotColumnGrandTotal?: boolean;
+    isPivotRowSubTotal?: boolean;
+    isPivotColumnSubTotal?: boolean;
+    isHideFilters?: boolean;
+    isHideValues?: boolean;
+}
+
+export declare interface SmartGridPivotDropZoneItem {
+    mode: string;
+    filterValue: string;
+    id: string;
+    name: string;
+    aggregation?: SmartGridAggregationType;
+    condition?: string;
+}
+
+export declare interface SmartGridPivotDropZoneProps {
+    type: "rows" | "columns" | "values";
+    items: SmartGridColumnDefinition[];
+    defaultExpanded?: boolean;
+    onDrop: (column: SmartGridColumnDefinition) => void;
+    onRemoveItem: (itemId: string) => void;
+    isDragOver?: boolean;
+    onClearAll?: () => void;
+}
+
+export declare interface SmartGridPivotField {
+    id: string;
+    name: string;
+    type: "dimension" | "measure";
+}
+
+export declare interface SmartGridPivotFieldItemProps {
+    column: SmartGridColumnDefinition;
+    isDragging?: boolean;
+}
+
+export declare interface SmartGridPivotFieldListProps {
+    fields: SmartGridColumnDefinition[];
+}
+
+export declare interface SmartGridPivotFilterConditionOption {
+    value: string;
+    label: string;
+}
+
+export declare interface SmartGridPivotFilterConditions {
+    number?: SmartGridPivotFilterConditionOption[];
+    text?: SmartGridPivotFilterConditionOption[];
+}
+
+export declare interface SmartGridPivotFilterItem {
+    id: string;
+    name: string;
+    value: string;
+    mode: SmartGridFilterMode;
+    condition?: string;
+}
+
+export declare interface SmartGridPivotFiltersSectionProps {
+    items: SmartGridColumnDefinition[];
+    defaultExpanded?: boolean;
+    onDrop: (column: SmartGridColumnDefinition) => void;
+    onRemoveItem: (id: string) => void;
+    onFilterValueChange: (id: string, value: string) => void;
+    onFilterModeChange?: (id: string, mode: SmartGridFilterMode) => void;
+    onFilterConditionChange?: (id: string, condition: string) => void;
+    onClearAll?: () => void;
+}
+
+export declare interface SmartGridPivotFooterProps {
+    onCancel: () => void;
+    onSave?: () => void;
+    onApply?: () => void;
+    isSaveDisabled?: boolean;
+    isApplyDisabled?: boolean;
+    isHideSave?: boolean;
+    cancelText?: string;
+    saveText?: string;
+    applyText?: string;
+}
+
+export declare interface SmartGridPivotHeaderProps {
+    title: string;
+    onClose: () => void;
+}
+
+export declare type SmartGridPivotMode = "saved" | "create";
+
+export declare interface SmartGridPivotNotificationProps {
+    message: string;
+    defaultVisible?: boolean;
+    onClose?: () => void;
+}
+
+export declare interface SmartGridPivotPanelProps {
+    isOpen: boolean;
+    onClose: () => void;
+    onSave: (state: SmartGridPivotSavePayload) => void;
+    availableFields: SmartGridColumnDefinition[];
+    versions?: SmartGridPivotVersion[];
+    selectedVersion?: SmartGridPivotVersion;
+    onVersionChange?: (version: SmartGridPivotVersion) => void;
+    initialState?: Partial<SmartGridPivotState>;
+    showNotification?: boolean;
+    onNotificationClose?: () => void;
+    pivotAggrValues?: SmartGridPivotAggregationOption[];
+    pivotFilterConditions?: SmartGridPivotFilterConditions;
+    pivotChildren?: React.ReactNode;
+    savedPivots?: SmartGridPivotState[];
+    recentlyUsedPivots?: SmartGridPivotState[];
+    onDeleteSavedPivot?: (pivotId: string) => void;
+    onEditSavedPivot?: (pivot: SmartGridPivotState) => void;
+    defaultMode?: SmartGridPivotMode;
+    handlePivotApply?: (state: SmartGridPivotState) => void;
+    isHidePivotSave?: boolean;
+    showTotalsSection?: boolean;
+    pivotAggregationFunc?: SmartGridSelectOption[];
+    isPivotRowGrandTotal?: boolean;
+    isPivotColumnGrandTotal?: boolean;
+    isPivotRowSubTotal?: boolean;
+    isPivotColumnSubTotal?: boolean;
+    isHideFilters?: boolean;
+    isHideValues?: boolean;
+}
+
+export declare type SmartGridPivotSaveHandler = {
+    handlePivotSave?: (state: SmartGridPivotSavePayload, setIsPivotOpen: Dispatch<SetStateAction<boolean>>) => void;
+    handlePivotApply?: (state: SmartGridPivotSavePayload, setIsPivotOpen: Dispatch<SetStateAction<boolean>>) => void;
+};
+
+export declare interface SmartGridPivotSavePayload extends SmartGridPivotState {
+    isReplace?: boolean;
+    isUpdated?: boolean;
+    oldName?: string;
+}
+
+export declare interface SmartGridPivotSectionProps {
+    title: string;
+    type: SmartGridPivotSectionType;
+    isExpanded: boolean;
+    onToggleExpand: () => void;
+    children?: React.ReactNode;
+}
+
+export declare interface SmartGridPivotSectionState {
+    items: SmartGridColumnDefinition[];
+}
+
+export declare type SmartGridPivotSectionType = "rows" | "columns" | "values" | "filters" | "totals";
+
+export declare interface SmartGridPivotState {
+    id?: string;
+    name: string;
+    viewType?: SmartGridPivotViewType;
+    isDefault?: boolean;
+    rows: SmartGridPivotSectionState;
+    columns: SmartGridPivotSectionState;
+    values: SmartGridPivotSectionState;
+    filters: SmartGridPivotSectionState;
+    totals: SmartGridPivotTotalsState;
+}
+
+export declare interface SmartGridPivotTotalsState {
+    showRowGrandTotal: boolean;
+    showColumnGrandTotal: boolean;
+    showRowSubTotal: boolean;
+    showColumnSubTotal: boolean;
+}
+
+export declare interface SmartGridPivotValueItem {
+    id: string;
+    name: string;
+    aggregation: SmartGridAggregationType;
+}
+
+export declare interface SmartGridPivotValuesSectionProps {
+    items: SmartGridColumnDefinition[];
+    defaultExpanded?: boolean;
+    onDrop: (column: SmartGridColumnDefinition) => void;
+    onRemoveItem: (id: string) => void;
+    onAggregationChange: (id: string, aggregation: SmartGridAggregationType) => void;
+    onClearAll?: () => void;
+    pivotAggregationFunc?: SmartGridSelectOption[];
+}
+
+export declare interface SmartGridPivotVersion {
+    value: string;
+    label: string;
+}
+
+export declare interface SmartGridPivotVersionSelectProps {
+    label: string;
+    versions: SmartGridPivotVersion[];
+    selectedVersion: SmartGridPivotVersion | null;
+    onVersionChange: (version: SmartGridPivotVersion) => void;
+}
+
+export declare type SmartGridPivotViewType = "global" | "personal";
+
+export declare interface SmartGridPivotWrapperProps {
+    pivotConfig: SmartGridPivotConfig;
+    shouldRenderTable: boolean;
+    showSaveTableConfig: boolean;
+}
+
 export declare interface SmartGridPromptButton {
     label: string;
     type: "default" | "primary" | "secondary";
@@ -2347,6 +2586,7 @@ export declare interface SmartGridRadioGroupProps {
     orientation?: SmartGridRadioOrientation;
     disabled?: boolean;
     name?: string;
+    className?: string;
 }
 
 export declare interface SmartGridRadioOption {
@@ -2571,6 +2811,7 @@ export declare interface SmartGridRowRenderProps {
     scrollContainerRef: RefObject<HTMLDivElement>;
     rowHeightCache: RowHeightCache | null;
     adjustTableHeightServerSide?: boolean;
+    height: string | number;
 }
 
 export declare interface SmartGridRowSpanInfo {
@@ -2729,6 +2970,7 @@ export declare interface SmartGridSelectProps {
     isCellRenderer?: boolean;
     tableApi?: SmartGridAPI | null;
     lazyLoadCellRenderer?: boolean;
+    isEnableResetButton?: boolean;
 }
 
 export declare interface SmartGridServerProps {
@@ -2941,6 +3183,7 @@ export declare interface SmartGridStateContext {
         isSavingViewLoading?: boolean;
         savedViewsOptions?: SmartGridSavedViewsOptions[];
     } & Record<string, unknown>;
+    pivotPanelColumnDef: null | SmartGridColumnDefinition[];
     [key: string]: unknown;
 }
 
@@ -3080,6 +3323,7 @@ export declare interface SmartGridTableContentProps {
     copyToClipboardHandler?: () => void;
     downloadExcelHandler?: () => void;
     downloadCSVHandler?: () => void;
+    pivotConfig?: SmartGridPivotConfig;
 }
 
 export declare interface SmartGridTableContentRendererProps {
@@ -3306,6 +3550,7 @@ export declare interface SmartGridTableProps extends SmartGridSaveViewCallbackRe
     hasSplitRenderer?: boolean;
     splitRendererKeys?: string[];
     removeSelectionOnOperation?: boolean;
+    pivotConfig?: SmartGridPivotConfig;
 }
 
 export declare interface SmartGridTableRef {