@sitevision/api 1.0.19 → 1.1.0-alpha.1

package/server/UserDataUtil/index.d.ts

@@ -1,112 +1,194 @@
-import Serializable from "../../builtins/Serializable";
-
-export interface UserDataUtil {
-  /**
-   * The read-only keys.
-   * @returns {Set<string>} a set of keys that are read-only 
-   */
-  getReadOnlyKeys(): Set<string>;
-
-  /**
-   * Gets user data for current user.
-   * @param {string} aUserDataKey - the data key
-   * @returns {Serializable} the value for aUserDataKey (typically a String), or null 
-   */
-  getUserData(aUserDataKey: string): Serializable;
-
-  /**
-   * Gets user data for a user.
-   * @param {Node} aUserNode - the user node (typically a sv:user or sv:simpleUser)
-   * @param {string} aUserDataKey - the data key
-   * @returns {Serializable} the value for aUserDataKey (typically a String), or null 
-   */
-  getUserData(aUserNode: Node, aUserDataKey: string): Serializable;
-
-  /**
-   * Removes user data.
-   * @param {string} aUserDataKey - the data key
-   */
-  removeUserData(aUserDataKey: string): void;
-
-  /**
-   * Removes user data for a user.
-   * @param {Node} aUserNode - the user node (typically a sv:user or sv:simpleUser)
-   * @param {string} aUserDataKey - the data key
-   */
-  removeUserData(aUserNode: Node, aUserDataKey: string): void;
-
-  /**
-   * Sets user data for current user.
-   * @param {string} aUserDataKey - the data key
-   * @param {Serializable} aSerializableValue - the data value (typically a String)
-   */
-  setUserData(aUserDataKey: string, aSerializableValue: Serializable): void;
-
-  /**
-   * Sets user data for a user.
-   * @param {Node} aUserNode - the user node (typically a sv:user or sv:simpleUser)
-   * @param {string} aUserDataKey - the data key
-   * @param {Serializable} aSerializableValue - the data value (typically a String)
-   */
-  setUserData(aUserNode: Node, aUserDataKey: string, aSerializableValue: Serializable): void;
-}
+import Node from "../../hidden/javax/jcr/Node";
 
 /**
  * The read-only keys.
- * @returns {Set<string>} a set of keys that are read-only 
+ *
+ * <p>
+ *    Mutating operations (set/remove) with any of these keys will be ignored.
+ * </p>
+ * <p>
+ *    <em>Note that internal-only properties are not included in the returned set, but they will also be ignored in mutating operations.</em>
+ * </p>
+ * @return a set of keys that are read-only
  */
-export function getReadOnlyKeys(): Set<string>;
+export function getReadOnlyKeys(): Set<unknown>;
 
 /**
  * Gets user data for current user.
- * @param {string} aUserDataKey - the data key
- * @returns {Serializable} the value for aUserDataKey (typically a String), or null 
+ *
+ * <p>
+ *    <em>This read operation is equivalent to using the user info mechanism of the portlet specification.</em>
+ * </p>
+ * @param aUserDataKey the data key
+ * @return the value for <code>aUserDataKey</code> (typically a <code>String</code>), or null
  */
-export function getUserData(aUserDataKey: string): Serializable;
+export function getUserData(aUserDataKey: string): unknown;
 
 /**
  * Gets user data for a user.
- * @param {Node} aUserNode - the user node (typically a sv:user or sv:simpleUser)
- * @param {string} aUserDataKey - the data key
- * @returns {Serializable} the value for aUserDataKey (typically a String), or null 
+ * @param aUserNode the user node (typically a <code>sv:user</code> or <code>sv:simpleUser</code>)
+ * @param aUserDataKey the data key
+ * @return the value for <code>aUserDataKey</code> (typically a <code>String</code>), or null
  */
