@sitevision/api 2023.2.1 → 2023.2.2-beta.2

package/server/SystemUserUtil/index.d.ts

@@ -3,16 +3,16 @@ import type { Node } from "../../types/javax/jcr/Node";
 /**
  * System user utility interface.
  *
- * <p>
- *    This interface handles nodes with primary node type <code>sv:systemUser</code>, i.e. the
- *    <em>Anonymous</em>, <em>System</em>, <em>Indexer</em> and <em>Extractor</em> user.
- * </p>
+ *  <p>
+ *     This interface handles nodes with primary node type <code>sv:systemUser</code>, i.e. the
+ *     <em>Anonymous</em>, <em>System</em>, <em>Indexer</em> and <em>Extractor</em> user.
+ *  </p>
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.user.UserFactory#getSystemUserUtil()}.
- *    See {@link senselogic.sitevision.api.user.UserFactory} for how to obtain an instance of the <code>UserFactory</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.user.UserFactory#getSystemUserUtil()}.
+ *     See {@link senselogic.sitevision.api.user.UserFactory} for how to obtain an instance of the <code>UserFactory</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 3.6
  */
@@ -20,15 +20,15 @@ export interface SystemUserUtil {
   /**
    * Checks if current user is anonymous (not authenticated).
    *
-   * <p>
-   *    An <em>Anonymous user</em> is not authenticated and can only access public resources.
-   * </p>
+   *  <p>
+   *     An <em>Anonymous user</em> is not authenticated and can only access public resources.
+   *  </p>
    *
-   * <p>
-   * <em>Note! This method does NOT produce a reliable result if called during the authentication process
-   * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
-   * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
-   * </p>
+   *  <p>
+   *  <em>Note! This method does NOT produce a reliable result if called during the authentication process
+   *  (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
+   *  {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
+   *  </p>
    * @return <code>true</code> if current user is Anonymous (i.e. not authenticated), <code>false</code> otherwise
    */
   isAnonymous(): boolean;
@@ -36,27 +36,27 @@ export interface SystemUserUtil {
   /**
    * Checks if a user node is anonymous (not authenticated).
    *
-   * <p>
-   *    An <em>Anonymous user</em> is not authenticated and can only access public resources.
-   * </p>
+   *  <p>
+   *     An <em>Anonymous user</em> is not authenticated and can only access public resources.
+   *  </p>
    * @param aUserNode a user node
-   * @return <code>true</code> if <code>aUserNode</code> is anonymous (i.e. not authenticated), <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @return <code>true</code> if <code>aUserNode</code> is anonymous (i.e. not authenticated), <code>false</code> otherwise&#xA; (i.e. no match or <code>aUserNode</code> is <code>null</code>)
    */
   isAnonymous(aUserNode: Node): boolean;
 
   /**
    * Checks if current user is the Sitevision System user.
    *
-   * <p>
-   *    The <em>System user</em> has all permissions and full access to all Sitevision portlets and functionality allowed
-   *    by the current license(-s).
-   * </p>
+   *  <p>
+   *     The <em>System user</em> has all permissions and full access to all Sitevision portlets and functionality allowed
+   *     by the current license(-s).
+   *  </p>
    *
-   * <p>
-   * <em>Note! This method does NOT produce a reliable result if called during the authentication process
-   * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
-   * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
-   * </p>
+   *  <p>
+   *  <em>Note! This method does NOT produce a reliable result if called during the authentication process
+   *  (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
+   *  {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
+   *  </p>
    * @return <code>true</code> if current user is the Sitevision System user, <code>false</code> otherwise
    */
   isSystem(): boolean;
@@ -64,28 +64,28 @@ export interface SystemUserUtil {
   /**
    * Checks if a user node is the Sitevision System user.
    *
-   * <p>
-   *    The <em>System user</em> has all permissions and full access to all Sitevision portlets and functionality allowed
-   *    by the current license(-s).
-   * </p>
+   *  <p>
+   *     The <em>System user</em> has all permissions and full access to all Sitevision portlets and functionality allowed
+   *     by the current license(-s).
+   *  </p>
    * @param aUserNode a user node
-   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision System user, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision System user, <code>false</code> otherwise&#xA; (i.e. no match or <code>aUserNode</code> is <code>null</code>)
    */
   isSystem(aUserNode: Node): boolean;
 
   /**
    * Checks if current user is the Sitevision Indexer.
    *
-   * <p>
-   *    The <em>Indexer user</em> has read permission on all resources and visits/renders pages in order to collect
-   *    metadata/content and such that should be indexed by the Sitevision search engine.
-   * </p>
+   *  <p>
+   *     The <em>Indexer user</em> has read permission on all resources and visits/renders pages in order to collect
+   *     metadata/content and such that should be indexed by the Sitevision search engine.
+   *  </p>
    *
-   * <p>
-   * <em>Note! This method does NOT produce a reliable result if called during the authentication process
-   * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
-   * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
-   * </p>
+   *  <p>
+   *  <em>Note! This method does NOT produce a reliable result if called during the authentication process
+   *  (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
+   *  {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
+   *  </p>
    * @return <code>true</code> if current user is the Sitevision Indexer, <code>false</code> otherwise
    */
   isIndexer(): boolean;
@@ -93,27 +93,27 @@ export interface SystemUserUtil {
   /**
    * Checks if a user node is the Sitevision Indexer.
    *
-   * <p>
-   *    The <em>Indexer user</em> has read permission on all resources and visits/renders pages in order to collect
-   *    metadata/content and such that should be indexed by the Sitevision search engine.
-   * </p>
+   *  <p>
+   *     The <em>Indexer user</em> has read permission on all resources and visits/renders pages in order to collect
+   *     metadata/content and such that should be indexed by the Sitevision search engine.
+   *  </p>
    * @param aUserNode a user node
-   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Indexer, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Indexer, <code>false</code> otherwise&#xA; (i.e. no match or <code>aUserNode</code> is <code>null</code>)
    */
   isIndexer(aUserNode: Node): boolean;
 
   /**
    * Checks if current user is the Sitevision Validator.
    *
-   * <p>
-   *    The <em>Validator user</em> has read permission on all resources and visits/renders pages in order to validate them.
-   * </p>
+   *  <p>
+   *     The <em>Validator user</em> has read permission on all resources and visits/renders pages in order to validate them.
+   *  </p>
    *
-   * <p>
-   * <em>Note! This method does NOT produce a reliable result if called during the authentication process
-   * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
-   * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
-   * </p>
+   *  <p>
+   *  <em>Note! This method does NOT produce a reliable result if called during the authentication process
+   *  (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
+   *  {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
+   *  </p>
    * @return <code>true</code> if current user is the Sitevision Validator, <code>false</code> otherwise
    * @since Sitevision 4.2.3
    */
@@ -122,11 +122,11 @@ export interface SystemUserUtil {
   /**
    * Checks if a user node is the Sitevision Validator.
    *
-   * <p>
-   *    The <em>Validator user</em> has read permission on all resources and visits/renders pages in order to validate them.
-   * </p>
+   *  <p>
+   *     The <em>Validator user</em> has read permission on all resources and visits/renders pages in order to validate them.
+   *  </p>
    * @param aUserNode a user node
-   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Validator, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Validator, <code>false</code> otherwise&#xA; (i.e. no match or <code>aUserNode</code> is <code>null</code>)
    * @since Sitevision 4.2.3
    */
   isValidator(aUserNode: Node): boolean;
@@ -134,16 +134,16 @@ export interface SystemUserUtil {
   /**
    * Checks if current user is the Sitevision Extractor.
    *
-   * <p>
-   *    The <em>Extractor user</em> has read permission on all resources and renders pages in order to store their
-   *    content as static html pages.
-   * </p>
+   *  <p>
+   *     The <em>Extractor user</em> has read permission on all resources and renders pages in order to store their
+   *     content as static html pages.
+   *  </p>
    *
-   * <p>
-   * <em>Note! This method does NOT produce a reliable result if called during the authentication process
-   * (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
-   * {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
-   * </p>
+   *  <p>
+   *  <em>Note! This method does NOT produce a reliable result if called during the authentication process
+   *  (i.e. from a JAAS filter or JAAS module) since it relies on a fully loaded current user (as of
+   *  {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentUser()}).</em>
+   *  </p>
    * @return <code>true</code> if current user is the Sitevision Extractor, <code>false</code> otherwise
    */
   isExtractor(): boolean;
@@ -151,12 +151,12 @@ export interface SystemUserUtil {
   /**
    * Checks if a user node is the Sitevision Extractor.
    *
-   * <p>
-   *    The <em>Extractor user</em> has read permission on all resources and renders pages in order to store their
-   *    content as static html pages.
-   * </p>
+   *  <p>
+   *     The <em>Extractor user</em> has read permission on all resources and renders pages in order to store their
+   *     content as static html pages.
+   *  </p>
    * @param aUserNode a user node
-   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Extractor, <code>false</code> otherwise (i.e. no match or <code>aUserNode</code> is <code>null</code>)
+   * @return <code>true</code> if <code>aUserNode</code> is the Sitevision Extractor, <code>false</code> otherwise&#xA; (i.e. no match or <code>aUserNode</code> is <code>null</code>)
    */
   isExtractor(aUserNode: Node): boolean;
 }

package/server/TagUtil/index.d.ts

@@ -1,16 +1,19 @@
+import type { String } from "../../types/java/lang/String";
 import type { Node } from "../../types/javax/jcr/Node";
 
+import type { List } from "../../types/java/util/List";
+
 /**
  * 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>
+ *  <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
  */
@@ -21,35 +24,35 @@ export interface TagUtil {
    * @return a sv:tag or null if no tag with aTagName could be fond
    * @throws IllegalArgumentException if aTagName is invalid
    */
-  getTagByName(aTagName: string): Node;
+  getTagByName(aTagName: String | 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>
+   *  <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: string): Node;
+  getOrCreateTagByName(aTagName: String | 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>
+   *  <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
@@ -60,48 +63,48 @@ export interface TagUtil {
   /**
    * 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'));
+   *  <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>
+   *     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 IllegalArgumentException if aTaggableNode is null or an unsupported type,&#xA; 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;
+  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>
+   *  <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
@@ -113,16 +116,16 @@ export interface TagUtil {
   /**
    * 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>
+   *  <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;
+  getTags(aTaggableNode: Node): List;
 }
 
 declare namespace TagUtil {}