@genesislcap/expression-builder 14.408.0 → 14.409.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 (41) hide show
  1. package/README.md +24 -2
  2. package/package.json +10 -10
  3. package/docs/api/expression-builder.config.base_logical_combinators.md +0 -16
  4. package/docs/api/expression-builder.config.base_operators.md +0 -16
  5. package/docs/api/expression-builder.config.logical_combinators.md +0 -16
  6. package/docs/api/expression-builder.config.md +0 -67
  7. package/docs/api/expression-builder.config.null_combinator.md +0 -18
  8. package/docs/api/expression-builder.expressionbuilder.config.md +0 -61
  9. package/docs/api/expression-builder.expressionbuilder.dispatchchangeevent.md +0 -59
  10. package/docs/api/expression-builder.expressionbuilder.md +0 -152
  11. package/docs/api/expression-builder.expressionbuilder.model.md +0 -35
  12. package/docs/api/expression-builder.expressionbuilder.styles.md +0 -39
  13. package/docs/api/expression-builder.formatdatestring.md +0 -57
  14. package/docs/api/expression-builder.formatdatetimestring.md +0 -57
  15. package/docs/api/expression-builder.md +0 -149
  16. package/docs/api/expression-builder.styles.md +0 -16
  17. package/docs/api/expression-builder.template.md +0 -16
  18. package/docs/api/expression-builder.types._operator.md +0 -25
  19. package/docs/api/expression-builder.types.binaryoperator.md +0 -20
  20. package/docs/api/expression-builder.types.checkboxinput.md +0 -19
  21. package/docs/api/expression-builder.types.combinator.md +0 -29
  22. package/docs/api/expression-builder.types.config.md +0 -25
  23. package/docs/api/expression-builder.types.customelements.md +0 -48
  24. package/docs/api/expression-builder.types.customstyles.md +0 -32
  25. package/docs/api/expression-builder.types.dateinput.md +0 -20
  26. package/docs/api/expression-builder.types.datetimeinput.md +0 -20
  27. package/docs/api/expression-builder.types.field.md +0 -24
  28. package/docs/api/expression-builder.types.fieldtypes.md +0 -18
  29. package/docs/api/expression-builder.types.group.md +0 -49
  30. package/docs/api/expression-builder.types.md +0 -286
  31. package/docs/api/expression-builder.types.numberinput.md +0 -20
  32. package/docs/api/expression-builder.types.operator.md +0 -18
  33. package/docs/api/expression-builder.types.rule.md +0 -45
  34. package/docs/api/expression-builder.types.selectinput.md +0 -23
  35. package/docs/api/expression-builder.types.styles.md +0 -25
  36. package/docs/api/expression-builder.types.ternararyoperator.md +0 -20
  37. package/docs/api/expression-builder.types.textinput.md +0 -20
  38. package/docs/api/expression-builder.types.uniraryoperator.md +0 -22
  39. package/docs/api/expression-builder.types.variadicoperator.md +0 -20
  40. package/docs/api/index.md +0 -30
  41. package/docs/api-report.md.api.md +0 -268