-export function getUserData(aUserNode: Node, aUserDataKey: string): Serializable;
+export function getUserData(aUserNode: Node, aUserDataKey: string): unknown;
 
 /**
- * Removes user data.
- * @param {string} aUserDataKey - the data key
+ * Sets user data for current user.
+ *
+ * <p>
+ *    <em>This write operation is equivalent to using the Sitevision-specific user info mechanism of the portlet specification.</em>
+ * </p>
+ *
+ * <p>
+ *    <em>Important note!</em> The set/write operation will be ignored if <code>aUserDataKey</code> is <code>null</code>, whitespace-only or
+ *    <em>read-only</em> (see {@link #getReadOnlyKeys}). The set operation will also be ignored if <code>aSerializableValue</code>
+ *    is <code>null</code>.
+ *    Use {@link #removeUserData(String)} to remove data instead.
+ * </p>
+ * @param aUserDataKey the data key
+ * @param aSerializableValue the data value (typically a <code>String</code>)
  */
-export function removeUserData(aUserDataKey: string): void;
+export function setUserData(
+  aUserDataKey: string,
+  aSerializableValue: unknown
+): void;
 
 /**
- * Removes user data for a user.
- * @param {Node} aUserNode - the user node (typically a sv:user or sv:simpleUser)
- * @param {string} aUserDataKey - the data key
+ * Sets user data for a user.
+ *
+ * <p>
+ *    <em>Important note!</em> The set/write operation will be ignored if <code>aUserDataKey</code> is <code>null</code>, whitespace-only or
+ *    <em>read-only</em> (see {@link #getReadOnlyKeys}). The set operation will also be ignored if <code>aSerializableValue</code>
+ *    is <code>null</code>.
+ *    Use {@link #removeUserData(String)} to remove data instead.
+ * </p>
+ *
+ * <p>
+ *    <em>Permission note!</em> Current user (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}) must have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on current site
+ *    (as of {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getSite()}), otherwise the set/write operation will be ignored.
+ * </p>
+ * @param aUserNode the user node (typically a <code>sv:user</code> or <code>sv:simpleUser</code>)
+ * @param aUserDataKey the data key
+ * @param aSerializableValue the data value (typically a <code>String</code>)
  */
-export function removeUserData(aUserNode: Node, aUserDataKey: string): void;
+export function setUserData(
+  aUserNode: Node,
+  aUserDataKey: string,
+  aSerializableValue: unknown
+): void;
 
 /**
- * Sets user data for current user.
- * @param {string} aUserDataKey - the data key
- * @param {Serializable} aSerializableValue - the data value (typically a String)
+ * Removes user data.
+ *
+ * <p>
+ *    <em>Important note!</em> The remove/delete operation will be ignored if <code>aUserDataKey</code> is <code>null</code>, whitespace-only or
+ *    <em>read-only</em> (see {@link #getReadOnlyKeys}).
+ * </p>
+ * @param aUserDataKey the data key
  */
-export function setUserData(aUserDataKey: string, aSerializableValue: Serializable): void;
+export function removeUserData(aUserDataKey: string): void;
 
 /**
- * Sets user data for a user.
- * @param {Node} aUserNode - the user node (typically a sv:user or sv:simpleUser)
- * @param {string} aUserDataKey - the data key
- * @param {Serializable} aSerializableValue - the data value (typically a String)
+ * Removes user data for a user.
+ *
+ * <p>
+ *    <em>Important note!</em> The remove/delete operation will be ignored if <code>aUserDataKey</code> is <code>null</code>, whitespace-only or
+ *    <em>read-only</em> (see {@link #getReadOnlyKeys}).
+ * </p>
+ *
+ * <p>
+ *    <em>Permission note!</em> Current user (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}) must have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on current site
+ *    (as of {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getSite()}), otherwise the remove/delete operation will be ignored.
+ * </p>
+ * @param aUserNode the user node (typically a <code>sv:user</code> or <code>sv:simpleUser</code>)
+ * @param aUserDataKey the data key
  */
-export function setUserData(aUserNode: Node, aUserDataKey: string, aSerializableValue: Serializable): void;
+export function removeUserData(aUserNode: Node, aUserDataKey: string): void;
 
