@sitevision/api 1.0.20 → 1.1.0-alpha.1

package/server/ImageUtil/index.d.ts

@@ -0,0 +1,430 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * <p>
+ *    Adds several images to a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>, <code>sv:personalImageRepository</code>
+ *    or a <code>sv:folder</code> residing as sub node to an image repository.
+ *    If an other parent node is specified a <code>ConstraintViolationException</code> is thrown.
+ *    The images map keys correspond to the file names (will correspond to the property fileName of the sv:image nodes)
+ *    and the values to URIs pointing to the file resources.
+ * </p>
+ *
+ * <p>
+ *    Note that the images must have an image mime-type to be created.
+ * </p>
+ *
+ * <p>
+ *    <strong>URI note!</strong> The resource must be accessible from the Sitevision server! Sitevision opens
+ *    a stream to an URL with the <code>aUri</code> value when creating the binary content of the image.
+ *    If a firewall or such blocks outgoing communication from the server - image creation will fail.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
+ *    or a <code>ConstraintViolationException</code> is thrown.
+ *    <em>Creating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>
+ * @param aParent the parent node for the images. May not be <code>null</code>
+ * @param aImages a map of file name to URI pairs May not be <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 image exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ */
+export function createImages(
+  aParent: Node,
+  aImages: Record<unknown, unknown>
+): void;
+
+/**
+ * Creates an image using a uri string.
+ *
+ * <p>
+ *    Note that the <code>aParent</code> of the file must be a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>,
+ *    <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
+ * </p>
+ * <p>
+ *    The file must have an image mime-type or an <code>IllegalArgumentException</code> is thrown.
+ * </p>
+ *
+ * <p>
+ *    <strong>URI note!</strong> The resource must be accessible from the Sitevision server! Sitevision opens
+ *    a stream to an URL with the <code>aUri</code> value when creating the binary content of the image.
+ *    If a firewall or such blocks outgoing communication from the server - image creation will fail.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
+ *    or a <code>ConstraintViolationException</code> is thrown.
+ *    <em>Creating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>
+ * @param aParent the parent node of the image. May not be <code>null</code>
+ * @param aFileName the fileName property of the sv:image. May not be <code>null</code>
+ * @param aUri the URI pointing to the file resource. May not be <code>null</code>
+ * @return a sv:image node corresponding to the newly created image. 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 or if image exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ */
+export function createImage(
+  aParent: Node,
+  aFileName: string,
+  aUri: string
+): Node;
+
+/**
+ * Creates an image 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:localImageRepository</code>, <code>sv:imageRepository</code>,
+ *    <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
+ * </p>
+ * <p>
+ *    The file name must correspond to an image mime-type or an <code>IllegalArgumentException</code> is thrown.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
+ *    or a <code>ConstraintViolationException</code> is thrown.
+ *    <em>Creating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>
+ * @param aParent the parent node of the image. May not be <code>null</code>
+ * @param aFileName the fileName property of the sv:image. May not be <code>null</code>
+ * @param aBase64EncodedString a base64 encoded string. May not be <code>null</code>
+ * @return a sv:image node corresponding to the newly created image. 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 <code>aBase64EncodedString</code> is not base64 encoded or if image exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 4.5.4
+ */
+export function createImageFromBase64(
+  aParent: Node,
+  aFileName: string,
+  aBase64EncodedString: string
+): Node;
+
+/**
+ * Creates an image using a sv:temporaryFile.
+ *
+ * <p>
+ *    Note that the <code>aParent</code> of the file must be a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>,
+ *    <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
+ * </p>
+ * <p>
+ *    The file name must correspond to an image mime-type or an <code>IllegalArgumentException</code> is thrown.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
+ *    or a <code>ConstraintViolationException</code> is thrown.
+ *    <em>Creating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>
+ * @param aParent the parent node of the image
+ * @param aTemporaryFile a sv:temporaryFile (typically created via {@link senselogic.sitevision.api.node.builder.TemporaryFileNodeBuilder})
+ * @return a sv:image node corresponding to the newly created image. 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 image exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 4.5.4
+ */
+export function createImageFromTemporary(
+  aParent: Node,
+  aTemporaryFile: Node
+): Node;
+
+/**
+ * Updates the binary content of an existing image using a uri string.
+ *
+ * <p>
+ *    Properties related to the binary content will also be updated (e.g. <code>length</code>, <code>width</code> and <code>height</code>).
+ * </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 image that should be updated!
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ *    <em>Updating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>
+ * @param aImage the image. May not be <code>null</code>
+ * @param aUri the URI pointing to the file resource to fetch new binary content from. May not be <code>null</code>
+ * @throws ConstraintViolationException if the user is not authorized to alter the image node, if an invalid node is specified, if the end part of <code>aUri</code> doesn't match the file extension of <code>aImage</code> or if image exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 3.6.3
+ */
+export function updateBinaryContent(aImage: Node, aUri: string): void;
+
+/**
+ * Updates the binary content of an existing image 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>, <code>width</code> and <code>height</code>).
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ *    <em>Updating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>
+ * @param aImage the image. May not be <code>null</code>
+ * @param aBase64EncodedString a base64 encoded string. May not be <code>null</code>
+ * @throws ConstraintViolationException if the user is not authorized to alter the image node, if an invalid node is specified, if <code>aBase64EncodedString</code> is not base64 encoded or if image exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 4.5.4
+ */
+export function updateBinaryContentFromBase64(
+  aImage: Node,
+  aBase64EncodedString: string
+): void;
+
+/**
+ * Updates the binary content of an existing image using a sv:temporaryFile.
+ *
+ * <p>
+ *    Properties related to the binary content will also be updated (e.g. <code>length</code>, <code>width</code> and <code>height</code>).
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ *    <em>Updating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>
+ * @param aImage the image. May not be <code>null</code>
+ * @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 image 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>aImage</code> or if image exceeds file size limit
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 4.5.4
+ */
+export function updateBinaryContentFromTemporary(
+  aImage: Node,
+  aTemporaryFile: Node
+): void;
+
+/**
+ * Alters the name of an image.
+ *
+ * <p>
+ *    If no image is specified a <code>NullPointerException</code> is thrown.
+ *    If the node is not a sv:image 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 image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ *    <em>Updating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>
+ * @param aImage the sv:image that should be renamed. May not be <code>null</code>
+ * @param aName the new name of the image. May not be <code>null</code>
+ * @throws ConstraintViolationException if the current user is not authorized to alter the name of the image or if the image extension doesn't match
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 4.5.2
+ */
+export function renameImage(aImage: Node, aName: string): void;
+
+/**
+ * The Base64 String representation of an image Node.
+ *
+ * <p>
+ *    Reads the binary content of an image and encodes the bytes using
+ *    {@link senselogic.sitevision.api.text.EndecUtil#base64encodeToString(byte[])}.
+ * </p>
+ * @param aImage the image Node (sv:image or sv:temporaryFile), may not be null
+ * @return aImage as base64-encoded String
+ * @throws ConstraintViolationException if aImage is not a sv:image or sv:temporaryFile
+ * @throws RepositoryException if something else goes wrong
+ * @since Sitevision 4.5.5.2
+ */
+export function toBase64(aImage: Node): string;
+
+/**
+ * Image utility interface that handles nodes with primary node type <code>sv:image</code>.
+ *
+ * <p>
+ *    <em>Note!</em> This interface is used to <em>create</em> images. You would typically use
+ *    {@link senselogic.sitevision.api.webresource.structure.StructureUtil} to <em>move</em> an image
+ *    and {@link senselogic.sitevision.api.webresource.structure.TrashcanUtil} to <em>delete</em> an image.
+ *    To <em>render</em> images, you would typically use {@link senselogic.sitevision.api.render.ImageRenderer}
+ *    or {@link senselogic.sitevision.api.render.ImageLinkRenderer}.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getImageUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p><p>
+ *    Adds several images to a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>, <code>sv:personalImageRepository</code>
+ *    or a <code>sv:folder</code> residing as sub node to an image repository.
+ *    If an other parent node is specified a <code>ConstraintViolationException</code> is thrown.
+ *    The images map keys correspond to the file names (will correspond to the property fileName of the sv:image nodes)
+ *    and the values to URIs pointing to the file resources.
+ * </p>
+ *
+ * <p>
+ *    Note that the images must have an image mime-type to be created.
+ * </p>
+ *
+ * <p>
+ *    <strong>URI note!</strong> The resource must be accessible from the Sitevision server! Sitevision opens
+ *    a stream to an URL with the <code>aUri</code> value when creating the binary content of the image.
+ *    If a firewall or such blocks outgoing communication from the server - image creation will fail.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
+ *    or a <code>ConstraintViolationException</code> is thrown.
+ *    <em>Creating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>Creates an image using a uri string.
+ *
+ * <p>
+ *    Note that the <code>aParent</code> of the file must be a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>,
+ *    <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
+ * </p>
+ * <p>
+ *    The file must have an image mime-type or an <code>IllegalArgumentException</code> is thrown.
+ * </p>
+ *
+ * <p>
+ *    <strong>URI note!</strong> The resource must be accessible from the Sitevision server! Sitevision opens
+ *    a stream to an URL with the <code>aUri</code> value when creating the binary content of the image.
+ *    If a firewall or such blocks outgoing communication from the server - image creation will fail.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
+ *    or a <code>ConstraintViolationException</code> is thrown.
+ *    <em>Creating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>Creates an image 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:localImageRepository</code>, <code>sv:imageRepository</code>,
+ *    <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
+ * </p>
+ * <p>
+ *    The file name must correspond to an image mime-type or an <code>IllegalArgumentException</code> is thrown.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
+ *    or a <code>ConstraintViolationException</code> is thrown.
+ *    <em>Creating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>Creates an image using a sv:temporaryFile.
+ *
+ * <p>
+ *    Note that the <code>aParent</code> of the file must be a <code>sv:localImageRepository</code>, <code>sv:imageRepository</code>,
+ *    <code>sv:personalImageRepository</code> or a <code>sv:folder</code> residing as sub node to an image repository.
+ * </p>
+ * <p>
+ *    The file name must correspond to an image mime-type or an <code>IllegalArgumentException</code> is thrown.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the parent node (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE})
+ *    or a <code>ConstraintViolationException</code> is thrown.
+ *    <em>Creating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>Updates the binary content of an existing image using a uri string.
+ *
+ * <p>
+ *    Properties related to the binary content will also be updated (e.g. <code>length</code>, <code>width</code> and <code>height</code>).
+ * </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 image that should be updated!
+ * </p>
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ *    <em>Updating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>Updates the binary content of an existing image 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>, <code>width</code> and <code>height</code>).
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ *    <em>Updating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>Updates the binary content of an existing image using a sv:temporaryFile.
+ *
+ * <p>
+ *    Properties related to the binary content will also be updated (e.g. <code>length</code>, <code>width</code> and <code>height</code>).
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user (the invoker of this method) must have WRITE permission
+ *    on the image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ *    <em>Updating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>Alters the name of an image.
+ *
+ * <p>
+ *    If no image is specified a <code>NullPointerException</code> is thrown.
+ *    If the node is not a sv:image 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 image node that should be updated (see {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}).
+ *    <em>Updating an image for a <code>sv:userIdentity</code> requires
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES} on current page.</em>
+ * </p>The Base64 String representation of an image Node.
+ *
+ * <p>
+ *    Reads the binary content of an image and encodes the bytes using
+ *    {@link senselogic.sitevision.api.text.EndecUtil#base64encodeToString(byte[])}.
+ * </p>
+ * @author Mikael Wikblom
+ * @since Sitevision 2.6.2
+ */
+declare namespace ImageUtil {
+  export {
+    createImages,
+    createImage,
+    createImageFromBase64,
+    createImageFromTemporary,
+    updateBinaryContent,
+    updateBinaryContentFromBase64,
+    updateBinaryContentFromTemporary,
+    renameImage,
+    toBase64,
+  };
+}
+
+export default ImageUtil;

