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

package/hidden/senselogic/sitevision/api/node/NodeIteratorUtil/index.d.ts

@@ -0,0 +1,231 @@
+import NodeIterator from "../../../../../javax/jcr/NodeIterator";
+import Filter from "../../base/Filter";
+
+import Node from "../../../../../javax/jcr/Node";
+
+import FilterSplit from "../../base/FilterSplit";
+
+/**
+ * Node iterator utility interface.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getNodeIteratorUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ */
+
+interface NodeIteratorUtil {
+  /**
+   * Gets a filtered NodeIterator.
+   *
+   * <p>
+   *    This NodeIterator decorates a NodeIterator with a Filter, i.e. it will only return nodes that matches given filter.
+   * </p>
+   *
+   * <p>
+   *    This <strong>server-side Javascript example</strong> demonstrates how to create a node iterator that is very similar to the
+   *    {@link #getMenuItems(Node) MenuItems} iterator but this node iterator is not respecting the "visibleInMenus" property.
+   * </p>
+   * <pre><code>    const nodeFilterUtil = require('NodeFilterUtil');
+   *    const nodeIteratorUtil = require('NodeIteratorUtil');
+   *    const startNode = ...
+   *
+   *    const filter = nodeFilterUtil.getAnyOfPrimaryNodeTypesFilter([
+   *       'sv:page', 'sv:structurePage', 'sv:article', 'sv:link', 'sv:structureLink', 'sv:collaborationGroupPage'
+   *    ]);
+   *    const nodes = nodeIteratorUtil.getFilteredNodeIterator(startNode.getNodes(), filter);
+   *
+   *    while (nodes.hasNext()) {
+   *       let node = nodes.nextNode();
+   *       ...
+   *    }</code></pre>
+   * @param aNodeIterator a NodeIterator, must not be null
+   * @param aNodeFilter a Node Filter, must not be null
+   * @return a filtered NodeIterator
+   * @throws NullPointerException if aNodeIterator or aNodeFilter is null
+   * @see NodeFilterUtil
+   * @since Sitevision 8.1
+   */
+  getFilteredNodeIterator(
+    aNodeIterator: NodeIterator,
+    aNodeFilter: Filter
+  ): NodeIterator;
+
+  /**
+   * Gets a node iterator via a node identifier.
+   *
+   * <p>
+   *    The purpose of this method is twofold:
+   * </p>
+   * <ul>
+   *    <li>
+   *       <em>Convenience.</em> This method combines {@link javax.jcr.Session#getNodeByIdentifier(String)} and {@link Node#getNodes()},
+   *       i.e. a shortcut to get an iterator without having to actually lookup/resolve the parent node.
+   *    </li>
+   *    <li>
+   *       <em>Permission workaround.</em> This method does <em>not</em> do any permission checks on the resolved parent Node, i.e.
+   *       a shortcut to get an iterator of children where you (potentially) have permission from a parent where you don't.
+   *    </li>
+   * </ul>
+   * @param aIdentifier a node identifier
+   * @return a <code>NodeIterator</code> for the sub nodes of the Node resolved via <code>aIdentifier</code>, or <code>null</code> if indeterminable
+   * @since Sitevision 4.0.2
+   */
+  getNodeIteratorByIdentifier(aIdentifier: java.lang.String): NodeIterator;
+
+  /**
+   * Gets an iterator for default menu items (i.e. non-hidden pages, link pages etc. where current user has read permission)
+   * @param aParent the base node for the iterator
+   * @return a <code>NodeIterator</code> for the sub nodes of <code>aParent</code>, or <code>null</code> if indeterminable (i.e. <code>aParent</code> is not a <code>Node</code> in the page tree)
+   */
+  getMenuItems(aParent: Node): NodeIterator;
+
+  /**
+   * Gets an iterator for default menu items via a node identifier.
+   *
+   * <p>
+   *    The purpose of this method is twofold:
+   * </p>
+   * <ul>
+   *    <li>
+   *       <em>Convenience.</em> This method combines {@link javax.jcr.Session#getNodeByIdentifier(String)} and {@link #getMenuItems(Node)},
+   *       i.e. a shortcut to get a menu iterator without having to actually lookup/resolve the parent node.
+   *    </li>
+   *    <li>
+   *       <em>Permission workaround.</em> This method does <em>not</em> do any permission checks on the resolved parent Node, i.e.
+   *       a shortcut to get an iterator of children where you (potentially) have permission from a parent where you don't.
+   *    </li>
+   * </ul>
+   * @param aIdentifier a node identifier
+   * @return a <code>NodeIterator</code> for the sub nodes of the Node resolved via <code>aIdentifier</code>, or <code>null</code> if indeterminable
+   * @since Sitevision 4.0.2
+   * @see #getMenuItems(Node)
+   */
+  getMenuItemsByIdentifier(aIdentifier: java.lang.String): NodeIterator;
+
+  /**
+   * Gets an iterator for default menu items (i.e. getMenuItems(Node)), including folders
+   * @see #getMenuItems(Node)
+   * @param aParent the base node for the iterator
+   * @return a <code>NodeIterator</code> for the sub nodes of <code>aParent</code>, or <code>null</code> if indeterminable (i.e. <code>aParent</code> is not a <code>Node</code> in the page tree)
+   */
+  getMenuItemsIncludingFolders(aParent: Node): NodeIterator;
+
+  /**
+   * Gets an iterator for default menu items (including folders) via a node identifier.
+   *
+   * <p>
+   *    The purpose of this method is twofold:
+   * </p>
+   * <ul>
+   *    <li>
+   *       <em>Convenience.</em> This method combines {@link javax.jcr.Session#getNodeByIdentifier(String)} and
+   *       {@link #getMenuItemsIncludingFolders(Node)}, i.e. a shortcut to get a menu iterator without having to actually
+   *       lookup/resolve the parent node.
+   *    </li>
+   *    <li>
+   *       <em>Permission workaround.</em> This method does <em>not</em> do any permission checks on the resolved parent Node, i.e.
+   *       a shortcut to get an iterator of children where you (potentially) have permission from a parent where you don't.
+   *    </li>
+   * </ul>
+   * @param aIdentifier a node identifier
+   * @return a <code>NodeIterator</code> for the sub nodes of the Node resolved via <code>aIdentifier</code>, or <code>null</code> if indeterminable
+   * @since Sitevision 4.0.2
+   * @see #getMenuItemsIncludingFolders(Node)
+   */
+  getMenuItemsIncludingFoldersByIdentifier(
+    aIdentifier: java.lang.String
+  ): NodeIterator;
+
+  /**
+   * Gets the first node from a node iterator that matches a specified filter.
+   *
+   * <p>
+   *    <em>Tip!</em> Use {@link senselogic.sitevision.api.node.NodeFilterUtil} to get
+   *    an appropriate node filter.
+   * </p>
+   * @param aNodeIterator a node iterator
+   * @param aFilter a node filter
+   * @return first node that matches <code>aFilter</code>, or <code>null</code>. If <code>aFilter</code> is <code>null</code>, the filter will be ignored (all nodes will be accepted). If <code>aNodeIterator</code> is <code>null</code>, <code>null</code> will be returned.
+   * @since Sitevision 3.6.2
+   */
+  findFirst(aNodeIterator: NodeIterator, aFilter: Filter): Node;
+
+  /**
+   * Gets a max-sized node list from a node iterator that matches a specified filter.
+   *
+   * <p>
+   *    <em>Tip!</em> Use {@link senselogic.sitevision.api.node.NodeFilterUtil} to get
+   *    an appropriate node filter. If the list of nodes should be sorted by a specific property value,
+   *    you would typically use {@link senselogic.sitevision.api.node.NodeComparatorUtil}
+   *    to get an appropriate <code>Comparator</code>.
+   * </p>
+   * @param aNodeIterator a node iterator
+   * @param aFilter a node filter
+   * @param aMaxNodesToFind max number of nodes to include in the result
+   * @return a list of nodes that matches <code>aFilter</code>, never <code>null</code>. The list will contain at most <code>aMaxNodesToFind</code> nodes. If <code>aFilter</code> is <code>null</code>, the filter will be ignored (all nodes will be accepted). If <code>aNodeIterator</code> is <code>null</code>, an empty list will be returned. If <code>aMaxNodesToFind</code> is negative, an empty list will be returned.
+   * @since Sitevision 3.6.2
+   */
+  findNodes(
+    aNodeIterator: NodeIterator,
+    aFilter: Filter,
+    aMaxNodesToFind: int
+  ): unknown[];
+
+  /**
+   * Gets a list of all nodes from a node iterator that matches a specified filter.
+   *
+   * <p>
+   *    <em>Tip!</em> Use {@link senselogic.sitevision.api.node.NodeFilterUtil} to get
+   *    an appropriate node filter. If the list of nodes should be sorted by a specific property value,
+   *    you would typically use {@link senselogic.sitevision.api.node.NodeComparatorUtil}
+   *    to get an appropriate <code>Comparator</code>.
+   * </p>
+   * @param aNodeIterator a node iterator
+   * @param aFilter a node filter
+   * @return a list of nodes that matches <code>aFilter</code>, never <code>null</code>. If <code>aFilter</code> is <code>null</code>, the filter will be ignored (all nodes will be accepted). If <code>aNodeIterator</code> is <code>null</code>, an empty list will be returned.
+   * @since Sitevision 3.6.2
+   */
+  findAll(aNodeIterator: NodeIterator, aFilter: Filter): unknown[];
+
+  /**
+   * Gets a list of all nodes of a node iterator.
+   *
+   * <p>
+   *    <strong>Note!</strong> This is a convenience method to use <strong>only when you must</strong> get nodes as a list!
+   *    The only apparent reason is when you need need to <em>sort</em> the nodes! If you don't, you should use
+   *    the <code>NodeIterator</code> instead and do your processing for each node.
+   * </p>
+   * <p>
+   *    <strong>Sorting tip!</strong> When the list of nodes should be sorted by a specific <em>property value</em>,
+   *    you would typically use {@link senselogic.sitevision.api.node.NodeComparatorUtil}to get an appropriate
+   *    <code>Comparator</code>. The list can then be sorted by <code>Collections.sort(List, Comparator)</code>.
+   *    When using Velocity, you must use the non-static class {@link senselogic.sitevision.api.script.factory.CollectionsInstance}.
+   * </p>
+   * @param aNodeIterator a node iterator
+   * @return a list of all nodes provided by <code>aNodeIterator</code>, never <code>null</code>.
+   * @since Sitevision 3.6.2
+   */
+  toList(aNodeIterator: NodeIterator): unknown[];
+
+  /**
+   * Gets the filtering result of a split operation for a node iterator with a node filter as divider.
+   *
+   * <p>
+   *    This method would typically be used instead of {@link #findAll(javax.jcr.NodeIterator, senselogic.sitevision.api.base.Filter)}
+   *    when you are also interested in the nodes that does NOT match the filter.
+   * </p>
+   * <p>
+   *    <em>Note!</em> If <code>aFilter</code> is <code>null</code>, no nodes will match (all nodes
+   *    gathered via <code>aNodeIterator</code> will be <em>rejected</em> in the resulting filter split).
+   * </p>
+   * @param aNodeIterator a node iterator
+   * @param aFilter a node filter
+   * @return the filtering result
+   * @since Sitevision 3.6.3
+   * @see senselogic.sitevision.api.node.NodeFilterUtil#split(java.util.Collection, senselogic.sitevision.api.base.Filter)
+   */
+  split(aNodeIterator: NodeIterator, aFilter: Filter): FilterSplit;
+}

