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

package/hidden/senselogic/sitevision/api/subscription/SubscriberUtil/index.d.ts

@@ -1,96 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * <p>
- *    Subscriber utility interface.
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getSubscriberUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- *
- * <p>
- *    To find an active subscription, use the property <code>isActiveSubscription</code> or the convenience method
- *    {@link SubscriptionUtil#getActiveSubscription}. An active subscription is either <code>sv:site</code>, <code>sv:page</code>,
- *    <code>sv:archive</code> or <code>sv:article</code> where the subscription functionality has been activated.
- *    More information about subscriptions can be found in the Sitevision help pages.
- * </p>
- *
- * <p>
- *    A subscriber is either an e-mail or a phone number. Phone number is only available if the Sitevision licence
- *    contains the feature "sms".
- * </p>
- *
- * <p>
- *    The write methods are fully synchronized and will never throw <code>ConcurrentModificationExceptions</code>.
- * </p>
- * @author Mikael Wikblom
- * @since Sitevision 2.6.1_10
- */
-
-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): Set<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: java.lang.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: java.lang.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: java.lang.String
-  ): boolean;
-}

package/hidden/senselogic/sitevision/api/subscription/SubscriptionUtil/index.d.ts

@@ -1,137 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * <p>
- *    Subscription utility interface.
- * </p>
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getSubscriptionUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
- * @author Mikael Wikblom
- * @since Sitevision 2.6.1_10
- */
-
-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: java.lang.String,
-    description: java.lang.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: java.lang.String,
-    fromAddress: java.lang.String,
-    subject: java.lang.String,
-    footer: java.lang.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: java.lang.String
-  ): boolean;
-}

package/hidden/senselogic/sitevision/api/tag/TagUtil/index.d.ts

