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

package/server/TrashcanUtil/index.d.ts

@@ -1,113 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * <p>
- *    Puts a node in the site trashcan.
- * </p>
- * <p>
- *    A node that has been deleted (i.e. put in the site trashcan) can later be restored using the method
- *    {@link #restoreNode(javax.jcr.Node)} or be permanently removed with the method
- *    {@link #deleteNodeFromTrashcan(javax.jcr.Node)}.
- * </p>
- * <p>
- *    Valid node types are:
- * </p>
- * <ul>
- *    <li><code>sv:archive</code></li>
- *    <li><code>sv:article</code></li>
- *    <li><code>sv:file</code></li>
- *    <li><code>sv:folder</code></li>
- *    <li><code>sv:image</code></li>
- *    <li><code>sv:link</code></li>
- *    <li><code>sv:page</code></li>
- *    <li><code>sv:template</code></li>
- * </ul>
- * <p>
- *    If any other node is specified a <code>ConstraintViolationException</code> is thrown.
- * </p>
- *
- * <p>
- *    The current user must be authorized to delete objects, to alter the node and its current parent or
- *    a <code>ConstraintViolationException</code> is thrown
- *    (see {@link senselogic.sitevision.api.security.PermissionUtil#hasEffectiveDeletePermission(Node, Node)}).
- * </p>
- *
- * <p>
- *    If no node is specified a <code>NullPointerException</code> is thrown.
- * </p>
- * @param aNode the node that will be moved to the site trashcan. May not be <code>null</code>
- * @throws ConstraintViolationException if an invalid node is specified or if the current user is not authorized to perform the delete operation
- * @throws RepositoryException if something else goes wrong
- * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveDeletePermission(Node, Node)
- */
-export function moveNodeToTrashcan(aNode: Node): void;
-
-/**
- * <p>
- *    Restores a node from the site trashcan.
- * </p>
- * <p>
- *    If the node is not in the site trashcan or if an invalid node type is specified
- *    (i.e. a node that never could be in the site trashcan like the sv:site node)
- *    a <code>IllegalArgumentException</code> is thrown.
- * </p>
- *
- * <p>
- *    The current user must be authorized to alter the node and the parent node after the
- *    restore operation or a <code>ConstraintViolationException</code> is thrown.
- * </p>
- *
- * <p>
- *    If no node is specified a <code>NullPointerException</code> is thrown.
- * </p>
- * @param aNode the node that should be restored. This node must be located in the site trashcan. May not be null
- * @throws ConstraintViolationException is thrown if the current user is not authorized to perform the restore operation
- * @throws RepositoryException is thrown if something else goes wrong
- */
-export function restoreNode(aNode: Node): void;
-
-/**
- * <p>
- *    Deletes a node from the site trashcan.
- * </p>
- * <p>
- *    If the node is not in the site trashcan or if an invalid node type is specified
- *    (i.e. a node that never could be in the site trashcan like the sv:site node)
- *    a <code>IllegalArgumentException</code> is thrown.
- * </p>
- *
- * <p>
- *    The current user must be authorized to delete objects or a <code>ConstraintViolationException</code> is thrown.
- * </p>
- *
- * <p>
- *    If no node is specified a <code>NullPointerException</code> is thrown.
- * </p>
- * @param aNode the node that should be removed from the site trashcan. This node must be located in the site trashcan. May not be <code>null</code>
- * @throws ConstraintViolationException if the current user is not authorized to perform the delete operation
- * @throws RepositoryException if something else goes wrong
- */
-export function deleteNodeFromTrashcan(aNode: Node): void;
-
-/**
- * <p>
- *    Checks if a node is in the site trashcan
- * </p>
- *
- * <p>
- *    If no node is specified a <code>NullPointerException</code> is thrown.
- * </p>
- *
- * <p>
- *    Note that some nodes can't be put in the trashcan (e.g. sv:user, sv:color, sv:portlet, sv:layout etc).
- *    For such nodes <code>false</code> will be returned.
- * </p>
- * @param aNode the node to be checked if it is located in the site trashcan. May not be <code>null</code>
- * @return <code>true</code> if the <code>Node</code> is in site trashcan, <code>false</code> otherwise
- * @since Sitevision 6.2
- */
-export function isInTrashcan(aNode: Node): boolean;
-
 /**
  * Trashcan utility interface for delete and restore of nodes.
  *
@@ -119,13 +11,118 @@ export function isInTrashcan(aNode: Node): boolean;
  * @see senselogic.sitevision.api.resource.ResourceLocatorUtil#getTrashcan()
  * @since Sitevision 2.6.2
  */
-declare namespace trashcanUtil {
-  export {
-    moveNodeToTrashcan,
-    restoreNode,
-    deleteNodeFromTrashcan,
-    isInTrashcan,
-  };
+export interface TrashcanUtil {
+  /**
+   * <p>
+   *    Puts a node in the site trashcan.
+   * </p>
+   * <p>
+   *    A node that has been deleted (i.e. put in the site trashcan) can later be restored using the method
+   *    {@link #restoreNode(javax.jcr.Node)} or be permanently removed with the method
+   *    {@link #deleteNodeFromTrashcan(javax.jcr.Node)}.
+   * </p>
+   * <p>
+   *    Valid node types are:
+   * </p>
+   * <ul>
+   *    <li><code>sv:archive</code></li>
+   *    <li><code>sv:article</code></li>
+   *    <li><code>sv:file</code></li>
+   *    <li><code>sv:folder</code></li>
+   *    <li><code>sv:image</code></li>
+   *    <li><code>sv:link</code></li>
+   *    <li><code>sv:page</code></li>
+   *    <li><code>sv:template</code></li>
+   * </ul>
+   * <p>
+   *    If any other node is specified a <code>ConstraintViolationException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    The current user must be authorized to delete objects, to alter the node and its current parent or
+   *    a <code>ConstraintViolationException</code> is thrown
+   *    (see {@link senselogic.sitevision.api.security.PermissionUtil#hasEffectiveDeletePermission(Node, Node)}).
+   * </p>
+   *
+   * <p>
+   *    If no node is specified a <code>NullPointerException</code> is thrown.
+   * </p>
+   * @param aNode the node that will be moved to the site trashcan. May not be <code>null</code>
+   * @throws ConstraintViolationException if an invalid node is specified or if the current user is not authorized to perform the delete operation
+   * @throws RepositoryException if something else goes wrong
+   * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveDeletePermission(Node, Node)
+   */
+  moveNodeToTrashcan(aNode: Node): void;
+
+  /**
+   * <p>
+   *    Restores a node from the site trashcan.
+   * </p>
+   * <p>
+   *    If the node is not in the site trashcan or if an invalid node type is specified
+   *    (i.e. a node that never could be in the site trashcan like the sv:site node)
+   *    a <code>IllegalArgumentException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    The current user must be authorized to alter the node and the parent node after the
+   *    restore operation or a <code>ConstraintViolationException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    If no node is specified a <code>NullPointerException</code> is thrown.
+   * </p>
+   * @param aNode the node that should be restored. This node must be located in the site trashcan. May not be null
+   * @throws ConstraintViolationException is thrown if the current user is not authorized to perform the restore operation
+   * @throws RepositoryException is thrown if something else goes wrong
+   */
+  restoreNode(aNode: Node): void;
+
+  /**
+   * <p>
+   *    Deletes a node from the site trashcan.
+   * </p>
+   * <p>
+   *    If the node is not in the site trashcan or if an invalid node type is specified
+   *    (i.e. a node that never could be in the site trashcan like the sv:site node)
+   *    a <code>IllegalArgumentException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    The current user must be authorized to delete objects or a <code>ConstraintViolationException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    If no node is specified a <code>NullPointerException</code> is thrown.
+   * </p>
+   * @param aNode the node that should be removed from the site trashcan. This node must be located in the site trashcan. May not be <code>null</code>
+   * @throws ConstraintViolationException if the current user is not authorized to perform the delete operation
+   * @throws RepositoryException if something else goes wrong
+   */
+  deleteNodeFromTrashcan(aNode: Node): void;
+
+  /**
+   * <p>
+   *    Checks if a node is in the site trashcan
+   * </p>
+   *
+   * <p>
+   *    If no node is specified a <code>NullPointerException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    Note that some nodes can't be put in the trashcan (e.g. sv:user, sv:color, sv:portlet, sv:layout etc).
+   *    For such nodes <code>false</code> will be returned.
+   * </p>
+   * @param aNode the node to be checked if it is located in the site trashcan. May not be <code>null</code>
+   * @return <code>true</code> if the <code>Node</code> is in site trashcan, <code>false</code> otherwise
+   * @since Sitevision 6.2
+   */
+  isInTrashcan(aNode: Node): boolean;
 }
 
+declare namespace TrashcanUtil {}
+
+declare var trashcanUtil: TrashcanUtil;
+
 export default trashcanUtil;

package/server/UserDataUtil/index.d.ts

@@ -1,112 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * 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
- */
-export function getReadOnlyKeys(): 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
- */
-export function getUserData(aUserDataKey: 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
- */
-export function getUserData(aUserNode: Node, aUserDataKey: 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>)
- */
-export function setUserData(
-  aUserDataKey: string,
-  aSerializableValue: unknown
-): 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>)
- */
-export function setUserData(
-  aUserNode: Node,
-  aUserDataKey: string,
-  aSerializableValue: unknown
-): 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
- */
-export function removeUserData(aUserDataKey: 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
- */
-export function removeUserData(aUserNode: Node, aUserDataKey: string): void;
-
 /**
  * User data utility interface.
  *
@@ -136,8 +29,114 @@ export function removeUserData(aUserNode: Node, aUserDataKey: string): void;
  * @author Magnus Lövgren
  * @since Sitevision 4.1
  */
-declare namespace userDataUtil {
-  export { getReadOnlyKeys, getUserData, setUserData, removeUserData };
+export 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(): 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: 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: 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: string, aSerializableValue: unknown): 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: string,
+    aSerializableValue: unknown
+  ): 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: 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: string): void;
 }
 
+declare namespace UserDataUtil {}
+
+declare var userDataUtil: UserDataUtil;
+
 export default userDataUtil;

package/server/UserFactory/index.d.ts

@@ -1,52 +1,10 @@
-import UserIdentityUtil from "../UserIdentityUtil";
+import type { UserIdentityUtil } from "../UserIdentityUtil";
 import type { Node } from "../../types/javax/jcr/Node";
 import type { UserIdentityWrapper } from "../../types/senselogic/sitevision/api/user/UserIdentityWrapper";
-import SystemUserUtil from "../SystemUserUtil";
-import UserUtil from "../UserUtil";
-import SimpleUserUtil from "../SimpleUserUtil";
-import UserDataUtil from "../UserDataUtil";
-
-/**
- * Gets an instance of a user identity utility class.
- * @return an instance of a user identity utility class
- */
-export function 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>)
- */
-export function getUserIdentityWrapper(
-  aUserIdentity: Node
-): UserIdentityWrapper;
-
-/**
- * Gets an instance of a system user utility class.
- * @return an instance of a system user utility class
- */
-export function getSystemUserUtil(): SystemUserUtil;
-
-/**
- * Gets an instance of a user utility class.
- * @return an instance of a user utility class
- * @since Sitevision 4.0.1
- */
-export function 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
- */
-export function getSimpleUserUtil(): SimpleUserUtil;
-
-/**
- * Gets an instance of a user data utility class.
- * @return an instance of a user data utility class
- * @since Sitevision 4.1
- */
-export function getUserDataUtil(): UserDataUtil;
+import type { SystemUserUtil } from "../SystemUserUtil";
+import type { UserUtil } from "../UserUtil";
+import type { SimpleUserUtil } from "../SimpleUserUtil";
+import type { UserDataUtil } from "../UserDataUtil";
 
 /**
  * Factory for creating user-related instances.
@@ -59,15 +17,50 @@ export function getUserDataUtil(): UserDataUtil;
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
-declare namespace userFactory {
-  export {
-    getUserIdentityUtil,
-    getUserIdentityWrapper,
-    getSystemUserUtil,
-    getUserUtil,
-    getSimpleUserUtil,
-    getUserDataUtil,
-  };
+export 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;
 }
 
+declare namespace UserFactory {}
+
+declare var userFactory: UserFactory;
+
 export default userFactory;