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

package/hidden/senselogic/sitevision/api/user/UserDataUtil/index.d.ts

@@ -0,0 +1,140 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * User data utility interface.
+ *
+ * <p>
+ *    The portlet specification allows access of user-specific data via a read-only <code>java.util.Map</code>
+ *    that can be obtained as request attribute using the <code>PortletRequest.USER_INFO</code> constant.
+ *    This utility is a convenience to get such user data, but it also extends it by allowing write operations
+ *    and access other user's data. Data written via this utility can be accesses via the Map exposed via the
+ *    <code>PortletRequest.USER_INFO</code> constant and vice versa. Hence, with this utility there are no need to use
+ *    the portlet specification mechanism for accessing user data.
+ * </p>
+ *
+ * <p>
+ *    Mutating data operations (set/remove) on other users requires certain permissions, see individual method documentation.
+ * </p>
+ *
+ * <p>
+ *    <strong>Important note!</strong> The user data mechanism is closely tied to a specific user object and is intended to handle
+ *    basic <em>user information</em> and <em>user preferences</em>. Adding "too much" (count) or "too large" (size) user data
+ *    might cause persistence implications and performance implications.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link UserFactory#getUserDataUtil()}.
+ *    See {@link senselogic.sitevision.api.user.UserFactory} for how to obtain an instance of the <code>UserFactory</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 4.1
+ */
+
+interface UserDataUtil {
+  /**
+   * The read-only keys.
+   *
+   * <p>
+   *    Mutating operations (set/remove) with any of these keys will be ignored.
+   * </p>
+   * <p>
+   *    <em>Note that internal-only properties are not included in the returned set, but they will also be ignored in mutating operations.</em>
+   * </p>
+   * @return a set of keys that are read-only
+   */
+  getReadOnlyKeys(): Set<unknown>;
+
+  /**
+   * Gets user data for current user.
+   *
+   * <p>
+   *    <em>This read operation is equivalent to using the user info mechanism of the portlet specification.</em>
+   * </p>
+   * @param aUserDataKey the data key
+   * @return the value for <code>aUserDataKey</code> (typically a <code>String</code>), or null
+   */
+  getUserData(aUserDataKey: java.lang.String): unknown;
+
+  /**
+   * Gets user data for a user.
+   * @param aUserNode the user node (typically a <code>sv:user</code> or <code>sv:simpleUser</code>)
+   * @param aUserDataKey the data key
+   * @return the value for <code>aUserDataKey</code> (typically a <code>String</code>), or null
+   */
+  getUserData(aUserNode: Node, aUserDataKey: java.lang.String): unknown;
+
+  /**
+   * Sets user data for current user.
+   *
+   * <p>
+   *    <em>This write operation is equivalent to using the Sitevision-specific user info mechanism of the portlet specification.</em>
+   * </p>
+   *
+   * <p>
+   *    <em>Important note!</em> The set/write operation will be ignored if <code>aUserDataKey</code> is <code>null</code>, whitespace-only or
+   *    <em>read-only</em> (see {@link #getReadOnlyKeys}). The set operation will also be ignored if <code>aSerializableValue</code>
+   *    is <code>null</code>.
+   *    Use {@link #removeUserData(String)} to remove data instead.
+   * </p>
+   * @param aUserDataKey the data key
+   * @param aSerializableValue the data value (typically a <code>String</code>)
+   */
+  setUserData(
+    aUserDataKey: java.lang.String,
+    aSerializableValue: java.io.Serializable
+  ): void;
+
+  /**
+   * Sets user data for a user.
+   *
+   * <p>
+   *    <em>Important note!</em> The set/write operation will be ignored if <code>aUserDataKey</code> is <code>null</code>, whitespace-only or
+   *    <em>read-only</em> (see {@link #getReadOnlyKeys}). The set operation will also be ignored if <code>aSerializableValue</code>
+   *    is <code>null</code>.
+   *    Use {@link #removeUserData(String)} to remove data instead.
+   * </p>
+   *
+   * <p>
+   *    <em>Permission note!</em> Current user (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}) must have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on current site
+   *    (as of {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getSite()}), otherwise the set/write operation will be ignored.
+   * </p>
+   * @param aUserNode the user node (typically a <code>sv:user</code> or <code>sv:simpleUser</code>)
+   * @param aUserDataKey the data key
+   * @param aSerializableValue the data value (typically a <code>String</code>)
+   */
+  setUserData(
+    aUserNode: Node,
+    aUserDataKey: java.lang.String,
+    aSerializableValue: java.io.Serializable
+  ): void;
+
+  /**
+   * Removes user data.
+   *
+   * <p>
+   *    <em>Important note!</em> The remove/delete operation will be ignored if <code>aUserDataKey</code> is <code>null</code>, whitespace-only or
+   *    <em>read-only</em> (see {@link #getReadOnlyKeys}).
+   * </p>
+   * @param aUserDataKey the data key
+   */
+  removeUserData(aUserDataKey: java.lang.String): void;
+
+  /**
+   * Removes user data for a user.
+   *
+   * <p>
+   *    <em>Important note!</em> The remove/delete operation will be ignored if <code>aUserDataKey</code> is <code>null</code>, whitespace-only or
+   *    <em>read-only</em> (see {@link #getReadOnlyKeys}).
+   * </p>
+   *
+   * <p>
+   *    <em>Permission note!</em> Current user (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}) must have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on current site
+   *    (as of {@link senselogic.sitevision.api.resource.ResourceLocatorUtil#getSite()}), otherwise the remove/delete operation will be ignored.
+   * </p>
+   * @param aUserNode the user node (typically a <code>sv:user</code> or <code>sv:simpleUser</code>)
+   * @param aUserDataKey the data key
+   */
+  removeUserData(aUserNode: Node, aUserDataKey: java.lang.String): void;
+}

