@creatio/base 0.814.0 → 0.815.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 (108) hide show
  1. package/CHANGELOG.md +2 -0
  2. package/esm2020/lib/internal/enums/platform-apis.enum.mjs +2 -1
  3. package/esm2020/lib/internal/model/data-source-config.mjs +1 -1
  4. package/esm2020/lib/public/enums/aggregation-function.enum.mjs +26 -8
  5. package/esm2020/lib/public/enums/aggregation-type.enum.mjs +26 -8
  6. package/esm2020/lib/public/enums/data-schema-type.enum.mjs +12 -2
  7. package/esm2020/lib/public/enums/data-value-type.enum.mjs +123 -1
  8. package/esm2020/lib/public/enums/index.mjs +2 -1
  9. package/esm2020/lib/public/enums/message-channel-type.enum.mjs +11 -0
  10. package/esm2020/lib/public/esq/data-model/columns/arithmetic/arithmetic-query-column.mjs +6 -1
  11. package/esm2020/lib/public/esq/data-model/columns/base-query-column.mjs +15 -1
  12. package/esm2020/lib/public/esq/data-model/columns/entity-column/entity-query-column.mjs +6 -1
  13. package/esm2020/lib/public/esq/data-model/columns/functions/aggregation-function-column.mjs +6 -1
  14. package/esm2020/lib/public/esq/data-model/columns/functions/date-part-function-column.mjs +9 -1
  15. package/esm2020/lib/public/esq/data-model/columns/functions/length-function-column.mjs +6 -1
  16. package/esm2020/lib/public/esq/data-model/columns/functions/macros-function-column.mjs +6 -1
  17. package/esm2020/lib/public/esq/data-model/columns/functions/window-function-column.mjs +6 -1
  18. package/esm2020/lib/public/esq/data-model/columns/parameters/parameter-query-column.mjs +6 -1
  19. package/esm2020/lib/public/esq/data-model/columns/query-column-test-utils.mjs +7 -1
  20. package/esm2020/lib/public/esq/data-model/columns/sub-queries/aggregation-sub-query-column.mjs +6 -1
  21. package/esm2020/lib/public/esq/data-model/columns/sub-queries/sub-query-column.mjs +6 -1
  22. package/esm2020/lib/public/esq/data-model/enums/admin-unit-role-sources.enum.mjs +13 -9
  23. package/esm2020/lib/public/esq/data-model/enums/aggregation-eval-type.enum.mjs +14 -4
  24. package/esm2020/lib/public/esq/data-model/enums/arithmetic-operation.enum.mjs +17 -5
  25. package/esm2020/lib/public/esq/data-model/enums/comparison-type.enum.mjs +73 -1
  26. package/esm2020/lib/public/esq/data-model/enums/date-part-type.enum.mjs +29 -9
  27. package/esm2020/lib/public/esq/data-model/enums/expression-type.enum.mjs +20 -1
  28. package/esm2020/lib/public/esq/data-model/enums/filter-type.enum.mjs +33 -1
  29. package/esm2020/lib/public/esq/data-model/enums/function-type.enum.mjs +29 -8
  30. package/esm2020/lib/public/esq/data-model/enums/logical-operator-type.enum.mjs +11 -1
  31. package/esm2020/lib/public/esq/data-model/enums/order-direction.enum.mjs +14 -1
  32. package/esm2020/lib/public/esq/data-model/enums/query-macros-type.enum.mjs +113 -37
  33. package/esm2020/lib/public/esq/data-model/expressions/arithmetic/arithmetic-expression.mjs +13 -1
  34. package/esm2020/lib/public/esq/data-model/expressions/base-expression.mjs +22 -3
  35. package/esm2020/lib/public/esq/data-model/expressions/columns/column-expression.mjs +13 -1
  36. package/esm2020/lib/public/esq/data-model/expressions/expression-parser/base-expression-parser.mjs +9 -2
  37. package/esm2020/lib/public/esq/data-model/expressions/expression-parser/expression-parser.mjs +4 -3
  38. package/esm2020/lib/public/esq/data-model/expressions/expression-parser/expression-resolver.mjs +10 -3
  39. package/esm2020/lib/public/esq/data-model/expressions/functions/aggregation-function-expression.mjs +10 -1
  40. package/esm2020/lib/public/esq/data-model/expressions/functions/argument-function-expression.mjs +9 -2
  41. package/esm2020/lib/public/esq/data-model/expressions/functions/date-part-function-expression.mjs +10 -1
  42. package/esm2020/lib/public/esq/data-model/expressions/functions/function-expression.mjs +10 -1
  43. package/esm2020/lib/public/esq/data-model/expressions/functions/length-function-expression.mjs +12 -1
  44. package/esm2020/lib/public/esq/data-model/expressions/functions/macros-function-expression.mjs +12 -1
  45. package/esm2020/lib/public/esq/data-model/expressions/functions/window-function-expression.mjs +10 -1
  46. package/esm2020/lib/public/esq/data-model/expressions/mocks/expression.mock.mjs +4 -1
  47. package/esm2020/lib/public/esq/data-model/expressions/parameters/parameter-expression.mjs +12 -1
  48. package/esm2020/lib/public/esq/data-model/expressions/sub-queries/aggregation-sub-query-expression.mjs +7 -1
  49. package/esm2020/lib/public/esq/data-model/expressions/sub-queries/sub-query-expression.mjs +11 -1
  50. package/esm2020/lib/public/esq/data-model/filters/base-filter.mjs +19 -1
  51. package/esm2020/lib/public/esq/data-model/filters/between-filter.mjs +8 -3
  52. package/esm2020/lib/public/esq/data-model/filters/compare-filter.mjs +7 -2
  53. package/esm2020/lib/public/esq/data-model/filters/exists-filter.mjs +16 -2
  54. package/esm2020/lib/public/esq/data-model/filters/filter-group.mjs +59 -12
  55. package/esm2020/lib/public/esq/data-model/filters/filter-parser/base-filter-parser.mjs +7 -2
  56. package/esm2020/lib/public/esq/data-model/filters/filter-parser/filter-parser.mjs +6 -2
  57. package/esm2020/lib/public/esq/data-model/filters/filter-parser/filter-resolver.mjs +8 -2
  58. package/esm2020/lib/public/esq/data-model/filters/filter-test-utils.mjs +7 -1
  59. package/esm2020/lib/public/esq/data-model/filters/in-filter.mjs +10 -3
  60. package/esm2020/lib/public/esq/data-model/filters/isnull-filter.mjs +11 -2
  61. package/esm2020/lib/public/esq/data-model/filters/mocks/parser.mock.mjs +4 -1
  62. package/esm2020/lib/public/esq/data-model/filters/single-filter.mjs +8 -2
  63. package/esm2020/lib/public/esq/data-model/metadata-provider/metadata-provider.mjs +1 -1
  64. package/esm2020/lib/public/esq/data-model/queries/base-filterable-query.mjs +11 -1
  65. package/esm2020/lib/public/esq/data-model/queries/base-query.mjs +3 -1
  66. package/esm2020/lib/public/esq/data-model/queries/delete-query.mjs +3 -1
  67. package/esm2020/lib/public/esq/data-model/queries/entity-schema-query.mjs +39 -18
  68. package/esm2020/lib/public/esq/data-model/queries/insert-query.mjs +14 -2
  69. package/esm2020/lib/public/esq/data-model/queries/query-operation-type.mjs +14 -1
  70. package/esm2020/lib/public/esq/data-model/queries/select-localization-query.mjs +3 -1
  71. package/esm2020/lib/public/esq/data-model/queries/update-query.mjs +16 -3
  72. package/esm2020/lib/public/exceptions/argument-empty-exception.mjs +6 -1
  73. package/esm2020/lib/public/exceptions/argument-out-of-range-exception.mjs +6 -1
  74. package/esm2020/lib/public/exceptions/item-not-found-exception.mjs +6 -1
  75. package/esm2020/lib/public/exceptions/next-handler-already-specified-exception.mjs +2 -1
  76. package/esm2020/lib/public/exceptions/validation-utilities.mjs +35 -1
  77. package/esm2020/lib/public/interfaces/serializable.mjs +1 -1
  78. package/esm2020/lib/public/models/data-source/data-source-insert-result.model.mjs +1 -1
  79. package/esm2020/lib/public/models/index.mjs +2 -1
  80. package/esm2020/lib/public/models/lookup-value.model.mjs +1 -1
  81. package/esm2020/lib/public/models/message-channel-event.mjs +2 -0
  82. package/esm2020/lib/public/models/request/base-request.mjs +2 -3
  83. package/esm2020/lib/public/models/view-model-context.mjs +1 -1
  84. package/esm2020/lib/public/services/mask-service/schema-view-mask.request.mjs +10 -1
  85. package/esm2020/lib/public/services/model/base-model.mjs +1 -1
  86. package/esm2020/lib/public/services/model/data-schema-attribute.mjs +1 -1
  87. package/esm2020/lib/public/services/model/data-schema.mjs +1 -1
  88. package/esm2020/lib/public/services/model/data-source-aggregation-config.mjs +1 -1
  89. package/esm2020/lib/public/services/model/data-source-attribute.mjs +1 -1
  90. package/esm2020/lib/public/services/model/data-source-can-execute-operation.mjs +1 -1
  91. package/esm2020/lib/public/services/model/data-source-function-config.mjs +1 -1
  92. package/esm2020/lib/public/services/model/data-source-paging-config.mjs +1 -1
  93. package/esm2020/lib/public/services/model/data-source-parameter.mjs +26 -1
  94. package/esm2020/lib/public/services/model/data-source-sorting-config.mjs +1 -1
  95. package/esm2020/lib/public/services/model/model-load-options.mjs +1 -1
  96. package/esm2020/lib/public/services/sys-settings/base-sys-settings.service.mjs +1 -1
  97. package/esm2020/lib/public/types/aggregation-eval.type.mjs +1 -1
  98. package/esm2020/lib/public/types/entity-column-value.mjs +1 -1
  99. package/esm2020/lib/public/types/guid.type.mjs +7 -7
  100. package/esm2020/lib/public/types/index.mjs +2 -1
  101. package/esm2020/lib/public/types/json-data.type.mjs +1 -1
  102. package/esm2020/lib/public/types/teardown-logic.type.mjs +2 -0
  103. package/fesm2015/creatio-base.mjs +1128 -138
  104. package/fesm2015/creatio-base.mjs.map +1 -1
  105. package/fesm2020/creatio-base.mjs +1128 -140
  106. package/fesm2020/creatio-base.mjs.map +1 -1
  107. package/index.d.ts +1665 -151
  108. package/package.json +3 -2
package/index.d.ts CHANGED
@@ -1,38 +1,50 @@
1
+ /**
2
+ * @public
3
+ * @description Base configuration for function attribute.
4
+ */
1
5
  declare interface BaseDataSourceFunctionConfig {
6
+ /**
7
+ * @public
8
+ * @description Type of function.
9
+ */
2
10
  type: ɵFunctionStringType;
3
11
  }
4
12
 
13
+ /**
14
+ * @public
15
+ * @description SysAdminUnitInRole source type.
16
+ */
5
17
  export declare enum eAdminUnitRoleSources {
6
18
  /**
7
- * Empty value.
19
+ * @description Empty value.
8
20
  */
9
21
  None = 0,
10
22
  /**
11
- * Self.
23
+ * @description Self.
12
24
  */
13
25
  Self = 1,
14
26
  /**
15
- * Explicit entry into role.
27
+ * @description Explicit entry into role.
16
28
  */
17
29
  ExplicitEntry = 2,
18
30
  /**
19
- * Delegated role.
31
+ * @description Delegated role.
20
32
  */
21
33
  Delegated = 4,
22
34
  /**
23
- * Gets functional role from organizational role.
35
+ * @description Gets functional role from organizational role.
24
36
  */
25
37
  FuncRoleFromOrgRole = 8,
26
38
  /**
27
- * Gets role up hierarchy from role.
39
+ * @description Gets role up hierarchy from role.
28
40
  */
29
41
  UpHierarchy = 16,
30
42
  /**
31
- * Gets role as a manager.
43
+ * @description Gets role as a manager.
32
44
  */
33
45
  AsManager = 32,
34
46
  /**
35
- * Gets all roles.
47
+ * @description Gets all roles.
36
48
  */
37
49
  All = 63
38
50
  }
@@ -47,43 +59,94 @@ export declare enum eAdminUnitRoleSources {
47
59
  */
48
60
  export declare type ɵAbstractType<T = any> = abstract new (...args: any[]) => T;
49
61
 
62
+ /**
63
+ * @public
64
+ * @description Types of aggregation to evaluate.
65
+ */
50
66
  export declare type ɵAggregationEval = 'all' | 'distinct' | 'none';
51
67
 
68
+ /**
69
+ * @public
70
+ * @description Scope of the aggregation function.
71
+ */
52
72
  export declare enum ɵAggregationEvalType {
53
- /** The scope of the aggregating function is not defined. */
73
+ /**
74
+ * @description The scope of the aggregating function is not defined.
75
+ */
54
76
  None = 0,
55
- /** Applies to all elements. */
77
+ /**
78
+ * @description Applies to all elements.
79
+ */
56
80
  All = 1,
57
- /** Applies to unique values. */
81
+ /**
82
+ * @description Applies to unique values.
83
+ */
58
84
  Distinct = 2
59
85
  }
60
86
 
87
+ /**
88
+ * @public
89
+ * The type of the aggregation function (can be set to None).
90
+ */
61
91
  export declare enum ɵAggregationFunction {
62
- /** Aggregation function type not defined. */
92
+ /**
93
+ * @description Aggregation function type not defined.
94
+ */
63
95
  None = "",
64
- /** Aggregation function type not defined. */
96
+ /**
97
+ * @description Aggregation function type not defined.
98
+ */
65
99
  Count = "Count",
66
- /** Sum of values of all elements. */
100
+ /**
101
+ * @description Sum of values of all elements.
102
+ */
67
103
  Sum = "Sum",
68
- /** Average value for all elements. */
104
+ /**
105
+ * @description Average value for all elements.
106
+ */
69
107
  Avg = "Avg",
70
- /** The minimum value among all elements. */
108
+ /**
109
+ * @description The minimum value among all elements.
110
+ */
71
111
  Min = "Min",
72
- /** The maximum value among all elements. */
112
+ /**
113
+ * @description The maximum value among all elements.
114
+ */
73
115
  Max = "Max",
74
- /** Top one record from collection. */
116
+ /**
117
+ * @description Top one record from collection.
118
+ */
75
119
  TopOne = "TopOne"
76
120
  }
77
121
 
122
+ /**
123
+ * @public
124
+ * @classdesc Class contains info about column with aggregation function.
125
+ * @extends {ɵBaseQueryColumn}
126
+ */
78
127
  export declare class ɵAggregationFunctionColumn extends ɵBaseQueryColumn<ɵAggregationFunctionExpression> {
79
128
  constructor(aggregationType: ɵAggregationType, aggregationEvalType: ɵAggregationEvalType, functionArgument: ɵBaseExpression);
80
129
  }
81
130
 
131
+ /**
132
+ * @public
133
+ * @description A class that describes expression with aggregate function.
134
+ * @extends {ɵArgumentFunctionExpression}
135
+ */
82
136
  export declare class ɵAggregationFunctionExpression extends ɵArgumentFunctionExpression {
83
137
  /* Excluded from this release type: _instanceOfKey */
84
138
  /* Excluded from this release type: _instanceOfKeys */
139
+ /**
140
+ * @description The type of the functional expression passed for initialization.
141
+ */
85
142
  readonly functionType: ɵFunctionType;
143
+ /**
144
+ * @description Aggregation type.
145
+ */
86
146
  readonly aggregationType: ɵAggregationType;
147
+ /**
148
+ * @description The scope of the aggregating function.
149
+ */
87
150
  readonly aggregationEvalType: ɵAggregationEvalType;
88
151
  constructor(config: ɵAggregationFunctionExpressionConfig);
89
152
  /**
@@ -91,19 +154,40 @@ export declare class ɵAggregationFunctionExpression extends ɵArgumentFunctionE
91
154
  * @public
92
155
  */
93
156
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser?: TExpressionParser): ɵAggregationFunctionExpression;
157
+ /** {@inheritDoc ɵBaseExpression.clone} */
94
158
  clone(): ɵAggregationFunctionExpression;
95
159
  }
96
160
 
161
+ /**
162
+ * @public
163
+ * @description Configuration for aggregation function expression.
164
+ */
97
165
  export declare type ɵAggregationFunctionExpressionConfig = ɵArgumentFunctionExpressionConfig<ɵAggregationFunctionExpression> & Pick<ɵAggregationFunctionExpression, 'aggregationType' | 'aggregationEvalType'>;
