@vuu-ui/vuu-filters 4.0.0-alpha.2 → 4.0.0-alpha.21

package/types/filter-pill/FilterPill.d.ts

@@ -13,4 +13,4 @@ export interface FilterPillProps extends SplitStateButtonProps, Pick<Partial<Edi
     onBeginEdit?: (filter: Filter) => void;
     onMenuAction?: MenuActionHandler;
 }
-export declare const FilterPill: ({ allowClose, allowDelete, allowEdit, allowRename, className: classNameProp, columnsByName, editable, editing, editLabelApiRef, filter, id: idProp, onBeginEdit, onExitEditMode, onMenuAction, ...htmlAttributes }: FilterPillProps) => import("react").JSX.Element;
+export declare const FilterPill: ({ allowClose, allowDelete, allowEdit, allowRename, className: classNameProp, columnsByName, editable, editing, editLabelApiRef, filter, id: idProp, onBeginEdit, onExitEditMode, onMenuAction, ...htmlAttributes }: FilterPillProps) => import("react/jsx-runtime").JSX.Element;

package/types/filter-pill/FilterPillNext.d.ts

@@ -12,4 +12,4 @@ export interface FilterPillNextProps extends FilterPillNextHookProps, Omit<HTMLA
     permissions?: FilterPermissions;
     showTooltip?: boolean;
 }
-export declare const FilterPillNext: ({ active, appearence, columns, className, defaultActive, filter, id, onClick, onMenuAction: onMenuActionProp, permissions, showTooltip, ...htmlAttributes }: FilterPillNextProps) => import("react").JSX.Element;
+export declare const FilterPillNext: ({ active, appearence, columns, className, defaultActive, filter, id, onClick, onMenuAction: onMenuActionProp, permissions, showTooltip, ...htmlAttributes }: FilterPillNextProps) => import("react/jsx-runtime").JSX.Element;

package/types/filter-pill-menu/FilterPillMenu.d.ts

@@ -14,4 +14,4 @@ export interface FilterPillMenuProps {
     onMenuAction: MenuActionHandler;
     onMenuClose?: () => void;
 }
-export declare const FilterPillMenu: ({ allowClose, allowDelete, allowEdit, allowRename, filter, location, onMenuAction, onMenuClose, }: FilterPillMenuProps) => import("react").JSX.Element;
+export declare const FilterPillMenu: ({ allowClose, allowDelete, allowEdit, allowRename, filter, location, onMenuAction, onMenuClose, }: FilterPillMenuProps) => import("react/jsx-runtime").JSX.Element;

package/types/filter-provider/FilterContext.d.ts

