@turquoisehealth/pit-viper 2.130.2-dev.0 → 2.131.0

package/pv-components/dist/vue/visualizations/components/tables/PvDataTable/types.d.ts

@@ -1,352 +0,0 @@
-import { AgCartesianSeriesTooltipRendererParams } from 'ag-charts-enterprise';
-import { ColDefDataType } from './table-components/formatting';
-import { Component, ComputedRef, CSSProperties, Ref } from 'vue';
-import { CellSelectionOptions, Column, FilterModel, GetContextMenuItemsParams, GridState, IServerSideGetRowsParams, ProcessCellForExportParams, ProcessDataFromClipboardParams, RowSelectionOptions, Theme, ValueFormatterFunc } from 'ag-grid-enterprise';
-import { ColDef, GridApi, IsGroupOpenByDefaultParams, IsServerSideGroupOpenByDefaultParams, RefreshServerSideParams } from 'ag-grid-community';
-import { QueryBuilderSuggestionMenuOption } from '../../base/PvQueryBuilderInput/useQueryBuilder';
-import { MenuOption, PvMultiSelectButtonSlotProps } from '../../base';
-export type TableSearchStyle = "query-builder" | "text";
-/**
- * Context passed to custom filter renderer components via slotContext
- */
-export interface FilterSlotContext {
-    gridApi?: GridApi;
-    colDef?: ColDef;
-    /** Whether the table is currently loading rows */
-    rowsLoading?: boolean;
-}
-/**
- * Props passed to custom filter renderer components (header, footer, empty results, options)
- * Extends PvMultiSelectButton slot props with MenuOption specialized to FilterValueResponseOption
- */
-export interface FilterRendererProps extends Omit<PvMultiSelectButtonSlotProps<FilterValueResponseOption, FilterSlotContext>, 'selectedItems'> {
-    selectedItems: MenuOption<FilterValueResponseOption>[];
-}
-export interface FocusUpdateEvent {
-    focuses?: string[] | null | undefined;
-    filterField?: string | null | undefined;
-}
-export interface ChartState {
-    seriesField?: string | null;
-    secondarySeriesField?: string | null;
-    chartType?: string | null;
-    chartSort?: string | null;
-    chartCategoryFields?: string[] | null;
-    tableGrouped?: boolean | null;
-}
-export interface ChartStateChangedEvent {
-    api: GridApi | null;
-    newState: ChartState | null;
-    oldState: ChartState | null;
-}
-export interface TooltipDatum {
-    [key: string]: string | number | undefined;
-}
-export type ChartTooltipRenderer = (params: AgCartesianSeriesTooltipRendererParams<TooltipDatum>) => string;
-export interface ColDefContextProps<T> {
-    aggFuncDisplayName?: string;
-    chartSeriesDisplayName?: string;
-    dataType?: ColDefDataType;
-    emptyFilterResultsRenderer?: Component;
-    filterSelectMax?: number;
-    filterSelectMin?: number;
-    filterOptionsSortDescription?: string;
-    filterOptionsSortTooltip?: string;
-    filterOptionsRenderer?: Component;
-    filterSearch?: boolean;
-    filterRequiredToGroup?: boolean;
-    filterValueFormatter?: string | ValueFormatterFunc<T> | undefined;
-    filterHeaderRenderer?: Component;
-    filterFooterRenderer?: Component;
-    isArrayField?: boolean;
-    metadataDisplayFields?: string[];
-    valueDecimals?: number;
-    visibilityState?: "alwaysShow" | "alwaysHide";
-    hideFromCharting?: boolean;
-    chartOnSecondaryAxes?: boolean;
-    customTooltipRenderer?: ChartTooltipRenderer;
-    queryColIds?: string[];
-    aggregateFields?: string[];
-}
-export interface FilterValuesSetHandlerParams<T> {
-    api: GridApi<T>;
-    colDef: ColDef<T>;
-    column: Column<T>;
-    filterModel?: FilterModel | null;
-    query?: string;
-}
-export interface TableSearchHandlerParams<T> {
-    api: GridApi<T>;
-    filterModel?: FilterModel | null;
-    query?: string;
-}
-export interface FilterValueMatchResult {
-    matchedField?: string;
-    matchedValue?: string;
-}
-export interface FilterValueResponseOption {
-    value: string;
-    label?: string;
-    subduedText?: string;
-    isPreference?: boolean;
-    isSelectable?: boolean;
-    metadata?: any;
-    colField?: string;
-    matchedValue?: string;
-    matchedField?: string;
-}
-export interface PvDataTableProps<T> {
-    /**
-     * Column definitions for the table. Follows the AG Grid column definition format.
-     */
-    colDefs?: ColDef<T>[];
-    /**
-     * Array of JSON data objects to be displayed in the table. Only used for client-side row model.
-     */
-    rowData?: T[];
-    /**
-     * Handler to fetch server-side data. Only used for server-side row model.
-     */
-    serverSideRowHandler?: (params: IServerSideGetRowsParams<T>, isCsvExport?: boolean) => void;
-    /**
-     * Handler to fetch filter values for server-side filtering. Only used for server-side row model.
-     */
-    filterValuesSetHandler?: (params: FilterValuesSetHandlerParams<T>) => Promise<(FilterValueResponseOption | null)[]>;
-    /**
-     * Handler to return suggestions for applying search terms to the table.
-     */
-    tableSearchHandler?: (params: TableSearchHandlerParams<T>) => Promise<(QueryBuilderSuggestionMenuOption | null)[]>;
-    /**
-     * Specifies an initial set of filters/groups/sort/etc. to be applied to the table.
-     */
-    initialGridState?: GridState;
-    /**
-     * Specifies an initial set of metadata values for filters that require them
-     */
-    initialFilterValueMap?: Record<string, (FilterValueResponseOption | null)[]>;
-    /**
-     * Override the Pit Viper them
-     */
-    theme?: Theme;
-    /**
-     * For aggregated columns, only show the aggregate at the final group level
-     */
-    displayBaseAggregationsOnly?: boolean;
-    /**
-     * Display Row Number in the first column
-     */
-    displayRowNumber?: boolean;
-    /**
-     * Display Counts on Grouped Rows (requires allChildrenCount on the object)
-     */
-    displayGroupCount?: boolean;
-    /**
-     * Displays Icon on Preferences that emits handle-settings-icon event
-     */
-    displayPreferencesIcon?: boolean;
-    /**
-     * Display button to hide/show columns
-     */
-    enableColumnVisibilitySelector?: boolean;
-    /**
-     * Display everything focus view related
-     */
-    enableFocusView?: boolean;
-    /**
-     * Display button to group by columns
-     */
-    enableGroupBySelector?: boolean;
-    /**
-     * Display input to search within the table
-     */
-    enableTableSearch?: boolean;
-    /**
-     * Allows for slot content to be placed above the chart
-     */
-    enableTopSlot?: boolean;
-    /**
-     * Display button to open the vertical filter drawer
-     */
-    enableVerticalFilterPanel?: boolean;
-    /**
-     * Number of groups to support (defaults to 2)
-     */
-    rowGroupLimit?: number;
-    /**
-     * Whether to expand all groups by default, based on level. -1 expands all groups
-     */
-    groupDefaultExpanded?: number;
-    /**
-     * A handler to determine if a group should be open by default dynamically.
-     */
-    isClientSideGroupOpenByDefault?: (params: IsGroupOpenByDefaultParams) => boolean;
-    /**
-     * A handler to determine whether a group should be open by default.
-     */
-    isServerSideGroupOpenByDefault?: (params: IsServerSideGroupOpenByDefaultParams) => boolean;
-    /**
-     * Display button to export table data as CSV
-     */
-    enableCsvExport?: boolean;
-    /**
-     * # of rows to export to CSV - be careful overriding this as large exports can cause performance issues
-     */
-    csvRowLimit?: number;
-    /**
-     * Optional param to implement custom logic for CSV export. If not specified, the serverSideRowHandler will be used to generate the CSV data.
-     */
-    serverSideCsvHandler?: (params: IServerSideGetRowsParams<T>) => Promise<void>;
-    /**
-     * Field that can be used to identify row uniqueness for preserving expanded/collapsed row states
-     */
-    uniqueRowIdField?: string;
-    /**
-     * If true, will not show data until at least one filter is applied
-     */
-    requireFiltersToShowData?: boolean;
-    /**
-     * If true, will show loading state - can be used as a dynamic prop to show/hide loading state
-     */
-    isLoading?: boolean;
-    /**
-     * Height of the table + filter container (must be a valid CSS height value, e.g. '500px', '50vh', etc.).
-     */
-    containerHeight?: string;
-    /**
-     * Min height of the table + filter container (must be a valid CSS height value, e.g. '500px', '50vh', etc.)
-     */
-    containerMinHeight?: string;
-    /**
-     * Enables the ValidationModule for advanced debugging as well as additional console logging from AG Grid
-     */
-    debugMode?: boolean;
-    /**
-     * If true, hide all row-grouped columns from the table.
-     */
-    hideAllRowGroupedColumns?: boolean;
-    /**
-     * Specifies the column to pin to the left of the table if at least one row grouping is enabled.
-     */
-    leftPinnedColumnName?: string;
-    /**
-     * Enables pagination
-     */
-    pagination?: boolean;
-    /**
-     * Set the pagination page size. Defaults to 50.
-     */
-    paginationPageSize?: 20 | 50 | 100 | 200;
-    /**
-     * Row height for individual rows
-     */
-    rowHeight?: number;
-    /**
-     * Set tooltip show delay. Detaults 1000ms
-     */
-    tooltipShowDelay?: number;
-    /**
-     * Set tooltip hide delay.
-     */
-    tooltipHideDelay?: number;
-    /**
-     * Hide the table rows (but still show the filter panel)
-     */
-    hideTable?: boolean;
-    /**
-     * DOM location to use for relocating the filter panel
-     */
-    filterTeleportLocation?: string;
-    /**
-     * When specified, the filters will be put in their native spot within the AG Grid headers
-     */
-    enableInlineFilters?: boolean;
-    /**
-     * List of column fields that can be focused
-     */
-    focusableColumns?: string[];
-    tableSearchPlaceholder?: string;
-    tableSearchStyle?: TableSearchStyle;
-    maxHorizontalFilters?: number;
-    maintainColumnOrder?: boolean;
-    /**
-     * Custom CSS Properties
-     */
-    customCssProperties?: {
-        agGridWrapper: CSSProperties;
-    };
-    /**
-     * If true, then the table is grouped.
-     */
-    isTableGrouped?: boolean;
-    /**
-     * Options for configuring row selection
-     */
-    rowSelection?: RowSelectionOptions;
-    /**
-     * If true, copies column headers along with cell values when using the clipboard.
-     */
-    copyHeadersToClipboard?: boolean;
-    /**
-     * Controls cell-level selection behavior.
-     *
-     * - `false` (default): Cell selection is disabled and only row selection (if configured)
-     *   is available.
-     * - `true`: Enables the default AG Grid cell selection behavior.
-     * - `CellSelectionOptions`: Pass an options object from `ag-grid-enterprise` to
-     *   fine-tune how cell selection works (for example, enabling range selection,
-     *   configuring selection mode, or adjusting drag/handle behavior).
-     *
-     * Use the boolean form when you only need to turn cell selection on or off.
-     * Use the `CellSelectionOptions` form when you need more granular configuration.
-     */
-    cellSelection?: boolean | CellSelectionOptions;
-    /**
-     * If true, disables cutting data to the clipboard from the table.
-     */
-    suppressCutToClipboard?: boolean;
-    /**
-     * If true, disables pasting data from the clipboard into the table.
-     */
-    suppressClipboardPaste?: boolean;
-    processCellForClipboard?: (params: ProcessCellForExportParams) => any;
-    processCellFromClipboard?: (params: ProcessCellForExportParams) => any;
-    processDataFromClipboard?: (params: ProcessDataFromClipboardParams) => string[][] | null;
-    /**
-     * A handler to customize the context menu items. If provided, will override the default behavior.
-     * Return an array of context menu item names, or undefined to use defaults.
-     */
-    getContextMenuItems?: (params: GetContextMenuItemsParams<T>) => any;
-    /**
-     * If true, enables undo/redo functionality for cell editing.
-     */
-    undoRedoCellEditing?: boolean;
-    /**
-     * The maximum number of undo/redo actions to store. Defaults to 10
-     */
-    undoRedoCellEditingLimit?: number;
-    /**
-     * Properties to override the default `ColDef` properties applied to all columns.
-     *
-     * These overrides are **shallow-merged** with the defaults: only top-level
-     * properties are merged. Nested objects (for example `filterParams`,
-     * `headerClass`, etc.) are not deep-merged; providing an override for a
-     * nested object will replace the entire default object.
-     */
-    defaultColDefOverrides?: Partial<ColDef<T>>;
-    /**
-     * Properties to override the defaults for `autoGroupColumnDef`.
-     *
-     * These overrides are **shallow-merged** with the defaults: only top-level
-     * properties are merged. Nested objects are not deep-merged and will replace
-     * the corresponding default object when provided.
-     */
-    autoGroupColumnDefOverrides?: Partial<ColDef<T>>;
-}
-export interface PvDataTablePublicInterface {
-    getCsvData: () => Promise<string | null>;
-    refreshData: (params?: RefreshServerSideParams | null) => Promise<void>;
-    getFilterValueSelectedMetadataMap: () => Record<string, (FilterValueResponseOption | null)[]>;
-    availableRowGroupColumns: ComputedRef<ColDef[]>;
-    availableAggFuncColumns: ComputedRef<ColDef[]>;
-    rowGroupColumnFields: Ref<string[]>;
-}

