@sitevision/api 2.0.0-alpha.1 → 2.0.0-alpha.2

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 (332) hide show
  1. package/index.d.ts +8 -0
  2. package/package.json +1 -1
  3. package/server/AliasUtil/index.d.ts +13 -11
  4. package/server/ArchiveUtil/index.d.ts +45 -43
  5. package/server/ArraysInstance/index.d.ts +1667 -1808
  6. package/server/ArticleUtil/index.d.ts +294 -226
  7. package/server/AuthenticationUtil/index.d.ts +73 -85
  8. package/server/BookmarkUtil/index.d.ts +76 -81
  9. package/server/BuddyIconRenderer/index.d.ts +124 -132
  10. package/server/BuddyIconRenderer.BuddyIconSize/index.d.ts +41 -0
  11. package/server/BuddyIconRenderer.BuddyIconSize/index.js +25 -0
  12. package/server/ClientUtil/index.d.ts +11 -9
  13. package/server/CollaborationFactory/index.d.ts +37 -40
  14. package/server/CollaborationGroupFolderUtil/index.d.ts +30 -28
  15. package/server/CollaborationGroupState/index.d.ts +27 -0
  16. package/server/CollaborationGroupState/index.js +11 -0
  17. package/server/CollaborationGroupTemplateUtil/index.d.ts +48 -50
  18. package/server/CollaborationGroupType/index.d.ts +28 -0
  19. package/server/CollaborationGroupType/index.js +12 -0
  20. package/server/CollaborationGroupUtil/index.d.ts +86 -82
  21. package/server/CollectionsInstance/index.d.ts +642 -705
  22. package/server/ColorUtil/index.d.ts +36 -37
  23. package/server/CompoundAndFilterBuilder/index.d.ts +31 -29
  24. package/server/CompoundComparatorBuilder/index.d.ts +35 -33
  25. package/server/CompoundOrFilterBuilder/index.d.ts +31 -29
  26. package/server/ContentNodeUtil/index.d.ts +36 -34
  27. package/server/CurrencyFactory/index.d.ts +72 -70
  28. package/server/DateUtil/index.d.ts +132 -142
  29. package/server/DecorationUtil/index.d.ts +13 -11
  30. package/server/DeviceUtil/index.d.ts +21 -19
  31. package/server/DimensionMode/index.d.ts +17 -0
  32. package/server/DimensionMode/index.js +12 -0
  33. package/server/DirectoryUtil/index.d.ts +90 -88
  34. package/server/DocType/index.d.ts +30 -0
  35. package/server/DocType/index.js +14 -0
  36. package/server/DocTypeUtil/index.d.ts +129 -135
  37. package/server/EndecUtil/index.d.ts +330 -347
  38. package/server/ExtendedDismaxParserBuilder/index.d.ts +156 -170
  39. package/server/FileIconRenderer/index.d.ts +153 -172
  40. package/server/FileUtil/index.d.ts +274 -300
  41. package/server/FilterBuilder/index.d.ts +42 -40
  42. package/server/FolderUtil/index.d.ts +93 -94
  43. package/server/FontUtil/index.d.ts +36 -37
  44. package/server/FormatterBuilderFactory/index.d.ts +76 -84
  45. package/server/HighlightBuilder/index.d.ts +79 -86
  46. package/server/IconUtil/index.d.ts +27 -25
  47. package/server/ImageLinkRenderer/index.d.ts +34 -32
  48. package/server/ImageRenderer/index.d.ts +343 -379
  49. package/server/ImageUtil/index.d.ts +247 -265
  50. package/server/IndexUtil/index.d.ts +40 -37
  51. package/server/IndexUtil.IndexType/index.d.ts +29 -0
  52. package/server/IndexUtil.IndexType/index.js +13 -0
  53. package/server/IndexingUtil/index.d.ts +69 -47
  54. package/server/InstanceCreatorUtil/index.d.ts +421 -457
  55. package/server/InstanceTypeUtil/index.d.ts +168 -189
  56. package/server/JwtUtil/index.d.ts +131 -129
  57. package/server/LandingPageUtil/index.d.ts +84 -87
  58. package/server/LandingPageUtil/index.js +1 -0
  59. package/server/LinkPageUtil/index.d.ts +297 -251
  60. package/server/LinkRenderer/index.d.ts +651 -715
  61. package/server/LinkTargetBuilder/index.d.ts +69 -77
  62. package/server/LinkValueBuilder/index.d.ts +70 -77
  63. package/server/ListWrapper/index.d.ts +82 -91
  64. package/server/LocaleUtil/index.d.ts +382 -394
  65. package/server/LogUtil/index.d.ts +119 -128
  66. package/server/MailBuilder/index.d.ts +109 -124
  67. package/server/MailUtil/index.d.ts +58 -63
  68. package/server/MathInstance/index.d.ts +625 -657
  69. package/server/MessageDigesterFactory/index.d.ts +30 -28
  70. package/server/MetadataDefinitionUtil/index.d.ts +79 -83
  71. package/server/MetadataUtil/index.d.ts +322 -346
  72. package/server/MimeTypeUtil/index.d.ts +209 -215
  73. package/server/MonitorBuilder/index.d.ts +20 -20
  74. package/server/NodeComparatorUtil/index.d.ts +215 -225
  75. package/server/NodeFactoryUtil/index.d.ts +18 -16
  76. package/server/NodeFilterUtil/index.d.ts +652 -739
  77. package/server/NodeIteratorUtil/index.d.ts +214 -229
  78. package/server/NodeResolverUtil/index.d.ts +400 -406
  79. package/server/NodeTreeUtil/index.d.ts +214 -229
  80. package/server/NodeTypeUtil/index.d.ts +1432 -548
  81. package/server/OfflineVersionPropertyUtil/index.d.ts +8 -6
  82. package/server/OnlineVersionPropertyUtil/index.d.ts +8 -6
  83. package/server/OutputUtil/index.d.ts +385 -380
  84. package/server/PageUtil/index.d.ts +266 -188
  85. package/server/PermissionUtil/index.d.ts +393 -430
  86. package/server/PermissionUtil.Permission/index.d.ts +54 -0
  87. package/server/PermissionUtil.Permission/index.js +38 -0
  88. package/server/PortletContextUtil/index.d.ts +112 -107
  89. package/server/PortletUtil/index.d.ts +32 -22
  90. package/server/PrincipalUtil/index.d.ts +35 -33
  91. package/server/Properties/index.d.ts +69 -76
  92. package/server/PropertyUtil/index.d.ts +1422 -1464
  93. package/server/PublishingUtil/index.d.ts +248 -249
  94. package/server/QueryStringUtil/index.d.ts +404 -415
  95. package/server/RedirectUtil/index.d.ts +64 -68
  96. package/server/RelatedValueBuilder/index.d.ts +45 -43
  97. package/server/Requester/index.d.ts +125 -125
  98. package/server/ResourceLocatorUtil/index.d.ts +436 -476
  99. package/server/RestApi/index.d.ts +158 -138
  100. package/server/RestAppInvokerFactory/index.d.ts +28 -26
  101. package/server/RoleAssignmentBuilder/index.d.ts +39 -37
  102. package/server/RoleMatcherBuilder/index.d.ts +39 -37
  103. package/server/RoleUtil/index.d.ts +35 -37
  104. package/server/ScriptUtil/index.d.ts +458 -495
  105. package/server/SearchFactory/index.d.ts +90 -105
  106. package/server/SearchUtil/index.d.ts +75 -73
  107. package/server/SearcherBuilder/index.d.ts +117 -124
  108. package/server/Session/index.d.ts +261 -1103
  109. package/server/Session/index.js +1 -20
  110. package/server/SimpleUserUtil/index.d.ts +28 -29
  111. package/server/SiteCookieUtil/index.d.ts +152 -175
  112. package/server/SortBuilder/index.d.ts +27 -25
  113. package/server/SourceSetMode/index.d.ts +12 -0
  114. package/server/SourceSetMode/index.js +12 -0
  115. package/server/SpellCheckBuilder/index.d.ts +30 -30
  116. package/server/StandardParserBuilder/index.d.ts +36 -34
  117. package/server/StructureUtil/index.d.ts +85 -83
  118. package/server/SubscriberUtil/index.d.ts +60 -67
  119. package/server/SubscriptionUtil/index.d.ts +123 -130
  120. package/server/SystemUserUtil/index.d.ts +148 -146
  121. package/server/TagUtil/index.d.ts +115 -120
  122. package/server/TemplateUtil/index.d.ts +115 -120
  123. package/server/TemporaryFileNodeBuilder/index.d.ts +32 -30
  124. package/server/TemporaryNodeBuilder/index.d.ts +139 -177
  125. package/server/TextModuleRendererBuilder/index.d.ts +22 -20
  126. package/server/TimestampUtil/index.d.ts +103 -117
  127. package/server/TranslationUtil/index.d.ts +98 -104
  128. package/server/TrashcanUtil/index.d.ts +114 -117
  129. package/server/UserDataUtil/index.d.ts +110 -111
  130. package/server/UserFactory/index.d.ts +47 -54
  131. package/server/UserFieldRenderer/index.d.ts +120 -128
  132. package/server/UserIdentityUtil/index.d.ts +38 -36
  133. package/server/UserUtil/index.d.ts +32 -30
  134. package/server/Utils/index.d.ts +634 -723
  135. package/server/VelocityRenderer/index.d.ts +96 -94
  136. package/server/VersionUtil/index.d.ts +25 -9
  137. package/server/WebContentUtil/index.d.ts +277 -284
  138. package/server/WebResourceFactory/index.d.ts +41 -46
  139. package/server/XSLTUtil/index.d.ts +34 -32
  140. package/server/XmlParserUtil/index.d.ts +50 -48
  141. package/types/javax/jcr/Binary/index.d.ts +3 -21
  142. package/types/javax/jcr/Binary/index.js +0 -1
  143. package/types/javax/jcr/Credentials/index.d.ts +3 -1
  144. package/types/javax/jcr/ImportUUIDBehavior/index.d.ts +27 -1
  145. package/types/javax/jcr/Item/index.d.ts +6 -119
  146. package/types/javax/jcr/Item/index.js +0 -6
  147. package/types/javax/jcr/ItemVisitor/index.d.ts +5 -3
  148. package/types/javax/jcr/NamespaceRegistry/index.d.ts +69 -43
  149. package/types/javax/jcr/NamespaceRegistry/index.js +0 -2
  150. package/types/javax/jcr/Node/index.d.ts +37 -1506
  151. package/types/javax/jcr/Node/index.js +1 -34
  152. package/types/javax/jcr/NodeIterator/index.d.ts +5 -3
  153. package/types/javax/jcr/Property/index.d.ts +494 -494
  154. package/types/javax/jcr/Property/index.js +0 -5
  155. package/types/javax/jcr/PropertyIterator/index.d.ts +5 -3
  156. package/types/javax/jcr/RangeIterator/index.d.ts +2 -42
  157. package/types/javax/jcr/RangeIterator/index.js +1 -5
  158. package/types/javax/jcr/Repository/index.d.ts +465 -263
  159. package/types/javax/jcr/Repository/index.js +0 -4
  160. package/types/javax/jcr/RepositoryFactory/index.d.ts +4 -2
  161. package/types/javax/jcr/Value/index.d.ts +4 -31
  162. package/types/javax/jcr/Value/index.js +0 -2
  163. package/types/javax/jcr/ValueFactory/index.d.ts +6 -74
  164. package/types/javax/jcr/ValueFactory/index.js +1 -2
  165. package/types/javax/jcr/Workspace/index.d.ts +103 -577
  166. package/types/javax/jcr/Workspace/index.js +1 -12
  167. package/types/javax/jcr/lock/Lock/index.d.ts +4 -2
  168. package/types/javax/jcr/lock/LockManager/index.d.ts +4 -2
  169. package/types/javax/jcr/nodetype/ItemDefinition/index.d.ts +4 -105
  170. package/types/javax/jcr/nodetype/ItemDefinition/index.js +0 -5
  171. package/types/javax/jcr/nodetype/NodeDefinition/index.d.ts +5 -3
  172. package/types/javax/jcr/nodetype/NodeDefinitionTemplate/index.d.ts +4 -2
  173. package/types/javax/jcr/nodetype/NodeType/index.d.ts +262 -269
  174. package/types/javax/jcr/nodetype/NodeType/index.js +1 -12
  175. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.d.ts +5 -107
  176. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.js +1 -7
  177. package/types/javax/jcr/nodetype/NodeTypeIterator/index.d.ts +5 -3
  178. package/types/javax/jcr/nodetype/NodeTypeManager/index.d.ts +9 -130
  179. package/types/javax/jcr/nodetype/NodeTypeManager/index.js +1 -8
  180. package/types/javax/jcr/nodetype/NodeTypeTemplate/index.d.ts +4 -2
  181. package/types/javax/jcr/nodetype/PropertyDefinition/index.d.ts +5 -272
  182. package/types/javax/jcr/nodetype/PropertyDefinition/index.js +1 -7
  183. package/types/javax/jcr/nodetype/PropertyDefinitionTemplate/index.d.ts +5 -3
  184. package/types/javax/jcr/observation/Event/index.d.ts +85 -42
  185. package/types/javax/jcr/observation/EventIterator/index.d.ts +5 -3
  186. package/types/javax/jcr/observation/EventJournal/index.d.ts +4 -2
  187. package/types/javax/jcr/observation/EventListener/index.d.ts +4 -2
  188. package/types/javax/jcr/observation/EventListenerIterator/index.d.ts +5 -3
  189. package/types/javax/jcr/observation/ObservationManager/index.d.ts +6 -4
  190. package/types/javax/jcr/query/Query/index.d.ts +35 -12
  191. package/types/javax/jcr/query/QueryManager/index.d.ts +6 -4
  192. package/types/javax/jcr/query/QueryResult/index.d.ts +5 -3
  193. package/types/javax/jcr/query/Row/index.d.ts +5 -3
  194. package/types/javax/jcr/query/RowIterator/index.d.ts +5 -3
  195. package/types/javax/jcr/query/qom/And/index.d.ts +4 -2
  196. package/types/javax/jcr/query/qom/BindVariableValue/index.d.ts +4 -2
  197. package/types/javax/jcr/query/qom/ChildNode/index.d.ts +4 -2
  198. package/types/javax/jcr/query/qom/ChildNodeJoinCondition/index.d.ts +4 -2
  199. package/types/javax/jcr/query/qom/Column/index.d.ts +3 -1
  200. package/types/javax/jcr/query/qom/Comparison/index.d.ts +6 -4
  201. package/types/javax/jcr/query/qom/Constraint/index.d.ts +3 -1
  202. package/types/javax/jcr/query/qom/DescendantNode/index.d.ts +4 -2
  203. package/types/javax/jcr/query/qom/DescendantNodeJoinCondition/index.d.ts +4 -2
  204. package/types/javax/jcr/query/qom/DynamicOperand/index.d.ts +4 -2
  205. package/types/javax/jcr/query/qom/EquiJoinCondition/index.d.ts +4 -2
  206. package/types/javax/jcr/query/qom/FullTextSearch/index.d.ts +5 -3
  207. package/types/javax/jcr/query/qom/FullTextSearchScore/index.d.ts +4 -2
  208. package/types/javax/jcr/query/qom/Join/index.d.ts +5 -3
  209. package/types/javax/jcr/query/qom/JoinCondition/index.d.ts +3 -1
  210. package/types/javax/jcr/query/qom/Length/index.d.ts +5 -3
  211. package/types/javax/jcr/query/qom/Literal/index.d.ts +5 -3
  212. package/types/javax/jcr/query/qom/LowerCase/index.d.ts +4 -2
  213. package/types/javax/jcr/query/qom/NodeLocalName/index.d.ts +4 -2
  214. package/types/javax/jcr/query/qom/NodeName/index.d.ts +4 -2
  215. package/types/javax/jcr/query/qom/Not/index.d.ts +4 -2
  216. package/types/javax/jcr/query/qom/Operand/index.d.ts +3 -1
  217. package/types/javax/jcr/query/qom/Or/index.d.ts +4 -2
  218. package/types/javax/jcr/query/qom/Ordering/index.d.ts +4 -2
  219. package/types/javax/jcr/query/qom/PropertyExistence/index.d.ts +4 -2
  220. package/types/javax/jcr/query/qom/PropertyValue/index.d.ts +4 -2
  221. package/types/javax/jcr/query/qom/QueryObjectModel/index.d.ts +8 -6
  222. package/types/javax/jcr/query/qom/QueryObjectModelConstants/index.d.ts +76 -2
  223. package/types/javax/jcr/query/qom/QueryObjectModelFactory/index.d.ts +37 -35
  224. package/types/javax/jcr/query/qom/SameNode/index.d.ts +4 -2
  225. package/types/javax/jcr/query/qom/SameNodeJoinCondition/index.d.ts +4 -2
  226. package/types/javax/jcr/query/qom/Selector/index.d.ts +4 -2
  227. package/types/javax/jcr/query/qom/Source/index.d.ts +3 -1
  228. package/types/javax/jcr/query/qom/StaticOperand/index.d.ts +4 -2
  229. package/types/javax/jcr/query/qom/UpperCase/index.d.ts +4 -2
  230. package/types/javax/jcr/retention/Hold/index.d.ts +3 -1
  231. package/types/javax/jcr/retention/RetentionManager/index.d.ts +5 -3
  232. package/types/javax/jcr/retention/RetentionPolicy/index.d.ts +3 -1
  233. package/types/javax/jcr/security/AccessControlEntry/index.d.ts +4 -2
  234. package/types/javax/jcr/security/AccessControlList/index.d.ts +6 -4
  235. package/types/javax/jcr/security/AccessControlManager/index.d.ts +6 -4
  236. package/types/javax/jcr/security/AccessControlPolicy/index.d.ts +3 -1
  237. package/types/javax/jcr/security/AccessControlPolicyIterator/index.d.ts +5 -3
  238. package/types/javax/jcr/security/NamedAccessControlPolicy/index.d.ts +4 -2
  239. package/types/javax/jcr/security/Privilege/index.d.ts +130 -44
  240. package/types/javax/jcr/version/Version/index.d.ts +5 -3
  241. package/types/javax/jcr/version/VersionHistory/index.d.ts +7 -5
  242. package/types/javax/jcr/version/VersionIterator/index.d.ts +5 -3
  243. package/types/javax/jcr/version/VersionManager/index.d.ts +7 -5
  244. package/types/senselogic/sitevision/api/base/Builder/index.d.ts +3 -1
  245. package/types/senselogic/sitevision/api/base/Filter/index.d.ts +3 -1
  246. package/types/senselogic/sitevision/api/base/FilterSplit/index.d.ts +4 -2
  247. package/types/senselogic/sitevision/api/base/Loadable/index.d.ts +3 -1
  248. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.d.ts +9 -0
  249. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.js +11 -0
  250. package/types/senselogic/sitevision/api/base/Resolver/index.d.ts +3 -1
  251. package/types/senselogic/sitevision/api/base/Wrapper/index.d.ts +3 -1
  252. package/types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts +13 -7
  253. package/types/senselogic/sitevision/api/format/NumericFormatter/index.d.ts +3 -1
  254. package/types/senselogic/sitevision/api/format/NumericFormatterBuilder/index.d.ts +5 -3
  255. package/types/senselogic/sitevision/api/i18n/Currency/index.d.ts +3 -1
  256. package/types/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts +5 -3
  257. package/types/senselogic/sitevision/api/link/CustomLinkRenderData/index.d.ts +3 -1
  258. package/types/senselogic/sitevision/api/mail/Mail/index.d.ts +3 -1
  259. package/types/senselogic/sitevision/api/message/MessageTextLinker/index.d.ts +3 -1
  260. package/types/senselogic/sitevision/api/metadata/value/LinkValue/index.d.ts +3 -1
  261. package/types/senselogic/sitevision/api/metadata/value/RelatedValue/index.d.ts +3 -1
  262. package/types/senselogic/sitevision/api/property/VersionedPropertyUtil/index.d.ts +4 -2
  263. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.d.ts +51 -0
  264. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.js +12 -0
  265. package/types/senselogic/sitevision/api/render/ImageScaler/index.d.ts +4 -2
  266. package/types/senselogic/sitevision/api/render/TextModuleRenderer/index.d.ts +4 -2
  267. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess/index.d.ts +3 -1
  268. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.d.ts +85 -0
  269. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.js +21 -0
  270. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.d.ts +31 -0
  271. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.js +12 -0
  272. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.d.ts +31 -0
  273. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.js +12 -0
  274. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.d.ts +67 -0
  275. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.js +18 -0
  276. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.d.ts +25 -0
  277. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.js +11 -0
  278. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.d.ts +19 -0
  279. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.js +10 -0
  280. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts +1243 -0
  281. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js +189 -0
  282. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.d.ts +31 -0
  283. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.js +12 -0
  284. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.d.ts +91 -0
  285. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.js +22 -0
  286. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.d.ts +27 -0
  287. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.js +11 -0
  288. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.d.ts +19 -0
  289. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.js +10 -0
  290. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.d.ts +19 -0
  291. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.js +10 -0
  292. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.d.ts +25 -0
  293. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.js +11 -0
  294. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.d.ts +37 -0
  295. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.js +13 -0
  296. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.d.ts +25 -0
  297. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.js +11 -0
  298. package/types/senselogic/sitevision/api/render/velocity/VelocityContext/index.d.ts +3 -1
  299. package/types/senselogic/sitevision/api/render/velocity/VelocityEvaluator/index.d.ts +3 -1
  300. package/types/senselogic/sitevision/api/script/RequesterChainable/index.d.ts +4 -2
  301. package/types/senselogic/sitevision/api/script/app/RestAppInvoker/index.d.ts +3 -1
  302. package/types/senselogic/sitevision/api/script/factory/TypedArgument/index.d.ts +3 -1
  303. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingCollection/index.d.ts +3 -1
  304. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingIterator/index.d.ts +4 -2
  305. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts +24 -2
  306. package/types/senselogic/sitevision/api/search/SearchFieldUtil/index.d.ts +3 -1
  307. package/types/senselogic/sitevision/api/search/SearchHighlighter/index.d.ts +4 -2
  308. package/types/senselogic/sitevision/api/search/SearchHit/index.d.ts +19 -3
  309. package/types/senselogic/sitevision/api/search/SearchResult/index.d.ts +31 -7
  310. package/types/senselogic/sitevision/api/search/facet/SearchFacetField/index.d.ts +3 -1
  311. package/types/senselogic/sitevision/api/search/facet/SearchFacetValue/index.d.ts +3 -1
  312. package/types/senselogic/sitevision/api/search/searcher/Searcher/index.d.ts +4 -2
  313. package/types/senselogic/sitevision/api/search/searcher/component/Filter/index.d.ts +3 -1
  314. package/types/senselogic/sitevision/api/search/searcher/component/Highlight/index.d.ts +3 -1
  315. package/types/senselogic/sitevision/api/search/searcher/component/Monitor/index.d.ts +3 -1
  316. package/types/senselogic/sitevision/api/search/searcher/component/Parser/index.d.ts +3 -1
  317. package/types/senselogic/sitevision/api/search/searcher/component/Sort/index.d.ts +3 -1
  318. package/types/senselogic/sitevision/api/search/searcher/component/SpellCheck/index.d.ts +3 -1
  319. package/types/senselogic/sitevision/api/search/sort/CustomSort/index.d.ts +3 -1
  320. package/types/senselogic/sitevision/api/search/suggestion/SearchSuggestion/index.d.ts +3 -1
  321. package/types/senselogic/sitevision/api/security/DirectoryAttributes/index.d.ts +3 -1
  322. package/types/senselogic/sitevision/api/security/MessageDigester/index.d.ts +3 -1
  323. package/types/senselogic/sitevision/api/security/RoleAssignment/index.d.ts +4 -2
  324. package/types/senselogic/sitevision/api/security/RoleMatcher/index.d.ts +4 -2
  325. package/types/senselogic/sitevision/api/security/SecretStore/index.d.ts +3 -1
  326. package/types/senselogic/sitevision/api/security/UserUtil/index.d.ts +4 -2
  327. package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts +35 -3
  328. package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilterChain/index.d.ts +3 -1
  329. package/types/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts +5 -3
  330. package/types/senselogic/sitevision/api/webresource/LinkTarget/index.d.ts +3 -1
  331. package/types/senselogic/sitevision/api/xml/XmlElement/index.d.ts +3 -1
  332. package/types/senselogic/sitevision/api/xml/XmlElementHandler/index.d.ts +4 -2