package/hidden/senselogic/sitevision/api/user/UserFactory/index.d.ts

@@ -0,0 +1,61 @@
+import UserIdentityUtil from "../UserIdentityUtil";
+import Node from "../../../../../javax/jcr/Node";
+import UserIdentityWrapper from "../UserIdentityWrapper";
+import SystemUserUtil from "../SystemUserUtil";
+import UserUtil from "../UserUtil";
+import SimpleUserUtil from "../SimpleUserUtil";
+import UserDataUtil from "../UserDataUtil";
+
+/**
+ * Factory for creating user-related instances.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getUserFactory()}.
+ *    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 UserFactory {
+  /**
+   * Gets an instance of a user identity utility class.
+   * @return an instance of a user identity utility class
+   */
+  getUserIdentityUtil(): UserIdentityUtil;
+
+  /**
+   * Gets an instance of a user identity wrapper.
+   * @param aUserIdentity a user identity (or user)
+   * @return an instance of a user identity wrapper, or <code>null</code> if indeterminable (e.g. <code>aUserIdentity</code> is <code>null</code>)
+   */
+  getUserIdentityWrapper(aUserIdentity: Node): UserIdentityWrapper;
+
+  /**
+   * Gets an instance of a system user utility class.
+   * @return an instance of a system user utility class
+   */
+  getSystemUserUtil(): SystemUserUtil;
+
+  /**
+   * Gets an instance of a user utility class.
+   * @return an instance of a user utility class
+   * @since Sitevision 4.0.1
+   */
+  getUserUtil(): UserUtil;
+
+  /**
+   * Gets an instance of a simple user utility class.
+   * @return an instance of a simple user utility class
+   * @since Sitevision 4.0.1
+   */
+  getSimpleUserUtil(): SimpleUserUtil;
+
+  /**
+   * Gets an instance of a user data utility class.
+   * @return an instance of a user data utility class
+   * @since Sitevision 4.1
+   */
+  getUserDataUtil(): UserDataUtil;
+}

package/hidden/senselogic/sitevision/api/user/UserIdentityUtil/index.d.ts