package/pv-components/dist/vue/visualizations/components/tables/PvDataTable/useFilterStore.d.ts

@@ -1,45 +0,0 @@
-import { Column, FilterModel } from 'ag-grid-enterprise';
-import { Ref, ComputedRef } from 'vue';
-import { ColDef, GridApi } from 'ag-grid-community';
-import { FilterValueMatchResult, FilterValueResponseOption, FilterValuesSetHandlerParams, TableSearchHandlerParams } from './types';
-import { QueryTerm } from '../../base/PvQueryBuilderInput/useQueryBuilder';
-export declare const createFilterStore: () => {
-    filterModel: Ref<FilterModel | null, FilterModel | null>;
-    filterLastUpdatedMap: Ref<Record<string, number>, Record<string, number>>;
-    filterLastFetchTimeMap: Ref<Record<string, number>, Record<string, number>>;
-    filterModelCleared: Ref<number, number>;
-    filterValuesLoadingStatus: Ref<Record<string, boolean>, Record<string, boolean>>;
-    filterValueMap: Ref<Record<string, (FilterValueResponseOption | null)[]>, Record<string, (FilterValueResponseOption | null)[]>>;
-    filterValueSelectedMetadataMap: Ref<Record<string, (FilterValueResponseOption | null)[]>, Record<string, (FilterValueResponseOption | null)[]>>;
-    filterStoreHandler: Ref<((params: FilterValuesSetHandlerParams<unknown>) => Promise<(FilterValueResponseOption | null)[]>) | undefined, ((params: FilterValuesSetHandlerParams<unknown>) => Promise<(FilterValueResponseOption | null)[]>) | undefined>;
-    fetchFilterValues: (api: GridApi, colDef: ColDef, column: Column, filterModel?: FilterModel) => Promise<(string | null)[]>;
-    filterValueContext: (colField: string, value: string | null) => FilterValueResponseOption | null | undefined;
-    getFilterSelectedValues: (colField: string) => (string | null)[];
-    getSearchMatchDataFromFilterContext: (colDef: ColDef, option: FilterValueResponseOption | null | undefined) => FilterValueMatchResult;
-    isServerSideFilter: ComputedRef<boolean>;
-    stagedFilterModel: Ref<FilterModel | null, FilterModel | null>;
-    setFilterSelectedValues: (colField: string, selectedValues: (string | null)[]) => (string | null)[];
-    setFilterValueSearchText: (colField: string, searchText: string | null) => void;
-    tableSearchFilterModel: Ref<FilterModel | null, FilterModel | null>;
-    tableSearchHandler: Ref<((params: TableSearchHandlerParams<unknown>) => Promise<(QueryTerm | null)[]>) | undefined, ((params: TableSearchHandlerParams<unknown>) => Promise<(QueryTerm | null)[]>) | undefined>;
-};
-export declare const useFilterStore: () => {
-    filterModel: Ref<FilterModel | null, FilterModel | null>;
-    filterLastUpdatedMap: Ref<Record<string, number>, Record<string, number>>;
-    filterLastFetchTimeMap: Ref<Record<string, number>, Record<string, number>>;
-    filterModelCleared: Ref<number, number>;
-    filterValuesLoadingStatus: Ref<Record<string, boolean>, Record<string, boolean>>;
-    filterValueMap: Ref<Record<string, (FilterValueResponseOption | null)[]>, Record<string, (FilterValueResponseOption | null)[]>>;
-    filterValueSelectedMetadataMap: Ref<Record<string, (FilterValueResponseOption | null)[]>, Record<string, (FilterValueResponseOption | null)[]>>;
-    filterStoreHandler: Ref<((params: FilterValuesSetHandlerParams<unknown>) => Promise<(FilterValueResponseOption | null)[]>) | undefined, ((params: FilterValuesSetHandlerParams<unknown>) => Promise<(FilterValueResponseOption | null)[]>) | undefined>;
-    fetchFilterValues: (api: GridApi, colDef: ColDef, column: Column, filterModel?: FilterModel) => Promise<(string | null)[]>;
-    filterValueContext: (colField: string, value: string | null) => FilterValueResponseOption | null | undefined;
-    getFilterSelectedValues: (colField: string) => (string | null)[];
-    getSearchMatchDataFromFilterContext: (colDef: ColDef, option: FilterValueResponseOption | null | undefined) => FilterValueMatchResult;
-    isServerSideFilter: ComputedRef<boolean>;
-    stagedFilterModel: Ref<FilterModel | null, FilterModel | null>;
-    setFilterSelectedValues: (colField: string, selectedValues: (string | null)[]) => (string | null)[];
-    setFilterValueSearchText: (colField: string, searchText: string | null) => void;
-    tableSearchFilterModel: Ref<FilterModel | null, FilterModel | null>;
-    tableSearchHandler: Ref<((params: TableSearchHandlerParams<unknown>) => Promise<(QueryTerm | null)[]>) | undefined, ((params: TableSearchHandlerParams<unknown>) => Promise<(QueryTerm | null)[]>) | undefined>;
-};

