@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,85 +1,3 @@
1
- /**
2
- * Logout current user based on a HttpServletRequest.
3
- * @param aServletRequest the current servlet request
4
- * @param invalidateHttpSession whether or not the session should be invalidated. This is normally not the case
5
- */
6
- export function logout(
7
- aServletRequest: unknown,
8
- invalidateHttpSession: boolean
9
- ): void;
10
-
11
- /**
12
- * Logout current user based on a PortletRequest.
13
- * @param aPortletRequest the current portlet request
14
- * @param invalidateHttpSession whether or not the session should be invalidated. This is normally not the case
15
- */
16
- export function logout(
17
- aPortletRequest: unknown,
18
- invalidateHttpSession: boolean
19
- ): void;
20
-
21
- /**
22
- * Authenticates a user based on a shared state map.
23
- * @param aServletRequest the current servlet request
24
- * @param sharedState a map containing "javax.security.auth.login.name" and "javax.security.auth.login.password"
25
- * @throws LoginException if login fails
26
- * @since Sitevision 2.6.2_06
27
- */
28
- export function login(aServletRequest: unknown, sharedState: unknown): void;
29
-
30
- /**
31
- * Authenticates a user based on username and password.
32
- * @param aServletRequest the current servlet request
33
- * @param name a username
34
- * @param password a password
35
- * @throws LoginException if login fails
36
- * @since Sitevision 2.6.2_06
37
- */
38
- export function login(
39
- aServletRequest: unknown,
40
- name: string,
41
- password: string
42
- ): void;
43
-
44
- /**
45
- * Re-authenticates a user based on a Subject already in the session.
46
- * @param aServletRequest the current servlet request
47
- * @throws LoginException if login fails
48
- * @since Sitevision 2.6.2_06
49
- */
50
- export function reLogin(aServletRequest: unknown): void;
51
-
52
- /**
53
- * Authenticates a user based on a shared state map.
54
- * @param aPortletRequest the current portlet request
55
- * @param sharedState a map containing "javax.security.auth.login.name" and "javax.security.auth.login.password"
56
- * @throws LoginException if login fails
57
- * @since Sitevision 2.6.2_06
58
- */
59
- export function login(aPortletRequest: unknown, sharedState: unknown): void;
60
-
61
- /**
62
- * Authenticates a user based on username and password.
63
- * @param aPortletRequest the current portlet request
64
- * @param name a username
65
- * @param password a password
66
- * @throws LoginException if login fails
67
- * @since Sitevision 2.6.2_06
68
- */
69
- export function login(
70
- aPortletRequest: unknown,
71
- name: string,
72
- password: string
73
- ): void;
74
-
75
- /**
76
- * Re-authenticates a user based on a Subject already in the session.
77
- * @param aPortletRequest the current portlet request
78
- * @throws LoginException if login fails
79
- * @since Sitevision 2.6.2_06
80
- */
81
- export function reLogin(aPortletRequest: unknown): void;
82
-
83
1
  /**
84
2
  * <p>
85
3
  * Authentication utility interface.
@@ -93,8 +11,78 @@ export function reLogin(aPortletRequest: unknown): void;
93
11
  * @author Mikael Wikblom
94
12
  * @since Sitevision 2.6.1_03, Sitevision 2.7_01
95
13
  */