@@ -1,268 +0,0 @@
1
- ## API Report File for "@genesislcap/expression-builder"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import { ElementStyles } from '@microsoft/fast-element';
8
- import { GenesisElement } from '@genesislcap/web-core';
9
- import { ViewTemplate } from '@microsoft/fast-element';
10
-
11
- // @beta
12
- const BASE_LOGICAL_COMBINATORS: Combinator[];
13
-
14
- // @alpha (undocumented)
15
- const BASE_OPERATORS: Operator[];
16
-
17
- // @beta
18
- type BinaryOperator = {
19
- nbInputs: 1;
20
- } & _Operator;
21
-
22
- // @beta
23
- type CheckboxInput = {
24
- input: 'checkbox';
25
- type: 'boolean';
26
- };
27
-
28
- // @beta (undocumented)
29
- type Combinator = {
30
- type: string;
31
- maxRules: 1 | 2 | 'many';
32
- invisible?: boolean;
33
- label?: string;
34
- description?: string;
35
- allowedFields?: Field['fieldId'][];
36
- allowedOperators?: Operator['type'][];
37
- validator?: (group: Group) => string | null;
38
- allowLiterals?: boolean;
39
- forceFieldOnly?: boolean;
40
- };
41
-
42
- declare namespace Config {
43
- export {
44
- BASE_LOGICAL_COMBINATORS,
45
- LOGICAL_COMBINATORS,
46
- NULL_COMBINATOR,
47
- BASE_OPERATORS
48
- }
49
- }
50
- export { Config }
51
-
52
- // @beta (undocumented)
53
- type Config_2 = {
54
- operators: Operator[];
55
- fields: Field[];
56
- combinators: Combinator[];
57
- model?: Group;
58
- maxNesting?: number;
59
- partialRuleValidationWarning?: boolean;
60
- };
61
-
62
- // @beta
63
- type CustomElements = {
64
- checkbox?: string;
65
- text?: string;
66
- number?: string;
67
- date?: string;
68
- datetimeLocal?: string;
69
- select?: string;
70
- option?: string;
71
- optgroup?: string;
72
- button?: string;
73
- radio?: {
74
- input: string;
75
- group: string;
76
- };
77
- };
78
-
79
- // @beta
80
- type CustomStyles = {
81
- rule?: string;
82
- value?: string;
83
- field?: string;
84
- operator?: string;
85
- group?: string;
86
- };
87
-
88
- // @beta
89
- type DateInput = {
90
- input: 'date';
91
- type: 'date';
92
- validation?: (x: unknown) => string | null;
93
- };
94
-
95
- // @beta
96
- type DateTimeInput = {
97
- input: 'datetime-local';
98
- type: 'date-time';
99
- validation?: (x: unknown) => string | null;
100
- };
101
-
102
- // Warning: (ae-forgotten-export) The symbol "MetadataProvider" needs to be exported by the entry point index.d.ts
103
- //
104
- // @beta
105
- export class ExpressionBuilder extends GenesisElement implements MetadataProvider {
106
- config: Config_2;
107
- // @internal (undocumented)
108
- configChanged(_: Config_2, newConfig: Config_2): void;
109
- // @internal (undocumented)
110
- connectedCallback(): void;
111
- // @internal (undocumented)
112
- disconnectedCallback(): void;
113
- protected dispatchChangeEvent(group: Group): void;
114
- // @internal (undocumented)
115
- getConfig(): Config_2;
116
- // @internal (undocumented)
117
- getGroupId(): string;
118
- // @internal (undocumented)
119
- getRuleId(): string;
120
- // Warning: (ae-forgotten-export) The symbol "ModelGroup" needs to be exported by the entry point index.d.ts
121
- model: ModelGroup | null;
122
- // @internal (undocumented)
123
- modelChanged(_: Config_2, newModel: ModelGroup): void;
124
- styles?: Styles;
125
- }
126
-
127
- // @beta (undocumented)
128
- type Field = {
129
- optgroup?: string | null;
130
- defaultValue?: any;
131
- fieldId: string;
132
- label: string;
133
- operators?: string[];
134
- } & FieldTypes;
135
-
136
- // @beta
137
- type FieldTypes = TextInput | NumberInput | CheckboxInput | SelectInput | DateInput | DateTimeInput;
138
-
139
- // @beta
140
- export const formatDateString: (date: Date) => string;
141
-
142
- // @beta
143
- export const formatDateTimeString: (date: Date) => string;
144
-
145
- // @beta
146
- type Group = {
147
- combinator: Combinator;
148
- children: (Rule | Group)[];
149
- };
150
-
151
- // @beta
152
- const LOGICAL_COMBINATORS: Combinator[];
153
-
154
- // @beta
155
- const NULL_COMBINATOR: Combinator;
156
-
157
- // @beta
158
- type NumberInput = {
159
- input: 'number';
160
- type: 'int' | 'short' | 'double' | 'long' | 'bigdecimal';
161
- validation?: (x: unknown) => string | null;
162
- };
163
-
164
- // @beta (undocumented)
165
- type Operator = UniraryOperator | BinaryOperator | TernararyOperator | VariadicOperator;
166
-
167
- // @beta (undocumented)
168
- type _Operator = {
169
- applyTo: FieldTypes['type'][];
170
- optgroup?: string | null;
171
- type: string;
172
- label?: string;
173
- tooltip?: string;
174
- valueType?: FieldTypes;
175
- };
176
-
177
- // @beta
178
- type Rule = {
179
- field: Field | null;
180
- } & ({
181
- operator: null;
182
- } | {
183
- operator: UniraryOperator;
184
- } | {
185
- operator: BinaryOperator;
186
- value: any;
187
- } | {
188
- operator: TernararyOperator;
189
- value: [any, any];
190
- } | {
191
- operator: VariadicOperator;
192
- value: any[];
193
- });
194
-
195
- // @beta
196
- type SelectInput = {
197
- input: 'select';
198
- type: 'enum';
199
- values: Record<string, string | number | {
200
- label: string;
201
- tooltip?: string;
202
- }>;
203
- };
204
-
205
- // @beta
206
- type Styles = {
207
- customElements?: CustomElements;
208
- customStyles?: CustomStyles;
209
- };
210
-
211
- // @alpha (undocumented)
212
- export const styles: ElementStyles;
213
-
214
- // @alpha (undocumented)
215
- export const template: ViewTemplate<ExpressionBuilder, any>;
216
-
217
- // @beta
218
- type TernararyOperator = {
219
- nbInputs: 2;
220
- } & _Operator;
221
-
222
- // @beta
223
- type TextInput = {
224
- type: 'string';
225
- input: 'text';
226
- validation?: (x: unknown) => string | null;
227
- };
228
-
229
- declare namespace Types {
230
- export {
231
- CustomElements,
232
- CustomStyles,
233
- Styles,
234
- Config_2 as Config,
235
- _Operator,
236
- UniraryOperator,
237
- BinaryOperator,
238
- TernararyOperator,
239
- VariadicOperator,
240
- Operator,
241
- TextInput,
242
- NumberInput,
243
- CheckboxInput,
244
- SelectInput,
245
- DateInput,
246
- DateTimeInput,
247
- FieldTypes,
248
- Field,
249
- Combinator,
250
- Rule,
251
- Group
252
- }
253
- }
254
- export { Types }
255
-
256
- // @beta
257
- type UniraryOperator = {
258
- nbInputs: 0;
259
- } & _Operator;
260
-
261
- // @beta
262
- type VariadicOperator = {
263
- nbInputs: 'many';
264
- } & _Operator;
265
-
266
- // (No @packageDocumentation comment for this package)
267
-
268
- ```