@qualcomm-ui/core 1.0.0

package/dist/table/features/filters.d.ts

@@ -0,0 +1,309 @@
+import type { RowModel } from "..";
+import type { TableFeature } from "../core/table";
+import { type BuiltInFilterFn } from "../filter-fns";
+import type { Column, FilterFns, OnChangeFn, Row, RowData, TableInstance, Updater } from "../types";
+export interface FiltersTableState {
+    columnFilters: ColumnFiltersState;
+    globalFilter: any;
+}
+export type ColumnFiltersState = ColumnFilter[];
+export interface ColumnFilter {
+    id: string;
+    value: unknown;
+}
+export interface ResolvedColumnFilter<TData extends RowData> {
+    filterFn: FilterFn<TData>;
+    id: string;
+    resolvedValue: unknown;
+}
+export interface FilterFn<TData extends RowData> {
+    (row: Row<TData>, columnId: string, filterValue: any, addMeta: (meta: Record<string, any>) => void): boolean;
+    autoRemove?: ColumnFilterAutoRemoveTestFn<TData>;
+    resolveFilterValue?: TransformFilterValueFn<TData>;
+}
+export type TransformFilterValueFn<TData extends RowData> = (value: any, column?: Column<TData, unknown>) => unknown;
+export type ColumnFilterAutoRemoveTestFn<TData extends RowData> = (value: any, column?: Column<TData, unknown>) => boolean;
+export type CustomFilterFns<TData extends RowData> = Record<string, FilterFn<TData>>;
+export type FilterFnOption<TData extends RowData> = "auto" | BuiltInFilterFn | FilterFn<TData>;
+export interface FiltersColumnDef<TData extends RowData> {
+    /**
+     * Enables/disables the `column` filter for this column.
+     */
+    enableColumnFilter?: boolean;
+    /**
+     * Enables/disables the global filter for this column.
+     */
+    enableGlobalFilter?: boolean;
+    /**
+     * The filter function to use with this column. Can be the name of a built-in
+     * filter function or a custom filter function.
+     *
+     * @inheritDoc
+     */
+    filterFn?: FilterFnOption<TData>;
+}
+export interface FiltersColumn<TData extends RowData> {
+    /** @internal */
+    _getFacetedMinMaxValues?: () => undefined | [number, number];
+    /** @internal */
+    _getFacetedRowModel?: () => RowModel<TData>;
+    /** @internal */
+    _getFacetedUniqueValues?: () => Map<any, number>;
+    /**
+     * Returns an automatically calculated filter function for the column based off of
+     * the columns first known value.
+     *
+     * @inheritDoc
+     */
+    getAutoFilterFn: () => FilterFn<TData> | undefined;
+    /**
+     * Returns whether the column can be `column` filtered.
+     */
+    getCanFilter: () => boolean;
+    /**
+     * Returns whether the column can be globally filtered. Set to `false`
+     * to disable a column from being scanned during global filtering.
+     */
+    getCanGlobalFilter: () => boolean;
+    /**
+     * A function that computes and returns a min/max tuple derived from
+     * {@link getFacetedRowModel}. Useful for displaying faceted result values. > ⚠️
+     * Requires that you pass a valid {@link getFacetedMinMaxValues} function to
+     * `options.getFacetedMinMaxValues`. A default implementation is provided via the
+     * exported {@link getFacetedMinMaxValues} function.
+     */
+    getFacetedMinMaxValues: () => undefined | [number, number];
+    /**
+     * Returns the row model with all other column filters applied, excluding its own
+     * filter. Useful for displaying faceted result counts.️ Requires that you
+     * pass a valid {@link getFacetedRowModel} function to `options.facetedRowModel`. A
+     * default implementation is provided via the exported {@link getFacetedRowModel}
+     * function.
+     *
+     * @inheritDoc
+     */
+    getFacetedRowModel: () => RowModel<TData>;
+    /**
+     * A function that computes and returns a `Map` of unique values and their
+     * occurrences derived from `column.getFacetedRowModel`. Useful for displaying
+     * faceted result values. Requires that you pass a valid {@link
+     * getFacetedUniqueValues} function to `options.getFacetedUniqueValues`. A default
+     * implementation is provided via the exported {@link getFacetedUniqueValues}
+     * function.
+     */
+    getFacetedUniqueValues: () => Map<any, number>;
+    /**
+     * Returns the filter function (either user-defined or automatic, depending on
+     * configuration) for the columnId specified.
+     *
+     * @inheritDoc
+     */
+    getFilterFn: () => FilterFn<TData> | undefined;
+    /**
+     * Returns the index of the column filter in the table's `state.columnFilters`
+     * array. Returns `-1` if not found.
+     */
+    getFilterIndex: () => number;
+    /**
+     * Returns the current filter value for the column.
+     */
+    getFilterValue: () => unknown;
+    /**
+     * Returns whether the column is currently filtered.
+     */
+    getIsFiltered: () => boolean;
+    /**
+     * A function that sets the current filter value for the column. You can pass it a
+     * value or an updater function for immutability-safe operations on existing
+     * values.
+     */
+    setFilterValue: (updater: Updater<any>) => void;
+}
+export interface FiltersRow<_TData extends RowData> {
+    /**
+     * The column filters map for the row. This object tracks whether a row is
+     * passing/failing specific filters by their column ID.
+     */
+    columnFilters: Record<string, boolean>;
+    /**
+     * The column filters meta map for the row. This object tracks any filter meta for
+     * a row as optionally provided during the filtering process.
+     */
+    columnFiltersMeta: Record<string, Record<string, any>>;
+}
+interface FiltersOptionsBase<TData extends RowData> {
+    /**
+     * Enables/disables `column` filtering for all columns.
+     */
+    enableColumnFilters?: boolean;
+    /**
+     * Enables/disables all filtering for the table.
+     */
+    enableFilters?: boolean;
+    /**
+     * Enables/disables global filtering for all columns.
+     */
+    enableGlobalFilter?: boolean;
+    /**
+     * By default, filtering is done from parent rows down (so if a parent row is
+     * filtered out, all of its children will be filtered out as well). Setting this
+     * option to `true` will cause filtering to be done from leaf rows up (which means
+     * parent rows will be included so long as one of their child or grand-child rows
+     * is also included).
+     */
+    filterFromLeafRows?: boolean;
+    /**
+     * If provided, this function will be called with the column and should return
+     * `true` or `false` to indicate whether this column should be used for global
+     * filtering.
+     *
+     * This is useful if the column can contain data that is not `string` or `number`
+     * (i.e. `undefined`).
+     */
+    getColumnCanGlobalFilter?: (
+    /** @inheritDoc */
+    column: Column<TData, unknown>) => boolean;
+    getFacetedMinMaxValues?: (
+    /** @inheritDoc */
+    table: TableInstance<TData>, columnId: string) => () => undefined | [number, number];
+    getFacetedRowModel?: (
+    /** @inheritDoc */
+    table: TableInstance<TData>, 
+    /**
+     * The id of the column
+     */
+    columnId: string) => () => RowModel<TData>;
+    getFacetedUniqueValues?: (
+    /** @inheritDoc */
+    table: TableInstance<TData>, columnId: string) => () => Map<any, number>;
+    /**
+     * If provided, this function is called once per table and should return a
+     * new function which will calculate and return the row model for the table
+     * when it's filtered. - For server-side filtering, this function is unnecessary
+     * and can be ignored since the server should already return the filtered row
+     * model. - For client-side filtering, this function is required. A default
+     * implementation is provided via any table adapter's `{ getFilteredRowModel }`
+     * export.
+     */
+    getFilteredRowModel?: (
+    /** @inheritDoc */
+    table: TableInstance<TData>) => () => RowModel<TData>;
+    /**
+     * The filter function to use for global filtering.
+     * - A `string` referencing a built-in filter function
+     * - A `string` that references a custom filter functions provided via the
+     * `tableOptions.filterFns` option - A custom filter function
+     *
+     * @inheritDoc
+     */
+    globalFilterFn?: FilterFnOption<TData>;
+    /**
+     * Disables the `getFilteredRowModel` from being used to filter data. This may be
+     * useful if your table needs to dynamically support both client-side and
+     * server-side filtering.
+     */
+    manualFiltering?: boolean;
+    /**
+     * By default, filtering is done for all rows (max depth of 100), no matter if
+     * they are root level parent rows or the child leaf rows of a parent row. Setting
+     * this option to `0` will cause filtering to only be applied to the root level
+     * parent rows, with all sub-rows remaining unfiltered. Similarly, setting this
+     * option to `1` will cause filtering to only be applied to child leaf rows 1
+     * level deep, and so on.
+     *
+     * This is useful for situations where you want a row's entire child hierarchy to
+     * be visible regardless of the applied filter.
+     */
+    maxLeafRowFilterDepth?: number;
+    /**
+     * If provided, this function will be called with an `updaterFn` when
+     * `state.columnFilters` changes. This overrides the default internal state
+     * management, so you will need to persist the state change either fully or
+     * partially outside the table.
+     */
+    onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>;
+    /**
+     * If provided, this function will be called with an `updaterFn` when
+     * `state.globalFilter` changes. This overrides the default internal state
+     * management, so you will need to persist the state change either fully or
+     * partially outside the table.
+     */
+    onGlobalFilterChange?: OnChangeFn<any>;
+}
+type ResolvedFilterFns = keyof FilterFns extends never ? {
+    /** @inheritDoc */
+    filterFns?: Record<string, FilterFn<any>>;
+} : {
+    /** @inheritDoc */
+    filterFns: Record<keyof FilterFns, FilterFn<any>>;
+};
+export interface FiltersOptions<TData extends RowData> extends FiltersOptionsBase<TData>, ResolvedFilterFns {
+}
+export interface FiltersInstance<TData extends RowData> {
+    /** @internal */
+    _getFilteredRowModel?: () => RowModel<TData>;
+    /** @internal */
+    _getGlobalFacetedMinMaxValues?: () => undefined | [number, number];
+    /** @internal */
+    _getGlobalFacetedRowModel?: () => RowModel<TData>;
+    /** @internal */
+    _getGlobalFacetedUniqueValues?: () => Map<any, number>;
+    /**
+     * Returns the row model for the table after `column` filtering has been applied.
+     */
+    getFilteredRowModel: () => RowModel<TData>;
+    /**
+     * Currently, this function returns the built-in `includesString` filter function.
+     * In future releases, it may return more dynamic filter functions based on the
+     * nature of the data provided.
+     *
+     * @inheritDoc
+     */
+    getGlobalAutoFilterFn: () => FilterFn<TData> | undefined;
+    /**
+     * Returns the faceted min and max values for the global filter.
+     */
+    getGlobalFacetedMinMaxValues: () => undefined | [number, number];
+    /**
+     * Returns the row model for the table after global filtering has been applied.
+     */
+    getGlobalFacetedRowModel: () => RowModel<TData>;
+    /**
+     * Returns the faceted unique values for the global filter.
+     */
+    getGlobalFacetedUniqueValues: () => Map<any, number>;
+    /**
+     * Returns the filter function (either user-defined or automatic, depending on
+     * configuration) for the global filter.
+     *
+     * @inheritDoc
+     */
+    getGlobalFilterFn: () => FilterFn<TData> | undefined;
+    /**
+     * Returns the row model for the table before any `column` filtering has been
+     * applied.
+     */
+    getPreFilteredRowModel: () => RowModel<TData>;
+    /**
+     * Resets the `columnFilters` state to `initialState.columnFilters`, or `true`
+     * can be passed to force a default blank state reset to `[]`.
+     */
+    resetColumnFilters: (defaultState?: boolean) => void;
+    /**
+     * Resets the `globalFilter` state to `initialState.globalFilter`, or `true` can
+     * be passed to force a default blank state reset to `undefined`.
+     */
+    resetGlobalFilter: (defaultState?: boolean) => void;
+    /**
+     * Sets or updates the `state.columnFilters` state.
+     */
+    setColumnFilters: (updater: Updater<ColumnFiltersState>) => void;
+    /**
+     * Sets or updates the `state.globalFilter` state.
+     */
+    setGlobalFilter: (updater: Updater<any>) => void;
+}
+export declare const Filters: TableFeature;
+export declare function shouldAutoRemoveFilter<TData extends RowData>(filterFn?: FilterFn<TData>, value?: any, column?: Column<TData, unknown>): boolean;
+export {};
+//# sourceMappingURL=filters.d.ts.map

