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

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

@@ -0,0 +1,22 @@
+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/base/Builder/index.d.ts

@@ -87,7 +87,7 @@
  *       $scriptUtil.swallow($mailBuilder.addRecipient('magnus.lovgren@sitevision.se'))
  *       #set ($mail = $mailBuilder.build())</code></pre>
  *    </li>
- * </ul>Creates an instance of type <em>T</em> using current state of this builder.
+ * </ul>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */

package/hidden/senselogic/sitevision/api/base/Builder/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  build: function build() {}
+};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/base/Filter/index.d.ts

@@ -8,7 +8,7 @@
  * </p>
  * <p>
  *    See {@link senselogic.sitevision.api.node.NodeFilterUtil} for predefined node filters (i.e. <code>Filter&lt;Node&gt;</code>).
- * </p>Whether a given object matches the filter requirements or not.
+ * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.2
  * @see senselogic.sitevision.api.node.NodeFilterUtil

package/hidden/senselogic/sitevision/api/base/Filter/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  accept: function accept() {}
+};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/base/FilterSplit/index.d.ts

@@ -15,11 +15,7 @@ import Filter from "../Filter";
  *    to split on an iterator and
  *    {@link senselogic.sitevision.api.node.NodeFilterUtil#split(java.util.Collection, Filter)}
  *    to split on a collection.
- * </p>Gets the list of items that was accepted by the filter.
- *
- * <p>
- *    <em>Note! The accepted list will always be empty if the filter used for the filtering operation is null</em>
- * </p>Gets the list of items that was rejected by the filter.Gets the filter used for the filtering operation.
+ * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6.3
  */
@@ -32,13 +28,13 @@ interface FilterSplit {
    * </p>
    * @return the list of accepted items, never <code>null</code>
    */
-  getAccepted(): unknown[];
+  getAccepted(): unknown;
 
   /**
    * Gets the list of items that was rejected by the filter.
    * @return the list of rejected items, never <code>null</code>
    */
-  getRejected(): unknown[];
+  getRejected(): unknown;
 
   /**
    * Gets the filter used for the filtering operation.

package/hidden/senselogic/sitevision/api/base/FilterSplit/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  getAccepted: function getAccepted() {},
+  getRejected: function getRejected() {},
+  getFilter: function getFilter() {}
+};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/base/Loadable/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * A functional interface for loading resources.Loads a resource that is identified with a specific name.
+ * A functional interface for loading resources.
  * @author Magnus Lövgren
  * @since Sitevision 4.0
  */

package/hidden/senselogic/sitevision/api/base/Loadable/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  load: function load() {}
+};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/base/Resolver/index.d.ts

@@ -13,7 +13,7 @@
  * <p>
  *    See {@link senselogic.sitevision.api.node.NodeResolverUtil} for predefined resolvers that operates on nodes
  *    (i.e. <code>Resolver&lt;Node,?&gt;</code>).
- * </p>Resolves a value from an object.
+ * </p>
  * @param <T> type of object to operate on
  * @param <V> type of value to produce
  * @author Magnus Lövgren

package/hidden/senselogic/sitevision/api/base/Resolver/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  resolve: function resolve() {}
+};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/base/Wrapper/index.d.ts

@@ -9,7 +9,7 @@
  * <p>
  *    All invocations for the wrapper will be delegated to the wrapped object, or executed with the wrapped object as subject/context
  *    when performing the invocation.
- * </p>Gets the wrapped object.
+ * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */

package/hidden/senselogic/sitevision/api/base/Wrapper/index.js

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {
+  unwrap: function unwrap() {}
+};
+exports["default"] = _default;

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

@@ -0,0 +1,87 @@
+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

@@ -0,0 +1,23 @@
+/**
+ * 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

@@ -0,0 +1,49 @@
+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

@@ -0,0 +1,39 @@
+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

@@ -0,0 +1,58 @@
+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

@@ -0,0 +1,99 @@
+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;
+}