@hitgrab/finder 0.1.6-alpha → 0.1.8-alpha

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -30,7 +30,10 @@ export declare const ERRORS: {
30
30
  WRONG_RULE_TYPE_FOR_MIXIN: string;
31
31
  NO_SEARCH_RULE_SET: string;
32
32
  SETTING_MULTIPLE_FILTER_WITHOUT_ARRAY: string;
33
+ ADDING_OPTION_TO_MULTIPLE_FILTER_WITHOUT_OPTION_VALUE: string;
34
+ DELETING_OPTION_VALUE_FROM_NON_MULTIPLE_FILTER: string;
33
35
  SETTING_BOOLEAN_FILTER_WITHOUT_BOOLEAN_VALUE: string;
36
+ ADDING_OPTION_VALUE_TO_NON_MULTIPLE_FILTER: string;
34
37
  TOGGLING_OPTION_ON_RULE_WITH_NO_OPTIONS: string;
35
38
  TOGGLING_OPTION_ON_RULE_WITH_SINGLE_VALUE: string;
36
39
  TOGGLING_OPTION_THAT_DOES_NOT_EXIST: string;
@@ -4,5 +4,7 @@ export declare function BooleanFilter(rule: HydratedFilterRule): {
4
4
  parse(value: unknown): any;
5
5
  has(value: unknown): any;
6
6
  toggle(value: unknown, optionValue?: any): boolean;
7
+ add(value: unknown, optionValue: any): never;
8
+ delete(value: unknown, optionValue?: any): undefined;
7
9
  isActive(value: unknown): boolean;
8
10
  };
@@ -4,11 +4,15 @@ export declare function makeFilter(rule: HydratedFilterRule): {
4
4
  parse(value: unknown): any;
5
5
  has(value: unknown): any;
6
6
  toggle(value: unknown, optionValue?: any): boolean;
7
+ add(value: unknown, optionValue: any): never;
8
+ delete(value: unknown, optionValue?: any): undefined;
7
9
  isActive(value: unknown): boolean;
8
10
  } | {
9
11
  validate(value: unknown): boolean;
10
12
  parse(value: unknown): any[];
11
13
  has(value: unknown, optionValue?: any): boolean;
12
14
  toggle(value: unknown, optionValue?: any): any[];
15
+ add(value: unknown, optionValue: any): any[];
16
+ delete(value: unknown, optionValue?: any): any[] | undefined;
13
17
  isActive(value: unknown): boolean;
14
18
  };
@@ -4,5 +4,7 @@ export declare function MultipleFilter(rule: HydratedFilterRule): {
4
4
  parse(value: unknown): any[];
5
5
  has(value: unknown, optionValue?: any): boolean;
6
6
  toggle(value: unknown, optionValue?: any): any[];
7
+ add(value: unknown, optionValue: any): any[];
8
+ delete(value: unknown, optionValue?: any): any[] | undefined;
7
9
  isActive(value: unknown): boolean;
8
10
  };
@@ -4,5 +4,7 @@ export declare function SingleFilter(rule: HydratedFilterRule): {
4
4
  parse(value: unknown): any;
5
5
  has(value: unknown): value is {} | null;
6
6
  toggle(value: unknown, optionValue?: any): never;
7
+ add(value: unknown, optionValue: any): never;
8
+ delete(value: unknown, optionValue?: any): undefined;
7
9
  isActive(value: unknown): boolean;
8
10
  };
@@ -13,7 +13,8 @@ declare class FiltersMixin {
13
13
  get(identifier: FilterRuleIdentifier): any;
14
14
  has(identifier: FilterRuleIdentifier, optionValue?: any): boolean;
15
15
  getRule(identifier: FilterRuleIdentifier): HydratedFilterRule<any, any, any>;
16
- delete(identifier: FilterRuleIdentifier): void;
16
+ add(identifier: FilterRuleIdentifier, optionValue: any): void;
17
+ delete(identifier: FilterRuleIdentifier, optionValue?: any): void;
17
18
  isRuleActive(identifier: FilterRuleIdentifier): boolean;
18
19
  toggle(identifier: FilterRuleIdentifier, optionValue?: any): void;
19
20
  test(options: FilterTestOptions): any[];
@@ -40,11 +40,12 @@ declare class FinderCore<FItem = any, FContext = any> {
40
40
  rules: import("..").HydratedFilterRule<unknown, any, any>[];
41
41
  isActive: (identifier: string | import("..").FilterRuleUnion | import("..").HydratedFilterRule<any, any, any>) => boolean;
42
42
  get: (identifier: string | import("..").FilterRuleUnion | import("..").HydratedFilterRule<any, any, any>) => any;
43
+ add: (identifier: string | import("..").FilterRuleUnion | import("..").HydratedFilterRule<any, any, any>, optionValue: any) => void;
43
44
  has: (identifier: string | import("..").FilterRuleUnion | import("..").HydratedFilterRule<any, any, any>, optionValue?: any) => boolean;
44
45
  getRule: (identifier: string | import("..").FilterRuleUnion | import("..").HydratedFilterRule<any, any, any>) => import("..").HydratedFilterRule<any, any, any>;
45
46
  toggle: (identifier: string | import("..").FilterRuleUnion | import("..").HydratedFilterRule<any, any, any>, optionValue?: any) => void;
46
47
  set: <FValue>(identifier: string | import("..").FilterRuleUnion | import("..").HydratedFilterRule<any, any, any>, value: FValue | FValue[]) => void;
47
- delete: (identifier: string | import("..").FilterRuleUnion | import("..").HydratedFilterRule<any, any, any>) => void;
48
+ delete: (identifier: string | import("..").FilterRuleUnion | import("..").HydratedFilterRule<any, any, any>, optionValue?: any) => void;
48
49
  test: (options: import("./types/rule-types").FilterTestOptions) => any[];
49
50
  testRule: ({ rule: identifier, value, ...options }: import("./types/rule-types").FilterTestRuleOptions) => any[];
50
51
  testRuleOptions: ({ rule: identifier, ...options }: import("./types/rule-types").FilterTestRuleOptionsOptions) => Map<any, any>;
@@ -5,11 +5,11 @@ import { FilterRuleWithBooleanValue, FilterRuleWithMultipleValues, FilterRuleWit
5
5
  * Enforce structure for an array of rule of mixed types.
6
6
  */
7
7
  export declare function finderRuleset<FItem>(rules: FinderRule<FItem>[]): FinderRule<FItem>[];
8
- export declare function searchRule<FItem>(rule: SearchRule<FItem>): SearchRule<FItem, any>;
9
- export declare function filterRule<FItem, FValue = any, T = FilterRuleWithMultipleValues<FItem, FValue>>(rule: T): FilterRuleWithMultipleValues<FItem, FValue>;
10
- export declare function filterRule<FItem, FValue = any, T = FilterRuleWithBooleanValue<FItem, FValue>>(rule: T): FilterRuleWithBooleanValue<FItem, FValue>;
11
- export declare function filterRule<FItem, FValue = any, T = FilterRuleWithSingleValue<FItem, FValue>>(rule: T): FilterRuleWithSingleValue<FItem, FValue>;
12
- export declare function sortByRule<FItem>(rule: SortByRule<FItem>): SortByRule<FItem, any>;
13
- export declare function groupByRule<FItem>(rule: GroupByRule<FItem>): GroupByRule<FItem, any>;
8
+ export declare function searchRule<FItem, FContext = any>(rule: SearchRule<FItem, FContext>): SearchRule<FItem, FContext>;
9
+ export declare function filterRule<FItem, FValue = any, FContext = any, T = FilterRuleWithMultipleValues<FItem, FValue, FContext>>(rule: T): FilterRuleWithMultipleValues<FItem, FValue>;
10
+ export declare function filterRule<FItem, FValue = any, FContext = any, T = FilterRuleWithBooleanValue<FItem, FContext>>(rule: T): FilterRuleWithBooleanValue<FItem, FValue>;
11
+ export declare function filterRule<FItem, FValue = any, FContext = any, T = FilterRuleWithSingleValue<FItem, FValue, FContext>>(rule: T): FilterRuleWithSingleValue<FItem, FValue>;
12
+ export declare function sortByRule<FItem, FContext = any>(rule: SortByRule<FItem, FContext>): SortByRule<FItem, FContext>;
13
+ export declare function groupByRule<FItem, FContext = any>(rule: GroupByRule<FItem, FContext>): GroupByRule<FItem, FContext>;
14
14
  export declare function ruleEffect<FItem, FContext = any>(rules: string | FinderRule<FItem> | (string | FinderRule<FItem>)[] | ((items: FItem[], context: FContext) => string | FinderRule<FItem> | (string | FinderRule<FItem>)[]), onChange: (instance: FinderCore<FItem, FContext>, rule: FinderRule) => void): RuleEffect<FItem, FContext>;
15
15
  export declare function searchEffect<FItem, FContext = any>(haystack: string | string[] | ((items: FItem[], context: FContext) => string | string[]), onChange: (instance: FinderCore<FItem, FContext>, searchTerm: string) => void): SearchEffect<FItem, FContext>;