package/dist/table/features/filters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filters.d.ts","sourceRoot":"","sources":["../../../src/table/features/filters.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,QAAQ,EAAC,MAAM,IAAI,CAAA;AAChC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,eAAe,CAAA;AAC/C,OAAO,EAAC,KAAK,eAAe,EAAY,MAAM,eAAe,CAAA;AAC7D,OAAO,KAAK,EACV,MAAM,EACN,SAAS,EACT,UAAU,EACV,GAAG,EACH,OAAO,EACP,aAAa,EACb,OAAO,EACR,MAAM,UAAU,CAAA;AAGjB,MAAM,WAAW,iBAAiB;IAChC,aAAa,EAAE,kBAAkB,CAAA;IACjC,YAAY,EAAE,GAAG,CAAA;CAClB;AAED,MAAM,MAAM,kBAAkB,GAAG,YAAY,EAAE,CAAA;AAE/C,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,oBAAoB,CAAC,KAAK,SAAS,OAAO;IACzD,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAA;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,OAAO,CAAA;CACvB;AAED,MAAM,WAAW,QAAQ,CAAC,KAAK,SAAS,OAAO;IAC7C,CACE,GAAG,EAAE,GAAG,CAAC,KAAK,CAAC,EACf,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,GAAG,EAChB,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,IAAI,GAC3C,OAAO,CAAA;IAEV,UAAU,CAAC,EAAE,4BAA4B,CAAC,KAAK,CAAC,CAAA;IAChD,kBAAkB,CAAC,EAAE,sBAAsB,CAAC,KAAK,CAAC,CAAA;CACnD;AAED,MAAM,MAAM,sBAAsB,CAAC,KAAK,SAAS,OAAO,IAAI,CAC1D,KAAK,EAAE,GAAG,EACV,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,KAC5B,OAAO,CAAA;AAEZ,MAAM,MAAM,4BAA4B,CAAC,KAAK,SAAS,OAAO,IAAI,CAChE,KAAK,EAAE,GAAG,EACV,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,KAC5B,OAAO,CAAA;AAEZ,MAAM,MAAM,eAAe,CAAC,KAAK,SAAS,OAAO,IAAI,MAAM,CACzD,MAAM,EACN,QAAQ,CAAC,KAAK,CAAC,CAChB,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,KAAK,SAAS,OAAO,IAC5C,MAAM,GACN,eAAe,GACf,QAAQ,CAAC,KAAK,CAAC,CAAA;AAEnB,MAAM,WAAW,gBAAgB,CAAC,KAAK,SAAS,OAAO;IACrD;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAE5B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,aAAa,CAAC,KAAK,SAAS,OAAO;IAClD,gBAAgB;IAChB,uBAAuB,CAAC,EAAE,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC5D,gBAAgB;IAChB,mBAAmB,CAAC,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC3C,gBAAgB;IAChB,uBAAuB,CAAC,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IAChD;;;;;OAKG;IACH,eAAe,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,SAAS,CAAA;IAClD;;OAEG;IACH,YAAY,EAAE,MAAM,OAAO,CAAA;IAC3B;;;OAGG;IACH,kBAAkB,EAAE,MAAM,OAAO,CAAA;IACjC;;;;;;OAMG;IACH,sBAAsB,EAAE,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC1D;;;;;;;;OAQG;IACH,kBAAkB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IACzC;;;;;;;OAOG;IACH,sBAAsB,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IAC9C;;;;;OAKG;IACH,WAAW,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,SAAS,CAAA;IAC9C;;;OAGG;IACH,cAAc,EAAE,MAAM,MAAM,CAAA;IAC5B;;OAEG;IACH,cAAc,EAAE,MAAM,OAAO,CAAA;IAC7B;;OAEG;IACH,aAAa,EAAE,MAAM,OAAO,CAAA;IAC5B;;;;OAIG;IACH,cAAc,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,CAAA;CAChD;AAED,MAAM,WAAW,UAAU,CAAC,MAAM,SAAS,OAAO;IAChD;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACtC;;;OAGG;IACH,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAA;CACvD;AAED,UAAU,kBAAkB,CAAC,KAAK,SAAS,OAAO;IAChD;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;;;;;;OAOG;IACH,wBAAwB,CAAC,EAAE;IACzB,kBAAkB;IAClB,MAAM,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,KAC3B,OAAO,CAAA;IAEZ,sBAAsB,CAAC,EAAE;IACvB,kBAAkB;IAClB,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,EAC3B,QAAQ,EAAE,MAAM,KACb,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAEvC,kBAAkB,CAAC,EAAE;IACnB,kBAAkB;IAClB,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,KACb,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAE1B,sBAAsB,CAAC,EAAE;IACvB,kBAAkB;IAClB,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,EAC3B,QAAQ,EAAE,MAAM,KACb,MAAM,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IAC3B;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE;IACpB,kBAAkB;IAClB,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,KACxB,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC1B;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC,CAAA;IACtC;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;;;;;;;OAUG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAC9B;;;;;OAKG;IACH,qBAAqB,CAAC,EAAE,UAAU,CAAC,kBAAkB,CAAC,CAAA;IACtD;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,UAAU,CAAC,GAAG,CAAC,CAAA;CACvC;AAED,KAAK,iBAAiB,GAAG,MAAM,SAAS,SAAS,KAAK,GAClD;IACE,kBAAkB;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;CAC1C,GACD;IACE,kBAAkB;IAClB,SAAS,EAAE,MAAM,CAAC,MAAM,SAAS,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAA;CAClD,CAAA;AAEL,MAAM,WAAW,cAAc,CAAC,KAAK,SAAS,OAAO,CACnD,SAAQ,kBAAkB,CAAC,KAAK,CAAC,EAC/B,iBAAiB;CAAG;AAExB,MAAM,WAAW,eAAe,CAAC,KAAK,SAAS,OAAO;IACpD,gBAAgB;IAChB,oBAAoB,CAAC,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC5C,gBAAgB;IAChB,6BAA6B,CAAC,EAAE,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClE,gBAAgB;IAChB,yBAAyB,CAAC,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IACjD,gBAAgB;IAChB,6BAA6B,CAAC,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IACtD;;OAEG;IACH,mBAAmB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAE1C;;;;;;OAMG;IACH,qBAAqB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,SAAS,CAAA;IACxD;;OAEG;IACH,4BAA4B,EAAE,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChE;;OAEG;IACH,wBAAwB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC/C;;OAEG;IACH,4BAA4B,EAAE,MAAM,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IACpD;;;;;OAKG;IACH,iBAAiB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,SAAS,CAAA;IACpD;;;OAGG;IACH,sBAAsB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC7C;;;OAGG;IACH,kBAAkB,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IACpD;;;OAGG;IACH,iBAAiB,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IACnD;;OAEG;IACH,gBAAgB,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,KAAK,IAAI,CAAA;IAChE;;OAEG;IACH,eAAe,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,CAAA;CACjD;AAED,eAAO,MAAM,OAAO,EAAE,YA6RrB,CAAA;AAED,wBAAgB,sBAAsB,CAAC,KAAK,SAAS,OAAO,EAC1D,QAAQ,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,EAC1B,KAAK,CAAC,EAAE,GAAG,EACX,MAAM,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,GAC9B,OAAO,CAQT"}

