@vuu-ui/vuu-filters 0.8.27-debug → 0.8.28-debug

package/types/filter-editor/useFilterEditor.d.ts

@@ -0,0 +1,31 @@
+import type { MenuActionHandler, MenuBuilder } from "@vuu-ui/vuu-data-types";
+import type { ColumnDescriptorsByName } from "@vuu-ui/vuu-filter-types";
+import { KeyboardEventHandler } from "react";
+import { FilterEditorProps } from "./FilterEditor";
+import { FilterModel } from "../FilterModel";
+import { FilterClauseCancelHandler } from "../filter-clause";
+import { FilterClauseCombinatorChangeHandler } from "./FilterClauseCombinator";
+export interface FilterEditorHookProps extends Pick<FilterEditorProps, "columnDescriptors" | "filter" | "onCancel" | "onSave"> {
+    label?: string;
+}
+export declare const useFilterEditor: ({ columnDescriptors, filter, onCancel, onSave, }: FilterEditorHookProps) => {
+    columnsByName: ColumnDescriptorsByName;
+    filterModel: FilterModel;
+    isValid: boolean;
+    onCancelFilterClause: FilterClauseCancelHandler;
+    onCancelFilterEdit: () => void;
+    onChangeFilterCombinator: FilterClauseCombinatorChangeHandler;
+    onKeyDownCombinator: KeyboardEventHandler<HTMLElement>;
+    saveButtonProps: {
+        PopupMenuProps: {
+            icon: string;
+            menuBuilder: MenuBuilder<string, unknown>;
+            menuActionHandler: MenuActionHandler;
+            menuLocation: string;
+        };
+        onClick: () => boolean | undefined;
+        onKeyDown: KeyboardEventHandler<Element>;
+    };
+    saveButtonRef: import("react").RefObject<HTMLDivElement>;
+    setContainer: (instance: HTMLDivElement | null) => void;
+};

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

@@ -1,15 +1,18 @@
+/// <reference types="react" />
 import { MenuActionHandler } from "@vuu-ui/vuu-data-types";
 import { ColumnDescriptorsByName, Filter } from "@vuu-ui/vuu-filter-types";
-import { EditableLabelProps } from "@vuu-ui/vuu-ui-controls";
-import { HTMLAttributes } from "react";
+import { EditableLabelProps, SplitStateButtonProps } from "@vuu-ui/vuu-ui-controls";
 import "./FilterPill.css";