@@ -1,166 +1,168 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
1
+ import type Node from "../../types/javax/jcr/Node";
2
2
 
3
3
  /**
4
- * Checks if current user is anonymous (not authenticated).
4
+ * System user utility interface.
5
5
  *
6
6
  * <p>
7
- * An <em>Anonymous user</em> is not authenticated and can only access public resources.
7
+ * This interface handles nodes with primary node type <code>sv:systemUser</code>, i.e. the
8
+ * <em>Anonymous</em>, <em>System</em>, <em>Indexer</em> and <em>Extractor</em> user.
8
9
  * </p>
9
10
  *
10
11
  * <p>
11
- * <em>Note! This method does NOT produce a reliable result if called during the authentication process
12
- * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
13
- * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
14
- * </p>
15
- * @return <code>true</code> if current user is Anonymous (i.e. not authenticated), <code>false</code> otherwise
16
- */
17
- export function isAnonymous(): boolean;
18
-
19
- /**
20
- * Checks if a user node is anonymous (not authenticated).
21
- *
22
- * <p>
23
- * An <em>Anonymous user</em> is not authenticated and can only access public resources.
12
+ * An instance of the Sitevision class implementing this interface can be obtained via
13
+ * {@link senselogic.sitevision.api.user.UserFactory#getSystemUserUtil()}.
14
+ * See {@link senselogic.sitevision.api.user.UserFactory} for how to obtain an instance of the <code>UserFactory</code> interface.
24
15
  * </p>
25
- * @param aUserNode a user node
26
- * @return <code>true</code> if <code>aUserNode</code> is anonymous (i.e. not authenticated), <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
16
+ * @author Magnus Lövgren
17
+ * @since Sitevision 3.6
27
18
  */