package/dist/table/features/grouping.d.ts

@@ -0,0 +1,182 @@
+import type { CellContext, RowModel } from "..";
+import { type BuiltInAggregationFn } from "../aggregation-fns";
+import type { TableFeature } from "../core/table";
+import type { AggregationFns, Column, ColumnDefTemplate, ColumnMeta, OnChangeFn, Row, RowData, TableInstance, Updater } from "../types";
+export type GroupingState = string[];
+export interface GroupingTableState {
+    grouping: GroupingState;
+}
+export type AggregationFn<TData extends RowData> = (
+/**
+ * The id of the column.
+ */
+columnId: string, 
+/** @inheritDoc */
+leafRows: Row<TData>[], 
+/** @inheritDoc */
+childRows: Row<TData>[]) => any;
+export type CustomAggregationFns = Record<string, AggregationFn<any>>;
+export type AggregationFnOption<TData extends RowData> = "auto" | keyof AggregationFns | BuiltInAggregationFn | AggregationFn<TData>;
+export interface GroupingColumnDef<TData extends RowData, TValue> {
+    /**
+     * The cell to display each row for the column if the cell is an aggregate.
+     */
+    aggregatedCell?: ColumnDefTemplate<CellContext<TData, TValue>>;
+    /**
+     * The resolved aggregation function for the column.
+     *
+     * @inheritDoc
+     */
+    aggregationFn?: AggregationFnOption<TData>;
+    /**
+     * Enables/disables grouping for this column.
+     */
+    enableGrouping?: boolean;
+    /**
+     * Specify a value to be used for grouping rows on this column. If this option is
+     * not specified, the value derived from `accessorKey` / `accessorFn` will be used
+     * instead.
+     */
+    getGroupingValue?: (row: TData) => any;
+}
+export interface GroupingColumn<TData extends RowData> {
+    /**
+     * Returns the aggregation function for the column.
+     *
+     * @inheritDoc
+     */
+    getAggregationFn: () => AggregationFn<TData> | undefined;
+    /**
+     * Returns the automatically inferred aggregation function for the column.
+     *
+     * @inheritDoc
+     */
+    getAutoAggregationFn: () => AggregationFn<TData> | undefined;
+    /**
+     * Returns whether the column can be grouped.
+     */
+    getCanGroup: () => boolean;
+    /**
+     * Returns the index of the column in the grouping state.
+     */
+    getGroupedIndex: () => number;
+    /**
+     * Returns whether the column is currently grouped.
+     */
+    getIsGrouped: () => boolean;
+    /**
+     * Returns a function that toggles the grouping state of the column. This is
+     * useful for passing to the `onClick` prop of a button.
+     */
+    getToggleGroupingHandler: () => () => void;
+    /**
+     * Toggles the grouping state of the column.
+     */
+    toggleGrouping: () => void;
+}
+export interface GroupingRow {
+    /** @internal */
+    _groupingValuesCache: Record<string, any>;
+    /**
+     * Returns the grouping value for any row and column (including leaf rows).
+     */
+    getGroupingValue: (columnId: string) => unknown;
+    /**
+     * Returns whether the row is currently grouped.
+     */
+    getIsGrouped: () => boolean;
+    /**
+     * If this row is grouped, this is the id of the column that this row is grouped
+     * by.
+     */
+    groupingColumnId?: string;
+    /**
+     * If this row is grouped, this is the unique/shared value for the
+     * `groupingColumnId` for all of the rows in this group.
+     */
+    groupingValue?: unknown;
+}
+export interface GroupingCell {
+    /**
+     * Returns whether the cell is currently aggregated.
+     */
+    getIsAggregated: () => boolean;
+    /**
+     * Returns whether the cell is currently grouped.
+     */
+    getIsGrouped: () => boolean;
+    /**
+     * Returns whether the cell is currently a placeholder cell.
+     */
+    getIsPlaceholder: () => boolean;
+}
+export interface ColumnDefaultOptions {
+    enableGrouping: boolean;
+    onGroupingChange: OnChangeFn<GroupingState>;
+}
+interface GroupingOptionsBase {
+    /**
+     * Enables/disables grouping for the table.
+     */
+    enableGrouping?: boolean;
+    /**
+     * Returns the row model after grouping has taken place, but no further.
+     */
+    getGroupedRowModel?: (
+    /** @inheritDoc */
+    table: TableInstance<any>) => () => RowModel<any>;
+    /**
+     * Grouping columns are automatically reordered by default to the start of the
+     * columns list. If you would rather remove them or leave them as-is, set the
+     * appropriate mode here.
+     */
+    groupedColumnMode?: false | "reorder" | "remove";
+    /**
+     * Enables manual grouping. If this option is set to `true`, the table will not
+     * automatically group rows using `getGroupedRowModel()` and instead will expect
+     * you to manually group the rows before passing them to the table. This is useful
+     * if you are doing server-side grouping and aggregation.
+     */
+    manualGrouping?: boolean;
+    /**
+     * If this function is provided, it will be called when the grouping state changes
+     * and you will be expected to manage the state yourself. You can pass the managed
+     * state back to the table via the `tableOptions.state.grouping` option.
+     */
+    onGroupingChange?: OnChangeFn<GroupingState>;
+}
+type ResolvedAggregationFns = keyof AggregationFns extends never ? {
+    /** @inheritDoc */
+    aggregationFns?: Record<string, AggregationFn<any>>;
+} : {
+    /** @inheritDoc */
+    aggregationFns: Record<keyof AggregationFns, AggregationFn<any>>;
+};
+export interface GroupingOptions extends GroupingOptionsBase, ResolvedAggregationFns {
+}
+export type GroupingColumnMode = false | "reorder" | "remove";
+export interface GroupingInstance<TData extends RowData> {
+    /** @internal */
+    _getGroupedRowModel?: () => RowModel<TData>;
+    /**
+     * Returns the row model for the table after grouping has been applied.
+     */
+    getGroupedRowModel: () => RowModel<TData>;
+    /**
+     * Returns the row model for the table before any grouping has been applied.
+     */
+    getPreGroupedRowModel: () => RowModel<TData>;
+    /**
+     * Resets the `grouping` state to `initialState.grouping`, or `true` can be
+     * passed to force a default blank state reset to `[]`.
+     */
+    resetGrouping: (defaultState?: boolean) => void;
+    /**
+     * Updates the grouping state of the table via an update function or value.
+     */
+    setGrouping: (updater: Updater<GroupingState>) => void;
+}
+export declare const Grouping: TableFeature;
+export declare function orderColumns<TData extends RowData>(leafColumns: Column<TData, unknown>[], grouping: string[], groupedColumnMode?: GroupingColumnMode): Column<TData, unknown, ColumnMeta>[];
+export {};
+//# sourceMappingURL=grouping.d.ts.map