@@ -1,6 +1,13 @@
 import { FilterContainerFilter, FilterContainerFilterDescriptor, FilterContainerFilterDescriptorWithFilter } from "@vuu-ui/vuu-filter-types";
 import { FilterAction } from "../filter-pill/FilterMenu";
 import { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
+import type { DateTimePattern } from "@vuu-ui/vuu-utils";
+import type { VuuColumnDataType } from "@vuu-ui/vuu-protocol-types";
+/** The column attributes by which a ColumnFilter pattern is configured */
+export type ColumnFilterPatternColumn = {
+    name: string;
+    serverDataType?: VuuColumnDataType;
+};
 export declare const filterDescriptorHasFilter: (f: FilterContainerFilterDescriptor) => f is FilterContainerFilterDescriptorWithFilter;
 export type FilterContextFilterMenuActionHandler = <T extends FilterAction = FilterAction>(key: string, filterId: string, filterAction: T, 
 /**
@@ -8,6 +15,24 @@ export type FilterContextFilterMenuActionHandler = <T extends FilterAction = Fil
  */
 columns?: ColumnDescriptor[]) => void;
 export interface FilterContextProps {
+    /**
+     * Returns the column descriptor used by a ColumnFilter (within a
+     * FilterContainer) for the named column, if one is registered.
+     */
+    getColumnFilterColumn?: (key: string, columnName: string) => ColumnDescriptor | undefined;
+    /**
+     * The date/time pattern of the ColumnFilter for the column, as configured
+     * by FilterProvider columnFilterPatterns (by column name) or
+     * columnTypeFilterPatterns (by serverDataType). Available whether or not
+     * the ColumnFilter is mounted.
+     */
+    getColumnFilterPattern?: (column: ColumnFilterPatternColumn) => DateTimePattern | undefined;
+    /**
+     * Register the column descriptor used by a ColumnFilter, which may differ
+     * from the Table column descriptor, e.g. a different date/time pattern.
+     * Returns a function to unregister.
+     */
+    registerColumnFilterColumn?: (key: string, column: ColumnDescriptor) => () => void;
     deleteFilter: (key: string, filterId: string) => void;
     saveFilter: (key: string, name: string) => void;
     filterDescriptors: Map<string, FilterContainerFilterDescriptor[]>;
@@ -24,6 +49,15 @@ export declare const isNullFilter: (f?: FilterContainerFilterDescriptor) => bool
 export declare const NullFilterDescriptor: FilterContainerFilterDescriptor;
 export declare const EmptyFilterDescriptor: FilterContainerFilterDescriptor;
 export declare const FilterContext: import("react").Context<FilterContextProps>;
+/**
+ * Access the column descriptors registered by ColumnFilters
+ * (see FilterContainerColumnFilter).
+ */
+export declare function useColumnFilterRegistry(key?: string): {
+    getColumnFilterColumn: (columnName: string) => ColumnDescriptor | undefined;
+    getColumnFilterPattern: (column: ColumnFilterPatternColumn) => DateTimePattern | undefined;
+    registerColumnFilterColumn: (column: ColumnDescriptor) => (() => void) | undefined;
+};
 interface SavedFilterHookProps {
     availableColumns?: ColumnDescriptor[];
 }

package/types/filter-provider/FilterProvider.d.ts

@@ -1,10 +1,28 @@
 import { FilterContainerFilterDescriptor } from "@vuu-ui/vuu-filter-types";
 import { ReactNode } from "react";
+import { type DateTimePattern } from "@vuu-ui/vuu-utils";
+import type { VuuColumnDataType } from "@vuu-ui/vuu-protocol-types";
 export type SavedFilterRecord = Record<string, FilterContainerFilterDescriptor[]>;
 export interface FilterProviderProps {
     children: ReactNode;
+    /**
+     * Date/time patterns, keyed by column name, of the ColumnFilters
+     * (FilterContainerColumnFilter) within this provider. A ColumnFilter
+     * without a pattern prop uses the pattern configured here. As these are
+     * available whether or not a ColumnFilter is mounted, the filter context
+     * menu can match a temporal cell value at the precision of the ColumnFilter,
+     * even where ColumnFilters are created on demand.
+     */
+    columnFilterPatterns?: Record<string, DateTimePattern>;
+    /**
+     * Date/time patterns, keyed by serverDataType, of the ColumnFilters within
+     * this provider, e.g. { epochtimestampnano: { time: "hh:mm:ss.ms" } }.
+     * Applies to columns with no entry in columnFilterPatterns. The column must
+     * have a serverDataType (a Table column has one, from the table schema).
+     */
+    columnTypeFilterPatterns?: Partial<Record<VuuColumnDataType, DateTimePattern>>;
     onFiltersSaved?: (savedFilters: SavedFilterRecord) => void;
     savedFilters?: SavedFilterRecord;
     filterNameMaxLength?: number;
 }
-export declare const FilterProvider: ({ children, onFiltersSaved, savedFilters: savedFiltersProp, filterNameMaxLength, }: FilterProviderProps) => import("react").JSX.Element;
+export declare const FilterProvider: ({ children, columnFilterPatterns, columnTypeFilterPatterns, onFiltersSaved, savedFilters: savedFiltersProp, filterNameMaxLength, }: FilterProviderProps) => import("react/jsx-runtime").JSX.Element;

package/types/filter-toggle-button/FilterToggleButton.d.ts

@@ -6,4 +6,4 @@ export interface FilterToggleButtonProps {
     filterProviderKey?: string;
     onToggle: () => void;
 }
-export declare const FilterToggleButton: ({ columns, filterProviderKey, onToggle, }: FilterToggleButtonProps) => import("react").JSX.Element;
+export declare const FilterToggleButton: ({ columns, filterProviderKey, onToggle, }: FilterToggleButtonProps) => import("react/jsx-runtime").JSX.Element;

package/types/index.d.ts

@@ -4,15 +4,15 @@ export * from "./filter-clause";
 export { ExtendedSingleValueFilterClause } from "./filter-container/ExtendedSingleValueFilterClause";
 export { FilterContainer, FilterContainerColumnFilter, type FilterContainerColumnFilterProps, type FilterContainerProps, } from "./filter-container/FilterContainer";
 export type { FilterAppliedHandler } from "./filter-container/useFilterContainer";
-export { useFilterContextMenu } from "./filter-context-menu/useFilterContextMenu";
+export { type FilterContextMenuHookProps, useFilterContextMenu, } from "./filter-context-menu/useFilterContextMenu";
 export { FilterDisplay } from "./filter-display/FilterDisplay";
 export * from "./filter-editor";
 export { FilterPanel } from "./filter-panel/FilterPanel";
 export * from "./filter-pill";
 export { type FilterPermissions } from "./filter-pill/FilterMenu";
 export { FilterPillNext, type FilterPillNextProps, } from "./filter-pill/FilterPillNext";
-export { NULL_FILTER, useSavedFilters } from "./filter-provider/FilterContext";
-export { FilterProvider } from "./filter-provider/FilterProvider";
+export { NULL_FILTER, type ColumnFilterPatternColumn, useColumnFilterRegistry, useSavedFilters, } from "./filter-provider/FilterContext";
+export { FilterProvider, type FilterProviderProps, } from "./filter-provider/FilterProvider";
 export * from "./filter-utils";
 export * from "./FilterModel";
 export * from "./inline-filter";
@@ -21,4 +21,4 @@ export { FilterNamePrompt as SaveFilterConfirmPrompt, type FilterNamePromptProps
 export { SavedFilterPanel, type SavedFilterPanelProps, } from "./saved-filters/SavedFilterPanel";
 export type { FilterClickHandler } from "./saved-filters/useSavedFilterPanel";
 export { TabbedFilterContainer, type TabbedFilterContainerProps, } from "./tabbed-filter-container/TabbedFilterContainer";
-export { ToggleFilter, type ToggleFilterProps, } from "./toggle-filter/ToggleFilter";
+export { ToggleFilter, type ToggleFilterProps, type ToggleFilterValue, } from "./toggle-filter/ToggleFilter";

package/types/inline-filter/InlineFilter.d.ts

@@ -9,4 +9,4 @@ export interface InlineFilterProps extends Partial<BaseRowProps>, Omit<HTMLAttri
     onFilterCleared?: () => void;
     table: TableSchemaTable;
 }
-export declare const InlineFilter: ({ ariaRole, onFilterApplied, onFilterCleared, table, ...htmlAttributes }: InlineFilterProps) => import("react").JSX.Element;
+export declare const InlineFilter: ({ ariaRole, onFilterApplied, onFilterCleared, table, ...htmlAttributes }: InlineFilterProps) => import("react/jsx-runtime").JSX.Element;

package/types/quick-filters/QuickFilters.d.ts

@@ -14,4 +14,4 @@ export interface QuickFilterProps extends HTMLAttributes<HTMLDivElement>, Pick<F
      */
     showFind?: boolean | string[];
 }
-export declare const QuickFilters: ({ allowAddColumn, allowFind, availableColumns, onApplyFilter, onClearFilter, onChangeQuickFilterColumns, quickFilterColumns, vuuTable, }: QuickFilterProps) => import("react").JSX.Element;
+export declare const QuickFilters: ({ allowAddColumn, allowFind, availableColumns, onApplyFilter, onClearFilter, onChangeQuickFilterColumns, quickFilterColumns, vuuTable, }: QuickFilterProps) => import("react/jsx-runtime").JSX.Element;

package/types/saved-filters/DeleteFilterPrompt.d.ts

@@ -6,4 +6,4 @@ export interface DeleteFilterPromptProps extends Pick<PromptProps, "onConfirm" |
     columns?: ColumnDescriptor[];
     filterDescriptor: FilterContainerFilterDescriptor;
 }
