@rivet-health/design-system 40.27.2 → 40.28.0

package/lib/table/table/state-helpers/column-helpers.d.ts

@@ -0,0 +1,14 @@
+import { RivTable } from '../state';
+export declare namespace TableColumnHelpers {
+    function getColumnAlignment(dataType: RivTable.ColumnDataType, isFirst: boolean): RivTable.ColumnAlignment;
+    function getAllColumns<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, supportedColumns: Map<C, RivTable.ColumnMetadata>, columnNameMap: RivTable.ColumnNameMap<C>): RivTable.ColumnSettings<C>[];
+    function resolveColumns<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, supportedColumns: Map<C, RivTable.ColumnMetadata>, columnNameMap: RivTable.ColumnNameMap<C>, allowSelection: boolean | undefined): RivTable.FullColumn<C>[];
+    function changeColumnPin<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, columns: Map<C, RivTable.ColumnMetadata>, columnNameMap: RivTable.ColumnNameMap<C>, column: C, pinned: boolean): RivTable.CoreState<R, C, F, G>;
+    function changeColumnsFreezeState<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, columns: Map<C, RivTable.ColumnMetadata>, columnNameMap: RivTable.ColumnNameMap<C>, index: number, freeze: boolean): RivTable.CoreState<R, C, F, G>;
+    function moveColumnTo<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, columns: Map<C, RivTable.ColumnMetadata>, columnNameMap: RivTable.ColumnNameMap<C>, column: C, position: 'start' | 'end'): RivTable.CoreState<R, C, F, G>;
+    function changeColumnOrder<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, columns: Map<C, RivTable.ColumnMetadata>, columnNameMap: RivTable.ColumnNameMap<C>, previousIndex: number, newIndex: number): RivTable.CoreState<R, C, F, G>;
+    function changeColumnEnabled<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, columns: Map<C, RivTable.ColumnMetadata>, columnNameMap: RivTable.ColumnNameMap<C>, column: C, enabled: boolean): RivTable.CoreState<R, C, F, G>;
+    function enableAllColumns<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, columns: Map<C, RivTable.ColumnMetadata>, columnNameMap: RivTable.ColumnNameMap<C>, enabled: boolean): RivTable.CoreState<R, C, F, G>;
+    function changeColumnWidth<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, columns: Map<C, RivTable.ColumnMetadata>, columnNameMap: RivTable.ColumnNameMap<C>, column: C, preferredWidth: RivTable.ColumnSettings<C>['preferredWidth']): RivTable.CoreState<R, C, F, G>;
+    function resetToDefaultColumns<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, columns: Map<C, RivTable.ColumnMetadata>, columnNameMap: RivTable.ColumnNameMap<C>, defaultColumnState: RivTable.ColumnSettings<C>[]): RivTable.CoreState<R, C, F, G>;
+}

package/lib/table/table/state-helpers/display-helpers.d.ts

@@ -0,0 +1,5 @@
+import { RivTable } from '../state';
+export declare namespace TableDisplayHelpers {
+    function getZeroStateMessage<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, entity: string): string | null;
+    function memoizedCellRowSpan<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(s: RivTable.CoreState<R, C, F, G>, fullColumns: RivTable.FullColumn<C>[], options?: RivTable.ManagerOptions<R, C, F, G>): Map<C, number[]> | null;
+}

package/lib/table/table/state-helpers/order-helpers.d.ts

