@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
@@ -0,0 +1,54 @@
1
+ /**
2
+ * The named permission demarcation, used by {@link PermissionUtil}.
3
+ *
4
+ * <p>
5
+ * Example of how to get the {@link #READ} 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.security.PermissionUtil$Permission') <em>## Note the '$' separator...</em>
12
+ * #set ($readEnum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'READ'))</code></pre>
13
+ * </li>
14
+ * <li>
15
+ * Using server-side <strong>JavaScript:</strong><pre><code>
16
+ * var readEnum = require('PermissionUtil.Permission.READ');</code></pre>
17
+ * </li>
18
+ * </ul>
19
+ * @author Magnus Lövgren
20
+ * @since Sitevision 3.6
21
+ */
22
+ declare enum Permission {
23
+ READ,
24
+ WRITE,
25
+ MOVE_NODE,
26
+ PUBLISH,
27
+ REVIEW,
28
+ DELETE,
29
+ CREATE_ARCHIVE,
30
+ CREATE_COLLABORATION_GROUP,
31
+ CREATE_FOLDER,
32
+ CREATE_LAYOUT,
33
+ CREATE_PAGE,
34
+ CREATE_LINK_PAGE,
35
+ CREATE_CLOSED_COLLABORATION_GROUP,
36
+ MANAGE_COLLABORATION_GROUP,
37
+ MANAGE_SITE_PROPERTIES,
38
+ MANAGE_SUBSCRIPTION,
39
+ MANAGE_USER_IDENTITIES,
40
+ MODIFY_SEARCH_PRIORITY,
41
+ MANAGE_TRANSLATIONS,
42
+ MANAGE_ADDONS,
43
+ MANAGE_USERS,
44
+ MANAGE_RIGHTS,
45
+ DEVELOPER,
46
+ USE_COLLABORATION_GROUP,
47
+ MANAGE_TOPICS,
48
+ MANAGE_PUBLISHING_PROJECT,
49
+ MANAGE_DOWNLOAD_PROTECTION,
50
+ MANAGE_CHANNELS,
51
+ CREATE_PRIVATE_CHANNELS,
52
+ }
53
+
54
+ export default Permission;
@@ -0,0 +1,38 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _default = {
8
+ READ: 'READ',
9
+ WRITE: 'WRITE',
10
+ MOVE_NODE: 'MOVE_NODE',
11
+ PUBLISH: 'PUBLISH',
12
+ REVIEW: 'REVIEW',
13
+ DELETE: 'DELETE',
14
+ CREATE_ARCHIVE: 'CREATE_ARCHIVE',
15
+ CREATE_COLLABORATION_GROUP: 'CREATE_COLLABORATION_GROUP',
16
+ CREATE_FOLDER: 'CREATE_FOLDER',
17
+ CREATE_LAYOUT: 'CREATE_LAYOUT',
18
+ CREATE_PAGE: 'CREATE_PAGE',
19
+ CREATE_LINK_PAGE: 'CREATE_LINK_PAGE',
20
+ CREATE_CLOSED_COLLABORATION_GROUP: 'CREATE_CLOSED_COLLABORATION_GROUP',
21
+ MANAGE_COLLABORATION_GROUP: 'MANAGE_COLLABORATION_GROUP',
22
+ MANAGE_SITE_PROPERTIES: 'MANAGE_SITE_PROPERTIES',
23
+ MANAGE_SUBSCRIPTION: 'MANAGE_SUBSCRIPTION',
24
+ MANAGE_USER_IDENTITIES: 'MANAGE_USER_IDENTITIES',
25
+ MODIFY_SEARCH_PRIORITY: 'MODIFY_SEARCH_PRIORITY',
26
+ MANAGE_TRANSLATIONS: 'MANAGE_TRANSLATIONS',
27
+ MANAGE_ADDONS: 'MANAGE_ADDONS',
28
+ MANAGE_USERS: 'MANAGE_USERS',
29
+ MANAGE_RIGHTS: 'MANAGE_RIGHTS',
30
+ DEVELOPER: 'DEVELOPER',
31
+ USE_COLLABORATION_GROUP: 'USE_COLLABORATION_GROUP',
32
+ MANAGE_TOPICS: 'MANAGE_TOPICS',
33
+ MANAGE_PUBLISHING_PROJECT: 'MANAGE_PUBLISHING_PROJECT',
34
+ MANAGE_DOWNLOAD_PROTECTION: 'MANAGE_DOWNLOAD_PROTECTION',
35
+ MANAGE_CHANNELS: 'MANAGE_CHANNELS',
36
+ CREATE_PRIVATE_CHANNELS: 'CREATE_PRIVATE_CHANNELS'
37
+ };
38
+ exports["default"] = _default;
@@ -1,96 +1,6 @@
1
- import type { Node } from '../../types/javax/jcr/Node';
1
+ import type Node from "../../types/javax/jcr/Node";
2
2
 