98
166
 
167
+ /**
168
+ * @public
169
+ * @classdesc Class contains info about column with sub query and aggregation.
170
+ * @extends {ɵBaseQueryColumn}
171
+ */
99
172
  export declare class ɵAggregationSubQueryColumn extends ɵBaseQueryColumn<ɵAggregationSubQueryExpression> {
100
173
  constructor(columnPath: string, aggregationType: ɵAggregationType, subFilters?: ɵFilterGroup, subOrderDirection?: number, subOrderColumn?: string);
101
174
  }
102
175
 
176
+ /**
177
+ * @public
178
+ * @description A class that describes expression with aggregation sub query.
179
+ * @extends {ɵSubQueryExpression}
180
+ */
103
181
  export declare class ɵAggregationSubQueryExpression extends ɵSubQueryExpression {
104
182
  /* Excluded from this release type: _instanceOfKey */
105
183
  /* Excluded from this release type: _instanceOfKeys */
184
+ /**
185
+ * @description Aggregation type.
186
+ */
106
187
  readonly aggregationType: ɵAggregationType;
188
+ /**
189
+ * @description Function type.
190
+ */
107
191
  readonly functionType?: ɵFunctionType;
108
192
  constructor(config: ɵAggregationSubQueryExpressionConfig);
109
193
  /**
@@ -111,54 +195,122 @@ export declare class ɵAggregationSubQueryExpression extends ɵSubQueryExpressio
111
195
  * @public
112
196
  */
113
197
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser>(dto: ɵJsonObject, filterParser: TFilterParser): ɵAggregationSubQueryExpression;
198
+ /** {@inheritDoc ɵBaseExpression.clone} */
114
199
  clone(): ɵAggregationSubQueryExpression;
115
200
  }
116
201
 
202
+ /**
203
+ * @public
204
+ * @description Configuration for aggregation in sub query expression.
205
+ */
117
206
  export declare type ɵAggregationSubQueryExpressionConfig = ɵSubQueryExpressionConfig & Pick<ɵAggregationSubQueryExpression, 'aggregationType'> & Pick<ɵAggregationSubQueryExpression, 'functionType'>;
118
207
 
208
+ /**
209
+ * @public
210
+ * The type of the aggregation (can be set to None).
211
+ */
119
212
  export declare enum ɵAggregationType {
120
- /** Aggregation function type not defined. */
213
+ /**
214
+ * @description Aggregation function type not defined.
215
+ */
121
216
  None = 0,
122
- /** Aggregation function type not defined. */
217
+ /**
218
+ * @description Aggregation function type not defined.
219
+ */
123
220
  Count = 1,
124
- /** Sum of values of all elements. */
221
+ /**
222
+ * @description Sum of values of all elements.
223
+ */
125
224
  Sum = 2,
126
- /** Average value for all elements. */
225
+ /**
226
+ * @description Average value for all elements.
227
+ */
127
228
  Avg = 3,
128
- /** The minimum value among all elements. */
229
+ /**
230
+ * @description The minimum value among all elements.
231
+ */
129
232
  Min = 4,
130
- /** The maximum value among all elements. */
233
+ /**
234
+ * @description The maximum value among all elements.
235
+ */
131
236
  Max = 5,
132
- /** Top one record from collection. */
237
+ /**
238
+ * @description Top one record from collection.
239
+ */
133
240
  TopOne = 6
134
241
  }
135
242
 
243
+ /**
244
+ * @public
245
+ * @description The exception thrown when trying to pass an empty or null argument.
246
+ * @extends {Error}
247
+ */
136
248
  export declare class ɵArgumentEmptyException extends Error {
137
249
  constructor(argumentName: string);
138
250
  }
139
251
 
252
+ /**
253
+ * @public
254
+ * @abstract
255
+ * @description A class that describes a functional expression with argument.
256
+ * @extends {ɵFunctionExpression}
257
+ */
140
258
  export declare abstract class ɵArgumentFunctionExpression extends ɵFunctionExpression {
141
259
  /* Excluded from this release type: _instanceOfKey */
142
260
  /* Excluded from this release type: _instanceOfKeys */
261
+ /**
262
+ * @description Expression argument.
263
+ */
143
264
  readonly functionArgument: ɵBaseExpression;
144
265
  protected constructor(config: ɵArgumentFunctionExpressionConfig<ɵArgumentFunctionExpression>);
266
+ /**
267
+ * @public
268
+ * @description Abstract method to create cloned instance.
269
+ */
145
270
  abstract clone(): ɵArgumentFunctionExpression;
271
+ /** {@inheritDoc ɵBaseExpression.toJson} */
146
272
  toJson(): ɵJsonObject;
147
273
  /* Excluded from this release type: _getUsedColumns */
148
274
  }
149
275
 
276
+ /**
277
+ * @public
278
+ * @description Configuration for function wih argument expression.
279
+ */
150
280
  export declare type ɵArgumentFunctionExpressionConfig<TExpression extends ɵArgumentFunctionExpression> = ɵFunctionExpressionConfig<TExpression> & Pick<ɵArgumentFunctionExpression, 'functionArgument'>;
151
281
 
282
+ /**
283
+ * @public
284
+ * @description The exception thrown when trying to pass argument that not in range.
285
+ * @extends {Error}
286
+ */
152
287
  export declare class ɵArgumentOutOfRangeException extends Error {
153
288
  constructor(argumentName: string);
154
289
  }
155
290
 
291
+ /**
292
+ * @public
293
+ * @description Arithmetic expression.
294
+ * @extends {ɵBaseExpression}
295
+ */
156
296
  export declare class ɵArithmeticExpression extends ɵBaseExpression {
157
297
  /* Excluded from this release type: _instanceOfKey */
158
298
  /* Excluded from this release type: _instanceOfKeys */
299
+ /**
300
+ * @description Expression type. Default 'ArithmeticOperation'.
301
+ */
159
302
  readonly expressionType: ɵExpressionType;
303
+ /**
304
+ * @description Operation.
305
+ */
160
306
  readonly arithmeticOperation: ɵArithmeticOperation;
307
+ /**
308
+ * @description Left operand expression.
309
+ */
161
310
  readonly leftArithmeticOperand: ɵBaseExpression;
311
+ /**
312
+ * @description Right operand expression.
313
+ */
162
314
  readonly rightArithmeticOperand: ɵBaseExpression;
163
315
  constructor(config: ɵArithmeticExpressionConfig);
164
316
  /**
@@ -166,23 +318,48 @@ export declare class ɵArithmeticExpression extends ɵBaseExpression {
166
318
  * @public
167
319
  */
168
320
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser?: TExpressionParser): ɵArithmeticExpression;
321
+ /**
322
+ * @public
323
+ * @description Clones instance.
324
+ */
169
325
  clone(): ɵArithmeticExpression;
170
326
  /* Excluded from this release type: _getUsedColumns */
171
327
  }
172
328
 
329
+ /**
330
+ * @public
331
+ * @description Config used for arithmetic expression
332
+ */
173
333
  export declare type ɵArithmeticExpressionConfig = ɵExpressionConfig<ɵArithmeticExpression> & Pick<ɵArithmeticExpression, 'arithmeticOperation' | 'leftArithmeticOperand' | 'rightArithmeticOperand'>;
174
334
 
335
+ /**
336
+ * @public
337
+ * @description Arithmetic operation.
338
+ */
175
339
  export declare enum ɵArithmeticOperation {
176
- /** Addition. */
340
+ /**
341
+ * @description Addition.
342
+ */
177
343
  Addition = 0,
178
- /** Subtraction. */
344
+ /**
345
+ * @description Subtraction.
346
+ */
179
347
  Subtraction = 1,
180
- /** Multiplication. */
348
+ /**
349
+ * @description Multiplication.
350
+ */
181
351
  Multiplication = 2,
182
- /** Division. */
352
+ /**
353
+ * @description Division.
354
+ */
183
355
  Division = 3
184
356
  }
185
357
 
358
+ /**
359
+ * @public
360
+ * @classdesc Class contains info about column with arithmetic operation.
361
+ * @extends {ɵBaseQueryColumn}
362
+ */
186
363
  export declare class ɵArithmeticQueryColumn extends ɵBaseQueryColumn<ɵArithmeticExpression> {
187
364
  constructor(arithmeticOperation: ɵArithmeticOperation, leftArithmeticOperand: ɵBaseExpression, rightArithmeticOperand: ɵBaseExpression);
188
365
  }
@@ -196,10 +373,23 @@ declare interface ɵBaseDataSchemaAttributeFunctionConfig {
196
373
 
197
374
  /**
198
375
  * @public
376
+ * @description Base interface for data source parameters.
199
377
  */
200
378
  export declare interface ɵBaseDataSourceParameter {
379
+ /**
380
+ * @public
381
+ * @description Type of parameter.
382
+ */
201
383
  type: ɵModelParameterType;
384
+ /**
385
+ * @public
386
+ * @description Value of parameter.
387
+ */
202
388
  value: any;
389
+ /**
390
+ * @public
391
+ * @description Optional relation configurations for parameter.
392
+ */
203
393
  relationsConfigs?: ɵDataSourceParameterRelationConfig[];
204
394
  }
205
395
 
@@ -254,42 +444,95 @@ export declare interface ɵBaseDialogService<TConfig extends ɵBaseDialogConfig
254
444
  open(config: TConfig): Promise<string>;
255
445
  }
256
446
 
447
+ /**
448
+ * @public
449
+ * @abstract
450
+ * @description The base class of the expression.
451
+ * @extends {ɵSerializable}
452
+ */
257
453
  export declare abstract class ɵBaseExpression implements ɵSerializable {
258
454
  /* Excluded from this release type: _instanceOfKey */
259
455
  /* Excluded from this release type: _instanceOfKeys */
456
+ /**
457
+ * @description True if expression has brackets.
458
+ */
260
459
  readonly isBlock: boolean;
460
+ /**
461
+ * @public
462
+ * @description Method for checking if an instance is of the current class type.
463
+ * @param instance - The instance to check.
464
+ * @returns `true` if the instance is of the current class type, `false` otherwise.
465
+ */
261
466
  static [Symbol.hasInstance](instance: ɵBaseExpression): boolean;
467
+ /**
468
+ * @description Type of expression
469
+ */
262
470
  abstract readonly expressionType: ɵExpressionType;
263
471
  protected constructor(config: ɵExpressionConfig<ɵBaseExpression>);
264
472
  /**
265
- * Parses expression from json.
266
473
  * @public
474
+ * @description Parses expression from json.
267
475
  */
268
476
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser?: TExpressionParser): ɵBaseExpression;
477
+ /**
478
+ * @description Converts instance to json object.
479
+ * @param item - The instance to serialize.
480
+ */
269
481
  protected serializeItem(item: ɵSerializable): ɵJsonObject;
482
+ /**
483
+ * @description Abstract method to create cloned instance.
484
+ */
270
485
  abstract clone(): ɵBaseExpression;
271
486
  /**
272
- * Converts instance to json object.
273
487
  * @public
488
+ * @description Converts instance to json object.
274
489
  */
275
490
  toJson(): ɵJsonObject;
276
491
  /* Excluded from this release type: _getUsedColumns */
277
492
  }
278
493
 
279
494
  /**
280
- * Expression parser interface
281
495
  * @public
496
+ * @description Expression parser interface.
282
497
  */
283
498
  export declare class ɵBaseExpressionParser {
499
+ /**
500
+ * @public
501
+ * @description Parses filter from json.
502
+ * @param dto - Serialized object.
503
+ * @param filterParser - Type of parser.
504
+ * @return InstanceType of expression.
505
+ */
284
506
  static fromJson(dto: ɵJsonObject, filterParser: typeof ɵBaseFilterParser): unknown;
285
507
  }
286
508
 
