@sitevision/api 2.0.0-alpha.1 → 2023.2.1-alpha.0

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 (280) hide show
  1. package/client/requester/index.d.ts +10 -8
  2. package/client/toasts/index.d.ts +7 -5
  3. package/common/app/index.d.ts +45 -46
  4. package/common/events/index.d.ts +30 -31
  5. package/common/i18n/index.d.ts +7 -5
  6. package/common/router/index.d.ts +72 -77
  7. package/common/security/index.d.ts +27 -21
  8. package/index.d.ts +8 -0
  9. package/package.json +1 -1
  10. package/server/AliasUtil/index.d.ts +11 -9
  11. package/server/ArchiveUtil/index.d.ts +43 -41
  12. package/server/ArraysInstance/index.d.ts +1666 -1807
  13. package/server/ArticleUtil/index.d.ts +292 -224
  14. package/server/AuthenticationUtil/index.d.ts +72 -84
  15. package/server/BookmarkUtil/index.d.ts +74 -79
  16. package/server/BuddyIconRenderer/index.d.ts +123 -131
  17. package/server/BuddyIconRenderer.BuddyIconSize/index.d.ts +41 -0
  18. package/server/BuddyIconRenderer.BuddyIconSize/index.js +25 -0
  19. package/server/ClientUtil/index.d.ts +10 -8
  20. package/server/CollaborationFactory/index.d.ts +37 -40
  21. package/server/CollaborationGroupFolderUtil/index.d.ts +28 -26
  22. package/server/CollaborationGroupState/index.d.ts +27 -0
  23. package/server/CollaborationGroupState/index.js +11 -0
  24. package/server/CollaborationGroupTemplateUtil/index.d.ts +46 -48
  25. package/server/CollaborationGroupType/index.d.ts +28 -0
  26. package/server/CollaborationGroupType/index.js +12 -0
  27. package/server/CollaborationGroupUtil/index.d.ts +84 -80
  28. package/server/CollectionsInstance/index.d.ts +641 -704
  29. package/server/ColorUtil/index.d.ts +34 -35
  30. package/server/CompoundAndFilterBuilder/index.d.ts +28 -26
  31. package/server/CompoundComparatorBuilder/index.d.ts +33 -31
  32. package/server/CompoundOrFilterBuilder/index.d.ts +28 -26
  33. package/server/ContentNodeUtil/index.d.ts +34 -32
  34. package/server/CurrencyFactory/index.d.ts +70 -68
  35. package/server/DateUtil/index.d.ts +131 -141
  36. package/server/DecorationUtil/index.d.ts +11 -9
  37. package/server/DeviceUtil/index.d.ts +19 -17
  38. package/server/DimensionMode/index.d.ts +17 -0
  39. package/server/DimensionMode/index.js +12 -0
  40. package/server/DirectoryUtil/index.d.ts +87 -85
  41. package/server/DocType/index.d.ts +30 -0
  42. package/server/DocType/index.js +14 -0
  43. package/server/DocTypeUtil/index.d.ts +127 -133
  44. package/server/EndecUtil/index.d.ts +329 -346
  45. package/server/ExtendedDismaxParserBuilder/index.d.ts +153 -167
  46. package/server/FileIconRenderer/index.d.ts +152 -171
  47. package/server/FileUtil/index.d.ts +272 -298
  48. package/server/FilterBuilder/index.d.ts +39 -37
  49. package/server/FolderUtil/index.d.ts +91 -92
  50. package/server/FontUtil/index.d.ts +34 -35
  51. package/server/FormatterBuilderFactory/index.d.ts +73 -81
  52. package/server/HighlightBuilder/index.d.ts +76 -83
  53. package/server/IconUtil/index.d.ts +25 -23
  54. package/server/ImageLinkRenderer/index.d.ts +35 -33
  55. package/server/ImageRenderer/index.d.ts +340 -376
  56. package/server/ImageUtil/index.d.ts +245 -263
  57. package/server/IndexUtil/index.d.ts +38 -35
  58. package/server/IndexUtil.IndexType/index.d.ts +29 -0
  59. package/server/IndexUtil.IndexType/index.js +13 -0
  60. package/server/IndexingUtil/index.d.ts +67 -45
  61. package/server/InstanceCreatorUtil/index.d.ts +423 -459
  62. package/server/InstanceTypeUtil/index.d.ts +167 -188
  63. package/server/JwtUtil/index.d.ts +129 -127
  64. package/server/LandingPageUtil/index.d.ts +82 -85
  65. package/server/LandingPageUtil/index.js +1 -0
  66. package/server/LinkPageUtil/index.d.ts +294 -248
  67. package/server/LinkRenderer/index.d.ts +649 -713
  68. package/server/LinkTargetBuilder/index.d.ts +65 -73
  69. package/server/LinkValueBuilder/index.d.ts +66 -73
  70. package/server/ListWrapper/index.d.ts +80 -89
  71. package/server/LocaleUtil/index.d.ts +381 -393
  72. package/server/LogUtil/index.d.ts +118 -127
  73. package/server/MailBuilder/index.d.ts +106 -121
  74. package/server/MailUtil/index.d.ts +58 -63
  75. package/server/MathInstance/index.d.ts +624 -656
  76. package/server/MessageDigesterFactory/index.d.ts +28 -26
  77. package/server/MetadataDefinitionUtil/index.d.ts +77 -81
  78. package/server/MetadataUtil/index.d.ts +321 -345
  79. package/server/MimeTypeUtil/index.d.ts +208 -214
  80. package/server/MonitorBuilder/index.d.ts +17 -17
  81. package/server/NodeComparatorUtil/index.d.ts +214 -224
  82. package/server/NodeFactoryUtil/index.d.ts +19 -17
  83. package/server/NodeFilterUtil/index.d.ts +651 -738
  84. package/server/NodeIteratorUtil/index.d.ts +209 -224
  85. package/server/NodeResolverUtil/index.d.ts +398 -404
  86. package/server/NodeTreeUtil/index.d.ts +211 -226
  87. package/server/NodeTypeUtil/index.d.ts +1430 -546
  88. package/server/OfflineVersionPropertyUtil/index.d.ts +6 -4
  89. package/server/OnlineVersionPropertyUtil/index.d.ts +6 -4
  90. package/server/OutputUtil/index.d.ts +384 -379
  91. package/server/PageUtil/index.d.ts +264 -186
  92. package/server/PermissionUtil/index.d.ts +391 -428
  93. package/server/PermissionUtil.Permission/index.d.ts +54 -0
  94. package/server/PermissionUtil.Permission/index.js +38 -0
  95. package/server/PortletContextUtil/index.d.ts +111 -106
  96. package/server/PortletUtil/index.d.ts +30 -20
  97. package/server/PrincipalUtil/index.d.ts +33 -31
  98. package/server/Properties/index.d.ts +68 -75
  99. package/server/PropertyUtil/index.d.ts +1419 -1461
  100. package/server/PublishingUtil/index.d.ts +246 -247
  101. package/server/QueryStringUtil/index.d.ts +403 -414
  102. package/server/RedirectUtil/index.d.ts +62 -66
  103. package/server/RelatedValueBuilder/index.d.ts +40 -38
  104. package/server/Requester/index.d.ts +123 -123
  105. package/server/ResourceLocatorUtil/index.d.ts +434 -474
  106. package/server/RestApi/index.d.ts +156 -136
  107. package/server/RestAppInvokerFactory/index.d.ts +25 -23
  108. package/server/RoleAssignmentBuilder/index.d.ts +35 -33
  109. package/server/RoleMatcherBuilder/index.d.ts +35 -33
  110. package/server/RoleUtil/index.d.ts +35 -37
  111. package/server/ScriptUtil/index.d.ts +457 -494
  112. package/server/SearchFactory/index.d.ts +102 -117
  113. package/server/SearchUtil/index.d.ts +73 -71
  114. package/server/SearcherBuilder/index.d.ts +107 -114
  115. package/server/Session/index.d.ts +251 -1093
  116. package/server/Session/index.js +1 -20
  117. package/server/SimpleUserUtil/index.d.ts +26 -27
  118. package/server/SiteCookieUtil/index.d.ts +150 -173
  119. package/server/SortBuilder/index.d.ts +24 -22
  120. package/server/SourceSetMode/index.d.ts +12 -0
  121. package/server/SourceSetMode/index.js +12 -0
  122. package/server/SpellCheckBuilder/index.d.ts +27 -27
  123. package/server/StandardParserBuilder/index.d.ts +33 -31
  124. package/server/StructureUtil/index.d.ts +83 -81
  125. package/server/SubscriberUtil/index.d.ts +58 -65
  126. package/server/SubscriptionUtil/index.d.ts +121 -128
  127. package/server/SystemUserUtil/index.d.ts +146 -144
  128. package/server/TagUtil/index.d.ts +113 -118
  129. package/server/TemplateUtil/index.d.ts +113 -118
  130. package/server/TemporaryFileNodeBuilder/index.d.ts +29 -27
  131. package/server/TemporaryNodeBuilder/index.d.ts +136 -174
  132. package/server/TextModuleRendererBuilder/index.d.ts +18 -16
  133. package/server/TimestampUtil/index.d.ts +102 -116
  134. package/server/TranslationUtil/index.d.ts +96 -102
  135. package/server/TrashcanUtil/index.d.ts +112 -115
  136. package/server/UserDataUtil/index.d.ts +108 -109
  137. package/server/UserFactory/index.d.ts +49 -56
  138. package/server/UserFieldRenderer/index.d.ts +118 -126
  139. package/server/UserIdentityUtil/index.d.ts +36 -34
  140. package/server/UserUtil/index.d.ts +30 -28
  141. package/server/Utils/index.d.ts +702 -791
  142. package/server/VelocityRenderer/index.d.ts +94 -92
  143. package/server/VersionUtil/index.d.ts +24 -8
  144. package/server/WebContentUtil/index.d.ts +275 -282
  145. package/server/WebResourceFactory/index.d.ts +46 -51
  146. package/server/XSLTUtil/index.d.ts +33 -31
  147. package/server/XmlParserUtil/index.d.ts +47 -45
  148. package/server/appData/index.d.ts +8 -6
  149. package/server/appInfo/index.d.ts +6 -2
  150. package/server/appResource/index.d.ts +23 -21
  151. package/server/cache/index.d.ts +8 -6
  152. package/server/globalAppData/index.d.ts +8 -6
  153. package/server/headless/index.d.ts +28 -26
  154. package/server/hooks/index.d.ts +9 -9
  155. package/server/oauth2/index.d.ts +12 -10
  156. package/server/privileged/index.d.ts +24 -22
  157. package/server/storage/index.d.ts +22 -20
  158. package/types/javax/jcr/Binary/index.d.ts +0 -20
  159. package/types/javax/jcr/Binary/index.js +0 -1
  160. package/types/javax/jcr/ImportUUIDBehavior/index.d.ts +24 -0
  161. package/types/javax/jcr/Item/index.d.ts +1 -116
  162. package/types/javax/jcr/Item/index.js +0 -6
  163. package/types/javax/jcr/NamespaceRegistry/index.d.ts +66 -42
  164. package/types/javax/jcr/NamespaceRegistry/index.js +0 -2
  165. package/types/javax/jcr/Node/index.d.ts +24 -1495
  166. package/types/javax/jcr/Node/index.js +1 -34
  167. package/types/javax/jcr/NodeIterator/index.d.ts +1 -1
  168. package/types/javax/jcr/Property/index.d.ts +487 -489
  169. package/types/javax/jcr/Property/index.js +0 -5
  170. package/types/javax/jcr/PropertyIterator/index.d.ts +1 -1
  171. package/types/javax/jcr/RangeIterator/index.d.ts +1 -43
  172. package/types/javax/jcr/RangeIterator/index.js +1 -5
  173. package/types/javax/jcr/Repository/index.d.ts +460 -260
  174. package/types/javax/jcr/Repository/index.js +0 -4
  175. package/types/javax/jcr/Value/index.d.ts +0 -29
  176. package/types/javax/jcr/Value/index.js +0 -2
  177. package/types/javax/jcr/ValueFactory/index.d.ts +0 -70
  178. package/types/javax/jcr/ValueFactory/index.js +1 -2
  179. package/types/javax/jcr/Workspace/index.d.ts +93 -569
  180. package/types/javax/jcr/Workspace/index.js +1 -12
  181. package/types/javax/jcr/nodetype/ItemDefinition/index.d.ts +0 -103
  182. package/types/javax/jcr/nodetype/ItemDefinition/index.js +0 -5
  183. package/types/javax/jcr/nodetype/NodeDefinition/index.d.ts +1 -1
  184. package/types/javax/jcr/nodetype/NodeDefinitionTemplate/index.d.ts +1 -1
  185. package/types/javax/jcr/nodetype/NodeType/index.d.ts +255 -264
  186. package/types/javax/jcr/nodetype/NodeType/index.js +1 -12
  187. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.d.ts +0 -104
  188. package/types/javax/jcr/nodetype/NodeTypeDefinition/index.js +1 -7
  189. package/types/javax/jcr/nodetype/NodeTypeIterator/index.d.ts +1 -1
  190. package/types/javax/jcr/nodetype/NodeTypeManager/index.d.ts +0 -123
  191. package/types/javax/jcr/nodetype/NodeTypeManager/index.js +1 -8
  192. package/types/javax/jcr/nodetype/NodeTypeTemplate/index.d.ts +1 -1
  193. package/types/javax/jcr/nodetype/PropertyDefinition/index.d.ts +1 -270
  194. package/types/javax/jcr/nodetype/PropertyDefinition/index.js +1 -7
  195. package/types/javax/jcr/nodetype/PropertyDefinitionTemplate/index.d.ts +1 -1
  196. package/types/javax/jcr/observation/Event/index.d.ts +82 -41
  197. package/types/javax/jcr/observation/EventIterator/index.d.ts +1 -1
  198. package/types/javax/jcr/observation/EventJournal/index.d.ts +1 -1
  199. package/types/javax/jcr/observation/EventListenerIterator/index.d.ts +1 -1
  200. package/types/javax/jcr/query/Query/index.d.ts +29 -8
  201. package/types/javax/jcr/query/RowIterator/index.d.ts +1 -1
  202. package/types/javax/jcr/query/qom/And/index.d.ts +1 -1
  203. package/types/javax/jcr/query/qom/BindVariableValue/index.d.ts +1 -1
  204. package/types/javax/jcr/query/qom/ChildNode/index.d.ts +1 -1
  205. package/types/javax/jcr/query/qom/ChildNodeJoinCondition/index.d.ts +1 -1
  206. package/types/javax/jcr/query/qom/Comparison/index.d.ts +1 -1
  207. package/types/javax/jcr/query/qom/DescendantNode/index.d.ts +1 -1
  208. package/types/javax/jcr/query/qom/DescendantNodeJoinCondition/index.d.ts +1 -1
  209. package/types/javax/jcr/query/qom/DynamicOperand/index.d.ts +1 -1
  210. package/types/javax/jcr/query/qom/EquiJoinCondition/index.d.ts +1 -1
  211. package/types/javax/jcr/query/qom/FullTextSearch/index.d.ts +1 -1
  212. package/types/javax/jcr/query/qom/FullTextSearchScore/index.d.ts +1 -1
  213. package/types/javax/jcr/query/qom/Join/index.d.ts +1 -1
  214. package/types/javax/jcr/query/qom/Length/index.d.ts +1 -1
  215. package/types/javax/jcr/query/qom/Literal/index.d.ts +1 -1
  216. package/types/javax/jcr/query/qom/LowerCase/index.d.ts +1 -1
  217. package/types/javax/jcr/query/qom/NodeLocalName/index.d.ts +1 -1
  218. package/types/javax/jcr/query/qom/NodeName/index.d.ts +1 -1
  219. package/types/javax/jcr/query/qom/Not/index.d.ts +1 -1
  220. package/types/javax/jcr/query/qom/Or/index.d.ts +1 -1
  221. package/types/javax/jcr/query/qom/PropertyExistence/index.d.ts +1 -1
  222. package/types/javax/jcr/query/qom/PropertyValue/index.d.ts +1 -1
  223. package/types/javax/jcr/query/qom/QueryObjectModel/index.d.ts +1 -1
  224. package/types/javax/jcr/query/qom/QueryObjectModelConstants/index.d.ts +73 -1
  225. package/types/javax/jcr/query/qom/QueryObjectModelFactory/index.d.ts +1 -1
  226. package/types/javax/jcr/query/qom/SameNode/index.d.ts +1 -1
  227. package/types/javax/jcr/query/qom/SameNodeJoinCondition/index.d.ts +1 -1
  228. package/types/javax/jcr/query/qom/Selector/index.d.ts +1 -1
  229. package/types/javax/jcr/query/qom/StaticOperand/index.d.ts +1 -1
  230. package/types/javax/jcr/query/qom/UpperCase/index.d.ts +1 -1
  231. package/types/javax/jcr/security/AccessControlList/index.d.ts +1 -1
  232. package/types/javax/jcr/security/AccessControlPolicyIterator/index.d.ts +1 -1
  233. package/types/javax/jcr/security/NamedAccessControlPolicy/index.d.ts +1 -1
  234. package/types/javax/jcr/security/Privilege/index.d.ts +127 -43
  235. package/types/javax/jcr/version/Version/index.d.ts +1 -1
  236. package/types/javax/jcr/version/VersionHistory/index.d.ts +1 -1
  237. package/types/javax/jcr/version/VersionIterator/index.d.ts +1 -1
  238. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.d.ts +9 -0
  239. package/types/senselogic/sitevision/api/base/Requireable/ScriptEngine/index.js +11 -0
  240. package/types/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts +9 -5
  241. package/types/senselogic/sitevision/api/format/NumericFormatterBuilder/index.d.ts +1 -1
  242. package/types/senselogic/sitevision/api/link/CustomLinkProcessor/index.d.ts +1 -1
  243. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.d.ts +49 -0
  244. package/types/senselogic/sitevision/api/render/BuddyIconRenderer.BuddyIconInfo/index.js +12 -0
  245. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.d.ts +83 -0
  246. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ArticleUtilConstants/index.js +21 -0
  247. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.d.ts +29 -0
  248. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.ExceptionSuppressingProxyConstants/index.js +12 -0
  249. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.d.ts +29 -0
  250. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.IndexingUtilConstants/index.js +12 -0
  251. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.d.ts +65 -0
  252. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.LinkPageUtilConstants/index.js +18 -0
  253. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.d.ts +23 -0
  254. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MathInstanceConstants/index.js +11 -0
  255. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.d.ts +17 -0
  256. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants/index.js +10 -0
  257. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.d.ts +1241 -0
  258. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.NodeTypeUtilConstants/index.js +189 -0
  259. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.d.ts +29 -0
  260. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.OutputUtilConstants/index.js +12 -0
  261. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.d.ts +89 -0
  262. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PageUtilConstants/index.js +22 -0
  263. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.d.ts +25 -0
  264. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletContextUtilConstants/index.js +11 -0
  265. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.d.ts +17 -0
  266. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.PortletUtilConstants/index.js +10 -0
  267. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.d.ts +17 -0
  268. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.QueryStringUtilConstants/index.js +10 -0
  269. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.d.ts +23 -0
  270. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchHitConstants/index.js +11 -0
  271. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.d.ts +35 -0
  272. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.SearchResultConstants/index.js +13 -0
  273. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.d.ts +23 -0
  274. package/types/senselogic/sitevision/api/render/velocity/VelocityAccess.VersionUtilConstants/index.js +11 -0
  275. package/types/senselogic/sitevision/api/script/RequesterChainable/index.d.ts +2 -2
  276. package/types/senselogic/sitevision/api/script/proxy/ExceptionSuppressingProxy/index.d.ts +22 -2
  277. package/types/senselogic/sitevision/api/search/SearchHit/index.d.ts +16 -2
  278. package/types/senselogic/sitevision/api/search/SearchResult/index.d.ts +28 -6
  279. package/types/senselogic/sitevision/api/security/jaas/filter/AuthenticationFilter/index.d.ts +31 -1
  280. package/types/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts +1 -1
