@sitevision/api 1.0.19 → 1.1.0-alpha.1

package/server/FileUtil/index.d.ts

@@ -0,0 +1,462 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * <p>
+ *    Adds several files to a sv:localFileRepository, sv:fileRepository, sv:personalFileRepository or a sv:folder
+ *    residing as sub node to a file repository.
+ * </p>
+ * <p>
+ *    Files are specified by a map where the keys denotes the file names (will correspond to the property fileName
+ *    of the sv:file nodes) and the values denotes the URIs pointing to the file resources. The file resources
+ *    (i.e. the URIs) must be accessible from the Sitevision server. Sitevision opens a stream with the URI value
+ *    when creating/uploading the binary content of the file. If a firewall or such blocks outgoing communication
+ *    from the server - file creation will fail.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the parent node
+ *    (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>
+ * <p>
+ *    A warning will be written to the system log if Sitevision for any reason is unable to create one of the files.
+ * </p>
+ * @param aParent the parent node for the files
+ * @param aFileMappings a map of file name to URI pairs
+ * @throws java.lang.NullPointerException if <code>aParent</code> or <code>aFileMappings</code> is <code>null</code>
+ * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid parent node is specified or if file exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ */
+export function createFiles(
+  aParent: Node,
+  aFileMappings: Record<unknown, unknown>
+): void;
+
+/**
+ * Creates a file using a uri string.
+ *
+ * <p>
+ *    Note that the <code>aParent</code> of the file must be a <code>sv:localFileRepository</code>, <code>sv:fileRepository</code>,
+ *    <code>sv:personalFileRepository</code> or a <code>sv:folder</code> residing as sub node to a file repository.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the parent node
+ *    (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>
+ * <p>
+ *    <strong>URI note!</strong> The file resource must be accessible from the Sitevision server! Sitevision opens
+ *    a stream to an URL with the <code>aUri</code> value when creating/uploading the binary content of the file.
+ *    If a firewall or such blocks outgoing communication from the server - file creation will fail.
+ * </p>
+ * @param aParent the parent node of the file
+ * @param aFileName the filename
+ * @param aUri the URI pointing to the file resource retrievable from the Sitevision server
+ * @return a sv:file node corresponding to the newly created file. Will never return <code>null</code>
+ * @throws java.lang.NullPointerException if <code>aParent</code>, <code>aFileName</code> or <code>aUri</code> is <code>null</code>
+ * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid parent node is specified or if file exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ */
+export function createFile(
+  aParent: Node,
+  aFileName: string,
+  aUri: string
+): Node;
+
+/**
+ * Creates a file using a base64 string.
+ *
+ * <p>
+ *    The base64 decoder uses "The Base64 Alphabet" as specified in Table 1 of RFC 4648 and RFC 2045 for decoding operation.
+ *    The decoder rejects data that contains characters outside the base64 alphabet.
+ * </p>
+ * <p>
+ *    Note that the <code>aParent</code> of the file must be a <code>sv:localFileRepository</code>, <code>sv:fileRepository</code>,
+ *    <code>sv:personalFileRepository</code> or a <code>sv:folder</code> residing as sub node to a file repository.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the parent node
+ *    (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>
+ * @param aParent the parent node of the file
+ * @param aFileName the filename
+ * @param aBase64EncodedString a base64 encoded string
+ * @return a sv:file node corresponding to the newly created file. Will never return <code>null</code>
+ * @throws java.lang.NullPointerException if <code>aParent</code>, <code>aFileName</code> or <code>aBase64EncodedString</code> is <code>null</code>
+ * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid parent node is specified, if <code>aBase64EncodedString</code> is not base64 encoded or if file exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 4.5.4
+ */
+export function createFileFromBase64(
+  aParent: Node,
+  aFileName: string,
+  aBase64EncodedString: string
+): Node;
+
+/**
+ * Creates a file using a sv:temporaryFile.
+ *
+ * <p>
+ *    Note that the <code>aParent</code> of the file must be a <code>sv:localFileRepository</code>, <code>sv:fileRepository</code>,
+ *    <code>sv:personalFileRepository</code> or a <code>sv:folder</code> residing as sub node to a file repository.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the parent node
+ *    (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>
+ * @param aParent the parent node of the file
+ * @param aTemporaryFile a sv:temporaryFile (typically created via {@link senselogic.sitevision.api.node.builder.TemporaryFileNodeBuilder})
+ * @return a sv:file node corresponding to the newly created file. Will never return <code>null</code>
+ * @throws ConstraintViolationException if the user is not authorized to alter the parent node, if an invalid parent node is specified, if an invalid temporary node is specified or if file exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 4.5.4
+ */
+export function createFileFromTemporary(
+  aParent: Node,
+  aTemporaryFile: Node
+): Node;
+
+/**
+ * Updates the binary content of an existing file using a uri string.
+ *
+ * <p>
+ *    Properties related to the binary content will also be updated (e.g. <code>length</code>). A new version will
+ *    be created if the binary content of a <em>group file</em> is updated.
+ * </p>
+ * <p>
+ *    <strong>URI note!</strong> The URI must be accessible from the Sitevision server and the ending part
+ *    of the URI must match the file extension of the existing file that should be updated! Sitevision opens
+ *    a stream to an URL with the <code>anUri</code> value when uploading the binary content of the file.
+ *    If a firewall or such blocks outgoing communication from the server - file update will fail.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the file node that
+ *    should be updated (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>
+ * @param aFile the file
+ * @param aUri the URI pointing to the file resource to fetch new binary content from
+ * @throws ConstraintViolationException if the user is not authorized to alter the file node, if an invalid node is specified, if the end part of <code>aUri</code> doesn't match the file extension of <code>aFile</code> or if file exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 3.6.3
+ */
+export function updateBinaryContent(aFile: Node, aUri: string): void;
+
+/**
+ * Updates the binary content of an existing file using a base64 string.
+ *
+ * <p>
+ *    The base64 decoder uses "The Base64 Alphabet" as specified in Table 1 of RFC 4648 and RFC 2045 for decoding operation.
+ *    The decoder rejects data that contains characters outside the base64 alphabet.
+ * </p>
+ * <p>
+ *    Properties related to the binary content will also be updated (e.g. <code>length</code>). A new version will
+ *    be created if the binary content of a <em>group file</em> is updated.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the file node that
+ *    should be updated (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>
+ * @param aFile the file
+ * @param aBase64EncodedString a base64 encoded string
+ * @throws ConstraintViolationException if the user is not authorized to alter the file node, if an invalid node is specified, if <code>aBase64EncodedString</code> is not base64 encoded, if file exceeds file size limit or if file exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 4.5.4
+ */
+export function updateBinaryContentFromBase64(
+  aFile: Node,
+  aBase64EncodedString: string
+): void;
+
+/**
+ * Updates the binary content of an existing file using a sv:temporaryFile.
+ *
+ * <p>
+ *    Properties related to the binary content will also be updated (e.g. <code>length</code>). A new version will
+ *    be created if the binary content of a <em>group file</em> is updated.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the file node that
+ *    should be updated (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>
+ * @param aFile the file
+ * @param aTemporaryFile the sv:temporaryFile (typically created via {@link senselogic.sitevision.api.node.builder.TemporaryFileNodeBuilder})
+ * @throws ConstraintViolationException if the user is not authorized to alter the file node, if an invalid node is specified, if the end part of the file represented by <code>aTemporaryFile</code> doesn't match the file extension of <code>aFile</code> or if file exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 4.5.4
+ */
+export function updateBinaryContentFromTemporary(
+  aFile: Node,
+  aTemporaryFile: Node
+): void;
+
+/**
+ * Gets the contents of a file as a String using the UTF-8 character encoding.
+ *
+ * <p>
+ *    <em>Note! This is mere a convenience method for {@link #getContentAsString(Node, String)} using UTF-8 as character encoding.</em>
+ * </p>
+ * @param aFile the file Node (sv:file or sv:temporaryFile)
+ * @return the UTF-8 file content, or null if aFile isn't a character-based file
+ * @see #getContentAsString(Node, String)
+ * @since Sitevision 4.1.1
+ */
+export function getContentAsString(aFile: Node): string;
+
+/**
+ * Gets the contents of a file as a String using a given character encoding.
+ *
+ * <p>
+ *    <em>Note!</em> This method operates on character-based file nodes only! That is:
+ * </p>
+ * <ul>
+ *    <li>
+ *       Files that are of <em>text type</em> (as of {@link senselogic.sitevision.api.webresource.mime.MimeTypeUtil#isTextType(String)}).
+ *    </li>
+ *    <li>
+ *       Files that are of <em>xml type</em> (as of {@link senselogic.sitevision.api.webresource.mime.MimeTypeUtil#isXmlType(String)}).
+ *    </li>
+ *    <li>
+ *       Common "cross-over/mixed-types" files, such as <em>json</em> (application type) and <em>svg</em> (image type).
+ *    </li>
+ * </ul>
+ * @param aFile the file Node (sv:file or sv:temporaryFile)
+ * @param aCharacterEncoding the character encoding (Note! UTF-8 will be used instead for null, empty and illegal/unsupported encoding)
+ * @return the file content using the specified character encoding, or null if aFile isn't a character-based file
+ * @since Sitevision 4.1.1
+ */
+export function getContentAsString(
+  aFile: Node,
+  aCharacterEncoding: string
+): string;
+
+/**
+ * Alters the name of a file.
+ *
+ * <p>
+ *    If no file is specified a <code>NullPointerException</code> is thrown.
+ *    If the node is not a sv:file an <code>IllegalArgumentException</code> is thrown.
+ *    If no name is provided a <code>NullPointerException</code> is thrown.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the file node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ *    <em>Updating a file for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>
+ * @param aFile the sv:file that should be renamed. May not be <code>null</code>
+ * @param aNewName the new name of the file. May not be <code>null</code>
+ * @throws ConstraintViolationException if the current user is not authorized to alter the name of the file or if the file extension doesn't match
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 4.5.2
+ */
+export function renameFile(aFile: Node, aNewName: string): void;
+
+/**
+ * Modifies versioning for a file.
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the file node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>
+ * @param aFile the sv:file. May not be null
+ * @param aVersioned the new state of versioning for this file
+ * @throws ConstraintViolationException if the current user is not authorized to mutate aFile or if aFile is not a sv:file
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 9.1
+ */
+export function setVersioned(aFile: Node, aVersioned: boolean): void;
+
+/**
+ * Modifies download protection for a file.
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission and MANAGE_DOWNLOAD_PROTECTION
+ *    permission on the file 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>
+ *    <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 aFile the sv:file. May not be null
+ * @param aDownloadProtected the new state of download protection for aFile
+ * @throws ConstraintViolationException if the current user is not authorized to mutate aFile or if aFile is not a sv:file
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 2022.08.1
+ */
+export function setDownloadProtected(
+  aFile: Node,
+  aDownloadProtected: boolean
+): void;
+
+/**
+ * File utility interface that handles nodes with primary node type <code>sv:file</code> and <code>sv:temporaryFile</code>.
+ *
+ * <p>
+ *    <em>Note!</em> This interface is used to <em>create</em> files. You would typically use
+ *    {@link senselogic.sitevision.api.webresource.structure.StructureUtil} to <em>move</em> a file
+ *    and {@link senselogic.sitevision.api.webresource.structure.TrashcanUtil} to <em>delete</em> a file.
+ *    To check <em>MIME/Content-Type</em> for a file you would typically use {@link senselogic.sitevision.api.webresource.mime.MimeTypeUtil}.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getFileUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p><p>
+ *    Adds several files to a sv:localFileRepository, sv:fileRepository, sv:personalFileRepository or a sv:folder
+ *    residing as sub node to a file repository.
+ * </p>
+ * <p>
+ *    Files are specified by a map where the keys denotes the file names (will correspond to the property fileName
+ *    of the sv:file nodes) and the values denotes the URIs pointing to the file resources. The file resources
+ *    (i.e. the URIs) must be accessible from the Sitevision server. Sitevision opens a stream with the URI value
+ *    when creating/uploading the binary content of the file. If a firewall or such blocks outgoing communication
+ *    from the server - file creation will fail.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the parent node
+ *    (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>
+ * <p>
+ *    A warning will be written to the system log if Sitevision for any reason is unable to create one of the files.
+ * </p>Creates a file using a uri string.
+ *
+ * <p>
+ *    Note that the <code>aParent</code> of the file must be a <code>sv:localFileRepository</code>, <code>sv:fileRepository</code>,
+ *    <code>sv:personalFileRepository</code> or a <code>sv:folder</code> residing as sub node to a file repository.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the parent node
+ *    (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>
+ * <p>
+ *    <strong>URI note!</strong> The file resource must be accessible from the Sitevision server! Sitevision opens
+ *    a stream to an URL with the <code>aUri</code> value when creating/uploading the binary content of the file.
+ *    If a firewall or such blocks outgoing communication from the server - file creation will fail.
+ * </p>Creates a file using a base64 string.
+ *
+ * <p>
+ *    The base64 decoder uses "The Base64 Alphabet" as specified in Table 1 of RFC 4648 and RFC 2045 for decoding operation.
+ *    The decoder rejects data that contains characters outside the base64 alphabet.
+ * </p>
+ * <p>
+ *    Note that the <code>aParent</code> of the file must be a <code>sv:localFileRepository</code>, <code>sv:fileRepository</code>,
+ *    <code>sv:personalFileRepository</code> or a <code>sv:folder</code> residing as sub node to a file repository.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the parent node
+ *    (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>Creates a file using a sv:temporaryFile.
+ *
+ * <p>
+ *    Note that the <code>aParent</code> of the file must be a <code>sv:localFileRepository</code>, <code>sv:fileRepository</code>,
+ *    <code>sv:personalFileRepository</code> or a <code>sv:folder</code> residing as sub node to a file repository.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the parent node
+ *    (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>Updates the binary content of an existing file using a uri string.
+ *
+ * <p>
+ *    Properties related to the binary content will also be updated (e.g. <code>length</code>). A new version will
+ *    be created if the binary content of a <em>group file</em> is updated.
+ * </p>
+ * <p>
+ *    <strong>URI note!</strong> The URI must be accessible from the Sitevision server and the ending part
+ *    of the URI must match the file extension of the existing file that should be updated! Sitevision opens
+ *    a stream to an URL with the <code>anUri</code> value when uploading the binary content of the file.
+ *    If a firewall or such blocks outgoing communication from the server - file update will fail.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the file node that
+ *    should be updated (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>Updates the binary content of an existing file using a base64 string.
+ *
+ * <p>
+ *    The base64 decoder uses "The Base64 Alphabet" as specified in Table 1 of RFC 4648 and RFC 2045 for decoding operation.
+ *    The decoder rejects data that contains characters outside the base64 alphabet.
+ * </p>
+ * <p>
+ *    Properties related to the binary content will also be updated (e.g. <code>length</code>). A new version will
+ *    be created if the binary content of a <em>group file</em> is updated.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the file node that
+ *    should be updated (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>Updates the binary content of an existing file using a sv:temporaryFile.
+ *
+ * <p>
+ *    Properties related to the binary content will also be updated (e.g. <code>length</code>). A new version will
+ *    be created if the binary content of a <em>group file</em> is updated.
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user must be authorized to alter the file node that
+ *    should be updated (e.g. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>Gets the contents of a file as a String using the UTF-8 character encoding.
+ *
+ * <p>
+ *    <em>Note! This is mere a convenience method for {@link #getContentAsString(Node, String)} using UTF-8 as character encoding.</em>
+ * </p>Gets the contents of a file as a String using a given character encoding.
+ *
+ * <p>
+ *    <em>Note!</em> This method operates on character-based file nodes only! That is:
+ * </p>
+ * <ul>
+ *    <li>
+ *       Files that are of <em>text type</em> (as of {@link senselogic.sitevision.api.webresource.mime.MimeTypeUtil#isTextType(String)}).
+ *    </li>
+ *    <li>
+ *       Files that are of <em>xml type</em> (as of {@link senselogic.sitevision.api.webresource.mime.MimeTypeUtil#isXmlType(String)}).
+ *    </li>
+ *    <li>
+ *       Common "cross-over/mixed-types" files, such as <em>json</em> (application type) and <em>svg</em> (image type).
+ *    </li>
+ * </ul>Alters the name of a file.
+ *
+ * <p>
+ *    If no file is specified a <code>NullPointerException</code> is thrown.
+ *    If the node is not a sv:file an <code>IllegalArgumentException</code> is thrown.
+ *    If no name is provided a <code>NullPointerException</code> is thrown.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the file node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ *    <em>Updating a file for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>Modifies versioning for a file.
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the file node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ * </p>Modifies download protection for a file.
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission and MANAGE_DOWNLOAD_PROTECTION
+ *    permission on the file 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>
+ *    <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>
+ * @author Mikael Wikblom
+ * @since Sitevision 2.6.2
+ */
+declare namespace FileUtil {
+  export {
+    createFiles,
+    createFile,
+    createFileFromBase64,
+    createFileFromTemporary,
+    updateBinaryContent,
+    updateBinaryContentFromBase64,
+    updateBinaryContentFromTemporary,
+    getContentAsString,
+    renameFile,
+    setVersioned,
+    setDownloadProtected,
+  };
+}
+
+export default FileUtil;

package/server/FilterBuilder/index.d.ts

@@ -0,0 +1,120 @@
+import Filter from "../../hidden/senselogic/sitevision/api/search/searcher/component/Filter";
+
+/**
+ * Adds a filter query.
+ *
+ * <p>
+ *    <em>Solr note: this is the 'fq' param</em>
+ * </p>
+ *
+ * <p>
+ *    <strong>Query syntax note! </strong>Query strings should be expressed according to the <em>Solr query syntax</em>.
+ *    The syntax is basically the <em>
+ *    <a href="http://lucene.apache.org/core/4_10_3/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">
+ *    Lucene query syntax</a></em>
+ *    with <em><a href="http://wiki.apache.org/solr/SolrQuerySyntax#Differences_From_Lucene_Query_Parser">some minor differences</a></em>.
+ *    Also note that a general recommendation is to always use the <em>prefix operators</em> (<code>+</code>/<code>-</code>) instead of the
+ *    <em>boolean keywords</em> (AND/OR/NOT) to avoid unexpected behaviour. For deeper understanding, see for example
+ *    <a href="http://searchhub.org/2011/12/28/why-not-and-or-and-not/">Why Not AND, OR, And NOT?</a>.
+ * </p>
+ * @param aFilterQuery the filter query, a <code>null</code> or whitespace-only value will be ignored
+ * @return this builder
+ */
+export function addFilterQuery(aFilterQuery: string): FilterBuilder;
+
+/**
+ * Removes all previously added filter queries.
+ * @return this builder
+ */
+export function clearFilterQueries(): FilterBuilder;
+
+/**
+ * Creates a Filter component instance using currently specified state/behaviour.
+ * @return a filter component
+ * @throws IllegalStateException if no filter query exist
+ */
+export function build(): Filter;
+
+/**
+ * <p>
+ *    Builder for creating a {@link senselogic.sitevision.api.search.searcher.component.Filter} component with specific behaviour.
+ * </p>
+ *
+ * <p>
+ *    FilterBuilder has one <strong>mandatory attribute</strong>:
+ * </p>
+ * <ul>
+ *    <li>
+ *       <em>filter query</em> - The query/queries. Must be non-null.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    Using the FilterBuilder 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 FilterBuilder</li>
+ *   <li>Add a filter query</li>
+ *   <li>Possibly add another filter query</li>
+ *   <li>...</li>
+ *   <li>Do build</li>
+ * </ol>
+ * <p>
+ *    When you have built a <code>Filter</code> instance, you can re-use the FilterBuilder to build more instances. Typically like:
+ * </p>
+ * <ol>
+ *   <li>Clear the filter queries</li>
+ *   <li>Add a filter query</li>
+ *   <li>Possibly add another filter query</li>
+ *   <li>...</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 ($filterBuilder = $searchFactory.FilterBuilder)
+ *
+ *   <em>## Create a Filter</em>
+ *   #set ($nameMustStartWithAndersFilter = $filterBuilder.addFilterQuery('+name:Anders*').build())
+ *
+ *   <em>## Re-use the builder to create another Filter</em>
+ *   #set ($nameMustContainMagnusFilter = $filterBuilder.clearFilterQueries().addFilterQuery('+name.analyzed:magnus*').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>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.search.SearchFactory#getFilterBuilder()}.
+ *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
+ * </p>Adds a filter query.
+ *
+ * <p>
+ *    <em>Solr note: this is the 'fq' param</em>
+ * </p>
+ *
+ * <p>
+ *    <strong>Query syntax note! </strong>Query strings should be expressed according to the <em>Solr query syntax</em>.
+ *    The syntax is basically the <em>
+ *    <a href="http://lucene.apache.org/core/4_10_3/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#package_description">
+ *    Lucene query syntax</a></em>
+ *    with <em><a href="http://wiki.apache.org/solr/SolrQuerySyntax#Differences_From_Lucene_Query_Parser">some minor differences</a></em>.
+ *    Also note that a general recommendation is to always use the <em>prefix operators</em> (<code>+</code>/<code>-</code>) instead of the
+ *    <em>boolean keywords</em> (AND/OR/NOT) to avoid unexpected behaviour. For deeper understanding, see for example
+ *    <a href="http://searchhub.org/2011/12/28/why-not-and-or-and-not/">Why Not AND, OR, And NOT?</a>.
+ * </p>Removes all previously added filter queries.Creates a Filter component instance using currently specified state/behaviour.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+declare namespace FilterBuilder {
+  export { addFilterQuery, clearFilterQueries, build };
+}
+
+export default FilterBuilder;