@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,9 +1,3 @@
1
- /**
2
- * Gets the Internet Protocol (IP) address of the client (or last proxy) that initiated currently executing request.
3
- * @return a <code>String</code> containing the IP address of the client that sent the request, or <code>null</code> if indeterminable
4
- */
5
- export function getClientAddress(): string;
6
-
7
1
  /**
8
2
  * Client utility interface.
9
3
  *
@@ -19,8 +13,16 @@ export function getClientAddress(): string;
19
13
  * @author Magnus Lövgren
20
14
  * @since Sitevision 2.6_02
21
15
  */
22
- declare namespace clientUtil {
23
- export { getClientAddress };
16
+ export interface ClientUtil {
17
+ /**
18
+ * Gets the Internet Protocol (IP) address of the client (or last proxy) that initiated currently executing request.
19
+ * @return a <code>String</code> containing the IP address of the client that sent the request, or <code>null</code> if indeterminable
20
+ */
21
+ getClientAddress(): string;
24
22
  }
25
23
 
26
- export default clientUtil;
24
+ declare namespace ClientUtil {}
25
+
26
+ declare var clientUtil: ClientUtil;
27
+
28
+ export = clientUtil;
@@ -1,39 +1,9 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
2
- import type { CollaborationGroupWrapper } from "../../types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper";
1
+ import type Node from "../../types/javax/jcr/Node";
2
+ import type CollaborationGroupWrapper from "../../types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper";
3
3
  import CollaborationGroupUtil from "../CollaborationGroupUtil";
4
4
  import CollaborationGroupFolderUtil from "../CollaborationGroupFolderUtil";
5
5
  import CollaborationGroupTemplateUtil from "../CollaborationGroupTemplateUtil";
6
6
 
7
- /**
8
- * Gets a collaboration group wrapper for a specified collaboration group.
9
- * @param aCollaborationGroup the collaboration group (or the collaboration group page)
10
- * @return a collaboration group wrapper for <code>aCollaborationGroup</code>, or <code>null</code> if <code>aCollaborationGroup</code> isn't a collaboration group or if current user doesn't have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on <code>aCollaborationGroup</code>.
11
- */
12
- export function getCollaborationGroupWrapper(
13
- aCollaborationGroup: Node
14
- ): CollaborationGroupWrapper;
15
-
16
- /**
17
- * Gets an instance of a collaboration group utility class
18
- * @return An instance of a collaboration group utility class
19
- * @since Sitevision 3.6.4
20
- */
21
- export function getCollaborationGroupUtil(): CollaborationGroupUtil;
22
-
23
- /**
24
- * Gets an instance of a collaboration group folder utility class
25
- * @return An instance of a collaboration group folder utility class
26
- * @since Sitevision 3.6.4
27
- */
28
- export function getCollaborationGroupFolderUtil(): CollaborationGroupFolderUtil;
29
-
30
- /**
31
- * Gets an instance of a collaboration group template utility class
32
- * @return An instance of a collaboration group template utility class
33
- * @since Sitevision 3.6.4
34
- */
35
- export function getCollaborationGroupTemplateUtil(): CollaborationGroupTemplateUtil;
36
-
37
7
  /**
38
8
  * Factory for creating collaboration-related instances.
39
9
  *
@@ -45,13 +15,40 @@ export function getCollaborationGroupTemplateUtil(): CollaborationGroupTemplateU
45
15
  * @author Magnus Lövgren
46
16
  * @since Sitevision 3.6
47
17
  */
48
- declare namespace collaborationFactory {
49
- export {
50
- getCollaborationGroupWrapper,
51
- getCollaborationGroupUtil,
52
- getCollaborationGroupFolderUtil,
53
- getCollaborationGroupTemplateUtil,
54
- };
18
+ export interface CollaborationFactory {
19
+ /**
20
+ * Gets a collaboration group wrapper for a specified collaboration group.
21
+ * @param aCollaborationGroup the collaboration group (or the collaboration group page)
22
+ * @return a collaboration group wrapper for <code>aCollaborationGroup</code>, or <code>null</code> if <code>aCollaborationGroup</code> isn't a collaboration group or if current user doesn't have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on <code>aCollaborationGroup</code>.
23
+ */
24
+ getCollaborationGroupWrapper(
25
+ aCollaborationGroup: Node
26
+ ): CollaborationGroupWrapper;
27
+
28
+ /**
29
+ * Gets an instance of a collaboration group utility class
30
+ * @return An instance of a collaboration group utility class
31
+ * @since Sitevision 3.6.4
32
+ */
33
+ getCollaborationGroupUtil(): CollaborationGroupUtil;
34
+
35
+ /**
36
+ * Gets an instance of a collaboration group folder utility class
37
+ * @return An instance of a collaboration group folder utility class
38
+ * @since Sitevision 3.6.4
39
+ */
40
+ getCollaborationGroupFolderUtil(): CollaborationGroupFolderUtil;
41
+
42
+ /**
43
+ * Gets an instance of a collaboration group template utility class
44
+ * @return An instance of a collaboration group template utility class
45
+ * @since Sitevision 3.6.4
46
+ */
47
+ getCollaborationGroupTemplateUtil(): CollaborationGroupTemplateUtil;
55
48
  }
56
49
 
57
- export default collaborationFactory;
50
+ declare namespace CollaborationFactory {}
51
+
52
+ declare var collaborationFactory: CollaborationFactory;
53
+
54
+ export = collaborationFactory;
@@ -1,28 +1,4 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
2
-
3
- /**
4
- * Gets the default collaboration group folder.
5
- *
6
- * <p>
7
- * The <em>default collaboration group folder</em> is the folder where new collaboration groups
8
- * (i.e. collaboration group pages) are created by default.
9
- * </p>
10
- * @return the default collaboration group folder, or <code>null</code> if indeterminable
11
- */
12
- export function getDefaultCollaborationGroupFolder(): Node;
13
-
14
- /**
15
- * Whether or not a collaboration group folder already contains a named collaboration group.
16
- * @param aCollaborationGroupFolder the collaboration group folder
17
- * @param aGroupName the name of the collaboration group
18
- * @return <code>true</code> if <code>aCollaborationGroupFolder</code> contains (case ignored) a group named <code>aGroupName</code>, <code>false</code> otherwise
19
- * @throws java.lang.NullPointerException if <code>aCollaborationGroupFolder</code> or <code>aGroupName</code> is <code>null</code>
20
- * @throws RepositoryException if <code>aCollaborationGroupFolder</code> is not a collaboration folder
21
- */
22
- export function containsCollaborationGroup(
23
- aCollaborationGroupFolder: Node,
24
- aGroupName: string
25
- ): boolean;
1
+ import type Node from "../../types/javax/jcr/Node";
26
2
 
27
3
  /**
28
4
  * Collaboration group folder utility interface that handles nodes with primary node type <code>sv:collaborationGroupFolder</code>.
@@ -35,8 +11,34 @@ export function containsCollaborationGroup(
35
11
  * @author Magnus Lövgren
36
12
  * @since Sitevision 3.6.4
37
13
  */
38
- declare namespace collaborationGroupFolderUtil {
39
- export { getDefaultCollaborationGroupFolder, containsCollaborationGroup };
14
+ export interface CollaborationGroupFolderUtil {
15
+ /**
16
+ * Gets the default collaboration group folder.
17
+ *
18
+ * <p>
19
+ * The <em>default collaboration group folder</em> is the folder where new collaboration groups
20
+ * (i.e. collaboration group pages) are created by default.
21
+ * </p>
22
+ * @return the default collaboration group folder, or <code>null</code> if indeterminable
23
+ */
24
+ getDefaultCollaborationGroupFolder(): Node;
25
+
26
+ /**
27
+ * Whether or not a collaboration group folder already contains a named collaboration group.
28
+ * @param aCollaborationGroupFolder the collaboration group folder
29
+ * @param aGroupName the name of the collaboration group
30
+ * @return <code>true</code> if <code>aCollaborationGroupFolder</code> contains (case ignored) a group named <code>aGroupName</code>, <code>false</code> otherwise
31
+ * @throws java.lang.NullPointerException if <code>aCollaborationGroupFolder</code> or <code>aGroupName</code> is <code>null</code>
32
+ * @throws RepositoryException if <code>aCollaborationGroupFolder</code> is not a collaboration folder
33
+ */
34
+ containsCollaborationGroup(
35
+ aCollaborationGroupFolder: Node,
36
+ aGroupName: string
37
+ ): boolean;
40
38
  }
41
39
 
42
- export default collaborationGroupFolderUtil;
40
+ declare namespace CollaborationGroupFolderUtil {}
41
+
42
+ declare var collaborationGroupFolderUtil: CollaborationGroupFolderUtil;
43
+
44
+ export = collaborationGroupFolderUtil;
@@ -0,0 +1,27 @@
1
+ /**
2
+ * Collaboration group state.
3
+ *
4
+ * <p>
5
+ * Example of how to get the {@link #ACTIVE} state:
6
+ * </p>
7
+ * <ul>
8
+ * <li>
9
+ * Using <strong>Velocity:</strong><pre><code>
10
+ * #set ($instanceCreatorUtil = $sitevisionUtils.instanceCreatorUtil)
11
+ * #set ($enumClassName = 'senselogic.sitevision.api.collaboration.CollaborationGroupState')
12
+ * #set ($activeEnum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'ACTIVE'))</code></pre>
13
+ * </li>
14
+ * <li>
15
+ * Using server-side <strong>JavaScript:</strong><pre><code>
16
+ * var activeEnum = require('CollaborationGroupState.ACTIVE');</code></pre>
17
+ * </li>
18
+ * </ul>
19
+ * @author Magnus Lövgren
20
+ * @since Sitevision 4.1
21
+ */
22
+ declare enum CollaborationGroupState {
23
+ ACTIVE,
24
+ INACTIVE,
25
+ }
26
+
27
+ export default CollaborationGroupState;
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _default = {
8
+ ACTIVE: 'ACTIVE',
9
+ INACTIVE: 'INACTIVE'
10
+ };
11
+ exports["default"] = _default;
@@ -1,46 +1,4 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
2
-
3
- /**
4
- * Gets the default collaboration group template.
5
- *
6
- * <p>
7
- * The <em>default collaboration group template</em> is the template that are used by default to create new
8
- * collaboration groups (i.e. collaboration group pages).
9
- * </p>
10
- * <p>
11
- * <em>Permission note!</em> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
12
- * on default collaboration group template.
13
- * </p>
14
- * @return the default collaboration group template, or <code>null</code> if indeterminable
15
- */
16
- export function getDefaultCollaborationGroupTemplate(): Node;
17
-
18
- /**
19
- * Gets the first found collaboration group template that matches a given name.
20
- *
21
- * <p>
22
- * <em>Permission note!</em> Only collaboration group templates that current user has
23
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on will be considered.
24
- * </p>
25
- * @param aCollaborationGroupTemplateName name of the template
26
- * @return a collaboration group template, or <code>null</code> if indeterminable (e.g. no accessible collaboration group template named <code>aCollaborationGroupTemplateName</code> could be found)
27
- * @since Sitevision 4.1
28
- */
29
- export function getCollaborationGroupTemplateByName(
30
- aCollaborationGroupTemplateName: string
31
- ): Node;
32
-
33
- /**
34
- * Gets all collaboration group templates.
35
- *
36
- * <p>
37
- * <em>Permission note!</em> The list will only contain collaboration group templates that current user has
38
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on.
39
- * </p>
40
- * @return all collaboration group templates, or empty list if there are no accessible collaboration group templates.
41
- * @since Sitevision 4.1
42
- */
43
- export function getCollaborationGroupTemplates(): unknown;
1
+ import type Node from "../../types/javax/jcr/Node";
44
2
 
45
3
  /**
46
4
  * Collaboration group template utility interface that handles nodes with primary node type <code>sv:collaborationGroupTemplate</code>.
@@ -54,12 +12,52 @@ export function getCollaborationGroupTemplates(): unknown;
54
12
  * @since Sitevision 3.6.4
55
13
  * @see senselogic.sitevision.api.resource.TemplateUtil
56
14
  */
57
- declare namespace collaborationGroupTemplateUtil {
58
- export {
59
- getDefaultCollaborationGroupTemplate,
60
- getCollaborationGroupTemplateByName,
61
- getCollaborationGroupTemplates,
62
- };
15
+ export interface CollaborationGroupTemplateUtil {
16
+ /**
17
+ * Gets the default collaboration group template.
18
+ *
19
+ * <p>
20
+ * The <em>default collaboration group template</em> is the template that are used by default to create new
21
+ * collaboration groups (i.e. collaboration group pages).
22
+ * </p>
23
+ * <p>
24
+ * <em>Permission note!</em> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
25
+ * on default collaboration group template.
26
+ * </p>
27
+ * @return the default collaboration group template, or <code>null</code> if indeterminable
28
+ */
29
+ getDefaultCollaborationGroupTemplate(): Node;
30
+
31
+ /**
32
+ * Gets the first found collaboration group template that matches a given name.
33
+ *
34
+ * <p>
35
+ * <em>Permission note!</em> Only collaboration group templates that current user has
36
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on will be considered.
37
+ * </p>
38
+ * @param aCollaborationGroupTemplateName name of the template
39
+ * @return a collaboration group template, or <code>null</code> if indeterminable (e.g. no accessible collaboration group template named <code>aCollaborationGroupTemplateName</code> could be found)
40
+ * @since Sitevision 4.1
41
+ */
42
+ getCollaborationGroupTemplateByName(
43
+ aCollaborationGroupTemplateName: string
44
+ ): Node;
45
+
46
+ /**
47
+ * Gets all collaboration group templates.
48
+ *
49
+ * <p>
50
+ * <em>Permission note!</em> The list will only contain collaboration group templates that current user has
51
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on.
52
+ * </p>
53
+ * @return all collaboration group templates, or empty list if there are no accessible collaboration group templates.
54
+ * @since Sitevision 4.1
55
+ */
56
+ getCollaborationGroupTemplates(): unknown;
63
57
  }
64
58
 
65
- export default collaborationGroupTemplateUtil;
59
+ declare namespace CollaborationGroupTemplateUtil {}
60
+
61
+ declare var collaborationGroupTemplateUtil: CollaborationGroupTemplateUtil;
62
+
63
+ export = collaborationGroupTemplateUtil;
@@ -0,0 +1,28 @@
1
+ /**
2
+ * Type of Collaboration group.
3
+ *
4
+ * <p>
5
+ * Example of how to get the {@link #OPEN} 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.collaboration.CollaborationGroupType')
12
+ * #set ($openEnum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'OPEN'))</code></pre>
13
+ * </li>
14
+ * <li>
15
+ * Using server-side <strong>JavaScript:</strong><pre><code>
16
+ * var openEnum = require('CollaborationGroupType.OPEN');</code></pre>
17
+ * </li>
18
+ * </ul>
19
+ * @author Magnus Lövgren
20
+ * @since Sitevision 4.1
21
+ */
22
+ declare enum CollaborationGroupType {
23
+ OPEN,
24
+ MEMBER_MODERATED,
25
+ CLOSED,
26
+ }
27
+
28
+ export default CollaborationGroupType;
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _default = {
8
+ OPEN: 'OPEN',
9
+ MEMBER_MODERATED: 'MEMBER_MODERATED',
10
+ CLOSED: 'CLOSED'
11
+ };
12
+ exports["default"] = _default;
@@ -1,83 +1,6 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
1
+ import type Node from "../../types/javax/jcr/Node";
2
2
 
3
- /**
4
- * Creates an open collaboration group.
5
- *
6
- * <p>
7
- * <em>
8
- * This is a legacy convenience method that delegates to {@link #createCollaborationGroup(Node, Node, String, CollaborationGroupType)}
9
- * using {@link CollaborationGroupType#OPEN} as group type.
10
- * </em>
11
- * </p>
12
- * @param aGroupTemplate the collaboration group template (sv:collaborationGroupTemplate) to use when creating the collaboration group page of the collaboration group
13
- * @param aGroupFolder the collaboration group folder (sv:collaborationGroupFolder) where the collaboration group page of the collaboration group should reside
14
- * @param aGroupName the name of the collaboration group
15
- * @return The created collaboration group (sv:collaborationGroup)
16
- * @throws java.lang.NullPointerException if <code>aGroupTemplate</code>, <code>aGroupFolder</code> or <code>aGroupName</code> is <code>null</code>
17
- * @throws ConstraintViolationException if <code>aGroupTemplate</code> or <code>aGroupFolder</code> is of invalid type, if <code>aGroupName</code> is whitespace only, if <code>aGroupFolder</code> already contains a collaboration group named <code>aGroupName</code> (case ignored) or if current user is not authorized to create the collaboration group
18
- * @throws RepositoryException if something else goes wrong
19
- * @see #createCollaborationGroup(Node, Node, String, CollaborationGroupType)
20
- */
21
- export function createCollaborationGroup(
22
- aGroupTemplate: Node,
23
- aGroupFolder: Node,
24
- aGroupName: string
25
- ): Node;
26
-
27
- /**
28
- * Creates a collaboration group.
29
- *
30
- * <p>
31
- * <strong>Permission note!</strong> Current user must have
32
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on <code>aGroupTemplate</code>
33
- * and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_COLLABORATION_GROUP} on <code>aGroupFolder</code>.
34
- * In order to create a {@link CollaborationGroupType#CLOSED} collaboration group, current user must also have
35
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_CLOSED_COLLABORATION_GROUP} on <code>aGroupFolder</code>.
36
- * </p>
37
- * <p>
38
- * <strong>User note!</strong> Current user must have a user identity as it will be the administrator of the created
39
- * group. <em>Anonymous</em> users doesn't have a user identity, nor the <em>Indexer</em>, <em>Validator</em> or the <em>Extractor</em>.
40
- * In other words: {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUserIdentity()} must be non-<code>null</code>.
41
- * </p>
42
- *
43
- * <p>
44
- * <em>Tip!</em> Use {@link CollaborationGroupTemplateUtil} to get a group template,
45
- * use {@link CollaborationGroupFolderUtil} to get the default group folder (and perhaps check if the collaboration folder already contains
46
- * a collaboration group with specified name). Use {@link CollaborationGroupWrapper} to update the group that is created.
47
- * </p>
48
- * @param aGroupTemplate the collaboration group template (sv:collaborationGroupTemplate) to use when creating the collaboration group page of the collaboration group
49
- * @param aGroupFolder the collaboration group folder (sv:collaborationGroupFolder) where the collaboration group page of the collaboration group should reside
50
- * @param aGroupName the name of the collaboration group
51
- * @param aGroupType the group type, note that {@link CollaborationGroupType#CLOSED} needs additional permission
52
- * @return The created collaboration group (sv:collaborationGroup)
53
- * @throws java.lang.NullPointerException if <code>aGroupTemplate</code>, <code>aGroupFolder</code>, <code>aGroupName</code> or <code>aGroupType</code> is <code>null</code>
54
- * @throws ConstraintViolationException if <code>aGroupTemplate</code> or <code>aGroupFolder</code> is of invalid type, if <code>aGroupName</code> is whitespace only, if <code>aGroupFolder</code> already contains a collaboration group named <code>aGroupName</code> (case ignored) or if current user is not authorized to create the collaboration group (see permission note above)
55
- * @throws RepositoryException if something else goes wrong
56
- * @since Sitevision 4.1
57
- */
58
- export function createCollaborationGroup(
59
- aGroupTemplate: Node,
60
- aGroupFolder: Node,
61
- aGroupName: string,
62
- aGroupType: unknown
63
- ): Node;
64
-
65
- /**
66
- * Removes a collaboration group.
67
- *
68
- * <p>
69
- * <em>Note!</em> When a collaboration group (<code>sv:collaborationGroup</code>) is removed,
70
- * its collaboration group page (<code>sv:collaborationGroupPage</code>) is moved to the trashcan.
71
- * </p>
72
- * <p>
73
- * <strong>Permission note!</strong> To remove a collaboration group current user must have
74
- * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP} on the collaboration group page.
75
- * </p>
76
- * @param aCollaborationGroup a collaboration group to remove
77
- * @return <code>true</code> if <code>aCollaborationGroup</code> was removed, i.e. collaboration group page was moved to trashcan, <code>false</code> otherwise.
78
- * @since Sitevision 4.5.3
79
- */
80
- export function removeCollaborationGroup(aCollaborationGroup: Node): boolean;
3
+ import CollaborationGroupType from "../CollaborationGroupType";
81
4
 
82
5
  /**
83
6
  * Collaboration group utility interface.
@@ -95,8 +18,89 @@ export function removeCollaborationGroup(aCollaborationGroup: Node): boolean;
95
18
  * @author Magnus Lövgren
96
19
  * @since Sitevision 3.6.4
97
20
  */
98
- declare namespace collaborationGroupUtil {
99
- export { createCollaborationGroup, removeCollaborationGroup };
21
+ export interface CollaborationGroupUtil {
22
+ /**
23
+ * Creates an open collaboration group.
24
+ *
25
+ * <p>
26
+ * <em>
27
+ * This is a legacy convenience method that delegates to {@link #createCollaborationGroup(Node, Node, String, CollaborationGroupType)}
28
+ * using {@link CollaborationGroupType#OPEN} as group type.
29
+ * </em>
30
+ * </p>
31
+ * @param aGroupTemplate the collaboration group template (sv:collaborationGroupTemplate) to use when creating the collaboration group page of the collaboration group
32
+ * @param aGroupFolder the collaboration group folder (sv:collaborationGroupFolder) where the collaboration group page of the collaboration group should reside
33
+ * @param aGroupName the name of the collaboration group
34
+ * @return The created collaboration group (sv:collaborationGroup)
35
+ * @throws java.lang.NullPointerException if <code>aGroupTemplate</code>, <code>aGroupFolder</code> or <code>aGroupName</code> is <code>null</code>
36
+ * @throws ConstraintViolationException if <code>aGroupTemplate</code> or <code>aGroupFolder</code> is of invalid type, if <code>aGroupName</code> is whitespace only, if <code>aGroupFolder</code> already contains a collaboration group named <code>aGroupName</code> (case ignored) or if current user is not authorized to create the collaboration group
37
+ * @throws RepositoryException if something else goes wrong
38
+ * @see #createCollaborationGroup(Node, Node, String, CollaborationGroupType)
39
+ */
40
+ createCollaborationGroup(
41
+ aGroupTemplate: Node,
42
+ aGroupFolder: Node,
43
+ aGroupName: string
44
+ ): Node;
45
+
46
+ /**
47
+ * Creates a collaboration group.
48
+ *
49
+ * <p>
50
+ * <strong>Permission note!</strong> Current user must have
51
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on <code>aGroupTemplate</code>
52
+ * and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_COLLABORATION_GROUP} on <code>aGroupFolder</code>.
53
+ * In order to create a {@link CollaborationGroupType#CLOSED} collaboration group, current user must also have
54
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_CLOSED_COLLABORATION_GROUP} on <code>aGroupFolder</code>.
55
+ * </p>
56
+ * <p>
57
+ * <strong>User note!</strong> Current user must have a user identity as it will be the administrator of the created
58
+ * group. <em>Anonymous</em> users doesn't have a user identity, nor the <em>Indexer</em>, <em>Validator</em> or the <em>Extractor</em>.
59
+ * In other words: {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUserIdentity()} must be non-<code>null</code>.
60
+ * </p>
61
+ *
62
+ * <p>
63
+ * <em>Tip!</em> Use {@link CollaborationGroupTemplateUtil} to get a group template,
64
+ * use {@link CollaborationGroupFolderUtil} to get the default group folder (and perhaps check if the collaboration folder already contains
65
+ * a collaboration group with specified name). Use {@link CollaborationGroupWrapper} to update the group that is created.
66
+ * </p>
67
+ * @param aGroupTemplate the collaboration group template (sv:collaborationGroupTemplate) to use when creating the collaboration group page of the collaboration group
68
+ * @param aGroupFolder the collaboration group folder (sv:collaborationGroupFolder) where the collaboration group page of the collaboration group should reside
69
+ * @param aGroupName the name of the collaboration group
70
+ * @param aGroupType the group type, note that {@link CollaborationGroupType#CLOSED} needs additional permission
71
+ * @return The created collaboration group (sv:collaborationGroup)
72
+ * @throws java.lang.NullPointerException if <code>aGroupTemplate</code>, <code>aGroupFolder</code>, <code>aGroupName</code> or <code>aGroupType</code> is <code>null</code>
73
+ * @throws ConstraintViolationException if <code>aGroupTemplate</code> or <code>aGroupFolder</code> is of invalid type, if <code>aGroupName</code> is whitespace only, if <code>aGroupFolder</code> already contains a collaboration group named <code>aGroupName</code> (case ignored) or if current user is not authorized to create the collaboration group (see permission note above)
74
+ * @throws RepositoryException if something else goes wrong
75
+ * @since Sitevision 4.1
76
+ */
77
+ createCollaborationGroup(
78
+ aGroupTemplate: Node,
79
+ aGroupFolder: Node,
80
+ aGroupName: string,
81
+ aGroupType: CollaborationGroupType
82
+ ): Node;
83
+
84
+ /**
85
+ * Removes a collaboration group.
86
+ *
87
+ * <p>
88
+ * <em>Note!</em> When a collaboration group (<code>sv:collaborationGroup</code>) is removed,
89
+ * its collaboration group page (<code>sv:collaborationGroupPage</code>) is moved to the trashcan.
90
+ * </p>
91
+ * <p>
92
+ * <strong>Permission note!</strong> To remove a collaboration group current user must have
93
+ * {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP} on the collaboration group page.
94
+ * </p>
95
+ * @param aCollaborationGroup a collaboration group to remove
96
+ * @return <code>true</code> if <code>aCollaborationGroup</code> was removed, i.e. collaboration group page was moved to trashcan, <code>false</code> otherwise.
97
+ * @since Sitevision 4.5.3
98
+ */
99
+ removeCollaborationGroup(aCollaborationGroup: Node): boolean;
100
100
  }
101
101
 
102
- export default collaborationGroupUtil;
102
+ declare namespace CollaborationGroupUtil {}
103
+
104
+ declare var collaborationGroupUtil: CollaborationGroupUtil;
105
+
106
+ export = collaborationGroupUtil;