@sitevision/api 1.0.20 → 1.1.0-alpha.1

package/server/BookmarkUtil/index.d.ts

@@ -1,59 +1,50 @@
-import List from '../../builtins/List';
-import Node from '../../builtins/Node';
+import Node from "../../hidden/javax/jcr/Node";
 
 /**
  * Returns a list of <code>Node</code> objects for all bookmarks belonging to
  * the current user regardless of category. This method only returns valid bookmarks
  * (existing, published objects)
- *
- * @return {List<Node>} a list of bookmark nodes. Is never <code>null</code>
+ * @return a list of bookmark nodes. Is never <code>null</code>
  */
-export function getBookmarks(): List<Node>;
+export function getBookmarks(): unknown[];
 
 /**
  * Returns a list of <code>Node</code> objects corresponding to the bookmarks for
  * the current user and the provided categories. This method only returns valid bookmarks
  * (existing, published objects)
- *
- * @param {string} category a comma separated list of categories or <code>null</code> for no category
- * @return {List<Node>} a list of bookmark nodes. Is never <code>null</code>
+ * @param category a comma separated list of categories or <code>null</code> for no category
+ * @return a list of bookmark nodes. Is never <code>null</code>
  */
-export function getBookmarks(category: string): List<Node>;
+export function getBookmarks(category: string): unknown[];
 
 /**
  * Adds a bookmark for the current user. This operation is synchronized
- *
- * @param {Node} bookmark   the node to be bookmarked must be a <code>sv:page</code>,
- *                   <code>sv:sitePage</code> or an <code>sv:article</code>
- * @param {string} categories a comma separated list of categories to where this bookmark belongs
+ * @param bookmark the node to be bookmarked must be a <code>sv:page</code>, <code>sv:sitePage</code> or an <code>sv:article</code>
+ * @param categories a comma separated list of categories to where this bookmark belongs
  * @throws IllegalArgumentException if <code>bookmark</code> is node of wrong type
- * @throws NullPointerException     if <code>bookmark</code> is <code>null</code>
+ * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
  * @deprecated Use {@link #add(javax.jcr.Node)}, categories will be resolved from metadata.
  */
 export function add(bookmark: Node, categories: string): void;
 
 /**
  * Adds a bookmark for the current user. This operation is synchronized
- *
- * @param {Node} bookmark the node to be bookmarked must be a <code>sv:page</code>,
- *                 <code>sv:sitePage</code> or an <code>sv:article</code>
+ * @param bookmark the node to be bookmarked must be a <code>sv:page</code>, <code>sv:sitePage</code> or an <code>sv:article</code>
  * @throws IllegalArgumentException if bookmark is node of wrong type
- * @throws NullPointerException     if <code>bookmark</code> is <code>null</code>
+ * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
  */
 export function add(bookmark: Node): void;
 
 /**
  * Removes a bookmark for the current user. This operation is synchronized
- *
- * @param {Node} bookmark the bookmark
+ * @param bookmark the bookmark
  * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
  */
 export function remove(bookmark: Node): void;
 
 /**
  * Checks if the current user has the provided bookmark
- *
- * @param {Node} bookmark the bookmark
+ * @param bookmark the bookmark
  * @return if the user has provided bookmark
  * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
  */
