@turquoisehealth/pit-viper 2.186.1 → 2.186.2-dev.0

package/pv-components/dist/vue/visualizations/components/charts/PvDataTableWithChart/PvDataTableWithChart.vue.d.ts

@@ -1,4 +1,4 @@
-import { ColumnMovedEvent, ColumnResizedEvent, ColumnRowGroupChangedEvent, FilterChangedEvent } from 'ag-grid-enterprise';
+import { AdvancedFilterModel, ColumnMovedEvent, ColumnResizedEvent, ColumnRowGroupChangedEvent, FilterChangedEvent, FilterModel } from 'ag-grid-enterprise';
 import { FirstDataRenderedEvent, GridReadyEvent, RefreshServerSideParams, SortChangedEvent } from 'ag-grid-community';
 import { ChartStateChangedEvent, FocusUpdateEvent, FilterValueResponseOption } from '../../tables/PvDataTable/types';
 import { PvDataTableWithChartProps } from './types';
@@ -27,9 +27,13 @@ declare const _default: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>
         getCsvData: () => Promise<string | null> | undefined;
         refreshData: (params?: RefreshServerSideParams | null) => Promise<void> | undefined;
         getFilterValueSelectedMetadataMap: () => Record<string, ( FilterValueResponseOption | null)[]> | undefined;
+        getPvFilterModel: () => FilterModel | AdvancedFilterModel | null | undefined;
+        setPvFilterModel: (model: FilterModel | AdvancedFilterModel | null) => boolean | undefined;
     }>): void;
     attrs: any;