package/hidden/senselogic/sitevision/api/node/NodeResolverUtil/index.d.ts

@@ -0,0 +1,406 @@
+import Resolver from "../../base/Resolver";
+
+/**
+ * Node resolver utility interface.
+ * @author Magnus Lövgren
+ * @since Sitevision 4.1
+ */
+
+interface NodeResolverUtil {
+  /**
+   * Gets the Calendar resolver for Collaboration-related nodes.
+   *
+   * <p>
+   *    This is a convenience resolver that uses the {@link #getCollaborationDateResolver()} to resolve a <code>Date</code>
+   *    from a <code>Node</code> and then convert it to a <code>Calendar</code>.
+   * </p>
+   * <p>
+   *    <em>Note!</em> <code>Calendar</code> implements <code>Comparable</code> so this resolver can be used
+   *    to get a <code>Comparator</code> using {@link NodeComparatorUtil#getResolverComparator(Resolver)}.
+   * </p>
+   * @return the Calendar resolver for collaboration-related nodes
+   * @see #getCollaborationDateResolver()
+   */
+  getCollaborationCalendarResolver(): Resolver;
+
+  /**
+   * Gets the Date resolver for Collaboration-related nodes.
+   *
+   * <p>
+   *    <strong>Types</strong><br>
+   *     The Date value will be resolved differently for different node types.
+   *     For some types it will potentially do multiple checks and return the <em>first found</em> of them
+   *     (i.e. first check that has a non-null Date value).
+   * </p>
+   * <ul>
+   *     <li>
+   *         <code>sv:userIdentity</code>
+   *         <br><em>- returns:</em>
+   *         <ul>
+   *             <li>The time when the last entry was added to the personal timeline of the identity.</li>
+   *         </ul>
+   *     </li>
+   *     <li>
+   *         <code>sv:collaborationGroup</code>
+   *         <br><em>- returns first found of:</em>
+   *         <ol>
+   *             <li>The time when the collaboration group had it's last activity e.g. new entry or a modified file.</li>
+   *             <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last published.</li>
+   *             <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last modified.</li>
+   *             <li>The time when the <code>sv:collaborationGroupPage</code> of the group was created.</li>
+   *         </ol>
+   *     </li>
+   *     <li>
+   *         <code>sv:collaborationGroupPage</code>
+   *         <br><em>- returns first found of:</em>
+   *         <ol>
+   *             <li>
+   *                The time when the <code>sv:collaborationGroup</code> of the collaboration group page had it's last activity
+   *                e.g. new entry or a modified file.
+   *             </li>
+   *             <li>The time when the collaboration group page was last published.</li>
+   *             <li>The time when the collaboration group page was last modified.</li>
+   *             <li>The time when the collaboration group page was created.</li>
+   *         </ol>
+   *     </li>
+   *     <li>
+   *         <code>sv:collaborationGroupTemplate</code>
+   *         <br><em>- returns first found of:</em>
+   *         <ol>
+   *             <li>The time when the node was last published.</li>
+   *             <li>The time when the node was last modified.</li>
+   *             <li>The time when the node was created.</li>
+   *         </ol>
+   *     </li>
+   *     <li>
+   *         <code>sv:collaborationGroupFolder</code>
+   *         <br><em>- returns first found of:</em>
+   *         <ol>
+   *             <li>The time when the node was last modified.</li>
+   *             <li>The time when the node was created.</li>
+   *         </ol>
+   *     </li>
+   * </ul>
+   *
+   * <p>
+   *     This resolver also supports some non-collaboration node types:
+   * </p>
+   * <ul>
+   *     <li>
+   *         <code>sv:page</code>, <code>sv:article</code>, <code>sv:sitePage</code>, <code>sv:link</code>, <code>sv:template</code>,
+   *         <code>sv:structurePage</code>, <code>sv:structureLink</code>
+   *         <br><em>- returns first found of:</em>
+   *         <ol>
+   *             <li>The time when the node was last published.</li>
+   *             <li>The time when the node was last modified.</li>
+   *             <li>The time when the node was created.</li>
+   *         </ol>
+   *     </li>
+   *     <li>
+   *         <code>sv:image</code>, <code>sv:file</code>, <code>sv:folder</code>, <code>sv:structureFolder</code>
+   *         <br><em>- returns first found of:</em>
+   *         <ol>
+   *             <li>The time when the node was last modified.</li>
+   *             <li>The time when the node was created.</li>
+   *         </ol>
+   *     </li>
+   * </ul>
+   * <p>
+   *     Unsupported node types will resolve to <code>null</code>.
+   * </p>
+   *
+   * <p>
+   *    <strong>Example</strong>
+   *    <br>This server-side Javascript code demonstrates how to get the "last updated" Date from av sv:collaborationGroup.
+   * </p>
+   * <pre><code> <em>// Use NodeResolverUtil to get the Date resolver for Collaboration Nodes</em>
+   * var nodeResolverUtil = require('NodeResolverUtil'),
+   *     collaborationDateResolver = nodeResolverUtil.getCollaborationDateResolver(),
+   *     collaborationGroup,
+   *     lastUpdated;
+   *
+   * <em>// Get the sv:collaborationGroup Node...</em>
+   * collaborationGroup = ...
+   *
+   * <em>// Use the resolver to get (i.e. resolve) the "last updated" Date of the Collaboration group</em>
+   * lastUpdated = collaborationDateResolver.resolve(collaborationGroup);</code></pre>
+   *
+   * <p>
+   *    <strong>Sorting tip!</strong><br>
+   *    <code>Date</code> implements <code>Comparable</code> so this resolver can be used
+   *    to get a <code>Comparator</code> using {@link NodeComparatorUtil#getResolverComparator(Resolver)}.
+   *    This resolver and the resolver comparator can be helpful when you want to sort a collection of
+   *    <code>sv:collaborationGroup</code> nodes in "most active" order.
+   * </p>
+   * @return the Date resolver for collaboration-related nodes
+   */
+  getCollaborationDateResolver(): Resolver;
+
+  /**
+   * Gets the versioned Calendar resolver for nodes.
+   *
+   * <p>
+   *    This is a convenience resolver that uses the {@link #getVersionedDateResolver()} to resolve a <code>Date</code>
+   *    from a <code>Node</code> and then convert it to a <code>Calendar</code>.
+   * </p>
+   * <p>
+   *    <em>Note!</em> <code>Calendar</code> implements <code>Comparable</code> so this resolver can be used
+   *    to get a <code>Comparator</code> using {@link NodeComparatorUtil#getResolverComparator(Resolver)}.
+   * </p>
+   * @return the Calendar resolver for nodes
+   * @see #getVersionedDateResolver()
+   */
+  getVersionedCalendarResolver(): Resolver;
+
+  /**
+   * Gets the versioned Date resolver for nodes.
+   *
+   * <p>
+   *    <strong>Types and versions</strong><br>
+   *     The Date value will be resolved differently for different node types in different versions.
+   *     For some types it will potentially do multiple checks and return the <em>first found</em> of them
+   *     (i.e. first check that has a non-null Date value).
+   * </p>
+   *
+   * <p>
+   *    Date resolve in the {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}:
+   * </p>
+   * <ul>
+   *     <li>
+   *         <code>sv:page</code>, <code>sv:article</code>, <code>sv:sitePage</code>, <code>sv:link</code>, <code>sv:template</code>,
+   *         <code>sv:collaborationGroupPage</code>, <code>sv:collaborationGroupTemplate</code>,
+   *         <code>sv:structurePage</code>, <code>sv:structureLink</code>
+   *         <br><em>- returns first found of:</em>
+   *         <ol>
+   *             <li>The time when the node was last published.</li>
+   *             <li>The time when the node was last modified.</li>
+   *             <li>The time when the node was created.</li>
+   *         </ol>
+   *     </li>
+   *     <li>
+   *         <code>sv:collaborationGroup</code>
+   *         <br><em>- returns first found of:</em>
+   *         <ol>
+   *             <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last published.</li>
+   *             <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last modified.</li>
+   *             <li>The time when the <code>sv:collaborationGroupPage</code> of the group was created.</li>
+   *         </ol>
+   *     </li>
+   *     <li>
+   *         <code>sv:file</code>, <code>sv:image</code>, <code>sv:folder</code>, <code>sv:structureFolder</code>
+   *         <br><em>- returns first found of:</em>
+   *         <ol>
+   *             <li>The time when the node was last modified.</li>
+   *             <li>The time when the node was created.</li>
+   *         </ol>
+   *     </li>
+   * </ul>
+   *
+   * <p>
+   *    Date resolve in the {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}:
+   * </p>
+   * <ul>
+   *     <li>
+   *         <code>sv:page</code>, <code>sv:article</code>, <code>sv:sitePage</code>, <code>sv:link</code>, <code>sv:template</code>,
+   *         <code>sv:file</code>, <code>sv:image</code>, <code>sv:folder</code>,
+   *         <code>sv:collaborationGroupPage</code>, <code>sv:collaborationGroupTemplate</code>,
+   *         <code>sv:structurePage</code>, <code>sv:structureLink</code>, <code>sv:structureFolder</code>
+   *         <br><em>- returns first found of:</em>
+   *         <ol>
+   *             <li>The time when the node was last modified.</li>
+   *             <li>The time when the node was created.</li>
+   *         </ol>
+   *     </li>
+   *     <li>
+   *         <code>sv:collaborationGroup</code>
+   *         <br><em>- returns first found of:</em>
+   *         <ol>
+   *             <li>The time when the <code>sv:collaborationGroupPage</code> of the group was last modified.</li>
+   *             <li>The time when the <code>sv:collaborationGroupPage</code> of the group was created.</li>
+   *         </ol>
+   *     </li>
+   * </ul>
+   * <p>
+   *     Unsupported node types will resolve to <code>null</code>.
+   * </p>
+   *
+   * <p>
+   *    <strong>Sorting tip!</strong><br>
+   *    <code>Date</code> implements <code>Comparable</code> so this resolver can be used
+   *    to get a <code>Comparator</code> using {@link NodeComparatorUtil#getResolverComparator(Resolver)}.
+   *    This resolver and the resolver comparator can be helpful when you want to sort nodes by time.
+   * </p>
+   * @return the versioned Date resolver for nodes
+   */
+  getVersionedDateResolver(): Resolver;
+
+  /**
+   * Gets the Locale resolver for nodes.
+   *
+   * <p>
+   *     The Locale value will be resolved differently for different node types:
+   * </p>
+   * <ul>
+   *     <li>
+   *         <code>sv:page</code>, <code>sv:article</code>, <code>sv:template</code>, <code>sv:sitePage</code>,
+   *         <code>sv:structurePage</code>, <code>sv:collaborationGroupPage</code>, <code>sv:collaborationGroupTemplate</code>,
+   *         <code>sv:link</code>, <code>sv:structureLink</code>,
+   *         <code>sv:folder</code>, <code>sv:structureFolder</code>, <code>sv:collaborationGroupFolder</code>
+   *         <code>sv:archive</code>,
+   *         <code>sv:applicationIndex</code>, <code>sv:nodeIndex</code>
+   *         <br><em>- returns:</em>
+   *         <ul>
+   *             <li>The Locale of the node.</li>
+   *         </ul>
+   *     </li>
+   *     <li>
+   *         <code>sv:collaborationGroup</code>
+   *         <br><em>- returns:</em>
+   *         <ul>
+   *             <li>The Locale of the <code>sv:collaborationGroupPage</code> of the group.</li>
+   *         </ul>
+   *     </li>
+   * </ul>
+   *
+   * <p>
+   *     Unsupported node types will resolve to <code>null</code>.
+   * </p>
+   * @return the Locale resolver for nodes
+   * @see senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()
+   */
+  getLocaleResolver(): Resolver;
+
+  /**
+   * Gets the sv:tag resolver for nodes.
+   *
+   * <p>
+   *     The list of tags can be resolved for different node types:
+   * </p>
+   * <ul>
+   *     <li>
+   *         <code>sv:page</code>, <code>sv:article</code>, <code>sv:file</code>, <code>sv:image</code>,
+   *         <code>sv:sitePage</code>, <code>sv:collaborationGroupPage</code>
+   *         <br><em>- returns:</em>
+   *         <ul>
+   *             <li>The potential tags of the node.</li>
+   *         </ul>
+   *     </li>
+   *     <li>
+   *         <code>sv:timelineEntry</code>, <code>sv:timelineWallEntry</code>, <code>sv:timelineFileEntry</code>,
+   *         <code>sv:timelineFileWallEntry</code>, <code>sv:timelineShareEntry</code>, <code>sv:timelineSharePageEntry</code>
+   *         <br><em>- returns:</em>
+   *         <ul>
+   *             <li>The potential tags in the entry text.</li>
+   *         </ul>
+   *     </li>
+   *     <li>
+   *         <code>sv:comment</code>, <code>sv:pageComment</code>
+   *         <br><em>- returns:</em>
+   *         <ul>
+   *             <li>The potential tags in the comment text.</li>
+   *         </ul>
+   *     </li>
+   *     <li>
+   *         <code>sv:tagGroup</code>
+   *         <br><em>- returns:</em>
+   *         <ul>
+   *             <li>The potential tags of the tag group.</li>
+   *         </ul>
+   *     </li>
+   *     <li>
+   *         <code>sv:tagGroupRepository</code>
+   *         <br><em>- returns:</em>
+   *         <ul>
+   *             <li>All the potential tags of all the tag groups of the repository combined.</li>
+   *         </ul>
+   *     </li>
+   * </ul>
+   *
+   * <p>
+   *     Unsupported node types will resolve to an empty list (unmodifiable), i.e. the resolver will never return null.
+   * </p>
+   * <p>
+   *     <em>Note!</em> The resolved list is not explicitly sorted. The tags will typically be in insertion order.
+   * </p>
+   *
+   * <p>
+   *    <strong>Example</strong>
+   *    <br>This server-side Javascript code demonstrates how to get all tags that belong to a sv:tagGroup, sorted by the tag name.
+   * </p>
+   * <pre><code> <em>// Resolves and returns a List of sv:tag from a given Node</em>
+   * function getAllTagsFrom(from) {
+   *    var nodeResolverUtil = require('NodeResolverUtil'),
+   *        tagResolver = nodeResolverUtil.getTagsResolver();
+   *
+   *    return tagResolver.resolve(from);
+   * }
+   *
+   * <em>// Sorts a List of sv:tag by the tag names in ascending order</em>
+   * function sortTagList(tagList) {
+   *    var nodeComparatorUtil = require('NodeComparatorUtil'),
+   *        collectionsInstance = require('CollectionsInstance'),
+   *        tagNameComparator;
+   *
+   *    tagNameComparator = nodeComparatorUtil.getPropertyComparator('tagName');
+   *    collectionsInstance.sort(tagList, tagNameComparator);
+   * }
+   *
+   * var resourceLocatorUtil = require('ResourceLocatorUtil'),
+   *     tagGroupsRepository,
+   *     tags;
+   *
+   * tagGroupsRepository = resourceLocatorUtil.getTagGroupRepository();
+   * tags = getAllTagsFrom(tagGroupsRepository);
+   *
+   * if (tags.size() &gt; 1) {
+   *    sortTagList(tags);
+   * }</code></pre>
+   * @return a resolver that can resolve a List of sv:tag from a Node
+   * @since Sitevision 5
+   */
+  getTagsResolver(): Resolver;
+
+  /**
+   * Gets the sv:tagGroup resolver for nodes.
+   *
+   * <p>
+   *     The list of tag groups can be resolved for different node types:
+   * </p>
+   * <ul>
+   *     <li>
+   *         <code>sv:tag</code>
+   *         <br><em>- returns:</em>
+   *         <ul>
+   *             <li>The potential tag groups of the tag <em>(a sv:tag can belong to multiple sv:tagGroup)</em>.</li>
+   *         </ul>
+   *     </li>
+   *     <li>
+   *         <code>sv:tagGroupRepository</code>
+   *         <br><em>- returns:</em>
+   *         <ul>
+   *             <li>The potential tag groups of the repository.</li>
+   *         </ul>
+   *     </li>
+   *     <li>
+   *        <code>sv:sitePage</code>, <code>sv:page</code>, <code>sv:folder</code>, <code>sv:archive</code>,
+   *        <code>sv:article</code>, <code>sv:file</code>, <code>sv:image</code>, <code>sv:collaborationGroupFolder</code>,
+   *        <code>sv:collaborationGroupPage</code>, <code>sv:userField</code> (of type TAGS),
+   *        <code>sv:metadataMultipleTagDefinition</code>, <code>sv:metadataSingleTagDefinition</code>
+   *        <br><em>- returns:</em>
+   *       <ul>
+   *          <li>The potential effective tag groups of the node.</li>
+   *       </ul>
+   *     </li>
+   * </ul>
+   *
+   * <p>
+   *     Unsupported node types will resolve to an empty list (unmodifiable), i.e. the resolver will never return null.
+   * </p>
+   * <p>
+   *     <em>Note!</em> The resolved list is not explicitly sorted. The tag groups will typically be in insertion order.
+   * </p>
+   * @return a resolver that can resolve a List of sv:tagGroup from a Node
+   * @since Sitevision 5
+   */
+  getTagGroupsResolver(): Resolver;
+}