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

package/hidden/senselogic/sitevision/api/alias/AliasUtil/index.d.ts

@@ -1,22 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * Alias utility interface.
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getAliasUtil()}.
- *    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 2022.10.2
- */
-
-interface AliasUtil {
-  /**
-   * Gets the alias name for a given Node.
-   * @param aNode a Node that is the target of an alias, typically a sv:page, sv:article or sv:file
-   * @return the first found alias name for aNode, or null if aNode is null or no matching alias could be found
-   */
-  getAliasName(aNode: Node): string;
-}

package/hidden/senselogic/sitevision/api/bookmark/BookmarkUtil/index.d.ts

@@ -1,87 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * <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>
- * @author Mikael Wikblom
- * @since Sitevision 2.6.1
- */
-
-interface BookmarkUtil {
-  /**
-   * 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 a list of bookmark nodes. Is never <code>null</code>
-   */
-  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 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>
-   */
-  getBookmarks(category: java.lang.String): unknown[];
-
-  /**
-   * Adds a bookmark for the current user. This operation is synchronized
-   * @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>
-   * @deprecated Use {@link #add(javax.jcr.Node)}, categories will be resolved from metadata.
-   */
-  add(bookmark: Node, categories: java.lang.String): void;
-
-  /**
-   * Adds a bookmark for the current user. This operation is synchronized
-   * @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>
-   */
-  add(bookmark: Node): void;
-
-  /**
-   * Removes a bookmark for the current user. This operation is synchronized
-   * @param bookmark the bookmark
-   * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
-   */
-  remove(bookmark: Node): void;
-
-  /**
-   * Checks if the current user has the provided bookmark
-   * @param bookmark the bookmark
-   * @return if the user has provided bookmark
-   * @throws NullPointerException if <code>bookmark</code> is <code>null</code>
-   */
-  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 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
-   */
-  getLimitNofBookmarks(): boolean;
-
-  /**
-   * Accessor to 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
-   */
-  getMaxNofBookmarks(): number;
-}

package/hidden/senselogic/sitevision/api/client/ClientUtil/index.d.ts

@@ -1,23 +0,0 @@
-/**
- * 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>
- * @author Magnus Lövgren
- * @since Sitevision 2.6_02
- */
-
-interface ClientUtil {
-  /**
-   * Gets the Internet Protocol (IP) address of the client (or last proxy) that initiated currently executing request.
-   * @return a <code>String</code> containing the IP address of the client that sent the request, or <code>null</code> if indeterminable
-   */
-  getClientAddress(): string;
-}

package/hidden/senselogic/sitevision/api/collaboration/CollaborationFactory/index.d.ts

@@ -1,49 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-import CollaborationGroupWrapper from "../CollaborationGroupWrapper";
-import CollaborationGroupUtil from "../CollaborationGroupUtil";
-import CollaborationGroupFolderUtil from "../CollaborationGroupFolderUtil";
-import CollaborationGroupTemplateUtil from "../CollaborationGroupTemplateUtil";
-
-/**
- * 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>
- * @author Magnus Lövgren
- * @since Sitevision 3.6
- */
-
-interface CollaborationFactory {
-  /**
-   * 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>.
-   */
-  getCollaborationGroupWrapper(
-    aCollaborationGroup: Node
-  ): CollaborationGroupWrapper;
-
-  /**
-   * Gets an instance of a collaboration group utility class
-   * @return An instance of a collaboration group utility class
-   * @since Sitevision 3.6.4
-   */
-  getCollaborationGroupUtil(): CollaborationGroupUtil;
-
-  /**
-   * 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
-   */
-  getCollaborationGroupFolderUtil(): CollaborationGroupFolderUtil;
-
-  /**
-   * 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
-   */
-  getCollaborationGroupTemplateUtil(): CollaborationGroupTemplateUtil;
-}

package/hidden/senselogic/sitevision/api/collaboration/CollaborationGroupFolderUtil/index.d.ts

@@ -1,39 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * 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>
- * @author Magnus Lövgren
- * @since Sitevision 3.6.4
- */
-
-interface CollaborationGroupFolderUtil {
-  /**
-   * 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
-   */
-  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
-   */
-  containsCollaborationGroup(
-    aCollaborationGroupFolder: Node,
-    aGroupName: java.lang.String
-  ): boolean;
-}

package/hidden/senselogic/sitevision/api/collaboration/CollaborationGroupTemplateUtil/index.d.ts