package/dist/table/features/grouping.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"grouping.d.ts","sourceRoot":"","sources":["../../../src/table/features/grouping.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,WAAW,EAAE,QAAQ,EAAC,MAAM,IAAI,CAAA;AAC7C,OAAO,EAAiB,KAAK,oBAAoB,EAAC,MAAM,oBAAoB,CAAA;AAC5E,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,eAAe,CAAA;AAC/C,OAAO,KAAK,EACV,cAAc,EAEd,MAAM,EACN,iBAAiB,EACjB,UAAU,EACV,UAAU,EACV,GAAG,EACH,OAAO,EACP,aAAa,EACb,OAAO,EACR,MAAM,UAAU,CAAA;AAGjB,MAAM,MAAM,aAAa,GAAG,MAAM,EAAE,CAAA;AAEpC,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,aAAa,CAAA;CACxB;AAED,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,OAAO,IAAI;AACjD;;GAEG;AACH,QAAQ,EAAE,MAAM;AAChB,kBAAkB;AAClB,QAAQ,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE;AACtB,kBAAkB;AAClB,SAAS,EAAE,GAAG,CAAC,KAAK,CAAC,EAAE,KACpB,GAAG,CAAA;AAER,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAA;AAErE,MAAM,MAAM,mBAAmB,CAAC,KAAK,SAAS,OAAO,IACjD,MAAM,GACN,MAAM,cAAc,GACpB,oBAAoB,GACpB,aAAa,CAAC,KAAK,CAAC,CAAA;AAExB,MAAM,WAAW,iBAAiB,CAAC,KAAK,SAAS,OAAO,EAAE,MAAM;IAC9D;;OAEG;IACH,cAAc,CAAC,EAAE,iBAAiB,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;IAC9D;;;;OAIG;IACH,aAAa,CAAC,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAA;IAC1C;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,KAAK,GAAG,CAAA;CACvC;AAED,MAAM,WAAW,cAAc,CAAC,KAAK,SAAS,OAAO;IACnD;;;;OAIG;IACH,gBAAgB,EAAE,MAAM,aAAa,CAAC,KAAK,CAAC,GAAG,SAAS,CAAA;IACxD;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,aAAa,CAAC,KAAK,CAAC,GAAG,SAAS,CAAA;IAC5D;;OAEG;IACH,WAAW,EAAE,MAAM,OAAO,CAAA;IAC1B;;OAEG;IACH,eAAe,EAAE,MAAM,MAAM,CAAA;IAC7B;;OAEG;IACH,YAAY,EAAE,MAAM,OAAO,CAAA;IAC3B;;;OAGG;IACH,wBAAwB,EAAE,MAAM,MAAM,IAAI,CAAA;IAC1C;;OAEG;IACH,cAAc,EAAE,MAAM,IAAI,CAAA;CAC3B;AAED,MAAM,WAAW,WAAW;IAC1B,gBAAgB;IAChB,oBAAoB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IACzC;;OAEG;IACH,gBAAgB,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAA;IAC/C;;OAEG;IACH,YAAY,EAAE,MAAM,OAAO,CAAA;IAC3B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,eAAe,EAAE,MAAM,OAAO,CAAA;IAC9B;;OAEG;IACH,YAAY,EAAE,MAAM,OAAO,CAAA;IAC3B;;OAEG;IACH,gBAAgB,EAAE,MAAM,OAAO,CAAA;CAChC;AAED,MAAM,WAAW,oBAAoB;IACnC,cAAc,EAAE,OAAO,CAAA;IACvB,gBAAgB,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;CAC5C;AAED,UAAU,mBAAmB;IAC3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE;IACnB,kBAAkB;IAClB,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,KACtB,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAA;IACxB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,KAAK,GAAG,SAAS,GAAG,QAAQ,CAAA;IAChD;;;;;OAKG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,UAAU,CAAC,aAAa,CAAC,CAAA;CAC7C;AAED,KAAK,sBAAsB,GAAG,MAAM,cAAc,SAAS,KAAK,GAC5D;IACE,kBAAkB;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAA;CACpD,GACD;IACE,kBAAkB;IAClB,cAAc,EAAE,MAAM,CAAC,MAAM,cAAc,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAA;CACjE,CAAA;AAEL,MAAM,WAAW,eACf,SAAQ,mBAAmB,EACzB,sBAAsB;CAAG;AAE7B,MAAM,MAAM,kBAAkB,GAAG,KAAK,GAAG,SAAS,GAAG,QAAQ,CAAA;AAE7D,MAAM,WAAW,gBAAgB,CAAC,KAAK,SAAS,OAAO;IACrD,gBAAgB;IAChB,mBAAmB,CAAC,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC3C;;OAEG;IACH,kBAAkB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IACzC;;OAEG;IACH,qBAAqB,EAAE,MAAM,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC5C;;;OAGG;IACH,aAAa,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IAC/C;;OAEG;IACH,WAAW,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,KAAK,IAAI,CAAA;CACvD;AAID,eAAO,MAAM,QAAQ,EAAE,YAiKtB,CAAA;AAED,wBAAgB,YAAY,CAAC,KAAK,SAAS,OAAO,EAChD,WAAW,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,EACrC,QAAQ,EAAE,MAAM,EAAE,EAClB,iBAAiB,CAAC,EAAE,kBAAkB,GACrC,MAAM,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,CAkBtC"}