-export declare const DeleteFilterPrompt: ({ children, className, columns, filterDescriptor, onClose, onConfirm, open, ...htmlAttributes }: DeleteFilterPromptProps) => import("react").JSX.Element;
+export declare const DeleteFilterPrompt: ({ children, className, columns, filterDescriptor, onClose, onConfirm, open, ...htmlAttributes }: DeleteFilterPromptProps) => import("react/jsx-runtime").JSX.Element;

package/types/saved-filters/FilterNamePrompt.d.ts

@@ -3,4 +3,4 @@ import { HTMLAttributes } from "react";
 import { FilterNamePromptHookProps } from "./useFilterNamePrompt";
 export interface FilterNamePromptProps extends FilterNamePromptHookProps, Pick<PromptProps, "onClose" | "open" | "title">, Omit<HTMLAttributes<HTMLDivElement>, "title"> {
 }
-export declare const FilterNamePrompt: ({ className, filterName, onClose, onConfirm: onConfirmProp, open, title, filterNameMaxLength, ...htmlAttributes }: FilterNamePromptProps) => import("react").JSX.Element;
+export declare const FilterNamePrompt: ({ className, filterName, onClose, onConfirm: onConfirmProp, open, title, filterNameMaxLength, ...htmlAttributes }: FilterNamePromptProps) => import("react/jsx-runtime").JSX.Element;