@@ -1,127 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * Tag utility interface for tree nodes.
- *
- * <p>
- *    This sv:tag utility operates on taggable nodes of type: <code>sv:page</code>, <code>sv:article</code>, <code>sv:sitePage</code>,
- *    <code>sv:collaborationGroupPage</code>, <code>sv:file</code> and <code>sv:image</code>.
- * </p>
- * <p>
- *    <em>Related: Use {@link senselogic.sitevision.api.node.NodeResolverUtil#getTagsResolver()} to resolve sv:tag's from other node types
- *    (e.g. sv:timelineEntry, sv:comment, sv:tagGroup etc). Use {@link senselogic.sitevision.api.metadata.MetadataUtil} to set tag metadata.</em>
- * </p>
- * @author Karl Eklöf
- * @since Sitevision 9.1
- */
-
-interface TagUtil {
-  /**
-   * Gets a sv:tag Node by name.
-   * @param aTagName the tag name. Must not be null, whitespace-only or shebang-only
-   * @return a sv:tag or null if no tag with aTagName could be fond
-   * @throws IllegalArgumentException if aTagName is invalid
-   */
-  getTagByName(aTagName: java.lang.String): Node;
-
-  /**
-   * Gets or creates a sv:tag Node by name.
-   *
-   * <p>
-   *    <strong>Permission note:</strong> Current user must be authenticated (i.e. non-anonymous).
-   * </p>
-   * @param aTagName the tag name. Must not be null, whitespace-only or shebang-only
-   * @return the sv:tag for aTagName
-   * @throws IllegalArgumentException if aTagName is invalid
-   * @throws RepositoryException if current user is anonymous or the sv:tag could not be found or created
-   */
-  getOrCreateTagByName(aTagName: java.lang.String): Node;
-
-  /**
-   * Adds a sv:tag to a Node.
-   *
-   * <p>
-   *    <strong>Permission note:</strong> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE}
-   *    permission on the taggable Node that is mutated.
-   * </p>
-   * <p>
-   *    <strong>Versioning note:</strong> Mutation of the taggable Node is always executed in the
-   *    {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE} version.
-   *    In other words - if you mutate the sv:tag entries on a sv:page, you must also
-   *    {@link senselogic.sitevision.api.versioning.PublishingUtil publish} the sv:page for changes to affect the
-   *    {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION ONLINE/published} version.
-   * </p>
-   * @param aTaggableNode a taggable node (sv:page, sv:article, sv:sitePage, sv:collaborationGroupPage, sv:file or sv:image)
-   * @param aTagNode a sv:tag
-   * @throws IllegalArgumentException if aTaggableNode or aTagNode is null or an unsupported type
-   * @throws RepositoryException if mutation is not allowed or fails
-   */
-  addTag(aTaggableNode: Node, aTagNode: Node): void;
-
-  /**
-   * Adds multiple sv:tag to a Node.
-   *
-   * <p>
-   *    <strong>Permission note:</strong> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE}
-   *    permission on the taggable Node that is mutated.
-   * </p>
-   * <p>
-   *    <strong>Versioning note:</strong> Mutation of the taggable Node is always executed in the
-   *    {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE} version.
-   *    In other words - if you mutate the sv:tag entries on a sv:page, you must also
-   *    {@link senselogic.sitevision.api.versioning.PublishingUtil publish} the sv:page for changes to affect the
-   *    {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION ONLINE/published} version.
-   * </p>
-   * <p>
-   *    Server-side Javascript example:
-   * </p>
-   * <pre><code>    const tagUtil = require('TagUtil');
-   *    ...
-   *    let tags = [];
-   *    tags.push(tagUtil.getOrCreateTagByName('mytag'));
-   *    tags.push(tagUtil.getOrCreateTagByName('myothertag'));
-   *
-   *    tagUtil.addTags(pageNode, tags);</code></pre>
-   * @param aTaggableNode a taggable node (sv:page, sv:article, sv:sitePage, sv:collaborationGroupPage, sv:file or sv:image)
-   * @param aTagNodes a var-args array of sv:tag nodes
-   * @throws IllegalArgumentException if aTaggableNode is null or an unsupported type, or if or aTagNodes is null, empty or contains an unsupported type
-   * @throws RepositoryException if mutation is not allowed or fails
-   */
-  addTags(aTaggableNode: Node, aTagNodes: Node): void;
-
-  /**
-   * Removes a sv:tag from a Node.
-   *
-   * <p>
-   *    <strong>Permission note:</strong> Current user must have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE WRITE}
-   *    permission on the taggable Node that is mutated.
-   * </p>
-   * <p>
-   *    <strong>Versioning note:</strong> Mutation of the taggable Node is always executed in the
-   *    {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE} version.
-   *    In other words - if you mutate the sv:tag entries on a sv:page, you must also
-   *    {@link senselogic.sitevision.api.versioning.PublishingUtil publish} the sv:page for changes to affect the
-   *    {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION ONLINE/published} version.
-   * </p>
-   * @param aTaggableNode a taggable node (sv:page, sv:article, sv:sitePage, sv:collaborationGroupPage, sv:file or sv:image)
-   * @param aTagNode a sv:tag
-   * @return true if aTagNode was removed from aTaggableNode, false otherwise
-   * @throws IllegalArgumentException if aTaggableNode or aTagNode is null or an unsupported type
-   * @throws RepositoryException if mutation is not allowed or fails
-   */
-  removeTag(aTaggableNode: Node, aTagNode: Node): boolean;
-
-  /**
-   * Gets all sv:tag's for a Node.
-   *
-   * <p>
-   *    <em>Version note! This method executes in current version, i.e. it will return the list of sv:tag's
-   *    in current version ({@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION OFFLINE_VERSION} or
-   *    {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION ONLINE_VERSION}).</em>
-   * </p>
-   * @param aTaggableNode a taggable node (sv:page, sv:article, sv:sitePage, sv:collaborationGroupPage, sv:file or sv:image)
-   * @return a list of sv:tag nodes for aTaggableNode
-   * @throws IllegalArgumentException if aTaggableNode is null or an unsupported type
-   */
-  getTags(aTaggableNode: Node): unknown[];
-}