@sitevision/api 1.1.0-alpha.2 → 2.0.0-alpha.0

package/hidden/senselogic/sitevision/api/property/VersionedPropertyUtil/index.d.ts

@@ -46,195 +46,6 @@ import Binary from "../../../../../javax/jcr/Binary";
  *    An instance of the Sitevision class implementing this interface can be obtained via
  *    {@link senselogic.sitevision.api.Utils#getVersionedPropertyUtil(int)}.
  *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Gets a String property from a potential Node in a specific version.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a String property from a potential Node in a specific version - with a fallback value if the property doesn't exist.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a String property from a potential "nested" Node's property in a specific version.
- * (i.e. the base <code>Node</code> has a property that is a <code>Node</code>,
- * and that "inner/nested" <code>Node</code> has a <code>String</code> property).
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aNodePropertyName</code> and <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a String property from a potential "nested" Node's property in a specific version - with a fallback value if the property doesn't exist.
- * (i.e. the base <code>Node</code> has a property that is a <code>Node</code>,
- * and that "inner/nested" <code>Node</code> has a <code>String</code> property).
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aNodePropertyName</code> and <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a <code>List</code> of property values from a potential Node in a specific version.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a <code>List</code> of property values from a potential Node in a specific version - with a fallback value if the property doesn't exist.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a <code>List</code> of property values from a potential "nested" Node's property in a specific version.
- * (i.e. the base <code>Node</code> has a property that is a <code>Node</code>,
- * and that "inner/nested" <code>Node</code> has a <code>String</code> property).
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aNodePropertyName</code> and <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a <code>List</code> of property values from a potential "nested" Node's property in a specific version
- * - with a fallback value if the property doesn't exist.
- * (i.e. the base <code>Node</code> has a property that is a <code>Node</code>,
- * and that "inner/nested" <code>Node</code> has a <code>String</code> property).
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aNodePropertyName</code> and <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets an int property from a potential Node in a specific version.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets an int property from a potential node in a specific version -  with a fallback value if the property doesn't exist.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a boolean property from a potential Node in a specific version.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a boolean property from a potential Node in a specific version - with a fallback value if the property doesn't exist.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a Calendar property from a potential Node in a specific version.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a Calendar property from a potential Node in a specific version - with a fallback value if the property doesn't exist.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a double property from a potential Node in a specific version.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a double property from a potential Node in a specific version - with a fallback value if the property doesn't exist.
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a Binary property from a potential Node in a specific version.
- *
- * <p>
- *    Ensure to always handle resources appropriately when working with Binary! If you get a stream via {@link javax.jcr.Binary#getStream()},
- *    you must also <code>close</code> the stream when you are done.
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> The <code>Binary</code> support is limited, see {@link javax.jcr.Property#getBinary()} for more information!
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
- * </p>Gets a Binary property from a potential Node in a specific version - with a fallback value if the property doesn't exist.
- *
- * <p>
- *    Ensure to always handle resources appropriately when working with Binary! If you get a stream via {@link javax.jcr.Binary#getStream()},
- *    you must also <code>close</code> the stream when you are done.
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> The <code>Binary</code> support is limited, see {@link javax.jcr.Property#getBinary()} for more information!
- * </p>
- *
- * <p>
- *    <strong>Note!</strong> This method does <em>not</em> escape names (i.e. <code>aPropertyName</code>).
- *    Illegal characters in node names and property names must always be escaped,
- *    typically via {@link senselogic.sitevision.api.text.EndecUtil#escapeJcrName(String)}.
- *    For best performance - never escape a name if you are certain that it doesn't contain any illegal characters.
- *    Sitevision model properties never contain illegal characters. Though, depending on configuration "dynamic" ones
- *    (e.g. metadata properties) might contain illegal characters.
  * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.0
@@ -346,7 +157,7 @@ interface VersionedPropertyUtil {
    * @param aPropertyName the name of the property
    * @return the value for <code>aPropertyName</code> as <code>String</code>. If the property is single valued a list with one element is returned. If no node or property exists, <code>null</code> is returned.
    */
-  getStrings(aNodeIdentifier: string, aPropertyName: string): unknown[];
+  getStrings(aNodeIdentifier: string, aPropertyName: string): unknown;
 
   /**
    * Gets a <code>List</code> of property values from a potential Node in a specific version - with a fallback value if the property doesn't exist.
@@ -367,8 +178,8 @@ interface VersionedPropertyUtil {
   getStrings(
     aNodeIdentifier: string,
     aPropertyName: string,
-    aDefaultValue: unknown[]
-  ): unknown[];
+    aDefaultValue: unknown
+  ): unknown;
 
   /**
    * Gets a <code>List</code> of property values from a potential "nested" Node's property in a specific version.
@@ -392,7 +203,7 @@ interface VersionedPropertyUtil {
     aNodeIdentifier: string,
     aNodePropertyName: string,
     aPropertyName: string
-  ): unknown[];
+  ): unknown;
 
   /**
    * Gets a <code>List</code> of property values from a potential "nested" Node's property in a specific version
@@ -418,8 +229,8 @@ interface VersionedPropertyUtil {
     aNodeIdentifier: string,
     aNodePropertyName: string,
     aPropertyName: string,
-    aDefaultValue: unknown[]
-  ): unknown[];
+    aDefaultValue: unknown
+  ): unknown;
 
   /**
    * Gets an int property from a potential Node in a specific version.

package/hidden/senselogic/sitevision/api/property/VersionedPropertyUtil/index.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getString: function getString() {},
+  getNestedString: function getNestedString() {},
+  getStrings: function getStrings() {},
+  getNestedStrings: function getNestedStrings() {},
+  getInt: function getInt() {},
+  getBoolean: function getBoolean() {},
+  getCalendar: function getCalendar() {},
+  getDouble: function getDouble() {},
+  getBinary: function getBinary() {}
+};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/redirect/RedirectUtil/index.d.ts

@@ -0,0 +1,73 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * Redirect utility interface (301 redirects for <em>"old urls"</em>).
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getRedirectUtil()}.
+ *    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 4.0.3
+ */
+
+interface RedirectUtil {
+  /**
+   * Gets all 301 redirect URIs registered for a specific node.
+   * @param aNode a node, typically a <code>sv:page</code>
+   * @return a set of 301 redirect URIs for <code>aNode</code>, never <code>null</code>
+   */
+  getRedirectURIs(aNode: Node): Set<unknown>;
+
+  /**
+   * Adds a relative URI that should trigger a 301 redirect to a specific node.
+   *
+   * <p>
+   *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+   * </p>
+   * @param aNode a node, typically a <code>sv:page</code>
+   * @param aRelativeURI the relative URI that should trigger a 301 redirect to <code>aNode</code>.
+   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, whitespace-only or an absolute URI.
+   * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
+   */
+  addRedirectURI(aNode: Node, aRelativeURI: java.lang.String): void;
+
+  /**
+   * Adds a collection of relative URIs that should trigger 301 redirects to a specific node.
+   *
+   * <p>
+   *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+   * </p>
+   * @param aNode a node, typically a <code>sv:page</code>
+   * @param aRelativeURIs a collection of relative URIs that should trigger 301 redirects to <code>aNode</code>.
+   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, empty or doesn't contain any non-whitespace only or an non-absolute URI.
+   * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
+   */
+  addRedirectURIs(aNode: Node, aRelativeURIs: java.util.Collection): void;
+
+  /**
+   * Removes a relative 301 redirect URI from a specific node.
+   *
+   * <p>
+   *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+   * </p>
+   * @param aNode a node, typically a <code>sv:page</code>
+   * @param aRelativeURI the relative URI that should be removed from <code>aNode</code>.
+   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node, if <code>aRelativeURI</code> is <code>null</code>, whitespace-only or an absolute URI.
+   * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
+   */
+  removeRedirectURI(aNode: Node, aRelativeURI: java.lang.String): void;
+
+  /**
+   * Removes all relative 301 redirect URIs from a specific node.
+   *
+   * <p>
+   *    Permission note! Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on <code>aNode</code>.
+   * </p>
+   * @param aNode a node, typically a <code>sv:page</code>
+   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or an invalid node,
+   * @throws RepositoryException if current user is not authorized to alter <code>aNode</code>, if <code>aNode</code> is already locked or something else goes wrong
+   */
+  removeAllRedirectURIs(aNode: Node): void;
+}

package/hidden/senselogic/sitevision/api/render/BuddyIconRenderer/index.d.ts

@@ -0,0 +1,186 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * BuddyIconRenderer is a stateful utility interface for rendering of buddy icons for user identities and collaboration groups.
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getBuddyIconRenderer()}.
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ *
+ * <p>
+ *  BuddyIconRenderer has few attributes:
+ * </p>
+ * <ul>
+ *    <li><em>buddyIconNode</em> - The node that should be rendered as a buddy icon. Default is <code>null</code>.
+ *    </li>
+ *    <li><em>buddyIconSize</em> - The size of the buddy icon that is rendered. Default is <code>BuddyIconSize.SMALL</code>. Note that image size
+ *    settings are followed with best effort. Images will never be upscaled.
+ *    </li>
+ *    <li><em>linkBuddyIcon</em> - Whether or not rendered buddy icons should be linked. Default is <code>true</code>.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *   Using the BuddyIconRenderer is pretty straightforward, if you remember that it is <strong>stateful</strong> and that the previously
+ *   loaded buddy icon 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 BuddyIconRenderer</li>
+ *   <li>Possibly init the renderer with rendering settings (buddyIconSize, linkBuddyIcon)</li>
+ *   <li>Set a buddy icon node</li>
+ *   <li>Do render</li>
+ * </ol>
+ * <p>
+ * When you have rendered once, you can re-use the BuddyIconRenderer until you are done. Something like:
+ * </p>
+ * <ol>
+ *   <li>Update the buddy icon node</li>
+ *   <li>Do render.</li>
+ * </ol>
+ *
+ * <p>
+ *    <strong>Example of how this strategy could be implemented in Velocity:</strong><br>
+ *    (You want to do a simple listing of buddy icons for some collaboration groups, collaboration group pages, user identities or users)
+ * </p>
+ * <pre><code>
+ *   <em>## Get BuddyIconRenderer</em>
+ *   #set ($buddyIconRenderer = $sitevisionUtils.buddyIconRenderer)
+ *
+ *   <em>## Iterate through the list of nodes and render a buddy icon for all supported nodes</em>
+ *   &lt;ul class="sv-no-list-style"&gt;
+ *   #foreach ($item in $items)
+ *     <em>## Check if this node can be rendered as a buddy icon</em>
+ *     #if ($buddyIconRenderer.isRenderable($item))
+ *       <em>## Update the renderer and render</em>
+ *       $buddyIconRenderer.update($item)
+ *       &lt;li&gt;
+ *          $buddyIconRenderer.render()
+ *       &lt;/li&gt;
+ *     #end
+ *   #end
+ *   &lt;/ul&gt;
+ * </code></pre>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.5.3
+ */
+
+interface BuddyIconRenderer {
+  /**
+   * Sets the size for rendered buddy icons.
+   *
+   * <p>Default is <code>BuddyIconSize.SMALL</code></p>
+   * @param aBuddyIconSize the icon size
+   */
+  setBuddyIconSize(
+    aBuddyIconSize: senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize
+  ): void;
+
+  /**
+   * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.SMALL)</code>
+   * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
+   * @see BuddyIconSize#SMALL
+   */
+  forceUseSmallBuddyIconSize(): void;
+
+  /**
+   * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.LARGE)</code>
+   * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
+   * @see BuddyIconSize#LARGE
+   */
+  forceUseLargeBuddyIconSize(): void;
+
+  /**
+   * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.X_LARGE)</code>
+   * @since Sitevision 8.2
+   * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
+   * @see BuddyIconSize#X_LARGE
+   */
+  forceUseXLargeBuddyIconSize(): void;
+
+  /**
+   * Whether or not rendered buddy icons should be linked.
+   *
+   * <p>Default is <code>true</code></p>
+   * @param aLinkBuddyIcon Whether or not buddy icons should be linked.
+   */
+  setLinkBuddyIcon(aLinkBuddyIcon: boolean): void;
+
+  /**
+   * Utility method for executing <code>setLinkBuddyIcon(false)</code>
+   * @see #setLinkBuddyIcon(boolean)
+   */
+  clearUseLinkBuddyIcon(): void;
+
+  /**
+   * Utility method for executing <code>setLinkBuddyIcon(true)</code>
+   * @see #setLinkBuddyIcon(boolean)
+   */
+  forceUseLinkBuddyIcon(): void;
+
+  /**
+   * Updates the renderer with a new buddy icon supported node.
+   *
+   * <p>
+   *    If <code>aBuddyIconNode</code> is not a type that can be represented by a buddy icon, 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 aBuddyIconNode a node that can be rendered as a buddy icon.
+   */
+  update(aBuddyIconNode: Node): void;
+
+  /**
+   * Whether or not this renderer contains a node that can be rendered.
+   * @return <code>true</code> if a renderable node is loaded, <code>false</code> if not.
+   */
+  isLoaded(): boolean;
+
+  /**
+   * Helper method to check if a certain node can be rendered as a buddy icon.
+   *
+   * <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 style="margin-bottom:1em"><code>sv:systemUser</code> &raquo; <em>will be renderable if a sv:userIdentity can be extracted</em></li>
+   *    <li><code>sv:collaborationGroup</code></li>
+   *    <li><code>sv:collaborationGroupPage</code> &raquo; <em>will be renderable if a sv:collaborationGroup 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
+   */
+  isRenderable(aNode: Node): boolean;
+
+  /**
+   * BuddyIconInfo for current state.
+   *
+   * <p>
+   *    <em>
+   *       The data this method provides is used by the {@link #render()} method.
+   *       The intent of this method is to facilitate custom buddy icon rendering solutions.
+   *       See {@link BuddyIconInfo} for such example.
+   *    </em>
+   * </p>
+   *
+   * <p>
+   *    Note! Returned BuddyIconInfo object is never null but its <code>uri</code> will potentially be null and its
+   *    <code>width</code>/<code>height</code> might be zero.
+   *    Typically when this renderer has no valid/renderable node loaded, see {@link #isLoaded()}.
+   * </p>
+   * @return the BuddyIconInfo for current state, is never null.
+   * @since Sitevision 8.2
+   */
+  getBuddyIconInfo(): BuddyIconInfo;
+
+  /**
+   * Builds a html string based on current state.
+   *
+   * <strong>Size note!</strong> Profile images will never be upscaled. If a buddy icon size is larger than the actual size of the profile image,
+   * the image will be rendered with the largest possible buddy icon size.
+   * @return a html string, ready to print out on a page. Might be empty but never <code>null</code>.
+   */
+  render(): string;
+}