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

package/server/StructureUtil/index.d.ts

@@ -1,84 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * <p>
- *    Moves a node from the current parent to another in the node structure.
- * </p>
- * <p>
- *    Currently supported node types are:
- * </p>
- * <ul>
- *    <li><code>sv:article</code></li>
- *    <li><code>sv:archive</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>
- *    The valid structures are listed below. Any other, invalid combination will result in a <code>ConstraintViolationException</code>.
- * </p>
- *
- * <pre>
- *    Node        - allowed parents
- *    ------------------------------------------------------------------------------------------------------
- *    sv:article  - sv:archive
- *    sv:archive  - sv:sitePage, sv:page, sv:folder, sv:article
- *    sv:file     - sv:folder, *fileRepos
- *    sv:folder   - sv:sitePage, sv:page, sv:folder, sv:article, sv:templateRepository, *fileRepos
- *    sv:image    - sv:folder, *fileRepos
- *    sv:link     - sv:sitePage, sv:page, sv:folder, sv:article
- *    sv:page     - sv:sitePage, sv:page, sv:folder, sv:article
- *    sv:template - sv:folder, sv:templateRepository
- *
- *    Node        - allowed root nodes
- *    ------------------------------------------------------------------------------------------------------
- *    sv:archive  - sv:sitePage
- *    sv:article  - sv:sitePage
- *    sv:file     - *fileRepos
- *    sv:folder   - sv:sitePage, sv:templateRepository, *fileRepos
- *    sv:image    - *fileRepos
- *    sv:link     - sv:sitePage
- *    sv:page     - sv:sitePage
- *    sv:template - sv:templateRepository
- *
- *    *fileRepos corresponds to sv:fileRepository, sv:imageRepository, sv:localFileRepository, sv:localImageRepository
- * </pre>
- *
- * <p>
- *    If the node or the parent is null a <code>NullPointerException</code> is thrown.
- * </p>
- *
- * <p>
- *    Requires {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MOVE_NODE} and
- *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on aNode
- *    If the user is not authorized to alter aNode a <code>ConstraintViolationException</code> is thrown.
- * </p>
- *
- * <p>
- *    Requires {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on aParent and current container of aNode
- *    If the user is not authorized to write on aParent or the current container of aNode a <code>ConstraintViolationException</code> is thrown.
- * </p>
- *
- * <p>
- *    If the parent is descendant of the node a <code>ConstraintViolationException</code> is thrown.
- * </p>
- *
- * <p>
- *    <em>
- *       Note! The move operation will be ignored if the node is already a child of the parent.
- *    </em>
- * </p>
- * @param aNode the node that is to be moved. May not be <code>null</code>
- * @param aParent the new parent node. May not be <code>null</code>
- * @throws ConstraintViolationException if current user is not authorized to move aNode to aParent or if an invalid structure would be result of the operation
- * @throws RepositoryException if something else goes wrong
- */
-export function moveNode(aNode: Node, aParent: Node): void;
-
 /**
  * Utility interface for alterations of the node structure.
  *
@@ -90,8 +11,89 @@ export function moveNode(aNode: Node, aParent: Node): void;
  * @author Mikael Wikblom
  * @since Sitevision 2.6.2
  */
-declare namespace structureUtil {
-  export { moveNode };
+export interface StructureUtil {
+  /**
+   * <p>
+   *    Moves a node from the current parent to another in the node structure.
+   * </p>
+   * <p>
+   *    Currently supported node types are:
+   * </p>
+   * <ul>
+   *    <li><code>sv:article</code></li>
+   *    <li><code>sv:archive</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>
+   *    The valid structures are listed below. Any other, invalid combination will result in a <code>ConstraintViolationException</code>.
+   * </p>
+   *
+   * <pre>
+   *    Node        - allowed parents
+   *    ------------------------------------------------------------------------------------------------------
+   *    sv:article  - sv:archive
+   *    sv:archive  - sv:sitePage, sv:page, sv:folder, sv:article
+   *    sv:file     - sv:folder, *fileRepos
+   *    sv:folder   - sv:sitePage, sv:page, sv:folder, sv:article, sv:templateRepository, *fileRepos
+   *    sv:image    - sv:folder, *fileRepos
+   *    sv:link     - sv:sitePage, sv:page, sv:folder, sv:article
+   *    sv:page     - sv:sitePage, sv:page, sv:folder, sv:article
+   *    sv:template - sv:folder, sv:templateRepository
+   *
+   *    Node        - allowed root nodes
+   *    ------------------------------------------------------------------------------------------------------
+   *    sv:archive  - sv:sitePage
+   *    sv:article  - sv:sitePage
+   *    sv:file     - *fileRepos
+   *    sv:folder   - sv:sitePage, sv:templateRepository, *fileRepos
+   *    sv:image    - *fileRepos
+   *    sv:link     - sv:sitePage
+   *    sv:page     - sv:sitePage
+   *    sv:template - sv:templateRepository
+   *
+   *    *fileRepos corresponds to sv:fileRepository, sv:imageRepository, sv:localFileRepository, sv:localImageRepository
+   * </pre>
+   *
+   * <p>
+   *    If the node or the parent is null a <code>NullPointerException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    Requires {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MOVE_NODE} and
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on aNode
+   *    If the user is not authorized to alter aNode a <code>ConstraintViolationException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    Requires {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE} on aParent and current container of aNode
+   *    If the user is not authorized to write on aParent or the current container of aNode a <code>ConstraintViolationException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    If the parent is descendant of the node a <code>ConstraintViolationException</code> is thrown.
+   * </p>
+   *
+   * <p>
+   *    <em>
+   *       Note! The move operation will be ignored if the node is already a child of the parent.
+   *    </em>
+   * </p>
+   * @param aNode the node that is to be moved. May not be <code>null</code>
+   * @param aParent the new parent node. May not be <code>null</code>
+   * @throws ConstraintViolationException if current user is not authorized to move aNode to aParent or if an invalid structure would be result of the operation
+   * @throws RepositoryException if something else goes wrong
+   */
+  moveNode(aNode: Node, aParent: Node): void;
 }
 
+declare namespace StructureUtil {}
+
+declare var structureUtil: StructureUtil;
+
 export default structureUtil;

package/server/SubscriberUtil/index.d.ts

@@ -1,68 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * <p>Access to a <code>Set</code> of subscribers (i.e. e-mail and / or phone numbers) for an active subscription.</p>
- *
- * <p>This method will never throw exceptions.</p>
- * @param anActiveSubscription the active subscription <code>Node</code>
- * @return a <code>Set</code> of <code>String</code> with the subscribers. Will never return <code>null</code>
- */
-export function getSubscribers(anActiveSubscription: Node): unknown;
-
-/**
- * <p>
- *    Method used to add an e-mail or phone number as a subscriber to the active subscription.
- *    If the subscriber is already a subscriber nothing will be done.
- * </p>
- *
- * <p>
- *    This method will not throw exceptions.
- * </p>
- * @param anActiveSubscription the active subscription <code>Node</code>
- * @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
- * @return indicates that the subscriber is available as a subscriber after the operation
- */
-export function addSubscriber(
-  anActiveSubscription: Node,
-  aSubscriber: string
-): boolean;
-
-/**
- * <p>
- *    Removes an e-mail or phone number from the subscribers of the active subscription.
- *    If the subscriber is not a subscriber nothing will be done.
- * </p>
- *
- * <p>
- *    This method will not throw exceptions.
- * </p>
- * @param anActiveSubscription the active subscription <code>Node</code>
- * @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
- * @return indicates that the subscriber is not available as a subscriber after the operation
- */
-export function removeSubscriber(
-  anActiveSubscription: Node,
-  aSubscriber: string
-): boolean;
-
-/**
- * <p>
- *    Finds out if an e-mail of phone number is already a subscriber to the active subscription.
- *    Note that this method is much faster than <code>getSubscribers(anActiveSubscription).contains(aSubscriber)</code>
- * </p>
- *
- * <p>
- *    This method will not throw exceptions.
- * </p>
- * @param anActiveSubscription the active subscription <code>Node</code>
- * @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
- * @return indicates that the subscriber already is a subscriber to the active subscription
- */
-export function isSubscriber(
-  anActiveSubscription: Node,
-  aSubscriber: string
-): boolean;
-
 /**
  * <p>
  *    Subscriber utility interface.
@@ -92,8 +29,64 @@ export function isSubscriber(
  * @author Mikael Wikblom
  * @since Sitevision 2.6.1_10
  */
-declare namespace subscriberUtil {
-  export { getSubscribers, addSubscriber, removeSubscriber, isSubscriber };
+export interface SubscriberUtil {
+  /**
+   * <p>Access to a <code>Set</code> of subscribers (i.e. e-mail and / or phone numbers) for an active subscription.</p>
+   *
+   * <p>This method will never throw exceptions.</p>
+   * @param anActiveSubscription the active subscription <code>Node</code>
+   * @return a <code>Set</code> of <code>String</code> with the subscribers. Will never return <code>null</code>
+   */
+  getSubscribers(anActiveSubscription: Node): unknown;
+
+  /**
+   * <p>
+   *    Method used to add an e-mail or phone number as a subscriber to the active subscription.
+   *    If the subscriber is already a subscriber nothing will be done.
+   * </p>
+   *
+   * <p>
+   *    This method will not throw exceptions.
+   * </p>
+   * @param anActiveSubscription the active subscription <code>Node</code>
+   * @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
+   * @return indicates that the subscriber is available as a subscriber after the operation
+   */
+  addSubscriber(anActiveSubscription: Node, aSubscriber: string): boolean;
+
+  /**
+   * <p>
+   *    Removes an e-mail or phone number from the subscribers of the active subscription.
+   *    If the subscriber is not a subscriber nothing will be done.
+   * </p>
+   *
+   * <p>
+   *    This method will not throw exceptions.
+   * </p>
+   * @param anActiveSubscription the active subscription <code>Node</code>
+   * @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
+   * @return indicates that the subscriber is not available as a subscriber after the operation
+   */
+  removeSubscriber(anActiveSubscription: Node, aSubscriber: string): boolean;
+
+  /**
+   * <p>
+   *    Finds out if an e-mail of phone number is already a subscriber to the active subscription.
+   *    Note that this method is much faster than <code>getSubscribers(anActiveSubscription).contains(aSubscriber)</code>
+   * </p>
+   *
+   * <p>
+   *    This method will not throw exceptions.
+   * </p>
+   * @param anActiveSubscription the active subscription <code>Node</code>
+   * @param aSubscriber a <code>String</code> containing the e-mail or phone number of the subscriber
+   * @return indicates that the subscriber already is a subscriber to the active subscription
+   */
+  isSubscriber(anActiveSubscription: Node, aSubscriber: string): boolean;
 }
 
+declare namespace SubscriberUtil {}
+
+declare var subscriberUtil: SubscriberUtil;
+
 export default subscriberUtil;

package/server/SubscriptionUtil/index.d.ts

@@ -1,125 +1,5 @@
 import type { Node } from "../../types/javax/jcr/Node";
 
-/**
- * <p>Returns the active subscription <code>Node</code> of a <code>Node</code>. An active subscription
- * is a <code>sv:site</code>, <code>sv:page</code>, <code>sv:article</code> or <code>sv:archive</code> that has activated
- * the subscription functionality. More information about subscriptions can be found in the Sitevision help pages.</p>
- *
- * <p>
- * <code>
- * ex: from the sitevision navigator <br>
- * - server <br>
- * ---site A (subscription activated, including all children) <br>
- * -----page 1 <br>
- * -------archive X (subscription activated, including all children) <br>
- * ---------article V <br>
- * -----page 2 (subscription activated) <br>
- * -------page 21 <br>
- * <br>
- * getActiveSubscription(site A) -&gt; site A <br>
- * getActiveSubscription(page 1) -&gt; site A <br>
- * getActiveSubscription(archive X) -&gt; archive X <br>
- * getActiveSubscription(article V) -&gt; archive X <br>
- * getActiveSubscription(page 2) -&gt; page 2 <br>
- * getActiveSubscription(page 21) -&gt; null <br>
- * </code>
- * </p>
- *
- * <p>To find out if a <code>Node</code> has active subscription use the property <code>isActiveSubscription</code>. This
- * method is simply convenience to find the active <code>Node</code>.</p>
- *
- * <p>This method will never throw exceptions</p>
- * @param aNode a <code>Node</code> in the navigation (e.g. a sv:page or an sv:article)
- * @return a <code>Node</code> with activated subscription or <code>null</code> if not available
- */
-export function getActiveSubscription(aNode: Node): Node;
-
-/**
- * <p>Activates a subscription for the given <code>Node</code>.</p>
- *
- * <p>The current user must have write subscription permission to activate subscriptions.</p>
- * @param aNode the <code>Node</code> to activate a subscription for.
- * @param subtreeScope true if activation should include subnodes, false otherwise.
- * @param title the subscription title.
- * @param description the subscription description.
- * @throws ConstraintViolationException if the current user isn't allowed to modify subscriptions.
- * @throws IllegalArgumentException if the given node <code>aNode</code> is null or if the given node isn't a subscriptionable node.
- * @throws RepositoryException if something else goes wrong.
- * @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
- * @since Sitevision 2.6.2_05
- */
-export function activateSubscription(
-  aNode: Node,
-  subtreeScope: boolean,
-  title: string,
-  description: string
-): void;
-
-/**
- * <p>Deactivates the subscription for the given <code>Node</code>.</p>
- *
- * <p>The current user must have write subscription permission to deactivate subscriptions.</p>
- * @param aNode the <code>Node</code> to deactivate the subscription for.
- * @throws RepositoryException if the current user isn't allowed to modify subscriptions.
- * @throws IllegalArgumentException if the given node <code>aNode</code> is null or if the given node isn't a subscriptionable node.
- * @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
- * @since Sitevision 2.6.2_05
- */
-export function deactivateSubscription(aNode: Node): void;
-
-/**
- * <p>Configures email properties for the subscription on the given node.</p>
- *
- * <p>The current user must have write subscription permission to configure subscription email.</p>
- * @param aNode the <code>Node</code> to configure.
- * @param from name of the sender.
- * @param fromAddress email address of the sender.
- * @param subject the email subject.
- * @param footer the email footer
- * @throws ConstraintViolationException if the current user isn't allowed to modify subscriptions.
- * @throws IllegalArgumentException if the given node <code>aNode</code> is null, if the given node isn't a subscriptionable node, if <code>fromAddress</code> is null or not a valid email adress.
- * @throws RepositoryException if something else goes wrong.
- * @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
- * @since Sitevision 2.6.2_05
- */
-export function configureSubscriptionEmail(
-  aNode: Node,
-  from: string,
-  fromAddress: string,
-  subject: string,
-  footer: string
-): void;
-
-/**
- * Notifies the subscribers of a given node with an active subscription.
- *
- * <p>
- *    This method will use the settings of the active subscription to send mail notifications to all subscribers.
- *    A properly configured active subscription has mail settings that specifies <em>from</em>, <em>from address</em>,
- *    <em>subject</em> and a <em>footer</em>. The active subscription also has a <em>mail template</em> that is
- *    used to create the actual <em>body</em> of the notification. The mail template for an active subscription
- *    will typically include something like this:
- * </p>
- * <ol>
- *    <li>A <em>notification</em> text</li>
- *    <li>The <em>URL</em> of the node</li>
- *    <li>The mail <em>footer</em></li>
- * </ol>
- * <p>
- *    The <code>aNotificationText</code> parameter of this method will be used as <em>notification</em> text in the mail template.
- *    In other words - if <code>aNotificationText</code> is <code>null</code>, the notification mail body will typically
- *    contain the <em>URL</em> and the <em>footer</em> only.
- * </p>
- * @param aNode a <code>Node</code> that has an active subscription, typically a sv:page or sv:article
- * @param aNotificationText the notification text
- * @return <code>true</code> if a notification could be scheduled, <code>false</code> otherwise (e.g. if <code>aNode</code> is <code>null</code> or has no <em>active subscription</em>, see {@link #getActiveSubscription(javax.jcr.Node)})
- * @since Sitevision 3.6.3
- */
-export function notifySubscribersOf(
-  aNode: Node,
-  aNotificationText: string
-): boolean;
-
 /**
  * <p>
  *    Subscription utility interface.
@@ -133,14 +13,127 @@ export function notifySubscribersOf(
  * @author Mikael Wikblom
  * @since Sitevision 2.6.1_10
  */
-declare namespace subscriptionUtil {
-  export {
-    getActiveSubscription,
-    activateSubscription,
-    deactivateSubscription,
-    configureSubscriptionEmail,
-    notifySubscribersOf,
-  };
+export interface SubscriptionUtil {
+  /**
+   * <p>Returns the active subscription <code>Node</code> of a <code>Node</code>. An active subscription
+   * is a <code>sv:site</code>, <code>sv:page</code>, <code>sv:article</code> or <code>sv:archive</code> that has activated
+   * the subscription functionality. More information about subscriptions can be found in the Sitevision help pages.</p>
+   *
+   * <p>
+   * <code>
+   * ex: from the sitevision navigator <br>
+   * - server <br>
+   * ---site A (subscription activated, including all children) <br>
+   * -----page 1 <br>
+   * -------archive X (subscription activated, including all children) <br>
+   * ---------article V <br>
+   * -----page 2 (subscription activated) <br>
+   * -------page 21 <br>
+   * <br>
+   * getActiveSubscription(site A) -&gt; site A <br>
+   * getActiveSubscription(page 1) -&gt; site A <br>
+   * getActiveSubscription(archive X) -&gt; archive X <br>
+   * getActiveSubscription(article V) -&gt; archive X <br>
+   * getActiveSubscription(page 2) -&gt; page 2 <br>
+   * getActiveSubscription(page 21) -&gt; null <br>
+   * </code>
+   * </p>
+   *
+   * <p>To find out if a <code>Node</code> has active subscription use the property <code>isActiveSubscription</code>. This
+   * method is simply convenience to find the active <code>Node</code>.</p>
+   *
+   * <p>This method will never throw exceptions</p>
+   * @param aNode a <code>Node</code> in the navigation (e.g. a sv:page or an sv:article)
+   * @return a <code>Node</code> with activated subscription or <code>null</code> if not available
+   */
+  getActiveSubscription(aNode: Node): Node;
+
+  /**
+   * <p>Activates a subscription for the given <code>Node</code>.</p>
+   *
+   * <p>The current user must have write subscription permission to activate subscriptions.</p>
+   * @param aNode the <code>Node</code> to activate a subscription for.
+   * @param subtreeScope true if activation should include subnodes, false otherwise.
+   * @param title the subscription title.
+   * @param description the subscription description.
+   * @throws ConstraintViolationException if the current user isn't allowed to modify subscriptions.
+   * @throws IllegalArgumentException if the given node <code>aNode</code> is null or if the given node isn't a subscriptionable node.
+   * @throws RepositoryException if something else goes wrong.
+   * @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
+   * @since Sitevision 2.6.2_05
+   */
+  activateSubscription(
+    aNode: Node,
+    subtreeScope: boolean,
+    title: string,
+    description: string
+  ): void;
+
+  /**
+   * <p>Deactivates the subscription for the given <code>Node</code>.</p>
+   *
+   * <p>The current user must have write subscription permission to deactivate subscriptions.</p>
+   * @param aNode the <code>Node</code> to deactivate the subscription for.
+   * @throws RepositoryException if the current user isn't allowed to modify subscriptions.
+   * @throws IllegalArgumentException if the given node <code>aNode</code> is null or if the given node isn't a subscriptionable node.
+   * @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
+   * @since Sitevision 2.6.2_05
+   */
+  deactivateSubscription(aNode: Node): void;
+
+  /**
+   * <p>Configures email properties for the subscription on the given node.</p>
+   *
+   * <p>The current user must have write subscription permission to configure subscription email.</p>
+   * @param aNode the <code>Node</code> to configure.
+   * @param from name of the sender.
+   * @param fromAddress email address of the sender.
+   * @param subject the email subject.
+   * @param footer the email footer
+   * @throws ConstraintViolationException if the current user isn't allowed to modify subscriptions.
+   * @throws IllegalArgumentException if the given node <code>aNode</code> is null, if the given node isn't a subscriptionable node, if <code>fromAddress</code> is null or not a valid email adress.
+   * @throws RepositoryException if something else goes wrong.
+   * @see senselogic.sitevision.api.security.PermissionUtil#hasWriteSubscriptionPermission(javax.jcr.Node, javax.jcr.Node)
+   * @since Sitevision 2.6.2_05
+   */
+  configureSubscriptionEmail(
+    aNode: Node,
+    from: string,
+    fromAddress: string,
+    subject: string,
+    footer: string
+  ): void;
+
+  /**
+   * Notifies the subscribers of a given node with an active subscription.
+   *
+   * <p>
+   *    This method will use the settings of the active subscription to send mail notifications to all subscribers.
+   *    A properly configured active subscription has mail settings that specifies <em>from</em>, <em>from address</em>,
+   *    <em>subject</em> and a <em>footer</em>. The active subscription also has a <em>mail template</em> that is
+   *    used to create the actual <em>body</em> of the notification. The mail template for an active subscription
+   *    will typically include something like this:
+   * </p>
+   * <ol>
+   *    <li>A <em>notification</em> text</li>
+   *    <li>The <em>URL</em> of the node</li>
+   *    <li>The mail <em>footer</em></li>
+   * </ol>
+   * <p>
+   *    The <code>aNotificationText</code> parameter of this method will be used as <em>notification</em> text in the mail template.
+   *    In other words - if <code>aNotificationText</code> is <code>null</code>, the notification mail body will typically
+   *    contain the <em>URL</em> and the <em>footer</em> only.
+   * </p>
+   * @param aNode a <code>Node</code> that has an active subscription, typically a sv:page or sv:article
+   * @param aNotificationText the notification text
+   * @return <code>true</code> if a notification could be scheduled, <code>false</code> otherwise (e.g. if <code>aNode</code> is <code>null</code> or has no <em>active subscription</em>, see {@link #getActiveSubscription(javax.jcr.Node)})
+   * @since Sitevision 3.6.3
+   */
+  notifySubscribersOf(aNode: Node, aNotificationText: string): boolean;
 }
 
+declare namespace SubscriptionUtil {}
+
+declare var subscriptionUtil: SubscriptionUtil;
+
 export default subscriptionUtil;