-declare namespace userDataUtil {
-  export {
-    getReadOnlyKeys,
-    getUserData,
-    removeUserData,
-    setUserData,
-  };
+/**
+ * User data utility interface.
+ *
+ * <p>
+ *    The portlet specification allows access of user-specific data via a read-only <code>java.util.Map</code>
+ *    that can be obtained as request attribute using the <code>PortletRequest.USER_INFO</code> constant.
+ *    This utility is a convenience to get such user data, but it also extends it by allowing write operations
+ *    and access other user's data. Data written via this utility can be accesses via the Map exposed via the
+ *    <code>PortletRequest.USER_INFO</code> constant and vice versa. Hence, with this utility there are no need to use
+ *    the portlet specification mechanism for accessing user data.
+ * </p>
+ *
+ * <p>
+ *    Mutating data operations (set/remove) on other users requires certain permissions, see individual method documentation.
+ * </p>
+ *
+ * <p>
+ *    <strong>Important note!</strong> The user data mechanism is closely tied to a specific user object and is intended to handle
+ *    basic <em>user information</em> and <em>user preferences</em>. Adding "too much" (count) or "too large" (size) user data
+ *    might cause persistence implications and performance implications.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link UserFactory#getUserDataUtil()}.
+ *    See {@link senselogic.sitevision.api.user.UserFactory} for how to obtain an instance of the <code>UserFactory</code> interface.
+ * </p>The read-only keys.
+ *
+ * <p>
+ *    Mutating operations (set/remove) with any of these keys will be ignored.
+ * </p>
+ * <p>
+ *    <em>Note that internal-only properties are not included in the returned set, but they will also be ignored in mutating operations.</em>
+ * </p>Gets user data for current user.
+ *
+ * <p>
+ *    <em>This read operation is equivalent to using the user info mechanism of the portlet specification.</em>
+ * </p>Gets user data for a user.Sets user data for current user.
+ *
+ * <p>
+ *    <em>This write operation is equivalent to using the Sitevision-specific user info mechanism of the portlet specification.</em>
+ * </p>
+ *
+ * <p>
+ *    <em>Important note!</em> The set/write operation will be ignored if <code>aUserDataKey</code> is <code>null</code>, whitespace-only or
+ *    <em>read-only</em> (see {@link #getReadOnlyKeys}). The set operation will also be ignored if <code>aSerializableValue</code>
+ *    is <code>null</code>.
+ *    Use {@link #removeUserData(String)} to remove data instead.
+ * </p>Sets user data for a user.
+ *
+ * <p>
+ *    <em>Important note!</em> The set/write operation will be ignored if <code>aUserDataKey</code> is <code>null</code>, whitespace-only or
+ *    <em>read-only</em> (see {@link #getReadOnlyKeys}). The set operation will also be ignored if <code>aSerializableValue</code>
+ *    is <code>null</code>.
+ *    Use {@link #removeUserData(String)} to remove data instead.
+ * </p>
+ *
+ * <p>
+ *    <em>Permission note!</em> Current user (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}) must have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on current site
+ *    (as of {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getSite()}), otherwise the set/write operation will be ignored.
+ * </p>Removes user data.
+ *
+ * <p>
+ *    <em>Important note!</em> The remove/delete operation will be ignored if <code>aUserDataKey</code> is <code>null</code>, whitespace-only or
+ *    <em>read-only</em> (see {@link #getReadOnlyKeys}).
+ * </p>Removes user data for a user.
+ *
+ * <p>
+ *    <em>Important note!</em> The remove/delete operation will be ignored if <code>aUserDataKey</code> is <code>null</code>, whitespace-only or
+ *    <em>read-only</em> (see {@link #getReadOnlyKeys}).
+ * </p>
+ *
+ * <p>
+ *    <em>Permission note!</em> Current user (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}) must have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on current site
+ *    (as of {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getSite()}), otherwise the remove/delete operation will be ignored.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 4.1
+ */
+declare namespace UserDataUtil {
+  export { getReadOnlyKeys, getUserData, setUserData, removeUserData };
 }
 
-export default userDataUtil;
+export default UserDataUtil;

package/server/UserFactory/index.d.ts

@@ -1,58 +1,73 @@
-import Node from '../../builtins/Node';
+import UserIdentityUtil from "../UserIdentityUtil";
+import Node from "../../hidden/javax/jcr/Node";
+import UserIdentityWrapper from "../../hidden/senselogic/sitevision/api/user/UserIdentityWrapper";
+import SystemUserUtil from "../SystemUserUtil";
+import UserUtil from "../UserUtil";
+import SimpleUserUtil from "../SimpleUserUtil";
+import UserDataUtil from "../UserDataUtil";
 
-import { SimpleUserUtil } from '../SimpleUserUtil';
-import { SystemUserUtil } from '../SystemUserUtil';
-import { UserDataUtil } from '../UserDataUtil';
-import { UserIdentityUtil } from '../UserIdentityUtil';
-import { UserIdentityWrapper } from '../UserIdentityWrapper';
-import { UserUtil } from '../UserUtil';
+/**
+ * Gets an instance of a user identity utility class.
+ * @return an instance of a user identity utility class
+ */
+export function getUserIdentityUtil(): UserIdentityUtil;
 
 /**
- * Gets an instance of a simple user utility class.
- * @returns {SimpleUserUtil} an instance of a simple user utility class 
+ * Gets an instance of a user identity wrapper.
+ * @param aUserIdentity a user identity (or user)
+ * @return an instance of a user identity wrapper, or <code>null</code> if indeterminable (e.g. <code>aUserIdentity</code> is <code>null</code>)
  */
-export function getSimpleUserUtil(): SimpleUserUtil;
+export function getUserIdentityWrapper(
+  aUserIdentity: Node
+): UserIdentityWrapper;
 
 /**
  * Gets an instance of a system user utility class.
- * @returns {SystemUserUtil} an instance of a system user utility class 
+ * @return an instance of a system user utility class
  */
 export function getSystemUserUtil(): SystemUserUtil;
 
 /**
- * Gets an instance of a user data utility class.
- * @returns {UserDataUtil} an instance of a user data utility class 
+ * Gets an instance of a user utility class.
+ * @return an instance of a user utility class
+ * @since Sitevision 4.0.1
  */
-export function getUserDataUtil(): UserDataUtil;
+export function getUserUtil(): UserUtil;
 
 /**
- * Gets an instance of a user identity utility class.
- * @returns {UserIdentityUtil} an instance of a user identity utility class 
+ * Gets an instance of a simple user utility class.
+ * @return an instance of a simple user utility class
+ * @since Sitevision 4.0.1
  */
-export function getUserIdentityUtil(): UserIdentityUtil;
+export function getSimpleUserUtil(): SimpleUserUtil;
 
 /**
- * Gets an instance of a user identity wrapper.
- * @param {Node} aUserIdentity - a user identity (or user)
- * @returns {UserIdentityWrapper} an instance of a user identity wrapper, or null if indeterminable (e.g. aUserIdentity is null) 
+ * Gets an instance of a user data utility class.
+ * @return an instance of a user data utility class
+ * @since Sitevision 4.1
  */
-export function getUserIdentityWrapper(aUserIdentity: Node): UserIdentityWrapper;
+export function getUserDataUtil(): UserDataUtil;
 
 /**
- * Gets an instance of a user utility class.
- * @returns {UserUtil} an instance of a user utility class 
+ * Factory for creating user-related instances.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getUserFactory()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Gets an instance of a user identity utility class.Gets an instance of a user identity wrapper.Gets an instance of a system user utility class.Gets an instance of a user utility class.Gets an instance of a simple user utility class.Gets an instance of a user data utility class.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
  */
-export function getUserUtil(): UserUtil;
-
-declare namespace userFactory {
+declare namespace UserFactory {
   export {
-    getSimpleUserUtil,
-    getSystemUserUtil,
-    getUserDataUtil,
     getUserIdentityUtil,
     getUserIdentityWrapper,
+    getSystemUserUtil,
     getUserUtil,
+    getSimpleUserUtil,
+    getUserDataUtil,
   };
 }
 
-export default userFactory;
+export default UserFactory;

package/server/UserFieldRenderer/index.d.ts

@@ -0,0 +1,258 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * Updates the renderer with a new user identity node.
+ *
+ * <p>
+ * If <code>aUserIdentity</code> is not a renderable node, the argument will be considered as <code>null</code>, i.e.
+ * the renderer will not have any renderable node in subsequent render execution.
+ * </p>
+ * @param aUserIdentity a user identity node, or a user that has an identity on current site
+ */
+export function update(aUserIdentity: Node): void;
+
+/**
+ * Whether or not this renderer contains a user identity.
+ * @return <code>true</code> if a renderable node is loaded, <code>false</code> if not.
+ */
+export function isLoaded(): boolean;
+
+/**
+ * Helper method to check if a certain node can be rendered.
+ *
+ * <p>
+ *    Nodes with the following primary node types are potentially renderable:
+ * </p>
+ * <ul>
+ *    <li><code>sv:userIdentity</code></li>
+ *    <li><code>sv:user</code> <em>(non-anonymous)</em> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+ *    <li><code>sv:simpleUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+ *    <li><code>sv:systemUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+ * </ul>
+ * @param aNode the node to check
+ * @return <code>true</code> if <code>aNode</code> is supported by this renderer, <code>false</code> if not
+ */
+export function isRenderable(aNode: Node): boolean;
+
+/**
+ * Helper method to check if a named user field is available.
+ *
+ * <p>
+ *    <strong>An important note about field names and user field lookup!</strong> A specific user field can be found
+ *    via <em>multiple</em> names:
+ * </p>
+ * <ol>
+ *    <li>Primarily user fields are found via their <em>UI name</em>.</li>
+ *    <li>Secondary user fields are found via their <em>Ldap name</em> (ldap-read fields only).</li>
+ *    <li>As last resort user fields are found via their <em>Index name</em>.</li>
+ * </ol>
+ * <p>
+ *    <em>First found match is used!</em>
+ * </p>
+ * <p>
+ *    This is a convenience to make user fields easier to find, but <em>beware of colliding names</em>! For instance,
+ *    if field A has Ldap name "X" and field B has UI name "X" - field B will be used.
+ * </p>
+ * @param aUserFieldName the name of the user field
+ * @return <code>true</code> if current site has a user field that can be found via <code>aUserFieldName</code>, <code>false</code> if not
+ */
+export function isValidFieldName(aUserFieldName: string): boolean;
+
+/**
+ * Returns the value as html for a named user field for currently loaded user identity.
+ *
+ * <p>
+ *    The rendered output of the user field value is handled as:
+ * </p>
+ * <ul>
+ *    <li>The value is XML escaped (see: {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)})</li>
+ *    <li>Line breaks are converted to &lt;br&gt; (see: {@link senselogic.sitevision.api.text.EndecUtil#br(String)})</li>
+ *    <li>Potential links are converted to anchors (see: {@link senselogic.sitevision.api.render.OutputUtil#getHyperlinkedText(String)})</li>
+ * </ul>
+ *
+ * <p>
+ *    <em>Note! The result of this method is equivalent with calling {@link #getPlainUserFieldValueAsHtml(String)} with the
+ *    result of the {@link #renderPlain(String)} method, but this method is more efficient and should always be preferred.</em>
+ * </p>
+ * @param aUserFieldName the name of the user field, see: {@link #isValidFieldName(String)}
+ * @return a html string, ready to print out on a page. Might be empty but never <code>null</code>.
+ */
+export function render(aUserFieldName: string): string;
+
+/**
+ * Returns the value as plain text for a named user field for currently loaded user identity.
+ *
+ * <p>
+ *    <strong>Note!</strong> The rendered output is plain text and <em>must be escaped</em> if it should be part of the html output of a page!
+ * </p>
+ * @param aUserFieldName the name of the user field, see: {@link #isValidFieldName(String)}
+ * @return a plain string. Might be empty but never <code>null</code>.
+ * @since Sitevision 3.6
+ * @see #render(String)
+ */
+export function renderPlain(aUserFieldName: string): string;
+
+/**
+ * Returns a plain text user field value as html.
+ *
+ * <p>
+ *    <strong>Note!</strong> This method is <em>stateless</em>, i.e. you don't have to have a user identity loaded to call this method.
+ *    Typically you would always use the {@link #render(String)} whenever possible. This method should only be used when you have a plain
+ *    text user field value, but no user identity (e.g. in large search results where you want to avoid loading lots of user identity objects).
+ * </p>
+ * <p>
+ *    The rendered output of the plain text user field value is handled as:
+ * </p>
+ * <ul>
+ *    <li>The value is XML escaped (see: {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)})</li>
+ *    <li>Line breaks are converted to &lt;br&gt; (see: {@link senselogic.sitevision.api.text.EndecUtil#br(String)})</li>
+ *    <li>Potential links are converted to anchors (see: {@link senselogic.sitevision.api.render.OutputUtil#getHyperlinkedText(String)})</li>
+ * </ul>
+ * @param aPlainUserFieldValue the plain text user field value
+ * @return a html string, ready to print out on a page. Might be empty but never <code>null</code>.
+ * @since Sitevision 3.6
+ */
+export function getPlainUserFieldValueAsHtml(
+  aPlainUserFieldValue: string
+): string;
+
+/**
+ * UserFieldRenderer is a stateful utility interface for rendering user field values for user identities.
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getUserFieldRenderer()}.
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ *
+ * <p>
+ *   Using the UserFieldRenderer is pretty straightforward, if you remember that it is <strong>stateful</strong> and that the previously loaded
+ *   user identity node will be cleared whenever you try to load a new one. Conceptually you would typically use it like this:
+ * </p>
+ * <ol>
+ *   <li>Get the UserFieldRenderer</li>
+ *   <li>Set a user identity node</li>
+ *   <li>Do render of a named user field</li>
+ *   <li>Do render of another named user field</li>
+ *   <li>...</li>
+ * </ol>
+ * <p>
+ * You can then re-use the UserFieldRenderer for another user identity until you are done. Something like:
+ * </p>
+ * <ol>
+ *   <li>Update the user identity node</li>
+ *   <li>Do render of a named user field</li>
+ *   <li>Do render of another named user field</li>
+ *   <li>...</li>
+ * </ol>
+ *
+ * <p>
+ *    <strong>Example of how this strategy could be implemented in Velocity:</strong><br>
+ *    (You want to do a simple listing of the user fields "Namn" and "E-postadress" for some user identities or users in $myList)
+ * </p>
+ * <pre><code>
+ *   <em>## Get UserFieldRenderer</em>
+ *   #set ($userFieldRenderer = $sitevisionUtils.userFieldRenderer)
+ *
+ *   <em>## Ensure at least one of the fields actually exist</em>
+ *   #if ($userFieldRenderer.isValidFieldName('Namn') || $userFieldRenderer.isValidFieldName('E-postadress'))
+ *     <em>## Iterate through the list and render fields for all valid nodes</em>
+ *     &lt;ul class="sv-no-list-style"&gt;
+ *     #foreach ($item in $myList)
+ *       <em>## Check if this node can be rendered</em>
+ *       #if ($userFieldRenderer.isRenderable($item))
+ *         <em>## Update the renderer and render</em>
+ *         $userFieldRenderer.update($item)
+ *         &lt;li&gt;
+ *           $userFieldRenderer.render('Namn')
+ *           $userFieldRenderer.render('E-postadress')
+ *         &lt;/li&gt;
+ *       #end
+ *     #end
+ *     &lt;/ul&gt;
+ *   #end
+ * </code></pre>
+ *
+ * <p>
+ *    <strong>Important rendering note!</strong> When rendering a user field value, you must specify the <em>name</em>
+ *    of the user field. See {@link #isValidFieldName(String)} for more information about how names are matched to user fields.
+ * </p>Updates the renderer with a new user identity node.
+ *
+ * <p>
+ * If <code>aUserIdentity</code> is not a renderable node, the argument will be considered as <code>null</code>, i.e.
+ * the renderer will not have any renderable node in subsequent render execution.
+ * </p>Whether or not this renderer contains a user identity.Helper method to check if a certain node can be rendered.
+ *
+ * <p>
+ *    Nodes with the following primary node types are potentially renderable:
+ * </p>
+ * <ul>
+ *    <li><code>sv:userIdentity</code></li>
+ *    <li><code>sv:user</code> <em>(non-anonymous)</em> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+ *    <li><code>sv:simpleUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+ *    <li><code>sv:systemUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+ * </ul>Helper method to check if a named user field is available.
+ *
+ * <p>
+ *    <strong>An important note about field names and user field lookup!</strong> A specific user field can be found
+ *    via <em>multiple</em> names:
+ * </p>
+ * <ol>
+ *    <li>Primarily user fields are found via their <em>UI name</em>.</li>
+ *    <li>Secondary user fields are found via their <em>Ldap name</em> (ldap-read fields only).</li>
+ *    <li>As last resort user fields are found via their <em>Index name</em>.</li>
+ * </ol>
+ * <p>
+ *    <em>First found match is used!</em>
+ * </p>
+ * <p>
+ *    This is a convenience to make user fields easier to find, but <em>beware of colliding names</em>! For instance,
+ *    if field A has Ldap name "X" and field B has UI name "X" - field B will be used.
+ * </p>Returns the value as html for a named user field for currently loaded user identity.
+ *
+ * <p>
+ *    The rendered output of the user field value is handled as:
+ * </p>
+ * <ul>
+ *    <li>The value is XML escaped (see: {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)})</li>
+ *    <li>Line breaks are converted to &lt;br&gt; (see: {@link senselogic.sitevision.api.text.EndecUtil#br(String)})</li>
+ *    <li>Potential links are converted to anchors (see: {@link senselogic.sitevision.api.render.OutputUtil#getHyperlinkedText(String)})</li>
+ * </ul>
+ *
+ * <p>
+ *    <em>Note! The result of this method is equivalent with calling {@link #getPlainUserFieldValueAsHtml(String)} with the
+ *    result of the {@link #renderPlain(String)} method, but this method is more efficient and should always be preferred.</em>
+ * </p>Returns the value as plain text for a named user field for currently loaded user identity.
+ *
+ * <p>
+ *    <strong>Note!</strong> The rendered output is plain text and <em>must be escaped</em> if it should be part of the html output of a page!
+ * </p>Returns a plain text user field value as html.
+ *
+ * <p>
+ *    <strong>Note!</strong> This method is <em>stateless</em>, i.e. you don't have to have a user identity loaded to call this method.
+ *    Typically you would always use the {@link #render(String)} whenever possible. This method should only be used when you have a plain
+ *    text user field value, but no user identity (e.g. in large search results where you want to avoid loading lots of user identity objects).
+ * </p>
+ * <p>
+ *    The rendered output of the plain text user field value is handled as:
+ * </p>
+ * <ul>
+ *    <li>The value is XML escaped (see: {@link senselogic.sitevision.api.text.EndecUtil#escapeXML(String)})</li>
+ *    <li>Line breaks are converted to &lt;br&gt; (see: {@link senselogic.sitevision.api.text.EndecUtil#br(String)})</li>
+ *    <li>Potential links are converted to anchors (see: {@link senselogic.sitevision.api.render.OutputUtil#getHyperlinkedText(String)})</li>
+ * </ul>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.5.3
+ */
+declare namespace UserFieldRenderer {
+  export {
+    update,
+    isLoaded,
+    isRenderable,
+    isValidFieldName,
+    render,
+    renderPlain,
+    getPlainUserFieldValueAsHtml,
+  };
+}
+
+export default UserFieldRenderer;