@vuu-ui/vuu-filters 0.6.10-debug → 0.6.11

package/package.json

@@ -4,9 +4,9 @@
   "license": "Apache-2.0",
   "type": "module",
   "peerDependencies": {
-    "@vuu-ui/vuu-codemirror": "0.6.10-debug",
-    "@vuu-ui/vuu-data": "0.6.10-debug",
-    "@vuu-ui/vuu-utils": "0.6.10-debug",
+    "@vuu-ui/vuu-codemirror": "0.6.11",
+    "@vuu-ui/vuu-data": "0.6.11",
+    "@vuu-ui/vuu-utils": "0.6.11",
     "@salt-ds/core": "1.0.0",
     "@heswell/salt-lab": "1.0.0-alpha.0-vuu.1",
     "react": "^17.0.2",
@@ -16,9 +16,11 @@
     "cjs",
     "esm",
     "index.css",
-    "index.css.map"
+    "index.css.map",
+    "/types"
   ],
   "module": "esm/index.js",
   "main": "cjs/index.js",
-  "version": "0.6.10-debug"
+  "version": "0.6.11",
+  "types": "types/index.d.ts"
 }

package/types/filter-evaluation-utils.d.ts

@@ -0,0 +1,6 @@
+import { DataSourceRow } from "@vuu-ui/vuu-data";
+import { Filter } from "@vuu-ui/vuu-filter-types";
+import { ColumnMap } from "@vuu-ui/vuu-utils";
+export declare const getFilterPredicate: (columnMap: ColumnMap, filterQuery: string) => FilterPredicate;
+export declare function filterPredicate(columnMap: ColumnMap, filter: Filter): FilterPredicate;
+export type FilterPredicate = (row: DataSourceRow) => boolean;

package/types/filter-input/FilterInput.d.ts

@@ -0,0 +1,10 @@
+import { Filter } from "@vuu-ui/vuu-filter-types";
+import { HTMLAttributes } from "react";
+import { filterSubmissionHandler, SuggestionConsumer } from "./useCodeMirrorEditor";
+import "./FilterInput.css";
+export interface FilterInputProps extends SuggestionConsumer, HTMLAttributes<HTMLDivElement> {
+    existingFilter?: Filter;
+    namedFilters?: Map<string, string>;
+    onSubmitFilter?: filterSubmissionHandler;
+}
+export declare const FilterInput: ({ existingFilter, namedFilters, onSubmitFilter, suggestionProvider, ...props }: FilterInputProps) => JSX.Element;

package/types/filter-input/codemirror-basic-setup.d.ts

@@ -0,0 +1,3 @@
+import { Extension } from "@vuu-ui/vuu-codemirror";
+export declare const minimalSetup: Extension;
+export { EditorView } from "@codemirror/view";

package/types/filter-input/filter-language-parser/FilterLanguage.d.ts

@@ -0,0 +1,2 @@
+import { LanguageSupport } from "@vuu-ui/vuu-codemirror";
+export declare const filterLanguageSupport: () => LanguageSupport;

package/types/filter-input/filter-language-parser/FilterParser.d.ts

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

package/types/filter-input/filter-language-parser/FilterTreeWalker.d.ts

@@ -0,0 +1,3 @@
+import { Tree } from "@lezer/common";
+import { Filter } from "@vuu-ui/vuu-filter-types";
+export declare const walkTree: (tree: Tree, source: string) => Partial<Filter> | undefined;

package/types/filter-input/filter-language-parser/generated/filter-parser.d.ts

@@ -0,0 +1,2 @@
+export const parser: LRParser;
+import { LRParser } from "@vuu-ui/vuu-codemirror";

package/types/filter-input/filter-language-parser/generated/filter-parser.terms.d.ts

@@ -0,0 +1,27 @@
+export const Filter: 1;
+export const ColumnValueExpression: 2;
+export const Column: 3;
+export const Operator: 4;
+export const Eq: 5;
+export const NotEq: 6;
+export const Gt: 7;
+export const Lt: 8;
+export const Starts: 9;
+export const Ends: 10;
+export const Number: 11;
+export const String: 12;
+export const True: 13;
+export const False: 14;
+export const ColumnSetExpression: 15;
+export const In: 16;
+export const LBrack: 17;
+export const Values: 18;
+export const Comma: 19;
+export const RBrack: 20;
+export const AndExpression: 21;
+export const And: 22;
+export const OrExpression: 23;
+export const Or: 24;
+export const ParenthesizedExpression: 25;
+export const As: 26;
+export const FilterName: 27;

package/types/filter-input/filter-language-parser/index.d.ts

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

package/types/filter-input/filterInfo.d.ts