@@ -63,8 +54,7 @@ export function contains(bookmark: Node): boolean;
  * Accesses a <code>boolean</code> indicating if the current site has a limited number of bookmarks.
  *
  * To get the max number of bookmarks, use {@link #getMaxNofBookmarks()}.
- *
- * @return {boolean} a <code>boolean</code> indicating if the current site has a limited number of bookmarks
+ * @return a <code>boolean</code> indicating if the current site has a limited number of bookmarks
  * @throws NullPointerException if current site is indeterminable
  * @see #getMaxNofBookmarks()
  * @since Sitevision 2.6.1_01
@@ -73,15 +63,33 @@ export function getLimitNofBookmarks(): boolean;
 
 /**
  * Accessor to max number of bookmarks for the current site.
- *
- * @return {number} max number of bookmarks for the current site
+ * @return max number of bookmarks for the current site
  * @throws NullPointerException if current site is indeterminable
  * @see #getLimitNofBookmarks()
  * @since Sitevision 2.6.1_01
  */
 export function getMaxNofBookmarks(): number;
 
-declare namespace bookmarkUtil {
+/**
+ * <p>Bookmark utility interface. Bookmarks are potentially clustered between sitevision instances.
+ * All altering methods in this class are synchronized.</p>
+ *
+ * <p><strong>Note:</strong> Does NOT work for anonymous users!</p>
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getBookmarkUtil()}.
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Returns a list of <code>Node</code> objects for all bookmarks belonging to
+ * the current user regardless of category. This method only returns valid bookmarks
+ * (existing, published objects)Returns a list of <code>Node</code> objects corresponding to the bookmarks for
+ * the current user and the provided categories. This method only returns valid bookmarks
+ * (existing, published objects)Adds a bookmark for the current user. This operation is synchronizedAdds a bookmark for the current user. This operation is synchronizedRemoves a bookmark for the current user. This operation is synchronizedChecks if the current user has the provided bookmarkAccesses a <code>boolean</code> indicating if the current site has a limited number of bookmarks.
+ *
+ * To get the max number of bookmarks, use {@link #getMaxNofBookmarks()}.Accessor to max number of bookmarks for the current site.
+ * @author Mikael Wikblom
+ * @since Sitevision 2.6.1
+ */
+declare namespace BookmarkUtil {
   export {
     getBookmarks,
     add,
@@ -92,4 +100,4 @@ declare namespace bookmarkUtil {
   };
 }
 
-export default bookmarkUtil;
+export default BookmarkUtil;

package/server/BuddyIconRenderer/index.d.ts

@@ -0,0 +1,240 @@
+import BuddyIconRenderer_BuddyIconSize from "../BuddyIconRenderer_BuddyIconSize";
+import Node from "../../hidden/javax/jcr/Node";
+import BuddyIconRenderer_BuddyIconInfo from "../../hidden/senselogic/sitevision/api/render/BuddyIconRenderer/BuddyIconInfo";
+
+/**
+ * Sets the size for rendered buddy icons.
+ *
+ * <p>Default is <code>BuddyIconSize.SMALL</code></p>
+ * @param aBuddyIconSize the icon size
+ */
+export function setBuddyIconSize(aBuddyIconSize: BuddyIconSize): void;
+
+/**
+ * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.SMALL)</code>
+ * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
+ * @see BuddyIconSize#SMALL
+ */
+export function forceUseSmallBuddyIconSize(): void;
+
+/**
+ * Utility method for executing <code>setBuddyIconSize(BuddyIconSize.LARGE)</code>
+ * @see #setBuddyIconSize(senselogic.sitevision.api.render.BuddyIconRenderer.BuddyIconSize)
+ * @see BuddyIconSize#LARGE
+ */
+export function 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
+ */
+export function 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.
+ */
+export function setLinkBuddyIcon(aLinkBuddyIcon: boolean): void;
+
+/**
+ * Utility method for executing <code>setLinkBuddyIcon(false)</code>
+ * @see #setLinkBuddyIcon(boolean)
+ */
+export function clearUseLinkBuddyIcon(): void;
+
+/**
+ * Utility method for executing <code>setLinkBuddyIcon(true)</code>
+ * @see #setLinkBuddyIcon(boolean)
+ */
+export function 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.
+ */
+export function 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.
+ */
+export function 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
+ */
+export function 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
+ */
+export function 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>.
+ */
+export function render(): string;
+
+/**
+ * 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>Sets the size for rendered buddy icons.
+ *
+ * <p>Default is <code>BuddyIconSize.SMALL</code></p>Utility method for executing <code>setBuddyIconSize(BuddyIconSize.SMALL)</code>Utility method for executing <code>setBuddyIconSize(BuddyIconSize.LARGE)</code>Utility method for executing <code>setBuddyIconSize(BuddyIconSize.X_LARGE)</code>Whether or not rendered buddy icons should be linked.
+ *
+ * <p>Default is <code>true</code></p>Utility method for executing <code>setLinkBuddyIcon(false)</code>Utility method for executing <code>setLinkBuddyIcon(true)</code>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>Whether or not this renderer contains a node that can be rendered.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>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>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.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.5.3
+ */
+declare namespace BuddyIconRenderer {
+  export {
+    setBuddyIconSize,
+    forceUseSmallBuddyIconSize,
+    forceUseLargeBuddyIconSize,
+    forceUseXLargeBuddyIconSize,
+    setLinkBuddyIcon,
+    clearUseLinkBuddyIcon,
+    forceUseLinkBuddyIcon,
+    update,
+    isLoaded,
+    isRenderable,
+    getBuddyIconInfo,
+    render,
+  };
+}
+
+export default BuddyIconRenderer;

package/server/ClientUtil/index.d.ts

@@ -1,12 +1,26 @@
 /**
  * Gets the Internet Protocol (IP) address of the client (or last proxy) that initiated currently executing request.
- *
- * @return {string} a <code>String</code> containing the IP address of the client that sent the request, or <code>null</code> if indeterminable
+ * @return a <code>String</code> containing the IP address of the client that sent the request, or <code>null</code> if indeterminable
  */
 export function getClientAddress(): string;
 
-declare namespace clientUtil {
+/**
+ * Client utility interface.
+ *
+ * <p>
+ * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getClientUtil()}.
+ * See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ *
+ * <p>
+ * <em>Tip!</em> If you want to check if current client is a mobile device, you would typically use
+ * {@link senselogic.sitevision.api.device.DeviceUtil}.
+ * </p>Gets the Internet Protocol (IP) address of the client (or last proxy) that initiated currently executing request.
+ * @author Magnus Lövgren
+ * @since Sitevision 2.6_02
+ */
+declare namespace ClientUtil {
   export { getClientAddress };
 }
 
-export default clientUtil;
+export default ClientUtil;

package/server/CollaborationFactory/index.d.ts

@@ -1,40 +1,57 @@
-import { ICollaborationGroupFolderUtil } from '../CollaborationGroupFolderUtil';
-import { ICollaborationGroupTemplateUtil } from '../CollaborationGroupTemplateUtil';
-import { ICollaborationGroupUtil } from '../CollaborationGroupUtil';
-import { ICollaborationGroupWrapper } from '../CollaborationGroupWrapper';
+import Node from "../../hidden/javax/jcr/Node";
+import CollaborationGroupWrapper from "../../hidden/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper";
+import CollaborationGroupUtil from "../CollaborationGroupUtil";
+import CollaborationGroupFolderUtil from "../CollaborationGroupFolderUtil";
+import CollaborationGroupTemplateUtil from "../CollaborationGroupTemplateUtil";
 
 /**
-* Gets an instance of a collaboration group folder utility class
-* @returns {ICollaborationGroupFolderUtil} An instance of a collaboration group folder utility class 
-*/
-export function getCollaborationGroupFolderUtil(): ICollaborationGroupFolderUtil;
+ * Gets a collaboration group wrapper for a specified collaboration group.
+ * @param aCollaborationGroup the collaboration group (or the collaboration group page)
+ * @return a collaboration group wrapper for <code>aCollaborationGroup</code>, or <code>null</code> if <code>aCollaborationGroup</code> isn't a collaboration group or if current user doesn't have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on <code>aCollaborationGroup</code>.
+ */
+export function getCollaborationGroupWrapper(
+  aCollaborationGroup: Node
+): CollaborationGroupWrapper;
 
 /**
-* Gets an instance of a collaboration group template utility class
-* @returns {ICollaborationGroupTemplateUtil} An instance of a collaboration group template utility class 
-*/
-export function getCollaborationGroupTemplateUtil(): ICollaborationGroupTemplateUtil;
+ * Gets an instance of a collaboration group utility class
+ * @return An instance of a collaboration group utility class
+ * @since Sitevision 3.6.4
+ */
+export function getCollaborationGroupUtil(): CollaborationGroupUtil;
 
 /**
-* Gets an instance of a collaboration group utility class
-* @returns {ICollaborationGroupUtil} An instance of a collaboration group utility class 
-*/
-export function getCollaborationGroupUtil(): ICollaborationGroupUtil;
+ * Gets an instance of a collaboration group folder utility class
+ * @return An instance of a collaboration group folder utility class
+ * @since Sitevision 3.6.4
+ */
+export function getCollaborationGroupFolderUtil(): CollaborationGroupFolderUtil;
 
 /**
-* Gets a collaboration group wrapper for a specified collaboration group.
-* @returns {ICollaborationGroupWrapper} a collaboration group wrapper for aCollaborationGroup, or null if aCollaborationGroupisn't a collaboration group or if current user doesn't have PermissionUtil.Permission.READon aCollaborationGroup. 
-* @param {Node} aCollaborationGroup - the collaboration group (or the collaboration group page)
-*/
-export function getCollaborationGroupWrapper(aCollaborationGroup: Node): ICollaborationGroupWrapper;
+ * Gets an instance of a collaboration group template utility class
+ * @return An instance of a collaboration group template utility class
+ * @since Sitevision 3.6.4
+ */
+export function getCollaborationGroupTemplateUtil(): CollaborationGroupTemplateUtil;
 
-declare namespace collaborationFactory {
+/**
+ * Factory for creating collaboration-related instances.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getCollaborationFactory()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Gets a collaboration group wrapper for a specified collaboration group.Gets an instance of a collaboration group utility classGets an instance of a collaboration group folder utility classGets an instance of a collaboration group template utility class
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+declare namespace CollaborationFactory {
   export {
+    getCollaborationGroupWrapper,
+    getCollaborationGroupUtil,
     getCollaborationGroupFolderUtil,
     getCollaborationGroupTemplateUtil,
-    getCollaborationGroupUtil,
-    getCollaborationGroupWrapper,
   };
 }
 
-export default collaborationFactory;
+export default CollaborationFactory;

package/server/CollaborationGroupFolderUtil/index.d.ts

@@ -1,36 +1,47 @@
-import Node from '../../builtins/Node';
+import Node from "../../hidden/javax/jcr/Node";
 
 /**
-* Whether or not a collaboration group folder already contains a named collaboration group.
-* @returns {boolean} true if aCollaborationGroupFolder contains (case ignored) a group named aGroupName,false otherwise 
-* @param {Node} aCollaborationGroupFolder - the collaboration group folder
-* @param {string} aGroupName - the name of the collaboration group
-*/
-export function containsCollaborationGroup(aCollaborationGroupFolder: Node, aGroupName: string): boolean;
-
-/**
-* Gets the default collaboration group folder.
-* @returns {Node} the default collaboration group folder, or null if indeterminable 
-*/
+ * Gets the default collaboration group folder.
+ *
+ * <p>
+ *    The <em>default collaboration group folder</em> is the folder where new collaboration groups
+ *    (i.e. collaboration group pages) are created by default.
+ * </p>
+ * @return the default collaboration group folder, or <code>null</code> if indeterminable
+ */
 export function getDefaultCollaborationGroupFolder(): Node;
 
-export interface ICollaborationGroupFolderUtil {
-  /**
-  * Whether or not a collaboration group folder already contains a named collaboration group.
-  * @returns {boolean} true if aCollaborationGroupFolder contains (case ignored) a group named aGroupName,false otherwise 
-  * @param {Node} aCollaborationGroupFolder - the collaboration group folder
-  * @param {string} aGroupName - the name of the collaboration group
-  */
-  containsCollaborationGroup(aCollaborationGroupFolder: Node, aGroupName: string): boolean;
-  /**
-  * Gets the default collaboration group folder.
-  * @returns {Node} the default collaboration group folder, or null if indeterminable 
-  */
-  getDefaultCollaborationGroupFolder(): Node;
-}
+/**
+ * Whether or not a collaboration group folder already contains a named collaboration group.
+ * @param aCollaborationGroupFolder the collaboration group folder
+ * @param aGroupName the name of the collaboration group
+ * @return <code>true</code> if <code>aCollaborationGroupFolder</code> contains (case ignored) a group named <code>aGroupName</code>, <code>false</code> otherwise
+ * @throws java.lang.NullPointerException if <code>aCollaborationGroupFolder</code> or <code>aGroupName</code> is <code>null</code>
+ * @throws RepositoryException if <code>aCollaborationGroupFolder</code> is not a collaboration folder
+ */
+export function containsCollaborationGroup(
+  aCollaborationGroupFolder: Node,
+  aGroupName: string
+): boolean;
 
-declare namespace collaborationGroupFolderUtil {
-  export { containsCollaborationGroup, getDefaultCollaborationGroupFolder };
+/**
+ * Collaboration group folder utility interface that handles nodes with primary node type <code>sv:collaborationGroupFolder</code>.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link CollaborationFactory#getCollaborationGroupFolderUtil()}.
+ *    See {@link CollaborationFactory} for how to obtain an instance of the <code>CollaborationFactory</code> interface.
+ * </p>Gets the default collaboration group folder.
+ *
+ * <p>
+ *    The <em>default collaboration group folder</em> is the folder where new collaboration groups
+ *    (i.e. collaboration group pages) are created by default.
+ * </p>Whether or not a collaboration group folder already contains a named collaboration group.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.4
+ */
+declare namespace CollaborationGroupFolderUtil {
+  export { getDefaultCollaborationGroupFolder, containsCollaborationGroup };
 }
 
-export default collaborationGroupFolderUtil;
+export default CollaborationGroupFolderUtil;