@sitevision/api 2.0.0-alpha.1 → 2023.2.1-alpha.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 (280) hide show
  1. package/client/requester/index.d.ts +10 -8
  2. package/client/toasts/index.d.ts +7 -5
  3. package/common/app/index.d.ts +45 -46
  4. package/common/events/index.d.ts +30 -31
  5. package/common/i18n/index.d.ts +7 -5
  6. package/common/router/index.d.ts +72 -77
  7. package/common/security/index.d.ts +27 -21
  8. package/index.d.ts +8 -0
  9. package/package.json +1 -1
  10. package/server/AliasUtil/index.d.ts +11 -9
  11. package/server/ArchiveUtil/index.d.ts +43 -41
  12. package/server/ArraysInstance/index.d.ts +1666 -1807
  13. package/server/ArticleUtil/index.d.ts +292 -224
  14. package/server/AuthenticationUtil/index.d.ts +72 -84
  15. package/server/BookmarkUtil/index.d.ts +74 -79
  16. package/server/BuddyIconRenderer/index.d.ts +123 -131
  17. package/server/BuddyIconRenderer.BuddyIconSize/index.d.ts +41 -0
  18. package/server/BuddyIconRenderer.BuddyIconSize/index.js +25 -0
  19. package/server/ClientUtil/index.d.ts +10 -8
  20. package/server/CollaborationFactory/index.d.ts +37 -40
  21. package/server/CollaborationGroupFolderUtil/index.d.ts +28 -26
  22. package/server/CollaborationGroupState/index.d.ts +27 -0
  23. package/server/CollaborationGroupState/index.js +11 -0
  24. package/server/CollaborationGroupTemplateUtil/index.d.ts +46 -48
  25. package/server/CollaborationGroupType/index.d.ts +28 -0
  26. package/server/CollaborationGroupType/index.js +12 -0
  27. package/server/CollaborationGroupUtil/index.d.ts +84 -80
  28. package/server/CollectionsInstance/index.d.ts +641 -704
  29. package/server/ColorUtil/index.d.ts +34 -35
  30. package/server/CompoundAndFilterBuilder/index.d.ts +28 -26
  31. package/server/CompoundComparatorBuilder/index.d.ts +33 -31
  32. package/server/CompoundOrFilterBuilder/index.d.ts +28 -26
  33. package/server/ContentNodeUtil/index.d.ts +34 -32
  34. package/server/CurrencyFactory/index.d.ts +70 -68
  35. package/server/DateUtil/index.d.ts +131 -141
  36. package/server/DecorationUtil/index.d.ts +11 -9
  37. package/server/DeviceUtil/index.d.ts +19 -17
  38. package/server/DimensionMode/index.d.ts +17 -0
  39. package/server/DimensionMode/index.js +12 -0
  40. package/server/DirectoryUtil/index.d.ts +87 -85
  41. package/server/DocType/index.d.ts +30 -0
  42. package/server/DocType/index.js +14 -0
  43. package/server/DocTypeUtil/index.d.ts +127 -133
  44. package/server/EndecUtil/index.d.ts +329 -346
  45. package/server/ExtendedDismaxParserBuilder/index.d.ts +153 -167
  46. package/server/FileIconRenderer/index.d.ts +152 -171
  47. package/server/FileUtil/index.d.ts +272 -298
  48. package/server/FilterBuilder/index.d.ts +39 -37
  49. package/server/FolderUtil/index.d.ts +91 -92
  50. package/server/FontUtil/index.d.ts +34 -35
  51. package/server/FormatterBuilderFactory/index.d.ts +73 -81
  52. package/server/HighlightBuilder/index.d.ts +76 -83
  53. package/server/IconUtil/index.d.ts +25 -23
  54. package/server/ImageLinkRenderer/index.d.ts +35 -33
  55. package/server/ImageRenderer/index.d.ts +340 -376
  56. package/server/ImageUtil/index.d.ts +245 -263
  57. package/server/IndexUtil/index.d.ts +38 -35
  58. package/server/IndexUtil.IndexType/index.d.ts +29 -0
  59. package/server/IndexUtil.IndexType/index.js +13 -0
  60. package/server/IndexingUtil/index.d.ts +67 -45
  61. package/server/InstanceCreatorUtil/index.d.ts +423 -459
  62. package/server/InstanceTypeUtil/index.d.ts +167 -188
  63. package/server/JwtUtil/index.d.ts +129 -127
  64. package/server/LandingPageUtil/index.d.ts +82 -85
  65. package/server/LandingPageUtil/index.js +1 -0
  66. package/server/LinkPageUtil/index.d.ts +294 -248
  67. package/server/LinkRenderer/index.d.ts +649 -713
  68. package/server/LinkTargetBuilder/index.d.ts +65 -73
  69. package/server/LinkValueBuilder/index.d.ts +66 -73
  70. package/server/ListWrapper/index.d.ts +80 -89
  71. package/server/LocaleUtil/index.d.ts +381 -393
  72. package/server/LogUtil/index.d.ts +118 -127
  73. package/server/MailBuilder/index.d.ts +106 -121
  74. package/server/MailUtil/index.d.ts +58 -63
  75. package/server/MathInstance/index.d.ts +624 -656
  76. package/server/MessageDigesterFactory/index.d.ts +28 -26
  77. package/server/MetadataDefinitionUtil/index.d.ts +77 -81
  78. package/server/MetadataUtil/index.d.ts +321 -345
  79. package/server/MimeTypeUtil/index.d.ts +208 -214
  80. package/server/MonitorBuilder/index.d.ts +17 -17
  81. package/server/NodeComparatorUtil/index.d.ts +214 -224
  82. package/server/NodeFactoryUtil/index.d.ts +19 -17
  83. package/server/NodeFilterUtil/index.d.ts +651 -738
  84. package/server/NodeIteratorUtil/index.d.ts +209 -224
  85. package/server/NodeResolverUtil/index.d.ts +398 -404
  86. package/server/NodeTreeUtil/index.d.ts +211 -226
  87. package/server/NodeTypeUtil/index.d.ts +1430 -546
  88. package/server/OfflineVersionPropertyUtil/index.d.ts +6 -4
  89. package/server/OnlineVersionPropertyUtil/index.d.ts +6 -4
  90. package/server/OutputUtil/index.d.ts +384 -379
  91. package/server/PageUtil/index.d.ts +264 -186
  92. package/server/PermissionUtil/index.d.ts +391 -428
  93. package/server/PermissionUtil.Permission/index.d.ts +54 -0
  94. package/server/PermissionUtil.Permission/index.js +38 -0
  95. package/server/PortletContextUtil/index.d.ts +111 -106
  96. package/server/PortletUtil/index.d.ts +30 -20
  97. package/server/PrincipalUtil/index.d.ts +33 -31
  98. package/server/Properties/index.d.ts +68 -75
  99. package/server/PropertyUtil/index.d.ts +1419 -1461
  100. package/server/PublishingUtil/index.d.ts +246 -247
  101. package/server/QueryStringUtil/index.d.ts +403 -414
  102. package/server/RedirectUtil/index.d.ts +62 -66
  103. package/server/RelatedValueBuilder/index.d.ts +40 -38
  104. package/server/Requester/index.d.ts +123 -123
  105. package/server/ResourceLocatorUtil/index.d.ts +434 -474
  106. package/server/RestApi/index.d.ts +156 -136
  107. package/server/RestAppInvokerFactory/index.d.ts +25 -23
  108. package/server/RoleAssignmentBuilder/index.d.ts +35 -33
  109. package/server/RoleMatcherBuilder/index.d.ts +35 -33
  110. package/server/RoleUtil/index.d.ts +35 -37
  111. package/server/ScriptUtil/index.d.ts +457 -494
  112. package/server/SearchFactory/index.d.ts +102 -117
  113. package/server/SearchUtil/index.d.ts +73 -71
  114. package/server/SearcherBuilder/index.d.ts +107 -114
  115. package/server/Session/index.d.ts +251 -1093
  116. package/server/Session/index.js +1 -20
  117. package/server/SimpleUserUtil/index.d.ts +26 -27
  118. package/server/SiteCookieUtil/index.d.ts +150 -173
  119. package/server/SortBuilder/index.d.ts +24 -22
  120. package/server/SourceSetMode/index.d.ts +12 -0
  121. package/server/SourceSetMode/index.js +12 -0
  122. package/server/SpellCheckBuilder/index.d.ts +27 -27
  123. package/server/StandardParserBuilder/index.d.ts +33 -31
  124. package/server/StructureUtil/index.d.ts +83 -81
  125. package/server/SubscriberUtil/index.d.ts +58 -65
  126. package/server/SubscriptionUtil/index.d.ts +121 -128
  127. package/server/SystemUserUtil/index.d.ts +146 -144
  128. package/server/TagUtil/index.d.ts +113 -118
  129. package/server/TemplateUtil/index.d.ts +113 -118
  130. package/server/TemporaryFileNodeBuilder/index.d.ts +29 -27
  131. package/server/TemporaryNodeBuilder/index.d.ts +136 -174
  132. package/server/TextModuleRendererBuilder/index.d.ts +18 -16
  133. package/server/TimestampUtil/index.d.ts +102 -116
  134. package/server/TranslationUtil/index.d.ts +96 -102
  135. package/server/TrashcanUtil/index.d.ts +112 -115
  136. package/server/UserDataUtil/index.d.ts +108 -109
  137. package/server/UserFactory/index.d.ts +49 -56
  138. package/server/UserFieldRenderer/index.d.ts +118 -126
  139. package/server/UserIdentityUtil/index.d.ts +36 -34
  140. package/server/UserUtil/index.d.ts +30 -28
  141. package/server/Utils/index.d.ts +702 -791
  142. package/server/VelocityRenderer/index.d.ts +94 -92
  143. package/server/VersionUtil/index.d.ts +24 -8
  144. package/server/WebContentUtil/index.d.ts +275 -282
  145. package/server/WebResourceFactory/index.d.ts +46 -51
  146. package/server/XSLTUtil/index.d.ts +33 -31
  147. package/server/XmlParserUtil/index.d.ts +47 -45
  148. package/server/appData/index.d.ts +8 -6
  149. package/server/appInfo/index.d.ts +6 -2
  150. package/server/appResource/index.d.ts +23 -21
  151. package/server/cache/index.d.ts +8 -6
  152. package/server/globalAppData/index.d.ts +8 -6
  153. package/server/headless/index.d.ts +28 -26
  154. package/server/hooks/index.d.ts +9 -9
  155. package/server/oauth2/index.d.ts +12 -10
  156. package/server/privileged/index.d.ts +24 -22
  157. package/server/storage/index.d.ts +22 -20
  158. package/types/javax/jcr/Binary/index.d.ts +0 -20
  159. package/types/javax/jcr/Binary/index.js +0 -1
  160. package/types/javax/jcr/ImportUUIDBehavior/index.d.ts +24 -0
  161. package/types/javax/jcr/Item/index.d.ts +1 -116
  162. package/types/javax/jcr/Item/index.js +0 -6
  163. package/types/javax/jcr/NamespaceRegistry/index.d.ts +66 -42
  164. package/types/javax/jcr/NamespaceRegistry/index.js +0 -2
  165. package/types/javax/jcr/Node/index.d.ts +24 -1495
  166. package/types/javax/jcr/Node/index.js +1 -34
  167. package/types/javax/jcr/NodeIterator/index.d.ts +1 -1
  168. package/types/javax/jcr/Property/index.d.ts +487 -489
  169. package/types/javax/jcr/Property/index.js +0 -5
  170. package/types/javax/jcr/PropertyIterator/index.d.ts +1 -1
  171. package/types/javax/jcr/RangeIterator/index.d.ts +1 -43
  172. package/types/javax/jcr/RangeIterator/index.js +1 -5
  173. package/types/javax/jcr/Repository/index.d.ts +460 -260
  174. package/types/javax/jcr/Repository/index.js +0 -4
  175. package/types/javax/jcr/Value/index.d.ts +0 -29
  176. package/types/javax/jcr/Value/index.js +0 -2
  177. package/types/javax/jcr/ValueFactory/index.d.ts +0 -70
  178. package/types/javax/jcr/ValueFactory/index.js +1 -2
  179. package/types/javax/jcr/Workspace/index.d.ts +93 -569
  180. package/types/javax/jcr/Workspace/index.js +1 -12
  181. package/types/javax/jcr/nodetype/ItemDefinition/index.d.ts +0 -103
  182. package/types/javax/jcr/nodetype/ItemDefinition/index.js +0 -5
  183. package/types/javax/jcr/nodetype/NodeDefinition/index.d.ts +1 -1
  184. package/types/javax/jcr/nodetype/NodeDefinitionTemplate/index.d.ts +1 -1
  185. package/types/javax/jcr/nodetype/NodeType/index.d.ts +255 -264
  186. package/types/javax/jcr/nodetype/NodeType/index.js +1 -12
  187. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.d.ts +0 -104
  188. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.js +1 -7
  189. package/types/javax/jcr/nodetype/NodeTypeIterator/index.d.ts +1 -1
  190. package/types/javax/jcr/nodetype/NodeTypeManager/index.d.ts +0 -123
  191. package/types/javax/jcr/nodetype/NodeTypeManager/index.js +1 -8
  192. package/types/javax/jcr/nodetype/NodeTypeTemplate/index.d.ts +1 -1
  193. package/types/javax/jcr/nodetype/PropertyDefinition/index.d.ts +1 -270
  194. package/types/javax/jcr/nodetype/PropertyDefinition/index.js +1 -7
  195. package/types/javax/jcr/nodetype/PropertyDefinitionTemplate/index.d.ts +1 -1
  196. package/types/javax/jcr/observation/Event/index.d.ts +82 -41
  197. package/types/javax/jcr/observation/EventIterator/index.d.ts +1 -1
  198. package/types/javax/jcr/observation/EventJournal/index.d.ts +1 -1
  199. package/types/javax/jcr/observation/EventListenerIterator/index.d.ts +1 -1
  200. package/types/javax/jcr/query/Query/index.d.ts +29 -8
  201. package/types/javax/jcr/query/RowIterator/index.d.ts +1 -1
  202. package/types/javax/jcr/query/qom/And/index.d.ts +1 -1
  203. package/types/javax/jcr/query/qom/BindVariableValue/index.d.ts +1 -1
  204. package/types/javax/jcr/query/qom/ChildNode/index.d.ts +1 -1
  205. package/types/javax/jcr/query/qom/ChildNodeJoinCondition/index.d.ts +1 -1
  206. package/types/javax/jcr/query/qom/Comparison/index.d.ts +1 -1
  207. package/types/javax/jcr/query/qom/DescendantNode/index.d.ts +1 -1
  208. package/types/javax/jcr/query/qom/DescendantNodeJoinCondition/index.d.ts +1 -1
  209. package/types/javax/jcr/query/qom/DynamicOperand/index.d.ts +1 -1
  210. package/types/javax/jcr/query/qom/EquiJoinCondition/index.d.ts +1 -1
  211. package/types/javax/jcr/query/qom/FullTextSearch/index.d.ts +1 -1
  212. package/types/javax/jcr/query/qom/FullTextSearchScore/index.d.ts +1 -1
  213. package/types/javax/jcr/query/qom/Join/index.d.ts +1 -1
  214. package/types/javax/jcr/query/qom/Length/index.d.ts +1 -1
  215. package/types/javax/jcr/query/qom/Literal/index.d.ts +1 -1
  216. package/types/javax/jcr/query/qom/LowerCase/index.d.ts +1 -1
  217. package/types/javax/jcr/query/qom/NodeLocalName/index.d.ts +1 -1
  218. package/types/javax/jcr/query/qom/NodeName/index.d.ts +1 -1
  219. package/types/javax/jcr/query/qom/Not/index.d.ts +1 -1
  220. package/types/javax/jcr/query/qom/Or/index.d.ts +1 -1
  221. package/types/javax/jcr/query/qom/PropertyExistence/index.d.ts +1 -1
  222. package/types/javax/jcr/query/qom/PropertyValue/index.d.ts +1 -1
  223. package/types/javax/jcr/query/qom/QueryObjectModel/index.d.ts +1 -1
  224. package/types/javax/jcr/query/qom/QueryObjectModelConstants/index.d.ts +73 -1
  225. package/types/javax/jcr/query/qom/QueryObjectModelFactory/index.d.ts +1 -1
  226. package/types/javax/jcr/query/qom/SameNode/index.d.ts +1 -1
  227. package/types/javax/jcr/query/qom/SameNodeJoinCondition/index.d.ts +1 -1
  228. package/types/javax/jcr/query/qom/Selector/index.d.ts +1 -1
  229. package/types/javax/jcr/query/qom/StaticOperand/index.d.ts +1 -1
  230. package/types/javax/jcr/query/qom/UpperCase/index.d.ts +1 -1
  231. package/types/javax/jcr/security/AccessControlList/index.d.ts +1 -1
  232. package/types/javax/jcr/security/AccessControlPolicyIterator/index.d.ts +1 -1
  233. package/types/javax/jcr/security/NamedAccessControlPolicy/index.d.ts +1 -1
  234. package/types/javax/jcr/security/Privilege/index.d.ts +127 -43
  235. package/types/javax/jcr/version/Version/index.d.ts +1 -1
  236. package/types/javax/jcr/version/VersionHistory/index.d.ts +1 -1
  237. package/types/javax/jcr/version/VersionIterator/index.d.ts +1 -1
  238. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.d.ts +9 -0
  239. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.js +11 -0
  240. package/types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts +9 -5
  241. package/types/senselogic/sitevision/api/format/NumericFormatterBuilder/index.d.ts +1 -1
  242. package/types/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts +1 -1
  243. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.d.ts +49 -0
  244. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.js +12 -0
  245. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.d.ts +83 -0
  246. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.js +21 -0
  247. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.d.ts +29 -0
  248. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.js +12 -0
  249. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.d.ts +29 -0
  250. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.js +12 -0
  251. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.d.ts +65 -0
  252. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.js +18 -0
  253. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.d.ts +23 -0
  254. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.js +11 -0
  255. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.d.ts +17 -0
  256. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.js +10 -0
  257. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts +1241 -0
  258. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js +189 -0
  259. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.d.ts +29 -0
  260. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.js +12 -0
  261. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.d.ts +89 -0
  262. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.js +22 -0
  263. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.d.ts +25 -0
  264. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.js +11 -0
  265. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.d.ts +17 -0
  266. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.js +10 -0
  267. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.d.ts +17 -0
  268. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.js +10 -0
  269. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.d.ts +23 -0
  270. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.js +11 -0
  271. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.d.ts +35 -0
  272. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.js +13 -0
  273. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.d.ts +23 -0
  274. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.js +11 -0
  275. package/types/senselogic/sitevision/api/script/RequesterChainable/index.d.ts +2 -2
  276. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts +22 -2
  277. package/types/senselogic/sitevision/api/search/SearchHit/index.d.ts +16 -2
  278. package/types/senselogic/sitevision/api/search/SearchResult/index.d.ts +28 -6
  279. package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts +31 -1
  280. package/types/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts +1 -1