@@ -1,58 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * Collaboration group template utility interface that handles nodes with primary node type <code>sv:collaborationGroupTemplate</code>.
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link CollaborationFactory#getCollaborationGroupTemplateUtil()}.
- *    See {@link CollaborationFactory} for how to obtain an instance of the <code>CollaborationFactory</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 3.6.4
- * @see senselogic.sitevision.api.resource.TemplateUtil
- */
-
-interface CollaborationGroupTemplateUtil {
-  /**
-   * Gets the default collaboration group template.
-   *
-   * <p>
-   *    The <em>default collaboration group template</em> is the template that are used by default to create new
-   *    collaboration groups (i.e. collaboration group pages).
-   * </p>
-   * <p>
-   *    <em>Permission note!</em> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
-   *    on default collaboration group template.
-   * </p>
-   * @return the default collaboration group template, or <code>null</code> if indeterminable
-   */
-  getDefaultCollaborationGroupTemplate(): Node;
-
-  /**
-   * Gets the first found collaboration group template that matches a given name.
-   *
-   * <p>
-   *    <em>Permission note!</em> Only collaboration group templates that current user has
-   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on will be considered.
-   * </p>
-   * @param aCollaborationGroupTemplateName name of the template
-   * @return a collaboration group template, or <code>null</code> if indeterminable (e.g. no accessible collaboration group template named <code>aCollaborationGroupTemplateName</code> could be found)
-   * @since Sitevision 4.1
-   */
-  getCollaborationGroupTemplateByName(
-    aCollaborationGroupTemplateName: java.lang.String
-  ): Node;
-
-  /**
-   * Gets all collaboration group templates.
-   *
-   * <p>
-   *    <em>Permission note!</em> The list will only contain collaboration group templates that current user has
-   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on.
-   * </p>
-   * @return all collaboration group templates, or empty list if there are no accessible collaboration group templates.
-   * @since Sitevision 4.1
-   */
-  getCollaborationGroupTemplates(): unknown[];
-}

package/hidden/senselogic/sitevision/api/collaboration/CollaborationGroupUtil/index.d.ts

