@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,279 +1,5 @@
1
1
  import type { Node } from "../../types/javax/jcr/Node";
2
2
 
3
- /**
4
- * <p>
5
- * Alters the content of a sv:page, sv:article or a sv:template.
6
- * </p>
7
- *
8
- * <p>
9
- * If an invalid node type is specified a <code>IllegalArgumentException</code> is thrown. The page content is specified as a
10
- * HTML string used to generate a portlet structure in the <strong>first</strong> layout available. The provided
11
- * content is converted to Sitevision text, table and image modules. It is also possible to specify that a horizontal
12
- * or a vertical layout should be created.
13
- * </p>
14
- *
15
- * <p>
16
- * <strong>Note that the content (i.e portlets and layouts) of the first layout will be replaced, not appended.</strong>
17
- * </p>
18
- *
19
- * <p>
20
- * The current user must be authorized to alter the node or a <code>ConstraintViolationException</code> is thrown.
21
- * </p>
22
- *
23
- * <p>
24
- * If no node or no content is specified a <code>NullPointerException</code> is thrown.
25
- * </p>
26
- * @param aNode aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page.
27
- * @param aContent the HTML content. May not be <code>null</code>
28
- * @throws ConstraintViolationException if the current user is not allowed to alter the node
29
- * @throws RepositoryException if something else goes wrong
30
- * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
31
- */
32
- export function updateContent(aNode: Node, aContent: string): void;
33
-
34
- /**
35
- * <p>
36
- * Alters the content of a sv:page, sv:article or a sv:template.
37
- * </p>
38
- *
39
- * <p>
40
- * If an invalid node type is specified a <code>IllegalArgumentException</code> is thrown. The page content is specified using the
41
- * content map containing keys corresponding to layout names (e.g. "mittenspalt") on the page and values containing the
42
- * HTML used to generate a portlet structure in the layout. The provided content is converted to
43
- * Sitevision text, table and image modules. It is also possible to specify that a horizontal or a vertical
44
- * layout should be created.
45
- * </p>
46
- *
47
- * <p>
48
- * The names of the content map must correspond to layout names on the page.
49
- * </p>
50
- *
51
- * <p>
52
- * <strong>Note that the content of the specified layouts (i.e portlets and layouts) will be replaced, not appended.</strong>
53
- * </p>
54
- *
55
- * <p>
56
- * The current user must be authorized to alter the node or a <code>ConstraintViolationException</code> is thrown.
57
- * </p>
58
- *
59
- * <p>
60
- * If no node or no content is specified a <code>NullPointerException</code> is thrown.
61
- * </p>
62
- * @param aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page.
63
- * @param aContent a map containing the HTML content. The keys must correspond to layout names on the node. May not be <code>null</code>
64
- * @throws ConstraintViolationException if the current user is not allowed to alter the node
65
- * @throws RepositoryException if something else goes wrong
66
- * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
67
- */
68
- export function updateContent(aNode: Node, aContent: unknown): void;
69
-
70
- /**
71
- * Alters the content of a sv:page, sv:article or a sv:template with raw HTML (a HTML portlet is created).
72
- *
73
- * <p>
74
- * <strong>Note!</strong> This method creates a single HTML portlet that contains all supplied content. This method
75
- * is intended to be used as a <em>temporary solution</em> when the proper {@link #updateContent(javax.jcr.Node, java.util.Map)}
76
- * and {@link #updateContent(javax.jcr.Node, String)} methods for some reason can't be used. Typically when converting badly formatted
77
- * legacy CMS data into Sitevision content. I.e. this method enables creation of content that later on ought to be manually converted
78
- * to proper Sitevision portlets.
79
- * </p>
80
- *
81
- * <p>
82
- * <strong>Note!</strong> Content is treated <em>as-is</em>, hence no internal links or references to local resources will be resolved
83
- * as with the {@link #updateContent(javax.jcr.Node, java.util.Map)} and {@link #updateContent(javax.jcr.Node, String)} methods.
84
- * The {@link #resolveToResourceURL(javax.jcr.Node, String)} can be used to manually try to resolve "old" resource url to a "new"
85
- * Sitevision resource url.
86
- * </p>
87
- * @param aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page
88
- * @param aContent the HTML content. May not be <code>null</code>
89
- * @throws NullPointerException if aNode is null or if aContent is null
90
- * @throws IllegalArgumentException if aNode is of invalid type
91
- * @throws ConstraintViolationException if current user is not allowed to alter aNode
92
- * @throws RepositoryException if something else goes wrong
93
- * @since Sitevision 3.6
94
- * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
95
- */
96
- export function updateContentWithRawHtml(aNode: Node, aContent: string): void;
97
-
98
- /**
99
- * Alters the content of a sv:page, sv:article or a sv:template with raw HTML (a HTML portlet is created).
100
- *
101
- * <p>
102
- * <strong>Note!</strong> This method creates a single HTML portlet for each supplied content entry. This method
103
- * is intended to be used as a <em>temporary solution</em> when the proper {@link #updateContent(javax.jcr.Node, java.util.Map)}
104
- * and {@link #updateContent(javax.jcr.Node, String)} methods for some reason can't be used. Typically when converting badly formatted
105
- * legacy CMS data into Sitevision content. I.e. this method enables creation of content that later on ought to be manually converted
106
- * to proper Sitevision portlets.
107
- * </p>
108
- *
109
- * <p>
110
- * <strong>Note!</strong> Content is treated <em>as-is</em>, hence no internal links or references to local resources will be resolved
111
- * as with the {@link #updateContent(javax.jcr.Node, java.util.Map)} and {@link #updateContent(javax.jcr.Node, String)} methods.
112
- * The {@link #resolveToResourceURL(javax.jcr.Node, String)} can be used to manually try to resolve "old" resource url to a "new"
113
- * Sitevision resource url.
114
- * </p>
115
- * @param aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page
116
- * @param aContent a map containing the HTML content. The keys must correspond to layout names on the node. May not be <code>null</code>
117
- * @throws NullPointerException if aNode is null or if aContent is null
118
- * @throws IllegalArgumentException if aNode is of invalid type
119
- * @throws ConstraintViolationException if current user is not allowed to alter aNode
120
- * @throws RepositoryException if something else goes wrong
121
- * @since Sitevision 3.6
122
- * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
123
- */
124
- export function updateContentWithRawHtml(aNode: Node, aContent: unknown): void;
125
-
126
- /**
127
- * Appends the content to the existing node.
128
- *
129
- * <p>
130
- * If an invalid node type is specified a <code>IllegalArgumentException</code> is thrown. The page content is specified as a
131
- * HTML string used to generate a portlet structure in the <strong>first</strong> layout available. The provided
132
- * content is converted to Sitevision text, table and image modules. It is also possible to specify that a horizontal
133
- * or a vertical layout should be created.
134
- * </p>
135
- *
136
- * <p>
137
- * <strong>Note that the content (i.e portlets and layouts) of the first layout will be appended, not replaced.</strong>
138
- * </p>
139
- *
140
- * <p>
141
- * The current user must be authorized to alter the node or a <code>ConstraintViolationException</code> is thrown.
142
- * </p>
143
- *
144
- * <p>
145
- * If no node or no content is specified a <code>NullPointerException</code> is thrown.
146
- * </p>
147
- * @param aNode aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page.
148
- * @param aContent the HTML content. May not be <code>null</code>
149
- * @throws NullPointerException if aNode is null or if aContent is null
150
- * @throws IllegalArgumentException if aNode is of invalid type
151
- * @throws ConstraintViolationException if the current user is not allowed to alter the node
152
- * @throws RepositoryException if something else goes wrong
153
- * @since Sitevision 2022.08.1
154
- * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
155
- */
156
- export function appendContent(aNode: Node, aContent: string): void;
157
-
158
- /**
159
- * <p>
160
- * Append the content to the existing node.
161
- * </p>
162
- *
163
- * <p>
164
- * If an invalid node type is specified a <code>IllegalArgumentException</code> is thrown. The page content is specified using the
165
- * content map containing keys corresponding to layout names (e.g. "mittenspalt") on the page and values containing the
166
- * HTML used to generate a portlet structure in the layout. The provided content is converted to
167
- * Sitevision text, table and image modules. It is also possible to specify that a horizontal or a vertical
168
- * layout should be created.
169
- * </p>
170
- *
171
- * <p>
172
- * The names of the content map must correspond to layout names on the page.
173
- * </p>
174
- *
175
- * <p>
176
- * <strong>Note that the content of the specified layouts (i.e portlets and layouts) will be appended, not replaced.</strong>
177
- * </p>
178
- *
179
- * <p>
180
- * The current user must be authorized to alter the node or a <code>ConstraintViolationException</code> is thrown.
181
- * </p>
182
- *
183
- * <p>
184
- * If no node or no content is specified a <code>NullPointerException</code> is thrown.
185
- * </p>
186
- * @param aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page.
187
- * @param aContent a map containing the HTML content. The keys must correspond to layout names on the node. May not be <code>null</code>
188
- * @throws NullPointerException if aNode is null or if aContent is null
189
- * @throws IllegalArgumentException if aNode is of invalid type
190
- * @throws ConstraintViolationException if the current user is not allowed to alter the node
191
- * @throws RepositoryException if something else goes wrong
192
- * @since Sitevision 2022.08.1
193
- * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
194
- */
195
- export function appendContent(aNode: Node, aContent: unknown): void;
196
-
197
- /**
198
- * Appends raw HTML (a HTML portlet is created) to the existing content of a node.
199
- *
200
- * <p>
201
- * <strong>Note!</strong> This method creates a single HTML portlet that contains all supplied content and appends it to the existing content.
202
- * This method is intended to be used as a <em>temporary solution</em> when the proper {@link #updateContent(javax.jcr.Node, java.util.Map)}
203
- * and {@link #updateContent(javax.jcr.Node, String)} methods for some reason can't be used. Typically when converting badly formatted legacy
204
- * CMS data into Sitevision content. I.e. this method enables creation of content that later on ought to be manually converted to proper
205
- * Sitevision portlets.
206
- * </p>
207
- *
208
- * <p>
209
- * <strong>Note!</strong> Content is treated <em>as-is</em>, hence no internal links or references to local resources will be resolved
210
- * as with the {@link #updateContent(javax.jcr.Node, java.util.Map)} and {@link #updateContent(javax.jcr.Node, String)} methods.
211
- * The {@link #resolveToResourceURL(javax.jcr.Node, String)} can be used to manually try to resolve "old" resource url to a "new"
212
- * Sitevision resource url.
213
- * </p>
214
- * @param aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page
215
- * @param aContent the HTML content. May not be <code>null</code>
216
- * @throws NullPointerException if aNode is null or if aContent is null
217
- * @throws IllegalArgumentException if aNode is of invalid type
218
- * @throws ConstraintViolationException if current user is not allowed to alter aNode
219
- * @throws RepositoryException if something else goes wrong
220
- * @since Sitevision 3.6
221
- * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
222
- */
223
- export function appendContentWithRawHtml(aNode: Node, aContent: string): void;
224
-
225
- /**
226
- * Appends raw HTML (a HTML portlet is created) to the existing content of a node.
227
- *
228
- * <p>
229
- * <strong>Note!</strong> This method creates a single HTML portlet that contains all supplied content and appends it to the existing content.
230
- * This method is intended to be used as a <em>temporary solution</em> when the proper {@link #updateContent(javax.jcr.Node, java.util.Map)}
231
- * and {@link #updateContent(javax.jcr.Node, String)} methods for some reason can't be used. Typically when converting badly formatted legacy
232
- * CMS data into Sitevision content. I.e. this method enables creation of content that later on ought to be manually converted to proper
233
- * Sitevision portlets.
234
- * </p>
235
- *
236
- * <p>
237
- * <strong>Note!</strong> Content is treated <em>as-is</em>, hence no internal links or references to local resources will be resolved
238
- * as with the {@link #updateContent(javax.jcr.Node, java.util.Map)} and {@link #updateContent(javax.jcr.Node, String)} methods.
239
- * The {@link #resolveToResourceURL(javax.jcr.Node, String)} can be used to manually try to resolve "old" resource url to a "new"
240
- * Sitevision resource url.
241
- * </p>
242
- * @param aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page
243
- * @param aContent a map containing the HTML content. The keys must correspond to layout names on the node. May not be <code>null</code>
244
- * @throws NullPointerException if aNode is null or if aContent is null
245
- * @throws IllegalArgumentException if aNode is of invalid type
246
- * @throws ConstraintViolationException if current user is not allowed to alter aNode
247
- * @throws RepositoryException if something else goes wrong
248
- * @since Sitevision 3.6
249
- * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
250
- */
251
- export function appendContentWithRawHtml(aNode: Node, aContent: unknown): void;
252
-
253
- /**
254
- * Resolves an unresolved URL to a resource (potentially needed for all resource references in HTML content that later is
255
- * updated or appended as raw HTML).
256
- *
257
- * <p>
258
- * <strong>Note!</strong> HTML content is treated <em>as-is</em> when using the
259
- * {@link #appendContentWithRawHtml(javax.jcr.Node, java.util.Map)}, {@link #appendContentWithRawHtml(javax.jcr.Node, String)},
260
- * {@link #updateContentWithRawHtml(javax.jcr.Node, java.util.Map)} or {@link #updateContentWithRawHtml(javax.jcr.Node, String)}.
261
- * Hence no internal links or references to local resources will be resolved as with the {@link #updateContent(javax.jcr.Node, java.util.Map)}
262
- * and {@link #updateContent(javax.jcr.Node, String)} methods.
263
- * This method can be used to manually try to resolve "old" resource url to a "new" Sitevision resource url.
264
- * </p>
265
- * @param aNode the node that <code>aUnresolvedURL</code> should be resolved for, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page
266
- * @param aUnresolvedURL an unresolved URL
267
- * @return the potentially resolved URL
268
- * @throws NullPointerException if aNode is null or if aUnresolvedURL is null
269
- * @throws IllegalArgumentException if aNode is of invalid type
270
- * @since Sitevision 3.6
271
- */
272
- export function resolveToResourceURL(
273
- aNode: Node,
274
- aUnresolvedURL: string
275
- ): string;
276
-
277
3
  /**
278
4
  * Utility interface for content manipulation of a sv:page, sv:article or a sv:template.
279
5
  *
@@ -457,14 +183,281 @@ export function resolveToResourceURL(
457
183
  * @author Mikael Wikblom
458
184
  * @since Sitevision 2.6.2
459
185
  */