package/pv-components/dist/vue/visualizations/components/tables/PvDataTable/useFilterStore.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/pv-components/dist/vue/visualizations/components/tables/PvDataTable/useFocus.d.ts

@@ -1,27 +0,0 @@
-import { ComputedRef } from 'vue';
-export interface FocusData {
-    focuses?: string[] | undefined;
-    focusType?: string | null | undefined;
-}
-export declare const createFocusStore: (initialFocusData?: FocusData | null) => {
-    computedFocuses: ComputedRef<string[]>;
-    computedFocusType: ComputedRef<string | null>;
-    clearAllFocuses: () => void;
-    handleFocusUpdate: (option: string | null) => void;
-    isFocused: (option: string | null, filterField: string | null) => boolean;
-    removeFocus: (option: string | null) => void;
-    isFocusable: (filterFields: string[]) => boolean;
-    setFocusType: (newFocusType: string | null | undefined) => void;
-    setFocuses: (newFocuses: string[]) => void;
-};
-export declare const useFocusStore: () => {
-    computedFocuses: ComputedRef<string[]>;
-    computedFocusType: ComputedRef<string | null>;
-    clearAllFocuses: () => void;
-    handleFocusUpdate: (option: string | null) => void;
-    isFocused: (option: string | null, filterField: string | null) => boolean;
-    removeFocus: (option: string | null) => void;
-    isFocusable: (filterFields: string[]) => boolean;
-    setFocusType: (newFocusType: string | null | undefined) => void;
-    setFocuses: (newFocuses: string[]) => void;
-};