@@ -1,256 +1,5 @@
1
1
  import type { Node } from "../../types/javax/jcr/Node";
2
2
 
3
- /**
4
- * <p>
5
- * Adds several images to a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>, <code>sv:personalImageRepository</code>
6
- * or a <code>sv:folder</code> residing as sub node to an image repository.
7
- * If an other parent node is specified a <code>ConstraintViolationException</code> is thrown.
8
- * The images map keys correspond to the file names (will correspond to the property fileName of the sv:image nodes)
9
- * and the values to URIs pointing to the file resources.
10
- * </p>
11
- *
12
- * <p>
13
- * Note that the images must have an image mime-type to be created.
14
- * </p>
15
- *
16
- * <p>
17
- * <strong>URI note!</strong> The resource must be accessible from the Sitevision server! Sitevision opens
18
- * a stream to an URL with the <code>aUri</code> value when creating the binary content of the image.
19
- * If a firewall or such blocks outgoing communication from the server - image creation will fail.
20
- * </p>
21
- *
22
- * <p>
23
- * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
24
- * on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
25
- * or a <code>ConstraintViolationException</code> is thrown.
26
- * <em>Creating an image for a <code>sv:userIdentity</code> requires
27
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
28
- * </p>
29
- * @param aParent the parent node for the images. May not be <code>null</code>
30
- * @param aImages a map of file name to URI pairs May not be <code>null</code>
31
- * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid parent node is specified or if image exceeds file size limit
32
- * @throws RepositoryException if something else goes wrong
33
- */
34
- export function createImages(aParent: Node, aImages: unknown): void;
35
-
36
- /**
37
- * Creates an image using a uri string.
38
- *
39
- * <p>
40
- * Note that the <code>aParent</code> of the file must be a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>,
41
- * <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
42
- * </p>
43
- * <p>
44
- * The file must have an image mime-type or an <code>IllegalArgumentException</code> is thrown.
45
- * </p>
46
- *
47
- * <p>
48
- * <strong>URI note!</strong> The resource must be accessible from the Sitevision server! Sitevision opens
49
- * a stream to an URL with the <code>aUri</code> value when creating the binary content of the image.
50
- * If a firewall or such blocks outgoing communication from the server - image creation will fail.
51
- * </p>
52
- *
53
- * <p>
54
- * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
55
- * on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
56
- * or a <code>ConstraintViolationException</code> is thrown.
57
- * <em>Creating an image for a <code>sv:userIdentity</code> requires
58
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
59
- * </p>
60
- * @param aParent the parent node of the image. May not be <code>null</code>
61
- * @param aFileName the fileName property of the sv:image. May not be <code>null</code>
62
- * @param aUri the URI pointing to the file resource. May not be <code>null</code>
63
- * @return a sv:image node corresponding to the newly created image. Will never return <code>null</code>
64
- * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid parent node is specified or if image exceeds file size limit
65
- * @throws RepositoryException if something else goes wrong
66
- */
67
- export function createImage(
68
- aParent: Node,
69
- aFileName: string,
70
- aUri: string
71
- ): Node;
72
-
73
- /**
74
- * Creates an image using a base64 string.
75
- *
76
- * <p>
77
- * The base64 decoder uses "The Base64 Alphabet" as specified in Table 1 of RFC 4648 and RFC 2045 for decoding operation.
78
- * The decoder rejects data that contains characters outside the base64 alphabet.
79
- * </p>
80
- * <p>
81
- * Note that the <code>aParent</code> of the file must be a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>,
82
- * <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
83
- * </p>
84
- * <p>
85
- * The file name must correspond to an image mime-type or an <code>IllegalArgumentException</code> is thrown.
86
- * </p>
87
- *
88
- * <p>
89
- * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
90
- * on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
91
- * or a <code>ConstraintViolationException</code> is thrown.
92
- * <em>Creating an image for a <code>sv:userIdentity</code> requires
93
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
94
- * </p>
95
- * @param aParent the parent node of the image. May not be <code>null</code>
96
- * @param aFileName the fileName property of the sv:image. May not be <code>null</code>
97
- * @param aBase64EncodedString a base64 encoded string. May not be <code>null</code>
98
- * @return a sv:image node corresponding to the newly created image. Will never return <code>null</code>
99
- * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid parent node is specified, if <code>aBase64EncodedString</code> is not base64 encoded or if image exceeds file size limit
100
- * @throws RepositoryException if something else goes wrong
101
- * @since Sitevision 4.5.4
102
- */
103
- export function createImageFromBase64(
104
- aParent: Node,
105
- aFileName: string,
106
- aBase64EncodedString: string
107
- ): Node;
108
-
109
- /**
110
- * Creates an image using a sv:temporaryFile.
111
- *
112
- * <p>
113
- * Note that the <code>aParent</code> of the file must be a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>,
114
- * <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
115
- * </p>
116
- * <p>
117
- * The file name must correspond to an image mime-type or an <code>IllegalArgumentException</code> is thrown.
118
- * </p>
119
- *
120
- * <p>
121
- * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
122
- * on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
123
- * or a <code>ConstraintViolationException</code> is thrown.
124
- * <em>Creating an image for a <code>sv:userIdentity</code> requires
125
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
126
- * </p>
127
- * @param aParent the parent node of the image
128
- * @param aTemporaryFile a sv:temporaryFile (typically created via {@link senselogic.sitevision.api.node.builder.TemporaryFileNodeBuilder})
129
- * @return a sv:image node corresponding to the newly created image. Will never return <code>null</code>
130
- * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid parent node is specified, if an invalid temporary node is specified or if image exceeds file size limit
131
- * @throws RepositoryException if something else goes wrong
132
- * @since Sitevision 4.5.4
133
- */
134
- export function createImageFromTemporary(
135
- aParent: Node,
136
- aTemporaryFile: Node
137
- ): Node;
138
-
139
- /**
140
- * Updates the binary content of an existing image using a uri string.
141
- *
142
- * <p>
143
- * Properties related to the binary content will also be updated (e.g. <code>length</code>, <code>width</code> and <code>height</code>).
144
- * </p>
145
- *
146
- * <p>
147
- * <strong>URI note!</strong> The URI must be accessible from the Sitevision server and the ending part
148
- * of the URI must match the file extension of the existing image that should be updated!
149
- * </p>
150
- * <p>
151
- * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
152
- * on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
153
- * <em>Updating an image for a <code>sv:userIdentity</code> requires
154
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
155
- * </p>
156
- * @param aImage the image. May not be <code>null</code>
157
- * @param aUri the URI pointing to the file resource to fetch new binary content from. May not be <code>null</code>
158
- * @throws ConstraintViolationException if the user is not authorized to alter the image node, if an invalid node is specified, if the end part of <code>aUri</code> doesn't match the file extension of <code>aImage</code> or if image exceeds file size limit
159
- * @throws RepositoryException if something else goes wrong
160
- * @since Sitevision 3.6.3
161
- */
162
- export function updateBinaryContent(aImage: Node, aUri: string): void;
163
-
164
- /**
165
- * Updates the binary content of an existing image using a base64 string.
166
- *
167
- * <p>
168
- * The base64 decoder uses "The Base64 Alphabet" as specified in Table 1 of RFC 4648 and RFC 2045 for decoding operation.
169
- * The decoder rejects data that contains characters outside the base64 alphabet.
170
- * </p>
171
- * <p>
172
- * Properties related to the binary content will also be updated (e.g. <code>length</code>, <code>width</code> and <code>height</code>).
173
- * </p>
174
- *
175
- * <p>
176
- * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
177
- * on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
178
- * <em>Updating an image for a <code>sv:userIdentity</code> requires
179
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
180
- * </p>
181
- * @param aImage the image. May not be <code>null</code>
182
- * @param aBase64EncodedString a base64 encoded string. May not be <code>null</code>
183
- * @throws ConstraintViolationException if the user is not authorized to alter the image node, if an invalid node is specified, if <code>aBase64EncodedString</code> is not base64 encoded or if image exceeds file size limit
184
- * @throws RepositoryException if something else goes wrong
185
- * @since Sitevision 4.5.4
186
- */
187
- export function updateBinaryContentFromBase64(
188
- aImage: Node,
189
- aBase64EncodedString: string
190
- ): void;
191
-
192
- /**
193
- * Updates the binary content of an existing image using a sv:temporaryFile.
194
- *
195
- * <p>
196
- * Properties related to the binary content will also be updated (e.g. <code>length</code>, <code>width</code> and <code>height</code>).
197
- * </p>
198
- *
199
- * <p>
200
- * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
201
- * on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
202
- * <em>Updating an image for a <code>sv:userIdentity</code> requires
203
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
204
- * </p>
205
- * @param aImage the image. May not be <code>null</code>
206
- * @param aTemporaryFile the sv:temporaryFile (typically created via {@link senselogic.sitevision.api.node.builder.TemporaryFileNodeBuilder})
207
- * @throws ConstraintViolationException if the user is not authorized to alter the image node, if an invalid node is specified, if the end part of the file represented by <code>aTemporaryFile</code> doesn't match the file extension of <code>aImage</code> or if image exceeds file size limit
208
- * @throws RepositoryException if something else goes wrong
209
- * @since Sitevision 4.5.4
210
- */
211
- export function updateBinaryContentFromTemporary(
212
- aImage: Node,
213
- aTemporaryFile: Node
214
- ): void;
215
-
216
- /**
217
- * Alters the name of an image.
218
- *
219
- * <p>
220
- * If no image is specified a <code>NullPointerException</code> is thrown.
221
- * If the node is not a sv:image an <code>IllegalArgumentException</code> is thrown.
222
- * If no name is provided a <code>NullPointerException</code> is thrown.
223
- * </p>
224
- *
225
- * <p>
226
- * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
227
- * on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
228
- * <em>Updating an image for a <code>sv:userIdentity</code> requires
229
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
230
- * </p>
231
- * @param aImage the sv:image that should be renamed. May not be <code>null</code>
232
- * @param aName the new name of the image. May not be <code>null</code>
233
- * @throws ConstraintViolationException if the current user is not authorized to alter the name of the image or if the image extension doesn't match
234
- * @throws RepositoryException if something else goes wrong
235
- * @since Sitevision 4.5.2
236
- */
237
- export function renameImage(aImage: Node, aName: string): void;
238
-
239
- /**
240
- * The Base64 String representation of an image Node.
241
- *
242
- * <p>
243
- * Reads the binary content of an image and encodes the bytes using
244
- * {@link senselogic.sitevision.api.text.EndecUtil#base64encodeToString(byte[])}.
245
- * </p>
246
- * @param aImage the image Node (sv:image or sv:temporaryFile), may not be null
247
- * @return aImage as base64-encoded String
248
- * @throws ConstraintViolationException if aImage is not a sv:image or sv:temporaryFile
249
- * @throws RepositoryException if something else goes wrong
250
- * @since Sitevision 4.5.5.2
251
- */
252
- export function toBase64(aImage: Node): string;
253
-
254
3
  /**
255
4
  * Image utility interface that handles nodes with primary node type <code>sv:image</code>.
256
5
  *
@@ -269,18 +18,251 @@ export function toBase64(aImage: Node): string;
269
18
  * @author Mikael Wikblom
270
19
  * @since Sitevision 2.6.2
271
20
  */