28
- export function isAnonymous(aUserNode: Node): boolean;
19
+ export interface SystemUserUtil {
20
+ /**
21
+ * Checks if current user is anonymous (not authenticated).
22
+ *
23
+ * <p>
24
+ * An <em>Anonymous user</em> is not authenticated and can only access public resources.
25
+ * </p>
26
+ *
27
+ * <p>
28
+ * <em>Note! This method does NOT produce a reliable result if called during the authentication process
29
+ * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
30
+ * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
31
+ * </p>
32
+ * @return <code>true</code> if current user is Anonymous (i.e. not authenticated), <code>false</code> otherwise
33
+ */
34
+ isAnonymous(): boolean;
29
35
 
30
- /**
31
- * Checks if current user is the Sitevision System user.
32
- *
33
- * <p>
34
- * The <em>System user</em> has all permissions and full access to all Sitevision portlets and functionality allowed
35
- * by the current license(-s).
36
- * </p>
37
- *
38
- * <p>
39
- * <em>Note! This method does NOT produce a reliable result if called during the authentication process
40
- * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
41
- * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
42
- * </p>
43
- * @return <code>true</code> if current user is the Sitevision System user, <code>false</code> otherwise
44
- */
45
- export function isSystem(): boolean;
36
+ /**
37
+ * Checks if a user node is anonymous (not authenticated).
38
+ *
39
+ * <p>
40
+ * An <em>Anonymous user</em> is not authenticated and can only access public resources.
41
+ * </p>
42
+ * @param aUserNode a user node
43
+ * @return <code>true</code> if <code>aUserNode</code> is anonymous (i.e. not authenticated), <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
44
+ */
45
+ isAnonymous(aUserNode: Node): boolean;
46
46
 
47
- /**
48
- * Checks if a user node is the Sitevision System user.
49
- *
50
- * <p>
51
- * The <em>System user</em> has all permissions and full access to all Sitevision portlets and functionality allowed
52
- * by the current license(-s).
53
- * </p>
54
- * @param aUserNode a user node
55
- * @return <code>true</code> if <code>aUserNode</code> is the Sitevision System user, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
56
- */
57
- export function isSystem(aUserNode: Node): boolean;
47
+ /**
48
+ * Checks if current user is the Sitevision System user.
49
+ *
50
+ * <p>
51
+ * The <em>System user</em> has all permissions and full access to all Sitevision portlets and functionality allowed
52
+ * by the current license(-s).
53
+ * </p>
54
+ *
55
+ * <p>
56
+ * <em>Note! This method does NOT produce a reliable result if called during the authentication process
57
+ * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
58
+ * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
59
+ * </p>
60
+ * @return <code>true</code> if current user is the Sitevision System user, <code>false</code> otherwise
61
+ */
62
+ isSystem(): boolean;
58
63
 
59
- /**
60
- * Checks if current user is the Sitevision Indexer.
61
- *
62
- * <p>
63
- * The <em>Indexer user</em> has read permission on all resources and visits/renders pages in order to collect
64
- * metadata/content and such that should be indexed by the Sitevision search engine.
65
- * </p>
66
- *
67
- * <p>
68
- * <em>Note! This method does NOT produce a reliable result if called during the authentication process
69
- * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
70
- * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
71
- * </p>
72
- * @return <code>true</code> if current user is the Sitevision Indexer, <code>false</code> otherwise
73
- */
74
- export function isIndexer(): boolean;
64
+ /**
65
+ * Checks if a user node is the Sitevision System user.
66
+ *
67
+ * <p>
68
+ * The <em>System user</em> has all permissions and full access to all Sitevision portlets and functionality allowed
69
+ * by the current license(-s).
70
+ * </p>
71
+ * @param aUserNode a user node
72
+ * @return <code>true</code> if <code>aUserNode</code> is the Sitevision System user, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
73
+ */
74
+ isSystem(aUserNode: Node): boolean;
75
75
 
76
- /**
77
- * Checks if a user node is the Sitevision Indexer.
78
- *
79
- * <p>
80
- * The <em>Indexer user</em> has read permission on all resources and visits/renders pages in order to collect
81
- * metadata/content and such that should be indexed by the Sitevision search engine.
82
- * </p>
83
- * @param aUserNode a user node
84
- * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Indexer, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
85
- */
86
- export function isIndexer(aUserNode: Node): boolean;
76
+ /**
77
+ * Checks if current user is the Sitevision Indexer.
78
+ *
79
+ * <p>
80
+ * The <em>Indexer user</em> has read permission on all resources and visits/renders pages in order to collect
81
+ * metadata/content and such that should be indexed by the Sitevision search engine.
82
+ * </p>
83
+ *
84
+ * <p>
85
+ * <em>Note! This method does NOT produce a reliable result if called during the authentication process
86
+ * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
87
+ * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
88
+ * </p>
89
+ * @return <code>true</code> if current user is the Sitevision Indexer, <code>false</code> otherwise
90
+ */
91
+ isIndexer(): boolean;
87
92
 
88
- /**
89
- * Checks if current user is the Sitevision Validator.
90
- *
91
- * <p>
92
- * The <em>Validator user</em> has read permission on all resources and visits/renders pages in order to validate them.
93
- * </p>
94
- *
95
- * <p>
96
- * <em>Note! This method does NOT produce a reliable result if called during the authentication process
97
- * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
98
- * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
99
- * </p>
100
- * @return <code>true</code> if current user is the Sitevision Validator, <code>false</code> otherwise
101
- * @since Sitevision 4.2.3
102
- */
103
- export function isValidator(): boolean;
93
+ /**
94
+ * Checks if a user node is the Sitevision Indexer.
95
+ *
96
+ * <p>
97
+ * The <em>Indexer user</em> has read permission on all resources and visits/renders pages in order to collect
98
+ * metadata/content and such that should be indexed by the Sitevision search engine.
99
+ * </p>
100
+ * @param aUserNode a user node
101
+ * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Indexer, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
102
+ */
103
+ isIndexer(aUserNode: Node): boolean;
104
104
 
105
- /**
106
- * Checks if a user node is the Sitevision Validator.
107
- *
108
- * <p>
109
- * The <em>Validator user</em> has read permission on all resources and visits/renders pages in order to validate them.
110
- * </p>
111
- * @param aUserNode a user node
112
- * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Validator, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
113
- * @since Sitevision 4.2.3
114
- */
115
- export function isValidator(aUserNode: Node): boolean;
105
+ /**
106
+ * Checks if current user is the Sitevision Validator.
107
+ *
108
+ * <p>
109
+ * The <em>Validator user</em> has read permission on all resources and visits/renders pages in order to validate them.
110
+ * </p>
111
+ *
112
+ * <p>
113
+ * <em>Note! This method does NOT produce a reliable result if called during the authentication process
114
+ * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
115
+ * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
116
+ * </p>
117
+ * @return <code>true</code> if current user is the Sitevision Validator, <code>false</code> otherwise
118
+ * @since Sitevision 4.2.3
119
+ */
120
+ isValidator(): boolean;
116
121
 
117
- /**
118
- * Checks if current user is the Sitevision Extractor.
119
- *
120
- * <p>
121
- * The <em>Extractor user</em> has read permission on all resources and renders pages in order to store their
122
- * content as static html pages.
123
- * </p>
124
- *
125
- * <p>
126
- * <em>Note! This method does NOT produce a reliable result if called during the authentication process
127
- * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
128
- * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
129
- * </p>
130
- * @return <code>true</code> if current user is the Sitevision Extractor, <code>false</code> otherwise
131
- */
132
- export function isExtractor(): boolean;
122
+ /**
123
+ * Checks if a user node is the Sitevision Validator.
124
+ *
125
+ * <p>
126
+ * The <em>Validator user</em> has read permission on all resources and visits/renders pages in order to validate them.
127
+ * </p>
128
+ * @param aUserNode a user node
129
+ * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Validator, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
130
+ * @since Sitevision 4.2.3
131
+ */
132
+ isValidator(aUserNode: Node): boolean;
133
133
 
134
- /**
135
- * Checks if a user node is the Sitevision Extractor.
136
- *
137
- * <p>
138
- * The <em>Extractor user</em> has read permission on all resources and renders pages in order to store their
139
- * content as static html pages.
140
- * </p>
141
- * @param aUserNode a user node
142
- * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Extractor, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
143
- */
144
- export function isExtractor(aUserNode: Node): boolean;
134
+ /**
135
+ * Checks if current user is the Sitevision Extractor.
136
+ *
137
+ * <p>
138
+ * The <em>Extractor user</em> has read permission on all resources and renders pages in order to store their
139
+ * content as static html pages.
140
+ * </p>
141
+ *
142
+ * <p>
143
+ * <em>Note! This method does NOT produce a reliable result if called during the authentication process
144
+ * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
145
+ * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
146
+ * </p>
147
+ * @return <code>true</code> if current user is the Sitevision Extractor, <code>false</code> otherwise
148
+ */
149
+ isExtractor(): boolean;
145
150
 
146
- /**
147
- * System user utility interface.
148
- *
149
- * <p>
150
- * This interface handles nodes with primary node type <code>sv:systemUser</code>, i.e. the
151
- * <em>Anonymous</em>, <em>System</em>, <em>Indexer</em> and <em>Extractor</em> user.
152
- * </p>
153
- *
154
- * <p>
155
- * An instance of the Sitevision class implementing this interface can be obtained via
156
- * {@link senselogic.sitevision.api.user.UserFactory#getSystemUserUtil()}.
157
- * See {@link senselogic.sitevision.api.user.UserFactory} for how to obtain an instance of the <code>UserFactory</code> interface.
158
- * </p>
159
- * @author Magnus Lövgren
160
- * @since Sitevision 3.6
161
- */
162
- declare namespace systemUserUtil {
163
- export { isAnonymous, isSystem, isIndexer, isValidator, isExtractor };
151
+ /**
152
+ * Checks if a user node is the Sitevision Extractor.
153
+ *
154
+ * <p>
155
+ * The <em>Extractor user</em> has read permission on all resources and renders pages in order to store their
156
+ * content as static html pages.
157
+ * </p>
158
+ * @param aUserNode a user node
159
+ * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Extractor, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
160
+ */
161
+ isExtractor(aUserNode: Node): boolean;
164
162
  }
165
163
 
166
- export default systemUserUtil;
164
+ declare namespace SystemUserUtil {}
165
+
166
+ declare var systemUserUtil: SystemUserUtil;
167
+
168
+ export = systemUserUtil;
@@ -1,113 +1,4 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
2
-
3
- /**
4
- * Gets a sv:tag Node by name.
5
- * @param aTagName the tag name. Must not be null, whitespace-only or shebang-only
6
- * @return a sv:tag or null if no tag with aTagName could be fond
7
- * @throws IllegalArgumentException if aTagName is invalid
8
- */
9
- export function getTagByName(aTagName: string): Node;
10
-
11
- /**
12
- * Gets or creates a sv:tag Node by name.
13
- *
14
- * <p>
15
- * <strong>Permission note:</strong> Current user must be authenticated (i.e. non-anonymous).
16
- * </p>
17
- * @param aTagName the tag name. Must not be null, whitespace-only or shebang-only
18
- * @return the sv:tag for aTagName
19
- * @throws IllegalArgumentException if aTagName is invalid
20
- * @throws RepositoryException if current user is anonymous or the sv:tag could not be found or created
21
- */
22
- export function getOrCreateTagByName(aTagName: string): Node;
23
-
24
- /**
25
- * Adds a sv:tag to a Node.
26
- *
27
- * <p>
28
- * <strong>Permission note:</strong> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE}
29
- * permission on the taggable Node that is mutated.
30
- * </p>
31
- * <p>
32
- * <strong>Versioning note:</strong> Mutation of the taggable Node is always executed in the
33
- * {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE} version.
34
- * In other words - if you mutate the sv:tag entries on a sv:page, you must also
35
- * {@link senselogic.sitevision.api.versioning.PublishingUtil publish} the sv:page for changes to affect the
36
- * {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION ONLINE/published} version.
37
- * </p>
38
- * @param aTaggableNode a taggable node (sv:page, sv:article, sv:sitePage, sv:collaborationGroupPage, sv:file or sv:image)
39
- * @param aTagNode a sv:tag
40
- * @throws IllegalArgumentException if aTaggableNode or aTagNode is null or an unsupported type
41
- * @throws RepositoryException if mutation is not allowed or fails
42
- */
43
- export function addTag(aTaggableNode: Node, aTagNode: Node): void;
44
-
45
- /**
46
- * Adds multiple sv:tag to a Node.
47
- *
48
- * <p>
49
- * <strong>Permission note:</strong> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE}
50
- * permission on the taggable Node that is mutated.
51
- * </p>
52
- * <p>
53
- * <strong>Versioning note:</strong> Mutation of the taggable Node is always executed in the
54
- * {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE} version.
55
- * In other words - if you mutate the sv:tag entries on a sv:page, you must also
56
- * {@link senselogic.sitevision.api.versioning.PublishingUtil publish} the sv:page for changes to affect the
57
- * {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION ONLINE/published} version.
58
- * </p>
59
- * <p>
60
- * Server-side Javascript example:
61
- * </p>
62
- * <pre><code> const tagUtil = require('TagUtil');
63
- * ...
64
- * let tags = [];
65
- * tags.push(tagUtil.getOrCreateTagByName('mytag'));
66
- * tags.push(tagUtil.getOrCreateTagByName('myothertag'));
67
- *
68
- * tagUtil.addTags(pageNode, tags);</code></pre>
69
- * @param aTaggableNode a taggable node (sv:page, sv:article, sv:sitePage, sv:collaborationGroupPage, sv:file or sv:image)
70
- * @param aTagNodes a var-args array of sv:tag nodes
71
- * @throws IllegalArgumentException if aTaggableNode is null or an unsupported type, or if or aTagNodes is null, empty or contains an unsupported type
72
- * @throws RepositoryException if mutation is not allowed or fails
73
- */
74
- export function addTags(aTaggableNode: Node, aTagNodes: Node): void;
75
-
76
- /**
77
- * Removes a sv:tag from a Node.
78
- *
79
- * <p>
80
- * <strong>Permission note:</strong> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE}
81
- * permission on the taggable Node that is mutated.
82
- * </p>
83
- * <p>
84
- * <strong>Versioning note:</strong> Mutation of the taggable Node is always executed in the
85
- * {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE} version.
86
- * In other words - if you mutate the sv:tag entries on a sv:page, you must also
87
- * {@link senselogic.sitevision.api.versioning.PublishingUtil publish} the sv:page for changes to affect the
88
- * {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION ONLINE/published} version.
89
- * </p>
90
- * @param aTaggableNode a taggable node (sv:page, sv:article, sv:sitePage, sv:collaborationGroupPage, sv:file or sv:image)
91
- * @param aTagNode a sv:tag
92
- * @return true if aTagNode was removed from aTaggableNode, false otherwise
93
- * @throws IllegalArgumentException if aTaggableNode or aTagNode is null or an unsupported type
94
- * @throws RepositoryException if mutation is not allowed or fails
95
- */
96
- export function removeTag(aTaggableNode: Node, aTagNode: Node): boolean;
97
-
98
- /**
99
- * Gets all sv:tag's for a Node.
100
- *
101
- * <p>
102
- * <em>Version note! This method executes in current version, i.e. it will return the list of sv:tag's
103
- * in current version ({@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE_VERSION} or
104
- * {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION ONLINE_VERSION}).</em>
105
- * </p>
106
- * @param aTaggableNode a taggable node (sv:page, sv:article, sv:sitePage, sv:collaborationGroupPage, sv:file or sv:image)
107
- * @return a list of sv:tag nodes for aTaggableNode
108
- * @throws IllegalArgumentException if aTaggableNode is null or an unsupported type
109
- */
110
- export function getTags(aTaggableNode: Node): unknown;
1
+ import type Node from "../../types/javax/jcr/Node";
111
2
 
112
3
  /**
113
4
  * Tag utility interface for tree nodes.
@@ -123,15 +14,119 @@ export function getTags(aTaggableNode: Node): unknown;
123
14
  * @author Karl Eklöf
124
15
  * @since Sitevision 9.1
125
16
  */
126
- declare namespace tagUtil {
127
- export {
128
- getTagByName,
129
- getOrCreateTagByName,
130
- addTag,
131
- addTags,
132
- removeTag,
133
- getTags,
134
- };
17
+ export interface TagUtil {
18
+ /**
19
+ * Gets a sv:tag Node by name.
20
+ * @param aTagName the tag name. Must not be null, whitespace-only or shebang-only
21
+ * @return a sv:tag or null if no tag with aTagName could be fond
22
+ * @throws IllegalArgumentException if aTagName is invalid
23
+ */
24
+ getTagByName(aTagName: string): Node;
25
+
26
+ /**
27
+ * Gets or creates a sv:tag Node by name.
28
+ *
29
+ * <p>
30
+ * <strong>Permission note:</strong> Current user must be authenticated (i.e. non-anonymous).
31
+ * </p>
32
+ * @param aTagName the tag name. Must not be null, whitespace-only or shebang-only
33
+ * @return the sv:tag for aTagName
34
+ * @throws IllegalArgumentException if aTagName is invalid
35
+ * @throws RepositoryException if current user is anonymous or the sv:tag could not be found or created
36
+ */
37
+ getOrCreateTagByName(aTagName: string): Node;
38
+
39
+ /**
40
+ * Adds a sv:tag to a Node.
41
+ *
42
+ * <p>
43
+ * <strong>Permission note:</strong> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE}
44
+ * permission on the taggable Node that is mutated.
45
+ * </p>
46
+ * <p>
47
+ * <strong>Versioning note:</strong> Mutation of the taggable Node is always executed in the
48
+ * {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE} version.
49
+ * In other words - if you mutate the sv:tag entries on a sv:page, you must also
50
+ * {@link senselogic.sitevision.api.versioning.PublishingUtil publish} the sv:page for changes to affect the
51
+ * {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION ONLINE/published} version.
52
+ * </p>
53
+ * @param aTaggableNode a taggable node (sv:page, sv:article, sv:sitePage, sv:collaborationGroupPage, sv:file or sv:image)
54
+ * @param aTagNode a sv:tag
55
+ * @throws IllegalArgumentException if aTaggableNode or aTagNode is null or an unsupported type
56
+ * @throws RepositoryException if mutation is not allowed or fails
57
+ */
58
+ addTag(aTaggableNode: Node, aTagNode: Node): void;
59
+
60
+ /**
61
+ * Adds multiple sv:tag to a Node.
62
+ *
63
+ * <p>
64
+ * <strong>Permission note:</strong> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE}
65
+ * permission on the taggable Node that is mutated.
66
+ * </p>
67
+ * <p>
68
+ * <strong>Versioning note:</strong> Mutation of the taggable Node is always executed in the
69
+ * {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE} version.
70
+ * In other words - if you mutate the sv:tag entries on a sv:page, you must also
71
+ * {@link senselogic.sitevision.api.versioning.PublishingUtil publish} the sv:page for changes to affect the
72
+ * {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION ONLINE/published} version.
73
+ * </p>
74
+ * <p>
75
+ * Server-side Javascript example:
76
+ * </p>
77
+ * <pre><code> const tagUtil = require('TagUtil');
78
+ * ...
79
+ * let tags = [];
80
+ * tags.push(tagUtil.getOrCreateTagByName('mytag'));
81
+ * tags.push(tagUtil.getOrCreateTagByName('myothertag'));
82
+ *
83
+ * tagUtil.addTags(pageNode, tags);</code></pre>
84
+ * @param aTaggableNode a taggable node (sv:page, sv:article, sv:sitePage, sv:collaborationGroupPage, sv:file or sv:image)
85
+ * @param aTagNodes a var-args array of sv:tag nodes
86
+ * @throws IllegalArgumentException if aTaggableNode is null or an unsupported type, or if or aTagNodes is null, empty or contains an unsupported type
87
+ * @throws RepositoryException if mutation is not allowed or fails
88
+ */
89
+ addTags(aTaggableNode: Node, aTagNodes: Node): void;
90
+
91
+ /**
92
+ * Removes a sv:tag from a Node.
93
+ *
94
+ * <p>
95
+ * <strong>Permission note:</strong> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE}
96
+ * permission on the taggable Node that is mutated.
97
+ * </p>
98
+ * <p>
99
+ * <strong>Versioning note:</strong> Mutation of the taggable Node is always executed in the
100
+ * {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE} version.
101
+ * In other words - if you mutate the sv:tag entries on a sv:page, you must also
102
+ * {@link senselogic.sitevision.api.versioning.PublishingUtil publish} the sv:page for changes to affect the
103
+ * {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION ONLINE/published} version.
104
+ * </p>
105
+ * @param aTaggableNode a taggable node (sv:page, sv:article, sv:sitePage, sv:collaborationGroupPage, sv:file or sv:image)
106
+ * @param aTagNode a sv:tag
107
+ * @return true if aTagNode was removed from aTaggableNode, false otherwise
108
+ * @throws IllegalArgumentException if aTaggableNode or aTagNode is null or an unsupported type
109
+ * @throws RepositoryException if mutation is not allowed or fails
110
+ */
111
+ removeTag(aTaggableNode: Node, aTagNode: Node): boolean;
112
+
113
+ /**
114
+ * Gets all sv:tag's for a Node.
115
+ *
116
+ * <p>
117
+ * <em>Version note! This method executes in current version, i.e. it will return the list of sv:tag's
118
+ * in current version ({@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE_VERSION} or
119
+ * {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION ONLINE_VERSION}).</em>
120
+ * </p>
121
+ * @param aTaggableNode a taggable node (sv:page, sv:article, sv:sitePage, sv:collaborationGroupPage, sv:file or sv:image)
122
+ * @return a list of sv:tag nodes for aTaggableNode
123
+ * @throws IllegalArgumentException if aTaggableNode is null or an unsupported type
124
+ */
125
+ getTags(aTaggableNode: Node): unknown;
135
126
  }
136
127
 
137
- export default tagUtil;
128
+ declare namespace TagUtil {}
129
+
130
+ declare var tagUtil: TagUtil;
131
+
132
+ export = tagUtil;