@@ -1,99 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * Collaboration group utility interface.
- *
- * <p>
- *    <em>Note!</em> This interface is used to <em>create</em> collaboration groups. You would typically use
- *    {@link senselogic.sitevision.api.collaboration.CollaborationGroupWrapper} to <em>update</em> an existing
- *    collaboration group.
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link CollaborationFactory#getCollaborationGroupUtil()}.
- *    See {@link CollaborationFactory} for how to obtain an instance of the <code>CollaborationFactory</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 3.6.4
- */
-
-interface CollaborationGroupUtil {
-  /**
-   * Creates an open collaboration group.
-   *
-   * <p>
-   *    <em>
-   *       This is a legacy convenience method that delegates to {@link #createCollaborationGroup(Node, Node, String, CollaborationGroupType)}
-   *       using {@link CollaborationGroupType#OPEN} as group type.
-   *    </em>
-   * </p>
-   * @param aGroupTemplate the collaboration group template (sv:collaborationGroupTemplate) to use when creating the collaboration group page of the collaboration group
-   * @param aGroupFolder the collaboration group folder (sv:collaborationGroupFolder) where the collaboration group page of the collaboration group should reside
-   * @param aGroupName the name of the collaboration group
-   * @return The created collaboration group (sv:collaborationGroup)
-   * @throws java.lang.NullPointerException if <code>aGroupTemplate</code>, <code>aGroupFolder</code> or <code>aGroupName</code> is <code>null</code>
-   * @throws ConstraintViolationException if <code>aGroupTemplate</code> or <code>aGroupFolder</code> is of invalid type, if <code>aGroupName</code> is whitespace only, if <code>aGroupFolder</code> already contains a collaboration group named <code>aGroupName</code> (case ignored) or if current user is not authorized to create the collaboration group
-   * @throws RepositoryException if something else goes wrong
-   * @see #createCollaborationGroup(Node, Node, String, CollaborationGroupType)
-   */
-  createCollaborationGroup(
-    aGroupTemplate: Node,
-    aGroupFolder: Node,
-    aGroupName: java.lang.String
-  ): Node;
-
-  /**
-   * Creates a collaboration group.
-   *
-   * <p>
-   *    <strong>Permission note!</strong> Current user must have
-   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on <code>aGroupTemplate</code>
-   *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_COLLABORATION_GROUP} on <code>aGroupFolder</code>.
-   *    In order to create a {@link CollaborationGroupType#CLOSED} collaboration group, current user must also have
-   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_CLOSED_COLLABORATION_GROUP} on <code>aGroupFolder</code>.
-   * </p>
-   * <p>
-   *    <strong>User note!</strong> Current user must have a user identity as it will be the administrator of the created
-   *    group. <em>Anonymous</em> users doesn't have a user identity, nor the <em>Indexer</em>, <em>Validator</em> or the <em>Extractor</em>.
-   *    In other words: {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUserIdentity()} must be non-<code>null</code>.
-   * </p>
-   *
-   * <p>
-   *    <em>Tip!</em> Use {@link CollaborationGroupTemplateUtil} to get a group template,
-   *    use {@link CollaborationGroupFolderUtil} to get the default group folder (and perhaps check if the collaboration folder already contains
-   *    a collaboration group with specified name). Use {@link CollaborationGroupWrapper} to update the group that is created.
-   * </p>
-   * @param aGroupTemplate the collaboration group template (sv:collaborationGroupTemplate) to use when creating the collaboration group page of the collaboration group
-   * @param aGroupFolder the collaboration group folder (sv:collaborationGroupFolder) where the collaboration group page of the collaboration group should reside
-   * @param aGroupName the name of the collaboration group
-   * @param aGroupType the group type, note that {@link CollaborationGroupType#CLOSED} needs additional permission
-   * @return The created collaboration group (sv:collaborationGroup)
-   * @throws java.lang.NullPointerException if <code>aGroupTemplate</code>, <code>aGroupFolder</code>, <code>aGroupName</code> or <code>aGroupType</code> is <code>null</code>
-   * @throws ConstraintViolationException if <code>aGroupTemplate</code> or <code>aGroupFolder</code> is of invalid type, if <code>aGroupName</code> is whitespace only, if <code>aGroupFolder</code> already contains a collaboration group named <code>aGroupName</code> (case ignored) or if current user is not authorized to create the collaboration group (see permission note above)
-   * @throws RepositoryException if something else goes wrong
-   * @since Sitevision 4.1
-   */
-  createCollaborationGroup(
-    aGroupTemplate: Node,
-    aGroupFolder: Node,
-    aGroupName: java.lang.String,
-    aGroupType: senselogic.sitevision.api.collaboration.CollaborationGroupType
-  ): Node;
-
-  /**
-   * Removes a collaboration group.
-   *
-   * <p>
-   *    <em>Note!</em> When a collaboration group (<code>sv:collaborationGroup</code>) is removed,
-   *    its collaboration group page (<code>sv:collaborationGroupPage</code>) is moved to the trashcan.
-   * </p>
-   * <p>
-   *    <strong>Permission note!</strong> To remove a collaboration group current user must have
-   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP} on the collaboration group page.
-   * </p>
-   * @param aCollaborationGroup a collaboration group to remove
-   * @return <code>true</code> if <code>aCollaborationGroup</code> was removed, i.e. collaboration group page was moved to trashcan, <code>false</code> otherwise.
-   * @since Sitevision 4.5.3
-   */
-  removeCollaborationGroup(aCollaborationGroup: Node): boolean;
-}

package/hidden/senselogic/sitevision/api/context/PortletContextUtil/index.d.ts