3
- /**
4
- * Gets current page (i.e. the page node for the currently executing portlet).
5
- * @return current page <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet or current portlet is not bound to any page)
6
- */
7
- export function getCurrentPage(): Node;
8
-
9
- /**
10
- * Gets current portlet.
11
- * @return current portlet as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet)
12
- */
13
- export function getCurrentPortlet(): Node;
14
-
15
- /**
16
- * Gets current module element (module element draft or module element).
17
- * @return current module element as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a module element)
18
- * @since Sitevision 4.2
19
- */
20
- export function getCurrentModuleElement(): Node;
21
-
22
- /**
23
- * Gets current Locale.
24
- * @return current <code>Locale</code>, or default <code>Locale</code> if indeterminable
25
- * @see senselogic.sitevision.api.node.NodeResolverUtil#getLocaleResolver()
26
- */
27
- export function getCurrentLocale(): unknown;
28
-
29
- /**
30
- * Gets current user.
31
- * @return current user <code>Node</code>, or <code>null</code> if indeterminable
32
- * @since Sitevision 2.6
33
- */
34
- export function getCurrentUser(): Node;
35
-
36
- /**
37
- * Gets current user identity.
38
- * @return current user identity <code>Node</code>, or <code>null</code> if indeterminable
39
- * @since Sitevision 3.5
40
- */
41
- export function getCurrentUserIdentity(): Node;
42
-
43
- /**
44
- * Gets current decorated node (applicable during render of a sv:decorationTemplate).
45
- *
46
- * <p>
47
- * This method returns the "decorated" node (typically a sv:portlet or sv:layout) during render of a sv:decorationTemplate.
48
- * In other words - it returns the node that is decorated with the template-based decoration that is now rendering.
49
- * </p>
50
- * @return the decorated node or null if indeterminable (i.e. the caller is not a part of a decoration template that is being rendered right now)
51
- * @since Sitevision 5.1
52
- */
53
- export function getCurrentDecoratedNode(): Node;
54
-
55
- /**
56
- * Gets current version.
57
- * @return {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}, or {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
58
- * @since Sitevision 2.6
59
- * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#getCurrentVersion()}
60
- */
61
- export function getCurrentVersion(): number;
62
-
63
- /**
64
- * Gets a unique namespace for the specific portlet that is rendering.
65
- *
66
- * <p>
67
- * The namespace is based on the prefix (aPrefix) and the current portlet's id.
68
- * If you have two portlets of same type on the same page, the namespaces will differ. This can for instance be very useful when you
69
- * connect a &lt;label&gt; with an &lt;input&gt;. Example in Velocity:
70
- * </p>
71
- * <pre><code>
72
- * #set ($portletContextUtil = $sitevisionUtils.portletContextUtil)
73
- * ...
74
- * #set ($ns = $portletContextUtil.getPortletNamespace('name'))
75
- * &lt;label for="$ns"&gt;Name: &lt;/label&gt;&lt;input id="$ns" name="name" type="text" /&gt;</code></pre>
76
- * The namespace generated in the above example (i.e. <code>$ns</code>) could be something like: <code>name12_2b9561c511855e0ab91800015</code>
77
- * @param aPrefix the prefix for the namespace (ensure it only contains chars that are valid in an id value if you use it as such)
78
- * @return a unique prefixed namespace for current portlet, or aPrefix if indeterminable
79
- */
80
- export function getPortletNamespace(aPrefix: string): string;
81
-
82
- /**
83
- * Gets a unique nonce for this request.
84
- *
85
- * <p>
86
- * The nonce should be used for all client-side inline javascript (e.g. <code>&lt;script nonce="..."&gt; ... &lt;script&gt;</code>).
87
- * If not specified, the script might be blocked and ignored by the client/browser due to the content security policy settings of the page
88
- * (i.e. typically when the CSP has no "unsafe-inline" specified).
89
- * </p>
90
- * @return A unique identifier for this request.
91
- * @since Sitevision 2022.08.1
92
- */
93
- export function getNonce(): string;
3
+ import type PortletContextUtilConstants from "../../types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants";
94
4
 