96
- declare namespace authenticationUtil {
97
- export { logout, login, reLogin };
14
+ export interface AuthenticationUtil {
15
+ /**
16
+ * Logout current user based on a HttpServletRequest.
17
+ * @param aServletRequest the current servlet request
18
+ * @param invalidateHttpSession whether or not the session should be invalidated. This is normally not the case
19
+ */
20
+ logout(aServletRequest: unknown, invalidateHttpSession: boolean): void;
21
+
22
+ /**
23
+ * Logout current user based on a PortletRequest.
24
+ * @param aPortletRequest the current portlet request
25
+ * @param invalidateHttpSession whether or not the session should be invalidated. This is normally not the case
26
+ */
27
+ logout(aPortletRequest: unknown, invalidateHttpSession: boolean): void;
28
+
29
+ /**
30
+ * Authenticates a user based on a shared state map.
31
+ * @param aServletRequest the current servlet request
32
+ * @param sharedState a map containing "javax.security.auth.login.name" and "javax.security.auth.login.password"
33
+ * @throws LoginException if login fails
34
+ * @since Sitevision 2.6.2_06
35
+ */
36
+ login(aServletRequest: unknown, sharedState: unknown): void;
37
+
38
+ /**
39
+ * Authenticates a user based on username and password.
40
+ * @param aServletRequest the current servlet request
41
+ * @param name a username
42
+ * @param password a password
43
+ * @throws LoginException if login fails
44
+ * @since Sitevision 2.6.2_06
45
+ */
46
+ login(aServletRequest: unknown, name: string, password: string): void;
47
+
48
+ /**
49
+ * Re-authenticates a user based on a Subject already in the session.
50
+ * @param aServletRequest the current servlet request
51
+ * @throws LoginException if login fails
52
+ * @since Sitevision 2.6.2_06
53
+ */
54
+ reLogin(aServletRequest: unknown): void;
55
+
56
+ /**
57
+ * Authenticates a user based on a shared state map.
58
+ * @param aPortletRequest the current portlet request
59
+ * @param sharedState a map containing "javax.security.auth.login.name" and "javax.security.auth.login.password"
60
+ * @throws LoginException if login fails
61
+ * @since Sitevision 2.6.2_06
62
+ */
63
+ login(aPortletRequest: unknown, sharedState: unknown): void;
64
+
65
+ /**
66
+ * Authenticates a user based on username and password.
67
+ * @param aPortletRequest the current portlet request
68
+ * @param name a username
69
+ * @param password a password
70
+ * @throws LoginException if login fails
71
+ * @since Sitevision 2.6.2_06
72
+ */
73
+ login(aPortletRequest: unknown, name: string, password: string): void;
74
+
75
+ /**
76
+ * Re-authenticates a user based on a Subject already in the session.
77
+ * @param aPortletRequest the current portlet request
78
+ * @throws LoginException if login fails
79
+ * @since Sitevision 2.6.2_06
80
+ */
81
+ reLogin(aPortletRequest: unknown): void;
98
82
  }
99
83
 
100
- export default authenticationUtil;
84
+ declare namespace AuthenticationUtil {}
85
+
86
+ declare var authenticationUtil: AuthenticationUtil;
87
+
88
+ export = authenticationUtil;
@@ -1,74 +1,4 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
2
-
3
- /**
4
- * Returns a list of <code>Node</code> objects for all bookmarks belonging to
5
- * the current user regardless of category. This method only returns valid bookmarks
6
- * (existing, published objects)
7
- * @return a list of bookmark nodes. Is never <code>null</code>
8
- */
9
- export function getBookmarks(): unknown;
10
-
11
- /**
12
- * Returns a list of <code>Node</code> objects corresponding to the bookmarks for
13
- * the current user and the provided categories. This method only returns valid bookmarks
14
- * (existing, published objects)
15
- * @param category a comma separated list of categories or <code>null</code> for no category
16
- * @return a list of bookmark nodes. Is never <code>null</code>
17
- */
18
- export function getBookmarks(category: string): unknown;
19
-
20
- /**
21
- * Adds a bookmark for the current user. This operation is synchronized
22
- * @param bookmark the node to be bookmarked must be a <code>sv:page</code>, <code>sv:sitePage</code> or an <code>sv:article</code>
23
- * @param categories a comma separated list of categories to where this bookmark belongs
24
- * @throws IllegalArgumentException if <code>bookmark</code> is node of wrong type
25
- * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
26
- * @deprecated Use {@link #add(javax.jcr.Node)}, categories will be resolved from metadata.
27
- */
28
- export function add(bookmark: Node, categories: string): void;
29
-
30
- /**
31
- * Adds a bookmark for the current user. This operation is synchronized
32
- * @param bookmark the node to be bookmarked must be a <code>sv:page</code>, <code>sv:sitePage</code> or an <code>sv:article</code>
33
- * @throws IllegalArgumentException if bookmark is node of wrong type
34
- * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
35
- */
36
- export function add(bookmark: Node): void;
37
-
38
- /**
39
- * Removes a bookmark for the current user. This operation is synchronized
40
- * @param bookmark the bookmark
41
- * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
42
- */
43
- export function remove(bookmark: Node): void;
44
-
45
- /**
46
- * Checks if the current user has the provided bookmark
47
- * @param bookmark the bookmark
48
- * @return if the user has provided bookmark
49
- * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
50
- */
51
- export function contains(bookmark: Node): boolean;
52
-
53
- /**
54
- * Accesses a <code>boolean</code> indicating if the current site has a limited number of bookmarks.
55
- *
56
- * To get the max number of bookmarks, use {@link #getMaxNofBookmarks()}.
57
- * @return a <code>boolean</code> indicating if the current site has a limited number of bookmarks
58
- * @throws NullPointerException if current site is indeterminable
59
- * @see #getMaxNofBookmarks()
60
- * @since Sitevision 2.6.1_01
61
- */
62
- export function getLimitNofBookmarks(): boolean;
63
-
64
- /**
65
- * Accessor to max number of bookmarks for the current site.
66
- * @return max number of bookmarks for the current site
67
- * @throws NullPointerException if current site is indeterminable
68
- * @see #getLimitNofBookmarks()
69
- * @since Sitevision 2.6.1_01
70
- */
71
- export function getMaxNofBookmarks(): number;
1
+ import type Node from "../../types/javax/jcr/Node";
72
2
 
73
3
  /**
74
4
  * <p>Bookmark utility interface. Bookmarks are potentially clustered between sitevision instances.
@@ -83,15 +13,80 @@ export function getMaxNofBookmarks(): number;
83
13
  * @author Mikael Wikblom
84
14
  * @since Sitevision 2.6.1
85
15
  */
86
- declare namespace bookmarkUtil {
87
- export {
88
- getBookmarks,
89
- add,
90
- remove,
91
- contains,
92
- getLimitNofBookmarks,
93
- getMaxNofBookmarks,
94
- };
16
+ export interface BookmarkUtil {
17
+ /**
18
+ * Returns a list of <code>Node</code> objects for all bookmarks belonging to
19
+ * the current user regardless of category. This method only returns valid bookmarks
20
+ * (existing, published objects)
21
+ * @return a list of bookmark nodes. Is never <code>null</code>
22
+ */
23
+ getBookmarks(): unknown;
24
+
25
+ /**
26
+ * Returns a list of <code>Node</code> objects corresponding to the bookmarks for
27
+ * the current user and the provided categories. This method only returns valid bookmarks
28
+ * (existing, published objects)
29
+ * @param category a comma separated list of categories or <code>null</code> for no category
30
+ * @return a list of bookmark nodes. Is never <code>null</code>
31
+ */
32
+ getBookmarks(category: string): unknown;
33
+
34
+ /**
35
+ * Adds a bookmark for the current user. This operation is synchronized
36
+ * @param bookmark the node to be bookmarked must be a <code>sv:page</code>, <code>sv:sitePage</code> or an <code>sv:article</code>
37
+ * @param categories a comma separated list of categories to where this bookmark belongs
38
+ * @throws IllegalArgumentException if <code>bookmark</code> is node of wrong type
39
+ * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
40
+ * @deprecated Use {@link #add(javax.jcr.Node)}, categories will be resolved from metadata.
41
+ */
42
+ add(bookmark: Node, categories: string): void;
43
+
44
+ /**
45
+ * Adds a bookmark for the current user. This operation is synchronized
46
+ * @param bookmark the node to be bookmarked must be a <code>sv:page</code>, <code>sv:sitePage</code> or an <code>sv:article</code>
47
+ * @throws IllegalArgumentException if bookmark is node of wrong type
48
+ * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
49
+ */
50
+ add(bookmark: Node): void;
51
+
52
+ /**
53
+ * Removes a bookmark for the current user. This operation is synchronized
54
+ * @param bookmark the bookmark
55
+ * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
56
+ */
57
+ remove(bookmark: Node): void;
58
+
59
+ /**
60
+ * Checks if the current user has the provided bookmark
61
+ * @param bookmark the bookmark
62
+ * @return if the user has provided bookmark
63
+ * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
64
+ */
65
+ contains(bookmark: Node): boolean;
66
+
67
+ /**
68
+ * Accesses a <code>boolean</code> indicating if the current site has a limited number of bookmarks.
69
+ *
70
+ * To get the max number of bookmarks, use {@link #getMaxNofBookmarks()}.
71
+ * @return a <code>boolean</code> indicating if the current site has a limited number of bookmarks
72
+ * @throws NullPointerException if current site is indeterminable
73
+ * @see #getMaxNofBookmarks()
74
+ * @since Sitevision 2.6.1_01
75
+ */
76
+ getLimitNofBookmarks(): boolean;
77
+
78
+ /**
79
+ * Accessor to max number of bookmarks for the current site.
80
+ * @return max number of bookmarks for the current site
81
+ * @throws NullPointerException if current site is indeterminable
82
+ * @see #getLimitNofBookmarks()
83
+ * @since Sitevision 2.6.1_01
84
+ */
85
+ getMaxNofBookmarks(): number;
95
86
  }
96
87
 
97
- export default bookmarkUtil;
88
+ declare namespace BookmarkUtil {}
89
+
90
+ declare var bookmarkUtil: BookmarkUtil;
91
+
92
+ export = bookmarkUtil;
@@ -1,120 +1,7 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
1
+ import BuddyIconSize from "../BuddyIconRenderer.BuddyIconSize";
2
2
 
3
- /**
4
- * Sets the size for rendered buddy icons.
5
- *
6
- * <p>Default is <code>BuddyIconSize.SMALL</code></p>
7
- * @param aBuddyIconSize the icon size
8
- */
9
- export function setBuddyIconSize(aBuddyIconSize: unknown): void;
10
-
11
- /**
12
- * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.SMALL)</code>
13
- * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
14
- * @see BuddyIconSize#SMALL
15
- */
16
- export function forceUseSmallBuddyIconSize(): void;
17
-
18
- /**
19
- * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.LARGE)</code>
20
- * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
21
- * @see BuddyIconSize#LARGE
22
- */
23
- export function forceUseLargeBuddyIconSize(): void;
24
-
25
- /**
26
- * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.X_LARGE)</code>
27
- * @since Sitevision 8.2
28
- * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
29
- * @see BuddyIconSize#X_LARGE
30
- */
31
- export function forceUseXLargeBuddyIconSize(): void;
32
-
33
- /**
34
- * Whether or not rendered buddy icons should be linked.
35
- *
36
- * <p>Default is <code>true</code></p>
37
- * @param aLinkBuddyIcon Whether or not buddy icons should be linked.
38
- */
39
- export function setLinkBuddyIcon(aLinkBuddyIcon: boolean): void;
40
-
41
- /**
42
- * Utility method for executing <code>setLinkBuddyIcon(false)</code>
43
- * @see #setLinkBuddyIcon(boolean)
44
- */
45
- export function clearUseLinkBuddyIcon(): void;
46
-
47
- /**
48
- * Utility method for executing <code>setLinkBuddyIcon(true)</code>
49
- * @see #setLinkBuddyIcon(boolean)
50
- */
51
- export function forceUseLinkBuddyIcon(): void;
52
-
53
- /**
54
- * Updates the renderer with a new buddy icon supported node.
55
- *
56
- * <p>
57
- * If <code>aBuddyIconNode</code> is not a type that can be represented by a buddy icon, the argument will be considered as <code>null</code>,
58
- * i.e. the renderer will not have any renderable node in subsequent render execution.
59
- * </p>
60
- * @param aBuddyIconNode a node that can be rendered as a buddy icon.
61
- */
62
- export function update(aBuddyIconNode: Node): void;
63
-
64
- /**
65
- * Whether or not this renderer contains a node that can be rendered.
66
- * @return <code>true</code> if a renderable node is loaded, <code>false</code> if not.
67
- */
68
- export function isLoaded(): boolean;
69
-
70
- /**
71
- * Helper method to check if a certain node can be rendered as a buddy icon.
72
- *
73
- * <p>
74
- * Nodes with the following primary node types are potentially renderable:
75
- * </p>
76
- * <ul>
77
- * <li><code>sv:userIdentity</code></li>
78
- * <li><code>sv:user</code> <em>(non-anonymous)</em> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
79
- * <li><code>sv:simpleUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
80
- * <li style="margin-bottom:1em"><code>sv:systemUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
81
- * <li><code>sv:collaborationGroup</code></li>
82
- * <li><code>sv:collaborationGroupPage</code> &raquo; <em>will be renderable if a sv:collaborationGroup can be extracted</em></li>
83
- * </ul>
84
- * @param aNode the node to check
85
- * @return <code>true</code> if <code>aNode</code> is supported by this renderer, <code>false</code> if not
86
- */
87
- export function isRenderable(aNode: Node): boolean;
88
-
89
- /**
90
- * BuddyIconInfo for current state.
91
- *
92
- * <p>
93
- * <em>
94
- * The data this method provides is used by the {@link #render()} method.
95
- * The intent of this method is to facilitate custom buddy icon rendering solutions.
96
- * See {@link BuddyIconInfo} for such example.
97
- * </em>
98
- * </p>
99
- *
100
- * <p>
101
- * Note! Returned BuddyIconInfo object is never null but its <code>uri</code> will potentially be null and its
102
- * <code>width</code>/<code>height</code> might be zero.
103
- * Typically when this renderer has no valid/renderable node loaded, see {@link #isLoaded()}.
104
- * </p>
105
- * @return the BuddyIconInfo for current state, is never null.
106
- * @since Sitevision 8.2
107
- */
108
- export function getBuddyIconInfo(): unknown;
109
-
110
- /**
111
- * Builds a html string based on current state.
112
- *
113
- * <strong>Size note!</strong> Profile images will never be upscaled. If a buddy icon size is larger than the actual size of the profile image,
114
- * the image will be rendered with the largest possible buddy icon size.
115
- * @return a html string, ready to print out on a page. Might be empty but never <code>null</code>.
116
- */
117
- export function render(): string;
3
+ import type Node from "../../types/javax/jcr/Node";
4
+ import type BuddyIconInfo from "../../types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo";
118
5
 
119
6
  /**
120
7
  * BuddyIconRenderer is a stateful utility interface for rendering of buddy icons for user identities and collaboration groups.
@@ -180,21 +67,126 @@ export function render(): string;
180
67
  * @author Magnus Lövgren
181
68
  * @since Sitevision 3.5.3
182
69
  */
183
- declare namespace buddyIconRenderer {
184
- export {
185
- setBuddyIconSize,
186
- forceUseSmallBuddyIconSize,
187
- forceUseLargeBuddyIconSize,
188
- forceUseXLargeBuddyIconSize,
189
- setLinkBuddyIcon,
190
- clearUseLinkBuddyIcon,
191
- forceUseLinkBuddyIcon,
192
- update,
193
- isLoaded,
194
- isRenderable,
195
- getBuddyIconInfo,
196
- render,
197
- };
70
+ export interface BuddyIconRenderer {
71
+ /**
72
+ * Sets the size for rendered buddy icons.
73
+ *
74
+ * <p>Default is <code>BuddyIconSize.SMALL</code></p>
75
+ * @param aBuddyIconSize the icon size
76
+ */
77
+ setBuddyIconSize(aBuddyIconSize: BuddyIconSize): void;
78
+
79
+ /**
80
+ * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.SMALL)</code>
81
+ * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
82
+ * @see BuddyIconSize#SMALL
83
+ */
84
+ forceUseSmallBuddyIconSize(): void;
85
+
86
+ /**
87
+ * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.LARGE)</code>
88
+ * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
89
+ * @see BuddyIconSize#LARGE
90
+ */
91
+ forceUseLargeBuddyIconSize(): void;
92
+
93
+ /**
94
+ * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.X_LARGE)</code>
95
+ * @since Sitevision 8.2
96
+ * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
97
+ * @see BuddyIconSize#X_LARGE
98
+ */
99
+ forceUseXLargeBuddyIconSize(): void;
100
+
101
+ /**
102
+ * Whether or not rendered buddy icons should be linked.
103
+ *
104
+ * <p>Default is <code>true</code></p>
105
+ * @param aLinkBuddyIcon Whether or not buddy icons should be linked.
106
+ */
107
+ setLinkBuddyIcon(aLinkBuddyIcon: boolean): void;
108
+
109
+ /**
110
+ * Utility method for executing <code>setLinkBuddyIcon(false)</code>
111
+ * @see #setLinkBuddyIcon(boolean)
112
+ */
113
+ clearUseLinkBuddyIcon(): void;
114
+
115
+ /**
116
+ * Utility method for executing <code>setLinkBuddyIcon(true)</code>
117
+ * @see #setLinkBuddyIcon(boolean)
118
+ */
119
+ forceUseLinkBuddyIcon(): void;
120
+
121
+ /**
122
+ * Updates the renderer with a new buddy icon supported node.
123
+ *
124
+ * <p>
125
+ * If <code>aBuddyIconNode</code> is not a type that can be represented by a buddy icon, the argument will be considered as <code>null</code>,
126
+ * i.e. the renderer will not have any renderable node in subsequent render execution.
127
+ * </p>
128
+ * @param aBuddyIconNode a node that can be rendered as a buddy icon.
129
+ */
130
+ update(aBuddyIconNode: Node): void;
131
+
132
+ /**
133
+ * Whether or not this renderer contains a node that can be rendered.
134
+ * @return <code>true</code> if a renderable node is loaded, <code>false</code> if not.
135
+ */
136
+ isLoaded(): boolean;
137
+
138
+ /**
139
+ * Helper method to check if a certain node can be rendered as a buddy icon.
140
+ *
141
+ * <p>
142
+ * Nodes with the following primary node types are potentially renderable:
143
+ * </p>
144
+ * <ul>
145
+ * <li><code>sv:userIdentity</code></li>
146
+ * <li><code>sv:user</code> <em>(non-anonymous)</em> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
147
+ * <li><code>sv:simpleUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
148
+ * <li style="margin-bottom:1em"><code>sv:systemUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
149
+ * <li><code>sv:collaborationGroup</code></li>
150
+ * <li><code>sv:collaborationGroupPage</code> &raquo; <em>will be renderable if a sv:collaborationGroup can be extracted</em></li>
151
+ * </ul>
152
+ * @param aNode the node to check
153
+ * @return <code>true</code> if <code>aNode</code> is supported by this renderer, <code>false</code> if not
154
+ */
155
+ isRenderable(aNode: Node): boolean;
156
+
157
+ /**
158
+ * BuddyIconInfo for current state.
159
+ *
160
+ * <p>
161
+ * <em>
162
+ * The data this method provides is used by the {@link #render()} method.
163
+ * The intent of this method is to facilitate custom buddy icon rendering solutions.
164
+ * See {@link BuddyIconInfo} for such example.
165
+ * </em>
166
+ * </p>
167
+ *
168
+ * <p>
169
+ * Note! Returned BuddyIconInfo object is never null but its <code>uri</code> will potentially be null and its
170
+ * <code>width</code>/<code>height</code> might be zero.
171
+ * Typically when this renderer has no valid/renderable node loaded, see {@link #isLoaded()}.
172
+ * </p>
173
+ * @return the BuddyIconInfo for current state, is never null.
174
+ * @since Sitevision 8.2
175
+ */
176
+ getBuddyIconInfo(): BuddyIconInfo;
177
+
178
+ /**
179
+ * Builds a html string based on current state.
180
+ *
181
+ * <strong>Size note!</strong> Profile images will never be upscaled. If a buddy icon size is larger than the actual size of the profile image,
182
+ * the image will be rendered with the largest possible buddy icon size.
183
+ * @return a html string, ready to print out on a page. Might be empty but never <code>null</code>.
184
+ */
185
+ render(): string;
198
186
  }
199
187
 
200
- export default buddyIconRenderer;
188
+ declare namespace BuddyIconRenderer {}
189
+
190
+ declare var buddyIconRenderer: BuddyIconRenderer;
191
+
192
+ export = buddyIconRenderer;
@@ -0,0 +1,41 @@
1
+ /**
2
+ * The size of the icons rendered by the BuddyIconRenderer.
3
+ *
4
+ * <p>
5
+ * Example of how to get the {@link #LARGE} type:
6
+ * </p>
7
+ * <ul>
8
+ * <li>
9
+ * Using <strong>Velocity:</strong><pre><code>
10
+ * #set ($instanceCreatorUtil = $sitevisionUtils.instanceCreatorUtil)
11
+ * #set ($enumClassName = 'senselogic.sitevision.api.render.BuddyIconRenderer$BuddyIconSize') <em>## Note the '$' separator...</em>
12
+ * #set ($largeSize = $instanceCreatorUtil.getEnumInstance($enumClassName, 'LARGE'))</code></pre>
13
+ * </li>
14
+ * <li>
15
+ * Using server-side <strong>JavaScript:</strong><pre><code>
16
+ * var largeSize = require('BuddyIconRenderer.BuddyIconSize.LARGE');</code></pre>
17
+ * </li>
18
+ * </ul>
19
+ * @author Magnus Lövgren
20
+ * @since Sitevision 3.5.3
21
+ */
22
+ declare enum BuddyIconSize {
23
+ SMALL,
24
+ LARGE,
25
+ X_LARGE,
26
+ WIDTH_160,
27
+ WIDTH_320,
28
+ WIDTH_480,
29
+ WIDTH_640,
30
+ WIDTH_800,
31
+ WIDTH_960,
32
+ WIDTH_1120,
33
+ WIDTH_1280,
34
+ WIDTH_1440,
35
+ WIDTH_1600,
36
+ WIDTH_1760,
37
+ WIDTH_1920,
38
+ WIDTH_2080,
39
+ }
40
+
41
+ export default BuddyIconSize;
@@ -0,0 +1,25 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _default = {
8
+ SMALL: 'SMALL',
9
+ LARGE: 'LARGE',
10
+ X_LARGE: 'X_LARGE',
11
+ WIDTH_160: 'WIDTH_160',
12
+ WIDTH_320: 'WIDTH_320',
13
+ WIDTH_480: 'WIDTH_480',
14
+ WIDTH_640: 'WIDTH_640',
15
+ WIDTH_800: 'WIDTH_800',
16
+ WIDTH_960: 'WIDTH_960',
17
+ WIDTH_1120: 'WIDTH_1120',
18
+ WIDTH_1280: 'WIDTH_1280',
19
+ WIDTH_1440: 'WIDTH_1440',
20
+ WIDTH_1600: 'WIDTH_1600',
21
+ WIDTH_1760: 'WIDTH_1760',
22
+ WIDTH_1920: 'WIDTH_1920',
23
+ WIDTH_2080: 'WIDTH_2080'
24
+ };
25
+ exports["default"] = _default;