ia-table 0.9.2 → 0.10.1

package/dist/components/IATable/types/columns.type.ts

@@ -0,0 +1,185 @@
+import { CSSProperties } from "react";
+import { SmartGridAPI, SmartGridRowData } from "./api.type";
+import {
+  SmartGridNewSortModel,
+  SmartGridSortModel,
+  SmartGridUpdateData,
+} from "./common.type";
+
+export interface SmartGridValueFormatterParams {
+  value: unknown;
+  data: SmartGridRowData;
+  colDef: SmartGridColumnDefinition;
+}
+export interface SmartGridValueGetterParams {
+  data: SmartGridRowData;
+  node: {
+    data: SmartGridRowData;
+  };
+  colDef: SmartGridColumnDefinition;
+  column: SmartGridColumnDefinition;
+  api: SmartGridAPI;
+  columnApi?: unknown;
+  getValue: (field: string) => unknown;
+}
+
+export type SmartGridCellRenderer = {
+  value: unknown;
+  data: SmartGridRowData;
+  rowIndex: number;
+  colIndex: number;
+  column: SmartGridColumnDefinition;
+  colDef: SmartGridColumnDefinition;
+  node: {
+    data: SmartGridRowData;
+    rowIndex: number;
+    id: string | number;
+    parent: SmartGridUpdateData & {
+      id: string | number;
+      level: number;
+      setExpanded: () => void;
+    };
+    setDataValue: (colId: string, newValue: unknown) => void;
+    childrenMapped: Record<string, string>;
+    allLeafChildren: Record<string, string>;
+    group: boolean;
+    level: number;
+    childIndex: number;
+    isSelected: () => boolean;
+    isExpandable: () => boolean;
+    isExpanded: () => boolean;
+  };
+  api: SmartGridAPI;
+  eGridCell: React.HTMLAttributes<HTMLDivElement>;
+  wholeData: SmartGridRowData[];
+  actions: Record<string, unknown>;
+  setDataValue: (colId: string, newValue: unknown) => void;
+};
+export type SmartGridCellRendererParams = Record<string, unknown>;
+
+export type SmartGridHeaderStyleParams = {
+  column: SmartGridColumnDefinition;
+  displayName: string;
+  enableSorting: boolean;
+  sortState: SmartGridNewSortModel;
+  onSort: (field: string, direction: string) => void;
+  isSearchable: boolean;
+  showSortIcon: boolean;
+  toggleSearchModal: (e: React.MouseEvent<HTMLElement>) => void;
+  hasFilters: boolean;
+  isExpandable: boolean;
+  onToggle: (field: string, isExpandable: boolean) => void;
+  api: SmartGridAPI;
+  availableWidth: number;
+  wrapHeaderText: boolean;
+  menuButtonRef: React.RefObject<HTMLElement>;
+  menuToggle: (e: React.MouseEvent<HTMLElement>) => void;
+  toggleAdvancedSeach: (value: boolean) => void;
+};
+export interface SmartGridColumnDefinition {
+  field: string;
+  headerName?: string;
+  column_name?: string;
+  label?: string;
+  width?: number;
+  minWidth?: number;
+  maxWidth?: number;
+  hide?: boolean;
+  hidden?: boolean;
+  pinned?: "left" | "right" | boolean | null;
+  is_frozen?: boolean;
+  children?: SmartGridColumnDefinition[];
+  parent_id?: string | number;
+  type?: string;
+  cellDataType?: string;
+  valueFormatter?: (params: SmartGridValueFormatterParams) => string;
+  valueGetter?: (params: SmartGridValueGetterParams) => unknown;
+  leftTotalWidth?: number;
+  originalWidth?: number;
+  isAutoWidth?: boolean;
+  filterable?: boolean;
+  isSortable?: boolean;
+  is_sortable?: boolean;
+  resizable?: boolean;
+  align?: "left" | "center" | "right";
+  cellRenderer?: string | ((params: SmartGridCellRenderer) => JSX.Element);
+  cellRendererParams?: SmartGridCellRendererParams;
+  cellClassName?: string;
+  cellStyle?: {
+    textAlign?: "left" | "center" | "right";
+    [key: string]: unknown;
+  };
+  autoHeight?: boolean;
+  wrapHeaderText?: boolean;
+  editable?: boolean;
+  is_editable?: boolean;
+  is_disabled?: boolean;
+  is_searchable?: boolean;
+  isSearchable?: boolean;
+  advanceSearchEnabled?: boolean;
+  sortable?: boolean;
+  rowGroup?: boolean;
+  enableRowGroup?: boolean;
+  rowGroupIndex?: number;
+  aggFunc?: string;
+  columnGroupShow?: "open" | "closed";
+  originalIndex?: number;
+  parentColumns?: string[];
+  hasChildren?: boolean;
+  hasAnyFrozenChildren?: boolean;
+  hasAnyRightPinnedChildren?: boolean;
+  isChildWithoutParent?: boolean;
+  colorClass?: string;
+  isLeaf?: boolean;
+  isStandalone?: boolean;
+  isWithEmptyHeaderName?: boolean;
+  isParentWithChildEmptyHeaderName?: boolean;
+  path?: string[];
+  parentField?: string | null;
+  originalFields?: string[];
+  colId?: string;
+  colSpan?: number;
+  rowSpan?: number;
+  comparator?: (
+    valueA: unknown,
+    valueB: unknown,
+    nodeA: unknown,
+    nodeB: unknown,
+    sortModel: SmartGridSortModel
+  ) => number;
+  headerTooltip?: string;
+  filter?: string | boolean;
+  filterParams?: {
+    filterOptions?: string[];
+    textCustomComparator?: (
+      filter: string,
+      value: unknown,
+      filterText: string
+    ) => boolean;
+    numberCustomComparator?: (filter: number, value: unknown) => boolean;
+    dateCustomComparator?: (
+      filterLocalDateAtMidnight: Date,
+      cellValue: string
+    ) => number;
+    comparator?: (filterValue: unknown, cellValue: unknown) => boolean;
+    [key: string]: unknown;
+  };
+  order_of_display?: number;
+  is_hidden?: boolean;
+  formatter?: string | null;
+  accessor?: string;
+  id?: string;
+  required?: boolean;
+  sub_headers?: SmartGridColumnDefinition[];
+  extra?: {
+    width?: number;
+    is_grouping_key?: boolean;
+    is_disabled?: boolean;
+    isDisabled?: boolean;
+    columnGroupShow?: "open" | "closed";
+    [key: string]: unknown;
+  };
+  headerComponent: React.FC<SmartGridHeaderStyleParams>;
+  headerStyle?: (params: SmartGridHeaderStyleParams) => CSSProperties;
+  [key: string]: unknown;
+}

