gantri-components 2.40.0-beta.6 → 2.40.0-beta.7

package/dist/components/table/components/custom-columns-wrapper/custom-columns-wrapper.d.ts

@@ -1,7 +1,7 @@
 import { RowData } from '@tanstack/react-table';
 import { CustomColumnsWrapperProps } from './custom-columns-wrapper.types';
-export declare const CustomColumnsWrapper: <DataType extends RowData<{
+export declare const CustomColumnsWrapper: <TData extends RowData<{
     [key: string]: unknown;
     id?: string | number | undefined;
     subRows?: any[] | undefined;
-}>>(props: CustomColumnsWrapperProps<DataType>) => JSX.Element;
+}>>(props: CustomColumnsWrapperProps<TData>) => JSX.Element;

package/dist/components/table/components/custom-columns-wrapper/custom-columns-wrapper.types.d.ts

@@ -1,8 +1,8 @@
 import { RowData, Table } from '@tanstack/react-table';
 import { PropsWithChildren } from 'react';
-export interface CustomColumnsProps<DataType extends RowData> {
-    disabledColumns: (keyof DataType | string)[];
-    hiddenColumns: (keyof DataType | string)[];
+export interface CustomColumnsProps<TData extends RowData> {
+    disabledColumns: (keyof TData | string)[];
+    hiddenColumns: (keyof TData | string)[];
     onUpdateHiddenColumns: (columnsToHide: string[]) => Promise<void>;
 }
 export interface CustomColumnOption {
@@ -12,8 +12,8 @@ export interface CustomColumnOption {
     onChange: (event: unknown) => void;
     value: string;
 }
-export type CustomColumnsWrapperProps<DataType extends RowData> = PropsWithChildren<{
-    customColumns: CustomColumnsProps<DataType> | undefined;
-    table: Table<DataType>;
+export type CustomColumnsWrapperProps<TData extends RowData> = PropsWithChildren<{
+    customColumns: CustomColumnsProps<TData> | undefined;
+    table: Table<TData>;
     tableContainerEl: HTMLDivElement | null;
 }>;

package/dist/components/table/components/custom-columns-wrapper/helpers/get-custom-column-initial-visibility/get-custom-column-initial-visibility.d.ts

@@ -1 +1,30 @@
+/**
+ * Used to mark the starting hidden columns when using custom columns.
+ *
+ * @example
+ * const [hiddenColumns, setHiddenColumns] = useState<string[]>(STARTING_HIDDEN_COLUMNS);
+ * const initialColumnVisibility = getCustomColumnInitialVisibility(hiddenColumns);
+ * const [columnVisibility, setColumnVisibility] = useState(initialColumnVisibility);
+ *
+ * return (
+ *   <TableComponent
+ *     data={tableData}
+ *     columns={tableColumns}
+ *     options={{
+ *       state: {
+ *         columnVisibility,
+ *       },
+ *       onColumnVisibilityChange: setColumnVisibility,
+ *     }}
+ *     customColumns={{
+ *       disabledColumns: [DISABLED_COLUMNS],
+ *       onUpdateHiddenColumns: async columns => {
+ *         // REQUEST API HIDE COLUMNS
+ *         setHiddenColumns(columns);
+ *       },
+ *       hiddenColumns: hiddenColumns,
+ *     }}
+ *   />
+ * )
+ */
 export declare const getCustomColumnInitialVisibility: (hiddenColumns: string[]) => {};

package/dist/components/table/components/custom-columns-wrapper/helpers/get-custom-column-options/get-custom-column-options.d.ts

@@ -1,8 +1,8 @@
 import { RowData } from '@tanstack/react-table';
 import { CustomColumnOption } from '../../custom-columns-wrapper.types';
 import { GetCustomColumnOptionsArgs } from './get-custom-column-options.types';
-export declare const getCustomColumnOptions: <DataType extends RowData<{
+export declare const getCustomColumnOptions: <TData extends RowData<{
     [key: string]: unknown;
     id?: string | number | undefined;
     subRows?: any[] | undefined;
-}>>(args: GetCustomColumnOptionsArgs<DataType>) => CustomColumnOption[];
+}>>(args: GetCustomColumnOptionsArgs<TData>) => CustomColumnOption[];

package/dist/components/table/components/custom-columns-wrapper/helpers/get-custom-column-options/get-custom-column-options.types.d.ts

@@ -1,6 +1,6 @@
 import { RowData, Table } from '@tanstack/react-table';
 import { CustomColumnsProps } from '../../custom-columns-wrapper.types';
-export interface GetCustomColumnOptionsArgs<DataType extends RowData> {
-    customColumns: CustomColumnsProps<DataType> | undefined;
-    table: Table<DataType>;
+export interface GetCustomColumnOptionsArgs<TData extends RowData> {
+    customColumns: CustomColumnsProps<TData> | undefined;
+    table: Table<TData>;
 }

package/dist/components/table/components/table-actions-wrapper/hooks/use-confirm-interaction/use-confirm-interaction.d.ts

@@ -1,10 +1,10 @@
 import { RowData } from '@tanstack/react-table';
 import { UseConfirmInteractionProps, OnConfirmInteraction } from './use-confirm-interaction.types';
-export declare const useConfirmInteraction: <DataType extends RowData<{
+export declare const useConfirmInteraction: <TData extends RowData<{
     [key: string]: unknown;
     id?: string | number | undefined;
     subRows?: any[] | undefined;
-}>>(props: UseConfirmInteractionProps<DataType>) => {
+}>>(props: UseConfirmInteractionProps<TData>) => {
     /** Not necessary for `onConfirmInteraction`. Only provided in case additional logic is needed. */
     confirmAllInteractions: boolean;
     /** If applicable, renders a discard selections confirmation modal when called. */

package/dist/components/table/components/table-actions-wrapper/hooks/use-confirm-interaction/use-confirm-interaction.types.d.ts

@@ -1,6 +1,6 @@
 import { RowData, Table } from '@tanstack/react-table';
 export type TableInteraction = 'FOCUS_SEARCH' | 'OPEN_FILTERS' | 'OPEN_SORT' | 'USE_PAGING' | 'CUSTOM_ACTION';
-export interface UseConfirmInteractionProps<DataType extends RowData> {
-    table: Table<DataType>;
+export interface UseConfirmInteractionProps<TData extends RowData> {
+    table: Table<TData>;
 }
 export type OnConfirmInteraction = (interaction: TableInteraction) => Promise<boolean>;

package/dist/components/table/components/table-actions-wrapper/table-actions-wrapper.d.ts

@@ -2,8 +2,8 @@ import React, { PropsWithChildren } from 'react';
 import { RowData } from '@tanstack/react-table';
 import { TableActionsWrapperProps } from './table-actions-wrapper.types';
 /** Wraps the table with relevant components for paging, filters, sort, and table actions. */
-export declare const TableActionsWrapper: <DataType extends RowData<{
+export declare const TableActionsWrapper: <TData extends RowData<{
     [key: string]: unknown;
     id?: string | number | undefined;
     subRows?: any[] | undefined;
-}>>(props: React.PropsWithChildren<TableActionsWrapperProps<DataType>>) => JSX.Element;
+}>>(props: React.PropsWithChildren<TableActionsWrapperProps<TData>>) => JSX.Element;

package/dist/components/table/components/table-actions-wrapper/table-actions-wrapper.types.d.ts

@@ -15,19 +15,19 @@ export interface SearchProps {
     placeholder?: string;
     value: string;
 }
-export interface CustomActionProps<DataType extends RowData> {
+export interface CustomActionProps<TData extends RowData> {
     Component: JSXElementConstructor<{
         onConfirmInteraction: () => Promise<boolean>;
-        table: Table<DataType>;
+        table: Table<TData>;
     }>;
     position: 'left' | 'right' | 'bottom';
 }
-export interface TableActionsWrapperProps<DataType extends RowData> {
+export interface TableActionsWrapperProps<TData extends RowData> {
     className: string | undefined;
-    customAction: CustomActionProps<DataType> | undefined;
+    customAction: CustomActionProps<TData> | undefined;
     filters: FiltersProps | undefined;
     paging: PagingProps | undefined;
     search: SearchProps | undefined;
     sorting: SortProps | undefined;
-    table: Table<DataType>;
+    table: Table<TData>;
 }

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

@@ -1,7 +1,7 @@
 import { RowData } from '@tanstack/react-table';
 import { TableFooterProps } from './table-footer.types';
-export declare const TableFooter: <DataType extends RowData<{
+export declare const TableFooter: <TData extends RowData<{
     [key: string]: unknown;
     id?: string | number | undefined;
     subRows?: any[] | undefined;
-}>>(props: TableFooterProps<DataType>) => JSX.Element;
+}>>(props: TableFooterProps<TData>) => JSX.Element;

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

@@ -1,4 +1,4 @@
 import { RowData, Table } from '@tanstack/react-table';
-export type TableFooterProps<DataType extends RowData> = {
-    table: Table<DataType>;
+export type TableFooterProps<TData extends RowData> = {
+    table: Table<TData>;
 };

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

@@ -1,7 +1,7 @@
 import { RowData } from '@tanstack/react-table';
 import { TableHeaderProps } from './table-header.types';
-export declare const TableHeader: <DataType extends RowData<{
+export declare const TableHeader: <TData extends RowData<{
     [key: string]: unknown;
     id?: string | number | undefined;
     subRows?: any[] | undefined;
-}>>(props: TableHeaderProps<DataType>) => JSX.Element;
+}>>(props: TableHeaderProps<TData>) => JSX.Element;

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

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

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

@@ -1,11 +1,11 @@
 /// <reference types="react" />
 import { RowData } from '@tanstack/react-table';
 import { UseDragAndDropProps } from './use-drag-and-drop.types';
-export declare const useDragAndDrop: <DataType extends RowData<{
+export declare const useDragAndDrop: <TData extends RowData<{
     [key: string]: unknown;
     id?: string | number | undefined;
     subRows?: any[] | undefined;
-}>>(props: UseDragAndDropProps<DataType>) => {
+}>>(props: UseDragAndDropProps<TData>) => {
     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,9 +1,9 @@
 import { Row, RowData } from '@tanstack/react-table';
-export interface UseDragAndDropProps<DataType extends RowData> {
+export interface UseDragAndDropProps<TData extends RowData> {
     enableReordering: boolean;
     handleOnReorder: () => Promise<void>;
     index: number;
     isSubRow: boolean;
     moveRow: (startIndex: number, endIndex: number) => void;
-    row: Row<DataType>;
+    row: Row<TData>;
 }

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

@@ -1,7 +1,7 @@
 import { RowData } from '@tanstack/react-table';
 import { TableRowProps } from './table-row.types';
-export declare const TableRow: <DataType extends RowData<{
+export declare const TableRow: <TData extends RowData<{
     [key: string]: unknown;
     id?: string | number | undefined;
     subRows?: any[] | undefined;
-}>>(props: TableRowProps<DataType>) => JSX.Element;
+}>>(props: TableRowProps<TData>) => JSX.Element;

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

@@ -1,12 +1,12 @@
 import { Row, RowData } from '@tanstack/react-table';
 import { CustomRowProps, GetCellProps, OnRowClick } from '../../table.types';
-export interface TableRowProps<DataType extends RowData> {
+export interface TableRowProps<TData extends RowData> {
     customRowProps: CustomRowProps;
     enableReordering: boolean;
-    getCellProps: GetCellProps<DataType> | undefined;
+    getCellProps: GetCellProps<TData> | undefined;
     handleOnReorder: () => Promise<void>;
     index: number;
     moveRow: (startIndex: number, endIndex: number) => void;
-    onRowClick?: OnRowClick<DataType>;
-    row: Row<DataType>;
+    onRowClick?: OnRowClick<TData>;
+    row: Row<TData>;
 }

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

@@ -1,7 +1,8 @@
 import { RowData } from '@tanstack/react-table';
+import { TDataWithId } from './add-missing-ids.types';
 /** If an index does not contain an `id` value, one is added using uuid. */
-export declare const addMissingIds: <DataType extends RowData<{
+export declare const addMissingIds: <TData extends RowData<{
     [key: string]: unknown;
     id?: string | number | undefined;
     subRows?: any[] | undefined;
-}>>(data: DataType[]) => DataType[];
+}>>(data: TData[]) => TDataWithId<TData>[];

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

@@ -0,0 +1,4 @@
+import { RowData } from '@tanstack/react-table';
+export type TDataWithId<TData extends RowData> = TData & {
+    id: number | string;
+};

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

@@ -2,3 +2,4 @@ export * from './table';
 export * from './table.types';
 export * from './components/table-row/table-row.constants';
 export * from './components/custom-columns-wrapper/helpers/get-custom-column-initial-visibility';
+export * from './helpers';

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

@@ -2,10 +2,10 @@ import { RowData } from '@tanstack/react-table';
 import { TableProps } from './table.types';
 /** Official docs: https://tanstack.com/table/v8/docs/guide/overview */
 export declare const Table: {
-    <DataType extends RowData<{
+    <TData extends RowData<{
         [key: string]: unknown;
         id?: string | number | undefined;
         subRows?: any[] | undefined;
-    }>>(props: TableProps<DataType>): JSX.Element;
+    }>>(props: TableProps<TData>): JSX.Element;
     defaultProps: import("./table.types").TableDefaultProps;
 };

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

@@ -4,29 +4,29 @@ import { PagingProps } from './components/table-actions-wrapper/components/pagin
 import { CustomActionProps, FiltersProps, SearchProps } from './components/table-actions-wrapper/table-actions-wrapper.types';
 import { SortProps } from './components/table-actions-wrapper/components/sort/sort.types';
 import { CustomColumnsProps } from './components/custom-columns-wrapper/custom-columns-wrapper.types';
-export interface TableProps<DataType extends RowData> extends Partial<TableDefaultProps> {
+export interface TableProps<TData extends RowData> extends Partial<TableDefaultProps> {
     className?: string;
-    columns: ColumnDef<DataType, any>[];
-    customAction?: CustomActionProps<DataType>;
-    customColumns?: CustomColumnsProps<DataType>;
+    columns: ColumnDef<TData, any>[];
+    customAction?: CustomActionProps<TData>;
+    customColumns?: CustomColumnsProps<TData>;
     /**
      * 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[];
+    data: TData[];
     filters?: FiltersProps;
-    getCellProps?: GetCellProps<DataType>;
-    getHeaderCellProps?: GetHeaderCellProps<DataType>;
+    getCellProps?: GetCellProps<TData>;
+    getHeaderCellProps?: GetHeaderCellProps<TData>;
     /** Include `status` in the returned value to set the row status color. */
-    getRowProps?: GetRowProps<DataType>;
-    onRowClick?: OnRowClick<DataType>;
+    getRowProps?: GetRowProps<TData>;
+    onRowClick?: OnRowClick<TData>;
     /** Any options provided are passed to `useReactTable` and may override default values. */
-    options?: Partial<TableOptions<DataType>>;
+    options?: Partial<TableOptions<TData>>;
     paging?: PagingProps;
     reordering?: {
         enable: boolean;
-        onReorder: (data: DataType[]) => Promise<void>;
+        onReorder: (data: TData[]) => Promise<void>;
     };
     search?: SearchProps;
     sorting?: SortProps;
@@ -34,13 +34,13 @@ export interface TableProps<DataType extends RowData> extends Partial<TableDefau
 export interface TableDefaultProps {
     stickyFirstColumn: boolean;
 }
-export type GetHeaderCellProps<DataType extends RowData> = (cell?: Header<DataType, unknown>) => CustomCellProps;
-export type GetRowProps<DataType extends RowData> = (row?: Row<DataType>, rows?: Row<DataType>[]) => CustomRowProps;
+export type GetHeaderCellProps<TData extends RowData> = (cell?: Header<TData, unknown>) => CustomCellProps;
+export type GetRowProps<TData extends RowData> = (row?: Row<TData>, rows?: Row<TData>[]) => CustomRowProps;
 export interface CustomRowProps extends Record<string, unknown>, HTMLAttributes<HTMLTableRowElement> {
     status?: RowStatusValue | undefined;
 }
 export type RowStatusValue = 'handled' | 'next' | 'error' | 'warning';
-export type GetCellProps<DataType extends RowData> = (cell?: Cell<DataType, unknown>) => CustomCellProps;
-export type OnRowClick<DataType extends RowData> = (data: Row<DataType>, event: MouseEvent<HTMLTableRowElement>) => void;
+export type GetCellProps<TData extends RowData> = (cell?: Cell<TData, unknown>) => CustomCellProps;
+export type OnRowClick<TData extends RowData> = (data: Row<TData>, event: MouseEvent<HTMLTableRowElement>) => void;
 export interface CustomCellProps extends Record<string, unknown>, HTMLAttributes<HTMLTableCellElement> {
 }