@@ -1,112 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * Portlet context utility interface.
- *
- * <p>
- *    Contains methods for retrieving information about present portlet execution context.
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getPortletContextUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>The offline version (i.e. the version used when editing in the Sitevision editor) markerThe online version (i.e. the published version that visitors can access) marker
- * @author Magnus Lövgren
- * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}
- * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
- */
-
-interface PortletContextUtil {
-  /**
-   * Gets current page (i.e. the page node for the currently executing portlet).
-   * @return current page <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet or current portlet is not bound to any page)
-   */
-  getCurrentPage(): Node;
-
-  /**
-   * Gets current portlet.
-   * @return current portlet as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a portlet)
-   */
-  getCurrentPortlet(): Node;
-
-  /**
-   * Gets current module element (module element draft or module element).
-   * @return current module element as <code>Node</code>, or <code>null</code> if indeterminable (i.e. this method is not called from within a module element)
-   * @since Sitevision 4.2
-   */
-  getCurrentModuleElement(): Node;
-
-  /**
-   * Gets current Locale.
-   * @return current <code>Locale</code>, or default <code>Locale</code> if indeterminable
-   * @see senselogic.sitevision.api.node.NodeResolverUtil#getLocaleResolver()
-   */
-  getCurrentLocale(): unknown;
-
-  /**
-   * Gets current user.
-   * @return current user <code>Node</code>, or <code>null</code> if indeterminable
-   * @since Sitevision 2.6
-   */
-  getCurrentUser(): Node;
-
-  /**
-   * Gets current user identity.
-   * @return current user identity <code>Node</code>, or <code>null</code> if indeterminable
-   * @since Sitevision 3.5
-   */
-  getCurrentUserIdentity(): Node;
-
-  /**
-   * Gets current decorated node (applicable during render of a sv:decorationTemplate).
-   *
-   * <p>
-   *    This method returns the "decorated" node (typically a sv:portlet or sv:layout) during render of a sv:decorationTemplate.
-   *    In other words - it returns the node that is decorated with the template-based decoration that is now rendering.
-   * </p>
-   * @return the decorated node or null if indeterminable (i.e. the caller is not a part of a decoration template that is being rendered right now)
-   * @since Sitevision 5.1
-   */
-  getCurrentDecoratedNode(): Node;
-
-  /**
-   * Gets current version.
-   * @return {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}, or {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
-   * @since Sitevision 2.6
-   * @deprecated Use {@link senselogic.sitevision.api.versioning.VersionUtil#getCurrentVersion()}
-   */
-  getCurrentVersion(): number;
-
-  /**
-   * Gets a unique namespace for the specific portlet that is rendering.
-   *
-   * <p>
-   *    The namespace is based on the prefix (aPrefix) and the current portlet's id.
-   *    If you have two portlets of same type on the same page, the namespaces will differ. This can for instance be very useful when you
-   *    connect a &lt;label&gt; with an &lt;input&gt;. Example in Velocity:
-   * </p>
-   * <pre><code>
-   *   #set ($portletContextUtil = $sitevisionUtils.portletContextUtil)
-   *   ...
-   *   #set ($ns = $portletContextUtil.getPortletNamespace('name'))
-   *   &lt;label for="$ns"&gt;Name: &lt;/label&gt;&lt;input id="$ns" name="name" type="text" /&gt;</code></pre>
-   * The namespace generated in the above example (i.e. <code>$ns</code>) could be something like: <code>name12_2b9561c511855e0ab91800015</code>
-   * @param aPrefix the prefix for the namespace (ensure it only contains chars that are valid in an id value if you use it as such)
-   * @return a unique prefixed namespace for current portlet, or aPrefix if indeterminable
-   */
-  getPortletNamespace(aPrefix: java.lang.String): string;
-
-  /**
-   * Gets a unique nonce for this request.
-   *
-   * <p>
-   *    The nonce should be used for all client-side inline javascript (e.g. <code>&lt;script nonce="..."&gt; ... &lt;script&gt;</code>).
-   *    If not specified, the script might be blocked and ignored by the client/browser due to the content security policy settings of the page
-   *    (i.e. typically when the CSP has no "unsafe-inline" specified).
-   * </p>
-   * @return A unique identifier for this request.
-   * @since Sitevision 2022.08.1
-   */
-  getNonce(): string;
-}

package/hidden/senselogic/sitevision/api/cookie/SiteCookieUtil/index.d.ts