@@ -0,0 +1 @@
+export declare const filterInfo: (filterName: string, filterQuery: string) => HTMLElement;

package/types/filter-input/highlighting.d.ts

@@ -0,0 +1 @@
+export declare const vuuHighlighting: import("@codemirror/state").Extension;

package/types/filter-input/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./FilterInput";
+export * from "./useCodeMirrorEditor";
+export * from "./useFilterSuggestionProvider";

package/types/filter-input/theme.d.ts

@@ -0,0 +1 @@
+export declare const vuuTheme: import("@codemirror/state").Extension;

package/types/filter-input/useCodeMirrorEditor.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="react" />
+import { Completion } from "@vuu-ui/vuu-codemirror";
+import { Filter } from "@vuu-ui/vuu-filter-types";
+import { FilterSubmissionMode } from "./useFilterAutoComplete";
+export type SuggestionType = "column" | "columnValue" | "operator";
+export interface SuggestionOptions {
+    columnName?: string;
+    operator?: string;
+    startsWith?: string;
+    selection?: string[];
+}
+export type getSuggestionsType = (valueType: SuggestionType, options?: SuggestionOptions) => Promise<Completion[]>;
+export interface ISuggestionProvider {
+    getSuggestions: getSuggestionsType;
+    isPartialMatch: (valueType: SuggestionType, columnName?: string, text?: string | undefined) => Promise<boolean>;
+}
+export interface SuggestionConsumer {
+    suggestionProvider: ISuggestionProvider;
+}
+export type filterSubmissionHandler = (filter: Filter | undefined, filterQuery: string, mode?: FilterSubmissionMode, filterName?: string) => void;
+export interface CodeMirrorEditorProps {
+    existingFilter?: Filter;
+    onSubmitFilter?: filterSubmissionHandler;
+    suggestionProvider: ISuggestionProvider;
+}
+export declare const useCodeMirrorEditor: ({ existingFilter, onSubmitFilter, suggestionProvider, }: CodeMirrorEditorProps) => {
+    editorRef: import("react").RefObject<HTMLDivElement>;
+    clearInput: () => void;
+};

package/types/filter-input/useFilterAutoComplete.d.ts

@@ -0,0 +1,7 @@
+import { CompletionSource } from "@vuu-ui/vuu-codemirror";
+import { Filter } from "@vuu-ui/vuu-filter-types";
+import { MutableRefObject } from "react";
+import { ISuggestionProvider } from "./useCodeMirrorEditor";
+export type FilterSubmissionMode = "and" | "or" | "replace";
+export type ApplyCompletion = (mode?: FilterSubmissionMode) => void;
+export declare const useAutoComplete: (suggestionProvider: ISuggestionProvider, onSubmit: MutableRefObject<ApplyCompletion>, existingFilter?: Filter) => CompletionSource;

package/types/filter-input/useFilterSuggestionProvider.d.ts

@@ -0,0 +1,13 @@
+import { Completion } from "@vuu-ui/vuu-codemirror";
+import { ColumnDescriptor } from "@vuu-ui/vuu-datagrid-types";
+import { ISuggestionProvider } from "@vuu-ui/vuu-filters";
+import { VuuTable } from "@vuu-ui/vuu-protocol-types";
+export interface VuuCompletion extends Completion {
+    isIllustration?: boolean;
+}
+export interface SuggestionProviderHookProps {
+    columns: ColumnDescriptor[];
+    namedFilters?: Map<string, string>;
+    table: VuuTable;
+}
+export declare const useFilterSuggestionProvider: ({ columns, namedFilters, table, }: SuggestionProviderHookProps) => ISuggestionProvider;

package/types/filter-toolbar/FilterDropdown.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { DropdownProps } from "@heswell/salt-lab";
+import { ISuggestionProvider } from "../filter-input";
+export interface FilterDropdownProps extends DropdownProps {
+    column: string;
+    suggestionProvider: ISuggestionProvider;
+}
+export declare const FilterDropdown: ({ column, selected: selectedProp, suggestionProvider, ...props }: FilterDropdownProps) => JSX.Element;

package/types/filter-toolbar/FilterDropdownMultiSelect.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import { DropdownProps } from "@heswell/salt-lab";
+import { ISuggestionProvider } from "../filter-input";
+export interface FilterDropdownProps extends DropdownProps<string, "multiple"> {
+    column: string;
+    suggestionProvider: ISuggestionProvider;
+}
+export declare const FilterDropdownMultiSelect: ({ column, selected: selectedProp, suggestionProvider, ...props }: FilterDropdownProps) => JSX.Element;

