@bsol-oss/react-datatable5 5.0.1 → 6.0.1

package/dist/index.d.ts

@@ -1,12 +1,15 @@
 /// <reference types="react" />
-import { RowData, OnChangeFn, Updater, FilterFn, ColumnDef, RowSelectionState, ColumnOrderState, ColumnFiltersState, PaginationState, SortingState, VisibilityState, Row, Table as Table$1, Column } from '@tanstack/react-table';
+import { Row, RowData, OnChangeFn, Updater, FilterFn, ColumnDef, RowSelectionState, ColumnOrderState, ColumnFiltersState, PaginationState, SortingState, VisibilityState, Table as Table$1, Column } from '@tanstack/react-table';
 import * as React$1 from 'react';
 import React__default, { ReactNode } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { RankingInfo } from '@tanstack/match-sorter-utils';
+import { ImageProps, TableHeaderProps as TableHeaderProps$1, TableRootProps, GridProps, CardBodyProps, TextProps } from '@chakra-ui/react';
 import { IconType } from 'react-icons';
-import { TableHeaderProps as TableHeaderProps$1, TableRootProps, GridProps, CardBodyProps, TextProps } from '@chakra-ui/react';
+import { RankingInfo } from '@tanstack/match-sorter-utils';
 import * as _tanstack_table_core from '@tanstack/table-core';