460
- declare namespace webContentUtil {
461
- export {
462
- updateContent,
463
- updateContentWithRawHtml,
464
- appendContent,
465
- appendContentWithRawHtml,
466
- resolveToResourceURL,
467
- };
186
+ export interface WebContentUtil {
187
+ /**
188
+ * <p>
189
+ * Alters the content of a sv:page, sv:article or a sv:template.
190
+ * </p>
191
+ *
192
+ * <p>
193
+ * If an invalid node type is specified a <code>IllegalArgumentException</code> is thrown. The page content is specified as a
194
+ * HTML string used to generate a portlet structure in the <strong>first</strong> layout available. The provided
195
+ * content is converted to Sitevision text, table and image modules. It is also possible to specify that a horizontal
196
+ * or a vertical layout should be created.
197
+ * </p>
198
+ *
199
+ * <p>
200
+ * <strong>Note that the content (i.e portlets and layouts) of the first layout will be replaced, not appended.</strong>
201
+ * </p>
202
+ *
203
+ * <p>
204
+ * The current user must be authorized to alter the node or a <code>ConstraintViolationException</code> is thrown.
205
+ * </p>
206
+ *
207
+ * <p>
208
+ * If no node or no content is specified a <code>NullPointerException</code> is thrown.
209
+ * </p>
210
+ * @param aNode aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page.
211
+ * @param aContent the HTML content. May not be <code>null</code>
212
+ * @throws ConstraintViolationException if the current user is not allowed to alter the node
213
+ * @throws RepositoryException if something else goes wrong
214
+ * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
215
+ */
216
+ updateContent(aNode: Node, aContent: string): void;
217
+
218
+ /**
219
+ * <p>
220
+ * Alters the content of a sv:page, sv:article or a sv:template.
221
+ * </p>
222
+ *
223
+ * <p>
224
+ * If an invalid node type is specified a <code>IllegalArgumentException</code> is thrown. The page content is specified using the
225
+ * content map containing keys corresponding to layout names (e.g. "mittenspalt") on the page and values containing the
226
+ * HTML used to generate a portlet structure in the layout. The provided content is converted to
227
+ * Sitevision text, table and image modules. It is also possible to specify that a horizontal or a vertical
228
+ * layout should be created.
229
+ * </p>
230
+ *
231
+ * <p>
232
+ * The names of the content map must correspond to layout names on the page.
233
+ * </p>
234
+ *
235
+ * <p>
236
+ * <strong>Note that the content of the specified layouts (i.e portlets and layouts) will be replaced, not appended.</strong>
237
+ * </p>
238
+ *
239
+ * <p>
240
+ * The current user must be authorized to alter the node or a <code>ConstraintViolationException</code> is thrown.
241
+ * </p>
242
+ *
243
+ * <p>
244
+ * If no node or no content is specified a <code>NullPointerException</code> is thrown.
245
+ * </p>
246
+ * @param aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page.
247
+ * @param aContent a map containing the HTML content. The keys must correspond to layout names on the node. May not be <code>null</code>
248
+ * @throws ConstraintViolationException if the current user is not allowed to alter the node
249
+ * @throws RepositoryException if something else goes wrong
250
+ * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
251
+ */
252
+ updateContent(aNode: Node, aContent: unknown): void;
253
+
254
+ /**
255
+ * Alters the content of a sv:page, sv:article or a sv:template with raw HTML (a HTML portlet is created).
256
+ *
257
+ * <p>
258
+ * <strong>Note!</strong> This method creates a single HTML portlet that contains all supplied content. This method
259
+ * is intended to be used as a <em>temporary solution</em> when the proper {@link #updateContent(javax.jcr.Node, java.util.Map)}
260
+ * and {@link #updateContent(javax.jcr.Node, String)} methods for some reason can't be used. Typically when converting badly formatted
261
+ * legacy CMS data into Sitevision content. I.e. this method enables creation of content that later on ought to be manually converted
262
+ * to proper Sitevision portlets.
263
+ * </p>
264
+ *
265
+ * <p>
266
+ * <strong>Note!</strong> Content is treated <em>as-is</em>, hence no internal links or references to local resources will be resolved
267
+ * as with the {@link #updateContent(javax.jcr.Node, java.util.Map)} and {@link #updateContent(javax.jcr.Node, String)} methods.
268
+ * The {@link #resolveToResourceURL(javax.jcr.Node, String)} can be used to manually try to resolve "old" resource url to a "new"
269
+ * Sitevision resource url.
270
+ * </p>
271
+ * @param aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page
272
+ * @param aContent the HTML content. May not be <code>null</code>
273
+ * @throws NullPointerException if aNode is null or if aContent is null
274
+ * @throws IllegalArgumentException if aNode is of invalid type
275
+ * @throws ConstraintViolationException if current user is not allowed to alter aNode
276
+ * @throws RepositoryException if something else goes wrong
277
+ * @since Sitevision 3.6
278
+ * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
279
+ */
280
+ updateContentWithRawHtml(aNode: Node, aContent: string): void;
281
+
282
+ /**
283
+ * Alters the content of a sv:page, sv:article or a sv:template with raw HTML (a HTML portlet is created).
284
+ *
285
+ * <p>
286
+ * <strong>Note!</strong> This method creates a single HTML portlet for each supplied content entry. This method
287
+ * is intended to be used as a <em>temporary solution</em> when the proper {@link #updateContent(javax.jcr.Node, java.util.Map)}
288
+ * and {@link #updateContent(javax.jcr.Node, String)} methods for some reason can't be used. Typically when converting badly formatted
289
+ * legacy CMS data into Sitevision content. I.e. this method enables creation of content that later on ought to be manually converted
290
+ * to proper Sitevision portlets.
291
+ * </p>
292
+ *
293
+ * <p>
294
+ * <strong>Note!</strong> Content is treated <em>as-is</em>, hence no internal links or references to local resources will be resolved
295
+ * as with the {@link #updateContent(javax.jcr.Node, java.util.Map)} and {@link #updateContent(javax.jcr.Node, String)} methods.
296
+ * The {@link #resolveToResourceURL(javax.jcr.Node, String)} can be used to manually try to resolve "old" resource url to a "new"
297
+ * Sitevision resource url.
298
+ * </p>
299
+ * @param aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page
300
+ * @param aContent a map containing the HTML content. The keys must correspond to layout names on the node. May not be <code>null</code>
301
+ * @throws NullPointerException if aNode is null or if aContent is null
302
+ * @throws IllegalArgumentException if aNode is of invalid type
303
+ * @throws ConstraintViolationException if current user is not allowed to alter aNode
304
+ * @throws RepositoryException if something else goes wrong
305
+ * @since Sitevision 3.6
306
+ * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
307
+ */
308
+ updateContentWithRawHtml(aNode: Node, aContent: unknown): void;
309
+
310
+ /**
311
+ * Appends the content to the existing node.
312
+ *
313
+ * <p>
314
+ * If an invalid node type is specified a <code>IllegalArgumentException</code> is thrown. The page content is specified as a
315
+ * HTML string used to generate a portlet structure in the <strong>first</strong> layout available. The provided
316
+ * content is converted to Sitevision text, table and image modules. It is also possible to specify that a horizontal
317
+ * or a vertical layout should be created.
318
+ * </p>
319
+ *
320
+ * <p>
321
+ * <strong>Note that the content (i.e portlets and layouts) of the first layout will be appended, not replaced.</strong>
322
+ * </p>
323
+ *
324
+ * <p>
325
+ * The current user must be authorized to alter the node or a <code>ConstraintViolationException</code> is thrown.
326
+ * </p>
327
+ *
328
+ * <p>
329
+ * If no node or no content is specified a <code>NullPointerException</code> is thrown.
330
+ * </p>
331
+ * @param aNode aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page.
332
+ * @param aContent the HTML content. May not be <code>null</code>
333
+ * @throws NullPointerException if aNode is null or if aContent is null
334
+ * @throws IllegalArgumentException if aNode is of invalid type
335
+ * @throws ConstraintViolationException if the current user is not allowed to alter the node
336
+ * @throws RepositoryException if something else goes wrong
337
+ * @since Sitevision 2022.08.1
338
+ * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
339
+ */
340
+ appendContent(aNode: Node, aContent: string): void;
341
+
342
+ /**
343
+ * <p>
344
+ * Append the content to the existing node.
345
+ * </p>
346
+ *
347
+ * <p>
348
+ * If an invalid node type is specified a <code>IllegalArgumentException</code> is thrown. The page content is specified using the
349
+ * content map containing keys corresponding to layout names (e.g. "mittenspalt") on the page and values containing the
350
+ * HTML used to generate a portlet structure in the layout. The provided content is converted to
351
+ * Sitevision text, table and image modules. It is also possible to specify that a horizontal or a vertical
352
+ * layout should be created.
353
+ * </p>
354
+ *
355
+ * <p>
356
+ * The names of the content map must correspond to layout names on the page.
357
+ * </p>
358
+ *
359
+ * <p>
360
+ * <strong>Note that the content of the specified layouts (i.e portlets and layouts) will be appended, not replaced.</strong>
361
+ * </p>
362
+ *
363
+ * <p>
364
+ * The current user must be authorized to alter the node or a <code>ConstraintViolationException</code> is thrown.
365
+ * </p>
366
+ *
367
+ * <p>
368
+ * If no node or no content is specified a <code>NullPointerException</code> is thrown.
369
+ * </p>
370
+ * @param aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page.
371
+ * @param aContent a map containing the HTML content. The keys must correspond to layout names on the node. May not be <code>null</code>
372
+ * @throws NullPointerException if aNode is null or if aContent is null
373
+ * @throws IllegalArgumentException if aNode is of invalid type
374
+ * @throws ConstraintViolationException if the current user is not allowed to alter the node
375
+ * @throws RepositoryException if something else goes wrong
376
+ * @since Sitevision 2022.08.1
377
+ * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
378
+ */
379
+ appendContent(aNode: Node, aContent: unknown): void;
380
+
381
+ /**
382
+ * Appends raw HTML (a HTML portlet is created) to the existing content of a node.
383
+ *
384
+ * <p>
385
+ * <strong>Note!</strong> This method creates a single HTML portlet that contains all supplied content and appends it to the existing content.
386
+ * This method is intended to be used as a <em>temporary solution</em> when the proper {@link #updateContent(javax.jcr.Node, java.util.Map)}
387
+ * and {@link #updateContent(javax.jcr.Node, String)} methods for some reason can't be used. Typically when converting badly formatted legacy
388
+ * CMS data into Sitevision content. I.e. this method enables creation of content that later on ought to be manually converted to proper
389
+ * Sitevision portlets.
390
+ * </p>
391
+ *
392
+ * <p>
393
+ * <strong>Note!</strong> Content is treated <em>as-is</em>, hence no internal links or references to local resources will be resolved
394
+ * as with the {@link #updateContent(javax.jcr.Node, java.util.Map)} and {@link #updateContent(javax.jcr.Node, String)} methods.
395
+ * The {@link #resolveToResourceURL(javax.jcr.Node, String)} can be used to manually try to resolve "old" resource url to a "new"
396
+ * Sitevision resource url.
397
+ * </p>
398
+ * @param aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page
399
+ * @param aContent the HTML content. May not be <code>null</code>
400
+ * @throws NullPointerException if aNode is null or if aContent is null
401
+ * @throws IllegalArgumentException if aNode is of invalid type
402
+ * @throws ConstraintViolationException if current user is not allowed to alter aNode
403
+ * @throws RepositoryException if something else goes wrong
404
+ * @since Sitevision 3.6
405
+ * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
406
+ */
407
+ appendContentWithRawHtml(aNode: Node, aContent: string): void;
408
+
409
+ /**
410
+ * Appends raw HTML (a HTML portlet is created) to the existing content of a node.
411
+ *
412
+ * <p>
413
+ * <strong>Note!</strong> This method creates a single HTML portlet that contains all supplied content and appends it to the existing content.
414
+ * This method is intended to be used as a <em>temporary solution</em> when the proper {@link #updateContent(javax.jcr.Node, java.util.Map)}
415
+ * and {@link #updateContent(javax.jcr.Node, String)} methods for some reason can't be used. Typically when converting badly formatted legacy
416
+ * CMS data into Sitevision content. I.e. this method enables creation of content that later on ought to be manually converted to proper
417
+ * Sitevision portlets.
418
+ * </p>
419
+ *
420
+ * <p>
421
+ * <strong>Note!</strong> Content is treated <em>as-is</em>, hence no internal links or references to local resources will be resolved
422
+ * as with the {@link #updateContent(javax.jcr.Node, java.util.Map)} and {@link #updateContent(javax.jcr.Node, String)} methods.
423
+ * The {@link #resolveToResourceURL(javax.jcr.Node, String)} can be used to manually try to resolve "old" resource url to a "new"
424
+ * Sitevision resource url.
425
+ * </p>
426
+ * @param aNode the node that will be altered, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page
427
+ * @param aContent a map containing the HTML content. The keys must correspond to layout names on the node. May not be <code>null</code>
428
+ * @throws NullPointerException if aNode is null or if aContent is null
429
+ * @throws IllegalArgumentException if aNode is of invalid type
430
+ * @throws ConstraintViolationException if current user is not allowed to alter aNode
431
+ * @throws RepositoryException if something else goes wrong
432
+ * @since Sitevision 3.6
433
+ * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveWritePermission(Node, Node)
434
+ */
435
+ appendContentWithRawHtml(aNode: Node, aContent: unknown): void;
436
+
437
+ /**
438
+ * Resolves an unresolved URL to a resource (potentially needed for all resource references in HTML content that later is
439
+ * updated or appended as raw HTML).
440
+ *
441
+ * <p>
442
+ * <strong>Note!</strong> HTML content is treated <em>as-is</em> when using the
443
+ * {@link #appendContentWithRawHtml(javax.jcr.Node, java.util.Map)}, {@link #appendContentWithRawHtml(javax.jcr.Node, String)},
444
+ * {@link #updateContentWithRawHtml(javax.jcr.Node, java.util.Map)} or {@link #updateContentWithRawHtml(javax.jcr.Node, String)}.
445
+ * Hence no internal links or references to local resources will be resolved as with the {@link #updateContent(javax.jcr.Node, java.util.Map)}
446
+ * and {@link #updateContent(javax.jcr.Node, String)} methods.
447
+ * This method can be used to manually try to resolve "old" resource url to a "new" Sitevision resource url.
448
+ * </p>
449
+ * @param aNode the node that <code>aUnresolvedURL</code> should be resolved for, typically a node with primary node type <code>sv:page</code> or <code>sv:article</code>. May not be <code>null</code> and may not be the site page
450
+ * @param aUnresolvedURL an unresolved URL
451
+ * @return the potentially resolved URL
452
+ * @throws NullPointerException if aNode is null or if aUnresolvedURL is null
453
+ * @throws IllegalArgumentException if aNode is of invalid type
454
+ * @since Sitevision 3.6
455
+ */
456
+ resolveToResourceURL(aNode: Node, aUnresolvedURL: string): string;
468
457
  }
469
458
 
459
+ declare namespace WebContentUtil {}
460
+
461
+ declare var webContentUtil: WebContentUtil;
462
+
470
463
  export default webContentUtil;