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