package/dist/table/features/ordering.d.ts

@@ -0,0 +1,33 @@
+import type { TableFeature } from "../core/table";
+import type { Column, OnChangeFn, RowData, Updater } from "../types";
+export interface ColumnOrderTableState {
+    columnOrder: ColumnOrderState;
+}
+export type ColumnOrderState = string[];
+export interface ColumnOrderOptions {
+    /**
+     * If provided, this function will be called with an `updaterFn` when
+     * `state.columnOrder` changes. This overrides the default internal state
+     * management, so you will need to persist the state change either fully or
+     * partially outside the table.
+     */
+    onColumnOrderChange?: OnChangeFn<ColumnOrderState>;
+}
+export interface ColumnOrderDefaultOptions {
+    onColumnOrderChange: OnChangeFn<ColumnOrderState>;
+}
+export interface ColumnOrderInstance<TData extends RowData> {
+    /** @internal */
+    _getOrderColumnsFn: () => (columns: Column<TData, unknown>[]) => Column<TData, unknown>[];
+    /**
+     * Resets the `columnOrder` state to `initialState.columnOrder`, or `true` can
+     * be passed to force a default blank state reset to `[]`.
+     */
+    resetColumnOrder: (defaultState?: boolean) => void;
+    /**
+     * Sets or updates the `state.columnOrder` state.
+     */
+    setColumnOrder: (updater: Updater<ColumnOrderState>) => void;
+}
+export declare const Ordering: TableFeature;
+//# sourceMappingURL=ordering.d.ts.map

