@sitevision/api 2023.2.1 → 2023.2.2-beta.1

package/server/FolderUtil/index.d.ts

@@ -1,75 +1,76 @@
 import type { Node } from "../../types/javax/jcr/Node";
+import type { String } from "../../types/java/lang/String";
 
 /**
  * Folder utility interface that handles nodes with primary node type <code>sv:folder</code>.
  *
- * <p>
- *    <em>Note!</em> This interface is used to <em>create</em> folders. You would typically use
- *    {@link senselogic.sitevision.api.webresource.structure.StructureUtil} to <em>move</em> a folder
- *    and {@link senselogic.sitevision.api.webresource.structure.TrashcanUtil} to <em>delete</em> a folder.
- * </p>
+ *  <p>
+ *     <em>Note!</em> This interface is used to <em>create</em> folders. You would typically use
+ *     {@link senselogic.sitevision.api.webresource.structure.StructureUtil} to <em>move</em> a folder
+ *     and {@link senselogic.sitevision.api.webresource.structure.TrashcanUtil} to <em>delete</em> a folder.
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getFolderUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getFolderUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Mikael Wikblom
  * @since Sitevision 2.6.2
  */
 export interface FolderUtil {
   /**
    * <p>
-   *    Creates a folder as sub node of the specified parent.
-   * </p>
-   * <p>
-   *    The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}, {@code sv:collaborationGroupPage},
-   *    {@code sv:imageRepository}, {@code sv:localImageRepository}, {@code sv:personalImageRepository},
-   *    {@code sv:fileRepository}, {@code sv:localFileRepository}, {@code sv:personalFileRepository}
-   *    or {@code sv:templateRepository}.
-   *    If an other parent is specified an <code>ConstraintViolationException</code> is thrown.
-   * </p>
+   *     Creates a folder as sub node of the specified parent.
+   *  </p>
+   *  <p>
+   *     The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}, {@code sv:collaborationGroupPage},
+   *     {@code sv:imageRepository}, {@code sv:localImageRepository}, {@code sv:personalImageRepository},
+   *     {@code sv:fileRepository}, {@code sv:localFileRepository}, {@code sv:personalFileRepository}
+   *     or {@code sv:templateRepository}.
+   *     If an other parent is specified an <code>ConstraintViolationException</code> is thrown.
+   *  </p>
    *
-   * <p>Any name can be given the folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
+   *  <p>Any name can be given the folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
    *
-   * <p>The current user must be authorized to create folders and to do write operations on the parent node or
-   * a <code>ConstraintViolationException</code> will be thrown.</p>
+   *  <p>The current user must be authorized to create folders and to do write operations on the parent node or
+   *  a <code>ConstraintViolationException</code> will be thrown.</p>
    *
-   * <p>Note that a new folder inherits metadata and permissions from its parent.</p>
+   *  <p>Note that a new folder inherits metadata and permissions from its parent.</p>
    * @param aParent the parent node of the sv:folder. May not be <code>null</code>
    * @param aName the name of the folder. May not be <code>null</code>
    * @return the newly created sv:folder node.
-   * @throws ConstraintViolationException if an invalid parent is specified or if the current user is not authorized to create a folder
+   * @throws ConstraintViolationException if an invalid parent is specified or if the current user&#xA; is not authorized to create a folder
    * @throws RepositoryException if something else goes wrong
    */
-  createFolder(aParent: Node, aName: string): Node;
+  createFolder(aParent: Node, aName: String | string): Node;
 
   /**
    * <p>Alters the name of a folder. If no folder is specified a <code>NullPointerException</code>
-   * is thrown. If the node is not a sv:folder an <code>IllegalArgumentException</code> is thrown.</p>
+   *  is thrown. If the node is not a sv:folder an <code>IllegalArgumentException</code> is thrown.</p>
    *
-   * <p>Any name can be given a folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
+   *  <p>Any name can be given a folder. If null is provided a <code>NullPointerException</code> is thrown.</p>
    *
-   * <p>The current user must be authorized to do write operations on the folder or
-   * a <code>ConstraintViolationException</code> will be thrown.</p>
+   *  <p>The current user must be authorized to do write operations on the folder or
+   *  a <code>ConstraintViolationException</code> will be thrown.</p>
    * @param aFolder the sv:folder that should be renamed. May not be <code>null</code>
    * @param aName the new name of the folder. May not be <code>null</code>
    * @throws ConstraintViolationException if the current user is not authorized to alter the name of the folder
    * @throws RepositoryException if something else goes wrong
    */
-  renameFolder(aFolder: Node, aName: string): void;
+  renameFolder(aFolder: Node, aName: String | string): void;
 
   /**
    * Modifies versioning for a file folder (versioning only applies to new files created in the file folder).
    *
-   * <p>
-   *    If no folder is specified a <code>NullPointerException</code> is thrown.
-   *    If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
-   * </p>
+   *  <p>
+   *     If no folder is specified a <code>NullPointerException</code> is thrown.
+   *     If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
+   *  </p>
    *
-   * <p>
-   *    Current user must be authorized to do write operations on the folder or
-   *    a <code>ConstraintViolationException</code> will be thrown.
-   * </p>
+   *  <p>
+   *     Current user must be authorized to do write operations on the folder or
+   *     a <code>ConstraintViolationException</code> will be thrown.
+   *  </p>
    * @param aFolder the sv:folder. May not be null
    * @param aVersioned the new state of versioning for aFolder
    * @throws ConstraintViolationException if the current user is not authorized to mutate aFolder
@@ -81,21 +82,21 @@ export interface FolderUtil {
   /**
    * Modifies download protection for a file folder (download protection only applies to new files created in the file folder).
    *
-   * <p>
-   *    Current user (the invoker of this method) must have WRITE permission and MANAGE_DOWNLOAD_PROTECTION permission on the folder node that
-   *    should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
-   *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_DOWNLOAD_PROTECTION}).
-   * </p>
+   *  <p>
+   *     Current user (the invoker of this method) must have WRITE permission and MANAGE_DOWNLOAD_PROTECTION permission on the folder node that
+   *     should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
+   *     and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_DOWNLOAD_PROTECTION}).
+   *  </p>
    *
-   * <p>
-   *    If no folder is specified a <code>NullPointerException</code> is thrown.
-   *    If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
-   * </p>
+   *  <p>
+   *     If no folder is specified a <code>NullPointerException</code> is thrown.
+   *     If the node is not a sv:folder in a file tree an <code>IllegalArgumentException</code> is thrown.
+   *  </p>
    *
-   * <p>
-   *    <em>Tip! Use {@link senselogic.sitevision.api.property.PropertyUtil} or {@link senselogic.sitevision.api.property.Properties}
-   *    to check current state, i.e. the "downloadProtected" boolean property.</em>
-   * </p>
+   *  <p>
+   *     <em>Tip! Use {@link senselogic.sitevision.api.property.PropertyUtil} or {@link senselogic.sitevision.api.property.Properties}
+   *     to check current state, i.e. the "downloadProtected" boolean property.</em>
+   *  </p>
    * @param aFolder the sv:folder. May not be null
    * @param aDownloadProtected the new state of download protection for aFolder
    * @throws ConstraintViolationException if the current user is not authorized to mutate aFolder

package/server/FontUtil/index.d.ts

@@ -1,12 +1,13 @@
+import type { String } from "../../types/java/lang/String";
 import type { Node } from "../../types/javax/jcr/Node";
 
 /**
  * Utility interface for Fonts.
  *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getFontUtil()}.
- * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *  An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getFontUtil()}.
+ *  See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  */
 export interface FontUtil {
@@ -15,7 +16,7 @@ export interface FontUtil {
    * @param aFontName the name of the font
    * @return the first font with name aFontName, or <code>null</code> if no font matches
    */
-  getFontByName(aFontName: string): Node;
+  getFontByName(aFontName: String | string): Node;
 
   /**
    * Gets the font with a given font name with a fallback value if no font matches
@@ -23,14 +24,14 @@ export interface FontUtil {
    * @param aDefaultValue fallback value
    * @return the first font with name aFontName, or aDefaultValue if no font matches
    */
-  getFontByName(aFontName: string, aDefaultValue: Node): Node;
+  getFontByName(aFontName: String | string, aDefaultValue: Node): Node;
 
   /**
    * Gets the font with a given class name
    * @param aClassName the class name of the font
    * @return the first font with class name aClassName, or <code>null</code> if no font matches
    */
-  getFontByClassName(aClassName: string): Node;
+  getFontByClassName(aClassName: String | string): Node;
 
   /**
    * Gets the font with a given class name with a fallback value if no font matches
@@ -38,7 +39,7 @@ export interface FontUtil {
    * @param aDefaultValue fallback value
    * @return the first font with class name aClassName, or aDefaultValue if no font matches
    */
-  getFontByClassName(aClassName: string, aDefaultValue: Node): Node;
+  getFontByClassName(aClassName: String | string, aDefaultValue: Node): Node;
 }
 
 declare namespace FontUtil {}

package/server/FormatterBuilderFactory/index.d.ts

@@ -1,14 +1,15 @@
+import type { Locale } from "../../types/java/util/Locale";
 import type { NumericFormatterBuilder } from "../../types/senselogic/sitevision/api/format/NumericFormatterBuilder";
 import type { Currency } from "../../types/senselogic/sitevision/api/i18n/Currency";
 
 /**
  * Factory for creating formatter builders.
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getFormatterBuilderFactory()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.Utils#getFormatterBuilderFactory()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 6.1
  */
@@ -16,61 +17,61 @@ export interface FormatterBuilderFactory {
   /**
    * Returns a builder for creating number formatters with a given Locale.
    *
-   * <p>
-   *    <em>The builder returned by this method will create instances that are conceptually equivalent with
-   *    <code>java.text.NumberFormat.getNumberInstance(aLocale)</code>.</em>
-   * </p>
+   *  <p>
+   *     <em>The builder returned by this method will create instances that are conceptually equivalent with
+   *     <code>java.text.NumberFormat.getNumberInstance(aLocale)</code>.</em>
+   *  </p>
    * @param aLocale the Locale
    * @return a NumericFormatterBuilder that creates number formatters
    * @throws NullPointerException if aLocale is null
    */
-  getNumberFormatterBuilder(aLocale: unknown): NumericFormatterBuilder;
+  getNumberFormatterBuilder(aLocale: Locale): NumericFormatterBuilder;
 
   /**
    * Returns a builder for creating percent formatters with a given Locale.
    *
-   * <p>
-   *    <em>The builder returned by this method will create instances that are conceptually equivalent with
-   *    <code>java.text.NumberFormat.getPercentInstance(aLocale)</code>.</em>
-   * </p>
+   *  <p>
+   *     <em>The builder returned by this method will create instances that are conceptually equivalent with
+   *     <code>java.text.NumberFormat.getPercentInstance(aLocale)</code>.</em>
+   *  </p>
    * @param aLocale the Locale
    * @return a NumericFormatterBuilder that creates percent formatters
    * @throws NullPointerException if aLocale is null
    */
-  getPercentFormatterBuilder(aLocale: unknown): NumericFormatterBuilder;
+  getPercentFormatterBuilder(aLocale: Locale): NumericFormatterBuilder;
 
   /**
    * Returns a builder for creating currency formatters with a given Locale.
    *
-   * <p>
-   *    <strong>Currency note!</strong> Currency typically depends on a <em>country</em>. A language-only Locale
-   *    will typically be formatted without any specific currency. Use {@link #getCurrencyFormatterBuilder(Locale, Currency)}
-   *    to actively specify what currency to use when using such locale.
-   * </p>
+   *  <p>
+   *     <strong>Currency note!</strong> Currency typically depends on a <em>country</em>. A language-only Locale
+   *     will typically be formatted without any specific currency. Use {@link #getCurrencyFormatterBuilder(Locale, Currency)}
+   *     to actively specify what currency to use when using such locale.
+   *  </p>
    *
-   * <p>
-   *    <em>The builder returned by this method will create instances that are conceptually equivalent with
-   *    <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code>.</em>
-   * </p>
+   *  <p>
+   *     <em>The builder returned by this method will create instances that are conceptually equivalent with
+   *     <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code>.</em>
+   *  </p>
    * @param aLocale the Locale
    * @return a NumericFormatterBuilder that creates currency formatters
    * @throws NullPointerException if aLocale is null
    * @see #getCurrencyFormatterBuilder(Locale, Currency)
    */
-  getCurrencyFormatterBuilder(aLocale: unknown): NumericFormatterBuilder;
+  getCurrencyFormatterBuilder(aLocale: Locale): NumericFormatterBuilder;
 
   /**
    * Returns a builder for creating currency formatters with a given Locale and Currency.
    *
-   * <p>
-   *    Currency instances are created via methods in {@link senselogic.sitevision.api.i18n.CurrencyFactory}.
-   * </p>
+   *  <p>
+   *     Currency instances are created via methods in {@link senselogic.sitevision.api.i18n.CurrencyFactory}.
+   *  </p>
    *
-   * <p>
-   *    <em>The builder returned by this method will create instances that are conceptually equivalent with
-   *    <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code> with a
-   *    <code>java.util.Currency.getInstance(aCurrencyCode)</code> set.</em>
-   * </p>
+   *  <p>
+   *     <em>The builder returned by this method will create instances that are conceptually equivalent with
+   *     <code>java.text.NumberFormat.getCurrencyInstance(aLocale)</code> with a
+   *     <code>java.util.Currency.getInstance(aCurrencyCode)</code> set.</em>
+   *  </p>
    * @param aLocale the Locale
    * @param aCurrency the currency
    * @return a NumericFormatterBuilder that creates currency formatters
@@ -78,7 +79,7 @@ export interface FormatterBuilderFactory {
    * @see senselogic.sitevision.api.i18n.CurrencyFactory
    */
   getCurrencyFormatterBuilder(
-    aLocale: unknown,
+    aLocale: Locale,
     aCurrency: Currency
   ): NumericFormatterBuilder;
 }

package/server/HighlightBuilder/index.d.ts

@@ -1,79 +1,81 @@
+import type { String } from "../../types/java/lang/String";
+
 import type { Highlight } from "../../types/senselogic/sitevision/api/search/searcher/component/Highlight";
 import type { Builder } from "../../types/senselogic/sitevision/api/base/Builder";
 
 /**
  * <p>
- *    Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.Highlight} component with specific behaviour.
- * </p>
+ *     Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.Highlight} component with specific behaviour.
+ *  </p>
  *
- * <p>
- *    HighlightBuilder has one <strong>mandatory attribute</strong>:
- * </p>
- * <ul>
- *    <li>
- *       <em>highlighted field</em> - The name of the field(s) that should be highlighted. Must be non-null.
- *    </li>
- * </ul>
- * <p>
- *    HighlightBuilder also has some <strong>optional attributes</strong>:
- * </p>
- * <ul>
- *    <li>
- *       <em>fragment char count</em> - The size of a highlighted fragment. Default is 200.
- *    </li>
- *    <li>
- *       <em>fragment pre string</em> - The start value of a highlighted section of a fragment. Default is "&lt;mark&gt;".
- *    </li>
- *    <li>
- *       <em>fragment post string</em> - The end value of a highlighted section of a fragment. Default is "&lt;/mark&gt;".
- *    </li>
- * </ul>
+ *  <p>
+ *     HighlightBuilder has one <strong>mandatory attribute</strong>:
+ *  </p>
+ *  <ul>
+ *     <li>
+ *        <em>highlighted field</em> - The name of the field(s) that should be highlighted. Must be non-null.
+ *     </li>
+ *  </ul>
+ *  <p>
+ *     HighlightBuilder also has some <strong>optional attributes</strong>:
+ *  </p>
+ *  <ul>
+ *     <li>
+ *        <em>fragment char count</em> - The size of a highlighted fragment. Default is 200.
+ *     </li>
+ *     <li>
+ *        <em>fragment pre string</em> - The start value of a highlighted section of a fragment. Default is "&lt;mark&gt;".
+ *     </li>
+ *     <li>
+ *        <em>fragment post string</em> - The end value of a highlighted section of a fragment. Default is "&lt;/mark&gt;".
+ *     </li>
+ *  </ul>
  *
- * <p>
- *    Using the HighlightBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
- *    would typically use it like this:
- * </p>
- * <ol>
- *   <li>Get the HighlightBuilder</li>
- *   <li>Add a highlighted field</li>
- *   <li>Possibly set a char count</li>
- *   <li>Possibly set pre + post</li>
- *   <li>Do build</li>
- * </ol>
- * <p>
- *    When you have built a <code>Highlight</code> instance, you can re-use the HighlightBuilder to build more instances. Typically like:
- * </p>
- * <ol>
- *   <li>Clear the highlighted fields</li>
- *   <li>Possibly change char count</li>
- *   <li>Possibly change pre + post</li>
- *   <li>Do build</li>
- * </ol>
- * <p>
- *    <strong>Example of how this strategy could be implemented in Velocity:</strong>
- * </p>
- * <pre><code>
- *   <em>## Get the builder</em>
- *   #set ($searchFactory = $sitevisionUtils.searchFactory)
- *   #set ($highlightBuilder = $searchFactory.highlightBuilder)
+ *  <p>
+ *     Using the HighlightBuilder is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
+ *     would typically use it like this:
+ *  </p>
+ *  <ol>
+ *    <li>Get the HighlightBuilder</li>
+ *    <li>Add a highlighted field</li>
+ *    <li>Possibly set a char count</li>
+ *    <li>Possibly set pre + post</li>
+ *    <li>Do build</li>
+ *  </ol>
+ *  <p>
+ *     When you have built a <code>Highlight</code> instance, you can re-use the HighlightBuilder to build more instances. Typically like:
+ *  </p>
+ *  <ol>
+ *    <li>Clear the highlighted fields</li>
+ *    <li>Possibly change char count</li>
+ *    <li>Possibly change pre + post</li>
+ *    <li>Do build</li>
+ *  </ol>
+ *  <p>
+ *     <strong>Example of how this strategy could be implemented in Velocity:</strong>
+ *  </p>
+ *  <pre><code>
+ *    <em>## Get the builder</em>
+ *    #set ($searchFactory = $sitevisionUtils.searchFactory)
+ *    #set ($highlightBuilder = $searchFactory.highlightBuilder)
  *
- *   <em>## Create a Highlight</em>
- *   #set ($summaryHighlight = $highlightBuilder.addHighlightedField('summary').build())
+ *    <em>## Create a Highlight</em>
+ *    #set ($summaryHighlight = $highlightBuilder.addHighlightedField('summary').build())
  *
- *   <em>## Re-use the builder to create another Highlight</em>
- *   #set ($nameHighlight = $highlightBuilder.clearHighlightedFields().addHighlightedField('name').build())
- * </code></pre>
+ *    <em>## Re-use the builder to create another Highlight</em>
+ *    #set ($nameHighlight = $highlightBuilder.clearHighlightedFields().addHighlightedField('name').build())
+ *  </code></pre>
  *
- * <p>
- *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
- *    more information about Builders and how to work with them!
- * </p>
+ *  <p>
+ *     <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
+ *     more information about Builders and how to work with them!
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.search.SearchFactory#getHighlightBuilder()}.
- *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.search.SearchFactory#getHighlightBuilder()}.
+ *     See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
@@ -81,13 +83,13 @@ export interface HighlightBuilder extends Builder {
   /**
    * Adds a field that should be highlighted.
    *
-   * <p>
-   *    <em>Solr note: this is the 'hl.fl' param</em>
-   * </p>
+   *  <p>
+   *     <em>Solr note: this is the 'hl.fl' param</em>
+   *  </p>
    * @param aHighlightedField name of the field, a <code>null</code> or whitespace-only value will be ignored
    * @return this builder
    */
-  addHighlightedField(aHighlightedField: string): HighlightBuilder;
+  addHighlightedField(aHighlightedField: String | string): HighlightBuilder;
 
   /**
    * Removes all previously added highlighted fields.
@@ -98,13 +100,13 @@ export interface HighlightBuilder extends Builder {
   /**
    * Sets the number of chars that highlighted fragment should contain.
    *
-   * <p>
-   *    If no char count is specified, the default value of the index config will be used (200).
-   * </p>
+   *  <p>
+   *     If no char count is specified, the default value of the index config will be used (200).
+   *  </p>
    *
-   * <p>
-   *    <em>Solr note: this is the 'hl.fragsize' param</em>
-   * </p>
+   *  <p>
+   *     <em>Solr note: this is the 'hl.fragsize' param</em>
+   *  </p>
    * @param aCharCount the char count
    * @return this builder
    * @throws IllegalArgumentException if <code>aCharCount</code> is zero or negative
@@ -114,34 +116,34 @@ export interface HighlightBuilder extends Builder {
   /**
    * Sets the start value for the highlighted section(s) of a fragment.
    *
-   * <p>
-   *    If the pre string and post string are not specified, the default value of the index config will be used
-   *    ('&lt;mark&gt;' and '&lt;/mark&gt;').
-   * </p>
+   *  <p>
+   *     If the pre string and post string are not specified, the default value of the index config will be used
+   *     ('&lt;mark&gt;' and '&lt;/mark&gt;').
+   *  </p>
    *
-   * <p>
-   *    <em>Solr note: this is the 'hl.simple.pre' param</em>
-   * </p>
+   *  <p>
+   *     <em>Solr note: this is the 'hl.simple.pre' param</em>
+   *  </p>
    * @param aPreString a fragment start
    * @return this builder
    */
-  setFragmentPreString(aPreString: string): HighlightBuilder;
+  setFragmentPreString(aPreString: String | string): HighlightBuilder;
 
   /**
    * Sets the end value for the highlighted section(s) of a fragment.
    *
-   * <p>
-   *    <strong>Note! </strong> The fragment <em>pre</em> value must match the fragment <em>post</em> string!
-   *    E.g: if the <em>pre</em> string is "&lt;em&gt;", the <em>post</em> string would typically be "&lt;/em&gt;".
-   * </p>
+   *  <p>
+   *     <strong>Note! </strong> The fragment <em>pre</em> value must match the fragment <em>post</em> string!
+   *     E.g: if the <em>pre</em> string is "&lt;em&gt;", the <em>post</em> string would typically be "&lt;/em&gt;".
+   *  </p>
    *
-   * <p>
-   *    <em>Solr note: this is the 'hl.simple.post' param</em>
-   * </p>
+   *  <p>
+   *     <em>Solr note: this is the 'hl.simple.post' param</em>
+   *  </p>
    * @param aPostString a fragment end
    * @return this builder
    */
-  setFragmentPostString(aPostString: string): HighlightBuilder;
+  setFragmentPostString(aPostString: String | string): HighlightBuilder;
 
   /**
    * Creates a Highlight component instance using currently specified state/behaviour.

package/server/IconUtil/index.d.ts

@@ -1,12 +1,13 @@
+import type { String } from "../../types/java/lang/String";
 import type { Node } from "../../types/javax/jcr/Node";
 
 /**
  * Utility interface for Icons.
  *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getIconUtil()}.
- * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *  An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getIconUtil()}.
+ *  See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  */
 export interface IconUtil {
@@ -15,21 +16,21 @@ export interface IconUtil {
    * @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
    * @return the file icon node for aFileExtension, or <code>null</code> if the extension has no icon mapping
    */
-  getFileIcons(aFileExtension: string): Node;
+  getFileIcons(aFileExtension: String | string): Node;
 
   /**
    * Gets the small file icon URI for a given file extension
    * @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
    * @return the small file icon URI for aFileExtension, or <code>null</code> if no small icon is specified for the extension
    */
-  getSmallFileIconURI(aFileExtension: string): string;
+  getSmallFileIconURI(aFileExtension: String | string): string;
 
   /**
    * Gets the large file icon URI for a given file extension
    * @param aFileExtension the file extension (e.g "pdf", "PDF", "doc"). The extension is case insensitive.
    * @return the large file icon URI for aFileExtension, or <code>null</code> if no large icon is specified for the extension
    */
-  getLargeFileIconURI(aFileExtension: string): string;
+  getLargeFileIconURI(aFileExtension: String | string): string;
 }
 
 declare namespace IconUtil {}