@beabee/beabee-common 1.8.3 → 1.9.0

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.
Files changed (7) hide show
  1. package/dist/cjs/search/index.js +0 -1
  2. package/dist/cjs/utils/rules.js +1 -25
  3. package/dist/esm/search/index.js +0 -1
  4. package/dist/esm/utils/rules.js +0 -22
  5. package/dist/types/search/index.d.ts +9 -15
  6. package/dist/types/utils/rules.d.ts +1 -3
  7. package/package.json +1 -1
package/dist/cjs/search/index.js CHANGED
@@ -34,7 +34,6 @@ exports.ruleOperators = [
34
34
  "is_empty",
35
35
  "is_not_empty",
36
36
  ];
37
- // *** Operator definitions ***
38
37
  const equalityOperators = {
39
38
  equal: { args: 1 },
40
39
  not_equal: { args: 1 },
package/dist/cjs/utils/rules.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.convertFiltersToRuleGroup = exports.convertRuleGroupToFilters = exports.validateRuleGroup = exports.validateRule = exports.isRuleGroup = void 0;
3
+ exports.validateRuleGroup = exports.validateRule = exports.isRuleGroup = void 0;
4
4
  const error_1 = require("../error");
5
5
  const search_1 = require("../search");
6
6
  const date_1 = require("./date");
@@ -61,27 +61,3 @@ function validateRuleGroup(filters, ruleGroup) {
61
61
  return validatedRuleGroup;
62
62
  }
63
63
  exports.validateRuleGroup = validateRuleGroup;
64
- function convertRuleGroupToFilters(ruleGroup) {
65
- if (!ruleGroup) {
66
- return null;
67
- }
68
- // TODO: how to handle groups?
69
- const rulesWithoutGroups = ruleGroup.rules.filter((rule) => !isRuleGroup(rule));
70
- return rulesWithoutGroups.map((rule) => ({
71
- id: rule.field,
72
- operator: rule.operator,
73
- values: [...rule.value],
74
- }));
75
- }
76
- exports.convertRuleGroupToFilters = convertRuleGroupToFilters;
77
- function convertFiltersToRuleGroup(matchType, filters) {
78
- return {
79
- condition: matchType === "all" ? "AND" : "OR",
80
- rules: filters.map((filter) => ({
81
- field: filter.id,
82
- operator: filter.operator,
83
- value: filter.values,
84
- })),
85
- };
86
- }
87
- exports.convertFiltersToRuleGroup = convertFiltersToRuleGroup;
package/dist/esm/search/index.js CHANGED
@@ -17,7 +17,6 @@ export const ruleOperators = [
17
17
  "is_empty",
18
18
  "is_not_empty",
19
19
  ];
20
- // *** Operator definitions ***
21
20
  const equalityOperators = {
22
21
  equal: { args: 1 },
23
22
  not_equal: { args: 1 },
package/dist/esm/utils/rules.js CHANGED
@@ -55,25 +55,3 @@ export function validateRuleGroup(filters, ruleGroup) {
55
55
  }
56
56
  return validatedRuleGroup;
57
57
  }
58
- export function convertRuleGroupToFilters(ruleGroup) {
59
- if (!ruleGroup) {
60
- return null;
61
- }
62
- // TODO: how to handle groups?
63
- const rulesWithoutGroups = ruleGroup.rules.filter((rule) => !isRuleGroup(rule));
64
- return rulesWithoutGroups.map((rule) => ({
65
- id: rule.field,
66
- operator: rule.operator,
67
- values: [...rule.value],
68
- }));
69
- }
70
- export function convertFiltersToRuleGroup(matchType, filters) {
71
- return {
72
- condition: matchType === "all" ? "AND" : "OR",
73
- rules: filters.map((filter) => ({
74
- field: filter.id,
75
- operator: filter.operator,
76
- value: filter.values,
77
- })),
78
- };
79
- }
package/dist/types/search/index.d.ts CHANGED
@@ -10,24 +10,22 @@ export interface RuleGroup {
10
10
  condition: "AND" | "OR";
11
11
  rules: (RuleGroup | Rule)[];
12
12
  }
13
- interface BaseValidatedRule<T extends FilterType, F extends string, V> {
13
+ export declare type ValidatedRuleValue<T extends FilterType> = T extends "number" ? number : T extends "boolean" ? boolean : string;
14
+ interface BaseValidatedRule<T extends FilterType, F extends string> {
14
15
  type: T;
15
16
  field: F;
16
17
  operator: keyof typeof operatorsByType[T];
17
- value: V[];
18
+ value: ValidatedRuleValue<T>[];
18
19
  }
19
- declare type ValidatedNumberRule<Field extends string> = BaseValidatedRule<"number", Field, number>;
20
- declare type ValidatedStringRule<Field extends string> = BaseValidatedRule<Exclude<FilterType, "number" | "boolean">, Field, string>;
21
- declare type ValidatedBooleanRule<Field extends string> = BaseValidatedRule<"boolean", Field, boolean>;
20
+ declare type ValidatedNumberRule<Field extends string> = BaseValidatedRule<"number", Field>;
21
+ declare type ValidatedStringRule<Field extends string> = BaseValidatedRule<Exclude<FilterType, "number" | "boolean">, Field>;
22
+ declare type ValidatedBooleanRule<Field extends string> = BaseValidatedRule<"boolean", Field>;
22
23
  export declare type ValidatedRule<Field extends string> = ValidatedNumberRule<Field> | ValidatedStringRule<Field> | ValidatedBooleanRule<Field>;
23
24
  export interface ValidatedRuleGroup<Field extends string> {
24
25
  condition: "AND" | "OR";
25
26
  rules: (ValidatedRuleGroup<Field> | ValidatedRule<Field>)[];
26
27
  }
27
28
  export declare type FilterType = "text" | "date" | "number" | "boolean" | "array" | "enum" | "contact";
28
- export interface FilterOperatorParams {
29
- args: number;
30
- }
31
29
  interface BaseFilterArgs {
32
30
  type: FilterType;
33
31
  nullable?: boolean;
@@ -41,12 +39,8 @@ export interface OtherFilterArgs extends BaseFilterArgs {
41
39
  }
42
40
  export declare type FilterArgs = EnumFilterArgs | OtherFilterArgs;
43
41
  export declare type Filters<T extends string = string> = Record<T, FilterArgs>;
44
- export declare type FilterValue = RuleValue;
45
- export declare type FilterOperator = RuleOperator;
46
- export interface Filter {
47
- id: string;
48
- operator: FilterOperator;
49
- values: FilterValue[];
42
+ export interface RuleOperatorParams {
43
+ args: number;
50
44
  }
51
45
  export declare const nullableOperators: {
52
46
  is_empty: {
@@ -165,7 +159,7 @@ export declare const operatorsByType: {
165
159
  };
166
160
  };
167
161
  };
168
- export declare const operatorsByTypeMap: Record<FilterType, Partial<Record<FilterOperator, FilterOperatorParams>>>;
162
+ export declare const operatorsByTypeMap: Record<FilterType, Partial<Record<RuleOperator, RuleOperatorParams>>>;
169
163
  export interface Paginated<T> {
170
164
  items: T[];
171
165
  offset: number;
package/dist/types/utils/rules.d.ts CHANGED
@@ -1,6 +1,4 @@
1
- import { Filter, Filters, Rule, RuleGroup, ValidatedRule, ValidatedRuleGroup } from "../search";
1
+ import { Filters, Rule, RuleGroup, ValidatedRule, ValidatedRuleGroup } from "../search";
2
2
  export declare function isRuleGroup(ruleOrGroup: Rule | RuleGroup): ruleOrGroup is RuleGroup;
3
3
  export declare function validateRule<Field extends string>(filters: Filters<Field>, rule: Rule): ValidatedRule<Field>;
4
4
  export declare function validateRuleGroup<Field extends string>(filters: Filters<Field>, ruleGroup: RuleGroup): ValidatedRuleGroup<Field>;
5
- export declare function convertRuleGroupToFilters(ruleGroup?: RuleGroup): Filter[] | null;
6
- export declare function convertFiltersToRuleGroup(matchType: "all" | "any", filters: Filter[]): RuleGroup;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@beabee/beabee-common",
3
- "version": "1.8.3",
3
+ "version": "1.9.0",
4
4
  "description": "",
5
5
  "main": "./dist/cjs/index.js",
6
6
  "module": "./dist/esm/index.js",