272
- declare namespace imageUtil {
273
- export {
274
- createImages,
275
- createImage,
276
- createImageFromBase64,
277
- createImageFromTemporary,
278
- updateBinaryContent,
279
- updateBinaryContentFromBase64,
280
- updateBinaryContentFromTemporary,
281
- renameImage,
282
- toBase64,
283
- };
21
+ export interface ImageUtil {
22
+ /**
23
+ * <p>
24
+ * Adds several images to a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>, <code>sv:personalImageRepository</code>
25
+ * or a <code>sv:folder</code> residing as sub node to an image repository.
26
+ * If an other parent node is specified a <code>ConstraintViolationException</code> is thrown.
27
+ * The images map keys correspond to the file names (will correspond to the property fileName of the sv:image nodes)
28
+ * and the values to URIs pointing to the file resources.
29
+ * </p>
30
+ *
31
+ * <p>
32
+ * Note that the images must have an image mime-type to be created.
33
+ * </p>
34
+ *
35
+ * <p>
36
+ * <strong>URI note!</strong> The resource must be accessible from the Sitevision server! Sitevision opens
37
+ * a stream to an URL with the <code>aUri</code> value when creating the binary content of the image.
38
+ * If a firewall or such blocks outgoing communication from the server - image creation will fail.
39
+ * </p>
40
+ *
41
+ * <p>
42
+ * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
43
+ * on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
44
+ * or a <code>ConstraintViolationException</code> is thrown.
45
+ * <em>Creating an image for a <code>sv:userIdentity</code> requires
46
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
47
+ * </p>
48
+ * @param aParent the parent node for the images. May not be <code>null</code>
49
+ * @param aImages a map of file name to URI pairs May not be <code>null</code>
50
+ * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid parent node is specified or if image exceeds file size limit
51
+ * @throws RepositoryException if something else goes wrong
52
+ */
53
+ createImages(aParent: Node, aImages: unknown): void;
54
+
55
+ /**
56
+ * Creates an image using a uri string.
57
+ *
58
+ * <p>
59
+ * Note that the <code>aParent</code> of the file must be a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>,
60
+ * <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
61
+ * </p>
62
+ * <p>
63
+ * The file must have an image mime-type or an <code>IllegalArgumentException</code> is thrown.
64
+ * </p>
65
+ *
66
+ * <p>
67
+ * <strong>URI note!</strong> The resource must be accessible from the Sitevision server! Sitevision opens
68
+ * a stream to an URL with the <code>aUri</code> value when creating the binary content of the image.
69
+ * If a firewall or such blocks outgoing communication from the server - image creation will fail.
70
+ * </p>
71
+ *
72
+ * <p>
73
+ * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
74
+ * on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
75
+ * or a <code>ConstraintViolationException</code> is thrown.
76
+ * <em>Creating an image for a <code>sv:userIdentity</code> requires
77
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
78
+ * </p>
79
+ * @param aParent the parent node of the image. May not be <code>null</code>
80
+ * @param aFileName the fileName property of the sv:image. May not be <code>null</code>
81
+ * @param aUri the URI pointing to the file resource. May not be <code>null</code>
82
+ * @return a sv:image node corresponding to the newly created image. Will never return <code>null</code>
83
+ * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid parent node is specified or if image exceeds file size limit
84
+ * @throws RepositoryException if something else goes wrong
85
+ */
86
+ createImage(aParent: Node, aFileName: string, aUri: string): Node;
87
+
88
+ /**
89
+ * Creates an image using a base64 string.
90
+ *
91
+ * <p>
92
+ * The base64 decoder uses "The Base64 Alphabet" as specified in Table 1 of RFC 4648 and RFC 2045 for decoding operation.
93
+ * The decoder rejects data that contains characters outside the base64 alphabet.
94
+ * </p>
95
+ * <p>
96
+ * Note that the <code>aParent</code> of the file must be a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>,
97
+ * <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
98
+ * </p>
99
+ * <p>
100
+ * The file name must correspond to an image mime-type or an <code>IllegalArgumentException</code> is thrown.
101
+ * </p>
102
+ *
103
+ * <p>
104
+ * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
105
+ * on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
106
+ * or a <code>ConstraintViolationException</code> is thrown.
107
+ * <em>Creating an image for a <code>sv:userIdentity</code> requires
108
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
109
+ * </p>
110
+ * @param aParent the parent node of the image. May not be <code>null</code>
111
+ * @param aFileName the fileName property of the sv:image. May not be <code>null</code>
112
+ * @param aBase64EncodedString a base64 encoded string. May not be <code>null</code>
113
+ * @return a sv:image node corresponding to the newly created image. Will never return <code>null</code>
114
+ * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid parent node is specified, if <code>aBase64EncodedString</code> is not base64 encoded or if image exceeds file size limit
115
+ * @throws RepositoryException if something else goes wrong
116
+ * @since Sitevision 4.5.4
117
+ */
118
+ createImageFromBase64(
119
+ aParent: Node,
120
+ aFileName: string,
121
+ aBase64EncodedString: string
122
+ ): Node;
123
+
124
+ /**
125
+ * Creates an image using a sv:temporaryFile.
126
+ *
127
+ * <p>
128
+ * Note that the <code>aParent</code> of the file must be a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>,
129
+ * <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
130
+ * </p>
131
+ * <p>
132
+ * The file name must correspond to an image mime-type or an <code>IllegalArgumentException</code> is thrown.
133
+ * </p>
134
+ *
135
+ * <p>
136
+ * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
137
+ * on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
138
+ * or a <code>ConstraintViolationException</code> is thrown.
139
+ * <em>Creating an image for a <code>sv:userIdentity</code> requires
140
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
141
+ * </p>
142
+ * @param aParent the parent node of the image
143
+ * @param aTemporaryFile a sv:temporaryFile (typically created via {@link senselogic.sitevision.api.node.builder.TemporaryFileNodeBuilder})
144
+ * @return a sv:image node corresponding to the newly created image. Will never return <code>null</code>
145
+ * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid parent node is specified, if an invalid temporary node is specified or if image exceeds file size limit
146
+ * @throws RepositoryException if something else goes wrong
147
+ * @since Sitevision 4.5.4
148
+ */
149
+ createImageFromTemporary(aParent: Node, aTemporaryFile: Node): Node;
150
+
151
+ /**
152
+ * Updates the binary content of an existing image using a uri string.
153
+ *
154
+ * <p>
155
+ * Properties related to the binary content will also be updated (e.g. <code>length</code>, <code>width</code> and <code>height</code>).
156
+ * </p>
157
+ *
158
+ * <p>
159
+ * <strong>URI note!</strong> The URI must be accessible from the Sitevision server and the ending part
160
+ * of the URI must match the file extension of the existing image that should be updated!
161
+ * </p>
162
+ * <p>
163
+ * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
164
+ * on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
165
+ * <em>Updating an image for a <code>sv:userIdentity</code> requires
166
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
167
+ * </p>
168
+ * @param aImage the image. May not be <code>null</code>
169
+ * @param aUri the URI pointing to the file resource to fetch new binary content from. May not be <code>null</code>
170
+ * @throws ConstraintViolationException if the user is not authorized to alter the image node, if an invalid node is specified, if the end part of <code>aUri</code> doesn't match the file extension of <code>aImage</code> or if image exceeds file size limit
171
+ * @throws RepositoryException if something else goes wrong
172
+ * @since Sitevision 3.6.3
173
+ */
174
+ updateBinaryContent(aImage: Node, aUri: string): void;
175
+
176
+ /**
177
+ * Updates the binary content of an existing image using a base64 string.
178
+ *
179
+ * <p>
180
+ * The base64 decoder uses "The Base64 Alphabet" as specified in Table 1 of RFC 4648 and RFC 2045 for decoding operation.
181
+ * The decoder rejects data that contains characters outside the base64 alphabet.
182
+ * </p>
183
+ * <p>
184
+ * Properties related to the binary content will also be updated (e.g. <code>length</code>, <code>width</code> and <code>height</code>).
185
+ * </p>
186
+ *
187
+ * <p>
188
+ * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
189
+ * on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
190
+ * <em>Updating an image for a <code>sv:userIdentity</code> requires
191
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
192
+ * </p>
193
+ * @param aImage the image. May not be <code>null</code>
194
+ * @param aBase64EncodedString a base64 encoded string. May not be <code>null</code>
195
+ * @throws ConstraintViolationException if the user is not authorized to alter the image node, if an invalid node is specified, if <code>aBase64EncodedString</code> is not base64 encoded or if image exceeds file size limit
196
+ * @throws RepositoryException if something else goes wrong
197
+ * @since Sitevision 4.5.4
198
+ */
199
+ updateBinaryContentFromBase64(
200
+ aImage: Node,
201
+ aBase64EncodedString: string
202
+ ): void;
203
+
204
+ /**
205
+ * Updates the binary content of an existing image using a sv:temporaryFile.
206
+ *
207
+ * <p>
208
+ * Properties related to the binary content will also be updated (e.g. <code>length</code>, <code>width</code> and <code>height</code>).
209
+ * </p>
210
+ *
211
+ * <p>
212
+ * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
213
+ * on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
214
+ * <em>Updating an image for a <code>sv:userIdentity</code> requires
215
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
216
+ * </p>
217
+ * @param aImage the image. May not be <code>null</code>
218
+ * @param aTemporaryFile the sv:temporaryFile (typically created via {@link senselogic.sitevision.api.node.builder.TemporaryFileNodeBuilder})
219
+ * @throws ConstraintViolationException if the user is not authorized to alter the image node, if an invalid node is specified, if the end part of the file represented by <code>aTemporaryFile</code> doesn't match the file extension of <code>aImage</code> or if image exceeds file size limit
220
+ * @throws RepositoryException if something else goes wrong
221
+ * @since Sitevision 4.5.4
222
+ */
223
+ updateBinaryContentFromTemporary(aImage: Node, aTemporaryFile: Node): void;
224
+
225
+ /**
226
+ * Alters the name of an image.
227
+ *
228
+ * <p>
229
+ * If no image is specified a <code>NullPointerException</code> is thrown.
230
+ * If the node is not a sv:image an <code>IllegalArgumentException</code> is thrown.
231
+ * If no name is provided a <code>NullPointerException</code> is thrown.
232
+ * </p>
233
+ *
234
+ * <p>
235
+ * <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
236
+ * on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
237
+ * <em>Updating an image for a <code>sv:userIdentity</code> requires
238
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
239
+ * </p>
240
+ * @param aImage the sv:image that should be renamed. May not be <code>null</code>
241
+ * @param aName the new name of the image. May not be <code>null</code>
242
+ * @throws ConstraintViolationException if the current user is not authorized to alter the name of the image or if the image extension doesn't match
243
+ * @throws RepositoryException if something else goes wrong
244
+ * @since Sitevision 4.5.2
245
+ */
246
+ renameImage(aImage: Node, aName: string): void;
247
+
248
+ /**
249
+ * The Base64 String representation of an image Node.
250
+ *
251
+ * <p>
252
+ * Reads the binary content of an image and encodes the bytes using
253
+ * {@link senselogic.sitevision.api.text.EndecUtil#base64encodeToString(byte[])}.
254
+ * </p>
255
+ * @param aImage the image Node (sv:image or sv:temporaryFile), may not be null
256
+ * @return aImage as base64-encoded String
257
+ * @throws ConstraintViolationException if aImage is not a sv:image or sv:temporaryFile
258
+ * @throws RepositoryException if something else goes wrong
259
+ * @since Sitevision 4.5.5.2
260
+ */
261
+ toBase64(aImage: Node): string;
284
262
  }
285
263
 
264
+ declare namespace ImageUtil {}
265
+
266
+ declare var imageUtil: ImageUtil;
267
+
286
268
  export default imageUtil;
@@ -1,38 +1,6 @@
1
+ import type IndexType from "../IndexUtil.IndexType";
1
2
  import type { Node } from "../../types/javax/jcr/Node";
2
3
 
3
- /**
4
- * Gets the default index for a specified index type.
5
- *
6
- * <p>
7
- * <strong>Note!</strong>The default user identity index is only handled if a <em>Social Collaboration</em> license is in use.
8
- * The default user-generated content (UGC) index is only handled if a <em>Social Collaboration</em> license is in use.
9
- * </p>
10
- * @param aIndexType type of index
11
- * @return the default index for <code>aIndexType</code>, or <code>null</code> if not available
12
- */
13
- export function getDefaultIndex(aIndexType: unknown): Node;
14
-
15
- /**
16
- * Gets an index by name.
17
- *
18
- * <p>
19
- * Lookup order:
20
- * </p>
21
- * <ol>
22
- * <li>Custom <em>site</em> index</li>
23
- * <li>Custom <em>server</em> index</li>
24
- * <li><em>Default</em> index(-es), types specified by {@link senselogic.sitevision.api.search.index.IndexUtil.IndexType}</li>
25
- * </ol>
26
- * <p>
27
- * <strong>Note!</strong> Custom index is only handled if a <em>Search Package 2</em> license is in use.
28
- * The default user identity index is only handled if a <em>Social Collaboration</em> license is in use.
29
- * The default user-generated content (UGC) index is only handled if a <em>Social Collaboration</em> license is in use.
30
- * </p>
31
- * @param aIndexName the name of the index
32
- * @return the index or <code>null</code> if no index matches <code>aIndexName</code>
33
- */
34
- export function getIndexByName(aIndexName: string): Node;
35
-
36
4
  /**
37
5
  * Index utility interface.
38
6
  *
@@ -44,8 +12,43 @@ export function getIndexByName(aIndexName: string): Node;
44
12
  * @author Magnus Lövgren
45
13
  * @since Sitevision 3.6
46
14
  */
47
- declare namespace indexUtil {
48
- export { getDefaultIndex, getIndexByName };
15
+ export interface IndexUtil {
16
+ /**
17
+ * Gets the default index for a specified index type.
18
+ *
19
+ * <p>
20
+ * <strong>Note!</strong>The default user identity index is only handled if a <em>Social Collaboration</em> license is in use.
21
+ * The default user-generated content (UGC) index is only handled if a <em>Social Collaboration</em> license is in use.
22
+ * </p>
23
+ * @param aIndexType type of index
24
+ * @return the default index for <code>aIndexType</code>, or <code>null</code> if not available
25
+ */
26
+ getDefaultIndex(aIndexType: IndexType): Node;
27
+
28
+ /**
29
+ * Gets an index by name.
30
+ *
31
+ * <p>
32
+ * Lookup order:
33
+ * </p>
34
+ * <ol>
35
+ * <li>Custom <em>site</em> index</li>
36
+ * <li>Custom <em>server</em> index</li>
37
+ * <li><em>Default</em> index(-es), types specified by {@link senselogic.sitevision.api.search.index.IndexUtil.IndexType}</li>
38
+ * </ol>
39
+ * <p>
40
+ * <strong>Note!</strong> Custom index is only handled if a <em>Search Package 2</em> license is in use.
41
+ * The default user identity index is only handled if a <em>Social Collaboration</em> license is in use.
42
+ * The default user-generated content (UGC) index is only handled if a <em>Social Collaboration</em> license is in use.
43
+ * </p>
44
+ * @param aIndexName the name of the index
45
+ * @return the index or <code>null</code> if no index matches <code>aIndexName</code>
46
+ */
47
+ getIndexByName(aIndexName: string): Node;
49
48
  }
50
49
 
50
+ declare namespace IndexUtil {}
51
+
52
+ declare var indexUtil: IndexUtil;
53
+
51
54
  export default indexUtil;
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Type of default index, used by {@link senselogic.sitevision.api.search.index.IndexUtil}.
3
+ *
4
+ * <p>
5
+ * Example of how to get the {@link #USER_IDENTITY} type:
6
+ * </p>
7
+ * <ul>
8
+ * <li>
9
+ * Using <strong>Velocity:</strong><pre><code>
10
+ * #set ($instanceCreatorUtil = $sitevisionUtils.instanceCreatorUtil)
11
+ * #set ($enumClassName = 'senselogic.sitevision.api.search.index.IndexUtil$IndexType') <em>## Note the '$' separator...</em>
12
+ * #set ($userIdentityEnum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'USER_IDENTITY'))</code></pre>
13
+ * </li>
14
+ * <li>
15
+ * Using server-side <strong>JavaScript:</strong><pre><code>
16
+ * var userIdentityEnum = require('IndexUtil.IndexType.USER_IDENTITY');</code></pre>
17
+ * </li>
18
+ * </ul>
19
+ * @author Magnus Lövgren
20
+ * @since Sitevision 3.6
21
+ */
22
+ declare enum IndexType {
23
+ NODE,
24
+ USER_IDENTITY,
25
+ USER,
26
+ UGC,
27
+ }
28
+
29
+ export default IndexType;
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _default = {
8
+ NODE: 'NODE',
9
+ USER_IDENTITY: 'USER_IDENTITY',
10
+ USER: 'USER',
11
+ UGC: 'UGC'
12
+ };
13
+ exports["default"] = _default;