-    slots: {};
+    slots: {
+        'top-slot'?(_: {}): any;
+    };
     emit: {
         (e: "chart-state-changed", event: ChartStateChangedEvent): void;
         (e: "column-moved", event: ColumnMovedEvent<T>): void;

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

@@ -3,6 +3,7 @@ import { ColDefDataType } from './table-components/formatting';
 import { Component, ComputedRef, CSSProperties, Ref } from 'vue';
 import { AdvancedFilterModel, CellSelectionOptions, FilterModel, GetContextMenuItemsParams, GridState, IServerSideGetRowsParams, ProcessCellForExportParams, ProcessDataFromClipboardParams, RowSelectionOptions, Theme, ValueFormatterFunc } from 'ag-grid-enterprise';
 import { PvDataTableTheme } from '../themes';
+import { PvDataTableFilterStore } from './useFilterStore';
 import { ColDef, GridApi, IsGroupOpenByDefaultParams, IsServerSideGroupOpenByDefaultParams, RefreshServerSideParams } from 'ag-grid-community';
 import { QueryBuilderSuggestionMenuOption } from '../../base/PvQueryBuilderInput/useQueryBuilder';
 import { MenuOption, PvMultiSelectButtonSlotProps } from '../../base';
@@ -252,6 +253,10 @@ export interface PvDataTableProps<T> {
      * Array of JSON data objects to be displayed in the table. Only used for client-side row model.
      */
     rowData?: T[];
+    /**
+     * External filter store used to share filter/search state and controls with custom components.
+     */
+    filterStore?: PvDataTableFilterStore;
     /**
      * Handler to fetch server-side data. Only used for server-side row model.
      */
@@ -545,13 +550,15 @@ export interface PvDataTablePublicInterface {
     availableAggFuncColumns: ComputedRef<ColDef[]>;
     rowGroupColumnFields: Ref<string[]>;
     /**
-     * Gets the current Advanced Filter model. Returns null if no filter is applied.
-     * Only available when `enableAdvancedFilter` is true.
+     * Gets the current filter model. Returns an AdvancedFilterModel when `enableAdvancedFilter` is true,
+     * a regular FilterModel when `enableAdvancedFilter` is false, and null when no filter is applied.
      */
     getPvFilterModel: () => FilterModel | AdvancedFilterModel | null;
     /**
-     * Sets the Advanced Filter model. Pass null to clear the filter.
-     * Only available when `enableAdvancedFilter` is true.
+     * Applies a filter model to the table. Regular FilterModels are converted to AdvancedFilterModels when
+     * `enableAdvancedFilter` is true. Returns false when the model could not be applied, such as before the
+     * grid API is ready or when an AdvancedFilterModel is passed while advanced filtering is disabled.
+     * Pass null to clear the filter.
      */
-    setPvFilterModel: (model: FilterModel | AdvancedFilterModel | null) => void;
+    setPvFilterModel: (model: FilterModel | AdvancedFilterModel | null) => boolean;
 }

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

@@ -1,14 +1,22 @@
 import { AdvancedFilterModel, FilterModel } from 'ag-grid-enterprise';
-import { Ref, ComputedRef } from 'vue';
-import { ColDef, GridApi } from 'ag-grid-community';
+import { ColDef, GridApi, RefreshServerSideParams } from 'ag-grid-community';
+import { Ref, ShallowRef, ComputedRef } from 'vue';
 import { FilterValueMatchResult, FilterValueResponseOption, FilterValuesResponse, FilterValuesSetHandlerParams, TableSearchHandlerParams } from './types';
 import { QueryTerm } from '../../base/PvQueryBuilderInput/useQueryBuilder';
 /**
  * Type guard to check if a filter model is a regular FilterModel (not AdvancedFilterModel)
  */
 export declare const isRegularFilterModel: (model: FilterModel | AdvancedFilterModel | null) => model is FilterModel;
+export type PvDataTableFilterModel = FilterModel | AdvancedFilterModel | null;
+export interface PvDataTableFilterController {
+    getFilterModel: () => PvDataTableFilterModel;
+    refreshData: (params?: RefreshServerSideParams | null) => Promise<void> | void;
+    setFilterModel: (model: PvDataTableFilterModel) => boolean | void;
+    setTableSearchFilterModel: (model: PvDataTableFilterModel) => boolean | void;
+}
 export declare const createFilterStore: () => {
-    filterModel: Ref<FilterModel | AdvancedFilterModel | null, FilterModel | AdvancedFilterModel | null>;
+    filterController: ShallowRef<PvDataTableFilterController | null, PvDataTableFilterController | null>;
+    filterModel: Ref<PvDataTableFilterModel, PvDataTableFilterModel>;
     filterLastUpdatedMap: Ref<Record<string, number>, Record<string, number>>;
     filterLastFetchTimeMap: Ref<Record<string, number>, Record<string, number>>;
     filterModelCleared: Ref<number, number>;
@@ -28,10 +36,10 @@ export declare const createFilterStore: () => {
     getFilterSelectedValues: (colField: string) => (string | null)[];
     getSearchMatchDataFromFilterContext: (colDef: ColDef, option: FilterValueResponseOption | null | undefined) => FilterValueMatchResult;
     isServerSideFilter: ComputedRef<boolean>;
-    stagedFilterModel: Ref<FilterModel | AdvancedFilterModel | null, FilterModel | AdvancedFilterModel | null>;
+    stagedFilterModel: Ref<PvDataTableFilterModel, PvDataTableFilterModel>;
     setFilterSelectedValues: (colField: string, selectedValues: (string | null)[]) => (string | null)[];
     setFilterValueSearchText: (colField: string, searchText: string | null) => void;
-    tableSearchFilterModel: Ref<FilterModel | AdvancedFilterModel | null, FilterModel | AdvancedFilterModel | null>;
+    tableSearchFilterModel: Ref<PvDataTableFilterModel, PvDataTableFilterModel>;
     tableSearchFilterModelEmpty: ComputedRef<boolean>;
     tableSearchHandler: Ref<((params: TableSearchHandlerParams<unknown>) => Promise<(QueryTerm | null)[]>) | undefined, ((params: TableSearchHandlerParams<unknown>) => Promise<(QueryTerm | null)[]>) | undefined>;
     filterValuesMap: Ref<Record<string, (string | null)[]>, Record<string, (string | null)[]>>;
@@ -51,12 +59,131 @@ export declare const createFilterStore: () => {
     clearStagedSelectedValues: () => void;
     getStagedSelectedValues: (colField: string) => (string | null)[];
     setStagedSelectedValues: (colField: string, selectedValues: (string | null)[]) => void;
+    registerFilterController: (controller: PvDataTableFilterController) => void;
+    unregisterFilterController: (controller?: PvDataTableFilterController) => void;
+    getFilterModel: () => PvDataTableFilterModel;
+    applyFilterModel: (model: PvDataTableFilterModel) => void;
+    applyTableSearchFilterModel: (model: PvDataTableFilterModel) => void;
+    refreshData: (params?: RefreshServerSideParams | null) => void | Promise<void> | undefined;
     filterValueSearchTextMap: Ref<Record<string, string | null>, Record<string, string | null>>;
     filterValuesHasMoreMap: Ref<Record<string, boolean | undefined>, Record<string, boolean | undefined>>;
     filterValuesTotalCountMap: Ref<Record<string, number | undefined>, Record<string, number | undefined>>;
 };
+export type PvDataTableFilterStore = ReturnType<typeof createFilterStore>;
+export declare const createPvDataTableFilterStore: () => {
+    filterController: ShallowRef<PvDataTableFilterController | null, PvDataTableFilterController | null>;
+    filterModel: Ref<PvDataTableFilterModel, PvDataTableFilterModel>;
+    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<FilterValuesResponse | (FilterValueResponseOption | null)[]>) | undefined, ((params: FilterValuesSetHandlerParams<unknown>) => Promise<FilterValuesResponse | (FilterValueResponseOption | null)[]>) | undefined>;
+    fetchFilterValues: (colDef: ColDef, options?: {
+        api?: GridApi;
+        filterModel?: FilterModel | AdvancedFilterModel;
+        offset?: number;
+        parentId?: string;
+        useStaged?: boolean;
+    }) => Promise<(string | null)[]>;
+    filterValueContext: (colField: string, value: string | null) => FilterValueResponseOption | null | undefined;
+    filterModelEmpty: ComputedRef<boolean>;
+    getFilterSelectedValues: (colField: string) => (string | null)[];
+    getSearchMatchDataFromFilterContext: (colDef: ColDef, option: FilterValueResponseOption | null | undefined) => FilterValueMatchResult;
+    isServerSideFilter: ComputedRef<boolean>;
+    stagedFilterModel: Ref<PvDataTableFilterModel, PvDataTableFilterModel>;
+    setFilterSelectedValues: (colField: string, selectedValues: (string | null)[]) => (string | null)[];
+    setFilterValueSearchText: (colField: string, searchText: string | null) => void;
+    tableSearchFilterModel: Ref<PvDataTableFilterModel, PvDataTableFilterModel>;
+    tableSearchFilterModelEmpty: ComputedRef<boolean>;
+    tableSearchHandler: Ref<((params: TableSearchHandlerParams<unknown>) => Promise<(QueryTerm | null)[]>) | undefined, ((params: TableSearchHandlerParams<unknown>) => Promise<(QueryTerm | null)[]>) | undefined>;
+    filterValuesMap: Ref<Record<string, (string | null)[]>, Record<string, (string | null)[]>>;
+    getFilterValues: (colField: string) => (string | null)[];
+    setFilterValues: (colField: string, values: (string | null)[]) => void;
+    filterStaleMap: Ref<Record<string, boolean>, Record<string, boolean>>;
+    refreshFiltersInBackground: Ref<boolean, boolean>;
+    stageFilterChangesUntilDropdownCloses: Ref<boolean, boolean>;
+    markOtherFieldsStale: (changedFields: Set<string>) => void;
+    aggregateFieldMap: Ref<Record<string, string[]>, Record<string, string[]>>;
+    registerAggregateField: (parent: string, children: string[]) => void;
+    registeredFilterFields: Ref<Set<string>, Set<string>>;
+    registerFilterField: (field: string) => void;
+    unregisterFilterField: (field: string) => void;
+    stagedSelectedValuesMap: Ref<Record<string, (string | null)[]>, Record<string, (string | null)[]>>;
+    initStagedSelectedValues: () => void;
+    clearStagedSelectedValues: () => void;
+    getStagedSelectedValues: (colField: string) => (string | null)[];
+    setStagedSelectedValues: (colField: string, selectedValues: (string | null)[]) => void;
+    registerFilterController: (controller: PvDataTableFilterController) => void;
+    unregisterFilterController: (controller?: PvDataTableFilterController) => void;
+    getFilterModel: () => PvDataTableFilterModel;
+    applyFilterModel: (model: PvDataTableFilterModel) => void;
+    applyTableSearchFilterModel: (model: PvDataTableFilterModel) => void;
+    refreshData: (params?: RefreshServerSideParams | null) => void | Promise<void> | undefined;
+    filterValueSearchTextMap: Ref<Record<string, string | null>, Record<string, string | null>>;
+    filterValuesHasMoreMap: Ref<Record<string, boolean | undefined>, Record<string, boolean | undefined>>;
+    filterValuesTotalCountMap: Ref<Record<string, number | undefined>, Record<string, number | undefined>>;
+};
+export declare const providePvDataTableFilterStore: (filterStore: PvDataTableFilterStore) => void;
 export declare const useFilterStore: () => {
-    filterModel: Ref<FilterModel | AdvancedFilterModel | null, FilterModel | AdvancedFilterModel | null>;
+    filterController: ShallowRef<PvDataTableFilterController | null, PvDataTableFilterController | null>;
+    filterModel: Ref<PvDataTableFilterModel, PvDataTableFilterModel>;
+    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<FilterValuesResponse | (FilterValueResponseOption | null)[]>) | undefined, ((params: FilterValuesSetHandlerParams<unknown>) => Promise<FilterValuesResponse | (FilterValueResponseOption | null)[]>) | undefined>;
+    fetchFilterValues: (colDef: ColDef, options?: {
+        api?: GridApi;
+        filterModel?: FilterModel | AdvancedFilterModel;
+        offset?: number;
+        parentId?: string;
+        useStaged?: boolean;
+    }) => Promise<(string | null)[]>;
+    filterValueContext: (colField: string, value: string | null) => FilterValueResponseOption | null | undefined;
+    filterModelEmpty: ComputedRef<boolean>;
+    getFilterSelectedValues: (colField: string) => (string | null)[];
+    getSearchMatchDataFromFilterContext: (colDef: ColDef, option: FilterValueResponseOption | null | undefined) => FilterValueMatchResult;
+    isServerSideFilter: ComputedRef<boolean>;
+    stagedFilterModel: Ref<PvDataTableFilterModel, PvDataTableFilterModel>;
+    setFilterSelectedValues: (colField: string, selectedValues: (string | null)[]) => (string | null)[];
+    setFilterValueSearchText: (colField: string, searchText: string | null) => void;
+    tableSearchFilterModel: Ref<PvDataTableFilterModel, PvDataTableFilterModel>;
+    tableSearchFilterModelEmpty: ComputedRef<boolean>;
+    tableSearchHandler: Ref<((params: TableSearchHandlerParams<unknown>) => Promise<(QueryTerm | null)[]>) | undefined, ((params: TableSearchHandlerParams<unknown>) => Promise<(QueryTerm | null)[]>) | undefined>;
+    filterValuesMap: Ref<Record<string, (string | null)[]>, Record<string, (string | null)[]>>;
+    getFilterValues: (colField: string) => (string | null)[];
+    setFilterValues: (colField: string, values: (string | null)[]) => void;
+    filterStaleMap: Ref<Record<string, boolean>, Record<string, boolean>>;
+    refreshFiltersInBackground: Ref<boolean, boolean>;
+    stageFilterChangesUntilDropdownCloses: Ref<boolean, boolean>;
+    markOtherFieldsStale: (changedFields: Set<string>) => void;
+    aggregateFieldMap: Ref<Record<string, string[]>, Record<string, string[]>>;
+    registerAggregateField: (parent: string, children: string[]) => void;
+    registeredFilterFields: Ref<Set<string>, Set<string>>;
+    registerFilterField: (field: string) => void;
+    unregisterFilterField: (field: string) => void;
+    stagedSelectedValuesMap: Ref<Record<string, (string | null)[]>, Record<string, (string | null)[]>>;
+    initStagedSelectedValues: () => void;
+    clearStagedSelectedValues: () => void;
+    getStagedSelectedValues: (colField: string) => (string | null)[];
+    setStagedSelectedValues: (colField: string, selectedValues: (string | null)[]) => void;
+    registerFilterController: (controller: PvDataTableFilterController) => void;
+    unregisterFilterController: (controller?: PvDataTableFilterController) => void;
+    getFilterModel: () => PvDataTableFilterModel;
+    applyFilterModel: (model: PvDataTableFilterModel) => void;
+    applyTableSearchFilterModel: (model: PvDataTableFilterModel) => void;
+    refreshData: (params?: RefreshServerSideParams | null) => void | Promise<void> | undefined;
+    filterValueSearchTextMap: Ref<Record<string, string | null>, Record<string, string | null>>;
+    filterValuesHasMoreMap: Ref<Record<string, boolean | undefined>, Record<string, boolean | undefined>>;
+    filterValuesTotalCountMap: Ref<Record<string, number | undefined>, Record<string, number | undefined>>;
+};
+export declare const usePvDataTableFilterStore: () => {
+    filterController: ShallowRef<PvDataTableFilterController | null, PvDataTableFilterController | null>;
+    filterModel: Ref<PvDataTableFilterModel, PvDataTableFilterModel>;
     filterLastUpdatedMap: Ref<Record<string, number>, Record<string, number>>;
     filterLastFetchTimeMap: Ref<Record<string, number>, Record<string, number>>;
     filterModelCleared: Ref<number, number>;
@@ -76,10 +203,10 @@ export declare const useFilterStore: () => {
     getFilterSelectedValues: (colField: string) => (string | null)[];
     getSearchMatchDataFromFilterContext: (colDef: ColDef, option: FilterValueResponseOption | null | undefined) => FilterValueMatchResult;
     isServerSideFilter: ComputedRef<boolean>;
-    stagedFilterModel: Ref<FilterModel | AdvancedFilterModel | null, FilterModel | AdvancedFilterModel | null>;
+    stagedFilterModel: Ref<PvDataTableFilterModel, PvDataTableFilterModel>;
     setFilterSelectedValues: (colField: string, selectedValues: (string | null)[]) => (string | null)[];
     setFilterValueSearchText: (colField: string, searchText: string | null) => void;
-    tableSearchFilterModel: Ref<FilterModel | AdvancedFilterModel | null, FilterModel | AdvancedFilterModel | null>;
+    tableSearchFilterModel: Ref<PvDataTableFilterModel, PvDataTableFilterModel>;
     tableSearchFilterModelEmpty: ComputedRef<boolean>;
     tableSearchHandler: Ref<((params: TableSearchHandlerParams<unknown>) => Promise<(QueryTerm | null)[]>) | undefined, ((params: TableSearchHandlerParams<unknown>) => Promise<(QueryTerm | null)[]>) | undefined>;
     filterValuesMap: Ref<Record<string, (string | null)[]>, Record<string, (string | null)[]>>;
@@ -99,6 +226,12 @@ export declare const useFilterStore: () => {
     clearStagedSelectedValues: () => void;
     getStagedSelectedValues: (colField: string) => (string | null)[];
     setStagedSelectedValues: (colField: string, selectedValues: (string | null)[]) => void;
+    registerFilterController: (controller: PvDataTableFilterController) => void;
+    unregisterFilterController: (controller?: PvDataTableFilterController) => void;
+    getFilterModel: () => PvDataTableFilterModel;
+    applyFilterModel: (model: PvDataTableFilterModel) => void;
+    applyTableSearchFilterModel: (model: PvDataTableFilterModel) => void;
+    refreshData: (params?: RefreshServerSideParams | null) => void | Promise<void> | undefined;
     filterValueSearchTextMap: Ref<Record<string, string | null>, Record<string, string | null>>;
     filterValuesHasMoreMap: Ref<Record<string, boolean | undefined>, Record<string, boolean | undefined>>;
     filterValuesTotalCountMap: Ref<Record<string, number | undefined>, Record<string, number | undefined>>;

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

@@ -1,10 +1,10 @@
 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 { PvDataTableFilterStore } from './PvDataTable/useFilterStore';
 import { OptionWithFormatterAndDataType, CrosslineOverlayGroup } from '../charts/PvDataTableWithChart/types';
 import { createFocusStore } from './PvDataTable/useFocus';
-export declare const FilterStoreKey: InjectionKey<ReturnType<typeof createFilterStore>>;
+export declare const FilterStoreKey: InjectionKey<PvDataTableFilterStore>;
 export declare const FocusStoreKey: InjectionKey<ReturnType<typeof createFocusStore>>;
 export type SortState = Ref<SortModelItem[]>;
 export declare const SortStateKey: InjectionKey<SortState>;

package/pv-components/dist/vue/visualizations/components/visualizations/index.d.ts

@@ -2,6 +2,8 @@ export { default as PvChart } from '../charts/PvChart/PvChart.vue';
 export { default as PvDataTableWithChart } from '../charts/PvDataTableWithChart/PvDataTableWithChart.vue';
 export { default as PvMapChart } from '../charts/PvMapChart/PvMapChart.vue';
 export { default as PvDataTable } from '../tables/PvDataTable/PvDataTable.vue';
+export { createPvDataTableFilterStore, providePvDataTableFilterStore, usePvDataTableFilterStore, } from '../tables/PvDataTable/useFilterStore';
+export type { PvDataTableFilterController, PvDataTableFilterModel, PvDataTableFilterStore, } from '../tables/PvDataTable/useFilterStore';
 export type { FocusUpdateEvent, FilterValueResponseOption, FilterRendererProps } from '../tables/PvDataTable/types';
 export type { CrosslineOverlayGroup, VerticalLineOverlay } from '../charts/PvDataTableWithChart/types';
 export { constructAdvancedFilterCondition, convertFilterModelToAdvanced, filterModelContainsColId, mergeFilterModels, getSelectedValuesFromFilterModel, filterModelsEqual, mergeAdvancedFilterCondition, removeColumnFromAdvancedFilter, getSelectedValuesFromAdvancedFilterModel, isAdvancedFilterModel, isFilterModelEmpty, getSelectedValues, getSelectedValuesFromFilterModelByColId, updateSetFilter, updateMultiOrSetFilter, removeColumnFilter, excludeValueFromSetFilter, } from '../tables/PvDataTable/filters/filterHelpers';