package/server/IndexUtil/index.d.ts

@@ -0,0 +1,71 @@
+import IndexUtil_IndexType from "../IndexUtil_IndexType";
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * Gets the default index for a specified index type.
+ *
+ * <p>
+ *    <strong>Note!</strong>The default user identity index is only handled if a <em>Social Collaboration</em> license is in use.
+ *    The default user-generated content (UGC) index is only handled if a <em>Social Collaboration</em> license is in use.
+ * </p>
+ * @param aIndexType type of index
+ * @return the default index for <code>aIndexType</code>, or <code>null</code> if not available
+ */
+export function getDefaultIndex(aIndexType: IndexType): Node;
+
+/**
+ * Gets an index by name.
+ *
+ * <p>
+ *    Lookup order:
+ * </p>
+ * <ol>
+ *    <li>Custom <em>site</em> index</li>
+ *    <li>Custom <em>server</em> index</li>
+ *    <li><em>Default</em> index(-es), types specified by {@link senselogic.sitevision.api.search.index.IndexUtil.IndexType}</li>
+ * </ol>
+ * <p>
+ *    <strong>Note!</strong> Custom index is only handled if a <em>Search Package 2</em> license is in use.
+ *    The default user identity index is only handled if a <em>Social Collaboration</em> license is in use.
+ *    The default user-generated content (UGC) index is only handled if a <em>Social Collaboration</em> license is in use.
+ * </p>
+ * @param aIndexName the name of the index
+ * @return the index or <code>null</code> if no index matches <code>aIndexName</code>
+ */
+export function getIndexByName(aIndexName: string): Node;
+
+/**
+ * Index utility interface.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.search.SearchFactory#getIndexUtil()}.
+ *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
+ * </p>Gets the default index for a specified index type.
+ *
+ * <p>
+ *    <strong>Note!</strong>The default user identity index is only handled if a <em>Social Collaboration</em> license is in use.
+ *    The default user-generated content (UGC) index is only handled if a <em>Social Collaboration</em> license is in use.
+ * </p>Gets an index by name.
+ *
+ * <p>
+ *    Lookup order:
+ * </p>
+ * <ol>
+ *    <li>Custom <em>site</em> index</li>
+ *    <li>Custom <em>server</em> index</li>
+ *    <li><em>Default</em> index(-es), types specified by {@link senselogic.sitevision.api.search.index.IndexUtil.IndexType}</li>
+ * </ol>
+ * <p>
+ *    <strong>Note!</strong> Custom index is only handled if a <em>Search Package 2</em> license is in use.
+ *    The default user identity index is only handled if a <em>Social Collaboration</em> license is in use.
+ *    The default user-generated content (UGC) index is only handled if a <em>Social Collaboration</em> license is in use.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+declare namespace IndexUtil {
+  export { getDefaultIndex, getIndexByName };
+}
+
+export default IndexUtil;

package/server/IndexingUtil/index.d.ts

@@ -0,0 +1,92 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * Sets the resource priority for an indexable node.
+ *
+ * <p>
+ *    The <em>resource priority</em> of a node will influence its <em>document boost</em> when indexed.
+ * </p>
+ *
+ * <p>
+ *    <strong>Note!</strong> Method invocations that doesn't fulfill these 3 criteria will always fail (i.e. return <code>false</code>):
+ * </p>
+ * <ul>
+ *    <li>
+ *       The <code>aNode</code> must be an indexable node, typically a <code>sv:page</code>, <code>sv:article</code>,
+ *       <code>sv:file</code> or <code>sv:image</code>.
+ *    </li>
+ *    <li>
+ *       The <code>aPriority</code> must be in interval: [ {@link #MIN_RESOURCE_PRIORITY} .. {@link #MAX_RESOURCE_PRIORITY} ].
+ *    </li>
+ *    <li>
+ *       Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} and
+ *       {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MODIFY_SEARCH_PRIORITY}
+ *       on <code>aNode</code>.
+ *    </li>
+ * </ul>
+ * <p>
+ *    This method tries to acquire a <em>lock</em> on <code>aNode</code> in order to mutate its resource priority.
+ *    Mutation will fail (i.e. this method will return <code>false</code>) if <code>aNode</code> is already locked.
+ * </p>
+ *
+ * <p>
+ *    <em>Indexing note!</em> Changing the value of the resource priority of a node will automatically trigger a re-index of the node.
+ * </p>
+ * @param aNode the indexable node
+ * @param aPriority the priority, i.e. in interval: [ {@link #MIN_RESOURCE_PRIORITY} .. {@link #MAX_RESOURCE_PRIORITY} ]
+ * @return <code>true</code> if the operation succeeded, <code>false</code> otherwise
+ */
+export function setResourcePriority(aNode: Node, aPriority: number): boolean;
+
+/**
+ * Indexing utility interface.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.search.SearchFactory#getIndexingUtil()}.
+ *    See {@link senselogic.sitevision.api.search.SearchFactory} for how to obtain an instance of the <code>SearchFactory</code> interface.
+ * </p>Sets the resource priority for an indexable node.
+ *
+ * <p>
+ *    The <em>resource priority</em> of a node will influence its <em>document boost</em> when indexed.
+ * </p>
+ *
+ * <p>
+ *    <strong>Note!</strong> Method invocations that doesn't fulfill these 3 criteria will always fail (i.e. return <code>false</code>):
+ * </p>
+ * <ul>
+ *    <li>
+ *       The <code>aNode</code> must be an indexable node, typically a <code>sv:page</code>, <code>sv:article</code>,
+ *       <code>sv:file</code> or <code>sv:image</code>.
+ *    </li>
+ *    <li>
+ *       The <code>aPriority</code> must be in interval: [ {@link #MIN_RESOURCE_PRIORITY} .. {@link #MAX_RESOURCE_PRIORITY} ].
+ *    </li>
+ *    <li>
+ *       Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} and
+ *       {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MODIFY_SEARCH_PRIORITY}
+ *       on <code>aNode</code>.
+ *    </li>
+ * </ul>
+ * <p>
+ *    This method tries to acquire a <em>lock</em> on <code>aNode</code> in order to mutate its resource priority.
+ *    Mutation will fail (i.e. this method will return <code>false</code>) if <code>aNode</code> is already locked.
+ * </p>
+ *
+ * <p>
+ *    <em>Indexing note!</em> Changing the value of the resource priority of a node will automatically trigger a re-index of the node.
+ * </p>The minimum resource priority.
+ *
+ * A resource indexed with this priority value will get a document boost of <code>0.1F</code>.The default resource priority.
+ *
+ * A resource indexed with this priority value will get the default document boost of <code>1.0F</code>.The maximum resource priority.
+ *
+ * A resource indexed with this priority value will get a document boost of <code>2.0F</code>.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.4
+ */
+declare namespace IndexingUtil {
+  export { setResourcePriority };
+}
+
+export default IndexingUtil;