@@ -1,233 +1,227 @@
1
- /**
2
- * Returns the MIME type appropriate for a specified file extension.
3
- * @param aFileExtensionExpression a file extension (e.g <em>pdf</em>) or an expression that ends with a period and a file extension (e.g <em>myfile.pdf</em> or <em>http://www.xyz.com/files/myfile.pdf</em>). Case insensitive.
4
- * @return a MIME type that matches the extension in <code>aFileExtensionExpression</code>, or <code>null</code> if extension is unknown
5
- * @see #getMimeType(String, String)
6
- */
7
- export function getMimeType(aFileExtensionExpression: string): string;
8
-
9
- /**
10
- * Returns the MIME type (or a fallback MIME type) appropriate for a specified file extension.
11
- * @param aFileExtensionExpression a file extension (e.g <em>pdf</em>) or an expression that ends with a period and a file extension (e.g <em>myfile.pdf</em> or <em>http://www.xyz.com/files/myfile.pdf</em>). Case insensitive.
12
- * @param aFallbackMimeType the fallback MIME type to return if no MIME type can be found for <code>aFileExtensionExpression</code>
13
- * @return a MIME type that matches the extension in <code>aFileExtensionExpression</code>, or <code>aFallbackMimeType</code> if extension is unknown
14
- */
15
- export function getMimeType(
16
- aFileExtensionExpression: string,
17
- aFallbackMimeType: string
18
- ): string;
19
-
20
- /**
21
- * Returns the file extension for a specified MIME type.
22
- * @param aMimeType a MIME type. Case insensitive.
23
- * @return the lowercased default file extension for MIME type <code>aMimeType</code>, or <code>null</code> if <code>aMimeType</code> is unknown or has no single well-known extension (e.g. <em>application/octet-stream</em> or <em>text/plain</em>)
24
- * @see #getExtension(String, String)
25
- */
26
- export function getExtension(aMimeType: string): string;
27
-
28
- /**
29
- * Returns the file extension (or a fallback extension) for a specified MIME type.
30
- * @param aMimeType a MIME type. Case insensitive.
31
- * @param aFallbackExtension the fallback extension to return if no extension can be found for <code>aMimeType</code>
32
- * @return the lowercased default file extension for MIME type <code>aMimeType</code>, or <code>aFallbackExtension</code> if <code>aMimeType</code> is unknown or has no single well-known extension (e.g. <em>application/octet-stream</em> or <em>text/plain</em>)
33
- */
34
- export function getExtension(
35
- aMimeType: string,
36
- aFallbackExtension: string
37
- ): string;
1
+ import type { MimeTypeUtilConstants } from "../../types/senselogic/sitevision/api/render/velocity/VelocityAccess.MimeTypeUtilConstants";
38
2
 
