@sitevision/api 1.0.19 → 1.1.0-alpha.1

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