package/pv-components/dist/vue/visualizations/components/tables/PvDataTable/useFocus.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/pv-components/dist/vue/visualizations/components/tables/symbols.d.ts

@@ -1,54 +0,0 @@
-import { InjectionKey, Ref, ShallowRef } from 'vue';
-import { Column, GridApi, SortModelItem, ColDef } from 'ag-grid-community';
-import { MenuOption } from '../../types';
-import { createFilterStore } from './PvDataTable/useFilterStore';
-import { OptionWithFormatterAndDataType } from '../charts/PvDataTableWithChart/types';
-import { createFocusStore } from './PvDataTable/useFocus';
-export declare const FilterStoreKey: InjectionKey<ReturnType<typeof createFilterStore>>;
-export declare const FocusStoreKey: InjectionKey<ReturnType<typeof createFocusStore>>;
-export type SortState = Ref<SortModelItem[]>;
-export declare const SortStateKey: InjectionKey<SortState>;
-export type GridApiState = ShallowRef<GridApi | null>;
-export declare const GridApiKey: InjectionKey<GridApiState>;
-export type ColumnDisplayOrderState = Ref<Column[] | null>;
-export declare const ColumnDisplayOrderKey: InjectionKey<ColumnDisplayOrderState>;
-export type CurrentlyActiveFilterState = Ref<ColDef | null>;
-export declare const CurrentlyActiveFilterKey: InjectionKey<CurrentlyActiveFilterState>;
-export type AvailableFilterColumnsState = Ref<ColDef[]>;
-export declare const AvailableFilterColumnsKey: InjectionKey<AvailableFilterColumnsState>;
-export type AvailableRowGroupColumnsState = Ref<ColDef[]>;
-export declare const AvailableRowGroupColumnsKey: InjectionKey<AvailableRowGroupColumnsState>;
-export type RowGroupColumnFieldsState = Ref<string[]>;
-export declare const RowGroupColumnFieldsKey: InjectionKey<RowGroupColumnFieldsState>;
-export type GroupColumnCellValueColumnState = Ref<Column | null>;
-export declare const GroupColumnCellValueColumnKey: InjectionKey<GroupColumnCellValueColumnState>;
-export type ExpandedRowsState = Ref<Record<number, boolean>>;
-export declare const ExpandedRowsKey: InjectionKey<ExpandedRowsState>;
-export type FirstDataRenderedState = Ref<boolean>;
-export declare const FirstDataRenderedKey: InjectionKey<FirstDataRenderedState>;
-export type RowsLoadingState = Ref<boolean>;
-export declare const RowsLoadingKey: InjectionKey<RowsLoadingState>;
-export type CurrentPageState = Ref<number>;
-export declare const CurrentPageKey: InjectionKey<CurrentPageState>;
-export type TotalPageState = Ref<number>;
-export declare const TotalPageKey: InjectionKey<TotalPageState>;
-export type ActiveChartFilterOptionState = Ref<string>;
-export declare const ActiveChartFilterOptionKey: InjectionKey<ActiveChartFilterOptionState>;
-export type RowGroupColumnsState = Ref<string[]>;
-export declare const RowGroupColumnsKey: InjectionKey<RowGroupColumnsState>;
-export type ChartTypesState = Ref<MenuOption[]>;
-export declare const ChartTypeKey: InjectionKey<ChartTypesState>;
-export type SortTypesState = Ref<MenuOption[]>;
-export declare const SortTypesKey: InjectionKey<SortTypesState>;
-export type ActiveChartState = Ref<MenuOption | undefined>;
-export declare const ActiveChartKey: InjectionKey<ActiveChartState>;
-export type ActiveSortState = Ref<MenuOption | undefined>;
-export declare const ActiveSortKey: InjectionKey<ActiveSortState>;
-export type ActiveSeriesKey = Ref<string | undefined>;
-export declare const ActiveSeriesKey: InjectionKey<ActiveSeriesKey>;
-export type AvailableSeriesKey = Ref<OptionWithFormatterAndDataType[]>;
-export declare const AvailableSeriesKey: InjectionKey<AvailableSeriesKey>;
-export type ActiveSecondarySeriesKey = Ref<string | undefined>;
-export declare const ActiveSecondarySeriesKey: InjectionKey<ActiveSecondarySeriesKey>;
-export type AvailableSecondarySeriesKey = Ref<OptionWithFormatterAndDataType[]>;
-export declare const AvailableSecondarySeriesKey: InjectionKey<AvailableSecondarySeriesKey>;

package/pv-components/dist/vue/visualizations/components/tables/themes.d.ts

@@ -1,3 +0,0 @@
-import { Theme } from 'ag-grid-community';
-export declare const PitViperAGGridBaseTheme: Theme;
-export declare const PitViperAGGridGroupedTheme: Theme;