@infinite-table/infinite-react 1.2.5 → 1.3.0

package/index.d.ts

@@ -23,7 +23,7 @@ declare type MultisortInfo<T> = {
     valueGetter?: (item: T) => any;
 };
 declare type MultisortInfoAllowMultipleFields<T> = Omit<MultisortInfo<T>, 'field'> & {
-    field?: keyof T | (keyof T)[];
+    field?: keyof T | (keyof T | ((item: T) => any))[];
 };
 declare const multisort: {
     <T>(sortInfo: MultisortInfoAllowMultipleFields<T>[], array: T[], get?: ((item: any) => T) | undefined): T[];
@@ -230,6 +230,22 @@ declare type KeyOfNoSymbol<T> = Exclude<keyof T, Symbol>;
  * @see https://github.com/maninak/ts-xor/tree/master#description
  */
 declare type XOR<T, U> = T | U extends object ? Prettify<Without<T, U> & U> | Prettify<Without<U, T> & T> : T | U;
+/**
+ * Useful if applying XOR on more than 2 types.
+ * It comes with the penalty of having the types wrapped in an array
+ *
+ * @example
+ * ```
+ * AllXOR<[
+ *   { a: AModule },
+ *   { b: BModule },
+ *   { c: CModule },
+ *   { d: DModule }
+ * ]>
+ * ```
+ * @see https://github.com/Microsoft/TypeScript/issues/14094#issuecomment-723571692
+ */
+declare type AllXOR<T extends any[]> = T extends [infer Only] ? Only : T extends [infer A, infer B, ...infer Rest] ? AllXOR<[XOR<A, B>, ...Rest]> : never;
 /**
  * Get the keys of T without any keys of U.
  */
@@ -374,10 +390,7 @@ declare type InfiniteTableColumnVerticalAlignFn<T> = (params: InfiniteTableColum
 declare type InfiniteTableColumnHeaderStyle<T> = CSSProperties | InfiniteTableColumnHeaderStyleFn<T>;
 declare type InfiniteTableColumnClassName<T> = string | InfiniteTableColumnClassNameFn<T>;
 declare type InfiniteTableColumnHeaderClassName<T> = string | InfiniteTableColumnHeaderClassNameFn<T>;
-declare type InfiniteTableColumnValueGetterParams<T> = {
-    data: T;
-    field?: keyof T;
-};
+declare type InfiniteTableColumnValueGetterParams<T> = ValueGetterParams<T>;
 declare type InfiniteTableColumnValueFormatterParams<T> = InfiniteTableRowInfoDataDiscriminator<T>;
 declare type InfiniteTableColumnValueGetter<T, VALUE_GETTER_TYPE = string | number | boolean | Date | null | undefined> = (params: InfiniteTableColumnValueGetterParams<T>) => VALUE_GETTER_TYPE;
 declare type InfiniteTableColumnValueFormatter<T, VALUE_FORMATTER_TYPE = string | number | boolean | Date | null | undefined> = (params: InfiniteTableColumnValueFormatterParams<T>) => VALUE_FORMATTER_TYPE;
@@ -449,7 +462,7 @@ declare type InfiniteTableColumn<DATA_TYPE> = {
     };
 };
 declare type InfiniteTableGeneratedGroupColumn<T> = Omit<InfiniteTableColumn<T>, 'sortable'> & {
-    groupByField: string | string[];
+    groupByForColumn: GroupBy<T> | GroupBy<T>[];
     id?: string;
 };
 declare type InfiniteTablePivotColumn<T> = InfiniteTableColumn<T> & ColumnTypeWithInherit<Partial<InfiniteTablePivotFinalColumnVariant<T, any>>>;
@@ -1242,6 +1255,7 @@ interface InfiniteTableMappedState<T> {
     columnMinWidth: NonUndefined<InfiniteTableProps<T>['columnMinWidth']>;
     columnMaxWidth: NonUndefined<InfiniteTableProps<T>['columnMaxWidth']>;
     columnDefaultWidth: NonUndefined<InfiniteTableProps<T>['columnDefaultWidth']>;
+    columnDefaultFlex: InfiniteTableProps<T>['columnDefaultFlex'];
     columnCssEllipsis: NonUndefined<InfiniteTableProps<T>['columnCssEllipsis']>;
     draggableColumns: NonUndefined<InfiniteTableProps<T>['draggableColumns']>;
     sortable: NonUndefined<InfiniteTableProps<T>['sortable']>;
@@ -1344,12 +1358,29 @@ interface InfiniteTableCellContext<T> {
     columnApi: InfiniteTableColumnApi<T>;
 }
 
+declare type ValueGetterParams<T> = {
+    data: T;
+    field?: keyof T;
+};
 declare type GroupKeyType$1<T extends any = any> = T;
-declare type GroupBy<DataType, KeyType> = {
-    field: KeyOfNoSymbol<DataType>;
+declare type GroupByValueGetter<T> = (params: ValueGetterParams<T>) => any;
+declare type GroupBy<DataType, KeyType = any> = {
     toKey?: (value: any, data: DataType) => GroupKeyType$1<KeyType>;
     column?: Partial<InfiniteTableGroupColumnBase<DataType>>;
-};
+} & AllXOR<[
+    {
+        field: KeyOfNoSymbol<DataType>;
+    },
+    {
+        valueGetter: GroupByValueGetter<DataType>;
+        field: KeyOfNoSymbol<DataType>;
+    },
+    {
+        valueGetter: GroupByValueGetter<DataType>;
+        field?: KeyOfNoSymbol<DataType>;
+        groupField: string;
+    }
+]>;
 
 declare type RenderRange = {
     renderStartIndex: number;
@@ -1463,8 +1494,7 @@ interface DataSourceDataParams<T> {
     changes?: DataSourceDataParamsChanges<T>;
 }
 declare type DataSourceDataParamsChanges<T> = Partial<Record<keyof Omit<DataSourceDataParams<T>, 'originalDataArray' | 'changes'>, true>>;
-declare type DataSourceSingleSortInfo<T> = Omit<MultisortInfo<T>, 'field'> & {
-    field?: keyof T | (keyof T)[];
+declare type DataSourceSingleSortInfo<T> = MultisortInfoAllowMultipleFields<T> & {
     id?: string;
 };
 declare type DataSourceGroupBy<T> = GroupBy<T, any>;
@@ -1982,17 +2012,17 @@ declare type InfiniteTable_HasGrouping_RowInfoBase<T> = {
      *
      * Example: People grouped by country and city
      *
-     * Italy  - country         - groupKeys: ['country']
-     *    Rome - city           - groupKeys: ['country', 'city']
-     *      Marco    - person   - groupKeys: ['country', 'city']
-     *      Luca     - person   - groupKeys: ['country', 'city']
-     *      Giuseppe  - person  - groupKeys: ['country', 'city']
+     * Italy  - country         - groupBy: [{field: 'country'}]
+     *    Rome - city           - groupBy: [{field: 'country'}, {field: 'city'} ]
+     *      Marco    - person   - groupBy: [{field: 'country'}, {field: 'city'} ]
+     *      Luca     - person   - groupBy: [{field: 'country'}, {field: 'city'} ]
+     *      Giuseppe  - person  - groupBy: [{field: 'country'}, {field: 'city'} ]
      */
-    groupBy: (keyof T)[];
+    groupBy: GroupBy<T, any>[];
     /**
      * The groupBy value of the DataSource component, mapped to the groupBy.field
      */
-    rootGroupBy: (keyof T)[];
+    rootGroupBy: GroupBy<T, any>[];
     /**
      * Available on all rowInfo objects when the datasource is grouped.
      *
@@ -2625,6 +2655,7 @@ interface InfiniteTableProps<T> {
     columnCssEllipsis?: boolean;
     columnHeaderCssEllipsis?: boolean;
     columnDefaultWidth?: number;
+    columnDefaultFlex?: number;
     columnMinWidth?: number;
     columnMaxWidth?: number;
     hideColumnWhenGrouped?: boolean;