package/dist/components/IATable/types/common.type.ts

@@ -0,0 +1,62 @@
+import { SmartGridRowData } from "./api.type";
+
+export type SmartGridSortDirection = "asc" | "desc" | "none";
+
+export type SmartGridUpdateData = {
+  data: SmartGridRowData;
+  setData: (data: SmartGridRowData) => void;
+  setDataValue: (field: string, value: unknown, callback?: () => void) => void;
+};
+
+export interface SmartGridRowNode extends SmartGridUpdateData {
+  id: string | number;
+  childIndex?: number;
+  selected: boolean;
+  rowIndex?: number;
+  absoluteRowIndex?: number;
+  originalData?: SmartGridRowData;
+  rowHeight?: number;
+  setSelected: (selected: boolean, clearSelection?: boolean) => void;
+  isGroup?: () => boolean;
+}
+
+export interface SmartGridOldSortModel {
+  colId: string;
+  sort: SmartGridSortDirection;
+}
+
+export interface SmartGridNewSortModel {
+  column: string;
+  order: string;
+}
+
+export type SmartGridSortModel =
+  | SmartGridOldSortModel
+  | SmartGridNewSortModel
+  | null;
+
+export type SmartGridStringFilter = {
+  column: string;
+  pattern: string;
+  search_type: string;
+  operator?: string;
+};
+
+export type SmartGridRangeFilter = {
+  column: string;
+  min_val: number;
+  max_val: number;
+  search_type: string;
+  operator?: string;
+};
+
+export interface SmartGridFilterModel {
+  pattern: string;
+  search_type: string;
+  column?: string;
+  field?: string;
+  min_val?: number;
+  max_val?: number;
+  type?: string;
+  operator?: string;
+}