package/types/saved-filters/SavedFilterPanel.d.ts

@@ -11,4 +11,4 @@ export interface SavedFilterPanelProps extends HTMLAttributes<HTMLDivElement>, P
     availableColumns?: ColumnDescriptor[];
     filterPillPermissions?: FilterPermissions;
 }
-export declare const SavedFilterPanel: ({ availableColumns, className, filterPillPermissions, filterProviderKey, ...htmlAttributes }: SavedFilterPanelProps) => import("react").JSX.Element;
+export declare const SavedFilterPanel: ({ availableColumns, className, filterPillPermissions, filterProviderKey, ...htmlAttributes }: SavedFilterPanelProps) => import("react/jsx-runtime").JSX.Element;

package/types/tabbed-filter-container/TabbedFilterContainer.d.ts

@@ -7,4 +7,4 @@ export interface TabbedFilterContainerProps extends HTMLAttributes<HTMLDivElemen
     filterTabLabel?: string;
     savedFilterLabel?: string;
 }
-export declare const TabbedFilterContainer: ({ SavedFilterPanelProps, children, className, filter, filterProviderKey, filterTabLabel, onFilterApplied, onFilterCleared, savedFilterLabel, ...htmlAttributes }: TabbedFilterContainerProps) => import("react").JSX.Element;
+export declare const TabbedFilterContainer: ({ SavedFilterPanelProps, children, className, filter, filterProviderKey, filterTabLabel, onFilterApplied, onFilterCleared, savedFilterLabel, ...htmlAttributes }: TabbedFilterContainerProps) => import("react/jsx-runtime").JSX.Element;

package/types/toggle-filter/ToggleFilter.d.ts

@@ -1,6 +1,8 @@
 import { ToggleButtonGroupProps } from "@salt-ds/core";
 import { CommitHandler } from "@vuu-ui/vuu-utils";
 import { type ToggleFilterHookProps } from "./useToggleFilter";
+export type ToggleFilterValue = string | number | boolean;
+type Value = ToggleButtonGroupProps["value"];
 /**
  * ToggleFilter is designed to work with a FilterProvider and
  * DataSourceProvider. With a DataSourceProvider, values will
@@ -11,7 +13,20 @@ import { type ToggleFilterHookProps } from "./useToggleFilter";
  * With neither of these Providers available, the ToggleFilter is
  * behaving like a regular ToggleButtonGroup.
  */
-export interface ToggleFilterProps extends ToggleButtonGroupProps, ToggleFilterHookProps {
+export interface ToggleFilterProps extends Omit<ToggleButtonGroupProps, "defaultValue" | "value">, Omit<ToggleFilterHookProps, "values"> {
+    defaultValue?: ToggleFilterValue | Value;
+    /**
+     * Optional labels for the toggle buttons. If provided, must contain
+     * the same number of items as values. Defaults to values.
+     */
+    labels?: string[];
     onCommit: CommitHandler<HTMLElement>;
+    value?: ToggleFilterValue | Value;
+    /**
+     * Values for the toggle buttons. Boolean values are converted to
+     * strings internally, the original value is passed to onCommit.
+     */
+    values: ToggleFilterValue[];
 }
 export declare const ToggleFilter: import("react").ForwardRefExoticComponent<ToggleFilterProps & import("react").RefAttributes<HTMLDivElement>>;
+export {};

package/types/toggle-filter/useToggleFilter.d.ts

@@ -8,4 +8,22 @@ export interface ToggleFilterHookProps {
     table?: TableSchemaTable;
     values: string[];
 }
-export declare const useToggleFilter: ({ column, table, values, }: ToggleFilterHookProps) => string | undefined;
+export interface ToggleFilterHookResult {
+    /**
+     * If only one of the toggle values has matching data, that value.
+     */
+    onlyAvailableValue?: string;
+    /**
+     * Toggle values for which there is no matching data.
+     */
+    unavailableValues: string[];
+}
+/**
+ * Determines which toggle values have matching data, using typeahead
+ * against the DataSource. Typeahead respects the filter applied to the
+ * DataSource, so while a filter on this column is in effect, results
+ * would only reflect the filtered value. In that case no check is made
+ * and the result of the last check (if any) is retained. If there has
+ * been no check, all values are assumed to possibly have data.
+ */
+export declare const useToggleFilter: ({ column, table, values, }: ToggleFilterHookProps) => ToggleFilterHookResult;