-export interface FilterPillProps extends Pick<Partial<EditableLabelProps>, "onExitEditMode">, HTMLAttributes<HTMLDivElement> {
+export interface FilterPillProps extends SplitStateButtonProps, Pick<Partial<EditableLabelProps>, "editing" | "editLabelApiRef" | "onExitEditMode"> {
+    allowClose?: boolean;
+    allowDelete?: boolean;
+    allowEdit?: boolean;
+    allowRename?: boolean;
     columnsByName?: ColumnDescriptorsByName;
     editable?: boolean;
     filter: Filter;
     index?: number;
     onBeginEdit?: (filter: Filter) => void;
     onMenuAction?: MenuActionHandler;
-    showMenu?: boolean;
 }
-export declare const FilterPill: ({ className: classNameProp, columnsByName, editable, filter, id: idProp, onBeginEdit, onExitEditMode, onMenuAction, showMenu, ...htmlAttributes }: FilterPillProps) => JSX.Element;
+export declare const FilterPill: ({ allowClose, allowDelete, allowEdit, allowRename, className: classNameProp, columnsByName, editable, editing, editLabelApiRef, filter, id: idProp, onBeginEdit, onExitEditMode, onMenuAction, ...htmlAttributes }: FilterPillProps) => JSX.Element;

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

@@ -0,0 +1,12 @@
+import { ContextMenuItemDescriptor } from "@vuu-ui/vuu-data-types";
+export type MenuOptions = {
+    [key: string]: unknown;
+};
+export interface FilterPillMenuOptions {
+    tabIndex: number;
+}
+export declare const isFilterPillMenuOptions: (options: unknown) => options is FilterPillMenuOptions;
+export declare const closeCommand: (options?: MenuOptions) => ContextMenuItemDescriptor;
+export declare const deleteCommand: (options?: MenuOptions) => ContextMenuItemDescriptor;
+export declare const renameCommand: (options?: MenuOptions) => ContextMenuItemDescriptor;
+export declare const editCommand: (options?: MenuOptions) => ContextMenuItemDescriptor;

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

@@ -0,0 +1,2 @@
+import { ColumnDescriptorsByName, Filter } from "@vuu-ui/vuu-filter-types";
+export declare const getFilterTooltipText: (columnsByName?: ColumnDescriptorsByName) => (filter: Filter) => string;

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

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 import { MenuActionHandler } from "@vuu-ui/vuu-data-types";
 import "./FilterPillMenu.css";
-import { MenuOptions } from "./FilterPillMenuOptions";
+import { MenuOptions } from "../filter-pill/FilterPillMenuOptions";
 import { Filter } from "@vuu-ui/vuu-filter-types";
 export interface FilterMenuOptions extends MenuOptions {
     filter: Filter;

package/types/filter-utils.d.ts

@@ -19,7 +19,6 @@ export declare const removeLastClause: (filter: MultiClauseFilter) => Filter;
   in filter editing UI only.
 */
 export declare const addClause: (existingFilter: Filter, clause: Partial<Filter>, { combineWith }?: AddFilterOptions) => FilterWithPartialClause;
-export declare const replaceClause: (existingFilter: FilterWithPartialClause | Partial<Filter> | undefined, clause: Partial<FilterClause>, idx: number) => Filter | Partial<Filter>;
 export declare const addFilter: (existingFilter: Filter | undefined, filter: Filter, { combineWith }?: AddFilterOptions) => Filter | undefined;
 interface CommonFilter {
     colName?: string;

package/types/index.d.ts

@@ -1,6 +1,7 @@
+export * from "./FilterModel";
 export * from "./filter-bar";
-export * from "./filter-builder-menu";
 export * from "./filter-clause";
+export * from "./filter-editor";
 export * from "./filter-input";
 export * from "./filter-pill";
 export * from "./filter-utils";

package/types/filter-builder-menu/FilterBuilderMenu.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="react" />
-import { ContextMenuProps } from "@vuu-ui/vuu-popups";
-import { MenuActionHandler } from "@vuu-ui/vuu-data-types";
-import { ListProps } from "@vuu-ui/vuu-ui-controls";
-import "./FilterBuilderMenu.css";
-export interface FilterBuilderMenuProps extends Omit<ContextMenuProps, "children"> {
-    ListProps?: Pick<ListProps, "onKeyDownCapture">;
-    onMenuAction: MenuActionHandler;
-}
-export declare const FilterBuilderMenu: ({ ListProps, onMenuAction, }: FilterBuilderMenuProps) => JSX.Element;

package/types/filter-builder-menu/index.d.ts

@@ -1 +0,0 @@
-export * from "./FilterBuilderMenu";

package/types/filter-clause/DateInput.d.ts

@@ -1,9 +0,0 @@
-import React from "react";
-import { NumericFilterClauseOp } from "@vuu-ui/vuu-filter-types";
-import { FilterClauseValueEditor } from "./filterClauseTypes";
-interface Props extends Pick<FilterClauseValueEditor<number>, "onInputComplete"> {
-    value: number | undefined;
-    operator: NumericFilterClauseOp;
-}
-export declare const DateInput: React.FC<Props>;
-export {};

package/types/filter-clause/FilterClauseEditor.d.ts

@@ -1,17 +0,0 @@
-import { SuggestionFetcher, TableSchema } from "@vuu-ui/vuu-data-types";
-import { ColumnDescriptorsByName, FilterClause } from "@vuu-ui/vuu-filter-types";
-import { CloseReason } from "@vuu-ui/vuu-ui-controls";
-import { HTMLAttributes } from "react";
-import { FilterClauseCancelHandler } from "./useFilterClauseEditor";
-import "./FilterClauseEditor.css";
-export interface FilterClauseEditorProps extends Omit<HTMLAttributes<HTMLDivElement>, "onChange"> {
-    columnsByName: ColumnDescriptorsByName;
-    filterClause: Partial<FilterClause>;
-    onCancel?: FilterClauseCancelHandler;
-    onChange: (filterClause: Partial<FilterClause>) => void;
-    onDropdownClose?: (closeReason: CloseReason) => void;
-    onDropdownOpen?: () => void;
-    suggestionProvider?: () => SuggestionFetcher;
-    tableSchema?: TableSchema;
-}
-export declare const FilterClauseEditor: ({ className, columnsByName, onCancel, onChange, onDropdownClose, onDropdownOpen, filterClause, suggestionProvider, tableSchema, ...htmlAttributes }: FilterClauseEditorProps) => JSX.Element;

package/types/filter-clause/FilterClauseTextValueEditor.d.ts

@@ -1,11 +0,0 @@
-import { HTMLAttributes, RefObject } from "react";
-import { FilterClauseValueEditor } from "./filterClauseTypes";
-import { SuggestionFetcher } from "@vuu-ui/vuu-data-types";
-export interface TextInputProps extends FilterClauseValueEditor, HTMLAttributes<HTMLDivElement> {
-    "data-field"?: string;
-    ref: RefObject<HTMLDivElement>;
-    operator: string;
-    suggestionProvider?: () => SuggestionFetcher;
-    value: string | string[];
-}
-export declare const FilterClauseTextValueEditor: import("react").ForwardRefExoticComponent<Omit<TextInputProps, "ref"> & import("react").RefAttributes<HTMLDivElement>>;

package/types/filter-clause/FilterClauseValueEditor.d.ts

@@ -1,9 +0,0 @@
-/// <reference types="react" />
-import { TableSchema } from "@vuu-ui/vuu-data-types";
-import { useFilterClauseEditor } from "./useFilterClauseEditor";
-import { FilterClauseEditorProps } from "./FilterClauseEditor";
-type InputElementProps = Pick<ReturnType<typeof useFilterClauseEditor>, "selectedColumn" | "operator" | "InputProps" | "onChangeValue" | "onDeselectValue" | "value"> & Pick<FilterClauseEditorProps, "suggestionProvider"> & {
-    table?: TableSchema["table"];
-};
-export declare const FilterClauseValueEditor: React.FC<InputElementProps>;
-export {};

package/types/filter-clause/NumericInput.d.ts

@@ -1,9 +0,0 @@
-import { HTMLAttributes, RefObject } from "react";
-import { FilterClauseValueEditor } from "./filterClauseTypes";
-export interface NumericInputProps extends FilterClauseValueEditor<number>, HTMLAttributes<HTMLDivElement> {
-    operatorInputRef?: RefObject<HTMLInputElement>;
-    operator: string;
-    ref: RefObject<HTMLDivElement>;
-    value?: number;
-}
-export declare const NumericInput: import("react").ForwardRefExoticComponent<Omit<NumericInputProps, "ref"> & import("react").RefAttributes<HTMLDivElement>>;

package/types/filter-clause/useFilterClauseEditor.d.ts

@@ -1,32 +0,0 @@
-import { ColumnDescriptorsByName, FilterClause, FilterClauseOp } from "@vuu-ui/vuu-filter-types";
-import { ColumnDescriptor } from "@vuu-ui/vuu-table-types";
-import { SingleSelectionHandler } from "@vuu-ui/vuu-ui-controls";
-import { KeyboardEvent, KeyboardEventHandler } from "react";
-type FilterClauseValue = boolean | boolean[] | string | string[] | number | number[];
-export type FilterClauseCancelType = "Backspace";
-export type FilterClauseCancelHandler = (reason: FilterClauseCancelType) => void;
-export interface FilterClauseEditorHookProps {
-    columnsByName: ColumnDescriptorsByName;
-    filterClause: Partial<FilterClause>;
-    onCancel?: FilterClauseCancelHandler;
-    onChange: (filterClause: Partial<FilterClause>) => void;
-}
-export declare const useFilterClauseEditor: ({ filterClause, onCancel, onChange, columnsByName, }: FilterClauseEditorHookProps) => {
-    InputProps: {
-        inputProps: {
-            onKeyDownCapture: (evt: KeyboardEvent<HTMLInputElement>) => void;
-        };
-    };
-    columnRef: import("react").RefObject<HTMLDivElement>;
-    onChangeValue: (value: string | string[] | number | number[]) => void;
-    onClear: (e: any) => void;
-    onClearKeyDown: KeyboardEventHandler<Element>;
-    onDeselectValue: () => void;
-    onColumnSelect: SingleSelectionHandler<ColumnDescriptor>;
-    onOperatorSelect: SingleSelectionHandler<string>;
-    operator: FilterClauseOp | undefined;
-    operatorRef: import("react").RefObject<HTMLDivElement>;
-    selectedColumn: ColumnDescriptor | undefined;
-    value: FilterClauseValue | undefined;
-};
-export {};