package/dist/components/IATable/types/index.type.ts

@@ -0,0 +1,7 @@
+// Export all types from all type files using wildcard exports
+export * from "./api.type";
+export * from "./cache.type";
+export * from "./columns.type";
+export * from "./common.type";
+export * from "./reducer.type";
+export * from "./table.type";

package/dist/components/IATable/types/reducer.type.ts

@@ -0,0 +1,3 @@
+export interface SmartGridStateContext {
+  [key: string]: any;
+}

package/dist/components/IATable/types/svg.d.ts

@@ -0,0 +1,5 @@
+declare module "*.svg" {
+  import React from "react";
+  const SVGComponent: React.FC<React.SVGProps<SVGSVGElement>>;
+  export default SVGComponent;
+}

package/dist/components/IATable/types/table.type.ts

@@ -0,0 +1,200 @@
+import { CSSProperties, ReactNode, Ref } from "react";
+import {
+  SmartGridColumnDefinition,
+  SmartGridHeaderStyleParams,
+} from "./columns.type";
+import {
+  SmartGridAPI,
+  SmartGridCellValueChangedParams,
+  SmartGridGetRowDataParams,
+  SmartGridRowData,
+} from "./api.type";
+import { SmartGridSortModel } from "./common.type";
+
+export interface SmartGridTableRef {
+  api: SmartGridAPI;
+}
+
+export interface SmartGridRowDragStartParams {
+  api: SmartGridAPI;
+  type: "rowDragStart";
+  rowIndex: number;
+  rowData: SmartGridRowData;
+}
+
+export interface SmartGridRowDragEndParams {
+  api: SmartGridAPI;
+  type: "rowDragEnd";
+  fromIndex: number;
+  toIndex: number;
+  rowData: SmartGridRowData;
+}
+
+export type SmartGridOnReadyParams = {
+  api: SmartGridAPI;
+  columnApi: SmartGridAPI;
+  type: "gridReady";
+};
+
+export type SmartGridRowGrouOpenParams = {
+  rowId: string;
+  rowIndex: number;
+  api: SmartGridAPI;
+  isExpanded: boolean;
+};
+
+export type SmartGridOnSelectionChangedParams = {
+  api: SmartGridAPI;
+  type: string;
+  source: string;
+};
+
+export type SmartGridRowStyleParams = {
+  api: SmartGridAPI;
+  data: SmartGridRowData;
+  pinned: boolean;
+  node: {
+    rowIndex: number;
+    data: SmartGridRowData;
+    api: SmartGridAPI;
+    pinned: boolean;
+  };
+};
+
+export type SmartGridDefaultColDef = {
+  minWidth: number;
+  headerComponentParams?: {
+    innerHeaderComponent:
+      | ((params: SmartGridHeaderStyleParams) => ReactNode)
+      | null;
+  };
+  headerComponent?: ((params: SmartGridHeaderStyleParams) => ReactNode) | null;
+};
+
+export type SmartGridTableProps = {
+  ref?: Ref<SmartGridTableRef>;
+  data?: SmartGridRowData[];
+  columns: SmartGridColumnDefinition[];
+  height?: number | string;
+  uniqueIdField: string;
+  childKeyField?: string;
+  defaultColDef?: SmartGridDefaultColDef;
+  pinnedTopRowData?: SmartGridRowData[];
+  pinnedBottomRowData?: SmartGridRowData[];
+  getRowStyle?: (params: SmartGridRowStyleParams) => CSSProperties;
+  tableHeader?: string | ReactNode;
+  topRightOptions?: string | ReactNode;
+  bottomLeftOptions?: string | ReactNode;
+  bottomCenterOptions?: string | ReactNode;
+  bottomRightOptions?: string | ReactNode;
+  topLeftOptions?: string | ReactNode;
+  headerHeight?: number | string;
+  onSelectionChanged?: (event: SmartGridOnSelectionChangedParams) => void;
+  onRowDragStart?: (event: SmartGridRowDragStartParams) => void;
+  onRowDragEnd?: (event: SmartGridRowDragEndParams) => void;
+  onCellValueChanged?: (params: SmartGridCellValueChangedParams) => void;
+  onGridReady?: (params: SmartGridOnReadyParams) => void;
+  onRowGroupOpened?: (params: SmartGridRowGrouOpenParams) => void;
+  fetchData?: (
+    manualbody: any,
+    page: any,
+    context: any,
+    pageNo: any,
+    other: any
+  ) => Promise<any>;
+  apiUrl?: string;
+  autoFetch?: boolean;
+  cacheConfig?: {
+    threshold?: number;
+    maxBlocksInCache?: number;
+    cacheOverflowSize?: number;
+    rowHeight?: number;
+    purgeStrategy?: string;
+    enablePersistence?: boolean;
+    persistenceStorageKey?: string;
+    persistenceOptions?: any;
+    force?: boolean;
+  };
+  onScroll?: (event: any) => void;
+  showSaveTableConfig?: boolean;
+  loadTableInstance?: (api: SmartGridAPI) => void;
+  adjustTableHeightServerSide?: boolean;
+  largeDatasetOptions?: {
+    enableIndexedDBCache?: boolean;
+    enableStreamingLoad?: boolean;
+    enableEnhancedWorker?: boolean;
+    binaryFormat?: boolean;
+    extremelyLargeDatasetThreshold?: number;
+  };
+  gridOptions?: any;
+  tableId?: string;
+  alignedGrids?: any[];
+  masterDetail?: boolean;
+  detailCellRenderer?: any;
+  detailRowHeight?: number;
+  infiniteScroll?: boolean;
+  customTabFunction?: any;
+  getRowData?: (params: SmartGridGetRowDataParams, columnName: string) => any;
+  rowDragManaged?: boolean;
+  hidePaginationPageSizeSelector?: boolean;
+  purgeClosedRowNodes?: boolean;
+  detailRendererTable?: boolean;
+  smartGridMenuOptions?: {
+    withColumMenu?: boolean;
+    autoWithColumMenu?: boolean;
+    freezeColumnMenu?: boolean;
+    sortColumnMenu?: boolean;
+    collapseColumnAll?: boolean;
+    expandColumnAll?: boolean;
+    wrapText?: boolean;
+    [key: string]: any;
+  };
+  paginateOriginalRowsOnly?: boolean;
+  isSaveViewEnabled?: boolean;
+  isSavingViewLoading?: boolean;
+  maxSavedViews?: number;
+  deleteViewPromptText?: string;
+  savedViewsOptions?: any[];
+  handleSetDefaultView?: (view: any) => void;
+  handleSavedViewClick?: (view: any) => void;
+  handleEditSaveView?: (view: any) => void;
+  handleSaveAndApply?: (view: any) => void;
+  handleDeleteViewClick?: (view: any) => void;
+  rowHeight?: string;
+  additionalButtons?: string | ReactNode;
+  aboveTableComponent?: string | ReactNode;
+  shouldRenderTable?: boolean;
+  nestedTable?: boolean;
+  nestedTableComponent?: Function | ReactNode;
+  enableNestedTableCloseButton?: boolean;
+  downloadAsExcel?: boolean;
+  downloadAsCSV?: boolean;
+  copyToClipboard?: boolean;
+  onCloseNestedTable?: () => void;
+  downloadExcelHandler?: () => void;
+  downloadCSVHandler?: () => void;
+  copyToClipboardHandler?: () => void;
+  ShowFullText?: boolean;
+  hideNotification?: boolean;
+  isSingleSelect?: boolean;
+  defaultPageSize?: number;
+  paginationPageSize?: number[];
+  enableRowSpan?: boolean;
+  rowSpanColumn?: string | string[];
+  showHeader?: boolean;
+  showFooter?: boolean;
+  showToolbar?: boolean;
+  selectable?: boolean;
+  defaultSort?: SmartGridSortModel;
+  actions?: Record<string, any>;
+  pagination?: boolean;
+  showTableSettingActionTab?: boolean;
+  showTableSettingFormatTab?: boolean;
+  showFilters?: boolean;
+  expandable?: boolean;
+  onCellClicked?: () => void;
+  onCellClick?: () => void;
+  onRowClicked?: () => void;
+  onRowClick?: () => void;
+  [key: string]: any;
+};