@sitevision/api 1.0.19 → 1.1.0-alpha.1

package/server/TimestampUtil/index.d.ts

@@ -1,117 +1,133 @@
-import Calendar from '../../builtins/Calendar';
-import Date from '../../builtins/Date';
-import Instant from '../../builtins/Instant';
-import LocalDateTime from '../../builtins/LocalDateTime';
-import Locale from '../../builtins/Locale';
-
 /**
-* Formats a given timestamp.
-* @returns {string} a formatted String representing aTimestamp using Locale according toPortletContextUtil.getCurrentLocale(). If aLocale can not be resolved Locale.ENGLISH is used.If aTimestamp is negative or aFormatPattern is not valid the given timestamp is returned as String.
-* @param {number} aTimestamp - a timestamp.
-* @param {string} aFormatPattern - a date to string pattern according to SimpleDateFormat.
-*/
-export function format(aTimestamp: number, aFormatPattern: string): string;
+ * Returns current timestamp.
+ * @return a long representing the current time.
+ */
+export function getTimestamp(): number;
 
 /**
-* Formats a given timestamp using a specified Locale.
-* @returns {string} a formatted String representing the aTimestamp. If aTimestamp is negative or aFormatPattern is not valid the given timestampis returned as String.
-* @param {number} aTimestamp - a timestamp.
-* @param {string} aFormatPattern - a date to string pattern according to SimpleDateFormat.
-* @param {Locale} aLocale - a locale. If aLocale is null the current locale (as of PortletContextUtil.getCurrentLocale()) will be used. If aLocale can not be resolved Locale.ENGLISH will be used.
-*/
-export function format(aTimestamp: number, aFormatPattern: string, aLocale: Locale): string;
+ * Formats current timestamp.
+ * @param aFormatPattern a date to string pattern according to SimpleDateFormat.
+ * @return a formatted String representing current timestamp using Locale according to {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}. If aLocale can not be resolved Locale.ENGLISH is used. If aFormatPattern is not valid current timestamp is returned as String.
+ */
+export function formatCurrent(aFormatPattern: string): string;
 
 /**
-* Formats current timestamp.
-* @returns {string} a formatted String representing current timestamp using Locale according toPortletContextUtil.getCurrentLocale(). If aLocale can not be resolved Locale.ENGLISH is used.If aFormatPattern is not valid current timestamp is returned as String.
-* @param {string} aFormatPattern - a date to string pattern according to SimpleDateFormat.
-*/
-export function formatCurrent(aFormatPattern: string): string;
+ * Formats current timestamp using a specified Locale.
+ * @param aFormatPattern a date to string pattern according to SimpleDateFormat.
+ * @param aLocale a locale. If aLocale is null the current locale (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}) will be used. If aLocale can not be resolved Locale.ENGLISH will be used.
+ * @return a formatted String representing current timestamp. If aFormatPattern is not valid current timestamp is returned as String.
+ */
+export function formatCurrent(aFormatPattern: string, aLocale: unknown): string;
 
 /**
-* Formats current timestamp using a specified Locale.
-* @returns {string} a formatted String representing current timestamp. If aFormatPattern is not valid current timestamp is returned as String.
-* @param {string} aFormatPattern - a date to string pattern according to SimpleDateFormat.
-* @param {Locale} aLocale - a locale. If aLocale is null the current locale (as of PortletContextUtil.getCurrentLocale()) will be used. If aLocale can not be resolved Locale.ENGLISH will be used.
-*/
-export function formatCurrent(aFormatPattern: string, aLocale: Locale): string;
+ * Formats a given timestamp.
+ * @param aTimestamp a timestamp.
+ * @param aFormatPattern a date to string pattern according to SimpleDateFormat.
+ * @return a formatted String representing aTimestamp using Locale according to {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}. If aLocale can not be resolved Locale.ENGLISH is used. If aTimestamp is negative or aFormatPattern is not valid the given timestamp is returned as String.
+ */
+export function format(aTimestamp: number, aFormatPattern: string): string;
 
 /**
-* Converts a Calendar to a timestamp.
-* @returns {number} the timestamp representing aCalendar, or -1 if aCalendar is null.
-* @param {Calendar} aCalendar - a Calendar.
-*/
-export function fromCalendar(aCalendar: Calendar): number;
+ * Formats a given timestamp using a specified Locale.
+ * @param aTimestamp a timestamp.
+ * @param aFormatPattern a date to string pattern according to SimpleDateFormat.
+ * @param aLocale a locale. If aLocale is null the current locale (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}) will be used. If aLocale can not be resolved Locale.ENGLISH will be used.
+ * @return a formatted String representing the aTimestamp. If aTimestamp is negative or aFormatPattern is not valid the given timestamp is returned as String.
+ */
+export function format(
+  aTimestamp: number,
+  aFormatPattern: string,
+  aLocale: unknown
+): string;
 
 /**
-* Converts a Date to a timestamp.
-* @returns {number} the timestamp representing aDate, or -1 if aDate is null.
-* @param {Date} aDate - a Date.
-*/
-export function fromDate(aDate: Date): number;
+ * Converts a timestamp to a Date.
+ * @param aTimestamp a timestamp.
+ * @return the Date representing aTimestamp, or null if aTimestamp is negative.
+ * @since Sitevision 4.5.5
+ */
+export function toDate(aTimestamp: number): unknown;
 
 /**
-* Converts a Instant to a timestamp.
-* @returns {number} aInstant timestamp representing aInstant, or -1 if aInstant is null.
-* @param {Instant} aInstant - a Instant.
-*/
-export function fromInstant(aInstant: Instant): number;
+ * Converts a Date to a timestamp.
+ * @param aDate a Date.
+ * @return the timestamp representing aDate, or -1 if aDate is null.
+ * @since Sitevision 4.5.5
+ */
+export function fromDate(aDate: unknown): number;
 
 /**
-* Converts a LocalDateTime to a timestamp (using the system default ZoneId).
-* @returns {number} aInstant timestamp representing aLocalDateTime, or -1 if aLocalDateTime is null.
-* @param {LocalDateTime} aLocalDateTime - a LocalDateTime.
-*/
-export function fromLocalDateTime(aLocalDateTime: LocalDateTime): number;
+ * Converts a timestamp to a Calendar.
+ * @param aTimestamp a timestamp.
+ * @return the Calendar representing aTimestamp, or null if aTimestamp is negative.
+ * @since Sitevision 4.5.5
+ */
+export function toCalendar(aTimestamp: number): unknown;
 
 /**
-* Returns current timestamp.
-* @returns {number} a long representing the current time.
-*/
-export function getTimestamp(): number;
+ * Converts a Calendar to a timestamp.
+ * @param aCalendar a Calendar.
+ * @return the timestamp representing aCalendar, or -1 if aCalendar is null.
+ * @since Sitevision 4.5.5
+ */
+export function fromCalendar(aCalendar: unknown): number;
 
 /**
-* Converts a timestamp to a Calendar.
-* @returns {Calendar} the Calendar representing aTimestamp, or null if aTimestamp is negative.
-* @param {number} aTimestamp - a timestamp.
-*/
-export function toCalendar(aTimestamp: number): Calendar;
+ * Converts a timestamp to a Instant.
+ * @param aTimestamp a timestamp.
+ * @return the Instant representing aTimestamp, or null if aTimestamp is negative.
+ * @since Sitevision 4.5.5
+ */
+export function toInstant(aTimestamp: number): unknown;
 
 /**
-* Converts a timestamp to a Date.
-* @returns {Date} the Date representing aTimestamp, or null if aTimestamp is negative.
-* @param {number} aTimestamp - a timestamp.
-*/
-export function toDate(aTimestamp: number): Date;
+ * Converts a Instant to a timestamp.
+ * @param aInstant a Instant.
+ * @return aInstant timestamp representing aInstant, or -1 if aInstant is null.
+ * @since Sitevision 4.5.5
+ */
+export function fromInstant(aInstant: unknown): number;
 
 /**
-* Converts a timestamp to a Instant.
-* @returns {Instant} the Instant representing aTimestamp, or null if aTimestamp is negative.
-* @param {number} aTimestamp - a timestamp.
-*/
-export function toInstant(aTimestamp: number): Instant;
+ * Converts a timestamp to a LocalDateTime (using the system default ZoneId).
+ * @param aTimestamp a timestamp.
+ * @return the LocalDateTime representing aTimestamp, or null if aTimestamp is negative.
+ * @since Sitevision 4.5.5
+ */
+export function toLocalDateTime(aTimestamp: number): unknown;
 
 /**
-* Converts a timestamp to a LocalDateTime (using the system default ZoneId).
-* @returns {LocalDateTime} the LocalDateTime representing aTimestamp, or null if aTimestamp is negative.
-* @param {number} aTimestamp - a timestamp.
-*/
-export function toLocalDateTime(aTimestamp: number): LocalDateTime;
+ * Converts a LocalDateTime to a timestamp (using the system default ZoneId).
+ * @param aLocalDateTime a Instant.
+ * @return aInstant timestamp representing aLocalDateTime, or -1 if aLocalDateTime is null.
+ * @since Sitevision 4.5.5
+ */
+export function fromLocalDateTime(aLocalDateTime: unknown): number;
 