@@ -0,0 +1,12 @@
+import { RivTable } from '../state';
+export declare namespace TableOrderHelpers {
+    function orderEmptyLast<R>(rows: R[], key: keyof R, direction: RivTable.OrderDirection): R[];
+    function orderNestedRowsEmptyLast<R extends RivTable.Row>(rows: RivTable.NestedRow<R>[], key: keyof R, direction: RivTable.OrderDirection): RivTable.NestedRow<R>[];
+    function orderNestedRowsBySearchMatch<R extends RivTable.Row>(rows: RivTable.NestedRow<R>[], idToSearchIndexMap: Map<string | number, number>): RivTable.NestedRow<R>[];
+    function toggleColumnOrder<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, column: C): RivTable.CoreState<R, C, F, G>;
+    function sortLowLevelNestedRows<R extends RivTable.Row>(allRows: RivTable.NestedRow<R>[], sortKey: keyof R, direction: RivTable.OrderDirection): RivTable.NestedRow<R>[];
+    function sortLowLevelNestedRowsWithHeaders<R extends RivTable.Row>(allHeaders: RivTable.NestedHeaderRow<R>[], sortKey: keyof R, direction: RivTable.OrderDirection): RivTable.NestedHeaderRow<R>[];
+    function createIdToSearchIndexMap<R extends RivTable.Row>(rowsMatchingSearch: R[]): Map<string | number, number>;
+    function sortNestedRowsBasedOnSearchMatches<R extends RivTable.Row>(allRows: RivTable.NestedRow<R>[], idToSearchIndexMap: Map<string | number, number>): RivTable.NestedRow<R>[];
+    function sortNestedRowsWithHeadersBasedOnSearchMatches<R extends RivTable.Row>(allHeaders: RivTable.NestedHeaderRow<R>[], idToSearchIndexMap: Map<string | number, number>): RivTable.NestedHeaderRow<R>[];
+}

package/lib/table/table/state-helpers/pagination-helpers.d.ts

@@ -0,0 +1,13 @@
+import { RivTable } from '../state';
+export declare namespace TablePaginationHelpers {
+    function getPageCount<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): number;
+    function getPreviousPage<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): number | null;
+    function getPages<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): number[];
+    function getNextPage<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): number | null;
+    function getShowPaginationControls<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): boolean;
+    function getPageRowStart<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): number;
+    function getPageRowEnd<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): number;
+    function isPageOutOfBounds<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, result: RivTable.Result<R> | RivTable.GroupResult<R, G>): boolean;
+    function paginateNestedRows<R extends RivTable.Row>(allNestedRows: RivTable.NestedRow<R>[], pageNumber: number, pageSize: number): RivTable.NestedRow<R>[];
+    function paginateNestedHeaderRows<R extends RivTable.Row>(allHeaders: RivTable.NestedHeaderRow<R>[], pageNumber: number, pageSize: number): RivTable.NestedHeaderRow<R>[];
+}

package/lib/table/table/state-helpers/result-helpers.d.ts

@@ -0,0 +1,11 @@
+import { RivTable } from '../state';
+export declare namespace TableResultHelpers {
+    function isRegularResult<R extends RivTable.Row, G extends RivTable.Group>(result: RivTable.Result<R> | RivTable.GroupResult<R, G> | RivTable.NestedResult<R> | RivTable.NestedWithHeaderResult<R>): result is RivTable.Result<R>;
+    function isGroupResult<R extends RivTable.Row, G extends RivTable.Group>(result: RivTable.Result<R> | RivTable.GroupResult<R, G> | RivTable.NestedResult<R> | RivTable.NestedWithHeaderResult<R>): result is RivTable.GroupResult<R, G>;
+    function isNestedResult<R extends RivTable.Row, G extends RivTable.Group>(result: RivTable.Result<R> | RivTable.GroupResult<R, G> | RivTable.NestedResult<R> | RivTable.NestedWithHeaderResult<R>): result is RivTable.NestedResult<R>;
+    function isNestedWithHeaderResult<R extends RivTable.Row, G extends RivTable.Group>(result: RivTable.Result<R> | RivTable.GroupResult<R, G> | RivTable.NestedResult<R> | RivTable.NestedWithHeaderResult<R>): result is RivTable.NestedWithHeaderResult<R>;
+    function getAllRowsFromResult<R extends RivTable.Row, G extends RivTable.Group>(result: RivTable.Result<R> | RivTable.GroupResult<R, G> | RivTable.NestedResult<R> | RivTable.NestedWithHeaderResult<R>): R[];
+    function getAllRowsFromNestedRows<R extends RivTable.Row>(nestedRows: RivTable.NestedRow<R>[]): R[];
+    function getAllRowsFromNestedHeaders<R extends RivTable.Row>(nestedHeaders: RivTable.NestedHeaderRow<R>[]): R[];
+    function getCsvFilename<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(pluralEntityName: string, options?: RivTable.ManagerOptions<R, C, F, G>): string;
+}

package/lib/table/table/state-helpers/search-helpers.d.ts

@@ -0,0 +1,5 @@
+import { RivTable } from '../state';
+export declare namespace TableSearchHelpers {
+    function getSearchColumnsSelectedState<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, expectedValue: 'all' | 'none'): boolean;
+    function toggleAllSearchColumns<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): RivTable.CoreState<R, C, F, G>;
+}