@@ -1,166 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * Site cookie utility interface.
- *
- * <p>
- *    Contains methods for retrieving sv:siteCookie Nodes of current site and current user's consent status of them.
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getSiteCookieUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- * @see senselogic.sitevision.api.resource.ResourceLocatorUtil#getSiteCookieRepository()
- * @author Karl Eklöf
- * @since Sitevision 9.1
- */
-
-interface SiteCookieUtil {
-  /**
-   * Necessary Site cookies (sv:siteCookie) of current site.
-   * @return the necessary site cookies of current site, or empty list if current site has no site cookies
-   */
-  getNecessarySiteCookies(): unknown[];
-
-  /**
-   * Gets the necessary site cookies category title.
-   * @return necessary site cookies category title
-   */
-  getNecessarySiteCookiesTitle(): string;
-
-  /**
-   * Gets the necessary site cookies category description.
-   * @return necessary site cookies category description
-   */
-  getNecessarySiteCookiesDescription(): string;
-
-  /**
-   * Analytics Site cookies (sv:siteCookie) of current site.
-   * @return the analytics site cookies of current site, or empty list if current site has no site cookies
-   */
-  getAnalyticsSiteCookies(): unknown[];
-
-  /**
-   * Gets the analytics site cookies category title.
-   * @return analytics site cookies category title
-   */
-  getAnalyticsSiteCookiesTitle(): string;
-
-  /**
-   * Gets the analytics site cookies category description.
-   * @return analytics site cookies category description
-   */
-  getAnalyticsSiteCookiesDescription(): string;
-
-  /**
-   * Marketing Site cookies (sv:siteCookie) of current site.
-   * @return the marketing site cookies of current site, or empty list if current site has no site cookies
-   */
-  getMarketingSiteCookies(): unknown[];
-
-  /**
-   * Gets the marketing site cookies category title.
-   * @return marketing site cookies category title
-   */
-  getMarketingSiteCookiesTitle(): string;
-
-  /**
-   * Gets the marketing site cookies category description.
-   * @return marketing site cookies category description
-   */
-  getMarketingSiteCookiesDescription(): string;
-
-  /**
-   * Functional Site cookies (sv:siteCookie) of current site.
-   * @return the functional site cookies of current site, or empty list if current site has no site cookies
-   * @since Sitevision 9.1.1
-   */
-  getFunctionalSiteCookies(): unknown[];
-
-  /**
-   * Gets the functional site cookies category title.
-   * @return functional site cookies category title
-   * @since Sitevision 9.1.1
-   */
-  getFunctionalSiteCookiesTitle(): string;
-
-  /**
-   * Gets the functional site cookies category description.
-   * @return functional site cookies category description
-   * @since Sitevision 9.1.1
-   */
-  getFunctionalSiteCookiesDescription(): string;
-
-  /**
-   * Custom Site cookies (sv:siteCookie) of current site.
-   * @return the custom site cookies of current site, or empty list if current site has no site cookies
-   */
-  getCustomSiteCookies(): unknown[];
-
-  /**
-   * Gets the custom site cookies category title.
-   * @return custom site cookies category title
-   */
-  getCustomSiteCookiesTitle(): string;
-
-  /**
-   * Gets the custom site cookies category description.
-   * @return custom site cookies category description
-   */
-  getCustomSiteCookiesDescription(): string;
-
-  /**
-   * Convenience method that resolves a sv:siteCookie Node from a given cookie identifier.
-   * @param aCookieIdentifier the site cookie identifier
-   * @return the sv:siteCookie Node with the "cookieIdentifier" property that matches aCookieIdentifier. Returns null if aCookieIdentifier is null, blank or indeterminable
-   */
-  resolveSiteCookieByIdentifier(aCookieIdentifier: java.lang.String): Node;
-
-  /**
-   * Checks whether or not current user explicitly has accepted a specific site cookie.
-   * @param aSiteCookie the sv:siteCookie
-   * @return true if current user has accepted aSiteCookie, false otherwise
-   */
-  checkUserConsent(aSiteCookie: Node): boolean;
-
-  /**
-   * Whether or not current user has explicitly accepted/rejected all "user selectable" site cookies.
-   * @return true if there are site cookies that current user hasn't yet accepted/rejected, false otherwise
-   * @see #hasUserConsentCookie()
-   */
-  hasPendingUserConsents(): boolean;
-
-  /**
-   * Whether or not current user has a consent cookie.
-   * @return true if current user has a consent cookie set, false otherwise
-   * @see #hasPendingUserConsents()
-   */
-  hasUserConsentCookie(): boolean;
-
-  /**
-   * The name of the cookie that contains data about site cookie consents.
-   * @return the name of the cookie that contains data about site cookie consents
-   */
-  getUserConsentCookieName(): string;
-
-  /**
-   * Generates a consent string that can be saved as cookie value for the cookie named {@link #getUserConsentCookieName()}.
-   *
-   * <p>
-   *    <em>Note!</em> All "user selectable" sv:siteCookie Nodes that are <em>not</em> present in <code>aAllowCookieIdList</code>
-   *    will be treated as rejected.
-   * </p>
-   * @param aAllowCookieIdList the list of sv:siteCookie accepted by current user
-   * @return a string that represents the accept/reject status for current sv:siteCookie's
-   * @throws IllegalArgumentException if aAllowCookieIdList is null or contains other than sv:siteCookie Nodes
-   */
-  createUserConsentCookieValue(aAllowCookieIdList: java.util.List): string;
-
-  /**
-   * Gets all sv:siteCookie nodes that current user has accepted.
-   * @return the list of sv:siteCookie Nodes current user has accepted. Returns empty list if site has no site cookies or if current user hasn't accepted any sv:siteCookie
-   */
-  getUserConsents(): unknown[];
-}