-declare namespace timestampUtil {
+/**
+ * Timestamp utility interface.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getTimestampUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Returns current timestamp.Formats current timestamp.Formats current timestamp using a specified Locale.Formats a given timestamp.Formats a given timestamp using a specified Locale.Converts a timestamp to a Date.Converts a Date to a timestamp.Converts a timestamp to a Calendar.Converts a Calendar to a timestamp.Converts a timestamp to a Instant.Converts a Instant to a timestamp.Converts a timestamp to a LocalDateTime (using the system default ZoneId).Converts a LocalDateTime to a timestamp (using the system default ZoneId).
+ * @author Jimmy Roselin
+ * @since Sitevision 4.5.4.1
+ */
+declare namespace TimestampUtil {
   export {
-    format,
+    getTimestamp,
     formatCurrent,
-    fromCalendar,
+    format,
+    toDate,
     fromDate,
-    fromInstant,
-    fromLocalDateTime,
-    getTimestamp,
     toCalendar,
-    toDate,
+    fromCalendar,
     toInstant,
+    fromInstant,
     toLocalDateTime,
+    fromLocalDateTime,
   };
 }
 
-export default timestampUtil;
+export default TimestampUtil;

package/server/TranslationUtil/index.d.ts

@@ -0,0 +1,175 @@
+import Node from "../../hidden/javax/jcr/Node";
+
+/**
+ * Gets a list of all Locales that are set up for translations on the current site.
+ *
+ * <p>
+ *    <em>Note! The returned List is immutable/unmodifiable,
+ *    i.e. you must create a copy if you want to modify it (e.g. sort).</em>
+ * </p>
+ * @return a list of all Locales that are set up for translations on the current site
+ */
+export function getSiteTranslationLocales(): unknown[];
+
+/**
+ * Gets the translation mappings for a given page node.
+ *
+ * <p>
+ *    Each entry in the returned map depicts a <em>"translation"</em>, i.e. a localized version of the given <code>aPageNode</code>.
+ * </p>
+ * <p>
+ *    <strong>Important note! The returned map is never null, but entry <em>values</em> in the map might be!</strong>
+ * </p>
+ * <ul>
+ *    <li>
+ *       The entry <em>key</em> (i.e. the Locale) will never be null.
+ *    </li>
+ *    <li>
+ *       The entry <em>value</em> (i.e. the Node) will be null if current user doesn't have
+ *       {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} permissions on the node.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    <em>Tip!</em> If you are only interested in non-null Nodes/values in the returned map, you can use
+ *    {@link senselogic.sitevision.api.node.NodeFilterUtil} to filter them out!<br>
+ *       Below is a conceptual example of how it could be done in server-side JavaScript (e.g. WebApp, RESTApp, Script module).
+ * </p><pre><code>    var thePotentiallyTranslatedPageNode = ...,
+ *        translationUtil = require('TranslationUtil'),
+ *        nodeFilterUtil = require('NodeFilterUtil'),
+ *        translationMappings,
+ *        skipNullValuesFilter,
+ *        filteredTranslationMappings;
+ *
+ *    translationMappings = translationUtil.getTranslations(thePotentiallyTranslatedPageNode, false);
+ *
+ *    skipNullValuesFilter = nodeFilterUtil.getNonNullFilter();
+ *    filteredTranslationMappings = nodeFilterUtil.getFilteredValueMap(translationMappings, skipNullValuesFilter);</code></pre>
+ *
+ * <p>
+ *    Please note that determining the "<em>is this page node translated at all?</em>" state from the returned result
+ *    depends on the <code>aIncludePageNode</code> value:
+ * </p>
+ * <ul>
+ *    <li>
+ *       If it is <code>false</code>, an empty map will be returned.
+ *    </li>
+ *    <li>
+ *       If it is <code>true</code>, a map with one entry <em>(i.e. the <code>aPageNode</code> itself)</em> will be returned.
+ *    </li>
+ * </ul>
+ * @param aPageNode a page node that can be translated
+ * @param aIncludePageNode whether or not to include aPageNode in the result
+ * @return a Map of translation mappings
+ * @since Sitevision 4.3.1
+ */
+export function getTranslations(
+  aPageNode: Node,
+  aIncludePageNode: boolean
+): Record<unknown, unknown>;
+
+/**
+ * Gets the page node a given node is potentially translated from (the translation source).
+ * @param aPageNode the page node that is translated
+ * @return the page node aPageNode was translated from, or null if the page node isn't translated from another page or if current user doesn't have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} permissions on the from node.
+ * @since Sitevision 4.3.1
+ */
+export function getTranslatedFrom(aPageNode: Node): Node;
+
+/**
+ * Sets the translated from node to the page node provided as translation node.
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user must match have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_TRANSLATIONS} and
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
+ *    on @aTranslationPageNode.
+ * </p>
+ * @param aOriginalPageNode the original page node to be configured as translated from on aTranslationPageNode. It will be configured as original in aTranslationPageNode as well if aOriginalPageNode doesn't have any original configured.
+ * @param aTranslationPageNode the translation page node to be configured as translation of aOriginalPageNode
+ * @return true if aTranslationPageNode could be configured as translation of aOriginalPageNode, false otherwise.
+ * @since Sitevision 4.3.2
+ */
+export function setTranslatedFrom(
+  aOriginalPageNode: Node,
+  aTranslationPageNode: Node
+): boolean;
+
+/**
+ * Translation utility interface.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getTranslationUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>Gets a list of all Locales that are set up for translations on the current site.
+ *
+ * <p>
+ *    <em>Note! The returned List is immutable/unmodifiable,
+ *    i.e. you must create a copy if you want to modify it (e.g. sort).</em>
+ * </p>Gets the translation mappings for a given page node.
+ *
+ * <p>
+ *    Each entry in the returned map depicts a <em>"translation"</em>, i.e. a localized version of the given <code>aPageNode</code>.
+ * </p>
+ * <p>
+ *    <strong>Important note! The returned map is never null, but entry <em>values</em> in the map might be!</strong>
+ * </p>
+ * <ul>
+ *    <li>
+ *       The entry <em>key</em> (i.e. the Locale) will never be null.
+ *    </li>
+ *    <li>
+ *       The entry <em>value</em> (i.e. the Node) will be null if current user doesn't have
+ *       {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} permissions on the node.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    <em>Tip!</em> If you are only interested in non-null Nodes/values in the returned map, you can use
+ *    {@link senselogic.sitevision.api.node.NodeFilterUtil} to filter them out!<br>
+ *       Below is a conceptual example of how it could be done in server-side JavaScript (e.g. WebApp, RESTApp, Script module).
+ * </p><pre><code>    var thePotentiallyTranslatedPageNode = ...,
+ *        translationUtil = require('TranslationUtil'),
+ *        nodeFilterUtil = require('NodeFilterUtil'),
+ *        translationMappings,
+ *        skipNullValuesFilter,
+ *        filteredTranslationMappings;
+ *
+ *    translationMappings = translationUtil.getTranslations(thePotentiallyTranslatedPageNode, false);
+ *
+ *    skipNullValuesFilter = nodeFilterUtil.getNonNullFilter();
+ *    filteredTranslationMappings = nodeFilterUtil.getFilteredValueMap(translationMappings, skipNullValuesFilter);</code></pre>
+ *
+ * <p>
+ *    Please note that determining the "<em>is this page node translated at all?</em>" state from the returned result
+ *    depends on the <code>aIncludePageNode</code> value:
+ * </p>
+ * <ul>
+ *    <li>
+ *       If it is <code>false</code>, an empty map will be returned.
+ *    </li>
+ *    <li>
+ *       If it is <code>true</code>, a map with one entry <em>(i.e. the <code>aPageNode</code> itself)</em> will be returned.
+ *    </li>
+ * </ul>Gets the page node a given node is potentially translated from (the translation source).Sets the translated from node to the page node provided as translation node.
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user must match have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_TRANSLATIONS} and
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
+ *    on @aTranslationPageNode.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 4.2.1
+ */
+declare namespace TranslationUtil {
+  export {
+    getSiteTranslationLocales,
+    getTranslations,
+    getTranslatedFrom,
+    setTranslatedFrom,
+  };
+}
+
+export default TranslationUtil;

package/server/TrashcanUtil/index.d.ts

@@ -1,37 +1,206 @@
-import Node from '../../builtins/Node';
+import Node from "../../hidden/javax/jcr/Node";
 
 /**
-* Deletes a node from the site trashcan.
-* @param {Node} aNode - the node that should be removed from the site trashcan. This node must be located in the site trashcan. May not be null.
-*/
-export function deleteNodeFromTrashcan(aNode: Node): void;
+ * <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;
 
 /**
-* Checks if a node is in the site trashcan. If no node is specified a NullPointerException is thrown.
-* @returns {boolean} true if the Node is in site trashcan, false otherwise 
-* @param {Node} aNode - the node to be checked if it is located in the site trashcan. May not be null
-*/
-export function isInTrashcan(aNode: Node): boolean;
+ * <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;
 
 /**
-* Puts a node in the site trashcan.
-* @param {Node} aNode - the node that will be moved to the site trashcan. May not be null
-*/
-export function moveNodeToTrashcan(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;
 
 /**
-* Restores a node from the site trashcan.
-* @param {Node} aNode - the node that should be restored. This node must be located in the site trashcan. May not be null
-*/
-export function restoreNode(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;
 
-declare namespace trashcanUtil {
+/**
+ * Trashcan utility interface for delete and restore of nodes.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getTrashcanUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p><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><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><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><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>
+ * @author Mikael Wikblom
+ * @see senselogic.sitevision.api.resource.ResourceLocatorUtil#getTrashcan()
+ * @since Sitevision 2.6.2
+ */
+declare namespace TrashcanUtil {
   export {
-    deleteNodeFromTrashcan,
-    isInTrashcan,
     moveNodeToTrashcan,
     restoreNode,
-  }
-};
+    deleteNodeFromTrashcan,
+    isInTrashcan,
+  };
+}
 
-export default trashcanUtil;
+export default TrashcanUtil;