+import { JSONSchema7 } from 'json-schema';
+import { FieldValues, SubmitHandler } from 'react-hook-form';
+import { RenderProps, Props } from 'dayzed';
 
 interface DensityToggleButtonProps {
     icon?: React__default.ReactElement;
@@ -66,6 +69,22 @@ declare const ResetSortingButton: ({ text, }: ResetSortingButtonProps) => react_
 
 declare const RowCountText: () => react_jsx_runtime.JSX.Element;
 
+interface CardHeaderProps<TData> {
+    row: Row<TData>;
+    imageColumnId?: keyof TData;
+    titleColumnId?: keyof TData;
+    tagColumnId?: keyof TData;
+    tagIcon?: IconType;
+    showTag?: boolean;
+    imageProps?: ImageProps;
+}
+declare const CardHeader: <TData>({ row, imageColumnId, titleColumnId, tagColumnId, tagIcon, showTag, imageProps, }: CardHeaderProps<TData>) => react_jsx_runtime.JSX.Element;
+
+interface DataDisplayProps {
+    variant?: "horizontal" | "stats" | "";
+}
+declare const DataDisplay: ({ variant }: DataDisplayProps) => react_jsx_runtime.JSX.Element;
+
 type DensityState = "sm" | "md" | "lg";
 interface DensityTableState {
     density: DensityState;
@@ -99,7 +118,7 @@ declare module "@tanstack/react-table" {
 interface DataTableProps<TData> {
     children?: ReactNode | ReactNode[];
     data: TData[];
-    columns: ColumnDef<TData, any>[];
+    columns: ColumnDef<TData, unknown>[];
     enableRowSelection?: boolean;
     enableMultiRowSelection?: boolean;
     enableSubRowSelection?: boolean;
@@ -123,6 +142,10 @@ interface DataTableProps<TData> {
 }
 declare const DataTable: <TData>({ columns, data, enableRowSelection, enableMultiRowSelection, enableSubRowSelection, onRowSelect, columnOrder, columnFilters, columnVisibility, density, globalFilter, pagination, sorting, rowSelection, setPagination, setSorting, setColumnFilters, setRowSelection, setGlobalFilter, setColumnOrder, setDensity, setColumnVisibility, children, }: DataTableProps<TData>) => react_jsx_runtime.JSX.Element;
 
+interface RefreshDataConfig {
+    debounce?: boolean;
+    delay?: number;
+}
 interface UseDataFromUrlReturn<T> {
     data: T;
     loading: boolean;
@@ -130,10 +153,7 @@ interface UseDataFromUrlReturn<T> {
     /**
      * Delays sending the request when the `refreshData` function is called multiple times within a short period.
      */
-    refreshData: (config?: {
-        debounce?: boolean;
-        delay?: number;
-    }) => void;
+    refreshData: (config?: RefreshDataConfig) => void;
 }
 interface UseDataFromUrlProps<T> {
     url: string;
@@ -196,17 +216,16 @@ interface UseDataTableServerProps<TData> extends Omit<UseDataFromUrlProps<DataRe
 interface UseDataTableServerReturn<TData> extends UseDataFromUrlReturn<DataResponse<TData>>, UseDataTableReturn {
 }
 interface Result<T> {
-    results: T[];
+    data: T[];
 }
 interface DataResponse<T> extends Result<T> {
-    success: boolean;
     count: number;
 }
 declare const useDataTableServer: <TData>({ url, onFetchSuccess, default: { sorting: defaultSorting, pagination: defaultPagination, rowSelection: defaultRowSelection, columnFilters: defaultColumnFilters, columnOrder: defaultColumnOrder, columnVisibility: defaultColumnVisibility, globalFilter: defaultGlobalFilter, density: defaultDensity, }, debounce, debounceDelay, }: UseDataTableServerProps<TData>) => UseDataTableServerReturn<TData>;
 
 interface DataTableServerProps<TData> extends UseDataFromUrlReturn<DataResponse<TData>> {
     children: ReactNode | ReactNode[];
-    columns: ColumnDef<TData, any>[];
+    columns: ColumnDef<TData>[];
     enableRowSelection?: boolean;
     enableMultiRowSelection?: boolean;
     enableSubRowSelection?: boolean;
@@ -230,16 +249,6 @@ interface DataTableServerProps<TData> extends UseDataFromUrlReturn<DataResponse<
 }
 declare const DataTableServer: <TData>({ columns, enableRowSelection, enableMultiRowSelection, enableSubRowSelection, onRowSelect, columnOrder, columnFilters, columnVisibility, density, globalFilter, pagination, sorting, rowSelection, setPagination, setSorting, setColumnFilters, setRowSelection, setGlobalFilter, setColumnOrder, setDensity, setColumnVisibility, data, loading, hasError, refreshData, children, }: DataTableServerProps<TData>) => react_jsx_runtime.JSX.Element;
 
-interface DefaultCardProps<TData> {
-    row: Row<TData>;
-    imageColumnId?: keyof TData;
-    titleColumnId?: keyof TData;
-    tagColumnId?: keyof TData;
-    tagIcon?: IconType;
-    showTag?: boolean;
-}
-declare const DefaultCard: <TData>({ row, imageColumnId, titleColumnId, tagColumnId, tagIcon, showTag, }: DefaultCardProps<TData>) => react_jsx_runtime.JSX.Element;
-
 interface TableControlsProps {
     totalText?: string;
     showFilter?: boolean;
@@ -275,7 +284,7 @@ interface TableProps extends TableRootProps {
     emptyComponent?: ReactNode;
     children: ReactNode;
 }
-declare const Table: ({ children, emptyComponent, ...props }: TableProps) => string | number | bigint | boolean | react_jsx_runtime.JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | React$1.ReactPortal | React$1.ReactElement<unknown, string | React$1.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null;
+declare const Table: ({ children, emptyComponent, ...props }: TableProps) => string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | React$1.ReactPortal | React$1.ReactElement<unknown, string | React$1.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | react_jsx_runtime.JSX.Element | null;
 
 interface TableBodyProps {
     pinnedBgColor?: {
@@ -299,8 +308,9 @@ declare const TableBody: ({ pinnedBgColor, showSelector, alwaysShowSelector, }:
 
 interface TableCardContainerProps extends GridProps {
     children: ReactNode;
+    variant?: "carousel" | "";
 }
-declare const TableCardContainer: ({ children, ...props }: TableCardContainerProps) => react_jsx_runtime.JSX.Element;
+declare const TableCardContainer: ({ children, variant, ...props }: TableCardContainerProps) => react_jsx_runtime.JSX.Element;
 
 interface TableCardsProps<TData> {
     isSelectable?: boolean;
@@ -309,7 +319,7 @@ interface TableCardsProps<TData> {
     cardBodyProps?: CardBodyProps;
 }
 declare const DefaultCardTitle: () => react_jsx_runtime.JSX.Element;
-declare const TableCards: <TData>({ isSelectable, showDisplayNameOnly, renderTitle, cardBodyProps }: TableCardsProps<TData>) => react_jsx_runtime.JSX.Element;
+declare const TableCards: <TData>({ isSelectable, showDisplayNameOnly, renderTitle, cardBodyProps, }: TableCardsProps<TData>) => react_jsx_runtime.JSX.Element;
 
 interface TableRendererProps<TData> {
     render: (render: Table$1<TData>) => React__default.ReactElement;
@@ -368,7 +378,7 @@ declare const TextCell: ({ label, padding, children, ...props }: TextCellProps)
 
 declare const useDataTableContext: () => {
     table: _tanstack_table_core.Table<any>;
-    refreshData: () => void;
+    refreshData: (config?: RefreshDataConfig | undefined) => void;
     globalFilter: string;
     setGlobalFilter: _tanstack_table_core.OnChangeFn<string>;
     loading: boolean;
@@ -382,6 +392,94 @@ declare const FilterOptions: ({ column }: FilterOptionsProps) => react_jsx_runti
 
 declare const GlobalFilter: () => react_jsx_runtime.JSX.Element;
 
+interface GetColumnsConfigs<K extends RowData> {
+    schema: JSONSchema7;
+    ignore?: K[];
+    width?: number[];
+    meta?: {
+        [key in K as string]?: object;
+    };
+    defaultWidth?: number;
+}
+declare const widthSanityCheck: <K extends unknown>(widthList: number[], ignoreList: K[], properties: { [key in K as string]?: object | undefined; }) => void;
+declare const getColumns: <TData extends unknown>({ schema, ignore, width, meta, defaultWidth, }: GetColumnsConfigs<TData>) => ColumnDef<TData>[];
+
+interface DisplayTextProps {
+    title?: string;
+    addNew?: string;
+    submit?: string;
+    confirm?: string;
+    save?: string;
+    empty?: string;
+    cancel?: string;
+    submitSuccess?: string;
+    submitAgain?: string;
+    fieldRequired?: string;
+}
+interface FormProps<TData extends FieldValues> {
+    schema: JSONSchema7;
+    serverUrl: string;
+    order?: string[];
+    ignore?: string[];
+    onSubmit?: SubmitHandler<TData>;
+    preLoadedValues?: object;
+    rowNumber?: number | string;
+    displayText?: DisplayTextProps;
+}
+interface CustomJSONSchema7Definition extends JSONSchema7 {
+    variant: string;
+    in_table: string;
+    column_ref: string;
+    display_column: string;
+    gridColumn: string;
+    gridRow: string;
+}
+declare const Form: <TData extends FieldValues>({ schema, serverUrl, order, ignore, onSubmit, preLoadedValues, rowNumber, displayText, }: FormProps<TData>) => react_jsx_runtime.JSX.Element;
+
+interface CalendarProps extends RenderProps {
+    firstDayOfWeek?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+}
+interface GetDateColorProps {
+    today: boolean;
+    selected: boolean;
+    selectable: boolean;
+}
+interface GetVariantProps {
+    today: boolean;
+    selected: boolean;
+    selectable: boolean;
+}
+interface DatePickerProps extends Props {
+}
+
+interface GetMultiDatesProps {
+    selected: boolean;
+    selectable: boolean;
+    selectedDate: Date;
+    selectedDates: Date[];
+}
+declare const getMultiDates: ({ selected, selectedDate, selectedDates, selectable, }: GetMultiDatesProps) => Date[];
+
+interface GetRangeDatesProps {
+    selectable: boolean;
+    date: Date;
+    selectedDates: Date[];
+}
+declare const getRangeDates: ({ selectable, date, selectedDates, }: GetRangeDatesProps) => Date[] | undefined;
+
+interface RangeCalendarProps extends RenderProps {
+    firstDayOfWeek?: 0 | 1 | 2 | 3 | 4 | 5 | 6;
+    selected?: Date[];
+}
+interface GetStyleProps {
+    today: boolean;
+    selected: boolean;
+    unavailable: boolean;
+    isInRange: boolean;
+}
+interface RangeDatePickerProps extends Props {
+}
+
 declare module "@tanstack/react-table" {
     interface ColumnMeta<TData extends RowData, TValue> {
         /**
@@ -434,4 +532,4 @@ declare module "@tanstack/react-table" {
     }
 }
 
-export { type DataResponse, DataTable, type DataTableDefaultState, type DataTableProps, DataTableServer, type DataTableServerProps, DefaultCard, type DefaultCardProps, DefaultCardTitle, DefaultTable, type DefaultTableProps, DensityToggleButton, type DensityToggleButtonProps, EditFilterButton, type EditFilterButtonProps, EditOrderButton, type EditOrderButtonProps, EditSortingButton, type EditSortingButtonProps, EditViewButton, type EditViewButtonProps, FilterOptions, type FilterOptionsProps, GlobalFilter, PageSizeControl, type PageSizeControlProps, ReloadButton, type ReloadButtonProps, ResetFilteringButton, type ResetFilteringButtonProps, ResetSelectionButton, type ResetSelectionButtonProps, ResetSortingButton, type ResetSortingButtonProps, type Result, RowCountText, Table, TableBody, type TableBodyProps, TableCardContainer, type TableCardContainerProps, TableCards, type TableCardsProps, TableComponent, TableControls, type TableControlsProps, TableFilter, TableFilterTags, TableFooter, type TableFooterProps, TableHeader, type TableHeaderProps, TableLoadingComponent, type TableLoadingComponentProps, TableOrderer, TablePagination, type TableProps, type TableRendererProps, type TableRowSelectorProps, TableSelector, TableSorter, TableViewer, TextCell, type TextCellProps, type UseDataFromUrlProps, type UseDataFromUrlReturn, type UseDataTableProps, type UseDataTableReturn, type UseDataTableServerProps, type UseDataTableServerReturn, useDataFromUrl, useDataTable, useDataTableContext, useDataTableServer };
+export { type CalendarProps, CardHeader, type CardHeaderProps, type CustomJSONSchema7Definition, DataDisplay, type DataDisplayProps, type DataResponse, DataTable, type DataTableDefaultState, type DataTableProps, DataTableServer, type DataTableServerProps, type DatePickerProps, DefaultCardTitle, DefaultTable, type DefaultTableProps, DensityToggleButton, type DensityToggleButtonProps, type DisplayTextProps, EditFilterButton, type EditFilterButtonProps, EditOrderButton, type EditOrderButtonProps, EditSortingButton, type EditSortingButtonProps, EditViewButton, type EditViewButtonProps, FilterOptions, type FilterOptionsProps, Form, type FormProps, type GetColumnsConfigs, type GetDateColorProps, type GetMultiDatesProps, type GetRangeDatesProps, type GetStyleProps, type GetVariantProps, GlobalFilter, PageSizeControl, type PageSizeControlProps, type RangeCalendarProps, type RangeDatePickerProps, type RefreshDataConfig, ReloadButton, type ReloadButtonProps, ResetFilteringButton, type ResetFilteringButtonProps, ResetSelectionButton, type ResetSelectionButtonProps, ResetSortingButton, type ResetSortingButtonProps, type Result, RowCountText, Table, TableBody, type TableBodyProps, TableCardContainer, type TableCardContainerProps, TableCards, type TableCardsProps, TableComponent, TableControls, type TableControlsProps, TableFilter, TableFilterTags, TableFooter, type TableFooterProps, TableHeader, type TableHeaderProps, TableLoadingComponent, type TableLoadingComponentProps, TableOrderer, TablePagination, type TableProps, type TableRendererProps, type TableRowSelectorProps, TableSelector, TableSorter, TableViewer, TextCell, type TextCellProps, type UseDataFromUrlProps, type UseDataFromUrlReturn, type UseDataTableProps, type UseDataTableReturn, type UseDataTableServerProps, type UseDataTableServerReturn, getColumns, getMultiDates, getRangeDates, useDataFromUrl, useDataTable, useDataTableContext, useDataTableServer, widthSanityCheck };