@@ -0,0 +1,52 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * User identity utility interface.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link UserFactory#getUserIdentityUtil()}.
+ *    See {@link senselogic.sitevision.api.user.UserFactory} for how to obtain an instance of the <code>UserFactory</code> interface.
+ * </p>
+ *
+ * <p>
+ *    <em>Tip!</em> Use {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUserIdentity()} for getting
+ *    the user identity of current user.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+
+interface UserIdentityUtil {
+  /**
+   * Creates the corresponding <code>sv:userIdentity</code> Node for a specified <code>sv:user</code> Node.
+   *
+   * <p>
+   *    <strong>Note!</strong> When Collaboration is activated for a site, user identities are automatically created
+   *    for each user when they authenticates themselves. This method is typically used for "infrequent" users during
+   *    the startup phase of using Collaboration.
+   * </p>
+   * <p>
+   *    <em>Note that neither anonymous users, the indexer or the extractor can have a user identity!</em>
+   * </p>
+   * @param aUserNode a user node that presumably do not have a corresponding user identity
+   * @return the existing or created sv:userIdentity Node for <code>aUserNode</code>, or <code>null</code> if <code>aUserNode</code> is <code>null</code> or isn't allowed to have user identity for current site (e.g. user is anonymized).
+   * @see #getUserIdentity(javax.jcr.Node)
+   */
+  getOrCreateUserIdentity(aUserNode: Node): Node;
+
+  /**
+   * Gets the corresponding <code>sv:userIdentity</code> Node for a specified <code>sv:user</code> Node.
+   *
+   * <p>
+   *    <em>Note that neither anonymous users, the indexer or the extractor user has a user identity!</em>
+   * </p>
+   * <p>
+   *    <em>Tip!</em> Use {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUserIdentity()} for getting
+   *    the user identity of current user.
+   * </p>
+   * @param aUserNode a user node
+   * @return the corresponding sv:userIdentity Node for <code>aUserNode</code>, or <code>null</code> if <code>aUserNode</code> is <code>null</code> or has no corresponding user identity for current site (e.g. user is anonymized).
+   */
+  getUserIdentity(aUserNode: Node): Node;
+}

package/hidden/senselogic/sitevision/api/user/UserIdentityWrapper/index.d.ts

@@ -1,5 +1,7 @@
 import Node from "../../../../../javax/jcr/Node";
 
