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