@sitecore/sc-contenthub-webclient-sdk 0.9.7

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 (636) hide show
  1. package/LICENSE +24 -0
  2. package/dist/api/api-info-resource.d.ts +8 -0
  3. package/dist/api/api-info-resource.js +42 -0
  4. package/dist/api/api-info.d.ts +29 -0
  5. package/dist/api/api-info.js +14 -0
  6. package/dist/api/api-resource.d.ts +4 -0
  7. package/dist/api/api-resource.js +16 -0
  8. package/dist/api/api-routes-dictionary.d.ts +8 -0
  9. package/dist/api/api-routes-dictionary.js +10 -0
  10. package/dist/authentication/oauth-grant-base.d.ts +6 -0
  11. package/dist/authentication/oauth-grant-base.js +42 -0
  12. package/dist/authentication/oauth-grant-type.d.ts +4 -0
  13. package/dist/authentication/oauth-grant-type.js +8 -0
  14. package/dist/authentication/oauth-password-grant.d.ts +8 -0
  15. package/dist/authentication/oauth-password-grant.js +45 -0
  16. package/dist/authentication/oauth-refreshtoken-grant.d.ts +7 -0
  17. package/dist/authentication/oauth-refreshtoken-grant.js +39 -0
  18. package/dist/authentication/token-info.d.ts +6 -0
  19. package/dist/authentication/token-info.js +35 -0
  20. package/dist/base-types.d.ts +56 -0
  21. package/dist/base-types.js +32 -0
  22. package/dist/caches/culture-cache.d.ts +8 -0
  23. package/dist/caches/culture-cache.js +21 -0
  24. package/dist/caches/entity-definition-cache.d.ts +44 -0
  25. package/dist/caches/entity-definition-cache.js +96 -0
  26. package/dist/clients/api-client.d.ts +56 -0
  27. package/dist/clients/api-client.js +107 -0
  28. package/dist/clients/commands-client.d.ts +16 -0
  29. package/dist/clients/commands-client.js +40 -0
  30. package/dist/clients/content-hub-client.d.ts +75 -0
  31. package/dist/clients/content-hub-client.js +66 -0
  32. package/dist/clients/culture-client.d.ts +36 -0
  33. package/dist/clients/culture-client.js +43 -0
  34. package/dist/clients/culture-loader.d.ts +41 -0
  35. package/dist/clients/culture-loader.js +103 -0
  36. package/dist/clients/entities-client.d.ts +201 -0
  37. package/dist/clients/entities-client.js +271 -0
  38. package/dist/clients/entity-definitions-client.d.ts +87 -0
  39. package/dist/clients/entity-definitions-client.js +354 -0
  40. package/dist/clients/extended-client.d.ts +11 -0
  41. package/dist/clients/extended-client.js +2 -0
  42. package/dist/clients/internal-client.d.ts +46 -0
  43. package/dist/clients/internal-client.js +240 -0
  44. package/dist/clients/notifications-client.d.ts +35 -0
  45. package/dist/clients/notifications-client.js +128 -0
  46. package/dist/clients/option-list-client.d.ts +49 -0
  47. package/dist/clients/option-list-client.js +85 -0
  48. package/dist/clients/pages-client.d.ts +36 -0
  49. package/dist/clients/pages-client.js +52 -0
  50. package/dist/clients/policies-client.d.ts +47 -0
  51. package/dist/clients/policies-client.js +92 -0
  52. package/dist/clients/querying-client.d.ts +34 -0
  53. package/dist/clients/querying-client.js +95 -0
  54. package/dist/clients/raw-client.d.ts +29 -0
  55. package/dist/clients/raw-client.js +79 -0
  56. package/dist/clients/request-message.d.ts +25 -0
  57. package/dist/clients/request-message.js +12 -0
  58. package/dist/clients/response-handler.d.ts +30 -0
  59. package/dist/clients/response-handler.js +145 -0
  60. package/dist/clients/response-message.d.ts +45 -0
  61. package/dist/clients/response-message.js +34 -0
  62. package/dist/clients/schema-querying.d.ts +16 -0
  63. package/dist/clients/schema-querying.js +70 -0
  64. package/dist/clients/search-client.d.ts +16 -0
  65. package/dist/clients/search-client.js +36 -0
  66. package/dist/clients/settings-client.d.ts +37 -0
  67. package/dist/clients/settings-client.js +126 -0
  68. package/dist/clients/users-client.d.ts +150 -0
  69. package/dist/clients/users-client.js +317 -0
  70. package/dist/clients/web-content-hub-client.d.ts +13 -0
  71. package/dist/clients/web-content-hub-client.js +2 -0
  72. package/dist/constants/api.d.ts +130 -0
  73. package/dist/constants/api.js +133 -0
  74. package/dist/constants/defaults.d.ts +7 -0
  75. package/dist/constants/defaults.js +10 -0
  76. package/dist/constants/definitions.d.ts +62 -0
  77. package/dist/constants/definitions.js +88 -0
  78. package/dist/constants/index.d.ts +5 -0
  79. package/dist/constants/index.js +30 -0
  80. package/dist/constants/notifications.d.ts +7 -0
  81. package/dist/constants/notifications.js +10 -0
  82. package/dist/contracts/base/culture-insensitive-property.d.ts +28 -0
  83. package/dist/contracts/base/culture-insensitive-property.js +47 -0
  84. package/dist/contracts/base/culture-sensitive-property.d.ts +49 -0
  85. package/dist/contracts/base/culture-sensitive-property.js +113 -0
  86. package/dist/contracts/base/data-type.d.ts +18 -0
  87. package/dist/contracts/base/data-type.js +24 -0
  88. package/dist/contracts/base/entity-base.d.ts +65 -0
  89. package/dist/contracts/base/entity-base.js +362 -0
  90. package/dist/contracts/base/entity-construction-args.d.ts +15 -0
  91. package/dist/contracts/base/entity-construction-args.js +16 -0
  92. package/dist/contracts/base/entity-definition.d.ts +108 -0
  93. package/dist/contracts/base/entity-definition.js +126 -0
  94. package/dist/contracts/base/entity.d.ts +237 -0
  95. package/dist/contracts/base/entity.js +76 -0
  96. package/dist/contracts/base/index.d.ts +14 -0
  97. package/dist/contracts/base/index.js +26 -0
  98. package/dist/contracts/base/json-content-type.d.ts +9 -0
  99. package/dist/contracts/base/json-content-type.js +13 -0
  100. package/dist/contracts/base/lazy-loading-manager.d.ts +4 -0
  101. package/dist/contracts/base/lazy-loading-manager.js +17 -0
  102. package/dist/contracts/base/member-condition.d.ts +48 -0
  103. package/dist/contracts/base/member-condition.js +125 -0
  104. package/dist/contracts/base/member-definition-type.d.ts +13 -0
  105. package/dist/contracts/base/member-definition-type.js +17 -0
  106. package/dist/contracts/base/member-definition.d.ts +77 -0
  107. package/dist/contracts/base/member-definition.js +101 -0
  108. package/dist/contracts/base/member-group.d.ts +54 -0
  109. package/dist/contracts/base/member-group.js +61 -0
  110. package/dist/contracts/base/member.d.ts +32 -0
  111. package/dist/contracts/base/member.js +26 -0
  112. package/dist/contracts/base/option-lists/flat-option-list-value.d.ts +4 -0
  113. package/dist/contracts/base/option-lists/flat-option-list-value.js +9 -0
  114. package/dist/contracts/base/option-lists/flat-option-list.d.ts +9 -0
  115. package/dist/contracts/base/option-lists/flat-option-list.js +11 -0
  116. package/dist/contracts/base/option-lists/hierarchical-option-list.d.ts +9 -0
  117. package/dist/contracts/base/option-lists/hierarchical-option-list.js +11 -0
  118. package/dist/contracts/base/option-lists/hierarchical-options-list-value.d.ts +7 -0
  119. package/dist/contracts/base/option-lists/hierarchical-options-list-value.js +14 -0
  120. package/dist/contracts/base/option-lists/option-list-base.d.ts +23 -0
  121. package/dist/contracts/base/option-lists/option-list-base.js +33 -0
  122. package/dist/contracts/base/option-lists/option-list-type.d.ts +13 -0
  123. package/dist/contracts/base/option-lists/option-list-type.js +17 -0
  124. package/dist/contracts/base/option-lists/option-list-value-base.d.ts +7 -0
  125. package/dist/contracts/base/option-lists/option-list-value-base.js +14 -0
  126. package/dist/contracts/base/option-lists/option-list-value.d.ts +30 -0
  127. package/dist/contracts/base/option-lists/option-list-value.js +2 -0
  128. package/dist/contracts/base/option-lists/option-list.d.ts +40 -0
  129. package/dist/contracts/base/option-lists/option-list.js +2 -0
  130. package/dist/contracts/base/property-definition.d.ts +61 -0
  131. package/dist/contracts/base/property-definition.js +76 -0
  132. package/dist/contracts/base/property-definitions/boolean-property-definition.d.ts +7 -0
  133. package/dist/contracts/base/property-definitions/boolean-property-definition.js +33 -0
  134. package/dist/contracts/base/property-definitions/datetime-property-definition.d.ts +7 -0
  135. package/dist/contracts/base/property-definitions/datetime-property-definition.js +33 -0
  136. package/dist/contracts/base/property-definitions/datetimeoffset-property-definition.d.ts +7 -0
  137. package/dist/contracts/base/property-definitions/datetimeoffset-property-definition.js +33 -0
  138. package/dist/contracts/base/property-definitions/decimal-property-definition.d.ts +7 -0
  139. package/dist/contracts/base/property-definitions/decimal-property-definition.js +33 -0
  140. package/dist/contracts/base/property-definitions/index.d.ts +8 -0
  141. package/dist/contracts/base/property-definitions/index.js +20 -0
  142. package/dist/contracts/base/property-definitions/integer-property-definition.d.ts +7 -0
  143. package/dist/contracts/base/property-definitions/integer-property-definition.js +33 -0
  144. package/dist/contracts/base/property-definitions/json-property-definition.d.ts +10 -0
  145. package/dist/contracts/base/property-definitions/json-property-definition.js +38 -0
  146. package/dist/contracts/base/property-definitions/long-property-definition.d.ts +7 -0
  147. package/dist/contracts/base/property-definitions/long-property-definition.js +33 -0
  148. package/dist/contracts/base/property-definitions/string-property-definition.d.ts +33 -0
  149. package/dist/contracts/base/property-definitions/string-property-definition.js +55 -0
  150. package/dist/contracts/base/property-manager.d.ts +19 -0
  151. package/dist/contracts/base/property-manager.js +114 -0
  152. package/dist/contracts/base/property.d.ts +21 -0
  153. package/dist/contracts/base/property.js +30 -0
  154. package/dist/contracts/base/relation-cardinality.d.ts +19 -0
  155. package/dist/contracts/base/relation-cardinality.js +22 -0
  156. package/dist/contracts/base/relation-container.d.ts +40 -0
  157. package/dist/contracts/base/relation-container.js +118 -0
  158. package/dist/contracts/base/relation-definition.d.ts +123 -0
  159. package/dist/contracts/base/relation-definition.js +116 -0
  160. package/dist/contracts/base/relation-manager.d.ts +70 -0
  161. package/dist/contracts/base/relation-manager.js +197 -0
  162. package/dist/contracts/base/relation-role.d.ts +14 -0
  163. package/dist/contracts/base/relation-role.js +17 -0
  164. package/dist/contracts/base/relation.d.ts +74 -0
  165. package/dist/contracts/base/relation.js +40 -0
  166. package/dist/contracts/base/relations/child-to-many-parents-relation.d.ts +27 -0
  167. package/dist/contracts/base/relations/child-to-many-parents-relation.js +67 -0
  168. package/dist/contracts/base/relations/child-to-one-parent-relation.d.ts +26 -0
  169. package/dist/contracts/base/relations/child-to-one-parent-relation.js +74 -0
  170. package/dist/contracts/base/relations/parent-to-many-children-relation.d.ts +27 -0
  171. package/dist/contracts/base/relations/parent-to-many-children-relation.js +67 -0
  172. package/dist/contracts/base/relations/parent-to-one-child-relation.d.ts +29 -0
  173. package/dist/contracts/base/relations/parent-to-one-child-relation.js +74 -0
  174. package/dist/contracts/base/relations/to-many-relation.d.ts +16 -0
  175. package/dist/contracts/base/relations/to-many-relation.js +2 -0
  176. package/dist/contracts/base/relations/to-one-relation.d.ts +18 -0
  177. package/dist/contracts/base/relations/to-one-relation.js +2 -0
  178. package/dist/contracts/base/rendition.d.ts +14 -0
  179. package/dist/contracts/base/rendition.js +13 -0
  180. package/dist/contracts/base/resource.d.ts +21 -0
  181. package/dist/contracts/base/resource.js +2 -0
  182. package/dist/contracts/base/string-content-type.d.ts +21 -0
  183. package/dist/contracts/base/string-content-type.js +25 -0
  184. package/dist/contracts/base/typed-entity.d.ts +11 -0
  185. package/dist/contracts/base/typed-entity.js +2 -0
  186. package/dist/contracts/base/users.d.ts +0 -0
  187. package/dist/contracts/base/users.js +1 -0
  188. package/dist/contracts/base/view-mode.d.ts +4 -0
  189. package/dist/contracts/base/view-mode.js +8 -0
  190. package/dist/contracts/content/asset.d.ts +22 -0
  191. package/dist/contracts/content/asset.js +67 -0
  192. package/dist/contracts/content/final-life-cycle-status.d.ts +7 -0
  193. package/dist/contracts/content/final-life-cycle-status.js +11 -0
  194. package/dist/contracts/dirty-tracking/dirty-tracking.d.ts +10 -0
  195. package/dist/contracts/dirty-tracking/dirty-tracking.js +2 -0
  196. package/dist/contracts/notifications/mail-template.d.ts +44 -0
  197. package/dist/contracts/notifications/mail-template.js +2 -0
  198. package/dist/contracts/policies/condition.d.ts +16 -0
  199. package/dist/contracts/policies/condition.js +10 -0
  200. package/dist/contracts/policies/member-policy.d.ts +31 -0
  201. package/dist/contracts/policies/member-policy.js +12 -0
  202. package/dist/contracts/policies/policy.d.ts +19 -0
  203. package/dist/contracts/policies/policy.js +11 -0
  204. package/dist/contracts/policies/rule-type.d.ts +7 -0
  205. package/dist/contracts/policies/rule-type.js +11 -0
  206. package/dist/contracts/policies/rule.d.ts +58 -0
  207. package/dist/contracts/policies/rule.js +19 -0
  208. package/dist/contracts/policies/user-group-policy.d.ts +10 -0
  209. package/dist/contracts/policies/user-group-policy.js +17 -0
  210. package/dist/contracts/policies/user-policy.d.ts +10 -0
  211. package/dist/contracts/policies/user-policy.js +17 -0
  212. package/dist/contracts/querying/culture-load-option.d.ts +35 -0
  213. package/dist/contracts/querying/culture-load-option.js +69 -0
  214. package/dist/contracts/querying/entity-definition-id-iterator.d.ts +9 -0
  215. package/dist/contracts/querying/entity-definition-id-iterator.js +30 -0
  216. package/dist/contracts/querying/entity-definition-id-query-result.d.ts +10 -0
  217. package/dist/contracts/querying/entity-definition-id-query-result.js +22 -0
  218. package/dist/contracts/querying/entity-definition-iterator.d.ts +16 -0
  219. package/dist/contracts/querying/entity-definition-iterator.js +30 -0
  220. package/dist/contracts/querying/entity-definition-query-result.d.ts +21 -0
  221. package/dist/contracts/querying/entity-definition-query-result.js +22 -0
  222. package/dist/contracts/querying/entity-iterator.d.ts +13 -0
  223. package/dist/contracts/querying/entity-iterator.js +30 -0
  224. package/dist/contracts/querying/entity-load-configuration-builder.d.ts +76 -0
  225. package/dist/contracts/querying/entity-load-configuration-builder.js +101 -0
  226. package/dist/contracts/querying/entity-load-configuration.d.ts +51 -0
  227. package/dist/contracts/querying/entity-load-configuration.js +67 -0
  228. package/dist/contracts/querying/entity-load-option.d.ts +35 -0
  229. package/dist/contracts/querying/entity-load-option.js +94 -0
  230. package/dist/contracts/querying/entity-query-result.d.ts +23 -0
  231. package/dist/contracts/querying/entity-query-result.js +33 -0
  232. package/dist/contracts/querying/filters/comparison-operator.d.ts +11 -0
  233. package/dist/contracts/querying/filters/comparison-operator.js +15 -0
  234. package/dist/contracts/querying/filters/composite-filter-operator.d.ts +4 -0
  235. package/dist/contracts/querying/filters/composite-filter-operator.js +8 -0
  236. package/dist/contracts/querying/filters/composite-query-filter.d.ts +19 -0
  237. package/dist/contracts/querying/filters/composite-query-filter.js +49 -0
  238. package/dist/contracts/querying/filters/createdby-query-filter.d.ts +5 -0
  239. package/dist/contracts/querying/filters/createdby-query-filter.js +30 -0
  240. package/dist/contracts/querying/filters/createdon-query-filter.d.ts +19 -0
  241. package/dist/contracts/querying/filters/createdon-query-filter.js +45 -0
  242. package/dist/contracts/querying/filters/definition-query-filter.d.ts +34 -0
  243. package/dist/contracts/querying/filters/definition-query-filter.js +58 -0
  244. package/dist/contracts/querying/filters/filter-data-type.d.ts +11 -0
  245. package/dist/contracts/querying/filters/filter-data-type.js +15 -0
  246. package/dist/contracts/querying/filters/filter-type.d.ts +18 -0
  247. package/dist/contracts/querying/filters/filter-type.js +22 -0
  248. package/dist/contracts/querying/filters/id-query-filter.d.ts +25 -0
  249. package/dist/contracts/querying/filters/id-query-filter.js +49 -0
  250. package/dist/contracts/querying/filters/identifier-query-filter.d.ts +25 -0
  251. package/dist/contracts/querying/filters/identifier-query-filter.js +49 -0
  252. package/dist/contracts/querying/filters/index.d.ts +20 -0
  253. package/dist/contracts/querying/filters/index.js +32 -0
  254. package/dist/contracts/querying/filters/modifiedby-query-filter.d.ts +5 -0
  255. package/dist/contracts/querying/filters/modifiedby-query-filter.js +30 -0
  256. package/dist/contracts/querying/filters/modifiedon-query-filter.d.ts +19 -0
  257. package/dist/contracts/querying/filters/modifiedon-query-filter.js +45 -0
  258. package/dist/contracts/querying/filters/modules-query-filter.d.ts +14 -0
  259. package/dist/contracts/querying/filters/modules-query-filter.js +43 -0
  260. package/dist/contracts/querying/filters/not-query-filter.d.ts +14 -0
  261. package/dist/contracts/querying/filters/not-query-filter.js +39 -0
  262. package/dist/contracts/querying/filters/property-query-filter.d.ts +38 -0
  263. package/dist/contracts/querying/filters/property-query-filter.js +63 -0
  264. package/dist/contracts/querying/filters/query-filter.d.ts +10 -0
  265. package/dist/contracts/querying/filters/query-filter.js +28 -0
  266. package/dist/contracts/querying/filters/relation-connection-type.d.ts +15 -0
  267. package/dist/contracts/querying/filters/relation-connection-type.js +19 -0
  268. package/dist/contracts/querying/filters/relation-query-filter.d.ts +23 -0
  269. package/dist/contracts/querying/filters/relation-query-filter.js +48 -0
  270. package/dist/contracts/querying/filters/secured-ancestors-query-filter.d.ts +24 -0
  271. package/dist/contracts/querying/filters/secured-ancestors-query-filter.js +53 -0
  272. package/dist/contracts/querying/filters/user-query-filter.d.ts +37 -0
  273. package/dist/contracts/querying/filters/user-query-filter.js +61 -0
  274. package/dist/contracts/querying/id-iterator.d.ts +11 -0
  275. package/dist/contracts/querying/id-iterator.js +19 -0
  276. package/dist/contracts/querying/id-query-result.d.ts +17 -0
  277. package/dist/contracts/querying/id-query-result.js +24 -0
  278. package/dist/contracts/querying/iterator.d.ts +9 -0
  279. package/dist/contracts/querying/iterator.js +2 -0
  280. package/dist/contracts/querying/load-option.d.ts +4 -0
  281. package/dist/contracts/querying/load-option.js +2 -0
  282. package/dist/contracts/querying/load-options.d.ts +6 -0
  283. package/dist/contracts/querying/load-options.js +10 -0
  284. package/dist/contracts/querying/loading-query-iterator.d.ts +17 -0
  285. package/dist/contracts/querying/loading-query-iterator.js +57 -0
  286. package/dist/contracts/querying/member-load-option.d.ts +11 -0
  287. package/dist/contracts/querying/member-load-option.js +15 -0
  288. package/dist/contracts/querying/minimal-schema.d.ts +8 -0
  289. package/dist/contracts/querying/minimal-schema.js +48 -0
  290. package/dist/contracts/querying/property-data.d.ts +8 -0
  291. package/dist/contracts/querying/property-data.js +43 -0
  292. package/dist/contracts/querying/property-load-option.d.ts +30 -0
  293. package/dist/contracts/querying/property-load-option.js +70 -0
  294. package/dist/contracts/querying/query-iterator.d.ts +18 -0
  295. package/dist/contracts/querying/query-iterator.js +54 -0
  296. package/dist/contracts/querying/query-load-configuration.d.ts +39 -0
  297. package/dist/contracts/querying/query-load-configuration.js +86 -0
  298. package/dist/contracts/querying/query-request.d.ts +6 -0
  299. package/dist/contracts/querying/query-request.js +30 -0
  300. package/dist/contracts/querying/query-result-paging-manager.d.ts +9 -0
  301. package/dist/contracts/querying/query-result-paging-manager.js +22 -0
  302. package/dist/contracts/querying/query-result.d.ts +5 -0
  303. package/dist/contracts/querying/query-result.js +2 -0
  304. package/dist/contracts/querying/query-sort-order.d.ts +13 -0
  305. package/dist/contracts/querying/query-sort-order.js +17 -0
  306. package/dist/contracts/querying/query.d.ts +23 -0
  307. package/dist/contracts/querying/query.js +56 -0
  308. package/dist/contracts/querying/relation-data.d.ts +7 -0
  309. package/dist/contracts/querying/relation-data.js +38 -0
  310. package/dist/contracts/querying/relation-load-option.d.ts +31 -0
  311. package/dist/contracts/querying/relation-load-option.js +74 -0
  312. package/dist/contracts/querying/relation-specification.d.ts +33 -0
  313. package/dist/contracts/querying/relation-specification.js +52 -0
  314. package/dist/contracts/querying/schema-querying.d.ts +20 -0
  315. package/dist/contracts/querying/schema-querying.js +2 -0
  316. package/dist/contracts/querying/scroll-request.d.ts +7 -0
  317. package/dist/contracts/querying/scroll-request.js +33 -0
  318. package/dist/contracts/querying/skip-take-iterator-base.d.ts +14 -0
  319. package/dist/contracts/querying/skip-take-iterator-base.js +60 -0
  320. package/dist/contracts/querying/sort-field-type.d.ts +13 -0
  321. package/dist/contracts/querying/sort-field-type.js +17 -0
  322. package/dist/contracts/querying/sorting.d.ts +25 -0
  323. package/dist/contracts/querying/sorting.js +44 -0
  324. package/dist/contracts/users/user-group-combine-method.d.ts +4 -0
  325. package/dist/contracts/users/user-group-combine-method.js +8 -0
  326. package/dist/contracts/users/user-group-configuration.d.ts +11 -0
  327. package/dist/contracts/users/user-group-configuration.js +35 -0
  328. package/dist/contracts/users/user-profile.d.ts +4 -0
  329. package/dist/contracts/users/user-profile.js +2 -0
  330. package/dist/contracts/users/user.d.ts +24 -0
  331. package/dist/contracts/users/user.js +64 -0
  332. package/dist/converters/api-resource-converter.d.ts +16 -0
  333. package/dist/converters/api-resource-converter.js +45 -0
  334. package/dist/converters/file-version-converter.d.ts +22 -0
  335. package/dist/converters/file-version-converter.js +43 -0
  336. package/dist/converters/index.d.ts +6 -0
  337. package/dist/converters/index.js +18 -0
  338. package/dist/converters/member-condition-converter.d.ts +20 -0
  339. package/dist/converters/member-condition-converter.js +50 -0
  340. package/dist/converters/member-condition-resource-converter.d.ts +21 -0
  341. package/dist/converters/member-condition-resource-converter.js +53 -0
  342. package/dist/converters/minimal-schema-relation-cardinality-converter.d.ts +11 -0
  343. package/dist/converters/minimal-schema-relation-cardinality-converter.js +33 -0
  344. package/dist/converters/page-resource-menus-converter.d.ts +19 -0
  345. package/dist/converters/page-resource-menus-converter.js +45 -0
  346. package/dist/converters/page-resource-zones-converter.d.ts +19 -0
  347. package/dist/converters/page-resource-zones-converter.js +45 -0
  348. package/dist/converters/relation-map-resource-converter.d.ts +6 -0
  349. package/dist/converters/relation-map-resource-converter.js +38 -0
  350. package/dist/converters/relation-resource-converter.d.ts +22 -0
  351. package/dist/converters/relation-resource-converter.js +51 -0
  352. package/dist/converters/renditions-converter.d.ts +20 -0
  353. package/dist/converters/renditions-converter.js +44 -0
  354. package/dist/converters/string-to-any-map-converter.d.ts +20 -0
  355. package/dist/converters/string-to-any-map-converter.js +34 -0
  356. package/dist/culture-info.d.ts +5 -0
  357. package/dist/culture-info.js +7 -0
  358. package/dist/dirty-value-calculator.d.ts +7 -0
  359. package/dist/dirty-value-calculator.js +29 -0
  360. package/dist/entity-link.d.ts +8 -0
  361. package/dist/entity-link.js +40 -0
  362. package/dist/error-messages.d.ts +57 -0
  363. package/dist/error-messages.js +64 -0
  364. package/dist/errors/argument-error.d.ts +4 -0
  365. package/dist/errors/argument-error.js +11 -0
  366. package/dist/errors/authentication-error.d.ts +5 -0
  367. package/dist/errors/authentication-error.js +12 -0
  368. package/dist/errors/bad-request-error.d.ts +5 -0
  369. package/dist/errors/bad-request-error.js +11 -0
  370. package/dist/errors/forbidden-error.d.ts +4 -0
  371. package/dist/errors/forbidden-error.js +11 -0
  372. package/dist/errors/internal-error.d.ts +4 -0
  373. package/dist/errors/internal-error.js +11 -0
  374. package/dist/errors/invalid-operation-error.d.ts +4 -0
  375. package/dist/errors/invalid-operation-error.js +11 -0
  376. package/dist/errors/not-found-error.d.ts +5 -0
  377. package/dist/errors/not-found-error.js +11 -0
  378. package/dist/errors/not-implemented-error.d.ts +4 -0
  379. package/dist/errors/not-implemented-error.js +11 -0
  380. package/dist/errors/not-loaded-error.d.ts +4 -0
  381. package/dist/errors/not-loaded-error.js +11 -0
  382. package/dist/errors/not-supported-error.d.ts +4 -0
  383. package/dist/errors/not-supported-error.js +11 -0
  384. package/dist/errors/schema-error.d.ts +4 -0
  385. package/dist/errors/schema-error.js +11 -0
  386. package/dist/errors/validation-error.d.ts +6 -0
  387. package/dist/errors/validation-error.js +12 -0
  388. package/dist/errors/validation-failure.d.ts +7 -0
  389. package/dist/errors/validation-failure.js +14 -0
  390. package/dist/errors/web-api-error.d.ts +13 -0
  391. package/dist/errors/web-api-error.js +13 -0
  392. package/dist/factories/entity-factory.d.ts +38 -0
  393. package/dist/factories/entity-factory.js +76 -0
  394. package/dist/factories/option-list-factory.d.ts +26 -0
  395. package/dist/factories/option-list-factory.js +22 -0
  396. package/dist/factories/property-factory.d.ts +10 -0
  397. package/dist/factories/property-factory.js +54 -0
  398. package/dist/factories/relation-factory.d.ts +55 -0
  399. package/dist/factories/relation-factory.js +70 -0
  400. package/dist/fileversion.d.ts +78 -0
  401. package/dist/fileversion.js +144 -0
  402. package/dist/guard.d.ts +29 -0
  403. package/dist/guard.js +142 -0
  404. package/dist/http-method.d.ts +9 -0
  405. package/dist/http-method.js +13 -0
  406. package/dist/index.d.ts +10 -0
  407. package/dist/index.js +22 -0
  408. package/dist/link-helper.d.ts +209 -0
  409. package/dist/link-helper.js +371 -0
  410. package/dist/link.d.ts +9 -0
  411. package/dist/link.js +78 -0
  412. package/dist/logging/log-level.d.ts +6 -0
  413. package/dist/logging/log-level.js +10 -0
  414. package/dist/logging/logger-base.d.ts +26 -0
  415. package/dist/logging/logger-base.js +98 -0
  416. package/dist/logging/logger.d.ts +16 -0
  417. package/dist/logging/logger.js +2 -0
  418. package/dist/logging/null-logger.d.ts +7 -0
  419. package/dist/logging/null-logger.js +13 -0
  420. package/dist/mappers/api-resource-mapper.d.ts +5 -0
  421. package/dist/mappers/api-resource-mapper.js +16 -0
  422. package/dist/mappers/condition-mapper.d.ts +36 -0
  423. package/dist/mappers/condition-mapper.js +112 -0
  424. package/dist/mappers/entity-definition-mapper.d.ts +13 -0
  425. package/dist/mappers/entity-definition-mapper.js +88 -0
  426. package/dist/mappers/entity-mapper.d.ts +19 -0
  427. package/dist/mappers/entity-mapper.js +134 -0
  428. package/dist/mappers/final-life-cycle-status-mapper.d.ts +6 -0
  429. package/dist/mappers/final-life-cycle-status-mapper.js +51 -0
  430. package/dist/mappers/load-options-mapper.d.ts +16 -0
  431. package/dist/mappers/load-options-mapper.js +100 -0
  432. package/dist/mappers/mapping-utilities.d.ts +7 -0
  433. package/dist/mappers/mapping-utilities.js +19 -0
  434. package/dist/mappers/member-condition-mapper.d.ts +12 -0
  435. package/dist/mappers/member-condition-mapper.js +119 -0
  436. package/dist/mappers/member-definition-mapper.d.ts +19 -0
  437. package/dist/mappers/member-definition-mapper.js +266 -0
  438. package/dist/mappers/member-group-mapper.d.ts +14 -0
  439. package/dist/mappers/member-group-mapper.js +95 -0
  440. package/dist/mappers/member-security-mapper.d.ts +34 -0
  441. package/dist/mappers/member-security-mapper.js +101 -0
  442. package/dist/mappers/notification-mapper.d.ts +5 -0
  443. package/dist/mappers/notification-mapper.js +17 -0
  444. package/dist/mappers/option-list-mapper.d.ts +18 -0
  445. package/dist/mappers/option-list-mapper.js +131 -0
  446. package/dist/mappers/policy-mapper.d.ts +29 -0
  447. package/dist/mappers/policy-mapper.js +124 -0
  448. package/dist/mappers/property-mapper.d.ts +21 -0
  449. package/dist/mappers/property-mapper.js +339 -0
  450. package/dist/mappers/querying-mapper.d.ts +16 -0
  451. package/dist/mappers/querying-mapper.js +96 -0
  452. package/dist/mappers/relation-cardinality-mapper.d.ts +5 -0
  453. package/dist/mappers/relation-cardinality-mapper.js +37 -0
  454. package/dist/mappers/relation-mapper.d.ts +16 -0
  455. package/dist/mappers/relation-mapper.js +202 -0
  456. package/dist/mappers/relation-role-mapper.d.ts +5 -0
  457. package/dist/mappers/relation-role-mapper.js +29 -0
  458. package/dist/mappers/rendition-mapper.d.ts +9 -0
  459. package/dist/mappers/rendition-mapper.js +34 -0
  460. package/dist/mappers/rule-type-mapper.d.ts +6 -0
  461. package/dist/mappers/rule-type-mapper.js +33 -0
  462. package/dist/mappers/rules-mapper.d.ts +35 -0
  463. package/dist/mappers/rules-mapper.js +123 -0
  464. package/dist/mappers/typed-entity-creator.d.ts +27 -0
  465. package/dist/mappers/typed-entity-creator.js +76 -0
  466. package/dist/models/entity-definition-collection-resource.d.ts +5 -0
  467. package/dist/models/entity-definition-collection-resource.js +26 -0
  468. package/dist/models/entity-definition-resource.d.ts +23 -0
  469. package/dist/models/entity-definition-resource.js +98 -0
  470. package/dist/models/entity-list-resource.d.ts +5 -0
  471. package/dist/models/entity-list-resource.js +26 -0
  472. package/dist/models/entity-resource.d.ts +36 -0
  473. package/dist/models/entity-resource.js +142 -0
  474. package/dist/models/list-resource.d.ts +13 -0
  475. package/dist/models/list-resource.js +50 -0
  476. package/dist/models/member-condition-resource.d.ts +32 -0
  477. package/dist/models/member-condition-resource.js +95 -0
  478. package/dist/models/member-definition-resource.d.ts +15 -0
  479. package/dist/models/member-definition-resource.js +71 -0
  480. package/dist/models/member-group-resource.d.ts +14 -0
  481. package/dist/models/member-group-resource.js +61 -0
  482. package/dist/models/notifications/distribute-notification-resource.d.ts +7 -0
  483. package/dist/models/notifications/distribute-notification-resource.js +37 -0
  484. package/dist/models/notifications/mail-request-broadcast.d.ts +7 -0
  485. package/dist/models/notifications/mail-request-broadcast.js +18 -0
  486. package/dist/models/notifications/mail-request-by-id.d.ts +9 -0
  487. package/dist/models/notifications/mail-request-by-id.js +28 -0
  488. package/dist/models/notifications/mail-request-by-username.d.ts +9 -0
  489. package/dist/models/notifications/mail-request-by-username.js +28 -0
  490. package/dist/models/notifications/mail-request.d.ts +26 -0
  491. package/dist/models/notifications/mail-request.js +12 -0
  492. package/dist/models/notifications/notification-level.d.ts +8 -0
  493. package/dist/models/notifications/notification-level.js +12 -0
  494. package/dist/models/notifications/realtime-request-broadcast.d.ts +7 -0
  495. package/dist/models/notifications/realtime-request-broadcast.js +18 -0
  496. package/dist/models/notifications/realtime-request-by-id.d.ts +9 -0
  497. package/dist/models/notifications/realtime-request-by-id.js +28 -0
  498. package/dist/models/notifications/realtime-request-by-username.d.ts +9 -0
  499. package/dist/models/notifications/realtime-request-by-username.js +28 -0
  500. package/dist/models/notifications/realtime-request.d.ts +60 -0
  501. package/dist/models/notifications/realtime-request.js +41 -0
  502. package/dist/models/notifications/request-by-id.d.ts +13 -0
  503. package/dist/models/notifications/request-by-id.js +2 -0
  504. package/dist/models/notifications/request-by-username.d.ts +13 -0
  505. package/dist/models/notifications/request-by-username.js +2 -0
  506. package/dist/models/notifications/validators/mail-validator.d.ts +6 -0
  507. package/dist/models/notifications/validators/mail-validator.js +23 -0
  508. package/dist/models/notifications/validators/realtime-validator.d.ts +5 -0
  509. package/dist/models/notifications/validators/realtime-validator.js +14 -0
  510. package/dist/models/notifications/validators/request-by-id-validator.d.ts +6 -0
  511. package/dist/models/notifications/validators/request-by-id-validator.js +31 -0
  512. package/dist/models/notifications/validators/request-by-username-validator.d.ts +6 -0
  513. package/dist/models/notifications/validators/request-by-username-validator.js +31 -0
  514. package/dist/models/notifications/validators/validator-base.d.ts +6 -0
  515. package/dist/models/notifications/validators/validator-base.js +16 -0
  516. package/dist/models/option-lists/flat-option-list-value.d.ts +4 -0
  517. package/dist/models/option-lists/flat-option-list-value.js +9 -0
  518. package/dist/models/option-lists/hierarchical-options-list-value.d.ts +7 -0
  519. package/dist/models/option-lists/hierarchical-options-list-value.js +14 -0
  520. package/dist/models/option-lists/option-list-collection-resource.d.ts +6 -0
  521. package/dist/models/option-lists/option-list-collection-resource.js +32 -0
  522. package/dist/models/option-lists/option-list-description-resource.d.ts +5 -0
  523. package/dist/models/option-lists/option-list-description-resource.js +31 -0
  524. package/dist/models/option-lists/option-list-resource.d.ts +16 -0
  525. package/dist/models/option-lists/option-list-resource.js +62 -0
  526. package/dist/models/option-lists/option-list-value-resource.d.ts +6 -0
  527. package/dist/models/option-lists/option-list-value-resource.js +32 -0
  528. package/dist/models/pages/component-visualization.d.ts +10 -0
  529. package/dist/models/pages/component-visualization.js +54 -0
  530. package/dist/models/pages/language-resource.d.ts +10 -0
  531. package/dist/models/pages/language-resource.js +47 -0
  532. package/dist/models/pages/menu-item.d.ts +12 -0
  533. package/dist/models/pages/menu-item.js +66 -0
  534. package/dist/models/pages/page-component-resource.d.ts +20 -0
  535. package/dist/models/pages/page-component-resource.js +87 -0
  536. package/dist/models/pages/page-resource.d.ts +23 -0
  537. package/dist/models/pages/page-resource.js +100 -0
  538. package/dist/models/pages/page-row-settings.d.ts +27 -0
  539. package/dist/models/pages/page-row-settings.js +119 -0
  540. package/dist/models/pages/portal-column-resource.d.ts +6 -0
  541. package/dist/models/pages/portal-column-resource.js +37 -0
  542. package/dist/models/pages/portal-row-resource.d.ts +7 -0
  543. package/dist/models/pages/portal-row-resource.js +38 -0
  544. package/dist/models/pages/portal-section-resource.d.ts +6 -0
  545. package/dist/models/pages/portal-section-resource.js +37 -0
  546. package/dist/models/permissions-resource.d.ts +4 -0
  547. package/dist/models/permissions-resource.js +28 -0
  548. package/dist/models/policies/condition-resource.d.ts +21 -0
  549. package/dist/models/policies/condition-resource.js +53 -0
  550. package/dist/models/policies/member-policy-resource.d.ts +8 -0
  551. package/dist/models/policies/member-policy-resource.js +43 -0
  552. package/dist/models/policies/policy-resource.d.ts +50 -0
  553. package/dist/models/policies/policy-resource.js +89 -0
  554. package/dist/models/policies/rule-resource.d.ts +49 -0
  555. package/dist/models/policies/rule-resource.js +78 -0
  556. package/dist/models/property-definition-resource.d.ts +45 -0
  557. package/dist/models/property-definition-resource.js +198 -0
  558. package/dist/models/query-loading-resource.d.ts +4 -0
  559. package/dist/models/query-loading-resource.js +28 -0
  560. package/dist/models/query-result-resource.d.ts +9 -0
  561. package/dist/models/query-result-resource.js +34 -0
  562. package/dist/models/relation-definition-resource.d.ts +29 -0
  563. package/dist/models/relation-definition-resource.js +115 -0
  564. package/dist/models/relation-map-resource.d.ts +6 -0
  565. package/dist/models/relation-map-resource.js +16 -0
  566. package/dist/models/relation-resource.d.ts +21 -0
  567. package/dist/models/relation-resource.js +93 -0
  568. package/dist/models/resource-containers/entity-definition-resource-container.d.ts +8 -0
  569. package/dist/models/resource-containers/entity-definition-resource-container.js +2 -0
  570. package/dist/models/resource-containers/entity-resource-container.d.ts +8 -0
  571. package/dist/models/resource-containers/entity-resource-container.js +2 -0
  572. package/dist/models/resource.d.ts +4 -0
  573. package/dist/models/resource.js +26 -0
  574. package/dist/models/search/aggregation-request-resource.d.ts +16 -0
  575. package/dist/models/search/aggregation-request-resource.js +72 -0
  576. package/dist/models/search/aggregation-response-resource.d.ts +8 -0
  577. package/dist/models/search/aggregation-response-resource.js +41 -0
  578. package/dist/models/search/bucket-response-resource.d.ts +8 -0
  579. package/dist/models/search/bucket-response-resource.js +46 -0
  580. package/dist/models/search/date-interval.d.ts +10 -0
  581. package/dist/models/search/date-interval.js +14 -0
  582. package/dist/models/search/facet-response-resource.d.ts +20 -0
  583. package/dist/models/search/facet-response-resource.js +98 -0
  584. package/dist/models/search/field-filter-request-resource.d.ts +16 -0
  585. package/dist/models/search/field-filter-request-resource.js +76 -0
  586. package/dist/models/search/field-filter-response-resource.d.ts +17 -0
  587. package/dist/models/search/field-filter-response-resource.js +84 -0
  588. package/dist/models/search/field-filter-value-response-resource.d.ts +6 -0
  589. package/dist/models/search/field-filter-value-response-resource.js +31 -0
  590. package/dist/models/search/filter-operator.d.ts +86 -0
  591. package/dist/models/search/filter-operator.js +90 -0
  592. package/dist/models/search/full-text-response-resource.d.ts +4 -0
  593. package/dist/models/search/full-text-response-resource.js +27 -0
  594. package/dist/models/search/group-category.d.ts +6 -0
  595. package/dist/models/search/group-category.js +35 -0
  596. package/dist/models/search/group-config.d.ts +4 -0
  597. package/dist/models/search/group-config.js +27 -0
  598. package/dist/models/search/group-item.d.ts +10 -0
  599. package/dist/models/search/group-item.js +44 -0
  600. package/dist/models/search/grouped-view-response-resource.d.ts +15 -0
  601. package/dist/models/search/grouped-view-response-resource.js +65 -0
  602. package/dist/models/search/metric-option-request-resource.d.ts +7 -0
  603. package/dist/models/search/metric-option-request-resource.js +37 -0
  604. package/dist/models/search/metric-option-response-resource.d.ts +5 -0
  605. package/dist/models/search/metric-option-response-resource.js +31 -0
  606. package/dist/models/search/nested-relation-info.d.ts +11 -0
  607. package/dist/models/search/nested-relation-info.js +96 -0
  608. package/dist/models/search/requested-aggregation-type.d.ts +5 -0
  609. package/dist/models/search/requested-aggregation-type.js +9 -0
  610. package/dist/models/search/requested-filter-type.d.ts +6 -0
  611. package/dist/models/search/requested-filter-type.js +10 -0
  612. package/dist/models/search/search-group-request-resource.d.ts +5 -0
  613. package/dist/models/search/search-group-request-resource.js +31 -0
  614. package/dist/models/search/search-request.d.ts +41 -0
  615. package/dist/models/search/search-request.js +131 -0
  616. package/dist/models/search/search-response.d.ts +36 -0
  617. package/dist/models/search/search-response.js +123 -0
  618. package/dist/models/search/selection-pool-filter-resource.d.ts +7 -0
  619. package/dist/models/search/selection-pool-filter-resource.js +38 -0
  620. package/dist/models/search/sorting-request-resource.d.ts +5 -0
  621. package/dist/models/search/sorting-request-resource.js +32 -0
  622. package/dist/models/search/sorting-response-resource.d.ts +6 -0
  623. package/dist/models/search/sorting-response-resource.js +34 -0
  624. package/dist/models/search-document-resource.d.ts +7 -0
  625. package/dist/models/search-document-resource.js +33 -0
  626. package/dist/models/set-password-request-resource.d.ts +5 -0
  627. package/dist/models/set-password-request-resource.js +31 -0
  628. package/dist/settings/fetch-setting.d.ts +12 -0
  629. package/dist/settings/fetch-setting.js +61 -0
  630. package/dist/settings/super-user-excluded-privileges.d.ts +3 -0
  631. package/dist/settings/super-user-excluded-privileges.js +27 -0
  632. package/dist/settings/usage-rights-configuration.d.ts +24 -0
  633. package/dist/settings/usage-rights-configuration.js +90 -0
  634. package/dist/type-guards.d.ts +20 -0
  635. package/dist/type-guards.js +28 -0
  636. package/package.json +78 -0