509
+ /**
510
+ * @public
511
+ * @abstract
512
+ * @description The base class of the filter.
513
+ * @extends {ɵSerializable}
514
+ */
287
515
  export declare abstract class ɵBaseFilter implements ɵSerializable {
288
516
  /* Excluded from this release type: _instanceOfKey */
289
517
  /* Excluded from this release type: _instanceOfKeys */
518
+ /**
519
+ * @description Type of filter.
520
+ */
290
521
  readonly filterType: ɵFilterType;
522
+ /**
523
+ * @description Indicates that the filter is active and will be taken into account when building the query.
524
+ */
291
525
  isEnabled: boolean;
526
+ /**
527
+ * @description Drop the time for the date / time type parameters.
528
+ */
292
529
  trimDateTimeParameterToDate: boolean;
530
+ /**
531
+ * @public
532
+ * @description Method for checking if an instance is of the current class type.
533
+ * @param instance - The instance to check.
534
+ * @returns `true` if the instance is of the current class type, `false` otherwise.
535
+ */
293
536
  static [Symbol.hasInstance](instance: ɵBaseFilter): boolean;
294
537
  protected constructor(filterType: ɵFilterType);
295
538
  /**
@@ -298,6 +541,10 @@ export declare abstract class ɵBaseFilter implements ɵSerializable {
298
541
  */
299
542
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵBaseFilter;
300
543
  protected serializeItem(item: ɵSerializable): ɵJsonObject;
544
+ /**
545
+ * @public
546
+ * @description Clones instance.
547
+ */
301
548
  abstract clone(): ɵBaseFilter;
302
549
  /**
303
550
  * Converts instance to json object.
@@ -309,20 +556,35 @@ export declare abstract class ɵBaseFilter implements ɵSerializable {
309
556
 
310
557
  /**
311
558
  * @public
559
+ * @description The base class of the filtered data request.
560
+ * @extends {ɵBaseQuery}
312
561
  */
313
562
  export declare abstract class ɵBaseFilterableQuery extends ɵBaseQuery {
563
+ /**
564
+ * @description Collection of filters.
565
+ */
314
566
  readonly filters: ɵFilterGroup;
315
567
  protected constructor(operationType: ɵQueryOperationType, rootSchemaName: string);
568
+ /**
569
+ * @public
570
+ * @description Clears all filters.
571
+ */
316
572
  clearFilters(): void;
573
+ /** {@inheritDoc ɵMetadataProvider.getMetadata} */
317
574
  getMetadata(): Record<string, unknown>;
318
575
  /* Excluded from this release type: _getUsedColumns */
319
576
  }
320
577
 
321
578
  /**
322
- * Filter parser interface
323
579
  * @public
580
+ * @description Filter parser interface.
324
581
  */
325
582
  export declare class ɵBaseFilterParser {
583
+ /**
584
+ * @description Creates filter from JSON.
585
+ * @param dto - Serialized filter.
586
+ * @return Instance of filter.
587
+ */
326
588
  static fromJson(dto: ɵJsonObject): unknown;
327
589
  }
328
590
 
@@ -355,37 +617,101 @@ export declare interface ɵBaseMaskService {
355
617
  hideFullScreenMask(taskName: string): Promise<void>;
356
618
  }
357
619
 
620
+ /**
621
+ * @public
622
+ * @description Base class of the model.
623
+ */
358
624
  export declare interface ɵBaseModel<TLoadOptions extends ɵDataSourceLoadOptions> {
625
+ /**
626
+ * @public
627
+ * @description Async method to return data schema.
628
+ */
359
629
  getSchema(): Promise<ɵDataSchema>;
630
+ /**
631
+ * @description Abstract async method to load data.
632
+ * @param {{}} config - Load config.
633
+ */
360
634
  load(config?: {
361
635
  attributes?: string[] | ɵDataSourceAttribute[];
362
636
  parameters?: ɵDataSourceParameters;
363
637
  loadOptions?: TLoadOptions;
364
638
  }): Promise<ɵJsonArray>;
639
+ /**
640
+ * @description Abstract async method to insert record.
641
+ * @param {ɵJsonObject} dto - Serialized object.
642
+ */
365
643
  insert(dto: ɵJsonObject): Promise<ɵDataSourceSaveResult>;
644
+ /**
645
+ * @description Abstract async method to update record.
646
+ * @param {ɵJsonObject} dto - Serialized object.
647
+ * @param {ɵDataSourceParameters} parameters - Values.
648
+ */
366
649
  update(dto: ɵJsonObject, parameters: ɵDataSourceParameters): Promise<ɵDataSourceSaveResult>;
650
+ /**
651
+ * @description Abstract async method to copy record.
652
+ * @param {string} primaryColumnValue - primary value.
653
+ * @param {ɵJsonObject} data - Serialized object.
654
+ */
367
655
  copy(primaryColumnValue: string, data: ɵJsonObject): Promise<ɵJsonObject>;
656
+ /**
657
+ * @description Abstract async method to create record.
658
+ * @param {ɵJsonObject} data - Serialized object.
659
+ */
368
660
  create(data: ɵJsonObject): Promise<ɵJsonObject>;
661
+ /**
662
+ * @description Abstract async method to delete record.
663
+ * @param {ɵDataSourceParameters} parameters - parameters.
664
+ */
369
665
  delete(parameters: ɵDataSourceParameters): Promise<ɵDataSourceSaveResult>;
666
+ /**
667
+ * @description Abstract async method to check if model data can be saved.
668
+ * @param {ɵDataSourceCanExecuteOperationPayload} params - Parameters.
669
+ */
370
670
  canSave(params: ɵDataSourceCanExecuteOperationPayload): Promise<ɵDataSourceCanExecuteOperationResult>;
671
+ /**
672
+ * @description Abstract async method to check if record can be deleted.
673
+ * @param {ɵDataSourceCanExecuteOperationPayload} params - Parameters.
674
+ */
371
675
  canDelete(params: ɵDataSourceCanExecuteOperationPayload): Promise<ɵDataSourceCanExecuteOperationResult>;
372
676
  }
373
677
 
374
678
  /**
375
679
  * @public
680
+ * @description The base class of the data request. Implements {@link ɵMetadataProvider}
376
681
  */
377
682
  export declare abstract class ɵBaseQuery implements ɵMetadataProvider<Record<string, unknown>> {
378
683
  readonly operationType: ɵQueryOperationType;
379
684
  readonly rootSchemaName: string;
380
685
  protected constructor(operationType: ɵQueryOperationType, rootSchemaName: string);
686
+ /** {@inheritDoc ɵMetadataProvider.getMetadata} */
381
687
  getMetadata(): Record<string, unknown>;
382
688
  }
383
689
 
690
+ /**
691
+ * @public
692
+ * @abstract
693
+ * @classdesc Class contains info about column for query.
694
+ */
384
695
  export declare abstract class ɵBaseQueryColumn<TExpression extends ɵBaseExpression = ɵBaseExpression> {
696
+ /**
697
+ * @description Order direction.
698
+ */
385
699
  orderDirection: ɵOrderDirection;
700
+ /**
701
+ * @description Column order position.
702
+ */
386
703
  orderPosition: number;
704
+ /**
705
+ * @description If true then column data will be present in the result set.
706
+ */
387
707
  isVisible: boolean;
708
+ /**
709
+ * @description Column caption.
710
+ */
388
711
  caption?: string;
712
+ /**
713
+ * @description Column expression.
714
+ */
389
715
  readonly expression: TExpression;
390
716
  protected constructor(expression: TExpression);
391
717
  /**
@@ -414,29 +740,29 @@ export declare abstract class ɵBaseQueryColumn<TExpression extends ɵBaseExpres
414
740
 
415
741
  /**
416
742
  * @public
417
- * @class ɵBaseRequest
418
- * @describe Base definition of request.
743
+ * @description Base definition of request.
419
744
  * @template TEvent
420
745
  */
421
746
  export declare class ɵBaseRequest<TEvent = unknown> {
422
747
  /**
423
- * The type of request.
748
+ * @public
749
+ * @description The type of request.
424
750
  * @example
425
751
  * 'crt.RequestType'
426
752
  */
427
753
  readonly type: string;
428
754
  /**
429
755
  * @deprecated use event binding expression instead.
430
- *
431
- * The target event from which this request originated.
432
756
  */
433
757
  readonly $initialEvent?: TEvent;
434
758
  /**
435
- * The context in which the requests were triggered.
759
+ * @public
760
+ * @description The context in which the requests were triggered.
436
761
  */
437
762
  readonly $context: ɵViewModelContext;
438
763
  /**
439
- * The scope of the request.
764
+ * @public
765
+ * @description The scope of the request.
440
766
  */
441
767
  scopes?: string[];
442
768
  }
@@ -447,17 +773,29 @@ export declare class ɵBaseRequest<TEvent = unknown> {
447
773
  */
448
774
  export declare interface ɵBaseSysSettingsService {
449
775
  /**
450
- * Returns value of the specified system setting.
776
+ * @public
777
+ * @description Returns value of the specified system setting.
451
778
  * @param sysSettingCode Code of system setting.
452
779
  * @param defaultValue Default value to be used if system setting has no value.
453
780
  */
454
781
  getValueByCode<T>(sysSettingCode: string, defaultValue?: T): Promise<T>;
455
782
  }
456
783
 
784
+ /**
785
+ * @public
786
+ * @description Filter class of the "Between" type.
787
+ * @extends {ɵSingleFilter}
788
+ */
457
789
  export declare class ɵBetweenFilter extends ɵSingleFilter {
458
790
  /* Excluded from this release type: _instanceOfKey */
459
791
  /* Excluded from this release type: _instanceOfKeys */
792
+ /**
793
+ * @description The initial expression of the filtering range.
794
+ */
460
795
  readonly rightLessExpression: ɵBaseExpression;
796
+ /**
797
+ * @description The final expression of the filtering range.
798
+ */
461
799
  readonly rightGreaterExpression: ɵBaseExpression;
462
800
  constructor(leftExpression: ɵBaseExpression, rightLessExpression: ɵBaseExpression, rightGreaterExpression: ɵBaseExpression);
463
801
  /**
@@ -476,26 +814,53 @@ export declare class ɵBetweenFilter extends ɵSingleFilter {
476
814
  */
477
815
  export declare type ɵButtonColor = 'primary' | 'accent' | 'warn' | 'default';
478
816
 
817
+ /**
818
+ * @public
819
+ * @description A class that defines an expression of type column EntitySchema.
820
+ * @extends {ɵBaseExpression}
821
+ */
479
822
  export declare class ɵColumnExpression extends ɵBaseExpression {
480
823
  /* Excluded from this release type: _instanceOfKey */
481
824
  /* Excluded from this release type: _instanceOfKeys */
825
+ /**
826
+ * @description Type of expression.
827
+ */
482
828
  readonly expressionType: ɵExpressionType;
829
+ /**
830
+ * @description The path to the column is relative to root schema. Elements of the path are separated by a dot.
831
+ */
483
832
  columnPath: string;
484
833
  constructor(config: ɵColumnExpressionConfig);
485
834
  /**
486
835
  * Parses expression from json.
487
836
  * @public
837
+ * @param dto - Serialized object.
488
838
  */
489
839
  static fromJson(dto: ɵJsonObject): ɵColumnExpression;
840
+ /**
841
+ * @description Clones instance.
842
+ */
490
843
  clone(): ɵColumnExpression;
491
844
  /* Excluded from this release type: _getUsedColumns */
492
845
  }
493
846
 
847
+ /**
848
+ * @public
849
+ * @description Configuration of expression of type column EntitySchema.
850
+ */
494
851
  export declare type ɵColumnExpressionConfig = ɵExpressionConfig<ɵColumnExpression> & Pick<ɵColumnExpression, 'columnPath'>;
495
852
 
853
+ /**
854
+ * @public
855
+ * @description Comparison filter class.
856
+ * @extends {ɵSingleFilter}
857
+ */
496
858
  export declare class ɵCompareFilter extends ɵSingleFilter {
497
859
  /* Excluded from this release type: _instanceOfKey */
498
860
  /* Excluded from this release type: _instanceOfKeys */
861
+ /**
862
+ * @description Filter expression.
863
+ */
499
864
  readonly rightExpression: ɵBaseExpression;
500
865
  constructor(comparisonType: ɵComparisonType, leftExpression: ɵBaseExpression, rightExpression: ɵBaseExpression);
501
866
  /**
@@ -508,28 +873,112 @@ export declare class ɵCompareFilter extends ɵSingleFilter {
508
873
  /* Excluded from this release type: _getUsedColumns */
509
874
  }
510
875
 
876
+ /**
877
+ * @public
878
+ * @description The type of comparison operation in the filter.
879
+ */
511
880
  export declare enum ɵComparisonType {
881
+ /**
882
+ * @public
883
+ * @description Value is between two specified values.
884
+ */
512
885
  Between = 0,
886
+ /**
887
+ * @public
888
+ * @description Value contains a specified substring.
889
+ */
513
890
  Contain = 11,
891
+ /**
892
+ * @public
893
+ * @description Value ends with a specified substring.
894
+ */
514
895
  End_with = 13,
896
+ /**
897
+ * @public
898
+ * @description Value is equal to a specified value.
899
+ */
515
900
  Equal = 3,
901
+ /**
902
+ * @public
903
+ * @description Value exists (is not null or undefined).
904
+ */
516
905
  Exists = 15,
906
+ /**
907
+ * @public
908
+ * @description Value is greater than a specified value.
909
+ */
517
910
  Greater = 7,
911
+ /**
912
+ * @public
913
+ * @description Value is greater than or equal to a specified value.
914
+ */
518
915
  Greater_or_equal = 8,
916
+ /**
917
+ * @public
918
+ * @description Value is not null.
919
+ */
519
920
  Is_not_null = 2,
921
+ /**
922
+ * @public
923
+ * @description Value is null.
924
+ */
520
925
  Is_null = 1,
926
+ /**
927
+ * @public
928
+ * @description Value is less than a specified value.
929
+ */
521
930
  Less = 5,
931
+ /**
932
+ * @public
933
+ * @description Value is less than or equal to a specified value.
934
+ */
522
935
  Less_or_equal = 6,
936
+ /**
937
+ * @public
938
+ * @description Value does not contain a specified substring.
939
+ */
523
940
  Not_contain = 12,
941
+ /**
942
+ * @public
943
+ * @description Value does not end with a specified substring.
944
+ */
524
945
  Not_end_with = 14,
946
+ /**
947
+ * @public
948
+ * @description Value is not equal to a specified value.
949
+ */
525
950
  Not_equal = 4,
951
+ /**
952
+ * @public
953
+ * @description Value does not exist (is null or undefined).
954
+ */
526
955
  Not_exists = 16,
956
+ /**
957
+ * @public
958
+ * @description Value does not start with a specified substring.
959
+ */
527
960
  Not_start_with = 10,
961
+ /**
962
+ * @public
963
+ * @description Value starts with a specified substring.
964
+ */
528
965
  Start_with = 9
529
966
  }
530
967
 
968
+ /**
969
+ * @public
970
+ * @description Interface for condition with expression and parameter.
971
+ * @property {ɵExpressionType} expressionType - Type of expression.
972
+ * @property {Record<string, unknown>=} parameter - Parameter.
973
+ */
531
974
  export declare interface ɵConditionalValueItem {
975
+ /**
976
+ * @description Type of expression.
977
+ */
532
978
  expressionType: ɵExpressionType;
979
+ /**
980
+ * @description Parameter.
981
+ */
533
982
  parameter: {
534
983
  dataValueType: ɵDataValueType;
535
984
  value: string;
@@ -548,6 +997,9 @@ export declare interface ɵConditionalValueItem {
548
997
  * @property {string} primaryColorAttributeName - name of the column that defines color.
549
998
  */
550
999
  export declare interface ɵDataSchema {
1000
+ /**
1001
+ * @description Name of the object schema.
1002
+ */
551
1003
  name: string;
552
1004
  /**
553
1005
  * @description {@link ɵDataSchemaType} type of DataSchema.
@@ -562,12 +1014,25 @@ export declare interface ɵDataSchema {
562
1014
  * @description {@link ɵDataSchemaAttribute[]} - array of attributes of DataSchema.
563
1015
  */
564
1016
  attributes: ɵDataSchemaAttribute[];
1017
+ /**
1018
+ * @description The column representing the primary key.
1019
+ */
565
1020
  primaryAttributeName?: string;
1021
+ /**
1022
+ * @description The name of the primary column to display.
1023
+ */
566
1024
  primaryDisplayAttributeName?: string;
1025
+ /**
1026
+ * @description Name of the hierarchical column.
1027
+ */
567
1028
  hierarchyAttributeName?: string;
1029
+ /**
1030
+ * @description Name of the column with corresponding color.
1031
+ */
568
1032
  primaryColorAttributeName?: string;
569
1033
  /**
570
1034
  * @public
1035
+ * @description Configuration for data source.
571
1036
  */
572
1037
  dataSourceConfig: ɵDataSourceConfig;
573
1038
  }
@@ -586,50 +1051,93 @@ export declare interface ɵDataSchema {
586
1051
  * @property {boolean} isRequired - flag to determine DataSchemaAttribute required or not.
587
1052
  */
588
1053
  export declare interface ɵDataSchemaAttribute {
1054
+ /**
1055
+ * @public
1056
+ * @description Attribute name.
1057
+ */
589
1058
  name: string;
1059
+ /**
1060
+ * @public
1061
+ * @description Attribute caption.
1062
+ */
590
1063
  caption: string;
591
1064
  /**
592
1065
  * @public
1066
+ * @description Column path.
593
1067
  */
594
1068
  path: string;
595
1069
  /**
1070
+ * @public
596
1071
  * @description {@link ɵDataValueType} - value type of DataSchemaAttribute.
597
1072
  */
598
1073
  dataValueType: ɵDataValueType;
599
1074
  /**
600
1075
  * @public
1076
+ * @description Collection of validators.
601
1077
  */
602
1078
  validators: ɵDataSchemaValidatorConfig;
603
1079
  /**
604
1080
  * @public
1081
+ * @description Default value.
605
1082
  */
606
1083
  defaultValue: Promise<ɵJsonData> | unknown;
607
1084
  /**
608
1085
  * @public
1086
+ * @description Default value schema.
609
1087
  */
610
1088
  defaultValueSchema: ɵDefaultValueSchema;
1089
+ /**
1090
+ * @public
1091
+ * @description Whether value can be copied.
1092
+ */
611
1093
  isValueCloneable: boolean;
612
1094
  /**
613
1095
  * @public
1096
+ * @description Type of attribute.
614
1097
  */
615
1098
  attributeType: ɵDataSchemaAttributeType;
1099
+ /**
1100
+ * @public
1101
+ * @description The name of the schema of the object referenced by attribute.
1102
+ */
616
1103
  referenceSchemaName?: string;
617
1104
  /**
618
1105
  * @public
1106
+ * @description Configuration of attribute function.
619
1107
  */
620
1108
  functionConfig?: ɵDataSchemaAttributeFunctionConfig;
621
1109
  /**
622
1110
  * @public
1111
+ * @description Configuration of attribute aggregation.
623
1112
  */
624
1113
  aggregationConfig?: ɵDataSchemaAttributeAggregationConfig;
1114
+ /**
1115
+ * @public
1116
+ * @description Whether attribute should ues mask.
1117
+ */
625
1118
  isMasked: boolean;
1119
+ /**
1120
+ * @public
1121
+ * @description Whether attribute is system.
1122
+ */
1123
+ isSystem: boolean;
1124
+ /**
1125
+ * @public
1126
+ * @description Format is validated.
1127
+ */
626
1128
  isFormatValidated: boolean;
1129
+ /**
1130
+ * @public
1131
+ * @description Whether attribute is contain sensitive data.
1132
+ */
627
1133
  isSensitiveData: boolean;
628
1134
  /**
629
1135
  * @public
1136
+ * @description Usage type.
630
1137
  */
631
1138
  usageType: ɵDataSchemaAttributeUsageType;
632
1139
  /**
1140
+ * @public
633
1141
  * @description flag to determine DataSchemaAttribute required or not.
634
1142
  */
635
1143
  isRequired: boolean;
@@ -700,11 +1208,21 @@ export declare interface ɵDataSchemaAttributeValidatorConfig {
700
1208
  }
701
1209
 
702
1210
  /**
703
- * Type of DataSchema. In combination with the name is used for unique identification of {@link DataSchema}.
1211
+ * @public
1212
+ * @decription Type of DataSchema. In combination with the name is used for unique identification of {@link ɵDataSchema}.
704
1213
  */
705
1214
  export declare enum ɵDataSchemaType {
1215
+ /**
1216
+ * @description Entity.
1217
+ */
706
1218
  Entity = "Entity",
1219
+ /**
1220
+ * @description Client unit.
1221
+ */
707
1222
  ClientUnit = "ClientUnit",
1223
+ /**
1224
+ * @description Intent.
1225
+ */
708
1226
  Intent = "Intent"
709
1227
  }
710
1228
 
@@ -715,121 +1233,290 @@ export declare interface ɵDataSchemaValidatorConfig {
715
1233
  [name: string]: ɵDataSchemaAttributeValidatorConfig;
716
1234
  }
717
1235
 
1236
+ /**
1237
+ * @public
1238
+ * @description Config for aggregation in datasource.
1239
+ * @property {ɵAggregationFunction} aggregationFunction - Aggregation function.
1240
+ * @property {ɵFilterGroup} filter - Filter.
1241
+ * @property {string} sortByColumn - Column to be sorted by.
1242
+ * @property {ɵOrderDirection} sortByDirection - Sort direction.
1243
+ */
718
1244
  export declare interface ɵDataSourceAggregationConfig {
1245
+ /**
1246
+ * @description Aggregation function.
1247
+ */
719
1248
  aggregationFunction?: ɵAggregationFunction;
1249
+ /**
1250
+ * @description Filter.
1251
+ */
720
1252
  filter?: ɵFilterGroup;
1253
+ /**
1254
+ * @description Column to be sorted by.
1255
+ */
721
1256
  sortByColumn?: string;
1257
+ /**
1258
+ * @description Sort direction.
1259
+ */
722
1260
  sortByDirection?: ɵOrderDirection;
723
1261
  }
724
1262
 
1263
+ /**
1264
+ * @public
1265
+ * @description Configuration for aggregation function attribute.
1266
+ */
725
1267
  export declare interface ɵDataSourceAggregationFunctionConfig extends BaseDataSourceFunctionConfig {
1268
+ /**
1269
+ * @public
1270
+ * @description Type of function. Default 'aggregation'.
1271
+ */
726
1272
  type: 'aggregation';
1273
+ /**
1274
+ * @public
1275
+ * @description Aggregation function to apply.
1276
+ */
727
1277
  aggregation: ɵAggregationFunction;
1278
+ /**
1279
+ * @public
1280
+ * @description Aggregation evaluation mode.
1281
+ */
728
1282
  aggregationEval: ɵAggregationEval;
729
1283
  }
730
1284
 
731
1285
  /**
732
1286
  * @public
1287
+ * @description Config for attribute in datasource.
1288
+ * @property {ɵDataSourceAttributeType} type - Type of attribute.
1289
+ * @property {string} name - Unique name of attribute.
1290
+ * @property {string} path - Path to attribute in data source.
1291
+ * @property {string} [caption] - Caption to display in UI.
1292
+ * @property {ɵDataValueType} [dataValueType] - Type of value.
1293
+ * @property {ɵDataSourceFunctionConfig} [functionConfig] - Configuration for function attribute.
1294
+ * @property {ɵDataSourceAggregationConfig} [aggregationConfig] - Configuration for aggregation attribute.
733
1295
  */
734
1296
  export declare interface ɵDataSourceAttribute {
1297
+ /**
1298
+ * @public
1299
+ * @description Type of attribute.
1300
+ */
735
1301
  type?: ɵDataSourceAttributeType;
1302
+ /**
1303
+ * @public
1304
+ * @description Unique name of attribute.
1305
+ */
736
1306
  name: string;
1307
+ /**
1308
+ * @public
1309
+ * @description Path to attribute in data source.
1310
+ */
737
1311
  path: string;
1312
+ /**
1313
+ * @public
1314
+ * @description Caption to display in UI.
1315
+ */
738
1316
  caption?: string;
1317
+ /**
1318
+ * @public
1319
+ * @description Type of value.
1320
+ */
739
1321
  dataValueType?: ɵDataValueType;
1322
+ /**
1323
+ * @public
1324
+ * @description Configuration for function attribute.
1325
+ */
740
1326
  functionConfig?: ɵDataSourceFunctionConfig;
1327
+ /**
1328
+ * @public
1329
+ * @description Configuration for aggregation attribute.
1330
+ */
741
1331
  aggregationConfig?: ɵDataSourceAggregationConfig;
742
1332
  }
743
1333
 
744
1334
  /**
745
1335
  * @public
1336
+ * @description Types of attribute.
746
1337
  */
747
1338
  export declare type ɵDataSourceAttributeType = 'default' | 'aggregation' | 'function';
748
1339
 
1340
+ /**
1341
+ * @public
1342
+ * @description Payload for canExecuteOperation request.
1343
+ * @property {string} primaryColumnValue - Primary column value of record.
1344
+ */
749
1345
  export declare interface ɵDataSourceCanExecuteOperationPayload {
1346
+ /**
1347
+ * @public
1348
+ * @description Primary column value of record for which to check operation execution possibility.
1349
+ */
750
1350
  primaryColumnValue?: string;
751
1351
  }
752
1352
 
1353
+ /**
1354
+ * @public
1355
+ * @description Result of canExecuteOperation request.
1356
+ * @property {boolean} result - Indicates whether operation can be executed.
1357
+ * @property {string} message - Optional message to display if operation cannot be executed.
1358
+ */
753
1359
  export declare interface ɵDataSourceCanExecuteOperationResult {
1360
+ /**
1361
+ * @public
1362
+ * @description Indicates whether operation can be executed.
1363
+ */
754
1364
  result: boolean;
1365
+ /**
1366
+ * @public
1367
+ * @description Optional message to display if operation cannot be executed.
1368
+ */
755
1369
  message?: string;
756
1370
  }
757
1371
 
758
1372
  /**
759
1373
  * @public
1374
+ * @description Configuration of data source.
760
1375
  */
761
1376
  export declare interface ɵDataSourceConfig {
1377
+ /**
1378
+ * @description Type.
1379
+ */
762
1380
  type: string;
1381
+ /**
1382
+ * @description Configuration of instances.
1383
+ */
763
1384
  config?: ɵDataSourceInstanceConfig;
764
1385
  /**
765
1386
  * @deprecated Use scope instead.
766
1387
  */
767
1388
  hiddenInPageDesigner?: boolean;
1389
+ /**
1390
+ * @description Scope.
1391
+ */
768
1392
  scope?: ɵDataSourceScope;
1393
+ /**
1394
+ * @description Disable synchronization.
1395
+ */
769
1396
  disableSync?: boolean;
770
1397
  }
771
1398
 
1399
+ /**
1400
+ * @public
1401
+ * @description Configuration for date part function attribute.
1402
+ */
772
1403
  export declare interface ɵDataSourceDatePartFunctionConfig extends BaseDataSourceFunctionConfig {
1404
+ /**
1405
+ * @public
1406
+ * @description Type of function. Default 'datePart'.
1407
+ */
773
1408
  type: 'datePart';
1409
+ /**
1410
+ * @public
1411
+ * @description Date part to extract.
1412
+ */
774
1413
  datePart: ɵDatePart;
775
1414
  }
776
1415
 
1416
+ /**
1417
+ * @public
1418
+ * @description Union type for all possible function configurations.
1419
+ */
777
1420
  export declare type ɵDataSourceFunctionConfig = ɵDataSourceAggregationFunctionConfig | ɵDataSourceDatePartFunctionConfig;
778
1421
 
779
1422
  /**
780
1423
  * @public
1424
+ * @description Data source insert response.
1425
+ * @property {Array<Record<string, unknown>>} primaryAttributes - Collection of primary attributes.
781
1426
  */
782
1427
  export declare interface ɵDataSourceInsertResult extends ɵDataSourceSaveResult {
1428
+ /**
1429
+ * @description Collection of primary attributes.
1430
+ */
783
1431
  primaryAttributes: Array<Record<string, unknown>>;
784
1432
  }
785
1433
 
786
1434
  /**
787
1435
  * @public
1436
+ * @description Interface for collection of data sources.
788
1437
  */
789
1438
  export declare interface ɵDataSourceInstanceConfig {
1439
+ /**
1440
+ * @description Key value pair.
1441
+ */
790
1442
  [key: string]: any;
791
1443
  }
792
1444
 
793
1445
  /**
794
1446
  * @public
1447
+ * @description Config for load data through data source
1448
+ * @property {ɵDataSourcePagingConfig} pagingConfig - Pagination options.
1449
+ * @property {ɵDataSourceSortingConfig} sortingConfig - Sorting options.
795
1450
  */
796
1451
  export declare interface ɵDataSourceLoadOptions {
1452
+ /**
1453
+ * @description Pagination options.
1454
+ */
797
1455
  pagingConfig?: ɵDataSourcePagingConfig;
1456
+ /**
1457
+ * @description Sorting options.
1458
+ */
798
1459
  sortingConfig?: ɵDataSourceSortingConfig;
799
1460
  }
800
1461
 
801
1462
  /**
802
1463
  * @public
1464
+ * @description Config for paging in datasource.
1465
+ * @propery {number} rowsOffset - Rows count to skip.
1466
+ * @propery {number} rowCount - Rows count to query.
803
1467
  */
804
1468
  export declare interface ɵDataSourcePagingConfig {
1469
+ /**
1470
+ * @description Rows count to skip.
1471
+ */
805
1472
  rowsOffset: number;
1473
+ /**
1474
+ * @description Rows count to query.
1475
+ */
806
1476
  rowCount: number;
807
1477
  }
808
1478
 
809
1479
  /**
810
1480
  * @public
1481
+ * @description Union type for all possible data source parameters.
811
1482
  */
812
1483
  export declare type ɵDataSourceParameter = ɵBaseDataSourceParameter | ɵPrimaryDisplayFilterDataSourceParameter;
813
1484
 
814
1485
  /**
815
1486
  * @public
1487
+ * @description Configuration for data source parameter relation.
816
1488
  */
817
1489
  export declare interface ɵDataSourceParameterRelationConfig {
1490
+ /**
1491
+ * @public
1492
+ * @description Name of data schema.
1493
+ */
818
1494
  dataSchemaName: string;
1495
+ /**
1496
+ * @public
1497
+ * @description Path to attribute in data schema.
1498
+ */
819
1499
  attributePath: string;
1500
+ /**
1501
+ * @public
1502
+ * @description Path to relation in data schema.
1503
+ */
820
1504
  relationPath: string;
821
1505
  /**
822
1506
  * @public
1507
+ * @description Whether to use attribute value.
823
1508
  */
824
1509
  useAttributeValue?: boolean;
825
1510
  /**
826
1511
  * @public
1512
+ * @description Optional value for relation.
827
1513
  */
828
1514
  value?: unknown;
829
1515
  }
830
1516
 
831
1517
  /**
832
1518
  * @public
1519
+ * @description Array of data source parameters.
833
1520
  */
834
1521
  export declare type ɵDataSourceParameters = ɵDataSourceParameter[];
835
1522
 
@@ -865,56 +1552,183 @@ export declare enum ɵDataSourceScope {
865
1552
 
866
1553
  /**
867
1554
  * @public
1555
+ * @description Config for soring data source.
1556
+ * @property {ɵSortColumnOptions[]} columns - Array of columns to sort.
868
1557
  */
869
1558
  export declare interface ɵDataSourceSortingConfig {
1559
+ /**
1560
+ * @description Array of columns to sort.
1561
+ */
870
1562
  columns: ɵSortColumnOptions[];
871
1563
  }
872
1564
 
1565
+ /**
1566
+ * @public
1567
+ * Types of values.
1568
+ */
873
1569
  export declare enum ɵDataValueType {
1570
+ /**
1571
+ * @description Global unique identifier.
1572
+ */
874
1573
  Guid = 0,
1574
+ /**
1575
+ * @description String.
1576
+ */
875
1577
  Text = 1,
1578
+ /**
1579
+ * @description Integer.
1580
+ */
876
1581
  Integer = 4,
1582
+ /**
1583
+ * @description Real number.
1584
+ */
877
1585
  Float = 5,
1586
+ /**
1587
+ * @description Currency.
1588
+ */
878
1589
  Money = 6,
1590
+ /**
1591
+ * @description Date and time.
1592
+ */
879
1593
  DateTime = 7,
1594
+ /**
1595
+ * @description Date.
1596
+ */
880
1597
  Date = 8,
1598
+ /**
1599
+ * @description Time.
1600
+ */
881
1601
  Time = 9,
1602
+ /**
1603
+ * @description Lookup.
1604
+ */
882
1605
  Lookup = 10,
1606
+ /**
1607
+ * @description Enumeration.
1608
+ */
883
1609
  Enum = 11,
1610
+ /**
1611
+ * @description Boolean.
1612
+ */
884
1613
  Boolean = 12,
1614
+ /**
1615
+ * @description Binary data object.
1616
+ */
885
1617
  Blob = 13,
1618
+ /**
1619
+ * @description The object of image binary data.
1620
+ */
886
1621
  Image = 14,
1622
+ /**
1623
+ * @description Custom object.
1624
+ */
887
1625
  CUSTOM_OBJECT = 15,
1626
+ /**
1627
+ * @description Image from a lookup.
1628
+ */
888
1629
  IMAGELOOKUP = 16,
1630
+ /**
1631
+ * @description Collection of items.
1632
+ */
889
1633
  COLLECTION = 17,
1634
+ /**
1635
+ * @description Color.
1636
+ */
890
1637
  Color = 18,
1638
+ /**
1639
+ * @description Localized string.
1640
+ */
891
1641
  LOCALIZABLE_STRING = 19,
1642
+ /**
1643
+ * @description Object (Entity).
1644
+ */
892
1645
  ENTITY = 20,
1646
+ /**
1647
+ * @description Collection of objects (EntityCollection).
1648
+ */
893
1649
  ENTITY_COLLECTION = 21,
1650
+ /**
1651
+ * @description List of object column values (EntityColumnMappingCollection).
1652
+ */
894
1653
  ENTITY_COLUMN_MAPPING_COLLECTION = 22,
1654
+ /**
1655
+ * @description Hash string.
1656
+ */
895
1657
  HASH_TEXT = 23,
1658
+ /**
1659
+ * @description Encrypted string.
1660
+ */
896
1661
  SECURE_TEXT = 24,
1662
+ /**
1663
+ * @description File.
1664
+ */
897
1665
  FILE = 25,
1666
+ /**
1667
+ * @description Mapping.
1668
+ */
898
1669
  MAPPING = 26,
1670
+ /**
1671
+ * @description Short length text.
1672
+ */
899
1673
  SHORT_TEXT = 27,
1674
+ /**
1675
+ * @description Medium length text.
1676
+ */
900
1677
  MEDIUM_TEXT = 28,
1678
+ /**
1679
+ * @description Unlimited length text.
1680
+ */
901
1681
  MAXSIZE_TEXT = 29,
1682
+ /**
1683
+ * @description Long length text.
1684
+ */
902
1685
  LONG_TEXT = 30,
903
1686
  FLOAT1 = 31,
904
1687
  FLOAT2 = 32,
905
1688
  FLOAT3 = 33,
906
1689
  FLOAT4 = 34,
1690
+ /**
1691
+ * @description Localizable parameter values list.
1692
+ */
907
1693
  LOCALIZABLE_PARAMETER_VALUES_LIST = 35,
1694
+ /**
1695
+ * @description Process not localizable text.
1696
+ */
908
1697
  METADATA_TEXT = 36,
1698
+ /**
1699
+ * @description Stage indicator.
1700
+ */
909
1701
  STAGE_INDICATOR = 37,
1702
+ /**
1703
+ * @description Serializable list of values.
1704
+ */
910
1705
  OBJECT_LIST = 38,
1706
+ /**
1707
+ * @description Serializable list of composite values.
1708
+ */
911
1709
  COMPOSITE_OBJECT_LIST = 39,
912
1710
  FLOAT8 = 40,
1711
+ /**
1712
+ * @description File.
1713
+ */
913
1714
  FILE_LOCATOR = 41,
1715
+ /**
1716
+ * @description Phone.
1717
+ */
914
1718
  PHONE_TEXT = 42,
1719
+ /**
1720
+ * @description Text with formating tags.
1721
+ */
915
1722
  RICH_TEXT = 43,
1723
+ /**
1724
+ * @description Web link.
1725
+ */
916
1726
  WEB_TEXT = 44,
917
- EMAIL_TEXT = 45
1727
+ /**
1728
+ * @description Email.
1729
+ */
1730
+ EMAIL_TEXT = 45,
1731
+ COMPOSITE_OBJECT = 46
918
1732
  }
919
1733
 
920
1734
  /**
@@ -923,15 +1737,34 @@ export declare enum ɵDataValueType {
923
1737
  */
924
1738
  export declare type ɵDatePart = 'minute' | 'hour' | 'day' | 'weekday' | 'week' | 'month' | 'year' | 'none';
925
1739
 
1740
+ /**
1741
+ * @public
1742
+ * @classdesc Class contains info about column with date part.
1743
+ * @extends {ɵBaseQueryColumn}
1744
+ */
926
1745
  export declare class ɵDatePartFunctionColumn extends ɵBaseQueryColumn<ɵDatePartFunctionExpression> {
927
1746
  constructor(datePartType: ɵDatePartType, functionArgument: ɵBaseExpression);
1747
+ /**
1748
+ * @description Part of date.
1749
+ */
928
1750
  get datePartType(): ɵDatePartType;
929
1751
  }
930
1752
 
1753
+ /**
1754
+ * @public
1755
+ * @description A class that describes expression part of date function.
1756
+ * @extends {ɵArgumentFunctionExpression}
1757
+ */
931
1758
  export declare class ɵDatePartFunctionExpression extends ɵArgumentFunctionExpression {
932
1759
  /* Excluded from this release type: _instanceOfKey */
933
1760
  /* Excluded from this release type: _instanceOfKeys */
1761
+ /**
1762
+ * @description Function type. Default 'DatePart'.
1763
+ */
934
1764
  readonly functionType: ɵFunctionType;
1765
+ /**
1766
+ * @description Date part type.
1767
+ */
935
1768
  readonly datePartType: ɵDatePartType;
936
1769
  constructor(config: ɵDatePartFunctionExpressionConfig);
937
1770
  /**
@@ -939,33 +1772,58 @@ export declare class ɵDatePartFunctionExpression extends ɵArgumentFunctionExpr
939
1772
  * @public
940
1773
  */
941
1774
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser?: TExpressionParser): ɵDatePartFunctionExpression;
1775
+ /** {@inheritDoc ɵBaseExpression.clone} */
942
1776
  clone(): ɵDatePartFunctionExpression;
943
1777
  }
944
1778
 
1779
+ /**
1780
+ * @public
1781
+ * @description Configuration for date part expression.
1782
+ */
945
1783
  export declare type ɵDatePartFunctionExpressionConfig = ɵArgumentFunctionExpressionConfig<ɵDatePartFunctionExpression> & Pick<ɵDatePartFunctionExpression, 'datePartType'>;
946
1784
 
1785
+ /**
1786
+ * @public
1787
+ * @description Part of the date.
1788
+ */
947
1789
  export declare enum ɵDatePartType {
948
- /** Empty value. */
1790
+ /**
1791
+ * @description Empty value.
1792
+ */
949
1793
  None = 0,
950
- /** Day. */
1794
+ /**
1795
+ * @description Day.
1796
+ */
951
1797
  Day = 1,
952
- /** Week. */
1798
+ /**
1799
+ * @description Week.
1800
+ */
953
1801
  Week = 2,
954
- /** Month. */
1802
+ /**
1803
+ * @description Month.
1804
+ */
955
1805
  Month = 3,
956
- /** Year. */
1806
+ /**
1807
+ * @description Year.
1808
+ */
957
1809
  Year = 4,
958
- /** Day of the week. */
1810
+ /**
1811
+ * @description Day of the week.
1812
+ */
959
1813
  WeekDay = 5,
960
- /** Hour. */
1814
+ /**
1815
+ * @description Hour.
1816
+ */
961
1817
  Hour = 6,
962
- /** Minute. */
1818
+ /**
1819
+ * @description Minute.
1820
+ */
963
1821
  HourMinute = 7
964
1822
  }
965
1823
 
966
- export declare const ɵDEFAULT_COLUMN_PLAIN_OBJ: object;
1824
+ /* Excluded from this release type: ɵDEFAULT_COLUMN_PLAIN_OBJ */
967
1825
 
968
- export declare const ɵDEFAULT_FILTER_PLAIN_OBJ: object;
1826
+ /* Excluded from this release type: ɵDEFAULT_FILTER_PLAIN_OBJ */
969
1827
 
970
1828
  /**
971
1829
  * @public
@@ -991,6 +1849,8 @@ export declare enum ɵDefaultValueSource {
991
1849
 
992
1850
  /**
993
1851
  * @public
1852
+ * @description Request to delete data.
1853
+ * @extends {ɵBaseFilterableQuery}
994
1854
  */
995
1855
  export declare class ɵDeleteQuery extends ɵBaseFilterableQuery {
996
1856
  constructor(rootSchemaName: string);
@@ -1014,8 +1874,8 @@ export declare interface ɵDialogAction<T extends ɵBaseDialogButtonConfig = ɵB
1014
1874
  }
1015
1875
 
1016
1876
  /**
1017
- * Empty Guid constant.
1018
1877
  * @public
1878
+ * @description Empty Guid constant.
1019
1879
  */
1020
1880
  export declare const ɵEMPTY_GUID = "00000000-0000-0000-0000-000000000000";
1021
1881
 
@@ -1026,71 +1886,94 @@ export declare const ɵEMPTY_GUID = "00000000-0000-0000-0000-000000000000";
1026
1886
  */
1027
1887
  export declare function ɵencodeDate(date: Date): string;
1028
1888
 
1889
+ /**
1890
+ * @public
1891
+ * @description type of column value.
1892
+ */
1029
1893
  export declare type ɵEntityColumnValue = boolean | number | string | ɵGuid | Date | ɵLookupValue | null;
1030
1894
 
1895
+ /**
1896
+ * @public
1897
+ * @classdesc Class contains info about common column from entity.
1898
+ * @extends {ɵBaseQueryColumn}
1899
+ */
1031
1900
  export declare class ɵEntityQueryColumn extends ɵBaseQueryColumn<ɵColumnExpression> {
1032
1901
  constructor(columnPath: string);
1033
1902
  }
1034
1903
 
1035
1904
  /**
1036
1905
  * @public
1906
+ * @description The query class for data fetching.
1907
+ * @extends {ɵBaseFilterableQuery}
1037
1908
  */
1038
1909
  export declare class ɵEntitySchemaQuery extends ɵBaseFilterableQuery {
1039
1910
  private _columns;
1911
+ /**
1912
+ * @description Determines if merge duplicates in query result.
1913
+ */
1040
1914
  isDistinct: boolean;
1041
1915
  /**
1042
- * Number of rows to select.
1916
+ * @description Number of rows to select.
1043
1917
  */
1044
1918
  rowCount: number;
1045
1919
  /**
1046
- * Rows count to skip.
1920
+ * @description Rows count to skip.
1047
1921
  */
1048
1922
  rowsOffset: number;
1049
1923
  /**
1050
- * Query conditional values
1924
+ * @description Query conditional values
1051
1925
  */
1052
1926
  conditionalValues?: null | {
1053
1927
  items: unknown;
1054
1928
  };
1929
+ /**
1930
+ * @description The parameter that determines whether to use the localized data.
1931
+ */
1055
1932
  useLocalization: boolean;
1933
+ /**
1934
+ * @description Represent parameter which determines disabling data in filtering.
1935
+ */
1056
1936
  useRecordDeactivation: boolean;
1057
1937
  /**
1058
- * Bit mask that indicates which role sources will be considered when checking record rights.
1938
+ * @description Bit mask that indicates which role sources will be considered when checking record rights.
1059
1939
  */
1060
1940
  adminUnitRoleSources?: eAdminUnitRoleSources;
1061
1941
  constructor(rootSchemaName: string);
1062
1942
  private _internalAddColumn;
1063
1943
  private _getIsPageable;
1064
1944
  /**
1065
- * Returns column instance by column alias.
1945
+ * @public
1946
+ * @description Returns column instance by column alias.
1066
1947
  * @param columnAlias Column alias.
1067
1948
  * @returns [BaseQueryColumn] Column instance.
1068
1949
  */
1069
1950
  getColumn(columnAlias: string): ɵBaseQueryColumn;
1070
1951
  /**
1071
- * Returns column instance by column alias if not found returns null.
1952
+ * @public
1953
+ * @description Returns column instance by column alias if not found returns null.
1072
1954
  */
1073
1955
  findColumn(columnAlias: string): ɵBaseQueryColumn;
1074
- /**
1075
- * @inheritDoc
1076
- */
1956
+ /** {@inheritDoc ɵMetadataProvider.getMetadata} */
1077
1957
  getMetadata(): Record<string, unknown>;
1078
1958
  /**
1079
- * Add column.
1959
+ * @public
1960
+ * @description Add column.
1080
1961
  * @param column Column path.
1081
1962
  * @param columnAlias Column alias.
1082
1963
  * @returns [BaseQueryColumn] Column instance.
1083
1964
  */
1084
1965
  addColumn(column: ɵBaseQueryColumn, columnAlias: string): ɵBaseQueryColumn;
1085
1966
  /**
1086
- * Add column by column path.
1967
+ * @public
1968
+ * @description Add column by column path.
1087
1969
  * @param columnPath Column path.
1088
1970
  * @param columnAlias Column alias.
1089
1971
  * @returns [EntityQueryColumn] Column instance.
1090
1972
  */
1091
1973
  addSchemaColumn(columnPath: string, columnAlias?: string): ɵEntityQueryColumn;
1092
1974
  /**
1093
- * Add aggregation sub query column.
1975
+ * @public
1976
+ * @description Add aggregation sub query column.
1094
1977
  * @param columnPath Column path.
1095
1978
  * @param aggregationType Aggregation type.
1096
1979
  * @param subFilters Sub query filters.
@@ -1099,7 +1982,8 @@ export declare class ɵEntitySchemaQuery extends ɵBaseFilterableQuery {
1099
1982
  */
1100
1983
  addAggregationSubQueryColumn(columnPath: string, aggregationType: ɵAggregationType, aggregationConfig: ɵDataSourceAggregationConfig, columnAlias?: string): ɵAggregationSubQueryColumn;
1101
1984
  /**
1102
- * Add parameter column.
1985
+ * @public
1986
+ * @description Add parameter column.
1103
1987
  * @param value Parameter value.
1104
1988
  * @param dataValueType Parameter data value type.
1105
1989
  * @param columnAlias Column alias.
@@ -1107,7 +1991,8 @@ export declare class ɵEntitySchemaQuery extends ɵBaseFilterableQuery {
1107
1991
  */
1108
1992
  addParameterColumn(value: ɵEntityColumnValue, dataValueType: ɵDataValueType, columnAlias: string): ɵParameterQueryColumn;
1109
1993
  /**
1110
- * Add arithmetic column.
1994
+ * @public
1995
+ * @description Add arithmetic column.
1111
1996
  * @param arithmeticOperation Arithmetic operation.
1112
1997
  * @param leftArithmeticOperand Left arithmetic operand expression.
1113
1998
  * @param rightArithmeticOperand Right arithmetic operand expression.
@@ -1116,14 +2001,16 @@ export declare class ɵEntitySchemaQuery extends ɵBaseFilterableQuery {
1116
2001
  */
1117
2002
  addArithmeticColumn(arithmeticOperation: ɵArithmeticOperation, leftArithmeticOperand: ɵBaseExpression, rightArithmeticOperand: ɵBaseExpression, columnAlias: string): ɵArithmeticQueryColumn;
1118
2003
  /**
1119
- * Add macros function column.
2004
+ * @public
2005
+ * @description Add macros function column.
1120
2006
  * @param queryMacrosType Macros type.
1121
2007
  * @param columnAlias Column alias.
1122
2008
  * @returns [MacrosFunctionColumn] Column instance.
1123
2009
  */
1124
2010
  addMacrosFunctionColumn(queryMacrosType: ɵQueryMacrosType, columnAlias: string): ɵMacrosFunctionColumn;
1125
2011
  /**
1126
- * Add date part function column.
2012
+ * @public
2013
+ * @description Add date part function column.
1127
2014
  * @param columnPath Column path.
1128
2015
  * @param datePartType Date part type.
1129
2016
  * @param columnAlias Column alias.
@@ -1131,7 +2018,8 @@ export declare class ɵEntitySchemaQuery extends ɵBaseFilterableQuery {
1131
2018
  */
1132
2019
  addDatePartFunctionColumn(columnPath: string, datePartType: ɵDatePartType, columnAlias: string): ɵDatePartFunctionColumn;
1133
2020
  /**
1134
- * Add aggregation function column.
2021
+ * @public
2022
+ * @description Add aggregation function column.
1135
2023
  * @param columnPath Column path.
1136
2024
  * @param aggregationType Aggregation type.
1137
2025
  * @param columnAlias Column alias.
@@ -1140,14 +2028,16 @@ export declare class ɵEntitySchemaQuery extends ɵBaseFilterableQuery {
1140
2028
  */
1141
2029
  addAggregationFunctionColumn(columnPath: string, aggregationType: ɵAggregationType, columnAlias: string, aggregationEvalType?: ɵAggregationEvalType): ɵAggregationFunctionColumn;
1142
2030
  /**
1143
- * Add length function column.
2031
+ * @public
2032
+ * @description Add length function column.
1144
2033
  * @param columnPath Column path.
1145
2034
  * @param columnAlias Column alias.
1146
2035
  * @returns [LengthFunctionColumn] Column instance.
1147
2036
  */
1148
2037
  addLengthFunctionColumn(columnPath: string, columnAlias: string): ɵLengthFunctionColumn;
1149
2038
  /**
1150
- * Add window function column.
2039
+ * @public
2040
+ * @description Add window function column.
1151
2041
  * @param columnPath Column path.
1152
2042
  * @param aggregationType Aggregation type.
1153
2043
  * @param columnAlias Column alias.
@@ -1158,10 +2048,21 @@ export declare class ɵEntitySchemaQuery extends ɵBaseFilterableQuery {
1158
2048
  /* Excluded from this release type: _getUsedColumns */
1159
2049
  }
1160
2050
 
2051
+ /**
2052
+ * @public
2053
+ * @description The comparison filter class [Exists according to the specified condition].
2054
+ * @extends {ɵSingleFilter}
2055
+ */
1161
2056
  export declare class ɵExistsFilter extends ɵSingleFilter {
1162
2057
  /* Excluded from this release type: _instanceOfKey */
1163
2058
  /* Excluded from this release type: _instanceOfKeys */
2059
+ /**
2060
+ * @description Subquery filters. Cannot contain filters with other subqueries.
2061
+ */
1164
2062
  readonly subFilters?: ɵFilterGroup;
2063
+ /**
2064
+ * @description Indicates that the filter is aggregating.
2065
+ */
1165
2066
  readonly isAggregative: boolean;
1166
2067
  constructor(leftExpression: ɵBaseExpression, subFilters?: ɵFilterGroup, comparisonType?: ɵComparisonType, isAggregative?: boolean);
1167
2068
  /**
@@ -1169,12 +2070,17 @@ export declare class ɵExistsFilter extends ɵSingleFilter {
1169
2070
  * @public
1170
2071
  */
1171
2072
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵExistsFilter;
2073
+ /**
2074
+ * @public
2075
+ * @description Clones instance.
2076
+ */
1172
2077
  clone(): ɵExistsFilter;
2078
+ /** {@inheritDoc ɵSerializable.toJson} */
1173
2079
  toJson(): ɵJsonObject;
1174
2080
  /* Excluded from this release type: _getUsedColumns */
1175
2081
  }
1176
2082
 
1177
- export declare const ɵEXPRESSION_TYPE_MOCK: ɵExpressionType;
2083
+ /* Excluded from this release type: ɵEXPRESSION_TYPE_MOCK */
1178
2084
 
1179
2085
  export declare type ɵExpressionConfig<TExpression extends ɵBaseExpression> = Partial<Omit<TExpression, 'expressionType'>>;
1180
2086
 
@@ -1189,62 +2095,108 @@ export declare class ɵExpressionMock extends ɵBaseExpression {
1189
2095
  }
1190
2096
 
1191
2097
  /**
1192
- * Expression parser.
1193
2098
  * @public
2099
+ * @description Expression parser.
2100
+ * @extends {ɵBaseExpressionParser}
1194
2101
  */
1195
2102
  export declare class ɵExpressionParser extends ɵBaseExpressionParser {
1196
2103
  /**
1197
- * Parses expression from json.
1198
2104
  * @public
2105
+ * @description Parses expression from json.
1199
2106
  */
1200
2107
  static fromJson(dto: ɵJsonObject, filterParser: typeof ɵBaseFilterParser): ɵBaseExpression;
1201
2108
  }
1202
2109
 
1203
2110
  /**
1204
- * Expression resolver.
2111
+ * @description Expression resolver.
1205
2112
  * @public
1206
2113
  */
1207
2114
  export declare class ɵExpressionResolver {
2115
+ /**
2116
+ * @public
2117
+ * @description Resolves class of expression.
2118
+ * @param expressionType - Type of expression.
2119
+ * @param dto - Serialized object.
2120
+ * @return Class of expression.
2121
+ */
1208
2122
  static resolve(expressionType: ɵExpressionType, dto: ɵJsonObject): typeof ɵBaseExpression;
1209
2123
  }
1210
2124
 
2125
+ /**
2126
+ * @public
2127
+ * @description Type of expression.
2128
+ */
1211
2129
  export declare enum ɵExpressionType {
2130
+ /**
2131
+ * @description Column.
2132
+ */
1212
2133
  SchemaColumn = 0,
2134
+ /**
2135
+ * @description Function.
2136
+ */
1213
2137
  Function = 1,
2138
+ /**
2139
+ * @description Parameter.
2140
+ */
1214
2141
  Parameter = 2,
2142
+ /**
2143
+ * @description Subselect query.
2144
+ */
1215
2145
  SubQuery = 3,
2146
+ /**
2147
+ * @description Arithmetic operation.
2148
+ */
1216
2149
  ArithmeticOperation = 4
1217
2150
  }
1218
2151
 
2152
+ /**
2153
+ * @public
2154
+ * @description Group of filters. Groups of filters can be nested into each other,
2155
+ * i.e. The collection itself can be an element of another collection.
2156
+ * @extends {ɵBaseFilter}
2157
+ */
1219
2158
  export declare class ɵFilterGroup extends ɵBaseFilter {
1220
2159
  /* Excluded from this release type: _instanceOfKey */
1221
2160
  /* Excluded from this release type: _instanceOfKeys */
2161
+ /**
2162
+ * @public
2163
+ * @description Collection of child filters.
2164
+ */
1222
2165
  filters: Map<string, ɵBaseFilter>;
2166
+ /**
2167
+ * @public
2168
+ * @description Return collecion of deserialized filters.
2169
+ */
1223
2170
  get items(): {
1224
2171
  [key: string]: ɵBaseFilter;
1225
2172
  };
2173
+ /**
2174
+ * @description The type of the logical operation for a combination of filters in the collection.
2175
+ */
1226
2176
  logicalOperation: ɵLogicalOperatorType;
2177
+ /**
2178
+ * @description Root schema name.
2179
+ */
1227
2180
  rootSchemaName?: string;
1228
2181
  constructor(logicalOperation?: ɵLogicalOperatorType, rootSchemaName?: string);
1229
2182
  /**
1230
- * Parses filter group from json.
1231
2183
  * @public
2184
+ * @description Parses filter group from json.
1232
2185
  */
1233
2186
  static fromJson<T extends typeof ɵBaseFilterParser>(dto: ɵJsonObject, filterParser: T): ɵFilterGroup;
1234
- /**
1235
- * Converts instance to json object.
1236
- * @public
1237
- */
2187
+ /** {@inheritDoc ɵSerializable.toJson} */
1238
2188
  toJson(): ɵJsonObject;
1239
2189
  private _createParameterValueExpressions;
1240
2190
  /**
1241
- * Returns filter item by index.
2191
+ * @public
2192
+ * @description Returns filter item by index.
1242
2193
  * @param index Item index.
1243
2194
  * @returns Filter.
1244
2195
  */
1245
2196
  getItemByIndex(index: number): ɵBaseFilter;
1246
2197
  /**
1247
- * Creates and adds compare filter by value.
2198
+ * @public
2199
+ * @description Creates and adds compare filter by value.
1248
2200
  * @param comparisonType Comparison type.
1249
2201
  * @param columnPath Column path.
1250
2202
  * @param parameterValue Parameter value.
@@ -1252,7 +2204,8 @@ export declare class ɵFilterGroup extends ɵBaseFilter {
1252
2204
  */
1253
2205
  addSchemaColumnFilterWithParameter(comparisonType: ɵComparisonType, columnPath: string, parameterValue: ɵEntityColumnValue, filterKey?: string): void;
1254
2206
  /**
1255
- * Creates and adds in filter by values.
2207
+ * @public
2208
+ * @description Creates and adds in filter by values.
1256
2209
  * @param comparisonType Comparison type.
1257
2210
  * @param columnPath Column path.
1258
2211
  * @param parameterValues Parameter values.
@@ -1260,29 +2213,62 @@ export declare class ɵFilterGroup extends ɵBaseFilter {
1260
2213
  */
1261
2214
  addSchemaColumnInFilterWithParameters(comparisonType: ɵComparisonType, columnPath: string, parameterValues: ɵEntityColumnValue[], filterKey?: string): void;
1262
2215
  /**
1263
- * Creates and adds in filter for primary column.
2216
+ * @public
2217
+ * @description Creates and adds in filter for primary column.
1264
2218
  * @param primaryColumnValues Primary column values.
1265
2219
  * @param filterKey Filter key.
1266
2220
  */
1267
2221
  addPrimarySchemaColumnInFilter(primaryColumnValues: ɵEntityColumnValue[], filterKey?: string): void;
2222
+ /**
2223
+ * @public
2224
+ * @description Creates and adds null filter.
2225
+ * @param columnPath Path of column.
2226
+ * @param filterKey Filter key.
2227
+ */
1268
2228
  addSchemaColumnIsNullFilter(columnPath: string, filterKey?: string): void;
1269
2229
  /**
1270
- * Creates and adds not null filter.
2230
+ * @public
2231
+ * @description Creates and adds not null filter.
1271
2232
  * @param columnPath Column path.
1272
2233
  * @param filterKey Filter key.
1273
2234
  */
1274
2235
  addSchemaColumnIsNotNullFilter(columnPath: string, filterKey?: string): void;
1275
2236
  /**
1276
- * Creates and adds filter between less value and greater value.
2237
+ * @public
2238
+ * @description Creates and adds filter between less value and greater value.
1277
2239
  * @param columnPath Column path.
1278
2240
  * @param lessParamValue Less parameter value.
1279
2241
  * @param greaterParamValue Greater parameter value.
1280
2242
  * @param filterKey Filter key.
1281
2243
  */
1282
2244
  addSchemaColumnBetweenFilterWithParameters(columnPath: string, lessParamValue: Date | number, greaterParamValue: Date | number, filterKey?: string): void;
2245
+ /**
2246
+ * @public
2247
+ * @description Creates and adds exists filter.
2248
+ * @param columnPath Column path.
2249
+ * @param subFilters Filters for exists expression.
2250
+ * @param filterKey Filter key.
2251
+ */
1283
2252
  addExistsFilter(columnPath: string, subFilters?: ɵFilterGroup, filterKey?: string): void;
2253
+ /**
2254
+ * @public
2255
+ * @description Creates and adds not exists filter.
2256
+ * @param columnPath Column path.
2257
+ * @param subFilters Filters for exist expression.
2258
+ * @param filterKey Filter key.
2259
+ */
1284
2260
  addNotExistsFilter(columnPath: string, subFilters?: ɵFilterGroup, filterKey?: string): void;
2261
+ /**
2262
+ * @public
2263
+ * @description Adds filter.
2264
+ * @param filter Instance of filter.
2265
+ * @param filterKey Filter key.
2266
+ */
1285
2267
  add(filter: ɵBaseFilter, filterKey?: string): void;
2268
+ /**
2269
+ * @public
2270
+ * @description Clones instance.
2271
+ */
1286
2272
  clone(): ɵFilterGroup;
1287
2273
  /* Excluded from this release type: _getUsedColumns */
1288
2274
  }
@@ -1297,40 +2283,101 @@ export declare class ɵFilterMock extends ɵBaseFilter {
1297
2283
  }
1298
2284
 
1299
2285
  /**
1300
- * Filter parser.
1301
2286
  * @public
2287
+ * @description Filter parser.
1302
2288
  */
1303
2289
  export declare class ɵFilterParser extends ɵBaseFilterParser {
2290
+ /**
2291
+ * @description Creates filter from JSON.
2292
+ * @param dto - Serialized filter.
2293
+ */
1304
2294
  static fromJson(dto: ɵJsonObject): ɵBaseFilter;
1305
2295
  }
1306
2296
 
1307
2297
  /**
1308
- * Filter resolver.
1309
2298
  * @public
2299
+ * @description Filter resolver.
1310
2300
  */
1311
2301
  export declare class ɵFilterResolver {
2302
+ /**
2303
+ * @public
2304
+ * @description Resolves class of filter.
2305
+ * @param filterType - Type of filter.
2306
+ * @return Class of filter.
2307
+ */
1312
2308
  static resolve(filterType: ɵFilterType): typeof ɵBaseFilter;
1313
2309
  }
1314
2310
 
2311
+ /**
2312
+ * @public
2313
+ * @description The type of filter.
2314
+ */
1315
2315
  export declare enum ɵFilterType {
2316
+ /**
2317
+ * @public
2318
+ * @description No filter applied.
2319
+ */
1316
2320
  None = 0,
2321
+ /**
2322
+ * @public
2323
+ * @description Comparison filter (e.g., equal to, greater than).
2324
+ */
1317
2325
  Compare = 1,
2326
+ /**
2327
+ * @public
2328
+ * @description Checks if a value is null.
2329
+ */
1318
2330
  IsNull = 2,
2331
+ /**
2332
+ * @public
2333
+ * @description Checks if a value is between two specified values.
2334
+ */
1319
2335
  Between = 3,
2336
+ /**
2337
+ * @public
2338
+ * @description Checks if a value is in a specified set of values.
2339
+ */
1320
2340
  In = 4,
2341
+ /**
2342
+ * @public
2343
+ * @description Checks if a value exists.
2344
+ */
1321
2345
  Exists = 5,
2346
+ /**
2347
+ * @public
2348
+ * @description A group of filters combined with logical operators (AND, OR).
2349
+ */
1322
2350
  FilterGroup = 6
1323
2351
  }
1324
2352
 
2353
+ /**
2354
+ * @public
2355
+ * @abstract
2356
+ * @description A class that describes a functional expression.
2357
+ * @extends {ɵFunctionExpression}
2358
+ */
1325
2359
  export declare abstract class ɵFunctionExpression extends ɵBaseExpression {
1326
2360
  /* Excluded from this release type: _instanceOfKey */
1327
2361
  /* Excluded from this release type: _instanceOfKeys */
2362
+ /**
2363
+ * @description Expression type. Default 'Function'.
2364
+ */
1328
2365
  readonly expressionType: ɵExpressionType;
2366
+ /**
2367
+ * @description The type of the functional expression.
2368
+ */
1329
2369
  abstract readonly functionType: ɵFunctionType;
1330
2370
  protected constructor(config: ɵFunctionExpressionConfig<ɵFunctionExpression>);
2371
+ /**
2372
+ * @description Abstract method to create cloned instance.
2373
+ */
1331
2374
  abstract clone(): ɵFunctionExpression;
1332
2375
  }
1333
2376
 
2377
+ /**
2378
+ * @public
2379
+ * @description Configuration for funcion expression.
2380
+ */
1334
2381
  export declare type ɵFunctionExpressionConfig<TExpression extends ɵFunctionExpression> = Omit<ɵExpressionConfig<TExpression>, 'functionType'>;
1335
2382
 
1336
2383
  /**
@@ -1339,93 +2386,145 @@ export declare type ɵFunctionExpressionConfig<TExpression extends ɵFunctionExp
1339
2386
  */
1340
2387
  export declare type ɵFunctionStringType = 'aggregation' | 'datePart' | 'none';
1341
2388
 
2389
+ /**
2390
+ * @public
2391
+ * @description The type of function in the filter.
2392
+ */
1342
2393
  export declare enum ɵFunctionType {
2394
+ /**
2395
+ * @description Function type not defined.
2396
+ * */
1343
2397
  None = 0,
1344
- /** Substitution by macro. */
2398
+ /**
2399
+ * @description Substitution by macro.
2400
+ * */
1345
2401
  Macros = 1,
1346
- /** Aggregating function. */
2402
+ /**
2403
+ * @description Aggregating function.
2404
+ * */
1347
2405
  Aggregation = 2,
1348
- /** Date fragment. */
2406
+ /**
2407
+ * @description Date fragment.
2408
+ * */
1349
2409
  DatePart = 3,
1350
- /** The size of the value in bytes, used for binary data. */
2410
+ /**
2411
+ * @description The size of the value in bytes, used for binary data.
2412
+ * */
1351
2413
  Length = 4,
1352
- /** Window query function */
2414
+ /**
2415
+ * @description Window query function
2416
+ * */
1353
2417
  Window = 5,
1354
- /** Date add. */
2418
+ /**
2419
+ * @description Date add.
2420
+ * */
1355
2421
  DateAdd = 6,
1356
- /** Date diff. */
2422
+ /**
2423
+ * @description Date diff.
2424
+ * */
1357
2425
  DateDiff = 7
1358
2426
  }
1359
2427
 
1360
2428
  /**
1361
- * Generates new Guid.
2429
+ * @description Generates new Guid.
1362
2430
  * @public
1363
2431
  */
1364
2432
  export declare function ɵgenerateGuid(): ɵGuid;
1365
2433
 
1366
- export declare function ɵgetColumnPlainObj(expressionPlainObj?: object): object;
2434
+ /* Excluded from this release type: ɵgetColumnPlainObj */
1367
2435
 
1368
- export declare function ɵgetFilterPlainObj(filterPlainObj?: object): object;
2436
+ /* Excluded from this release type: ɵgetFilterPlainObj */
1369
2437
 
1370
2438
  /**
1371
- * Type for Guid value.
2439
+ * @description Type for Guid value.
1372
2440
  * @public
1373
2441
  */
1374
2442
  export declare type ɵGuid = string;
1375
2443
 
2444
+ /**
2445
+ * @public
2446
+ * @description In-Filter Class
2447
+ * @extends {ɵSingleFilter}
2448
+ */
1376
2449
  export declare class ɵInFilter extends ɵSingleFilter {
1377
2450
  /* Excluded from this release type: _instanceOfKey */
1378
2451
  /* Excluded from this release type: _instanceOfKeys */
2452
+ /**
2453
+ * @description An array of expressions that will be compared with {@link #leftExpression}.
2454
+ */
1379
2455
  readonly rightExpressions: ɵBaseExpression[];
1380
2456
  constructor(comparisonType: ɵComparisonType, leftExpression: ɵBaseExpression, rightExpressions: ɵBaseExpression[]);
1381
2457
  /**
1382
- * Parses in filter from json.
2458
+ * @description Parses in filter from json.
1383
2459
  * @public
1384
2460
  */
1385
2461
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵInFilter;
2462
+ /** {@inheritDoc ɵBaseFilter.clone} */
1386
2463
  clone(): ɵInFilter;
2464
+ /** {@inheritDoc ɵSerializable.toJson} */
1387
2465
  toJson(): ɵJsonObject;
1388
2466
  /* Excluded from this release type: _getUsedColumns */
1389
2467
  }
1390
2468
 
1391
2469
  /**
1392
2470
  * @public
2471
+ * @description Request to insert data.
1393
2472
  */
1394
2473
  export declare class ɵInsertQuery extends ɵBaseQuery {
1395
2474
  private _columnValues;
1396
2475
  constructor(rootSchemaName: string);
2476
+ /**
2477
+ * @description A collection of column values for updating entities.
2478
+ */
1397
2479
  get columnValues(): {
1398
2480
  items: {
1399
2481
  [key: string]: ɵParameterExpression;
1400
2482
  };
1401
2483
  };
2484
+ /**
2485
+ * @public
2486
+ * @description Adds the value parameter. An instance of the value-parameter is created and
2487
+ * is added to the column values collection.
2488
+ * @param columnName The alias of the column to set value in
2489
+ * @param columnValue The value of the parameter. The value must match the data type.
2490
+ * @param dataValueType The type of the given parameter value.
2491
+ */
1402
2492
  addColumn(columnName: string, columnValue: ɵEntityColumnValue, dataValueType: ɵDataValueType): void;
1403
2493
  }
1404
2494
 
1405
2495
  /**
1406
- * Checks if Guid is empty value or equal to EMPTY_GUID.
2496
+ * @description Checks if Guid is empty value or equal to EMPTY_GUID.
1407
2497
  * @param guid Guid for check.
1408
2498
  * @public
1409
2499
  */
1410
2500
  export declare function ɵisEmptyGuid(guid: ɵGuid | undefined): boolean;
1411
2501
 
1412
2502
  /**
1413
- * Checks if value is Guid.
2503
+ * @description Checks if value is Guid.
1414
2504
  * @param value Value for check.
1415
2505
  * @public
1416
2506
  */
1417
2507
  export declare function ɵisGuid(value: unknown): boolean;
1418
2508
 
2509
+ /**
2510
+ * @public
2511
+ * @description IsNull filter Class
2512
+ * @extends {ɵSingleFilter}
2513
+ */
1419
2514
  export declare class ɵIsNullFilter extends ɵSingleFilter {
1420
2515
  /* Excluded from this release type: _instanceOfKey */
1421
2516
  /* Excluded from this release type: _instanceOfKeys */
1422
2517
  constructor(comparisonType: ɵComparisonType, leftExpression: ɵBaseExpression);
2518
+ /**
2519
+ * @description Flag that indicates if expression is empty or not.
2520
+ */
1423
2521
  get isNull(): boolean;
1424
2522
  /**
1425
- * Parses isNull filter from json.
2523
+ * @description Parses isNull filter from json.
1426
2524
  * @public
1427
2525
  */
1428
2526
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser: TExpressionParser): ɵIsNullFilter;
2527
+ /** {@inheritDoc ɵBaseFilter.clone} */
1429
2528
  clone(): ɵIsNullFilter;
1430
2529
  }
1431
2530
 
@@ -1451,35 +2550,59 @@ export declare interface ɵItemCreationConfig {
1451
2550
  initialModelValues?: ɵJsonObject;
1452
2551
  }
1453
2552
 
2553
+ /**
2554
+ * @public
2555
+ * @description An exception thrown when trying to retrieve a collection item and it not exists.
2556
+ * @extends {Error}
2557
+ */
1454
2558
  export declare class ɵItemNotFoundException extends Error {
1455
2559
  constructor(key: string);
1456
2560
  }
1457
2561
 
1458
2562
  /**
1459
2563
  * @public
2564
+ * @description Collection of JSON data.
1460
2565
  */
1461
2566
  export declare type ɵJsonArray = Array<ɵJsonData>;
1462
2567
 
1463
2568
  /**
1464
2569
  * @public
2570
+ * @description possible types of values in JSON.
1465
2571
  */
1466
2572
  export declare type ɵJsonData = string | number | boolean | null | undefined | ɵJsonObject | ɵJsonArray;
1467
2573
 
1468
2574
  /**
1469
2575
  * @public
2576
+ * @description JSON object.
1470
2577
  */
1471
2578
  export declare interface ɵJsonObject {
1472
2579
  [key: string]: ɵJsonData;
1473
2580
  }
1474
2581
 
2582
+ /**
2583
+ * @public
2584
+ * @classdesc Class contains info about column with length function.
2585
+ * @extends {ɵBaseQueryColumn}
2586
+ */
1475
2587
  export declare class ɵLengthFunctionColumn extends ɵBaseQueryColumn<ɵLengthFunctionExpression> {
1476
2588
  constructor(functionArgument: ɵColumnExpression);
1477
2589
  }
1478
2590
 
2591
+ /**
2592
+ * @public
2593
+ * @description A class that describes expression with length function.
2594
+ * @extends {ɵArgumentFunctionExpression}
2595
+ */
1479
2596
  export declare class ɵLengthFunctionExpression extends ɵArgumentFunctionExpression {
1480
2597
  /* Excluded from this release type: _instanceOfKey */
1481
2598
  /* Excluded from this release type: _instanceOfKeys */
2599
+ /**
2600
+ * @description Function type. Default 'Length'.
2601
+ */
1482
2602
  readonly functionType: ɵFunctionType;
2603
+ /**
2604
+ * @description Argument of function.
2605
+ */
1483
2606
  readonly functionArgument: ɵColumnExpression;
1484
2607
  constructor(config: ɵLengthFunctionExpressionConfig);
1485
2608
  /**
@@ -1487,9 +2610,16 @@ export declare class ɵLengthFunctionExpression extends ɵArgumentFunctionExpres
1487
2610
  * @public
1488
2611
  */
1489
2612
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser?: TExpressionParser): ɵLengthFunctionExpression;
2613
+ /**
2614
+ * @description Method to create cloned instance.
2615
+ */
1490
2616
  clone(): ɵLengthFunctionExpression;
1491
2617
  }
1492
2618
 
2619
+ /**
2620
+ * @public
2621
+ * @description Configuration of expression with length function.
2622
+ */
1493
2623
  export declare type ɵLengthFunctionExpressionConfig = ɵArgumentFunctionExpressionConfig<ɵLengthFunctionExpression>;
1494
2624
 
1495
2625
  /**
@@ -1509,8 +2639,18 @@ export declare type ɵLocalizableString = string | Record<string, unknown>;
1509
2639
  */
1510
2640
  export declare type ɵLocalizeFn = (key: string) => string;
1511
2641
 
2642
+ /**
2643
+ * @public
2644
+ * @description The type of logical operation.
2645
+ */
1512
2646
  export declare enum ɵLogicalOperatorType {
2647
+ /**
2648
+ * @description Logical And.
2649
+ */
1513
2650
  And = 0,
2651
+ /**
2652
+ * @description Logical Or.
2653
+ */
1514
2654
  Or = 1
1515
2655
  }
1516
2656
 
@@ -1520,8 +2660,9 @@ export declare enum ɵLogicalOperatorType {
1520
2660
  * @extends {ɵJsonObject}
1521
2661
  * @property {string} displayValue - Value witch will be displayed in lookup
1522
2662
  * @property {string} primaryImageValue - Image for lookup value
1523
- * @property {ɵGuid} value - {@link ɵGuid} - actual lookup value
1524
- * @property {string} primaryColorValue - display color of lookup value
2663
+ * @property {ɵGuid} value - {@link ɵGuid} - Actual lookup value
2664
+ * @property {string} primaryColorValue - Display color of lookup value
2665
+ * @property {string} secondaryDisplayValue - Secondary display value
1525
2666
  */
1526
2667
  export declare interface ɵLookupValue extends ɵJsonObject {
1527
2668
  /**
@@ -1533,13 +2674,17 @@ export declare interface ɵLookupValue extends ɵJsonObject {
1533
2674
  */
1534
2675
  primaryImageValue?: string;
1535
2676
  /**
1536
- * @description actual lookup value
2677
+ * @description Actual lookup value
1537
2678
  */
1538
2679
  value: ɵGuid;
1539
2680
  /**
1540
- * @description display color of lookup value
2681
+ * @description Display color of lookup value
1541
2682
  */
1542
2683
  primaryColorValue?: string;
2684
+ /**
2685
+ * @description Secondary display value
2686
+ */
2687
+ secondaryDisplayValue?: string;
1543
2688
  }
1544
2689
 
1545
2690
  /**
@@ -1550,20 +2695,39 @@ export declare interface ɵLookupValue extends ɵJsonObject {
1550
2695
  */
1551
2696
  export declare interface ɵLookupValueWithCode extends ɵLookupValue {
1552
2697
  /**
1553
- * @description code of lookup value
2698
+ * @description Code of lookup value
1554
2699
  */
1555
2700
  code: string;
1556
2701
  }
1557
2702
 
2703
+ /**
2704
+ * @public
2705
+ * @classdesc Class contains info about column with macros function.
2706
+ * @extends {ɵBaseQueryColumn}
2707
+ */
1558
2708
  export declare class ɵMacrosFunctionColumn extends ɵBaseQueryColumn<ɵMacrosFunctionExpression> {
1559
2709
  constructor(macrosType: ɵQueryMacrosType);
1560
2710
  }
1561
2711
 
2712
+ /**
2713
+ * @public
2714
+ * @description A class that describes expression with macros function.
2715
+ * @extends {ɵFunctionExpression}
2716
+ */
1562
2717
  export declare class ɵMacrosFunctionExpression extends ɵFunctionExpression {
1563
2718
  /* Excluded from this release type: _instanceOfKey */
1564
2719
  /* Excluded from this release type: _instanceOfKeys */
2720
+ /**
2721
+ * @description Function type. Default 'Macros'.
2722
+ */
1565
2723
  readonly functionType: ɵFunctionType;
2724
+ /**
2725
+ * @description Type of macros.
2726
+ */
1566
2727
  readonly macrosType: ɵQueryMacrosType;
2728
+ /**
2729
+ * @description Function argument.
2730
+ */
1567
2731
  readonly functionArgument?: ɵBaseExpression;
1568
2732
  constructor(config: ɵMacrosFunctionExpressionConfig);
1569
2733
  /**
@@ -1571,16 +2735,54 @@ export declare class ɵMacrosFunctionExpression extends ɵFunctionExpression {
1571
2735
  * @public
1572
2736
  */
1573
2737
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser?: TFilterParser, expressionParser?: TExpressionParser): ɵMacrosFunctionExpression;
2738
+ /**
2739
+ * @description method to create cloned instance.
2740
+ */
1574
2741
  clone(): ɵMacrosFunctionExpression;
1575
2742
  /* Excluded from this release type: _getUsedColumns */
1576
2743
  }
1577
2744
 
2745
+ /**
2746
+ * @public
2747
+ * @description Configuration of expression with macros function.
2748
+ */
1578
2749
  export declare type ɵMacrosFunctionExpressionConfig = ɵFunctionExpressionConfig<ɵMacrosFunctionExpression> & Pick<ɵMacrosFunctionExpression, 'macrosType'>;
1579
2750
 
1580
2751
  /**
1581
2752
  * @public
2753
+ * @description Message channel event.
2754
+ * @property {string} sender - target sender of message.
2755
+ * @property {string} bodyTypeName - type of body.
2756
+ * @property {ɵGuid} id - {@link ɵGuid} - Actual event id.
2757
+ * @property {T} body - message body.
2758
+ */
2759
+ export declare interface ɵMessageChannelEvent<T = unknown> {
2760
+ header: {
2761
+ sender: string;
2762
+ bodyTypeName: string;
2763
+ };
2764
+ body: T;
2765
+ id: ɵGuid;
2766
+ }
2767
+
2768
+ /**
2769
+ * @public
2770
+ * @description type of sending message.
2771
+ */
2772
+ export declare enum ɵMessageChannelType {
2773
+ PTP = "PTPMsg",
2774
+ BROADCAST = "BroadcastMsg"
2775
+ }
2776
+
2777
+ /**
2778
+ * @public
2779
+ * @description Provider to work with metadata.
1582
2780
  */
1583
2781
  export declare interface ɵMetadataProvider<T> {
2782
+ /**
2783
+ * @public
2784
+ * @description Returns metadata.
2785
+ */
1584
2786
  getMetadata(): T;
1585
2787
  }
1586
2788
 
@@ -1649,35 +2851,91 @@ export declare enum ɵModelInPageAction {
1649
2851
 
1650
2852
  /**
1651
2853
  * @public
2854
+ * @description Enum for model parameter types.
1652
2855
  */
1653
2856
  export declare enum ɵModelParameterType {
2857
+ /**
2858
+ * @public
2859
+ * @description Parameter represents primary column value.
2860
+ */
1654
2861
  PrimaryColumnValue = "primaryColumnValue",
2862
+ /**
2863
+ * @public
2864
+ * @description Parameter represents column value.
2865
+ */
1655
2866
  ColumnValue = "columnValue",
2867
+ /**
2868
+ * @public
2869
+ * @description Parameter represents filter value.
2870
+ */
1656
2871
  Filter = "filter",
2872
+ /**
2873
+ * @public
2874
+ * @description Parameter represents primary display value filter.
2875
+ */
1657
2876
  PrimaryDisplayValueFilter = "primaryDisplayValueFilter",
2877
+ /**
2878
+ * @public
2879
+ * @description Parameter is empty.
2880
+ */
1658
2881
  Empty = "empty",
2882
+ /**
2883
+ * @public
2884
+ * @description Parameter is never used.
2885
+ */
1659
2886
  Never = "never"
1660
2887
  }
1661
2888
 
1662
2889
  /**
1663
2890
  * @public
2891
+ * @description An exception thrown when next handler already specified.
1664
2892
  */
1665
2893
  export declare class ɵNextHandlerAlreadySpecifiedException extends Error {
1666
2894
  constructor();
1667
2895
  }
1668
2896
 
2897
+ /**
2898
+ * @public
2899
+ * @description Sort order (can be set to None).
2900
+ */
1669
2901
  export declare enum ɵOrderDirection {
2902
+ /**
2903
+ * @description Order not defined.
2904
+ * */
1670
2905
  None = 0,
2906
+ /**
2907
+ * @description Ascending.
2908
+ * */
1671
2909
  Asc = 1,
2910
+ /**
2911
+ * @description Descending.
2912
+ * */
1672
2913
  Desc = 2
1673
2914
  }
1674
2915
 
2916
+ /**
2917
+ * @public
2918
+ * @description The class that defines the parametric expression.
2919
+ * @extends {ɵBaseExpression}
2920
+ */
1675
2921
  export declare class ɵParameterExpression extends ɵBaseExpression {
1676
2922
  /* Excluded from this release type: _instanceOfKey */
1677
2923
  /* Excluded from this release type: _instanceOfKeys */
2924
+ /**
2925
+ * @description Type of expression.
2926
+ */
1678
2927
  readonly expressionType: ɵExpressionType;
2928
+ /**
2929
+ * @description Parameter value.
2930
+ */
1679
2931
  readonly value: ɵEntityColumnValue;
2932
+ /**
2933
+ * @description Parameter value type.
2934
+ */
1680
2935
  readonly dataValueType: ɵDataValueType;
2936
+ /**
2937
+ * @description Parameter object reference.
2938
+ */
1681
2939
  readonly parameter: {
1682
2940
  value?: ɵEntityColumnValue;
1683
2941
  arrayValue?: string[];
@@ -1691,20 +2949,29 @@ export declare class ɵParameterExpression extends ɵBaseExpression {
1691
2949
  static fromJson(dto: ɵJsonObject): ɵParameterExpression;
1692
2950
  private _convertStringToBlobArray;
1693
2951
  private _getParameterValueMetadata;
2952
+ /**
2953
+ * @description Returns cloned instance.
2954
+ */
1694
2955
  clone(): ɵParameterExpression;
1695
2956
  /* Excluded from this release type: _getUsedColumns */
1696
2957
  }
1697
2958
 
2959
+ /**
2960
+ * @public
2961
+ * @description Configuration of parametric expression.
2962
+ */
1698
2963
  export declare type ɵParameterExpressionConfig = ɵExpressionConfig<ɵParameterExpression> & Pick<ɵParameterExpression, 'value'>;
1699
2964
 
2965
+ /**
2966
+ * @public
2967
+ * @classdesc Class contains info about column that contains parameter.
2968
+ * @extends {ɵBaseQueryColumn}
2969
+ */
1700
2970
  export declare class ɵParameterQueryColumn extends ɵBaseQueryColumn<ɵParameterExpression> {
1701
2971
  constructor(value: ɵEntityColumnValue, dataValueType?: ɵDataValueType);
1702
2972
  }
1703
2973
 
1704
- export declare const ɵparserMock: {
1705
- fromJson: (data: any) => any;
1706
- clone: () => undefined;
1707
- };
2974
+ /* Excluded from this release type: ɵparserMock */
1708
2975
 
1709
2976
  /**
1710
2977
  * Available platform APIs
@@ -1718,95 +2985,198 @@ export declare enum ɵPlatformAPIs {
1718
2985
 
1719
2986
  /**
1720
2987
  * @public
2988
+ * @description Data source parameter for primary display value filtering.
2989
+ * @extends {ɵBaseDataSourceParameter}
1721
2990
  */
1722
2991
  export declare interface ɵPrimaryDisplayFilterDataSourceParameter extends ɵBaseDataSourceParameter {
2992
+ /**
2993
+ * @public
2994
+ * @description Type of parameter. Always 'primaryDisplayValueFilter'.
2995
+ */
1723
2996
  type: ɵModelParameterType.PrimaryDisplayValueFilter;
2997
+ /**
2998
+ * @public
2999
+ * @description Value of parameter.
3000
+ */
1724
3001
  value: string;
3002
+ /**
3003
+ * @public
3004
+ * @description Comparison type for filtering.
3005
+ */
1725
3006
  comparisonType: ɵComparisonType;
1726
3007
  }
1727
3008
 
3009
+ /**
3010
+ * @public
3011
+ * @description The type of macros.
3012
+ */
1728
3013
  export declare enum ɵQueryMacrosType {
1729
- /** Macro type not defined. */
3014
+ /**
3015
+ * @description Macro type not defined.
3016
+ */
1730
3017
  None = 0,
1731
- /** Current user. */
3018
+ /**
3019
+ * @description Current user.
3020
+ */
1732
3021
  CurrentUser = 1,
1733
- /** Current user contact. */
3022
+ /**
3023
+ * @description Current user contact.
3024
+ */
1734
3025
  CurrentUserContact = 2,
1735
- /** Yesterday. */
3026
+ /**
3027
+ * @description Yesterday.
3028
+ */
1736
3029
  Yesterday = 3,
1737
- /** Today. */
3030
+ /**
3031
+ * @description Today.
3032
+ */
1738
3033
  Today = 4,
1739
- /** Tomorrow. */
3034
+ /**
3035
+ * @description Tomorrow.
3036
+ */
1740
3037
  Tomorrow = 5,
1741
- /** Previous week. */
3038
+ /**
3039
+ * @description Previous week.
3040
+ */
1742
3041
  PreviousWeek = 6,
1743
- /** This week. */
3042
+ /**
3043
+ * @description This week.
3044
+ */
1744
3045
  CurrentWeek = 7,
1745
- /** Next week. */
3046
+ /**
3047
+ * @description Next week.
3048
+ */
1746
3049
  NextWeek = 8,
1747
- /** Previous month. */
3050
+ /**
3051
+ * @description Previous month.
3052
+ */
1748
3053
  PreviousMonth = 9,
1749
- /** Current month. */
3054
+ /**
3055
+ * @description Current month.
3056
+ */
1750
3057
  CurrentMonth = 10,
1751
- /** Next month. */
3058
+ /**
3059
+ * @description Next month.
3060
+ */
1752
3061
  NextMonth = 11,
1753
- /** Previous quarter. */
3062
+ /**
3063
+ * @description Previous quarter.
3064
+ */
1754
3065
  PreviousQuarter = 12,
1755
- /** Current quarter. */
3066
+ /**
3067
+ * @description Current quarter.
3068
+ */
1756
3069
  CurrentQuarter = 13,
1757
- /** Next quarter. */
3070
+ /**
3071
+ * @description Next quarter.
3072
+ */
1758
3073
  NextQuarter = 14,
1759
- /** Previous half of the year. */
3074
+ /**
3075
+ * @description Previous half of the year.
3076
+ */
1760
3077
  PreviousHalfYear = 15,
1761
- /** Current half-year. */
3078
+ /**
3079
+ * @description Current half-year.
3080
+ */
1762
3081
  CurrentHalfYear = 16,
1763
- /** Next half-year. */
3082
+ /**
3083
+ * @description Next half-year.
3084
+ */
1764
3085
  NextHalfYear = 17,
1765
- /** Last year. */
3086
+ /**
3087
+ * @description Last year.
3088
+ */
1766
3089
  PreviousYear = 18,
1767
- /** This year. */
3090
+ /**
3091
+ * @description This year.
3092
+ */
1768
3093
  CurrentYear = 19,
1769
- /** Previous hour. */
3094
+ /**
3095
+ * @description Previous hour.
3096
+ */
1770
3097
  PreviousHour = 20,
1771
- /** Current hour. */
3098
+ /**
3099
+ * @description Current hour.
3100
+ */
1772
3101
  CurrentHour = 21,
1773
- /** Next hour. */
3102
+ /**
3103
+ * @description Next hour.
3104
+ */
1774
3105
  NextHour = 22,
1775
- /** Next year. */
3106
+ /**
3107
+ * @description Next year.
3108
+ */
1776
3109
  NextYear = 23,
1777
- /** Next N Days. */
3110
+ /**
3111
+ * @description Next N Days.
3112
+ */
1778
3113
  NextNDays = 24,
1779
- /** Previous N days. */
3114
+ /**
3115
+ * @description Previous N days.
3116
+ */
1780
3117
  PreviousNDays = 25,
1781
- /** Next N hours. */
3118
+ /**
3119
+ * @description Next N hours.
3120
+ */
1782
3121
  NextNHours = 26,
1783
- /** Previous N hours. */
3122
+ /**
3123
+ * @description Previous N hours.
3124
+ */
1784
3125
  PreviousNHours = 27,
1785
- /** Primary column. */
3126
+ /**
3127
+ * @description Primary column.
3128
+ */
1786
3129
  PrimaryColumn = 34,
1787
- /** Primary displayed column. */
3130
+ /**
3131
+ * @description Primary displayed column.
3132
+ */
1788
3133
  PrimaryDisplayColumn = 35,
1789
- /** Primary image display column. */
3134
+ /**
3135
+ * @description Primary image display column.
3136
+ */
1790
3137
  PrimaryImageColumn = 36,
1791
- /** Anniversary today. */
3138
+ /**
3139
+ * @description Anniversary today.
3140
+ */
1792
3141
  DayOfYearToday = 37,
1793
- /** Anniversary on the date computed as today plus days offset. */
3142
+ /**
3143
+ * @description Anniversary on the date computed as today plus days offset.
3144
+ */
1794
3145
  DayOfYearTodayPlusDaysOffset = 38,
1795
- /** Anniversary on the next several days. */
3146
+ /**
3147
+ * @description Anniversary on the next several days.
3148
+ */
1796
3149
  NextNDaysOfYear = 39,
1797
- /** Anniversary on the previous several days. */
3150
+ /**
3151
+ * @description Anniversary on the previous several days.
3152
+ */
1798
3153
  PreviousNDaysOfYear = 40,
1799
- /** Primary color display column. */
3154
+ /**
3155
+ * @description Primary color display column.
3156
+ */
1800
3157
  PrimaryColorColumn = 41
1801
3158
  }
1802
3159
 
1803
3160
  /**
1804
3161
  * @public
3162
+ * @description Type of data query
1805
3163
  */
1806
3164
  export declare enum ɵQueryOperationType {
3165
+ /**
3166
+ * @description Select query.
3167
+ */
1807
3168
  Select = 0,
3169
+ /**
3170
+ * @description Insert query.
3171
+ */
1808
3172
  Insert = 1,
3173
+ /**
3174
+ * @description Edit query.
3175
+ */
1809
3176
  Update = 2,
3177
+ /**
3178
+ * @description Delete query.
3179
+ */
1810
3180
  Delete = 3
1811
3181
  }
1812
3182
 
@@ -1871,6 +3241,9 @@ export declare class ɵSchemaViewMaskRequest extends ɵBaseRequest {
1871
3241
  readonly action: ɵSchemaViewMaskRequestAction;
1872
3242
  readonly taskName: string;
1873
3243
  readonly $context: ɵViewModelContext;
3244
+ /**
3245
+ * @description Request type
3246
+ */
1874
3247
  readonly type = "crt.SchemaViewMaskRequest";
1875
3248
  constructor(action: ɵSchemaViewMaskRequestAction, taskName: string, $context: ɵViewModelContext);
1876
3249
  }
@@ -1880,35 +3253,72 @@ export declare class ɵSchemaViewMaskRequest extends ɵBaseRequest {
1880
3253
  * @description Actions of mask request.
1881
3254
  */
1882
3255
  export declare enum ɵSchemaViewMaskRequestAction {
3256
+ /**
3257
+ * @description To add task.
3258
+ */
1883
3259
  AddTask = "addTask",
3260
+ /**
3261
+ * @description To remove task.
3262
+ */
1884
3263
  RemoveTask = "removeTask"
1885
3264
  }
1886
3265
 
1887
3266
  /**
1888
3267
  * @public
3268
+ * @description The query class for localized data fetching.
3269
+ * @extends {ɵEntitySchemaQuery}
1889
3270
  */
1890
3271
  export declare class ɵSelectLocalizationQuery extends ɵEntitySchemaQuery {
1891
3272
  }
1892
3273
 
3274
+ /**
3275
+ * @public
3276
+ * @description Interface which add ability for serialize any object.
3277
+ */
1893
3278
  export declare interface ɵSerializable {
3279
+ /**
3280
+ * @public
3281
+ * @description Converts instance to json object.
3282
+ */
1894
3283
  toJson(): ɵJsonObject;
1895
3284
  }
1896
3285
 
3286
+ /**
3287
+ * @public
3288
+ * @description Basic filter class with one condition.
3289
+ * @extends {ɵBaseFilter}
3290
+ */
1897
3291
  export declare abstract class ɵSingleFilter extends ɵBaseFilter {
1898
3292
  /* Excluded from this release type: _instanceOfKey */
1899
3293
  /* Excluded from this release type: _instanceOfKeys */
3294
+ /**
3295
+ * @description Type of comparison operation.
3296
+ */
1900
3297
  readonly comparisonType: ɵComparisonType;
3298
+ /**
3299
+ * @description The test expression.
3300
+ */
1901
3301
  readonly leftExpression: ɵBaseExpression;
1902
3302
  protected constructor(filterType: ɵFilterType, comparisonType: ɵComparisonType, leftExpression: ɵBaseExpression);
3303
+ /** {@inheritDoc ɵSerializable.toJson} */
1903
3304
  toJson(): ɵJsonObject;
1904
3305
  /* Excluded from this release type: _getUsedColumns */
1905
3306
  }
1906
3307
 
1907
3308
  /**
1908
3309
  * @public
3310
+ * @description Config for column with soring.
3311
+ * @property {string} columnName - Column name.
3312
+ * @property {ɵSortDirection} direction - Sort direction.
1909
3313
  */
1910
3314
  export declare interface ɵSortColumnOptions {
3315
+ /**
3316
+ * @description Column name.
3317
+ */
1911
3318
  columnName: string;
3319
+ /**
3320
+ * @description Sort direction.
3321
+ */
1912
3322
  direction: ɵSortDirection;
1913
3323
  }
1914
3324
 
@@ -1918,17 +3328,42 @@ export declare interface ɵSortColumnOptions {
1918
3328
  */
1919
3329
  export declare type ɵSortDirection = 'asc' | 'desc' | 'none';
1920
3330
 
3331
+ /**
3332
+ * @public
3333
+ * @classdesc Class contains info about column with sub query.
3334
+ * @extends {ɵBaseQueryColumn}
3335
+ */
1921
3336
  export declare class ɵSubQueryColumn extends ɵBaseQueryColumn<ɵSubQueryExpression> {
1922
3337
  constructor(columnPath: string, subFilters?: ɵFilterGroup);
1923
3338
  }
1924
3339
 
3340
+ /**
3341
+ * @public
3342
+ * @description The class that defines the sub query expression.
3343
+ * @extends {ɵBaseExpression}
3344
+ */
1925
3345
  export declare class ɵSubQueryExpression extends ɵBaseExpression {
1926
3346
  /* Excluded from this release type: _instanceOfKey */
1927
3347
  /* Excluded from this release type: _instanceOfKeys */
3348
+ /**
3349
+ * @description Type of expression.
3350
+ */
1928
3351
  readonly expressionType: ɵExpressionType;
3352
+ /**
3353
+ * @description The path to the column is relative to root schema.
3354
+ */
1929
3355
  columnPath: string;
3356
+ /**
3357
+ * @description Sub-query filters. Can not contain filters with other sub-queries.
3358
+ */
1930
3359
  readonly subFilters: ɵFilterGroup;
3360
+ /**
3361
+ * @description Order direction.
3362
+ */
1931
3363
  readonly subOrderDirection?: number;
3364
+ /**
3365
+ * @description Column for order.
3366
+ */
1932
3367
  readonly subOrderColumn?: string;
1933
3368
  constructor(config: ɵSubQueryExpressionConfig);
1934
3369
  /**
@@ -1936,13 +3371,25 @@ export declare class ɵSubQueryExpression extends ɵBaseExpression {
1936
3371
  * @public
1937
3372
  */
1938
3373
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser>(dto: ɵJsonObject, filterParser: TFilterParser): ɵSubQueryExpression;
3374
+ /** {@inheritDoc ɵBaseExpression.clone} */
1939
3375
  clone(): ɵSubQueryExpression;
3376
+ /** {@inheritDoc ɵBaseExpression.toJson} */
1940
3377
  toJson(): ɵJsonObject;
1941
3378
  /* Excluded from this release type: _getUsedColumns */
1942
3379
  }
1943
3380
 
3381
+ /**
3382
+ * @public
3383
+ * @description Configuration for sub query expression.
3384
+ */
1944
3385
  export declare type ɵSubQueryExpressionConfig = ɵExpressionConfig<ɵSubQueryExpression> & Pick<ɵSubQueryExpression, 'columnPath'>;
1945
3386
 
3387
+ /**
3388
+ * @public
3389
+ * @description A function executed as part of the finalization.
3390
+ */
3391
+ export declare type ɵTeardownLogic = () => void;
3392
+
1946
3393
  /**
1947
3394
  * @public
1948
3395
  * Returns a string represent of date in ISO 8601 without time zone specification(doesn't convert it
@@ -1966,30 +3413,73 @@ export declare type ɵType<T = any> = new (...args: any[]) => T;
1966
3413
 
1967
3414
  /**
1968
3415
  * @public
3416
+ * @description Request for data changes.
3417
+ * @extends {ɵBaseFilterableQuery}
1969
3418
  */
1970
3419
  export declare class ɵUpdateQuery extends ɵBaseFilterableQuery {
1971
3420
  private _columnValues;
1972
3421
  /**
1973
- * Flag that indicates whether to force save data.
3422
+ * @description Flag that indicates whether to force save data.
1974
3423
  */
1975
3424
  isForceUpdate: boolean;
1976
3425
  constructor(rootSchemaName: string);
3426
+ /**
3427
+ * @description A collection of column values for updating entities.
3428
+ */
1977
3429
  get columnValues(): {
1978
3430
  items: {
1979
3431
  [key: string]: ɵParameterExpression;
1980
3432
  };
1981
3433
  };
3434
+ /**
3435
+ * @public
3436
+ * @description Adds the value parameter. An instance of the value-parameter is created and
3437
+ * is added to the column values collection.
3438
+ * @param columnName The alias of the column to set value in
3439
+ * @param columnValue The value of the parameter. The value must match the data type.
3440
+ * @param dataValueType The type of the given parameter value.
3441
+ */
1982
3442
  addColumn(columnName: string, columnValue: ɵEntityColumnValue, dataValueType: ɵDataValueType): void;
1983
3443
  }
1984
3444
 
3445
+ /**
3446
+ * @public
3447
+ * @description Utilities class with various validation methods.
3448
+ */
1985
3449
  export declare class ɵValidationUtilities {
3450
+ /**
3451
+ * @public
3452
+ * @description Checks if argument is empty.
3453
+ * @param argumentName - Argument name.
3454
+ * @param argumentValue - Value of argument.
3455
+ */
1986
3456
  static checkArgumentEmpty<T>(argumentName: string, argumentValue: T | null | undefined): asserts argumentValue is T;
3457
+ /**
3458
+ * @public
3459
+ * @description Checks if array is empty.
3460
+ * @param argumentName - Argument name.
3461
+ * @param argumentValue - Value of argument.
3462
+ */
1987
3463
  static checkArrayEmpty<T>(argumentName: string, argumentValue: ArrayLike<T>): void;
3464
+ /**
3465
+ * @public
3466
+ * @description Checks if string is empty.
3467
+ * @param argumentName - Argument name.
3468
+ * @param argumentValue - Value of argument.
3469
+ */
1988
3470
  static checkStringIsNotEmpty(argumentName: string, argumentValue: string): string;
3471
+ /**
3472
+ * @public
3473
+ * @description Checks if argument in range.
3474
+ * @param argumentName - Argument name.
3475
+ * @param argumentValue - Value of argument.
3476
+ * @param range - Range.
3477
+ */
1989
3478
  static checkArgumentOutOfRange(argumentName: string, argumentValue: number, range: {
1990
3479
  begin?: number;
1991
3480
  end?: number;
1992
3481
  }): void;
3482
+ static checkEnumOutOfRange(argumentName: string, argumentValue: string, range: Record<string, unknown> | unknown): void;
1993
3483
  }
1994
3484
 
1995
3485
  /**
@@ -2010,17 +3500,36 @@ export declare interface ɵViewModelCollection<T extends ɵViewModelContext> {
2010
3500
  * Could contain any pair of key-value
2011
3501
  */
2012
3502
  export declare interface ɵViewModelContext {
3503
+ /**
3504
+ * @description Key value pair.
3505
+ */
2013
3506
  [key: string]: any;
2014
3507
  }
2015
3508
 
3509
+ /**
3510
+ * @public
3511
+ * @classdesc Class contains info about column with window function.
3512
+ * @extends {ɵBaseQueryColumn}
3513
+ */
2016
3514
  export declare class ɵWindowFunctionColumn extends ɵBaseQueryColumn<ɵWindowFunctionExpression> {
2017
3515
  constructor(functionArgument: ɵAggregationFunctionExpression);
2018
3516
  }
2019
3517
 
3518
+ /**
3519
+ * @public
3520
+ * @description A class that describes expression with window function.
3521
+ * @extends {ɵArgumentFunctionExpression}
3522
+ */
2020
3523
  export declare class ɵWindowFunctionExpression extends ɵArgumentFunctionExpression {
2021
3524
  /* Excluded from this release type: _instanceOfKey */
2022
3525
  /* Excluded from this release type: _instanceOfKeys */
3526
+ /**
3527
+ * @description Function type.
3528
+ */
2023
3529
  readonly functionType: ɵFunctionType;
3530
+ /**
3531
+ * @description Function argument
3532
+ */
2024
3533
  readonly functionArgument: ɵAggregationFunctionExpression;
2025
3534
  constructor(config: ɵWindowFunctionExpressionConfig);
2026
3535
  /**
@@ -2028,9 +3537,14 @@ export declare class ɵWindowFunctionExpression extends ɵArgumentFunctionExpres
2028
3537
  * @public
2029
3538
  */
2030
3539
  static fromJson<TFilterParser extends typeof ɵBaseFilterParser, TExpressionParser extends typeof ɵBaseExpressionParser>(dto: ɵJsonObject, filterParser: TFilterParser, expressionParser?: TExpressionParser): ɵWindowFunctionExpression;
3540
+ /** {@inheritDoc ɵBaseExpression.clone} */
2031
3541
  clone(): ɵWindowFunctionExpression;
2032
3542
  }
2033
3543
 
3544
+ /**
3545
+ * @public
3546
+ * @description Configuration for window funcion expression.
3547
+ */
2034
3548
  export declare type ɵWindowFunctionExpressionConfig = ɵArgumentFunctionExpressionConfig<ɵWindowFunctionExpression>;
2035
3549
 
2036
3550
  export { }