package/dist/table/features/ordering.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ordering.d.ts","sourceRoot":"","sources":["../../../src/table/features/ordering.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,eAAe,CAAA;AAC/C,OAAO,KAAK,EACV,MAAM,EACN,UAAU,EACV,OAAO,EAEP,OAAO,EACR,MAAM,UAAU,CAAA;AAKjB,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,gBAAgB,CAAA;CAC9B;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,EAAE,CAAA;AAEvC,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAA;CACnD;AAED,MAAM,WAAW,yBAAyB;IACxC,mBAAmB,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAA;CAClD;AAED,MAAM,WAAW,mBAAmB,CAAC,KAAK,SAAS,OAAO;IACxD,gBAAgB;IAChB,kBAAkB,EAAE,MAAM,CACxB,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,KAC9B,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,CAAA;IAC7B;;;OAGG;IACH,gBAAgB,EAAE,CAAC,YAAY,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IAClD;;OAEG;IACH,cAAc,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,KAAK,IAAI,CAAA;CAC7D;AAED,eAAO,MAAM,QAAQ,EAAE,YAqEtB,CAAA"}

package/dist/table/features/pagination.d.ts

@@ -0,0 +1,127 @@
+import type { TableFeature } from "../core/table";
+import type { OnChangeFn, RowData, RowModel, TableInstance, Updater } from "../types";
+export interface PaginationState {
+    pageIndex: number;
+    pageSize: number;
+}
+export interface PaginationTableState {
+    pagination: PaginationState;
+}
+export interface PaginationInitialTableState {
+    pagination?: Partial<PaginationState>;
+}
+export interface PaginationOptions {
+    /**
+     * If set to `true`, pagination will be reset to the first page when page-altering
+     * state changes e.g.,`data` is updated, filters change, grouping changes, etc.
+     */
+    autoResetPageIndex?: boolean;
+    /**
+     * Returns the row model after pagination has taken place, but no further.
+     *
+     * Pagination columns are automatically reordered by default to the start of the
+     * columns list. If you would rather remove them or leave them as-is, set the
+     * appropriate mode here.
+     */
+    getPaginationRowModel?: (
+    /** @inheritDoc */
+    table: TableInstance<any>) => () => RowModel<any>;
+    /**
+     * Enables manual pagination. If this option is set to `true`, the table will not
+     * automatically paginate rows using `getPaginationRowModel()` and instead will
+     * expect you to manually paginate the rows before passing them to the table. This
+     * is useful if you are doing server-side pagination and aggregation.
+     */
+    manualPagination?: boolean;
+    /**
+     * If this function is provided, it will be called when the pagination state
+     * changes and you will be expected to manage the state yourself. You can pass the
+     * managed state back to the table via the `tableOptions.state.pagination` option.
+     */
+    onPaginationChange?: OnChangeFn<PaginationState>;
+    /**
+     * When manually controlling pagination, you should supply a total `pageCount`
+     * value to the table if you know it. If you do not know how many pages there are,
+     * you can set this to `-1`.
+     */
+    pageCount?: number;
+}
+export interface PaginationDefaultOptions {
+    onPaginationChange: OnChangeFn<PaginationState>;
+}
+export interface PaginationInstance<TData extends RowData> {
+    /** @internal */
+    _autoResetPageIndex: () => void;
+    /** @internal */
+    _getPaginationRowModel?: () => RowModel<TData>;
+    /**
+     * Returns whether the table can go to the next page.
+     */
+    getCanNextPage: () => boolean;
+    /**
+     * Returns whether the table can go to the previous page.
+     */
+    getCanPreviousPage: () => boolean;
+    /**
+     * Returns the page count. If manually paginating or controlling the pagination
+     * state, this will come directly from the `options.pageCount` table option,
+     * otherwise it will be calculated from the table data using the total row count
+     * and current page size.
+     */
+    getPageCount: () => number;
+    /**
+     * Returns an array of page options (zero-index-based) for the current page size.
+     */
+    getPageOptions: () => number[];
+    /**
+     * Returns the row model for the table after pagination has been applied.
+     */
+    getPaginationRowModel: () => RowModel<TData>;
+    /**
+     * Returns the row model for the table before any pagination has been applied.
+     */
+    getPrePaginationRowModel: () => RowModel<TData>;
+    /**
+     * Increments the page index by one, if possible.
+     */
+    nextPage: () => void;
+    /**
+     * Decrements the page index by one, if possible.
+     */
+    previousPage: () => void;
+    /**
+     * Resets the page index to its initial state. If `defaultState` is `true`, the
+     * page index will be reset to `0` regardless of initial state.
+     */
+    resetPageIndex: (defaultState?: boolean) => void;
+    /**
+     * Resets the page size to its initial state. If `defaultState` is `true`, the
+     * page size will be reset to `10` regardless of initial state.
+     */
+    resetPageSize: (defaultState?: boolean) => void;
+    /**
+     * Resets the `pagination` state to `initialState.pagination`, or `true` can be
+     * passed to force a default blank state reset to `[]`.
+     */
+    resetPagination: (defaultState?: boolean) => void;
+    /**
+     * Updates the page count using the provided function or value.
+     */
+    setPageCount: (updater: Updater<number>) => void;
+    /**
+     * Updates the page index using the provided function or value in the
+     * `state.pagination.pageIndex` state.
+     */
+    setPageIndex: (updater: Updater<number>) => void;
+    /**
+     * Updates the page size using the provided function or value in the
+     * `state.pagination.pageSize` state.
+     */
+    setPageSize: (updater: Updater<number>) => void;
+    /**
+     * Sets or updates the `state.pagination` state.
+     */
+    setPagination: (updater: Updater<PaginationState>) => void;
+}
+export declare const Pagination: TableFeature;
+//# sourceMappingURL=pagination.d.ts.map