+import Wrapper from "../../base/Wrapper";
+
 /**
  * User identity wrapper interface.
  *
@@ -16,196 +18,6 @@ import Node from "../../../../../javax/jcr/Node";
  *    An instance of the Sitevision class implementing this interface can be obtained via
  *    {@link UserFactory#getUserIdentityWrapper(javax.jcr.Node)}.
  *    See {@link senselogic.sitevision.api.user.UserFactory} for how to obtain an instance of the <code>UserFactory</code> interface.
- * </p>Gets the contacts of the wrapped user identity.Checks if the wrapped user identity is contact with a specified user identity.Adds a contact for the wrapped user identity.
- *
- * <p>
- *    <strong>Permission note!</strong> This mutating operation is not allowed for a wrapped user identity that is {@link #isDisabled() disabled}.
- *    To be allowed to add a contact for the wrapped user identity, current user must match the wrapped user identity
- *    (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES}
- *    on current page.
- * </p>Removes a contact of the wrapped user identity.
- *
- * <p>
- *    <strong>Permission note!</strong> This mutating operation is not allowed for a wrapped user identity that is {@link #isDisabled() disabled}.
- *    To be allowed to remove a contact for the wrapped user identity, current user must match the wrapped user identity
- *    (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES}
- *    on current page.
- * </p>Gets the collaboration groups of the wrapped user identity.
- *
- * <p>
- *    <strong>Permission note!</strong> The returned set will only contain the collaboration groups that
- *    that current user is allowed to read (i.e. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}).
- * </p>Checks if wrapped user identity is admin of a collaboration group.Checks if wrapped user identity is member of a collaboration group.The wrapped user identity leaves a collaboration group.
- *
- * <p>
- *    <em>Only members can leave a collaboration group</em>, i.e. the leave attempt will be ignored if wrapped user
- *    identity isn't a member of specified collaboration group. Note that a group <em>admin</em>
- *    is also a group <em>member</em> so leaving a collaboration group might in fact also remove an <em>admin</em>,
- *    but <em>last admin</em> will never be removed. Collaboration groups that are <em>inactive</em> can not be leaved.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> This mutating operation is not allowed for a wrapped user identity that is {@link #isDisabled() disabled}.
- *    To remove group membership for the wrapped user identity, current user must match the wrapped user identity
- *    (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
- *    on the collaboration group.
- * </p>The wrapped user identity joins a collaboration group.
- *
- * <p>
- *    <em>Only non-members can join a collaboration group</em>, i.e. the join attempt will be ignored if wrapped user
- *    identity already are a member of specified collaboration group. Collaboration groups that are <em>inactive</em> can not be joined.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> This mutating operation is not allowed for a wrapped user identity that is {@link #isDisabled() disabled}.
- *    To join a collaboration group for the wrapped user identity, current user must match the wrapped user identity
- *    (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
- *    on the collaboration group.
- * </p>The wrapped user identity follows/eavesdrops a collaboration group.
- *
- * <p>
- *    <em>Only non-members can follow a collaboration group</em>, i.e. the follow attempt will be ignored if wrapped user
- *    identity already are a member of specified collaboration group. Collaboration groups that are <em>inactive</em>
- *    or <em>closed</em> can not be followed.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> This mutating operation is not allowed for a wrapped user identity that is {@link #isDisabled() disabled}.
- *    To follow a collaboration group for the wrapped user identity, current user must match the wrapped user identity
- *    (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
- *    on the collaboration group.
- * </p>Gets the collaboration groups the wrapped user identity follows/eavesdrops.
- *
- * <p>
- *    <strong>Permission note!</strong> The returned set will only contain active collaboration groups that
- *    that current user is allowed to read (i.e. {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}).
- * </p>Checks if wrapped user identity is following/eavesdropping a collaboration group.The wrapped user identity stops following/eavesdropping a collaboration group.
- *
- * <p>
- *    <em>Only followers can stop following a collaboration group</em>, i.e. the unfollow attempt will be ignored if wrapped user
- *    identity isn't a follower of specified collaboration group. Collaboration groups that are <em>inactive</em> can not be unfollowed.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> This mutating operation is not allowed for a wrapped user identity that is {@link #isDisabled() disabled}.
- *    To unfollow a group for the wrapped user identity, current user must match the wrapped user identity
- *    (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
- *    on the collaboration group.
- * </p>The wrapped user identity mutes a collaboration group (entries will not show up user's in compound timeline).
- *
- * <p>
- *    <em>Only members can mute a collaboration group</em>, i.e. the mute attempt will be ignored if wrapped user
- *    identity is not a member of the specified collaboration group.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> This mutating operation is not allowed for a wrapped user identity that is {@link #isDisabled() disabled}.
- *    To mute a collaboration group for the wrapped user identity, current user must match the wrapped user identity
- *    (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
- *    on the collaboration group.
- * </p>The wrapped user identity unmutes a collaboration group.
- *
- * <p>
- *    <em>Only members can unmute a collaboration group</em>, i.e. the unmute attempt will be ignored if wrapped user
- *     identity is not a member of the specified collaboration group.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> This mutating operation is not allowed for a wrapped user identity that is {@link #isDisabled() disabled}.
- *    To unmute a group for the wrapped user identity, current user must match the wrapped user identity
- *    (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
- *    on the collaboration group.
- * </p>Checks if wrapped user identity has muted the collaboration group.The wrapped user identity mutes notifications from a collaboration group (entries will show up but not notifications).
- *
- * <p>
- *    <em>Only members can mute notifications from a collaboration group</em>, i.e. the mute attempt will be ignored if wrapped user
- *    identity is not a member of the specified collaboration group.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> This mutating operation is not allowed for a wrapped user identity that is {@link #isDisabled() disabled}.
- *    To mute notifications from a collaboration group for the wrapped user identity, current user must match the wrapped user identity
- *    (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
- *    on the collaboration group.
- * </p>The wrapped user identity unmutes notifications from a collaboration group.
- *
- * <p>
- *    <em>Only members can unmute notifications from a collaboration group</em>, i.e. the unmute attempt will be ignored if wrapped user
- *     identity is not a member of the specified collaboration group.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> This mutating operation is not allowed for a wrapped user identity that is {@link #isDisabled() disabled}.
- *    To unmute notifications from a group for the wrapped user identity, current user must match the wrapped user identity
- *    (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
- *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
- *    on the collaboration group.
- * </p>Checks if wrapped user identity mutes notifications from the collaboration group.Gets the profile image of the wrapped user identity.
- *
- * <p>
- *    <em>Note!</em> This method returns the 'raw' profile image (i.e. a node of type <code>sv:image</code>)
- *    that the user has uploaded. For buddy icons, see {@link senselogic.sitevision.api.render.BuddyIconRenderer}.
- * </p>Gets the profile images folder of the wrapped user identity.Sets the profile image of the wrapped user identity.
- *
- * <p>
- *    This method <em>sets</em> the active profile image, i.e. determines which profile image that should be used.
- *    To <em>create a new</em> profile image (i.e. new binary data), you would typically use
- *    a method in {@link senselogic.sitevision.api.webresource.ImageUtil} first.
- * </p>
- *
- * <p>
- *    <strong>Model note!</strong> A profile image must be a node of type <code>sv:image</code>
- *    and a child of the <em>profile images folder</em> of the wrapped user identity.
- *    The profile images folder is available via {@link #getProfileImagesFolder()}.
- * </p>
- *
- * <p>
- *    <strong>Permission note!</strong> This mutating operation is not allowed for a wrapped user identity that is {@link #isDisabled() disabled}.
- *    To set the profile image for the wrapped user identity, current user must match the wrapped user identity
- *    (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES}
- *    on current page.
- * </p>Sets the visibility of the wrapped user identity in search results.
- *
- * <p>
- *    <strong>Permission note!</strong> This mutating operation is not allowed for a wrapped user identity that is {@link #isDisabled() disabled}.
- *    To update the hidden property for the wrapped user identity, current user must match the wrapped user identity
- *    (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES}
- *    on current page.
- * </p>Sets the availability of the wrapped user identity.
- *
- * <p>
- *    <strong>Permission note!</strong> To update the disabled property for the wrapped user identity,
- *    current user must match the wrapped user identity (i.e. <em>"is yourself"</em>) - or have
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_USER_IDENTITIES}
- *    on current page.
- * </p>Checks if the wrapped user identity is disabled or not.
- *
- * <p>
- *    This is a convenience method the check the boolean value of the <code>disabled</code> property of the wrapped user identity.
- *    <em>Note that a disabled user identity is not allowed to perform any mutating/write operations except {@link #setDisabled(boolean)}</em>.
- * </p>Gets the wrapped user identity.
- *
- * <p>
- *    <em>Note! This method is equivalent with {@link #unwrap()} if this wrapper is created with a <code>sv:userIdentity</code> node.</em>
  * </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
@@ -215,7 +27,7 @@ interface UserIdentityWrapper {
    * Gets the contacts of the wrapped user identity.
    * @return the contacts of the wrapped user identity. Never null.
    */