@@ -0,0 +1,7 @@
1
+ import { Nullable, Object_Unknown } from "../../base-types";
2
+ import Link from "../../link";
3
+ export declare class DistributeNotificationResource {
4
+ channels: Array<string>;
5
+ recipients: Nullable<Array<Link>>;
6
+ parameters: Object_Unknown;
7
+ }
@@ -0,0 +1,37 @@
1
+ "use strict";
2
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
3
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
4
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
5
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
6
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
7
+ };
8
+ var __metadata = (this && this.__metadata) || function (k, v) {
9
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
10
+ };
11
+ var __importDefault = (this && this.__importDefault) || function (mod) {
12
+ return (mod && mod.__esModule) ? mod : { "default": mod };
13
+ };
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.DistributeNotificationResource = void 0;
16
+ const ta_json_1 = require("ta-json");
17
+ const link_1 = __importDefault(require("../../link"));
18
+ let DistributeNotificationResource = class DistributeNotificationResource {
19
+ };
20
+ __decorate([
21
+ ta_json_1.JsonProperty("channels"),
22
+ ta_json_1.JsonElementType(String),
23
+ __metadata("design:type", Array)
24
+ ], DistributeNotificationResource.prototype, "channels", void 0);
25
+ __decorate([
26
+ ta_json_1.JsonProperty("recipients"),
27
+ ta_json_1.JsonElementType(link_1.default),
28
+ __metadata("design:type", Object)
29
+ ], DistributeNotificationResource.prototype, "recipients", void 0);
30
+ __decorate([
31
+ ta_json_1.JsonProperty("parameters"),
32
+ __metadata("design:type", Object)
33
+ ], DistributeNotificationResource.prototype, "parameters", void 0);
34
+ DistributeNotificationResource = __decorate([
35
+ ta_json_1.JsonObject()
36
+ ], DistributeNotificationResource);
37
+ exports.DistributeNotificationResource = DistributeNotificationResource;
@@ -0,0 +1,7 @@
1
+ import { MailRequest } from "./mail-request";
2
+ /**
3
+ * A request for sending e-mails to all users.
4
+ */
5
+ export declare class MailRequestBroadcast extends MailRequest {
6
+ validate(): void;
7
+ }
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.MailRequestBroadcast = void 0;
4
+ const validation_error_1 = require("../../errors/validation-error");
5
+ const mail_request_1 = require("./mail-request");
6
+ const mail_validator_1 = require("./validators/mail-validator");
7
+ /**
8
+ * A request for sending e-mails to all users.
9
+ */
10
+ class MailRequestBroadcast extends mail_request_1.MailRequest {
11
+ validate() {
12
+ const failures = new mail_validator_1.MailValidator().validate(this);
13
+ if (failures.length > 0) {
14
+ throw new validation_error_1.ValidationError(`MailRequestBroadcast is invalid`);
15
+ }
16
+ }
17
+ }
18
+ exports.MailRequestBroadcast = MailRequestBroadcast;
@@ -0,0 +1,9 @@
1
+ import { MailRequest } from "./mail-request";
2
+ import { IRequestById } from "./request-by-id";
3
+ /**
4
+ * A request for sending e-mails to specified users by id.
5
+ */
6
+ export declare class MailRequestById extends MailRequest implements IRequestById {
7
+ recipients: Array<number>;
8
+ validate(): void;
9
+ }
@@ -0,0 +1,28 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.MailRequestById = void 0;
4
+ const validation_error_1 = require("../../errors/validation-error");
5
+ const mail_request_1 = require("./mail-request");
6
+ const mail_validator_1 = require("./validators/mail-validator");
7
+ const request_by_id_validator_1 = require("./validators/request-by-id-validator");
8
+ /**
9
+ * A request for sending e-mails to specified users by id.
10
+ */
11
+ class MailRequestById extends mail_request_1.MailRequest {
12
+ constructor() {
13
+ super(...arguments);
14
+ this.recipients = [];
15
+ }
16
+ validate() {
17
+ const mailFailures = new mail_validator_1.MailValidator().validate(this);
18
+ const idFailures = new request_by_id_validator_1.RequestByIdValidator().validate(this);
19
+ if (mailFailures.length === 0 && idFailures.length === 0) {
20
+ return;
21
+ }
22
+ else {
23
+ const failures = mailFailures.concat(idFailures);
24
+ throw new validation_error_1.ValidationError("MailRequestById is invalid.", ...failures);
25
+ }
26
+ }
27
+ }
28
+ exports.MailRequestById = MailRequestById;
@@ -0,0 +1,9 @@
1
+ import { MailRequest } from "./mail-request";
2
+ import { IRequestByUsername } from "./request-by-username";
3
+ /**
4
+ * A request for sending e-mails specified users by username.
5
+ */
6
+ export declare class MailRequestByUsername extends MailRequest implements IRequestByUsername {
7
+ recipients: Array<string>;
8
+ validate(): void;
9
+ }
@@ -0,0 +1,28 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.MailRequestByUsername = void 0;
4
+ const validation_error_1 = require("../../errors/validation-error");
5
+ const mail_request_1 = require("./mail-request");
6
+ const mail_validator_1 = require("./validators/mail-validator");
7
+ const request_by_username_validator_1 = require("./validators/request-by-username-validator");
8
+ /**
9
+ * A request for sending e-mails specified users by username.
10
+ */
11
+ class MailRequestByUsername extends mail_request_1.MailRequest {
12
+ constructor() {
13
+ super(...arguments);
14
+ this.recipients = [];
15
+ }
16
+ validate() {
17
+ const mailFailures = new mail_validator_1.MailValidator().validate(this);
18
+ const usernamesFailures = new request_by_username_validator_1.RequestByUsernameValidator().validate(this);
19
+ if (mailFailures.length === 0 && usernamesFailures.length === 0) {
20
+ return;
21
+ }
22
+ else {
23
+ const failures = mailFailures.concat(usernamesFailures);
24
+ throw new validation_error_1.ValidationError("MailRequestByUsername is invalid", ...failures);
25
+ }
26
+ }
27
+ }
28
+ exports.MailRequestByUsername = MailRequestByUsername;
@@ -0,0 +1,26 @@
1
+ import { MapStringTo } from "../../base-types";
2
+ /**
3
+ * Interface for e-mail notification requests.
4
+ */
5
+ export interface IMailRequest {
6
+ /**
7
+ * Gets or sets the name of the mail template to be used.
8
+ */
9
+ mailTemplateName: string;
10
+ /**
11
+ * Gets or sets the variables to be applied on the mail template.
12
+ */
13
+ variables: MapStringTo<unknown>;
14
+ /**
15
+ * Validates the mail request.
16
+ */
17
+ validate(): void;
18
+ }
19
+ /**
20
+ * Base class for mail requests.
21
+ */
22
+ export declare abstract class MailRequest implements IMailRequest {
23
+ mailTemplateName: string;
24
+ variables: MapStringTo<unknown>;
25
+ abstract validate(): void;
26
+ }
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.MailRequest = void 0;
4
+ /**
5
+ * Base class for mail requests.
6
+ */
7
+ class MailRequest {
8
+ constructor() {
9
+ this.variables = {};
10
+ }
11
+ }
12
+ exports.MailRequest = MailRequest;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Notification levels
3
+ */
4
+ export declare enum NotificationLevel {
5
+ Info = 0,
6
+ Danger = 1,
7
+ Success = 2
8
+ }
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.NotificationLevel = void 0;
4
+ /**
5
+ * Notification levels
6
+ */
7
+ var NotificationLevel;
8
+ (function (NotificationLevel) {
9
+ NotificationLevel[NotificationLevel["Info"] = 0] = "Info";
10
+ NotificationLevel[NotificationLevel["Danger"] = 1] = "Danger";
11
+ NotificationLevel[NotificationLevel["Success"] = 2] = "Success";
12
+ })(NotificationLevel = exports.NotificationLevel || (exports.NotificationLevel = {}));
@@ -0,0 +1,7 @@
1
+ import { RealtimeRequest } from "./realtime-request";
2
+ /**
3
+ * A request for sending real-time notifications to all users.
4
+ */
5
+ export declare class RealtimeRequestBroadcast extends RealtimeRequest {
6
+ validate(): void;
7
+ }
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.RealtimeRequestBroadcast = void 0;
4
+ const validation_error_1 = require("../../errors/validation-error");
5
+ const realtime_request_1 = require("./realtime-request");
6
+ const realtime_validator_1 = require("./validators/realtime-validator");
7
+ /**
8
+ * A request for sending real-time notifications to all users.
9
+ */
10
+ class RealtimeRequestBroadcast extends realtime_request_1.RealtimeRequest {
11
+ validate() {
12
+ const failures = new realtime_validator_1.RealtimeValidator().validate(this);
13
+ if (failures.length > 0) {
14
+ throw new validation_error_1.ValidationError(`RealtimeRequestBroadcast is invalid`, ...failures);
15
+ }
16
+ }
17
+ }
18
+ exports.RealtimeRequestBroadcast = RealtimeRequestBroadcast;
@@ -0,0 +1,9 @@
1
+ import { RealtimeRequest } from "./realtime-request";
2
+ import { IRequestById } from "./request-by-id";
3
+ /**
4
+ * A request for sending real-time notifications to specified users by id.
5
+ */
6
+ export declare class RealtimeRequestById extends RealtimeRequest implements IRequestById {
7
+ recipients: Array<number>;
8
+ validate(): void;
9
+ }
@@ -0,0 +1,28 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.RealtimeRequestById = void 0;
4
+ const validation_error_1 = require("../../errors/validation-error");
5
+ const realtime_request_1 = require("./realtime-request");
6
+ const realtime_validator_1 = require("./validators/realtime-validator");
7
+ const request_by_id_validator_1 = require("./validators/request-by-id-validator");
8
+ /**
9
+ * A request for sending real-time notifications to specified users by id.
10
+ */
11
+ class RealtimeRequestById extends realtime_request_1.RealtimeRequest {
12
+ constructor() {
13
+ super(...arguments);
14
+ this.recipients = [];
15
+ }
16
+ validate() {
17
+ const realtimeFailures = new realtime_validator_1.RealtimeValidator().validate(this);
18
+ const idFailures = new request_by_id_validator_1.RequestByIdValidator().validate(this);
19
+ if (realtimeFailures.length === 0 && idFailures.length === 0) {
20
+ return;
21
+ }
22
+ else {
23
+ const failures = realtimeFailures.concat(idFailures);
24
+ throw new validation_error_1.ValidationError("RealtimeRequestByUsername is invalid", ...failures);
25
+ }
26
+ }
27
+ }
28
+ exports.RealtimeRequestById = RealtimeRequestById;
@@ -0,0 +1,9 @@
1
+ import { RealtimeRequest } from "./realtime-request";
2
+ import { IRequestByUsername } from "./request-by-username";
3
+ /**
4
+ * A request for sending real-time notifications to specified users by username.
5
+ */
6
+ export declare class RealtimeRequestByUsername extends RealtimeRequest implements IRequestByUsername {
7
+ recipients: Array<string>;
8
+ validate(): void;
9
+ }
@@ -0,0 +1,28 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.RealtimeRequestByUsername = void 0;
4
+ const validation_error_1 = require("../../errors/validation-error");
5
+ const realtime_request_1 = require("./realtime-request");
6
+ const realtime_validator_1 = require("./validators/realtime-validator");
7
+ const request_by_username_validator_1 = require("./validators/request-by-username-validator");
8
+ /**
9
+ * A request for sending real-time notifications to specified users by username.
10
+ */
11
+ class RealtimeRequestByUsername extends realtime_request_1.RealtimeRequest {
12
+ constructor() {
13
+ super(...arguments);
14
+ this.recipients = [];
15
+ }
16
+ validate() {
17
+ const realtimeFailures = new realtime_validator_1.RealtimeValidator().validate(this);
18
+ const usernameFailures = new request_by_username_validator_1.RequestByUsernameValidator().validate(this);
19
+ if (realtimeFailures.length === 0 && usernameFailures.length === 0) {
20
+ return;
21
+ }
22
+ else {
23
+ const failures = realtimeFailures.concat(usernameFailures);
24
+ throw new validation_error_1.ValidationError("RealtimeRequestByUsername is invalid", ...failures);
25
+ }
26
+ }
27
+ }
28
+ exports.RealtimeRequestByUsername = RealtimeRequestByUsername;
@@ -0,0 +1,60 @@
1
+ import { MapStringTo, Nullable } from "../../base-types";
2
+ import { NotificationLevel } from "./notification-level";
3
+ /**
4
+ * Interface for real-time notification requests.
5
+ */
6
+ export interface IRealtimeRequest {
7
+ /**
8
+ * Gets or sets the title of the notification.
9
+ */
10
+ title: string;
11
+ /**
12
+ * Gets or sets the target when the notification is clicked.
13
+ */
14
+ link: string;
15
+ /**
16
+ * Gets or sets the notification level.
17
+ */
18
+ notificationLevel: NotificationLevel;
19
+ /**
20
+ * Gets or sets the notification options. This directly maps to the notification API standard used by browsers.
21
+ * See https://developer.mozilla.org/en-US/docs/Web/API/notification for more information.
22
+ */
23
+ options: MapStringTo<unknown>;
24
+ /**
25
+ * Gets the notification body from the options object.
26
+ */
27
+ getBody(): Nullable<string>;
28
+ /**
29
+ * Sets the notification body on the options object.
30
+ * @param body - The notification body
31
+ */
32
+ setBody(body: string): void;
33
+ /**
34
+ * Gets the notification icon from the options object.
35
+ */
36
+ getIcon(): Nullable<string>;
37
+ /**
38
+ * Sets the notification icon on the options object.
39
+ * @param icon - The notification icon
40
+ */
41
+ setIcon(icon: string): void;
42
+ /**
43
+ * Validates the real-time request.
44
+ */
45
+ validate(): void;
46
+ }
47
+ /**
48
+ * Base class for real-time notification (browser notification) requests.
49
+ */
50
+ export declare abstract class RealtimeRequest implements IRealtimeRequest {
51
+ title: string;
52
+ link: string;
53
+ notificationLevel: NotificationLevel;
54
+ options: MapStringTo<unknown>;
55
+ getBody(): Nullable<string>;
56
+ setBody(body: string): void;
57
+ getIcon(): Nullable<string>;
58
+ setIcon(icon: string): void;
59
+ abstract validate(): void;
60
+ }
@@ -0,0 +1,41 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.RealtimeRequest = void 0;
4
+ const constants_1 = require("../../constants");
5
+ const notification_level_1 = require("./notification-level");
6
+ /**
7
+ * Base class for real-time notification (browser notification) requests.
8
+ */
9
+ class RealtimeRequest {
10
+ constructor() {
11
+ this.notificationLevel = notification_level_1.NotificationLevel.Info;
12
+ this.options = {};
13
+ }
14
+ getBody() {
15
+ if (this.options == null || !(constants_1.NOTIFICATIONS.REALTIME.INFO.body in this.options)) {
16
+ return null;
17
+ }
18
+ const body = this.options[constants_1.NOTIFICATIONS.REALTIME.INFO.body];
19
+ return body;
20
+ }
21
+ setBody(body) {
22
+ if (this.options == null) {
23
+ this.options = {};
24
+ }
25
+ this.options[constants_1.NOTIFICATIONS.REALTIME.INFO.body] = body;
26
+ }
27
+ getIcon() {
28
+ if (this.options == null || !(constants_1.NOTIFICATIONS.REALTIME.INFO.body in this.options)) {
29
+ return null;
30
+ }
31
+ const icon = this.options[constants_1.NOTIFICATIONS.REALTIME.INFO.icon];
32
+ return icon;
33
+ }
34
+ setIcon(icon) {
35
+ if (this.options == null) {
36
+ this.options = {};
37
+ }
38
+ this.options[constants_1.NOTIFICATIONS.REALTIME.INFO.icon] = icon;
39
+ }
40
+ }
41
+ exports.RealtimeRequest = RealtimeRequest;
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Interface for notification requests that target users by id.
3
+ */
4
+ export interface IRequestById {
5
+ /**
6
+ * Gets or sets the recipients.
7
+ */
8
+ recipients: Array<number>;
9
+ /**
10
+ * Validates the request.
11
+ */
12
+ validate(): void;
13
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,13 @@
1
+ /**
2
+ * Interface for notification requests that target users by username.
3
+ */
4
+ export interface IRequestByUsername {
5
+ /**
6
+ * Gets or sets the recipients.
7
+ */
8
+ recipients: Array<string>;
9
+ /**
10
+ * Validates the request.
11
+ */
12
+ validate(): void;
13
+ }
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,6 @@
1
+ import { ValidationFailure } from "../../../errors/validation-failure";
2
+ import { IMailRequest } from "../mail-request";
3
+ import { ValidatorBase } from "./validator-base";
4
+ export declare class MailValidator extends ValidatorBase {
5
+ validate(mailRequest: IMailRequest): Array<ValidationFailure>;
6
+ }
@@ -0,0 +1,23 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.MailValidator = void 0;
7
+ const validation_failure_1 = require("../../../errors/validation-failure");
8
+ const guard_1 = __importDefault(require("../../../guard"));
9
+ const validator_base_1 = require("./validator-base");
10
+ class MailValidator extends validator_base_1.ValidatorBase {
11
+ validate(mailRequest) {
12
+ guard_1.default.notNullOrUndefined(mailRequest);
13
+ try {
14
+ guard_1.default.stringNotNullOrEmpty(mailRequest.mailTemplateName);
15
+ }
16
+ catch (error) {
17
+ const failure = new validation_failure_1.ValidationFailure(`mailTemplateName cannot be null or whitespace.`);
18
+ this.addFailure(failure);
19
+ }
20
+ return this.getFailures();
21
+ }
22
+ }
23
+ exports.MailValidator = MailValidator;
@@ -0,0 +1,5 @@
1
+ import { ValidationFailure } from "../../../errors/validation-failure";
2
+ import { IRealtimeRequest } from "../realtime-request";
3
+ export declare class RealtimeValidator {
4
+ validate(realtimeRequest: IRealtimeRequest): Array<ValidationFailure>;
5
+ }
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.RealtimeValidator = void 0;
7
+ const guard_1 = __importDefault(require("../../../guard"));
8
+ class RealtimeValidator {
9
+ validate(realtimeRequest) {
10
+ guard_1.default.notNull(realtimeRequest);
11
+ return [];
12
+ }
13
+ }
14
+ exports.RealtimeValidator = RealtimeValidator;
@@ -0,0 +1,6 @@
1
+ import { ValidationFailure } from "../../../errors/validation-failure";
2
+ import { IRequestById } from "../request-by-id";
3
+ import { ValidatorBase } from "./validator-base";
4
+ export declare class RequestByIdValidator extends ValidatorBase {
5
+ validate(requestById: IRequestById): Array<ValidationFailure>;
6
+ }
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.RequestByIdValidator = void 0;
7
+ const validation_failure_1 = require("../../../errors/validation-failure");
8
+ const guard_1 = __importDefault(require("../../../guard"));
9
+ const validator_base_1 = require("./validator-base");
10
+ class RequestByIdValidator extends validator_base_1.ValidatorBase {
11
+ validate(requestById) {
12
+ guard_1.default.notNull(requestById);
13
+ if (requestById.recipients == null) {
14
+ const failure = new validation_failure_1.ValidationFailure(`Recipients cannot be null.`);
15
+ this.addFailure(failure);
16
+ }
17
+ if (requestById.recipients.length === 0) {
18
+ const failure = new validation_failure_1.ValidationFailure(`At least 1 recipient must be specified.`);
19
+ this.addFailure(failure);
20
+ }
21
+ try {
22
+ guard_1.default.validIds(requestById.recipients);
23
+ }
24
+ catch (error) {
25
+ const failure = new validation_failure_1.ValidationFailure(`Ids must be strictly positive.`);
26
+ this.addFailure(failure);
27
+ }
28
+ return this.getFailures();
29
+ }
30
+ }
31
+ exports.RequestByIdValidator = RequestByIdValidator;
@@ -0,0 +1,6 @@
1
+ import { ValidationFailure } from "../../../errors/validation-failure";
2
+ import { IRequestByUsername } from "../request-by-username";
3
+ import { ValidatorBase } from "./validator-base";
4
+ export declare class RequestByUsernameValidator extends ValidatorBase {
5
+ validate(requestByUsername: IRequestByUsername): Array<ValidationFailure>;
6
+ }
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.RequestByUsernameValidator = void 0;
7
+ const validation_failure_1 = require("../../../errors/validation-failure");
8
+ const guard_1 = __importDefault(require("../../../guard"));
9
+ const validator_base_1 = require("./validator-base");
10
+ class RequestByUsernameValidator extends validator_base_1.ValidatorBase {
11
+ validate(requestByUsername) {
12
+ guard_1.default.notNull(requestByUsername);
13
+ if (requestByUsername.recipients == null) {
14
+ const failure = new validation_failure_1.ValidationFailure(`Recipients cannot be null.`);
15
+ this.addFailure(failure);
16
+ }
17
+ if (requestByUsername.recipients.length === 0) {
18
+ const failure = new validation_failure_1.ValidationFailure(`At least 1 recipient must be specified.`);
19
+ this.addFailure(failure);
20
+ }
21
+ try {
22
+ guard_1.default.arrayNoneNullOrEmptyString(requestByUsername.recipients);
23
+ }
24
+ catch (error) {
25
+ const failure = new validation_failure_1.ValidationFailure(`Usernames cannot be null or whitespace.`);
26
+ this.addFailure(failure);
27
+ }
28
+ return this.getFailures();
29
+ }
30
+ }
31
+ exports.RequestByUsernameValidator = RequestByUsernameValidator;
@@ -0,0 +1,6 @@
1
+ import { ValidationFailure } from "../../../errors/validation-failure";
2
+ export declare abstract class ValidatorBase {
3
+ private _failures;
4
+ addFailure(failure: ValidationFailure): void;
5
+ getFailures(): Array<ValidationFailure>;
6
+ }
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ValidatorBase = void 0;
4
+ class ValidatorBase {
5
+ addFailure(failure) {
6
+ if (this._failures == null) {
7
+ this._failures = [];
8
+ }
9
+ this._failures.push(failure);
10
+ }
11
+ getFailures() {
12
+ var _a;
13
+ return (_a = this._failures) !== null && _a !== void 0 ? _a : [];
14
+ }
15
+ }
16
+ exports.ValidatorBase = ValidatorBase;
@@ -0,0 +1,4 @@
1
+ import { IFlatOptionListValue } from "../../contracts/base/option-lists/option-list-value";
2
+ import OptionListValueBase from "../../contracts/base/option-lists/option-list-value-base";
3
+ export default class FlatOptionListValue extends OptionListValueBase implements IFlatOptionListValue {
4
+ }
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const option_list_value_base_1 = __importDefault(require("../../contracts/base/option-lists/option-list-value-base"));
7
+ class FlatOptionListValue extends option_list_value_base_1.default {
8
+ }
9
+ exports.default = FlatOptionListValue;