39
3
  /**
40
- * Checks if a specified file extension is an image type (according to its mapped MIME type).
4
+ * A utility that determines an appropriate MIME type for a file extension or vice versa.
41
5
  *
42
6
  * <p>
43
- * <em>An image type has a MIME that starts with <code>image/</code></em>.
7
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getMimeTypeUtil()}.
8
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
44
9
  * </p>
45
- * @param aFileExtensionExpression a file extension (e.g <em>png</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.png</em> or <em>http://www.xyz.com/files/myresource.png</em>). Case insensitive.
46
- * @return true if <code>aFileExtensionExpression</code> is mapped to a <code>image/*</code> MIME type, false otherwise
47
- * @since Sitevision 4.0
10
+ * @author Magnus Lövgren
11
+ * @since Sitevision 3.0
48
12
  */
49
- export function isImageType(aFileExtensionExpression: string): boolean;
50
-
51
- /**
52
- * Checks if a specified file extension is a text type (according to its mapped MIME type).
13
+ export interface MimeTypeUtil extends MimeTypeUtilConstants {
14
+ /**
15
+ * The generic <code>application/octet-stream</code> MIME type.
53
16
  *
54
- * <p>
55
- * <em>A text type has a MIME that starts with "<code>text/</code>"</em>.
56
- * </p>
57
- * @param aFileExtensionExpression a file extension (e.g <em>txt</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.txt</em> or <em>http://www.xyz.com/files/myresource.txt</em>). Case insensitive.
58
- * @return true if <code>aFileExtensionExpression</code> is mapped to a <code>text/*</code> MIME type, false otherwise
59
- * @since Sitevision 4.1
60
- */
61
- export function isTextType(aFileExtensionExpression: string): boolean;
17
+ * <p><em>Would typically be appropriate to use as value for the fallback MIME type when using the
18
+ * {@link #getMimeType(String, String)} whenever you require an acceptable, non-null MIME type to be returned.</em></p>
19
+ * <pre><code> String mime = aMimeTypeUtil.getMimeType(anExtension, MimeTypeUtil.GENERIC_MIME_TYPE);</code></pre>
20
+
21
+ */
22
+ GENERIC_MIME_TYPE: "application/octet-stream";
62
23
 
63
- /**
64
- * Checks if a specified file extension is a text type (according to its mapped MIME type).
65
- *
66
- * <p>
67
- * <em>
68
- * A XML type typically has a MIME that starts with "<code>application/</code>" and ends with "<code>xml</code>".
69
- * This method will not include xml-based files covered by other categories (e.g. "office" types or the "svg" image type).
70
- * </em>
71
- * </p>
72
- * @param aFileExtensionExpression a file extension (e.g <em>xml</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.xml</em> or <em>http://www.xyz.com/files/myresource.xml</em>). Case insensitive.
73
- * @return true if <code>aFileExtensionExpression</code> is mapped to a <code>application/*xml</code> MIME type, false otherwise
74
- * @since Sitevision 4.1
75
- */
76
- export function isXmlType(aFileExtensionExpression: string): boolean;
24
+ /**
25
+ * Returns the MIME type appropriate for a specified file extension.
26
+ * @param aFileExtensionExpression a file extension (e.g <em>pdf</em>) or an expression that ends with a period and a file extension (e.g <em>myfile.pdf</em> or <em>http://www.xyz.com/files/myfile.pdf</em>). Case insensitive.
27
+ * @return a MIME type that matches the extension in <code>aFileExtensionExpression</code>, or <code>null</code> if extension is unknown
28
+ * @see #getMimeType(String, String)
29
+ */
30
+ getMimeType(aFileExtensionExpression: string): string;
77
31
 
78
- /**
79
- * Checks if a specified file extension is a video type (according to its mapped MIME type).
80
- *
81
- * <p>
82
- * <em>A video type has a MIME that starts with "<code>video/</code>"</em>.
83
- * </p>
84
- * @param aFileExtensionExpression a file extension (e.g <em>mov</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.mov</em> or <em>http://www.xyz.com/files/myresource.mov</em>). Case insensitive.
85
- * @return true if <code>aFileExtensionExpression</code> is mapped to a <code>video/*</code> MIME type, false otherwise
86
- * @since Sitevision 4.1
87
- */
88
- export function isVideoType(aFileExtensionExpression: string): boolean;
32
+ /**
33
+ * Returns the MIME type (or a fallback MIME type) appropriate for a specified file extension.
34
+ * @param aFileExtensionExpression a file extension (e.g <em>pdf</em>) or an expression that ends with a period and a file extension (e.g <em>myfile.pdf</em> or <em>http://www.xyz.com/files/myfile.pdf</em>). Case insensitive.
35
+ * @param aFallbackMimeType the fallback MIME type to return if no MIME type can be found for <code>aFileExtensionExpression</code>
36
+ * @return a MIME type that matches the extension in <code>aFileExtensionExpression</code>, or <code>aFallbackMimeType</code> if extension is unknown
37
+ */
38
+ getMimeType(
39
+ aFileExtensionExpression: string,
40
+ aFallbackMimeType: string
41
+ ): string;
89
42
 
90
- /**
91
- * Checks if a specified file extension is a compressed/archive type (according to its mapped MIME type).
92
- *
93
- * <p>
94
- * Example of compressed MIME types:
95
- * </p>
96
- * <ul>
97
- * <li>application/zip</li>
98
- * <li>application/x-gzip</li>
99
- * <li>application/x-bzip</li>
100
- * <li>application/x-rar-compressed</li>
101
- * <li>application/x-lzh-compressed</li>
102
- * <li>application/x-7z-compressed</li>
103
- * <li>application/x-tar</li>
104
- * <li>application/vnd.ms-cab-compressed</li>
105
- * <li>application/java-archive</li>
106
- * </ul>
107
- * @param aFileExtensionExpression a file extension (e.g <em>zip</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.zip</em> or <em>http://www.xyz.com/files/myresource.zip</em>). Case insensitive.
108
- * @return true if <code>aFileExtensionExpression</code> is mapped to a MIME type that is registered as compressed, false otherwise
109
- * @since Sitevision 4.1
110
- */
111
- export function isCompressedType(aFileExtensionExpression: string): boolean;
43
+ /**
44
+ * Returns the file extension for a specified MIME type.
45
+ * @param aMimeType a MIME type. Case insensitive.
46
+ * @return the lowercased default file extension for MIME type <code>aMimeType</code>, or <code>null</code> if <code>aMimeType</code> is unknown or has no single well-known extension (e.g. <em>application/octet-stream</em> or <em>text/plain</em>)
47
+ * @see #getExtension(String, String)
48
+ */
49
+ getExtension(aMimeType: string): string;
112
50
 
113
- /**
114
- * Checks if a specified file extension is a MS Word type (according to its mapped MIME type).
115
- *
116
- * <p>
117
- * Example of typical MS Word MIME types:
118
- * </p>
119
- * <ul>
120
- * <li>application/vnd.ms-word</li>
121
- * <li>application/vnd.openxmlformats-officedocument.wordprocessingml.document</li>
122
- * <li>application/vnd.openxmlformats-officedocument.wordprocessingml.template</li>
123
- * </ul>
124
- * @param aFileExtensionExpression a file extension (e.g <em>doc</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.doc</em> or <em>http://www.xyz.com/files/myresource.doc</em>). Case insensitive.
125
- * @return true if <code>aFileExtensionExpression</code> is mapped to a MS Word MIME type, false otherwise
126
- * @since Sitevision 4.1
127
- */
128
- export function isMSWordType(aFileExtensionExpression: string): boolean;
51
+ /**
52
+ * Returns the file extension (or a fallback extension) for a specified MIME type.
53
+ * @param aMimeType a MIME type. Case insensitive.
54
+ * @param aFallbackExtension the fallback extension to return if no extension can be found for <code>aMimeType</code>
55
+ * @return the lowercased default file extension for MIME type <code>aMimeType</code>, or <code>aFallbackExtension</code> if <code>aMimeType</code> is unknown or has no single well-known extension (e.g. <em>application/octet-stream</em> or <em>text/plain</em>)
56
+ */
57
+ getExtension(aMimeType: string, aFallbackExtension: string): string;
129
58
 
130
- /**
131
- * Checks if a specified file extension is a MS Excel type (according to its mapped MIME type).
132
- *
133
- * <p>
134
- * Example of typical MS Excel MIME types:
135
- * </p>
136
- * <ul>
137
- * <li>application/vnd.ms-excel</li>
138
- * <li>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</li>
139
- * <li>application/vnd.openxmlformats-officedocument.spreadsheetml.template</li>
140
- * </ul>
141
- * @param aFileExtensionExpression a file extension (e.g <em>xls</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.xls</em> or <em>http://www.xyz.com/files/myresource.xls</em>). Case insensitive.
142
- * @return true if <code>aFileExtensionExpression</code> is mapped to a MS Excel MIME type, false otherwise
143
- * @since Sitevision 4.1
144
- */
145
- export function isMSExcelType(aFileExtensionExpression: string): boolean;
59
+ /**
60
+ * Checks if a specified file extension is an image type (according to its mapped MIME type).
61
+ *
62
+ * <p>
63
+ * <em>An image type has a MIME that starts with <code>image/</code></em>.
64
+ * </p>
65
+ * @param aFileExtensionExpression a file extension (e.g <em>png</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.png</em> or <em>http://www.xyz.com/files/myresource.png</em>). Case insensitive.
66
+ * @return true if <code>aFileExtensionExpression</code> is mapped to a <code>image/*</code> MIME type, false otherwise
67
+ * @since Sitevision 4.0
68
+ */
69
+ isImageType(aFileExtensionExpression: string): boolean;
146
70
 
147
- /**
148
- * Checks if a specified file extension is a MS Powerpoint type (according to its mapped MIME type).
149
- *
150
- * <p>
151
- * Example of typical MS Powerpoint MIME types:
152
- * </p>
153
- * <ul>
154
- * <li>application/vnd.ms-powerpoint</li>
155
- * <li>application/vnd.openxmlformats-officedocument.presentationml.presentation</li>
156
- * <li>application/vnd.openxmlformats-officedocument.presentationml.template</li>
157
- * </ul>
158
- * @param aFileExtensionExpression a file extension (e.g <em>ppt</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.ppt</em> or <em>http://www.xyz.com/files/myresource.ppt</em>). Case insensitive.
159
- * @return true if <code>aFileExtensionExpression</code> is mapped to a MS Powerpoint MIME type, false otherwise
160
- * @since Sitevision 4.1
161
- */
162
- export function isMSPowerpointType(aFileExtensionExpression: string): boolean;
71
+ /**
72
+ * Checks if a specified file extension is a text type (according to its mapped MIME type).
73
+ *
74
+ * <p>
75
+ * <em>A text type has a MIME that starts with "<code>text/</code>"</em>.
76
+ * </p>
77
+ * @param aFileExtensionExpression a file extension (e.g <em>txt</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.txt</em> or <em>http://www.xyz.com/files/myresource.txt</em>). Case insensitive.
78
+ * @return true if <code>aFileExtensionExpression</code> is mapped to a <code>text/*</code> MIME type, false otherwise
79
+ * @since Sitevision 4.1
80
+ */
81
+ isTextType(aFileExtensionExpression: string): boolean;
163
82
 
164
- /**
165
- * Checks if a specified file extension is a MS Office type (according to its mapped MIME type).
166
- *
167
- * <p>
168
- * <em>
169
- * This is a convenience method that checks if <code>aFileExtensionExpression</code> is mapped to a MS Word/Excel/Powerpoint MIME type.
170
- * (i.e. a combination of {@link #isMSWordType(String)}, {@link #isMSExcelType(String)} and {@link #isMSPowerpointType(String)})
171
- * </em>
172
- * </p>
173
- * @param aFileExtensionExpression a file extension (e.g <em>doc</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.xls</em> or <em>http://www.xyz.com/files/myresource.ppt</em>). Case insensitive.
174
- * @return true if <code>aFileExtensionExpression</code> is mapped to a MS Word/Excel/Powerpoint MIME type, false otherwise
175
- * @since Sitevision 4.1
176
- */
177
- export function isMSOfficeType(aFileExtensionExpression: string): boolean;
83
+ /**
84
+ * Checks if a specified file extension is a text type (according to its mapped MIME type).
85
+ *
86
+ * <p>
87
+ * <em>
88
+ * A XML type typically has a MIME that starts with "<code>application/</code>" and ends with "<code>xml</code>".
89
+ * This method will not include xml-based files covered by other categories (e.g. "office" types or the "svg" image type).
90
+ * </em>
91
+ * </p>
92
+ * @param aFileExtensionExpression a file extension (e.g <em>xml</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.xml</em> or <em>http://www.xyz.com/files/myresource.xml</em>). Case insensitive.
93
+ * @return true if <code>aFileExtensionExpression</code> is mapped to a <code>application/*xml</code> MIME type, false otherwise
94
+ * @since Sitevision 4.1
95
+ */
96
+ isXmlType(aFileExtensionExpression: string): boolean;
178
97
 
179
- /**
180
- * Checks if a specified file extension is a font type (according to its mapped MIME type).
181
- *
182
- * <p>
183
- * Example of typical font MIME types:
184
- * </p>
185
- * <ul>
186
- * <li>font/woff2</li>
187
- * <li>font/woff</li>
188
- * <li>font/ttf</li>
189
- * <li>font/otf</li>
190
- * <li>font/sfnt</li>
191
- * <li>font/collection</li>
192
- * <li>application/x-font-ttf</li>
193
- * <li>application/vnd.ms-fontobject</li>
194
- * <li>application/x-dfont</li>
195
- * </ul>
196
- * @param aFileExtensionExpression a file extension (e.g <em>woff2</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.woff2</em> or <em>http://www.xyz.com/files/myresource.woff2</em>). Case insensitive.
197
- * @return true if aFileExtensionExpression is mapped to a MIME type that is registered as font, false otherwise
198
- * @since Sitevision 2022.10.1
199
- */
200
- export function isFontType(aFileExtensionExpression: string): boolean;
98
+ /**
99
+ * Checks if a specified file extension is a video type (according to its mapped MIME type).
100
+ *
101
+ * <p>
102
+ * <em>A video type has a MIME that starts with "<code>video/</code>"</em>.
103
+ * </p>
104
+ * @param aFileExtensionExpression a file extension (e.g <em>mov</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.mov</em> or <em>http://www.xyz.com/files/myresource.mov</em>). Case insensitive.
105
+ * @return true if <code>aFileExtensionExpression</code> is mapped to a <code>video/*</code> MIME type, false otherwise
106
+ * @since Sitevision 4.1
107
+ */
108
+ isVideoType(aFileExtensionExpression: string): boolean;
201
109
 
202
- /**
203
- * A utility that determines an appropriate MIME type for a file extension or vice versa.
204
- *
205
- * <p>
206
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getMimeTypeUtil()}.
207
- * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
208
- * </p>The generic <code>application/octet-stream</code> MIME type.
209
- *
210
- * <p><em>Would typically be appropriate to use as value for the fallback MIME type when using the
211
- * {@link #getMimeType(String, String)} whenever you require an acceptable, non-null MIME type to be returned.</em></p>
212
- * <pre><code> String mime = aMimeTypeUtil.getMimeType(anExtension, MimeTypeUtil.GENERIC_MIME_TYPE);</code></pre>
213
- * @author Magnus Lövgren
214
- * @since Sitevision 3.0
215
- */
216
- declare namespace mimeTypeUtil {
217
- export {
218
- getMimeType,
219
- getExtension,
220
- isImageType,
221
- isTextType,
222
- isXmlType,
223
- isVideoType,
224
- isCompressedType,
225
- isMSWordType,
226
- isMSExcelType,
227
- isMSPowerpointType,
228
- isMSOfficeType,
229
- isFontType,
230
- };
110
+ /**
111
+ * Checks if a specified file extension is a compressed/archive type (according to its mapped MIME type).
112
+ *
113
+ * <p>
114
+ * Example of compressed MIME types:
115
+ * </p>
116
+ * <ul>
117
+ * <li>application/zip</li>
118
+ * <li>application/x-gzip</li>
119
+ * <li>application/x-bzip</li>
120
+ * <li>application/x-rar-compressed</li>
121
+ * <li>application/x-lzh-compressed</li>
122
+ * <li>application/x-7z-compressed</li>
123
+ * <li>application/x-tar</li>
124
+ * <li>application/vnd.ms-cab-compressed</li>
125
+ * <li>application/java-archive</li>
126
+ * </ul>
127
+ * @param aFileExtensionExpression a file extension (e.g <em>zip</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.zip</em> or <em>http://www.xyz.com/files/myresource.zip</em>). Case insensitive.
128
+ * @return true if <code>aFileExtensionExpression</code> is mapped to a MIME type that is registered as compressed, false otherwise
129
+ * @since Sitevision 4.1
130
+ */
131
+ isCompressedType(aFileExtensionExpression: string): boolean;
132
+
133
+ /**
134
+ * Checks if a specified file extension is a MS Word type (according to its mapped MIME type).
135
+ *
136
+ * <p>
137
+ * Example of typical MS Word MIME types:
138
+ * </p>
139
+ * <ul>
140
+ * <li>application/vnd.ms-word</li>
141
+ * <li>application/vnd.openxmlformats-officedocument.wordprocessingml.document</li>
142
+ * <li>application/vnd.openxmlformats-officedocument.wordprocessingml.template</li>
143
+ * </ul>
144
+ * @param aFileExtensionExpression a file extension (e.g <em>doc</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.doc</em> or <em>http://www.xyz.com/files/myresource.doc</em>). Case insensitive.
145
+ * @return true if <code>aFileExtensionExpression</code> is mapped to a MS Word MIME type, false otherwise
146
+ * @since Sitevision 4.1
147
+ */
148
+ isMSWordType(aFileExtensionExpression: string): boolean;
149
+
150
+ /**
151
+ * Checks if a specified file extension is a MS Excel type (according to its mapped MIME type).
152
+ *
153
+ * <p>
154
+ * Example of typical MS Excel MIME types:
155
+ * </p>
156
+ * <ul>
157
+ * <li>application/vnd.ms-excel</li>
158
+ * <li>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</li>
159
+ * <li>application/vnd.openxmlformats-officedocument.spreadsheetml.template</li>
160
+ * </ul>
161
+ * @param aFileExtensionExpression a file extension (e.g <em>xls</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.xls</em> or <em>http://www.xyz.com/files/myresource.xls</em>). Case insensitive.
162
+ * @return true if <code>aFileExtensionExpression</code> is mapped to a MS Excel MIME type, false otherwise
163
+ * @since Sitevision 4.1
164
+ */
165
+ isMSExcelType(aFileExtensionExpression: string): boolean;
166
+
167
+ /**
168
+ * Checks if a specified file extension is a MS Powerpoint type (according to its mapped MIME type).
169
+ *
170
+ * <p>
171
+ * Example of typical MS Powerpoint MIME types:
172
+ * </p>
173
+ * <ul>
174
+ * <li>application/vnd.ms-powerpoint</li>
175
+ * <li>application/vnd.openxmlformats-officedocument.presentationml.presentation</li>
176
+ * <li>application/vnd.openxmlformats-officedocument.presentationml.template</li>
177
+ * </ul>
178
+ * @param aFileExtensionExpression a file extension (e.g <em>ppt</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.ppt</em> or <em>http://www.xyz.com/files/myresource.ppt</em>). Case insensitive.
179
+ * @return true if <code>aFileExtensionExpression</code> is mapped to a MS Powerpoint MIME type, false otherwise
180
+ * @since Sitevision 4.1
181
+ */
182
+ isMSPowerpointType(aFileExtensionExpression: string): boolean;
183
+
184
+ /**
185
+ * Checks if a specified file extension is a MS Office type (according to its mapped MIME type).
186
+ *
187
+ * <p>
188
+ * <em>
189
+ * This is a convenience method that checks if <code>aFileExtensionExpression</code> is mapped to a MS Word/Excel/Powerpoint MIME type.
190
+ * (i.e. a combination of {@link #isMSWordType(String)}, {@link #isMSExcelType(String)} and {@link #isMSPowerpointType(String)})
191
+ * </em>
192
+ * </p>
193
+ * @param aFileExtensionExpression a file extension (e.g <em>doc</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.xls</em> or <em>http://www.xyz.com/files/myresource.ppt</em>). Case insensitive.
194
+ * @return true if <code>aFileExtensionExpression</code> is mapped to a MS Word/Excel/Powerpoint MIME type, false otherwise
195
+ * @since Sitevision 4.1
196
+ */
197
+ isMSOfficeType(aFileExtensionExpression: string): boolean;
198
+
199
+ /**
200
+ * Checks if a specified file extension is a font type (according to its mapped MIME type).
201
+ *
202
+ * <p>
203
+ * Example of typical font MIME types:
204
+ * </p>
205
+ * <ul>
206
+ * <li>font/woff2</li>
207
+ * <li>font/woff</li>
208
+ * <li>font/ttf</li>
209
+ * <li>font/otf</li>
210
+ * <li>font/sfnt</li>
211
+ * <li>font/collection</li>
212
+ * <li>application/x-font-ttf</li>
213
+ * <li>application/vnd.ms-fontobject</li>
214
+ * <li>application/x-dfont</li>
215
+ * </ul>
216
+ * @param aFileExtensionExpression a file extension (e.g <em>woff2</em>) or an expression that ends with a period and a file extension (e.g <em>myresource.woff2</em> or <em>http://www.xyz.com/files/myresource.woff2</em>). Case insensitive.
217
+ * @return true if aFileExtensionExpression is mapped to a MIME type that is registered as font, false otherwise
218
+ * @since Sitevision 2022.10.1
219
+ */
220
+ isFontType(aFileExtensionExpression: string): boolean;
231
221
  }
232
222
 
223
+ declare namespace MimeTypeUtil {}
224
+
225
+ declare var mimeTypeUtil: MimeTypeUtil;
226
+
233
227
  export default mimeTypeUtil;
@@ -1,21 +1,6 @@
1
1
  import type { Monitor } from "../../types/senselogic/sitevision/api/search/searcher/component/Monitor";
2
2
  import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
3
3
 
4
- /**
5
- * Sets the query logging mode on or off.
6
- * @param aEnableQueryLogging whether or not the query logging mode should be turned on (true) or off (false).
7
- * @return this builder
8
- */
9
- export function setEnableQueryLogging(
10
- aEnableQueryLogging: boolean
11
- ): MonitorBuilder;
12
-
13
- /**
14
- * Creates a Monitor component instance using currently specified state/behaviour.
15
- * @return a monitor component
16
- */
17
- export function build(): Monitor;
18
-
19
4
  /**
20
5
  * <p>
21
6
  * Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.Monitor} component.
@@ -45,8 +30,23 @@ export function build(): Monitor;
45
30
  * @author Magnus Lövgren
46
31
  * @since Sitevision 4.1
47
32
  */
48
- declare namespace monitorBuilder {
49
- export { setEnableQueryLogging, build };
33
+ export interface MonitorBuilder extends Builder {
34
+ /**
35
+ * Sets the query logging mode on or off.
36
+ * @param aEnableQueryLogging whether or not the query logging mode should be turned on (true) or off (false).
37
+ * @return this builder
38
+ */
39
+ setEnableQueryLogging(aEnableQueryLogging: boolean): MonitorBuilder;
40
+
41
+ /**
42
+ * Creates a Monitor component instance using currently specified state/behaviour.
43
+ * @return a monitor component
44
+ */
45
+ build(): Monitor;
50
46
  }
51
47
 
48
+ declare namespace MonitorBuilder {}
49
+
50
+ declare var monitorBuilder: MonitorBuilder;
51
+
52
52
  export default monitorBuilder;