package/lib/table/table/state-helpers/selection-helpers.d.ts

@@ -0,0 +1,13 @@
+import { RivTable } from '../state';
+export declare namespace TableSelectionHelpers {
+    function isRowSelected<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, id: R['id']): boolean;
+    function isGroupSelected<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, group: RivTable.SubGroupResult<R, G>): RivTable.MultiSelectionState;
+    function isAllSelected<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): RivTable.MultiSelectionState;
+    function isCurrentPageSelected<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): RivTable.MultiSelectionState;
+    function selectedCount<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): number;
+    function setRowSelected<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, id: R['id'], selected: boolean, contiguous: boolean): RivTable.CoreState<R, C, F, G>;
+    function toggleGroupSelected<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>, group: RivTable.RowGroup<R, G>): RivTable.CoreState<R, C, F, G>;
+    function togglePageSelected<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): RivTable.CoreState<R, C, F, G>;
+    function toggleAllSelected<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): RivTable.CoreState<R, C, F, G>;
+    function clearSelection<R extends RivTable.Row, C extends RivTable.Column, F extends RivTable.Filters, G extends RivTable.Group>(state: RivTable.CoreState<R, C, F, G>): RivTable.CoreState<R, C, F, G>;
+}

package/lib/table/table/state.d.ts

@@ -147,6 +147,42 @@ export declare namespace RivTable {
          */
         totalMatchingRowCount: number;
     };
+    type NestedRow<R extends Row> = {
+        subRows?: NestedRow<R>[];
+        data: R;
+    };
+    type NestedResult<R extends Row> = {
+        /**
+         * The full row data for the current page, after filters, search query, and
+         * row ordering are applied, nested into "rows with subrows"
+         */
+        currentPageNestedRows: NestedRow<R>[];
+        /**
+         * The total number of rows (regardless of pagination) that match the
+         * filters and search query.
+         *
+         * Only counts rows at the bottom level of nesting.
+         */
+        totalMatchingRowCount: number;
+    };
+    type NestedHeaderRow<R extends Row> = {
+        subRows: NestedRow<R>[];
+        headerText: string;
+    };
+    type NestedWithHeaderResult<R extends Row> = {
+        /**
+         * The full row data for the current page, after filters, search query, and
+         * row ordering are applied, nested into "headers with subrows".
+         */
+        currentPageNestedHeaders: NestedHeaderRow<R>[];
+        /**
+         * The total number of rows (regardless of pagination) that match the
+         * filters and search query.
+         *
+         * Only counts rows at the bottom level of nesting.
+         */
+        totalMatchingRowCount: number;
+    };
     type Source<R extends Row, C extends Column, F extends Filters, G extends Group = {
         key: '';
     }> = (query: Query<C, F>, mostRecentAction: Action<R, C, F, G>) => Promise<Result<R> | GroupResult<R, G>>;
@@ -278,6 +314,18 @@ export declare namespace RivTable {
         totalMatchingRowCount: number;
         groupData: G;
     };
+    type FullNestedRow<R extends Row> = {
+        id: string | number;
+        subRows?: FullNestedRow<R>[];
+        data: R;
+        rowLink: RowLink | null;
+        selected: boolean;
+    };
+    type FullNestedWithHeaderRow<R extends Row> = {
+        id: string | number;
+        subRows: FullNestedRow<R>[];
+        headerText: string;
+    };
     type FullColumn<C extends Column> = ColumnSettings<C> & ColumnMetadata & {
         width: number;
         left: number | null;
@@ -419,5 +467,4 @@ export declare namespace RivTable {
         };
     };
     function createInMemoryManager<R extends Row, C extends Column, F extends Filters>(fetchDataset: () => Promise<R[]> | R[], columns: Map<C, InMemoryColumnMetadata<R>>, pluralEntityName: string, options?: InMemoryManagerOptions<R, C, F>): Manager<R, C, F>;
-    function getColumnAlignment(dataType: ColumnDataType, isFirst: boolean): ColumnAlignment;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivet-health/design-system",
-  "version": "40.27.2",
+  "version": "40.28.0",
   "peerDependencies": {
     "@angular/animations": ">=14.0.0",
     "@angular/common": ">=14.0.0",