95
5
  /**
96
6
  * Portlet context utility interface.
@@ -103,22 +13,117 @@ export function getNonce(): string;
103
13
  * An instance of the Sitevision class implementing this interface can be obtained via
104
14
  * {@link senselogic.sitevision.api.Utils#getPortletContextUtil()}.
105
15
  * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
106
- * </p>The offline version (i.e. the version used when editing in the Sitevision editor) markerThe online version (i.e. the published version that visitors can access) marker
16
+ * </p>
107
17
  * @author Magnus Lövgren
108
18
  */
109
- declare namespace portletContextUtil {
110
- export {
111
- getCurrentPage,
112
- getCurrentPortlet,
113
- getCurrentModuleElement,
114
- getCurrentLocale,
115
- getCurrentUser,
116
- getCurrentUserIdentity,
117
- getCurrentDecoratedNode,
118
- getCurrentVersion,
119
- getPortletNamespace,
120
- getNonce,
121
- };
19
+ export interface PortletContextUtil extends PortletContextUtilConstants {
20
+ /**
21
+ * The offline version (i.e. the version used when editing in the Sitevision editor) marker
22
+ * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}
23
+ */
24
+ OFFLINE_VERSION: 0;
25
+
26
+ /**
27
+ * The online version (i.e. the published version that visitors can access) marker
28
+ * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
29
+ */
30
+ ONLINE_VERSION: 1;
31
+
32
+ /**
33
+ * Gets current page (i.e. the page node for the currently executing portlet).
34
+ * @return current page <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet or current portlet is not bound to any page)
35
+ */
36
+ getCurrentPage(): Node;
37
+
38
+ /**
39
+ * Gets current portlet.
40
+ * @return current portlet as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet)
41
+ */
42
+ getCurrentPortlet(): Node;
43
+
44
+ /**
45
+ * Gets current module element (module element draft or module element).
46
+ * @return current module element as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a module element)
47
+ * @since Sitevision 4.2
48
+ */
49
+ getCurrentModuleElement(): Node;
50
+
51
+ /**
52
+ * Gets current Locale.
53
+ * @return current <code>Locale</code>, or default <code>Locale</code> if indeterminable
54
+ * @see senselogic.sitevision.api.node.NodeResolverUtil#getLocaleResolver()
55
+ */
56
+ getCurrentLocale(): unknown;
57
+
58
+ /**
59
+ * Gets current user.
60
+ * @return current user <code>Node</code>, or <code>null</code> if indeterminable
61
+ * @since Sitevision 2.6
62
+ */
63
+ getCurrentUser(): Node;
64
+
65
+ /**
66
+ * Gets current user identity.
67
+ * @return current user identity <code>Node</code>, or <code>null</code> if indeterminable
68
+ * @since Sitevision 3.5
69
+ */
70
+ getCurrentUserIdentity(): Node;
71
+
72
+ /**
73
+ * Gets current decorated node (applicable during render of a sv:decorationTemplate).
74
+ *
75
+ * <p>
76
+ * This method returns the "decorated" node (typically a sv:portlet or sv:layout) during render of a sv:decorationTemplate.
77
+ * In other words - it returns the node that is decorated with the template-based decoration that is now rendering.
78
+ * </p>
79
+ * @return the decorated node or null if indeterminable (i.e. the caller is not a part of a decoration template that is being rendered right now)
80
+ * @since Sitevision 5.1
81
+ */
82
+ getCurrentDecoratedNode(): Node;
83
+
84
+ /**
85
+ * Gets current version.
86
+ * @return {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}, or {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
87
+ * @since Sitevision 2.6
88
+ * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#getCurrentVersion()}
89
+ */
90
+ getCurrentVersion(): number;
91
+
92
+ /**
93
+ * Gets a unique namespace for the specific portlet that is rendering.
94
+ *
95
+ * <p>
96
+ * The namespace is based on the prefix (aPrefix) and the current portlet's id.
97
+ * If you have two portlets of same type on the same page, the namespaces will differ. This can for instance be very useful when you
98
+ * connect a &lt;label&gt; with an &lt;input&gt;. Example in Velocity:
99
+ * </p>
100
+ * <pre><code>
101
+ * #set ($portletContextUtil = $sitevisionUtils.portletContextUtil)
102
+ * ...
103
+ * #set ($ns = $portletContextUtil.getPortletNamespace('name'))
104
+ * &lt;label for="$ns"&gt;Name: &lt;/label&gt;&lt;input id="$ns" name="name" type="text" /&gt;</code></pre>
105
+ * The namespace generated in the above example (i.e. <code>$ns</code>) could be something like: <code>name12_2b9561c511855e0ab91800015</code>
106
+ * @param aPrefix the prefix for the namespace (ensure it only contains chars that are valid in an id value if you use it as such)
107
+ * @return a unique prefixed namespace for current portlet, or aPrefix if indeterminable
108
+ */
109
+ getPortletNamespace(aPrefix: string): string;
110
+
111
+ /**
112
+ * Gets a unique nonce for this request.
113
+ *
114
+ * <p>
115
+ * The nonce should be used for all client-side inline javascript (e.g. <code>&lt;script nonce="..."&gt; ... &lt;script&gt;</code>).
116
+ * If not specified, the script might be blocked and ignored by the client/browser due to the content security policy settings of the page
117
+ * (i.e. typically when the CSP has no "unsafe-inline" specified).
118
+ * </p>
119
+ * @return A unique identifier for this request.
120
+ * @since Sitevision 2022.08.1
121
+ */
122
+ getNonce(): string;
122
123
  }
123
124
 
124
- export default portletContextUtil;
125
+ declare namespace PortletContextUtil {}
126
+
127
+ declare var portletContextUtil: PortletContextUtil;
128
+
129
+ export = portletContextUtil;
@@ -1,22 +1,6 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
1
+ import type Node from "../../types/javax/jcr/Node";
2
2
 
3
- /**
4
- * <p>Extracts the user specific <code>PortletPreferences</code> for the specified portlet.
5
- * This method is a complement to the accessor provided by <code>PortletRequest.getPreferences</code>
6
- * which returns the <code>PortletPreferences</code> for the current user.</p>
7
- *
8
- * <p>Note that this method only returns the portlet preferences that are stored. Any
9
- * local modifications that has not yet been stored will be ignored.</p>
10
- * @param portlet The <code>Node</code> corresponding to a portlet
11
- * @param user The <code>Node</code> corresponding to a user
12
- * @param portletPreferencesType The preferences type <em>(for now, only {@link #PORTLET_PREFERENCES_TYPE_USER} is allowed)</em>
13
- * @return <code>PortletPreferences</code> that is effective for the provided user for the specified portlet
14
- */
15
- export function getPortletPreferences(
16
- portlet: Node,
17
- user: Node,
18
- portletPreferencesType: number
19
- ): unknown;
3
+ import type PortletUtilConstants from "../../types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants";
20
4
 
21
5
  /**
22
6
  * <p>Portlet utility interface.</p>
@@ -24,12 +8,38 @@ export function getPortletPreferences(
24
8
  * <p>
25
9
  * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getPortletUtil()}.
26
10
  * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
27
- * </p>The personal portlet preferences type.
11
+ * </p>
28
12
  * @author Mikael Wikblom
29
13
  * @since Sitevision 2.6_06
30
14
  */
31
- declare namespace portletUtil {
32
- export { getPortletPreferences };
15
+ export interface PortletUtil extends PortletUtilConstants {
16
+ /**
17
+ * The personal portlet preferences type.
18
+
19
+ */
20
+ PORTLET_PREFERENCES_TYPE_USER: 11;
21
+
22
+ /**
23
+ * <p>Extracts the user specific <code>PortletPreferences</code> for the specified portlet.
24
+ * This method is a complement to the accessor provided by <code>PortletRequest.getPreferences</code>
25
+ * which returns the <code>PortletPreferences</code> for the current user.</p>
26
+ *
27
+ * <p>Note that this method only returns the portlet preferences that are stored. Any
28
+ * local modifications that has not yet been stored will be ignored.</p>
29
+ * @param portlet The <code>Node</code> corresponding to a portlet
30
+ * @param user The <code>Node</code> corresponding to a user
31
+ * @param portletPreferencesType The preferences type <em>(for now, only {@link #PORTLET_PREFERENCES_TYPE_USER} is allowed)</em>
32
+ * @return <code>PortletPreferences</code> that is effective for the provided user for the specified portlet
33
+ */
34
+ getPortletPreferences(
35
+ portlet: Node,
36
+ user: Node,
37
+ portletPreferencesType: number
38
+ ): unknown;
33
39
  }
34
40
 
35
- export default portletUtil;
41
+ declare namespace PortletUtil {}
42
+
43
+ declare var portletUtil: PortletUtil;
44
+
45
+ export = portletUtil;
@@ -1,33 +1,4 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
2
-
3
- /**
4
- * Perform work during the login phase as a specified user.
5
- *
6
- * <p>
7
- * <strong>Note!</strong> This method should <em>only</em> be used during the login phase (i.e. in a JAAS login module).
8
- * Other usages will throw an <code>IllegalStateException</code>.
9
- * </p>
10
- * @param aUser the user
11
- * @param aAction a runnable containing the operations that is to be performed
12
- * @throws IllegalStateException if this method is not called during the login phase
13
- */
14
- export function doAsDuringLogin(aUser: Node, aAction: unknown): void;
15
-
16
- /**
17
- * Provides access to a virtual group wrapped as a JCR node given the group name.
18
- * @param aName the name of the virtual group, may not be null
19
- * @return the virtual group wrapped in a JCR node, or null if none exists
20
- * @since Sitevision 3.0
21
- */
22
- export function getVirtualGroupByName(aName: string): Node;
23
-
24
- /**
25
- * Provides access to virtual groups wrapped as a JCR node given the group name.
26
- * @param aNames a list of names, may not be null
27
- * @return a list of virtual groups wrapped in JCR nodes, or an empty list of none exists
28
- * @since Sitevision 3.0
29
- */
30
- export function getVirtualGroupsByName(aNames: unknown): unknown;
1
+ import type Node from "../../types/javax/jcr/Node";
31
2
 
32
3
  /**
33
4
  * <p>Principal utility interface.</p>
@@ -39,8 +10,39 @@ export function getVirtualGroupsByName(aNames: unknown): unknown;
39
10
  * @author Mikael Wikblom
40
11
  * @since Sitevision 2.6.1_06
41
12
  */
42
- declare namespace principalUtil {
43
- export { doAsDuringLogin, getVirtualGroupByName, getVirtualGroupsByName };
13
+ export interface PrincipalUtil {
14
+ /**
15
+ * Perform work during the login phase as a specified user.
16
+ *
17
+ * <p>
18
+ * <strong>Note!</strong> This method should <em>only</em> be used during the login phase (i.e. in a JAAS login module).
19
+ * Other usages will throw an <code>IllegalStateException</code>.
20
+ * </p>
21
+ * @param aUser the user
22
+ * @param aAction a runnable containing the operations that is to be performed
23
+ * @throws IllegalStateException if this method is not called during the login phase
24
+ */
25
+ doAsDuringLogin(aUser: Node, aAction: unknown): void;
26
+
27
+ /**
28
+ * Provides access to a virtual group wrapped as a JCR node given the group name.
29
+ * @param aName the name of the virtual group, may not be null
30
+ * @return the virtual group wrapped in a JCR node, or null if none exists
31
+ * @since Sitevision 3.0
32
+ */
33
+ getVirtualGroupByName(aName: string): Node;
34
+
35
+ /**
36
+ * Provides access to virtual groups wrapped as a JCR node given the group name.
37
+ * @param aNames a list of names, may not be null
38
+ * @return a list of virtual groups wrapped in JCR nodes, or an empty list of none exists
39
+ * @since Sitevision 3.0
40
+ */
41
+ getVirtualGroupsByName(aNames: unknown): unknown;
44
42
  }
45
43
 
46
- export default principalUtil;
44
+ declare namespace PrincipalUtil {}
45
+
46
+ declare var principalUtil: PrincipalUtil;
47
+
48
+ export = principalUtil;
@@ -1,76 +1,3 @@
1
- /**
2
- * Gets named properties from a given Node-resolvable object.
3
- *
4
- * <p>
5
- * <em>See code examples in the interface description above.</em>
6
- * </p>
7
- * @param aJcrNodeResolvable something that can be resolved as a Node. Typically a Node, a Node identifier or a relative URL of a Node (the URI property)
8
- * @param aPropertyNames the names of the properties of interest
9
- * @return the properties as a native Javascript object
10
- * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
11
- * @see #getEscaped(Object, String...)
12
- */
13
- export function get(
14
- aJcrNodeResolvable: unknown,
15
- aPropertyNames: string
16
- ): unknown;
17
-
18
- /**
19
- * Gets escaped named properties from a given Node-resolvable object.
20
- *
21
- * <p>
22
- * This method is equivalent with {@link #get(Object, String...)} except that all string values will be escaped.
23
- * </p>
24
- * @param aJcrNodeResolvable something that can be resolved as a Node. Typically a Node, a Node identifier or a relative URL of a Node (the URI property)
25
- * @param aPropertyNames the names of the properties of interest
26
- * @return the escaped properties as a native Javascript object
27
- * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
28
- * @since Sitevision 6.2
29
- */
30
- export function getEscaped(
31
- aJcrNodeResolvable: unknown,
32
- aPropertyNames: string
33
- ): unknown;
34
-
35
- /**
36
- * Processes an iterable object and returns an array of named properties for each Node-resolvable object that is iterated.
37
- *
38
- * <p>
39
- * This method is conceptually equivalent with the {@link #get(Object, String...) get} method but
40
- * the core functionality of this method is to process something that can be iterated in order to handle <em>multiple</em> nodes
41
- * and deliver properties for them as an array.
42
- * </p>
43
- *
44
- * <p>
45
- * <em>See code examples in the interface description above.</em>
46
- * </p>
47
- * @param aIterable something that can be resolved as a Node or something that can be iterated and contains objects that can be resolved as a Node. Typically an array, {@link javax.jcr.NodeIterator}, {@link senselogic.sitevision.api.search.SearchResult}, {@link java.util.Collection} or {@link senselogic.sitevision.api.base.FilterSplit} (the <em>accepted</em> nodes will be processed)
48
- * @param aPropertyNames the names of the properties of interest
49
- * @return a native Javascript array with properties
50
- * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
51
- * @see senselogic.sitevision.api.node.NodeIteratorUtil
52
- * @see #getArrayEscaped(Object, String...)
53
- * @since Sitevision 6.1
54
- */
55
- export function getArray(aIterable: unknown, aPropertyNames: string): unknown;
56
-
57
- /**
58
- * Processes an iterable object and returns an array of escaped named properties for each Node-resolvable object that is iterated.
59
- *
60
- * <p>
61
- * This method is equivalent with {@link #getArray(Object, String...)} except that all string values will be escaped.
62
- * </p>
63
- * @param aIterable something that can be resolved as a Node or something that can be iterated and contains objects that can be resolved as a Node. Typically an array, {@link javax.jcr.NodeIterator}, {@link senselogic.sitevision.api.search.SearchResult}, {@link java.util.Collection} or {@link senselogic.sitevision.api.base.FilterSplit} (the <em>accepted</em> nodes will be processed)
64
- * @param aPropertyNames the names of the properties of interest
65
- * @return a native Javascript array with escaped properties
66
- * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
67
- * @since Sitevision 6.2
68
- */
69
- export function getArrayEscaped(
70
- aIterable: unknown,
71
- aPropertyNames: string
72
- ): unknown;
73
-
74
1
  /**
75
2
  * Utility interface for getting multiple Node property values in server-side Javascript.
76
3
  *
@@ -169,8 +96,74 @@ export function getArrayEscaped(
169
96
  * @author Magnus Lövgren
170
97
  * @since Sitevision 4.5.2
171
98
  */
172
- declare namespace properties {
173
- export { get, getEscaped, getArray, getArrayEscaped };
99
+ export interface Properties {
100
+ /**
101
+ * Gets named properties from a given Node-resolvable object.
102
+ *
103
+ * <p>
104
+ * <em>See code examples in the interface description above.</em>
105
+ * </p>
106
+ * @param aJcrNodeResolvable something that can be resolved as a Node. Typically a Node, a Node identifier or a relative URL of a Node (the URI property)
107
+ * @param aPropertyNames the names of the properties of interest
108
+ * @return the properties as a native Javascript object
109
+ * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
110
+ * @see #getEscaped(Object, String...)
111
+ */
112
+ get(aJcrNodeResolvable: unknown, aPropertyNames: string): unknown;
113
+
114
+ /**
115
+ * Gets escaped named properties from a given Node-resolvable object.
116
+ *
117
+ * <p>
118
+ * This method is equivalent with {@link #get(Object, String...)} except that all string values will be escaped.
119
+ * </p>
120
+ * @param aJcrNodeResolvable something that can be resolved as a Node. Typically a Node, a Node identifier or a relative URL of a Node (the URI property)
121
+ * @param aPropertyNames the names of the properties of interest
122
+ * @return the escaped properties as a native Javascript object
123
+ * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
124
+ * @since Sitevision 6.2
125
+ */
126
+ getEscaped(aJcrNodeResolvable: unknown, aPropertyNames: string): unknown;
127
+
128
+ /**
129
+ * Processes an iterable object and returns an array of named properties for each Node-resolvable object that is iterated.
130
+ *
131
+ * <p>
132
+ * This method is conceptually equivalent with the {@link #get(Object, String...) get} method but
133
+ * the core functionality of this method is to process something that can be iterated in order to handle <em>multiple</em> nodes
134
+ * and deliver properties for them as an array.
135
+ * </p>
136
+ *
137
+ * <p>
138
+ * <em>See code examples in the interface description above.</em>
139
+ * </p>
140
+ * @param aIterable something that can be resolved as a Node or something that can be iterated and contains objects that can be resolved as a Node. Typically an array, {@link javax.jcr.NodeIterator}, {@link senselogic.sitevision.api.search.SearchResult}, {@link java.util.Collection} or {@link senselogic.sitevision.api.base.FilterSplit} (the <em>accepted</em> nodes will be processed)
141
+ * @param aPropertyNames the names of the properties of interest
142
+ * @return a native Javascript array with properties
143
+ * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
144
+ * @see senselogic.sitevision.api.node.NodeIteratorUtil
145
+ * @see #getArrayEscaped(Object, String...)
146
+ * @since Sitevision 6.1
147
+ */
148
+ getArray(aIterable: unknown, aPropertyNames: string): unknown;
149
+
150
+ /**
151
+ * Processes an iterable object and returns an array of escaped named properties for each Node-resolvable object that is iterated.
152
+ *
153
+ * <p>
154
+ * This method is equivalent with {@link #getArray(Object, String...)} except that all string values will be escaped.
155
+ * </p>
156
+ * @param aIterable something that can be resolved as a Node or something that can be iterated and contains objects that can be resolved as a Node. Typically an array, {@link javax.jcr.NodeIterator}, {@link senselogic.sitevision.api.search.SearchResult}, {@link java.util.Collection} or {@link senselogic.sitevision.api.base.FilterSplit} (the <em>accepted</em> nodes will be processed)
157
+ * @param aPropertyNames the names of the properties of interest
158
+ * @return a native Javascript array with escaped properties
159
+ * @throws Exception if the scripting engine fails to convert property values to a native Javascript object
160
+ * @since Sitevision 6.2
161
+ */
162
+ getArrayEscaped(aIterable: unknown, aPropertyNames: string): unknown;
174
163
  }
175
164
 
176
- export default properties;
165
+ declare namespace Properties {}
166
+
167
+ declare var properties: Properties;
168
+
169
+ export = properties;