-  getContacts(): Set<unknown>;
+  getContacts(): unknown;
 
   /**
    * Checks if the wrapped user identity is contact with a specified user identity.
@@ -263,7 +75,7 @@ interface UserIdentityWrapper {
    * </p>
    * @return the accessible collaboration groups of the wrapped user identity. Never null.
    */
-  getCollaborationGroups(): Set<unknown>;
+  getCollaborationGroups(): unknown;
 
   /**
    * Checks if wrapped user identity is admin of a collaboration group.
@@ -356,7 +168,7 @@ interface UserIdentityWrapper {
    * @return the accessible collaboration groups the wrapped user identity follows. Never null.
    * @since Sitevision 4.1
    */
-  getFollowedGroups(): Set<unknown>;
+  getFollowedGroups(): unknown;
 
   /**
    * Checks if wrapped user identity is following/eavesdropping a collaboration group.

package/{server → hidden/senselogic/sitevision/api/user}/UserIdentityWrapper/index.js

@@ -5,25 +5,31 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports["default"] = void 0;
 var _default = {
+  getContacts: function getContacts() {},
+  isContact: function isContact() {},
   addContact: function addContact() {},
-  followGroup: function followGroup() {},
+  removeContact: function removeContact() {},
   getCollaborationGroups: function getCollaborationGroups() {},
-  getContacts: function getContacts() {},
-  getFollowedGroups: function getFollowedGroups() {},
-  getProfileImage: function getProfileImage() {},
-  getProfileImagesFolder: function getProfileImagesFolder() {},
-  getUserIdentity: function getUserIdentity() {},
   isAdminOf: function isAdminOf() {},
-  isContact: function isContact() {},
-  isDisabled: function isDisabled() {},
-  isFollowing: function isFollowing() {},
   isMemberOf: function isMemberOf() {},
-  joinGroup: function joinGroup() {},
   leaveGroup: function leaveGroup() {},
-  removeContact: function removeContact() {},
-  setDisabled: function setDisabled() {},
-  setHidden: function setHidden() {},
+  joinGroup: function joinGroup() {},
+  followGroup: function followGroup() {},
+  getFollowedGroups: function getFollowedGroups() {},
+  isFollowing: function isFollowing() {},
+  unfollowGroup: function unfollowGroup() {},
+  muteGroup: function muteGroup() {},
+  unmuteGroup: function unmuteGroup() {},
+  isGroupMuted: function isGroupMuted() {},
+  muteNotifications: function muteNotifications() {},
+  unmuteNotifications: function unmuteNotifications() {},
+  isNotificationsMuted: function isNotificationsMuted() {},
+  getProfileImage: function getProfileImage() {},
+  getProfileImagesFolder: function getProfileImagesFolder() {},
   setProfileImage: function setProfileImage() {},
-  unfollowGroup: function unfollowGroup() {}
+  setHidden: function setHidden() {},
+  setDisabled: function setDisabled() {},
+  isDisabled: function isDisabled() {},
+  getUserIdentity: function getUserIdentity() {}
 };
 exports["default"] = _default;

package/hidden/senselogic/sitevision/api/user/UserUtil/index.d.ts

@@ -0,0 +1,67 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * User utility interface.
+ *
+ * <p>
+ *    This interface primarily handles nodes with primary node type <code>sv:user</code>, but some methods can also handle
+ *    other user types (i.e. <code>sv:simpleUser</code> and/or <code>sv:systemUser</code>).
+ * </p>
+ *
+ * <p>
+ *    <em>Tip!</em> Some user-related functionality in other interfaces:
+ * </p>
+ * <ul>
+ *    <li>
+ *       Use {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()} if you should get current user.
+ *    </li>
+ *    <li>
+ *       Use {@link senselogic.sitevision.api.user.UserIdentityUtil#getUserIdentity(javax.jcr.Node)} if you should get
+ *       the <code>sv:userIdentity</code> of a user.
+ *    </li>
+ *    <li>
+ *       Use {@link senselogic.sitevision.api.security.DirectoryUtil} if you should lookup/search directory-bound users.
+ *    </li>
+ *    <li>
+ *       Use {@link senselogic.sitevision.api.security.PermissionUtil} if you should check permission(s) for a <code>sv:user</code>.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.user.UserFactory#getUserUtil()}.
+ *    See {@link senselogic.sitevision.api.user.UserFactory} for how to obtain an instance of the <code>UserFactory</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 4.0.1
+ * @see senselogic.sitevision.api.user.SystemUserUtil
+ * @see senselogic.sitevision.api.user.SimpleUserUtil
+ */
+
+interface UserUtil {
+  /**
+   * Checks if current user is member of a group.
+   *
+   * <p>
+   *    This is a convenience for {@link #isMemberOfGroup(javax.jcr.Node, javax.jcr.Node)} using current user
+   *    (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).
+   * </p>
+   * @param aGroup a group node (sv:userGroup or sv:virtualGroup)
+   * @return <code>true</code> if current user is member of <code>aGroup</code>, <code>false</code> otherwise
+   */
+  isMemberOfGroup(aGroup: Node): boolean;
+
+  /**
+   * Checks if a specific user is member of a group.
+   *
+   * <p>
+   *    <em>Tip!</em> To check if a <code>sv:userIdentity</code> is member of a <code>sv:collaborationGroup</code>,
+   *    you would typically use {@link senselogic.sitevision.api.user.UserIdentityWrapper#isMemberOf(javax.jcr.Node)} or
+   *    {@link senselogic.sitevision.api.collaboration.CollaborationGroupWrapper#isMember(javax.jcr.Node)}.
+   * </p>
+   * @param aUser a user node (sv:user, sv:simpleUser or sv:systemUser)
+   * @param aGroup a group node (sv:userGroup or sv:virtualGroup)
+   * @return <code>true</code> if <code>aUser</code> is member of <code>aGroup</code>, <code>false</code> otherwise
+   */
+  isMemberOfGroup(aUser: Node, aGroup: Node): boolean;
+}