package/types/filter-toolbar/FilterToolbar.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { Filter } from "@vuu-ui/vuu-filter-types";
+import { ToolbarProps } from "@heswell/salt-lab";
+import { SuggestionConsumer } from "../filter-input";
+import "./FilterToolbar.css";
+export interface FilterToolbarProps extends SuggestionConsumer, ToolbarProps {
+    filter?: Filter;
+}
+export declare const FilterToolbar: ({ className, filter, suggestionProvider, ...props }: FilterToolbarProps) => JSX.Element;

package/types/filter-toolbar/index.d.ts

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

package/types/filter-toolbar/useFilterToolbar.d.ts

@@ -0,0 +1,7 @@
+import { Filter } from "@vuu-ui/vuu-filter-types";
+import { SuggestionConsumer } from "@vuu-ui/vuu-filters";
+import { ReactElement } from "react";
+export interface FilterToolbarProps extends SuggestionConsumer {
+    filter?: Filter;
+}
+export declare const useFilterToolbar: ({ filter, suggestionProvider, }: FilterToolbarProps) => ReactElement<any, string | import("react").JSXElementConstructor<any>> | ReactElement<any, string | import("react").JSXElementConstructor<any>>[];

package/types/filter-utils.d.ts

@@ -0,0 +1,44 @@
+import { KeyedColumnDescriptor } from "@vuu-ui/vuu-datagrid-types";
+import { Row } from "@vuu-ui/vuu-utils";
+import { Filter, FilterClause, FilterCombinatorOp } from "@vuu-ui/vuu-filter-types";
+export declare const AND = "and";
+export declare const EQUALS = "=";
+export declare const GREATER_THAN = ">";
+export declare const LESS_THAN = "<";
+export declare const OR = "or";
+export declare const STARTS_WITH = "starts";
+export declare const ENDS_WITH = "ends";
+export declare const IN = "in";
+export type FilterType = "and" | "=" | ">" | ">=" | "in" | "<=" | "<" | "NOT_IN" | "NOT_SW" | "or" | "SW";
+export declare const filterClauses: (filter: Filter | null, clauses?: FilterClause[]) => FilterClause[];
+type AddFilterOptions = {
+    combineWith: FilterCombinatorOp;
+};
+export declare const addFilter: (existingFilter: Filter | undefined, filter: Filter, { combineWith }?: AddFilterOptions) => Filter | undefined;
+export declare const filterAsQuery: (f: Filter, namedFilters?: {}) => string;
+interface CommonFilter {
+    colName?: string;
+    otherColFilters?: Filter[];
+    mode?: any;
+    value?: any;
+    values?: any;
+    op?: "or" | "and";
+    column?: string;
+    filters?: Filter[];
+}
+export interface OtherFilter extends CommonFilter {
+    type: FilterType;
+    values?: any[];
+}
+export type RowFilterFn = (row: Row) => boolean;
+export declare const removeColumnFromFilter: (column: KeyedColumnDescriptor, filter: Filter) => [Filter | undefined, string];
+export declare const removeFilter: (sourceFilter: Filter, filterToRemove: Filter) => {
+    type: string;
+    filters: Filter[];
+} | null;
+export declare const splitFilterOnColumn: (filter: Filter | null, columnName: string) => [Filter | null, Filter | null];
+export declare const overrideColName: (filter: Filter, column: string) => Filter;
+export declare const filterIncludesColumn: (filter: Filter, column: KeyedColumnDescriptor) => boolean;
+export declare const filterEquals: (f1?: Filter, f2?: Filter, strict?: boolean) => boolean;
+export declare const updateFilter: (filter: Filter | undefined, newFilter: Filter | undefined, mode: "add" | "replace") => Filter | undefined;
+export {};

package/types/filterTypes.d.ts

@@ -0,0 +1,9 @@
+import { AndFilter, Filter, MultiClauseFilter, MultiValueFilterClause, OrFilter, SingleValueFilterClause } from "@vuu-ui/vuu-filter-types";
+export declare const isNamedFilter: (f?: Filter) => boolean;
+export declare const isSingleValueFilter: (f?: Filter) => f is SingleValueFilterClause<string | number | boolean>;
+export declare const isFilterClause: (f?: Filter) => f is MultiValueFilterClause | SingleValueFilterClause<string | number | boolean>;
+export declare const isMultiValueFilter: (f?: Filter) => f is MultiValueFilterClause;
+export declare const isInFilter: (f: Filter) => f is MultiValueFilterClause;
+export declare const isAndFilter: (f: Filter) => f is AndFilter;
+export declare const isOrFilter: (f: Filter) => f is OrFilter;
+export declare function isMultiClauseFilter(f?: Filter): f is MultiClauseFilter;

package/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./filter-input";
+export * from "./filter-toolbar";
+export * from "./filter-evaluation-utils";
+export * from "./filter-utils";
+export * from "./filterTypes";