gantri-components 2.34.0-beta.5 → 2.34.0-beta.7

package/dist/components/table/components/table-footer/table-footer.d.ts

@@ -1,3 +1,3 @@
-import { BaseDataType } from '../../table.types';
+import { BaseTableDataType } from '../../table.types';
 import { TableFooterProps } from './table-footer.types';
-export declare const TableFooter: <DataType extends BaseDataType>(props: TableFooterProps<DataType>) => JSX.Element;
+export declare const TableFooter: <DataType extends BaseTableDataType>(props: TableFooterProps<DataType>) => JSX.Element;

package/dist/components/table/components/table-footer/table-footer.types.d.ts

@@ -1,5 +1,5 @@
 import { Table } from '@tanstack/react-table';
-import { BaseDataType } from '../../table.types';
-export type TableFooterProps<DataType extends BaseDataType> = {
+import { BaseTableDataType } from '../../table.types';
+export type TableFooterProps<DataType extends BaseTableDataType> = {
     table: Table<DataType>;
 };

package/dist/components/table/components/table-header/table-header.d.ts

@@ -1,3 +1,3 @@
-import { BaseDataType } from '../../table.types';
+import { BaseTableDataType } from '../../table.types';
 import { TableHeaderProps } from './table-header.types';
-export declare const TableHeader: <DataType extends BaseDataType>(props: TableHeaderProps<DataType>) => JSX.Element;
+export declare const TableHeader: <DataType extends BaseTableDataType>(props: TableHeaderProps<DataType>) => JSX.Element;

package/dist/components/table/components/table-header/table-header.types.d.ts

@@ -1,6 +1,6 @@
 import { Table } from '@tanstack/react-table';
-import { BaseDataType, GetHeaderCellProps } from '../../table.types';
-export type TableHeaderProps<DataType extends BaseDataType> = {
+import { BaseTableDataType, GetHeaderCellProps } from '../../table.types';
+export type TableHeaderProps<DataType extends BaseTableDataType> = {
     getHeaderCellProps: GetHeaderCellProps<DataType> | undefined;
     table: Table<DataType>;
 };

package/dist/components/table/components/table-row/hooks/use-drag-and-drop/use-drag-and-drop.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
-import { BaseDataType } from '../../../../table.types';
+import { BaseTableDataType } from '../../../../table.types';
 import { UseDragAndDropProps } from './use-drag-and-drop.types';
-export declare const useDragAndDrop: <DataType extends BaseDataType>(props: UseDragAndDropProps<DataType>) => {
+export declare const useDragAndDrop: <DataType extends BaseTableDataType>(props: UseDragAndDropProps<DataType>) => {
     dragAndDropRef: import("react").RefObject<HTMLTableRowElement>;
     isDragging: boolean;
 };

package/dist/components/table/components/table-row/hooks/use-drag-and-drop/use-drag-and-drop.types.d.ts

@@ -1,6 +1,6 @@
 import { Row } from '@tanstack/react-table';
-import { BaseDataType } from '../../../../table.types';
-export interface UseDragAndDropProps<DataType extends BaseDataType> {
+import { BaseTableDataType } from '../../../../table.types';
+export interface UseDragAndDropProps<DataType extends BaseTableDataType> {
     enableReordering: boolean;
     handleOnReorder: () => Promise<void>;
     index: number;

package/dist/components/table/components/table-row/table-row.d.ts

@@ -1,3 +1,3 @@
-import { BaseDataType } from '../../table.types';
+import { BaseTableDataType } from '../../table.types';
 import { TableRowProps } from './table-row.types';
-export declare const TableRow: <DataType extends BaseDataType>(props: TableRowProps<DataType>) => JSX.Element;
+export declare const TableRow: <DataType extends BaseTableDataType>(props: TableRowProps<DataType>) => JSX.Element;

package/dist/components/table/components/table-row/table-row.types.d.ts

@@ -1,6 +1,6 @@
 import { Row } from '@tanstack/react-table';
-import { BaseDataType, CustomRowProps, GetCellProps, OnRowClick } from '../../table.types';
-export interface TableRowProps<DataType extends BaseDataType> {
+import { BaseTableDataType, CustomRowProps, GetCellProps, OnRowClick } from '../../table.types';
+export interface TableRowProps<DataType extends BaseTableDataType> {
     customRowProps: CustomRowProps;
     enableReordering: boolean;
     getCellProps: GetCellProps<DataType> | undefined;

package/dist/components/table/helpers/add-missing-ids/index.d.ts

@@ -1,3 +1,3 @@
-import { BaseDataType } from '../../table.types';
+import { BaseTableDataType } from '../../table.types';
 /** If an index does not contain an `id` value, one is added using uuid. */
-export declare const addMissingIds: <DataType extends BaseDataType>(data: DataType[]) => DataType[];
+export declare const addMissingIds: <DataType extends BaseTableDataType>(data: DataType[]) => DataType[];

package/dist/components/table/table.d.ts

@@ -1,5 +1,5 @@
-import { BaseDataType, TableProps } from './table.types';
+import { BaseTableDataType, TableProps } from './table.types';
 export declare const Table: {
-    <DataType extends BaseDataType>(props: TableProps<DataType>): JSX.Element;
+    <DataType extends BaseTableDataType>(props: TableProps<DataType>): JSX.Element;
     defaultProps: import("./table.types").TableDefaultProps;
 };

package/dist/components/table/table.types.d.ts

@@ -3,15 +3,16 @@ import { HTMLAttributes, MouseEvent } from 'react';
 import { PagingProps } from '../paging/paging.types';
 import { CustomActionProps, FiltersProps, SearchProps } from './components/table-actions-wrapper';
 import { SortProps } from './components/table-actions-wrapper/components/sort/sort.types';
-export interface BaseDataType {
-    [key: string]: unknown;
-    id?: string | number;
-    subRows?: BaseDataType[];
-}
-export interface TableProps<DataType extends BaseDataType> extends Partial<TableDefaultProps> {
+export type BaseTableDataType = Record<any, any>;
+export interface TableProps<DataType extends BaseTableDataType> extends Partial<TableDefaultProps> {
     className?: string;
     columns: ColumnDef<DataType, any>[];
     customAction?: CustomActionProps;
+    /**
+     * For each index, if no `id` key exists, one will be assigned.
+     *
+     * To create collapsable rows, optionally provide the index with a `subRows` key. It should be an array of objects matching the expected data type.
+     */
     data: DataType[];
     enableReordering?: boolean;
     filters?: FiltersProps;
@@ -29,10 +30,10 @@ export interface TableProps<DataType extends BaseDataType> extends Partial<Table
 export interface TableDefaultProps {
     stickyFirstColumn: boolean;
 }
-export type GetHeaderCellProps<DataType extends BaseDataType> = (cell: Header<DataType, unknown>) => CustomCellProps;
-export type GetRowProps<DataType extends BaseDataType> = (row: Row<DataType>, rows: Row<DataType>[]) => CustomRowProps;
-export type GetCellProps<DataType extends BaseDataType> = (cell: Cell<DataType, unknown>) => CustomCellProps;
-export type OnRowClick<DataType extends BaseDataType> = (data: Row<DataType>, event: MouseEvent<HTMLTableRowElement>) => void;
+export type GetHeaderCellProps<DataType extends BaseTableDataType> = (cell: Header<DataType, unknown>) => CustomCellProps;
+export type GetRowProps<DataType extends BaseTableDataType> = (row: Row<DataType>, rows: Row<DataType>[]) => CustomRowProps;
+export type GetCellProps<DataType extends BaseTableDataType> = (cell: Cell<DataType, unknown>) => CustomCellProps;
+export type OnRowClick<DataType extends BaseTableDataType> = (data: Row<DataType>, event: MouseEvent<HTMLTableRowElement>) => void;
 export interface CustomRowProps extends Record<string, unknown>, HTMLAttributes<HTMLTableRowElement> {
     status?: RowStatusValue | undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gantri-components",
-  "version": "2.34.0-beta.5",
+  "version": "2.34.0-beta.7",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "umd": "dist/index.umd.js",
@@ -64,6 +64,7 @@
     "@storybook/testing-library": "^0.0.13",
     "@storybook/theming": "^6.5.12",
     "@svgr/cli": "^6.2.1",
+    "@tanstack/react-table": "^8.9.1",
     "@testing-library/dom": "^8.17.1",
     "@testing-library/jest-dom": "^5.16.5",
     "@testing-library/react": "^12.1.5",
@@ -126,7 +127,6 @@
   },
   "dependencies": {
     "@cloudinary/url-gen": "^1.7.0",
-    "@tanstack/react-table": "^8.9.1",
     "@types/lodash": "^4.14.182",
     "@types/react-dom": "^17.0.17",
     "formik": "^2.2.9",