@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,159 +1,149 @@
1
1
  /**
2
- * Formats a date according to the ISO8601 specification.
2
+ * Date utility interface.
3
3
  *
4
4
  * <p>
5
- * <em>An example:</em> A date representing february 3, 2001 at 04:45 in an +1h UTC timezone offset would be
6
- * ISO8601 formatted as <code>2001-02-03T04:05+01:00</code>.
5
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getDateUtil()}.
6
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
7
7
  * </p>
8
- * @param aDate a <code>Date</code> that needs to be formatted
9
- * @return the date formatted as a ISO8601 string, or <code>null</code> if <code>aDate</code> is <code>null</code>
8
+ * @author Albin Öhrn
9
+ * @since Sitevision 3.5
10
10
  */
11
- export function getDateAsISO8601String(aDate: unknown): string;
11
+ export interface DateUtil {
12
+ /**
13
+ * Formats a date according to the ISO8601 specification.
14
+ *
15
+ * <p>
16
+ * <em>An example:</em> A date representing february 3, 2001 at 04:45 in an +1h UTC timezone offset would be
17
+ * ISO8601 formatted as <code>2001-02-03T04:05+01:00</code>.
18
+ * </p>
19
+ * @param aDate a <code>Date</code> that needs to be formatted
20
+ * @return the date formatted as a ISO8601 string, or <code>null</code> if <code>aDate</code> is <code>null</code>
21
+ */
22
+ getDateAsISO8601String(aDate: unknown): string;
12
23
 
13
- /**
14
- * Formats a calendar according to the ISO8601 specification.
15
- *
16
- * <p>
17
- * <em>An example:</em> A calendar representing february 3, 2001 at 04:45 in an +1h UTC timezone offset would be
18
- * ISO8601 formatted as <code>2001-02-03T04:05+01:00</code>.
19
- * </p>
20
- * @param aCalendar a <code>Calendar</code> that needs to be formatted
21
- * @return aString the calendar date formatted as a ISO8601 string, or <code>null</code> if <code>aCalendar</code> is <code>null</code>
22
- */
23
- export function getCalendarAsISO8601String(aCalendar: unknown): string;
24
+ /**
25
+ * Formats a calendar according to the ISO8601 specification.
26
+ *
27
+ * <p>
28
+ * <em>An example:</em> A calendar representing february 3, 2001 at 04:45 in an +1h UTC timezone offset would be
29
+ * ISO8601 formatted as <code>2001-02-03T04:05+01:00</code>.
30
+ * </p>
31
+ * @param aCalendar a <code>Calendar</code> that needs to be formatted
32
+ * @return aString the calendar date formatted as a ISO8601 string, or <code>null</code> if <code>aCalendar</code> is <code>null</code>
33
+ */
34
+ getCalendarAsISO8601String(aCalendar: unknown): string;
24
35
 
25
- /**
26
- * Gets the date format pattern used in the Sitevision editor for a specific Locale.
27
- * @param aLocale the <code>Locale</code> that specifies the date format pattern
28
- * @return the date format pattern used in the Sitevision editor that corresponds to <code>aLocale</code>. If <code>aLocale</code> is <code>null</code> then the current locale (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}) is used to locate the format pattern. If no pattern exist for <code>aLocale</code> then the pattern that corresponds to <code>Locale.ENGLISH</code> will be returned.
29
- */
30
- export function getEditorFormatPattern(aLocale: unknown): string;
36
+ /**
37
+ * Gets the date format pattern used in the Sitevision editor for a specific Locale.
38
+ * @param aLocale the <code>Locale</code> that specifies the date format pattern
39
+ * @return the date format pattern used in the Sitevision editor that corresponds to <code>aLocale</code>. If <code>aLocale</code> is <code>null</code> then the current locale (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}) is used to locate the format pattern. If no pattern exist for <code>aLocale</code> then the pattern that corresponds to <code>Locale.ENGLISH</code> will be returned.
40
+ */
41
+ getEditorFormatPattern(aLocale: unknown): string;
31
42
 
32
- /**
33
- * Formats a Date according to a <code>SimpleDateFormat</code> pattern.
34
- *
35
- * <p>
36
- * <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
37
- * If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
38
- * </p>
39
- * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
40
- * @param aDate the Date
41
- * @return returns a String representation of aDate according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aDate is null
42
- * @see #getDateAsString(String, Date, Locale)
43
- */
44
- export function getDateAsString(aFormatPattern: string, aDate: unknown): string;
45
-
46
- /**
47
- * Formats a Date according to a <code>SimpleDateFormat</code> pattern using a given Locale.
48
- * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
49
- * @param aDate the Date
50
- * @param aLocale the Locale
51
- * @return returns a String representation of aDate according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aDate or aLocale is null
52
- * @since Sitevision 8.2
53
- */
54
- export function getDateAsString(
55
- aFormatPattern: string,
56
- aDate: unknown,
57
- aLocale: unknown
58
- ): string;
43
+ /**
44
+ * Formats a Date according to a <code>SimpleDateFormat</code> pattern.
45
+ *
46
+ * <p>
47
+ * <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
48
+ * If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
49
+ * </p>
50
+ * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
51
+ * @param aDate the Date
52
+ * @return returns a String representation of aDate according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aDate is null
53
+ * @see #getDateAsString(String, Date, Locale)
54
+ */
55
+ getDateAsString(aFormatPattern: string, aDate: unknown): string;
59
56
 
60
- /**
61
- * Formats the date of a Calendar according to a <code>SimpleDateFormat</code> pattern.
62
- *
63
- * <p>
64
- * <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
65
- * If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
66
- * </p>
67
- * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
68
- * @param aCalendar the Calendar
69
- * @return returns a String representation of aCalendar according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aCalendar is null
70
- * @see #getCalendarAsString(String, Calendar, Locale)
71
- */
72
- export function getCalendarAsString(
73
- aFormatPattern: string,
74
- aCalendar: unknown
75
- ): string;
57
+ /**
58
+ * Formats a Date according to a <code>SimpleDateFormat</code> pattern using a given Locale.
59
+ * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
60
+ * @param aDate the Date
61
+ * @param aLocale the Locale
62
+ * @return returns a String representation of aDate according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aDate or aLocale is null
63
+ * @since Sitevision 8.2
64
+ */
65
+ getDateAsString(
66
+ aFormatPattern: string,
67
+ aDate: unknown,
68
+ aLocale: unknown
69
+ ): string;
76
70
 
77
- /**
78
- * Formats the date of a Calendar according to a <code>SimpleDateFormat</code> pattern and a given Locale.
79
- * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
80
- * @param aCalendar the Calendar
81
- * @param aLocale the Locale
82
- * @return returns a String representation of aCalendar according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aCalendar or aLocale is null
83
- * @since Sitevision 8.2
84
- */
85
- export function getCalendarAsString(
86
- aFormatPattern: string,
87
- aCalendar: unknown,
88
- aLocale: unknown
89
- ): string;
71
+ /**
72
+ * Formats the date of a Calendar according to a <code>SimpleDateFormat</code> pattern.
73
+ *
74
+ * <p>
75
+ * <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
76
+ * If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
77
+ * </p>
78
+ * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
79
+ * @param aCalendar the Calendar
80
+ * @return returns a String representation of aCalendar according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aCalendar is null
81
+ * @see #getCalendarAsString(String, Calendar, Locale)
82
+ */
83
+ getCalendarAsString(aFormatPattern: string, aCalendar: unknown): string;
90
84
 
91
- /**
92
- * Converts a Date to a Calendar.
93
- * @param aDate a Date
94
- * @return a Calendar representing aDate, or null if aDate is null
95
- * @since Sitevision 4.5.5
96
- */
97
- export function toCalendar(aDate: unknown): unknown;
85
+ /**
86
+ * Formats the date of a Calendar according to a <code>SimpleDateFormat</code> pattern and a given Locale.
87
+ * @param aFormatPattern date to string pattern according to SimpleDateFormat. Default pattern will be used if aFormatPattern is null or blank
88
+ * @param aCalendar the Calendar
89
+ * @param aLocale the Locale
90
+ * @return returns a String representation of aCalendar according to aFormatPattern (and resolved Locale). Returns null if formatting fails or aCalendar or aLocale is null
91
+ * @since Sitevision 8.2
92
+ */
93
+ getCalendarAsString(
94
+ aFormatPattern: string,
95
+ aCalendar: unknown,
96
+ aLocale: unknown
97
+ ): string;
98
98
 
99
- /**
100
- * Converts a Calendar to a Date.
101
- * @param aCalendar a Calendar
102
- * @return a Date representing aCalendar, or null if aCalendar is null
103
- * @since Sitevision 4.5.5
104
- */
105
- export function toDate(aCalendar: unknown): unknown;
99
+ /**
100
+ * Converts a Date to a Calendar.
101
+ * @param aDate a Date
102
+ * @return a Calendar representing aDate, or null if aDate is null
103
+ * @since Sitevision 4.5.5
104
+ */
105
+ toCalendar(aDate: unknown): unknown;
106
106
 
107
- /**
108
- * Converts a date string to a Date using a <code>SimpleDateFormat</code> pattern.
109
- *
110
- * <p>
111
- * <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
112
- * If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
113
- * </p>
114
- * @param aDateStr the string representation of a Date
115
- * @param aFormatPattern string to date pattern according to SimpleDateFormat
116
- * @return a Date representation of aDateStr, or null if parsing fails or any method argument (aDateStr, aFormatPattern) is null or blank
117
- * @since Sitevision 5.1
118
- * @see #parseDate(String, String, Locale)
119
- */
120
- export function parseDate(aDateStr: string, aFormatPattern: string): unknown;
107
+ /**
108
+ * Converts a Calendar to a Date.
109
+ * @param aCalendar a Calendar
110
+ * @return a Date representing aCalendar, or null if aCalendar is null
111
+ * @since Sitevision 4.5.5
112
+ */
113
+ toDate(aCalendar: unknown): unknown;
121
114
 
122
- /**
123
- * Converts a date string to a Date using a <code>SimpleDateFormat</code> pattern and a given Locale.
124
- * @param aDateStr the string representation of a Date
125
- * @param aFormatPattern string to date pattern according to SimpleDateFormat
126
- * @param aLocale the Locale
127
- * @return a Date representation of aDateStr, or null if parsing fails or any method argument (aDateStr, aFormatPattern, aLocale) is null or blank
128
- * @since Sitevision 8.2
129
- */
130
- export function parseDate(
131
- aDateStr: string,
132
- aFormatPattern: string,
133
- aLocale: unknown
134
- ): unknown;
115
+ /**
116
+ * Converts a date string to a Date using a <code>SimpleDateFormat</code> pattern.
117
+ *
118
+ * <p>
119
+ * <em>Note!</em> The current locale as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()} will be used.
120
+ * If current locale is unavailable, <code>Locale.getDefault()</code> will be used.
121
+ * </p>
122
+ * @param aDateStr the string representation of a Date
123
+ * @param aFormatPattern string to date pattern according to SimpleDateFormat
124
+ * @return a Date representation of aDateStr, or null if parsing fails or any method argument (aDateStr, aFormatPattern) is null or blank
125
+ * @since Sitevision 5.1
126
+ * @see #parseDate(String, String, Locale)
127
+ */
128
+ parseDate(aDateStr: string, aFormatPattern: string): unknown;
135
129
 
136
- /**
137
- * Date utility interface.
138
- *
139
- * <p>
140
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getDateUtil()}.
141
- * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
142
- * </p>
143
- * @author Albin Öhrn
144
- * @since Sitevision 3.5
145
- */
146
- declare namespace dateUtil {
147
- export {
148
- getDateAsISO8601String,
149
- getCalendarAsISO8601String,
150
- getEditorFormatPattern,
151
- getDateAsString,
152
- getCalendarAsString,
153
- toCalendar,
154
- toDate,
155
- parseDate,
156
- };
130
+ /**
131
+ * Converts a date string to a Date using a <code>SimpleDateFormat</code> pattern and a given Locale.
132
+ * @param aDateStr the string representation of a Date
133
+ * @param aFormatPattern string to date pattern according to SimpleDateFormat
134
+ * @param aLocale the Locale
135
+ * @return a Date representation of aDateStr, or null if parsing fails or any method argument (aDateStr, aFormatPattern, aLocale) is null or blank
136
+ * @since Sitevision 8.2
137
+ */
138
+ parseDate(
139
+ aDateStr: string,
140
+ aFormatPattern: string,
141
+ aLocale: unknown
142
+ ): unknown;
157
143
  }
158
144
 
159
- export default dateUtil;
145
+ declare namespace DateUtil {}
146
+
147
+ declare var dateUtil: DateUtil;
148
+
149
+ export = dateUtil;
@@ -1,11 +1,4 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
2
-
3
- /**
4
- * Gets the decoration with a given name
5
- * @param aDecorationName the name of the decoration
6
- * @return the first decoration with name aDecorationName, or <code>null</code> if no decoration matches
7
- */
8
- export function getDecorationByName(aDecorationName: string): Node;
1
+ import type Node from "../../types/javax/jcr/Node";
9
2
 
10
3
  /**
11
4
  * Utility interface for Decorations.
@@ -16,8 +9,17 @@ export function getDecorationByName(aDecorationName: string): Node;
16
9
  * </p>
17
10
  * @author Magnus Lövgren
18
11
  */
19
- declare namespace decorationUtil {
20
- export { getDecorationByName };
12
+ export interface DecorationUtil {
13
+ /**
14
+ * Gets the decoration with a given name
15
+ * @param aDecorationName the name of the decoration
16
+ * @return the first decoration with name aDecorationName, or <code>null</code> if no decoration matches
17
+ */
18
+ getDecorationByName(aDecorationName: string): Node;
21
19
  }
22
20
 
23
- export default decorationUtil;
21
+ declare namespace DecorationUtil {}
22
+
23
+ declare var decorationUtil: DecorationUtil;
24
+
25
+ export = decorationUtil;
@@ -1,19 +1,4 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
2
-
3
- /**
4
- * Checks if current execution/rendering is in a mobile view.
5
- * @return <code>true</code> if current execution is rendering in a mobile view, <code>false</code> if not
6
- * @deprecated As of Sitevision 10 this method always returns <code>false</code>
7
- */
8
- export function isRenderingMobileView(): boolean;
9
-
10
- /**
11
- * Checks if currently executing client is a mobile device.
12
- * @param aPageNode a page node, typically the currently executing page (see {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentPage()}). Null is allowed but device checking will be more extensive with a proper value since it will also match against all configured devices for the site of the <code>aPageNode</code>.
13
- * @return <code>true</code> if currently executing client is a mobile device, <code>false</code> if not
14
- * @deprecated As of Sitevision 10 the parameter aPageNode is no longer used
15
- */
16
- export function isMobileDevice(aPageNode: Node): boolean;
1
+ import type Node from "../../types/javax/jcr/Node";
17
2
 
18
3
  /**
19
4
  * Device utility interface.
@@ -29,8 +14,25 @@ export function isMobileDevice(aPageNode: Node): boolean;
29
14
  * @author Magnus Lövgren
30
15
  * @since Sitevision 3.0
31
16
  */
32
- declare namespace deviceUtil {
33
- export { isRenderingMobileView, isMobileDevice };
17
+ export interface DeviceUtil {
18
+ /**
19
+ * Checks if current execution/rendering is in a mobile view.
20
+ * @return <code>true</code> if current execution is rendering in a mobile view, <code>false</code> if not
21
+ * @deprecated As of Sitevision 10 this method always returns <code>false</code>
22
+ */
23
+ isRenderingMobileView(): boolean;
24
+
25
+ /**
26
+ * Checks if currently executing client is a mobile device.
27
+ * @param aPageNode a page node, typically the currently executing page (see {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentPage()}). Null is allowed but device checking will be more extensive with a proper value since it will also match against all configured devices for the site of the <code>aPageNode</code>.
28
+ * @return <code>true</code> if currently executing client is a mobile device, <code>false</code> if not
29
+ * @deprecated As of Sitevision 10 the parameter aPageNode is no longer used
30
+ */
31
+ isMobileDevice(aPageNode: Node): boolean;
34
32
  }
35
33
 
36
- export default deviceUtil;
34
+ declare namespace DeviceUtil {}
35
+
36
+ declare var deviceUtil: DeviceUtil;
37
+
38
+ export = deviceUtil;
@@ -0,0 +1,17 @@
1
+ /**
2
+ * Dimension rendering mode, determines rendering of the <code>width/max-width</code> and <code>height/max-height</code> css properties.
3
+ *
4
+ * <p>
5
+ * The <code>max-width</code> and <code>max-height</code> css properties are used when rendering a responsive site.
6
+ * The <code>width</code> and <code>height</code> css properties are used when rendering a non-responsive site.
7
+ * </p>
8
+ * @author Magnus Lövgren
9
+ * @since Sitevision 5
10
+ */
11
+ declare enum DimensionMode {
12
+ AUTO,
13
+ ON,
14
+ OFF,
15
+ }
16
+
17
+ export default DimensionMode;
@@ -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
+ AUTO: 'AUTO',
9
+ ON: 'ON',
10
+ OFF: 'OFF'
11
+ };
12
+ exports["default"] = _default;
@@ -1,88 +1,5 @@
1
- import type { Node } from "../../types/javax/jcr/Node";
2
- import type { Property } from "../../types/javax/jcr/Property";
3
-
4
- /**
5
- * Searches for objects in all LDAP directories that are accessible in current context (i.e. current page).
6
- * <p>
7
- * Some examples of <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a> valid values for <code>aSearchFilter</code>:
8
- * <ul>
9
- * <li><code>"magnus"</code> - find all <em>magnus</em>, using the search base specified by the directories (usually common name) </li>
10
- * <li><code>"(cn=magnus)"</code> - find all with common name (cn) <em>magnus</em></li>
11
- * <li><code>"(cn=magnus*)"</code> - find all that has a common name (cn) that starts with <em>magnus</em></li>
12
- * <li><code>"(&amp;(cn=magnus)(mail=*))"</code> - find all that has a mail address and <em>magnus</em> as common name (cn)</li>
13
- * <li><code>"(|(cn=magnus)((sn=L*)))"</code> - find all with common name (cn) <em>magnus</em> or a surname (sn) that starts with <em>L</em></li>
14
- * </ul>
15
- * @param aSearchFilter LDAP search filter (as specified by <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a>)
16
- * @return the search result as a <code>List</code>. If there are no hits, an empty <code>List</code> is returned.
17
- * @see #search(String,Node)
18
- */
19
- export function search(aSearchFilter: string): unknown;
20
-
21
- /**
22
- * Searches for objects in a specified LDAP directory.
23
- * <p>
24
- * <em>Tip!</em> The repository for all LDAP directory nodes can be located via the
25
- * {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getDirectoryRepository() getDirectoryRepository()}
26
- * method in {@link senselogic.sitevision.api.resource.ResourceLocatorUtil}
27
- * </p>
28
- * @param aSearchFilter LDAP search filter (as specified by <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a>)
29
- * @param aDirectoryNode a LDAP directory <code>Node</code>
30
- * @return the search result as a <code>List</code>. If there are no hits, an empty <code>List</code> is returned.
31
- * @see #search(String)
32
- */
33
- export function search(aSearchFilter: string, aDirectoryNode: Node): unknown;
34
-
35
- /**
36
- * Searches for objects in a specified search base in a specified LDAP directory.
37
- * @param aSearchFilter LDAP search filter (as specified by <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a>)
38
- * @param aDirectoryNode a LDAP directory <code>Node</code>
39
- * @param aSearchBase a search base that exist in <code>aDirectoryNode</code>
40
- * @return the search result as a <code>List</code>. If there are no hits, an empty <code>List</code> is returned.
41
- * @see #search(String,Node)
42
- */
43
- export function search(
44
- aSearchFilter: string,
45
- aDirectoryNode: Node,
46
- aSearchBase: string
47
- ): unknown;
48
-
49
- /**
50
- * Gets a directory node object with a specific distinguished name, dn.
51
- * @param aDirectoryObjectDN the directory dn for a directory object
52
- * @return the directory object <code>Node</code>, or null if indeterminate
53
- */
54
- export function getNodeByDN(aDirectoryObjectDN: string): Node;
55
-
56
- /**
57
- * Gets a directory attribute value for a directory node object as <code>Property</code>.
58
- * <p>
59
- * The default properties for a directory node object adheres/corresponds to the attributes defined in the directory scheme.
60
- * All attributes that are defined in the scheme are exposed as properties in the Sitevision JCR model. This method tries to
61
- * find the attribute via the Sitevision JCR model but if no property can be found it executes LDAP queries
62
- * to find the attribute. This makes it possible to find scheme-defined attributes, but also custom-defined ones.
63
- * </p>
64
- * @param aDirectoryObjectNode a directory object node that has an attribute
65
- * @param anAttributeName the attribute name
66
- * @return the attribute value as <code>Property</code>, or <code>null</code> if indeterminate (e.g. <code>aDirectoryObjectNode</code> is not a directory object node or <code>aDirectoryObjectNode</code> has no attribute named <code>anAttributeName</code>)
67
- */
68
- export function getAttributeAsProperty(
69
- aDirectoryObjectNode: Node,
70
- anAttributeName: string
71
- ): Property;
72
-
73
- /**
74
- * Searches for ids in a specified search base in all directories.
75
- * @param aSearchFilter LDAP search filter (as specified by <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a>)
76
- * @param searchBase search base for the search, if <code>null</code> all directories for current node will be searched
77
- * @param attributes a <code>List</code> of return attributes
78
- * @return the search result as a <code>Map</code>. If there are no hits, an empty <code>Map</code> is returned. The <code>Map</code> contains ids as keys and a <code>Map</code> as values containing the returned attributes.
79
- * @since Sitevision 2.6.1_02
80
- */
81
- export function simpleSearch(
82
- aSearchFilter: string,
83
- searchBase: string,
84
- attributes: unknown
85
- ): unknown;
1
+ import type Node from "../../types/javax/jcr/Node";
2
+ import type Property from "../../types/javax/jcr/Property";
86
3
 
87
4
  /**
88
5
  * LDAP directory utility interface.
@@ -94,8 +11,93 @@ export function simpleSearch(
94
11
  * @author Magnus Lövgren
95
12
  * @since Sitevision 2.6
96
13
  */
97
- declare namespace directoryUtil {
98
- export { search, getNodeByDN, getAttributeAsProperty, simpleSearch };
14
+ export interface DirectoryUtil {
15
+ /**
16
+ * Searches for objects in all LDAP directories that are accessible in current context (i.e. current page).
17
+ * <p>
18
+ * Some examples of <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a> valid values for <code>aSearchFilter</code>:
19
+ * <ul>
20
+ * <li><code>"magnus"</code> - find all <em>magnus</em>, using the search base specified by the directories (usually common name) </li>
21
+ * <li><code>"(cn=magnus)"</code> - find all with common name (cn) <em>magnus</em></li>
22
+ * <li><code>"(cn=magnus*)"</code> - find all that has a common name (cn) that starts with <em>magnus</em></li>
23
+ * <li><code>"(&amp;(cn=magnus)(mail=*))"</code> - find all that has a mail address and <em>magnus</em> as common name (cn)</li>
24
+ * <li><code>"(|(cn=magnus)((sn=L*)))"</code> - find all with common name (cn) <em>magnus</em> or a surname (sn) that starts with <em>L</em></li>
25
+ * </ul>
26
+ * @param aSearchFilter LDAP search filter (as specified by <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a>)
27
+ * @return the search result as a <code>List</code>. If there are no hits, an empty <code>List</code> is returned.
28
+ * @see #search(String,Node)
29
+ */
30
+ search(aSearchFilter: string): unknown;
31
+
32
+ /**
33
+ * Searches for objects in a specified LDAP directory.
34
+ * <p>
35
+ * <em>Tip!</em> The repository for all LDAP directory nodes can be located via the
36
+ * {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getDirectoryRepository() getDirectoryRepository()}
37
+ * method in {@link senselogic.sitevision.api.resource.ResourceLocatorUtil}
38
+ * </p>
39
+ * @param aSearchFilter LDAP search filter (as specified by <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a>)
40
+ * @param aDirectoryNode a LDAP directory <code>Node</code>
41
+ * @return the search result as a <code>List</code>. If there are no hits, an empty <code>List</code> is returned.
42
+ * @see #search(String)
43
+ */
44
+ search(aSearchFilter: string, aDirectoryNode: Node): unknown;
45
+
46
+ /**
47
+ * Searches for objects in a specified search base in a specified LDAP directory.
48
+ * @param aSearchFilter LDAP search filter (as specified by <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a>)
49
+ * @param aDirectoryNode a LDAP directory <code>Node</code>
50
+ * @param aSearchBase a search base that exist in <code>aDirectoryNode</code>
51
+ * @return the search result as a <code>List</code>. If there are no hits, an empty <code>List</code> is returned.
52
+ * @see #search(String,Node)
53
+ */
54
+ search(
55
+ aSearchFilter: string,
56
+ aDirectoryNode: Node,
57
+ aSearchBase: string
58
+ ): unknown;
59
+
60
+ /**
61
+ * Gets a directory node object with a specific distinguished name, dn.
62
+ * @param aDirectoryObjectDN the directory dn for a directory object
63
+ * @return the directory object <code>Node</code>, or null if indeterminate
64
+ */
65
+ getNodeByDN(aDirectoryObjectDN: string): Node;
66
+
67
+ /**
68
+ * Gets a directory attribute value for a directory node object as <code>Property</code>.
69
+ * <p>
70
+ * The default properties for a directory node object adheres/corresponds to the attributes defined in the directory scheme.
71
+ * All attributes that are defined in the scheme are exposed as properties in the Sitevision JCR model. This method tries to
72
+ * find the attribute via the Sitevision JCR model but if no property can be found it executes LDAP queries
73
+ * to find the attribute. This makes it possible to find scheme-defined attributes, but also custom-defined ones.
74
+ * </p>
75
+ * @param aDirectoryObjectNode a directory object node that has an attribute
76
+ * @param anAttributeName the attribute name
77
+ * @return the attribute value as <code>Property</code>, or <code>null</code> if indeterminate (e.g. <code>aDirectoryObjectNode</code> is not a directory object node or <code>aDirectoryObjectNode</code> has no attribute named <code>anAttributeName</code>)
78
+ */
79
+ getAttributeAsProperty(
80
+ aDirectoryObjectNode: Node,
81
+ anAttributeName: string
82
+ ): Property;
83
+
84
+ /**
85
+ * Searches for ids in a specified search base in all directories.
86
+ * @param aSearchFilter LDAP search filter (as specified by <a href="http://www.ietf.org/rfc/rfc2254.txt">RFC 2254</a>)
87
+ * @param searchBase search base for the search, if <code>null</code> all directories for current node will be searched
88
+ * @param attributes a <code>List</code> of return attributes
89
+ * @return the search result as a <code>Map</code>. If there are no hits, an empty <code>Map</code> is returned. The <code>Map</code> contains ids as keys and a <code>Map</code> as values containing the returned attributes.
90
+ * @since Sitevision 2.6.1_02
91
+ */
92
+ simpleSearch(
93
+ aSearchFilter: string,
94
+ searchBase: string,
95
+ attributes: unknown
96
+ ): unknown;
99
97
  }
100
98
 
101
- export default directoryUtil;
99
+ declare namespace DirectoryUtil {}
100
+
101
+ declare var directoryUtil: DirectoryUtil;
102
+
103
+ export = directoryUtil;
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Defines doctypes rendered by Sitevision.
3
+ *
4
+ * <p>
5
+ * Example of how to get the {@link #HTML5} 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.webresource.doctype.DocType')
12
+ * #set ($html5Enum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'HTML5'))</code></pre>
13
+ * </li>
14
+ * <li>
15
+ * Using server-side <strong>JavaScript:</strong><pre><code>
16
+ * var html5Enum = require('DocType.HTML5');</code></pre>
17
+ * </li>
18
+ * </ul>
19
+ * @author Magnus Lövgren
20
+ * @since Sitevision 3.0
21
+ */
22
+ declare enum DocType {
23
+ NO_DOCTYPE,
24
+ HTML4_TRANSITIONAL,
25
+ XHTML1_TRANSITIONAL,
26
+ XHTML1_STRICT,
27
+ HTML5,
28
+ }
29
+
30
+ export default DocType;
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports["default"] = void 0;
7
+ var _default = {
8
+ NO_DOCTYPE: 'NO_DOCTYPE',
9
+ HTML4_TRANSITIONAL: 'HTML4_TRANSITIONAL',
10
+ XHTML1_TRANSITIONAL: 'XHTML1_TRANSITIONAL',
11
+ XHTML1_STRICT: 'XHTML1_STRICT',
12
+ HTML5: 'HTML5'
13
+ };
14
+ exports["default"] = _default;